README.md

oblivious-http

A TypeScript RFC 9458 Oblivious HTTP (OHTTP) implementation.

This was originally forked from https://github.com/chris-wood/ohttp-js.

To install dependencies:

bun install

To run:

bun run index.ts

To build:

bun run build

To publish:

First, update the version in package.json.

Then, commit the version change and create and push a new tag:

git add package.json
git commit -m "Release vX.Y.Z"
git tag vX.Y.Z # where X.Y.Z matches the version in package.json
git push origin main --tags

This will trigger the GitHub Actions workflow to automatically build and publish the package to npm.

Limitations

1. Only supports a single ciphersuite combination:

• KEM: DHKEM(X25519, HKDF-SHA256) (0x0020)
• KDF: HKDF-SHA256 (0x0001)
• AEAD: AES-128-GCM (0x0001)

2. Only supports a single KDF/AEAD per key configuration.

Warning

This implementation may have security issues. Use at your own risk!

Contributing

We welcome contributions from everyone! Feel free to open issues, submit pull requests, or engage in discussions to help improve this project.