]> AS207960 Cyfyngedig

13 Pen-y-lan Terrace Caerdydd CF23 9EU United Kingdom q@as207960.net q@magicalcodewit.ch https://magicalcodewit.ch

SEC acme tor hidden service onion service caa dns This document defines extensions to the Automated Certificate Management Environment (ACME) to allow for the automatic issuance of certificates to Tor Hidden Services (".onion" Special-Use Domain Names). Discussion Source for this draft and an issue tracker can be found at . The project website and a reference implementation can be found at .

Introduction The Tor network has the ability to host "Onion Services" only accessible via the Tor network. These services use the ".onion" Special-Use Domain Name to identify these services. These can be used as any other domain name could, but they do not form part of the DNS infrastructure. The Automated Certificate Management Environment (ACME) defines challenges for validating control of DNS identifiers, and whilst a ".onion" Special-Use Domain Name may appear as a DNS name, it requires special consideration to validate control of one such that ACME could be used on ".onion" Special-Use Domain Names. In order to allow ACME to be utilized to issue certificates to ".onion" Special-Use Domain Names, this document specifies challenges suitable to validate control of these Special-Use Domain Names. Additionally, this document defines an alternative to the DNS Certification Authority Authorization (CAA) Resource Record that can be used with ".onion" Special-Use Domain Names.

Requirements Language The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here.

Identifier defines the "dns" identifier type. This identifier type MUST be used when requesting a certificate for a ".onion" Special-Use Domain Name. The value of the identifier MUST be the textual representation as defined in the "Special Hostnames in Tor - .onion" section of . The value MAY include subdomain labels. Version 2 addresses MUST NOT be used as these are now considered insecure. Example identifiers (line breaks have been added for readability only):

Identifier Validation Challenges The CA/Browser Forum Baseline Requirements define methods accepted by the CA industry for validation of ".onion" Special-Use Domain Names (see ). This document incorporates these methods into ACME challenges.

Existing Challenges

Existing: "dns-01" Challenge The existing "dns-01" challenge MUST NOT be used to validate ".onion" Special-Use Domain Names as these domains are not part of the DNS.

Existing: http-01 Challenge The http-01 challenge, as defined in , MAY be used to validate a ".onion" Special-Use Domain Name with the modifications defined in this document, namely those described in Sections and . The ACME server SHOULD follow redirects. Note that these MAY be redirects to services that are not ".onion" and that the server SHOULD honor these. For example, clients might use redirects so that the response can be provided by a centralized certificate management server. See for security considerations on why a server might not want to follow redirects.

Existing tls-alpn-01 Challenge The tls-alpn-01 challenge, as defined in , MAY be used to validate a ".onion" Special-Use Domain Name with the modifications defined in this document, namely those described in Sections and .

New onion-csr-01 Challenge The two ACME-defined methods allowed by CA/BF described in Sections and (http-01 and tls-alpn-01) do not allow issuance of wildcard certificates. A ".onion" Special-Use Domain Name can have subdomains (just like any other domain in the DNS), and a site operator may find it useful to have one certificate for all virtual hosts on their site. This new validation method incorporates the specially signed Certificate Signing Request (CSR) (as defined by ) into ACME to allow for the issuance of wildcard certificates. To this end, a new challenge called onion-csr-01 is defined, with the following fields:

type (required, string):

The string onion-csr-01.

nonce (required, string):

A Base64-encoded nonce including padding characters. It MUST contain at least 64 bits of entropy. A response generated using this nonce MUST NOT be accepted by the ACME server if the nonce used was generated by the server more than 30 days prior (as per ).

authKey (optional, object):

The ACME server's Ed25519 public key encoded as per . This is further defined in .

An onion-csr-01 challenge MUST NOT be used to issue certificates for Special-Use Domain Names that are not ".onion". Clients prove control over the key associated with the ".onion" service by generating a Certificate Request (CSR) with the following additional extension attributes and signing it with the private key of the ".onion" Special-Use Domain Name:

• A caSigningNonce attribute containing the nonce provided in the challenge. This MUST be raw bytes and not the base64 encoded value provided in the challenge object.
• An applicantSigningNonce attribute containing a nonce generated by the client. This MUST have at least 64 bits of entropy. This MUST be raw bytes.

These additional attributes have the following format The subject of the CSR need not be meaningful and CAs MUST NOT validate its contents. The public key presented in this CSR MUST be the public key corresponding to the ".onion" Special-Use Domain Name being validated. It MUST NOT be the same public key presented in the CSR to finalize the order. Clients respond with the following object to validate the challenge:

csr (required, string):

The CSR in the base64url-encoded version of the DER format. (Note: Because this field uses base64url, and does not include headers, it is different from Privacy Enhanced Mail (PEM).)

When presented with the CSR, the server verifies it in the following manner:

1. The CSR is a well formatted PKCS#10 request.
2. The public key in the CSR corresponds to the ".onion" Special-Use Domain Name being validated.
3. The signature over the CSR validates with the ".onion" Special-Use Domain Name public key.
4. The caSigningNonce attribute is present and its contents match the nonce provided to the client.
5. The applicantSigningNonce attribute is present and contains at least 64 bits of entropy.

If all of the above are successful then validation succeeds, otherwise it has failed.

Client Authentication to Hidden Services Some Hidden Services do not wish to be accessible to the entire Tor network, and so they encrypt their Hidden Service Descriptor with the keys of clients authorized to connect. Without a way for the CA to signal what key it will use to connect, these services will not be able to obtain a certificate using http-01 or tls-alpn-01, nor enforce CAA with any validation method. To this end, an additional field in the challenge object is defined to allow the ACME server to advertise the Ed25519 public key it will use (as per the "Authentication during the introduction phase" section of ) to authenticate itself when retrieving the Hidden Service Descriptor.

authKey (optional, object):

The ACME server's Ed25519 public key encoded as per .

ACME servers MUST NOT use the same public key with multiple Hidden Services. ACME servers MAY reuse public keys for re-validation of the same Hidden Service. There is no method to communicate to the CA that client authentication is necessary; instead, the ACME server MUST attempt to calculate its CLIENT-ID as per the "Client behavior" section of . If no auth-client line in the First Layer Hidden Service Descriptor matches the computed client-id, then the server MUST assume that the Hidden Service does not require client authentication and proceed accordingly. In the case in which the Ed25519 public key is novel to the client, it will have to resign and republish its Hidden Service Descriptor. It MUST wait some (indeterminate) amount of time for the new descriptor to propagate the Tor Hidden Service directory servers before proceeding with responding to the challenge. This should take no more than a few minutes. This specification does not set a fixed time as changes in the operation of the Tor network can affect this propagation time in the future. ACME servers MUST NOT expire challenges before a reasonable time to allow publication of the new descriptor. It is RECOMMENDED the server allow at least 30 minutes; however, it is entirely up to operator preference.

ACME over Hidden Services A CA offering certificates to ".onion" Special-Use Domain Names SHOULD make their ACME server available as a Tor Hidden Service. ACME clients SHOULD also support connecting to ACME servers over Tor, regardless of their support of onion-csr-01, as their existing http-01 and tls-alpn-01 implementations could be used to obtain certificates for ".onion" Special-Use Domain Names.

Certification Authority Authorization (CAA) ".onion" Special-Use Domain Names are not part of the DNS; as such, a variation on CAA is necessary to allow restrictions to be placed on certificate issuance. To this end, a new field is added to the Second Layer Hidden Service Descriptor, as defined in the "Second layer plaintext format" section of with the following format (defined using the notation from the "netdoc document meta-format" section of ): The presentation format is provided above purely for the convenience of the reader and implementors: the canonical version remains that defined in , or future updates to the same. The contents of "flags", "tag", and "value" are as per . Multiple CAA records MAY be present, as is the case in the DNS. CAA records in a Hidden Service Descriptor are to be treated the same by CAs as if they had been in the DNS for the ".onion" Special-Use Domain Name. A Hidden Service's Second Layer Descriptor using CAA could look something like the following (additional line breaks have been added for readability):

Relevant Resource Record Set In the absence of the possibility for delegation of subdomains from a ".onion" Special-Use Domain Name, as there is in the DNS, there is no need, nor indeed any method available, to search up the DNS tree for a relevant CAA record set. Similarly, it is also impossible to check CAA records on the "onion" Special-Use Top-Level Domain (TLD), as it does not exist in any form except as described in ; therefore, implementors MUST NOT look there either. Instead, all subdomains under a ".onion" Special-Use Domain Name share the same CAA record set. That is, all of these share a CAA record set with "a.onion":

• b.a.onion
• c.a.onion
• e.d.a.onion

but these do not:

• b.c.onion
• c.d.onion
• e.c.d.onion
• a.b.onion

When to Check CAA If the Hidden Service has client authentication enabled, then it will be impossible for the ACME server to decrypt the Second Layer Hidden Service Descriptor to read the CAA records until the ACME server's public key has been added to the First Layer Hidden Service Descriptor. To this end, an ACME server MUST wait until the client responds to an authorization before checking the CAA and treat this response as an indication that their public key has been added and that the ACME server will be able to decrypt the Second Layer Hidden Service Descriptor.

Preventing Mis-Issuance by Unknown CAs In the case of a Hidden Service requiring client authentication, the CA will be unable to read the hidden service's CAA records without the Hidden Service trusting an ACME server's public key -- as the CAA records are in the Second Layer Hidden Service Descriptor. A method is necessary to signal that there are CAA records present (but not reveal their contents, which, in certain circumstances, would unwantedly disclose information about the Hidden Service operator). To this end, a new field is added to the First Layer Hidden Service Descriptor in the "First layer plaintext format" section of with the following format (defined using the notation from the "netdoc document meta-format" section of ): If an ACME server encounters this flag, it MUST NOT proceed with issuance until it can decrypt and parse the CAA records from the Second Layer Hidden Service Descriptor.

Alternative In-Band Presentation of CAA An ACME server might be unwilling to operate the infrastructure required to fetch, decode, and verify Tor Hidden Service Descriptors in order to check CAA records. To this end a method to signal CAA policies in-band of ACME is defined. If a Hidden Service does use this method to provide CAA records to an ACME server, it SHOULD still publish CAA records if its CAA record set includes "iodef", "contactemail", or "contactphone" so that this information is still publicly accessible. Additionally, a Hidden Service operator MAY not wish to publish a CAA record set in its Hidden Service Descriptor to avoid revealing information about the service operator. If an ACME server receives a validly signed CAA record set in the finalize request, it MAY proceed with issuance on the basis of the client-provided CAA record set only, without checking the CAA set in the Hidden Service. Alternatively, an ACME server MAY ignore the client provided record set and fetch the record set from the Hidden Service Descriptor. In any case, the server MAY fetch the record set from the Hidden Service Descriptor. If an ACME server receives a validly signed CAA record set in the finalize request, it need not check the CAA set in the Hidden Service Descriptor and can proceed with issuance on the basis of the client-provided CAA record set only. An ACME server MAY ignore the client-provided record set and is free to always fetch the record set from the Hidden Service Descriptor. A new field is defined in the ACME finalize endpoint to contain the Hidden Service's CAA record set for each ".onion" Special-Use Domain Name in the order.

onionCAA (optional, dictionary of objects):

The CAA record set for each ".onion" Special-Use Domain Name in the order. The key is the ".onion" Special-Use Domain Name, and the value is an object with the fields described below.

The contents of the values of the "onionCAA" object are as follows:

caa (required, string or null):

The CAA record set as a string, encoded in the same way as if was included in the Hidden Service Descriptor. If the Hidden Service does not have a CAA record set, then this MUST be null.

expiry (required, integer):

The Unix timestamp at which this CAA record set will expire. This SHOULD NOT be more than 8 hours in the future. ACME servers MUST process this as at least a 64-bit integer to ensure functionality beyond 2038.

signature (required, string):

The Ed25519 signature of the CAA record set using the private key corresponding to the ".onion" Special-Use Domain Name, encoded using base64url. The signature is defined below.

The data that the signature is calculated over is the concatenation of the following, encoded in UTF-8 : Where "|" is the ASCII character 0x7C, and expiry is the expiry field as a decimal string with no leading zeros. If the caa field is null, it is represented as an empty string in the signature calculation.

ACME Servers Requiring In-Band CAA If an ACME server does not support fetching a service's CAA record set from its Hidden Service Descriptor, and the ACME client does not provide an "onionCAA" object in its finalize request, the ACME server MUST respond with an "onionCAARequired" error to indicate this. To support signaling the server's support for fetching CAA record sets over Tor, a new field is defined in the directory "meta" object to signal this.

inBandOnionCAARequired (optional, boolean):

If true, the ACME server requires the client to provide the CAA record set in the finalize request. If false or absent, the ACME server does not require the client to provide the CAA record set is this manner.

A directory of such a CA could look like the following:

Example In-Band CAA Given the following example CAA record set for 5anebu2glyc235wbbop3m2ukzlaptpkq333vdtdvcjpigyb7x2i2m2qd.onion (additional line breaks have been added for readability): The following would be submitted to the ACME server's finalize endpoint (additional line breaks have been added for readability):

IANA Considerations

Validation Methods One new entry has been added to the "ACME Validation Methods" registry that was defined in (). onion-csr-01 Validation Method

Label	Identifier Type	ACME	Reference
onion-csr-01	dns	Y	RFC 9799

Error Types One new entry has been added to the "ACME Error Types" registry that was defined in (). onionCAARequired Error Type

Type	Description	Reference
onionCAARequired	The CA only supports checking the CAA for Hidden Services in-band, but the client has not provided an in-band CAA	RFC 9799

Directory Metadata Fields One new entry has been added to the "ACME Directory Metadata Fields" registry that was defined in (). onionCAARequired Metadata Field

Field name	Field type	Reference
onionCAARequired	boolean	RFC 9799

Security Considerations

Security of the onion-csr-01 Challenge The security considerations of apply to issuance using the Certificate Request method.

Use of the "dns" Identifier Type The reuse of the "dns" identifier type for a Special-Use Domain Name not actually in the DNS infrastructure raises questions regarding its suitability. The reasons to pursue this path in the first place are detailed in . It is felt that there is little security concern in reuse of the "dns" identifier type with regard to the mis-issuance by CAs that are not aware of ".onion" Special-Use Domain Names as CAs would not be able to resolve the identifier in the DNS.

http-01 Challenge In the absence of knowledge of this document, a CA would follow the procedure set out in , which specifies that the CA should "Dereference the URL using an HTTP GET request". Given that ".onion" Special-Use Domain Names require special handling to dereference, this dereferencing will fail, disallowing issuance.

tls-alpn-01 Challenge In the absence of knowledge of this document, a CA would follow the procedure set out in , which specifies that the CA "resolves the domain name being validated and chooses one of the IP addresses returned for validation". Given that ".onion" Special-Use Domain Names are not resolvable to IP addresses, this dereferencing will fail, disallowing issuance.

dns-01 Challenge In the absence of knowledge of this document, a CA would follow the procedure set out in , which specifies that the CA should "query for TXT records for the validation domain name". Given that ".onion" Special-Use Domain Names are not present in the DNS infrastructure, this query will fail, disallowing issuance.

Key Authorization with onion-csr-01 The onion-csr-01 challenge does not make use of the key authorization string defined in . This does not weaken the integrity of authorizations. The key authorization exists to ensure that, whilst an attacker observing the validation channel can observe the correct validation response, they cannot compromise the integrity of authorizations as the response can only be used with the account key for which it was generated. As the validation channel for this challenge is ACME itself, and ACME already requires that the request be signed by the account, the key authorization is not necessary.

Use of Tor for Domains That Are Not ".onion" An ACME server MUST NOT utilize Tor for the validation of domains that are not ".onion", due to the risk of exit hijacking .

Redirects with http-01 A site MAY redirect to another site when completing validation using the http-01 challenge. This redirect MAY be to either another ".onion" Special-Use Domain Name or a domain in the public DNS. A site operator MUST consider the privacy implications of redirecting to a site that is not ".onion" -- namely that the ACME server operator will then be able to learn information about the site they were redirected to that they would not have if accessed via a ".onion" Special-Use Domain Name, such as its IP address. If the site redirected to is on the same or an adjacent host to the ".onion" Special-Use Domain Name, this reveals information that the "Tor Rendezvous Specification - Version 3" section of was otherwise designed to protect. If an ACME server receives a redirect to a domain in the public DNS, it MUST NOT utilize Tor to make a connection to it due to the risk of exit hijacking.

Security of CAA Records The Second Layer Hidden Service Descriptor is signed, encrypted, and encoded using a Message Authentication Code (MAC) in a way that only a party with access to the secret key of the Hidden Service could manipulate what is published there. For more information about this process, see the "Hidden service descriptors: encryption format" section of .

In-Band CAA Tor directory servers are inherently untrusted entities. As such, there is no difference in the security model for accepting CAA records directly from the ACME client or fetching them over Tor: the CAA records are verified using the same hidden service key in either case.

Access of the Tor Network The ACME server MUST make its own connection to the Hidden Service via the Tor network and MUST NOT outsource this to a third-party service, such as Tor2Web.

Anonymity of the ACME Client ACME clients requesting certificates for ".onion" Special-Use Domain Names not over the Tor network can inadvertently expose the existence of a Hidden Service on the host requesting certificates to unintended parties; this is true even when features such as Encrypted ClientHello (ECH) are utilized, as the IP addresses of ACME servers are generally well-known, static, and not used for any other purpose. ACME clients SHOULD connect to ACME servers over the Tor network to alleviate this, preferring a Hidden Service endpoint if the CA provides such a service. If an ACME client requests a publicly trusted WebPKI certificate, it will expose the existence of the Hidden Service publicly due to its inclusion in Certificate Transparency logs . Hidden Service operators MUST consider the privacy implications of this before requesting WebPKI certificates. ACME client developers SHOULD warn users about the risks of CT-logged certificates for Hidden Services.

Avoid Unnecessary Certificates Not all services will need a publicly trusted WebPKI certificate; for internal or non-public services, operators SHOULD consider using self-signed or privately trusted certificates that aren't logged to certificate transparency.

Obfuscate Subscriber Information When an ACME client is registering with an ACME server, it SHOULD provide minimal or obfuscated subscriber details to the CA, such as a pseudonymous email address, if at all possible.

Separate ACME Account Keys If a Hidden Service operator does not want their different Hidden Services to be correlated by a CA, they MUST use separate ACME account keys for each Hidden Service.

References Normative References The Tor Project The Tor Project commit 2437d19c CA/Browser Forum Version 2.0.6 Informative References The Tor Project Privacy Enhancing Technologies (PETS 2014), Lecture Notes in Computer Science, vol. 8555, pp. 304-331

Discussion on the Use of the "dns" Identifier Type The reasons for utilizing the "dns" identifier type in ACME and not defining a new identifier type for ".onion" may not seem obvious at first glance. After all, ".onion" Special-Use Domain Names are not part of the DNS infrastructure and, as such, why should they use the "dns" identifier type? defines, and this document allows, using the http-01 or tls-alpn-01 validation methods already present in ACME (with some considerations). Given the situation of a web server placed behind a Tor-terminating proxy (as per the setup suggested by the Tor project ), existing ACME tooling can be blind to the fact that a ".onion" Special-Use Domain Name is being utilized, as they simply receive an incoming TCP connection as they would regardless (albeit from the Tor-terminating proxy). An example of this would be Certbot placing the ACME challenge response file in the webroot of an NGINX web server. Neither Certbot nor NGINX would require any modification to be aware of any special handling for ".onion" Special-Use Domain Names. This does raise some questions regarding security within existing implementations; however, the authors believe this is of little concern, as per .

Acknowledgements With thanks to the Open Technology Fund for funding the work that went into this document. The authors also wish to thank the following for their input on this document: