A Hybrid Public Key Encryption (HPKE) module extension for a hybrid post-quantum KEM, X25519Kyber768Draft00
npm install @hpke/hybridkem-x25519-kyber768Documentation: jsr.io |
pages (only for the latest ver.)
- Installation
- Node.js
- Deno
- Web Browsers
- Usage
- Contributing
@hpke/hybridkem-x25519-kyber768 need to be used with
@hpke/core,
which can be installed in the same manner as desribed below.
You can install the package with npm, yarn or pnpm.
``sh`Using npm:
npm install @hpke/hybridkem-x25519-kyber768
yarn add @hpke/hybridkem-x25519-kyber768
pnpm install @hpke/hybridkem-x25519-kyber768Using jsr:
npx jsr add @hpke/hybridkem-x25519-kyber768
yarn dlx jsr add @hpke/hybridkem-x25519-kyber768
pnpm dlx jsr add @hpke/hybridkem-x25519-kyber768
The above manner can be used with other JavaScript runtimes that support npm,
such as Cloudflare Workers and Bun.
Then, you can use the module from code like this:
`ts`
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { HybridkemX25519Kyber768 } from "@hpke/hybridkem-x25519-kyber768";
For Deno, it is recommended to use the jsr.io registry.
`sh`
deno add jsr:@hpke/hybridkem-x25519-kyber768
Followings are how to use this module with typical CDNs. Other CDNs can be used
as well.
Using esm.sh:
`html
`
Using unpkg:
`html`
This section shows some typical usage examples.
`js
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { HybridkemX25519Kyber768 } from "@hpke/hybridkem-x25519-kyber768";
async function doHpke() {
// setup
const suite = new CipherSuite({
kem: new HybridkemX25519Kyber768(),
kdf: new HkdfSha256(),
aead: new Aes128Gcm(),
});
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) {
console.log("failed:", err.message);
}
`
`ts
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { HybridkemX25519Kyber768 } from "@hpke/hybridkem-x25519-kyber768";
async function doHpke() {
// setup
const suite = new CipherSuite({
kem: new HybridkemX25519Kyber768(),
kdf: new HkdfSha256(),
aead: new Aes128Gcm(),
});
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.");
}
`
`html``
We welcome all kind of contributions, filing issues, suggesting new features or
sending PRs.