Internet-Draft | HTTP Message Signatures Directory | April 2025 |
Meunier | Expires 17 October 2025 | [Page] |
This document describes a method for clients using [HTTP-MESSAGE-SIGNATURES] to advertise their signing keys.¶
It defines a key directory format based on JWKS as defined in Section 5 of [JWK], as well as new HTTP Method Context to allow for in-band key discovery.¶
This note is to be removed before publishing as an RFC.¶
The latest revision of this draft can be found at https://thibmeu.github.io/http-message-signatures-directory/draft-meunier-http-message-signatures-directory.html. Status information for this document may be found at https://datatracker.ietf.org/doc/draft-meunier-http-message-signatures-directory/.¶
Discussion of this document takes place on the HTTP mailing list (mailto:ietf-http-wg@w3.org), which is archived at https://lists.w3.org/Archives/Public/ietf-http-wg/.¶
Source for this draft and an issue tracker can be found at https://github.com/thibmeu/http-message-signatures-directory.¶
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 https://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 17 October 2025.¶
Copyright (c) 2025 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 (https://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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
[HTTP-MESSAGE-SIGNATURES] allow a signer to generate a signature over an HTTP message, and a verifier to validate it. The specification assumes verifiers have prior knowledge of signers' key material, requiring out-of-band key distribution mechanisms. This creates deployment friction and limits the ability to dynamically verify signatures from previously unknown signers.¶
This document defines: 1. A standardized key directory format based on JWKS for publishing HTTP Message Signatures keys 2. A well-known URI location for discovering these key directories 3. A new HTTP header field enabling in-band key directory location discovery¶
Together, these mechanisms enable key distribution and discovery for HTTP Message Signatures cryptographic material.¶
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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The key directory is served as a JSON Web Key Set (JWKS) as defined in Section 5 of [JWK]. The "alg" parameter are restricted to algorithm registered against HTTP Signature Algorithms Section of [HTTP-MESSAGE-SIGNATURES-IANA]¶
The directory SHOULD be server over HTTPS.
The directory MUST be served with media type application/http-message-signatures-directory
.¶
Client application SHOULD validate the directory format and reject malformed entries.¶
Signature-Agent
A service sending signed requests as defined in [HTTP-MESSAGE-SIGNATURES] MAY include a
Signature-Agent
header field to communicate its signing key directory. This header
field contains a URI allowing retrieval of an HTTP Message Signatures Directory as
defined in Section 3.¶
The Signature-Agent
header field is an Item Structured Header [STRUCTURED-HEADERS]. Its value MUST be a
String containing a [URI]. The ABNF is:¶
Signature-Agent = sf-string ; Section 3.3.3 of {{STRUCTURED-HEADERS}}¶
The URI scheme MUST be one of: - https (RECOMMENDED): Points to an HTTPS resource serving the key directory - http: Points to an HTTP resource serving the key directory - data: Contains an inline key directory¶
When using the "data" URI scheme, the media type MUST be
application/http-message-signatures-directory
. The content MAY be base64 encoded
as per [BASE64].¶
Multiple Signature-Agent
header fields MAY be present in a request. Processors SHOULD
use the first valid URI that provides a valid key directory.¶
TODO: for inlining, CBOR Keys could be useful¶
Clients SHOULD implement key rotation by including multiple keys in the directory with different validity period. When rotating keys, clients SHOULD:¶
Add the new key to the directory before its intended use date¶
Continue to include the old key until its expiration date¶
Remove expired keys from the directory¶
Servers SHOULD cache the directory contents and refresh upon expiration.¶
Key directories enable discovery of signing keys which may reveal information about the signing entity. Implementers should consider:¶
Key directories should only contain keys actively used for signing. Including additional keys or metadata may expose unnecessary information about the signing service.¶
Verifiers accessing key directories may reveal information about signature verification patterns. Directory servers should avoid logging personally identifiable information from directory requests.¶
This section contains considerations for IANA.¶
This document updates the "Well-Known URIs" Registry [WellKnownURIs] with the following values.¶
URI Suffix | Change Controller | Reference | Status | Related information |
---|---|---|---|---|
http-message-signatures-directory | IETF | [this document] | permanent | None |
The following entries should be added to the IANA "media types" registry:¶
"application/http-message-signatures-directory"¶
The templates for these entries are listed below and the reference should be this RFC.¶
application¶
http-message-signatures-directory¶
N/A¶
N/A¶
"binary"¶
N/A¶
this specification¶
Services that implement the signer role for HTTP Message Signatures and verifiers that interact with the signer for the purpose of validating signatures.¶
N/A¶
see Authors' Addresses section¶
COMMON¶
N/A¶
see Authors' Addresses section¶
IETF¶
GET /.well-known/bar HTTP/1.1 Host: example.com Accept: application/http-message-signatures-directory HTTP/1.1 200 OK Content-Type: application/http-message-signatures-directory Cache-Control: max-age=86400 { "keys": { "kty": "OKP", "crv": "Ed25519", "kid": "NFcWBst6DXG-N35nHdzMrioWntdzNZghQSkjHNMMSjw", "x": "JrQLj5P_89iXES9-vFgrIy29clF9CC_oPPsw3c5D0bs", "use": "sig", "nbf": 1712793600, "exp": 1715385600 } }¶
This extend the examples from Appendix B of [HTTP-MESSAGE-SIGNATURES].¶
POST /foo?param=Value&Pet=dog HTTP/1.1 Host: example.com Signature-Agent: https://directory.test {"hello": "world"} HTTP/1.1 200 OK {"message": "good dog"}¶
TODO acknowledge.¶