Типы данных REST-интерфейса КриптоПро SVS
SignedDocument
Объект содержит документ, ЭП которого необходимо проверить, и другие параметры запроса проверки подписи.
| Поле | Тип | Описаниe |
|---|---|---|
| SignatureType | SignatureType | Формат подписи проверяемого документа. Обязательный параметр. |
| Source | byte[] | Исходный документ. Используется только для проверки подписи формата GOST3410 и отделенной подписи форматов CMS и CAdES. |
| Certificate | byte[] | Сертификат подписанта. Используется только для проверки подписи формата GOST3410. |
| Content | byte[] | Подписанный документ или значение подписи для проверки. Обязательный параметр. |
| VerifyParams | Dictionary<VerifyParams, string> | Словарь дополнительных параметров проверки подписи. Необязательный параметр. |
| CertVerifiersPluginsIds | List<int> | Список идентификаторов плагинов для дополнительных проверок сертификата, используемого при подписи. Если CertVerifiersPluginsIds не передан в запросе или явно указан как NULL, то при проверке будут использоваться плагины, у которых CheckByDefaultRequired = true. Если CertVerifiersPluginsIds проинициализирован, то для проверки будут использованы плагины с указанными идентификаторами. Если список пустой — дополнительная проверка не выполняется. |
VerifyPackageRequest
Модель данных запроса пакетной проверки подписи. Аналогична SignedDocument, но предполагает, что содержимое документов будет передано через multipart-form.
| Поле | Тип | Описаниe |
|---|---|---|
| SignatureType | SignatureType | Формат подписи проверяемого документа. |
| Certificate | byte[] | Сертификат подписанта. Используется только для проверки подписи формата GOST3410. |
| VerifyParams | Dictionary<VerifyParams, string> | Словарь дополнительных параметров проверки подписи. Необязательный параметр. |
| CertVerifiersPluginsIds | List<int> | Список идентификаторов плагинов для дополнительных проверок сертификата, используемого при подписи. Если CertVerifiersPluginsIds не передан в запросе или явно указан как NULL, то при проверке будут использоваться плагины, у которых CheckByDefaultRequired = true. Если CertVerifiersPluginsIds проинициализирован, то для проверки будут использованы плагины с указанными идентификаторами. Если список пустой — дополнительная проверка не выполняется. |
VerifyPackageRawRequest
Модель данных с данными запроса на пакетную проверку подписи. В отличие от VerifyPackageRequest содержит в себе содержимое всех документов.
| Поле | Тип | Описаниe |
|---|---|---|
| Documents | List<VerifiedDocumentInfo> | Список сведений о документах, подпись (подписи) которых необходимо проверить. |
| CustomParams | VerifyPackageRequest | Данные запроса на пакетную проверку подписи. |
VerifiedDocumentInfo
Объект содержит информацию о документе, подпись (подписи) которого необходимо проверить.
| Поле | Тип | Описаниe |
|---|---|---|
| DocumentName | string | Имя документа. |
| DocumentContent | byte[] | Содержимое документа в виде массива байт. |
Certificate
Объект содержит информацию о сертификате, статус которого необходимо проверить.
| Поле | Тип | Описаниe |
|---|---|---|
| Content | byte[] | Сертификат. |
| CertVerifiersPluginsIds | List<int> | Список идентификаторов плагинов для дополнительных проверок сертификата, используемого при подписи. Если CertVerifiersPluginsIds не передан в запросе или явно указан как NULL, то при проверке будут использоваться плагины, у которых CheckByDefaultRequired = true. Если CertVerifiersPluginsIds проинициализирован, то для проверки будут использованы плагины с указанными идентификаторами. Если список пустой — дополнительная проверка не выполняется. |
VerificationResultRest
Объект содержит информацию о результате проверки ЭП или сертификата одного элемента в пакете.
| Поле | Тип | Описаниe |
|---|---|---|
| Message | string | Суммарная информация о результатах проверки подписи. |
| Result | bool | Результат проверки подписи или сертификата. |
| SignerCertificate | byte[] | Сертификат. |
| SignerCertificateInfo | Dictionary<CertificateInfoParams, string> | Набор сведений о сертификате подписанта. |
| SignatureInfo | Dictionary<SignatureInfoParams, String> | Дополнительные сведения о подписи. |
| AdditionalCertificateResult | List<CertificateVerificationResult> | Сведения о дополнительных проверках сертификата. |
| AdditionalCertificatesInfo | List<Dictionary<CertificateInfoParams, string>> | Сведения о других сертификатах. |
| AdditionalInfo | List<String> | Дополнительные сведения о проверке подписи. Например, о проверке доказательств ее подлинности или о соответствии сложному формату. |
VerificationResultPackageRest
Объект содержит результат проверки подписи пакета документов.
| Поле | Тип | Описаниe |
|---|---|---|
| Results | List<VerifiedDocument> | Список сведений о документах в пакете. |
| ResultsReportBase64 | String | Отчет о проверке подписи пакета документов в формате Base64. Результат будет возвращен только при наличии в запросе VerifyPackageRequest в параметре Dictionary<VerifyParams, string> флага VerifyReport. |
VerifiedDocument
Объект содержит сведения о проверяемом документе в пакете.
| Поле | Тип | Описаниe |
|---|---|---|
| SignedDocumentName | String | Имя подписанного документа (или файла подписи, если проверяется отсоединенная CMS-подпись) |
| OriginalDocumentName | String | Имя исходного документа (при проверке отсоединенной CMS-подписи). |
| SignatureType | SignatureType | SignatureType |
| VerificationTime | DateTime | Дата и время проверки, представленные в международном формате даты и времени (см. ISO 8601-1:2019). |
| VerificationResults | List<VerificationResultRest> | Результат проверки подписи одного документа в пакете. |
| SignatureDocumentHash | byte[] | Хэш-значение подписанного документа, исходного документа или файла подписи (для отсоединенной CMS-подписи), вычисленная с использованием алгоритма ГОСТ Р 34.11-2012 с длиной ключа 256 бит. |
VsPolicyRest
Объект содержит политику Сервиса Проверки Подписи.
| Поле | Тип | Описаниe |
|---|---|---|
| SignatureDescriptions | List<SignatureTypeDescription> | Форматы подписи, которые можно проверить. |
| CertificateVerifiers | List<CertificateVerifier> | Зарегистрированные плагины для дополнительных проверок сертификатов. |
CertificateVerificationResult
Сведения о дополнительных проверках сертификата.
| Поле | Тип | Описаниe |
|---|---|---|
| AssemblyName | string | Имя плагина, реализующего дополнительные проверки сертификата. |
| PluginDescription | string | Описание плагина, реализующего дополнительные проверки сертификата. |
| bResult | bool | Результат проверки сертификата. |
| ErrorsList | List<string> | Список ошибок при проверке сертификата. |
SignatureTypeDescription
Объект содержит описание поддерживаемых форматов подписи.
| Поле | Тип | Описаниe |
|---|---|---|
| SignatureType | SignatureType | Формат подписи. |
| FileExtensions | IList<string> | Связанные с форматом подписи расширения файлов. |
SignersInfo
Объект содержит сведения обо всех подписантах, а также дополнительную информацию о подписанном документе.
| Поле | Тип | Описаниe |
|---|---|---|
| SignerInfoList | IList<SignerInfo> | Информация о найденных подписях. |
| AdditionalInfo | AdditionalSignedDocumentInfo | Дополнительная информация о подписанном документе. |
SignerInfo
Класс описывает информацию о подписи в документе.
| Поле | Тип | Описаниe |
|---|---|---|
| Id | string | Идентификатор узла подписи. |
| ParentId | string | Идентификатор родительского узла подписи. |
| Index | int | Порядковый номер узла подписи. Порядковый номер начинается с 1. |
| SignerCertificateInfo | Dictionary<CertificateInfoParams, string> | Отображаемые данные о сертификате. |
AdditionalSignedDocumentInfo
| Поле | Тип | Описаниe |
|---|---|---|
| Content | byte[] | Содержимое присоединенной подписи в формате CMS. |
CertificateVerifier
| Поле | Тип | Описаниe |
|---|---|---|
| ID | int | Идентификатор плагина. |
| ClassName | string | Имя класса, который реализует интерфейс ISVSCertificateVerifier. |
| AssemblyName | string | Полный путь до файла со сборкой плагина. В качестве значения данного параметра можно указать полный путь до файла со сборкой, либо только имя dll-файла сборки, если плагин находится в следующей директории: <Путь установки>\Plugins\CertificatesVerifiers. |
| PluginDescription | string | Описание плагина, которое отображается на Веб-интерфейсе Сервиса Проверки Подписи. |
| CheckByDefaultRequired | bool | Использовать ли по умолчанию плагин для проверки сертификата. |
| Parameters | Dictionary<string, string> | Дополнительные настройки плагина. |