@twin.org/crypto 0.0.1-next.38 → 0.0.1-next.39

package/dist/cjs/index.cjs

@@ -188,6 +188,27 @@ class Ed25519 {
             return false;
         }
     }
+    /**
+     * Convert a private key in PKCS8 format.
+     * @param privateKey The private key to convert.
+     * @returns The private key in PKCS8 format.
+     */
+    static async privateKeyToPKCS8(privateKey) {
+        core.Guards.uint8Array(Ed25519._CLASS_NAME, "privateKey", privateKey);
+        if (privateKey.length !== Ed25519.PRIVATE_KEY_SIZE) {
+            throw new core.GeneralError(Ed25519._CLASS_NAME, "privateKeyLength", {
+                requiredSize: Ed25519.PRIVATE_KEY_SIZE,
+                actualSize: privateKey.length
+            });
+        }
+        // crypto.subtle.importKey does not support Ed25519 keys in raw format.
+        // We need to convert the key to PKCS8 format before importing.
+        // The PKCS8 format is the raw key prefixed with the ASN.1 sequence for an Ed25519 private key.
+        // The ASN.1 sequence is 48 46 02 01 00 30 05 06 03 2b 65 70 04 20 04 20
+        const pkcs8Prefix = new Uint8Array([48, 46, 2, 1, 0, 48, 5, 6, 3, 43, 101, 112, 4, 34, 4, 32]); // 0x302e020100300506032b657004220420
+        const fullKey = core.Uint8ArrayHelper.concat([pkcs8Prefix, privateKey]);
+        return crypto.subtle.importKey("pkcs8", fullKey, "Ed25519", false, ["sign"]);
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { bech32 } from '@scure/base';
-import { Guards, BaseError, GeneralError, Is, Converter, GuardError, Base32, RandomHelper, Validation } from '@twin.org/core';
+import { Guards, BaseError, GeneralError, Is, Uint8ArrayHelper, Converter, GuardError, Base32, RandomHelper, Validation } from '@twin.org/core';
 import { ed25519, edwardsToMontgomeryPriv, edwardsToMontgomeryPub } from '@noble/curves/ed25519';
 import { secp256k1 } from '@noble/curves/secp256k1';
 import { blake2b } from '@noble/hashes/blake2b';
@@ -166,6 +166,27 @@ class Ed25519 {
             return false;
         }
     }
+    /**
+     * Convert a private key in PKCS8 format.
+     * @param privateKey The private key to convert.
+     * @returns The private key in PKCS8 format.
+     */
+    static async privateKeyToPKCS8(privateKey) {
+        Guards.uint8Array(Ed25519._CLASS_NAME, "privateKey", privateKey);
+        if (privateKey.length !== Ed25519.PRIVATE_KEY_SIZE) {
+            throw new GeneralError(Ed25519._CLASS_NAME, "privateKeyLength", {
+                requiredSize: Ed25519.PRIVATE_KEY_SIZE,
+                actualSize: privateKey.length
+            });
+        }
+        // crypto.subtle.importKey does not support Ed25519 keys in raw format.
+        // We need to convert the key to PKCS8 format before importing.
+        // The PKCS8 format is the raw key prefixed with the ASN.1 sequence for an Ed25519 private key.
+        // The ASN.1 sequence is 48 46 02 01 00 30 05 06 03 2b 65 70 04 20 04 20
+        const pkcs8Prefix = new Uint8Array([48, 46, 2, 1, 0, 48, 5, 6, 3, 43, 101, 112, 4, 34, 4, 32]); // 0x302e020100300506032b657004220420
+        const fullKey = Uint8ArrayHelper.concat([pkcs8Prefix, privateKey]);
+        return crypto.subtle.importKey("pkcs8", fullKey, "Ed25519", false, ["sign"]);
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.

package/dist/types/curves/ed25519.d.ts

@@ -34,4 +34,10 @@ export declare class Ed25519 {
      * @throws Error if the public key is not the correct length.
      */
     static verify(publicKey: Uint8Array, block: Uint8Array, signature: Uint8Array): boolean;
+    /**
+     * Convert a private key in PKCS8 format.
+     * @param privateKey The private key to convert.
+     * @returns The private key in PKCS8 format.
+     */
+    static privateKeyToPKCS8(privateKey: Uint8Array): Promise<CryptoKey>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/crypto - Changelog
 
-## 0.0.1-next.38
+## 0.0.1-next.39
 
 - Added: Bip44

package/docs/reference/classes/Ed25519.md

@@ -123,3 +123,25 @@ True if the signature matches.
 #### Throws
 
 Error if the public key is not the correct length.
+
+***
+
+### privateKeyToPKCS8()
+
+> `static` **privateKeyToPKCS8**(`privateKey`): `Promise`\<`CryptoKey`\>
+
+Convert a private key in PKCS8 format.
+
+#### Parameters
+
+##### privateKey
+
+`Uint8Array`
+
+The private key to convert.
+
+#### Returns
+
+`Promise`\<`CryptoKey`\>
+
+The private key in PKCS8 format.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/crypto",
-	"version": "0.0.1-next.38",
+	"version": "0.0.1-next.39",
 	"description": "Contains helper methods and classes which implement cryptographic functions",
 	"repository": {
 		"type": "git",
@@ -20,7 +20,7 @@
 		"@scure/base": "1.2.4",
 		"@scure/bip32": "1.6.2",
 		"@scure/bip39": "1.5.4",
-		"@twin.org/core": "0.0.1-next.38",
+		"@twin.org/core": "0.0.1-next.39",
 		"@twin.org/nameof": "next",
 		"micro-key-producer": "0.7.5"
 	},