C_EX_TokenManage
Функции общего назначения
C_EX_GetFunctionListExtended()
Назначение
Функция возвращает список дополнительных функций, расширяющих библиотеку PKCS#11 для работы с Рутокен.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GetFunctionListExtended)( CK_FUNCTION_LIST_EXTENDED_PTR_PTR ppFunctionList );
Параметры
ppFunctionList | [out] | указатель на список функций расширения |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Пример
Функции для работы со слотами и токенами
C_EX_GetTokenInfoExtended()
Назначение
Функция позволяет получить специфическую для устройств Рутокен информацию: класс токена, количество свободной и общей памяти, тип токена, номер протокола и т.д. По сравнению с похожей по назначению стандартной функции C_GetTokenInfo функция расширения предоставляет более полную информацию о токене.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GetTokenInfoExtended)( CK_SLOT_ID slotID, CK_TOKEN_INFO_EXTENDED_PTR pInfo );
Параметры
slotID | [in] | ID слота, к которому подключен токен |
pInfo | [out] | указатель на структуру CK_TOKEN_INFO_EXTENDED, получающую расширенные данные токена |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_CRYPTOKI_NOT_INITIALIZED,
CKR_DEVICE_ERROR,
CKR_DEVICE_MEMORY,
CKR_DEVICE_REMOVED,
CKR_FUNCTION_FAILED,
CKR_GENERAL_ERROR,
CKR_HOST_MEMORY,
CKR_SLOT_ID_INVALID,
CKR_TOKEN_NOT_PRESENT.
Пример
C_EX_InitToken()
Назначение
Функция позволяет полностью инициализировать память токена. На этапе инициализации есть возможность задать политику смены PIN-кода пользователя, метки токена произвольной длины и т.д.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_InitToken)( CK_SLOT_ID slotID, CK_UTF8CHAR_PTR pPin, CK_ULONG ulPinLen, CK_RUTOKEN_INIT_PARAM_PTR pInitInfo );
Параметры
slotID | [in] | ID слота, к которому подключен токен для инициализации |
pPin | [in] | указатель на PIN-код Администратора |
ulPinLen | [in] | длина PIN-кода Администратора, в байтах |
pInitInfo | [in] | указатель на структуру CK_RUTOKEN_INIT_PARAM, хранящую параметры инициализации |
Примечание
Основное отличие функции C_EX_InitToken от похожей по назначению стандартной функции C_InitToken в том, что функция расширения полностью инициализирует память токена, а также предоставляет возможность задать политику смены PIN-кода пользователя, метку произвольной длины, а стандартная функция C_InitToken позволяет инициализировать только память, занятую объектами PKCS#11, и задать метку фиксированной длины.
Все параметры, необходимые для инициализации, передаются в структуре типа CK_RUTOKEN_INIT_PARAM.
Внимание! Для Рутокен S параметры ulMinAdminPinLen и ulMinUserPinLen из структуры CK_RUTOKEN_INIT_PARAM, не могут принимать значение больше 1.
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_CRYPTOKI_NOT_INITIALIZED,
CKR_DEVICE_ERROR,
CKR_DEVICE_MEMORY,
CKR_DEVICE_REMOVED,
CKR_FUNCTION_CANCELED,
CKR_FUNCTION_FAILED,
CKR_GENERAL_ERROR,
CKR_HOST_MEMORY,
CKR_PIN_INCORRECT,
CKR_PIN_LOCKED,
CKR_SESSION_EXISTS,
CKR_SLOT_ID_INVALID,
CKR_TOKEN_NOT_PRESENT.
Пример
C_EX_UnblockUserPIN()
Назначение
Функция позволяет разблокировать PIN-код Пользователя.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_UnblockUserPIN)( CK_SESSION_HANDLE hSession );
Параметры
hSession | [in] | дескриптор сесии |
Примечание
Функция сбрасывает счетчик неверных попыток ввода PIN-кода для CKU_USER. Функция может быть вызвана только из сессии, имеющей статус CKS_RW_SO_FUNCTIONS.
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_CRYPTOKI_NOT_INITIALIZED,
CKR_DEVICE_ERROR,
CKR_DEVICE_MEMORY,
CKR_DEVICE_REMOVED,
CKR_FUNCTION_CANCELED,
CKR_FUNCTION_FAILED,
CKR_GENERAL_ERROR,
CKR_HOST_MEMORY,
CKR_PIN_INVALID,
CKR_PIN_LEN_RANGE,
CKR_SESSION_CLOSED,
CKR_SESSION_READ_ONLY,
CKR_SESSION_HANDLE_INVALID,
CKR_USER_NOT_LOGGED_IN,
CKR_ARGUMENTS_BAD.
Пример
C_EX_SetTokenName()
Назначение
Функция позволяет задать метку токена (символьное имя) произвольной длины.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_SetTokenName)( CK_SESSION_HANDLE hSession, CK_BYTE_PTR pLabel, CK_ULONG ulLabelLen );
Параметры
hSession | [in] | дескриптор сессии |
pLabel | [in] | указатель на буфер, содержащий новую метку токена |
ulLabelLen | [in] | размер буфера с новой меткой токена, в байтах |
Примечание
Функция позволяет установить метку токена произвольной длины, в отличии от стандартной функции C_InitToken, которая позволяет устанавливать метку токена фиксированного размера. Функция может быть вызвана только из сессии, имеющей статус CKS_RW_USER_FUNCTIONS.
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_CRYPTOKI_NOT_INITIALIZED,
CKR_DEVICE_ERROR,
CKR_DEVICE_MEMORY,
CKR_DEVICE_REMOVED,
CKR_FUNCTION_FAILED,
CKR_GENERAL_ERROR,
CKR_HOST_MEMORY,
CKR_PIN_EXPIRED,
CKR_SESSION_CLOSED,
CKR_SESSION_HANDLE_INVALID,
CKR_SESSION_READ_ONLY,
CKR_USER_NOT_LOGGED_IN.
Пример
C_EX_GetTokenName()
Назначение
Функция позволяет получить метку токена произвольной длины. Функция может быть вызвана из любой сессии.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GetTokenName)( CK_SESSION_HANDLE hSession, CK_BYTE_PTR pLabel, CK_ULONG_PTR ulLabelLen );
Параметры
hSession | [in] | дескриптор сессии |
pLabel | [out] | указатель на буфер, содержащий метку токена |
ulLabelLen | [in, out] | размер буфера с меткой токена, в байтах |
Примечание
Функция позволяет получить метку токена произвольной длины, в отличии от стандартной функции C_GetTokenInfo, которая позволяет получить метку токена фиксированного размера.
Для определения необходимого количества памяти для хранения метки токена, необходимо вызвать функцию C_EX_GetTokenName с параметром pLabel равным NULL_PTR, тогда в параметре pulLabelLen будет возвращен указатель на переменную с требуемым размером буфера.
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_CRYPTOKI_NOT_INITIALIZED,
CKR_DEVICE_ERROR,
CKR_DEVICE_MEMORY,
CKR_DEVICE_REMOVED,
CKR_FUNCTION_FAILED,
CKR_GENERAL_ERROR,
CKR_HOST_MEMORY,
CKR_SESSION_CLOSED,
CKR_SESSION_HANDLE_INVALID,
CKR_BUFFER_TOO_SMALL.
Пример
C_EX_SetLicense()
Назначение
Функция предназначена для записи данных вендора в токен и позволяет записать лицензию на токен.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_SetLicense)( CK_SESSION_HANDLE hSession, CK_ULONG ulLicenseNum, CK_BYTE_PTR pLicense, CK_ULONG ulLicenseLen );
Параметры
hSession | [in] | дескриптор сессии |
ulLicenseNum | [in] | идентификатор лицензии. Параметр может принимать одно из двух значений: 1 или 2 |
pLicense | [in] | указатель на буфер, содержащий лицензию |
ulLicenseLen | [in] | размер буфера с лицензией, в байтах. Параметр может принимать только одно значение: 72 |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_CRYPTOKI_NOT_INITIALIZED,
CKR_DEVICE_ERROR,
CKR_DEVICE_MEMORY,
CKR_DEVICE_REMOVED,
CKR_FUNCTION_FAILED,
CKR_FUNCTION_NOT_SUPPORTED,
CKR_GENERAL_ERROR,
CKR_HOST_MEMORY,
CKR_PIN_EXPIRED,
CKR_SESSION_CLOSED,
CKR_SESSION_HANDLE_INVALID,
CKR_SESSION_READ_ONLY,
CKR_USER_NOT_LOGGED_IN.
Примечание
Формат данных (лицензии) определяет вендор, размер ограничивается 72 байтами. Всего может быть до двух лицензий.Функция может быть вызвана только из сессии, имеющей статус CKS_RW_USER_FUNCTIONS или CKS_RW_SO_FUNCTIONS.
При инициализации памяти токена с помощью функций C_InitToken или C_EX_InitToken ранее записанная лицензия удалена не будет.
Пример
C_EX_GetLicense()
Назначение
Функция позволяет прочитать лицензию, записанную на токен.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GetLicense)( CK_SESSION_HANDLE hSession, CK_UKONG ulLicenseNum, CK_BYTE_PTR pLicense, CK_ULONG_PTR pulLicenseLen );
Параметры
hSession | [in] | дескриптор сессии |
ulLicenseNum | [in] | идентификатор лицензии. Параметр может принимать одно из двух значений: 1 или 2 |
pLicense | [out] | указатель на буфер для получения лицензии |
ulLicenseLen | [in, out] | размер буфера с лицензией, в байтах. Параметр может принимать только одно значение: 72 |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_CRYPTOKI_NOT_INITIALIZED,
CKR_DEVICE_ERROR,
CKR_DEVICE_MEMORY,
CKR_DEVICE_REMOVED,
CKR_FUNCTION_FAILED,
CKR_GENERAL_ERROR,
CKR_HOST_MEMORY,
CKR_SESSION_CLOSED,
CKR_SESSION_HANDLE_INVALID,
CKR_FUNCTION_NOT_SUPPORTED.
Примечание
Функция позволяет прочитать лицензию с токена. Функция может быть вызвана из сессии любого состояния. Длина лицензии может иметь единственное значение 72 байта, либо при передаче pLicense равного NULL_PTR в параметре pulLicenseLen возвращается указатель на длину буфера для требуемой лицензии.
Пример
C_EX_SetLocalPIN()
Назначение
Функция устанавливает локальный PIN-код, если он не был установлен или меняет локальный PIN-код, если он был установлен заранее.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_SetLocalPIN)( CK_SLOT_ID slotID, CK_UTF8CHAR_PTR pUserPin, // или pOldLocalPin CK_ULONG ulUserPinLen, // или pOldLocalPinLen CK_UTF8CHAR_PTR pNewLocalPin, CK_ULONG ulNewLocalPinLen, CK_ULONG ulLocalID );
Параметры
slotID | [in] | идентификатор слота, к которому подключен токен |
pUserPin или pOldLocalPin | [in] | указатель на текущий PIN-код Пользователя или на текущий локальный PIN-код |
ulUserPinLen или pOldLocalPinLen | [in] | длина текущего PIN-кода Пользователя или длина текущего локального PIN-кода |
pNewLocalPin | [in] | указатель на новый Локальный PIN-код |
ulNewLocalPinLen | [in] | длина нового Локального PIN-кода |
ulLocalID | [in] | идентификатор Локального PIN-кода |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Пример
C_EX_TokenManage()
Назначение
Предоставляет механизм принудительной смены PIN-кода пользователя.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_TokenManage)( CK_SESSION_HANDLE hSession, CK_ULONG ulMode, CK_VOID_PTR pValue );
Параметры
hSession | [in] | дескриптор сессии |
ulMode | [in] | режим работы функции:
|
pValue | [in] |
|
Возвращаемые значения
CKR_OK
– функция выполнена успешно.
CKR_ARGUMENTS_BAD
– неправильно переданы параметры функции
CKR_USER_NOT_LOGGED_IN
– пользователь SKU_SO не авторизован на токене (режимы)
Мультифункциональная функция
Здесь описаны не все возможные параметры функции. Описание других параметров функции можно найти здесь
C_EX_SlotManage
Назначение
Позволяет:
- получить расширенную информацию о всех локальных PIN-кодах токена.
- получить информацию об установленном флаге принудительной смене PIN-кода
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_SlotManage) ( CK_SLOT_ID slotID, CK_ULONG ulMode, CK_VOID_PTR pValue )
Параметры
hSession | [in] | дескриптор сессии |
ulMode | [in] | режим работы функции:
|
pValue | [out] |
|
Для режима работы функции MODE_GET_LOCAL_PIN_INFO
в pValue возвращается указатель массив структур типа CK_LOCAL_PIN_INFO
:
ulPinID | [in] | идентификатор PIN-кода |
ulMinSize | [out] | заданная минимальная длина PIN-кода |
ulMaxSize | [out] | заданная максимальная длина PIN-кода |
ulMaxRetryCount | [out] | заданное максимальное значение счетчика неверных попыток ввода пароля |
ulCurrentRetryCount | [out] | текущее значение счетчика оставшихся попыток ввода пароля: 0 – PIN-код заблокирован |
flags | [out] | информационные флаги:
|
Возвращаемые значения
CKR_OK
– функция выполнена успешно.
CKR_PIN_EXPIRED
– если PIN-код нужно сменить смене (MODE_GET_PIN_SET_TO_BE_CHANGED
).
CKR_ARGUMENTS_BAD
– неверно указаны аргументы функции.
Функции для работы с сертификатами
C_EX_GetCertificateInfoText()
Назначение
Функция позволяет получить информацию о сертификате из токена в текстовом виде.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GetCertificateInfoText)( CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hCert, CK_CHAR_PTR* pInfo, CK_ULONG_PTR pulInfoLen );
Параметры
hSession | [in] | дескриптор сессии |
hCert | [in] | дескриптор объекта (сертификата) |
pInfo | [out] | указатель на буфер, содержащий текстовую информацию о сертификате |
pulInfoLen | [out] | размер буфера, в байтах |
Примечание
Функция может быть вызвана из любого состояния. Так как память для массива выделяется внутри функции, по окончании работы функции pInfo нужно высвободить функцией C_EX_FreeBuffer.
C_EX_CreateCSR()
Назначение
Создает запрос на выпуск сертификата в центр сертификации и упаковывает его в формат PKCS#10.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_CreateCSR)( CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hPublicKey, CK_CHAR_PTR *dn, CK_ULONG dnLength, CK_BYTE_PTR *pCsr, CK_ULONG_PTR pulCsrLength, CK_OBJECT_HANDLE hPrivKey, CK_CHAR_PTR *pAttributes, CK_ULONG ulAttributesLength, CK_CHAR_PTR *pExtensions, CK_ULONG ulExtensionsLength );
Параметры
hSession | [in] | дескриптор сессии |
hPublicKey | [in] | дескриптор открытого ключа для создания сертификата |
dn | [in] | уникальное имя – массив строк, где в первой строке располагается тип поля в текстовом формате или идентификатор объекта (CN или «2.5.4.3»). Во второй строке должно находиться значение поля в кодировке UTF8. Последующие поля передаются аналогично, количество строк должно быть кратно двум |
dnLength | [in] | количество строк в массиве, на который ссылается параметр dn |
pCsr | [in] | указатель на указатель на массив байт, в который будет записан созданный запрос на сертификат |
pulCsrLength | [in] | указатель на переменную, в которой сохраняется размер массива. |
hPrivKey | [in] | закрытый ключ, соответствующий открытому ключу, на который ссылается параметр hPublicKey. Если значение установлено в «0», то поиск закрытого ключа будет осуществляться по ID открытого ключа. |
pAttributes | [in] | дополнительные атрибуты для включения в запрос. Формат аналогичен формату параметра dn (например, «1.2.840.113549.1.9.7» или «challengePassword»). |
ulAttributesLength | [in] | количество атрибутов в массиве, на который указывает параметр attributes. |
pExtensions | [in] | расширения для включения в запрос. Формат аналогичен параметру dn |
ulExtensionsLength | [in] | количество расширений в параметрах extensions |
Примечание
Функция может быть вызвана только из состояний "R/W User Functions" и "R User Functions". Память для массива pCsr выделяется внутри функции, поэтому после окончания работы память необходимо освободить, вызвав функцию C_EX_FreeBuffer().
Функция поддерживает генерацию запроса на сертификат для следующих типов ключей: ГОСТ 34.10-2012 с длиной закрытого ключа 256 бит, ГОСТ 34.10-2001 и RSA (типы ключей CKK_GOSTR3410 и CKK_RSA).
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Пример
Функции для работы с CMS/PKCS#7 сообщениями
C_EX_PKCS7Sign()
Назначение
Подписывает переданные на вход данные в формате PKCS#7.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_PKCS7Sign)( CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, CK_ULONG ulDataLen, CK_OBJECT_HANDLE hCert, CK_BYTE_PTR *ppEnvelope, CK_ULONG_PTR pEnvelopeLen, CK_OBJECT_HANDLE hPrivKey, CK_OBJECT_HANDLE_PTR phCertificates, CK_ULONG ulCertificatesLen, CK_ULONG flags );
Параметры
hSession | [in] | дескриптор сессии |
pData | [in] | указатель на байт-массив CK_BYTE, содержащий данные для подписи |
ulDataLen | [in] | длина данных для подписи |
hCert | [in] | дескриптор сертификата |
ppEnvelope | [out] | указатель на байт-массив, в который передаются данные (сообщение) |
pEnvelopeLen | [out] | указатель на длину созданного буфера с сообщением |
hPrivKey | [in] | дескриптор закрытого ключа, соответствующего указанному сертификату. Если равен 0, то закрытый ключ будет искаться по ID сертификата |
phCertificates | [in] | указатель на массив сертификатов, цепочку сертификатов |
ulCertificatesLen | [in] | количество сертификатов в параметре phCertificates |
flags | [in] | переменная типа CK_ULONG, может принимать следующие значения: 0 – хеширование программное, исходные данные, на которые ссылается указатель pData, сохраняются вместе с подписанным сообщением; |
Примечание
Функция может быть вызвана только из состояний "R/W User Functions" и "R User Functions". Буфер ppEnvelope создается внутри функции. После окончания работы с ним необходимо освободить его, вызвав функцию C_EX_FreeBuffer().
Функция поддерживает подпись по следующим алгоритмам: ГОСТ 34.10-2012 с длиной закрытого ключа 256 бит и ГОСТ 34.10-2001 (механизм CKM_GOSTR3410).
Возвращаемые значения
CKR_OK – функция выполнена успешно.
C_EX_PKCS7VerifyInit()
Назначение
Инициализирует процесс проверки подписи переданных на вход данных в формате PKCS#7.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_PKCS7VerifyInit)( CK_SESSION_HANDLE hSession, CK_BYTE_PTR pCms, CK_ULONG ulCmsSize, CK_VENDOR_X509_STORE_PTR pStore, CK_VENDOR_CRL_MODE ckMode, CK_FLAGS flags ); typedef struct CK_VENDOR_X509_STORE { CK_VENDOR_BUFFER_PTR pTrustedCertificates; // указатель на массив доверенных сертификатов CK_ULONG ulTrustedCertificateCount; // количество доверенных сертификатов в массиве CK_VENDOR_BUFFER_PTR pCertificates; // указатель на массив, содержащий сертификаты для проверки подписи CK_ULONG ulCertificateCount; // количество сертификатов в цепочке сертификатов CK_VENDOR_BUFFER_PTR pCrls; // указатель на массив списков отзыва сертификатов CK_ULONG ulCrlCount; // количество списков отзыва сертификатов в массиве } CK_VENDOR_X509_STORE; typedef struct CK_VENDOR_BUFFER { CK_BYTE_PTR pData; // указатель на массив байтов CK_ULONG ulSize; // длина массива }
Параметры
hSession | [in] | дескриптор сессии |
pCms | [in] | указатель на массив байтов, содержащий сообщение в формате PKCS#7 для проверки |
ulCmsSize | [in] | длина сообщения |
pStore | [in] | указатель на структуру типа CK_VENDOR_X509_STORE, которая содержит указатели на необходимые для проверки подписи доверенные сертификаты, сертификаты подписывающей стороны и списки отозванных сертификатов |
ckMode | [in] | политика проверки списков отозванных сертификатов (CRLs), может принимать следующие значения: OPTIONAL_CRL_CHECK – отсутствие списка отозванных сертификатов не вызывает ошибку при проверке подписи; |
flags | [in] | опции проверки подписи, могут принимать следующие значения: CKF_VENDOR_DO_NOT_USE_INTERNAL_CMS_CERTS – не использовать содержащиеся в CMS сообщении сертификаты для поиска сертификатов подписантов (сертификаты должны быть заданы в структуре CK_VENDOR_X509_STORE); |
Примечание
Функция может быть вызвана только из состояний "R/W User Functions" и "R User Functions".
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_OPERATION_ACTIVE,
CKR_FUNCTION_FAILED,
CKR_FUNCTION_NOT_SUPPORTED.
C_EX_PKCS7Verify()
Назначение
Выполняет проверкy присоединенной (attached) подписи в формате PKCS#7 и возвращает данные, которые были подписаны, и сертификаты подписантов.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_PKCS7Verify)( CK_SESSION_HANDLE hSession, CK_BYTE_PTR_PTR ppData, CK_ULONG_PTR pulDataSize, CK_VENDOR_BUFFER_PTR_PTR ppSignerCertificates, CK_ULONG_PTR pulSignerCertificatesCount ); typedef struct CK_VENDOR_BUFFER { CK_BYTE_PTR pData; // указатель на массив байтов CK_ULONG ulSize; // длина массива }
Параметры
hSession | [in] | дескриптор сессии |
ppData | [out] | указатель на массив байтов, содержащий данные, которые были подписаны (EncapsulatedContentInfo) |
pulDataSize | [out] | размер данных |
ppSignerCertificates | [out] | указатель на массив, содержащий сертификаты подписантов |
pulSignerCertificatesCount | [out] | количество сертификатов в массиве |
Примечание
Функция может быть вызвана только из состояний "R/W User Functions" и "R User Functions", после вызова функции C_EX_PKCS7Verifyinit.
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_CERT_CHAIN_NOT_VERIFIED,
CKR_FUNCTION_NOT_SUPPORTED,
CKR_HOST_MEMORY,
CKR_OPERATION_NOT_INITIALIZED,
CKR_SIGNATURE_INVALID.
C_EX_PKCS7VerifyUpdate()
Назначение
Начинает процесс проверки отсоединенной (detached) подписи в формате PKCS#7.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_PKCS7VerifyUpdate)( CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, CK_ULONG ulDataSize );
Параметры
hSession | [in] | дескриптор сессии |
pData | [in] | указатель на массив байтов, содержащий блок данных, которые были подписаны (EncapsulatedContentInfo) |
ulDataSize | [in] | размер данных |
Примечание
Функция может быть вызвана только из состояний "R/W User Functions" и "R User Functions", после вызова функции C_EX_PKCS7VerifyInit. Для завершения процесса проверки подписи необходим вызов функции C_EX_PKCS7Verifyfinal.
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_ARGUMENTS_BAD,
CKR_FUNCTION_NOT_SUPPORTED,
CKR_HOST_MEMORY,
CKR_OPERATION_NOT_INITIALIZED.
C_EX_PKCS7VerifyFinal()
Назначение
Завершает процесс проверки отсоединенной (detached) подписи в формате PKCS#7 и возвращает сертификаты подписантов.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_PKCS7VerifyFinal)( CK_SESSION_HANDLE hSession, CK_VENDOR_BUFFER_PTR_PTR ppSignerCertificates, CK_ULONG_PTR pulSignerCertificatesCount );
Параметры
hSession | [in] | дескриптор сессии |
ppSignerCertificates | [out] | указатель на массив, содержащий сертификаты подписантов |
pulSignerCertificatesCount | [out] | количество сертификатов в массиве |
Примечание
Функция может быть вызвана только из состояний "R/W User Functions" и "R User Functions", после вызова функции C_EX_PKCS7VerifyUpdate.
Возвращаемые значения
CKR_OK – функция выполнена успешно.
CKR_SIGNATURE_INVALID,
CKR_ARGUMENTS_BAD,
CKR_CERT_CHAIN_NOT_VERIFIED,
CKR_FUNCTION_NOT_SUPPORTED,
CKR_HOST_MEMORY,
CKR_OPERATION_NOT_INITIALIZED.
Функции для работы с флеш-памятью
C_EX_GetDriveSize()
Назначение
Возращает размер флеш-памяти токена.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GetDriveSize)( CK_SLOT_ID slotID, CK_ULONG_PTR pulDriveSize );
Параметры
slotID | [in] | идентификатор слота с подключенным токеном |
pulDriveSize | [out] | возвращаемый размер флеш-памяти в Мб |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Пример
C_EX_FormatDrive()
Разбивает флеш-память токена на независимые разделы с разными правами доступа.
Функция изменяет идентификатор слота
После окончания работы этой функции происходит переподключение токена. Нет никаких гарантий, что работу с этим токеном можно производить по старому SLOT_ID: он может начать указывать на другой токен или не быть валидным вовсе. Новый SLOT_ID токена можно найти, например, по серийному номеру.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_FormatDrive) ( CK_SLOT_ID slotID, CK_USER_TYPE userType, CK_UTF8CHAR_PTR pPin, CK_ULONG ulPinLen, CK_VOLUME_FORMAT_INFO_EXTENDED_PTR pInitParams, CK_ULONG ulInitParamsCount ); typedef struct CK_VOLUME_FORMAT_INFO_EXTENDED { CK_ULONG ulVolumeSize; CK_ACCESS_MODE_EXTENDED accessMode; CK_OWNER_EXTENDED volumeOwner; CK_FLAGS flags; } CK_VOLUME_FORMAT_INFO_EXTENDED;
Параметры
slotID | [in] | идентификатор слота с подключенным токеном | ||||||||
userType | [in] | тип пользователя, допустимое значение только CKU_SO – глобальный администратор. | ||||||||
pPin | [in] | PIN-код пользователя | ||||||||
ulPinLen | [in] | длина PIN-кода пользователя | ||||||||
pInitParams | [in] | указатель на массив структур типа CK_VOLUME_FORMAT_INFO_EXTENDED, содержащих детальную информацию о разделах
| ||||||||
ulInitParamsCount | [in] | количество записей в массиве |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Пример
C_EX_GetVolumesInfo()
Назначение
Возвращает информацию о существующих на флеш-памяти разделах.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GetVolumesInfo)( CK_SLOT_ID slotID, CK_VOLUME_INFO_EXTENDED_PTR pInfo, CK_ULONG_PTR pulInfoCount ); typedef struct CK_VOLUME_INFO_EXTENDED { CK_VOLUME_ID_EXTENDED idVolume; CK_ULONG ulVolumeSize; CK_ACCESS_MODE_EXTENDED accessMode; CK_OWNER_EXTENDED volumeOwner; CK_FLAGS flags; } CK_VOLUME_INFO_EXTENDED;
Параметры
slotID | [in] | идентификатор слота с подключенным токеном | ||||||||||
pInfo | [out] | указатель на массива структур типа
| ||||||||||
pulInfoCount | [out] | размер массива |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Примечания
При вызове функции с пустым указателем pInfo функция возвращает размер массива в pulInfoCount.
Пример
C_EX_ChangeVolumeAttributes()
Назначение
Функция измененяет флаг доступа к разделу.
Функция изменяет идентификатор слота
После изменения доступа к разделу на постоянной основе происходит переподключение токена. Нет никаких гарантий, что работу с этим токеном можно производить по старому SLOT_ID: он может начать указывать на другой токен или не быть валидным вовсе. Новый SLOT_ID токена можно найти, например, по серийному номеру.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_ChangeVolumeAttributes)( CK_SLOT_ID slotID, CK_USER_TYPE userType, CK_UTF8CHAR_PTR pPin, CK_ULONG ulPinLen, CK_VOLUME_ID_EXTENDED idVolume, CK_ACCESS_MODE_EXTENDED newAccessMode, CK_BBOOL bPermanent );
Параметры
slotID | [in] | идентификатор слота с подключенным токеном |
userType | [in] | владелец раздела, допустимые значения: CKU_USER – глобальный пользователь; |
pPin | [in] | PIN-код пользователя |
ulPinLen | [in] | длина PIN-кода пользователя |
idVolume | [in] | идентификатор раздела |
newAccessMode | [in] | новые флаги доступа к разделу |
bPermanent | [in] | флаг режима измения атрибута: CK_TRUE – постоянное изменение атрибута доступа, действует вплоть до следующего изменения атрибутов; |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Пример
Функции для работы с журналом
C_EX_GetJournal()
Назначение
Функция возвращает журнал операций.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GetJournal)( CK_SLOT_ID slotID, CK_BYTE_PTR pJournal, CK_ULONG_PTR pulJournalSize );
Параметры
slotID | [in] | идентификатор слота |
pJournal | [out] | указатель на запись журнала |
pulJournalSize | [out] | размер записи журнала |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Примечания
Формат возвращаемой записи журнала и пример парсинга доступны по ссылке.
Пример
Функции для работы с беспроводным каналом связи
C_EX_LoadActivationKey()
Назначение
Активирует защищенный канал связи с токеном с использованием пароля (поддерживается только в 20-й версии прошивки)
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_LoadActivationKey)( CK_SESSION_HANDLE hSession, CK_BYTE_PTR key, CK_ULONG keySize );
Параметры
hSession | [in] | дескриптор сессии |
key | [in] | указатель на пароль |
keySize | [in] | длина пароля |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
C_EX_SetActivationPassword()
Назначение
Активирует защищенный канал связи с токеном с использованием пароля (поддерживается с 21-й версии прошивки).
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_SetActivationPassword)( CK_SLOT_ID slotID, CK_UTF8CHAR_PTR password );
Параметры
hSession | [in] | дескриптор сессии |
password | [in] | пароль активации |
Возвращаемые значения
CKR_OK – функция выполнена успешно.
C_EX_GenerateActivationPassword()
Назначение
Генерирует пароль для активации защищенного канала связи с токеном.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_GenerateActivationPassword)( CK_SESSION_HANDLE hSession, CK_ULONG ulPasswordNumber, CK_UTF8CHAR_PTR pPassword, CK_ULONG_PTR pulPasswordSize, CK_ULONG ulPasswordCharacterSet );
Параметры
hSession | [in] | дескриптор сессии |
ulPasswordNumber | порядковый номер генерируемого пароля. Допустимые значения от 1 до 6 и
| |
pPassword | [out] | указатель на буфер, содержащий сгенерированный пароль |
pulPasswordSize | [out] | размер буфера |
ulPasswordCharacterSet | [in] | набор допустимых символов:
|
Возвращаемые значения
CKR_OK – функция выполнена успешно.
C_EX_TokenManage()
Назначение
Управляет режимом работы токена и таймаутом беспроводного соединения Рутокен Bluetooth.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_TokenManage)( CK_SESSION_HANDLE hSession, CK_ULONG ulMode, CK_VOID_PTR pValue );
Параметры
hSession | [in] | дескриптор сессии |
ulMode | [in] | режим работы функции:
|
pValue | [in] |
1 .. 0х46 – произвольное значение в минутах, от 1 минуты до 70 минут
|
Возвращаемые значения
CKR_OK – функция выполнена успешно.
Мультифункциональная функция
Здесь описаны не все возможные параметры функции. Описание других параметров функции можно найти здесь
Вспомогательные функции
C_EX_FreeBuffer()
Назначение
Функция освобождает память, выделенную другими расширенными функциями, например C_EX_GetCertificateInfoText.
Синтаксис
CK_DEFINE_FUNCTION(CK_RV, C_EX_FreeBuffer)( CK_BYTE_PTR pBuffer );
Параметры
pBuffer | [in] | указатель на буфер |
Возвращаемые значения
CKR_OK – функция выполнена успешно.