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 Hash Functions for Non-Streaming Messages Mask Generation Functions
Hash Functions x
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

Functions Based on GF(p)

This section describes functions designed to specify the elliptic curve cryptosystem and perform various operations on the elliptic curve defined over a prime finite field. The examples of the operations are shown below:

  • Setting up operations: ECCPSet sets up elliptic curve domain parameters. ECCPSetKeyPair sets a pair of public and private keys for the given cryptosystem.
  • Computation operations: ECCPAddPoint adds two points on the elliptic curve. ECCPMulPointScalar performs the scalar multiplication of a point on the elliptic curve. ECCPSignDSA computes the digital signature of a message.
  • Validation operations: ECCPValidate checks validity of the elliptic curve domain parameters. ECCPValidateKeyPair validates correctness of the public and private keys.
  • Generation operations: ECCPGenKeyPair generates a private key and computes a public key for the given elliptic cryptosystem.
  • Retrieval operations: ECCPGet retrieves elliptic curve domain parameters. ECCPGetOrderBitSize retrieves the size of a base point in bytes.

All functions described in this section employ a context IppsECCPState that catches several auxiliary components specifying operations performed on the elliptic curve or entire elliptic cryptosystem. ECCP stands for Elliptic Curve Cryptography Prime and means that all functions whose name include this abbreviation perform operations over a prime finite field GF( p).

The IppECCType enumerator lists standard elliptic curves supported. You can select a particular type in a call to ECCPSetStd.

The table below associates each value of IppECCType with parameters of the elliptic curve and provides a reference to the appropriate specification.

Standard Elliptic Curves

Value of IppECCType

Name of the Curve

Reference

ippECarbitrary

Not applicable

No reference because of arbitrary parameters.

ippECstd112r1

secp112r1

[SEC2]

ippECstd112r2

secp112r2

[SEC2]

ippECstd128r1

secp128r1

[SEC2]

ippECstd128r2

secp128r2

[SEC2]

ippECstd160r1

secp160r1

[SEC2]

ippECstd160r2

secp160r2

[SEC2]

ippECstd192r1

secp192r1

[SEC2]

ippECstd224r1

secp224r1

[SEC2]

ippECstd256r1

secp256r1

[SEC2]

ippECstd384r1

secp384r1

[SEC2]

ippECstd521r1

secp521r1

[SEC2]

ippECstdSM2

SM2

[SM2]

For more information on parameters recommended for the functions, see [SEC2] and [SM2].

IMPORTANT:

To provide minimum security of the elliptic curve cryptosystem over a prime finite field, the length of the underlying prime must be equal to or greater than 160 bits.

Parent topic: Elliptic Curve Cryptography Functions
  • ECCPGetSize
    Gets the size of the IppsECCPState context.
  • ECCPGetSizeStd
    Gets the size of the IppsECCPState context for a standard elliptic curve.
  • ECCPInit
    Initializes the context for the elliptic curve cryptosystem over GF(p).
  • ECCPInitStd
    Initializes the context for the cryptosystem based on a standard elliptic curve.
  • ECCPBindGxyTblStd
    Enable the use of base point-based pre-computed tables of standard elliptic curves.
  • ECCPSet
    Sets up elliptic curve domain parameters over GF(p).
  • ECCPSetStd
    Sets up a recommended set of domain parameters for an elliptic curve over GF(p).
  • ECCPGet
    Retrieves elliptic curve domain parameters over GF(p).
  • ECCPGetOrderBitSize
    Retrieves order size of the elliptic curve base point over GF(p) in bits.
  • ECCPValidate
    Checks validity of the elliptic curve domain parameters over GF(p).
  • ECCPPointGetSize
    Gets the size of the IppsECCPPoint context in bytes for a point on the elliptic curve point defined over GF(p).
  • ECCPPointInit
    Initializes the context for a point on the elliptic curve defined over GF(p).
  • ECCPSetPoint
    Sets coordinates of a point on the elliptic curve defined over GF(p).
  • ECCPSetPointAtInfinity
    Sets the point at infinity.
  • ECCPGetPoint
    Retrieves coordinates of the point on the elliptic curve defined over GF(p).
  • ECCPCheckPoint
    Checks correctness of the point on the elliptic curve defined over GF(p).
  • ECCPComparePoint
    Compares two points on the elliptic curve defined over GF(p).
  • ECCPNegativePoint
    Finds an elliptic curve point which is an additive inverse for the given point over GF(p).
  • ECCPAddPoint
    Computes the addition of two elliptic curve points over GF(p).
  • ECCPMulPointScalar
    Performs scalar multiplication of a point on the elliptic curve defined over GF(p).
  • ECCPGenKeyPair
    Generates a private key and computes public keys of the elliptic cryptosystem over GF(p).
  • ECCPPublicKey
    Computes a public key from the given private key of the elliptic cryptosystem over GF(p).
  • ECCPValidateKeyPair
    Validates private and public keys of the elliptic cryptosystem over GF(p).
  • ECCPSetKeyPair
    Sets private and/or public keys of the elliptic cryptosystem over GF(p).
  • ECCPSharedSecretDH
    Computes a shared secret field element by using the Diffie-Hellman scheme.
  • ECCPSharedSecretDHC
    Computes a shared secret field element by using the Diffie-Hellman scheme and the elliptic curve cofactor.
  • ECCPSignDSA
    Computes a digital signature over a message digest.
  • ECCPVerifyDSA
    Verifies authenticity of the digital signature over a message digest (ECDSA).
  • ECCPSignNR
    Computes the digital signature over a message digest (the Nyberg-Rueppel scheme).
  • ECCPVerifyNR
    Verifies authenticity of the digital signature over a message digest (the Nyberg-Rueppel scheme).
  • ECCPSignSM2
    Computes a digital signature over a message digest using the SM2 scheme.
  • ECCPVerifySM2
    Verifies authenticity of a digital signature over a message digest using the SM2 scheme.
  • Signing/Verification Using the Elliptic Curve Cryptography Functions over a Prime Finite Field
Level Two Title

Did you find the information on this page useful?

Characters remaining:

Feedback Message