Udostępnij przez


NCryptDecapsulate function

Note

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed jego wydaniem komercyjnym. Firma Microsoft nie udziela żadnych gwarancji, wyraźnych ani domniemanych, w odniesieniu do podanych tutaj informacji. Funkcja opisana w tym temacie jest dostępna w wersjach wstępnych programu Windows Insider Preview.

The NCryptDecapsulate function performs the Decapsulation operation of a Key Encapsulation Mechanism (KEM). Pobiera on szyfr KEM i odszyfrowuje go przy użyciu podanego klucza prywatnego, zwracając wspólny klucz tajny.

Jeśli tekst szyfrowania jest poprawnie sformatowany, ale nie jest zgodny z kluczem decapsulacji, ten interfejs API powiedzie się, ale zostanie wygenerowany losowy wspólny klucz tajny.

Syntax

SECURITY_STATUS NCryptDecapsulate (
 [in]    NCRYPT_KEY_HANDLE hKey,
 [in]    PCBYTE            pbCipherText,
 [in]    ULONG             cbCipherText,
 [out]   PBYTE             pbSecretKey,
 [in]    ULONG             cbSecretKey,
 [out]   ULONG             *pcbSecretKey,
 [in]    ULONG             dwFlags
);

Parameters

hKey[in]

Uchwyt klucza do użycia dla operacji demetyzacji.

pbCipherText[in]

Wskaźnik do buforu zawierającego szyfr KEM. The NCryptEncapsulate function may be used to create a KEM ciphertext.

cbCipherText[in]

The size, in bytes, of the pbCipherText buffer.

pbSecretKey[out]

Wskaźnik do buforu, który odbiera wspólny klucz tajny. 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.

dwFlags[in]

Zarezerwowane, musi mieć wartość zero.

Return value

Zwraca kod stanu wskazujący powodzenie lub niepowodzenie funkcji.

Możliwe kody powrotne obejmują, ale nie są ograniczone do następujących.

Return Code Description
ERROR_SUCCESS Funkcja zakończyła się pomyślnie.
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) is too small for the result decapsulation operation for the KEM parameters associated with the decapsulation key. pcbSecretKey receives the number of bytes required for pbSecretKey.

Remarks

To query the required size of the pbSecretKey buffer needed for the KEM shared secret key, call NCryptDecapsulate with a NULLpbSecretKey. The required size will be returned in pcbSecretKey. To zapytanie jest wydajne i zwraca rozmiar bez przeprowadzania decapsulacji. Equivalently, use NCryptGetProperty to query the NCRYPT_KEM_SHARED_SECRET_LENGTH_PROPERTY property of the algorithm or key handle. W przypadku obecnie obsługiwanych algorytmów KEM (ML-KEM) współdzielona długość wpisu tajnego jest stałym rozmiarem danego algorytmu.

Additional remarks

Given an invalid, but correctly-sized, ciphertext, the ML-KEM decapsulation operation will implicitly reject the ciphertext by returning success in equal time to a valid decapsulation operation, with pseudo-random agreed secret output. Wymusza to niepowodzenie protokołów wyższego poziomu później, gdy klucze symetryczne elementów równorzędnych nie są zgodne. So, decapsulate will only ever fail if there are programming errors (i.e. incorrect size, use of uninitialized hKey), or something fundamentally goes wrong with the environment (i.e. internal memory allocation fails, or self-test detect hardware error).

Requirements

Requirement Value
Minimalny obsługiwany klient Niejawni testerzy systemu Windows (kompilacja 27843): Rozpoczyna się obsługa ML-KEM. [Tylko aplikacje klasyczne]
Minimalna obsługiwana wersja serwera Niejawni testerzy systemu Windows (kompilacja 27843): Rozpoczyna się obsługa ML-KEM. [Tylko aplikacje klasyczne]
Library Ncrypt.lib
DLL Ncrypt.dll

See also

NCryptEncapsulate

NCryptGetProperty

BCryptEncapsulate

BCryptDecapsulate