Skip to content

Web Bot Auth

GitHub License

This repo contains Web Bot Auth libraries and examples for signed automated HTTP traffic, as described in draft-meunier-webbotauth-httpsig-protocol.

Table of Contents

Examples

Live deployment

Cloudflare Research provides a live environment at http-message-signatures-example.research.cloudflare.com.

Use this deployment to test an implementation.

  1. It validates the presence of a Signature header signed RFC9421 ed25519 test key,
  2. It exposes a bot directory on /.well-known/http-message-signatures-directory,
  3. It serves debug tools for request signatures, JWK key IDs, and directories.

Signing

ExampleDescription
Browser extensionAdds a Signature on every outgoing request
RustSigns a hardcoded test request

Verifying

ExampleDescription
Cloudflare WorkersVerify RFC 9421 Signature for every incoming request
Caddy PluginVerify RFC 9421 Signature for every incoming request
RustVerify a sample test request

HTTP Signature Directories

ExampleDescription
Cloudflare WorkersHost a registry, Signature Agent Card, and signed key directory on Cloudflare Workers

Development

This repository uses npm and cargo workspaces. There are several packages which it provides:

PackageLanguageDescription
http-message-sigTypeScriptHTTP Message Signatures as defined in RFC 9421
jsonwebkey-thumbprintTypeScriptJWK Thumbprint as defined in RFC 7638
web-bot-authTypeScriptHTTP Message Signatures for Bots as defined in draft-meunier-webbotauth-httpsig-protocol-00
web-bot-authRustHTTP Message Signatures for Bots as defined in draft-meunier-webbotauth-httpsig-protocol-00
http-signature-directoryRustValidates whether an HTTP message signature directory is correctly signed and valid

Security Considerations

This software has not been audited. Please use at your sole discretion.

License

This project is under the Apache 2.0 license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be Apache 2.0 licensed as above, without any additional terms or conditions.

About

Sign and verify orchestrated HTTP requests

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

148 stars

Watchers

9 watching

Forks

Releases

Used by

Contributors

Languages