Classes

NCALayerError: Класс ошибок NCALayerError.
NCALayerClient: Класс клиента NCALayer.

NCALayerError

Класс ошибок NCALayerError.

Kind: global class

NCALayerClient

Класс клиента NCALayer.

Kind: global class

NCALayerClient
- new NCALayerClient([url])
- instance
  - .connect() ⇒ Promise.<String>
  - .basicsSign(allowedStorages, format, data, signingParams, signerParams, locale) ⇒ Promise.<String>
  - .basicsSignCMS(allowedStorages, data, signingParams, signerParams, [locale]) ⇒ Promise.<String>
  - .basicsSignXML(allowedStorages, data, signingParams, signerParams, [locale]) ⇒ Promise.<String>
  - .getActiveTokens() ⇒ Promise.<Array.<String>>
  - .getKeyInfo(storageType) ⇒ Promise.<Object>
  - .createCAdESFromBase64(storageType, data, [keyType], [attach]) ⇒ Promise.<String>
  - .createCAdESFromBase64Hash(storageType, hash, [keyType]) ⇒ Promise.<String>
  - .createCAdESFromFile(storageType, filePath, [keyType], [attach]) ⇒ Promise.<String>
  - .createCMSSignatureFromBase64(storageType, data, [keyType], [attach]) ⇒ Promise.<String>
  - .createCMSSignatureFromFile(storageType, filePath, [keyType], [attach]) ⇒ Promise.<String>
  - .signXml(storageType, xml, [keyType], [tbsElementXPath], [signatureParentElementXPath]) ⇒ Promise.<String>
  - .signXmls(storageType, xmls, [keyType], [tbsElementXPath], [signatureParentElementXPath]) ⇒ Promise.<Array.<String>>
  - .showFileChooser([fileExtension], [currentDirectory]) ⇒ Promise.<String>
  - .changeLocale(localeId)
- static

new NCALayerClient([url])

Конструктор.

Param	Type	Default	Description
[url]	`String`	`'wss://127.0.0.1:13579'`	опциональный URL для подключения к NCALayer.

(async) ncaLayerClient.connect() ⇒ `Promise.<String>`

Подключиться к NCALayer.

Kind: instance method of NCALayerClient
Returns: Promise.<String> - версию NCALayer.
Throws:

NCALayerError

(async) ncaLayerClient.basicsSign(allowedStorages, format, data, signingParams, signerParams, locale) ⇒ `Promise.<String>`

Вычислить подпись под данными с указанными параметрами. Новая функция sign 2022 года из модуля kz.gov.pki.knca.basics (https://github.com/pkigovkz/sdkinfo/wiki/KNCA-Basics-Module). Сигнатура функции сложная, поэтому рекомендуем пользоваться функциями помощниками basicsSignXLM и basicsSignCMS.

Kind: instance method of NCALayerClient
Returns: Promise.<String> - подпись.
Throws:

NCALayerError

Param	Type	Description
allowedStorages	`Array`	массив строк с константами допустимых для использования типов хранилищ (см. константы basicsStorage*).
format	`String`	тип вычисляемой подписи: 'xml', либо 'cms'.
data	`String`	подписываемые данные.
signingParams	`Object`	параметры подписания (см. basicsCMSParams* и basicsXMLParams*).
signerParams	`Object`	параметры выбора сертификата для подписания (см. константы basicsSigner*).
locale	`String`	язык пользовательского интерфейса.

(async) ncaLayerClient.basicsSignCMS(allowedStorages, data, signingParams, signerParams, [locale]) ⇒ `Promise.<String>`

Вычислить CMS подпись под данными с указанными параметрами, это функция-помощник для упрощения работы с функцией basicsSign.

Kind: instance method of NCALayerClient
Returns: Promise.<String> - подпись.
Throws:

NCALayerError

Param	Type	Default	Description
allowedStorages	`Array`		массив строк с константами допустимых для использования типов хранилищ (см. константы basicsStorage*).
data	`String` \| `ArrayBuffer` \| `Array`		данные, которые нужно подписать, в виде строки Base64 либо ArrayBuffer. Так же поддерживается массив строк Base64 или ArrayBuffer, но это будет работать только с приложениями KAZTOKEN mobile/desktop, NCALayer не умеет подписывать массив документов.
signingParams	`Object`		параметры подписания (см basicsCMSParams*).
signerParams	`Object`		параметры выбора сертификата для подписания (см. константы basicsSigner*).
[locale]	`String`	`'ru'`	язык пользовательского интерфейса.

(async) ncaLayerClient.basicsSignXML(allowedStorages, data, signingParams, signerParams, [locale]) ⇒ `Promise.<String>`

Вычислить XML подпись под данными с указанными параметрами, это функция-помощник для упрощения работы с функцией basicsSign.

Kind: instance method of NCALayerClient
Returns: Promise.<String> - подпись.
Throws:

NCALayerError

Param	Type	Default	Description
allowedStorages	`Array`		массив строк с константами допустимых для использования типов хранилищ (см. константы basicsStorage*).
data	`String`		подписываемые данные.
signingParams	`Object`		параметры подписания (см basicsXMLParams*).
signerParams	`Object`		параметры выбора сертификата для подписания (см. константы basicsSigner*).
[locale]	`String`	`'ru'`	язык пользовательского интерфейса.

(async) ncaLayerClient.getActiveTokens() ⇒ `Promise.<Array.<String>>`

Получить список активных типов устройств.

Kind: instance method of NCALayerClient
Returns: Promise.<Array.<String>> - массив содержащий типы хранилищ экземпляры которых доступны в данный момент.
Throws:

NCALayerError

(async) ncaLayerClient.getKeyInfo(storageType) ⇒ `Promise.<Object>`

Получить информацию об одной записи (ключевой паре с сертификатом).

Kind: instance method of NCALayerClient
Returns: Promise.<Object> - объект с информацией о записи.
Throws:

NCALayerError

Param	Type	Description
storageType	`String`	тип хранилища на экземплярах которого следует искать записи.