Skip to content

Commit 3a59604

Browse files
dajiajidajiaji
authored
Merge pull request #428 from dajiaji/bump-to-1_5_0
Bump version to 1.5.0.
2 parents 97d2c03 + 11ae9da commit 3a59604

File tree

13 files changed

+42
-43
lines changed

13 files changed

+42
-43
lines changed

‎CHANGES.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Changes
22

3+
## Version 1.5.0
4+
5+
Released 2024-10-12
6+
7+
- [(#427) Introduce isDeno utility instead of isNode.](https://github.com/dajiaji/hpke-js/pull/427)
8+
- [(#425) Use codecove only to Deno v2.](https://github.com/dajiaji/hpke-js/pull/425)
9+
- [(#424) Add isDenoV1 for testing.](https://github.com/dajiaji/hpke-js/pull/424)
10+
- [(#423) Fix deno task test:* for Deno v2.](https://github.com/dajiaji/hpke-js/pull/423)
11+
- [(#422) Bump base deno version to v2.0.0.](https://github.com/dajiaji/hpke-js/pull/422)
12+
313
## Version 1.4.3
414

515
Released 2024-10-07

‎README.md‎

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ npm install hpke-js
4242
Then, you can use it as follows:
4343

4444
```js
45-
// import { AeadId, CipherSuite, KdfId, KemId } from "hpke-js";
46-
// const { AeadId, CipherSuite, KdfId, KemId } = require("@hpke/hpke-js");
4745
import {
4846
Aes128Gcm,
4947
CipherSuite,
@@ -52,19 +50,11 @@ import {
5250
} from "@hpke/core";
5351

5452
async function doHpke() {
55-
// When using "@hpke/core", specify the cryptographic algorithm instances
56-
// as follows, instead of identities above:
5753
const suite = new CipherSuite({
5854
kem: new DhkemP256HkdfSha256(),
5955
kdf: new HkdfSha256(),
6056
aead: new Aes128Gcm(),
6157
});
62-
// When using "hpke-js", specify the cryptographic algorithm as follows:
63-
// const suite = new CipherSuite({
64-
// kem: KemId.DhkemP256HkdfSha256,
65-
// kdf: KdfId.HkdfSha256,
66-
// aead: AeadId.Aes128Gcm,
67-
// });
6858

6959
// A recipient generates a key pair.
7060
const rkp = await suite.kem.generateKeyPair();
@@ -118,15 +108,16 @@ try {
118108

119109
The hpke-js includes the following packages.
120110

121-
| name | since | description |
122-
| ------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
123-
| hpke-js | v0.1.0- | The HPKE module supporting all of the ciphersuites defined in [RFC9180](https://datatracker.ietf.org/doc/html/rfc9180), which consists of the following @hpke/{core, dhkem-x25519, dhkem-x448, chacha20poly1305} internally. |
124-
| @hpke/core | v1.0.0- | The HPKE core module implemented using only [Web Cryptography API](https://www.w3.org/TR/WebCryptoAPI/). It does not support the X25519/X448-based KEMs and the ChaCha20/Poly1305 AEAD, but it has no external module dependencies. It's small in size and tree-shaking friendly. See [/core/README](https://github.com/dajiaji/hpke-js/blob/main/core/README.md). |
125-
| @hpke/chacha20poly1305 | v1.0.0- | The HPKE module extension for ChaCha20Poly1305 AEAD. See [/x/chacha20poly1305/README](https://github.com/dajiaji/hpke-js/blob/main/x/chacha20poly1305/README.md). |
126-
| @hpke/dhkem-x25519 | v1.0.0- | The HPKE module extension for DHKEM(X25519, HKDF-SHA256). See [/x/dhkem-x25519/README](https://github.com/dajiaji/hpke-js/blob/main/x/dhkem-x25519/README.md). |
127-
| @hpke/dhkem-x448 | v1.0.0- | The HPKE module extension for DHKEM(X448, HKDF-SHA512). See [/x/dhkem-x448/README](https://github.com/dajiaji/hpke-js/blob/main/x/dhkem-x448/README.md). |
128-
| @hpke/hybridkem-x25519-kyber768 | v1.2.1- | **EXPERIMENTAL AND NOT STANDARDIZED** The HPKE module extension for the hybrid post-quantum KEM currently named [X25519Kyber768Draft00](https://datatracker.ietf.org/doc/draft-westerbaan-cfrg-hpke-xyber768d00/). See [/x/hybridkem-x25519-kyber768/README](https://github.com/dajiaji/hpke-js/blob/main/x/hybridkem-x25519-kyber768/README.md). |
129-
| @hpke/dhkem-secp256k1 | v1.0.0- | **EXPERIMENTAL AND NOT STANDARDIZED** The HPKE module extension for DHKEM(secp256k1, HKDF-SHA256). See [/x/dhkem-secp256k1/README](https://github.com/dajiaji/hpke-js/blob/main/x/dhkem-secp256k1/README.md). |
111+
| name | since | description |
112+
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
113+
| @hpke/core | [![npm](https://img.shields.io/npm/v/@hpke/core?color=%23EE3214)](https://www.npmjs.com/package/@hpke/core)<br/>[![JSR](https://jsr.io/badges/@hpke/core)](https://jsr.io/@hpke/core) | The HPKE core module implemented using only [Web Cryptography API](https://www.w3.org/TR/WebCryptoAPI/). It does not support the X25519/X448-based KEMs and the ChaCha20/Poly1305 AEAD, but it has no external module dependencies. It's small in size and tree-shaking friendly.<br/>[README](https://github.com/dajiaji/hpke-js/blob/main/packages/core/README.md) / [samples](https://github.com/dajiaji/hpke-js/tree/main/packages/core/samples) |
114+
| @hpke/chacha20poly1305 | [![npm](https://img.shields.io/npm/v/@hpke/chacha20poly1305?color=%23EE3214)](https://www.npmjs.com/package/@hpke/chacha20poly1305)<br/>[![JSR](https://jsr.io/badges/@hpke/chacha20poly1305)](https://jsr.io/@hpke/chacha20poly1305) | The HPKE module extension for ChaCha20Poly1305 AEAD.<br/>[README](https://github.com/dajiaji/hpke-js/blob/main/packages/chacha20poly1305/README.md) / [samples](https://github.com/dajiaji/hpke-js/tree/main/packages/chacha20poly1305/samples) |
115+
| @hpke/dhkem-x25519 | [![npm](https://img.shields.io/npm/v/@hpke/dhkem-x25519?color=%23EE3214)](https://www.npmjs.com/package/@hpke/dhkem-x25519)<br/>[![JSR](https://jsr.io/badges/@hpke/dhkem-x25519)](https://jsr.io/@hpke/dhkem-x25519) | The HPKE module extension for DHKEM(X25519, HKDF-SHA256).<br/>[README](https://github.com/dajiaji/hpke-js/blob/main/packages/dhkem-x25519/README.md) / [samples](https://github.com/dajiaji/hpke-js/tree/main/packages/dhkem-x25519/samples) |
116+
| @hpke/dhkem-x448 | [![npm](https://img.shields.io/npm/v/@hpke/dhkem-x448?color=%23EE3214)](https://www.npmjs.com/package/@hpke/dhkem-x448)<br/>[![JSR](https://jsr.io/badges/@hpke/dhkem-x448)](https://jsr.io/@hpke/dhkem-x448) | The HPKE module extension for DHKEM(X448, HKDF-SHA512).<br/>[README](https://github.com/dajiaji/hpke-js/blob/main/packages/dhkem-x448/README.md) / [samples](https://github.com/dajiaji/hpke-js/tree/main/packages/dhkem-x448/samples) |
117+
| hpke-js | [![npm](https://img.shields.io/npm/v/hpke-js?color=%23EE3214)](https://www.npmjs.com/package/hpke-js) | The HPKE module supporting all of the ciphersuites defined in [RFC9180](https://datatracker.ietf.org/doc/html/rfc9180), which consists of the above @hpke/{core, dhkem-x25519, dhkem-x448, chacha20poly1305} internally.<br/>[README](https://github.com/dajiaji/hpke-js/tree/main/packages/hpke-js/README.md) / [samples](https://github.com/dajiaji/hpke-js/tree/main/packages/hpke-js/samples) |
118+
| @hpke/hpke-js | [![JSR](https://jsr.io/badges/@hpke/hpke-js)](https://jsr.io/@hpke/hpke-js) | The JSR version of the above `hpke-js`.<br/>[README](https://github.com/dajiaji/hpke-js/tree/main/packages/hpke-js/README.md) / [samples](https://github.com/dajiaji/hpke-js/tree/main/packages/hpke-js/samples) |
119+
| @hpke/hybridkem-x25519-kyber768 | [![npm](https://img.shields.io/npm/v/@hpke/hybridkem-x25519-kyber768?color=%23EE3214)](https://www.npmjs.com/package/@hpke/hybridkem-x25519-kyber768)<br/>[![JSR](https://jsr.io/badges/@hpke/hybridkem-x25519-kyber768)](https://jsr.io/@hpke/core) | **EXPERIMENTAL AND NOT STANDARDIZED**<br/>The HPKE module extension for the hybrid post-quantum KEM currently named [X25519Kyber768Draft00](https://datatracker.ietf.org/doc/draft-westerbaan-cfrg-hpke-xyber768d00/).<br/>[README](https://github.com/dajiaji/hpke-js/blob/main/packages/hybridkem-x25519-kyber768/README.md) / [samples](https://github.com/dajiaji/hpke-js/tree/main/packages/hybridkem-x25519-kyber768/samples) |
120+
| @hpke/dhkem-secp256k1 | [![npm](https://img.shields.io/npm/v/@hpke/dhkem-secp256k1?color=%23EE3214)](https://www.npmjs.com/package/@hpke/dhkem-secp256k1)<br/>[![JSR](https://jsr.io/badges/@hpke/dhkem-secp256k1)](https://jsr.io/@hpke/dhkem-secp256k1) | **EXPERIMENTAL AND NOT STANDARDIZED**<br/>The HPKE module extension for DHKEM(secp256k1, HKDF-SHA256).<br/>[README](https://github.com/dajiaji/hpke-js/blob/main/packages/dhkem-secp256k1/README.md) / [samples](https://github.com/dajiaji/hpke-js/tree/main/packages/dhkem-secp256k1/samples) |
130121

131122
## Supported Features
132123

@@ -175,7 +166,7 @@ The hpke-js includes the following packages.
175166
supported browsers
176167
- Confirmed: Chrome, Firefox, Edge, Safari, Opera, Vivaldi, Brave
177168
- **Node.js**: 16.x, 17.x, 18.x, 19.x, 20.x, 21.x, 22.x
178-
- **Deno**: 1.x (1.25-)
169+
- **Deno**: 1.x, 2.x
179170
- **Cloudflare Workers**
180171
- **bun**: 0.x (0.6.0-), 1.x
181172

‎SECURITY.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@
44

55
| Version | Supported |
66
| ------- | ------------------ |
7+
| 1.5.x | :white_check_mark: |
78
| 1.4.x | :white_check_mark: |
8-
| 1.2.x | :white_check_mark: |
9-
| 1.2.8 | :x: |
10-
| 0.22.x | :white_check_mark: |
9+
| 1.3.x | :white_check_mark: |
1110
| < 1.3 | :x: |
12-
| < 0.22 | :x: |
1311

1412
## Reporting a Vulnerability
1513

‎deno.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"**/*/*.js",
2323
"**/*/npm/",
2424
"**/*/.wrangler/",
25-
"coverage/*.json"
25+
"coverage/"
2626
]
2727
},
2828
"lint": {
@@ -31,7 +31,7 @@
3131
"**/*/*.js",
3232
"**/*/npm/",
3333
"**/*/.wrangler/",
34-
"coverage/*.json"
34+
"coverage/"
3535
]
3636
},
3737
"test": {
@@ -41,7 +41,7 @@
4141
"**/*/*.js",
4242
"**/*/npm/",
4343
"**/*/.wrangler/",
44-
"coverage/*.json"
44+
"coverage/"
4545
]
4646
},
4747
"tasks": {

‎npm/package-lock.json‎

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/chacha20poly1305/deno.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hpke/chacha20poly1305",
3-
"version": "1.4.3",
3+
"version": "1.5.0",
44
"exports": "./mod.ts",
55
"imports": {
66
"@noble/ciphers": "npm:@noble/ciphers@^0.5.3"

‎packages/common/deno.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hpke/common",
3-
"version": "1.4.3",
3+
"version": "1.5.0",
44
"exports": "./mod.ts",
55
"publish": {
66
"exclude": [

‎packages/core/deno.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hpke/core",
3-
"version": "1.4.3",
3+
"version": "1.5.0",
44
"exports": "./mod.ts",
55
"publish": {
66
"exclude": [

‎packages/dhkem-secp256k1/deno.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hpke/dhkem-secp256k1",
3-
"version": "1.4.3",
3+
"version": "1.5.0",
44
"exports": "./mod.ts",
55
"imports": {
66
"@noble/curves": "npm:@noble/curves@^1.4.2"

‎packages/dhkem-x25519/deno.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hpke/dhkem-x25519",
3-
"version": "1.4.3",
3+
"version": "1.5.0",
44
"exports": "./mod.ts",
55
"imports": {
66
"@noble/curves": "npm:@noble/curves@^1.4.2",

0 commit comments

Comments
 (0)