Documentation: [jsr.io](https://jsr.io/@hpke/dhkem-x448/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/dhkem-x448/docs/)
## Index
- [Installation](#installation)
- [Node.js](#nodejs)
- [Deno](#deno)
- [Web Browsers](#web-browsers)
- [Usage](#usage)
- [Contributing](#contributing)
## Installation
`@hpke/dhkem-x448` need to be used with
[@hpke/core](https://github.com/dajiaji/hpke-js/blob/main/packages/core/README.md),
which can be installed in the same manner as desribed below.
### Node.js
You can install the package with npm, yarn or pnpm.
```sh
# Using npm:
npm install @hpke/dhkem-x448
yarn add @hpke/dhkem-x448
pnpm install @hpke/dhkem-x448
# Using jsr:
npx jsr add @hpke/dhkem-x448
yarn dlx jsr add @hpke/dhkem-x448
pnpm dlx jsr add @hpke/dhkem-x448
```
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 { Aes256Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { DhkemX448HkdfSha512 } from "@hpke/dhkem-x448";
```
### Deno
For Deno, it is recommended to use the jsr.io registry.
```sh
deno add jsr:@hpke/dhkem-x448
```
### Web Browsers
Followings are how to use this 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.
### Node.js
```js
import { Aes256Gcm, CipherSuite, HkdfSha512 } from "@hpke/core";
import { DhkemX448HkdfSha512 } from "@hpke/dhkem-x448";
// const { DhkemX448HkdfSha512 } = require("@hpke/dhkem-x448");
async function doHpke() {
// setup
const suite = new CipherSuite({
kem: new DhkemX448HkdfSha512(),
kdf: new HkdfSha512(),
aead: new Aes256Gcm(),
});
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);
}
```
### Deno
```ts
import { Aes256Gcm, CipherSuite, HkdfSha512 } from "@hpke/core";
import { DhkemX448HkdfSha512 } from "@hpke/dhkem-x448";
async function doHpke() {
// setup
const suite = new CipherSuite({
kem: new DhkemX448HkdfSha512(),
kdf: new HkdfSha512(),
aead: new Aes256Gcm(),
});
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.");
}
```
### Browsers
```html
```
## Contributing
We welcome all kind of contributions, filing issues, suggesting new features or
sending PRs.