@sudoplatform/sudo-common 7.1.3 → 8.0.0

package/cjs/sudoKeyManager/keyData.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyDataKeyFormat = exports.KeyDataKeyType = void 0;
+/**
+ * Type of key
+ */
+var KeyDataKeyType;
+(function (KeyDataKeyType) {
+    KeyDataKeyType["SymmetricKey"] = "SymmetricKey";
+    KeyDataKeyType["RSAPublicKey"] = "RSAPublicKey";
+    KeyDataKeyType["RSAPrivateKey"] = "RSAPrivateKey";
+    KeyDataKeyType["Password"] = "Password";
+})(KeyDataKeyType = exports.KeyDataKeyType || (exports.KeyDataKeyType = {}));
+var KeyDataKeyFormat;
+(function (KeyDataKeyFormat) {
+    /**
+     * Raw key format.
+     *
+     * For SymmetricKey and Password types this means the raw bytes
+     * of the key/password.
+     *
+     * For RSAPublicKey this means RSAPublicKey binary format.
+     * For RSAPrivateKey this means RSAPrivateKey binary format.
+     * "RSA PUBLIC KEY" or "RSA PRIVATE KEY" in PEM speak
+     */
+    KeyDataKeyFormat["Raw"] = "Raw";
+    /**
+     * SPKI public key format.
+     *
+     * Applies to public keys (currently only RSAPublicKey)
+     * and means they are formated using SPKI.
+     *
+     * "PUBLIC KEY" in PEM speak
+     */
+    KeyDataKeyFormat["SPKI"] = "SPKI";
+    /**
+     * PKCS8 private key format.
+     *
+     * Applies to private keys (currently only RSAPrivateKey)
+     * and means they are formated using unencrypted PKCS8.
+     *
+     * "PRIVATE KEY" in PEM speak
+     */
+    KeyDataKeyFormat["PKCS8"] = "PKCS8";
+})(KeyDataKeyFormat = exports.KeyDataKeyFormat || (exports.KeyDataKeyFormat = {}));
+//# sourceMappingURL=keyData.js.map

package/cjs/sudoKeyManager/keyData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyData.js","sourceRoot":"","sources":["../../src/sudoKeyManager/keyData.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,+CAA6B,CAAA;IAC7B,+CAA6B,CAAA;IAC7B,iDAA+B,CAAA;IAC/B,uCAAqB,CAAA;AACvB,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAED,IAAY,gBAgCX;AAhCD,WAAY,gBAAgB;IAC1B;;;;;;;;;OASG;IACH,+BAAW,CAAA;IAEX;;;;;;;OAOG;IACH,iCAAa,CAAA;IAEb;;;;;;;OAOG;IACH,mCAAe,CAAA;AACjB,CAAC,EAhCW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAgC3B"}

package/cjs/sudoKeyManager/publicKey.d.ts

@@ -0,0 +1,8 @@
+export declare enum PublicKeyFormat {
+    RSAPublicKey = 0,
+    SPKI = 1
+}
+export interface PublicKey {
+    readonly keyData: ArrayBuffer;
+    readonly keyFormat: PublicKeyFormat;
+}

package/cjs/sudoKeyManager/publicKey.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicKeyFormat = void 0;
+var PublicKeyFormat;
+(function (PublicKeyFormat) {
+    PublicKeyFormat[PublicKeyFormat["RSAPublicKey"] = 0] = "RSAPublicKey";
+    PublicKeyFormat[PublicKeyFormat["SPKI"] = 1] = "SPKI";
+})(PublicKeyFormat = exports.PublicKeyFormat || (exports.PublicKeyFormat = {}));
+//# sourceMappingURL=publicKey.js.map

package/cjs/sudoKeyManager/publicKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publicKey.js","sourceRoot":"","sources":["../../src/sudoKeyManager/publicKey.ts"],"names":[],"mappings":";;;AAAA,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,qEAAY,CAAA;IACZ,qDAAI,CAAA;AACN,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B"}

package/cjs/sudoKeyManager/sudoCryptoProvider.d.ts

@@ -0,0 +1,324 @@
+import { EncryptionAlgorithm } from '../types/types';
+import { KeyData } from './keyData';
+import { PublicKey } from './publicKey';
+export declare class SudoCryptoProviderDefaults {
+    static readonly aesIVSize = 16;
+    static readonly aesKeySize = 256;
+    static readonly rsaKeySize = 2048;
+    static readonly pbkdfRounds = 10000;
+    static readonly pbkdfSaltSize = 16;
+}
+/**
+ * Optional arguments for symmetric encryption..
+ */
+export interface SymmetricEncryptionOptions {
+    iv?: ArrayBuffer;
+    algorithm?: EncryptionAlgorithm;
+}
+/**
+ * Optional arguments for public key encryption.
+ */
+export interface AsymmetricEncryptionOptions {
+    algorithm?: EncryptionAlgorithm;
+}
+/**
+ * CryptoProvider instance interface
+ */
+export interface SudoCryptoProvider {
+    getNamespace(): string;
+    getServiceName(): string;
+    /**
+     * Adds as password to the secure store.
+     *
+     * @param password The password to store.
+     * @param name The name of the password.
+     */
+    addPassword(password: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Retrieves a password from the secure store.
+     *
+     * @param name The name of the password to retrieve.
+     *
+     * @returns The password or undefined if a password with the given name was not found.
+     */
+    getPassword(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Deletes a password from the secure store.
+     *
+     * @param name The name of the password to delete.
+     */
+    deletePassword(name: string): Promise<void>;
+    /**
+     * Updates a password stored in the secure store.
+     *
+     * @param password The new password.
+     * @param name The name of the password to update.
+     */
+    updatePassword(password: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Adds a symmetric key to the secure store.
+     *
+     * @param key The symmetric key.
+     * @param name The name for the symmetric key.
+     */
+    addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Retrieves a symmetric key from the secure store.
+     *
+     * @param name The name of the symmetric key.
+     *
+     * @returns The symmetric key or undefined if not found.
+     */
+    getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Checks to see if the specified symmetric key exists.
+     *
+     * @param name The name of the symmetric key.
+     */
+    doesSymmetricKeyExist(name: string): Promise<boolean>;
+    /**
+     * Deletes a symmetric key from the secure store.
+     *
+     * @param name The name of the symmetric key.
+     */
+    deleteSymmetricKey(name: string): Promise<void>;
+    /**
+     * Generates a symmetric key and stores it securely.
+     *
+     * @param name The name for the symmetric key.
+     */
+    generateSymmetricKey(name: string): Promise<void>;
+    /**
+     * Generates a symmetric key from a password using PBKDF2.
+     *
+     * @param password The password from which to generate the symmetric key
+     * @param salt Salt to use in generation of the key
+     * @param rounds The number of rounds of PBKDF2 to perform. Default: per getDefaultPBKDF2Rounds
+     *
+     * @returns The generated symmetric key.
+     */
+    generateSymmetricKeyFromPassword(password: ArrayBuffer, salt: ArrayBuffer, options?: {
+        rounds?: number;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Generate random bytes using a secure random number generator.
+     *
+     * @param size Number of random bytes to generate
+     *
+     * @returns ArrayBuffer containing the random bytes.
+     */
+    generateRandomData(size: number): Promise<ArrayBuffer>;
+    /**
+     * Deletes a key pair from the secure store.
+     *
+     * @param name The name of the key pair to be deleted.
+     */
+    deleteKeyPair(name: string): Promise<void>;
+    /**
+     * Generates a signature for the given data with the specified private key.
+     *
+     * @param name The name of the private key to use for generation.
+     * @param data The data to sign.
+     *
+     * @returns Data signature
+     *
+     * @throws {@link KeyNotFoundError}
+     */
+    generateSignatureWithPrivateKey(name: string, data: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Verifies the given data against the provided signature using the specified public key.
+     *
+     * @param name The name of the public key to use for validation.
+     * @param data The data to verify
+     * @param signature The signature to verify against
+     *
+     * @returns True if the data and signature could be successfully verified
+     */
+    verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
+    /**
+     * Adds a private key to the secure store.
+     *
+     * @param key The private key to store securely.
+     * @param name The name of the private key to be stored.
+     */
+    addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Retrieves a private key from the secure store.
+     *
+     * @param name The name of the private key to be retrieved.
+     *
+     * @returns Requested private key or undefined if the key was not found.
+     */
+    getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Checks to see if the specified private key exists.
+     *
+     * @param name The name of the private key.
+     */
+    doesPrivateKeyExist(name: string): Promise<boolean>;
+    /**
+     * Adds a public key to the secure store.
+     *
+     * @param key The public key to store securely.
+     * @param name The name of the public key to be stored.
+     */
+    addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Deletes the specified public key from the secure store.
+     *
+     * @param name The name of the public key to be removed.
+     */
+    deletePublicKey(name: string): Promise<void>;
+    /**
+     * Retrieves the public key from the secure store.
+     *
+     * @param name The name of the public key.
+     *
+     * @returns The public key or undefined if the key was not found.
+     */
+    getPublicKey(name: string): Promise<PublicKey | undefined>;
+    /**
+     * Clear all types of keys
+     */
+    removeAllKeys(): Promise<void>;
+    /**
+     * @deprecated Use version with `options` param.
+     *
+     * Encrypts the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to encrypt.
+     * @param data Data to encrypt.
+     * @param iv Optional Initialization Vector.
+     *
+     * @returns Encrypted data and IV
+     */
+    encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Encrypts the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to encrypt.
+     * @param data Data to encrypt.
+     *
+     *
+     * @returns Encrypted data and IV
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     * @throws {@link KeyNotFoundError}
+     */
+    encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * @deprecated Use version with `options` param.
+     *
+     * Decrypt the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to decrypt.
+     * @param data The data to decrypt.
+     * @param iv Optional Initialization Vector.
+     *
+     * @returns Decrypted data
+     */
+    decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Decrypt the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to decrypt.
+     * @param data The data to decrypt.
+     *
+     * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     * @throws {@link KeyNotFoundError}
+     */
+    decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * @deprecated Use version with `options` param.
+     *
+     * Encrypts the given data with the specified key
+     *
+     * @param name The name of the symmetric key to use to encrypt.
+     * @param data Data to encrypt.
+     * @param iv Optional Initialization Vector.
+     *
+     * @returns Encrypted data and IV
+     */
+    encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Encrypts the given data with the specified key
+     *
+     * @param name The name of the symmetric key to use to encrypt.
+     * @param data Data to encrypt.
+     *
+     * @returns Encrypted data and IV
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     */
+    encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * @deprecated Use version with `options` param.
+     *
+     * Decrypt the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to decrypt.
+     * @param data The data to decrypt.
+     * @param iv Optional Initialization Vector.
+     *
+     * @returns Decrypted data
+     */
+    decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Decrypt the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to decrypt.
+     * @param data The data to decrypt.
+     *
+     * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     */
+    decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * Encrypts the given data with the specified public key.
+     *
+     * @param name The name of the public key to use for encryption.
+     * @param data The data to encrypt.
+     *
+     * @returns Encrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     * @throws {@link KeyNotFoundError}
+     */
+    encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * Decrypts the given data with the specified private key.
+     *
+     * @param name The name of the private key to use for decryption.
+     * @param data The data to decrypt.
+     *
+     * @returns Decrypted data.
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     * @throws {@link KeyNotFoundError}
+     */
+    decryptWithPrivateKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * Generates and securely stores a key pair for public key cryptography.
+     *
+     * @param name The name of the key pair to be generated.
+     */
+    generateKeyPair(name: string): Promise<void>;
+    /**
+     * Creates a SHA256 hash of the specified data.
+     *
+     * @param data Data to hash.
+     *
+     * @returns The SHA256 hash of data
+     */
+    generateHash(data: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Export all keys and passwords from the key store as an
+     * array of KeyData items.
+     *
+     * @returns Array of exported keys and passwords
+     */
+    exportKeys(): Promise<KeyData[]>;
+}

package/cjs/sudoKeyManager/sudoCryptoProvider.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SudoCryptoProviderDefaults = void 0;
+class SudoCryptoProviderDefaults {
+}
+exports.SudoCryptoProviderDefaults = SudoCryptoProviderDefaults;
+SudoCryptoProviderDefaults.aesIVSize = 16;
+SudoCryptoProviderDefaults.aesKeySize = 256;
+SudoCryptoProviderDefaults.rsaKeySize = 2048;
+SudoCryptoProviderDefaults.pbkdfRounds = 10000;
+SudoCryptoProviderDefaults.pbkdfSaltSize = 16;
+//# sourceMappingURL=sudoCryptoProvider.js.map

package/cjs/sudoKeyManager/sudoCryptoProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sudoCryptoProvider.js","sourceRoot":"","sources":["../../src/sudoKeyManager/sudoCryptoProvider.ts"],"names":[],"mappings":";;;AAIA,MAAa,0BAA0B;;AAAvC,gEAMC;AALwB,oCAAS,GAAG,EAAE,CAAA;AACd,qCAAU,GAAG,GAAG,CAAA;AAChB,qCAAU,GAAG,IAAI,CAAA;AACjB,sCAAW,GAAG,KAAK,CAAA;AACnB,wCAAa,GAAG,EAAE,CAAA"}