|
1 | | -# ssl-labs-test-task |
| 1 | + |
| 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 | + |
| 13 | + |
| 14 | +## Required Configuration |
| 15 | +SSL Labs Test task has one required configuration option that must be provided. |
| 16 | + |
| 17 | + |
| 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 | + |
| 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 | + |
| 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 | + |
0 commit comments