WebUnitClient | @pkic/web-unit-sdk

Клиент для Web Unit SDK.

Hierarchy

WebUnitClient

Constructors

constructor

new WebUnitClient(): WebUnitClient

Returns WebUnitClient

Properties

Static checkConnectivityTimeout

checkConnectivityTimeout: number = 10000

Таймаут проверки возможности соединения с Web Unit (в миллисекундах)

Static defaultExtension

defaultExtension: string = '.doc'

Расширение обрабатываемых файлов по умолчанию

Static httpBaseUrl

httpBaseUrl: string = 'http://127.0.0.1:61111/webhost'

URL Web Unit для подключения по протоколу HTTP

Static httpsBaseUrl

httpsBaseUrl: string = 'https://127.0.0.1:61112/webhost'

URL Web Unit для подключения по протоколу HTTPS

Methods

batchSign

batchSign(options: IBatchSignOptions): Promise<TWebUnitClientResponse<IBatchSignResponse>>

- Defined in WebUnitClient.ts:836
Пакетное подписание данных CMS-подписью.

Parameters
- options: IBatchSignOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IBatchSignResponse>>

batchSignXml

batchSignXml(options: IBatchSignXmlOptions): Promise<TWebUnitClientResponse<IBatchSignResponse>>

- Defined in WebUnitClient.ts:1172
Пакетная подпись XML-документов.

Parameters
- options: IBatchSignXmlOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IBatchSignResponse>>

checkConnection

checkConnection(): Promise<TWebUnitClientResponse<Record<string, any>>>

- Defined in WebUnitClient.ts:1240
Проверка возможности подключения к SDK

Returns Promise<TWebUnitClientResponse<Record<string, any>>>

decrypt

decrypt(options: IDecryptOptions): Promise<TWebUnitClientResponse<IDecryptResponse>>

- Defined in WebUnitClient.ts:939
Расшифрование данных размером не более 100 МБайт.

Parameters
- options: IDecryptOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IDecryptResponse>>

decryptAndVerifySign

decryptAndVerifySign(options: IDecryptAndVerifySignOptions): Promise<TWebUnitClientResponse<IDecryptAndVerifySignResponse>>

- Defined in WebUnitClient.ts:999
Расшифрование и проверка ЭП данных размером не более 100 МБайт.

Parameters
- options: IDecryptAndVerifySignOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IDecryptAndVerifySignResponse>>

encrypt

encrypt(options: IEncryptOptions): Promise<TWebUnitClientResponse<IEncryptResponse>>

- Defined in WebUnitClient.ts:913
Шифрование данных размером не более 100 МБайт.

Parameters
- options: IEncryptOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IEncryptResponse>>

generateCertificateRequest

generateCertificateRequest(options: IGenerateCertificateRequestOptions): Promise<TWebUnitClientResponse<IGenerateCertificateRequestResponse>>

- Defined in WebUnitClient.ts:778
Создание запроса на сертификат.

Parameters
- options: IGenerateCertificateRequestOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IGenerateCertificateRequestResponse>>

generatePseudoRandomSequence

generatePseudoRandomSequence(options: IPseudoRandomSequenceOptions): Promise<TWebUnitClientResponse<IGeneratePseudoRandomSequenceResponse>>

- Defined in WebUnitClient.ts:755
Сгенерировать псевдослучайную последовательность.

Parameters
- options: IPseudoRandomSequenceOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IGeneratePseudoRandomSequenceResponse>>

getCertificateList

getCertificateList(): Promise<TWebUnitClientResponse<IGetCertificateListResponse>>

- Defined in WebUnitClient.ts:1101
Получить список действительных сертификатов, которые можно использовать для формирования ЭП

Returns Promise<TWebUnitClientResponse<IGetCertificateListResponse>>

hash

hash(options: IHashOptions): Promise<TWebUnitClientResponse<IHashResponse>>

- Defined in WebUnitClient.ts:1041
Вычисление хэш-суммы данных.

Parameters
- options: IHashOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IHashResponse>>

hashFile

hashFile(options: IHashFileOptions): Promise<TWebUnitClientResponse<IHashFileResponse>>

- Defined in WebUnitClient.ts:1056
Вычисление хэш-суммы файла, размер которого превышает 80 Мбайт.

Parameters
- options: IHashFileOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IHashFileResponse>>

installCertificateIssuedByRequest

installCertificateIssuedByRequest(options: IInstallCertificateIssuedByRequestOptions): Promise<TWebUnitClientResponse<Record<string, any>>>

- Defined in WebUnitClient.ts:765
Установка сертификата, изданного удостоверяющм центром по ранее сделанному запросу.

Parameters
- options: IInstallCertificateIssuedByRequestOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<Record<string, any>>>

selectCertificate

selectCertificate(options: ISelectCertificateOptions): Promise<TWebUnitClientResponse<ISelectCertificateResponse>>

- Defined in WebUnitClient.ts:1023
Выбрать сертификат, с помощью которого будет выполняться подписание.

Parameters
- options: ISelectCertificateOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<ISelectCertificateResponse>>

sign

sign(options: ISignOptions): Promise<TWebUnitClientResponse<ISignResponse>>

- Defined in WebUnitClient.ts:802
Подписание данных размером до 100 МБайт.

Parameters
- options: ISignOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<ISignResponse>>

signAndEncrypt

signAndEncrypt(options: ISignAndEncryptOptions): Promise<TWebUnitClientResponse<ISignAndEncryptResponse>>

- Defined in WebUnitClient.ts:964
Подписание и шифрование данных размером не более 100 МБайт.

Parameters
- options: ISignAndEncryptOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<ISignAndEncryptResponse>>

signFile

signFile(options: ISignFileOptions): Promise<TWebUnitClientResponse<ISignFileResponse>>

- Defined in WebUnitClient.ts:1112
Подписание файла размером свыше 80 Мбайт.

Parameters
- options: ISignFileOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<ISignFileResponse>>

signXml

signXml(options: ISignXmlOptions): Promise<TWebUnitClientResponse<ISignXmlResponse>>

- Defined in WebUnitClient.ts:1133
Подписание данных в формате XML.

Parameters
- options: ISignXmlOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<ISignXmlResponse>>

specialSign01

specialSign01(options: ISpecialSign01Options): Promise<TWebUnitClientResponse<ISpecialSign>>

- Defined in WebUnitClient.ts:1071
Подписание данных. Возвращает ЭП в чистом виде (не в форме CMS-сообщения), а также хэш-сумму подписываемых данных.

Parameters
- options: ISpecialSign01Options
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<ISpecialSign>>

specialSignFile

specialSignFile(options: ISpecialSignFileOptions): Promise<TWebUnitClientResponse<ISpecialSign>>

- Defined in WebUnitClient.ts:1089
Подписание файла размером свыше 80 Мбайт. Возвращает ЭП в чистом виде (не в форме CMS-сообщения), а также хэш-сумму подписываемого файла.

Parameters
- options: ISpecialSignFileOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<ISpecialSign>>

specialSignHash

specialSignHash(options: ISpecialSignHashOptions): Promise<TWebUnitClientResponse<ISpecialSignHashResponse>>

- Defined in WebUnitClient.ts:1204
Подписание данных. Возвращает ЭП в чистом виде (не в форме CMS-сообщения).

Parameters
- options: ISpecialSignHashOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<ISpecialSignHashResponse>>

verifyFile

verifyFile(options: IVerifyFileOptions): Promise<TWebUnitClientResponse<IVerifySignResponse>>

- Defined in WebUnitClient.ts:889
Проверка ЭП файла.

Parameters
- options: IVerifyFileOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IVerifySignResponse>>

verifySign

verifySign(options: IVerifySignOptions): Promise<TWebUnitClientResponse<IVerifySignResponse>>

- Defined in WebUnitClient.ts:861
Проверка ЭП данных размером не более 100 МБайт.

Parameters
- options: IVerifySignOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IVerifySignResponse>>

verifySignedXml

verifySignedXml(options: IVerifySignedXmlOptions): Promise<TWebUnitClientResponse<IVerifySignResponse>>

- Defined in WebUnitClient.ts:1220
Проверка ЭП данных в формате XML.

Parameters
- options: IVerifySignedXmlOptions
  
  Параметры запроса.
Returns Promise<TWebUnitClientResponse<IVerifySignResponse>>

withByPass

withByPass(): WebUnitClient

- Defined in WebUnitClient.ts:746
Указать, что вызовы криптографических операций будут производиться в режиме "Без подтверждения".

Returns WebUnitClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns WebUnitClient

Properties

Static checkConnectivityTimeout

Static defaultExtension

Static httpBaseUrl

Static httpsBaseUrl

Methods

batchSign

Parameters

options: IBatchSignOptions

Returns Promise<TWebUnitClientResponse<IBatchSignResponse>>

batchSignXml

Parameters

options: IBatchSignXmlOptions

Returns Promise<TWebUnitClientResponse<IBatchSignResponse>>

checkConnection

Returns Promise<TWebUnitClientResponse<Record<string, any>>>

decrypt

Parameters

options: IDecryptOptions

Returns Promise<TWebUnitClientResponse<IDecryptResponse>>

decryptAndVerifySign

Parameters

options: IDecryptAndVerifySignOptions

Returns Promise<TWebUnitClientResponse<IDecryptAndVerifySignResponse>>

encrypt

Parameters

options: IEncryptOptions

Returns Promise<TWebUnitClientResponse<IEncryptResponse>>

generateCertificateRequest

Parameters

options: IGenerateCertificateRequestOptions

Returns Promise<TWebUnitClientResponse<IGenerateCertificateRequestResponse>>

generatePseudoRandomSequence

Parameters

options: IPseudoRandomSequenceOptions

Returns Promise<TWebUnitClientResponse<IGeneratePseudoRandomSequenceResponse>>

getCertificateList

Returns Promise<TWebUnitClientResponse<IGetCertificateListResponse>>

hash

Parameters

options: IHashOptions

Returns Promise<TWebUnitClientResponse<IHashResponse>>

hashFile

Parameters

options: IHashFileOptions

Returns Promise<TWebUnitClientResponse<IHashFileResponse>>

installCertificateIssuedByRequest

Parameters

options: IInstallCertificateIssuedByRequestOptions

Returns Promise<TWebUnitClientResponse<Record<string, any>>>

selectCertificate

Parameters

options: ISelectCertificateOptions

Returns Promise<TWebUnitClientResponse<ISelectCertificateResponse>>

sign

Parameters

options: ISignOptions

Returns Promise<TWebUnitClientResponse<ISignResponse>>

signAndEncrypt

Parameters

options: ISignAndEncryptOptions

Returns Promise<TWebUnitClientResponse<ISignAndEncryptResponse>>

signFile

Parameters

options: ISignFileOptions

Returns Promise<TWebUnitClientResponse<ISignFileResponse>>

signXml

Parameters

options: ISignXmlOptions

Returns Promise<TWebUnitClientResponse<ISignXmlResponse>>

specialSign01

Parameters