Merge pull request #20 from dajiaji/bump-to-1_0_0

Bump version up to 1.0.0.
dajiaji · Sep 11, 2023 · d5efe76 · d5efe76
2 parents a4bacbe + dc009fe
commit d5efe76
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 30 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/test/runtimes/browsers/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "npm"
+    directory: "/test/runtimes/cloudflare/"
+    schedule:
+      interval: "daily"
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,12 @@
 # Changes
 
+## Version 1.0.0
+
+Released 2023-09-11
+
+- [(#19) Add CI for various JavaScript runtimes.](https://github.com/dajiaji/crystals-kyber-js/pull/19)
+- [(#18) Remove KyberInterface.](https://github.com/dajiaji/crystals-kyber-js/pull/18)
+
 ## Version 0.3.1
 
 Released 2023-09-07

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <div align="center">
 
 [![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/crystals_kyber/mod.ts)
-![Browser CI](https://github.com/dajiaji/crystals-kyber-js/actions/workflows/ci_browser.yml/badge.svg)
+![Browser CI](https://github.com/dajiaji/crystals-kyber-js/actions/workflows/ci_browsers.yml/badge.svg)
 ![Node.js CI](https://github.com/dajiaji/crystals-kyber-js/actions/workflows/ci_node.yml/badge.svg)
 ![Deno CI](https://github.com/dajiaji/crystals-kyber-js/actions/workflows/ci_deno.yml/badge.svg)
 ![Cloudflare Workers CI](https://github.com/dajiaji/crystals-kyber-js/actions/workflows/ci_cloudflare.yml/badge.svg)
@@ -57,7 +57,7 @@ async function doKyber() {
   // The recipient decapsulates the ciphertext and generates the same shared secret with skR.
   const ssR = await recipient.decap(ct, skR);
 
-  console.assert(ssS === ssR, "The two shared secrets must match.");
+  // ssS === ssR
   return;
 }
 
@@ -100,7 +100,7 @@ Using deno.land:
 
 ```js
 // use a specific version
-import { Kyber768 } from "https://deno.land/x/crystals_kyber@0.3.1/mod.ts";
+import { Kyber768 } from "https://deno.land/x/crystals_kyber@1.0.0/mod.ts";
 
 // use the latest stable version
 import { Kyber768 } from "https://deno.land/x/crystals_kyber/mod.ts";
@@ -116,7 +116,7 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import { Kyber768 } from "https://esm.sh/crystals-kyber-js@0.3.1";
+  import { Kyber768 } from "https://esm.sh/crystals-kyber-js@1.0.0";
   // ...
 </script>
 
@@ -132,7 +132,7 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import { Kyber768 } from "https://unpkg.com/crystals-kyber-js@0.3.1";
+  import { Kyber768 } from "https://unpkg.com/crystals-kyber-js@1.0.0";
   // ...
 </script>
 ```
@@ -166,7 +166,7 @@ async function doKyber() {
 
   const ssR = await recipient.decap(ct, skR);
 
-  console.assert(ssS === ssR, "The two shared secrets must match.");
+  // ssS === ssR
   return;
 }
 
@@ -180,7 +180,7 @@ try {
 ### Deno
 
 ```js
-import { Kyber512 } from "https://deno.land/x/crystals_kyber@0.3.1/mod.ts";
+import { Kyber512 } from "https://deno.land/x/crystals_kyber@1.0.0/mod.ts";
 
 async function doKyber() {
 
@@ -192,7 +192,7 @@ async function doKyber() {
 
   const ssR = await recipient.decap(ct, skR);
 
-  console.assert(ssS === ssR, "The two shared secrets must match.");
+  // ssS === ssR
   return;
 }
 
@@ -210,7 +210,7 @@ try {
   <head></head>
   <body>
     <script type="module">
-      import { Kyber1024 } from "https://esm.sh/crystals-kyber@0.3.1";
+      import { Kyber1024 } from "https://esm.sh/crystals-kyber@1.0.0";
 
       globalThis.doKyber = async () => {
         try {
@@ -222,7 +222,7 @@ try {
 
           const ssR = await recipient.decap(ct, skR);
 
-          console.assert(ssS === ssR, "The two shared secrets must match.");
+          // ssS === ssR
           return;
         } catch (err) {
           alert("failed: ", err.message);

diff --git a/SECURITY.md b/SECURITY.md
@@ -4,7 +4,8 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 0.3.x   | :white_check_mark: |
+| 1.0.x   | :white_check_mark: |
+| < 1.0   | :x:                |
 
 ## Reporting a Vulnerability
 

diff --git a/src/kyber1024.ts b/src/kyber1024.ts
@@ -23,8 +23,7 @@ import { byte, int16, uint16, uint32 } from "./utils.ts";
  * const [ct, ssS] = await sender.encap(pkR);
 
  * const ssR = await recipient.decap(ct, skR);
-
- * console.assert(ssS === ssR, "The two shared secrets must match.");
+ * // ssS === ssR
  * ```
  */
 export class Kyber1024 extends KyberBase {

diff --git a/src/kyber512.ts b/src/kyber512.ts
@@ -18,13 +18,12 @@ import { byteopsLoad24, int16, prf } from "./utils.ts";
  *
  * const recipient = new Kyber512();
  * const [pkR, skR] = await recipient.generateKeyPair();
-
+ *
  * const sender = new Kyber512();
  * const [ct, ssS] = await sender.encap(pkR);
-
+ *
  * const ssR = await recipient.decap(ct, skR);
-
- * console.assert(ssS === ssR, "The two shared secrets must match.");
+ * // ssS === ssR
  * ```
  */
 export class Kyber512 extends KyberBase {

diff --git a/src/kyber768.ts b/src/kyber768.ts
@@ -17,13 +17,12 @@ import { KyberBase } from "./kyberBase.ts";
  *
  * const recipient = new Kyber768();
  * const [pkR, skR] = await recipient.generateKeyPair();
-
+ *
  * const sender = new Kyber768();
  * const [ct, ssS] = await sender.encap(pkR);
-
+ *
  * const ssR = await recipient.decap(ct, skR);
-
- * console.assert(ssS === ssR, "The two shared secrets must match.");
+ * // ssS === ssR
  * ```
  */
 export class Kyber768 extends KyberBase {

diff --git a/src/kyberBase.ts b/src/kyberBase.ts
@@ -163,7 +163,7 @@ export class KyberBase {
    * const [pk, sk] = await kyber.generateKeyPair();
    * const [ct, ssS] = await kyber.encap(pk);
    * const ssR = await kyber.decap(ct, sk);
-   * console.assert(ssS === ssR, "The two shared secrets must match.");
+   * // ssS === ssR
    * ```
    */
   public async decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array> {

diff --git a/test/kyber1024.test.ts b/test/kyber1024.test.ts
@@ -80,7 +80,6 @@ describe("Kyber1024", () => {
 
       const ssR = await recipient.decap(ct, skR);
 
-      console.assert(ssS === ssR, "The two shared secrets must match.");
       assertEquals(ssS, ssR);
     });
 
@@ -99,7 +98,6 @@ describe("Kyber1024", () => {
 
       const ssR = await recipient.decap(ct, skR);
 
-      console.assert(ssS === ssR, "The two shared secrets must match.");
       assertEquals(ssS, ssR);
     });
   });

diff --git a/test/kyber512.test.ts b/test/kyber512.test.ts
@@ -80,7 +80,6 @@ describe("Kyber512", () => {
 
       const ssR = await recipient.decap(ct, skR);
 
-      console.assert(ssS === ssR, "The two shared secrets must match.");
       assertEquals(ssS, ssR);
     });
 
@@ -99,7 +98,6 @@ describe("Kyber512", () => {
 
       const ssR = await recipient.decap(ct, skR);
 
-      console.assert(ssS === ssR, "The two shared secrets must match.");
       assertEquals(ssS, ssR);
     });
   });

diff --git a/test/kyber768.test.ts b/test/kyber768.test.ts
@@ -79,8 +79,6 @@ describe("Kyber768", () => {
       const [ct, ssS] = await sender.encap(pkR);
 
       const ssR = await recipient.decap(ct, skR);
-
-      console.assert(ssS === ssR, "The two shared secrets must match.");
       assertEquals(ssS, ssR);
     });
 
@@ -98,8 +96,6 @@ describe("Kyber768", () => {
       const [ct, ssS] = await sender.encap(pkR);
 
       const ssR = await recipient.decap(ct, skR);
-
-      console.assert(ssS === ssR, "The two shared secrets must match.");
       assertEquals(ssS, ssR);
     });
   });