simple-hpke 0.0.8 → 0.0.11

package/README.md

@@ -1,11 +1,11 @@
 # Simple HPKE
 [![tests](https://img.shields.io/github/actions/workflow/status/nichoth/simple-hpke/nodejs.yml?style=flat-square)](https://github.com/nichoth/simple-hpke/actions/workflows/nodejs.yml)
-[![types](https://img.shields.io/npm/types/@substrate-system/simple-hpke?style=flat-square)](README.md)
+[![types](https://img.shields.io/npm/types/simple-hpke?style=flat-square)](README.md)
 [![module](https://img.shields.io/badge/module-ESM%2FCJS-blue?style=flat-square)](README.md)
 [![semantic versioning](https://img.shields.io/badge/semver-2.0.0-blue?logo=semver&style=flat-square)](https://semver.org/)
 [![Common Changelog](https://nichoth.github.io/badge/common-changelog.svg)](./CHANGELOG.md)
-[![install size](https://flat.badgen.net/packagephobia/install/@substrate-system/simple-hpke)](https://packagephobia.com/result?p=@substrate-system/simple-hpke)
-[![gzip size](https://flat.badgen.net/bundlephobia/minzip/@substrate-system/simple-hpke)](https://bundlephobia.com/package/@substrate-system/simple-hpke)
+[![install size](https://flat.badgen.net/packagephobia/install/simple-hpke)](https://packagephobia.com/result?p=simple-hpke)
+[![gzip size](https://flat.badgen.net/bundlephobia/minzip/simple-hpke)](https://bundlephobia.com/package/simple-hpke)
 [![license](https://img.shields.io/badge/license-Big_Time-blue?style=flat-square)](LICENSE)
 
 
@@ -24,7 +24,7 @@ Hybrid Public Key Encryption
   * [Hybrid Encryption](#hybrid-encryption)
     + [Encrypt / Decrypt](#encrypt--decrypt)
       - [`encrypt`](#encrypt)
-      - [Encrypt to a string](#encrypt-to-a-string)
+      - [`encrypt.asString`](#encryptasstring)
       - [`decrypt`](#decrypt)
       - [`decrypt.asString`](#decryptasstring)
       - [`decrypt.fromString`](#decryptfromstring)
@@ -42,7 +42,7 @@ Hybrid Public Key Encryption
 ## Install
 
 ```sh
-npm i -S @substrate-system/simple-hpke
+npm i -S simple-hpke
 ```
 
 ## Example
@@ -54,10 +54,11 @@ Wrap an AES key, or encrypt a message.
 Encrypt an AES key to yourself, then recover it later.
 
 ```ts
-import { seal, open } from '@substrate-system/simple-hpke'
+import { seal, open } from 'simple-hpke'
 
-// An X25519 keypair. The private key can be non-extractable.
-// HPKE needs only `deriveBits`.
+// An X25519 keypair. (asymmetric keypair).
+// The private key can be non-extractable.
+// HPKE only needs `deriveBits`.
 const keypair = await crypto.subtle.generateKey(
     { name: 'X25519' },
     false,  // extractable
@@ -67,31 +68,37 @@ const keypair = await crypto.subtle.generateKey(
 // create a new AES key, and encrypt it to your public key.
 const { wrapped, key } = await seal(keypair)
 
-// Or wrap an existing AES key. The supplied key must be extractable.
+// Or wrap an existing AES key. The supplied AES key must be extractable.
 const aesKey = await crypto.subtle.generateKey(
     { name: 'AES-GCM', length: 256 },
     true,  // extractable
     ['encrypt', 'decrypt']
 )
 
-// pass in a key. The return value is just the wrapped key
+// pass in an existing key. The return value has the wrapped key.
 const { wrapped } = await seal(keypair, aesKey)
 
 // Later, recover the same key with your private key.
 const recoveredKey = await open(keypair, wrapped)
+
+// `recoveredKey` is equal to `aesKey`
 ```
 
 See [docs/README.md](./docs/README.md) for the full API and rationale.
 
+
+------------------------------------------------------
+
+
 ### Hybrid Encryption
 
-Seal a key, then use it to encrypt a message with AES-GCM.
-The wrapped key is concattenated with the cipher text, along with the
-IV. The recipient uses their private key to open the AES key and decrypt
-the message.
+Encrypt a message with AES-GCM, then encrypt the AES key to a given
+public key. The wrapped key is concattenated with the cipher text,
+along with the IV. The recipient uses their private key to open the AES key and
+decrypt the message.
 
 ```ts
-import { seal, open } from '@substrate-system/simple-hpke'
+import { seal, open } from 'simple-hpke'
 
 const recipient = await crypto.subtle.generateKey(
     { name: 'X25519' },
@@ -155,10 +162,7 @@ cipher text). `decrypt` reverses it, returning the plaintext bytes.
 
 
 ```ts
-import {
-    encrypt,
-    decrypt
-} from '@substrate-system/simple-hpke'
+import { encrypt, decrypt } from 'simple-hpke'
 
 // need a public key for the recipient
 const recipient = await crypto.subtle.generateKey(
@@ -214,14 +218,14 @@ async function encrypt (
 ):Promise<Uint8Array>
 ```
 
-##### Encrypt to a string
+##### `encrypt.asString`
 
-`encrypt.asString` is `encrypt` with the envelope encoded to a string, handy
+`encrypt.asString` is `encrypt` with the envelope encoded to a string, useful
 for transports that carry text (JSON, URLs, headers). `opts.encoding` sets the
 string encoding. Default encoding is `base64url`.
 
 ```ts
-import { encrypt, decrypt } from '@substrate-system/ecies'
+import { encrypt, decrypt } from 'simple-hpke'
 import { fromString } from 'uint8arrays'
 
 // recipient is any RecipientKey; keypair holds the matching private key
@@ -289,12 +293,12 @@ This exposes ESM and common JS via
 
 ### ESM
 ```js
-import { seal, open, encrypt, decrypt } from '@substrate-system/simple-hpke'
+import { seal, open, encrypt, decrypt } from 'simple-hpke'
 ```
 
 ### Common JS
 ```js
-require('@substrate-system/simple-hpke')
+require('simple-hpke')
 ```
 
 ### pre-built JS
@@ -303,7 +307,7 @@ accessible to your web server, then link to them in HTML.
 
 #### copy
 ```sh
-cp ./node_modules/@substrate-system/simple-hpke/dist/index.min.js ./public/hpke.min.js
+cp ./node_modules/simple-hpke/dist/index.min.js ./public/hpke.min.js
 ```
 
 #### HTML