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

Page tree

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

Compare with Current View Page History

« Previous Version 23 Next »

Устройство, подключенное к компьютеру. Может быть получено с помощью вызова Pkcs11Device::enumerate. 

Пространство имен:  rutoken::pki-core

Заголовочный файл: pki-core-cpp.h

Граф наследования


 

Классы

class  CommonKeyGenParamsОбщие параметры генерации ключевой пары для всех типов ключей независимо от алгоритма
class  Gost34102001KeyGenParamsПараметры генерации ключевой пары, специфичные для алгоритма ГОСТ 34.10-2001

Структуры

 

struct  FeatureДополнительная функциональность, поддерживаемая устройством
struct  FormatФорматы данных, которые устройство может подписывать

 

Открытые члены

 

Pkcs11Device (Pkcs11Device &&v) 
Pkcs11Device & operator= (Pkcs11Device &&v) 
void changePin (const std::string &oldPin, const std::string &newPin)Смена пользовательского PIN устройства
void deleteCert (const Pkcs11Cert &cert)Удаление сертификата с устройства
void deleteKeyPair (const Pkcs11PrivateKey &key)Удаление ключевой пары с устройства
std::vector< Pkcs11Cert > enumerateCerts ()Получение списка сертификатов, которые хранятся на устройстве
std::vector< Pkcs11PrivateKey > enumeratePrivateKeys ()Получение списка закрытых ключей, которые хранятся на устройстве
std::vector< Pkcs11UserCert > enumerateUserCerts ()Получение списка сертификатов, которые связаны с закрытыми ключами
Pkcs11PrivateKey generateKeyPair (const Gost34102001KeyGenParams &keyGenParams)Генерация ключевой пары ГОСТ Р 34.10-2001 на устройстве
std::string getLabel ()Получение метки устройства
std::string getSerialNumber ()Получение серийного номера устройства
Pkcs11Cert importCert (const ExternalCert &externalCert, bool trusted=false)Сохранение сертификата на устройстве
 Pkcs11UserCert importUserCert (const ExternalCert &externalCert)Сохранение сертификата на устройстве
bool isFeatureSupported (Feature::Type feature)Поддерживается ли возможность устройством
bool isFormatSupported (Format::Type format)Поддерживается ли устройством формат данных
bool isLoggedIn ()Произведена ли авторизация на устройстве
void login (const std::string &pin)Авторизация на устройстве
void logout ()Сброс прав доступа на устройстве

Открытые статические члены

 

static Pkcs11Device cast (Object &&v) 
static std::vector< Pkcs11Device >  enumerate ()Получение списка подключенных устройств

 

Подробное описание

static std::vector< Pkcs11Device >  enumerate   ()

Получение списка подключенных устройств.

Вызов этой функции делает объекты, полученные при предыдущем вызове, недействительными. 

 

void changePin (const std::string &oldPin, const std::string &newPin)
 
Смена PIN пользователя.

Аргументы

oldPin - старый PIN пользователя.

newPin - новый PIN пользователя.

 

void deleteCert (const Pkcs11Cert &cert)
Добавление произвольного расширения в запрос.

 Аргументы

cert - сертификат, который необходимо удалить

 

void deleteKeyPair(const Pkcs11PrivateKey &key)
 
 Удаление ключевой пары с устройства.

 Аргументы

key - закрытый ключ, который необходимо удалить.

 

 

std::vector< Pkcs11Cert > enumerateCerts ()

 Перечисление всех сертификатов, который хранятся на устройстве. 

 

std::vector< Pkcs11PrivateKey > enumeratePrivateKeys () enumeratePrivateKeys () 
 
 Получение списка закрытых ключей, хранящихся на устройстве.

 

std::vector< Pkcs11UserCert > enumerateUserCerts()

 

 Получение списка сертификатов, для которых есть закрытый ключ на устройстве.
 

Pkcs11PrivateKey generateKeyPair (const Gost34102001KeyGenParams &keyGenParams)

 Генерация ключевой пары ГОСТ Р 34.10-2001 на устройстве. 

Аргументы

keyGenParams - параметры генерации ключевой пары. 

Возвращает

Созданный ключ.

 

 

std::string getLabel

()

 Получение названия устройства.

 

std::string getSerialNumber ()
 
 Получение серийного номера устройства.

 

Pkcs11Cert importCert(const ExternalCert &externalCert, bool trusted=false)
 
Запись сертификата на устройство.

Аргументы

externalCert - внешний сертификат, который требуется записать на устройство.

trusted - сертификат будет записан как "CA". При этом он будет доверенным в рамках устройства.

Возвращает

Сертификат, связанный с устройством.

 

 Pkcs11UserCert importUserCert (const ExternalCert &externalCert)

 Запись сертификата на устройство. Для данного сертификата есть закрытый ключ на устройстве.

Аргументы

externalCert - внешний сертификат, который требуется записать на устройство.. 

Возвращает

Сертификат, связанный с устройством.

 

Pkcs11Cert importCert(const ExternalCert &externalCert, bool trusted=false)
 
Запись сертификата на устройство.

Аргументы

externalCert - внешний сертификат, который требуется записать на устройство.

trusted - сертификат будет записан как "CA". При этом он будет доверенным в рамках устройства.

Возвращает

Сертификат, связанный с устройством.

 

bool isFeatureSupported(Feature::Type feature)

 Получение информации о поддерживаемых устройством дополнительных возможностях.

Аргументы

feature - дополнительная возможность, поддержку которой необходимо проверить. 

 


bool isFormatSupported(Format::Type format)

 Получение информации о поддерживаемых устройством форматах данных для подписи.

Аргументы

format - формат, поддержку которого необходимо проверить.

 


bool isLoggedIn ()

 

Была ли произведена успешная авторизация на устройство.

 


void login (const std::string &pin)

 Авторизация на устройстве.

Аргументы

pin - PIN пользователя.



void logout()

 

Сброс прав доступа на устройство.

 

  • No labels