Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@hpke/dhkem-secp256k1

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@hpke/dhkem-secp256k1

A Hybrid Public Key Encryption (HPKE) module extension for secp256k1 curve (EXPERIMENTAL)

1.1.1
Source
npm

Version published: last year

Maintainers: 1

Created: last year

Source

@hpke/dhkem-secp256k1

A TypeScript Hybrid Public Key Encryption (HPKE) module extension for DH-KEM with secp256k1 curve, which is implemented by using @noble/curves/secp256k1. Note that the extension is EXPERIMENTAL and NOT STANDARDIZED.

Documentation: deno.land | pages(only for the latest ver.)

Index

Installation

Web Browser

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

Using esm.sh:

<!-- use a specific version -->
<script type="module">
  import * as hpke from "https://esm.sh/@hpke/core@1.1.1";
  import * as secp256k1 from "https://esm.sh/@hpke/dhkem-secp256k1@1.1.1";
  // ...
</script>

<!-- use the latest stable version -->
<script type="module">
  import * as hpke from "https://esm.sh/@hpke/core";
  import * as secp256k1 from "https://esm.sh/@hpke/dhkem-secp256k1";
  // ...
</script>

Using unpkg:

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

Node.js

Using npm:

npm install @hpke/dhkem-secp256k1

Using yarn:

yarn add @hpke/dhkem-secp256k1

Deno

Using deno.land:

// use a specific version
import * as hpke from "https://deno.land/x/hpke@1.1.1/core/mod.ts";
import * as secp256k1 from "https://deno.land/x/hpke@1.1.1/x/dhkem-secp256k1/mod.ts";

// use the latest stable version
import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
import * as secp256k1 from "https://deno.land/x/hpke/x/dhkem-secp256k1/mod.ts";

Cloudflare Workers

git clone git@github.com:dajiaji/hpke-js.git
cd hpke-js/x/dhkem-secp256k1
npm install -g esbuild
deno task dnt
deno task minify > $YOUR_SRC_PATH/hpke-dhkem-secp256k1.js

Usage

This section shows some typical usage examples.

Browsers

<html>
  <head></head>
  <body>
    <script type="module">
      import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.1.1";
      import { DhkemSecp256k1HkdfSha256 } from "https://esm.sh/@hpke/dhkem-secp256k1@1.1.1";

      globalThis.doHpke = async () => {

        const suite = new CipherSuite({
          kem: new DhkemSecp256k1HkdfSha256(),
          kdf: KdfId.HkdfSha256,
          aead: AeadId.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>

Node.js

import { AeadId, CipherSuite, KdfId } from "@hpke/core";
import { DhkemSecp256k1HkdfSha256 } from "@hpke/dhkem-secp256k1";
// const { DhkemSecp256k1HkdfSha256 } = require("@hpke/dhkem-secp256k1");

async function doHpke() {
  // setup
  const suite = new CipherSuite({
    kem: new DhkemSecp256k1HkdfSha256(),
    kdf: KdfId.HkdfSha256,
    aead: AeadId.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("my-secret-message"));

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

    console.log("decrypted: ", new TextDecoder().decode(pt));
    // decrypted: my-secret-message
  } catch (err) {
    console.log("failed to decrypt.");
  }
}

doHpke();

Deno

import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.1.1/core/mod.ts";
import { DhkemSecp256k1HkdfSha256 } from "https://deno.land/x/hpke@1.1.1/x/dhkem-secp256k1/mod.ts";

async function doHpke() {
  // setup
  const suite = new CipherSuite({
    kem: new DhkemSecp256k1HkdfSha256(),
    kdf: KdfId.HkdfSha256,
    aead: AeadId.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("my-secret-message"));

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

    console.log("decrypted: ", new TextDecoder().decode(pt));
    // decrypted: my-secret-message
  } catch (_err: unknown) {
    console.log("failed to decrypt.");
  }
}

doHpke();

Contributing

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

Keywords

FAQs

What is @hpke/dhkem-secp256k1?

Is @hpke/dhkem-secp256k1 well maintained?

Package last updated on 15 Aug 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install