Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Note
Cierta información se relaciona con un producto de versión preliminar que puede modificarse sustancialmente antes de su publicación comercial. Microsoft no ofrece ninguna garantía, expresa o implícita, con respecto a la información proporcionada aquí. La característica descrita en este tema está disponible en versiones preliminares de Windows Insider Preview.
The NCryptEncapsulate function performs the Encapsulation operation of a Key Encapsulation Mechanism (KEM). Genera una clave secreta compartida y la cifra con la clave pública proporcionada para generar un texto cifrado KEM, devolviendo tanto la clave secreta compartida como el texto cifrado KEM.
Syntax
NTSTATUS NCryptEncapsulate (
[in] NCRYPT_KEY_HANDLE hKey
[out] PBYTE pbSecretKey,
[in] ULONG cbSecretKey,
[out] ULONG *pcbSecretKey,
[out] PBYTE pbCipherText,
[in] ULONG cbCipherText,
[out] ULONG *pcbCipherText,
[in] ULONG dwFlags
);
Parameters
hKey[in]
Identificador de la clave que se va a usar para la operación de encapsulación.
pbSecretKey[out]
Puntero a un búfer que recibe la clave secreta compartida. See remarks for more information.
cbSecretKey[in]
The size, in bytes, of the pbSecretKey buffer.
pcbSecretKey[out]
A pointer to a ULONG variable that the receives the number of bytes written to pbSecretKey buffer.
If pbSecretKey is NULL, this receives the size, in bytes, required for the shared secret key.
See remarks for more information.
pbCipherText[out]
Puntero a un búfer que recibe el texto cifrado KEM. See remarks for more information.
cbCipherText[in]
The size, in bytes, of the pbCipherText buffer.
pcbCipherText[out]
A pointer to a ULONG variable that the receives the number of bytes written to pbCipherText buffer.
If pbCipherText is NULL, this receives the size, in bytes, required for the KEM ciphertext.
See remarks for more information.
dwFlags[in]
Reservado, debe ser cero.
Return value
Devuelve un código de estado que indica el éxito o error de la función.
Entre los códigos de retorno posibles se incluyen, entre otros, los siguientes.
| Return Code | Description |
|---|---|
ERROR_SUCCESS |
La función se realizó correctamente. |
NTE_BAD_FLAGS |
The dwFlags parameter contains a value that is not valid. |
NTE_INVALID_PARAMETER |
One or more required parameters (hKey, pcbSecretKey, pcbCipherText) is NULL, or one of the parameters has an invalid value. |
NTE_BUFFER_TOO_SMALL |
An output buffer size (cbSecretKey, cbCipherText) is too small for the result of the encapsulation for the KEM parameters associated with the encapsulation key. pcbSecretKey receives the number of bytes required for pbSecretKey, pcbCipherText receives the number of bytes required for pbCipherText. |
Remarks
To query the required sizes of the pbSecretKey and pbCipherText buffers, callers may call NCryptEncapsulate with NULL values in pbSecretKey and pbCipherText. The required size will be returned in pcbSecretKey and pcbCipherText, respectively. Esta consulta es eficaz y devuelve el tamaño sin realizar la encapsulación.
Equivalently, use NCryptGetProperty to query the NCRYPT_KEM_SHARED_SECRET_LENGTH_PROPERTY property of the algorithm or key handle, and the NCRYPT_KEM_CIPHERTEXT_LENGTH_PROPERTY property of the key handle.
Para los algoritmos KEM admitidos actualmente (ML-KEM), la longitud del secreto compartido es un tamaño constante para un algoritmo determinado y la longitud del texto cifrado KEM es un tamaño constante para un conjunto de parámetros determinado.
Requirements
| Requirement | Value |
|---|---|
| Cliente mínimo compatible | Windows Insiders (compilación 27843): Comienza la compatibilidad con ML-KEM. [solo aplicaciones de escritorio] |
| Servidor mínimo admitido | Windows Insiders (compilación 27843): Comienza la compatibilidad con ML-KEM. [solo aplicaciones de escritorio] |
| Library | Ncrypt.lib |
| DLL | Ncrypt.dll |