Messages¶
ACME protocol messages.
- exception acme.messages.Error(**kwargs: Any)[source]¶
ACME error.
https://tools.ietf.org/html/draft-ietf-appsawg-http-problem-00
- Variables
typ (unicode) –
title (unicode) –
detail (unicode) –
- classmethod with_code(code: str, **kwargs: Any) acme.messages.Error [source]¶
Create an Error instance with an ACME Error code.
- Unicode code
An ACME error code, like ‘dnssec’.
- Kwargs
kwargs to pass to Error.
- property description: Optional[str]¶
Hardcoded error description based on its type.
- Returns
Description if standard ACME error or
None
.- Return type
unicode
- property code: Optional[str]¶
ACME error code.
Basically self.typ without the ERROR_PREFIX.
- Returns
error code if standard ACME code or
None
.- Return type
unicode
- class acme.messages.Identifier(**kwargs: Any)[source]¶
ACME identifier.
- Variables
typ (IdentifierType) –
value (unicode) –
- class acme.messages.Directory(jobj: Mapping[str, Any])[source]¶
Directory.
- class Meta(**kwargs: Any)[source]¶
Directory Meta.
- property terms_of_service: str¶
URL for the CA TOS
- classmethod register(resource_body_cls: Type[acme.messages.Directory]) Type[acme.messages.Directory] [source]¶
Register resource.
- to_partial_json() Dict[str, Any] [source]¶
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.
- class acme.messages.Resource(**kwargs: Any)[source]¶
ACME Resource.
- Variables
body (acme.messages.ResourceBody) – Resource body.
- class acme.messages.ResourceWithURI(**kwargs: Any)[source]¶
ACME Resource with URI.
- Variables
uri (unicode) – Location of the resource.
- class acme.messages.ExternalAccountBinding[source]¶
ACME External Account Binding
- classmethod from_data(account_public_key: josepy.jwk.JWK, kid: str, hmac_key: str, directory: acme.messages.Directory) Dict[str, Any] [source]¶
Create External Account Binding Resource from contact details, kid and hmac.
- class acme.messages.Registration(**kwargs: Any)[source]¶
Registration Resource Body.
- Variables
key (josepy.jwk.JWK) – Public key.
contact (tuple) – Contact information following ACME spec,
tuple
ofunicode
.agreement (unicode) –
- classmethod from_data(phone: Optional[str] = None, email: Optional[str] = None, external_account_binding: Optional[acme.messages.ExternalAccountBinding] = None, **kwargs: Any) acme.messages.Registration [source]¶
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 emptytuple
.
- fields_to_partial_json() Dict[str, Any] [source]¶
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.RegistrationResource(**kwargs: Any)[source]¶
Registration Resource.
- Variables
body (acme.messages.Registration) –
new_authzr_uri (unicode) – Deprecated. Do not use.
terms_of_service (unicode) – URL for the CA TOS.
- class acme.messages.ChallengeBody(**kwargs: Any)[source]¶
Challenge Resource Body.
- Variables
acme.challenges.Challenge – Wrapped challenge. Conveniently, all challenge fields are proxied, i.e. you can call
challb.x
to getchallb.chall.x
contents.status (acme.messages.Status) –
validated (datetime.datetime) –
error (messages.Error) –
- encode(name: str) Any [source]¶
Encode a single field.
- Parameters
name (str) – Name of the field to be encoded.
- Raises
errors.SerializationError – if field cannot be serialized
errors.Error – if field could not be found
- to_partial_json() Dict[str, Any] [source]¶
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.
- property uri: str¶
The URL of this challenge.
- class acme.messages.ChallengeResource(**kwargs: Any)[source]¶
Challenge Resource.
- Variables
body (acme.messages.ChallengeBody) –
authzr_uri (unicode) – URI found in the ‘up’
Link
header.
- property uri: str¶
The URL of the challenge body.
- class acme.messages.Authorization(**kwargs: Any)[source]¶
Authorization Resource Body.
- Variables
identifier (acme.messages.Identifier) –
challenges (list) –
list
ofChallengeBody
combinations (tuple) – Challenge combinations (
tuple
oftuple
ofint
, as opposed tolist
oflist
from the spec).status (acme.messages.Status) –
expires (datetime.datetime) –
- property resolved_combinations: Tuple[Tuple[Dict[str, Any], ...], ...]¶
Combinations with challenges instead of indices.
- class acme.messages.AuthorizationResource(**kwargs: Any)[source]¶
Authorization Resource.
- Variables
body (acme.messages.Authorization) –
new_cert_uri (unicode) – Deprecated. Do not use.
- class acme.messages.CertificateRequest(**kwargs: Any)[source]¶
ACME new-cert request.
- Variables
csr (josepy.util.ComparableX509) –
OpenSSL.crypto.X509Req
wrapped inComparableX509
- class acme.messages.CertificateResource(**kwargs: Any)[source]¶
Certificate Resource.
- Variables
body (josepy.util.ComparableX509) –
OpenSSL.crypto.X509
wrapped inComparableX509
cert_chain_uri (unicode) – URI found in the ‘up’
Link
headerauthzrs (tuple) –
tuple
ofAuthorizationResource
.
- class acme.messages.Revocation(**kwargs: Any)[source]¶
Revocation message.
- Variables
certificate (ComparableX509) –
OpenSSL.crypto.X509
wrapped inComparableX509
- class acme.messages.Order(**kwargs: Any)[source]¶
Order Resource Body.
- Variables
identifiers (
list
ofIdentifier
) – List of identifiers for the certificate.status (acme.messages.Status) –
authorizations (
list
ofstr
) – URLs of authorizations.certificate (str) – URL to download certificate as a fullchain PEM.
finalize (str) – URL to POST to to request issuance once all authorizations have “valid” status.
expires (datetime.datetime) – When the order expires.
error (Error) – Any error that occurred during finalization, if applicable.
- class acme.messages.OrderResource(**kwargs: Any)[source]¶
Order Resource.
- Variables
body (acme.messages.Order) –
csr_pem (str) – The CSR this Order will be finalized with.
authorizations (
list
ofacme.messages.AuthorizationResource
) – Fully-fetched AuthorizationResource objects.fullchain_pem (str) – The fetched contents of the certificate URL produced once the order was finalized, if it’s present.
alternative_fullchains_pem (
list
ofstr
) – The fetched contents of alternative certificate chain URLs produced once the order was finalized, if present and requested during finalization.