myDSSSDK Documentation

Class DSSCertificates​Manager

public final class DSSCertificatesManager  

Класс для управления сертификатами в DSS со стороны SDK

Methods

create​Certificate(user:​dn:​template​Id:​ca​Id:​is​Client:​callback:​)

public static func createCertificate(
        user: DSSUser,
        dn: [String: String],
        templateId: String,
        caId: Int,
        isClient: Bool = false,
        callback: @escaping (_ result: Result<DSSCertificate, Error>) -> Void
    )  

Создание сертификата/запроса на сертификат

Перед выполнением user.isReadyToSign должен быть true

Parameters

user DSSUser

Пользователь, для которого нужно создать сертификат/запрос

dn [String:​ String]

Различительное имя субъекта в формате ["OID компонента имени": "Значение компонента имени"]

template​Id String

Идентификатор шаблона сертификата

ca​Id Int

Идентификатор обработчика УЦ

callback @escaping (_ result:​ Result<DSSCertificate, Error>) -> Void

Замыкание возвращает результат

result

Возвращает созданый запрос на сертификат или ошибку

list​Certificates(user:​callback:​)

public static func listCertificates(
        user: DSSUser,
        callback: @escaping (_ result: Result<[DSSCertificate], Error>) -> Void
    )  

Получение списка сертификатов и запросов на сертификат

Parameters

user DSSUser

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

callback @escaping (_ result:​ Result<[DSSCertificate], Error>) -> Void

Замыкание возвращает результат

result

Возвращает список или ошибку

delete​Certificate(user:​dss​Certificate​Id:​dss​Request​Id:​callback:​)

public static func deleteCertificate(
        user: DSSUser,
        dssCertificateId: String?,
        dssRequestId: String?,
        callback: @escaping (_ result: Result<Void, Error>) -> Void
    )  

Удаление сертификата / запроса на сертификат

Перед выполнением user.isReadyToSign должен быть true

Нужно передать либо dssCertificateId, либо dssRequestId:

  • Если передать dssCertificateId, то удалится сертификат, и связанный с ним запрос

  • Если передать dssRequestId, то удалится только запрос

Parameters

user DSSUser

Пользователь-владелец сертификата/запроса на сертификат

dss​Certificate​Id String?

Идентификатор удаляемого сертификата. Указывается, если нужно удалить сертификат

dss​Request​Id String?

Идентификатор удаляемого запроса на сертификат. Указывается, если нужно удалить запрос на сертификат

callback @escaping (_ result:​ Result<Void, Error>) -> Void

Замыкание возвращает результат

result

В случае успеха не возвращает ничего. Иначе — возвращает ошибку

set​Certificate(user:​content:​callback:​)

public static func setCertificate(
        user: DSSUser,
        content: Data,
        callback: @escaping (_ result: Result<Void, Error>) -> Void
    )  

Установка сертификата в DSS.

Перед выполнением user.isReadyToSign должен быть true

Parameters

user DSSUser

Пользователь-владелец сертификата/запроса на сертификат

content Data

Данные сертификата

callback @escaping (_ result:​ Result<Void, Error>) -> Void

Замыкание возвращает результат

result

В случае успеха не возвращает ничего. Иначе — возвращает ошибку

set​Certificate​Friendly​Name(user:​dss​Certificate​Id:​friendly​Name:​callback:​)

public static func setCertificateFriendlyName(
        user: DSSUser,
        dssCertificateId: String,
        friendlyName: String,
        callback: @escaping (_ result: Result<Void, Error>) -> Void
    )  

Установка имени сертификата для отображения

Parameters

user DSSUser

Пользователь-владелец сертификата

dss​Certificate​Id String

Идентификатор сертификата

friendly​Name String

Дружественное имя сертификата

callback @escaping (_ result:​ Result<Void, Error>) -> Void

Замыкание возвращает результат

result

В случае успеха не возвращает ничего. Иначе — возвращает ошибку

set​Default​Certificate(user:​dss​Certificate​Id:​callback:​)

public static func setDefaultCertificate(
        user: DSSUser,
        dssCertificateId: String,
        callback: @escaping (_ result: Result<Void, Error>) -> Void
    )  

Установка сертификата по умолчанию

Parameters

user DSSUser

Пользователь-владелец сертификата

dss​Certificate​Id String

Идентификатор сертификата

callback @escaping (_ result:​ Result<Void, Error>) -> Void

Замыкание возвращает результат

result

В случае успеха не возвращает ничего. Иначе — возвращает ошибку

revoke​Certificate(user:​dss​Certificate​Id:​revoke​At:​reason:​callback:​)

public static func revokeCertificate(
        user: DSSUser,
        dssCertificateId: String,
        revokeAt timestamp: TimeInterval? = nil,
        reason: CertificateRevokingReason = .unspecified,
        callback: @escaping (_ result: Result<Void, Error>) -> Void
    )  

Отзыв сертификата

Перед выполнением user.isReadyToSign должен быть true

Parameters

user DSSUser

Пользователь-владелец сертификата

dss​Certificate​Id String

Идентификатор сертификата

revoke​Time​Stamp

Время отзыва сертификата. Рекомендуем дополнительно закладывать 15 минут на сетевые запросы, обработку сервером и прочие операции. Если параметр не указан, то сертификат будет отозван немедленно.

reason Certificate​Revoking​Reason

Причина отзыва сертификата

callback @escaping (_ result:​ Result<Void, Error>) -> Void

Замыкание возвращает результат

result

В случае успеха не возвращает ничего. Иначе — возвращает ошибку

suspend​Certificate(user:​dss​Certificate​Id:​from:​to:​callback:​)

public static func suspendCertificate(
        user: DSSUser,
        dssCertificateId: String,
        from fromTimestamp: TimeInterval? = nil,
        to toTimestamp: TimeInterval,
        callback: @escaping (_ result: Result<Void, Error>) -> Void
    )  

Приостановка действия сертификата

Перед выполнением user.isReadyToSign должен быть true

Parameters

user DSSUser

Пользователь-владелец сертификата

dss​Certificate​Id String

Идентификатор сертификата

from​Timestamp Time​Interval?

Время начала приостановки действия сертификата. Рекомендуем дополнительно закладывать 15 минут на сетевые запросы, обработку сервером и прочие операции. Если параметр не задан, то действие сертификата будет приостановлено немедленно.

to​Timestamp Time​Interval

Время возобновления действия сертификата

callback @escaping (_ result:​ Result<Void, Error>) -> Void

Замыкание возвращает результат

result

В случае успеха не возвращает ничего. Иначе — возвращает ошибку

un​Suspend​Certificate(user:​dss​Certificate​Id:​callback:​)

public static func unSuspendCertificate(
        user: DSSUser,
        dssCertificateId: String,
        callback: @escaping (_ result: Result<Void, Error>) -> Void
    )  

Возобновление действия сертификата

Перед выполнением user.isReadyToSign должен быть true

Parameters

user DSSUser

Пользователь-владелец сертификата

dss​Certificate​Id String

Идентификатор сертификата

callback @escaping (_ result:​ Result<Void, Error>) -> Void

Замыкание возвращает результат

result

В случае успеха не возвращает ничего. Иначе — возвращает ошибку