КриптоПро CSP  

CPCExportKey

Функция CPCExportKey() используется для экспорта криптографических ключей из ключевого контейнера криптопровайдера, сохраняя их в защищённом виде.

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. 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 Если флаг установлен, то открытый ключ будет перевычислен даже при наличии сертификата.
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_TYPEdwBlobType параметр определяет неизвестный тип блоба.
NTE_NO_MEMORYКриптопровайдер во время операции исчерпал память.
NTE_FAILОшибка при считывании данных из системного реестра. см. Дополнительные параметры и определения .
SCARD_W_CANCELLED_BY_USERПользователь прервал операцию.
SCARD_E_NO_KEY_CONTAINERПопытка выполнения операции в контексте смарт-карты или токена, а не контейнера.
SCARD_W_SECURITY_VIOLATIONФукции безопасности токена или смарт-карты работают некорректно.
ERROR_PASSWORD_EXPIREDПароль данного носителя истек, необходимо его сменить.
SCARD_E_READ_ONLY_CARDСмарт-карта недоступна для использования из-за ограничений безопасности.

Примечания

PUBLICKEYBLOB длины 69 байт в настоящее время не может использоваться в составе сертификата открытого ключа. Блобы данного вида критичны к искажениям, поэтому должны использоваться в приложениях с контролем целостности.

Для экспорта сессионных ключей могут использоваться алгоритмы CALG_SIMPLE_EXPORT, CALG_PRO_EXPORT и CALG_PRO12_EXPORT. Долговременные ключи 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 возможна организация многопоточной работы функции CPCExportKey(). Для этого необходимо заранее создать специальный объект HCRYPTMODULE с помощью функции CPCGetProvParam() с флагом PP_CREATE_THREAD_CSP; данный объект в дальнейшем следует передавать функции CPCExportKey() в качестве первого параметра. Также необходимо в dwFlags передать флаг CP_CRYPT_NOKEYWLOCK, при этом ключ hExpKey блокируется только на чтение. Корректность работы функции и целостность ключа импорта гарантируются криптопровайдером.

Требования:

Ядро FreeBSD: 7/8/9 или выше
Ядро Linux: ядро 2.4.x/2.6.x/3.0.х/3.2.х или выше
Ядро Solaris: 10/11 или выше.
Ядро Windows 2000 или выше: Необходимо Windows 2000 SP4 или старше.
Ядро ОС: Поддерживается только типы SIMPLEBLOB и OPAQUEKEYBLOB.

См. также

CRYPT_SIMPLEBLOB ,CRYPT_OPAQUEBLOB ,CPCImportKey() ,CPExportKey в MS CSP World Wide Web link ,CryptExportKey в MS CryptoAPI 2.0 World Wide Web link