ACME-PYTHON(1) acme-python ACME-PYTHON(1) NAME acme-python - acme-python Documentation Contents: API DOCUMENTATION Challenges ACME Identifier Validation Challenges. class acme.challenges.Challenge(**kwargs: Any) ACME challenge. TYPES: Dict[str, Type[Challenge]] = {'dns': , 'dns-01': , 'http-01': , 'tls-alpn-01': } Types registered for JSON deserialization classmethod from_json(jobj: Mapping[str, Any]) -> GenericChallenge | UnrecognizedChallenge Deserialize ACME object from valid JSON object. Raises josepy.errors.UnrecognizedTypeError -- if type of the ACME object has not been registered. class acme.challenges.ChallengeResponse(**kwargs: Any) ACME challenge response. TYPES: Dict[str, Type[ChallengeResponse]] = {'dns': , 'dns-01': , 'http-01': , 'tls-alpn-01': } Types registered for JSON deserialization to_partial_json() -> Dict[str, Any] Get JSON serializable object. Returns Serializable JSON object representing ACME typed object. validate() will almost certainly not work, due to reasons explained in josepy.interfaces.IJSONSerializable. Return type dict class acme.challenges.UnrecognizedChallenge(jobj: Mapping[str, Any]) Unrecognized challenge. ACME specification defines a generic framework for challenges and defines some standard challenges that are implemented in this module. However, other implementations (including peers) might define additional challenge types, which should be ignored if unrecognized. Variables jobj -- Original JSON decoded object. to_partial_json() -> Dict[str, Any] Get JSON serializable object. Returns Serializable JSON object representing ACME typed object. validate() will almost certainly not work, due to reasons explained in josepy.interfaces.IJSONSerializable. Return type dict classmethod from_json(jobj: Mapping[str, Any]) -> UnrecognizedChallenge Deserialize ACME object from valid JSON object. Raises josepy.errors.UnrecognizedTypeError -- if type of the ACME object has not been registered. class acme.challenges.KeyAuthorizationChallengeResponse(**kwargs: Any) Response to Challenges based on Key Authorization. Parameters key_authorization (str) -- verify(chall: KeyAuthorizationChallenge, account_public_key: JWK) -> bool Verify the key authorization. Parameters o chall (KeyAuthorization) -- Challenge that corresponds to this response. o account_public_key (JWK) -- Returns True iff verification of the key authorization was successful. Return type bool to_partial_json() -> Dict[str, Any] Get JSON serializable object. Returns Serializable JSON object representing ACME typed object. validate() will almost certainly not work, due to reasons explained in josepy.interfaces.IJSONSerializable. Return type dict class acme.challenges.KeyAuthorizationChallenge(**kwargs: Any) Challenge based on Key Authorization. Parameters o response_cls -- Subclass of KeyAuthorizationChallengeResponse that will be used to generate response. o typ (str) -- type of the challenge typ: str = NotImplemented Type of the object. Subclasses must override. key_authorization(account_key: JWK) -> str Generate Key Authorization. Parameters account_key (JWK) -- Rtype str response(account_key: JWK) -> KeyAuthorizationChallengeResponse Generate response to the challenge. Parameters account_key (JWK) -- Returns Response (initialized response_cls) to the challenge. Return type KeyAuthorizationChallengeResponse abstract validation(account_key: JWK, **kwargs: Any) -> Any Generate validation for the challenge. Subclasses must implement this method, but they are likely to return completely different data structures, depending on what's necessary to complete the challenge. Interpretation of that return value must be known to the caller. Parameters account_key (JWK) -- Returns Challenge-specific validation. response_and_validation(account_key: JWK, *args: Any, **kwargs: Any) -> Tuple[KeyAuthorizationChallengeResponse, Any] Generate response and validation. Convenience function that return results of response and validation. Parameters account_key (JWK) -- Return type tuple class acme.challenges.DNS01Response(**kwargs: Any) ACME dns-01 challenge response. typ: str = 'dns-01' Type of the object. Subclasses must override. simple_verify(chall: DNS01, domain: str, account_public_key: JWK) -> bool Simple verify. This method no longer checks DNS records and is a simple wrapper around KeyAuthorizationChallengeResponse.verify. Parameters o chall (challenges.DNS01) -- Corresponding challenge. o domain (str) -- Domain name being verified. o account_public_key (JWK) -- Public key for the key pair being authorized. Returns True iff verification of the key authorization was successful. Return type bool class acme.challenges.DNS01(**kwargs: Any) ACME dns-01 challenge. response_cls alias of DNS01Response typ: str = 'dns-01' Type of the object. Subclasses must override. LABEL = '_acme-challenge' Label clients prepend to the domain name being validated. validation(account_key: JWK, **unused_kwargs: Any) -> str Generate validation. Parameters account_key (JWK) -- Return type str validation_domain_name(name: str) -> str Domain name for TXT validation record. Parameters name (str) -- Domain name being validated. Return type str class acme.challenges.HTTP01Response(**kwargs: Any) ACME http-01 challenge response. typ: str = 'http-01' Type of the object. Subclasses must override. PORT = 80 Verification port as defined by the protocol. You can override it (e.g. for testing) by passing port to simple_verify. WHITESPACE_CUTSET = '\n\r\t ' Whitespace characters which should be ignored at the end of the body. simple_verify(chall: HTTP01, domain: str, account_public_key: JWK, port: int | None = None, timeout: int = 30) -> bool Simple verify. Parameters o chall (challenges.SimpleHTTP) -- Corresponding challenge. o domain (str) -- Domain name being verified. o account_public_key (JWK) -- Public key for the key pair being authorized. o port (int) -- Port used in the validation. o timeout (int) -- Timeout in seconds. Returns True iff validation with the files currently served by the HTTP server is successful. Return type bool class acme.challenges.HTTP01(**kwargs: Any) ACME http-01 challenge. response_cls alias of HTTP01Response typ: str = 'http-01' Type of the object. Subclasses must override. URI_ROOT_PATH = '.well-known/acme-challenge' URI root path for the server provisioned resource. property path: str Path (starting with '/') for provisioned resource. Return type str uri(domain: str) -> str Create an URI to the provisioned resource. Forms an URI to the HTTPS server provisioned resource (containing token). Parameters domain (str) -- Domain name being verified. Return type str validation(account_key: JWK, **unused_kwargs: Any) -> str Generate validation. Parameters account_key (JWK) -- Return type str class acme.challenges.TLSALPN01Response(**kwargs: Any) ACME tls-alpn-01 challenge response. typ: str = 'tls-alpn-01' Type of the object. Subclasses must override. PORT = 443 Verification port as defined by the protocol. You can override it (e.g. for testing) by passing port to simple_verify. property h: bytes Hash value stored in challenge certificate gen_cert(domain: str, key: PKey | None = None, bits: int = 2048) -> Tuple[X509, PKey] Generate tls-alpn-01 certificate. Parameters o domain (str) -- Domain verified by the challenge. o key (OpenSSL.crypto.PKey) -- Optional private key used in certificate generation. If not provided (None), then fresh key will be generated. o bits (int) -- Number of bits for newly generated key. Return type tuple of OpenSSL.crypto.X509 and OpenSSL.crypto.PKey probe_cert(domain: str, host: str | None = None, port: int | None = None) -> X509 Probe tls-alpn-01 challenge certificate. Parameters o domain (str) -- domain being validated, required. o host (str) -- IP address used to probe the certificate. o port (int) -- Port used to probe the certificate. verify_cert(domain: str, cert: X509) -> bool Verify tls-alpn-01 challenge certificate. Parameters o domain (str) -- Domain name being validated. o cert (OpensSSL.crypto.X509) -- Challenge certificate. Returns Whether the certificate was successfully verified. Return type bool simple_verify(chall: TLSALPN01, domain: str, account_public_key: JWK, cert: X509 | None = None, host: str | None = None, port: int | None = None) -> bool Simple verify. Verify validation using account_public_key, optionally probe tls-alpn-01 certificate and check using verify_cert. Parameters o chall (.challenges.TLSALPN01) -- Corresponding challenge. o domain (str) -- Domain name being validated. o account_public_key (JWK) -- o cert (OpenSSL.crypto.X509) -- Optional certificate. If not provided (None) certificate will be retrieved using probe_cert. o host (string) -- IP address used to probe the certificate. o port (int) -- Port used to probe the certificate. Returns True if and only if client's control of the domain has been verified. Return type bool class acme.challenges.TLSALPN01(**kwargs: Any) ACME tls-alpn-01 challenge. response_cls alias of TLSALPN01Response typ: str = 'tls-alpn-01' Type of the object. Subclasses must override. validation(account_key: JWK, **kwargs: Any) -> Tuple[X509, PKey] Generate validation. Parameters o account_key (JWK) -- o domain (str) -- Domain verified by the challenge. o cert_key (OpenSSL.crypto.PKey) -- Optional private key used in certificate generation. If not provided (None), then fresh key will be generated. Return type tuple of OpenSSL.crypto.X509 and OpenSSL.crypto.PKey static is_supported() -> bool Check if TLS-ALPN-01 challenge is supported on this machine. This implies that a recent version of OpenSSL is installed (>= 1.0.2), or a recent cryptography version shipped with the OpenSSL library is installed. Returns True if TLS-ALPN-01 is supported on this machine, False otherwise. Return type bool class acme.challenges.DNS(**kwargs: Any) ACME "dns" challenge. typ: str = 'dns' Type of the object. Subclasses must override. LABEL = '_acme-challenge' Label clients prepend to the domain name being validated. gen_validation(account_key: JWK, alg: JWASignature = RS256, **kwargs: Any) -> JWS Generate validation. Parameters o account_key (.JWK) -- Private account key. o alg (.JWA) -- Returns This challenge wrapped in JWS Return type .JWS check_validation(validation: JWS, account_public_key: JWK) -> bool Check validation. Parameters o validation (JWS) -- o account_public_key (JWK) -- Return type bool gen_response(account_key: JWK, **kwargs: Any) -> DNSResponse Generate response. Parameters o account_key (.JWK) -- Private account key. o alg (.JWA) -- Return type DNSResponse validation_domain_name(name: str) -> str Domain name for TXT validation record. Parameters name (str) -- Domain name being validated. class acme.challenges.DNSResponse(**kwargs: Any) ACME "dns" challenge response. Parameters validation (JWS) -- typ: str = 'dns' Type of the object. Subclasses must override. check_validation(chall: DNS, account_public_key: JWK) -> bool Check validation. Parameters o chall (challenges.DNS) -- o account_public_key (JWK) -- Return type bool Client ACME client API. class acme.client.ClientV2(directory: Directory, net: ClientNetwork) ACME client for a v2 API. Variables o directory (messages.Directory) -- o net (.ClientNetwork) -- Client network. new_account(new_account: NewRegistration) -> RegistrationResource Register. Parameters new_account (.NewRegistration) -- Raises .ConflictError -- in case the account already exists Returns Registration Resource. Return type RegistrationResource query_registration(regr: RegistrationResource) -> RegistrationResource Query server about registration. Parameters regr (messages.RegistrationResource) -- Existing Registration Resource. update_registration(regr: RegistrationResource, update: Registration | None = None) -> RegistrationResource Update registration. Parameters o regr (messages.RegistrationResource) -- Registration Resource. o update (messages.Registration) -- Updated body of the resource. If not provided, body will be taken from regr. Returns Updated Registration Resource. Return type RegistrationResource new_order(csr_pem: bytes) -> OrderResource Request a new Order object from the server. Parameters csr_pem (bytes) -- A CSR in PEM format. Returns The newly created order. Return type OrderResource poll(authzr: AuthorizationResource) -> Tuple[AuthorizationResource, Response] Poll Authorization Resource for status. Parameters authzr (AuthorizationResource) -- Authorization Resource Returns Updated Authorization Resource and HTTP response. Return type (AuthorizationResource, requests.Response) poll_and_finalize(orderr: OrderResource, deadline: datetime | None = None) -> OrderResource Poll authorizations and finalize the order. If no deadline is provided, this method will timeout after 90 seconds. Parameters o orderr (messages.OrderResource) -- order to finalize o deadline (datetime.datetime) -- when to stop polling and timeout Returns finalized order Return type messages.OrderResource poll_authorizations(orderr: OrderResource, deadline: datetime) -> OrderResource Poll Order Resource for status. begin_finalization(orderr: OrderResource) -> OrderResource Start the process of finalizing an order. Parameters o orderr (messages.OrderResource) -- order to finalize o deadline (datetime.datetime) -- when to stop polling and timeout Returns updated order Return type messages.OrderResource poll_finalization(orderr: OrderResource, deadline: datetime, fetch_alternative_chains: bool = False) -> OrderResource Poll an order that has been finalized for its status. If it becomes valid, obtain the certificate. Returns finalized order (with certificate) Return type messages.OrderResource finalize_order(orderr: OrderResource, deadline: datetime, fetch_alternative_chains: bool = False) -> OrderResource Finalize an order and obtain a certificate. Parameters o orderr (messages.OrderResource) -- order to finalize o deadline (datetime.datetime) -- when to stop polling and timeout o fetch_alternative_chains (bool) -- whether to also fetch alternative certificate chains Returns finalized order Return type messages.OrderResource revoke(cert: ComparableX509, rsn: int) -> None Revoke certificate. Parameters o cert (.ComparableX509) -- OpenSSL.crypto.X509 wrapped in ComparableX509 o rsn (int) -- Reason code for certificate revocation. Raises .ClientError -- If revocation is unsuccessful. external_account_required() -> bool Checks if ACME server requires External Account Binding authentication. classmethod get_directory(url: str, net: ClientNetwork) -> Directory Retrieves the ACME directory (RFC 8555 section 7.1.1) from the ACME server. :param str url: the URL where the ACME directory is available :param ClientNetwork net: the ClientNetwork to use to make the request Returns the ACME directory object Return type messages.Directory deactivate_registration(regr: RegistrationResource) -> RegistrationResource Deactivate registration. Parameters regr (messages.RegistrationResource) -- The Registration Resource to be deactivated. Returns The Registration resource that was deactivated. Return type RegistrationResource deactivate_authorization(authzr: AuthorizationResource) -> AuthorizationResource Deactivate authorization. Parameters authzr (messages.AuthorizationResource) -- The Authorization resource to be deactivated. Returns The Authorization resource that was deactivated. Return type AuthorizationResource answer_challenge(challb: ChallengeBody, response: ChallengeResponse) -> ChallengeResource Answer challenge. Parameters o challb (ChallengeBody) -- Challenge Resource body. o response (challenges.ChallengeResponse) -- Corresponding Challenge response Returns Challenge Resource with updated body. Return type ChallengeResource Raises .UnexpectedUpdate -- classmethod retry_after(response: Response, default: int) -> datetime Compute next poll time based on response Retry-After header. Handles integers and various datestring formats per https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.37 Parameters o response (requests.Response) -- Response from poll. o default (int) -- Default value (in seconds), used when Retry-After header is not present or invalid. Returns Time point when next poll should be performed. Return type datetime.datetime class acme.client.ClientNetwork(key: JWK, account: RegistrationResource | None = None, alg: JWASignature = RS256, verify_ssl: bool = True, user_agent: str = 'acme-python', timeout: int = 45) Wrapper around requests that signs POSTs for authentication. Also adds user agent, and handles Content-Type. REPLAY_NONCE_HEADER = 'Replay-Nonce' Initialize. Parameters o key (josepy.JWK) -- Account private key o account (messages.RegistrationResource) -- Account object. Required if you are planning to use .post() for anything other than creating a new account; may be set later after registering. o alg (josepy.JWASignature) -- Algorithm to use in signing JWS. o verify_ssl (bool) -- Whether to verify certificates on SSL connections. o user_agent (str) -- String to send as User-Agent header. o timeout (int) -- Timeout for requests. head(*args: Any, **kwargs: Any) -> Response Send HEAD request without checking the response. Note, that _check_response is not called, as it is expected that status code other than successfully 2xx will be returned, or messages2.Error will be raised by the server. get(url: str, content_type: str = 'application/json', **kwargs: Any) -> Response Send GET request and check response. post(*args: Any, **kwargs: Any) -> Response POST object wrapped in JWS and check response. If the server responded with a badNonce error, the request will be retried once. Errors ACME errors. exception acme.errors.Error Generic ACME error. exception acme.errors.DependencyError Dependency error exception acme.errors.SchemaValidationError JSON schema ACME object validation error. exception acme.errors.ClientError Network error. exception acme.errors.UnexpectedUpdate Unexpected update error. exception acme.errors.NonceError Server response nonce error. exception acme.errors.BadNonce(nonce: str, error: Exception, *args: Any) Bad nonce error. exception acme.errors.MissingNonce(response: Response, *args: Any) Missing nonce error. According to the specification an "ACME server MUST include an Replay-Nonce header field in each successful response to a POST it provides to a client (...)". Variables ~.response (requests.Response) -- HTTP Response exception acme.errors.PollError(exhausted: Set[messages.AuthorizationResource], updated: Mapping[messages.AuthorizationResource, messages.AuthorizationResource]) Generic error when polling for authorization fails. This might be caused by either timeout (exhausted will be non-empty) or by some authorization being invalid. Variables o exhausted -- Set of AuthorizationResource that didn't finish within max allowed attempts. o updated -- Mapping from original AuthorizationResource to the most recently updated one property timeout: bool Was the error caused by timeout? exception acme.errors.ValidationError(failed_authzrs: List[messages.AuthorizationResource]) Error for authorization failures. Contains a list of authorization resources, each of which is invalid and should have an error field. exception acme.errors.TimeoutError Error for when polling an authorization or an order times out. exception acme.errors.IssuanceError(error: messages.Error) Error sent by the server after requesting issuance of a certificate. exception acme.errors.ConflictError(location: str) Error for when the server returns a 409 (Conflict) HTTP status. In the version of ACME implemented by Boulder, this is used to find an account if you only have the private key, but don't know the account URL. Also used in V2 of the ACME client for the same purpose. exception acme.errors.WildcardUnsupportedError Error for when a wildcard is requested but is unsupported by ACME CA. Fields ACME JSON fields. class acme.fields.Fixed(json_name: str, value: Any) Fixed field. decode(value: Any) -> Any Decode a value, optionally with context JSON object. encode(value: Any) -> Any Encode a value, optionally with context JSON object. class acme.fields.RFC3339Field(json_name: str, default: Any = None, omitempty: bool = False, decoder: Callable[[Any], Any] | None = None, encoder: Callable[[Any], Any] | None = None) RFC3339 field encoder/decoder. Handles decoding/encoding between RFC3339 strings and aware (not naive) datetime.datetime objects (e.g. datetime.datetime.now(pytz.UTC)). classmethod default_encoder(value: datetime) -> str Default (passthrough) encoder. classmethod default_decoder(value: str) -> datetime Default decoder. Recursively deserialize into immutable types ( josepy.util.frozendict instead of dict(), tuple() instead of list()). acme.fields.fixed(json_name: str, value: Any) -> Any Generates a type-friendly Fixed field. acme.fields.rfc3339(json_name: str, omitempty: bool = False) -> Any Generates a type-friendly RFC3339 field. JOSE The acme.jose module was moved to its own package "josepy". Please refer to its documentation there. Messages ACME protocol messages. acme.messages.is_acme_error(err: BaseException) -> bool Check if argument is an ACME error. class acme.messages.IdentifierType(name: str) ACME identifier type. class acme.messages.Identifier(**kwargs: Any) ACME identifier. Variables o typ (IdentifierType) -- o value (str) -- exception acme.messages.Error(**kwargs: Any) ACME error. https://datatracker.ietf.org/doc/html/rfc7807 Note: Although Error inherits from JSONObjectWithFields, which is immutable, we add mutability for Error to comply with the Python exception API. Variables o typ (str) -- o title (str) -- o detail (str) -- o identifier (Identifier) -- o subproblems (tuple) -- An array of ACME Errors which may be present when the CA returns multiple errors related to the same request, tuple of Error. classmethod with_code(code: str, **kwargs: Any) -> Error Create an Error instance with an ACME Error code. Str code An ACME error code, like 'dnssec'. Kwargs kwargs to pass to Error. property description: str | None Hardcoded error description based on its type. Returns Description if standard ACME error or None. Return type str property code: str | None ACME error code. Basically self.typ without the ERROR_PREFIX. Returns error code if standard ACME code or None. Return type str class acme.messages.Status(name: str) ACME "status" field. class acme.messages.Directory(jobj: Mapping[str, Any]) Directory. Directory resources must be accessed by the exact field name in RFC8555 (section 9.7.5). class Meta(**kwargs: Any) Directory Meta. property terms_of_service: str URL for the CA TOS to_partial_json() -> Dict[str, Any] Partially serialize. Following the example, partial serialization means the following: assert isinstance(Bar().to_partial_json()[0], Foo) assert isinstance(Bar().to_partial_json()[1], Foo) # in particular... assert Bar().to_partial_json() != ['foo', 'foo'] Raises josepy.errors.SerializationError -- in case of any serialization error. Returns Partially serializable object. classmethod from_json(jobj: MutableMapping[str, Any]) -> Directory Deserialize a decoded JSON document. Parameters jobj -- Python object, composed of only other basic data types, as decoded from JSON document. Not necessarily dict (as decoded from "JSON object" document). Raises josepy.errors.DeserializationError -- if decoding was unsuccessful, e.g. in case of unparseable X509 certificate, or wrong padding in JOSE base64 encoded string, etc. class acme.messages.Resource(**kwargs: Any) ACME Resource. Variables body (acme.messages.ResourceBody) -- Resource body. class acme.messages.ResourceWithURI(**kwargs: Any) ACME Resource with URI. Variables uri (str) -- Location of the resource. class acme.messages.ResourceBody(**kwargs: Any) ACME Resource Body. class acme.messages.ExternalAccountBinding ACME External Account Binding classmethod from_data(account_public_key: JWK, kid: str, hmac_key: str, directory: Directory) -> Dict[str, Any] Create External Account Binding Resource from contact details, kid and hmac. class acme.messages.Registration(**kwargs: Any) Registration Resource Body. Variables o key (jose.JWK) -- Public key. o contact (tuple) -- Contact information following ACME spec, tuple of str. o agreement (str) -- classmethod from_data(phone: str | None = None, email: str | None = None, external_account_binding: Dict[str, Any] | None = None, **kwargs: Any) -> GenericRegistration Create registration resource from contact details. The contact keyword being passed to a Registration object is meaningful, so this function represents empty iterables in its kwargs by passing on an empty tuple. to_partial_json() -> Dict[str, Any] Modify josepy.JSONDeserializable.to_partial_json() fields_to_partial_json() -> Dict[str, Any] Modify josepy.JSONObjectWithFields.fields_to_partial_json() property phones: Tuple[str, ...] All phones found in the contact field. property emails: Tuple[str, ...] All emails found in the contact field. class acme.messages.NewRegistration(**kwargs: Any) New registration. class acme.messages.UpdateRegistration(**kwargs: Any) Update registration. class acme.messages.RegistrationResource(**kwargs: Any) Registration Resource. Variables o body (acme.messages.Registration) -- o new_authzr_uri (str) -- Deprecated. Do not use. o terms_of_service (str) -- URL for the CA TOS. class acme.messages.ChallengeBody(**kwargs: Any) Challenge Resource Body. Variables o acme.challenges.Challenge -- Wrapped challenge. Conveniently, all challenge fields are proxied, i.e. you can call challb.x to get challb.chall.x contents. o status (acme.messages.Status) -- o validated (datetime.datetime) -- o error (messages.Error) -- encode(name: str) -> Any Encode a single field. Parameters name (str) -- Name of the field to be encoded. Raises o errors.SerializationError -- if field cannot be serialized o errors.Error -- if field could not be found to_partial_json() -> Dict[str, Any] Partially serialize. Following the example, partial serialization means the following: assert isinstance(Bar().to_partial_json()[0], Foo) assert isinstance(Bar().to_partial_json()[1], Foo) # in particular... assert Bar().to_partial_json() != ['foo', 'foo'] Raises josepy.errors.SerializationError -- in case of any serialization error. Returns Partially serializable object. classmethod fields_from_json(jobj: Mapping[str, Any]) -> Dict[str, Any] Deserialize fields from JSON. property uri: str The URL of this challenge. class acme.messages.ChallengeResource(**kwargs: Any) Challenge Resource. Variables o body (acme.messages.ChallengeBody) -- o authzr_uri (str) -- URI found in the 'up' Link header. property uri: str The URL of the challenge body. class acme.messages.Authorization(**kwargs: Any) Authorization Resource Body. Variables o identifier (acme.messages.Identifier) -- o challenges (list) -- list of ChallengeBody o status (acme.messages.Status) -- o expires (datetime.datetime) -- class acme.messages.NewAuthorization(**kwargs: Any) New authorization. class acme.messages.UpdateAuthorization(**kwargs: Any) Update authorization. class acme.messages.AuthorizationResource(**kwargs: Any) Authorization Resource. Variables o body (acme.messages.Authorization) -- o new_cert_uri (str) -- Deprecated. Do not use. class acme.messages.CertificateRequest(**kwargs: Any) ACME newOrder request. Variables csr (jose.ComparableX509) -- OpenSSL.crypto.X509Req wrapped in ComparableX509 class acme.messages.CertificateResource(**kwargs: Any) Certificate Resource. Variables o body (josepy.util.ComparableX509) -- OpenSSL.crypto.X509 wrapped in ComparableX509 o cert_chain_uri (str) -- URI found in the 'up' Link header o authzrs (tuple) -- tuple of AuthorizationResource. class acme.messages.Revocation(**kwargs: Any) Revocation message. Variables certificate (jose.ComparableX509) -- OpenSSL.crypto.X509 wrapped in jose.ComparableX509 class acme.messages.Order(**kwargs: Any) Order Resource Body. Variables o identifiers (list of Identifier) -- List of identifiers for the certificate. o status (acme.messages.Status) -- o authorizations (list of str) -- URLs of authorizations. o certificate (str) -- URL to download certificate as a fullchain PEM. o finalize (str) -- URL to POST to to request issuance once all authorizations have "valid" status. o expires (datetime.datetime) -- When the order expires. o error (Error) -- Any error that occurred during finalization, if applicable. class acme.messages.OrderResource(**kwargs: Any) Order Resource. Variables o body (acme.messages.Order) -- o csr_pem (bytes) -- The CSR this Order will be finalized with. o authorizations (list of acme.messages.AuthorizationResource) -- Fully-fetched AuthorizationResource objects. o fullchain_pem (str) -- The fetched contents of the certificate URL produced once the order was finalized, if it's present. o alternative_fullchains_pem (list of str) -- The fetched contents of alternative certificate chain URLs produced once the order was finalized, if present and requested during finalization. class acme.messages.NewOrder(**kwargs: Any) New order. Standalone Support for standalone client challenge solvers. class acme.standalone.TLSServer(*args: Any, **kwargs: Any) Generic TLS Server. server_bind() -> None Called by constructor to bind the socket. May be overridden. class acme.standalone.ACMEServerMixin ACME server common settings mixin. class acme.standalone.BaseDualNetworkedServers(ServerClass: Type[TCPServer], server_address: Tuple[str, int], *remaining_args: Any, **kwargs: Any) Base class for a pair of IPv6 and IPv4 servers that tries to do everything it's asked for both servers, but where failures in one server don't affect the other. If two servers are instantiated, they will serve on the same port. serve_forever() -> None Wraps socketserver.TCPServer.serve_forever getsocknames() -> List[Tuple[str, int]] Wraps socketserver.TCPServer.socket.getsockname shutdown_and_server_close() -> None Wraps socketserver.TCPServer.shutdown, socketserver.TCPServer.server_close, and threading.Thread.join class acme.standalone.TLSALPN01Server(server_address: Tuple[str, int], certs: List[Tuple[PKey, X509]], challenge_certs: Mapping[bytes, Tuple[PKey, X509]], ipv6: bool = False) TLSALPN01 Server. class acme.standalone.HTTPServer(*args: Any, **kwargs: Any) Generic HTTP Server. class acme.standalone.HTTP01Server(server_address: Tuple[str, int], resources: Set[HTTP01], ipv6: bool = False, timeout: int = 30) HTTP01 Server. class acme.standalone.HTTP01DualNetworkedServers(*args: Any, **kwargs: Any) HTTP01Server Wrapper. Tries everything for both. Failures for one don't affect the other. class acme.standalone.HTTP01RequestHandler(*args: Any, **kwargs: Any) HTTP01 challenge handler. Adheres to the stdlib's socketserver.BaseRequestHandler interface. Variables simple_http_resources (set) -- A set of HTTP01Resource objects. TODO: better name? class HTTP01Resource(chall, response, validation) chall Alias for field number 0 response Alias for field number 1 validation Alias for field number 2 property timeout: int The default timeout this server should apply to requests. :return: timeout to apply :rtype: int log_message(format: str, *args: Any) -> None Log arbitrary message. handle() -> None Handle request. handle_index() -> None Handle index page. handle_404() -> None Handler 404 Not Found errors. handle_simple_http_resource() -> None Handle HTTP01 provisioned resources. classmethod partial_init(simple_http_resources: Set[HTTP01], timeout: int) -> partial[HTTP01RequestHandler] Partially initialize this handler. This is useful because socketserver.BaseServer takes uninitialized handler and initializes it with the current request. ACME protocol implementation. This module is an implementation of the ACME protocol. o Index o Module Index o Search Page AUTHOR Let's Encrypt Project COPYRIGHT 2024, Let's Encrypt Project 0 April 6, 2024 ACME-PYTHON(1)