hpke-js

Index

- Installation
- Node.js
- Deno
- Web Browsers
- Usage
- Contributing

Installation

Where possible, it is recommended to use @hpke/core along with extension
modules (such as @hpke/chacha20poly1305) instead of hpke-js.

$3

You can install the package with npm, yarn or pnpm.

``sh


Using npm:

`ts
import { AeadId, CipherSuite, KdfId, KemId } from "hpke-js";
`

$3

For Deno, it is recommended to use the jsr.io registry.

`sh
deno add jsr:@hpke/hpke-js
`

$3

Followings are how to use the module with typical CDNs. Other CDNs can be used
as well.

Using esm.sh:

`html





`

Using unpkg:

`html


`

Usage

This section shows some typical usage examples.

$3

`js
import { AeadId, CipherSuite, KdfId, KemId } from "hpke-js";

async function doHpke() {
const suite = new CipherSuite({
kem: KemId.DhkemX25519HkdfSha256,
kdf: KdfId.HkdfSha256,
aead: AeadId.Chacha20Poly1305,
});

// 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("decrypted: ", new TextDecoder().decode(pt));
}

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

$3

`ts
import { AeadId, CipherSuite, KdfId, KemId } from "@hpke/hpke-js";

async function doHpke() {
const suite = new CipherSuite({
kem: KemId.DhkemX25519HkdfSha256,
kdf: KdfId.HkdfSha256,
aead: AeadId.Chacha20Poly1305,
});

const rkp = await suite.kem.generateKeyPair();

const sender = await suite.createSenderContext({
recipientPublicKey: rkp.publicKey,
});

// encrypt
const ct = await sender.seal(new TextEncoder().encode("Hello world!"));

const recipient = await suite.createRecipientContext({
recipientKey: rkp.privateKey,
enc: sender.enc,
});

// decrypt
const pt = await recipient.open(ct);

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

try {
doHpke();
} catch (_err: unknown) {
console.log("failed.");
}
`

$3

`html




do HPKE


``

Contributing

We welcome all kind of contributions, filing issues, suggesting new features or
sending PRs.