@twin.org/crypto 0.0.3-next.26 → 0.0.3-next.27

package/dist/es/hashes/argon2id.js

@@ -0,0 +1,38 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { argon2idAsync } from "@noble/hashes/argon2.js";
+import { Guards } from "@twin.org/core";
+/**
+ * Implementation of the Argon2id password based key derivation function.
+ */
+export class Argon2id {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "Argon2id";
+    /**
+     * Derive a key from the parameters using Argon2id.
+     * @param password The password to derive the key from.
+     * @param salt The salt for the derivation.
+     * @param options The options for the derivation.
+     * @param options.t Number of iterations to perform, default 1.
+     * @param options.m Amount of memory to use in kibibytes, default 8.
+     * @param options.p Number of parallel threads to use, default 1.
+     * @param options.dkLen The length of the derived key in bytes, default 32.
+     * @param options.maxmem The maximum amount of memory to use in bytes, default 2^30.
+     * @returns The derived key.
+     */
+    static async hash(password, salt, options) {
+        Guards.uint8Array(Argon2id.CLASS_NAME, "password", password);
+        Guards.uint8Array(Argon2id.CLASS_NAME, "salt", salt);
+        const localOptions = {
+            t: options?.t ?? 1,
+            m: options?.m ?? 8,
+            p: options?.p ?? 1,
+            dkLen: options?.dkLen ?? 32,
+            maxmem: options?.maxmem ?? 2 ** 30
+        };
+        return argon2idAsync(password, salt, localOptions);
+    }
+}
+//# sourceMappingURL=argon2id.js.map

package/dist/es/hashes/argon2id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"argon2id.js","sourceRoot":"","sources":["../../../src/hashes/argon2id.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAGxC;;GAEG;AACH,MAAM,OAAO,QAAQ;IACpB;;OAEG;IACI,MAAM,CAAU,UAAU,cAA8B;IAE/D;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACvB,QAAoB,EACpB,IAAgB,EAChB,OAMC;QAED,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QACnE,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG;YACpB,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC;YAClB,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC;YAClB,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC;YAClB,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC,IAAI,EAAE;SAClC,CAAC;QACF,OAAO,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACpD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { argon2idAsync } from \"@noble/hashes/argon2.js\";\nimport { Guards } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * Implementation of the Argon2id password based key derivation function.\n */\nexport class Argon2id {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<Argon2id>();\n\n\t/**\n\t * Derive a key from the parameters using Argon2id.\n\t * @param password The password to derive the key from.\n\t * @param salt The salt for the derivation.\n\t * @param options The options for the derivation.\n\t * @param options.t Number of iterations to perform, default 1.\n\t * @param options.m Amount of memory to use in kibibytes, default 8.\n\t * @param options.p Number of parallel threads to use, default 1.\n\t * @param options.dkLen The length of the derived key in bytes, default 32.\n\t * @param options.maxmem The maximum amount of memory to use in bytes, default 2^30.\n\t * @returns The derived key.\n\t */\n\tpublic static async hash(\n\t\tpassword: Uint8Array,\n\t\tsalt: Uint8Array,\n\t\toptions?: {\n\t\t\tt?: number;\n\t\t\tm?: number;\n\t\t\tp?: number;\n\t\t\tdkLen?: number;\n\t\t\tmaxmem?: number;\n\t\t}\n\t): Promise<Uint8Array> {\n\t\tGuards.uint8Array(Argon2id.CLASS_NAME, nameof(password), password);\n\t\tGuards.uint8Array(Argon2id.CLASS_NAME, nameof(salt), salt);\n\t\tconst localOptions = {\n\t\t\tt: options?.t ?? 1,\n\t\t\tm: options?.m ?? 8,\n\t\t\tp: options?.p ?? 1,\n\t\t\tdkLen: options?.dkLen ?? 32,\n\t\t\tmaxmem: options?.maxmem ?? 2 ** 30\n\t\t};\n\t\treturn argon2idAsync(password, salt, localOptions);\n\t}\n}\n"]}

package/dist/es/index.js

@@ -7,6 +7,7 @@ export * from "./curves/ed25519.js";
 export * from "./curves/secp256k1.js";
 export * from "./curves/x25519.js";
 export * from "./curves/zip215.js";
+export * from "./hashes/argon2id.js";
 export * from "./hashes/blake2b.js";
 export * from "./hashes/blake3.js";
 export * from "./hashes/hmacSha1.js";

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./address/bech32.js\";\nexport * from \"./address/bip44.js\";\nexport * from \"./ciphers/chaCha20Poly1305.js\";\nexport * from \"./curves/ed25519.js\";\nexport * from \"./curves/secp256k1.js\";\nexport * from \"./curves/x25519.js\";\nexport * from \"./curves/zip215.js\";\nexport * from \"./hashes/blake2b.js\";\nexport * from \"./hashes/blake3.js\";\nexport * from \"./hashes/hmacSha1.js\";\nexport * from \"./hashes/hmacSha256.js\";\nexport * from \"./hashes/hmacSha512.js\";\nexport * from \"./hashes/pbkdf2.js\";\nexport * from \"./hashes/sha1.js\";\nexport * from \"./hashes/sha256.js\";\nexport * from \"./hashes/sha3.js\";\nexport * from \"./hashes/sha512.js\";\nexport * from \"./helpers/integrityHelper.js\";\nexport * from \"./helpers/pemHelper.js\";\nexport * from \"./keys/bip32Path.js\";\nexport * from \"./keys/bip39.js\";\nexport * from \"./keys/slip0010.js\";\nexport * from \"./models/integrityAlgorithm.js\";\nexport * from \"./models/keyType.js\";\nexport * from \"./otp/hotp.js\";\nexport * from \"./otp/totp.js\";\nexport * from \"./passwords/passwordGenerator.js\";\nexport * from \"./passwords/passwordValidator.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./address/bech32.js\";\nexport * from \"./address/bip44.js\";\nexport * from \"./ciphers/chaCha20Poly1305.js\";\nexport * from \"./curves/ed25519.js\";\nexport * from \"./curves/secp256k1.js\";\nexport * from \"./curves/x25519.js\";\nexport * from \"./curves/zip215.js\";\nexport * from \"./hashes/argon2id.js\";\nexport * from \"./hashes/blake2b.js\";\nexport * from \"./hashes/blake3.js\";\nexport * from \"./hashes/hmacSha1.js\";\nexport * from \"./hashes/hmacSha256.js\";\nexport * from \"./hashes/hmacSha512.js\";\nexport * from \"./hashes/pbkdf2.js\";\nexport * from \"./hashes/sha1.js\";\nexport * from \"./hashes/sha256.js\";\nexport * from \"./hashes/sha3.js\";\nexport * from \"./hashes/sha512.js\";\nexport * from \"./helpers/integrityHelper.js\";\nexport * from \"./helpers/pemHelper.js\";\nexport * from \"./keys/bip32Path.js\";\nexport * from \"./keys/bip39.js\";\nexport * from \"./keys/slip0010.js\";\nexport * from \"./models/integrityAlgorithm.js\";\nexport * from \"./models/keyType.js\";\nexport * from \"./otp/hotp.js\";\nexport * from \"./otp/totp.js\";\nexport * from \"./passwords/passwordGenerator.js\";\nexport * from \"./passwords/passwordValidator.js\";\n"]}

package/dist/types/hashes/argon2id.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Implementation of the Argon2id password based key derivation function.
+ */
+export declare class Argon2id {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Derive a key from the parameters using Argon2id.
+     * @param password The password to derive the key from.
+     * @param salt The salt for the derivation.
+     * @param options The options for the derivation.
+     * @param options.t Number of iterations to perform, default 1.
+     * @param options.m Amount of memory to use in kibibytes, default 8.
+     * @param options.p Number of parallel threads to use, default 1.
+     * @param options.dkLen The length of the derived key in bytes, default 32.
+     * @param options.maxmem The maximum amount of memory to use in bytes, default 2^30.
+     * @returns The derived key.
+     */
+    static hash(password: Uint8Array, salt: Uint8Array, options?: {
+        t?: number;
+        m?: number;
+        p?: number;
+        dkLen?: number;
+        maxmem?: number;
+    }): Promise<Uint8Array>;
+}

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export * from "./curves/ed25519.js";
 export * from "./curves/secp256k1.js";
 export * from "./curves/x25519.js";
 export * from "./curves/zip215.js";
+export * from "./hashes/argon2id.js";
 export * from "./hashes/blake2b.js";
 export * from "./hashes/blake3.js";
 export * from "./hashes/hmacSha1.js";

package/docs/changelog.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [0.0.3-next.27](https://github.com/twinfoundation/framework/compare/crypto-v0.0.3-next.26...crypto-v0.0.3-next.27) (2026-03-27)
+
+
+### Features
+
+* add crypto argon2id ([#255](https://github.com/twinfoundation/framework/issues/255)) ([27fe3a7](https://github.com/twinfoundation/framework/commit/27fe3a72eeb0f398a278ebb3f1cb9c4dd459743c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.3-next.26 to 0.0.3-next.27
+    * @twin.org/nameof bumped from 0.0.3-next.26 to 0.0.3-next.27
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.26 to 0.0.3-next.27
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.26 to 0.0.3-next.27
+    * @twin.org/validate-locales bumped from 0.0.3-next.26 to 0.0.3-next.27
+
 ## [0.0.3-next.26](https://github.com/twinfoundation/framework/compare/crypto-v0.0.3-next.25...crypto-v0.0.3-next.26) (2026-03-24)
 
 

package/docs/reference/classes/Argon2id.md

@@ -0,0 +1,83 @@
+# Class: Argon2id
+
+Implementation of the Argon2id password based key derivation function.
+
+## Constructors
+
+### Constructor
+
+> **new Argon2id**(): `Argon2id`
+
+#### Returns
+
+`Argon2id`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### hash() {#hash}
+
+> `static` **hash**(`password`, `salt`, `options?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+Derive a key from the parameters using Argon2id.
+
+#### Parameters
+
+##### password
+
+`Uint8Array`
+
+The password to derive the key from.
+
+##### salt
+
+`Uint8Array`
+
+The salt for the derivation.
+
+##### options?
+
+The options for the derivation.
+
+###### t?
+
+`number`
+
+Number of iterations to perform, default 1.
+
+###### m?
+
+`number`
+
+Amount of memory to use in kibibytes, default 8.
+
+###### p?
+
+`number`
+
+Number of parallel threads to use, default 1.
+
+###### dkLen?
+
+`number`
+
+The length of the derived key in bytes, default 32.
+
+###### maxmem?
+
+`number`
+
+The maximum amount of memory to use in bytes, default 2^30.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The derived key.

package/docs/reference/index.md

@@ -9,6 +9,7 @@
 - [Secp256k1](classes/Secp256k1.md)
 - [X25519](classes/X25519.md)
 - [Zip215](classes/Zip215.md)
+- [Argon2id](classes/Argon2id.md)
 - [Blake2b](classes/Blake2b.md)
 - [Blake3](classes/Blake3.md)
 - [HmacSha1](classes/HmacSha1.md)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/crypto",
-	"version": "0.0.3-next.26",
+	"version": "0.0.3-next.27",
 	"description": "Helper methods and classes which implement cryptographic functions",
 	"repository": {
 		"type": "git",
@@ -20,8 +20,8 @@
 		"@scure/base": "2.0.0",
 		"@scure/bip32": "2.0.1",
 		"@scure/bip39": "2.0.1",
-		"@twin.org/core": "0.0.3-next.26",
-		"@twin.org/nameof": "0.0.3-next.26",
+		"@twin.org/core": "0.0.3-next.27",
+		"@twin.org/nameof": "0.0.3-next.27",
 		"crypto-browserify": "3.12.1",
 		"micro-key-producer": "0.8.5"
 	},