/**\r
Retrieves the size, in bytes, of the context buffer required for MD4 hash operations.\r
\r
+ If this interface is not supported, then return zero.\r
+\r
@return The size, in bytes, of the context buffer required for MD4 hash operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
subsequent use.\r
\r
If Md4Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] Md4Context Pointer to MD4 context being initialized.\r
\r
@retval TRUE MD4 context initialization succeeded.\r
@retval FALSE MD4 context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If Md4Context is NULL, then return FALSE.\r
If NewMd4Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] Md4Context Pointer to MD4 context being copied.\r
@param[out] NewMd4Context Pointer to new MD4 context.\r
\r
@retval TRUE MD4 context copy succeeded.\r
@retval FALSE MD4 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
by Md4Final(). Behavior with invalid context is undefined.\r
\r
If Md4Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] Md4Context Pointer to the MD4 context.\r
@param[in] Data Pointer to the buffer containing the data to be hashed.\r
\r
@retval TRUE MD4 data digest succeeded.\r
@retval FALSE MD4 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If Md4Context is NULL, then return FALSE.\r
If HashValue is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] Md4Context Pointer to the MD4 context.\r
@param[out] HashValue Pointer to a buffer that receives the MD4 digest\r
\r
@retval TRUE MD4 digest computation succeeded.\r
@retval FALSE MD4 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieves the size, in bytes, of the context buffer required for MD5 hash operations.\r
\r
+ If this interface is not supported, then return zero.\r
+\r
@return The size, in bytes, of the context buffer required for MD5 hash operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
subsequent use.\r
\r
If Md5Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] Md5Context Pointer to MD5 context being initialized.\r
\r
@retval TRUE MD5 context initialization succeeded.\r
@retval FALSE MD5 context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If Md5Context is NULL, then return FALSE.\r
If NewMd5Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] Md5Context Pointer to MD5 context being copied.\r
@param[out] NewMd5Context Pointer to new MD5 context.\r
\r
@retval TRUE MD5 context copy succeeded.\r
@retval FALSE MD5 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
by Md5Final(). Behavior with invalid context is undefined.\r
\r
If Md5Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] Md5Context Pointer to the MD5 context.\r
@param[in] Data Pointer to the buffer containing the data to be hashed.\r
\r
@retval TRUE MD5 data digest succeeded.\r
@retval FALSE MD5 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If Md5Context is NULL, then return FALSE.\r
If HashValue is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] Md5Context Pointer to the MD5 context.\r
@param[out] HashValue Pointer to a buffer that receives the MD5 digest\r
\r
@retval TRUE MD5 digest computation succeeded.\r
@retval FALSE MD5 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieves the size, in bytes, of the context buffer required for SHA-1 hash operations.\r
\r
+ If this interface is not supported, then return zero.\r
+\r
@return The size, in bytes, of the context buffer required for SHA-1 hash operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
subsequent use.\r
\r
If Sha1Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] Sha1Context Pointer to SHA-1 context being initialized.\r
\r
@retval TRUE SHA-1 context initialization succeeded.\r
@retval FALSE SHA-1 context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If Sha1Context is NULL, then return FALSE.\r
If NewSha1Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] Sha1Context Pointer to SHA-1 context being copied.\r
@param[out] NewSha1Context Pointer to new SHA-1 context.\r
\r
@retval TRUE SHA-1 context copy succeeded.\r
@retval FALSE SHA-1 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
by Sha1Final(). Behavior with invalid context is undefined.\r
\r
If Sha1Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] Sha1Context Pointer to the SHA-1 context.\r
@param[in] Data Pointer to the buffer containing the data to be hashed.\r
\r
@retval TRUE SHA-1 data digest succeeded.\r
@retval FALSE SHA-1 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If Sha1Context is NULL, then return FALSE.\r
If HashValue is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] Sha1Context Pointer to the SHA-1 context.\r
@param[out] HashValue Pointer to a buffer that receives the SHA-1 digest\r
\r
@retval TRUE SHA-1 digest computation succeeded.\r
@retval FALSE SHA-1 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If Sha256Context is NULL, then return FALSE.\r
If NewSha256Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] Sha256Context Pointer to SHA-256 context being copied.\r
@param[out] NewSha256Context Pointer to new SHA-256 context.\r
\r
@retval TRUE SHA-256 context copy succeeded.\r
@retval FALSE SHA-256 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieves the size, in bytes, of the context buffer required for HMAC-MD5 operations.\r
\r
+ If this interface is not supported, then return zero.\r
+\r
@return The size, in bytes, of the context buffer required for HMAC-MD5 operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
subsequent use.\r
\r
If HmacMd5Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] HmacMd5Context Pointer to HMAC-MD5 context being initialized.\r
@param[in] Key Pointer to the user-supplied key.\r
\r
@retval TRUE HMAC-MD5 context initialization succeeded.\r
@retval FALSE HMAC-MD5 context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If HmacMd5Context is NULL, then return FALSE.\r
If NewHmacMd5Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] HmacMd5Context Pointer to HMAC-MD5 context being copied.\r
@param[out] NewHmacMd5Context Pointer to new HMAC-MD5 context.\r
\r
@retval TRUE HMAC-MD5 context copy succeeded.\r
@retval FALSE HMAC-MD5 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
finalized by HmacMd5Final(). Behavior with invalid context is undefined.\r
\r
If HmacMd5Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] HmacMd5Context Pointer to the HMAC-MD5 context.\r
@param[in] Data Pointer to the buffer containing the data to be digested.\r
\r
@retval TRUE HMAC-MD5 data digest succeeded.\r
@retval FALSE HMAC-MD5 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If HmacMd5Context is NULL, then return FALSE.\r
If HashValue is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] HmacMd5Context Pointer to the HMAC-MD5 context.\r
@param[out] HashValue Pointer to a buffer that receives the HMAC-MD5 digest\r
\r
@retval TRUE HMAC-MD5 digest computation succeeded.\r
@retval FALSE HMAC-MD5 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieves the size, in bytes, of the context buffer required for HMAC-SHA1 operations.\r
\r
+ If this interface is not supported, then return zero.\r
+\r
@return The size, in bytes, of the context buffer required for HMAC-SHA1 operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
subsequent use.\r
\r
If HmacSha1Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] HmacSha1Context Pointer to HMAC-SHA1 context being initialized.\r
@param[in] Key Pointer to the user-supplied key.\r
\r
@retval TRUE HMAC-SHA1 context initialization succeeded.\r
@retval FALSE HMAC-SHA1 context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If HmacSha1Context is NULL, then return FALSE.\r
If NewHmacSha1Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] HmacSha1Context Pointer to HMAC-SHA1 context being copied.\r
@param[out] NewHmacSha1Context Pointer to new HMAC-SHA1 context.\r
\r
@retval TRUE HMAC-SHA1 context copy succeeded.\r
@retval FALSE HMAC-SHA1 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
be finalized by HmacSha1Final(). Behavior with invalid context is undefined.\r
\r
If HmacSha1Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.\r
@param[in] Data Pointer to the buffer containing the data to be digested.\r
\r
@retval TRUE HMAC-SHA1 data digest succeeded.\r
@retval FALSE HMAC-SHA1 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If HmacSha1Context is NULL, then return FALSE.\r
If HashValue is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.\r
@param[out] HashValue Pointer to a buffer that receives the HMAC-SHA1 digest\r
\r
@retval TRUE HMAC-SHA1 digest computation succeeded.\r
@retval FALSE HMAC-SHA1 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieves the size, in bytes, of the context buffer required for TDES operations.\r
\r
+ If this interface is not supported, then return zero.\r
+\r
@return The size, in bytes, of the context buffer required for TDES operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
Initializes user-supplied memory as TDES context for subsequent use.\r
\r
This function initializes user-supplied memory pointed by TdesContext as TDES context.\r
- In addtion, it sets up all TDES key materials for subsequent encryption and decryption\r
+ In addition, it sets up all TDES key materials for subsequent encryption and decryption\r
operations.\r
There are 3 key options as follows:\r
KeyLength = 64, Keying option 1: K1 == K2 == K3 (Backward compatibility with DES)\r
If TdesContext is NULL, then return FALSE.\r
If Key is NULL, then return FALSE.\r
If KeyLength is not valid, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] TdesContext Pointer to TDES context being initialized.\r
@param[in] Key Pointer to the user-supplied TDES key.\r
\r
@retval TRUE TDES context initialization succeeded.\r
@retval FALSE TDES context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If Input is NULL, then return FALSE.\r
If InputSize is not multiple of block size (8 bytes), then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] TdesContext Pointer to the TDES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
\r
@retval TRUE TDES encryption succeeded.\r
@retval FALSE TDES encryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If Input is NULL, then return FALSE.\r
If InputSize is not multiple of block size (8 bytes), then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] TdesContext Pointer to the TDES context.\r
@param[in] Input Pointer to the buffer containing the data to be decrypted.\r
\r
@retval TRUE TDES decryption succeeded.\r
@retval FALSE TDES decryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If InputSize is not multiple of block size (8 bytes), then return FALSE.\r
If Ivec is NULL, then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] TdesContext Pointer to the TDES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
\r
@retval TRUE TDES encryption succeeded.\r
@retval FALSE TDES encryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If InputSize is not multiple of block size (8 bytes), then return FALSE.\r
If Ivec is NULL, then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] TdesContext Pointer to the TDES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
\r
@retval TRUE TDES decryption succeeded.\r
@retval FALSE TDES decryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieves the size, in bytes, of the context buffer required for AES operations.\r
\r
+ If this interface is not supported, then return zero.\r
+\r
@return The size, in bytes, of the context buffer required for AES operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
Initializes user-supplied memory as AES context for subsequent use.\r
\r
This function initializes user-supplied memory pointed by AesContext as AES context.\r
- In addtion, it sets up all AES key materials for subsequent encryption and decryption\r
+ In addition, it sets up all AES key materials for subsequent encryption and decryption\r
operations.\r
There are 3 options for key length, 128 bits, 192 bits, and 256 bits.\r
\r
If AesContext is NULL, then return FALSE.\r
If Key is NULL, then return FALSE.\r
If KeyLength is not valid, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] AesContext Pointer to AES context being initialized.\r
@param[in] Key Pointer to the user-supplied AES key.\r
\r
@retval TRUE AES context initialization succeeded.\r
@retval FALSE AES context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If Input is NULL, then return FALSE.\r
If InputSize is not multiple of block size (16 bytes), then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] AesContext Pointer to the AES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
\r
@retval TRUE AES encryption succeeded.\r
@retval FALSE AES encryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If Input is NULL, then return FALSE.\r
If InputSize is not multiple of block size (16 bytes), then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] AesContext Pointer to the AES context.\r
@param[in] Input Pointer to the buffer containing the data to be decrypted.\r
\r
@retval TRUE AES decryption succeeded.\r
@retval FALSE AES decryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If InputSize is not multiple of block size (16 bytes), then return FALSE.\r
If Ivec is NULL, then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] AesContext Pointer to the AES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
\r
@retval TRUE AES encryption succeeded.\r
@retval FALSE AES encryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If InputSize is not multiple of block size (16 bytes), then return FALSE.\r
If Ivec is NULL, then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] AesContext Pointer to the AES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
\r
@retval TRUE AES decryption succeeded.\r
@retval FALSE AES decryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieves the size, in bytes, of the context buffer required for ARC4 operations.\r
\r
+ If this interface is not supported, then return zero.\r
+\r
@return The size, in bytes, of the context buffer required for ARC4 operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
Initializes user-supplied memory as ARC4 context for subsequent use.\r
\r
This function initializes user-supplied memory pointed by Arc4Context as ARC4 context.\r
- In addtion, it sets up all ARC4 key materials for subsequent encryption and decryption\r
+ In addition, it sets up all ARC4 key materials for subsequent encryption and decryption\r
operations.\r
\r
If Arc4Context is NULL, then return FALSE.\r
If Key is NULL, then return FALSE.\r
If KeySize does not in the range of [5, 256] bytes, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] Arc4Context Pointer to ARC4 context being initialized.\r
@param[in] Key Pointer to the user-supplied ARC4 key.\r
\r
@retval TRUE ARC4 context initialization succeeded.\r
@retval FALSE ARC4 context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If Arc4Context is NULL, then return FALSE.\r
If Input is NULL, then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] Arc4Context Pointer to the ARC4 context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
\r
@retval TRUE ARC4 encryption succeeded.\r
@retval FALSE ARC4 encryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If Arc4Context is NULL, then return FALSE.\r
If Input is NULL, then return FALSE.\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] Arc4Context Pointer to the ARC4 context.\r
@param[in] Input Pointer to the buffer containing the data to be decrypted.\r
\r
@retval TRUE ARC4 decryption succeeded.\r
@retval FALSE ARC4 decryption failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
should be already correctly initialized by ARC4Init().\r
\r
If Arc4Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] Arc4Context Pointer to the ARC4 context.\r
\r
@retval TRUE ARC4 reset succeeded.\r
@retval FALSE ARC4 reset failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If RsaContext is NULL, then return FALSE.\r
If BnSize is NULL, then return FALSE.\r
If BnSize is large enough but BigNumber is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] RsaContext Pointer to RSA context being set.\r
@param[in] KeyTag Tag of RSA key component being set.\r
@retval TRUE RSA key component was retrieved successfully.\r
@retval FALSE Invalid RSA key component tag.\r
@retval FALSE BnSize is too small.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
initialized by RandomSeed().\r
\r
If RsaContext is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] RsaContext Pointer to RSA context being set.\r
@param[in] ModulusLength Length of RSA modulus N in bits.\r
\r
@retval TRUE RSA key component was generated successfully.\r
@retval FALSE Invalid RSA key component tag.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
- Whether d*e = 1 mod lcm(p-1,q-1)\r
\r
If RsaContext is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] RsaContext Pointer to RSA context to check.\r
\r
@retval TRUE RSA key components are valid.\r
@retval FALSE RSA key components are not valid.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If MessageHash is NULL, then return FALSE.\r
If HashSize is not equal to the size of MD5, SHA-1 or SHA-256 digest, then return FALSE.\r
If SigSize is large enough but Signature is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] RsaContext Pointer to RSA context for signature generation.\r
@param[in] MessageHash Pointer to octet message hash to be signed.\r
@retval TRUE Signature successfully generated in PKCS1-v1_5.\r
@retval FALSE Signature generation failed.\r
@retval FALSE SigSize is too small.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieve the RSA Private Key from the password-protected PEM key data.\r
\r
+ If PemData is NULL, then return FALSE.\r
+ If RsaContext is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
@param[in] PemData Pointer to the PEM-encoded key data to be retrieved.\r
@param[in] PemSize Size of the PEM key data in bytes.\r
@param[in] Password NULL-terminated passphrase used for encrypted PEM key data.\r
RSA private key component. Use RsaFree() function to free the\r
resource.\r
\r
- If PemData is NULL, then return FALSE.\r
- If RsaContext is NULL, then return FALSE.\r
-\r
@retval TRUE RSA Private Key was retrieved successfully.\r
@retval FALSE Invalid PEM key data or incorrect password.\r
+ @retval FALSE This interface is not supported.\r
+ \r
\r
**/\r
BOOLEAN\r
/**\r
Retrieve the RSA Public Key from one DER-encoded X509 certificate.\r
\r
+ If Cert is NULL, then return FALSE.\r
+ If RsaContext is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
@param[in] Cert Pointer to the DER-encoded X509 certificate.\r
@param[in] CertSize Size of the X509 certificate in bytes.\r
@param[out] RsaContext Pointer to new-generated RSA context which contain the retrieved\r
RSA public key component. Use RsaFree() function to free the\r
resource.\r
\r
- If Cert is NULL, then return FALSE.\r
- If RsaContext is NULL, then return FALSE.\r
-\r
@retval TRUE RSA Public Key was retrieved successfully.\r
@retval FALSE Fail to retrieve RSA public key from X509 certificate.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Retrieve the subject bytes from one X.509 certificate.\r
\r
+ If Cert is NULL, then return FALSE.\r
+ If SubjectSize is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
@param[in] Cert Pointer to the DER-encoded X509 certificate.\r
@param[in] CertSize Size of the X509 certificate in bytes.\r
@param[out] CertSubject Pointer to the retrieved certificate subject bytes.\r
@param[in, out] SubjectSize The size in bytes of the CertSubject buffer on input,\r
and the size of buffer returned CertSubject on output.\r
\r
- If Cert is NULL, then return FALSE.\r
- If SubjectSize is NULL, then return FALSE.\r
-\r
@retval TRUE The certificate subject retrieved successfully.\r
@retval FALSE Invalid certificate, or the SubjectSize is too small for the result.\r
The SubjectSize will be updated with the required size.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Verify one X509 certificate was issued by the trusted CA.\r
\r
+ If Cert is NULL, then return FALSE.\r
+ If CACert is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
@param[in] Cert Pointer to the DER-encoded X509 certificate to be verified.\r
@param[in] CertSize Size of the X509 certificate in bytes.\r
@param[in] CACert Pointer to the DER-encoded trusted CA certificate.\r
@param[in] CACertSize Size of the CA Certificate in bytes.\r
\r
- If Cert is NULL, then return FALSE.\r
- If CACert is NULL, then return FALSE.\r
-\r
@retval TRUE The certificate was issued by the trusted CA.\r
@retval FALSE Invalid certificate or the certificate was not issued by the given\r
trusted CA.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If Cert is NULL, then return FALSE.\r
If SingleX509Cert is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] Cert Pointer to the DER-encoded certificate data.\r
@param[in] CertSize The size of certificate data in bytes.\r
\r
@retval TRUE The X509 object generation succeeded.\r
@retval FALSE The operation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
Construct a X509 stack object from a list of DER-encoded certificate data.\r
\r
If X509Stack is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] X509Stack On input, pointer to an existing X509 stack object.\r
On output, pointer to the X509 stack object with new\r
\r
@retval TRUE The X509 stack construction succeeded.\r
@retval FALSE The construction operation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Release the specified X509 object.\r
\r
- If X509Cert is NULL, then return FALSE.\r
+ If the interface is not supported, then ASSERT().\r
\r
@param[in] X509Cert Pointer to the X509 object to be released.\r
\r
/**\r
Release the specified X509 stack object.\r
\r
- If X509Stack is NULL, then return FALSE.\r
+ If the interface is not supported, then ASSERT().\r
\r
@param[in] X509Stack Pointer to the X509 stack object to be released.\r
\r
\r
If P7Data, CertStack, StackLength, TrustedCert or CertLength is NULL, then\r
return FALSE. If P7Length overflow, then return FAlSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] P7Data Pointer to the PKCS#7 message to verify.\r
@param[in] P7Length Length of the PKCS#7 message in bytes.\r
\r
@retval TRUE The operation is finished successfully.\r
@retval FALSE Error occurs during the operation.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
/**\r
Wrap function to use free() to free allocated memory for certificates.\r
\r
+ If this interface is not supported, then ASSERT().\r
+\r
@param[in] Certs Pointer to the certificates to be freed.\r
\r
**/\r
Syntax Standard, version 1.5". This interface is only intended to be used for\r
application to perform PKCS#7 functionality validation.\r
\r
+ If this interface is not supported, then return FALSE.\r
+\r
@param[in] PrivateKey Pointer to the PEM-formatted private key data for\r
data signing.\r
@param[in] PrivateKeySize Size of the PEM private key data in bytes.\r
\r
@retval TRUE PKCS#7 data signing succeeded.\r
@retval FALSE PKCS#7 data signing failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If P7Data, TrustedCert or InData is NULL, then return FALSE.\r
If P7Length, CertLength or DataLength overflow, then return FAlSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] P7Data Pointer to the PKCS#7 message to verify.\r
@param[in] P7Length Length of the PKCS#7 message in bytes.\r
\r
@retval TRUE The specified PKCS#7 signed data is valid.\r
@retval FALSE Invalid PKCS#7 signed data.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If AuthData is NULL, then return FALSE.\r
If ImageHash is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] AuthData Pointer to the Authenticode Signature retrieved from signed\r
PE/COFF image to be verified.\r
\r
@retval TRUE The specified Authenticode Signature is valid.\r
@retval FALSE Invalid Authenticode Signature.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
@return Pointer to the Diffie-Hellman Context that has been initialized.\r
If the allocations fails, DhNew() returns NULL.\r
+ If the interface is not supported, DhNew() returns NULL.\r
\r
**/\r
VOID *\r
/**\r
Release the specified DH context.\r
\r
- If DhContext is NULL, then return FALSE.\r
+ If the interface is not supported, then ASSERT().\r
\r
@param[in] DhContext Pointer to the DH context to be released.\r
\r
\r
If DhContext is NULL, then return FALSE.\r
If Prime is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] DhContext Pointer to the DH context.\r
@param[in] Generator Value of generator.\r
@retval TRUE DH pamameter generation succeeded.\r
@retval FALSE Value of Generator is not supported.\r
@retval FALSE PRNG fails to generate random prime number with PrimeLength.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
\r
If DhContext is NULL, then return FALSE.\r
If Prime is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] DhContext Pointer to the DH context.\r
@param[in] Generator Value of generator.\r
@retval FALSE Value of Generator is not suitable for the Prime.\r
@retval FALSE Value of Prime is not a prime number.\r
@retval FALSE Value of Prime is not a safe prime number.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
If DhContext is NULL, then return FALSE.\r
If PublicKeySize is NULL, then return FALSE.\r
If PublicKeySize is large enough but PublicKey is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] DhContext Pointer to the DH context.\r
@param[out] PublicKey Pointer to the buffer to receive generated public key.\r
@retval TRUE DH public key generation succeeded.\r
@retval FALSE DH public key generation failed.\r
@retval FALSE PublicKeySize is not large enough.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
Computes exchanged common key.\r
\r
Given peer's public key, this function computes the exchanged common key, based on its own\r
- context including value of prime modulus and random secret exponent. \r
+ context including value of prime modulus and random secret exponent.\r
\r
If DhContext is NULL, then return FALSE.\r
If PeerPublicKey is NULL, then return FALSE.\r
If KeySize is NULL, then return FALSE.\r
- If KeySize is large enough but Key is NULL, then return FALSE.\r
+ If Key is NULL, then return FALSE.\r
+ If KeySize is not large enough, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in, out] DhContext Pointer to the DH context.\r
@param[in] PeerPublicKey Pointer to the peer's public key.\r
@retval TRUE DH exchanged key generation succeeded.\r
@retval FALSE DH exchanged key generation failed.\r
@retval FALSE KeySize is not large enough.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
This function sets up the seed value for the pseudorandom number generator.\r
If Seed is not NULL, then the seed passed in is used.\r
If Seed is NULL, then default seed is used.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[in] Seed Pointer to seed value.\r
If NULL, default seed is used.\r
\r
@retval TRUE Pseudorandom number generator has enough entropy for random generation.\r
@retval FALSE Pseudorandom number generator does not have enough entropy for random generation.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
Generates a pseudorandom byte stream of the specified size.\r
\r
If Output is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
@param[out] Output Pointer to buffer to receive random value.\r
@param[in] Size Size of randome bytes to generate.\r
\r
@retval TRUE Pseudorandom byte stream generated successfully.\r
@retval FALSE Pseudorandom number generator fails to generate due to lack of entropy.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
projects / mirror_edk2.git / blobdiff