Source code for acme.client

"""ACME client API."""
import base64
import datetime
from email.utils import parsedate_tz
import http.client as http_client
import logging
import re
import time
from typing import Any
from typing import cast
from typing import List
from typing import Mapping
from typing import Optional
from typing import Set
from typing import Text
from typing import Tuple
from typing import Union

import josepy as jose
import OpenSSL
import requests
from requests.adapters import HTTPAdapter
from requests.utils import parse_header_links

from acme import challenges
from acme import crypto_util
from acme import errors
from acme import jws
from acme import messages

logger = logging.getLogger(__name__)


[docs]class ClientV2: """ACME client for a v2 API. :ivar messages.Directory directory: :ivar .ClientNetwork net: Client network. """ def __init__(self, directory: messages.Directory, net: 'ClientNetwork') -> None: """Initialize. :param .messages.Directory directory: Directory Resource :param .ClientNetwork net: Client network. """ = directory = net
[docs] def new_account(self, new_account: messages.NewRegistration) -> messages.RegistrationResource: """Register. :param .NewRegistration new_account: :raises .ConflictError: in case the account already exists :returns: Registration Resource. :rtype: `.RegistrationResource` """ response = self._post(['newAccount'], new_account) # if account already exists if response.status_code == 200 and 'Location' in response.headers: raise errors.ConflictError(response.headers['Location']) # "Instance of 'Field' has no key/contact member" bug: regr = self._regr_from_response(response) = regr return regr
[docs] def query_registration(self, regr: messages.RegistrationResource ) -> messages.RegistrationResource: """Query server about registration. :param messages.RegistrationResource regr: Existing Registration Resource. """ = self._get_v2_account(regr, True) return
[docs] def update_registration(self, regr: messages.RegistrationResource, update: Optional[messages.Registration] = None ) -> messages.RegistrationResource: """Update registration. :param messages.RegistrationResource regr: Registration Resource. :param messages.Registration update: Updated body of the resource. If not provided, body will be taken from `regr`. :returns: Updated Registration Resource. :rtype: `.RegistrationResource` """ # regr = self._get_v2_account(regr) update = regr.body if update is None else update body = messages.UpdateRegistration(**dict(update)) updated_regr = self._send_recv_regr(regr, body=body) = updated_regr return updated_regr
def _get_v2_account(self, regr: messages.RegistrationResource, update_body: bool = False ) -> messages.RegistrationResource: = None only_existing_reg = regr.body.update(only_return_existing=True) response = self._post(['newAccount'], only_existing_reg) updated_uri = response.headers['Location'] new_regr = regr.update(body=messages.Registration.from_json(response.json()) if update_body else regr.body, uri=updated_uri) = new_regr return new_regr
[docs] def new_order(self, csr_pem: bytes) -> messages.OrderResource: """Request a new Order object from the server. :param bytes csr_pem: A CSR in PEM format. :returns: The newly created order. :rtype: OrderResource """ csr = OpenSSL.crypto.load_certificate_request(OpenSSL.crypto.FILETYPE_PEM, csr_pem) # pylint: disable=protected-access dnsNames = crypto_util._pyopenssl_cert_or_req_all_names(csr) ipNames = crypto_util._pyopenssl_cert_or_req_san_ip(csr) # ipNames is now []string identifiers = [] for name in dnsNames: identifiers.append(messages.Identifier(typ=messages.IDENTIFIER_FQDN, value=name)) for ips in ipNames: identifiers.append(messages.Identifier(typ=messages.IDENTIFIER_IP, value=ips)) order = messages.NewOrder(identifiers=identifiers) response = self._post(['newOrder'], order) body = messages.Order.from_json(response.json()) authorizations = [] # pylint has trouble understanding our josepy based objects which use # things like custom metaclass logic. body.authorizations should be a # list of strings containing URLs so let's disable this check here. for url in body.authorizations: # pylint: disable=not-an-iterable authorizations.append(self._authzr_from_response(self._post_as_get(url), uri=url)) return messages.OrderResource( body=body, uri=response.headers.get('Location'), authorizations=authorizations, csr_pem=csr_pem)
[docs] def poll(self, authzr: messages.AuthorizationResource ) -> Tuple[messages.AuthorizationResource, requests.Response]: """Poll Authorization Resource for status. :param authzr: Authorization Resource :type authzr: `.AuthorizationResource` :returns: Updated Authorization Resource and HTTP response. :rtype: (`.AuthorizationResource`, `requests.Response`) """ response = self._post_as_get(authzr.uri) updated_authzr = self._authzr_from_response( response, authzr.body.identifier, authzr.uri) return updated_authzr, response
[docs] def poll_and_finalize(self, orderr: messages.OrderResource, deadline: Optional[datetime.datetime] = None) -> messages.OrderResource: """Poll authorizations and finalize the order. If no deadline is provided, this method will timeout after 90 seconds. :param messages.OrderResource orderr: order to finalize :param datetime.datetime deadline: when to stop polling and timeout :returns: finalized order :rtype: messages.OrderResource """ if deadline is None: deadline = + datetime.timedelta(seconds=90) orderr = self.poll_authorizations(orderr, deadline) return self.finalize_order(orderr, deadline)
[docs] def poll_authorizations(self, orderr: messages.OrderResource, deadline: datetime.datetime ) -> messages.OrderResource: """Poll Order Resource for status.""" responses = [] for url in orderr.body.authorizations: while < deadline: authzr = self._authzr_from_response(self._post_as_get(url), uri=url) if authzr.body.status != messages.STATUS_PENDING: # pylint: disable=no-member responses.append(authzr) break time.sleep(1) # If we didn't get a response for every authorization, we fell through # the bottom of the loop due to hitting the deadline. if len(responses) < len(orderr.body.authorizations): raise errors.TimeoutError() failed = [] for authzr in responses: if authzr.body.status != messages.STATUS_VALID: for chall in authzr.body.challenges: if chall.error is not None: failed.append(authzr) if failed: raise errors.ValidationError(failed) return orderr.update(authorizations=responses)
[docs] def begin_finalization(self, orderr: messages.OrderResource ) -> messages.OrderResource: """Start the process of finalizing an order. :param messages.OrderResource orderr: order to finalize :param datetime.datetime deadline: when to stop polling and timeout :returns: updated order :rtype: messages.OrderResource """ csr = OpenSSL.crypto.load_certificate_request( OpenSSL.crypto.FILETYPE_PEM, orderr.csr_pem) wrapped_csr = messages.CertificateRequest(csr=jose.ComparableX509(csr)) res = self._post(orderr.body.finalize, wrapped_csr) orderr = orderr.update(body=messages.Order.from_json(res.json())) return orderr
[docs] def poll_finalization(self, orderr: messages.OrderResource, deadline: datetime.datetime, fetch_alternative_chains: bool = False ) -> messages.OrderResource: """ Poll an order that has been finalized for its status. If it becomes valid, obtain the certificate. :returns: finalized order (with certificate) :rtype: messages.OrderResource """ while < deadline: time.sleep(1) response = self._post_as_get(orderr.uri) body = messages.Order.from_json(response.json()) if body.status == messages.STATUS_INVALID: if body.error is not None: raise errors.IssuanceError(body.error) raise errors.Error( "The certificate order failed. No further information was provided " "by the server.") elif body.status == messages.STATUS_VALID and body.certificate is not None: certificate_response = self._post_as_get(body.certificate) orderr = orderr.update(body=body, fullchain_pem=certificate_response.text) if fetch_alternative_chains: alt_chains_urls = self._get_links(certificate_response, 'alternate') alt_chains = [self._post_as_get(url).text for url in alt_chains_urls] orderr = orderr.update(alternative_fullchains_pem=alt_chains) return orderr raise errors.TimeoutError()
[docs] def finalize_order(self, orderr: messages.OrderResource, deadline: datetime.datetime, fetch_alternative_chains: bool = False) -> messages.OrderResource: """Finalize an order and obtain a certificate. :param messages.OrderResource orderr: order to finalize :param datetime.datetime deadline: when to stop polling and timeout :param bool fetch_alternative_chains: whether to also fetch alternative certificate chains :returns: finalized order :rtype: messages.OrderResource """ self.begin_finalization(orderr) return self.poll_finalization(orderr, deadline, fetch_alternative_chains)
[docs] def revoke(self, cert: jose.ComparableX509, rsn: int) -> None: """Revoke certificate. :param .ComparableX509 cert: `OpenSSL.crypto.X509` wrapped in `.ComparableX509` :param int rsn: Reason code for certificate revocation. :raises .ClientError: If revocation is unsuccessful. """ self._revoke(cert, rsn,['revokeCert'])
[docs] def external_account_required(self) -> bool: """Checks if ACME server requires External Account Binding authentication.""" return hasattr(, 'meta') and \ hasattr(, 'external_account_required') and \
def _post_as_get(self, *args: Any, **kwargs: Any) -> requests.Response: """ Send GET request using the POST-as-GET protocol. :param args: :param kwargs: :return: """ new_args = args[:1] + (None,) + args[1:] return self._post(*new_args, **kwargs) def _get_links(self, response: requests.Response, relation_type: str) -> List[str]: """ Retrieves all Link URIs of relation_type from the response. :param requests.Response response: The requests HTTP response. :param str relation_type: The relation type to filter by. """ # Can't use response.links directly because it drops multiple links # of the same relation type, which is possible in RFC8555 responses. if 'Link' not in response.headers: return [] links = parse_header_links(response.headers['Link']) return [l['url'] for l in links if 'rel' in l and 'url' in l and l['rel'] == relation_type]
[docs] @classmethod def get_directory(cls, url: str, net: 'ClientNetwork') -> messages.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 :rtype: messages.Directory """ return messages.Directory.from_json(net.get(url).json())
@classmethod def _regr_from_response(cls, response: requests.Response, uri: Optional[str] = None, terms_of_service: Optional[str] = None ) -> messages.RegistrationResource: if 'terms-of-service' in response.links: terms_of_service = response.links['terms-of-service']['url'] return messages.RegistrationResource( body=messages.Registration.from_json(response.json()), uri=response.headers.get('Location', uri), terms_of_service=terms_of_service) def _send_recv_regr(self, regr: messages.RegistrationResource, body: messages.Registration) -> messages.RegistrationResource: response = self._post(regr.uri, body) # TODO: Boulder returns httplib.ACCEPTED #assert response.status_code == httplib.OK # TODO: Boulder does not set Location or Link on update # (c.f. acme-spec #94) return self._regr_from_response( response, uri=regr.uri, terms_of_service=regr.terms_of_service) def _post(self, *args: Any, **kwargs: Any) -> requests.Response: """Wrapper around that adds the newNonce URL. This is used to retry the request in case of a badNonce error. """ kwargs.setdefault('new_nonce_url', getattr(, 'newNonce')) return*args, **kwargs)
[docs] def deactivate_registration(self, regr: messages.RegistrationResource ) -> messages.RegistrationResource: """Deactivate registration. :param messages.RegistrationResource regr: The Registration Resource to be deactivated. :returns: The Registration resource that was deactivated. :rtype: `.RegistrationResource` """ return self.update_registration(regr, messages.Registration.from_json( {"status": "deactivated", "contact": None}))
[docs] def deactivate_authorization(self, authzr: messages.AuthorizationResource ) -> messages.AuthorizationResource: """Deactivate authorization. :param messages.AuthorizationResource authzr: The Authorization resource to be deactivated. :returns: The Authorization resource that was deactivated. :rtype: `.AuthorizationResource` """ body = messages.UpdateAuthorization(status='deactivated') response = self._post(authzr.uri, body) return self._authzr_from_response(response, authzr.body.identifier, authzr.uri)
def _authzr_from_response(self, response: requests.Response, identifier: Optional[messages.Identifier] = None, uri: Optional[str] = None) -> messages.AuthorizationResource: authzr = messages.AuthorizationResource( body=messages.Authorization.from_json(response.json()), uri=response.headers.get('Location', uri)) if identifier is not None and authzr.body.identifier != identifier: # pylint: disable=no-member raise errors.UnexpectedUpdate(authzr) return authzr
[docs] def answer_challenge(self, challb: messages.ChallengeBody, response: challenges.ChallengeResponse) -> messages.ChallengeResource: """Answer challenge. :param challb: Challenge Resource body. :type challb: `.ChallengeBody` :param response: Corresponding Challenge response :type response: `.challenges.ChallengeResponse` :returns: Challenge Resource with updated body. :rtype: `.ChallengeResource` :raises .UnexpectedUpdate: """ resp = self._post(challb.uri, response) try: authzr_uri = resp.links['up']['url'] except KeyError: raise errors.ClientError('"up" Link header missing') challr = messages.ChallengeResource( authzr_uri=authzr_uri, body=messages.ChallengeBody.from_json(resp.json())) # TODO: check that challr.uri == resp.headers['Location']? if challr.uri != challb.uri: raise errors.UnexpectedUpdate(challr.uri) return challr
[docs] @classmethod def retry_after(cls, response: requests.Response, default: int) -> datetime.datetime: """Compute next `poll` time based on response ``Retry-After`` header. Handles integers and various datestring formats per :param requests.Response response: Response from `poll`. :param int default: Default value (in seconds), used when ``Retry-After`` header is not present or invalid. :returns: Time point when next `poll` should be performed. :rtype: `datetime.datetime` """ retry_after = response.headers.get('Retry-After', str(default)) try: seconds = int(retry_after) except ValueError: # The RFC 2822 parser handles all of RFC 2616's cases in modern # environments (primarily HTTP 1.1+ but also py27+) when = parsedate_tz(retry_after) if when is not None: try: tz_secs = datetime.timedelta(when[-1] if when[-1] is not None else 0) return datetime.datetime(*when[:7]) - tz_secs except (ValueError, OverflowError): pass seconds = default return + datetime.timedelta(seconds=seconds)
def _revoke(self, cert: jose.ComparableX509, rsn: int, url: str) -> None: """Revoke certificate. :param .ComparableX509 cert: `OpenSSL.crypto.X509` wrapped in `.ComparableX509` :param int rsn: Reason code for certificate revocation. :param str url: ACME URL to post to :raises .ClientError: If revocation is unsuccessful. """ response = self._post(url, messages.Revocation( certificate=cert, reason=rsn)) if response.status_code != http_client.OK: raise errors.ClientError( 'Successful revocation must return HTTP OK status')
[docs]class ClientNetwork: """Wrapper around requests that signs POSTs for authentication. Also adds user agent, and handles Content-Type. """ JSON_CONTENT_TYPE = 'application/json' JOSE_CONTENT_TYPE = 'application/jose+json' JSON_ERROR_CONTENT_TYPE = 'application/problem+json' REPLAY_NONCE_HEADER = 'Replay-Nonce' """Initialize. :param josepy.JWK key: Account private key :param messages.RegistrationResource account: Account object. Required if you are planning to use .post() for anything other than creating a new account; may be set later after registering. :param josepy.JWASignature alg: Algorithm to use in signing JWS. :param bool verify_ssl: Whether to verify certificates on SSL connections. :param str user_agent: String to send as User-Agent header. :param int timeout: Timeout for requests. """ def __init__(self, key: jose.JWK, account: Optional[messages.RegistrationResource] = None, alg: jose.JWASignature = jose.RS256, verify_ssl: bool = True, user_agent: str = 'acme-python', timeout: int = DEFAULT_NETWORK_TIMEOUT) -> None: self.key = key self.account = account self.alg = alg self.verify_ssl = verify_ssl self._nonces: Set[Text] = set() self.user_agent = user_agent self.session = requests.Session() self._default_timeout = timeout adapter = HTTPAdapter() self.session.mount("http://", adapter) self.session.mount("https://", adapter) def __del__(self) -> None: # Try to close the session, but don't show exceptions to the # user if the call to close() fails. See #4840. try: self.session.close() except Exception: # pylint: disable=broad-except pass def _wrap_in_jws(self, obj: jose.JSONDeSerializable, nonce: str, url: str) -> str: """Wrap `JSONDeSerializable` object in JWS. .. todo:: Implement ``acmePath``. :param josepy.JSONDeSerializable obj: :param str url: The URL to which this object will be POSTed :param str nonce: :rtype: str """ jobj = obj.json_dumps(indent=2).encode() if obj else b'' logger.debug('JWS payload:\n%s', jobj) kwargs = { "alg": self.alg, "nonce": nonce, "url": url } # newAccount and revokeCert work without the kid # newAccount must not have kid if self.account is not None: kwargs["kid"] = self.account["uri"] kwargs["key"] = self.key return jws.JWS.sign(jobj, **cast(Mapping[str, Any], kwargs)).json_dumps(indent=2) @classmethod def _check_response(cls, response: requests.Response, content_type: Optional[str] = None) -> requests.Response: """Check response content and its type. .. note:: Checking is not strict: wrong server response ``Content-Type`` HTTP header is ignored if response is an expected JSON object (c.f. Boulder #56). :param str content_type: Expected Content-Type response header. If JSON is expected and not present in server response, this function will raise an error. Otherwise, wrong Content-Type is ignored, but logged. :raises .messages.Error: If server response body carries HTTP Problem ( :raises .ClientError: In case of other networking errors. """ response_ct = response.headers.get('Content-Type') # Strip parameters from the media-type (rfc2616#section-3.7) if response_ct: response_ct = response_ct.split(';')[0].strip() try: # TODO: response.json() is called twice, once here, and # once in _get and _post clients jobj = response.json() except ValueError: jobj = None if response.status_code == 409: raise errors.ConflictError(response.headers.get('Location', 'UNKNOWN-LOCATION')) if not response.ok: if jobj is not None: if response_ct != cls.JSON_ERROR_CONTENT_TYPE: logger.debug( 'Ignoring wrong Content-Type (%r) for JSON Error', response_ct) try: raise messages.Error.from_json(jobj) except jose.DeserializationError as error: # Couldn't deserialize JSON object raise errors.ClientError((response, error)) else: # response is not JSON object raise errors.ClientError(response) else: if jobj is not None and response_ct != cls.JSON_CONTENT_TYPE: logger.debug( 'Ignoring wrong Content-Type (%r) for JSON decodable ' 'response', response_ct) if content_type == cls.JSON_CONTENT_TYPE and jobj is None: raise errors.ClientError(f'Unexpected response Content-Type: {response_ct}') return response def _send_request(self, method: str, url: str, *args: Any, **kwargs: Any) -> requests.Response: """Send HTTP request. Makes sure that `verify_ssl` is respected. Logs request and response (with headers). For allowed parameters please see `requests.request`. :param str method: method for the new `requests.Request` object :param str url: URL for the new `requests.Request` object :raises requests.exceptions.RequestException: in case of any problems :returns: HTTP Response :rtype: `requests.Response` """ if method == "POST": logger.debug('Sending POST request to %s:\n%s', url, kwargs['data']) else: logger.debug('Sending %s request to %s.', method, url) kwargs['verify'] = self.verify_ssl kwargs.setdefault('headers', {}) kwargs['headers'].setdefault('User-Agent', self.user_agent) kwargs.setdefault('timeout', self._default_timeout) try: response = self.session.request(method, url, *args, **kwargs) except requests.exceptions.RequestException as e: # pylint: disable=pointless-string-statement """Requests response parsing The requests library emits exceptions with a lot of extra text. We parse them with a regexp to raise a more readable exceptions. Example: HTTPSConnectionPool(host='', port=443): Max retries exceeded with url: /directory (Caused by NewConnectionError(' <requests.packages.urllib3.connection.VerifiedHTTPSConnection object at 0x108356c50>: Failed to establish a new connection: [Errno 65] No route to host',))""" # pylint: disable=line-too-long err_regex = r".*host='(\S*)'.*Max retries exceeded with url\: (\/\w*).*(\[Errno \d+\])([A-Za-z ]*)" m = re.match(err_regex, str(e)) if m is None: raise # pragma: no cover host, path, _err_no, err_msg = m.groups() raise ValueError(f"Requesting {host}{path}:{err_msg}") # If an Accept header was sent in the request, the response may not be # UTF-8 encoded. In this case, we don't set response.encoding and log # the base64 response instead of raw bytes to keep binary data out of the logs. debug_content: Union[bytes, str] if "Accept" in kwargs["headers"]: debug_content = base64.b64encode(response.content) else: # We set response.encoding so response.text knows the response is # UTF-8 encoded instead of trying to guess the encoding that was # used which is error prone. This setting affects all future # accesses of .text made on the returned response object as well. response.encoding = "utf-8" debug_content = response.text logger.debug('Received response:\nHTTP %d\n%s\n\n%s', response.status_code, "\n".join("{0}: {1}".format(k, v) for k, v in response.headers.items()), debug_content) return response
[docs] def head(self, *args: Any, **kwargs: Any) -> requests.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. """ return self._send_request('HEAD', *args, **kwargs)
[docs] def get(self, url: str, content_type: str = JSON_CONTENT_TYPE, **kwargs: Any) -> requests.Response: """Send GET request and check response.""" return self._check_response( self._send_request('GET', url, **kwargs), content_type=content_type)
def _add_nonce(self, response: requests.Response) -> None: if self.REPLAY_NONCE_HEADER in response.headers: nonce = response.headers[self.REPLAY_NONCE_HEADER] try: decoded_nonce = jws.Header._fields['nonce'].decode(nonce) except jose.DeserializationError as error: raise errors.BadNonce(nonce, error) logger.debug('Storing nonce: %s', nonce) self._nonces.add(decoded_nonce) else: raise errors.MissingNonce(response) def _get_nonce(self, url: str, new_nonce_url: str) -> str: if not self._nonces: logger.debug('Requesting fresh nonce') if new_nonce_url is None: response = self.head(url) else: # request a new nonce from the acme newNonce endpoint response = self._check_response(self.head(new_nonce_url), content_type=None) self._add_nonce(response) return self._nonces.pop()
[docs] def post(self, *args: Any, **kwargs: Any) -> requests.Response: """POST object wrapped in `.JWS` and check response. If the server responded with a badNonce error, the request will be retried once. """ try: return self._post_once(*args, **kwargs) except messages.Error as error: if error.code == 'badNonce': logger.debug('Retrying request after error:\n%s', error) return self._post_once(*args, **kwargs) raise
def _post_once(self, url: str, obj: jose.JSONDeSerializable, content_type: str = JOSE_CONTENT_TYPE, **kwargs: Any) -> requests.Response: new_nonce_url = kwargs.pop('new_nonce_url', None) data = self._wrap_in_jws(obj, self._get_nonce(url, new_nonce_url), url) kwargs.setdefault('headers', {'Content-Type': content_type}) response = self._send_request('POST', url, data=data, **kwargs) response = self._check_response(response, content_type=content_type) self._add_nonce(response) return response