@it-enterprise/digital-signature 1.2.2 → 1.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@it-enterprise/digital-signature",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "digital signature",
   "private": false,
   "main": "src/index.js",
@@ -18,4 +18,4 @@
     "@babel/eslint-parser": "^7.18.9",
     "eslint": "^7.18.0"
   }
-}
+}

package/readme.md

@@ -68,6 +68,11 @@ import {
 
 Инициализация библиотеки
 ```javascript
+import {
+  DigitalSignature,
+  Models
+} from "@it-enterprise/digital-signature";
+
 const ds = new DigitalSignature(
   new Models.DefaultSettingProvider(
     "uk", // Язык ошибок (строка, или функция, возвращающая строку)
@@ -80,20 +85,22 @@ const currentKeyType = await ds.initialise();
 Сменить тип библиотеки
 ```javascript
 /** Подпись файловыми ключами, через облачные сервисы  */
-export const DigitalSignatureLibraryTypeJS = 0;
+const DigitalSignatureLibraryTypeJS = 0;
 /** Подпись аппартными ключами */
-export const DigitalSignatureLibraryTypeSW = 1;
+const DigitalSignatureLibraryTypeSW = 1;
 /**
  * Типы библиотеки
  */
-export const DigitalSignatureLibraryType = {
+enum DigitalSignatureLibraryType = {
   /** Подпись файловыми ключами и через облачные сервисы */
   JS: DigitalSignatureLibraryTypeJS,
   /** Подпись аппартными ключами */
   SW: DigitalSignatureLibraryTypeSW
 };
 
-await ds.setLibraryType(type);
+import { Models } from "@it-enterprise/digital-signature";
+
+await ds.setLibraryType(Models.DigitalSignatureLibraryType.JS);
 ```
 
 # Центры сертификации ключей
@@ -116,6 +123,8 @@ const needCerts = ds.needPrivateKeyCertificates();
 ```  
 Структура объекта CASettings
 ```javascript
+import { EUSignCP.CASettings } from "@it-enterprise/digital-signature";
+
 class CASettings {
     // Названия ЦСК (обычно используется первое из списка)
     issuerCNs: Array<string>;
@@ -212,12 +221,15 @@ const ksps = ds.KSPs;
 
 ```javascript
 class KSPSettings {
+    // Идентификатор
+    id: string;
     // Название провайдера
     name: string;
     // Провайдер работает через QR код или через ID пользователя
     needQRCode: boolean;
     // Тип ID пользователя (имя пользователя/телефон/email)
     clientIdType?: EndUserKSPClientIdType;
+    // Тип провайдера
     ksp: EndUserKSP;
     address?: string;
     port?: string;
@@ -228,6 +240,36 @@ class KSPSettings {
     pollingInterval?: number;
     systemId?: string;
 }
+import { EUSignCP.KSPSettings } from "@it-enterprise/digital-signature";
+
+// Тип провайдера облачных ключей
+enum EndUserKSP = {
+  // DepositSign, ESign, Вчасно
+  IIT
+  // SmartID, CloudKey
+  PB
+  // Дія.Підпис
+  DIIA
+  // Подписание ключами с Гряды через сервис подписи
+  GRYADA
+}
+import { Models.EndUserKSP } from "@it-enterprise/digital-signature";
+
+// Тип ID пользователя
+enum EndUserKSPClientIdType = {
+  // По умолчанию
+  Default,
+  // Имя пользователя
+  Name,
+  // Номер телефона
+  Phone,
+  // Email
+  Email,
+  // Имя пользователя и пароль (2 поля)
+  NamePassword
+}
+import { Models.EndUserKSPClientIdType } from "@it-enterprise/digital-signature";
+
 ```
 
 Для ключей, работающих через QR код, после инициализации библиотеки нужно подписаться на событие подтверждения операции  
@@ -245,6 +287,7 @@ ds.addConfirmKSPOperationEventListener(eventArgs => { ... });
 
 Структура объекта, приходящего в коллбек события  
 ```javascript
+// Аргументы события
 class EndUserConfirmKSPOperationEvent {
     // Ссылка на подтверждение операции
     url: string;
@@ -255,6 +298,8 @@ class EndUserConfirmKSPOperationEvent {
     // Время, до которого действует ссылка
     expireDate: Date;
 }
+import { EUSignCP.EndUserEvents.EndUserConfirmKSPOperationEvent } from "@it-enterprise/digital-signature";
+
 ```
 QR код нужно отобразить пользовтелю, что бы он мог отсканировать его в приложении и подтвердить подписание  
 Для отображения QR кода можно использовать содержимое поля qrCode, либо сгенерировать его на основе ссылки из поля url  
@@ -276,7 +321,9 @@ const keyInfo = await ds.readPrivateKeyKSP(
   // Получать информацию о сертификатах пользователя
   // true - поля ownerInfo и certificates в keyInfo будут заполены, но пользователю нужно будет подтвердить дополнительную операцию подписания
   // false - поля ownerInfo и certificates в keyInfo будут пустыми, но пользователь не получит дополнительный запрос на подписание
-  getCerts = false);
+  getCerts = false,
+  // Пароль пользователя, если clientIdType == NamePassword
+  keyID = null);
 ```
 
 
@@ -327,6 +374,7 @@ class EndUserSignContainerInfo {
     // Тип подписи в ASiC контейнере (только для ASiC контейнеров)
     asicSignType: EndUserASiCSignType;
 }
+import { EUSignCP.EndUserSignContainerInfo } from "@it-enterprise/digital-signature";
 ```
 Типы контейнеров подписи
 ```javascript
@@ -344,6 +392,7 @@ enum EndUserSignContainerType {
     // Контейнер для подписей в виде ZIP-архива
     ASiC
 }
+import { EUSignCP.EndUserConstants.EndUserSignContainerType } from "@it-enterprise/digital-signature";
 ```
 Типы подписей CAdES
 ```javascript
@@ -355,6 +404,7 @@ enum EndUserCAdESType {
     // Подпись в одном контейнере с данными (внутренняя подпись)
     Enveloped
 }
+import { EUSignCP.EndUserConstants.EndUserCAdESType } from "@it-enterprise/digital-signature";
 ```
 Типы подписей XAdES
 ```javascript
@@ -363,9 +413,10 @@ const EU_XADES_TYPE_ENVELOPED = 3;
 enum EndUserXAdESType {
     // Подпись отдельно от данных (внешняя подпись)
     Detached,
-    // Подпись в одном контейнере с данными (внутренняя подпись)
+    // Подпись в одном контейнере с данными (внутренняя подпись) !! Данные могут быть только в формате XML !!
     Enveloped
 }
+import { EUSignCP.EndUserConstants.EndUserXAdESType } from "@it-enterprise/digital-signature";
 ```
 Типы контейнеров ASiC
 ```javascript
@@ -377,6 +428,7 @@ enum EndUserASiCType {
     // Расширенный контейнер, может содержать несколько файлов с данными и несколько подписей
     E
 }
+import { EUSignCP.EndUserConstants.EndUserASiCType } from "@it-enterprise/digital-signature";
 ```
 Типы подписей, которые могут содержаться в ASiC контейнере
 ```javascript
@@ -386,6 +438,7 @@ enum EndUserASiCSignType {
     CAdES,
     XAdES
 }
+import { EUSignCP.EndUserConstants.EndUserASiCSignType } from "@it-enterprise/digital-signature";
 ```
 
 Пример использования формата подписи:
@@ -435,6 +488,7 @@ declare type NamedData = {
     // В качестве возвращаемого результата: контейнер с подписью
     val: string | Uint8Array;
 };
+import { EUSignCP.NamedData } from "@it-enterprise/digital-signature";
 ```
 Пример использования формата именованных данных
 ```javascript

package/src/DigitalSignature.js

@@ -1,6 +1,6 @@
 import { EndUser, EndUserConstants, EndUserProxySettings, EndUserError, KSPSettings, EndUserCertificate, EndUserKeyMedia, EndUserSignContainerInfo } from "../euscp/euscp";
-import { DigitalSignatureKeyType, PrivateKeyInfo, FilePrivateKeyInfo, HardwarePrivateKeyInfo, KspPrivateKeyInfo } from "./Models";
-import { downloadAndSignFiles, downloadData, format, readFile, signAlgoToHashAlgo } from "./Utils";
+import { DigitalSignatureKeyType, PrivateKeyInfo, FilePrivateKeyInfo, HardwarePrivateKeyInfo, KspPrivateKeyInfo, EndUserKSP } from "./Models";
+import { downloadAndSignFiles, downloadData, format, isDefaultValue, readFile, signAlgoToHashAlgo } from "./Utils";
 import Resourses from "./Resourses.json";
 import GlSign from "./GlSign";
 
@@ -31,85 +31,8 @@ export default class DigitalSignature {
     /** @type {CASettings} */
     this._selectedCA = null;
 
-    const depositsign = new KSPSettings();
-    depositsign.name = "DepositSign";
-    depositsign.ksp = EndUserConstants.EU_KSP_IIT;
-    depositsign.address = "https://depositsign.com/api/v1/it-enterprise/sign-server";
-    depositsign.directAccess = true;
-    depositsign.needQRCode = false;
-
-    const diia = new KSPSettings();
-    diia.name = "Дія.Підпис";
-    diia.ksp = EndUserConstants.EU_KSP_DIIA;
-    diia.directAccess = true;
-    diia.mobileAppName = "Дія";
-    diia.address = "https://diia-sign.it.ua/KSPSign";
-    diia.systemId = "diia-sign-it-ent";
-    diia.needQRCode = true;
-
-    const smartId = new KSPSettings();
-    smartId.name = "Приватбанк - хмарний підпис \"SmartID\"";
-    smartId.ksp = EndUserConstants.EU_KSP_PB;
-    smartId.directAccess = true;
-    smartId.mobileAppName = "Приват24";
-    smartId.address = "https://acsk.privatbank.ua/cloud/api/back/";
-    smartId.clientIdPrefix = "IEIS_";
-    smartId.confirmationURL = "https://www.privat24.ua/rd/kep";
-    smartId.needQRCode = true;
-
-    const vchasno = new KSPSettings();
-    vchasno.name = "Вчасно - хмарний підпис";
-    vchasno.ksp = EndUserConstants.EU_KSP_IIT;
-    vchasno.address = "https://cs.vchasno.ua/ss/";
-    vchasno.directAccess = true;
-    vchasno.needQRCode = false;
-
-    const cloudKey = new KSPSettings();
-    cloudKey.name = "ТОВ «ЦСК «Україна» - хмарний підпис CloudKey";
-    cloudKey.ksp = EndUserConstants.EU_KSP_PB;
-    cloudKey.directAccess = true;
-    cloudKey.mobileAppName = "CloudKey";
-    cloudKey.address = "https://sid.uakey.com.ua/smartid/iit/";
-    cloudKey.clientIdPrefix = "DIIA_2";
-    cloudKey.confirmationURL = "https://sid.uakey.com.ua/kep?hash=rd/kep";
-    cloudKey.needQRCode = true;
-
-    const esign = new KSPSettings();
-    esign.name = "ESign - хмарний підпис";
-    esign.ksp = EndUserConstants.EU_KSP_IIT;
-    esign.address = "https://cabinet.e-life.com.ua/api/EDG/Sign";
-    esign.directAccess = true;
-    esign.needQRCode = false;
-
-    const idd = new KSPSettings();
-    idd.name = "ІДД ДПС - хмарний підпис";
-    idd.ksp = EndUserConstants.EU_KSP_IIT;
-    idd.address = "https://smart-sign.tax.gov.ua/";
-    idd.port = "443";
-    idd.directAccess = true;
-    idd.clientIdType = 1;
-    idd.needQRCode = false;
-
-    this._KSPs = {
-      depositsign,
-      diia,
-      smartId,
-      vchasno,
-      cloudKey,
-      esign,
-      idd,
-      asArray: function() {
-        return [
-          depositsign,
-          diia,
-          smartId,
-          vchasno,
-          cloudKey,
-          esign,
-          idd
-        ];
-      }
-    };
+    /** @type {KSPSettings} */
+    this._KSPs = [];
 
     /** @type {PrivateKeyInfo} */
     this._readedKey = null;
@@ -508,7 +431,8 @@ export default class DigitalSignature {
      * @param {boolean?} getCerts - Получать информацию о ключе пользователя. Это приведёт к дополнительному запросу на подписание
      */
   async readPrivateKeyDepositsign(userId, getCerts = false) {
-    return await this.readPrivateKeyKSP(userId, this._KSPs.depositsign, getCerts);
+    var deposit = this.KSPs.find(ksp => ksp.id === "depositsign");
+    return await this.readPrivateKeyKSP(userId, deposit, getCerts);
   }
 
   /**
@@ -516,7 +440,8 @@ export default class DigitalSignature {
    * @param {boolean?} getCerts - Получать информацию о ключе пользователя. Это приведёт к дополнительному запросу на подписание
    */
   async readPrivateKeyDiia(getCerts = false) {
-    return await this.readPrivateKeyKSP(null, this.KSPs.diia, getCerts);
+    var diia = this.KSPs.find(ksp => ksp.id === "diia-sign");
+    return await this.readPrivateKeyKSP(null, diia, getCerts);
   }
 
   /**
@@ -525,14 +450,14 @@ export default class DigitalSignature {
    * @param {string?} userId - Идентификатор пользователя
    * @param {boolean?} getCerts - Получать информацию о ключе пользователя. Это приведёт к дополнительному запросу на подписание
    */
-  async readPrivateKeyKSP(ksp, userId, getCerts = false) {
+  async readPrivateKeyKSP(ksp, userId, getCerts = false, keyId) {
     await this.setLibraryType(DigitalSignatureKeyType.KSP);
 
     if (ksp.ksp === EndUserConstants.EU_KSP_DIIA) {
-      await this._diiaCheckAccess();
+      await this._diiaCheckAccess(ksp);
     }
 
-    const ownerInfo = await this._euSign.ReadPrivateKeyKSP(userId, ksp.name, getCerts);
+    const ownerInfo = await this._euSign.ReadPrivateKeyKSP(userId, ksp.name, getCerts, keyId);
     if (getCerts && !ownerInfo) {
       throw {
         code: EndUserError.EU_ERROR_KEY_MEDIAS_READ_FAILED,
@@ -544,7 +469,8 @@ export default class DigitalSignature {
       ownerInfo,
       getCerts ? await this._euSign.GetOwnCertificates() : [],
       userId,
-      ksp
+      ksp,
+      keyId
     );
     return this._readedKey;
   }
@@ -570,7 +496,7 @@ export default class DigitalSignature {
    * @returns {KSPSettings[]} Список поддержирживаемых облачных провайдеров
    */
   get KSPs() {
-    return this._KSPs.asArray();
+    return this._glSign.KSPs;
   }
 
   /**
@@ -632,7 +558,7 @@ export default class DigitalSignature {
       signType = new EndUserSignContainerInfo();
       signType.type = EndUserConstants.EndUserSignContainerType.CAdES;
       signType.subType = EndUserConstants.EndUserCAdESType.Enveloped;
-    } else if (typeof signType != "object") {
+    } else if (isDefaultValue(signType)) {
       // По умолчанию создаётся подпись CAdES Detached
       signType = new EndUserSignContainerInfo();
       signType.type = EndUserConstants.EndUserSignContainerType.CAdES;
@@ -1033,7 +959,7 @@ export default class DigitalSignature {
         key = new HardwarePrivateKeyInfo(key.keyType, key.ownerInfo, key.certificates, key.keyMedia);
       }
       else if (key.keyType == DigitalSignatureKeyType.KSP) {
-        key = new KspPrivateKeyInfo(key.keyType, key.ownerInfo, key.certificates, key.userId, key.ksp);
+        key = new KspPrivateKeyInfo(key.keyType, key.ownerInfo, key.certificates, key.userId, key.ksp, key.keyId);
       }
       const certs = [];
       key.certificates.forEach(cert => {
@@ -1110,11 +1036,11 @@ export default class DigitalSignature {
   /**
    * Проверка доступности Дiя
    */
-  async _diiaCheckAccess() {
+  async _diiaCheckAccess(ksp) {
     const diia = "DIIA";
     if (sessionStorage[diia] != "+") {
       try {
-        sessionStorage[diia] = await downloadData(new URL(this._KSPs.diia.address).origin + "/diia");
+        sessionStorage[diia] = await downloadData(new URL(ksp.address).origin + "/diia");
       } catch {
         throw {
           code: EndUserError.EU_ERROR_TRANSMIT_REQUEST,

package/src/GlSign.js

@@ -1,4 +1,7 @@
 /* eslint-disable no-magic-numbers */
+
+import { getDefaultKSPs } from "./Models";
+
 /**
  * ПГУ GlSign
  */
@@ -68,6 +71,24 @@ export default class GlSign {
     this.AgentSignWeb = this._getZoneValue(settingArray, 21) === "+";
     this.TestCAConnection = this._getZoneValue(settingArray, 22) === "+";
     this.DontSaveToRegistry = this._getZoneValue(settingArray, 23) === "+";
+
+    var ksps = this._getZoneValue(settingArray, 24);
+    if (!ksps) {
+      this.KSPs = getDefaultKSPs();
+    } else {
+      try {
+        ksps = Buffer.from(ksps, "base64").toString();
+        this.KSPs = JSON.parse(ksps);
+      } catch (error) {
+        console.error("error parsing KSPs from GlSign");
+        console.error(error);
+      }
+      
+      if (!this.KSPs || this.KSPs.length === 0)
+      {
+        this.KSPs = getDefaultKSPs();
+      }
+    }
   }
   _getZoneValue(zones, zone) {
     if (zones.length >= zone) {

package/src/Models.js

@@ -1,8 +1,8 @@
-import { EndUserCertificate, EndUserError, EndUserOwnerInfo, EndUserConstants } from "../euscp/euscp";
+import { EndUserCertificate, EndUserError, EndUserOwnerInfo, EndUserConstants, KSPSettings } from "../euscp/euscp";
 import GlSign from "./GlSign";
 import { downloadData, byteArrayToBase64, base64ToByteArray, signAlgoToHashAlgo, getSupportedSignAlgos } from "./Utils";
 
-const LIBRARY_VERSION = "1.3.53";
+const LIBRARY_VERSION = "1.3.54";
 
 /**
  * Параметры библиотеки электронной подписи
@@ -279,6 +279,26 @@ export const DigitalSignatureKeyType = {
   KSP: DigitalSignatureKeyTypeKSP,
 };
 
+export const EU_KSP_GRYADA	= -1;
+export const EU_KSP_IIT	= 4;
+export const EU_KSP_PB = 6;
+export const EU_KSP_DIIA = 7;
+
+export const EndUserKSP = {
+  IIT: EU_KSP_IIT,
+  PB: EU_KSP_PB,
+  DIIA: EU_KSP_DIIA,
+  GRYADA: EU_KSP_GRYADA
+}
+
+export const EndUserKSPClientIdType = {
+  Default: 0,
+  Name: 1,
+  Phone: 2,
+  Email: 3,
+  NamePassword: -1
+}
+
 export class PrivateKeyInfo {
   /**
    * @param {number} keyType - Тип ключа
@@ -403,9 +423,77 @@ export class KspPrivateKeyInfo extends PrivateKeyInfo {
    * @param {string} userId - Идентификатор пользователя
    * @param {EndUserKSP} ksp - Объект KSP
    */
-  constructor(keyType, ownerInfo, certificates, userId, ksp) {
+  constructor(keyType, ownerInfo, certificates, userId, ksp, keyId) {
     super(keyType, ownerInfo, certificates, userId, userId);
     this.userId = userId;
     this.ksp = ksp;
+    this.keyId = keyId;
   }
 }
+
+export function getDefaultKSPs() {
+  const depositsign = new KSPSettings();
+  depositsign.id = "depositsign";
+  depositsign.name = "DepositSign";
+  depositsign.ksp = EndUserConstants.EU_KSP_IIT;
+  depositsign.address = "https://depositsign.com/api/v1/it-enterprise/sign-server";
+  depositsign.directAccess = true;
+  depositsign.needQRCode = false;
+
+  const diia = new KSPSettings();
+  diia.id = "diia-sign";
+  diia.name = "Дія.Підпис";
+  diia.ksp = EndUserConstants.EU_KSP_DIIA;
+  diia.directAccess = true;
+  diia.mobileAppName = "Дія";
+  diia.address = "https://diia-sign.it.ua/KSPSign";
+  diia.systemId = "diia-sign-it-ent";
+  diia.needQRCode = true;
+
+  const smartId = new KSPSettings();
+  smartId.id = "pb-smartid";
+  smartId.name = "Приватбанк - хмарний підпис \"SmartID\"";
+  smartId.ksp = EndUserConstants.EU_KSP_PB;
+  smartId.directAccess = true;
+  smartId.mobileAppName = "Приват24";
+  smartId.address = "https://acsk.privatbank.ua/cloud/api/back/";
+  smartId.clientIdPrefix = "IEIS_";
+  smartId.confirmationURL = "https://www.privat24.ua/rd/kep";
+  smartId.needQRCode = true;
+
+  const vchasno = new KSPSettings();
+  vchasno.id = "vchasno";
+  vchasno.name = "Вчасно - хмарний підпис";
+  vchasno.ksp = EndUserConstants.EU_KSP_IIT;
+  vchasno.address = "https://cs.vchasno.ua/ss/";
+  vchasno.directAccess = true;
+  vchasno.needQRCode = false;
+
+  const cloudKey = new KSPSettings();
+  cloudKey.id = "cloudkey";
+  cloudKey.name = "ТОВ «ЦСК «Україна» - хмарний підпис CloudKey";
+  cloudKey.ksp = EndUserConstants.EU_KSP_PB;
+  cloudKey.directAccess = true;
+  cloudKey.mobileAppName = "CloudKey";
+  cloudKey.address = "https://sid.uakey.com.ua/smartid/iit/";
+  cloudKey.clientIdPrefix = "DIIA_2";
+  cloudKey.confirmationURL = "https://sid.uakey.com.ua/kep?hash=rd/kep";
+  cloudKey.needQRCode = true;
+
+  const esign = new KSPSettings();
+  esign.id = "esign";
+  esign.name = "ESign - хмарний підпис";
+  esign.ksp = EndUserConstants.EU_KSP_IIT;
+  esign.address = "https://cabinet.e-life.com.ua/api/EDG/Sign";
+  esign.directAccess = true;
+  esign.needQRCode = false;
+
+  return [
+    depositsign,
+    diia,
+    smartId,
+    vchasno,
+    cloudKey,
+    esign
+  ];
+}

package/src/Utils.js

@@ -232,3 +232,7 @@ export async function downloadAndSignFiles(fileUrl, signFunc) {
     return returnNamedData ? sign : (sign.val || sign);
   }
 }
+
+export function isDefaultValue(value) {
+  return value === false || value === null || typeof value === "undefined";
+}