Let's Encrypt x Certbot
Metadata
- Identifier:
lets_encrypt - Maturity: Production
Categories
- Encryption for Web Applications
Description
Let's Encrypt is a free, automated, and open certificate authority brought to you by the nonprofit Internet Security Research Group (ISRG). Certbot is a free, open source software tool for automatically using Let's Encrypt certificates on manually-administrated websites to enable HTTPS.
Actions
| Identifier | Description | Expected Parameters Keys and Types |
|---|---|---|
Information
| Identifier | Description | Type | Properties | Default Value |
|---|---|---|---|---|
domain | The domain on which the user installs Let's Encrypt | STRING | CONFIGURATION, NON_DEDUCTIBLE, WRITABLE | |
email | The email of the user whom installs Let's Encrypt on the given domain | STRING | CONFIGURATION, NON_DEDUCTIBLE, WRITABLE | |
log_location | Location where Nginx logs messages | STRING | CONFIGURATION, MANDATORY, NON_DEDUCTIBLE, READ_ONLY, AUTO_GENERATED_BEFORE_INSTALL | |
revoke_reason | The reason why Let's Encrypt has been removed. Choose from 'unspecified', 'keycompromise', 'affiliationchanged', 'superseded', 'cessationofoperation', if you wish to change the reason. | STRING | CONFIGURATION, OPTIONAL, WITH_DEFAULT_VALUE, NON_DEDUCTIBLE, WRITABLE | unspecified |
secured_requests | Total number of secured requests | INTEGER | METRIC, READ_ONLY | |
secured_requests_today | Total number of secured requests today | INTEGER | METRIC, READ_ONLY | |
version | Installed version | STRING | METRIC, READ_ONLY |
Logs
| Identifier | Description | Location | Format |
|---|---|---|---|
logs | The logs generated by Let's Encrypt x Certbot for the given domain | LogLocation-dependent | TEXT |
Tests
| Identifier | Description | Type |
|---|---|---|
configuration_file_presence | Checks if the old Nginx configuration file is saved in /opt/mutablesecurity/lets_encrypt. | PRESENCE |
domain_request | Checks if the site exists before trying to generate certificate. | REQUIREMENT |
internet_access | Checks if host has Internet access. | REQUIREMENT |
nginx_active | Checks if Nginx is installed and the service is active. | REQUIREMENT |
request_via_https | Checks if the site is secured with Let's Encrypt. | SECURITY |
ubuntu | Checks if the operating system is Ubuntu. | REQUIREMENT |