package
A Hybrid Public Key Encryption (HPKE) module extension for X25519
npm install @hpke/dhkem-x25519GitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 2 packages.
579.1 kB
Includes dependencies.
Documentation: jsr.io | pages (only for the latest ver.)
@hpke/dhkem-x25519 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.
# Using npm:
npm install @hpke/dhkem-x25519
yarn add @hpke/dhkem-x25519
pnpm install @hpke/dhkem-x25519
# Using jsr:
npx jsr add @hpke/dhkem-x25519
yarn add jsr:@hpke/dhkem-x25519
pnpm add jsr:@hpke/dhkem-x25519The 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:
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { DhkemX25519HkdfSha256 } from "@hpke/dhkem-x25519";For Deno, it is recommended to use the jsr.io registry.
deno add jsr:@hpke/dhkem-x25519Followings are how to use this module with typical CDNs. Other CDNs can be used as well.
Using esm.sh:
<!-- use a specific version -->
<script type="module">
import {
Aes128Gcm,
CipherSuite,
HkdfSha256,
} from "https://esm.sh/@hpke/core@<SEMVER>";
import {
DhkemX25519HkdfSha256,
} from "https://esm.sh/@hpke/dhkem-x25519@<SEMVER>";
// ...
</script>
<!-- use the latest stable version -->
<script type="module">
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "https://esm.sh/@hpke/core";
import { DhkemX25519HkdfSha256 } from "https://esm.sh/@hpke/dhkem-x25519";
// ...
</scriptUsing unpkg:
<!-- use a specific version -->
<script type="module">
import {
Aes128Gcm,
CipherSuite,
HkdfSha256,
} from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
import {
DhkemX25519HkdfSha256,
} from "https://unpkg.com/@hpke/dhkem-x25519@<SEMVER>/esm/mod.js";
// ...
</script>This section shows some typical usage examples.
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { DhkemX25519HkdfSha256 } from "@hpke/dhkem-x25519";
// const { DhkemX25519HkdfSha256 } = require("@hpke/dhkem-x25519");
async function doHpke() {
// setup
const suite = new CipherSuite({
kem: new DhkemX25519HkdfSha256(),
kdf: new HkdfSha256(),
aead: new Aes128Gcm(),
});
const rkp = await suite.kem.generateKeyPair();
const sender = await suite.createSenderContext({
recipientPublicKey: rkp.publicKey,
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { DhkemX25519HkdfSha256 } from "@hpke/dhkem-x25519";
async function doHpke() {
// setup
const suite = new CipherSuite({
kem: new DhkemX25519HkdfSha256(),
kdf: new HkdfSha256(),
aead: new Aes128Gcm(),
});
const rkp = await suite.kem.generateKeyPair();
const sender = await suite.createSenderContext({
recipientPublicKey: rkp.publicKey,
});
// encrypt
<html>
<head></head>
<body>
<script type="module">
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "https://esm.sh/@hpke/core";
import { DhkemX25519HkdfSha256 } from "https://esm.sh/@hpke/dhkem-x25519";
globalThis.doHpke = async () => {
try {
const suite = new CipherSuite({
kem: new DhkemX25519HkdfSha256(),
kdf: new HkdfSha256(),
aead: new Aes128Gcm(),
We welcome all kind of contributions, filing issues, suggesting new features or sending PRs.