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

Compare with Current View Page History

« Previous Version 7 Next »

Устанавливает параметры операций проверки (создания) ЭЦП (МВ), которые используются в контексте определенной сессии.
Доступны следующие параметры, которые относятся к операциям ЭЦП и МВ:

  • тип ЭЦП
  • признак включения метки времени данных
  • признак включения метки времени ЭЦП
  • порядок включения сертификатов подписанта и издателей
  • режим проверки метки времени цифровой подписи
  • режим проверки метки времени данных
  • признак выполнения дополнительной проверки метки времени
  • описатель данных, которые необходимо подписать
  • признак возможности подписания документа несколько раз одним и тем же подписантом
URL-адрес запроса

https://localhost:9092/api/v1/ticket/{uuid}/option

Метод

PUT

Параметры запроса
uuidStringИдентификатор сессии
Настраиваемые заголовки запроса
Content-Typeapplication/json
Параметры JSON объекта запроса
ИмяТипОписаниеДопустимые значения
signatureTypeStringТип ЭЦПattached - встроенная ЭЦП, ЭЦП хранится вместе с подписанными данными
* detached - открепленная ЭЦП, ЭЦП хранится отдельно от подписанных данных
embedSignatureTsStringПризнак включения метки времени ЭЦП

true - встраивать метку времени ЭЦП
* false - не встраивать метку времени ЭЦП

При установке параметра cadesType в значение, отличное от  "undefined", значения параметра embedSignatureTs игнорируется.

embedDataTsStringПризнак включения метки времени данных

true - встраивать метку времени даных
* false - не встраивать метку времени данных

При установке параметра cadesType в значение, отличное от  "undefined", значения параметра embedDataTs игнорируется.

embedCertificateTypeStringПорядок включения сертификатов подписанта и издателей

signerCert - добавлять только сертификат подписанта
signerAndCaCert - добавлять сертификат подписанта и сертификаты издателей
signerCertAndCaInfo - добавлять сертификат подписанта и информацию про сертификаты издателей (сами сертификаты издателей не добавляются)
* nothing - не добавлять сертификаты

При установке параметра cadesType в значение, отличное от  "undefined", значения параметра embedCertificateType игнорируется.

signatureTsVerifyOptionStringРежим проверки метки времени цифровой подписи

* ignore - игнорировать метку времени
verifyIfPresent - проверять метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять метку времени и возвращать ошибку, если она отсутствует

dataTsVerifyOptionStringРежим проверки метки времени данных * ignore - игнорировать метку времени
verifyIfPresent - проверять метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять метку времени и возвращать ошибку, если она отсутствует

tsAdditionalVerifying

String

Признак выполнения дополнительной проверки метки времени

true - выполнять дополнительную проверку меток времени ЭЦП и данных при проверке ЭЦП для предоставления дополнительной информации в ответе
* false - не выполнять дополнительную проверку меток времени при проверке ЭЦП

dataToSignQualifier

StringОписатель данных, которые необходимо подписать* notSignedBefore - данные не содержат ранее созданную подпись
alreadySigned - данные уже содержат подпись, для добавления новой будет использован режим множественной подписи

duplicateSign

StringПризнак возможности подписания документа несколько раз одним и тем же подписантом

true - добавляет новую подпись, даже если документ уже был подписан подписантом
* false - новая подпись не добавляется, если документ уже был подписан подписантом

cadesTypeStringФормат вырабатываемой электронной подписи стандарта CAdES

* undefined - параметр cadesType не учитывается при выработке электронной подписи
CAdESBES - базовая цифровая подпись.
CAdESC - цифровая подпись, содержащая метку времени от цифровой подписи и ссылки на полный набор данных для проверки
CAdESEPES - базовая цифровая подпись с указанием политики цифровой подписи
CAdEST - цифровая подпись, содержащая метку времени от цифровой подписи
CAdESXLong - цифровая подпись, содержащая метку времени от цифровой подписи и полный набор данных для проверки.

При установке параметра cadesType в значение, отличное от  "undefined", значения параметров embedSignatureTs, embedDataTs, embedCertificateType игнорируются.

* - значение по умолчанию

Ответ
Код ответаContent-typeДопустимые параметрыПример содержимого
200application/json
message
settedOptions : {
    signatureType, 
    signatureTsVerifyOption,
    dataTsVerifyOption,
    embedSignatureTs,
    embedDataTs,
    embedCertificateType,
    dataToSignQualifier,
    duplicateSign
}
{
    "message": "Запрос на установку настроек сессии выполнен.",
    "settedOptions": {
       "signatureTsVerifyOption": "IGNORE",
       "embedSignatureTs": "false",
       "embedCertificateType": "NOTHING",
       "signatureType": "DETACHED",
       "dataTsVerifyOption": "IGNORE",
       "embedDataTs": "false",
       "dataToSignQualifier": "ALREADY_SIGNED",
       "duplicateSign": "true"
    }
}
503application/jsonmessage
{
    "message" : "Сервис хранения данных не запущен." 
}
400application/jsonmessage
{
    "message" : "Сессия отсутствует." 
}
Параметры JSON объекта ответа
ПараметрТип данныхОписание
messageStringОписание результата проведения операции
settedOptions
ObjectПараметры и их значения, которые были установлены после выполнения запроса
Пример кода на JavaScript + jQuery 2.2.4
var selectedOptions = {
    signatureType: "detached",
    embedCertificateType: "nothing",
    embedSignatureTs: "false",
    embedDataTs: "false",
    signatureTsVerifyOption: "ignore",
    dataTsVerifyOption: "ignore"
};
$.ajax({
    url: "https://localhost:9092/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/option",
    type: "PUT",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify(selectedOptions)
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
    settedOptions = jsonResponse.settedOptions;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при установке настроек сессии." : xhr.responseText;
    }
})



  • No labels