# @hpke/core

> A Hybrid Public Key Encryption (HPKE) core module for various JavaScript runtimes

Latest version **1.10.1** (published 2026-11-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hpke/core
pnpm add @hpke/core
yarn add @hpke/core
bun add @hpke/core
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.10.1 |
| Published | 2026-11-08 |
| First published | 2023-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16.0.0 |
| Dependencies | 1 |
| Unpacked size | 183.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 130 |
| Author | Ajitomi Daisuke |
| Maintainers | dajiaji |
| Keywords | hpke, rfc9180, hkdf, dh, security, encryption |

## Links

- npm: https://www.npmjs.com/package/@hpke/core
- Repository: https://github.com/dajiaji/hpke-js
- Homepage: https://github.com/dajiaji/hpke-js/tree/main/core#readme
- Issues: https://github.com/dajiaji/hpke-js/issues
- Funding: https://github.com/sponsors/dajiaji
- npm.io page: https://npm.io/package/@hpke/core

## Dependencies (1)

- [@hpke/common](https://npm.io/package/@hpke/common.md) ^1.13.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.10.1 (latest) — 2026-11-08
- 1.10.0 — 2026-11-03
- 1.9.0 — 2026-03-08
- 1.8.0 — 2026-03-01
- 1.7.5 — 2025-11-19
- 1.7.4 — 2025-08-14
- 1.7.3 — 2025-07-11
- 1.7.2 — 2025-03-09
- 1.7.1 — 2024-11-10
- 1.7.0 — 2024-11-06
- 1.6.1 — 2024-11-05
- 1.6.0 — 2024-11-04
- 1.5.0 — 2024-10-12
- 1.4.3 — 2024-10-07
- 1.4.2 — 2024-10-06
- … 22 more at https://npm.io/package/@hpke/core/versions

## README

<h1 align="center">@hpke/core</h1>

<div align="center">
<a href="https://www.npmjs.com/package/@hpke/core"><img src="https://img.shields.io/npm/v/@hpke/core" alt="npm"/></a>
<a href="https://jsr.io/@hpke/core"><img src="https://jsr.io/badges/@hpke/core" alt="JSR"/></a>
</div>

<div align="center">
A TypeScript <a href="https://datatracker.ietf.org/doc/html/rfc9180">Hybrid Public Key Encryption (HPKE)</a> core module implemented using only <a href="https://www.w3.org/TR/WebCryptoAPI/">Web Cryptography API</a>. It does not support the X448-based KEM and the ChaCha20Poly1305 AEAD, but it has no external module dependencies. It's small in size and tree-shaking friendly.</div>
<p></p>

<div align="center">

Documentation: [jsr.io](https://jsr.io/@hpke/core/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/core/docs/)

</div>

Auth and AuthPSK require a KEM that supports AuthEncap/AuthDecap. ML-KEM, X-Wing
and X25519-Kyber768 support only Base and PSK modes; requesting authentication
with these KEMs throws `NotSupportedError` (RFC 9180 Section 7.1.5).

## Index

- [Installation](#installation)
  - [Node.js](#nodejs)
  - [Deno](#deno)
  - [Web Browsers](#web-browsers)
- [Usage](#usage)
- [Contributing](#contributing)

## Installation

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

### Node.js

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

```sh
# 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
```

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,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "@hpke/core";
```

### Deno

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

```sh
deno add jsr:@hpke/core
```

### Web Browsers

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

Using esm.sh:

```html
<!-- use a specific version -->
<script type="module">
import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "https://esm.sh/@hpke/core@<SEMVER>";
// ...
</script>

<!-- use the latest stable version -->
<script type="module">
import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "https://esm.sh/@hpke/core";
// ...
</script>
```

Using unpkg:

```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
// ...
</script>
```

## Usage

This section shows some typical usage examples.

### Node.js

```js
import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "@hpke/core";

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

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

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

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

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

  // 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 {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "@hpke/core";

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

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

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

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

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

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

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

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

### Web Browsers

```html
<html>
  <head></head>
  <body>
    <script type="module">
    import {
      Aes128Gcm,
      CipherSuite,
      DhkemP256HkdfSha256,
      HkdfSha256,
    } from "https://esm.sh/@hpke/core";

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

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

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

      const recipient = await suite.createRecipientContext({
        recipientKey: rkp.privateKey, // rkp (CryptoKeyPair) is also acceptable.
        enc: sender.enc,
      });

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

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

        // hello world!
        alert(new TextDecoder().decode(pt));
      } catch (err) {
        alert("failed to decrypt.");
      }
    };
    </script>
    <button type="button" onclick="doHpke()">do HPKE</button>
  </body>
</html>
```

## Contributing

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

---
_Source: https://npm.io/package/@hpke/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
