Cryptography for Intel(R) Integrated Performance Primitives Developer Reference

Download
ID 768738
Date 12/16/2022
Public
Document Table of Contents
Document Table of Contents x
Developer Reference for Intel® Integrated Performance Primitives Cryptography
Developer Reference for Intel® Integrated Performance Primitives Cryptography x
Getting Help and Support What's New Notational Conventions Related Products Overview Symmetric Cryptography Primitive Functions One-Way Hash Primitives Data Authentication Primitive Functions Public Key Cryptography Functions Finite Field Arithmetic Multi-buffer Cryptography Functions Appendix A: Support Functions and Classes Removed Functions Bibliography Notices and Disclaimers
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 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 See Also Hash Functions for Non-Streaming Messages Mask Generation Functions
Hash Functions x
See Also HashGetSize HashInit HashPack, HashUnpack HashDuplicate HashUpdate HashFinal HashGetTag HashMethod HashMethodSet HashMethodGetSize SM3GetSize SM3Init SM3Pack, SM3Unpack SM3Duplicate SM3Update SM3Final SM3GetTag MD5GetSize MD5Init MD5Pack, MD5Unpack MD5Duplicate MD5Update MD5Final MD5GetTag SHA1GetSize SHA1Init SHA1Pack, SHA1Unpack SHA1Duplicate SHA1Update SHA1Final SHA1GetTag SHA224GetSize SHA224Init SHA224Pack, SHA224Unpack SHA224Duplicate SHA224Update SHA224Final SHA224GetTag SHA256GetSize SHA256Init SHA256Pack, SHA256Unpack SHA256Duplicate SHA256Update SHA256Final SHA256GetTag SHA384GetSize SHA384Init SHA384Pack, SHA384Unpack SHA384Duplicate SHA384Update SHA384Final SHA384GetTag SHA512GetSize SHA512Init SHA512Pack, SHA512Unpack SHA512Duplicate SHA512Update SHA512Final SHA512GetTag
Hash Functions for Non-Streaming Messages x
General Definition of a Hash Function HashMessage SM3MessageDigest MD5MessageDigest SHA1MessageDigest SHA224MessageDigest SHA256MessageDigest SHA384MessageDigest SHA512MessageDigest
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
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 Example of Using Pseudorandom Number Generation Functions
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 GF(p) x
ECCPGetSize ECCPGetSizeStd ECCPInit ECCPInitStd ECCPBindGxyTblStd ECCPSet ECCPSetStd ECCPGet ECCPGetOrderBitSize ECCPValidate ECCPPointGetSize ECCPPointInit ECCPSetPoint ECCPSetPointAtInfinity ECCPGetPoint ECCPCheckPoint ECCPComparePoint ECCPNegativePoint ECCPAddPoint ECCPMulPointScalar ECCPGenKeyPair ECCPPublicKey ECCPValidateKeyPair ECCPSetKeyPair ECCPSharedSecretDH ECCPSharedSecretDHC ECCPSignDSA ECCPVerifyDSA ECCPSignNR ECCPVerifyNR ECCPSignSM2 ECCPVerifySM2 Signing/Verification Using the Elliptic Curve Cryptography Functions over a Prime Finite Field
Functions based on SM2 x
GFpECESGetSize_SM2 GFpECESInit_SM2 GFpECESSetKey_SM2 GFpECESStart_SM2 GFpECESEncrypt_SM2 GFpECESDecrypt_SM2 GFpECESFinal_SM2 GFpECESGetBufferSize_SM2
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
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
Multi-buffer Cryptography Functions x
RSA Algorithm Functions 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 Modular Exponentiation
RSA Algorithm Functions 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_nistp256/384/521_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
Modular Exponentiation x
mbx_exp/1024/2048/3072/4096_mb8 mbx_exp_BufferSize
Appendix A: 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 Reference for Intel® Integrated Performance Primitives Cryptography

Hash Functions

NOTE:
The MD5 algorithm is considered weak due to known attacks on it. The functionality remains in the library, but the implementation will no longer be optimized and no security patches will be applied. A more secure alternative is available: SHA-2. For more information, see Fast Collision Attack on MD5 (https://eprint.iacr.org/2013/170.pdf) and How to Break MD5 and Other Hash Functions (http://merlot.usc.edu/csac-f06/papers/Wang05a.pdf).

Functions described in this section apply hash algorithms to digesting streaming messages.

Usage model of the generalized hash functions is similar to the model explained below.

A primitive implementing a hash algorithm uses the state context IppsHashState as an operational vehicle to carry all necessary variables to manage the computation of the chaining digest value.

The following example illustrates how the application code can apply the implemented SHA-1 hash standard to digest the input message stream.

  1. Call the function HashGetSize to get the size required to configure the IppsHashState context.

  2. Ensure that the required memory space is properly allocated. With the allocated memory, call the HashInit function with the value of hashAlg equal to ippHashAlg_SHA1 to set up the initial context state with the SHA-1 specified initialization vectors.

  3. Keep calling the function HashUpdate to digest incoming message stream in the queue till its completion. To determine the current value of the digest, call HashGetTag between the two calls to HashUpdate.

  4. Call the function HashFinal to pad the partial block into a final SHA-1 message block and transform it into a 160-bit message digest value.

  5. Clean up secret data stored in the context.

  6. Call the operating system memory free service function to release the IppsSHA1StateIppsHashState context.

The IppsHashState context is position-dependent. The HashPack, HashUnpack functions transform this context to a position-independent form and vice versa.

NOTE:

For memory-critical applications, consider using Reduced Memory Footprint Functions.

IMPORTANT:

The crypto community does not consider SHA-1 or MD5 algorithms secure anymore.

Recommendation: use a more secure hash algorithm (for example, any algorithm from the SHA-2 family) instead of SHA-1 or MD5.

Parent topic: One-Way Hash Primitives
  • HashGetSize
    Gets the size of the IppsHashState or IppsHashState_rmf context in bytes.
  • HashInit
    Initializes user-supplied memory as IppsHashState or IppsHashState_rmf context for future use.
  • HashPack, HashUnpack
    Packs/unpacks the IppsHashState or IppsHashState_rmf context into/from a user-defined buffer.
  • HashDuplicate
    Copies one IppsHashState or IppsHashState_rmf context to another.
  • HashUpdate
    Digests the current input message stream of the specified length.
  • HashFinal
    Completes computation of the digest value.
  • HashGetTag
    Computes the current digest value of the processed part of the message.
  • HashMethod
    Returns a pointer to a pre-defined hash algorithm.
  • HashMethodSet
    Initializes IppsHashMethod structure by pre-defined hash algorithm parameters.
  • HashMethodGetSize
    Gets the size of the IppsHashMethod context in bytes.
  • SM3GetSize
    Gets the size of the IppsSM3State context in bytes.
  • SM3Init
    Initializes user-supplied memory as IppsSM3State context for future use.
  • SM3Pack, SM3Unpack
    Packs/unpacks the IppsSM3State context into/from a user-defined buffer.
  • SM3Duplicate
    Copies one IppsSM3State context to another.
  • SM3Update
    Digests the current input message stream of the specified length.
  • SM3Final
    Completes computation of the SM3 digest value.
  • SM3GetTag
    Computes the current SM3 digest value of the processed part of the message.
  • MD5GetSize
    Gets the size of the IppsMD5State context in bytes (deprecated).
  • MD5Init
    Initializes user-supplied memory as IppsMD5State context for future use (deprecated).
  • MD5Pack, MD5Unpack
    Packs/unpacks the IppsMD5State context into/from a user-defined buffer (deprecated).
  • MD5Duplicate
    Copies one IppsMD5State context to another (deprecated).
  • MD5Update
    Digests the current input message stream of the specified length (deprecated).
  • MD5Final
    Completes computation of the MD5 digest value (deprecated).
  • MD5GetTag
    Computes the current MD5 digest value of the processed part of the message (deprecated).
  • SHA1GetSize
    Gets the size of the IppsSHA1State context in bytes.
  • SHA1Init
    Initializes user-supplied memory as IppsSHA1State context for future use.
  • SHA1Pack, SHA1Unpack
    Packs/unpacks the IppsSHA1State context into/from a user-defined buffer.
  • SHA1Duplicate
    Copies one IppsSHA1State context to another.
  • SHA1Update
    Digests the current input message stream of the specified length.
  • SHA1Final
    Completes computation of the SHA-1 digest value.
  • SHA1GetTag
    Computes the current SHA-1 digest value of the processed part of the message.
  • SHA224GetSize
    Gets the size of the IppsSHA224State context in bytes.
  • SHA224Init
    Initializes user-supplied memory as IppsSHA224State context for future use.
  • SHA224Pack, SHA224Unpack
    Packs/unpacks the IppsSHA224State context into/from a user-defined buffer.
  • SHA224Duplicate
    Copies one IppsSHA224State context to another.
  • SHA224Update
    Digests the current input message stream of the specified length.
  • SHA224Final
    Completes computation of the SHA-224 digest value.
  • SHA224GetTag
    Computes the current SHA-224 digest value of the processed part of the message.
  • SHA256GetSize
    Gets the size of the IppsSHA256State context in bytes.
  • SHA256Init
    Initializes user-supplied memory as IppsSHA256State context for future use.
  • SHA256Pack, SHA256Unpack
    Packs/unpacks the IppsSHA256State context into/from a user-defined buffer.
  • SHA256Duplicate
    Copies one IppsSHA256State context to another.
  • SHA256Update
    Digests the current input message stream of the specified length.
  • SHA256Final
    Completes computation of the SHA-256 digest value.
  • SHA256GetTag
    Computes the current SHA-256 digest value of the processed part of the message.
  • SHA384GetSize
    Gets the size of the IppsSHA384State context in bytes.
  • SHA384Init
    Initializes user-supplied memory as IppsSHA384State context for future use.
  • SHA384Pack, SHA384Unpack
    Packs/unpacks the IppsSHA384State context into/from a user-defined buffer.
  • SHA384Duplicate
    Copies one IppsSHA384State context to another.
  • SHA384Update
    Digests the current input message stream of the specified length.
  • SHA384Final
    Completes computing of the SHA-384 digest value.
  • SHA384GetTag
    Computes the current SHA-384 digest value of the processed part of the message.
  • SHA512GetSize
    Gets the size of the IppsSHA512State context in bytes.
  • SHA512Init
    Initializes user-supplied memory as IppsSHA512State context for future use.
  • SHA512Pack, SHA512Unpack
    Packs/unpacks the IppsSHA512State context into/from a user-defined buffer.
  • SHA512Duplicate
    Copies one IppsSHA512State context to another.
  • SHA512Update
    Digests the current input message stream of the specified length.
  • SHA512Final
    Completes computation of the SHA-512 digest value.
  • SHA512GetTag
    Computes the current SHA-512 digest value of the processed part of the message.

See Also

Level Two Title

Did you find the information on this page useful?

Characters remaining:

Feedback Message