Certbot class - nginx_le_shared library

Constructors

Certbot(): factory

Properties

blockedUntil → DateTime: If acquisitions are blocked returns the time at which it will be unblocked. If acquistions are not blocked returns the curren time.
no setter
hashCode → int: The hash code for this object.
no setterinherited
isBlocked → bool: no setter
logfile → String: The certbot log file
no setter
pathToBlockFlag → String: no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

blockAcquisitions() → void: After an unexpected error occurs we block futher acquistion attempts so we don't hit lets encrypt rate limits. Once a block is in place the user must use the cli 'acquire' command or pass in the CERTBOT_IGNORE_BLOCK=true environment variable.
certificates() → List<Certificate?>: Obtain the list of active certificates
clearBlockFlag() → void
delete({required bool wildcard, required String? emailaddress, required String domain, String? hostname}) → void: used by revoke to delete certificates after they have been revoked If we don't do this then the revoked certificates will still be renewed.
deleteInvalidCertificates({required String hostname, required String domain, required bool wildcard, required bool production}) → int: revokes any certificates that are not for the current fqdn and wildcard type.
deployCertificate() → bool: Check that we have valid certificate and deploy it to nginx.
deployCertificatesDirect(String certificateRootPath, {required bool reload, bool revoking = false}) → void
hasExpired(String hostname, String domain) → bool: Checks if the certificate for the given hostname.domain has expired
hasValidCertificate() → bool: true if we have a valid certificate for the given arguments and it has not expired.
isDeployed() → bool: true if we have a valid certificate and it has been deployed
log(String message) → void
logError(String message) → void
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
renew({bool force = false}) → void
revoke({required String? hostname, required String domain, required bool? production, required bool wildcard, required String? emailaddress}) → void: Revokes a certbot certificate.
revokeAll() → void: Revoke all the certificates we have.
scheduleRenews() → void
sendToStdout() → void
toString() → String: A string representation of this object.
inherited
wasIssuedFor({required String? hostname, required String domain, required bool wildcard, required bool production}) → bool: true if if we have a certificate was issued for the given hostname, domain and wildcard type.

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

pathTo → const String: The install creates a virtual python environment for certbot in /opt/certbot so we must run all commands from that directory.