КриптоПро CSP  

CPGetHashParam

Функция CPGetHashParam() возвращает параметры объекта функции хэширования и значение функции хэширования.

BOOL WINAPI CPGetHashParam(
  HCRYPTPROV hProv,
  HCRYPTHASH hHash,
  DWORD dwParam,
  BYTE * pbData,
  DWORD * pdwDataLen,
  DWORD dwFlags
);

Аргументы

hProv
[in] Дескриптор криптопровайдера. Получается при помощи функции CPAcquireContext().
hHash
[in] Дескриптор объекта функции хэширования, параметры которого определяются.
dwParam
[in] Параметр, принимающий следующие возможные значения:
Значение dwParam Содержимое буфера pbData
HP_ALGID Алгоритм функции хэширования. Идентификатор алгоритма (ALG_ID), соответствующий данному объекту функции хэширования. Возвращается через буфер pbData. В pdwDataLen будет возвращена величина 4.
HP_HASHSIZE Размер значения функции хэширования. Величина DWORD, определяющая число байтов в значении функции хэширования, будет возвращена через буфер pbData. В pdwDataLen будет возвращена величина 4.
HP_HASHVAL Значение функции хэширования в little-endian порядке байт в соответствии с типом GostR3411-94-Digest CPCMS [RFC 4490]. Вычисленное значение функции хэширования будет возвращено через буфер pbData. Длина значения функции хэширования будет возвращена в pdwDataLen.
Во время вызова функции объект хэша "закрывается".
Для ГОСТ Р 34.11-94 и ГОСТ Р 34.11-2012 (и HMAC-ов на их основе) проводится дополнение до размера блока (если требуется), исполняются шаговые функции для последнего блока (если требуется), для длины и для контрольной суммы.
Для ГОСТ 28147-89 и ГОСТ Р 34.13-2015 (Магма и Кузнечик) в режиме имитовставки проводится дополнение до размера блока (если требуется), и исполняется шаговая функции для последнего блока (если требуется).
Расчёт хэш-функции может быть продолжен с помощью:
  • последующего вызова *SetHashParam(HP_OPEN, TRUE) для CSP 3.6 и выше;
  • предварительного вызова *DuplicateHash() - стандартный для Microsoft способ;
HP_OID Возвращает значение объектного идентификатора алгоритма хэша в виде строки, заканчивающейся нулем. Для объектов хэширования ГОСТ Р 34.11-94 и имитовставок ГОСТ 28147-89 возвращается идентификатор узла замены.
HP_OPAQUEBLOB Возвращает блоб, содержащий внутреннее состояние объекта имитовставки ГОСТ 28147-89.
HP_HASHSTATEBLOB Возвращает блоб, содержащий внутреннее состояние объектов хэширования CALG_GR3411, CALG_GR3411_2012_256, CALG_GR3411_2012_512.
HP_SHAREDKEYMODE Возвращает значение числа компонент, на которые раскладывается ключ объектом CALG_SHAREDKEY_HASH, либо из которых собирается ключ объектом CALG_FITTINGKEY_HASH.
HP_IKE_SPI_COOKIE Возвращает 32-35 байты значения хэша (при нумерации 0..63) для объектов типа CALG_GR3411_2012_512 и CALG_GR3411_2012_512_HMAC.
*pbData
[out] Указатель на буфер данных параметра. Функция копирует соответствующие параметру данные в буфер. Формат этих данных зависит от значения dwParam. Если параметр - NULL, то данные не копируются. Требуемый размер буфера в байтах возвращается в pdwDataLen. Подробнее см. Возвращение данных неопределённой длины.
*pdwDataLen
[in/out] Указатель на буфер, содержащий длину данных параметра. При вызове функции указанный параметр содержит число байтов в буфере pbData. После её исполнения параметр будет установлен числом байтов данных параметра, скопированных в буфер pbData. Если буфер, соответствующий pbData, недостаточно большой, чтобы в него копировать запрошенные данные, будет возвращён код ошибки ERROR_MORE_DATA через функцию SetLastError(). В этом случае требуемый размер буфера возвращается в pdwDataLen. Если функция завершается с кодом ошибки, отличным от ERROR_MORE_DATA, в этом параметре возвращается ноль.
dwFlags
[in] Значения флагов. Параметр зарезервирован для будущего использования и должен быть нулевым.

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

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

Требования:

AIX: 6/7.
FreeBSD: 11/12, pfSense 2.x.
Linux: LSB 4.x (RHEL 5/6/7/8, SuSE 11SP4/12/15, Oracle Linux 5/6/7/8, CentOS 6/7/8, Ubuntu 14.04/16.04/18.04/19.10, Linux Mint 18/19, Fedora 28/29/30/31, Debian 8/9/10 и др.).
Solaris: 10/11.
Mac OS X: 10.9/10.10/10.11/10.12/10.13/10.14/10.15.
iOS: 8/9/10/11/12/13.
Sailfish: 2/3.
Windows: 7/8/8.1/10, Server 2008/2008R2/2012/2012R2/2016/2019.
Файл описания: Прототип описан в файле wincsp.h.
Ядро ОС: Вместо неё используется аналогичная функция CPCGetHashParam .

См. также

CPCreateHash() ,CPGetKeyParam() ,CPSetHashParam() ,CPGetHashParam в MS CSP World Wide Web link ,CryptGetHashParam в MS CryptoAPI 2.0 World Wide Web link