DWORD CPCAPI CPCExportKey( HCRYPTMODULE hCSP, HCRYPTPROV hProv, HCRYPTKEY hKey, HCRYPTKEY hExpKey, DWORD dwBlobType, DWORD dwFlags, BYTE * pbData, DWORD * pdwDataLen );
Аргументы
- hCSP
- [in] Указатель на таблицу функций криптопровайдера. Получается при помощи функции CPCCreateProvider()
- hProv
- [in] Дескриптор криптопровайдера. Получается при помощи функции CPCAcquireContext().
- hKey
- [in] Дескриптор экспортируемого ключа.
- hExpKey
- [in] Дескриптор ключа, на котором осуществляется криптографическая защита экспортируемого ключа. Необходимо, чтобы этот ключ был общим с получателем корреспонденции. Зашифрованные данные ключа помещаются в ключевой блоб, предназначенный для внешнего хранения и передачи по каналам связи. Алгоритмы функции экспорта ключей гарантируют, что только пользователь предназначения сможет использовать этот ключевой блоб. Для защиты ключа используется алгоритм, указанный при создании ключа экспорта. Если ключевой блоб не будет зашифрован (например, если тип ключевого блоба - PUBLICKEYBLOB), этот параметр должен быть нулевым.
- dwBlobType
- [in] Тип ключевого блоба, предназначенного для экспорта ключа. В настоящее время определены три типа ключевых блобов:
Тип Использование SIMPLEBLOB Используется для транспортировки симметричных ключей CALG_G28147, CALG_SYMMETRIC_512, CALG_GR3412_2015_M, CALG_GR3412_2015_K, CALG_UECSYMMETRIC, CALG_GOST_GENERIC_SECRET. pbData указывает на структуру CRYPT_SIMPLEBLOB . OPAQUEKEYBLOB Используется для транспортировки ключа сессии CALG_G28147 с накопленным состоянием. pbData указывает на структуру CRYPT_OPAQUEBLOB . PUBLICKEYBLOB Используется для транспортировки открытых ключей. pbData указывает на структуру CRYPT_PUBLICKEYBLOB . PRIVATEKEYBLOB Используется для транспортировки закрытых ключей). pbData указывает на структуру CRYPT_PRIVATEKEYBLOB . - dwFlags
- [in] Значения флагов. Должен быть нулевым во всех случаях за исключением экспорта ключевой пары в PUBLICKEYBLOB. В настоящее время определены следующие значения флагов:
Значение dwFlags Описание CRYPT_PUBLICCOMPRESS Если флаг установлен, то отрытый ключ в PUBLICKEYBLOB представляется парой (x,b), где байт b равен 2, если координата y чётная и 3 в противном случае. Если флаг не установлен, то отрытый ключ в PUBLICKEYBLOB представляется координатами (x,y) точки эллиптической кривой. CP_CRYPT_CALCULATE_PUBLIC_KEY Если флаг установлен, то открытый ключ будет перевычислен даже при наличии сертификата. CP_PRIMITIVE_PUBLICKEYBLOB Если флаг установлен, то структура PUBLICKEYBLOB не будет содержать информацию о параметрах экспортируемого открытого ключа. - pbData
- [in] Указатель на буфер данных, в который функция копирует ключевой блоб. Если значение этого параметра NULL, функция устанавливает по адресу pdwDataLen значение необходимой длины буфера и возвращает TRUE.
- pdwDataLen
- [in/out] Указатель на буфер, содержащий длину ключевого блоба. При вызове функции указанный параметр содержит число байтов в буфере pbData. После выполнения функции параметр будет установлен числом байтов данных, скопированных в буфер pbData. Если буфер, соответствующий pbData, недостаточно большой, будет возвращён код ошибки ERROR_MORE_DATA через функцию SetLastError(). В этом случае требуемый размер буфера возвращается в pdwDataLen. Если эта функция завершается с кодом ошибки, отличным от ERROR_MORE_DATA, в этом параметре возвращается ноль.
Возвращаемые значения
При успешном завершении функция возвращает 0 (S_OK), в противном случае возвращается соответствующий код ошибки (см. таблицу).| Коды возврата | Описание |
|---|---|
| ERROR_INVALID_PARAMETER | Один из параметров содержит некорректное значение. Чаще всего это некорректный указатель. |
| ERROR_MORE_DATA | Буфер pbData недостаточно большой, чтобы копировать затребованные данные. |
| NTE_BAD_FLAGS | Величина dwFlags имеет ненулевое значение. |
| NTE_BAD_KEY | Один или оба из ключей, указанных hKey и hExpKey, не действительны. |
| NTE_BAD_KEY_STATE | Попытка экспорта ключа, когда право экспорта криптопровайдером не предоставлено; попытка экспорта на ключе, для которого разрешение экспортировать не установлено. |
| NTE_BAD_TYPE | dwBlobType параметр определяет неизвестный тип блоба. |
| NTE_NO_MEMORY | Криптопровайдер во время операции исчерпал память. |
| NTE_FAIL | Ошибка при считывании данных из системного реестра. см. Дополнительные параметры и определения . |
| SCARD_W_CANCELLED_BY_USER | Пользователь прервал операцию. |
| SCARD_E_NO_KEY_CONTAINER | Попытка выполнения операции в контексте смарт-карты или токена, а не контейнера. |
| SCARD_W_SECURITY_VIOLATION | Фукции безопасности токена или смарт-карты работают некорректно. |
| SCARD_W_WRONG_CHV | Пользователь ввёл неправильный пароль или пароль, установленный функцией SetProvParam(), неправильный |
| SCARD_E_INVALID_CHV | Пользователь ввёл пароль с нарушением формата или пароль, установленный функцией SetProvParam(), имеет неправильный формат. Например, пароль имеет недопустимую длину или содержит недопустимые символы. |
| SCARD_W_CHV_BLOCKED | Ввод Pin-кода был заблокирован смарт-картой, т.к. исчерпалось количество попыток разрешенное картой для ввода. |
| ERROR_BAD_USERNAME | Введенный login доступа к ключевому сервису неверен. |
| ERROR_INVALID_PASSWORD | Введенный пароль доступа к ключевому сервису неверен. |
| ERROR_PASSWORD_EXPIRED | Пароль данного носителя истек, необходимо его сменить. |
| SCARD_E_READ_ONLY_CARD | Смарт-карта недоступна для использования из-за ограничений безопасности. |
Примечания
PUBLICKEYBLOB длины 69 байт в настоящее время не может использоваться в составе сертификата открытого ключа. Блобы данного вида критичны к искажениям, поэтому должны использоваться в приложениях с контролем целостности.
Для экспорта сессионных ключей любого типа могут использоваться алгоритмы CALG_SIMPLE_EXPORT, CALG_MGM_EXPORT_M, CALG_MGM_EXPORT_K, CALG_PRO_EXPORT и CALG_PRO12_EXPORT. Ключи ГОСТ Р 34.12-2015 М и ГОСТ Р 34.12-2015 К также могут быть экспортированы с использованием алгоритмов CALG_KEXP_2015_M и CALG_KEXP_2015_K. Долговременные ключи 2001 года могут быть экспортированы при помощи алгоритмов CALG_PRO_EXPORT и CALG_PRO12_EXPORT. К ключам 2012 года применим только алгоритм экспорта CALG_PRO12_EXPORT.
Для ключей 2012 года, которые используют параметры алгоритма ГОСТ 28147, отличные от параметров по умолчанию ("1.2.643.7.1.2.5.1.1", вариант ТК26 Z), идентификатор соответствующих параметров указывается в ключевом блобе. При использовании параметров по умолчанию идентификатор в блоб не записывается.
Если симметричный ключ использует параметры шифрования "1.2.643.7.1.2.5.1.1" (вариант ТК26 Z), то при экспорте данного ключа длина ключевого блоба будет больше, чем при использовании других параметров. Для обеспечения корректности работы с памятью рекомендуется предварительно запрашивать значение необходимой длины буфера для возвращаемых данных.
В случае, если производится экспорт SIMPLEBLOB для ключа ГОСТ 28147-89 возможна организация многопоточной работы функции CPCExportKey(). Для этого необходимо заранее создать специальный объект HCRYPTMODULE с помощью функции CPCGetProvParam() с флагом PP_CREATE_THREAD_CSP; данный объект в дальнейшем следует передавать функции CPCExportKey() в качестве первого параметра. Также необходимо в dwFlags передать флаг CP_CRYPT_NOKEYWLOCK, при этом ключ hExpKey блокируется только на чтение. Корректность работы функции и целостность ключа импорта гарантируются криптопровайдером.
Пример согласования общего ключа с использованием флага CP_PRIMITIVE_PUBLICKEYBLOB:
... CryptExportKey(hEphemKey, 0, PUBLICKEYBLOB, CP_PRIMITIVE_PUBLICKEYBLOB, pbBlob, &dwBlobLen); CryptImportKey(hProv, pbBlob, dwBlobLen, hSecretKey, CP_PRIMITIVE_PUBLICKEYBLOB, &hCommonKey); ...
Требования:
Ядро AIX: 6/7.
Ядро FreeBSD: 11/12.
Ядро Linux: 2.6.x и выше.
Ядро Solaris: 10/11.
Ядро Windows: 7/8/8.1/10, Server 2008/2008R2/2012/2012R2/2016/2019.
Ядро ОС: Поддерживается только типы SIMPLEBLOB и OPAQUEKEYBLOB.
См. также
CRYPT_SIMPLEBLOB ,CRYPT_OPAQUEBLOB ,CPCImportKey() ,CPExportKey в MS CSP 
,CryptExportKey в MS CryptoAPI 2.0