Портал документации Рутокен

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Для управления СКЗИ через API убедитесь, что в Мастере настройки в разделе Журнал учета СКЗИ включена опция Вести журнал учета СКЗИ. 

При работе с СКЗИ через API вам доступны следующие операции:

GET /Skzi

Возвращает список объектов skzi record.

ПараметрОбязательно/необязательноОписание
objectTypeНеобязательноТип объекта:
  • Distributive — дистрибутив;
  • License — лицензия;
  • Documentation — документация;
  • KeyDocument — ключевой документ;
  • Card — ключевой носитель;
  • Custom — пользовательский
skziTypeIdНеобязательноИдентификатор типа СКЗИ
serialNumberНеобязательноСерийный номер СКЗИ
instanceNumberНеобязательноНомер экземпляра
stateНеобязательноСостояние:
  • Created — изготовлено;
  • Assigned — назначено;
  • Sent — передано;
  • Returned — возвращено;
  • Issued — выдано;
  • Installed — установлено;
  • Destructed/Withdrawn — уничтожено/изъято
userNameНеобязательноИмя пользователя в формате Common Name
startDateНеобязательноПоиск СКЗИ с указанной даты
endDateНеобязательноПоиск СКЗИ до указанной даты
offsetНеобязательноСдвиг на указанное количество записей СКЗИ
countНеобязательноКоличество СКЗИ для вывода в ответе
ПараметрОписание
idИдентификатор СКЗИ
timeCreatedВремя изготовления СКЗИ
userIdИдентификатор пользователя
userNameИмя пользователя в формате Common Name
logonNameИмя учетной записи пользователя в формате DOMAIN\LogonName
objectTypeТип объекта:
  • Distributive — дистрибутив;
  • License — лицензия;
  • Documentation — документация;
  • KeyDocument — ключевой документ;
  • Card — ключевой носитель;
  • Custom — пользовательский
skziTypeIdИдентификатор типа СКЗИ
serialNumberСерийный номер СКЗИ
instanceNumberНомер экземпляра
creationDataОбъект с информацией об изготовлении СКЗИ:
  • creator — имя изготовителя;
  • timeCreated — время изготовления;
  • docNumber — номер документа об изготовлении
sendingDataОбъект с информацией о передаче СКЗИ:
  • docNumber — номер сопроводительного письма;
  • recipient — ФИО сотрудника, который подтверждает получение СКЗИ;
  • timeSent — время передачи;
  • timeConfirmed — время подтверждения получения;
  • confirmationDocNumber — номер документа о подтверждении получения
returnDataОбъект с информацией о возврате СКЗИ:
  • docNumber — номер сопроводительного письма;
  • timeReturned — время возврата;
  • timeConfirmed — время подтверждения получения СКЗИ;
  • confirmationDocNumber — номер документа о подтверждении получения
issueDataОбъект с информацией о выдаче СКЗИ:
  • docNumber — номер сопроводительного письма;
  • timeIssued — время выдачи
installationDataОбъект с информацией об установке СКЗИ:
  • docNumber — номер документа об установке;
  • installer — ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших установку СКЗИ;
  • timeInstalled — время установки;
  • hardwareId — номер аппаратного средства, на котором установлено или к которому подключено СКЗИ;
  • location — место установки
destructionDataОбъект с информацией об уничтожении/изъятии СКЗИ:
  • destructor — ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших уничтожение/изъятие СКЗИ;
  • timeDestructed — время уничтожения/изъятия;
  • docNumber — номер акта или расписки об уничтожении
commentПримечание
customFieldsОбъект с информацией о дополнительных полях в журнале учета СКЗИ;
  • id — идентификатор атрибута, который подставляется в шаблоны печати нормативных документов;
  • value — имя поля, которое отображается в журнале СКЗИ.

Дополнительные поля задаются в Мастере настройки Rutoken KeyBox в разделе Журнал учета СКЗИ
stateСостояние СКЗИ:
  • Created — изготовлено;
  • Assigned — назначено;
  • Sent — передано;
  • Returned — возвращено;
  • Issued — выдано;
  • Installed — установлено;
  • Destructed/Withdrawn — уничтожено/изъято

Пример запроса

http://localhost/keybox/api/Object?type=Distributive&state=Installed&offset=0&count=5 — вывод 5 записей СКЗИ типа объекта Дистрибутив в состоянии Installed (установлено).

POST /Skzi

Позволяет добавить СКЗИ в Rutoken KeyBox.

ПараметрОбязательно/необязательноОписание
objectTypeОбязательноТип объекта:
  • Distributive — дистрибутив;
  • License — лицензия;
  • Documentation — документация;
  • KeyDocument — ключевой документ;
  • Card — ключевой носитель;
  • Custom — пользовательский
skziTypeIdОбязательноИдентификатор типа СКЗИ
serialNumberОбязательноСерийный номер СКЗИ
instanceNumberНеобязательноНомер экземпляра
docNumberНеобязательноНомер документа, на основании которого добавляется СКЗИ. Если номер документа не указан, то номер генерируется по шаблону, настроенному для конкретного типа СКЗИ в разделе Конфигурация→СКЗИ→Нормативные документы
creationDateНеобязательноВремя создания документа. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время

Пример тела запроса

{
  "objectType": "Distributive",
  "skziType": "3",
  "serialNumber": "0578393357",
  "instanceNumber": "4",
  "docNumber": "35",
  "creationDate": "2024-11-12T15:24:41.979Z"
}

GET /Skzi/Types

Возвращает список значений skziType – список типов СКЗИ.

ПараметрОбязательно/необязательноОписание
skziTypeNameНеобязательноНазвание типа СКЗИ
familyНеобязательноСемейство СКЗИ:
  • Hardware — аппаратный;
  • Software — программный;
  • HardwareSoftware — аппаратно-программный
includeArchivedНеобязательно
  • true — включить в возвращаемые значения информацию об СКЗИ архивных типов;
  • false — не включать в возвращаемые значения информацию об СКЗИ архивных типов.

Значение по умолчанию — false

ПараметрОписание
idИдентификатор СКЗИ
skziTypeNameНазвание типа СКЗИ
familyСемейство СКЗИ:
  • Hardware — аппаратный;
  • Software — программный;
  • HardwareSoftware — аппаратно-программный
conformityCertificateИнформация о сертификате соответствия на СКЗИ:
  • number — номер;
  • issueDate — дата выдачи;
  • notAfter — дата окончания срока действия
supportCertificateИнформация о сертификате технической поддержки:
  • number — номер;
  • issueDate — дата выдачи;
  • notAfter — дата окончания срока действия
cardTypeNameНазвание типа устройства. Параметр отображается только для СКЗИ аппаратных типов
cardTypeModelНазвание модели устройства. Параметр отображается только для устройств Рутокен и JaCarta, если в разделе Типы СКЗИ настроены типы СКЗИ для различных моделей
isDefault
  • true — тип СКЗИ, используемый по умолчанию (для программных СКЗИ);
  • false — тип СКЗИ, не используемый по умолчанию
isArchived
  • true — архивный тип СКЗИ;
  • false — действующий тип СКЗИ

Пример запроса

http://localhost/keybox/api/Skzi/Types?skziTypeName=JaCarta%20PKI&family=Hardware&includeArchived=false — вывод списка действующих СКЗИ аппаратного типа JaCarta PKI.

GET /Skzi/<id>

Возвращает объект skzi record по его идентификатору.

Параметры запроса: id — идентификатор СКЗИ.

ПараметрОписание
idИдентификатор СКЗИ
timeCreatedВремя изготовления СКЗИ
userIdИдентификатор пользователя
userNameИмя пользователя в формате Common Name
logonNameИмя учетной записи пользователя
objectTypeТип объекта:
  • Distributive — дистрибутив;
  • License — лицензия;
  • Documentation — документация;
  • KeyDocument — ключевой документ;
  • Card — ключевой носитель;
  • Custom — пользовательский
skziTypeIdИдентификатор типа СКЗИ
serialNumberСерийный номер СКЗИ
instanceNumberНомер экземпляра
creationDataОбъект с информацией об изготовлении СКЗИ:
  • creator — имя изготовителя;
  • timeCreated — время изготовления;
  • docNumber — номер документа об изготовлении
sendingDataОбъект с информацией о передаче СКЗИ:
  • docNumber — номер сопроводительного письма;
  • recipient — ФИО сотрудника, который подтверждает получение СКЗИ;
  • timeSent — время передачи;
  • timeConfirmed — время подтверждения получения;
  • confirmationDocNumber — номер документа о подтверждении получения
returnDataОбъект с информацией о возврате СКЗИ:
  • docNumber — номер сопроводительного письма;
  • timeReturned — время возврата;
  • timeConfirmed — время подтверждения получения СКЗИ;
  • confirmationDocNumber — номер документа о подтверждении получения
issueDataОбъект с информацией о выдаче СКЗИ:
  • docNumber — номер сопроводительного письма;
  • timeIssued — время выдачи
installationDataОбъект с информацией об установке СКЗИ:
  • docNumber — номер документа об установке;
  • installer — ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших установку СКЗИ;
  • timeInstalled — время установки;
  • hardwareId  — номер аппаратного средства, на котором установлено или к которому подключено СКЗИ;
  • location — место установки
destructionDataОбъект с информацией об уничтожении/изъятии СКЗИ:
  • destructor — ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших уничтожение/изъятие СКЗИ;
  • timeDestructed — время уничтожения/изъятия;
  • docNumber — номер акта или расписки об уничтожении
commentПримечание
customFieldsОбъект с информацией о дополнительных полях в журнале учета СКЗИ:
  • id — идентификатор атрибута, который подставляется в шаблоны печати нормативных документов;
  • value — имя поля, которое отображается в журнале СКЗИ.

Дополнительные поля задаются в Мастере настройки Rutoken KeyBox в разделе Журнал учета СКЗИ
stateСостояние СКЗИ:
  • Created — изготовлено;
  • Assigned — назначено;
  • Sent — передано;
  • Returned — возвращено;
  • Issued — выдано;
  • Installed — установлено;
  • Destructed/Withdrawn — уничтожено/изъято


Пример запроса

http://localhost/keybox/api/Skzi/1 – вывод записи СКЗИ с идентификатором 1.

PUT /Skzi/<id>/Assign

Позволяет назначить СКЗИ на пользователя.

ПараметрОбязательно/необязательноОписание
idОбязательноИдентификатор СКЗИ
userNameОбязательноИмя пользователя в формате Common Name или имя учетной записи пользователя в формате DOMAIN\LogonName или User principal name (UPN)

Пример запроса

http://localhost/keybox/api/Skzi/8/assign?userName=evgeniy.belov%40demo.com  —  назначить СКЗИ с идентификатором 8 на пользователя evgeniy.belov@demо.cоm.

PUT /Skzi/<id>

Позволяет перевести СКЗИ из текущего состояния в следующие состояния по жизненному циклу. Перед изменением состояния СКЗИ рекомендуем назначить СКЗИ на пользователя.

СКЗИ может находиться в следующих состояниях: Created (изготовлено), Assigned (назначено), Sent (передано), Returned (возвращено), Issued (выдано), Installed (установлено), Destructed/Withdrawn (уничтожено/изъято).

Возможности изменения состояний СКЗИ:

  • Created или Assigned можно перевести в Sent, Returned, Issued, Installed;
  • Sent можно перевести в Returned, Issued, Installed;
  • Returned можно перевести в Issued, Installed;
  • Issued можно перевести в Installed.

СКЗИ в состоянии Destructed/Withdrawn нельзя перевести в другое состояние — оно завершает свой жизненный цикл. СКЗИ в состоянии Installed можно только уничтожить/изъять.

Состояние Sent должно передаваться во всех запросах на изменение состояния СКЗИ. Например, нельзя перевести СКЗИ из состояния Created в Installed, если в теле запроса нет параметра sendingData.


ОбъектПараметрОписание
id
Идентификатор СКЗИ




sendingData — информация о передаче СКЗИ		recipientФИО сотрудника, который подтверждает получение СКЗИ
timeSentВремя отправления документа. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время
timeConfirmedВремя подтверждения получения. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время
confirmУкажите значение:
  • true, чтобы сформировать документ, подтверждающий получение СКЗИ;
  • false, чтобы документ, подтверждающий получение СКЗИ, не формировался
confirmationDocNumberНомер документа о подтверждении получения СКЗИ. Если номер документа не указан, то номер генерируется по шаблону, настроенному для конкретного типа СКЗИ в разделе Конфигурация→СКЗИ→Нормативные документы
returnData — информация о возврате СКЗИtimeReturnedВремя возврата СКЗИ. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время
timeConfirmedВремя подтверждения получения СКЗИ. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время
confirmУкажите значение:
  • true, чтобы сформировать документ о подтверждении получения СКЗИ;
  • false, чтобы не формировать документ о подтверждении получения СКЗИ
confirmationDocNumberНомер документа о подтверждении получения СКЗИ. Если номер документа не указан, то номер генерируется по шаблону, настроенному для конкретного типа СКЗИ в разделе Конфигурация→СКЗИ→Нормативные документы
issueData — информация о выдаче СКЗИtimeIssuedВремя выдачи СКЗИ. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время
installationData — информация об установке СКЗИinstallerФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших установку СКЗИ. Имена указываются в формате Common name через запятую
timeInstalledВремя установки СКЗИ. Указывается в формате yyyyMMddHHmmss (UTC). Если значение не указано, то подставляется текущее время
hardwareIdНомер аппаратного средства, на котором установлено или к которому подключено СКЗИ
locationМесто установки СКЗИ
comment
Примечание
customFieldsidИдентификатор атрибута, который подставляется в шаблоны печати нормативных документов
valueОтображаемое имя поля в журнале СКЗИ
Пример тела запроса для перевода СКЗИ из Created в Installed
{
  "sendingData": {
    "recipient": "evgeniy.belov@demo.com",
    "timeSent": "2024-11-11T14:24:16.641Z",
    "timeConfirmed": "2024-11-11T14:24:16.641Z",
    "confirm": true,
    "confirmationDocNumber": "3"
},
  "installationData": {
    "installer": "Никифорова Ольга Петровна",
    "timeInstalled": "2024-11-11T14:24:16.641Z",
    "hardwareId": "PF3N9LFM",
    "location": "г. Москва, ул. Примерная, д. 9, каб. 368"
  },
}

В примере тела запроса для перевода СКЗИ из состояния Created в Installed пропущены состояния Returned и Issued. Если вам необходимо внести информацию об СКЗИ в состояниях Returned и Issued, вы можете прописать значения параметров returnData и issueData в теле запроса:

"sendingData": {
    "recipient": "evgeniy.belov@demo.com",
    "timeSent": "2024-11-11T14:24:16.641Z",
    "timeConfirmed": "2024-11-11T14:24:16.641Z",
    "confirm": true,
    "confirmationDocNumber": "4"
  },
  "returnData": {
    "timeReturned": "2024-12-04T16:11:05.247Z",
    "timeConfirmed": "2024-12-04T16:11:05.247Z",
    "confirm": true,
    "confirmationDocNumber": "5"
  },
  "issueData": {
    "timeIssued": "2024-12-04T16:11:05.247Z"
  },
  "installationData": {
    "installer": "Никифорова Ольга Петровна",
    "timeInstalled": "2024-11-11T14:24:16.641Z",
    "hardwareId": "PF3N9LFM",
    "location": "г. Москва, ул. Примерная, д. 9, каб. 368"
  }

DELETE /Skzi/<id>

Позволяет уничтожить/изъять СКЗИ.

ПараметрОбязательно/необязательноОписание
idОбязательноИдентификатор СКЗИ
reuseНеобязательно

Укажите значение:

  • true, чтобы изъять СКЗИ у пользователя и использовать повторно – например, для другого пользователя;
  • false, чтобы уничтожить СКЗИ.

Значение по умолчанию — false

destructorНеобязательно

ФИО сотрудников органа криптографической защиты, пользователей СКЗИ, производивших уничтожение/изъятие СКЗИ.

Имена указываются в формате Common name через запятую

timeDestructedНеобязательно

Время уничтожения/изъятия. Указывается в формате yyyyMMddHHmmss (UTC).

Если значение не указано, то подставляется текущее время

Пример запроса

http://localhost/keybox/api/Skzi/5?reuse=false&destructor=evgeniy.belov%40demo.com — уничтожить СКЗИ с идентификатором 5. Пользователь, производивший уничтожение – evgeniy.belov@dеmo.com.

  • No labels