Skip to content

Commit 49754a8

Browse files
committed
Updated the documentation.
1 parent 8dcefb8 commit 49754a8

File tree

4 files changed

+104
-4
lines changed

4 files changed

+104
-4
lines changed

BuildTask/ssl-labs-test/task.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"friendlyName": "SSL Labs Test",
66
"description": "Analyse the SSL configuration of any public web server using the Qualys SSL Labs SSL Server test.",
77
"helpMarkDown": "[More Information](https://github.com/kasunkv/ssl-labs-test-vsts-task)",
8-
"category": "Utility",
8+
"category": "Test",
99
"visibility": [
1010
"Build",
1111
"Release"

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,52 @@
1-
# ssl-labs-test-task
1+
![VSTS Build](https://kasunkodagoda.visualstudio.com/_apis/public/build/definitions/a6819d70-02f9-4711-8ff6-ae44bb52a8d1/36/badge)
2+
3+
# SSL Labs Test Task
4+
Visual Studio Team Services build/release task for running a SSL Labs Assessment on a give hostname powered by **Qualys SSL Labs**.
5+
6+
# Using SSL Labs Test Task
7+
Follow the instructions give below to add and configure the SSL Labs task in your build/release pipeline.
8+
9+
## Add the SSL Labs Task
10+
Install the SSL Labs Task in to your Visual Studio Team Services account and search for the task in the available tasks. The task will also appear in the _Test_ section of the task list. Add it to your build/release pipeline.
11+
12+
![Add Task](https://raw.githubusercontent.com/kasunkv/ssl-labs-test-vsts-task/master/screenshots/01-add-task.PNG)
13+
14+
## Required Configuration
15+
SSL Labs Test task has one required configuration option that must be provided.
16+
17+
![Required Options](https://raw.githubusercontent.com/kasunkv/ssl-labs-test-vsts-task/master/screenshots/02-set-required-hostname.PNG)
18+
19+
### Required Options
20+
* **Hostname to Analyse** : The hostname of the web server to analyse.
21+
22+
### Available Options
23+
* **Execute Fresh Scan** : Set this to make sure a fresh analysis is executed. If not a cached version of the analysis will be taken. Defaults to _false_
24+
* **Publish Analysis Results** : Set this if you want to publish the SSL Labs publicly on their web site. Defaults to _false_
25+
26+
## Verification
27+
This configuration section allows you to configure following certificate verification options.
28+
29+
![Verification Options](https://raw.githubusercontent.com/kasunkv/ssl-labs-test-vsts-task/master/screenshots/03-verifications.PNG)
30+
31+
### Available Options
32+
* **Enable Verifications** : Set this if you want to enable verifications for the SSL Certificate. Supports checking for Certificate Grade for now. Defaults to _false_.
33+
* **Minimum Certificate Grade** : Set this if you want to define a minimum grade for the certificate. The available options are **A+, A, A-, B, C, D, E, F** If empty the value defaults to _A_
34+
35+
36+
## Expiration Alerts
37+
This configuration section allows you to configure following Expiration alert options.
38+
39+
![Expiration Alert Options](https://raw.githubusercontent.com/kasunkv/ssl-labs-test-vsts-task/master/screenshots/04-expiration-alear.PNG)
40+
41+
### Available Options
42+
* **Enable Certificate Expiration Alerts** : Set this if you want to enable certificate expiration alerts. This will give you two options. 1). Fail the build upon expiration 2). Set a variable and its content for later use.
43+
* **Number of Days Certificate Expiration** : Set this to configure the alert to fire when there are defined number of days before the certificate expired.
44+
* **Alert Mode** : Select the mode for the alerts. Either break the build if the expiration fails or set a custom build variable to use later. Available options are **Break Build** and **Set Custom Variable**. The default value is set to _Break Build_
45+
* **Output Variable Name** : The name of the custom output variable you need to set. _Only available when Alert Mode is set to Break Build_
46+
* **Output Variable Content** : The content you need to include in the output variable. _Only available when Alert Mode is set to Break Build_
47+
48+
49+
# Credits
50+
SSL Labs Test Task is powered by [Qualys SSL Labs Assessment API](https://www.ssllabs.com/projects/ssllabs-apis/index.html).
51+
52+
![Qualys SSL Labs](https://www.krabivillas.com/filemanager/userfiles/blog/2016/powered-by-qualys-ssl-labs.png)

overview.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,50 @@
1-
# ssl-labs-test-task
1+
# SSL Labs Test Task
2+
Visual Studio Team Services build/release task for running a SSL Labs Assessment on a give hostname powered by **Qualys SSL Labs**.
3+
4+
# Using SSL Labs Test Task
5+
Follow the instructions give below to add and configure the SSL Labs task in your build/release pipeline.
6+
7+
## Add the SSL Labs Task
8+
Install the SSL Labs Task in to your Visual Studio Team Services account and search for the task in the available tasks. The task will also appear in the _Test_ section of the task list. Add it to your build/release pipeline.
9+
10+
![Add Task](https://raw.githubusercontent.com/kasunkv/ssl-labs-test-vsts-task/master/screenshots/01-add-task.PNG)
11+
12+
## Required Configuration
13+
SSL Labs Test task has one required configuration option that must be provided.
14+
15+
![Required Options](https://raw.githubusercontent.com/kasunkv/ssl-labs-test-vsts-task/master/screenshots/02-set-required-hostname.PNG)
16+
17+
### Required Options
18+
* **Hostname to Analyse** : The hostname of the web server to analyse.
19+
20+
### Available Options
21+
* **Execute Fresh Scan** : Set this to make sure a fresh analysis is executed. If not a cached version of the analysis will be taken. Defaults to _false_
22+
* **Publish Analysis Results** : Set this if you want to publish the SSL Labs publicly on their web site. Defaults to _false_
23+
24+
## Verification
25+
This configuration section allows you to configure following certificate verification options.
26+
27+
![Verification Options](https://raw.githubusercontent.com/kasunkv/ssl-labs-test-vsts-task/master/screenshots/03-verifications.PNG)
28+
29+
### Available Options
30+
* **Enable Verifications** : Set this if you want to enable verifications for the SSL Certificate. Supports checking for Certificate Grade for now. Defaults to _false_.
31+
* **Minimum Certificate Grade** : Set this if you want to define a minimum grade for the certificate. The available options are **A+, A, A-, B, C, D, E, F** If empty the value defaults to _A_
32+
33+
34+
## Expiration Alerts
35+
This configuration section allows you to configure following Expiration alert options.
36+
37+
![Expiration Alert Options](https://raw.githubusercontent.com/kasunkv/ssl-labs-test-vsts-task/master/screenshots/04-expiration-alear.PNG)
38+
39+
### Available Options
40+
* **Enable Certificate Expiration Alerts** : Set this if you want to enable certificate expiration alerts. This will give you two options. 1). Fail the build upon expiration 2). Set a variable and its content for later use.
41+
* **Number of Days Certificate Expiration** : Set this to configure the alert to fire when there are defined number of days before the certificate expired.
42+
* **Alert Mode** : Select the mode for the alerts. Either break the build if the expiration fails or set a custom build variable to use later. Available options are **Break Build** and **Set Custom Variable**. The default value is set to _Break Build_
43+
* **Output Variable Name** : The name of the custom output variable you need to set. _Only available when Alert Mode is set to Break Build_
44+
* **Output Variable Content** : The content you need to include in the output variable. _Only available when Alert Mode is set to Break Build_
45+
46+
47+
# Credits
48+
SSL Labs Test Task is powered by [Qualys SSL Labs Assessment API](https://www.ssllabs.com/projects/ssllabs-apis/index.html).
49+
50+
![Qualys SSL Labs](https://www.krabivillas.com/filemanager/userfiles/blog/2016/powered-by-qualys-ssl-labs.png)

vss-extension.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
}
4949
},
5050
"branding": {
51-
"color": "rgb(74, 74, 74)",
51+
"color": "rgb(130, 27, 27)",
5252
"theme": "dark"
5353
},
5454
"repository": {

0 commit comments

Comments
 (0)