Skip to content

JWK guidance #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thibmeu merged 1 commit into from
Sep 4, 2026
Merged

JWK guidance #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Cloudflare Research provides a live environment at [http-message-signatures-exam

Use this deployment to test an implementation.

1. It validates the presence of a `Signature` header signed [RFC9421 ed25519 test key](./examples/rfc9421-keys/ed25519.pem),
1. It validates the presence of a `Signature` header signed with a [published RFC 9421 test key](./examples/rfc9421-keys/ed25519.pem), which [must not be used in production](./packages/web-bot-auth/#security-considerations),
2. It exposes a bot directory on [/.well-known/http-message-signatures-directory](https://http-message-signatures-example.research.cloudflare.com/.well-known/http-message-signatures-directory),
3. It serves debug tools for request signatures, JWK key IDs, and directories.

Expand Down
6 changes: 3 additions & 3 deletions packages/web-bot-auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ const request = new Request("https://example.com", {
headers: { "Signature-Agent": signatureAgent },
});

// This is a testing-only private key/public key pair described in RFC 9421 Appendix B.1.4
// Also available at https://github.com/cloudflareresearch/web-bot-auth/blob/main/examples/rfc9421-keys/ed25519.json
// Published RFC 9421 test key. Never use it in production; see Security Considerations below.
// Fixture: https://github.com/cloudflareresearch/web-bot-auth/blob/main/examples/rfc9421-keys/ed25519.json
const RFC_9421_ED25519_TEST_KEY = {
kty: "OKP",
crv: "Ed25519",
Expand Down Expand Up @@ -109,7 +109,7 @@ const authenticated = await verify(signedRequest, {

## Security Considerations

This software has not been audited. Please use at your sole discretion.
This software has not been audited. Use it at your sole discretion. RFC test keys [must not be used in production](https://datatracker.ietf.org/doc/html/draft-meunier-webbotauth-httpsig-protocol-02#section-6.8). For production, [generate a unique asymmetric key](https://datatracker.ietf.org/doc/html/draft-meunier-webbotauth-httpsig-protocol-02#section-6.4) with [Web Crypto](https://github.com/cloudflare/web-bot-auth/tree/main/packages/jsonwebkey-thumbprint#usage) or [OpenSSL](https://developers.cloudflare.com/bots/concepts/bot/verified-bots/web-bot-auth/#1-generate-a-valid-signing-key). Publish only its public JWK values. [Overlap old and new public keys during rotation](https://datatracker.ietf.org/doc/html/draft-meunier-webbotauth-httpsig-protocol-02#section-5.5.2).

## License

Expand Down