Skip to content

Commit 957e717

Browse files
committed
Update README.MD for v1.0.2 release
1 parent a664144 commit 957e717

File tree

1 file changed

+11
-58
lines changed

1 file changed

+11
-58
lines changed

README.md

Lines changed: 11 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ SSLLWrapper stands for SSL Labs Wrapper which is the first publicly available .N
66
This wrapper easies the communication to the API's for .NET developers which allows you as the developer to focus on your project rather than managing the plumbing and overhead required to consume the API's.
77

88
**Notes**
9-
- SSL Labs' Assessment API's are currently still in development and are subject to change.
10-
- The wrapper is currently still in development as well though is in a functional beta stage.
9+
- SSL Labs' Assessment API's are currently still in development and are subject to change. This therefore may impact the wrapper though updates will be provided.
1110
- The wrapper does **NOT** use web scrapping like other wrappers which don't use the assessment API's.
11+
- This documentation is for v1.0.2 release.
1212

1313
### NuGet Package
1414
The wrapper can easily be imported into your project using the [SSLLWrapper NuGet package](https://www.nuget.org/packages/SSLLWrapper/). The NuGet install command for this package is:
@@ -18,10 +18,10 @@ The wrapper can easily be imported into your project using the [SSLLWrapper NuGe
1818
### Wrapper Usage
1919
When creating a new instance of SSLLWrapper you must supply the API url during the initialization. For example in C# this would be expressed as the following:
2020
```C#
21-
var service = new SSLLWrapper.Service("https://api.dev.ssllabs.com/api/fa78d5a4");
21+
var ssllService = new SSLLWrapper.SSLLService("https://api.dev.ssllabs.com/api/fa78d5a4");
2222

2323
// Or if you use the SSLWrapper namespace this can be shorten to
24-
var service = new Service("https://api.dev.ssllabs.com/api/fa78d5a4");
24+
var ssllService = new SSLLService("https://api.dev.ssllabs.com/api/fa78d5a4");
2525
```
2626
#### Methods
2727

@@ -48,9 +48,9 @@ The wrapper also contains an overloaded Analyze method which only requires the h
4848
public Analyze Analyze(string host)
4949
```
5050

51-
##### GetEndpointDetails()
51+
##### GetEndpointData()
5252

53-
The GetEndPointDetails method is used to retrieve a fully results set.
53+
The GetEndpointData method is used to retrieve a fully results set.
5454
```C#
5555
public Endpoint GetEndpointData(string host, string s, FromCache fromCache)
5656
```
@@ -64,7 +64,7 @@ public Endpoint GetEndpointData(string host, string s)
6464

6565
The GetStatusCodes method is use to retrieve a list of status codes and messages.
6666
```C#
67-
public StatusDetails GetStatusCodes()
67+
public StatusCodes GetStatusCodes()
6868
```
6969

7070
#### Response Objects
@@ -132,56 +132,9 @@ public bool isExceptional { get; set; }
132132
public Details Details { get; set; }
133133
```
134134

135-
##### StatusDetails
135+
##### StatusCodes
136136
```C#
137-
public string TESTING_PROTOCOL_INTOLERANCE_399 { get; set; }
138-
public string PREPARING_REPORT { get; set; }
139-
public string TESTING_SESSION_RESUMPTION { get; set; }
140-
public string TESTING_NPN { get; set; }
141-
public string RETRIEVING_CERT_V3__NO_SNI { get; set; }
142-
public string RETRIEVING_CERT_V3__SNI_APEX { get; set; }
143-
public string TESTING_CVE_2014_0224 { get; set; }
144-
public string TESTING_CAPABILITIES { get; set; }
145-
public string TESTING_HEARTBLEED { get; set; }
146-
public string TESTING_PROTO_3_3_V2H { get; set; }
147-
public string TESTING_SESSION_TICKETS { get; set; }
148-
public string VALIDATING_TRUST_PATHS { get; set; }
149-
public string TESTING_RENEGOTIATION { get; set; }
150-
public string TESTING_HTTPS { get; set; }
151-
public string TESTING_V2H_HANDSHAKE { get; set; }
152-
public string TESTING_STRICT_RI { get; set; }
153-
public string TESTING_SUITES_DEPRECATED { get; set; }
154-
public string TESTING_HANDSHAKE_SIMULATION { get; set; }
155-
public string TESTING_STRICT_SNI { get; set; }
156-
public string TESTING_PROTO_3_1_V2H { get; set; }
157-
public string TESTING_PROTOCOL_INTOLERANCE_499 { get; set; }
158-
public string TESTING_TLS_VERSION_INTOLERANCE { get; set; }
159-
public string TESTING_PROTOCOL_INTOLERANCE_304 { get; set; }
160-
public string TESTING_SUITES_BULK { get; set; }
161-
public string TESTING_BEAST { get; set; }
162-
public string TESTING_PROTO_2_0 { get; set; }
163-
public string BUILDING_TRUST_PATHS { get; set; }
164-
public string TESTING_PROTO_3_1 { get; set; }
165-
public string TESTING_PROTO_3_0_V2H { get; set; }
166-
public string TESTING_PROTO_3_0 { get; set; }
167-
public string TESTING_PROTOCOL_INTOLERANCE_300 { get; set; }
168-
public string TESTING_PROTOCOL_INTOLERANCE_301 { get; set; }
169-
public string TESTING_PROTOCOL_INTOLERANCE_302 { get; set; }
170-
public string TESTING_PROTOCOL_INTOLERANCE_303 { get; set; }
171-
public string TESTING_OCSP_STAPLING_PRIME { get; set; }
172-
public string TESTING_EXTENSION_INTOLERANCE { get; set; }
173-
public string TESTING_SSL2_SUITES { get; set; }
174-
public string TESTING_OCSP_STAPLING { get; set; }
175-
public string TESTING_SUITES { get; set; }
176-
public string TESTING_PROTO_3_2_V2H { get; set; }
177-
public string TESTING_POODLE_TLS { get; set; }
178-
public string RETRIEVING_CERT_V3__SNI_WWW { get; set; }
179-
public string CHECKING_REVOCATION { get; set; }
180-
public string TESTING_COMPRESSION { get; set; }
181-
public string TESTING_SUITE_PREFERENCE { get; set; }
182-
public string TESTING_PROTO_3_2 { get; set; }
183-
public string TESTING_PROTO_3_3 { get; set; }
184-
public string TESTING_LONG_HANDSHAKE { get; set; }
137+
public StatusDetails StatusDetails { get; set; }
185138
```
186139

187140
#### Custom Parameters
@@ -216,11 +169,11 @@ public enum All
216169
```
217170

218171
#### To Do
219-
- Flesh out SSLWrapper.Tests project to ensure as most code as appropriate is tested
220-
- General refractor
172+
- Flesh out SSLWrapper.Tests
221173

222174
### Author
223175
Ashley Poole - www.ashleypoole.co.uk.
176+
224177
[SSLWrapper project's home page](http://www.ashleypoole.co.uk/ssllwrapper?utm_source=github&utm_medium=githubproject&utm_campaign=ssllwrapper)
225178

226179
Please contact me if you have any questions, issues or recommendations either via [my website](http://www.ashleypoole.co.uk), [Twitter](http://twitter.com/geekypants92) or [by email](mailto:[email protected]).

0 commit comments

Comments
 (0)