@nmshd/transport 1.0.0

package/LICENSE

@@ -0,0 +1 @@
+UNLICENSED

package/README.md

@@ -0,0 +1,18 @@
+# Transport Library
+
+[![GitHub Actions CI](https://github.com/nmshd/cns-transport/workflows/Publish/badge.svg)](https://github.com/nmshd/cns-transport/actions?query=workflow%3APublish)
+[![npm version](https://badge.fury.io/js/@nmshd%2ftransport.svg)](https://www.npmjs.com/package/@nmshd/transport)
+
+The transport library handles backbone communication and content encryption.
+
+## Documentation
+
+The documentation for this project is currently under construction.
+
+## Contribute
+
+Currently contribution to this project is not possible. This will change soon.
+
+## License
+
+[UNLICENSED](LICENSE)

package/dist/TransportBuildInformation.d.ts

@@ -0,0 +1,13 @@
+import { ServalBuildInformation } from "@js-soft/ts-serval";
+import { CryptoBuildInformation } from "@nmshd/crypto";
+export declare class TransportBuildInformation {
+    readonly version: string;
+    readonly build: string;
+    readonly date: string;
+    readonly commit: string;
+    readonly dependencies: object;
+    readonly crypto: CryptoBuildInformation;
+    readonly serval: ServalBuildInformation;
+    private constructor();
+    static readonly info: TransportBuildInformation;
+}

package/dist/TransportBuildInformation.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransportBuildInformation = void 0;
+const ts_serval_1 = require("@js-soft/ts-serval");
+const crypto_1 = require("@nmshd/crypto");
+class TransportBuildInformation {
+    constructor() {
+        this.version = "1.0.0";
+        this.build = "";
+        this.date = "2021-09-27T12:58:14+00:00";
+        this.commit = "fe88cbb6f98878a3c7de0fc731101f8fbf40602e";
+        this.crypto = crypto_1.CryptoBuildInformation.info;
+        this.serval = ts_serval_1.ServalBuildInformation.info;
+        try {
+            // eslint-disable-next-line @typescript-eslint/quotes
+            this.dependencies = JSON.parse(`{"@js-soft/docdb-access-abstractions":"1.0.1","@js-soft/logging-abstractions":"1.0.0","@js-soft/simple-logger":"1.0.0","@js-soft/ts-utils":"1.0.1","axios":"^0.21.4","deep-equal":"^2.0.5","fast-json-patch":"^3.1.0","form-data":"^4.0.0","json-stringify-safe":"^5.0.1","lodash":"^4.17.21","luxon":"^2.0.2","qs":"^6.10.1","reflect-metadata":"^0.1.13","ts-simple-nameof":"^1.3.1","uuid":"^8.3.2"}`);
+        }
+        catch (e) {
+            this.dependencies = {};
+        }
+    }
+}
+exports.TransportBuildInformation = TransportBuildInformation;
+TransportBuildInformation.info = new TransportBuildInformation();
+//# sourceMappingURL=TransportBuildInformation.js.map

package/dist/TransportBuildInformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransportBuildInformation.js","sourceRoot":"","sources":["../src/TransportBuildInformation.ts"],"names":[],"mappings":";;;AAAA,kDAA2D;AAC3D,0CAAsD;AAEtD,MAAa,yBAAyB;IAUlC;QATgB,YAAO,GAAW,aAAa,CAAA;QAC/B,UAAK,GAAW,WAAW,CAAA;QAC3B,SAAI,GAAW,UAAU,CAAA;QACzB,WAAM,GAAW,YAAY,CAAA;QAG7B,WAAM,GAAG,+BAAsB,CAAC,IAAI,CAAA;QACpC,WAAM,GAAG,kCAAsB,CAAC,IAAI,CAAA;QAGhD,IAAI;YACA,qDAAqD;YACrD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAA;SACrD;QAAC,OAAO,CAAC,EAAE;YACR,IAAI,CAAC,YAAY,GAAG,EAAE,CAAA;SACzB;IACL,CAAC;;AAjBL,8DAoBC;AAD0B,8BAAI,GAA8B,IAAI,yBAAyB,EAAE,CAAA"}

package/dist/core/CoreCrypto.d.ts

@@ -0,0 +1,108 @@
+import { CoreBuffer, CryptoCipher, CryptoEncryptionAlgorithm, CryptoExchangeKeypair, CryptoExchangePublicKey, CryptoExchangeSecrets, CryptoSecretKey, CryptoSignature, CryptoSignatureKeypair, CryptoSignaturePrivateKey, CryptoSignaturePublicKey } from "@nmshd/crypto";
+import { TransportVersion } from "./types/TransportVersion";
+export declare abstract class CoreCrypto {
+    /**
+     * Generates a keypair for digital signatures. Depending on the given version, different algorithms are used:
+     *
+     * v1: ECDSA_P521
+     *
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving into a new CryptoKeypair
+     */
+    static generateSignatureKeypair(version?: TransportVersion): Promise<CryptoSignatureKeypair>;
+    /**
+     * Generates a keypair for key exchange (public key encryption).
+     * Depending on the given version, different algorithms are used:
+     *
+     * v1: ECDH_P521
+     *
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving into a new CryptoKeypair
+     */
+    static generateExchangeKeypair(version?: TransportVersion): Promise<CryptoExchangeKeypair>;
+    /**
+     * Generates a secret key for symmetric encryption. Depending on the given version, different algorithms are used:
+     *
+     * v1: AES256_GCM
+     *
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving into a new CryptoSecretKey
+     */
+    static generateSecretKey(version?: TransportVersion): Promise<CryptoSecretKey>;
+    /**
+     * Generates a password derived from a human readable/memorable master password, a unique salt, the given symmetric
+     * algorithm and the version. Depending on the given version, different key derivation algorithms are used.
+     * Careful, the symmetric algorithm possibly needs to be manually changed depending on the version in addition to
+     * the version.
+     *
+     * v1: blake2b with 150000 iterations
+     *
+     * @param master The master password as utf-8 encoded string
+     * @param salt A salt which is unique to this user/password instance.
+     * @param keyAlgorithm The [[CryptoSymmetricAlgorithm]] for which the key should be generated.
+     *                     Default is AES256_GCM.
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving in a [[CryptoSecretKey]].
+     */
+    static generatePassword(master: string, salt?: string, keyAlgorithm?: CryptoEncryptionAlgorithm, version?: TransportVersion): Promise<CryptoSecretKey>;
+    static deriveKeyFromBase(secret: CryptoSecretKey | CoreBuffer, keyId: number, context: string, keyAlgorithm?: CryptoEncryptionAlgorithm): Promise<CryptoSecretKey>;
+    static deriveClient(client: CryptoExchangeKeypair, serverPublicKey: CryptoExchangePublicKey, keyAlgorithm?: CryptoEncryptionAlgorithm, version?: TransportVersion): Promise<CryptoExchangeSecrets>;
+    static deriveServer(server: CryptoExchangeKeypair, clientPublicKey: CryptoExchangePublicKey, keyAlgorithm?: CryptoEncryptionAlgorithm, version?: TransportVersion): Promise<CryptoExchangeSecrets>;
+    /**
+     * Digitally signs the given content with the given private key.
+     *
+     * v1: ECDSA_ED25519 with SHA512 hashes
+     *
+     * @param content The content object which should be signed
+     * @param privateKey The private key to sign
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving in a [[CryptoSignature]] object.
+     */
+    static sign(content: CoreBuffer, privateKey: CryptoSignaturePrivateKey, version?: TransportVersion): Promise<CryptoSignature>;
+    /**
+     * Verifies the digital signature of a given content with the given digital
+     * signature and public key.
+     *
+     * @param content The content object which digital signature should be verified
+     * @param signature The digital signature itself
+     * @param publicKey The public key which should be verified
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving in either true or false, depending whether or not the
+     * digital signature is correct or wrong
+     */
+    static verify(content: CoreBuffer, signature: CryptoSignature, publicKey: CryptoSignaturePublicKey, version?: TransportVersion): Promise<boolean>;
+    /**
+     * Encrypt the given content with the given secret key.
+     *
+     * Please use [[deriveKey]], [[generateEncryptionkey]], or [[generatePassword]] to
+     * get a secret key. Never transfer secret key over the wire, the key exchange
+     * algorithms should take care of that.
+     *
+     * @param content The content object which should be encrypted
+     * @param secretKey The secret key for the encryption
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving in a [[CryptoCipher]] object.
+     */
+    static encrypt(content: CoreBuffer, secretKey: CryptoSecretKey, version?: TransportVersion): Promise<CryptoCipher>;
+    /**
+     * Decrypts the given cipher with the given secret key.
+     *
+     * Please use [[deriveKey]], [[generateEncryptionkey]], or [[generatePassword]] to
+     * get a secret key. Never transfer secret key over the wire, the key exchange
+     * algorithms should take care of that.
+     *
+     * @param cipher The content object which should be encrypted.
+     * @param secretKey The secret key for the encryption
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving with the decrypted content
+     */
+    static decrypt(cipher: CryptoCipher, secretKey: CryptoSecretKey, version?: TransportVersion): Promise<CoreBuffer>;
+    /**
+     * Creates a random buffer with the given size
+     *
+     * @param size The length of bytes which should be randomly filled.
+     * @returns A Promise object resolving in a randomly filled Buffer of given length.
+     */
+    static random(size: number): Promise<CoreBuffer>;
+    static createAccountPassword(): Promise<string>;
+}

package/dist/core/CoreCrypto.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreCrypto = void 0;
+const crypto_1 = require("@nmshd/crypto");
+const util_1 = require("../util");
+const TransportErrors_1 = require("./TransportErrors");
+const TransportVersion_1 = require("./types/TransportVersion");
+class CoreCrypto {
+    /**
+     * Generates a keypair for digital signatures. Depending on the given version, different algorithms are used:
+     *
+     * v1: ECDSA_P521
+     *
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving into a new CryptoKeypair
+     */
+    static async generateSignatureKeypair(version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                return await crypto_1.CryptoSignatures.generateKeypair(3 /* ECDSA_ED25519 */);
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    /**
+     * Generates a keypair for key exchange (public key encryption).
+     * Depending on the given version, different algorithms are used:
+     *
+     * v1: ECDH_P521
+     *
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving into a new CryptoKeypair
+     */
+    static async generateExchangeKeypair(version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                return await crypto_1.CryptoExchange.generateKeypair(3 /* ECDH_X25519 */);
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    /**
+     * Generates a secret key for symmetric encryption. Depending on the given version, different algorithms are used:
+     *
+     * v1: AES256_GCM
+     *
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving into a new CryptoSecretKey
+     */
+    static async generateSecretKey(version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                return await crypto_1.CryptoEncryption.generateKey(3 /* XCHACHA20_POLY1305 */);
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    /**
+     * Generates a password derived from a human readable/memorable master password, a unique salt, the given symmetric
+     * algorithm and the version. Depending on the given version, different key derivation algorithms are used.
+     * Careful, the symmetric algorithm possibly needs to be manually changed depending on the version in addition to
+     * the version.
+     *
+     * v1: blake2b with 150000 iterations
+     *
+     * @param master The master password as utf-8 encoded string
+     * @param salt A salt which is unique to this user/password instance.
+     * @param keyAlgorithm The [[CryptoSymmetricAlgorithm]] for which the key should be generated.
+     *                     Default is AES256_GCM.
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving in a [[CryptoSecretKey]].
+     */
+    static async generatePassword(master, salt = "enmeshed", keyAlgorithm = 3 /* XCHACHA20_POLY1305 */, version = TransportVersion_1.TransportVersion.Latest) {
+        const masterBuffer = crypto_1.CoreBuffer.fromString(master, crypto_1.Encoding.Utf8);
+        const saltBuffer = crypto_1.CoreBuffer.fromString(salt, crypto_1.Encoding.Utf8);
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                return await crypto_1.CryptoDerivation.deriveKeyFromMaster(masterBuffer, 150000, keyAlgorithm, saltBuffer);
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    static async deriveKeyFromBase(secret, keyId, context, keyAlgorithm = 3 /* XCHACHA20_POLY1305 */) {
+        let buffer;
+        if (secret instanceof crypto_1.CryptoSecretKey) {
+            buffer = secret.secretKey;
+        }
+        else if (secret instanceof crypto_1.CoreBuffer) {
+            buffer = secret;
+        }
+        else {
+            throw TransportErrors_1.TransportErrors.util.crypto.invalidSecretType();
+        }
+        return await crypto_1.CryptoDerivation.deriveKeyFromBase(buffer, keyId, context, keyAlgorithm);
+    }
+    static async deriveClient(client, serverPublicKey, keyAlgorithm = 3 /* XCHACHA20_POLY1305 */, version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                const base = await crypto_1.CryptoExchange.deriveTemplator(client, serverPublicKey, keyAlgorithm);
+                return base;
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    static async deriveServer(server, clientPublicKey, keyAlgorithm = 3 /* XCHACHA20_POLY1305 */, version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                const base = await crypto_1.CryptoExchange.deriveRequestor(server, clientPublicKey, keyAlgorithm);
+                return base;
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    /**
+     * Digitally signs the given content with the given private key.
+     *
+     * v1: ECDSA_ED25519 with SHA512 hashes
+     *
+     * @param content The content object which should be signed
+     * @param privateKey The private key to sign
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving in a [[CryptoSignature]] object.
+     */
+    static async sign(content, privateKey, version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                return await crypto_1.CryptoSignatures.sign(content, privateKey, 2 /* SHA512 */);
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    /**
+     * Verifies the digital signature of a given content with the given digital
+     * signature and public key.
+     *
+     * @param content The content object which digital signature should be verified
+     * @param signature The digital signature itself
+     * @param publicKey The public key which should be verified
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving in either true or false, depending whether or not the
+     * digital signature is correct or wrong
+     */
+    static async verify(content, signature, publicKey, version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                return await crypto_1.CryptoSignatures.verify(content, signature, publicKey);
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    /**
+     * Encrypt the given content with the given secret key.
+     *
+     * Please use [[deriveKey]], [[generateEncryptionkey]], or [[generatePassword]] to
+     * get a secret key. Never transfer secret key over the wire, the key exchange
+     * algorithms should take care of that.
+     *
+     * @param content The content object which should be encrypted
+     * @param secretKey The secret key for the encryption
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving in a [[CryptoCipher]] object.
+     */
+    static async encrypt(content, secretKey, version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                return await crypto_1.CryptoEncryption.encrypt(content, secretKey);
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    /**
+     * Decrypts the given cipher with the given secret key.
+     *
+     * Please use [[deriveKey]], [[generateEncryptionkey]], or [[generatePassword]] to
+     * get a secret key. Never transfer secret key over the wire, the key exchange
+     * algorithms should take care of that.
+     *
+     * @param cipher The content object which should be encrypted.
+     * @param secretKey The secret key for the encryption
+     * @param version The version which should be used, "latest" is the default.
+     * @returns A Promise object resolving with the decrypted content
+     */
+    static async decrypt(cipher, secretKey, version = TransportVersion_1.TransportVersion.Latest) {
+        switch (version) {
+            case TransportVersion_1.TransportVersion.V1:
+                return await crypto_1.CryptoEncryption.decrypt(cipher, secretKey);
+            default:
+                throw TransportErrors_1.TransportErrors.util.crypto.invalidVersion(version);
+        }
+    }
+    /**
+     * Creates a random buffer with the given size
+     *
+     * @param size The length of bytes which should be randomly filled.
+     * @returns A Promise object resolving in a randomly filled Buffer of given length.
+     */
+    static async random(size) {
+        return await crypto_1.CryptoRandom.bytes(size);
+    }
+    static async createAccountPassword() {
+        return await util_1.PasswordGenerator.createStrongPassword(100, 100);
+    }
+}
+exports.CoreCrypto = CoreCrypto;
+//# sourceMappingURL=CoreCrypto.js.map

package/dist/core/CoreCrypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreCrypto.js","sourceRoot":"","sources":["../../src/core/CoreCrypto.ts"],"names":[],"mappings":";;;AAAA,0CAqBsB;AACtB,kCAA2C;AAC3C,uDAAmD;AACnD,+DAA2D;AAE3D,MAAsB,UAAU;IAC5B;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,wBAAwB,CACxC,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,OAAO,MAAM,yBAAgB,CAAC,eAAe,uBAAwC,CAAA;YACzF;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,uBAAuB,CACvC,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,OAAO,MAAM,uBAAc,CAAC,eAAe,qBAAqC,CAAA;YACpF;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CACjC,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,OAAO,MAAM,yBAAgB,CAAC,WAAW,4BAA8C,CAAA;YAC3F;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAChC,MAAc,EACd,IAAI,GAAG,UAAU,EACjB,yCAAsF,EACtF,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,MAAM,YAAY,GAAe,mBAAU,CAAC,UAAU,CAAC,MAAM,EAAE,iBAAQ,CAAC,IAAI,CAAC,CAAA;QAC7E,MAAM,UAAU,GAAe,mBAAU,CAAC,UAAU,CAAC,IAAI,EAAE,iBAAQ,CAAC,IAAI,CAAC,CAAA;QACzE,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,OAAO,MAAM,yBAAgB,CAAC,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAA;YACrG;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CACjC,MAAoC,EACpC,KAAa,EACb,OAAe,EACf,yCAAsF;QAEtF,IAAI,MAAM,CAAA;QACV,IAAI,MAAM,YAAY,wBAAe,EAAE;YACnC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAA;SAC5B;aAAM,IAAI,MAAM,YAAY,mBAAU,EAAE;YACrC,MAAM,GAAG,MAAM,CAAA;SAClB;aAAM;YACH,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAA;SACxD;QACD,OAAO,MAAM,yBAAgB,CAAC,iBAAiB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;IACzF,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAC5B,MAA6B,EAC7B,eAAwC,EACxC,yCAAsF,EACtF,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,MAAM,IAAI,GAA0B,MAAM,uBAAc,CAAC,eAAe,CACpE,MAAM,EACN,eAAe,EACf,YAAY,CACf,CAAA;gBACD,OAAO,IAAI,CAAA;YACf;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAC5B,MAA6B,EAC7B,eAAwC,EACxC,yCAAsF,EACtF,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,MAAM,IAAI,GAA0B,MAAM,uBAAc,CAAC,eAAe,CACpE,MAAM,EACN,eAAe,EACf,YAAY,CACf,CAAA;gBACD,OAAO,IAAI,CAAA;YACf;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACpB,OAAmB,EACnB,UAAqC,EACrC,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,OAAO,MAAM,yBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,iBAA6B,CAAA;YACvF;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,OAAmB,EACnB,SAA0B,EAC1B,SAAmC,EACnC,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,OAAO,MAAM,yBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAA;YACvE;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CACvB,OAAmB,EACnB,SAA0B,EAC1B,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,OAAO,MAAM,yBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YAC7D;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CACvB,MAAoB,EACpB,SAA0B,EAC1B,UAA4B,mCAAgB,CAAC,MAAM;QAEnD,QAAQ,OAAO,EAAE;YACb,KAAK,mCAAgB,CAAC,EAAE;gBACpB,OAAO,MAAM,yBAAgB,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;YAC5D;gBACI,MAAM,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;SAChE;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAY;QACnC,OAAO,MAAM,qBAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACzC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,qBAAqB;QACrC,OAAO,MAAM,wBAAiB,CAAC,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IACjE,CAAC;CACJ;AAhQD,gCAgQC"}

package/dist/core/CoreError.d.ts

@@ -0,0 +1,18 @@
+import { ILogger } from "@js-soft/logging-abstractions";
+export declare class CoreError extends Error {
+    private readonly _code;
+    get code(): string;
+    private readonly _reason;
+    get reason(): string;
+    private readonly _data;
+    get data(): string;
+    private readonly _time;
+    get time(): Date;
+    private readonly _rootError?;
+    get rootError(): Error | undefined;
+    private readonly _context?;
+    get context(): Function | undefined;
+    constructor(code?: string, reason?: string, data?: any, time?: Date, rootError?: Error, context?: Function);
+    equals(error: CoreError): boolean;
+    logWith(logger: ILogger): this;
+}

package/dist/core/CoreError.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreError = void 0;
+const json_stringify_safe_1 = __importDefault(require("json-stringify-safe"));
+class CoreError extends Error {
+    constructor(code = "error.unknown", reason = "Operation failed unexpectedly.", data = null, time = new Date(), rootError, context) {
+        const message = [];
+        message.push(code);
+        if (reason) {
+            message.push(": '", reason, "'");
+        }
+        message.push(" at ", time.toISOString());
+        if (data) {
+            if (typeof data["toJSON"] === "function") {
+                message.push(` with data ${data.toJSON(false)}`);
+            }
+            else {
+                message.push(` with data ${(0, json_stringify_safe_1.default)(data)}`);
+            }
+        }
+        super(message.join(""));
+        this._code = code;
+        this._reason = reason;
+        this._time = time;
+        this._data = data;
+        this.name = "CoreError";
+        this._rootError = rootError;
+        this._context = context;
+        if (typeof Error.captureStackTrace !== "undefined") {
+            Error.captureStackTrace(this, context !== null && context !== void 0 ? context : CoreError);
+        }
+    }
+    get code() {
+        return this._code;
+    }
+    get reason() {
+        return this._reason;
+    }
+    get data() {
+        return this._data;
+    }
+    get time() {
+        return this._time;
+    }
+    get rootError() {
+        return this._rootError;
+    }
+    get context() {
+        return this._context;
+    }
+    equals(error) {
+        return this.code === error.code;
+    }
+    logWith(logger) {
+        logger.error(this);
+        return this;
+    }
+}
+exports.CoreError = CoreError;
+//# sourceMappingURL=CoreError.js.map

package/dist/core/CoreError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreError.js","sourceRoot":"","sources":["../../src/core/CoreError.ts"],"names":[],"mappings":";;;;;;AACA,8EAA2C;AAE3C,MAAa,SAAU,SAAQ,KAAK;IAgChC,YACI,IAAI,GAAG,eAAe,EACtB,MAAM,GAAG,gCAAgC,EACzC,OAAY,IAAI,EAChB,OAAa,IAAI,IAAI,EAAE,EACvB,SAAiB,EACjB,OAAkB;QAElB,MAAM,OAAO,GAAG,EAAE,CAAA;QAClB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClB,IAAI,MAAM,EAAE;YACR,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;SACnC;QAED,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;QAExC,IAAI,IAAI,EAAE;YACN,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,UAAU,EAAE;gBACtC,OAAO,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;aACnD;iBAAM;gBACH,OAAO,CAAC,IAAI,CAAC,cAAc,IAAA,6BAAS,EAAC,IAAI,CAAC,EAAE,CAAC,CAAA;aAChD;SACJ;QACD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QAEvB,IAAI,OAAO,KAAK,CAAC,iBAAiB,KAAK,WAAW,EAAE;YAChD,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,SAAS,CAAC,CAAA;SACtD;IACL,CAAC;IAjED,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAGD,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAGD,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAID,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAGD,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAGD,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAuCM,MAAM,CAAC,KAAgB;QAC1B,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAA;IACnC,CAAC;IAEM,OAAO,CAAC,MAAe;QAC1B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAClB,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AA7ED,8BA6EC"}

package/dist/core/CoreIdHelper.d.ts

@@ -0,0 +1,9 @@
+import { CoreId } from "./types/CoreId";
+export declare class CoreIdHelper {
+    private readonly prefix;
+    private readonly validateOnly;
+    private readonly coreIdRegex;
+    constructor(prefix: string, validateOnly?: boolean);
+    generate(): Promise<CoreId>;
+    validate(id: string): boolean;
+}

package/dist/core/CoreIdHelper.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreIdHelper = void 0;
+const Random_1 = require("../util/Random");
+const CoreId_1 = require("./types/CoreId");
+class CoreIdHelper {
+    constructor(prefix, validateOnly = false) {
+        this.prefix = prefix;
+        this.validateOnly = validateOnly;
+        this.coreIdRegex = new RegExp(`${prefix}[${Random_1.RandomCharacterRange.Alphanumeric}]{${20 - prefix.length}}`);
+    }
+    async generate() {
+        if (this.validateOnly) {
+            throw new Error("This CoreIdHelper is set up for validation only.");
+        }
+        return await CoreId_1.CoreId.generate(this.prefix);
+    }
+    validate(id) {
+        return this.coreIdRegex.test(id);
+    }
+}
+exports.CoreIdHelper = CoreIdHelper;
+//# sourceMappingURL=CoreIdHelper.js.map

package/dist/core/CoreIdHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreIdHelper.js","sourceRoot":"","sources":["../../src/core/CoreIdHelper.ts"],"names":[],"mappings":";;;AAAA,2CAAqD;AACrD,2CAAuC;AAEvC,MAAa,YAAY;IAGrB,YAAoC,MAAc,EAAmB,eAAwB,KAAK;QAA9D,WAAM,GAAN,MAAM,CAAQ;QAAmB,iBAAY,GAAZ,YAAY,CAAiB;QAC9F,IAAI,CAAC,WAAW,GAAG,IAAI,MAAM,CAAC,GAAG,MAAM,IAAI,6BAAoB,CAAC,YAAY,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;IAC3G,CAAC;IAEM,KAAK,CAAC,QAAQ;QACjB,IAAI,IAAI,CAAC,YAAY,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;SACtE;QAED,OAAO,MAAM,eAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7C,CAAC;IAEM,QAAQ,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACpC,CAAC;CACJ;AAlBD,oCAkBC"}

package/dist/core/CoreIds.d.ts

@@ -0,0 +1,9 @@
+import { CoreIdHelper } from "./CoreIdHelper";
+export declare class TransportIds {
+    static readonly generic: CoreIdHelper;
+    static readonly secret: CoreIdHelper;
+    static readonly relationshipSecret: CoreIdHelper;
+    static readonly relationshipTemplateKey: CoreIdHelper;
+    static readonly datawalletModification: CoreIdHelper;
+    static readonly fileReference: CoreIdHelper;
+}

package/dist/core/CoreIds.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransportIds = void 0;
+const CoreIdHelper_1 = require("./CoreIdHelper");
+class TransportIds {
+}
+exports.TransportIds = TransportIds;
+TransportIds.generic = new CoreIdHelper_1.CoreIdHelper("");
+TransportIds.secret = new CoreIdHelper_1.CoreIdHelper("TRPSEC");
+TransportIds.relationshipSecret = new CoreIdHelper_1.CoreIdHelper("TRPRSE");
+TransportIds.relationshipTemplateKey = new CoreIdHelper_1.CoreIdHelper("TRPRTK");
+TransportIds.datawalletModification = new CoreIdHelper_1.CoreIdHelper("TRPDWM");
+TransportIds.fileReference = new CoreIdHelper_1.CoreIdHelper("TRPFRF");
+//# sourceMappingURL=CoreIds.js.map

package/dist/core/CoreIds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreIds.js","sourceRoot":"","sources":["../../src/core/CoreIds.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAE7C,MAAa,YAAY;;AAAzB,oCAOC;AAN0B,oBAAO,GAAG,IAAI,2BAAY,CAAC,EAAE,CAAC,CAAA;AAC9B,mBAAM,GAAG,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAA;AACnC,+BAAkB,GAAG,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAA;AAC/C,oCAAuB,GAAG,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAA;AACpD,mCAAsB,GAAG,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAA;AACnD,0BAAa,GAAG,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAA"}

package/dist/core/CoreSerializable.d.ts

@@ -0,0 +1,18 @@
+import { ISerializable, Serializable } from "@js-soft/ts-serval";
+export interface ICoreSerializable extends ISerializable {
+}
+/**
+ * CoreSerializable is the local pendant of the Serializable class which
+ * automatically validates, serializes, deserializes and validates again.
+ *
+ * With the synchronous class, the deserialize methods (from and deserialize)
+ * are called synchronous. Please be aware, that CoreSerializable classes should
+ * have no CoreSerializableAsync properties.
+ */
+export declare class CoreSerializable extends Serializable implements ISerializable {
+    toBase64(): string;
+    static from(value: ICoreSerializable, type: new () => CoreSerializable): CoreSerializable;
+    static fromT<T>(value: ICoreSerializable, type: new () => T): T;
+    static fromBase64T<T>(value: string, type: new () => T): T;
+    static fromBase64Unknown(value: string): Serializable;
+}

package/dist/core/CoreSerializable.js

@@ -0,0 +1,44 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var CoreSerializable_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreSerializable = void 0;
+const ts_serval_1 = require("@js-soft/ts-serval");
+const crypto_1 = require("@nmshd/crypto");
+/**
+ * CoreSerializable is the local pendant of the Serializable class which
+ * automatically validates, serializes, deserializes and validates again.
+ *
+ * With the synchronous class, the deserialize methods (from and deserialize)
+ * are called synchronous. Please be aware, that CoreSerializable classes should
+ * have no CoreSerializableAsync properties.
+ */
+let CoreSerializable = CoreSerializable_1 = class CoreSerializable extends ts_serval_1.Serializable {
+    toBase64() {
+        return crypto_1.CoreBuffer.fromUtf8(this.serialize()).toBase64URL();
+    }
+    static from(value, type) {
+        return super.fromT(value, type);
+    }
+    static fromT(value, type) {
+        return super.fromT(value, type);
+    }
+    static fromBase64T(value, type) {
+        const serialized = crypto_1.CoreBuffer.fromBase64URL(value).toUtf8();
+        return CoreSerializable_1.deserializeT(serialized, type);
+    }
+    static fromBase64Unknown(value) {
+        const serialized = crypto_1.CoreBuffer.fromBase64URL(value).toUtf8();
+        return ts_serval_1.Serializable.deserializeUnknown(serialized);
+    }
+};
+CoreSerializable = CoreSerializable_1 = __decorate([
+    (0, ts_serval_1.type)("CoreSerializable")
+], CoreSerializable);
+exports.CoreSerializable = CoreSerializable;
+//# sourceMappingURL=CoreSerializable.js.map

package/dist/core/CoreSerializable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreSerializable.js","sourceRoot":"","sources":["../../src/core/CoreSerializable.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,kDAAsE;AACtE,0CAA0C;AAI1C;;;;;;;GAOG;AAGH,IAAa,gBAAgB,wBAA7B,MAAa,gBAAiB,SAAQ,wBAAY;IACvC,QAAQ;QACX,OAAO,mBAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IAC9D,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,KAAwB,EAAE,IAAgC;QACzE,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACnC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAI,KAAwB,EAAE,IAAiB;QAC9D,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACnC,CAAC;IAEM,MAAM,CAAC,WAAW,CAAI,KAAa,EAAE,IAAiB;QACzD,MAAM,UAAU,GAAG,mBAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAA;QAC3D,OAAO,kBAAgB,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IAC1D,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,KAAa;QACzC,MAAM,UAAU,GAAG,mBAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAA;QAC3D,OAAO,wBAAY,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAA;IACtD,CAAC;CACJ,CAAA;AAtBY,gBAAgB;IAD5B,IAAA,gBAAI,EAAC,kBAAkB,CAAC;GACZ,gBAAgB,CAsB5B;AAtBY,4CAAgB"}

package/dist/core/CoreSerializableAsync.d.ts

@@ -0,0 +1,18 @@
+import { ISerializableAsync, SerializableAsync } from "@js-soft/ts-serval";
+export interface ICoreSerializableAsync extends ISerializableAsync {
+}
+/**
+ * CoreSerializableAsync is the local pendant of the SerializableAsync class which
+ * automatically validates, serializes, deserializes and validates again.
+ *
+ * With the asynchronous class, the deserialize methods (from and deserialize)
+ * are called asynchronous (returning a Promise). You should only use CoreSerializableAsync
+ * classes if properties with CoreSerializableAsync types are used.
+ */
+export declare class CoreSerializableAsync extends SerializableAsync implements ISerializableAsync {
+    toBase64(): string;
+    static from(value: ICoreSerializableAsync, type: new () => CoreSerializableAsync): Promise<CoreSerializableAsync>;
+    static fromT<T>(value: ICoreSerializableAsync, type: new () => T): Promise<T>;
+    static fromBase64T<T>(value: string, type: new () => T): Promise<T>;
+    static fromBase64Unknown(value: string): Promise<SerializableAsync>;
+}