slh-dsa 0.0.2 → 0.0.4

package/README.md

@@ -1,37 +1,35 @@
 
-# @noble/post-quantum-simple
+# SLH-DSA/Sphincs+
 
 A lightweight wrapper around [@noble/post-quantum](https://github.com/paulmillr/noble-post-quantum) providing a simplified interface for SLH-DSA (SPHINCS+) stateless hash-based signatures.
 
 ## Features
 
--   🔐 **Simple API**: Just `generateKeys()`, `sign()`, and `verify()`
+-   🔐 **Simple API**: Just `keygen()`, `sign()`, and `verify()`
     
 -   🪶 **Lightweight**: Minimal abstraction over noble's implementation
     
--   📦 **Zero dependencies**: Only requires `@noble/post-quantum`
+-   📦 **Zero dependencies**: Only requires `@noble/hashes`
     
--   ⚡ **Multiple security levels**: SLH-DSA-SHAKE-128s, 128f, 192s, 192f, 256s
+-   ⚡ **Multiple security levels**: SLH-DSA-SHA2/SHAKE-128s, 128f, 192s, 192f, 256s
     
 
 ## Installation
 
 ```bash
-npm install @noble/post-quantum-simple
+npm install slh-dsa
 ```
 ## Quick Start
 
 ```javascript
-import { SLHDSA } from '@noble/post-quantum-simple';
-// Choose your security level
-const slhdsa = new SLHDSA('SLH-DSA-SHAKE-128s');
+import { slh_dsa_sha2_128s } from 'sslh-dsa';
 // Generate keypair
-const { publicKey, privateKey } = slhdsa.generateKeys();
+const { publicKey, privateKey } = slh_dsa_sha2_128s.keygen();
 // Sign a message
 const message = new TextEncoder().encode('Hello quantum world!');
-const signature = slhdsa.sign(privateKey, message);
+const signature = slh_dsa_sha2_128s.sign(message, privateKey);
 // Verify the signature
-const isValid = slhdsa.verify(publicKey, message, signature);
+const isValid = slh_dsa_sha2_128s.verify(signature, message, publicKey);
 console.log('Signature valid:', isValid); // true
 ```
 ## API
@@ -42,6 +40,7 @@ Created a new SLH-DSA instance with the specified algorithm.
 
 Supported algorithms:
 ```typescript
+// Standard configuration
 import {
 	slh_dsa_sha2_128f as sph,
 	slh_dsa_sha2_128s,
@@ -56,9 +55,13 @@ import {
 	slh_dsa_shake_256f,
 	slh_dsa_shake_256s,
 } from 'slh-dsa';
+
+// Special in this library
+import { customSphincs } from 'slh-dsa'
+const slh = customSphincs({ /* custom options */ }, /* hash function (sha256/sha512/shake) */)
 ```
 
-### `generateKeys()`
+### `keygen()`
 
 Generates a new keypair.
 Returns:
@@ -66,10 +69,10 @@ Returns:
 ```typescript
 {
 	publicKey: Uint8Array;
-	privateKey: Uint8Array;
+	secretKey: Uint8Array;
 }
 ```
-### `sign(privateKey, message)`
+### `sign(message, privateKey)`
 
 Signs a message using the private key.
 -   `privateKey`: `Uint8Array` - The private key from `generateKeys()`
@@ -79,7 +82,7 @@ Signs a message using the private key.
 
 Returns: `Uint8Array` - The signature
 
-### `verify(publicKey, message, signature)`
+### `verify(signature, message, publicKey)`
 
 Verifies a signature.
 

package/dist/index.d.ts

@@ -60,3 +60,4 @@ export declare const slh_dsa_sha2_192s: SphincsSigner;
 export declare const slh_dsa_sha2_256f: SphincsSigner;
 /** SLH-DSA: 256-bit small SHA2 version. */
 export declare const slh_dsa_sha2_256s: SphincsSigner;
+export declare const customSphincs: (opts: SphincsOpts, hash: "sha256" | "sha512" | "shake") => SphincsSigner;

package/dist/index.js

@@ -623,3 +623,6 @@ export const slh_dsa_sha2_192s = /* @__PURE__ */ gen(PARAMS['192s'], SHA512_SIMP
 export const slh_dsa_sha2_256f = /* @__PURE__ */ gen(PARAMS['256f'], SHA512_SIMPLE);
 /** SLH-DSA: 256-bit small SHA2 version. */
 export const slh_dsa_sha2_256s = /* @__PURE__ */ gen(PARAMS['256s'], SHA512_SIMPLE);
+export const customSphincs = (opts, hash) => {
+    return gen(opts, hash == 'sha256' ? SHA256_SIMPLE : hash == 'sha512' ? SHA512_SIMPLE : SHAKE_SIMPLE);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slh-dsa",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module",
   "description": "Lightweight wrapper for SLH-DSA or SPHINCS+",
   "author": "Nbrthx",