Developer Guide and Reference for Intel® Cryptography Primitives Library
A newer version of this document is available. Customers should click here to go to the newest version.
ippsMLKEM_GetInfo
Fills IppsMLKEMInfo structure with the sizes corresponding to the given scheme type.
Syntax
IppStatus ippsMLKEM_GetInfo(IppsMLKEMInfo* pInfo, IppsMLKEMParamSet schemeType);
Include Files
ippcp.h
Parameters
pInfo |
Pointer to the ML-KEM pInfo structure. |
schemeType |
Parameter specifying the scheme type. See Supported ML-KEM parameters for more information. |
Description
The function fills IppsMLKEMInfo structure with the sizes corresponding to the given scheme type. The sizes are used to allocate memory for the public key, secret key, ciphertext, and shared secret.
IppsMLKEMInfo is the public data type and has the following structure:
typedef struct {
int encapsKeySize;
int decapsKeySize;
int cipherTextSize;
int sharedSecretSize;
} IppsMLKEMInfo;
Important
The API family is supported in experimental mode. To use the functions, users need to define the IPPCP_PREVIEW_ML_KEM macro before including the ippcp.h header file. See Preview Features for more details.Return Values
ippStsNoErr |
Indicates no error. Any other value indicates an error or warning. |
ippStsNullPtrErr |
pInfo is a NULL pointer. |
ippStsBadArgErr |
schemeType is not supported. |