КриптоПро CSP  

CPGetKeyParam

Функция CPGetKeyParam() возвращает параметры ключа.

BOOL WINAPI CPGetKeyParam(
  HCRYPTPROV hProv,
  HCRYPTKEY hKey,
  DWORD dwParam,
  BYTE * pbData,
  DWORD * pdwDataLen,
  DWORD dwFlags
);

Аргументы

hProv
[in] Дескриптор криптопровайдера. Получается при помощи функции CPAcquireContext().
hKey
[in] Дескриптор ключа, параметры которого возвращаются.
dwParam
[in] Параметр, принимающий следующие возможные значения:
Значение dwParam Содержимое буфера pbData
KP_ALGID Идентификатор алгоритма (ALG_ID), соответствующий данному ключу.
KP_PERMISSIONS Флаги разрешения использования ключа. Возвращаются в виде переменной типа DWORD.
KP_IV Возвращает начальное значение вектора инициализации (IV или синхропосылки) алгоритма шифрования. Если ключ использовался в вызове CPEncrypt() или CPDecrypt() с параметром Final = FALSE, то значение данного параметра остается неизменным до вызова соответствующей функции с параметром Final = TRUE. По завершению работы функции начальное значение синхропосылки изменяется на случайное. До вызова CPEncrypt() или CPDecrypt() с параметром Final = FALSE значение параметра может быть изменено с помощью функции CPSetKeyParam().
KP_IV_BLOB Возвращает начальное значение вектора инициализации (IV или синхропосылки) для алгоритма VKO GOST R 34.10-2012-256.
KP_CERTIFICATE Получение сертификата из контейнера (из носителя).
KP_MODE Режим алгоритма шифрования. Возвращается в виде переменной типа DWORD. Используются режимы шифрования:
  • CRYPT_MODE_ECB - блочный шифр простой замены ГОСТ 28147-89;
  • CRYPT_MODE_CNT - шифрование гаммированием ГОСТ 28147-89;
  • CRYPT_MODE_CFB - шифрование гаммированием с обратной связью ГОСТ 28147-89;
  • CRYPT_MODE_CBCRFC4357 - блочный шифр с обратной связью на базе ГОСТ 28147-89, согласно RFC 4357;
  • CRYPT_MODE_CBCSTRICT - блочный шифр с обратной связью на базе ГОСТ 28147-89, шифртекст блока всегда является IV для следующего. Рекомендуется для использования только для обеспечения совместимости с существующими продуктами.
KP_MODE_BITS Глубина обратной связи. Возвращается в виде переменной типа DWORD. Значение этой величины равно 64, что соответствует режиму гаммирования с обратной связью ГОСТ 28147-89.
KP_MIXMODE Режим преобразования ключа. Возвращается в виде переменной типа DWORD. Используются режимы преобразования:
  • CRYPT_PROMIX_MODE - преобразование после зашифрования каждых 1024 байт информации,
  • CRYPT_SIMPLEMIX_MODE - без преобразования.
KP_KEYLEN Длина ключа в битах. Возвращается в виде переменной типа DWORD. Для ключей шифрования в параметре pbData возвращается длина ключа, для ключевых пар возвращается длина открытого ключа.
KP_BLOCKLEN Длина блока шифрования, обрабатываемого криптопровайдером. Возвращается в виде переменной типа DWORD. В случае сессионного ключа если для ключа установлен режим блочного шифрованя (CRYPT_MODE_ЕСB, CRYPT_MODE_CBС), в параметре pbData устанавливается размер блока алгоритма ГОСТ 28147-89, если установлен режим поточного шифрования (CRYPT_MODE_CNT, CRYPT_MODE_CFB), в параметре pbData устанавливается значение оптимального с точки зрения скорости шифрования размера блока, принимаемого от приложения (в настоящее время 8Кбит). В случае ключевой пары в параметре pbData устанавливается число бит модуля q для ключей на базе эллиптической кривой (ГОСТ Р 34.10-2001 и ГОСТ Р 34.10-2012).
KP_CIPHEROID Идентификатор узла замены, устанавливаемого приложением. Строковая величина с признаком конца строки.
KP_DHOID Идентификатор алгоритма Диффи-Хеллмана. Строка, заканчивающаяся нулем.
KP_SIGNATUREOID Идентификатор алгоритма подписи. Строка, заканчивающаяся нулем.
KP_HASHOID Идентификатор функции хэширования, устанавливаемой приложением. Строка, заканчивающаяся нулем.
KP_DELTA Возвращает значение дельты после установки на пользовательский ключ значение синхропосылки. Данные возвращаются в форме BLOB структуры, где pbData указавает на данные – 32 бита дельты, а cbData передаёт длину данных. Специфика протокола ООО "КРИПТО-ПРО" взаимодействия с функциональным ключевым носителем.
KP_FP Возвращает первые 8 байт открытого ключа.
KP_NOTAFTER Возвращает дату окончания действия ключей AT_SIGNATURE/AT_KEYEXCHANGE в виде структуры FILETIME.
KP_UEC_DERIVE_COUNTER Для ключа типа AT_UECSYMMETRICKEY возвращает значение счетчика ключей, полученных диверсификацией данного. Возвращается в виде переменной типа DWORD.
pbData
[out] Указатель на буфер данных параметра. Функция копирует соответствующие параметру данные в буфер. Формат этих данных зависит от значения dwParam. Если параметр - NULL, то данные не копируются. Требуемый размер буфера в байтах возвращается в pdwDataLen. Подробнее см. Возвращение данных неопределенной длины.
pdwDataLen
[in/out] Указатель на буфер, содержащий длину данных параметра. При вызове функции указанный параметр содержит число байтов в буфере pbData. После её выполнения параметр будет установлен числом байтов данных параметра, скопированных в буфер pbData. Если буфер, соответствующий pbData, недостаточно велик, чтобы в него копировать запрошенные данные, через функцию GetLastError() будет возвращён код ошибки ERROR_MORE_DATA. В этом случае требуемый размер буфера возвращается в pdwDataLen. Если эта функция завершается с кодом ошибки, отличным от ERROR_MORE_DATA, в этом параметре возвращается ноль.
dwFlags
[in] Значения флагов. Параметр зарезервирован для будущего использования и должен быть нулевым.

Возвращаемые значения

При успешном завершении функция возвращает TRUE, в противном случае возвращается FALSE. Если возвращается FALSE, соответствующий код ошибки (см. таблицу) может быть получен через функцию GetLastError().
Коды возвратаОписание
ERROR_INVALID_PARAMETERОдин из параметров содержит некорректное значение. Чаще всего это некорректный указатель.
ERROR_MORE_DATAРазмер буфера pbData недостаточен для копирования затребованных данных.
NTE_BAD_FLAGSПараметр dwFlags имеет ненулевое значение.
NTE_BAD_TYPEПараметр dwParam передаёт неизвестное значение параметра.
NTE_BAD_KEYДескриптор ключа ошибочен.
NTE_PERMПопытка чтения ключевых параметров, когда право чтения криптопровайдером не представлено.
SCARD_E_NO_SUCH_CERTIFICATEПри попытке получения сертификата, когда сертификат отсутствует.

Примечания

Синхропосылка ключа для шифрования по алгоритму ГОСТ 28147-89 вырабатывается криптопровайдером автоматически с установкой типа ключа CALG28147 (сессионный ключ). Эту синхропосылку рекомендуется получить на передающем конце из ключа с помощью функции CPGetKeyParam() для значения pvParam KP_IV. На приёмном конце значение синхропосылки устанавливается на ключ функцией CPSetKeyParam() при значении pvParam KP_IV. Если требуется задание синхропосылки из приложения, то её рекомендуется вырабатывать с помощью функции CPGenRandom(). Использовать в системе другие алгоритмы образования синхропосылок можно только по согласованию с разработчиком криптопровайдера.

Требования:

AIX: 5/6/7 или выше.
FreeBSD: 7/8/9 или выше.
Linux: LSB 3.1 (RHEL 4, SuSE 10) или выше.
Solaris: 10 или выше.
Mac OSX: 10.7/8 или выше.
iOS: 6/7 или выше.
Windows 2000 или выше: Необходимо Windows 2000 SP4 или старше с Internet Explorer 6.0 или старше.
Файл описания: Прототип описан в файле wincsp.h.
Ядро ОС: Вместо неё используется аналогичная функция CPCGetKeyParam .

См. также

CPSetKeyParam() ,CPGetKeyParam в MS CSP World Wide Web link ,CryptGetKeyParam в MS CryptoAPI 2.0 World Wide Web link