2 Defines base cryptographic library APIs.
3 The Base Cryptographic Library provides implementations of basic cryptography
4 primitives (Hash Serials, HMAC, RSA, Diffie-Hellman, etc) for UEFI security
5 functionality enabling.
7 Copyright (c) 2009 - 2020, Intel Corporation. All rights reserved.<BR>
8 SPDX-License-Identifier: BSD-2-Clause-Patent
12 #ifndef __BASE_CRYPT_LIB_H__
13 #define __BASE_CRYPT_LIB_H__
15 #include <Uefi/UefiBaseType.h>
18 /// MD5 digest size in bytes
20 #define MD5_DIGEST_SIZE 16
23 /// SHA-1 digest size in bytes.
25 #define SHA1_DIGEST_SIZE 20
28 /// SHA-256 digest size in bytes
30 #define SHA256_DIGEST_SIZE 32
33 /// SHA-384 digest size in bytes
35 #define SHA384_DIGEST_SIZE 48
38 /// SHA-512 digest size in bytes
40 #define SHA512_DIGEST_SIZE 64
43 /// SM3 digest size in bytes
45 #define SM3_256_DIGEST_SIZE 32
48 /// TDES block size in bytes
50 #define TDES_BLOCK_SIZE 8
53 /// AES block size in bytes
55 #define AES_BLOCK_SIZE 16
58 /// RSA Key Tags Definition used in RsaSetKey() function for key component identification.
61 RsaKeyN
, ///< RSA public Modulus (N)
62 RsaKeyE
, ///< RSA Public exponent (e)
63 RsaKeyD
, ///< RSA Private exponent (d)
64 RsaKeyP
, ///< RSA secret prime factor of Modulus (p)
65 RsaKeyQ
, ///< RSA secret prime factor of Modules (q)
66 RsaKeyDp
, ///< p's CRT exponent (== d mod (p - 1))
67 RsaKeyDq
, ///< q's CRT exponent (== d mod (q - 1))
68 RsaKeyQInv
///< The CRT coefficient (== 1/q mod p)
71 //=====================================================================================
72 // One-Way Cryptographic Hash Primitives
73 //=====================================================================================
76 Retrieves the size, in bytes, of the context buffer required for MD5 hash operations.
78 If this interface is not supported, then return zero.
80 @return The size, in bytes, of the context buffer required for MD5 hash operations.
81 @retval 0 This interface is not supported.
91 Initializes user-supplied memory pointed by Md5Context as MD5 hash context for
94 If Md5Context is NULL, then return FALSE.
95 If this interface is not supported, then return FALSE.
97 @param[out] Md5Context Pointer to MD5 context being initialized.
99 @retval TRUE MD5 context initialization succeeded.
100 @retval FALSE MD5 context initialization failed.
101 @retval FALSE This interface is not supported.
111 Makes a copy of an existing MD5 context.
113 If Md5Context is NULL, then return FALSE.
114 If NewMd5Context is NULL, then return FALSE.
115 If this interface is not supported, then return FALSE.
117 @param[in] Md5Context Pointer to MD5 context being copied.
118 @param[out] NewMd5Context Pointer to new MD5 context.
120 @retval TRUE MD5 context copy succeeded.
121 @retval FALSE MD5 context copy failed.
122 @retval FALSE This interface is not supported.
128 IN CONST VOID
*Md5Context
,
129 OUT VOID
*NewMd5Context
133 Digests the input data and updates MD5 context.
135 This function performs MD5 digest on a data buffer of the specified size.
136 It can be called multiple times to compute the digest of long or discontinuous data streams.
137 MD5 context should be already correctly initialized by Md5Init(), and should not be finalized
138 by Md5Final(). Behavior with invalid context is undefined.
140 If Md5Context is NULL, then return FALSE.
141 If this interface is not supported, then return FALSE.
143 @param[in, out] Md5Context Pointer to the MD5 context.
144 @param[in] Data Pointer to the buffer containing the data to be hashed.
145 @param[in] DataSize Size of Data buffer in bytes.
147 @retval TRUE MD5 data digest succeeded.
148 @retval FALSE MD5 data digest failed.
149 @retval FALSE This interface is not supported.
155 IN OUT VOID
*Md5Context
,
161 Completes computation of the MD5 digest value.
163 This function completes MD5 hash computation and retrieves the digest value into
164 the specified memory. After this function has been called, the MD5 context cannot
166 MD5 context should be already correctly initialized by Md5Init(), and should not be
167 finalized by Md5Final(). Behavior with invalid MD5 context is undefined.
169 If Md5Context is NULL, then return FALSE.
170 If HashValue is NULL, then return FALSE.
171 If this interface is not supported, then return FALSE.
173 @param[in, out] Md5Context Pointer to the MD5 context.
174 @param[out] HashValue Pointer to a buffer that receives the MD5 digest
177 @retval TRUE MD5 digest computation succeeded.
178 @retval FALSE MD5 digest computation failed.
179 @retval FALSE This interface is not supported.
185 IN OUT VOID
*Md5Context
,
190 Computes the MD5 message digest of a input data buffer.
192 This function performs the MD5 message digest of a given data buffer, and places
193 the digest value into the specified memory.
195 If this interface is not supported, then return FALSE.
197 @param[in] Data Pointer to the buffer containing the data to be hashed.
198 @param[in] DataSize Size of Data buffer in bytes.
199 @param[out] HashValue Pointer to a buffer that receives the MD5 digest
202 @retval TRUE MD5 digest computation succeeded.
203 @retval FALSE MD5 digest computation failed.
204 @retval FALSE This interface is not supported.
216 Retrieves the size, in bytes, of the context buffer required for SHA-1 hash operations.
218 If this interface is not supported, then return zero.
220 @return The size, in bytes, of the context buffer required for SHA-1 hash operations.
221 @retval 0 This interface is not supported.
231 Initializes user-supplied memory pointed by Sha1Context as SHA-1 hash context for
234 If Sha1Context is NULL, then return FALSE.
235 If this interface is not supported, then return FALSE.
237 @param[out] Sha1Context Pointer to SHA-1 context being initialized.
239 @retval TRUE SHA-1 context initialization succeeded.
240 @retval FALSE SHA-1 context initialization failed.
241 @retval FALSE This interface is not supported.
247 OUT VOID
*Sha1Context
251 Makes a copy of an existing SHA-1 context.
253 If Sha1Context is NULL, then return FALSE.
254 If NewSha1Context is NULL, then return FALSE.
255 If this interface is not supported, then return FALSE.
257 @param[in] Sha1Context Pointer to SHA-1 context being copied.
258 @param[out] NewSha1Context Pointer to new SHA-1 context.
260 @retval TRUE SHA-1 context copy succeeded.
261 @retval FALSE SHA-1 context copy failed.
262 @retval FALSE This interface is not supported.
268 IN CONST VOID
*Sha1Context
,
269 OUT VOID
*NewSha1Context
273 Digests the input data and updates SHA-1 context.
275 This function performs SHA-1 digest on a data buffer of the specified size.
276 It can be called multiple times to compute the digest of long or discontinuous data streams.
277 SHA-1 context should be already correctly initialized by Sha1Init(), and should not be finalized
278 by Sha1Final(). Behavior with invalid context is undefined.
280 If Sha1Context is NULL, then return FALSE.
281 If this interface is not supported, then return FALSE.
283 @param[in, out] Sha1Context Pointer to the SHA-1 context.
284 @param[in] Data Pointer to the buffer containing the data to be hashed.
285 @param[in] DataSize Size of Data buffer in bytes.
287 @retval TRUE SHA-1 data digest succeeded.
288 @retval FALSE SHA-1 data digest failed.
289 @retval FALSE This interface is not supported.
295 IN OUT VOID
*Sha1Context
,
301 Completes computation of the SHA-1 digest value.
303 This function completes SHA-1 hash computation and retrieves the digest value into
304 the specified memory. After this function has been called, the SHA-1 context cannot
306 SHA-1 context should be already correctly initialized by Sha1Init(), and should not be
307 finalized by Sha1Final(). Behavior with invalid SHA-1 context is undefined.
309 If Sha1Context is NULL, then return FALSE.
310 If HashValue is NULL, then return FALSE.
311 If this interface is not supported, then return FALSE.
313 @param[in, out] Sha1Context Pointer to the SHA-1 context.
314 @param[out] HashValue Pointer to a buffer that receives the SHA-1 digest
317 @retval TRUE SHA-1 digest computation succeeded.
318 @retval FALSE SHA-1 digest computation failed.
319 @retval FALSE This interface is not supported.
325 IN OUT VOID
*Sha1Context
,
330 Computes the SHA-1 message digest of a input data buffer.
332 This function performs the SHA-1 message digest of a given data buffer, and places
333 the digest value into the specified memory.
335 If this interface is not supported, then return FALSE.
337 @param[in] Data Pointer to the buffer containing the data to be hashed.
338 @param[in] DataSize Size of Data buffer in bytes.
339 @param[out] HashValue Pointer to a buffer that receives the SHA-1 digest
342 @retval TRUE SHA-1 digest computation succeeded.
343 @retval FALSE SHA-1 digest computation failed.
344 @retval FALSE This interface is not supported.
356 Retrieves the size, in bytes, of the context buffer required for SHA-256 hash operations.
358 @return The size, in bytes, of the context buffer required for SHA-256 hash operations.
363 Sha256GetContextSize (
368 Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for
371 If Sha256Context is NULL, then return FALSE.
373 @param[out] Sha256Context Pointer to SHA-256 context being initialized.
375 @retval TRUE SHA-256 context initialization succeeded.
376 @retval FALSE SHA-256 context initialization failed.
382 OUT VOID
*Sha256Context
386 Makes a copy of an existing SHA-256 context.
388 If Sha256Context is NULL, then return FALSE.
389 If NewSha256Context is NULL, then return FALSE.
390 If this interface is not supported, then return FALSE.
392 @param[in] Sha256Context Pointer to SHA-256 context being copied.
393 @param[out] NewSha256Context Pointer to new SHA-256 context.
395 @retval TRUE SHA-256 context copy succeeded.
396 @retval FALSE SHA-256 context copy failed.
397 @retval FALSE This interface is not supported.
403 IN CONST VOID
*Sha256Context
,
404 OUT VOID
*NewSha256Context
408 Digests the input data and updates SHA-256 context.
410 This function performs SHA-256 digest on a data buffer of the specified size.
411 It can be called multiple times to compute the digest of long or discontinuous data streams.
412 SHA-256 context should be already correctly initialized by Sha256Init(), and should not be finalized
413 by Sha256Final(). Behavior with invalid context is undefined.
415 If Sha256Context is NULL, then return FALSE.
417 @param[in, out] Sha256Context Pointer to the SHA-256 context.
418 @param[in] Data Pointer to the buffer containing the data to be hashed.
419 @param[in] DataSize Size of Data buffer in bytes.
421 @retval TRUE SHA-256 data digest succeeded.
422 @retval FALSE SHA-256 data digest failed.
428 IN OUT VOID
*Sha256Context
,
434 Completes computation of the SHA-256 digest value.
436 This function completes SHA-256 hash computation and retrieves the digest value into
437 the specified memory. After this function has been called, the SHA-256 context cannot
439 SHA-256 context should be already correctly initialized by Sha256Init(), and should not be
440 finalized by Sha256Final(). Behavior with invalid SHA-256 context is undefined.
442 If Sha256Context is NULL, then return FALSE.
443 If HashValue is NULL, then return FALSE.
445 @param[in, out] Sha256Context Pointer to the SHA-256 context.
446 @param[out] HashValue Pointer to a buffer that receives the SHA-256 digest
449 @retval TRUE SHA-256 digest computation succeeded.
450 @retval FALSE SHA-256 digest computation failed.
456 IN OUT VOID
*Sha256Context
,
461 Computes the SHA-256 message digest of a input data buffer.
463 This function performs the SHA-256 message digest of a given data buffer, and places
464 the digest value into the specified memory.
466 If this interface is not supported, then return FALSE.
468 @param[in] Data Pointer to the buffer containing the data to be hashed.
469 @param[in] DataSize Size of Data buffer in bytes.
470 @param[out] HashValue Pointer to a buffer that receives the SHA-256 digest
473 @retval TRUE SHA-256 digest computation succeeded.
474 @retval FALSE SHA-256 digest computation failed.
475 @retval FALSE This interface is not supported.
487 Retrieves the size, in bytes, of the context buffer required for SHA-384 hash operations.
489 @return The size, in bytes, of the context buffer required for SHA-384 hash operations.
494 Sha384GetContextSize (
499 Initializes user-supplied memory pointed by Sha384Context as SHA-384 hash context for
502 If Sha384Context is NULL, then return FALSE.
504 @param[out] Sha384Context Pointer to SHA-384 context being initialized.
506 @retval TRUE SHA-384 context initialization succeeded.
507 @retval FALSE SHA-384 context initialization failed.
513 OUT VOID
*Sha384Context
517 Makes a copy of an existing SHA-384 context.
519 If Sha384Context is NULL, then return FALSE.
520 If NewSha384Context is NULL, then return FALSE.
521 If this interface is not supported, then return FALSE.
523 @param[in] Sha384Context Pointer to SHA-384 context being copied.
524 @param[out] NewSha384Context Pointer to new SHA-384 context.
526 @retval TRUE SHA-384 context copy succeeded.
527 @retval FALSE SHA-384 context copy failed.
528 @retval FALSE This interface is not supported.
534 IN CONST VOID
*Sha384Context
,
535 OUT VOID
*NewSha384Context
539 Digests the input data and updates SHA-384 context.
541 This function performs SHA-384 digest on a data buffer of the specified size.
542 It can be called multiple times to compute the digest of long or discontinuous data streams.
543 SHA-384 context should be already correctly initialized by Sha384Init(), and should not be finalized
544 by Sha384Final(). Behavior with invalid context is undefined.
546 If Sha384Context is NULL, then return FALSE.
548 @param[in, out] Sha384Context Pointer to the SHA-384 context.
549 @param[in] Data Pointer to the buffer containing the data to be hashed.
550 @param[in] DataSize Size of Data buffer in bytes.
552 @retval TRUE SHA-384 data digest succeeded.
553 @retval FALSE SHA-384 data digest failed.
559 IN OUT VOID
*Sha384Context
,
565 Completes computation of the SHA-384 digest value.
567 This function completes SHA-384 hash computation and retrieves the digest value into
568 the specified memory. After this function has been called, the SHA-384 context cannot
570 SHA-384 context should be already correctly initialized by Sha384Init(), and should not be
571 finalized by Sha384Final(). Behavior with invalid SHA-384 context is undefined.
573 If Sha384Context is NULL, then return FALSE.
574 If HashValue is NULL, then return FALSE.
576 @param[in, out] Sha384Context Pointer to the SHA-384 context.
577 @param[out] HashValue Pointer to a buffer that receives the SHA-384 digest
580 @retval TRUE SHA-384 digest computation succeeded.
581 @retval FALSE SHA-384 digest computation failed.
587 IN OUT VOID
*Sha384Context
,
592 Computes the SHA-384 message digest of a input data buffer.
594 This function performs the SHA-384 message digest of a given data buffer, and places
595 the digest value into the specified memory.
597 If this interface is not supported, then return FALSE.
599 @param[in] Data Pointer to the buffer containing the data to be hashed.
600 @param[in] DataSize Size of Data buffer in bytes.
601 @param[out] HashValue Pointer to a buffer that receives the SHA-384 digest
604 @retval TRUE SHA-384 digest computation succeeded.
605 @retval FALSE SHA-384 digest computation failed.
606 @retval FALSE This interface is not supported.
618 Retrieves the size, in bytes, of the context buffer required for SHA-512 hash operations.
620 @return The size, in bytes, of the context buffer required for SHA-512 hash operations.
625 Sha512GetContextSize (
630 Initializes user-supplied memory pointed by Sha512Context as SHA-512 hash context for
633 If Sha512Context is NULL, then return FALSE.
635 @param[out] Sha512Context Pointer to SHA-512 context being initialized.
637 @retval TRUE SHA-512 context initialization succeeded.
638 @retval FALSE SHA-512 context initialization failed.
644 OUT VOID
*Sha512Context
648 Makes a copy of an existing SHA-512 context.
650 If Sha512Context is NULL, then return FALSE.
651 If NewSha512Context is NULL, then return FALSE.
652 If this interface is not supported, then return FALSE.
654 @param[in] Sha512Context Pointer to SHA-512 context being copied.
655 @param[out] NewSha512Context Pointer to new SHA-512 context.
657 @retval TRUE SHA-512 context copy succeeded.
658 @retval FALSE SHA-512 context copy failed.
659 @retval FALSE This interface is not supported.
665 IN CONST VOID
*Sha512Context
,
666 OUT VOID
*NewSha512Context
670 Digests the input data and updates SHA-512 context.
672 This function performs SHA-512 digest on a data buffer of the specified size.
673 It can be called multiple times to compute the digest of long or discontinuous data streams.
674 SHA-512 context should be already correctly initialized by Sha512Init(), and should not be finalized
675 by Sha512Final(). Behavior with invalid context is undefined.
677 If Sha512Context is NULL, then return FALSE.
679 @param[in, out] Sha512Context Pointer to the SHA-512 context.
680 @param[in] Data Pointer to the buffer containing the data to be hashed.
681 @param[in] DataSize Size of Data buffer in bytes.
683 @retval TRUE SHA-512 data digest succeeded.
684 @retval FALSE SHA-512 data digest failed.
690 IN OUT VOID
*Sha512Context
,
696 Completes computation of the SHA-512 digest value.
698 This function completes SHA-512 hash computation and retrieves the digest value into
699 the specified memory. After this function has been called, the SHA-512 context cannot
701 SHA-512 context should be already correctly initialized by Sha512Init(), and should not be
702 finalized by Sha512Final(). Behavior with invalid SHA-512 context is undefined.
704 If Sha512Context is NULL, then return FALSE.
705 If HashValue is NULL, then return FALSE.
707 @param[in, out] Sha512Context Pointer to the SHA-512 context.
708 @param[out] HashValue Pointer to a buffer that receives the SHA-512 digest
711 @retval TRUE SHA-512 digest computation succeeded.
712 @retval FALSE SHA-512 digest computation failed.
718 IN OUT VOID
*Sha512Context
,
723 Computes the SHA-512 message digest of a input data buffer.
725 This function performs the SHA-512 message digest of a given data buffer, and places
726 the digest value into the specified memory.
728 If this interface is not supported, then return FALSE.
730 @param[in] Data Pointer to the buffer containing the data to be hashed.
731 @param[in] DataSize Size of Data buffer in bytes.
732 @param[out] HashValue Pointer to a buffer that receives the SHA-512 digest
735 @retval TRUE SHA-512 digest computation succeeded.
736 @retval FALSE SHA-512 digest computation failed.
737 @retval FALSE This interface is not supported.
749 Retrieves the size, in bytes, of the context buffer required for SM3 hash operations.
751 @return The size, in bytes, of the context buffer required for SM3 hash operations.
761 Initializes user-supplied memory pointed by Sm3Context as SM3 hash context for
764 If Sm3Context is NULL, then return FALSE.
766 @param[out] Sm3Context Pointer to SM3 context being initialized.
768 @retval TRUE SM3 context initialization succeeded.
769 @retval FALSE SM3 context initialization failed.
779 Makes a copy of an existing SM3 context.
781 If Sm3Context is NULL, then return FALSE.
782 If NewSm3Context is NULL, then return FALSE.
783 If this interface is not supported, then return FALSE.
785 @param[in] Sm3Context Pointer to SM3 context being copied.
786 @param[out] NewSm3Context Pointer to new SM3 context.
788 @retval TRUE SM3 context copy succeeded.
789 @retval FALSE SM3 context copy failed.
790 @retval FALSE This interface is not supported.
796 IN CONST VOID
*Sm3Context
,
797 OUT VOID
*NewSm3Context
801 Digests the input data and updates SM3 context.
803 This function performs SM3 digest on a data buffer of the specified size.
804 It can be called multiple times to compute the digest of long or discontinuous data streams.
805 SM3 context should be already correctly initialized by Sm3Init(), and should not be finalized
806 by Sm3Final(). Behavior with invalid context is undefined.
808 If Sm3Context is NULL, then return FALSE.
810 @param[in, out] Sm3Context Pointer to the SM3 context.
811 @param[in] Data Pointer to the buffer containing the data to be hashed.
812 @param[in] DataSize Size of Data buffer in bytes.
814 @retval TRUE SM3 data digest succeeded.
815 @retval FALSE SM3 data digest failed.
821 IN OUT VOID
*Sm3Context
,
827 Completes computation of the SM3 digest value.
829 This function completes SM3 hash computation and retrieves the digest value into
830 the specified memory. After this function has been called, the SM3 context cannot
832 SM3 context should be already correctly initialized by Sm3Init(), and should not be
833 finalized by Sm3Final(). Behavior with invalid SM3 context is undefined.
835 If Sm3Context is NULL, then return FALSE.
836 If HashValue is NULL, then return FALSE.
838 @param[in, out] Sm3Context Pointer to the SM3 context.
839 @param[out] HashValue Pointer to a buffer that receives the SM3 digest
842 @retval TRUE SM3 digest computation succeeded.
843 @retval FALSE SM3 digest computation failed.
849 IN OUT VOID
*Sm3Context
,
854 Computes the SM3 message digest of a input data buffer.
856 This function performs the SM3 message digest of a given data buffer, and places
857 the digest value into the specified memory.
859 If this interface is not supported, then return FALSE.
861 @param[in] Data Pointer to the buffer containing the data to be hashed.
862 @param[in] DataSize Size of Data buffer in bytes.
863 @param[out] HashValue Pointer to a buffer that receives the SM3 digest
866 @retval TRUE SM3 digest computation succeeded.
867 @retval FALSE SM3 digest computation failed.
868 @retval FALSE This interface is not supported.
879 //=====================================================================================
880 // MAC (Message Authentication Code) Primitive
881 //=====================================================================================
884 Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA1 use.
886 If this interface is not supported, then return NULL.
888 @return Pointer to the HMAC_CTX context that has been initialized.
889 If the allocations fails, HmacSha1New() returns NULL.
890 @return NULL This interface is not supported.
900 Release the specified HMAC_CTX context.
902 If this interface is not supported, then do nothing.
904 @param[in] HmacSha1Ctx Pointer to the HMAC_CTX context to be released.
914 Set user-supplied key for subsequent use. It must be done before any
915 calling to HmacSha1Update().
917 If HmacSha1Context is NULL, then return FALSE.
918 If this interface is not supported, then return FALSE.
920 @param[out] HmacSha1Context Pointer to HMAC-SHA1 context.
921 @param[in] Key Pointer to the user-supplied key.
922 @param[in] KeySize Key size in bytes.
924 @retval TRUE The Key is set successfully.
925 @retval FALSE The Key is set unsuccessfully.
926 @retval FALSE This interface is not supported.
932 OUT VOID
*HmacSha1Context
,
938 Makes a copy of an existing HMAC-SHA1 context.
940 If HmacSha1Context is NULL, then return FALSE.
941 If NewHmacSha1Context is NULL, then return FALSE.
942 If this interface is not supported, then return FALSE.
944 @param[in] HmacSha1Context Pointer to HMAC-SHA1 context being copied.
945 @param[out] NewHmacSha1Context Pointer to new HMAC-SHA1 context.
947 @retval TRUE HMAC-SHA1 context copy succeeded.
948 @retval FALSE HMAC-SHA1 context copy failed.
949 @retval FALSE This interface is not supported.
955 IN CONST VOID
*HmacSha1Context
,
956 OUT VOID
*NewHmacSha1Context
960 Digests the input data and updates HMAC-SHA1 context.
962 This function performs HMAC-SHA1 digest on a data buffer of the specified size.
963 It can be called multiple times to compute the digest of long or discontinuous data streams.
964 HMAC-SHA1 context should be initialized by HmacSha1New(), and should not be finalized by
965 HmacSha1Final(). Behavior with invalid context is undefined.
967 If HmacSha1Context is NULL, then return FALSE.
968 If this interface is not supported, then return FALSE.
970 @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
971 @param[in] Data Pointer to the buffer containing the data to be digested.
972 @param[in] DataSize Size of Data buffer in bytes.
974 @retval TRUE HMAC-SHA1 data digest succeeded.
975 @retval FALSE HMAC-SHA1 data digest failed.
976 @retval FALSE This interface is not supported.
982 IN OUT VOID
*HmacSha1Context
,
988 Completes computation of the HMAC-SHA1 digest value.
990 This function completes HMAC-SHA1 hash computation and retrieves the digest value into
991 the specified memory. After this function has been called, the HMAC-SHA1 context cannot
993 HMAC-SHA1 context should be initialized by HmacSha1New(), and should not be finalized
994 by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.
996 If HmacSha1Context is NULL, then return FALSE.
997 If HmacValue is NULL, then return FALSE.
998 If this interface is not supported, then return FALSE.
1000 @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
1001 @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA1 digest
1004 @retval TRUE HMAC-SHA1 digest computation succeeded.
1005 @retval FALSE HMAC-SHA1 digest computation failed.
1006 @retval FALSE This interface is not supported.
1012 IN OUT VOID
*HmacSha1Context
,
1013 OUT UINT8
*HmacValue
1017 Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.
1019 @return Pointer to the HMAC_CTX context that has been initialized.
1020 If the allocations fails, HmacSha256New() returns NULL.
1030 Release the specified HMAC_CTX context.
1032 @param[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.
1038 IN VOID
*HmacSha256Ctx
1042 Set user-supplied key for subsequent use. It must be done before any
1043 calling to HmacSha256Update().
1045 If HmacSha256Context is NULL, then return FALSE.
1046 If this interface is not supported, then return FALSE.
1048 @param[out] HmacSha256Context Pointer to HMAC-SHA256 context.
1049 @param[in] Key Pointer to the user-supplied key.
1050 @param[in] KeySize Key size in bytes.
1052 @retval TRUE The Key is set successfully.
1053 @retval FALSE The Key is set unsuccessfully.
1054 @retval FALSE This interface is not supported.
1060 OUT VOID
*HmacSha256Context
,
1061 IN CONST UINT8
*Key
,
1066 Makes a copy of an existing HMAC-SHA256 context.
1068 If HmacSha256Context is NULL, then return FALSE.
1069 If NewHmacSha256Context is NULL, then return FALSE.
1070 If this interface is not supported, then return FALSE.
1072 @param[in] HmacSha256Context Pointer to HMAC-SHA256 context being copied.
1073 @param[out] NewHmacSha256Context Pointer to new HMAC-SHA256 context.
1075 @retval TRUE HMAC-SHA256 context copy succeeded.
1076 @retval FALSE HMAC-SHA256 context copy failed.
1077 @retval FALSE This interface is not supported.
1082 HmacSha256Duplicate (
1083 IN CONST VOID
*HmacSha256Context
,
1084 OUT VOID
*NewHmacSha256Context
1088 Digests the input data and updates HMAC-SHA256 context.
1090 This function performs HMAC-SHA256 digest on a data buffer of the specified size.
1091 It can be called multiple times to compute the digest of long or discontinuous data streams.
1092 HMAC-SHA256 context should be initialized by HmacSha256New(), and should not be finalized
1093 by HmacSha256Final(). Behavior with invalid context is undefined.
1095 If HmacSha256Context is NULL, then return FALSE.
1096 If this interface is not supported, then return FALSE.
1098 @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
1099 @param[in] Data Pointer to the buffer containing the data to be digested.
1100 @param[in] DataSize Size of Data buffer in bytes.
1102 @retval TRUE HMAC-SHA256 data digest succeeded.
1103 @retval FALSE HMAC-SHA256 data digest failed.
1104 @retval FALSE This interface is not supported.
1110 IN OUT VOID
*HmacSha256Context
,
1111 IN CONST VOID
*Data
,
1116 Completes computation of the HMAC-SHA256 digest value.
1118 This function completes HMAC-SHA256 hash computation and retrieves the digest value into
1119 the specified memory. After this function has been called, the HMAC-SHA256 context cannot
1121 HMAC-SHA256 context should be initialized by HmacSha256New(), and should not be finalized
1122 by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.
1124 If HmacSha256Context is NULL, then return FALSE.
1125 If HmacValue is NULL, then return FALSE.
1126 If this interface is not supported, then return FALSE.
1128 @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
1129 @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest
1132 @retval TRUE HMAC-SHA256 digest computation succeeded.
1133 @retval FALSE HMAC-SHA256 digest computation failed.
1134 @retval FALSE This interface is not supported.
1140 IN OUT VOID
*HmacSha256Context
,
1141 OUT UINT8
*HmacValue
1144 //=====================================================================================
1145 // Symmetric Cryptography Primitive
1146 //=====================================================================================
1149 Retrieves the size, in bytes, of the context buffer required for AES operations.
1151 If this interface is not supported, then return zero.
1153 @return The size, in bytes, of the context buffer required for AES operations.
1154 @retval 0 This interface is not supported.
1164 Initializes user-supplied memory as AES context for subsequent use.
1166 This function initializes user-supplied memory pointed by AesContext as AES context.
1167 In addition, it sets up all AES key materials for subsequent encryption and decryption
1169 There are 3 options for key length, 128 bits, 192 bits, and 256 bits.
1171 If AesContext is NULL, then return FALSE.
1172 If Key is NULL, then return FALSE.
1173 If KeyLength is not valid, then return FALSE.
1174 If this interface is not supported, then return FALSE.
1176 @param[out] AesContext Pointer to AES context being initialized.
1177 @param[in] Key Pointer to the user-supplied AES key.
1178 @param[in] KeyLength Length of AES key in bits.
1180 @retval TRUE AES context initialization succeeded.
1181 @retval FALSE AES context initialization failed.
1182 @retval FALSE This interface is not supported.
1188 OUT VOID
*AesContext
,
1189 IN CONST UINT8
*Key
,
1194 Performs AES encryption on a data buffer of the specified size in CBC mode.
1196 This function performs AES encryption on data buffer pointed by Input, of specified
1197 size of InputSize, in CBC mode.
1198 InputSize must be multiple of block size (16 bytes). This function does not perform
1199 padding. Caller must perform padding, if necessary, to ensure valid input data size.
1200 Initialization vector should be one block size (16 bytes).
1201 AesContext should be already correctly initialized by AesInit(). Behavior with
1202 invalid AES context is undefined.
1204 If AesContext is NULL, then return FALSE.
1205 If Input is NULL, then return FALSE.
1206 If InputSize is not multiple of block size (16 bytes), then return FALSE.
1207 If Ivec is NULL, then return FALSE.
1208 If Output is NULL, then return FALSE.
1209 If this interface is not supported, then return FALSE.
1211 @param[in] AesContext Pointer to the AES context.
1212 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1213 @param[in] InputSize Size of the Input buffer in bytes.
1214 @param[in] Ivec Pointer to initialization vector.
1215 @param[out] Output Pointer to a buffer that receives the AES encryption output.
1217 @retval TRUE AES encryption succeeded.
1218 @retval FALSE AES encryption failed.
1219 @retval FALSE This interface is not supported.
1225 IN VOID
*AesContext
,
1226 IN CONST UINT8
*Input
,
1228 IN CONST UINT8
*Ivec
,
1233 Performs AES decryption on a data buffer of the specified size in CBC mode.
1235 This function performs AES decryption on data buffer pointed by Input, of specified
1236 size of InputSize, in CBC mode.
1237 InputSize must be multiple of block size (16 bytes). This function does not perform
1238 padding. Caller must perform padding, if necessary, to ensure valid input data size.
1239 Initialization vector should be one block size (16 bytes).
1240 AesContext should be already correctly initialized by AesInit(). Behavior with
1241 invalid AES context is undefined.
1243 If AesContext is NULL, then return FALSE.
1244 If Input is NULL, then return FALSE.
1245 If InputSize is not multiple of block size (16 bytes), then return FALSE.
1246 If Ivec is NULL, then return FALSE.
1247 If Output is NULL, then return FALSE.
1248 If this interface is not supported, then return FALSE.
1250 @param[in] AesContext Pointer to the AES context.
1251 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1252 @param[in] InputSize Size of the Input buffer in bytes.
1253 @param[in] Ivec Pointer to initialization vector.
1254 @param[out] Output Pointer to a buffer that receives the AES encryption output.
1256 @retval TRUE AES decryption succeeded.
1257 @retval FALSE AES decryption failed.
1258 @retval FALSE This interface is not supported.
1264 IN VOID
*AesContext
,
1265 IN CONST UINT8
*Input
,
1267 IN CONST UINT8
*Ivec
,
1271 //=====================================================================================
1272 // Asymmetric Cryptography Primitive
1273 //=====================================================================================
1276 Allocates and initializes one RSA context for subsequent use.
1278 @return Pointer to the RSA context that has been initialized.
1279 If the allocations fails, RsaNew() returns NULL.
1289 Release the specified RSA context.
1291 If RsaContext is NULL, then return FALSE.
1293 @param[in] RsaContext Pointer to the RSA context to be released.
1303 Sets the tag-designated key component into the established RSA context.
1305 This function sets the tag-designated RSA key component into the established
1306 RSA context from the user-specified non-negative integer (octet string format
1307 represented in RSA PKCS#1).
1308 If BigNumber is NULL, then the specified key component in RSA context is cleared.
1310 If RsaContext is NULL, then return FALSE.
1312 @param[in, out] RsaContext Pointer to RSA context being set.
1313 @param[in] KeyTag Tag of RSA key component being set.
1314 @param[in] BigNumber Pointer to octet integer buffer.
1315 If NULL, then the specified key component in RSA
1317 @param[in] BnSize Size of big number buffer in bytes.
1318 If BigNumber is NULL, then it is ignored.
1320 @retval TRUE RSA key component was set successfully.
1321 @retval FALSE Invalid RSA key component tag.
1327 IN OUT VOID
*RsaContext
,
1328 IN RSA_KEY_TAG KeyTag
,
1329 IN CONST UINT8
*BigNumber
,
1334 Gets the tag-designated RSA key component from the established RSA context.
1336 This function retrieves the tag-designated RSA key component from the
1337 established RSA context as a non-negative integer (octet string format
1338 represented in RSA PKCS#1).
1339 If specified key component has not been set or has been cleared, then returned
1341 If the BigNumber buffer is too small to hold the contents of the key, FALSE
1342 is returned and BnSize is set to the required buffer size to obtain the key.
1344 If RsaContext is NULL, then return FALSE.
1345 If BnSize is NULL, then return FALSE.
1346 If BnSize is large enough but BigNumber is NULL, then return FALSE.
1347 If this interface is not supported, then return FALSE.
1349 @param[in, out] RsaContext Pointer to RSA context being set.
1350 @param[in] KeyTag Tag of RSA key component being set.
1351 @param[out] BigNumber Pointer to octet integer buffer.
1352 @param[in, out] BnSize On input, the size of big number buffer in bytes.
1353 On output, the size of data returned in big number buffer in bytes.
1355 @retval TRUE RSA key component was retrieved successfully.
1356 @retval FALSE Invalid RSA key component tag.
1357 @retval FALSE BnSize is too small.
1358 @retval FALSE This interface is not supported.
1364 IN OUT VOID
*RsaContext
,
1365 IN RSA_KEY_TAG KeyTag
,
1366 OUT UINT8
*BigNumber
,
1367 IN OUT UINTN
*BnSize
1371 Generates RSA key components.
1373 This function generates RSA key components. It takes RSA public exponent E and
1374 length in bits of RSA modulus N as input, and generates all key components.
1375 If PublicExponent is NULL, the default RSA public exponent (0x10001) will be used.
1377 Before this function can be invoked, pseudorandom number generator must be correctly
1378 initialized by RandomSeed().
1380 If RsaContext is NULL, then return FALSE.
1381 If this interface is not supported, then return FALSE.
1383 @param[in, out] RsaContext Pointer to RSA context being set.
1384 @param[in] ModulusLength Length of RSA modulus N in bits.
1385 @param[in] PublicExponent Pointer to RSA public exponent.
1386 @param[in] PublicExponentSize Size of RSA public exponent buffer in bytes.
1388 @retval TRUE RSA key component was generated successfully.
1389 @retval FALSE Invalid RSA key component tag.
1390 @retval FALSE This interface is not supported.
1396 IN OUT VOID
*RsaContext
,
1397 IN UINTN ModulusLength
,
1398 IN CONST UINT8
*PublicExponent
,
1399 IN UINTN PublicExponentSize
1403 Validates key components of RSA context.
1404 NOTE: This function performs integrity checks on all the RSA key material, so
1405 the RSA key structure must contain all the private key data.
1407 This function validates key components of RSA context in following aspects:
1408 - Whether p is a prime
1409 - Whether q is a prime
1411 - Whether d*e = 1 mod lcm(p-1,q-1)
1413 If RsaContext is NULL, then return FALSE.
1414 If this interface is not supported, then return FALSE.
1416 @param[in] RsaContext Pointer to RSA context to check.
1418 @retval TRUE RSA key components are valid.
1419 @retval FALSE RSA key components are not valid.
1420 @retval FALSE This interface is not supported.
1430 Carries out the RSA-SSA signature generation with EMSA-PKCS1-v1_5 encoding scheme.
1432 This function carries out the RSA-SSA signature generation with EMSA-PKCS1-v1_5 encoding scheme defined in
1434 If the Signature buffer is too small to hold the contents of signature, FALSE
1435 is returned and SigSize is set to the required buffer size to obtain the signature.
1437 If RsaContext is NULL, then return FALSE.
1438 If MessageHash is NULL, then return FALSE.
1439 If HashSize is not equal to the size of MD5, SHA-1 or SHA-256 digest, then return FALSE.
1440 If SigSize is large enough but Signature is NULL, then return FALSE.
1441 If this interface is not supported, then return FALSE.
1443 @param[in] RsaContext Pointer to RSA context for signature generation.
1444 @param[in] MessageHash Pointer to octet message hash to be signed.
1445 @param[in] HashSize Size of the message hash in bytes.
1446 @param[out] Signature Pointer to buffer to receive RSA PKCS1-v1_5 signature.
1447 @param[in, out] SigSize On input, the size of Signature buffer in bytes.
1448 On output, the size of data returned in Signature buffer in bytes.
1450 @retval TRUE Signature successfully generated in PKCS1-v1_5.
1451 @retval FALSE Signature generation failed.
1452 @retval FALSE SigSize is too small.
1453 @retval FALSE This interface is not supported.
1459 IN VOID
*RsaContext
,
1460 IN CONST UINT8
*MessageHash
,
1462 OUT UINT8
*Signature
,
1463 IN OUT UINTN
*SigSize
1467 Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme defined in
1470 If RsaContext is NULL, then return FALSE.
1471 If MessageHash is NULL, then return FALSE.
1472 If Signature is NULL, then return FALSE.
1473 If HashSize is not equal to the size of MD5, SHA-1, SHA-256 digest, then return FALSE.
1475 @param[in] RsaContext Pointer to RSA context for signature verification.
1476 @param[in] MessageHash Pointer to octet message hash to be checked.
1477 @param[in] HashSize Size of the message hash in bytes.
1478 @param[in] Signature Pointer to RSA PKCS1-v1_5 signature to be verified.
1479 @param[in] SigSize Size of signature in bytes.
1481 @retval TRUE Valid signature encoded in PKCS1-v1_5.
1482 @retval FALSE Invalid signature or invalid RSA context.
1488 IN VOID
*RsaContext
,
1489 IN CONST UINT8
*MessageHash
,
1491 IN CONST UINT8
*Signature
,
1496 Retrieve the RSA Private Key from the password-protected PEM key data.
1498 If PemData is NULL, then return FALSE.
1499 If RsaContext is NULL, then return FALSE.
1500 If this interface is not supported, then return FALSE.
1502 @param[in] PemData Pointer to the PEM-encoded key data to be retrieved.
1503 @param[in] PemSize Size of the PEM key data in bytes.
1504 @param[in] Password NULL-terminated passphrase used for encrypted PEM key data.
1505 @param[out] RsaContext Pointer to new-generated RSA context which contain the retrieved
1506 RSA private key component. Use RsaFree() function to free the
1509 @retval TRUE RSA Private Key was retrieved successfully.
1510 @retval FALSE Invalid PEM key data or incorrect password.
1511 @retval FALSE This interface is not supported.
1516 RsaGetPrivateKeyFromPem (
1517 IN CONST UINT8
*PemData
,
1519 IN CONST CHAR8
*Password
,
1520 OUT VOID
**RsaContext
1524 Retrieve the RSA Public Key from one DER-encoded X509 certificate.
1526 If Cert is NULL, then return FALSE.
1527 If RsaContext is NULL, then return FALSE.
1528 If this interface is not supported, then return FALSE.
1530 @param[in] Cert Pointer to the DER-encoded X509 certificate.
1531 @param[in] CertSize Size of the X509 certificate in bytes.
1532 @param[out] RsaContext Pointer to new-generated RSA context which contain the retrieved
1533 RSA public key component. Use RsaFree() function to free the
1536 @retval TRUE RSA Public Key was retrieved successfully.
1537 @retval FALSE Fail to retrieve RSA public key from X509 certificate.
1538 @retval FALSE This interface is not supported.
1543 RsaGetPublicKeyFromX509 (
1544 IN CONST UINT8
*Cert
,
1546 OUT VOID
**RsaContext
1550 Retrieve the subject bytes from one X.509 certificate.
1552 If Cert is NULL, then return FALSE.
1553 If SubjectSize is NULL, then return FALSE.
1554 If this interface is not supported, then return FALSE.
1556 @param[in] Cert Pointer to the DER-encoded X509 certificate.
1557 @param[in] CertSize Size of the X509 certificate in bytes.
1558 @param[out] CertSubject Pointer to the retrieved certificate subject bytes.
1559 @param[in, out] SubjectSize The size in bytes of the CertSubject buffer on input,
1560 and the size of buffer returned CertSubject on output.
1562 @retval TRUE The certificate subject retrieved successfully.
1563 @retval FALSE Invalid certificate, or the SubjectSize is too small for the result.
1564 The SubjectSize will be updated with the required size.
1565 @retval FALSE This interface is not supported.
1570 X509GetSubjectName (
1571 IN CONST UINT8
*Cert
,
1573 OUT UINT8
*CertSubject
,
1574 IN OUT UINTN
*SubjectSize
1578 Retrieve the common name (CN) string from one X.509 certificate.
1580 @param[in] Cert Pointer to the DER-encoded X509 certificate.
1581 @param[in] CertSize Size of the X509 certificate in bytes.
1582 @param[out] CommonName Buffer to contain the retrieved certificate common
1583 name string (UTF8). At most CommonNameSize bytes will be
1584 written and the string will be null terminated. May be
1585 NULL in order to determine the size buffer needed.
1586 @param[in,out] CommonNameSize The size in bytes of the CommonName buffer on input,
1587 and the size of buffer returned CommonName on output.
1588 If CommonName is NULL then the amount of space needed
1589 in buffer (including the final null) is returned.
1591 @retval RETURN_SUCCESS The certificate CommonName retrieved successfully.
1592 @retval RETURN_INVALID_PARAMETER If Cert is NULL.
1593 If CommonNameSize is NULL.
1594 If CommonName is not NULL and *CommonNameSize is 0.
1595 If Certificate is invalid.
1596 @retval RETURN_NOT_FOUND If no CommonName entry exists.
1597 @retval RETURN_BUFFER_TOO_SMALL If the CommonName is NULL. The required buffer size
1598 (including the final null) is returned in the
1599 CommonNameSize parameter.
1600 @retval RETURN_UNSUPPORTED The operation is not supported.
1606 IN CONST UINT8
*Cert
,
1608 OUT CHAR8
*CommonName
, OPTIONAL
1609 IN OUT UINTN
*CommonNameSize
1613 Retrieve the organization name (O) string from one X.509 certificate.
1615 @param[in] Cert Pointer to the DER-encoded X509 certificate.
1616 @param[in] CertSize Size of the X509 certificate in bytes.
1617 @param[out] NameBuffer Buffer to contain the retrieved certificate organization
1618 name string. At most NameBufferSize bytes will be
1619 written and the string will be null terminated. May be
1620 NULL in order to determine the size buffer needed.
1621 @param[in,out] NameBufferSize The size in bytes of the Name buffer on input,
1622 and the size of buffer returned Name on output.
1623 If NameBuffer is NULL then the amount of space needed
1624 in buffer (including the final null) is returned.
1626 @retval RETURN_SUCCESS The certificate Organization Name retrieved successfully.
1627 @retval RETURN_INVALID_PARAMETER If Cert is NULL.
1628 If NameBufferSize is NULL.
1629 If NameBuffer is not NULL and *CommonNameSize is 0.
1630 If Certificate is invalid.
1631 @retval RETURN_NOT_FOUND If no Organization Name entry exists.
1632 @retval RETURN_BUFFER_TOO_SMALL If the NameBuffer is NULL. The required buffer size
1633 (including the final null) is returned in the
1634 CommonNameSize parameter.
1635 @retval RETURN_UNSUPPORTED The operation is not supported.
1640 X509GetOrganizationName (
1641 IN CONST UINT8
*Cert
,
1643 OUT CHAR8
*NameBuffer
, OPTIONAL
1644 IN OUT UINTN
*NameBufferSize
1648 Verify one X509 certificate was issued by the trusted CA.
1650 If Cert is NULL, then return FALSE.
1651 If CACert is NULL, then return FALSE.
1652 If this interface is not supported, then return FALSE.
1654 @param[in] Cert Pointer to the DER-encoded X509 certificate to be verified.
1655 @param[in] CertSize Size of the X509 certificate in bytes.
1656 @param[in] CACert Pointer to the DER-encoded trusted CA certificate.
1657 @param[in] CACertSize Size of the CA Certificate in bytes.
1659 @retval TRUE The certificate was issued by the trusted CA.
1660 @retval FALSE Invalid certificate or the certificate was not issued by the given
1662 @retval FALSE This interface is not supported.
1668 IN CONST UINT8
*Cert
,
1670 IN CONST UINT8
*CACert
,
1675 Construct a X509 object from DER-encoded certificate data.
1677 If Cert is NULL, then return FALSE.
1678 If SingleX509Cert is NULL, then return FALSE.
1679 If this interface is not supported, then return FALSE.
1681 @param[in] Cert Pointer to the DER-encoded certificate data.
1682 @param[in] CertSize The size of certificate data in bytes.
1683 @param[out] SingleX509Cert The generated X509 object.
1685 @retval TRUE The X509 object generation succeeded.
1686 @retval FALSE The operation failed.
1687 @retval FALSE This interface is not supported.
1692 X509ConstructCertificate (
1693 IN CONST UINT8
*Cert
,
1695 OUT UINT8
**SingleX509Cert
1699 Construct a X509 stack object from a list of DER-encoded certificate data.
1701 If X509Stack is NULL, then return FALSE.
1702 If this interface is not supported, then return FALSE.
1704 @param[in, out] X509Stack On input, pointer to an existing or NULL X509 stack object.
1705 On output, pointer to the X509 stack object with new
1706 inserted X509 certificate.
1707 @param[in] Args VA_LIST marker for the variable argument list.
1708 A list of DER-encoded single certificate data followed
1709 by certificate size. A NULL terminates the list. The
1710 pairs are the arguments to X509ConstructCertificate().
1712 @retval TRUE The X509 stack construction succeeded.
1713 @retval FALSE The construction operation failed.
1714 @retval FALSE This interface is not supported.
1719 X509ConstructCertificateStackV (
1720 IN OUT UINT8
**X509Stack
,
1725 Construct a X509 stack object from a list of DER-encoded certificate data.
1727 If X509Stack is NULL, then return FALSE.
1728 If this interface is not supported, then return FALSE.
1730 @param[in, out] X509Stack On input, pointer to an existing or NULL X509 stack object.
1731 On output, pointer to the X509 stack object with new
1732 inserted X509 certificate.
1733 @param ... A list of DER-encoded single certificate data followed
1734 by certificate size. A NULL terminates the list. The
1735 pairs are the arguments to X509ConstructCertificate().
1737 @retval TRUE The X509 stack construction succeeded.
1738 @retval FALSE The construction operation failed.
1739 @retval FALSE This interface is not supported.
1744 X509ConstructCertificateStack (
1745 IN OUT UINT8
**X509Stack
,
1750 Release the specified X509 object.
1752 If the interface is not supported, then ASSERT().
1754 @param[in] X509Cert Pointer to the X509 object to be released.
1764 Release the specified X509 stack object.
1766 If the interface is not supported, then ASSERT().
1768 @param[in] X509Stack Pointer to the X509 stack object to be released.
1778 Retrieve the TBSCertificate from one given X.509 certificate.
1780 @param[in] Cert Pointer to the given DER-encoded X509 certificate.
1781 @param[in] CertSize Size of the X509 certificate in bytes.
1782 @param[out] TBSCert DER-Encoded To-Be-Signed certificate.
1783 @param[out] TBSCertSize Size of the TBS certificate in bytes.
1785 If Cert is NULL, then return FALSE.
1786 If TBSCert is NULL, then return FALSE.
1787 If TBSCertSize is NULL, then return FALSE.
1788 If this interface is not supported, then return FALSE.
1790 @retval TRUE The TBSCertificate was retrieved successfully.
1791 @retval FALSE Invalid X.509 certificate.
1797 IN CONST UINT8
*Cert
,
1799 OUT UINT8
**TBSCert
,
1800 OUT UINTN
*TBSCertSize
1804 Derives a key from a password using a salt and iteration count, based on PKCS#5 v2.0
1805 password based encryption key derivation function PBKDF2, as specified in RFC 2898.
1807 If Password or Salt or OutKey is NULL, then return FALSE.
1808 If the hash algorithm could not be determined, then return FALSE.
1809 If this interface is not supported, then return FALSE.
1811 @param[in] PasswordLength Length of input password in bytes.
1812 @param[in] Password Pointer to the array for the password.
1813 @param[in] SaltLength Size of the Salt in bytes.
1814 @param[in] Salt Pointer to the Salt.
1815 @param[in] IterationCount Number of iterations to perform. Its value should be
1816 greater than or equal to 1.
1817 @param[in] DigestSize Size of the message digest to be used (eg. SHA256_DIGEST_SIZE).
1818 NOTE: DigestSize will be used to determine the hash algorithm.
1819 Only SHA1_DIGEST_SIZE or SHA256_DIGEST_SIZE is supported.
1820 @param[in] KeyLength Size of the derived key buffer in bytes.
1821 @param[out] OutKey Pointer to the output derived key buffer.
1823 @retval TRUE A key was derived successfully.
1824 @retval FALSE One of the pointers was NULL or one of the sizes was too large.
1825 @retval FALSE The hash algorithm could not be determined from the digest size.
1826 @retval FALSE The key derivation operation failed.
1827 @retval FALSE This interface is not supported.
1833 IN UINTN PasswordLength
,
1834 IN CONST CHAR8
*Password
,
1835 IN UINTN SaltLength
,
1836 IN CONST UINT8
*Salt
,
1837 IN UINTN IterationCount
,
1838 IN UINTN DigestSize
,
1844 Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the
1845 encrypted message in a newly allocated buffer.
1847 Things that can cause a failure include:
1848 - X509 key size does not match any known key size.
1849 - Fail to parse X509 certificate.
1850 - Fail to allocate an intermediate buffer.
1851 - Null pointer provided for a non-optional parameter.
1852 - Data size is too large for the provided key size (max size is a function of key size
1853 and hash digest size).
1855 @param[in] PublicKey A pointer to the DER-encoded X509 certificate that
1856 will be used to encrypt the data.
1857 @param[in] PublicKeySize Size of the X509 cert buffer.
1858 @param[in] InData Data to be encrypted.
1859 @param[in] InDataSize Size of the data buffer.
1860 @param[in] PrngSeed [Optional] If provided, a pointer to a random seed buffer
1861 to be used when initializing the PRNG. NULL otherwise.
1862 @param[in] PrngSeedSize [Optional] If provided, size of the random seed buffer.
1864 @param[out] EncryptedData Pointer to an allocated buffer containing the encrypted
1866 @param[out] EncryptedDataSize Size of the encrypted message buffer.
1868 @retval TRUE Encryption was successful.
1869 @retval FALSE Encryption failed.
1875 IN CONST UINT8
*PublicKey
,
1876 IN UINTN PublicKeySize
,
1878 IN UINTN InDataSize
,
1879 IN CONST UINT8
*PrngSeed
, OPTIONAL
1880 IN UINTN PrngSeedSize
, OPTIONAL
1881 OUT UINT8
**EncryptedData
,
1882 OUT UINTN
*EncryptedDataSize
1886 The 3rd parameter of Pkcs7GetSigners will return all embedded
1887 X.509 certificate in one given PKCS7 signature. The format is:
1889 // UINT8 CertNumber;
1890 // UINT32 Cert1Length;
1892 // UINT32 Cert2Length;
1895 // UINT32 CertnLength;
1899 The two following C-structure are used for parsing CertStack more clearly.
1904 UINT32 CertDataLength
; // The length in bytes of X.509 certificate.
1905 UINT8 CertDataBuffer
[0]; // The X.509 certificate content (DER).
1909 UINT8 CertNumber
; // Number of X.509 certificate.
1910 //EFI_CERT_DATA CertArray[]; // An array of X.509 certificate.
1916 Get the signer's certificates from PKCS#7 signed data as described in "PKCS #7:
1917 Cryptographic Message Syntax Standard". The input signed data could be wrapped
1918 in a ContentInfo structure.
1920 If P7Data, CertStack, StackLength, TrustedCert or CertLength is NULL, then
1921 return FALSE. If P7Length overflow, then return FALSE.
1922 If this interface is not supported, then return FALSE.
1924 @param[in] P7Data Pointer to the PKCS#7 message to verify.
1925 @param[in] P7Length Length of the PKCS#7 message in bytes.
1926 @param[out] CertStack Pointer to Signer's certificates retrieved from P7Data.
1927 It's caller's responsibility to free the buffer with
1929 This data structure is EFI_CERT_STACK type.
1930 @param[out] StackLength Length of signer's certificates in bytes.
1931 @param[out] TrustedCert Pointer to a trusted certificate from Signer's certificates.
1932 It's caller's responsibility to free the buffer with
1934 @param[out] CertLength Length of the trusted certificate in bytes.
1936 @retval TRUE The operation is finished successfully.
1937 @retval FALSE Error occurs during the operation.
1938 @retval FALSE This interface is not supported.
1944 IN CONST UINT8
*P7Data
,
1946 OUT UINT8
**CertStack
,
1947 OUT UINTN
*StackLength
,
1948 OUT UINT8
**TrustedCert
,
1949 OUT UINTN
*CertLength
1953 Wrap function to use free() to free allocated memory for certificates.
1955 If this interface is not supported, then ASSERT().
1957 @param[in] Certs Pointer to the certificates to be freed.
1967 Retrieves all embedded certificates from PKCS#7 signed data as described in "PKCS #7:
1968 Cryptographic Message Syntax Standard", and outputs two certificate lists chained and
1969 unchained to the signer's certificates.
1970 The input signed data could be wrapped in a ContentInfo structure.
1972 @param[in] P7Data Pointer to the PKCS#7 message.
1973 @param[in] P7Length Length of the PKCS#7 message in bytes.
1974 @param[out] SignerChainCerts Pointer to the certificates list chained to signer's
1975 certificate. It's caller's responsibility to free the buffer
1976 with Pkcs7FreeSigners().
1977 This data structure is EFI_CERT_STACK type.
1978 @param[out] ChainLength Length of the chained certificates list buffer in bytes.
1979 @param[out] UnchainCerts Pointer to the unchained certificates lists. It's caller's
1980 responsibility to free the buffer with Pkcs7FreeSigners().
1981 This data structure is EFI_CERT_STACK type.
1982 @param[out] UnchainLength Length of the unchained certificates list buffer in bytes.
1984 @retval TRUE The operation is finished successfully.
1985 @retval FALSE Error occurs during the operation.
1990 Pkcs7GetCertificatesList (
1991 IN CONST UINT8
*P7Data
,
1993 OUT UINT8
**SignerChainCerts
,
1994 OUT UINTN
*ChainLength
,
1995 OUT UINT8
**UnchainCerts
,
1996 OUT UINTN
*UnchainLength
2000 Creates a PKCS#7 signedData as described in "PKCS #7: Cryptographic Message
2001 Syntax Standard, version 1.5". This interface is only intended to be used for
2002 application to perform PKCS#7 functionality validation.
2004 If this interface is not supported, then return FALSE.
2006 @param[in] PrivateKey Pointer to the PEM-formatted private key data for
2008 @param[in] PrivateKeySize Size of the PEM private key data in bytes.
2009 @param[in] KeyPassword NULL-terminated passphrase used for encrypted PEM
2011 @param[in] InData Pointer to the content to be signed.
2012 @param[in] InDataSize Size of InData in bytes.
2013 @param[in] SignCert Pointer to signer's DER-encoded certificate to sign with.
2014 @param[in] OtherCerts Pointer to an optional additional set of certificates to
2015 include in the PKCS#7 signedData (e.g. any intermediate
2017 @param[out] SignedData Pointer to output PKCS#7 signedData. It's caller's
2018 responsibility to free the buffer with FreePool().
2019 @param[out] SignedDataSize Size of SignedData in bytes.
2021 @retval TRUE PKCS#7 data signing succeeded.
2022 @retval FALSE PKCS#7 data signing failed.
2023 @retval FALSE This interface is not supported.
2029 IN CONST UINT8
*PrivateKey
,
2030 IN UINTN PrivateKeySize
,
2031 IN CONST UINT8
*KeyPassword
,
2033 IN UINTN InDataSize
,
2035 IN UINT8
*OtherCerts OPTIONAL
,
2036 OUT UINT8
**SignedData
,
2037 OUT UINTN
*SignedDataSize
2041 Verifies the validity of a PKCS#7 signed data as described in "PKCS #7:
2042 Cryptographic Message Syntax Standard". The input signed data could be wrapped
2043 in a ContentInfo structure.
2045 If P7Data, TrustedCert or InData is NULL, then return FALSE.
2046 If P7Length, CertLength or DataLength overflow, then return FALSE.
2047 If this interface is not supported, then return FALSE.
2049 @param[in] P7Data Pointer to the PKCS#7 message to verify.
2050 @param[in] P7Length Length of the PKCS#7 message in bytes.
2051 @param[in] TrustedCert Pointer to a trusted/root certificate encoded in DER, which
2052 is used for certificate chain verification.
2053 @param[in] CertLength Length of the trusted certificate in bytes.
2054 @param[in] InData Pointer to the content to be verified.
2055 @param[in] DataLength Length of InData in bytes.
2057 @retval TRUE The specified PKCS#7 signed data is valid.
2058 @retval FALSE Invalid PKCS#7 signed data.
2059 @retval FALSE This interface is not supported.
2065 IN CONST UINT8
*P7Data
,
2067 IN CONST UINT8
*TrustedCert
,
2068 IN UINTN CertLength
,
2069 IN CONST UINT8
*InData
,
2074 This function receives a PKCS7 formatted signature, and then verifies that
2075 the specified Enhanced or Extended Key Usages (EKU's) are present in the end-entity
2076 leaf signing certificate.
2077 Note that this function does not validate the certificate chain.
2079 Applications for custom EKU's are quite flexible. For example, a policy EKU
2080 may be present in an Issuing Certificate Authority (CA), and any sub-ordinate
2081 certificate issued might also contain this EKU, thus constraining the
2082 sub-ordinate certificate. Other applications might allow a certificate
2083 embedded in a device to specify that other Object Identifiers (OIDs) are
2084 present which contains binary data specifying custom capabilities that
2085 the device is able to do.
2087 @param[in] Pkcs7Signature The PKCS#7 signed information content block. An array
2088 containing the content block with both the signature,
2089 the signer's certificate, and any necessary intermediate
2091 @param[in] Pkcs7SignatureSize Number of bytes in Pkcs7Signature.
2092 @param[in] RequiredEKUs Array of null-terminated strings listing OIDs of
2093 required EKUs that must be present in the signature.
2094 @param[in] RequiredEKUsSize Number of elements in the RequiredEKUs string array.
2095 @param[in] RequireAllPresent If this is TRUE, then all of the specified EKU's
2096 must be present in the leaf signer. If it is
2097 FALSE, then we will succeed if we find any
2098 of the specified EKU's.
2100 @retval EFI_SUCCESS The required EKUs were found in the signature.
2101 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2102 @retval EFI_NOT_FOUND One or more EKU's were not found in the signature.
2107 VerifyEKUsInPkcs7Signature (
2108 IN CONST UINT8
*Pkcs7Signature
,
2109 IN CONST UINT32 SignatureSize
,
2110 IN CONST CHAR8
*RequiredEKUs
[],
2111 IN CONST UINT32 RequiredEKUsSize
,
2112 IN BOOLEAN RequireAllPresent
2116 Extracts the attached content from a PKCS#7 signed data if existed. The input signed
2117 data could be wrapped in a ContentInfo structure.
2119 If P7Data, Content, or ContentSize is NULL, then return FALSE. If P7Length overflow,
2120 then return FALSE. If the P7Data is not correctly formatted, then return FALSE.
2122 Caution: This function may receive untrusted input. So this function will do
2123 basic check for PKCS#7 data structure.
2125 @param[in] P7Data Pointer to the PKCS#7 signed data to process.
2126 @param[in] P7Length Length of the PKCS#7 signed data in bytes.
2127 @param[out] Content Pointer to the extracted content from the PKCS#7 signedData.
2128 It's caller's responsibility to free the buffer with FreePool().
2129 @param[out] ContentSize The size of the extracted content in bytes.
2131 @retval TRUE The P7Data was correctly formatted for processing.
2132 @retval FALSE The P7Data was not correctly formatted for processing.
2137 Pkcs7GetAttachedContent (
2138 IN CONST UINT8
*P7Data
,
2141 OUT UINTN
*ContentSize
2145 Verifies the validity of a PE/COFF Authenticode Signature as described in "Windows
2146 Authenticode Portable Executable Signature Format".
2148 If AuthData is NULL, then return FALSE.
2149 If ImageHash is NULL, then return FALSE.
2150 If this interface is not supported, then return FALSE.
2152 @param[in] AuthData Pointer to the Authenticode Signature retrieved from signed
2153 PE/COFF image to be verified.
2154 @param[in] DataSize Size of the Authenticode Signature in bytes.
2155 @param[in] TrustedCert Pointer to a trusted/root certificate encoded in DER, which
2156 is used for certificate chain verification.
2157 @param[in] CertSize Size of the trusted certificate in bytes.
2158 @param[in] ImageHash Pointer to the original image file hash value. The procedure
2159 for calculating the image hash value is described in Authenticode
2161 @param[in] HashSize Size of Image hash value in bytes.
2163 @retval TRUE The specified Authenticode Signature is valid.
2164 @retval FALSE Invalid Authenticode Signature.
2165 @retval FALSE This interface is not supported.
2170 AuthenticodeVerify (
2171 IN CONST UINT8
*AuthData
,
2173 IN CONST UINT8
*TrustedCert
,
2175 IN CONST UINT8
*ImageHash
,
2180 Verifies the validity of a RFC3161 Timestamp CounterSignature embedded in PE/COFF Authenticode
2183 If AuthData is NULL, then return FALSE.
2184 If this interface is not supported, then return FALSE.
2186 @param[in] AuthData Pointer to the Authenticode Signature retrieved from signed
2187 PE/COFF image to be verified.
2188 @param[in] DataSize Size of the Authenticode Signature in bytes.
2189 @param[in] TsaCert Pointer to a trusted/root TSA certificate encoded in DER, which
2190 is used for TSA certificate chain verification.
2191 @param[in] CertSize Size of the trusted certificate in bytes.
2192 @param[out] SigningTime Return the time of timestamp generation time if the timestamp
2195 @retval TRUE The specified Authenticode includes a valid RFC3161 Timestamp CounterSignature.
2196 @retval FALSE No valid RFC3161 Timestamp CounterSignature in the specified Authenticode data.
2201 ImageTimestampVerify (
2202 IN CONST UINT8
*AuthData
,
2204 IN CONST UINT8
*TsaCert
,
2206 OUT EFI_TIME
*SigningTime
2209 //=====================================================================================
2210 // DH Key Exchange Primitive
2211 //=====================================================================================
2214 Allocates and Initializes one Diffie-Hellman Context for subsequent use.
2216 @return Pointer to the Diffie-Hellman Context that has been initialized.
2217 If the allocations fails, DhNew() returns NULL.
2218 If the interface is not supported, DhNew() returns NULL.
2228 Release the specified DH context.
2230 If the interface is not supported, then ASSERT().
2232 @param[in] DhContext Pointer to the DH context to be released.
2242 Generates DH parameter.
2244 Given generator g, and length of prime number p in bits, this function generates p,
2245 and sets DH context according to value of g and p.
2247 Before this function can be invoked, pseudorandom number generator must be correctly
2248 initialized by RandomSeed().
2250 If DhContext is NULL, then return FALSE.
2251 If Prime is NULL, then return FALSE.
2252 If this interface is not supported, then return FALSE.
2254 @param[in, out] DhContext Pointer to the DH context.
2255 @param[in] Generator Value of generator.
2256 @param[in] PrimeLength Length in bits of prime to be generated.
2257 @param[out] Prime Pointer to the buffer to receive the generated prime number.
2259 @retval TRUE DH parameter generation succeeded.
2260 @retval FALSE Value of Generator is not supported.
2261 @retval FALSE PRNG fails to generate random prime number with PrimeLength.
2262 @retval FALSE This interface is not supported.
2267 DhGenerateParameter (
2268 IN OUT VOID
*DhContext
,
2270 IN UINTN PrimeLength
,
2275 Sets generator and prime parameters for DH.
2277 Given generator g, and prime number p, this function and sets DH
2278 context accordingly.
2280 If DhContext is NULL, then return FALSE.
2281 If Prime is NULL, then return FALSE.
2282 If this interface is not supported, then return FALSE.
2284 @param[in, out] DhContext Pointer to the DH context.
2285 @param[in] Generator Value of generator.
2286 @param[in] PrimeLength Length in bits of prime to be generated.
2287 @param[in] Prime Pointer to the prime number.
2289 @retval TRUE DH parameter setting succeeded.
2290 @retval FALSE Value of Generator is not supported.
2291 @retval FALSE Value of Generator is not suitable for the Prime.
2292 @retval FALSE Value of Prime is not a prime number.
2293 @retval FALSE Value of Prime is not a safe prime number.
2294 @retval FALSE This interface is not supported.
2300 IN OUT VOID
*DhContext
,
2302 IN UINTN PrimeLength
,
2303 IN CONST UINT8
*Prime
2307 Generates DH public key.
2309 This function generates random secret exponent, and computes the public key, which is
2310 returned via parameter PublicKey and PublicKeySize. DH context is updated accordingly.
2311 If the PublicKey buffer is too small to hold the public key, FALSE is returned and
2312 PublicKeySize is set to the required buffer size to obtain the public key.
2314 If DhContext is NULL, then return FALSE.
2315 If PublicKeySize is NULL, then return FALSE.
2316 If PublicKeySize is large enough but PublicKey is NULL, then return FALSE.
2317 If this interface is not supported, then return FALSE.
2319 @param[in, out] DhContext Pointer to the DH context.
2320 @param[out] PublicKey Pointer to the buffer to receive generated public key.
2321 @param[in, out] PublicKeySize On input, the size of PublicKey buffer in bytes.
2322 On output, the size of data returned in PublicKey buffer in bytes.
2324 @retval TRUE DH public key generation succeeded.
2325 @retval FALSE DH public key generation failed.
2326 @retval FALSE PublicKeySize is not large enough.
2327 @retval FALSE This interface is not supported.
2333 IN OUT VOID
*DhContext
,
2334 OUT UINT8
*PublicKey
,
2335 IN OUT UINTN
*PublicKeySize
2339 Computes exchanged common key.
2341 Given peer's public key, this function computes the exchanged common key, based on its own
2342 context including value of prime modulus and random secret exponent.
2344 If DhContext is NULL, then return FALSE.
2345 If PeerPublicKey is NULL, then return FALSE.
2346 If KeySize is NULL, then return FALSE.
2347 If Key is NULL, then return FALSE.
2348 If KeySize is not large enough, then return FALSE.
2349 If this interface is not supported, then return FALSE.
2351 @param[in, out] DhContext Pointer to the DH context.
2352 @param[in] PeerPublicKey Pointer to the peer's public key.
2353 @param[in] PeerPublicKeySize Size of peer's public key in bytes.
2354 @param[out] Key Pointer to the buffer to receive generated key.
2355 @param[in, out] KeySize On input, the size of Key buffer in bytes.
2356 On output, the size of data returned in Key buffer in bytes.
2358 @retval TRUE DH exchanged key generation succeeded.
2359 @retval FALSE DH exchanged key generation failed.
2360 @retval FALSE KeySize is not large enough.
2361 @retval FALSE This interface is not supported.
2367 IN OUT VOID
*DhContext
,
2368 IN CONST UINT8
*PeerPublicKey
,
2369 IN UINTN PeerPublicKeySize
,
2371 IN OUT UINTN
*KeySize
2374 //=====================================================================================
2375 // Pseudo-Random Generation Primitive
2376 //=====================================================================================
2379 Sets up the seed value for the pseudorandom number generator.
2381 This function sets up the seed value for the pseudorandom number generator.
2382 If Seed is not NULL, then the seed passed in is used.
2383 If Seed is NULL, then default seed is used.
2384 If this interface is not supported, then return FALSE.
2386 @param[in] Seed Pointer to seed value.
2387 If NULL, default seed is used.
2388 @param[in] SeedSize Size of seed value.
2389 If Seed is NULL, this parameter is ignored.
2391 @retval TRUE Pseudorandom number generator has enough entropy for random generation.
2392 @retval FALSE Pseudorandom number generator does not have enough entropy for random generation.
2393 @retval FALSE This interface is not supported.
2399 IN CONST UINT8
*Seed OPTIONAL
,
2404 Generates a pseudorandom byte stream of the specified size.
2406 If Output is NULL, then return FALSE.
2407 If this interface is not supported, then return FALSE.
2409 @param[out] Output Pointer to buffer to receive random value.
2410 @param[in] Size Size of random bytes to generate.
2412 @retval TRUE Pseudorandom byte stream generated successfully.
2413 @retval FALSE Pseudorandom number generator fails to generate due to lack of entropy.
2414 @retval FALSE This interface is not supported.
2424 //=====================================================================================
2425 // Key Derivation Function Primitive
2426 //=====================================================================================
2429 Derive key data using HMAC-SHA256 based KDF.
2431 @param[in] Key Pointer to the user-supplied key.
2432 @param[in] KeySize Key size in bytes.
2433 @param[in] Salt Pointer to the salt(non-secret) value.
2434 @param[in] SaltSize Salt size in bytes.
2435 @param[in] Info Pointer to the application specific info.
2436 @param[in] InfoSize Info size in bytes.
2437 @param[out] Out Pointer to buffer to receive hkdf value.
2438 @param[in] OutSize Size of hkdf bytes to generate.
2440 @retval TRUE Hkdf generated successfully.
2441 @retval FALSE Hkdf generation failed.
2446 HkdfSha256ExtractAndExpand (
2447 IN CONST UINT8
*Key
,
2449 IN CONST UINT8
*Salt
,
2451 IN CONST UINT8
*Info
,
2457 #endif // __BASE_CRYPT_LIB_H__