npm.io
1.8.1 • Published 1 week ago

@hpke/chacha20poly1305

Licence
MIT
Version
1.8.1
Deps
1
Size
97 kB
Vulns
0
Weekly
0
Stars
130

@hpke/chacha20poly1305

npm JSR
A TypeScript Hybrid Public Key Encryption (HPKE) module extension for AEAD with ChaCha20-Poly1305, which is implemented by using @noble/ciphers

Index

Installation

@hpke/chacha20poly1305 need to be used with @hpke/core, which can be installed in the same manner as desribed below.

Node.js

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

# Using npm:
npm install @hpke/chacha20poly1305
yarn add @hpke/chacha20poly1305
pnpm install @hpke/chacha20poly1305
# Using jsr:
npx jsr add @hpke/chacha20poly1305
yarn add jsr:@hpke/chacha20poly1305
pnpm add jsr:@hpke/chacha20poly1305

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:

import { CipherSuite, DhkemP256HkdfSha256, HkdfSha256 } from "@hpke/core";
import { Chacha20Poly1305 } from "@hpke/chacha20poly1305";
Deno

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

deno add jsr:@hpke/chacha20poly1305
Web Browsers

Followings 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 {
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "https://esm.sh/@hpke/core@<SEMVER>";
import { Chacha20Poly1305 } from "https://esm.sh/@hpke/chacha20poly1305@<SEMVER>";
// ...
</script>

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

Using unpkg:

<!-- use a specific version -->
<script type="module">
import {
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
import { Chacha20Poly1305 } from "https://unpkg.com/@hpke/chacha20poly1305@<SEMVER>/esm/mod.js";
// ...
</script>

Usage

This section shows some typical usage examples.

Node.js
import { CipherSuite, DhkemP256HkdfSha256, HkdfSha256 } from "@hpke/core";
import { Chacha20Poly1305 } from "@hpke/chacha20poly1305";
// const { Chacha20Poly1305 } = require("@hpke/chacha20poly1305");

async function doHpke() {
  // setup
  const suite = new CipherSuite({
    kem: new DhkemP256HkdfSha256(),
    kdf: new HkdfSha256(),
    aead: new 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) {
  console.log("failed:", err.message);
}
Deno
import { CipherSuite, DhkemP256HkdfSha256, HkdfSha256 } from "@hpke/core";
import { Chacha20Poly1305 } from "@hpke/chacha20poly1305";

async function doHpke() {
  // setup
  const suite = new CipherSuite({
    kem: new DhkemP256HkdfSha256(),
    kdf: new HkdfSha256(),
    aead: new 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.");
}
Web Browsers
<html>
  <head></head>
  <body>
    <script type="module">
    // import * as hpke from "https://esm.sh/hpke-js@<SEMVER>";
    import {
      CipherSuite,
      DhkemP256HkdfSha256,
      HkdfSha256,
    } from "https://esm.sh/@hpke/core";
    import { Chacha20Poly1305 } from "https://esm.sh/@hpke/chacha20poly1305";

    globalThis.doHpke = async () => {
      try {
        const suite = new CipherSuite({
          kem: new DhkemP256HkdfSha256(),
          kdf: new HkdfSha256(),
          aead: new 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, // rkp (CryptoKeyPair) is also acceptable.
          enc: sender.enc,
        });

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

        // Hello world!
        alert(new TextDecoder().decode(pt));
      } catch (err) {
        alert("failed:", err.message);
      }
    };
    </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.

Keywords