@twin.org/web 0.0.1-next.40 → 0.0.1-next.41

package/dist/cjs/index.cjs

@@ -1,8 +1,8 @@
 'use strict';
 
 var core = require('@twin.org/core');
-var jose = require('jose');
 var crypto = require('@twin.org/crypto');
+var jose = require('jose');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -720,6 +720,106 @@ class Jwk {
             throw new core.GeneralError(Jwk._CLASS_NAME, "jwkImportFailed", undefined, err);
         }
     }
+    /**
+     * Convert the Ed25519 private key to a crypto key.
+     * @param privateKey The private key to use.
+     * @returns The crypto key.
+     */
+    static async fromEd25519Private(privateKey) {
+        core.Guards.uint8Array(Jwk._CLASS_NAME, "privateKey", privateKey);
+        try {
+            const publicKey = crypto.Ed25519.publicKeyFromPrivateKey(privateKey);
+            const jwk = {
+                kty: "OKP",
+                use: "sig",
+                alg: "EdDSA",
+                crv: "Ed25519",
+                x: core.Converter.bytesToBase64Url(publicKey),
+                d: core.Converter.bytesToBase64Url(privateKey)
+            };
+            return jose.importJWK(jwk);
+        }
+        catch (err) {
+            throw new core.GeneralError(Jwk._CLASS_NAME, "jwkImportFailed", undefined, err);
+        }
+    }
+    /**
+     * Convert the Ed25519 public key to a crypto key.
+     * @param publicKey The private key to use.
+     * @returns The crypto key.
+     */
+    static async fromEd25519Public(publicKey) {
+        core.Guards.uint8Array(Jwk._CLASS_NAME, "publicKey", publicKey);
+        try {
+            const jwk = {
+                kty: "OKP",
+                use: "sig",
+                alg: "EdDSA",
+                crv: "Ed25519",
+                x: core.Converter.bytesToBase64Url(publicKey)
+            };
+            return jose.importJWK(jwk);
+        }
+        catch (err) {
+            throw new core.GeneralError(Jwk._CLASS_NAME, "jwkImportFailed", undefined, err);
+        }
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to handle JSON Web Signatures.
+ */
+class Jws {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Jws";
+    /**
+     * Create a signature.
+     * @param privateKey The private key to use.
+     * @param hash The hash to sign.
+     * @returns The signature.
+     */
+    static async create(privateKey, hash) {
+        core.Guards.defined(Jws._CLASS_NAME, "privateKey", privateKey);
+        core.Guards.uint8Array(Jws._CLASS_NAME, "hash", hash);
+        try {
+            const jws = await new jose.CompactSign(hash)
+                .setProtectedHeader({
+                alg: privateKey.algorithm.name,
+                b64: false,
+                crit: ["b64"]
+            })
+                .sign(privateKey);
+            return jws;
+        }
+        catch (err) {
+            throw new core.GeneralError(Jws._CLASS_NAME, "createFailed", undefined, err);
+        }
+    }
+    /**
+     * Verify a signature.
+     * @param jws The signature to verify.
+     * @param publicKey The public key to verify the signature with.
+     * @param hash The hash to verify.
+     * @returns True if the signature was verified.
+     */
+    static async verify(jws, publicKey, hash) {
+        core.Guards.stringValue(Jws._CLASS_NAME, "jws", jws);
+        core.Guards.defined(Jws._CLASS_NAME, "publicKey", publicKey);
+        core.Guards.uint8Array(Jws._CLASS_NAME, "hash", hash);
+        try {
+            const jwsParts = jws.split(".");
+            await jose.flattenedVerify({ protected: jwsParts[0], payload: hash, signature: jwsParts[2] }, publicKey);
+            return true;
+        }
+        catch (err) {
+            throw new core.GeneralError(Jws._CLASS_NAME, "verifyFailed", undefined, err);
+        }
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -742,7 +842,6 @@ class Jwt {
      */
     static async encode(header, payload, key) {
         core.Guards.object(Jwt._CLASS_NAME, "header", header);
-        core.Guards.stringValue(Jwt._CLASS_NAME, "header.alg", header.alg);
         core.Guards.object(Jwt._CLASS_NAME, "payload", payload);
         core.Guards.defined(Jwt._CLASS_NAME, "key", key);
         return Jwt.internalEncode(header, payload, key);
@@ -1106,6 +1205,7 @@ exports.HeaderTypes = HeaderTypes;
 exports.HttpMethod = HttpMethod;
 exports.HttpStatusCode = HttpStatusCode;
 exports.Jwk = Jwk;
+exports.Jws = Jws;
 exports.Jwt = Jwt;
 exports.MimeTypeHelper = MimeTypeHelper;
 exports.MimeTypes = MimeTypes;

package/dist/esm/index.mjs

@@ -1,6 +1,6 @@
 import { BaseError, StringHelper, Guards, Is, AsyncCache, ObjectHelper, GeneralError, Converter } from '@twin.org/core';
-import { importJWK, SignJWT, jwtVerify } from 'jose';
 import { Ed25519 } from '@twin.org/crypto';
+import { importJWK, CompactSign, flattenedVerify, SignJWT, jwtVerify } from 'jose';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -718,6 +718,106 @@ class Jwk {
             throw new GeneralError(Jwk._CLASS_NAME, "jwkImportFailed", undefined, err);
         }
     }
+    /**
+     * Convert the Ed25519 private key to a crypto key.
+     * @param privateKey The private key to use.
+     * @returns The crypto key.
+     */
+    static async fromEd25519Private(privateKey) {
+        Guards.uint8Array(Jwk._CLASS_NAME, "privateKey", privateKey);
+        try {
+            const publicKey = Ed25519.publicKeyFromPrivateKey(privateKey);
+            const jwk = {
+                kty: "OKP",
+                use: "sig",
+                alg: "EdDSA",
+                crv: "Ed25519",
+                x: Converter.bytesToBase64Url(publicKey),
+                d: Converter.bytesToBase64Url(privateKey)
+            };
+            return importJWK(jwk);
+        }
+        catch (err) {
+            throw new GeneralError(Jwk._CLASS_NAME, "jwkImportFailed", undefined, err);
+        }
+    }
+    /**
+     * Convert the Ed25519 public key to a crypto key.
+     * @param publicKey The private key to use.
+     * @returns The crypto key.
+     */
+    static async fromEd25519Public(publicKey) {
+        Guards.uint8Array(Jwk._CLASS_NAME, "publicKey", publicKey);
+        try {
+            const jwk = {
+                kty: "OKP",
+                use: "sig",
+                alg: "EdDSA",
+                crv: "Ed25519",
+                x: Converter.bytesToBase64Url(publicKey)
+            };
+            return importJWK(jwk);
+        }
+        catch (err) {
+            throw new GeneralError(Jwk._CLASS_NAME, "jwkImportFailed", undefined, err);
+        }
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to handle JSON Web Signatures.
+ */
+class Jws {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Jws";
+    /**
+     * Create a signature.
+     * @param privateKey The private key to use.
+     * @param hash The hash to sign.
+     * @returns The signature.
+     */
+    static async create(privateKey, hash) {
+        Guards.defined(Jws._CLASS_NAME, "privateKey", privateKey);
+        Guards.uint8Array(Jws._CLASS_NAME, "hash", hash);
+        try {
+            const jws = await new CompactSign(hash)
+                .setProtectedHeader({
+                alg: privateKey.algorithm.name,
+                b64: false,
+                crit: ["b64"]
+            })
+                .sign(privateKey);
+            return jws;
+        }
+        catch (err) {
+            throw new GeneralError(Jws._CLASS_NAME, "createFailed", undefined, err);
+        }
+    }
+    /**
+     * Verify a signature.
+     * @param jws The signature to verify.
+     * @param publicKey The public key to verify the signature with.
+     * @param hash The hash to verify.
+     * @returns True if the signature was verified.
+     */
+    static async verify(jws, publicKey, hash) {
+        Guards.stringValue(Jws._CLASS_NAME, "jws", jws);
+        Guards.defined(Jws._CLASS_NAME, "publicKey", publicKey);
+        Guards.uint8Array(Jws._CLASS_NAME, "hash", hash);
+        try {
+            const jwsParts = jws.split(".");
+            await flattenedVerify({ protected: jwsParts[0], payload: hash, signature: jwsParts[2] }, publicKey);
+            return true;
+        }
+        catch (err) {
+            throw new GeneralError(Jws._CLASS_NAME, "verifyFailed", undefined, err);
+        }
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -740,7 +840,6 @@ class Jwt {
      */
     static async encode(header, payload, key) {
         Guards.object(Jwt._CLASS_NAME, "header", header);
-        Guards.stringValue(Jwt._CLASS_NAME, "header.alg", header.alg);
         Guards.object(Jwt._CLASS_NAME, "payload", payload);
         Guards.defined(Jwt._CLASS_NAME, "key", key);
         return Jwt.internalEncode(header, payload, key);
@@ -1098,4 +1197,4 @@ class MimeTypeHelper {
     }
 }
 
-export { FetchError, FetchHelper, HeaderTypes, HttpMethod, HttpStatusCode, Jwk, Jwt, MimeTypeHelper, MimeTypes };
+export { FetchError, FetchHelper, HeaderTypes, HttpMethod, HttpStatusCode, Jwk, Jws, Jwt, MimeTypeHelper, MimeTypes };

package/dist/types/index.d.ts

@@ -11,5 +11,6 @@ export * from "./models/jwkCryptoKey";
 export * from "./models/mimeTypes";
 export * from "./utils/fetchHelper";
 export * from "./utils/jwk";
+export * from "./utils/jws";
 export * from "./utils/jwt";
 export * from "./utils/mimeTypeHelper";

package/dist/types/utils/jwk.d.ts

@@ -10,4 +10,16 @@ export declare class Jwk {
      * @returns The crypto key.
      */
     static toCryptoKey(jwk: IJwk): Promise<JwkCryptoKey>;
+    /**
+     * Convert the Ed25519 private key to a crypto key.
+     * @param privateKey The private key to use.
+     * @returns The crypto key.
+     */
+    static fromEd25519Private(privateKey: Uint8Array): Promise<JwkCryptoKey>;
+    /**
+     * Convert the Ed25519 public key to a crypto key.
+     * @param publicKey The private key to use.
+     * @returns The crypto key.
+     */
+    static fromEd25519Public(publicKey: Uint8Array): Promise<JwkCryptoKey>;
 }

package/dist/types/utils/jws.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Class to handle JSON Web Signatures.
+ */
+export declare class Jws {
+    /**
+     * Create a signature.
+     * @param privateKey The private key to use.
+     * @param hash The hash to sign.
+     * @returns The signature.
+     */
+    static create(privateKey: CryptoKey, hash: Uint8Array): Promise<string>;
+    /**
+     * Verify a signature.
+     * @param jws The signature to verify.
+     * @param publicKey The public key to verify the signature with.
+     * @param hash The hash to verify.
+     * @returns True if the signature was verified.
+     */
+    static verify(jws: string, publicKey: CryptoKey, hash: Uint8Array): Promise<boolean>;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/web - Changelog
 
-## 0.0.1-next.40
+## 0.0.1-next.41
 
 - Initial Release

package/docs/reference/classes/Jwk.md

@@ -33,3 +33,47 @@ The JWK to convert.
 `Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
 
 The crypto key.
+
+***
+
+### fromEd25519Private()
+
+> `static` **fromEd25519Private**(`privateKey`): `Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
+
+Convert the Ed25519 private key to a crypto key.
+
+#### Parameters
+
+##### privateKey
+
+`Uint8Array`
+
+The private key to use.
+
+#### Returns
+
+`Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
+
+The crypto key.
+
+***
+
+### fromEd25519Public()
+
+> `static` **fromEd25519Public**(`publicKey`): `Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
+
+Convert the Ed25519 public key to a crypto key.
+
+#### Parameters
+
+##### publicKey
+
+`Uint8Array`
+
+The private key to use.
+
+#### Returns
+
+`Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
+
+The crypto key.

package/docs/reference/classes/Jws.md

@@ -0,0 +1,75 @@
+# Class: Jws
+
+Class to handle JSON Web Signatures.
+
+## Constructors
+
+### new Jws()
+
+> **new Jws**(): [`Jws`](Jws.md)
+
+#### Returns
+
+[`Jws`](Jws.md)
+
+## Methods
+
+### create()
+
+> `static` **create**(`privateKey`, `hash`): `Promise`\<`string`\>
+
+Create a signature.
+
+#### Parameters
+
+##### privateKey
+
+`CryptoKey`
+
+The private key to use.
+
+##### hash
+
+`Uint8Array`
+
+The hash to sign.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The signature.
+
+***
+
+### verify()
+
+> `static` **verify**(`jws`, `publicKey`, `hash`): `Promise`\<`boolean`\>
+
+Verify a signature.
+
+#### Parameters
+
+##### jws
+
+`string`
+
+The signature to verify.
+
+##### publicKey
+
+`CryptoKey`
+
+The public key to verify the signature with.
+
+##### hash
+
+`Uint8Array`
+
+The hash to verify.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the signature was verified.

package/docs/reference/index.md

@@ -5,6 +5,7 @@
 - [FetchError](classes/FetchError.md)
 - [FetchHelper](classes/FetchHelper.md)
 - [Jwk](classes/Jwk.md)
+- [Jws](classes/Jws.md)
 - [Jwt](classes/Jwt.md)
 - [MimeTypeHelper](classes/MimeTypeHelper.md)
 

package/locales/en.json

@@ -16,6 +16,10 @@
 		},
 		"jwk": {
 			"jwkImportFailed": "Failed to import JWK"
+		},
+		"jws": {
+			"createFailed": "Failed to create JWS",
+			"verifyFailed": "Failed to verify JWS"
 		}
 	},
 	"errorMessages": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/web",
-	"version": "0.0.1-next.40",
+	"version": "0.0.1-next.41",
 	"description": "Contains classes for use with web operations",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.1-next.40",
-		"@twin.org/crypto": "0.0.1-next.40",
+		"@twin.org/core": "0.0.1-next.41",
+		"@twin.org/crypto": "0.0.1-next.41",
 		"@twin.org/nameof": "next",
 		"jose": "6.0.8"
 	},