Команда signAndEncrypt

Запросы на подпись и шифрование документов, выполнение обратных операций

Команда signAndEncrypt (подпись и шифрование) используется для запроса на подпись документа или пакета документов. Может использоваться в качестве аутентификатора.

Выполнение операции требует действующей лицензии на КриптоАРМ.

Формат ссылки

Для выполнения команды signAndEncrypt должна быть сформирована ссылка вида:

cryptoarm://<command>/<URL>/?id=<id>

• cryptoarm:// - зарегистрированный протокол

• <command> - выполняемая команда

• <URL> - ссылка на получение JSON с параметрами, нужными для выполнения команды

• ?id=<id> - обязательный параметр. Идентификатор транзакции.

Пример:

cryptoarm://signAndEncrypt/https://example.com/json?id=2c48eb32-a0a8-405c-ade9-eed130605cba

Описание запросов и ответов

Все запросы между КриптоАРМ и сервером ДОЛЖНЫ соответствовать спецификации протокола JSON-RPC 2.0. В качестве транспорта используется HTTP. Общее описание указано в разделе Формат ссылки.

Получение параметров операции

После получения команды signAndEncrypt КриптоАРМ отправляет запрос на <URL> для получения параметров операции.

Формат запроса

Пример:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

Content-Type: application/json
Content-Length: ...
Accept: application/json
{
    "jsonrpc": "2.0",
    "method": "signAndEncrypt.parameters",
    "id": "2c48eb32-a0a8-405c-ade9-eed130605cba",
    "diagnostic": {
    }
}

Формат ответа

Пример:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

HTTP/1.1 200 OK
Connection: close
Content-Length: ...
Content-Type: application/json
Date: Sat, 08 Jul 2020 12:04:08 GMT
{
    "jsonrpc": "2.0",
    "result": {
        "operation": [
            "SIGN",
            "ARCHIVE",
            "ENCRYPT"
        ],
        "props": {
            "headerText": "Подпись документов cryptoarm.ru",
            "license": "",
            "files": [{
                    "name": "file1.txt",
                    "url": "http://localhost:8080/public/files/file1.txt",
                    "id": 1,
                    "urlDetached": ""
                },
                {
                    "name": "file2.txt",
                    "url": "http://localhost:8080/public/files/file2.txt",
                    "id": 2,
                    "urlDetached": ""
                },
                {
                    "name": "file4.pdf",
                    "url": "http://localhost:8080/public/files/file4.pdf",
                    "id": 4,
                    "urlDetached": ""
                }
            ],
            "extra": {
                "token": "9c7101f7-9c47-4481-b4da-a6a497abde08",
                "signType": "1",
                "signStandart": "1"
            },
            "uploader": "http://localhost:8080/upload"
        }
    },
    "id": "2c48eb32-a0a8-405c-ade9-eed130605cba"
}

Отправка результата прямых операций

После того, как пользователь выберет нужные сертификаты КриптоАРМ выполняет операцию. Полученные файлы отправляется POST-запросом. Используются нотификации (уведомления), для которых не требуется ответ сервера.

Формат запроса

Пример:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

Content-Type: application/json
Content-Length: ...
Accept: application/json
{
    "jsonrpc": "2.0",
    "method": "signAndEncrypt.outDirectResults",
    "params": {
        "id": "2c48eb32-a0a8-405c-ade9-eed130605cba",
        "directResults": [
          {
            "id": 2
        "out": "MIIWgQYJKoZIhvcNAQcCoIIWcjCCFm4CA…cN/aHmA="
          }
        ]
    }
}

Отправка результата обратных операций

Результаты отправляется POST-запросом. Используются нотификации (уведомления), для которых не требуется ответ сервера.

Формат запроса

Пример:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

Content-Type: application/json
Content-Length: ...
Accept: application/json
{
    "jsonrpc": "2.0",
    "method": "signAndEncrypt.outReverseResults",
    "params": {
        "id": "2c48eb32-a0a8-405c-ade9-eed130605cba",
        "reverseResults": [
          {
            "out": "MIIWgQYJKoZIhvcNAQcCoIIWcjCCFm4CA…cN/aHmA="
          }
        ]
    }
}

Отправка результата проверки подписи

Результаты проверки подписи отправляется POST запросом. Используются нотификации (уведомления), для которых не требуется ответ сервера.

Формат запроса

Пример:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

Content-Type: application/json
Content-Length: ...
Accept: application/json
{
    "jsonrpc": "2.0",
    "method": "signAndEncrypt.verifySignResults",
    "params": {
        "id": "2c48eb32-a0a8-405c-ade9-eed130605cba",
        "verifyResults": [
          {
            "id": 2,
            "status": false,
            "signers": [
              {
                "hash": "MIIFFDCCBMGgAwIBAgIQTm1HiybyfWV",
                "issuerFriendlyName": "Минкомсвязь России",
                "issuerName": "Минкомсвязь России",
                "subjectFriendlyName ": "Минкомсвязь России",
                "subjectName": "Минкомсвязь России",
                "status": true
              }
             ]
          }
        ]
    }
}

Интерфейс ISignAndEncryptParameters

Объекты данного типа описывают вид операции и её параметры.

Тип ISignAndEncryptOperationDirect

Возможные прямые операции.

Тип ISignAndEncryptOperationReverse

Возможные обратные операции.

Тип ISignAndEncryptOperationVerify

Проверка подписи.

Интерфейс ISignAndEncryptOperationProps

Интерфейс ISignAndEncryptOperationProps описывает параметры операции.

Интерфейс IFile

Интерфейс IFile описывает файлы и ссылки на них.

Интерфейс IExtra

Интерфейс IExtra описывает настройки операции.

Если параметр не задан, то пользователю доступен выбор из всех доступных в приложении значений.

Интерфейс IDirectResults

Объекты данного типа описывают результаты прямой операции.

Интерфейс IDirectResultOut

Объекты данного типа содержат результаты прямой операции для файла.

Интерфейс IReverseResults

Объекты данного типа описывают результаты обратной операции.

Интерфейс IReverseResultOut

Объекты данного типа описывают результаты обратной операции.

Интерфейс IVerifySignResults

Объекты данного типа описывают результаты проверки подписи.

Интерфейс IVerifySignResult

Объекты данного типа описывают результаты проверки подписи.

Интерфейс ISignerStatus

Объекты данного типа описывают сведения о подписчиках.

Интерфейс ILocalResultParams

Объекты данного типа используется только в параметрах локального API.

Содержат пути для сохранения результатов операций.

Интерфейс ISignStampAppearance

Интерфейс ISignStampAppearance описывает параметры для штампа PDF.

Интерфейс IMockupSettings

Интерфейс IMockupSettings описывает параметры внешнего вида штампа.

Интерфейс IRequisitesSettings

Интерфейс IRequisitesSettings описывает содержимое (реквизиты) штампа подписи.

Интерфейс IPdfCertRequisite

Интерфейс IPdfCertRequisite описывает свойства для реквизита штампа.

Интерфейс IPdfMarkedArea

Интерфейс IPdfMarkedArea описывает параметры для расположения области штампа PDF (координаты и размеры).