@sudoplatform/sudo-common 8.1.1 → 8.2.0

package/cjs/types/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListOperationResultStatus = exports.EncryptionAlgorithm = exports.CachePolicy = void 0;
+exports.ListOperationResultStatus = exports.SignatureAlgorithm = exports.EncryptionAlgorithm = exports.CachePolicy = void 0;
 /**
  * Cache policy that determines how data is accessed when performing a query method
  * from the Email Service.
@@ -23,6 +23,15 @@ var EncryptionAlgorithm;
     EncryptionAlgorithm["AesGcmNoPadding"] = "AES/GCM/NoPadding";
     EncryptionAlgorithm["RsaOaepSha1"] = "RSA/OAEPWithSHA-1";
 })(EncryptionAlgorithm = exports.EncryptionAlgorithm || (exports.EncryptionAlgorithm = {}));
+/**
+ * Signature algorithm names that are
+ * supported by the Sudo Platform and can be used
+ * between devices.
+ */
+var SignatureAlgorithm;
+(function (SignatureAlgorithm) {
+    SignatureAlgorithm["RsaPkcs15Sha256"] = "RSA/SSAPKCS15withSHA-256";
+})(SignatureAlgorithm = exports.SignatureAlgorithm || (exports.SignatureAlgorithm = {}));
 /**
  * Status of the list operation result.
  */

package/cjs/types/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":";;;AAQA;;;GAGG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,8BAA8B;IAC9B,uCAAwB,CAAA;IACxB,wCAAwC;IACxC,0CAA2B,CAAA;AAC7B,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAwBD;;;;GAIG;AACH,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,kEAA2C,CAAA;IAC3C,4DAAqC,CAAA;IACrC,wDAAiC,CAAA;AACnC,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAID;;GAEG;AACH,IAAY,yBAcX;AAdD,WAAY,yBAAyB;IACnC;;OAEG;IACH,gDAAmB,CAAA;IACnB;;;OAGG;IACH,gDAAmB,CAAA;IACnB;;OAEG;IACH,gDAAmB,CAAA;AACrB,CAAC,EAdW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAcpC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":";;;AAQA;;;GAGG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,8BAA8B;IAC9B,uCAAwB,CAAA;IACxB,wCAAwC;IACxC,0CAA2B,CAAA;AAC7B,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAwBD;;;;GAIG;AACH,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,kEAA2C,CAAA;IAC3C,4DAAqC,CAAA;IACrC,wDAAiC,CAAA;AACnC,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAED;;;;GAIG;AACH,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,kEAA4C,CAAA;AAC9C,CAAC,EAFW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAE7B;AAID;;GAEG;AACH,IAAY,yBAcX;AAdD,WAAY,yBAAyB;IACnC;;OAEG;IACH,gDAAmB,CAAA;IACnB;;;OAGG;IACH,gDAAmB,CAAA;IACnB;;OAEG;IACH,gDAAmB,CAAA;AACrB,CAAC,EAdW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAcpC"}

package/lib/types/types.js

@@ -20,6 +20,15 @@ export var EncryptionAlgorithm;
     EncryptionAlgorithm["AesGcmNoPadding"] = "AES/GCM/NoPadding";
     EncryptionAlgorithm["RsaOaepSha1"] = "RSA/OAEPWithSHA-1";
 })(EncryptionAlgorithm || (EncryptionAlgorithm = {}));
+/**
+ * Signature algorithm names that are
+ * supported by the Sudo Platform and can be used
+ * between devices.
+ */
+export var SignatureAlgorithm;
+(function (SignatureAlgorithm) {
+    SignatureAlgorithm["RsaPkcs15Sha256"] = "RSA/SSAPKCS15withSHA-256";
+})(SignatureAlgorithm || (SignatureAlgorithm = {}));
 /**
  * Status of the list operation result.
  */

package/lib/types/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAQA;;;GAGG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,8BAA8B;IAC9B,uCAAwB,CAAA;IACxB,wCAAwC;IACxC,0CAA2B,CAAA;AAC7B,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAwBD;;;;GAIG;AACH,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,kEAA2C,CAAA;IAC3C,4DAAqC,CAAA;IACrC,wDAAiC,CAAA;AACnC,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAID;;GAEG;AACH,MAAM,CAAN,IAAY,yBAcX;AAdD,WAAY,yBAAyB;IACnC;;OAEG;IACH,gDAAmB,CAAA;IACnB;;;OAGG;IACH,gDAAmB,CAAA;IACnB;;OAEG;IACH,gDAAmB,CAAA;AACrB,CAAC,EAdW,yBAAyB,KAAzB,yBAAyB,QAcpC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAQA;;;GAGG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,8BAA8B;IAC9B,uCAAwB,CAAA;IACxB,wCAAwC;IACxC,0CAA2B,CAAA;AAC7B,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAwBD;;;;GAIG;AACH,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,kEAA2C,CAAA;IAC3C,4DAAqC,CAAA;IACrC,wDAAiC,CAAA;AACnC,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,kEAA4C,CAAA;AAC9C,CAAC,EAFW,kBAAkB,KAAlB,kBAAkB,QAE7B;AAID;;GAEG;AACH,MAAM,CAAN,IAAY,yBAcX;AAdD,WAAY,yBAAyB;IACnC;;OAEG;IACH,gDAAmB,CAAA;IACnB;;;OAGG;IACH,gDAAmB,CAAA;IACnB;;OAEG;IACH,gDAAmB,CAAA;AACrB,CAAC,EAdW,yBAAyB,KAAzB,yBAAyB,QAcpC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sudoplatform/sudo-common",
-  "version": "8.1.1",
+  "version": "8.2.0",
   "author": "Anonyome Labs, Inc.",
   "repository": {
     "type": "git",

package/types/sudoKeyManager/sudoCryptoProvider.d.ts

@@ -1,4 +1,4 @@
-import { EncryptionAlgorithm } from '../types/types';
+import { EncryptionAlgorithm, SignatureAlgorithm } from '../types/types';
 import { KeyData } from './keyData';
 import { PublicKey } from './publicKey';
 export declare class SudoCryptoProviderDefaults {
@@ -21,6 +21,13 @@ export interface SymmetricEncryptionOptions {
 export interface AsymmetricEncryptionOptions {
     algorithm?: EncryptionAlgorithm;
 }
+/**
+ * Optional arguments for private key signature generation
+ * and verification
+ */
+export interface SignatureOptions {
+    algorithm?: SignatureAlgorithm;
+}
 /**
  * CryptoProvider instance interface
  */
@@ -119,22 +126,24 @@ export interface SudoCryptoProvider {
      *
      * @param name The name of the private key to use for generation.
      * @param data The data to sign.
+     * @param options Signature options. Defaults to \{ algorithm: SignatureAlgorithm.RsaPkcs15Sha256 \}
      *
      * @returns Data signature
      *
      * @throws {@link KeyNotFoundError}
      */
-    generateSignatureWithPrivateKey(name: string, data: ArrayBuffer): Promise<ArrayBuffer>;
+    generateSignatureWithPrivateKey(name: string, data: ArrayBuffer, options?: SignatureOptions): 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
+     * @param options Signature options. Defaults to \{ algorithm: SignatureAlgorithm.RsaPkcs15Sha256 \}
      *
      * @returns True if the data and signature could be successfully verified
      */
-    verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
+    verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer, options?: SignatureOptions): Promise<boolean>;
     /**
      * Adds a private key to the secure store.
      *

package/types/types/types.d.ts

@@ -42,6 +42,14 @@ export declare enum EncryptionAlgorithm {
     AesGcmNoPadding = "AES/GCM/NoPadding",
     RsaOaepSha1 = "RSA/OAEPWithSHA-1"
 }
+/**
+ * Signature algorithm names that are
+ * supported by the Sudo Platform and can be used
+ * between devices.
+ */
+export declare enum SignatureAlgorithm {
+    RsaPkcs15Sha256 = "RSA/SSAPKCS15withSHA-256"
+}
 export declare type Subset<T, S> = Pick<T, keyof T & keyof S>;
 /**
  * Status of the list operation result.