Profile
Back to NewsBack
GitHub Trending 6 min
Reader Mode
dajiaji/hpke-js: A Hybrid Public Key Encryption (HPKE) module built on top of Web Cryptography API.

dajiaji/hpke-js: A Hybrid Public Key Encryption (HPKE) module built on top of Web Cryptography API.

4 hours ago
GitHub Trending

hpke-js

A modular TypeScript Hybrid Public Key Encryption (HPKE) library and HPKE-based protocol suite (OHTTP, COSE-HPKE, JOSE-HPKE) built on top of Web Cryptography API. Works on web browsers, Node.js, Deno and various other JavaScript runtimes.

For Node.js, you can install @hpke/core and other extensions via npm, yarn, pnpm or jsr:

# Using npm:
npm install @hpke/core
yarn add @hpke/core
pnpm install @hpke/core

Using jsr:

npx jsr add @hpke/core
yarn add jsr:@hpke/core
pnpm add jsr:@hpke/core

Following extensions can be installed in the same manner:

  • @hpke/chacha20poly1305
  • @hpke/dhkem-x25519
  • @hpke/dhkem-x448
  • @hpke/dhkem-secp256k1
  • @hpke/hybridkem-x-wing
  • @hpke/ml-kem
  • @hpke/hybridkem-x25519-kyber768 - deprecated
Then, you can use it as follows: 
import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "@hpke/core";

async function doHpke() {
  const suite = new CipherSuite({
    kem: new DhkemP256HkdfSha256(),
    kdf: new HkdfSha256(),
    aead: new Aes128Gcm(),
  });


// A recipient generates a key pair.
  const rkp = await suite.kem.generateKeyPair();


// A sender encrypts a message with the recipient public key.
  const sender = await suite.createSenderContext({
    recipientPublicKey: rkp.publicKey,
  });
  const ct = await sender.seal(new TextEncoder().encode("Hello world!"));


// The recipient decrypts it.
  const recipient = await suite.createRecipientContext({
    recipientKey: rkp.privateKey,
    enc: sender.enc,
  });
  const pt = await recipient.open(ct);


// Hello world!
  console.log(new TextDecoder().decode(pt));
}


try {
  doHpke();
} catch (e) {
  console.log("failed:", e.message);
}

Index

Packages

HPKE Library

| name | registry | description | | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | @hpke/core | npm</a>
JSR</a> | The HPKE core module implemented using only Web Cryptography API. It does not support the X448-based KEM and the ChaCha20/Poly1305 AEAD, but it has no external module dependencies. It's small in size and tree-shaking friendly.
README / samples | | @hpke/chacha20poly1305 | npm</a>
JSR</a> | The HPKE module extension for ChaCha20Poly1305 AEAD.
README / samples | | @hpke/dhkem-x25519 | npm</a>
JSR</a> | The HPKE module extension for DHKEM(X25519, HKDF-SHA256).
README / samples | | @hpke/dhkem-x448 | npm</a>
JSR</a> | The HPKE module extension for DHKEM(X448, HKDF-SHA512).
README / samples | | hpke-js | npm</a> | The HPKE module supporting all of the ciphersuites defined in RFC9180, which consists of the above @hpke/{core, dhkem-x25519, dhkem-x448, chacha20poly1305} internally.
README / samples | | @hpke/hpke-js | JSR</a> | The JSR version of the above hpke-js.
README / samples | | @hpke/ml-kem | npm</a>
JSR</a> | EXPERIMENTAL AND NOT STANDARDIZED
The HPKE module extension for ML-KEM.
README / samples | | @hpke/hybridkem-x-wing | npm</a>
JSR</a> | EXPERIMENTAL AND NOT STANDARDIZED
The HPKE module extension for X-Wing: general-purpose hybrid post-quantum KEM.
README / samples | | @hpke/hybridkem-x25519-kyber768 (deprelated) | npm</a>
JSR</a> | EXPERIMENTAL AND NOT STANDARDIZED
The HPKE module extension for the hybrid post-quantum KEM currently named X25519Kyber768Draft00.
README / samples | | @hpke/dhkem-secp256k1 | npm</a>
JSR</a> | EXPERIMENTAL AND NOT STANDARDIZED
The HPKE module extension for DHKEM(secp256k1, HKDF-SHA256).
README / samples |

HPKE-based Protocol Implementations (Coming Soon)

| name | registry | description | | ----------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | @hpke/ohttp | - | Oblivious HTTP (RFC 9458) client and server implementation using HPKE.
README | | @hpke/cose | - | COSE-HPKE (draft-ietf-cose-hpke) implementation built on top of @hpke/core.
README | | @hpke/jose | - | JOSE-HPKE (draft-ietf-jose-hpke-encrypt) encryption implementation built on top of @hpke/core.
README |

Supported Features

HPKE Modes

| Base | PSK | Auth | AuthPSK | | ---- | --- | ---- | ------- | | ✅ | ✅ | ✅ | ✅ |

Key Encapsulation Machanisms (KEMs)

| KEMs | Browser | Node.js | Deno | Cloudflare
Workers | bun | | ------------------------------ | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | | DHKEM (P-256, HKDF-SHA256) | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | | DHKEM (P-384, HKDF-SHA384) | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | | DHKEM (P-521, HKDF-SHA512) | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | | DHKEM (X25519, HKDF-SHA256) | ✅
hpke-js
@hpke/core
@hpke/dhkem-x25519 | ✅
hpke-js
@hpke/core
@hpke/dhkem-x25519 | ✅
hpke-js
@hpke/core
@hpke/dhkem-x25519 | ✅
hpke-js
@hpke/core
@hpke/dhkem-x25519 | ✅
hpke-js
@hpke/core
@hpke/dhkem-x25519 | | DHKEM (X448, HKDF-SHA512) | ✅
hpke-js
@hpke/dhkem-x448 | ✅
hpke-js
@hpke/dhkem-x448 | ✅
hpke-js
@hpke/dhkem-x448 | ✅
hpke-js
@hpke/dhkem-x448 | ✅
hpke-js
@hpke/dhkem-x448 | | ML-KEM-512 | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | | ML-KEM-768 | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | | ML-KEM-1024 | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | ✅
@hpke/ml-kem | | X-Wing | ✅
@hpke/hybridkem-x-wing | ✅
@hpke/hybridkem-x-wing | ✅
@hpke/hybridkem-x-wing | ✅
@hpke/hybridkem-x-wing | ✅
@hpke/hybridkem-x-wing | | Hybrid KEM (X25519, Kyber768) | ✅
@hpke/hybridkem-x25519-kyber768 | ✅
@hpke/hybridkem-x25519-kyber768 | ✅
@hpke/hybridkem-x25519-kyber768 | ✅
@hpke/hybridkem-x25519-kyber768 | ✅
@hpke/hybridkem-x25519-kyber768 | | DHKEM (secp256k1, HKDF-SHA256) | ✅
@hpke/dhkem-secp256k1 | ✅
@hpke/dhkem-secp256k1 | ✅
@hpke/dhkem-secp256k1 | ✅
@hpke/dhkem-secp256k1 | ✅
@hpke/dhkem-secp256k1 |

Key Derivation Functions (KDFs)

| KDFs | Browser | Node.js | Deno | Cloudflare
Workers | bun | | ----------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | | HKDF-SHA256 | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\*1) | | HKDF-SHA384 | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\*1) | | HKDF-SHA512 | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\1) | ✅
hpke-js
@hpke/core(\*1) |

  • (\*1) The HKDF functions built in @hpke/core can derive keys of the same
length as the hash size. If you want to derive keys longer than the hash size, use hpke-js.

Authenticated Encryption with Associated Data (AEAD) Functions

| AEADs | Browser | Node.js | Deno | Cloudflare
Workers | bun | | -------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | | AES-128-GCM | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | | AES-256-GCM | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | | ChaCha20
Poly1305 | ✅
hpke-js
@hpke/chacha
20poly1305 | ✅
hpke-js
@hpke/chacha
20poly1305 | ✅
hpke-js
@hpke/chacha
20poly1305 | ✅
hpke-js
@hpke/chacha
20poly1305 | ✅
hpke-js
@hpke/chacha
20poly1305 | | Export Only | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core | ✅
hpke-js
@hpke/core |

Supported Environments

supported browsers - Confirmed: Chrome, Firefox, Edge, Safari, Opera, Vivaldi, Brave
  • Node.js: 16.x, 17.x, 18.x, 19.x, 20.x, 21.x, 22.x, 23.x, 24.x, 25.x, 26.x
  • Deno: 2.x
  • Cloudflare Workers
  • bun: 0.x (0.6.0-), 1.x

Warnings and Restrictions

  • Although this library has been passed the following test vectors, it has not
been formally audited. - RFC9180 official test vectors provided on github.com/cfrg/draft-irtf-cfrg-hpke - ECDH/X25519/X448 test vectors provided on Project Wycheproof
  • The upper limit of the AEAD sequence number is further rounded to JavaScript's
MAX\_SAFE\_INTEGER (2^53-1).

Contributing

We welcome all kind of contributions, filing issues, suggesting new features or sending PRs. Please see our CONTRIBUTING.md for detailed guidelines on:

  • Development setup and prerequisites
  • Available development tasks
  • Code quality requirements
  • Project structure
  • Testing requirements
  • Documentation guidelines

References

You finished the article!

Want to go deeper or explore more stories?

Full Article on GitHub Trending More Tech News
Reading Mode

Adjust typography and theme to your preference.

View Original
Related Stories
Product Hunt Launches Look Impressive. But Do They Bring Paying Customers?
Dev.to 7 hours ago
Google Was Autocorrecting Our Brand Name, here's What I Did
Dev.to 2 days ago
I made $0 from my side project for 8 months. Then one furious email at 2am changed everything.
Dev.to 2 days ago
What metrics matter for LLM inference observability (TTFT, TPOT, ITL)?
Dev.to 3 days ago
Florilegium: Procedural Flowers in LaTeX
Hacker News 3 days ago
Related Stories

Product Hunt Launches Look Impressive. But Do They Bring Paying Custom...

Dev.to 7 hours ago

Google Was Autocorrecting Our Brand Name, here's What I Did

Dev.to 2 days ago

I made $0 from my side project for 8 months. Then one furious email at...

Dev.to 2 days ago

What metrics matter for LLM inference observability (TTFT, TPOT, ITL)?

Dev.to 3 days ago

Florilegium: Procedural Flowers in LaTeX

Hacker News 3 days ago
Chat with me