Messages¶
ACME protocol messages.
-
exception
acme.messages.
Error
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
,acme.errors.Error
ACME error.
https://tools.ietf.org/html/draft-ietf-appsawg-http-problem-00
Variables: - typ (unicode) –
- title (unicode) –
- detail (unicode) –
-
description
¶ Hardcoded error description based on its type.
Returns: Description if standard ACME error or None
.Return type: unicode
-
class
acme.messages.
_Constant
(name)[source]¶ Bases:
acme.jose.interfaces.JSONDeSerializable
,collections.abc.Hashable
ACME constant.
-
class
acme.messages.
Status
(name)[source]¶ Bases:
acme.messages._Constant
ACME “status” field.
-
class
acme.messages.
IdentifierType
(name)[source]¶ Bases:
acme.messages._Constant
ACME identifier type.
-
class
acme.messages.
Identifier
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
ACME identifier.
Variables: - typ (IdentifierType) –
- value (unicode) –
-
class
acme.messages.
Directory
(jobj)[source]¶ Bases:
acme.jose.interfaces.JSONDeSerializable
Directory.
-
class
Meta
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
Directory Meta.
-
class
-
class
acme.messages.
Resource
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
ACME Resource.
Variables: body (acme.messages.ResourceBody) – Resource body.
-
class
acme.messages.
ResourceWithURI
(**kwargs)[source]¶ Bases:
acme.messages.Resource
ACME Resource with URI.
Variables: uri (unicode) – Location of the resource.
-
class
acme.messages.
ResourceBody
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
ACME Resource Body.
-
class
acme.messages.
Registration
(**kwargs)[source]¶ Bases:
acme.messages.ResourceBody
Registration Resource Body.
Variables: - key (acme.jose.jwk.JWK) – Public key.
- contact (tuple) – Contact information following ACME spec,
tuple
ofunicode
. - agreement (unicode) –
- authorizations (unicode) – URI where
messages.Registration.Authorizations
can be found. - certificates (unicode) – URI where
messages.Registration.Certificates
can be found.
-
class
Authorizations
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
Authorizations granted to Account in the process of registration.
Variables: authorizations (tuple) – URIs to Authorization Resources.
-
class
Registration.
Certificates
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
Certificates granted to Account in the process of registration.
Variables: certificates (tuple) – URIs to Certificate Resources.
-
classmethod
Registration.
from_data
(phone=None, email=None, **kwargs)[source]¶ Create registration resource from contact details.
-
Registration.
phones
¶ All phones found in the
contact
field.
-
Registration.
emails
¶ All emails found in the
contact
field.
-
class
acme.messages.
NewRegistration
(**kwargs)[source]¶ Bases:
acme.messages.Registration
New registration.
-
class
acme.messages.
UpdateRegistration
(**kwargs)[source]¶ Bases:
acme.messages.Registration
Update registration.
-
class
acme.messages.
RegistrationResource
(**kwargs)[source]¶ Bases:
acme.messages.ResourceWithURI
Registration Resource.
Variables: - body (acme.messages.Registration) –
- new_authzr_uri (unicode) – URI found in the ‘next’
Link
header - terms_of_service (unicode) – URL for the CA TOS.
-
class
acme.messages.
ChallengeBody
(**kwargs)[source]¶ Bases:
acme.messages.ResourceBody
Challenge Resource Body.
Todo
Confusingly, this has a similar name to
challenges.Challenge
, as well asachallenges.AnnotatedChallenge
. Please use names such aschallb
to distinguish instances of this class fromachall
.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) –
- acme.challenges.Challenge – Wrapped challenge.
Conveniently, all challenge fields are proxied, i.e. you can
call
-
class
acme.messages.
ChallengeResource
(**kwargs)[source]¶ Bases:
acme.messages.Resource
Challenge Resource.
Variables: - body (acme.messages.ChallengeBody) –
- authzr_uri (unicode) – URI found in the ‘up’
Link
header.
-
class
acme.messages.
Authorization
(**kwargs)[source]¶ Bases:
acme.messages.ResourceBody
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) –
-
resolved_combinations
¶ Combinations with challenges instead of indices.
-
class
acme.messages.
NewAuthorization
(**kwargs)[source]¶ Bases:
acme.messages.Authorization
New authorization.
-
class
acme.messages.
AuthorizationResource
(**kwargs)[source]¶ Bases:
acme.messages.ResourceWithURI
Authorization Resource.
Variables: - body (acme.messages.Authorization) –
- new_cert_uri (unicode) – URI found in the ‘next’
Link
header
-
class
acme.messages.
CertificateRequest
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
ACME new-cert request.
Variables: csr (acme.jose.util.ComparableX509) – OpenSSL.crypto.X509Req
wrapped inComparableX509
-
class
acme.messages.
CertificateResource
(**kwargs)[source]¶ Bases:
acme.messages.ResourceWithURI
Certificate Resource.
Variables: - body (acme.jose.util.ComparableX509) –
OpenSSL.crypto.X509
wrapped inComparableX509
- cert_chain_uri (unicode) – URI found in the ‘up’
Link
header - authzrs (tuple) –
tuple
ofAuthorizationResource
.
- body (acme.jose.util.ComparableX509) –
-
class
acme.messages.
Revocation
(**kwargs)[source]¶ Bases:
acme.jose.json_util.JSONObjectWithFields
Revocation message.
Variables: certificate (ComparableX509) – OpenSSL.crypto.X509
wrapped inComparableX509