@human-protocol/sdk 3.0.6 → 3.0.7

package/dist/encryption.d.ts

@@ -1,5 +1,6 @@
 import * as openpgp from 'openpgp';
 import { IKeyPair } from './interfaces';
+type MessageDataType = string | Uint8Array;
 /**
  * ## Introduction
  *
@@ -100,7 +101,7 @@ export declare class Encryption {
      * const resultMessage = await encription.signAndEncrypt('message', publicKeys);
      * ```
      */
-    signAndEncrypt(message: string, publicKeys: string[]): Promise<string>;
+    signAndEncrypt(message: MessageDataType, publicKeys: string[]): Promise<string>;
     /**
      * This function decrypts messages using the private key. In addition, the public key can be added for signature verification.
      *
@@ -132,7 +133,7 @@ export declare class Encryption {
      * const resultMessage = await encription.decrypt('message');
      * ```
      */
-    decrypt(message: string, publicKey?: string): Promise<string>;
+    decrypt(message: string, publicKey?: string): Promise<Uint8Array>;
     /**
      * This function signs a message using the private key used to initialize the client.
      *
@@ -294,7 +295,7 @@ export declare class EncryptionUtils {
      * const result = await EncriptionUtils.encrypt('message', publicKeys);
      * ```
      */
-    static encrypt(message: string, publicKeys: string[]): Promise<string>;
+    static encrypt(message: MessageDataType, publicKeys: string[]): Promise<string>;
     /**
      * Verifies if a message appears to be encrypted with OpenPGP.
      *
@@ -327,4 +328,5 @@ export declare class EncryptionUtils {
      */
     static isEncrypted(message: string): boolean;
 }
+export {};
 //# sourceMappingURL=encryption.d.ts.map

package/dist/encryption.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../src/encryption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,UAAU,CAAqB;IAEvC;;;;OAIG;gBACS,UAAU,EAAE,OAAO,CAAC,UAAU;IAI1C;;;;;;OAMG;WACiB,KAAK,CACvB,iBAAiB,EAAE,MAAM,EACzB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,CAAC;IAkBtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACU,cAAc,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB1E;;;;;;;;;;;;;;;;;OAiBG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,eAAe;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;OAaG;WACiB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,eAAe,CACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,SAAK,GACd,OAAO,CAAC,QAAQ,CAAC;IAkBpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;WACiB,OAAO,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CASpD"}
+{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../src/encryption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,KAAK,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAU3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,UAAU,CAAqB;IAEvC;;;;OAIG;gBACS,UAAU,EAAE,OAAO,CAAC,UAAU;IAI1C;;;;;;OAMG;WACiB,KAAK,CACvB,iBAAiB,EAAE,MAAM,EACzB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,CAAC;IAkBtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACU,cAAc,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAkBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,OAAO,CAClB,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,UAAU,CAAC;IAoCtB;;;;;;;;;;;;;;;;;OAiBG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,eAAe;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;OAaG;WACiB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,eAAe,CACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,SAAK,GACd,OAAO,CAAC,QAAQ,CAAC;IAkBpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;WACiB,OAAO,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CASpD"}

package/dist/encryption.js

@@ -25,6 +25,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EncryptionUtils = exports.Encryption = void 0;
 const openpgp = __importStar(require("openpgp"));
+function makeMessageDataBinary(message) {
+    if (typeof message === 'string') {
+        return Buffer.from(message);
+    }
+    return message;
+}
 /**
  * ## Introduction
  *
@@ -139,13 +145,15 @@ class Encryption {
      * ```
      */
     async signAndEncrypt(message, publicKeys) {
-        const plaintext = message;
         const pgpPublicKeys = await Promise.all(publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey })));
-        const pgpMessage = await openpgp.createMessage({ text: plaintext });
+        const pgpMessage = await openpgp.createMessage({
+            binary: makeMessageDataBinary(message),
+        });
         const encrypted = await openpgp.encrypt({
             message: pgpMessage,
             encryptionKeys: pgpPublicKeys,
             signingKeys: this.privateKey,
+            format: 'armored',
         });
         return encrypted;
     }
@@ -181,17 +189,33 @@ class Encryption {
      * ```
      */
     async decrypt(message, publicKey) {
-        const pgpMessage = await openpgp.readMessage({ armoredMessage: message });
+        const pgpMessage = await openpgp.readMessage({
+            armoredMessage: message,
+        });
         const decryptionOptions = {
             message: pgpMessage,
             decryptionKeys: this.privateKey,
-            expectSigned: !!publicKey,
+            format: 'binary',
         };
-        if (publicKey) {
+        const shouldVerifySignature = !!publicKey;
+        if (shouldVerifySignature) {
             const pgpPublicKey = await openpgp.readKey({ armoredKey: publicKey });
             decryptionOptions.verificationKeys = pgpPublicKey;
         }
-        const { data: decrypted } = await openpgp.decrypt(decryptionOptions);
+        const { data: decrypted, signatures } = await openpgp.decrypt(decryptionOptions);
+        /**
+         * There is an option to automatically verify signatures - `expectSigned`,
+         * but atm it has a bug - https://github.com/openpgpjs/openpgpjs/issues/1803,
+         * so we have to verify it manually till it's fixed.
+         */
+        try {
+            if (shouldVerifySignature) {
+                await signatures[0].verified;
+            }
+        }
+        catch {
+            throw new Error('Signature could not be verified');
+        }
         return decrypted;
     }
     /**
@@ -404,12 +428,14 @@ class EncryptionUtils {
      * ```
      */
     static async encrypt(message, publicKeys) {
-        const plaintext = message;
         const pgpPublicKeys = await Promise.all(publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey })));
-        const pgpMessage = await openpgp.createMessage({ text: plaintext });
+        const pgpMessage = await openpgp.createMessage({
+            binary: makeMessageDataBinary(message),
+        });
         const encrypted = await openpgp.encrypt({
             message: pgpMessage,
             encryptionKeys: pgpPublicKeys,
+            format: 'armored',
         });
         return encrypted;
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "files": [
     "src",
     "dist"

package/src/encryption.ts

@@ -1,6 +1,16 @@
 import * as openpgp from 'openpgp';
 import { IKeyPair } from './interfaces';
 
+type MessageDataType = string | Uint8Array;
+
+function makeMessageDataBinary(message: MessageDataType): Uint8Array {
+  if (typeof message === 'string') {
+    return Buffer.from(message);
+  }
+
+  return message;
+}
+
 /**
  * ## Introduction
  *
@@ -126,20 +136,21 @@ export class Encryption {
    * ```
    */
   public async signAndEncrypt(
-    message: string,
+    message: MessageDataType,
     publicKeys: string[]
   ): Promise<string> {
-    const plaintext = message;
-
     const pgpPublicKeys = await Promise.all(
       publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey }))
     );
 
-    const pgpMessage = await openpgp.createMessage({ text: plaintext });
+    const pgpMessage = await openpgp.createMessage({
+      binary: makeMessageDataBinary(message),
+    });
     const encrypted = await openpgp.encrypt({
       message: pgpMessage,
       encryptionKeys: pgpPublicKeys,
       signingKeys: this.privateKey,
+      format: 'armored',
     });
 
     return encrypted as string;
@@ -176,23 +187,43 @@ export class Encryption {
    * const resultMessage = await encription.decrypt('message');
    * ```
    */
-  public async decrypt(message: string, publicKey?: string): Promise<string> {
-    const pgpMessage = await openpgp.readMessage({ armoredMessage: message });
+  public async decrypt(
+    message: string,
+    publicKey?: string
+  ): Promise<Uint8Array> {
+    const pgpMessage = await openpgp.readMessage({
+      armoredMessage: message,
+    });
 
     const decryptionOptions: openpgp.DecryptOptions = {
       message: pgpMessage,
       decryptionKeys: this.privateKey,
-      expectSigned: !!publicKey,
+      format: 'binary',
     };
 
-    if (publicKey) {
+    const shouldVerifySignature = !!publicKey;
+    if (shouldVerifySignature) {
       const pgpPublicKey = await openpgp.readKey({ armoredKey: publicKey });
       decryptionOptions.verificationKeys = pgpPublicKey;
     }
 
-    const { data: decrypted } = await openpgp.decrypt(decryptionOptions);
+    const { data: decrypted, signatures } =
+      await openpgp.decrypt(decryptionOptions);
+
+    /**
+     * There is an option to automatically verify signatures - `expectSigned`,
+     * but atm it has a bug - https://github.com/openpgpjs/openpgpjs/issues/1803,
+     * so we have to verify it manually till it's fixed.
+     */
+    try {
+      if (shouldVerifySignature) {
+        await signatures[0].verified;
+      }
+    } catch {
+      throw new Error('Signature could not be verified');
+    }
 
-    return decrypted as string;
+    return decrypted as Uint8Array;
   }
 
   /**
@@ -419,19 +450,20 @@ export class EncryptionUtils {
    * ```
    */
   public static async encrypt(
-    message: string,
+    message: MessageDataType,
     publicKeys: string[]
   ): Promise<string> {
-    const plaintext = message;
-
     const pgpPublicKeys = await Promise.all(
       publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey }))
     );
 
-    const pgpMessage = await openpgp.createMessage({ text: plaintext });
+    const pgpMessage = await openpgp.createMessage({
+      binary: makeMessageDataBinary(message),
+    });
     const encrypted = await openpgp.encrypt({
       message: pgpMessage,
       encryptionKeys: pgpPublicKeys,
+      format: 'armored',
     });
 
     return encrypted as string;