This tool is a command-line client for the SSL Labs APIs, designed for automated and/or bulk testing.
If you'd like to contribute, please have a look at the TODO file. For larger work, please get in touch first. For smaller work (there are some TODO comments in the source code), feel free to submit pull requests.
To report a problem, please create a new issue on GitHub: https://github.com/ssllabs/ssllabs-scan/issues Please don't send bug reports to the mailing list.
To discuss the API and the development of the reference client implementation, please join the ssllabs-devel mailing list: https://sourceforge.net/p/ssllabs/mailman/ssllabs-devel/
Before you use this tool please review the terms and conditions, which can be found here: https://www.ssllabs.com/about/terms.html
- Go >= 1.3
SYNOPSIS
ssllabs-scan [options] hostname
ssllabs-scan [options] --hostfile file
OPTIONS
| Option | Default value | Description |
|---|---|---|
| --api | BUILTIN | API entry point, for example https://www.example.com/api/ |
| --verbosity | info | Configure log verbosity: error, info, debug, or trace |
| --quiet | false | Disable status messages (logging) |
| --ignore-mismatch | false | Proceed with assessments on certificate mismatch |
| --json-flat | false | Output results in flattened JSON format |
| --exclude | none | Exclude certain keys from the flattened JSON |
| --include | none | Include only certain keys in the flattened JSON |
| --hostfile | none | File containing hosts to scan (one per line) |
| --usecache | false | If true, accept cached results (if available), else force live scan |
| --grade | false | Output only the hostname: grade |
| --hostcheck | false | If true, host resolution failure will result in a fatal error |
| --elasticsearch | false | If true, the output is pushed to an elasticsearch host |
| --elastic_host | http://127.0.0.1:9200 | The URL of the elasticsearch host or cluster |
| --elastic_index | ssllabs-scan | The name of the elasticsearch index |
| --elastic_user | none | Username to connect to the elasticsearch host |
| --elastic_pwd | none | Password to connect to the elasticsearch host |
| --elastic_mapping | none | If specified, the mapping will be used when creating the elasticsearch index |
Linux/Unix:
export HTTP_PROXY=[http://]host[:port]
Windows:
set HTTP_PROXY=[http://]host[:port]
The rules of Go's ProxyFromEnvironment apply (HTTP_PROXY, HTTPS_PROXY, NO_PROXY, lowercase variants allowed).
A list of libraries and tools that rely on the SSL Labs APIs can be found on the SSL Labs web site: https://www.ssllabs.com/projects/ssllabs-apis/
Docker images for this project are available at: