Команда diagnostics#

• Общая информация
• Формат ссылки
• Получение параметров операции
• Отправка сведений о рабочем месте
• Интерфейс IDiagnosticsParameters
• Тип IDiagnosticOperation
• Интерфейс IDiagnosticsOperationProps
• Интерфейс IDiagnosticsInformation
• Интерфейс ISystemInformation
• Интерфейс IVersions
• Интерфейс IProviders
• Интерфейс ILicenses
• Интерфейс ILicenseInfo
• LicenseType Enum

Общая информация#

Команда diagnostics используется для диагностики рабочего места пользователя. Схема взаимодействия:ката или списка сертификатов, а импорта сертификата в локальное хранилище, просмотра информации о сертификате.

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

В качестве транспорта используется HTTP.

🔍 Общее описание указано в разделе Формат ссылки.

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

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

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

• cryptoarm:// - зарегистрированный протокол
• diagnostics - выполняемая команда
• <URL> - ссылка, на которую КриптоАРМ будет слать запросы
• id - уникальный идентификатор транзакции

Пример:

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

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

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

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

Пример:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

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

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

Пример ответа:

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

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": ["CSP_ENABLED", "LICENSES", "VERSIONS"],
        "props": {
            "headerText": "Диагностика cryptoarm.ru",
            "descriptionText": "Выполняется диагностика рабочего места для работы на портале"
        }
    },
    "id": "2c48eb32-a0a8-405c-ade9-eed130605cba"
}

Отправка сведений о рабочем месте#

Полученные сведения отправляется 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

Content-Type: application/json
Content-Length: ...
Accept: application/json
{
  "jsonrpc": "2.0",
  "method": "diagnostics.information",
  "params": {
    "id": "2c48eb32-a0a8-405c-ade9-eed130605cba",
    "CSP_ENABLED": true,
    "LICENSES": {
      "csp": {
        "status": true,
      },
      "cryptoarm": {
        "status": true,
        "type": "temporary",
        "expiration": "1591689487056",
      }
    },
    "VERSIONS": {
      "csp": "5.0.11753",
      "cryptoarm": "2.5.2",
    }
  }
}

Интерфейс IDiagnosticsParameters#

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

Тип IDiagnosticOperation#

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

Интерфейс IDiagnosticsOperationProps#

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

Интерфейс IDiagnosticsInformation#

Объекты данного типа описывают объекты, содержащие сведения о рабочем месте.

Интерфейс ISystemInformation#

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

Интерфейс IVersions#

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

Интерфейс IProviders#

Объекты данного типа описывают доступность ГОСТ-провайдеров.

Интерфейс ILicenses#

Объекты данного типа описывают статусы лицензии КриптоАРМ и КритпоПро CSP.

Интерфейс ILicenseInfo#

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

LicenseType Enum#

Данное перечисление описывает возможные типы лицензий.