@qorechain/pqc 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,47 @@
+# @qorechain/pqc
+
+Post-quantum cryptography for [QoreChain](https://github.com/qorechain/qorechain-pqc) — standardized NIST primitives with one consistent API, proven byte-compatible against a shared cross-language test-vector suite.
+
+| Primitive | Standard | Role |
+|---|---|---|
+| ML-DSA | FIPS-204 | digital signatures (44 · 65 · **87**) |
+| ML-KEM | FIPS-203 | key encapsulation (512 · 768 · **1024**) |
+| SHAKE-256 | FIPS-202 | extendable-output hash |
+
+Backed by [`@noble/post-quantum`](https://github.com/paulmillr/noble-post-quantum).
+
+## Install
+
+```sh
+npm install @qorechain/pqc
+```
+
+## Use
+
+```js
+import { mldsa, mlkem, shake256, pubkeyHash } from '@qorechain/pqc';
+
+// ML-DSA-87 signatures
+const { publicKey, secretKey } = mldsa.keygen();
+const sig = mldsa.sign(secretKey, message);
+mldsa.verify(publicKey, message, sig); // true
+
+// ML-KEM-1024 key encapsulation
+const { publicKey: ek, secretKey: dk } = mlkem.keygen();
+const { cipherText, sharedSecret } = mlkem.encapsulate(ek);
+mlkem.decapsulate(dk, cipherText); // === sharedSecret
+
+// SHAKE-256 + blockchain helpers
+shake256(data, 32);        // 32-byte digest
+pubkeyHash(publicKey, 20); // pay-to-pubkey-hash
+```
+
+Level-specific exports: `mldsa44/65/87`, `mlkem512/768/1024` (`mldsa`/`mlkem` are the L5 defaults). Also `hybridSignBytes(bodyWithoutPqcExt, authInfo)` and `batchVerify`.
+
+## Interop
+
+Every binding (JS, Rust, Go, C, Python, Java) verifies the same vectors in [`/vectors`](https://github.com/qorechain/qorechain-pqc/tree/main/vectors), so a signature produced here verifies in every other language. See the [root README](https://github.com/qorechain/qorechain-pqc#readme).
+
+## License
+
+Apache-2.0

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@qorechain/pqc",
+  "version": "0.1.0",
+  "description": "QoreChain post-quantum cryptography — FIPS-204 ML-DSA, FIPS-203 ML-KEM, FIPS-202 SHAKE-256, with blockchain helpers. Byte-compatible across Rust/Go/Python/Java/C via shared test vectors.",
+  "type": "module",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "node --test"
+  },
+  "keywords": [
+    "post-quantum",
+    "pqc",
+    "ml-dsa",
+    "dilithium",
+    "ml-kem",
+    "kyber",
+    "shake256",
+    "fips-204",
+    "fips-203",
+    "qorechain",
+    "blockchain"
+  ],
+  "license": "Apache-2.0",
+  "author": "QoreChain",
+  "homepage": "https://github.com/qorechain/qorechain-pqc/tree/main/js#readme",
+  "bugs": {
+    "url": "https://github.com/qorechain/qorechain-pqc/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/qorechain/qorechain-pqc.git",
+    "directory": "js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@noble/post-quantum": "^0.6.1",
+    "@noble/hashes": "^2.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,21 @@
+export interface KeyPair { publicKey: Uint8Array; secretKey: Uint8Array; }
+export interface SigScheme {
+  readonly name: string;
+  keygen(seed?: Uint8Array): KeyPair;
+  sign(secretKey: Uint8Array, message: Uint8Array): Uint8Array;
+  verify(publicKey: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;
+}
+export interface KemScheme {
+  readonly name: string;
+  keygen(seed?: Uint8Array): KeyPair;
+  encapsulate(publicKey: Uint8Array): { cipherText: Uint8Array; sharedSecret: Uint8Array };
+  decapsulate(secretKey: Uint8Array, cipherText: Uint8Array): Uint8Array;
+}
+export const mldsa44: SigScheme; export const mldsa65: SigScheme; export const mldsa87: SigScheme;
+export const mlkem512: KemScheme; export const mlkem768: KemScheme; export const mlkem1024: KemScheme;
+export const mldsa: SigScheme; export const mlkem: KemScheme;
+export function shake256(data: Uint8Array, outLen?: number): Uint8Array;
+export function pubkeyHash(publicKey: Uint8Array, len?: number): Uint8Array;
+export function hybridSignBytes(bodyWithoutPqcExt: Uint8Array, authInfoBytes: Uint8Array): Uint8Array;
+export function batchVerify(scheme: SigScheme, items: { publicKey: Uint8Array; message: Uint8Array; signature: Uint8Array }[]): number;
+export const VERSION: string;

package/src/index.js

@@ -0,0 +1,80 @@
+// @qorechain/pqc — post-quantum cryptography for QoreChain.
+//
+// Standards (final NIST FIPS), wrapping the audited @noble/post-quantum:
+//   - ML-DSA   (FIPS-204) signatures — levels 44 / 65 / 87 (default 87)
+//   - ML-KEM   (FIPS-203) key encapsulation — levels 512 / 768 / 1024 (default 1024)
+//   - SHAKE-256 (FIPS-202) extendable-output hash
+//
+// The API is intentionally identical across every language binding in this repo
+// (keygen / sign(secretKey, message) / verify(publicKey, message, signature)),
+// and all bindings are validated against the shared vectors in /vectors.
+import { ml_dsa44, ml_dsa65, ml_dsa87 } from '@noble/post-quantum/ml-dsa.js';
+import { ml_kem512, ml_kem768, ml_kem1024 } from '@noble/post-quantum/ml-kem.js';
+import { shake256 as nobleShake } from '@noble/hashes/sha3.js';
+
+function wrapSig(scheme, name) {
+  return {
+    name,
+    // keygen(seed?) -> { publicKey, secretKey }. seed is a 32-byte ML-DSA xi.
+    keygen: (seed) => scheme.keygen(seed),
+    // sign(secretKey, message) -> signature  (conventional arg order)
+    sign: (secretKey, message) => scheme.sign(message, secretKey),
+    // verify(publicKey, message, signature) -> boolean
+    verify: (publicKey, message, signature) => scheme.verify(signature, message, publicKey),
+  };
+}
+function wrapKem(scheme, name) {
+  return {
+    name,
+    keygen: (seed) => scheme.keygen(seed),
+    encapsulate: (publicKey) => scheme.encapsulate(publicKey),
+    decapsulate: (secretKey, cipherText) => scheme.decapsulate(cipherText, secretKey),
+  };
+}
+
+export const mldsa44 = wrapSig(ml_dsa44, 'ml-dsa-44');
+export const mldsa65 = wrapSig(ml_dsa65, 'ml-dsa-65');
+export const mldsa87 = wrapSig(ml_dsa87, 'ml-dsa-87');
+export const mlkem512 = wrapKem(ml_kem512, 'ml-kem-512');
+export const mlkem768 = wrapKem(ml_kem768, 'ml-kem-768');
+export const mlkem1024 = wrapKem(ml_kem1024, 'ml-kem-1024');
+
+// QoreChain defaults (security level 5).
+export const mldsa = mldsa87;
+export const mlkem = mlkem1024;
+
+// SHAKE-256 (FIPS-202). Default 32-byte digest; XOF for arbitrary length.
+export function shake256(data, outLen = 32) { return nobleShake(data, { dkLen: outLen }); }
+
+// ── Blockchain helpers ──────────────────────────────────────────────────────
+
+// pubkeyHash: SHAKE-256(publicKey) truncated to `len` bytes (default 20). Lets a
+// chain register only the 20/32-byte hash in account state and require the full
+// public key in the transaction (pay-to-pubkey-hash style), keeping state small.
+export function pubkeyHash(publicKey, len = 20) { return shake256(publicKey, len); }
+
+// hybridSignBytes: the canonical message a PQC signature covers in QoreChain's
+// hybrid-extension scheme. B0 is the tx body WITHOUT the PQC extension; the
+// framing BE32(len(B0))||B0||BE32(len(authInfo))||authInfo is independent of the
+// extension, so a wallet's classical signature and this PQC signature can be
+// layered without invalidating each other.
+export function hybridSignBytes(bodyWithoutPqcExt, authInfoBytes) {
+  const be32 = (n) => { const b = new Uint8Array(4); new DataView(b.buffer).setUint32(0, n >>> 0, false); return b; };
+  const parts = [be32(bodyWithoutPqcExt.length), bodyWithoutPqcExt, be32(authInfoBytes.length), authInfoBytes];
+  const total = parts.reduce((a, p) => a + p.length, 0);
+  const out = new Uint8Array(total); let o = 0;
+  for (const p of parts) { out.set(p, o); o += p.length; }
+  return out;
+}
+
+// batchVerify: verify many (publicKey, message, signature) triples; returns the
+// index of the first failure, or -1 if all valid.
+export function batchVerify(scheme, items) {
+  for (let i = 0; i < items.length; i++) {
+    const { publicKey, message, signature } = items[i];
+    if (scheme.verify(publicKey, message, signature) !== true) return i;
+  }
+  return -1;
+}
+
+export const VERSION = '0.1.0';