Developer Guide and Reference for Intel® Cryptography Primitives Library

Download PDF
ID 834196
Date 10/31/2024
Public
Document Table of Contents
Document Table of Contents x
Developer Guide and Reference for Intel® Cryptography Primitives Library
Developer Guide and Reference for Intel® Cryptography Primitives Library x
Introducing Intel® Cryptography Primitives Library Getting Help and Support Notational Conventions Getting Started with Intel® Cryptography Primitives Library Theory of Operation Linking Your Application with Intel® Cryptography Primitives Library Using Custom Library Tool for Intel® Cryptography Primitives Library Programming with Intel® Cryptography Primitives Library in the Microsoft* Visual Studio* IDE Performance Test Tool (perfsys) Command Line Options Preview Features Intel® Cryptography Primitives Library API Reference Notices and Disclaimers
Getting Started with Intel® Cryptography Primitives Library x
Finding Intel® Cryptography Primitives Library on Your System Setting Environment Variables Compiler Integration Building Intel® Cryptography Primitives Library Applications Finding the Intel® Cryptography Primitives Library Documentation
Theory of Operation x
Dispatching Function Naming Conventions Support Functions
Linking Your Application with Intel® Cryptography Primitives Library x
Linking Options
Using Custom Library Tool for Intel® Cryptography Primitives Library x
System Requirements for Custom Library Tool Operation Modes Building a Custom DLL with Custom Library Tool Using Console Version of Custom Library Tool
Programming with Intel® Cryptography Primitives Library in the Microsoft* Visual Studio* IDE x
Linking Your Microsoft* Visual Studio* Project with Intel® Cryptography Primitives Library Using the IntelliSense* Features
Intel® Cryptography Primitives Library API Reference x
Related Products Overview Symmetric Cryptography Primitive Functions One-Way Hash Primitives Data Authentication Primitive Functions Public Key Cryptography Functions Finite Field Arithmetic Mitigation for Frequency Throttling Side-Channel Attack Multi-buffer Cryptography Functions Support Functions and Classes Deprecated Functions Bibliography
Overview x
Basic Features Function Context Structures Data Security Considerations
Symmetric Cryptography Primitive Functions x
Block Cipher Modes of Operation Rijndael Functions AES-CCM Functions AES-GCM Functions AES-SIV Functions AES-XTS Functions TDES Functions SMS4 Functions ARCFour Functions
Rijndael Functions x
AESGetSize AESInit AESSetKey AESPack, AESUnpack AESEncryptECB AESDecryptECB AESEncryptCBC AESDecryptCBC AESEncryptCBC_CS AESDecryptCBC_CS AESEncryptCFB AES_EncryptCFB16_MB AESDecryptCFB AESEncryptOFB AESDecryptOFB AESEncryptCTR AESDecryptCTR AESEncryptXTS_Direct, AESDecryptXTS_Direct Example of Using AES Functions
AES-CCM Functions x
AES_CCMGetSize AES_CCMInit AES_CCMStart AES_CCMEncrypt AES_CCMDecrypt AES_CCMGetTag AES_CCMMessageLen AES_CCMTagLen
AES-GCM Functions x
AES_GCMGetSize AES_GCMInit Syntax Include Files Parameters Description Return Values AES_GCMReinit AES_GCMStart AES_GCMReset AES_GCMProcessIV AES_GCMProcessAAD AES_GCMEncrypt AES_GCMDecrypt AES_GCMGetTag
AES-SIV Functions x
AES_S2V_CMAC AES_SIVEncrypt AES_SIVDecrypt Usage Example
AES-XTS Functions x
AES_XTSGetSize AES_XTSInit AES_XTSEncrypt AES_XTSDecrypt
TDES Functions x
DESGetSize DESInit DESPack, DESUnpack TDESEncryptECB TDESDecryptECB TDESEncryptCBC TDESDecryptCBC TDESEncryptCFB TDESDecryptCFB TDESEncryptOFB TDESDecryptOFB TDESEncryptCTR TDESDecryptCTR Example of Using TDES Functions
SMS4 Functions x
SMS4GetSize SMS4Init SMS4SetKey SMS4EncryptECB SMS4DecryptECB SMS4EncryptCBC SMS4DecryptCBC SMS4EncryptCBC_CS SMS4DecryptCBC_CS SMS4EncryptCFB SMS4DecryptCFB SMS4EncryptOFB SMS4DecryptOFB SMS4EncryptCTR SMS4DecryptCTR
ARCFour Functions x
ARCFourGetSize ARCFourCheckKey ARCFourInit ARCFourPack, ARCFourUnpack ARCFourEncrypt ARCFourDecrypt ARCFourReset
One-Way Hash Primitives x
Hash Functions Hash Functions for Non-Streaming Messages Mask Generation Functions
Hash Functions x
HashGetSize HashInit HashPack, HashUnpack HashDuplicate HashUpdate HashFinal HashGetTag HashMethod HashMethodSet HashStateMethodSet HashMethodGetSize
Hash Functions for Non-Streaming Messages x
General Definition of a Hash Function HashMessage
Mask Generation Functions x
User’s Implementation of a Mask Generation Function MGF MGF1_rmf, MGF2_rmf
Data Authentication Primitive Functions x
Message Authentication Functions
Message Authentication Functions x
Keyed Hash Functions CMAC Functions
Keyed Hash Functions x
HMAC_GetSize HMAC_Init HMAC_Pack, HMAC_Unpack HMAC_Duplicate HMAC_Update HMAC_Final HMAC_GetTag HMAC_Message
CMAC Functions x
AES_CMACGetSize AES_CMACInit AES_CMACUpdate AES_CMACFinal AES_CMACGetTag
Public Key Cryptography Functions x
Big Number Arithmetic Montgomery Reduction Scheme Functions Pseudorandom Number Generation Functions Prime Number Generation Functions RSA Algorithm Functions Discrete-Logarithm-Based Cryptography Functions Elliptic Curve Cryptography Functions Post-quantum Functions
Big Number Arithmetic x
BigNumGetSize BigNumInit Set_BN SetOctString_BN GetSize_BN Get_BN ExtGet_BN Ref_BN GetOctString_BN Cmp_BN CmpZero_BN Add_BN Sub_BN Mul_BN MAC_BN_I Div_BN Mod_BN Gcd_BN ModInv_BN
Montgomery Reduction Scheme Functions x
MontGetSize MontInit MontSet MontGet MontForm MontMul Example of Using Montgomery Reduction Scheme Functions MontExp
Pseudorandom Number Generation Functions x
User’s Implementation of a Pseudorandom Number Generator PRNGGetSize PRNGInit PRNGSetSeed PRNGGetSeed PRNGSetAugment PRNGSetModulus PRNGSetH0 PRNGen PRNGenRDRAND TRNGenRDSEED PRNGen_BN PRNGenRDRAND_BN TRNGenRDSEED_BN
Prime Number Generation Functions x
PrimeGetSize PrimeInit PrimeGen_BN PrimeTest_BN PrimeGen PrimeTest PrimeSet PrimeSet_BN PrimeGet PrimeGet_BN Example of Using Prime Number Generation Functions
RSA Algorithm Functions x
Functions for Building RSA System RSA Primitives RSA Encryption Schemes RSA Signature Schemes
Functions for Building RSA System x
RSA_GetSizePublicKey, RSA_GetSizePrivateKeyType1, RSA_GetSizePrivateKeyType2 RSA_InitPublicKey, RSA_InitPrivateKeyType1, RSA_InitPrivateKeyType2 RSA_SetPublicKey, RSA_SetPrivateKeyType1, RSA_SetPrivateKeyType2 RSA_GetPublicKey, RSA_GetPrivateKeyType1, RSA_GetPrivateKeyType2 RSA_GetBufferSizePublicKey, RSA_GetBufferSizePrivateKey RSA_MB_GetBufferSizePublicKey, RSA_MB_GetBufferSizePrivateKey RSA_GenerateKeys RSA_ValidateKeys
RSA Primitives x
RSA_Encrypt RSA_MB_Encrypt RSA_Decrypt RSA_MB_Decrypt Example of Using RSA Primitive Functions
RSA Encryption Schemes x
RSA-OAEP Scheme Functions PKCS V1.5 Encryption Scheme Functions
RSA-OAEP Scheme Functions x
RSAEncrypt_OAEP RSADecrypt_OAEP
PKCS V1.5 Encryption Scheme Functions x
RSAEncrypt_PKCSv15 RSADecrypt_PKCSv15
RSA Signature Schemes x
RSA-SSA Scheme Functions PKCS V1.5 Signature Scheme Functions
RSA-SSA Scheme Functions x
RSASign_PSS RSA_MB_Sign_PSS_rmf RSAVerify_PSS RSA_MB_Verify_PSS_rmf
PKCS V1.5 Signature Scheme Functions x
RSASign_PKCS1v15 RSA_MB_Sign_PKCS1v15_rmf RSAVerify_PKCS1v15 RSA_MB_Verify_PKCS1v15_rmf
Discrete-Logarithm-Based Cryptography Functions x
DLPGetSize DLPInit DLPPack, DLPUnpack DLPSet DLPGet DLPSetDP DLPGetDP DLPGenKeyPair DLPPublicKey DLPValidateKeyPair DLPSetKeyPair DLPGenerateDSA DLPValidateDSA DLPSignDSA DLPVerifyDSA Example of Using Discrete-logarithm Based Primitive Functions DLPGenerateDH DLPValidateDH DLPSharedSecretDH DLGetResultString
Elliptic Curve Cryptography Functions x
Functions Based on GF(p) Functions based on SM2 Arithmetic of the Group of Elliptic Curve Points ECCGetResultString
Functions based on SM2 x
GFpECESGetSize_SM2 GFpECESInit_SM2 GFpECESSetKey_SM2 GFpECESStart_SM2 GFpECESEncrypt_SM2 GFpECESDecrypt_SM2 GFpECESFinal_SM2 GFpECESGetBufferSize_SM2 GFpECEncryptSM2_Ext_EncMsgSize GFpECDecryptSM2_Ext_DecMsgSize GFpECEncryptSM2_Ext GFpECDecryptSM2_Ext GFpECMessageRepresentationSM2 GFpECUserIDHashSM2 GFpECKeyExchangeSM2_GetSize GFpECKeyExchangeSM2_Init GFpECKeyExchangeSM2_Setup GFpECKeyExchangeSM2_SharedKey GFpECKeyExchangeSM2_Confirm
Arithmetic of the Group of Elliptic Curve Points x
GFpECGetSize GFpECInit GFpECSet GFpECSetSubgroup GFpECInitStd GFpECGet GFpECGetSubgroup GFpECScratchBufferSize GFpECVerify GFpECPointGetSize GFpECPointInit GFpECSetPointAtInfinity GFpECSetPoint, GFpECSetPointREgular GFpECSetPointOctString GFpECSetPointRandom GFpECMakePoint GFpECSetPointHash, GFpECSetPointHashBackCompatible, GFpECSetPointHash_rmf, GFpECSetPointHashBackCompatible_rmf GFpECGetPoint , GFpECGetPointRegular GFpECGetPointOctString GFpECTstPoint GFpECTstPointInSubgroup GFpECCpyPoint GFpECCmpPoint GFpECNegPoint GFpECAddPoint GFpECMulPoint GFpECPrivateKey, GFpECPublicKey, GFpECTstKeyPair GFpECPublicKey GFpECTstKeyPair GFpECPSharedSecretDH, GFpECPSharedSecretDHC GFpECSharedSecretDHC GFpECPSignDSA, GFpECPSignNR, GFpECPSignSM2 GFpECPVerifyDSA, GFpECPVerifyNR, GFpECPVerifySM2 GFpECSignNR GFpECVerifyNR GFpECSignSM2 GFpECVerifySM2
Post-quantum Functions x
XMSS LMS
XMSS x
XMSS Verification Supported XMSS Algorithms Get Size Of XMSS Public Key Get Size Of XMSS Signature State Get Size Of Temporary Buffer Set XMSS Public Key State Set XMSS Signature State
LMS x
LMS Verification Supported LMS Algorithms Get Size Of LMS Public Key Get Size Of LMS Signature State Get Size Of Temporary Buffer Set LMS Public Key State Set LMS Signature State
Finite Field Arithmetic x
GFpInit GFpMethod GFpGetSize GFpxInitBinomial GFpxInit GFpxMethod GFpxGetSize GFpScratchBufferSize GFpElementGetSize GFpElementInit GFpSetElement GFpSetElementOctString GFpSetElementRandom GFpSetElementHash GFpCpyElement GFpGetElement GFpGetElementOctString GFpCmpElement GFpIsZeroElement GFpIsUnityElement GFpConj GFpNeg GFpInv GFpSqrt GFpAdd GFpSub GFpMul GFpSqr GFpExp GFpMultiExp GFpAdd_PE GFpSub_PE GFpMul_PE
Mitigation for Frequency Throttling Side-Channel Attack x
ippsAESSetupNoise ippsAES_GCMSetupNoise ippsAES_CMACSetupNoise
Multi-buffer Cryptography Functions x
RSA Algorithm Functions (MBX) NIST Recommended Elliptic Curve Functions Montgomery Curve25519 Elliptic Curve Functions Edwards Curve25519 Elliptic Curve Functions SM2 Elliptic Curve Functions SM3 Hash Functions SM4 Algorithm Functions SM4 XTS Algorithm Functions SM4 CCM Algorithm Functions SM4 GCM Algorithm Functions Modular Exponentiation
RSA Algorithm Functions (MBX) x
mbx_rsa_public mbx_rsa_private mbx_rsa_private_crt mbx_RSA_Method_BufSize
NIST Recommended Elliptic Curve Functions x
mbx_nistp256/384/521_ecdsa_sign_setup mbx_nistp256/384/521_ecdsa_sign_complete mbx_nistp256/384/521_ecdsa_sign mbx_nistp256/384/521_ecdsa_verify mbx_nistp256/384/521_ecpublic_key mbx_nistp256/384/521_ecdh
Montgomery Curve25519 Elliptic Curve Functions x
mbx_x25519_public_key mbx_x25519
Edwards Curve25519 Elliptic Curve Functions x
mbx_ed25519_public_key_mb8 mbx_ed25519_sign_mb8 mbx_ed25519_verify_mb8
SM2 Elliptic Curve Functions x
mbx_sm2_ecdsa_sign mbx_sm2_ecdsa_verify mbx_sm2_ecpublic_key mbx_sm2_ecdh
SM3 Hash Functions x
mbx_sm3_msg_digest_mb16 mbx_sm3_init_mb16 mbx_sm3_update_mb16 mbx_sm3_final_mb16
SM4 Algorithm Functions x
mbx_sm4_set_key_mb16 mbx_sm4_encrypt/decrypt_ecb_mb16 mbx_sm4_encrypt/decrypt_cbc_mb16 mbx_sm4_encrypt/decrypt_ctr128_mb16 mbx_sm4_encrypt/decrypt_ofb_mb16 mbx_sm4_encrypt/decrypt_cfb128_mb16
SM4 XTS Algorithm Functions x
mbx_sm4_xts_set_keys_mb16 mbx_sm4_xts_encrypt/decrypt_mb16
SM4 CCM Algorithm Functions x
mbx_sm4_ccm_init_mb16 mbx_sm4_ccm_update_aad_mb16 mbx_sm4_ccm_encrypt/decrypt_mb16 mbx_sm4_ccm_get_tag_mb16
SM4 GCM Algorithm Functions x
mbx_sm4_gcm_init_context_mb16 mbx_sm4_gcm_update_iv_mb16 mbx_sm4_gcm_update_aad_mb16 mbx_sm4_gcm_encrypt/decrypt_mb16 mbx_sm4_gcm_get_tag_mb16
Modular Exponentiation x
mbx_exp/1024/2048/3072/4096_mb8 mbx_exp_BufferSize
Support Functions and Classes x
Security Validation of Library Functions Version Information Function Dispatcher Control Functions Other Functions Classes and Functions Used in Examples
Version Information Function x
GetLibVersion
Dispatcher Control Functions x
Init
Other Functions x
GetCpuFeatures SetCpuFeatures GetEnabledCpuFeatures GetCpuClocks GetNumThreads GetEnabledNumThreads SetNumThreads GetStatusString
Classes and Functions Used in Examples x
BigNumber Class Functions for Creation of Cryptographic Contexts
Developer Guide and Reference for Intel® Cryptography Primitives Library

AES_GCMInit

Level Two Title