| ACME Working Group | R. Barnes |
| Internet-Draft | Mozilla |
| Intended status: Standards Track | J. Hoffman-Andrews |
| Expires: September 14, 2017 | EFF |
| J. Kasten | |
| University of Michigan | |
| March 13, 2017 |
Automatic Certificate Management Environment (ACME)
draft-ietf-acme-acme-06
Certificates in PKI using X.509 (PKIX) are used for a number of purposes, the most significant of which is the authentication of domain names. Thus, certificate authorities in the Web PKI are trusted to verify that an applicant for a certificate legitimately represents the domain name(s) in the certificate. Today, this verification is done through a collection of ad hoc mechanisms. This document describes a protocol that a certification authority (CA) and an applicant can use to automate the process of verification and certificate issuance. The protocol also provides facilities for other certificate management functions, such as certificate revocation.
DISCLAIMER: This is a work in progress draft of ACME and has not yet had a thorough security analysis.
RFC EDITOR: PLEASE REMOVE THE FOLLOWING PARAGRAPH: The source for this draft is maintained in GitHub. Suggested changes should be submitted as pull requests at https://github.com/ietf-wg-acme/acme. Instructions are on that page as well. Editorial changes can be managed in GitHub, but any substantive change should be discussed on the ACME mailing list (acme@ietf.org).
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 14, 2017.
Copyright (c) 2017 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
Certificates [RFC5280] in the Web PKI are most commonly used to authenticate domain names. Thus, certificate authorities in the Web PKI are trusted to verify that an applicant for a certificate legitimately represents the domain name(s) in the certificate.
Different types of certificates reflect different kinds of CA verification of information about the certificate subject. “Domain Validation” (DV) certificates are by far the most common type. For DV validation, the CA merely verifies that the requester has effective control of the web server and/or DNS server for the domain, but does not explicitly attempt to verify their real-world identity. (This is as opposed to “Organization Validation” (OV) and “Extended Validation” (EV) certificates, where the process is intended to also verify the real-world identity of the requester.)
Existing Web PKI certificate authorities tend to run on a set of ad hoc protocols for certificate issuance and identity verification. In the case of DV certificates, a typical user experience is something like:
With the exception of the CSR itself and the certificates that are issued, these are all completely ad hoc procedures and are accomplished by getting the human user to follow interactive natural-language instructions from the CA rather than by machine-implemented published protocols. In many cases, the instructions are difficult to follow and cause significant confusion. Informal usability tests by the authors indicate that webmasters often need 1-3 hours to obtain and install a certificate for a domain. Even in the best case, the lack of published, standardized mechanisms presents an obstacle to the wide deployment of HTTPS and other PKIX-dependent systems because it inhibits mechanization of tasks related to certificate issuance, deployment, and revocation.
This document describes an extensible framework for automating the issuance and domain validation procedure, thereby allowing servers and infrastructural software to obtain certificates without user interaction. Use of this protocol should radically simplify the deployment of HTTPS and the practicality of PKIX authentication for other protocols based on TLS [RFC5246].
The guiding use case for ACME is obtaining certificates for websites (HTTPS [RFC2818]). In this case, the user’s web server is intended to speak for one or more domains, and the process of certificate issuance is intended to verify that this web server actually speaks for the domain(s).
DV certificate validation commonly checks claims about properties related to control of a domain name – properties that can be observed by the certificate issuer in an interactive process that can be conducted purely online. That means that under typical circumstances, all steps in the request, verification, and issuance process can be represented and performed by Internet protocols with no out-of-band human intervention.
Prior to ACME, when deploying an HTTPS server, an operator typically gets a prompt to generate a self-signed certificate. If the operator were instead deploying an ACME-compatible web server, the experience would be something like this:
In this way, it would be nearly as easy to deploy with a CA-issued certificate as with a self-signed certificate. Furthermore, the maintenance of that CA-issued certificate would require minimal manual intervention. Such close integration of ACME with HTTPS servers would allow the immediate and automated deployment of certificates as they are issued, sparing the human administrator from much of the time-consuming work described in the previous section.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119 [RFC2119].
The two main roles in ACME are “client” and “server”. The ACME client uses the protocol to request certificate management actions, such as issuance or revocation. An ACME client therefore typically runs on a web server, mail server, or some other server system which requires valid TLS certificates. The ACME server runs at a certification authority, and responds to client requests, performing the requested actions if the client is authorized.
An ACME client is represented by an “account key pair”. The client uses the private key of this key pair to sign all messages sent to the server. The server uses the public key to verify the authenticity and integrity of messages from the client.
ACME allows a client to request certificate management actions using a set of JSON messages carried over HTTPS. In many ways, ACME functions much like a traditional CA, in which a user creates an account, requests a certificate, and proves control of the domains in that certificate in order for the CA to sign the requested certificate.
The first phase of ACME is for the client to request an account with the ACME server. The client generates an asymmetric key pair and requests a new account, optionally providing contact information, agreeing to terms of service, and/or associating the account with an existing account in another system. The creation request is signed with the generated private key to prove that the client controls it.
Client Server
Contact Information
ToS Agreement
Additional Data
Signature ------->
<------- Account
Once an account is registered, there are three major steps the client needs to take to get a certificate:
The client’s order for a certificate describes the desired certificate using a PKCS#10 Certificate Signing Request (CSR) plus a few additional fields that capture semantics that are not supported in the CSR format. If the server is willing to consider issuing such a certificate, it responds with a list of requirements that the client must satisfy before the certificate will be issued.
For example, in most cases, the server will require the client to demonstrate that it controls the identifiers in the requested certificate. Because there are many different ways to validate possession of different types of identifiers, the server will choose from an extensible set of challenges that are appropriate for the identifier being claimed. The client responds with a set of responses that tell the server which challenges the client has completed. The server then validates the challenges to check that the client has accomplished the challenge.
Once the validation process is complete and the server is satisfied that the client has met its requirements, the server will issue the requested certificate and make it available to the client.
Order
Signature ------->
Required
<------- Authorizations
Responses
Signature ------->
<~~~~~~~~Validation~~~~~~~~>
<------- Certificate
To revoke a certificate, the client sends a signed revocation request indicating the certificate to be revoked:
Client Server
Revocation request
Signature -------->
<-------- Result
Note that while ACME is defined with enough flexibility to handle different types of identifiers in principle, the primary use case addressed by this document is the case where domain names are used as identifiers. For example, all of the identifier validation challenges described in Section 8 below address validation of domain names. The use of ACME for other identifiers will require further specification, in order to describe how these identifiers are encoded in the protocol, and what types of validation challenges the server might require.
All requests and responses sent via HTTP by ACME clients, ACME servers, and validation servers as well as any inputs for digest computations MUST be encoded using the UTF-8 [RFC3629] character set.
Communications between an ACME client and an ACME server are done over HTTPS, using JSON Web Signature (JWS) [RFC7515] to provide some additional security properties for messages sent from the client to the server. HTTPS provides server authentication and confidentiality. With some ACME-specific extensions, JWS provides authentication of the client’s request payloads, anti-replay protection, and integrity for the HTTPS request URI.
Each ACME function is accomplished by the client sending a sequence of HTTPS requests to the server, carrying JSON messages [RFC2818][RFC7159]. Use of HTTPS is REQUIRED. Each subsection of Section 7 below describes the message formats used by the function and the order in which messages are sent.
In most HTTPS transactions used by ACME, the ACME client is the HTTPS client and the ACME server is the HTTPS server. The ACME server acts as an HTTP and HTTPS client when validating challenges via HTTP.
ACME clients SHOULD send a User-Agent header in accordance with [RFC7231], including the name and version of the ACME software in addition to the name and version of the underlying HTTP client software.
ACME clients SHOULD send an Accept-Language header in accordance with [RFC7231] to enable localization of error messages.
ACME servers that are intended to be generally accessible need to use Cross-Origin Resource Sharing (CORS) in order to be accessible from browser-based clients [W3C.CR-cors-20130129]. Such servers SHOULD set the Access-Control-Allow-Origin header field to the value “*”.
Binary fields in the JSON objects used by ACME are encoded using base64url encoding described in [RFC4648] Section 5, according to the profile specified in JSON Web Signature [RFC7515] Section 2. This encoding uses a URL safe character set. Trailing ‘=’ characters MUST be stripped.
All ACME requests with a non-empty body MUST encapsulate their payload in a JSON Web Signature (JWS) [RFC7515] object, signed using the account’s private key unless otherwise specified. The server MUST verify the JWS before processing the request. Encapsulating request bodies in JWS provides authentication of requests.
JWS objects sent in ACME requests MUST meet the following additional criteria:
The “jwk” and “kid” fields are mutually exclusive. Servers MUST reject requests that contain both.
For new-account requests, and for revoke-cert requests authenticated by certificate key, there MUST be a “jwk” field.
For all other requests, there MUST be a “kid” field. This field must contain the account URI received by POSTing to the new-account resource.
Note that authentication via signed JWS request bodies implies that GET requests are not authenticated. Servers MUST NOT respond to GET requests for resources that might be considered sensitive. Account resources are the only sensitive resources defined in this specification.
If the client sends a JWS signed with an algorithm that the server does not support, then the server MUST return an error with status code 400 (Bad Request) and type “urn:ietf:params:acme:error:badSignatureAlgorithm”. The problem document returned with the error MUST include an “algorithms” field with an array of supported “alg” values.
In the examples below, JWS objects are shown in the JSON or flattened JSON serialization, with the protected header and payload expressed as base64url(content) instead of the actual base64-encoded value, so that the content is readable.
It is common in deployment for the entity terminating TLS for HTTPS to be different from the entity operating the logical HTTPS server, with a “request routing” layer in the middle. For example, an ACME CA might have a content delivery network terminate TLS connections from clients so that it can inspect client requests for denial-of-service protection.
These intermediaries can also change values in the request that are not signed in the HTTPS request, e.g., the request URI and headers. ACME uses JWS to provide an integrity mechanism, which protects against an intermediary changing the request URI to another ACME URI.
As noted above, all ACME request objects carry a “url” parameter in their protected header. This header parameter encodes the URL to which the client is directing the request. On receiving such an object in an HTTP request, the server MUST compare the “url” parameter to the request URI. If the two do not match, then the server MUST reject the request as unauthorized.
Except for the directory resource, all ACME resources are addressed with URLs provided to the client by the server. For these resources, the client MUST set the “url” field to the exact string provided by the server (rather than performing any re-encoding on the URL). The server SHOULD perform the corresponding string equality check, configuring each resource with the URL string provided to clients and having the resource check that requests have the same string in their “url” fields.
The “url” header parameter specifies the URL [RFC3986] to which this JWS object is directed. The “url” parameter MUST be carried in the protected header of the JWS. The value of the “url” header MUST be a string representing the URL.
In order to protect ACME resources from any possible replay attacks, ACME requests have a mandatory anti-replay mechanism. This mechanism is based on the server maintaining a list of nonces that it has issued to clients, and requiring any signed request from the client to carry such a nonce.
An ACME server provides nonces to clients using the Replay-Nonce header field, as specified below. The server MUST include a Replay-Nonce header field in every successful response to a POST request and SHOULD provide it in error responses as well.
Every JWS sent by an ACME client MUST include, in its protected header, the “nonce” header parameter, with contents as defined below. As part of JWS verification, the ACME server MUST verify that the value of the “nonce” header is a value that the server previously provided in a Replay-Nonce header field. Once a nonce value has appeared in an ACME request, the server MUST consider it invalid, in the same way as a value it had never issued.
When a server rejects a request because its nonce value was unacceptable (or not present), it MUST provide HTTP status code 400 (Bad Request), and indicate the ACME error type “urn:ietf:params:acme:error:badNonce”. An error response with the “badNonce” error type MUST include a Replay-Nonce header with a fresh nonce. On receiving such a response, a client SHOULD retry the request using the new nonce.
The precise method used to generate and track nonces is up to the server. For example, the server could generate a random 128-bit value for each response, keep a list of issued nonces, and strike nonces from this list as they are used.
The “Replay-Nonce” header field includes a server-generated value that the server can use to detect unauthorized replay in future client requests. The server should generate the value provided in Replay-Nonce in such a way that they are unique to each message, with high probability.
The value of the Replay-Nonce field MUST be an octet string encoded according to the base64url encoding described in Section 2 of [RFC7515]. Clients MUST ignore invalid Replay-Nonce values.
base64url = [A-Z] / [a-z] / [0-9] / "-" / "_" Replay-Nonce = *base64url
The Replay-Nonce header field SHOULD NOT be included in HTTP request messages.
The “nonce” header parameter provides a unique value that enables the verifier of a JWS to recognize when replay has occurred. The “nonce” header parameter MUST be carried in the protected header of the JWS.
The value of the “nonce” header parameter MUST be an octet string, encoded according to the base64url encoding described in Section 2 of [RFC7515]. If the value of a “nonce” header parameter is not valid according to this encoding, then the verifier MUST reject the JWS as malformed.
Creation of resources can be rate limited to ensure fair usage and prevent abuse. Once the rate limit is exceeded, the server MUST respond with an error with the type “urn:ietf:params:acme:error:rateLimited”. Additionally, the server SHOULD send a “Retry-After” header indicating when the current request may succeed again. If multiple rate limits are in place, that is the time where all rate limits allow access again for the current request with exactly the same parameters.
In addition to the human readable “detail” field of the error response, the server MAY send one or multiple tokens in the “Link” header pointing to documentation about the specific hit rate limits using the “urn:ietf:params:acme:documentation” relation.
Errors can be reported in ACME both at the HTTP layer and within challenge objects as defined in {{identifier-validation-challenges}. ACME servers can return responses with an HTTP error response code (4XX or 5XX). For example: If the client submits a request using a method not allowed in this document, then the server MAY return status code 405 (Method Not Allowed).
When the server responds with an error status, it SHOULD provide additional information using a problem document [RFC7807]. To facilitate automatic response to errors, this document defines the following standard tokens for use in the “type” field (within the “urn:ietf:params:acme:error:” namespace):
| Type | Description |
|---|---|
| badCSR | The CSR is unacceptable (e.g., due to a short key) |
| badNonce | The client sent an unacceptable anti-replay nonce |
| badSignatureAlgorithm | The JWS was signed with an algorithm the server does not support |
| invalidContact | The contact URI for an account was invalid |
| malformed | The request message was malformed |
| rateLimited | The request exceeds a rate limit |
| rejectedIdentifier | The server will not issue for the identifier |
| serverInternal | The server experienced an internal error |
| unauthorized | The client lacks sufficient authorization |
| unsupportedIdentifier | Identifier is not supported, but may be in future |
| userActionRequired | Visit the “instance” URL and take actions specified there |
| badRevocationReason | The revocation reason provided is not allowed by the server |
| caa | CAA records forbid the CA from issuing |
| dns | There was a problem with a DNS query |
| connection | The server could not connect to validation target |
| tls | The server received a TLS error during validation |
| incorrectResponse | Response received didn’t match the challenge’s requirements |
This list is not exhaustive. The server MAY return errors whose “type” field is set to a URI other than those defined above. Servers MUST NOT use the ACME URN namespace for errors other than the standard types. Clients SHOULD display the “detail” field of all errors.
In this section, we describe the certificate management functions that ACME enables:
ACME is structured as a REST application with a few types of resources:
The server MUST provide “directory” and “new-nonce” resources.
ACME uses different URIs for different management functions. Each function is listed in a directory along with its corresponding URI, so clients only need to be configured with the directory URI. These URIs are connected by a few different link relations [RFC5988].
The “up” link relation is used with challenge resources to indicate the authorization resource to which a challenge belongs. It is also used from certificate resources to indicate a resource from which the client may fetch a chain of CA certificates that could be used to validate the certificate in the original resource.
The “index” link relation is present on all resources other than the directory and indicates the URL of the directory.
The following diagram illustrates the relations between resources on an ACME server. For the most part, these relations are expressed by URLs provided as strings in the resources’ JSON representations. Lines with labels in quotes indicate HTTP link relations.
directory
|
|--> new-nonce
|
----------------------------------+
| | | |
| | | |
V V V V
new-account new-authz new-order revoke-cert
| | |
| | |
V | V
acct | order --------> cert
| | ^ |
| | | "up" | "up"
| V | V
+------> authz cert-chain
| ^
| | "up"
V |
challenge
The following table illustrates a typical sequence of requests required to establish a new account with the server, prove control of an identifier, issue a certificate, and fetch an updated certificate some time after issuance. The “->” is a mnemonic for a Location header pointing to a created resource.
| Action | Request | Response |
|---|---|---|
| Get a nonce | HEAD new-nonce | 204 |
| Create account | POST new-account | 201 -> account |
| Submit an order | POST new-order | 201 -> order |
| Fetch challenges | GET authz | 200 |
| Respond to challenge | POST challenge | 200 |
| Poll for status | GET authz | 200 |
| Check for new cert | GET cert | 200 |
The remainder of this section provides the details of how these resources are structured and how the ACME protocol makes use of them.
In order to help clients configure themselves with the right URIs for each ACME operation, ACME servers provide a directory object. This should be the only URL needed to configure clients. It is a JSON object, whose keys are drawn from the following table and whose values are the corresponding URLs.
| Key | URL in value |
|---|---|
| new-nonce | New nonce |
| new-account | New account |
| new-order | New order |
| new-authz | New authorization |
| revoke-cert | Revoke certificate |
| key-change | Key change |
There is no constraint on the actual URI of the directory except that it should be different from the other ACME server resources’ URIs, and that it should not clash with other services. For instance:
The object MAY additionally contain a key “meta”. If present, it MUST be a JSON object; each field in the object is an item of metadata relating to the service provided by the ACME server.
The following metadata items are defined, all of which are OPTIONAL:
Clients access the directory by sending a GET request to the directory URI.
HTTP/1.1 200 OK
Content-Type: application/json
{
"new-nonce": "https://example.com/acme/new-nonce",
"new-account": "https://example.com/acme/new-account",
"new-order": "https://example.com/acme/new-order",
"new-authz": "https://example.com/acme/new-authz",
"revoke-cert": "https://example.com/acme/revoke-cert",
"key-change": "https://example.com/acme/key-change",
"meta": {
"terms-of-service": "https://example.com/acme/terms",
"website": "https://www.example.com/",
"caa-identities": ["example.com"]
}
}
An ACME account resource represents a set of metadata associated with an account. Account resources have the following structure:
{
"contact": [
"mailto:cert-admin@example.com",
"tel:+12025551212"
],
"terms-of-service-agreed": true,
"orders": "https://example.com/acme/acct/1/orders"
}
Each account object includes an “orders” URI from which a list of orders created by the account can be fetched via GET request. The result of the GET request MUST be a JSON object whose “orders” field is an array of URIs, each identifying an order belonging to the account. The server SHOULD include pending orders, and SHOULD NOT include orders that are invalid in the array of URIs. The server MAY return an incomplete list, along with a Link header with a “next” link relation indicating where further entries can be acquired.
HTTP/1.1 200 OK
Content-Type: application/json
Link: href="/acme/acct/1/orders?cursor=2", rel="next"
{
"orders": [
"https://example.com/acme/acct/1/order/1",
"https://example.com/acme/acct/1/order/2",
/* 47 more URLs not shown for example brevity */
"https://example.com/acme/acct/1/order/50"
]
}
An ACME order object represents a client’s request for a certificate and is used to track the progress of that order through to issuance. Thus, the object contains information about the requested certificate, the authorizations that the server requires the client to complete, and any certificates that have resulted from this order.
{
"status": "pending",
"expires": "2015-03-01T14:09:00Z",
"csr": "jcRf4uXra7FGYW5ZMewvV...rhlnznwy8YbpMGqwidEXfE",
"notBefore": "2016-01-01T00:00:00Z",
"notAfter": "2016-01-08T00:00:00Z",
"authorizations": [
"https://example.com/acme/authz/1234",
"https://example.com/acme/authz/2345"
],
"certificate": "https://example.com/acme/cert/1234"
}
The elements of the “authorizations” array are immutable once set. The server MUST NOT change the contents of the “authorizations” array after it is created. If a client observes a change in the contents of the “authorizations” array, then it SHOULD consider the order invalid.
The “authorizations” array in the challenge SHOULD reflect all authorizations that the CA takes into account in deciding to issue, even if some authorizations were fulfilled in earlier orders or in pre-authorization transactions. For example, if a CA allows multiple orders to be fulfilled based on a single authorization transaction, then it SHOULD reflect that authorization in all of the order.
An ACME authorization object represents a server’s authorization for an account to represent an identifier. In addition to the identifier, an authorization includes several metadata fields, such as the status of the authorization (e.g., “pending”, “valid”, or “revoked”) and which challenges were used to validate possession of the identifier.
The structure of an ACME authorization resource is as follows:
The only type of identifier defined by this specification is a fully-qualified domain name (type: “dns”). If a domain name contains non-ASCII Unicode characters it MUST be encoded using the rules defined in [RFC3492]. Servers MUST verify any identifier values that begin with the ASCII Compatible Encoding prefix “xn–” as defined in [RFC5890] are properly encoded. Wildcard domain names (with “*” as the first label) MUST NOT be included in authorization objects.
Section 8 describes a set of challenges for domain name validation.
{
"status": "valid",
"expires": "2015-03-01T14:09:00Z",
"identifier": {
"type": "dns",
"value": "example.org"
},
"challenges": [
{
"type": "http-01",
"status": "valid",
"validated": "2014-12-01T12:05:00Z",
"keyAuthorization": "SXQe-2XODaDxNR...vb29HhjjLPSggwiE"
}
]
}
Before sending a POST request to the server, an ACME client needs to have a fresh anti-replay nonce to put in the “nonce” header of the JWS. In most cases, the client will have gotten a nonce from a previous request. However, the client might sometimes need to get a new nonce, e.g., on its first request to the server or if an existing nonce is no longer valid.
To get a fresh nonce, the client sends a HEAD request to the new-nonce resource on the server. The server’s response MUST include a Replay-Nonce header field containing a fresh nonce, and SHOULD have status code 204 (No Content). The server SHOULD also respond to GET requests for this resource, returning an empty body (while still providing a Replay-Nonce header) with a 204 (No Content) status.
HEAD /acme/new-nonce HTTP/1.1 Host: example.com HTTP/1.1 204 No Content Replay-Nonce: oFvnlFP1wIhRlYS2jTaXbA Cache-Control: no-store
Proxy caching of responses from the new-nonce resource can cause clients receive the same nonce repeatedly, leading to badNonce errors. The server MUST include a Cache-Control header field with the “no-store” directive in responses for the new-nonce resource, in order to prevent caching of this resource.
A client creates a new account with the server by sending a POST request to the server’s new-account URI. The body of the request is a stub account object containing the “contact” field and optionally the “terms-of-service-agreed” field.
POST /acme/new-account HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"jwk": {...},
"nonce": "6S8IqOGY7eL2lsGoTZYifg",
"url": "https://example.com/acme/new-account"
}),
"payload": base64url({
"terms-of-service-agreed": true,
"contact": [
"mailto:cert-admin@example.com",
"tel:+12025551212"
]
}),
"signature": "RZPOnYoPs1PhjszF...-nh6X1qtOFPB519I"
}
The server MUST ignore any values provided in the “orders” fields in account bodies sent by the client, as well as any other fields that it does not recognize. If new fields are specified in the future, the specification of those fields MUST describe whether they can be provided by the client.
In general, the server MUST ignore any fields in the request object that it does not recognize. In particular, it MUST NOT reflect unrecognized fields in the resulting account object. This allows clients to detect when servers do not support an extension field.
The server SHOULD validate that the contact URLs in the “contact” field are valid and supported by the server. If the client provides the server with an invalid or unsupported contact URL, then the server MUST return an error of type “invalidContact”, with a description describing the error and what types of contact URL the server considers acceptable.
The server creates an account and stores the public key used to verify the JWS (i.e., the “jwk” element of the JWS header) to authenticate future requests from the account. The server returns this account object in a 201 (Created) response, with the account URI in a Location header field.
If the server already has an account registered with the provided account key, then it MUST return a response with a 200 (OK) status code and provide the URI of that account in the Location header field. This allows a client that has an account key but not the corresponding account URI to recover the account URI.
If the server wishes to present the client with terms under which the ACME service is to be used, it MUST indicate the URI where such terms can be accessed in the “terms-of-service” subfield of the “meta” field in the directory object, and the server MUST reject new-account requests that do not have the “terms-of-service-agreed” set to “true”. Clients SHOULD NOT automatically agree to terms by default. Rather, they SHOULD require some user interaction for agreement to terms.
HTTP/1.1 201 Created
Content-Type: application/json
Replay-Nonce: D8s4D2mLs8Vn-goWuPQeKA
Location: https://example.com/acme/acct/1
Link: <https://example.com/acme/some-directory>;rel="index"
{
"status": "valid",
"contact": [
"mailto:cert-admin@example.com",
"tel:+12025551212"
]
}
If the client wishes to update this information in the future, it sends a POST request with updated information to the account URI. The server MUST ignore any updates to “order” fields or any other fields it does not recognize.
For example, to update the contact information in the above account, the client could send the following request:
POST /acme/acct/1 HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "ax5RnthDqp_Yf4_HZnFLmA",
"url": "https://example.com/acme/acct/1"
}),
"payload": base64url({
"contact": [
"mailto:certificates@example.com",
"tel:+12125551212"
]
}),
"signature": "hDXzvcj8T6fbFbmn...rDzXzzvzpRy64N0o"
}
Servers SHOULD NOT respond to GET requests for account resources as these requests are not authenticated. If a client wishes to query the server for information about its account (e.g., to examine the “contact” or “certificates” fields), then it SHOULD do so by sending a POST request with an empty update. That is, it should send a JWS whose payload is an empty object ({}).
As described above, a client can indicate its agreement with the CA’s terms of service by setting the “terms-of-service-agreed” field in its account object to “true”.
If the server has changed its terms of service since a client initially agreed, and the server is unwilling to process a request without explicit agreement to the new terms, then it MUST return an error response with status code 403 (Forbidden) and type “urn:ietf:params:acme:error:userActionRequired”. This response MUST include a Link header with link relation “terms-of-service” and the latest terms-of-service URL.
The problem document returned with the error MUST also include an “instance” field, indicating a URL that the client should direct a human user to visit in order for instructions on how to agree to the terms.
HTTP/1.1 403 Forbidden
Replay-Nonce: IXVHDyxIRGcTE0VSblhPzw
Content-Type: application/problem+json
Content-Language: en
{
"type": "urn:ietf:params:acme:error:userActionRequired",
"detail": "Terms of service have changed",
"instance": "http://example.com/agreement/?token=W8Ih3PswD-8"
}
The server MAY require a value to be present for the “external-account-binding” field. This can be used to an ACME account with an existing account in a non-ACME system, such as a CA customer database.
To enable ACME account binding, a CA needs to provision the ACME client with a MAC key and a key identifier. The key identifier MUST be an ASCII string. The MAC key SHOULD be provided in base64url-encoded form, to maximize compatibility between provisioning systems and ACME clients.
The ACME client then computes a binding JWS to indicate the external account’s approval of the ACME account key. The payload of this JWS is the account key being registered, in JWK form. The protected header of the JWS MUST meet the following criteria:
The “signature” field of the JWS will contain the MAC value computed with the MAC key provided by the CA.
POST /acme/new-account HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"jwk": /* account key */,
"nonce": "K60BWPrMQG9SDxBDS_xtSw",
"url": "https://example.com/acme/new-account"
}),
"payload": base64url({
"contact": ["mailto:example@anonymous.invalid"],
"terms-of-service-agreed": true,
"external-account-binding": {
"protected": base64url({
"alg": "HS256",
"kid": /* key identifier from CA */,
"url": "https://example.com/acme/new-account"
}),
"payload": base64url(/* same as in "jwk" above */),
"signature": /* MAC using MAC key from CA */
}
}),
"signature": "5TWiqIYQfIDfALQv...x9C2mg8JGPxl5bI4"
}
When a CA receives a new-account request containing an “external-account-binding” field, it decides whether or not to verify the binding. If the CA does not verify the binding, then it MUST NOT reflect the “external-account-binding” field in the resulting account object (if any). To verify the account binding, the CA MUST take the following steps:
If all of these checks pass and the CA creates a new account, then the CA may consider the new account associated with the external account corresponding to the MAC key and MUST reflect value of the “external-account-binding” field in the resulting account object. If any of these checks fail, then the CA MUST reject the new-account request.
A client may wish to change the public key that is associated with an account in order to recover from a key compromise or proactively mitigate the impact of an unnoticed key compromise.
To change the key associated with an account, the client first constructs a key-change object describing the change that it would like the server to make:
The client then encapsulates the key-change object in a JWS, signed with the requested new account key (i.e., the key matching the “newKey” value).
The outer JWS MUST meet the normal requirements for an ACME JWS (see Section 6.2). The inner JWS MUST meet the normal requirements, with the following exceptions:
This transaction has signatures from both the old and new keys so that the server can verify that the holders of the two keys both agree to the change. The signatures are nested to preserve the property that all signatures on POST messages are signed by exactly one key.
POST /acme/key-change HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"jwk": /* old key */,
"nonce": "K60BWPrMQG9SDxBDS_xtSw",
"url": "https://example.com/acme/key-change"
}),
"payload": base64url({
"protected": base64url({
"alg": "ES256",
"jwk": /* new key */,
"url": "https://example.com/acme/key-change"
}),
"payload": base64url({
"account": "https://example.com/acme/acct/1",
"newKey": /* new key */
}),
"signature": "Xe8B94RD30Azj2ea...8BmZIRtcSKPSd8gU"
}),
"signature": "5TWiqIYQfIDfALQv...x9C2mg8JGPxl5bI4"
}
On receiving key-change request, the server MUST perform the following steps in addition to the typical JWS validation:
If all of these checks pass, then the server updates the corresponding account by replacing the old account key with the new public key and returns status code 200. Otherwise, the server responds with an error status code and a problem document describing the error.
A client can deactivate an account by posting a signed update to the server with a status field of “deactivated.” Clients may wish to do this when the account key is compromised or decommissioned.
POST /acme/acct/1 HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "ntuJWWSic4WVNSqeUmshgg",
"url": "https://example.com/acme/acct/1"
}),
"payload": base64url({
"status": "deactivated"
}),
"signature": "earzVLd3m5M4xJzR...bVTqn7R08AKOVf3Y"
}
The server MUST verify that the request is signed by the account key. If the server accepts the deactivation request, it replies with a 200 (OK) status code and the current contents of the account object.
Once an account is deactivated, the server MUST NOT accept further requests authorized by that account’s key. A server may take a variety of actions in response to an account deactivation, e.g., deleting data related to that account or sending mail to the account’s contacts. Servers SHOULD NOT revoke certificates issued by the deactivated account, since this could cause operational disruption for servers using these certificates. ACME does not provide a way to reactivate a deactivated account.
The client requests certificate issuance by sending a POST request to the server’s new-order resource. The body of the POST is a JWS object whose JSON payload is a subset of the order object defined in Section 7.1.3, containing the fields that describe the certificate to be issued:
POST /acme/new-order HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "5XJ1L3lEkMG7tR6pA00clA",
"url": "https://example.com/acme/new-order"
}),
"payload": base64url({
"csr": "5jNudRx6Ye4HzKEqT5...FS6aKdZeGsysoCo4H9P",
"notBefore": "2016-01-01T00:00:00Z",
"notAfter": "2016-01-08T00:00:00Z"
}),
"signature": "H6ZXtGjTZyUnPeKn...wEA4TklBdh3e454g"
}
The CSR encodes the client’s requests with regard to the content of the certificate to be issued. The CSR MUST indicate the requested identifiers, either in the commonName portion of the requested subject name, or in an extensionRequest attribute [RFC2985] requesting a subjectAltName extension.
The server MUST return an error if it cannot fulfill the request as specified, and MUST NOT issue a certificate with contents other than those requested. If the server requires the request to be modified in a certain way, it should indicate the required changes using an appropriate error type and description.
If the server is willing to issue the requested certificate, it responds with a 201 (Created) response. The body of this response is an order object reflecting the client’s request and any authorizations the client must complete before the certificate will be issued.
HTTP/1.1 201 Created
Replay-Nonce: MYAuvOpaoIiywTezizk5vw
Location: https://example.com/acme/order/asdf
{
"status": "pending",
"expires": "2016-01-01T00:00:00Z",
"csr": "jcRf4uXra7FGYW5ZMewvV...rhlnznwy8YbpMGqwidEXfE",
"notBefore": "2016-01-01T00:00:00Z",
"notAfter": "2016-01-08T00:00:00Z",
"authorizations": [
"https://example.com/acme/authz/1234",
"https://example.com/acme/authz/2345"
]
}
The order object returned by the server represents a promise that if the client fulfills the server’s requirements before the “expires” time, then the server will issue the requested certificate. In the order object, any authorization referenced in the “authorizations” array whose status is “pending” represents an authorization transaction that the client must complete before the server will issue the certificate (see Section 7.5). If the client fails to complete the required actions before the “expires” time, then the server SHOULD change the status of the order to “invalid” and MAY delete the order resource.
The server MUST issue the requested certificate and update the order resource with a URL for the certificate shortly after the client has fulfilled the server’s requirements. If the client has already satisfied the server’s requirements at the time of this request (e.g., by obtaining authorization for all of the identifiers in the certificate in previous transactions), then the server MUST proactively issue the requested certificate and provide a URL for it in the “certificate” field of the order. The server MUST, however, still list the completed authorizations in the “authorizations” array.
Once the client believes it has fulfilled the server’s requirements, it should send a GET request to the order resource to obtain its current state. The status of the order will indicate what action the client should take:
The order process described above presumes that authorization objects are created reactively, in response to a certificate order. Some servers may also wish to enable clients to obtain authorization for an identifier proactively, outside of the context of a specific issuance. For example, a client hosting virtual servers for a collection of names might wish to obtain authorization before any virtual servers are created and only create a certificate when a virtual server starts up.
In some cases, a CA running an ACME server might have a completely external, non-ACME process for authorizing a client to issue for an identifier. In these case, the CA should provision its ACME server with authorization objects corresponding to these authorizations and reflect them as already valid in any orders submitted by the client.
If a CA wishes to allow pre-authorization within ACME, it can offer a “new authorization” resource in its directory by adding the key “new-authz” with a URL for the new authorization resource.
To request authorization for an identifier, the client sends a POST request to the new-authorization resource specifying the identifier for which authorization is being requested and how the server should behave with respect to existing authorizations for this identifier.
POST /acme/new-authz HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"jwk": {...},
"nonce": "uQpSjlRb4vQVCjVYAyyUWg",
"url": "https://example.com/acme/new-authz"
}),
"payload": base64url({
"identifier": {
"type": "dns",
"value": "example.net"
}
}),
"signature": "nuSDISbWG8mMgE7H...QyVUL68yzf3Zawps"
}
Before processing the authorization request, the server SHOULD determine whether it is willing to issue certificates for the identifier. For example, the server should check that the identifier is of a supported type. Servers might also check names against a blacklist of known high-value identifiers. If the server is unwilling to issue for the identifier, it SHOULD return a 403 (Forbidden) error, with a problem document describing the reason for the rejection.
If the server is willing to proceed, it builds a pending authorization object from the inputs submitted by the client.
The server allocates a new URI for this authorization, and returns a 201 (Created) response, with the authorization URI in the Location header field, and the JSON authorization object in the body. The client then follows the process described in Section 7.5 to complete the authorization process.
To download the issued certificate, the client simply sends a GET request to the certificate URL.
The default format of the certificate is application/pem-certificate-chain (see IANA Considerations).
The server MAY provide one or more link relation header fields [RFC5988] with relation “alternate”. Each such field SHOULD express an alternative certificate chain starting with the same end-entity certificate. This can be used to express paths to various trust anchors. Clients can fetch these alternates and use their own heuristics to decide which is optimal.
GET /acme/cert/asdf HTTP/1.1 Host: example.com Accept: application/pkix-cert HTTP/1.1 200 OK Content-Type: application/pem-certificate-chain Link: <https://example.com/acme/some-directory>;rel="index" -----BEGIN CERTIFICATE----- [End-entity certificate contents] -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- [Issuer certificate contents] -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- [Other certificate contents] -----END CERTIFICATE-----
A certificate resource represents a single, immutable certificate. If the client wishes to obtain a renewed certificate, the client initiates a new order process to request one.
Because certificate resources are immutable once issuance is complete, the server MAY enable the caching of the resource by adding Expires and Cache-Control headers specifying a point in time in the distant future. These headers have no relation to the certificate’s period of validity.
The ACME client MAY request other formats by including an Accept header in its request. For example, the client could use the media type application/pkix-cert [RFC2585] to request the end-entity certificate in DER format. Server support for alternate formats is OPTIONAL. For formats that can only express a single certificate, the server SHOULD provide one or more Link: rel="up" headers pointing to an issuer or issuers so that ACME clients can build a certificate chain as defined in TLS.
The identifier authorization process establishes the authorization of an account to manage certificates for a given identifier. This process assures the server of two things:
This process may be repeated to associate multiple identifiers to a key pair (e.g., to request certificates with multiple identifiers), or to associate multiple accounts with an identifier (e.g., to allow multiple entities to manage certificates). The server may declare that an authorization is only valid for a specific order by setting the “scope” field of the authorization to the URI for that order.
Authorization resources are created by the server in response to certificate orders or authorization requests submitted by an account key holder; their URLs are provided to the client in the responses to these requests. The authorization object is implicitly tied to the account key used to sign the request.
When a client receives an order from the server it downloads the authorization resources by sending GET requests to the indicated URLs. If the client initiates authorization using a request to the new authorization resource, it will have already received the pending authorization object in the response to that request.
GET /acme/authz/1234 HTTP/1.1
Host: example.com
HTTP/1.1 200 OK
Content-Type: application/json
Link: <https://example.com/acme/some-directory>;rel="index"
{
"status": "pending",
"expires": "2018-03-03T14:09:00Z",
"identifier": {
"type": "dns",
"value": "example.org"
},
"challenges": [
{
"type": "http-01",
"url": "https://example.com/authz/1234/0",
"token": "DGyRejmCefe7v4NfDGDKfA"
},
{
"type": "tls-sni-02",
"url": "https://example.com/authz/1234/1",
"token": "DGyRejmCefe7v4NfDGDKfA"
},
{
"type": "dns-01",
"url": "https://example.com/authz/1234/2",
"token": "DGyRejmCefe7v4NfDGDKfA"
}
]
}
To prove control of the identifier and receive authorization, the client needs to respond with information to complete the challenges. To do this, the client updates the authorization object received from the server by filling in any required information in the elements of the “challenges” dictionary.
The client sends these updates back to the server in the form of a JSON object with the response fields required by the challenge type, carried in a POST request to the challenge URI (not authorization URI) once it is ready for the server to attempt validation.
For example, if the client were to respond to the “http-01” challenge in the above authorization, it would send the following request:
POST /acme/authz/asdf/0 HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "Q_s3MWoqT05TrdkM2MTDcw",
"url": "https://example.com/acme/authz/asdf/0"
}),
"payload": base64url({
"type": "http-01",
"keyAuthorization": "IlirfxKKXA...vb29HhjjLPSggwiE"
}),
"signature": "9cbg5JO1Gf5YLjjz...SpkUfcdPai9uVYYQ"
}
The server updates the authorization document by updating its representation of the challenge with the response fields provided by the client. The server MUST ignore any fields in the response object that are not specified as response fields for this type of challenge. The server provides a 200 (OK) response with the updated challenge object as its body.
If the client’s response is invalid for any reason or does not provide the server with appropriate information to validate the challenge, then the server MUST return an HTTP error. On receiving such an error, the client SHOULD undo any actions that have been taken to fulfill the challenge, e.g., removing files that have been provisioned to a web server.
The server is said to “finalize” the authorization when it has completed one of the validations, by assigning the authorization a status of “valid” or “invalid”, corresponding to whether it considers the account authorized for the identifier. If the final state is “valid”, then the server MUST include an “expires” field. When finalizing an authorization, the server MAY remove challenges other than the one that was completed, and may modify the “expires” field. The server SHOULD NOT remove challenges with status “invalid”.
Usually, the validation process will take some time, so the client will need to poll the authorization resource to see when it is finalized. For challenges where the client can tell when the server has validated the challenge (e.g., by seeing an HTTP or DNS request from the server), the client SHOULD NOT begin polling until it has seen the validation request from the server.
To check on the status of an authorization, the client sends a GET request to the authorization URI, and the server responds with the current authorization object. In responding to poll requests while the validation is still in progress, the server MUST return a 200 (OK) response and MAY include a Retry-After header field to suggest a polling interval to the client.
GET /acme/authz/asdf HTTP/1.1
Host: example.com
HTTP/1.1 200 OK
{
"status": "valid",
"expires": "2018-09-09T14:09:00Z",
"identifier": {
"type": "dns",
"value": "example.org"
},
"challenges": [
{
"type": "http-01"
"url": "https://example.com/authz/asdf/0",
"status": "valid",
"validated": "2014-12-01T12:05:00Z",
"token": "IlirfxKKXAsHtmzK29Pj8A",
"keyAuthorization": "IlirfxKKXA...vb29HhjjLPSggwiE"
}
]
}
If a client wishes to relinquish its authorization to issue certificates for an identifier, then it may request that the server deactivates each authorization associated with it by sending POST requests with the static object {“status”: “deactivated”} to each authorization URI.
POST /acme/authz/asdf HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "xWCM9lGbIyCgue8di6ueWQ",
"url": "https://example.com/acme/authz/asdf"
}),
"payload": base64url({
"status": "deactivated"
}),
"signature": "srX9Ji7Le9bjszhu...WTFdtujObzMtZcx4"
}
The server MUST verify that the request is signed by the account key corresponding to the account that owns the authorization. If the server accepts the deactivation, it should reply with a 200 (OK) status code and the updated contents of the authorization object.
The server MUST NOT treat deactivated authorization objects as sufficient for issuing certificates.
To request that a certificate be revoked, the client sends a POST request to the ACME server’s revoke-cert URI. The body of the POST is a JWS object whose JSON payload contains the certificate to be revoked:
POST /acme/revoke-cert HTTP/1.1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1", // OR "jwk"
"nonce": "JHb54aT_KTXBWQOzGYkt9A",
"url": "https://example.com/acme/revoke-cert"
}),
"payload": base64url({
"certificate": "MIIEDTCCAvegAwIBAgIRAP8...",
"reason": 1
}),
"signature": "Q1bURgJoEslbD1c5...3pYdSMLio57mQNN4"
}
Revocation requests are different from other ACME requests in that they can be signed either with an account key pair or the key pair in the certificate. Before revoking a certificate, the server MUST verify that the key used to sign the request is authorized to revoke the certificate. The server SHOULD consider at least the following accounts authorized for a given certificate:
The server SHOULD also consider a revocation request valid if it is signed with the private key corresponding to the public key in the certificate.
If the revocation succeeds, the server responds with status code 200 (OK). If the revocation fails, the server returns an error.
HTTP/1.1 200 OK
Replay-Nonce: IXVHDyxIRGcTE0VSblhPzw
Content-Length: 0
--- or ---
HTTP/1.1 403 Forbidden
Replay-Nonce: IXVHDyxIRGcTE0VSblhPzw
Content-Type: application/problem+json
Content-Language: en
{
"type": "urn:ietf:params:acme:error:unauthorized",
"detail": "No authorization provided for name example.net",
"instance": "http://example.com/doc/unauthorized"
}
There are few types of identifiers in the world for which there is a standardized mechanism to prove possession of a given identifier. In all practical cases, CAs rely on a variety of means to test whether an entity applying for a certificate with a given identifier actually controls that identifier.
Challenges provide the server with assurance that an account holder is also the entity that controls an identifier. For each type of challenge, it must be the case that in order for an entity to successfully complete the challenge the entity must both:
Section 10 documents how the challenges defined in this document meet these requirements. New challenges will need to document how they do.
ACME uses an extensible challenge/response framework for identifier validation. The server presents a set of challenges in the authorization object it sends to a client (as objects in the “challenges” array), and the client responds by sending a response object in a POST request to a challenge URI.
This section describes an initial set of challenge types. Each challenge must describe:
Challenge objects all contain the following basic fields:
All additional fields are specified by the challenge type. If the server sets a challenge’s “status” to “invalid”, it SHOULD also include the “error” field to help the client diagnose why the challenge failed.
Different challenges allow the server to obtain proof of different aspects of control over an identifier. In some challenges, like HTTP, TLS SNI, and DNS, the client directly proves its ability to do certain things related to the identifier. The choice of which challenges to offer to a client under which circumstances is a matter of server policy.
The identifier validation challenges described in this section all relate to validation of domain names. If ACME is extended in the future to support other types of identifiers, there will need to be new challenge types, and they will need to specify which types of identifier they apply to.
[[ Editor’s Note: In pre-RFC versions of this specification, challenges are labeled by type, and with the version of the draft in which they were introduced. For example, if an HTTP challenge were introduced in version -03 and a breaking change made in version -05, then there would be a challenge labeled “http-03” and one labeled “http-05” – but not one labeled “http-04”, since challenge in version -04 was compatible with one in version -03. ]]
Several of the challenges in this document make use of a key authorization string. A key authorization is a string that expresses a domain holder’s authorization for a specified key to satisfy a specified challenge, by concatenating the token for the challenge with a key fingerprint, separated by a “.” character:
key-authz = token || '.' || base64url(JWK_Thumbprint(accountKey))
The “JWK_Thumbprint” step indicates the computation specified in [RFC7638], using the SHA-256 digest [FIPS180-4]. As noted in JWA [RFC7518] any prepended zero octets in the JWK object MUST be stripped before doing the computation.
As specified in the individual challenges below, the token for a challenge is a string comprised entirely of characters in the URL-safe base64 alphabet. The “||” operator indicates concatenation of strings.
With HTTP validation, the client in an ACME transaction proves its control over a domain name by proving that for that domain name it can provision resources to be returned by an HTTP server. The ACME server challenges the client to provision a file at a specific path, with a specific string as its content.
As a domain may resolve to multiple IPv4 and IPv6 addresses, the server will connect to at least one of the hosts found in the DNS A and AAAA records, at its discretion. Because many web servers allocate a default HTTPS virtual host to a particular low-privilege tenant user in a subtle and non-intuitive manner, the challenge must be completed over HTTP, not HTTPS.
GET /acme/authz/1234/0 HTTP/1.1
Host: example.com
HTTP/1.1 200 OK
{
"type": "http-01",
"url": "https://example.com/acme/authz/0",
"status": "pending",
"token": "evaGxfADs6pSRb2LAv9IZf17"
}
A client responds to this challenge by constructing a key authorization from the “token” value provided in the challenge and the client’s account key. The client then provisions the key authorization as a resource on the HTTP server for the domain in question.
The path at which the resource is provisioned is comprised of the fixed prefix “.well-known/acme-challenge/”, followed by the “token” value in the challenge. The value of the resource MUST be the ASCII representation of the key authorization.
GET .well-known/acme-challenge/evaGxfADs6pSRb2LAv9IZf17 Host: example.com HTTP/1.1 200 OK LoqXcYV8q5ONbJQxbmR7SCTNo3tiAXDfowyjxAjEuX0.9jg46WB3rR_AHD-EBXdN7cBkH1WOu0tA3M9fm21mqTI
The client’s response to this challenge indicates its agreement to this challenge by sending the server the key authorization covering the challenge’s token and the client’s account key.
POST /acme/authz/1234/0
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "JHb54aT_KTXBWQOzGYkt9A",
"url": "https://example.com/acme/authz/1234/0"
}),
"payload": base64url({
"keyAuthorization": "evaGxfADs...62jcerQ"
}),
"signature": "Q1bURgJoEslbD1c5...3pYdSMLio57mQNN4"
}
On receiving a response, the server MUST verify that the key authorization in the response matches the “token” value in the challenge and the client’s account key. If they do not match, then the server MUST return an HTTP error in response to the POST request in which the client sent the challenge.
Given a challenge/response pair, the server verifies the client’s control of the domain by verifying that the resource was provisioned as expected.
The server SHOULD follow redirects when dereferencing the URI.
If all of the above verifications succeed, then the validation is successful. If the request fails, or the body does not pass these checks, then it has failed.
The TLS with Server Name Indication (TLS SNI) validation method proves control over a domain name by requiring the client to configure a TLS server referenced by the DNS A and AAAA resource records for the domain name to respond to specific connection attempts utilizing the Server Name Indication extension [RFC6066]. The server verifies the client’s challenge by accessing the TLS server and verifying a particular certificate is presented.
GET /acme/authz/1234/1 HTTP/1.1
Host: example.com
HTTP/1.1 200 OK
{
"type": "tls-sni-02",
"url": "https://example.com/acme/authz/1234/1",
"status": "pending",
"token": "evaGxfADs6pSRb2LAv9IZf17Dt3juxGJ-PCt92wr-oA"
}
A client responds to this challenge by constructing a self-signed certificate which the client MUST provision at the domain name concerned in order to pass the challenge.
The certificate may be constructed arbitrarily, except that each certificate MUST have exactly two subjectAlternativeNames, SAN A and SAN B. Both MUST be dNSNames.
SAN A MUST be constructed as follows: compute the SHA-256 digest [FIPS180-4] of the challenge token and encode it in lowercase hexadecimal form. The dNSName is “x.y.token.acme.invalid”, where x is the first half of the hexadecimal representation and y is the second half.
SAN B MUST be constructed as follows: compute the SHA-256 digest of the key authorization and encode it in lowercase hexadecimal form. The dNSName is “x.y.ka.acme.invalid” where x is the first half of the hexadecimal representation and y is the second half.
The client MUST ensure that the certificate is served to TLS connections specifying a Server Name Indication (SNI) value of SAN A.
The response to the TLS-SNI challenge simply acknowledges that the client is ready to fulfill this challenge.
POST /acme/authz/1234/1
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "JHb54aT_KTXBWQOzGYkt9A",
"url": "https://example.com/acme/authz/1234/1"
}),
"payload": base64url({
"keyAuthorization": "evaGxfADs...62jcerQ"
}),
"signature": "Q1bURgJoEslbD1c5...3pYdSMLio57mQNN4"
}
On receiving a response, the server MUST verify that the key authorization in the response matches the “token” value in the challenge and the client’s account key. If they do not match, then the server MUST return an HTTP error in response to the POST request in which the client sent the challenge.
Given a challenge/response pair, the ACME server verifies the client’s control of the domain by verifying that the TLS server was configured appropriately, using these steps:
It is RECOMMENDED that the server opens multiple TLS connections from various network perspectives, in order to make MitM attacks harder.
If all of the above verifications succeed, then the validation is successful. Otherwise, the validation fails.
When the identifier being validated is a domain name, the client can prove control of that domain by provisioning a TXT resource record containing a designated value for a specific validation domain name.
GET /acme/authz/1234/2 HTTP/1.1
Host: example.com
HTTP/1.1 200 OK
{
"type": "dns-01",
"url": "https://example.com/acme/authz/1234/2",
"status": "pending",
"token": "evaGxfADs6pSRb2LAv9IZf17Dt3juxGJ-PCt92wr-oA"
}
A client responds to this challenge by constructing a key authorization from the “token” value provided in the challenge and the client’s account key. The client then computes the SHA-256 digest [FIPS180-4] of the key authorization.
The record provisioned to the DNS is the base64url encoding of this digest. The client constructs the validation domain name by prepending the label “_acme-challenge” to the domain name being validated, then provisions a TXT record with the digest value under that name. For example, if the domain name being validated is “example.com”, then the client would provision the following DNS record:
_acme-challenge.example.com. 300 IN TXT "gfj9Xq...Rg85nM"
The response to the DNS challenge provides the computed key authorization to acknowledge that the client is ready to fulfill this challenge.
POST /acme/authz/1234/2
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "JHb54aT_KTXBWQOzGYkt9A",
"url": "https://example.com/acme/authz/1234/2"
}),
"payload": base64url({
"keyAuthorization": "evaGxfADs...62jcerQ"
}),
"signature": "Q1bURgJoEslbD1c5...3pYdSMLio57mQNN4"
}
On receiving a response, the server MUST verify that the key authorization in the response matches the “token” value in the challenge and the client’s account key. If they do not match, then the server MUST return an HTTP error in response to the POST request in which the client sent the challenge.
To validate a DNS challenge, the server performs the following steps:
If all of the above verifications succeed, then the validation is successful. If no DNS record is found, or DNS record and response payload do not pass these checks, then the validation fails.
There may be cases where a server cannot perform automated validation of an identifier, for example, if validation requires some manual steps. In such cases, the server may provide an “out of band” (OOB) challenge to request that the client perform some action outside of ACME in order to validate possession of the identifier.
The OOB challenge requests that the client have a human user visit a web page to receive instructions on how to validate possession of the identifier, by providing a URL for that web page.
GET /acme/authz/1234/3 HTTP/1.1
Host: example.com
HTTP/1.1 200 OK
{
"type": "oob-01",
"href": "https://example.com/validate/evaGxfADs6pSRb2LAv9IZ"
}
A client responds to this challenge by presenting the indicated URL for a human user to navigate to. If the user chooses to complete this challenge (by visiting the website and completing its instructions), the client indicates this by sending a simple acknowledgement response to the server.
POST /acme/authz/1234/3
Host: example.com
Content-Type: application/jose+json
{
"protected": base64url({
"alg": "ES256",
"kid": "https://example.com/acme/acct/1",
"nonce": "JHb54aT_KTXBWQOzGYkt9A",
"url": "https://example.com/acme/authz/1234/3"
}),
"payload": base64url({
"type": "oob-01"
}),
"signature": "Q1bURgJoEslbD1c5...3pYdSMLio57mQNN4"
}
On receiving a response, the server MUST verify that the value of the “type” field is “oob-01”. Otherwise, the steps the server takes to validate identifier possession are determined by the server’s local policy.
The “Media Types” registry should be updated with the following additional value:
MIME media type name: application
MIME subtype name: pem-certificate-chain
Required parameters: None
Optional parameters: None
Encoding considerations: None
Security considerations: Carries a cryptographic certificate
Interoperability considerations: None
Published specification: draft-ietf-acme-acme [[ RFC EDITOR: Please replace draft-ietf-acme-acme above with the RFC number assigned to this ]]
Applications which use this media type: Any MIME-complaint transport
Additional information:
File should contain one or more certificates encoded as PEM according to RFC 7468. In order to provide easy interoperation with TLS, the first certificate MUST be an end-entity certificate. Each following certificate SHOULD directly certify one preceding it. Because certificate validation requires that trust anchors be distributed independently, a certificate that specifies a trust anchor MAY be omitted from the chain, provided that supported peers are known to possess any omitted certificates.
The “Well-Known URIs” registry should be updated with the following additional value (using the template from [RFC5785]):
URI suffix: acme-challenge
Change controller: IETF
Specification document(s): This document, Section Section 8.2
Related information: N/A
The “Message Headers” registry should be updated with the following additional value:
| Header Field Name | Protocol | Status | Reference |
|---|---|---|---|
| Replay-Nonce | http | standard | Section 6.4.1 |
The “JSON Web Signature and Encryption Header Parameters” registry should be updated with the following additional value:
[[ RFC EDITOR: Please replace XXXX above with the RFC number assigned to this document ]]
The “JSON Web Signature and Encryption Header Parameters” registry should be updated with the following additional value:
[[ RFC EDITOR: Please replace XXXX above with the RFC number assigned to this document ]]
The “IETF URN Sub-namespace for Registered Protocol Parameter Identifiers” registry should be updated with the following additional value, following the template in [RFC3553]:
[[ RFC EDITOR: Please replace XXXX above with the RFC number assigned to this document, and replace URL-TBD with the URL assigned by IANA for registries of ACME parameters. ]]
This document requests that IANA create the following new registries:
All of these registries are under a heading of “Automated Certificate Management Environment (ACME) Protocol” and are administered under a Specification Required policy [RFC5226].
This registry lists field names that are defined for use in ACME account objects. Fields marked as “configurable” may be included in a new-account request.
Template:
Initial contents: The fields and descriptions defined in Section 7.1.2.
| Field Name | Field Type | Configurable | Reference |
|---|---|---|---|
| key | object | false | RFC XXXX |
| status | string | false | RFC XXXX |
| contact | array of string | true | RFC XXXX |
| external-account-binding | object | true | RFC XXXX |
| terms-of-service-agreed | boolean | true | RFC XXXX |
| orders | array of string | false | RFC XXXX |
This registry lists field names that are defined for use in ACME order objects. Fields marked as “configurable” may be included in a new-order request.
Template:
Initial contents: The fields and descriptions defined in Section 7.1.3.
| Field Name | Field Type | Configurable | Reference |
|---|---|---|---|
| status | string | false | RFC XXXX |
| expires | string | false | RFC XXXX |
| csr | string | true | RFC XXXX |
| notBefore | string | true | RFC XXXX |
| notAfter | string | true | RFC XXXX |
| authorizations | array of string | false | RFC XXXX |
| certificate | string | false | RFC XXXX |
This registry lists values that are used within URN values that are provided in the “type” field of problem documents in ACME.
Template:
Initial contents: The types and descriptions in the table in Section 6.6 above, with the Reference field set to point to this specification.
This registry lists the types of resources that ACME servers may list in their directory objects.
Template:
Initial contents:
| Key | Resource type | Reference |
|---|---|---|
| new-account | New account | RFC XXXX |
| new-order | New order | RFC XXXX |
| revoke-cert | Revoke certificate | RFC XXXX |
| key-change | Key change | RFC XXXX |
[[ RFC EDITOR: Please replace XXXX above with the RFC number assigned to this document ]]
This registry lists the types of identifiers in certificates that ACME clients may request authorization to issue.
Template:
Initial contents:
| Label | Reference |
|---|---|
| dns | RFC XXXX |
[[ RFC EDITOR: Please replace XXXX above with the RFC number assigned to this document ]]
This registry lists the ways that ACME servers can offer to validate control of an identifier. The “Identifier Type” field in the template must be contained in the Label column of the ACME Identifier Types registry.
Template:
Initial Contents
| Label | Identifier Type | Reference |
|---|---|---|
| http | dns | RFC XXXX |
| tls-sni | dns | RFC XXXX |
| dns | dns | RFC XXXX |
[[ RFC EDITOR: Please replace XXXX above with the RFC number assigned to this document ]]
ACME is a protocol for managing certificates that attest to identifier/key bindings. Thus the foremost security goal of ACME is to ensure the integrity of this process, i.e., to ensure that the bindings attested by certificates are correct and that only authorized entities can manage certificates. ACME identifies clients by their account keys, so this overall goal breaks down into two more precise goals:
In this section, we discuss the threat model that underlies ACME and the ways that ACME achieves these security goals within that threat model. We also discuss the denial-of-service risks that ACME servers face, and a few other miscellaneous considerations.
As a service on the Internet, ACME broadly exists within the Internet threat model [RFC3552]. In analyzing ACME, it is useful to think of an ACME server interacting with other Internet hosts along two “channels”:
+------------+
| ACME | ACME Channel
| Client |--------------------+
+------------+ |
V
+------------+
| ACME |
| Server |
+------------+
+------------+ |
| Validation |<-------------------+
| Server | Validation Channel
+------------+
In practice, the risks to these channels are not entirely separate, but they are different in most cases. Each channel, for example, uses a different communications pattern: the ACME channel will comprise inbound HTTPS connections to the ACME server and the validation channel outbound HTTP or DNS requests.
Broadly speaking, ACME aims to be secure against active and passive attackers on any individual channel. Some vulnerabilities arise (noted below) when an attacker can exploit both the ACME channel and one of the others.
On the ACME channel, in addition to network layer attackers, we also need to account for man-in-the-middle (MitM) attacks at the application layer, and for abusive use of the protocol itself. Protection against application layer MitM addresses potential attackers such as Content Distribution Networks (CDNs) and middleboxes with a TLS MitM function. Preventing abusive use of ACME means ensuring that an attacker with access to the validation channel can’t obtain illegitimate authorization by acting as an ACME client (legitimately, in terms of the protocol).
ACME allows anyone to request challenges for an identifier by registering an account key and sending a new-order request using that account key. The integrity of the authorization process thus depends on the identifier validation challenges to ensure that the challenge can only be completed by someone who both (1) holds the private key of the account key pair, and (2) controls the identifier in question.
Validation responses need to be bound to an account key pair in order to avoid situations where an ACME MitM can switch out a legitimate domain holder’s account key for one of his choosing, e.g.:
All of the challenges above have a binding between the account private key and the validation query made by the server, via the key authorization. The key authorization is signed by the account private key, reflects the corresponding public key, and is provided to the server in the validation response.
The association of challenges to identifiers is typically done by requiring the client to perform some action that only someone who effectively controls the identifier can perform. For the challenges in this document, the actions are:
There are several ways that these assumptions can be violated, both by misconfiguration and by attacks. For example, on a web server that allows non-administrative users to write to .well-known, any user can claim to own the web server’s hostname by responding to an HTTP challenge, and likewise for TLS configuration and TLS SNI.
The use of hosting providers is a particular risk for ACME validation. If the owner of the domain has outsourced operation of DNS or web services to a hosting provider, there is nothing that can be done against tampering by the hosting provider. As far as the outside world is concerned, the zone or website provided by the hosting provider is the real thing.
More limited forms of delegation can also lead to an unintended party gaining the ability to successfully complete a validation transaction. For example, suppose an ACME server follows HTTP redirects in HTTP validation and a website operator provisions a catch-all redirect rule that redirects requests for unknown resources to a different domain. Then the target of the redirect could use that to get a certificate through HTTP validation since the validation path will not be known to the primary server.
The DNS is a common point of vulnerability for all of these challenges. An entity that can provision false DNS records for a domain can attack the DNS challenge directly and can provision false A/AAAA records to direct the ACME server to send its TLS SNI or HTTP validation query to a remote server of the attacker’s choosing. There are a few different mitigations that ACME servers can apply:
Given these considerations, the ACME validation process makes it impossible for any attacker on the ACME channel or a passive attacker on the validation channel to hijack the authorization process to authorize a key of the attacker’s choice.
An attacker that can only see the ACME channel would need to convince the validation server to provide a response that would authorize the attacker’s account key, but this is prevented by binding the validation response to the account key used to request challenges. A passive attacker on the validation channel can observe the correct validation response and even replay it, but that response can only be used with the account key for which it was generated.
An active attacker on the validation channel can subvert the ACME process, by performing normal ACME transactions and providing a validation response for his own account key. The risks due to hosting providers noted above are a particular case.
It is RECOMMENDED that the server perform DNS queries and make HTTP and TLS connections from various network perspectives, in order to make MitM attacks harder.
As a protocol run over HTTPS, standard considerations for TCP-based and HTTP-based DoS mitigation also apply to ACME.
At the application layer, ACME requires the server to perform a few potentially expensive operations. Identifier validation transactions require the ACME server to make outbound connections to potentially attacker-controlled servers, and certificate issuance can require interactions with cryptographic hardware.
In addition, an attacker can also cause the ACME server to send validation requests to a domain of its choosing by submitting authorization requests for the victim domain.
All of these attacks can be mitigated by the application of appropriate rate limits. Issues closer to the front end, like POST body validation, can be addressed using HTTP request limiting. For validation and certificate requests, there are other identifiers on which rate limits can be keyed. For example, the server might limit the rate at which any individual account key can issue certificates or the rate at which validation can be requested within a given subtree of the DNS. And in order to prevent attackers from circumventing these limits simply by minting new accounts, servers would need to limit the rate at which accounts can be registered.
Server-Side Request Forgery (SSRF) attacks can arise when an attacker can cause a server to perform HTTP requests to an attacker-chosen URL. In the ACME HTTP challenge validation process, the ACME server performs an HTTP GET request to a URL in which the attacker can choose the domain. This request is made before the server has verified that the client controls the domain, so any client can cause a query to any domain.
Some server implementations include information from the validation server’s response (in order to facilitate debugging). Such implementations enable an attacker to extract this information from any web server that is accessible to the ACME server, even if it is not accessible to the ACME client.
It might seem that the risk of SSRF through this channel is limited by the fact that the attacker can only control the domain of the URL, not the path. However, if the attacker first sets the domain to one they control, then they can send the server an HTTP redirect (e.g., a 302 response) which will cause the server to query an arbitrary URI.
In order to further limit the SSRF risk, ACME server operators should ensure that validation queries can only be sent to servers on the public Internet, and not, say, web services within the server operator’s internal network. Since the attacker could make requests to these public servers himself, he can’t gain anything extra through an SSRF attack on ACME aside from a layer of anonymization.
The controls on issuance enabled by ACME are focused on validating that a certificate applicant controls the identifier he claims. Before issuing a certificate, however, there are many other checks that a CA might need to perform, for example:
CAs that use ACME to automate issuance will need to ensure that their servers perform all necessary checks before issuing.
CAs using ACME to allow clients to agree to terms of service should keep in mind that ACME clients can automate this agreement, possibly not involving a human user. If a CA wishes to have stronger evidence of user consent, it may present an out-of-band requirement or challenge to require human involvement.
There are certain factors that arise in operational reality that operators of ACME-based CAs will need to keep in mind when configuring their services. For example:
As noted above, DNS forgery attacks against the ACME server can result in the server making incorrect decisions about domain control and thus mis-issuing certificates. Servers SHOULD perform DNS queries over TCP, which provides better resistance to some forgery attacks than DNS over UDP.
An ACME-based CA will often need to make DNS queries, e.g., to validate control of DNS names. Because the security of such validations ultimately depends on the authenticity of DNS data, every possible precaution should be taken to secure DNS queries done by the CA. It is therefore RECOMMENDED that ACME-based CAs make all DNS queries via DNSSEC-validating stub or recursive resolvers. This provides additional protection to domains which choose to make use of DNSSEC.
An ACME-based CA must use only a resolver if it trusts the resolver and every component of the network route by which it is accessed. It is therefore RECOMMENDED that ACME-based CAs operate their own DNSSEC-validating resolvers within their trusted network and use these resolvers both for both CAA record lookups and all record lookups in furtherance of a challenge scheme (A, AAAA, TXT, etc.).
In many cases, TLS-based services are deployed on hosted platforms that use the Server Name Indication (SNI) TLS extension to distinguish between different hosted services or “virtual hosts”. When a client initiates a TLS connection with an SNI value indicating a provisioned host, the hosting platform routes the connection to that host.
When a connection comes in with an unknown SNI value, one might expect the hosting platform to terminate the TLS connection. However, some hosting platforms will choose a virtual host to be the “default”, and route connections with unknown SNI values to that host.
In such cases, the owner of the default virtual host can complete a TLS-based challenge (e.g., “tls-sni-02”) for any domain with an A record that points to the hosting platform. This could result in mis-issuance in cases where there are multiple hosts with different owners resident on the hosting platform.
A CA that accepts TLS-based proof of domain control should attempt to check whether a domain is hosted on a domain with a default virtual host before allowing an authorization request for this host to use a TLS-based challenge. Typically, systems with default virtual hosts do not allow the holder of the default virtual host to control what certificates are presented on a request-by-request basis. Rather, the default virtual host can configure which certificate is presented in TLS on a fairly static basis, so that the certificate presented should be stable over small intervals.
A CA can detect such a bounded default vhost by initiating TLS connections to the host with random SNI values within the namespace used for the TLS-based challenge (the “acme.invalid” namespace for “tls-sni-02”). If it receives the same certificate on two different connections, then it is very likely that the server is in a default virtual host configuration. Conversely, if the TLS server returns an unrecognized_name alert, then this is an indication that the server is not in a default virtual host configuration.
In addition to the editors listed on the front page, this document has benefited from contributions from a broad set of contributors, all the way back to its inception.
This document draws on many concepts established by Eric Rescorla’s “Automated Certificate Issuance Protocol” draft. Martin Thomson provided helpful guidance in the use of HTTP.
| [I-D.vixie-dnsext-dns0x20] | Vixie, P. and D. Dagon, "Use of Bit 0x20 in DNS Labels to Improve Transaction Identity", Internet-Draft draft-vixie-dnsext-dns0x20-00, March 2008. |
| [RFC3552] | Rescorla, E. and B. Korver, "Guidelines for Writing RFC Text on Security Considerations", BCP 72, RFC 3552, DOI 10.17487/RFC3552, July 2003. |
| [RFC3553] | Mealling, M., Masinter, L., Hardie, T. and G. Klyne, "An IETF URN Sub-namespace for Registered Protocol Parameters", BCP 73, RFC 3553, DOI 10.17487/RFC3553, June 2003. |
| [RFC5785] | Nottingham, M. and E. Hammer-Lahav, "Defining Well-Known Uniform Resource Identifiers (URIs)", RFC 5785, DOI 10.17487/RFC5785, April 2010. |
| [W3C.CR-cors-20130129] | Kesteren, A., "Cross-Origin Resource Sharing", World Wide Web Consortium CR CR-cors-20130129, January 2013. |