Skip to main content

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

IdentifierDescriptionExpected Parameters Keys and Types
No entry yet

Information

IdentifierDescriptionTypePropertiesDefault Value
domainThe domain on which the user installs Let's EncryptSTRINGCONFIGURATION, NON_DEDUCTIBLE, WRITABLE
emailThe email of the user whom installs Let's Encrypt on the given domainSTRINGCONFIGURATION, NON_DEDUCTIBLE, WRITABLE
log_locationLocation where Nginx logs messagesSTRINGCONFIGURATION, MANDATORY, NON_DEDUCTIBLE, READ_ONLY, AUTO_GENERATED_BEFORE_INSTALL
revoke_reasonThe reason why Let's Encrypt has been removed. Choose from 'unspecified', 'keycompromise', 'affiliationchanged', 'superseded', 'cessationofoperation', if you wish to change the reason.STRINGCONFIGURATION, OPTIONAL, WITH_DEFAULT_VALUE, NON_DEDUCTIBLE, WRITABLEunspecified
secured_requestsTotal number of secured requestsINTEGERMETRIC, READ_ONLY
secured_requests_todayTotal number of secured requests todayINTEGERMETRIC, READ_ONLY
versionInstalled versionSTRINGMETRIC, READ_ONLY

Logs

IdentifierDescriptionLocationFormat
logsThe logs generated by Let's Encrypt x Certbot for the given domainLogLocation-dependentTEXT

Tests

IdentifierDescriptionType
configuration_file_presenceChecks if the old Nginx configuration file is saved in /opt/mutablesecurity/lets_encrypt.PRESENCE
domain_requestChecks if the site exists before trying to generate certificate.REQUIREMENT
internet_accessChecks if host has Internet access.REQUIREMENT
nginx_activeChecks if Nginx is installed and the service is active.REQUIREMENT
request_via_httpsChecks if the site is secured with Let's Encrypt.SECURITY
ubuntuChecks if the operating system is Ubuntu.REQUIREMENT

References