Nuta
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować się zalogować lub zmienić katalog.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
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 NCryptEncapsulate function performs the Encapsulation operation of a Key Encapsulation Mechanism (KEM). Generuje on wspólny klucz tajny i szyfruje go przy użyciu podanego klucza publicznego w celu utworzenia szyfrowania KEM, zwracając zarówno wspólny klucz tajny, jak i szyfr 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]
Uchwyt klucza do użycia dla operacji hermetyzacji.
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.
pbCipherText[out]
Wskaźnik do buforu, który odbiera szyfr 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]
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, 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. To zapytanie jest wydajne i zwraca rozmiar bez wykonywania hermetyzacji.
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.
W przypadku obecnie obsługiwanych algorytmów KEM (ML-KEM) długość wspólnego wpisu tajnego jest stałym rozmiarem danego algorytmu, a długość szyfrowania KEM jest stałym rozmiarem danego zestawu parametrów.
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 |