Función CryptHashToBeSigned (wincrypt.h)

Artículo
03/15/2023

Importante Esta API está en desuso. El software nuevo y existente debe empezar a usar las API cryptography Next Generation. Microsoft puede quitar esta API en futuras versiones.

La función CryptHashToBeSigned calcula el hash del contenido codificado a partir de un certificado firmado y codificado. El hash se realiza solo en el contenido codificado "para firmar" y su firma.

Sintaxis

BOOL CryptHashToBeSigned(
  [in]      HCRYPTPROV_LEGACY hCryptProv,
  [in]      DWORD             dwCertEncodingType,
  [in]      const BYTE        *pbEncoded,
  [in]      DWORD             cbEncoded,
  [out]     BYTE              *pbComputedHash,
  [in, out] DWORD             *pcbComputedHash
);

Parámetros

[in] hCryptProv

Este parámetro no se usa y debe establecerse en NULL.

Windows Server 2003 y Windows XP: Identificador del proveedor de servicios criptográficos (CSP) que se va a usar para calcular el hash. El tipo de datos de este parámetro es HCRYPTPROV.

A menos que haya un motivo seguro para pasar un proveedor criptográfico específico en hCryptProv, se pasa cero. Pasar cero hace que se adquiera el proveedor PREDETERMINADO RSA o Digital Signature Standard (DSS) antes de realizar operaciones de cifrado de hash, comprobación de firmas o destinatarios.

[in] dwCertEncodingType

Especifica el tipo de codificación utilizado. Siempre es aceptable especificar los tipos de codificación de certificados y mensajes mediante su combinación con una operación OR bit a bit, como se muestra en el ejemplo siguiente:

X509_ASN_ENCODING | PKCS_7_ASN_ENCODING

Los tipos de codificación definidos actualmente son:

X509_ASN_ENCODING
PKCS_7_ASN_ENCODING

[in] pbEncoded

Dirección de un búfer que contiene el contenido que se va a aplicar un algoritmo hash. Esta es la forma codificada de un CERT_SIGNED_CONTENT_INFO.

[in] cbEncoded

Tamaño del búfer en bytes.

[out] pbComputedHash

Puntero a un búfer para recibir el hash calculado.

Este parámetro puede ser NULL para establecer el tamaño de esta información con fines de asignación de memoria. Para obtener más información, vea Recuperación de datos de longitud desconocida.

[in, out] pcbComputedHash

Puntero a un DWORD que contiene el tamaño, en bytes, del búfer al que apunta el parámetro pbComputedHash . Cuando se devuelve la función, DWORD contiene el número de bytes almacenados en el búfer.

Nota Al procesar los datos devueltos en el búfer, las aplicaciones deben usar el tamaño real de los datos devueltos. El tamaño real puede ser ligeramente menor que el tamaño del búfer especificado en la entrada. En la entrada, los tamaños de búfer suelen especificarse lo suficientemente grandes como para asegurarse de que los datos de salida más grandes posibles caben en el búfer. En la salida, la variable a la que apunta este parámetro se actualiza para reflejar el tamaño real de los datos copiados en el búfer.

Valor devuelto

Si la función se ejecuta correctamente, la función devuelve un valor distinto de cero (TRUE).

Si se produce un error en la función, devuelve cero (FALSE). Para obtener información de error extendida, llame a GetLastError.

Nota Los errores de las funciones llamadas CryptCreateHash, CryptGetHashParam y CryptHashData podrían propagarse a esta función. Esta función tiene los siguientes códigos de error.

Código devuelto	Descripción
ERROR_MORE_DATA	Si el búfer especificado por el parámetro pbComputedHash no es lo suficientemente grande como para contener los datos devueltos, la función establece el código ERROR_MORE_DATA y almacena el tamaño de búfer necesario, en bytes, en la variable a la que apunta pcbComputedHash.
ERROR_FILE_NOT_FOUND	Tipo de codificación de certificado no válido. Actualmente solo se admiten X509_ASN_ENCODING.
NTE_BAD_ALGID	El identificador de objeto (OID) del algoritmo de firma no se asigna a un algoritmo hash conocido o compatible.

Si se produce un error en la función, GetLastError puede devolver un error de codificación y descodificación de sintaxis abstracta uno (ASN.1). Para obtener información sobre estos errores, vea Valores devueltos de codificación y descodificación de ASN.1.

Requisitos


Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	wincrypt.h
Library	Crypt32.lib
Archivo DLL	Crypt32.dll

Consulte también

CryptHashCertificate

CryptHashPublicKeyInfo

funciones de Administración de datos

Compartir a través de