@sudoplatform/sudo-common 6.4.0 → 7.0.2

package/lib/sudoKeyArchive/sudoKeyArchive.d.ts

@@ -142,7 +142,7 @@ export declare class DefaultSudoKeyArchive implements SudoKeyArchive {
      *
      * @param excludedKeyTypes
      *     Set of key types to exclude from archive or restore operation.
-     *     Default: {{@link KeyArchiveKeyType.PublicKey}}
+     *     Default: {@link KeyArchiveKeyType.PublicKey}
      *
      * @param metaInfo
      *     Meta information to include with the key archive

package/lib/sudoKeyArchive/sudoKeyArchive.js

@@ -81,7 +81,7 @@ class DefaultSudoKeyArchive {
    *
    * @param excludedKeyTypes
    *     Set of key types to exclude from archive or restore operation.
-   *     Default: {{@link KeyArchiveKeyType.PublicKey}}
+   *     Default: {@link KeyArchiveKeyType.PublicKey}
    *
    * @param metaInfo
    *     Meta information to include with the key archive

package/lib/sudoKeyManager/sudoCryptoProvider.d.ts

@@ -75,7 +75,7 @@ export interface SudoCryptoProvider {
      *
      * @param name The name of the symmetric key.
      */
-    doesSymmetricKeyExists(name: string): Promise<boolean>;
+    doesSymmetricKeyExist(name: string): Promise<boolean>;
     /**
      * Deletes a symmetric key from the secure store.
      *
@@ -114,6 +114,27 @@ export interface SudoCryptoProvider {
      * @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.
      *
@@ -134,7 +155,7 @@ export interface SudoCryptoProvider {
      *
      * @param name The name of the private key.
      */
-    doesPrivateKeyExists(name: string): Promise<boolean>;
+    doesPrivateKeyExist(name: string): Promise<boolean>;
     /**
      * Adds a public key to the secure store.
      *
@@ -142,6 +163,12 @@ export interface SudoCryptoProvider {
      * @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.
      *
@@ -176,6 +203,7 @@ export interface SudoCryptoProvider {
      * @returns Encrypted data and IV
      *
      * @throws {@link UnrecognizedAlgorithmError}
+     * @throws {@link KeyNotFoundError}
      */
     encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -199,6 +227,7 @@ export interface SudoCryptoProvider {
      * @returns Decrypted data
      *
      * @throws {@link UnrecognizedAlgorithmError}
+     * @throws {@link KeyNotFoundError}
      */
     decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -256,6 +285,7 @@ export interface SudoCryptoProvider {
      * @returns Encrypted data
      *
      * @throws {@link UnrecognizedAlgorithmError}
+     * @throws {@link KeyNotFoundError}
      */
     encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -264,9 +294,10 @@ export interface SudoCryptoProvider {
      * @param name The name of the private key to use for decryption.
      * @param data The data to decrypt.
      *
-     * @returns Decrypted data or undefined if the private key is not found.
+     * @returns Decrypted data.
      *
      * @throws {@link UnrecognizedAlgorithmError}
+     * @throws {@link KeyNotFoundError}
      */
     decryptWithPrivateKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**

package/lib/sudoKeyManager/sudoKeyManager.d.ts

@@ -56,7 +56,7 @@ export interface SudoKeyManager {
      *
      * @param name The name of the symmetric key.
      */
-    doesSymmetricKeyExists(name: string): Promise<boolean>;
+    doesSymmetricKeyExist(name: string): Promise<boolean>;
     /**
      * Deletes a symmetric key from the secure store.
      *
@@ -83,7 +83,7 @@ export interface SudoKeyManager {
      *
      * @param name The name of the private key.
      */
-    doesPrivateKeyExists(name: string): Promise<boolean>;
+    doesPrivateKeyExist(name: string): Promise<boolean>;
     /**
      * Adds a public key to the secure store.
      *
@@ -93,6 +93,12 @@ export interface SudoKeyManager {
      * @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.
      *
@@ -109,6 +115,25 @@ export interface SudoKeyManager {
      * @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 or undefined if the private key is not found.
+     */
+    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>;
     /**
      * @deprecated Use version with `options` param.
      *
@@ -290,15 +315,18 @@ export declare class DefaultSudoKeyManager implements SudoKeyManager {
     updatePassword(password: ArrayBuffer, name: string): Promise<void>;
     addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
     getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
-    doesSymmetricKeyExists(name: string): Promise<boolean>;
+    doesSymmetricKeyExist(name: string): Promise<boolean>;
     deleteSymmetricKey(name: string): Promise<void>;
     generateKeyPair(name: string): Promise<void>;
     addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
     getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
-    doesPrivateKeyExists(name: string): Promise<boolean>;
+    doesPrivateKeyExist(name: string): Promise<boolean>;
     addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
+    deletePublicKey(name: string): Promise<void>;
     getPublicKey(name: string): Promise<PublicKey | undefined>;
     deleteKeyPair(name: string): Promise<void>;
+    generateSignatureWithPrivateKey(name: string, data: ArrayBuffer): Promise<ArrayBuffer>;
+    verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
     encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;

package/lib/sudoKeyManager/sudoKeyManager.js

@@ -49,8 +49,8 @@ class DefaultSudoKeyManager {
     return this.sudoCryptoProvider.getSymmetricKey(name);
   }
 
-  doesSymmetricKeyExists(name) {
-    return this.sudoCryptoProvider.doesSymmetricKeyExists(name);
+  doesSymmetricKeyExist(name) {
+    return this.sudoCryptoProvider.doesSymmetricKeyExist(name);
   }
 
   deleteSymmetricKey(name) {
@@ -69,14 +69,18 @@ class DefaultSudoKeyManager {
     return this.sudoCryptoProvider.getPrivateKey(name);
   }
 
-  doesPrivateKeyExists(name) {
-    return this.sudoCryptoProvider.doesPrivateKeyExists(name);
+  doesPrivateKeyExist(name) {
+    return this.sudoCryptoProvider.doesPrivateKeyExist(name);
   }
 
   addPublicKey(key, name) {
     return this.sudoCryptoProvider.addPublicKey(key, name);
   }
 
+  deletePublicKey(name) {
+    return this.sudoCryptoProvider.deletePublicKey(name);
+  }
+
   getPublicKey(name) {
     return this.sudoCryptoProvider.getPublicKey(name);
   }
@@ -85,6 +89,14 @@ class DefaultSudoKeyManager {
     return this.sudoCryptoProvider.deleteKeyPair(name);
   }
 
+  generateSignatureWithPrivateKey(name, data) {
+    return this.sudoCryptoProvider.generateSignatureWithPrivateKey(name, data);
+  }
+
+  verifySignatureWithPublicKey(name, data, signature) {
+    return this.sudoCryptoProvider.verifySignatureWithPublicKey(name, data, signature);
+  }
+
   encryptWithSymmetricKey(key, data, ivOrOptions) {
     if (_buffer.Buffer.isArrayBuffer(ivOrOptions)) {
       return this.sudoCryptoProvider.encryptWithSymmetricKey(key, data, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sudoplatform/sudo-common",
-  "version": "6.4.0",
+  "version": "7.0.2",
   "author": "Anonyome Labs, Inc.",
   "repository": {
     "type": "git",
@@ -44,40 +44,48 @@
   },
   "dependencies": {
     "apollo-client": "^2.6.10",
-    "aws-sdk": "^2.973.0",
+    "aws-sdk": "^2.1181.0",
     "browser-bunyan": "^1.8.0",
     "fflate": "^0.7.3",
     "graphql": "^15.8.0"
   },
   "peerDependencies": {
-    "io-ts": "^2.2.10"
+    "io-ts": "^2.2.16"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.17.10",
-    "@babel/plugin-proposal-class-properties": "^7.16.7",
-    "@babel/plugin-proposal-private-methods": "^7.16.11",
-    "@babel/preset-env": "^7.17.10",
-    "@babel/preset-typescript": "^7.16.7",
-    "@types/jest": "^27.5.0",
-    "@typescript-eslint/eslint-plugin": "^5.22.0",
-    "@typescript-eslint/parser": "^5.22.0",
+    "@babel/cli": "^7.18.9",
+    "@babel/core": "^7.18.9",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-private-methods": "^7.18.6",
+    "@babel/preset-env": "^7.18.9",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/jest": "^27.5.2",
+    "@typescript-eslint/eslint-plugin": "^5.30.7",
+    "@typescript-eslint/parser": "^5.30.7",
     "aws-sdk-mock": "^5.7.0",
-    "eslint": "^8.14.0",
+    "eslint": "^8.20.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "fp-ts": "^2.11.8",
+    "eslint-plugin-prettier": "^4.2.1",
+    "fp-ts": "^2.12.1",
     "io-ts": "^2.2.16",
     "io-ts-types": "^0.5.16",
     "isomorphic-webcrypto": "^2.3.8",
     "jest": "^27.5.1",
     "monocle-ts": "^2.3.13",
     "newtype-ts": "^0.3.5",
-    "prettier": "^2.6.2",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "ts-mockito": "^2.6.1",
-    "typedoc": "^0.22.15",
-    "typescript": "^4.6.4"
+    "typedoc": "^0.23.9",
+    "typescript": "^4.7.4"
+  },
+  "outdatedSuppressions": {
+    "major": {
+      "@types/jest": 1661135936,
+      "ansi-regex": 1661135937,
+      "graphql": 1661135937,
+      "jest": 1661135937
+    }
   }
 }

package/src/sudoKeyArchive/sudoKeyArchive.ts

@@ -195,7 +195,7 @@ export class DefaultSudoKeyArchive implements SudoKeyArchive {
    *
    * @param excludedKeyTypes
    *     Set of key types to exclude from archive or restore operation.
-   *     Default: {{@link KeyArchiveKeyType.PublicKey}}
+   *     Default: {@link KeyArchiveKeyType.PublicKey}
    *
    * @param metaInfo
    *     Meta information to include with the key archive

package/src/sudoKeyManager/sudoCryptoProvider.ts

@@ -91,7 +91,7 @@ export interface SudoCryptoProvider {
    *
    * @param name The name of the symmetric key.
    */
-  doesSymmetricKeyExists(name: string): Promise<boolean>
+  doesSymmetricKeyExist(name: string): Promise<boolean>
 
   /**
    * Deletes a symmetric key from the secure store.
@@ -138,6 +138,36 @@ export interface SudoCryptoProvider {
    */
   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.
    *
@@ -160,7 +190,7 @@ export interface SudoCryptoProvider {
    *
    * @param name The name of the private key.
    */
-  doesPrivateKeyExists(name: string): Promise<boolean>
+  doesPrivateKeyExist(name: string): Promise<boolean>
 
   /**
    * Adds a public key to the secure store.
@@ -170,6 +200,13 @@ export interface SudoCryptoProvider {
    */
   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.
    *
@@ -211,6 +248,7 @@ export interface SudoCryptoProvider {
    * @returns Encrypted data and IV
    *
    * @throws {@link UnrecognizedAlgorithmError}
+   * @throws {@link KeyNotFoundError}
    */
   encryptWithSymmetricKeyName(
     name: string,
@@ -244,6 +282,7 @@ export interface SudoCryptoProvider {
    * @returns Decrypted data
    *
    * @throws {@link UnrecognizedAlgorithmError}
+   * @throws {@link KeyNotFoundError}
    */
   decryptWithSymmetricKeyName(
     name: string,
@@ -326,6 +365,7 @@ export interface SudoCryptoProvider {
    * @returns Encrypted data
    *
    * @throws {@link UnrecognizedAlgorithmError}
+   * @throws {@link KeyNotFoundError}
    */
   encryptWithPublicKey(
     name: string,
@@ -339,9 +379,10 @@ export interface SudoCryptoProvider {
    * @param name The name of the private key to use for decryption.
    * @param data The data to decrypt.
    *
-   * @returns Decrypted data or undefined if the private key is not found.
+   * @returns Decrypted data.
    *
    * @throws {@link UnrecognizedAlgorithmError}
+   * @throws {@link KeyNotFoundError}
    */
   decryptWithPrivateKey(
     name: string,

package/src/sudoKeyManager/sudoKeyManager.ts

@@ -68,7 +68,7 @@ export interface SudoKeyManager {
    *
    * @param name The name of the symmetric key.
    */
-  doesSymmetricKeyExists(name: string): Promise<boolean>
+  doesSymmetricKeyExist(name: string): Promise<boolean>
 
   /**
    * Deletes a symmetric key from the secure store.
@@ -99,7 +99,7 @@ export interface SudoKeyManager {
    *
    * @param name The name of the private key.
    */
-  doesPrivateKeyExists(name: string): Promise<boolean>
+  doesPrivateKeyExist(name: string): Promise<boolean>
 
   /**
    * Adds a public key to the secure store.
@@ -111,6 +111,13 @@ export interface SudoKeyManager {
    */
   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.
    *
@@ -129,6 +136,34 @@ export interface SudoKeyManager {
    */
   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 or undefined if the private key is not found.
+   */
+  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>
+
   /**
    * @deprecated Use version with `options` param.
    *
@@ -393,8 +428,8 @@ export class DefaultSudoKeyManager implements SudoKeyManager {
     return this.sudoCryptoProvider.getSymmetricKey(name)
   }
 
-  public doesSymmetricKeyExists(name: string): Promise<boolean> {
-    return this.sudoCryptoProvider.doesSymmetricKeyExists(name)
+  public doesSymmetricKeyExist(name: string): Promise<boolean> {
+    return this.sudoCryptoProvider.doesSymmetricKeyExist(name)
   }
 
   public deleteSymmetricKey(name: string): Promise<void> {
@@ -413,14 +448,18 @@ export class DefaultSudoKeyManager implements SudoKeyManager {
     return this.sudoCryptoProvider.getPrivateKey(name)
   }
 
-  public doesPrivateKeyExists(name: string): Promise<boolean> {
-    return this.sudoCryptoProvider.doesPrivateKeyExists(name)
+  public doesPrivateKeyExist(name: string): Promise<boolean> {
+    return this.sudoCryptoProvider.doesPrivateKeyExist(name)
   }
 
   public addPublicKey(key: ArrayBuffer, name: string): Promise<void> {
     return this.sudoCryptoProvider.addPublicKey(key, name)
   }
 
+  public deletePublicKey(name: string): Promise<void> {
+    return this.sudoCryptoProvider.deletePublicKey(name)
+  }
+
   public getPublicKey(name: string): Promise<PublicKey | undefined> {
     return this.sudoCryptoProvider.getPublicKey(name)
   }
@@ -429,6 +468,25 @@ export class DefaultSudoKeyManager implements SudoKeyManager {
     return this.sudoCryptoProvider.deleteKeyPair(name)
   }
 
+  public generateSignatureWithPrivateKey(
+    name: string,
+    data: ArrayBuffer,
+  ): Promise<ArrayBuffer> {
+    return this.sudoCryptoProvider.generateSignatureWithPrivateKey(name, data)
+  }
+
+  verifySignatureWithPublicKey(
+    name: string,
+    data: ArrayBuffer,
+    signature: ArrayBuffer,
+  ): Promise<boolean> {
+    return this.sudoCryptoProvider.verifySignatureWithPublicKey(
+      name,
+      data,
+      signature,
+    )
+  }
+
   public encryptWithSymmetricKey(
     key: ArrayBuffer,
     data: ArrayBuffer,

package/test/unit/sudoKeyManager.spec.ts

@@ -177,21 +177,21 @@ describe('DefaultSudoKeyManager', () => {
     })
   })
 
-  describe('doesSymmetricKeyExists', () => {
-    it('should call crypto provider doesSymmetricKeyExists', async () => {
+  describe('doesSymmetricKeyExist', () => {
+    it('should call crypto provider doesSymmetricKeyExist', async () => {
       when(
-        sudoCryptoProviderMock.doesSymmetricKeyExists(anything()),
+        sudoCryptoProviderMock.doesSymmetricKeyExist(anything()),
       ).thenResolve(true)
 
       await expect(
-        sudoKeyManager.doesSymmetricKeyExists('VpnKey'),
+        sudoKeyManager.doesSymmetricKeyExist('VpnKey'),
       ).resolves.toEqual(true)
       const [actualKey] = capture(
-        sudoCryptoProviderMock.doesSymmetricKeyExists,
+        sudoCryptoProviderMock.doesSymmetricKeyExist,
       ).first()
       expect(actualKey).toStrictEqual('VpnKey')
 
-      verify(sudoCryptoProviderMock.doesSymmetricKeyExists(anything())).once()
+      verify(sudoCryptoProviderMock.doesSymmetricKeyExist(anything())).once()
     })
   })
 
@@ -281,22 +281,22 @@ describe('DefaultSudoKeyManager', () => {
     })
   })
 
-  describe('doesPrivateKeyExists', () => {
-    it('should call crypto provider doesPrivateKeyExists', async () => {
-      when(sudoCryptoProviderMock.doesPrivateKeyExists(anything())).thenResolve(
+  describe('doesPrivateKeyExist', () => {
+    it('should call crypto provider doesPrivateKeyExist', async () => {
+      when(sudoCryptoProviderMock.doesPrivateKeyExist(anything())).thenResolve(
         true,
       )
 
       await expect(
-        sudoKeyManager.doesPrivateKeyExists('VpnKeyPair'),
+        sudoKeyManager.doesPrivateKeyExist('VpnKeyPair'),
       ).resolves.toBeTruthy()
 
       const [actualKeyName] = capture(
-        sudoCryptoProviderMock.doesPrivateKeyExists,
+        sudoCryptoProviderMock.doesPrivateKeyExist,
       ).first()
       expect(actualKeyName).toStrictEqual('VpnKeyPair')
 
-      verify(sudoCryptoProviderMock.doesPrivateKeyExists(anything())).once()
+      verify(sudoCryptoProviderMock.doesPrivateKeyExist(anything())).once()
     })
   })