Работа с контейнерами

Описание и примеры представлены в разделе Жизненные циклы основных сущностей.

writeUserCertificate

GOST

PRO

GOST 2

writeUserCertificate

Записать пользовательский сертификат.

После успешной записи образовывается контейнер и идентификатор ключевой пары становится невалидным.

Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded.

Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

Примеры в разделе Создание контейнера с помощью команды writeUserCertificate.

Аргументы:

keyPairID

Тип: Integer

Идентификатор ключевой пары. Получить можно с помощью createKeyPair, getKeyPairList или deleteUserCertificate.

Примечание

Значение идентификатора не постоянно, но в рамках сессии не меняется.

cert

Тип: Array | String

Значение сертификата в формате X509 (может быть закодирован в PEM или DER, см. Поддержка PEM и DER форматов).

Результат:

Integer – идентификатор образованного контейнера.

generateUserSelfSignedCertificate

GOST

PRO

GOST 2

generateUserSelfSignedCertificate

Сгенерировать и записать самоподписанный пользовательский сертификат.

После успешной записи образовывается контейнер и идентификатор ключевой пары становится невалидным.

Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded.

Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

Примеры в разделе Создание контейнера с помощью команды generateUserSelfSignedCertificate.

Аргументы:

keyPairID

Тип: Integer

Идентификатор ключевой пары. Получить можно с помощью createKeyPair, getKeyPairList или deleteUserCertificate.

Примечание

Значение идентификатора не постоянно, но в рамках сессии не меняется.

dn

Тип: PlainObject

Объект, содержащий элементы ключ-значение. В качестве ключа задаются элементы типа String, а в качестве значения - String или массив из String, если необходимо установить несколько значений (см. Генерация запроса на квалифицированный сертификат).

exts

Тип: PlainObject

Расширения для включения в запрос. Формат аналогичен dn.

days

Тип: Integer

Срок действия сертификата в днях с момента выпуска.

Результат:

Integer – идентификатор образованного контейнера.

deleteUserCertificate

GOST

PRO

GOST 2

deleteUserCertificate

Удалить пользовательский сертификат.

После успешного удаления контейнер трансформируется в ключевую пару и идентификатор контейнера становится невалидным.

Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded.

Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

Аргументы:

contID

Тип: Integer

Идентификатор контейнера. Получить можно с помощью writeUserCertificate, generateUserSelfSignedCertificate или getContainerList.

Примечание

Значение идентификатора не постоянно, но в рамках сессии не меняется.

Результат:

Integer – идентификатор соответствующей ключевой пары.

deleteContainer

GOST

PRO

GOST 2

deleteContainer

Удалить контейнер.

Работает при состоянии аутентификации выше, чем JCWebClient2.Vars.AuthState.notBinded.

Текущее состояние аутентификации можно получить с помощью команды getLoggedInState.

Примеры в разделе Удаление контейнера.

Аргументы:

contID

Тип: Integer

Идентификатор контейнера. Получить можно с помощью writeUserCertificate, generateUserSelfSignedCertificate или getContainerList.

Примечание

Значение идентификатора не постоянно, но в рамках сессии не меняется.

getContainerList

GOST

PRO

GOST 2

getContainerList

Получить список контейнеров.

Работает при любом состоянии аутентификации.

Примеры в разделе Получение списков сущностей.

Аргументы:

tokenID

Тип: Integer

Идентификатор токена. Получается с помощью команды getAllSlots.

Примечание

Значение идентификатора не постоянно, но в рамках сессии не меняется.

filters (Необязательный)

Тип: PlainObject

Дополнительные параметры поиска.

Параметры:

serialNumber (Необязательный)

Тип: String

Серийный номер сертификата. В результат добавляются контейнеры, имеющие указанный серийный номер (регистр не учитывается).

issuerName (Необязательный)

Тип: String

Имя издателя. В результат добавляются контейнеры, имеющие указанную подстроку в имени издателя (регистр учитывается).

subjectName (Необязательный)

Тип: String

Имя субъекта. В результат добавляются контейнеры, имеющие указанную подстроку в имени субъекта (регистр учитывается).

Результат:

Array – массив из объектов со следующими параметрами:

id

Тип: Integer

Идентификатор контейнера.

description

Тип: String

Описание контейнера.

algorithm

Тип: String

Допустимые значения: JCWebClient2.Vars.KeyAlgorithm

Алгоритм.