2 Implements the EDK II Crypto Protocol/PPI services using the library services
3 from BaseCryptLib and TlsLib.
5 Copyright (C) Microsoft Corporation. All rights reserved.
6 Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
11 #include <Library/DebugLib.h>
12 #include <Library/BaseCryptLib.h>
13 #include <Library/TlsLib.h>
14 #include <Protocol/Crypto.h>
15 #include <Pcd/PcdCryptoServiceFamilyEnable.h>
18 A macro used to retrieve the FixedAtBuild PcdCryptoServiceFamilyEnable with a
19 typecast to its associcted structure type PCD_CRYPTO_SERVICE_FAMILY_ENABLE.
21 #define EDKII_CRYPTO_PCD ((const PCD_CRYPTO_SERVICE_FAMILY_ENABLE *) \
22 (FixedPcdGetPtr (PcdCryptoServiceFamilyEnable)))
25 A macro used to call a non-void BaseCryptLib function if it is enabled.
27 If a BaseCryptLib function is not enabled, there will be no references to it
28 from this module and will be optimized away reducing the size of this module.
30 @param Enable The name of the enable field in PCD
31 PcdCryptoServiceFamilyEnable for the BaseCryptLib
32 function being called. If the value of this field
33 is non-zero, then the BaseCryptLib function is
35 @param Function The name of the BaseCryptLib function.
36 @param Args The argument list to pass to Function.
37 @param ErrorReturnValue The value to return if the BaseCryptLib function is
41 #define CALL_BASECRYPTLIB(Enable, Function, Args, ErrorReturnValue) \
42 EDKII_CRYPTO_PCD->Enable \
44 : (BaseCryptLibServiceNotEnabled (#Function), ErrorReturnValue)
47 A macro used to call a void BaseCryptLib function if it is enabled.
49 If a BaseCryptLib function is not enabled, there will be no references to it
50 from this module and will be optimized away reducing the size of this module.
52 @param Enable The name of the enable field in PCD
53 PcdCryptoServiceFamilyEnable for the BaseCryptLib
54 function being called. If the value of this field
55 is non-zero, then the BaseCryptLib function is
57 @param Function The name of the BaseCryptLib function.
58 @param Args The argument list to pass to Function.
61 #define CALL_VOID_BASECRYPTLIB(Enable, Function, Args) \
62 EDKII_CRYPTO_PCD->Enable \
64 : BaseCryptLibServiceNotEnabled (#Function)
67 Internal worker function that prints a debug message and asserts if a call is
68 made to a BaseCryptLib function that is not enabled in the EDK II Crypto
71 If this debug message and assert are observed, then a module is using
72 BaseCryptLib function that is not enabled in a Crypto driver. The
73 PcdCryptoServiceFamilyEnable should be updated to enable the missing service.
75 @param[in] FunctionName Null-terminated ASCII string that is the name of an
76 EDK II Crypto service.
81 BaseCryptLibServiceNotEnabled (
82 IN CONST CHAR8
*FunctionName
85 DEBUG ((DEBUG_ERROR
, "[%a] Function %a() is not enabled\n", gEfiCallerBaseName
, FunctionName
));
86 ASSERT_EFI_ERROR (EFI_UNSUPPORTED
);
90 Internal worker function that prints a debug message and asserts if a call is
91 made to a BaseCryptLib function that is deprecated and unsupported any longer.
93 @param[in] FunctionName Null-terminated ASCII string that is the name of an
94 EDK II Crypto service.
99 BaseCryptLibServiceDeprecated (
100 IN CONST CHAR8
*FunctionName
103 DEBUG ((DEBUG_ERROR
, "[%a] Function %a() is deprecated and unsupported any longer\n", gEfiCallerBaseName
, FunctionName
));
104 ASSERT_EFI_ERROR (EFI_UNSUPPORTED
);
108 Returns the version of the EDK II Crypto Protocol.
110 @return The version of the EDK II Crypto Protocol.
115 CryptoServiceGetCryptoVersion (
119 return EDKII_CRYPTO_VERSION
;
122 //=====================================================================================
123 // One-Way Cryptographic Hash Primitives
124 //=====================================================================================
127 MD4 is deprecated and unsupported any longer.
128 Keep the function field for binary compability.
130 @retval 0 This interface is not supported.
135 DeprecatedCryptoServiceMd4GetContextSize (
139 return BaseCryptLibServiceDeprecated ("Md4GetContextSize"), 0;
143 MD4 is deprecated and unsupported any longer.
144 Keep the function field for binary compability.
146 @param[out] Md4Context Pointer to MD4 context being initialized.
148 @retval FALSE This interface is not supported.
153 DeprecatedCryptoServiceMd4Init (
157 return BaseCryptLibServiceDeprecated ("Md4Init"), FALSE
;
161 MD4 is deprecated and unsupported any longer.
162 Keep the function field for binary compability.
164 @param[in] Md4Context Pointer to MD4 context being copied.
165 @param[out] NewMd4Context Pointer to new MD4 context.
167 @retval FALSE This interface is not supported.
172 DeprecatedCryptoServiceMd4Duplicate (
173 IN CONST VOID
*Md4Context
,
174 OUT VOID
*NewMd4Context
177 return BaseCryptLibServiceDeprecated ("Md4Duplicate"), FALSE
;
181 MD4 is deprecated and unsupported any longer.
182 Keep the function field for binary compability.
184 @param[in, out] Md4Context Pointer to the MD4 context.
185 @param[in] Data Pointer to the buffer containing the data to be hashed.
186 @param[in] DataSize Size of Data buffer in bytes.
188 @retval FALSE This interface is not supported.
193 DeprecatedCryptoServiceMd4Update (
194 IN OUT VOID
*Md4Context
,
199 return BaseCryptLibServiceDeprecated ("Md4Update"), FALSE
;
203 MD4 is deprecated and unsupported any longer.
204 Keep the function field for binary compability.
206 @param[in, out] Md4Context Pointer to the MD4 context.
207 @param[out] HashValue Pointer to a buffer that receives the MD4 digest
210 @retval FALSE This interface is not supported.
215 DeprecatedCryptoServiceMd4Final (
216 IN OUT VOID
*Md4Context
,
220 return BaseCryptLibServiceDeprecated ("Md4Final"), FALSE
;
224 MD4 is deprecated and unsupported any longer.
225 Keep the function field for binary compability.
227 @param[in] Data Pointer to the buffer containing the data to be hashed.
228 @param[in] DataSize Size of Data buffer in bytes.
229 @param[out] HashValue Pointer to a buffer that receives the MD4 digest
232 @retval FALSE This interface is not supported.
237 DeprecatedCryptoServiceMd4HashAll (
243 return BaseCryptLibServiceDeprecated ("Md4HashAll"), FALSE
;
247 Retrieves the size, in bytes, of the context buffer required for MD5 hash operations.
249 If this interface is not supported, then return zero.
251 @return The size, in bytes, of the context buffer required for MD5 hash operations.
252 @retval 0 This interface is not supported.
257 CryptoServiceMd5GetContextSize (
261 return CALL_BASECRYPTLIB (Md5
.Services
.GetContextSize
, Md5GetContextSize
, (), 0);
265 Initializes user-supplied memory pointed by Md5Context as MD5 hash context for
268 If Md5Context is NULL, then return FALSE.
269 If this interface is not supported, then return FALSE.
271 @param[out] Md5Context Pointer to MD5 context being initialized.
273 @retval TRUE MD5 context initialization succeeded.
274 @retval FALSE MD5 context initialization failed.
275 @retval FALSE This interface is not supported.
280 CryptoServiceMd5Init (
284 return CALL_BASECRYPTLIB (Md5
.Services
.Init
, Md5Init
, (Md5Context
), FALSE
);
288 Makes a copy of an existing MD5 context.
290 If Md5Context is NULL, then return FALSE.
291 If NewMd5Context is NULL, then return FALSE.
292 If this interface is not supported, then return FALSE.
294 @param[in] Md5Context Pointer to MD5 context being copied.
295 @param[out] NewMd5Context Pointer to new MD5 context.
297 @retval TRUE MD5 context copy succeeded.
298 @retval FALSE MD5 context copy failed.
299 @retval FALSE This interface is not supported.
304 CryptoServiceMd5Duplicate (
305 IN CONST VOID
*Md5Context
,
306 OUT VOID
*NewMd5Context
309 return CALL_BASECRYPTLIB (Md5
.Services
.Duplicate
, Md5Duplicate
, (Md5Context
, NewMd5Context
), FALSE
);
313 Digests the input data and updates MD5 context.
315 This function performs MD5 digest on a data buffer of the specified size.
316 It can be called multiple times to compute the digest of long or discontinuous data streams.
317 MD5 context should be already correctly initialized by Md5Init(), and should not be finalized
318 by Md5Final(). Behavior with invalid context is undefined.
320 If Md5Context is NULL, then return FALSE.
321 If this interface is not supported, then return FALSE.
323 @param[in, out] Md5Context Pointer to the MD5 context.
324 @param[in] Data Pointer to the buffer containing the data to be hashed.
325 @param[in] DataSize Size of Data buffer in bytes.
327 @retval TRUE MD5 data digest succeeded.
328 @retval FALSE MD5 data digest failed.
329 @retval FALSE This interface is not supported.
334 CryptoServiceMd5Update (
335 IN OUT VOID
*Md5Context
,
340 return CALL_BASECRYPTLIB (Md5
.Services
.Update
, Md5Update
, (Md5Context
, Data
, DataSize
), FALSE
);
344 Completes computation of the MD5 digest value.
346 This function completes MD5 hash computation and retrieves the digest value into
347 the specified memory. After this function has been called, the MD5 context cannot
349 MD5 context should be already correctly initialized by Md5Init(), and should not be
350 finalized by Md5Final(). Behavior with invalid MD5 context is undefined.
352 If Md5Context is NULL, then return FALSE.
353 If HashValue is NULL, then return FALSE.
354 If this interface is not supported, then return FALSE.
356 @param[in, out] Md5Context Pointer to the MD5 context.
357 @param[out] HashValue Pointer to a buffer that receives the MD5 digest
360 @retval TRUE MD5 digest computation succeeded.
361 @retval FALSE MD5 digest computation failed.
362 @retval FALSE This interface is not supported.
367 CryptoServiceMd5Final (
368 IN OUT VOID
*Md5Context
,
372 return CALL_BASECRYPTLIB (Md5
.Services
.Final
, Md5Final
, (Md5Context
, HashValue
), FALSE
);
376 Computes the MD5 message digest of a input data buffer.
378 This function performs the MD5 message digest of a given data buffer, and places
379 the digest value into the specified memory.
381 If this interface is not supported, then return FALSE.
383 @param[in] Data Pointer to the buffer containing the data to be hashed.
384 @param[in] DataSize Size of Data buffer in bytes.
385 @param[out] HashValue Pointer to a buffer that receives the MD5 digest
388 @retval TRUE MD5 digest computation succeeded.
389 @retval FALSE MD5 digest computation failed.
390 @retval FALSE This interface is not supported.
395 CryptoServiceMd5HashAll (
401 return CALL_BASECRYPTLIB (Md5
.Services
.HashAll
, Md5HashAll
, (Data
, DataSize
, HashValue
), FALSE
);
405 Retrieves the size, in bytes, of the context buffer required for SHA-1 hash operations.
407 If this interface is not supported, then return zero.
409 @return The size, in bytes, of the context buffer required for SHA-1 hash operations.
410 @retval 0 This interface is not supported.
415 CryptoServiceSha1GetContextSize (
419 return CALL_BASECRYPTLIB (Sha1
.Services
.GetContextSize
, Sha1GetContextSize
, (), 0);
423 Initializes user-supplied memory pointed by Sha1Context as SHA-1 hash context for
426 If Sha1Context is NULL, then return FALSE.
427 If this interface is not supported, then return FALSE.
429 @param[out] Sha1Context Pointer to SHA-1 context being initialized.
431 @retval TRUE SHA-1 context initialization succeeded.
432 @retval FALSE SHA-1 context initialization failed.
433 @retval FALSE This interface is not supported.
438 CryptoServiceSha1Init (
439 OUT VOID
*Sha1Context
442 return CALL_BASECRYPTLIB (Sha1
.Services
.Init
, Sha1Init
, (Sha1Context
), FALSE
);
446 Makes a copy of an existing SHA-1 context.
448 If Sha1Context is NULL, then return FALSE.
449 If NewSha1Context is NULL, then return FALSE.
450 If this interface is not supported, then return FALSE.
452 @param[in] Sha1Context Pointer to SHA-1 context being copied.
453 @param[out] NewSha1Context Pointer to new SHA-1 context.
455 @retval TRUE SHA-1 context copy succeeded.
456 @retval FALSE SHA-1 context copy failed.
457 @retval FALSE This interface is not supported.
462 CryptoServiceSha1Duplicate (
463 IN CONST VOID
*Sha1Context
,
464 OUT VOID
*NewSha1Context
467 return CALL_BASECRYPTLIB (Sha1
.Services
.Duplicate
, Sha1Duplicate
, (Sha1Context
, NewSha1Context
), FALSE
);
471 Digests the input data and updates SHA-1 context.
473 This function performs SHA-1 digest on a data buffer of the specified size.
474 It can be called multiple times to compute the digest of long or discontinuous data streams.
475 SHA-1 context should be already correctly initialized by Sha1Init(), and should not be finalized
476 by Sha1Final(). Behavior with invalid context is undefined.
478 If Sha1Context is NULL, then return FALSE.
479 If this interface is not supported, then return FALSE.
481 @param[in, out] Sha1Context Pointer to the SHA-1 context.
482 @param[in] Data Pointer to the buffer containing the data to be hashed.
483 @param[in] DataSize Size of Data buffer in bytes.
485 @retval TRUE SHA-1 data digest succeeded.
486 @retval FALSE SHA-1 data digest failed.
487 @retval FALSE This interface is not supported.
492 CryptoServiceSha1Update (
493 IN OUT VOID
*Sha1Context
,
498 return CALL_BASECRYPTLIB (Sha1
.Services
.Update
, Sha1Update
, (Sha1Context
, Data
, DataSize
), FALSE
);
502 Completes computation of the SHA-1 digest value.
504 This function completes SHA-1 hash computation and retrieves the digest value into
505 the specified memory. After this function has been called, the SHA-1 context cannot
507 SHA-1 context should be already correctly initialized by Sha1Init(), and should not be
508 finalized by Sha1Final(). Behavior with invalid SHA-1 context is undefined.
510 If Sha1Context is NULL, then return FALSE.
511 If HashValue is NULL, then return FALSE.
512 If this interface is not supported, then return FALSE.
514 @param[in, out] Sha1Context Pointer to the SHA-1 context.
515 @param[out] HashValue Pointer to a buffer that receives the SHA-1 digest
518 @retval TRUE SHA-1 digest computation succeeded.
519 @retval FALSE SHA-1 digest computation failed.
520 @retval FALSE This interface is not supported.
525 CryptoServiceSha1Final (
526 IN OUT VOID
*Sha1Context
,
530 return CALL_BASECRYPTLIB (Sha1
.Services
.Final
, Sha1Final
, (Sha1Context
, HashValue
), FALSE
);
534 Computes the SHA-1 message digest of a input data buffer.
536 This function performs the SHA-1 message digest of a given data buffer, and places
537 the digest value into the specified memory.
539 If this interface is not supported, then return FALSE.
541 @param[in] Data Pointer to the buffer containing the data to be hashed.
542 @param[in] DataSize Size of Data buffer in bytes.
543 @param[out] HashValue Pointer to a buffer that receives the SHA-1 digest
546 @retval TRUE SHA-1 digest computation succeeded.
547 @retval FALSE SHA-1 digest computation failed.
548 @retval FALSE This interface is not supported.
553 CryptoServiceSha1HashAll (
559 return CALL_BASECRYPTLIB (Sha1
.Services
.HashAll
, Sha1HashAll
, (Data
, DataSize
, HashValue
), FALSE
);
563 Retrieves the size, in bytes, of the context buffer required for SHA-256 hash operations.
565 @return The size, in bytes, of the context buffer required for SHA-256 hash operations.
570 CryptoServiceSha256GetContextSize (
574 return CALL_BASECRYPTLIB (Sha256
.Services
.GetContextSize
, Sha256GetContextSize
, (), 0);
578 Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for
581 If Sha256Context is NULL, then return FALSE.
583 @param[out] Sha256Context Pointer to SHA-256 context being initialized.
585 @retval TRUE SHA-256 context initialization succeeded.
586 @retval FALSE SHA-256 context initialization failed.
591 CryptoServiceSha256Init (
592 OUT VOID
*Sha256Context
595 return CALL_BASECRYPTLIB (Sha256
.Services
.Init
, Sha256Init
, (Sha256Context
), FALSE
);
599 Makes a copy of an existing SHA-256 context.
601 If Sha256Context is NULL, then return FALSE.
602 If NewSha256Context is NULL, then return FALSE.
603 If this interface is not supported, then return FALSE.
605 @param[in] Sha256Context Pointer to SHA-256 context being copied.
606 @param[out] NewSha256Context Pointer to new SHA-256 context.
608 @retval TRUE SHA-256 context copy succeeded.
609 @retval FALSE SHA-256 context copy failed.
610 @retval FALSE This interface is not supported.
615 CryptoServiceSha256Duplicate (
616 IN CONST VOID
*Sha256Context
,
617 OUT VOID
*NewSha256Context
620 return CALL_BASECRYPTLIB (Sha256
.Services
.Duplicate
, Sha256Duplicate
, (Sha256Context
, NewSha256Context
), FALSE
);
624 Digests the input data and updates SHA-256 context.
626 This function performs SHA-256 digest on a data buffer of the specified size.
627 It can be called multiple times to compute the digest of long or discontinuous data streams.
628 SHA-256 context should be already correctly initialized by Sha256Init(), and should not be finalized
629 by Sha256Final(). Behavior with invalid context is undefined.
631 If Sha256Context is NULL, then return FALSE.
633 @param[in, out] Sha256Context Pointer to the SHA-256 context.
634 @param[in] Data Pointer to the buffer containing the data to be hashed.
635 @param[in] DataSize Size of Data buffer in bytes.
637 @retval TRUE SHA-256 data digest succeeded.
638 @retval FALSE SHA-256 data digest failed.
643 CryptoServiceSha256Update (
644 IN OUT VOID
*Sha256Context
,
649 return CALL_BASECRYPTLIB (Sha256
.Services
.Update
, Sha256Update
, (Sha256Context
, Data
, DataSize
), FALSE
);
653 Completes computation of the SHA-256 digest value.
655 This function completes SHA-256 hash computation and retrieves the digest value into
656 the specified memory. After this function has been called, the SHA-256 context cannot
658 SHA-256 context should be already correctly initialized by Sha256Init(), and should not be
659 finalized by Sha256Final(). Behavior with invalid SHA-256 context is undefined.
661 If Sha256Context is NULL, then return FALSE.
662 If HashValue is NULL, then return FALSE.
664 @param[in, out] Sha256Context Pointer to the SHA-256 context.
665 @param[out] HashValue Pointer to a buffer that receives the SHA-256 digest
668 @retval TRUE SHA-256 digest computation succeeded.
669 @retval FALSE SHA-256 digest computation failed.
674 CryptoServiceSha256Final (
675 IN OUT VOID
*Sha256Context
,
679 return CALL_BASECRYPTLIB (Sha256
.Services
.Final
, Sha256Final
, (Sha256Context
, HashValue
), FALSE
);
683 Computes the SHA-256 message digest of a input data buffer.
685 This function performs the SHA-256 message digest of a given data buffer, and places
686 the digest value into the specified memory.
688 If this interface is not supported, then return FALSE.
690 @param[in] Data Pointer to the buffer containing the data to be hashed.
691 @param[in] DataSize Size of Data buffer in bytes.
692 @param[out] HashValue Pointer to a buffer that receives the SHA-256 digest
695 @retval TRUE SHA-256 digest computation succeeded.
696 @retval FALSE SHA-256 digest computation failed.
697 @retval FALSE This interface is not supported.
702 CryptoServiceSha256HashAll (
708 return CALL_BASECRYPTLIB (Sha256
.Services
.HashAll
, Sha256HashAll
, (Data
, DataSize
, HashValue
), FALSE
);
712 Retrieves the size, in bytes, of the context buffer required for SHA-384 hash operations.
714 @return The size, in bytes, of the context buffer required for SHA-384 hash operations.
719 CryptoServiceSha384GetContextSize (
723 return CALL_BASECRYPTLIB (Sha384
.Services
.GetContextSize
, Sha384GetContextSize
, (), 0);
727 Initializes user-supplied memory pointed by Sha384Context as SHA-384 hash context for
730 If Sha384Context is NULL, then return FALSE.
732 @param[out] Sha384Context Pointer to SHA-384 context being initialized.
734 @retval TRUE SHA-384 context initialization succeeded.
735 @retval FALSE SHA-384 context initialization failed.
740 CryptoServiceSha384Init (
741 OUT VOID
*Sha384Context
744 return CALL_BASECRYPTLIB (Sha384
.Services
.Init
, Sha384Init
, (Sha384Context
), FALSE
);
748 Makes a copy of an existing SHA-384 context.
750 If Sha384Context is NULL, then return FALSE.
751 If NewSha384Context is NULL, then return FALSE.
752 If this interface is not supported, then return FALSE.
754 @param[in] Sha384Context Pointer to SHA-384 context being copied.
755 @param[out] NewSha384Context Pointer to new SHA-384 context.
757 @retval TRUE SHA-384 context copy succeeded.
758 @retval FALSE SHA-384 context copy failed.
759 @retval FALSE This interface is not supported.
764 CryptoServiceSha384Duplicate (
765 IN CONST VOID
*Sha384Context
,
766 OUT VOID
*NewSha384Context
769 return CALL_BASECRYPTLIB (Sha384
.Services
.Duplicate
, Sha384Duplicate
, (Sha384Context
, NewSha384Context
), FALSE
);
773 Digests the input data and updates SHA-384 context.
775 This function performs SHA-384 digest on a data buffer of the specified size.
776 It can be called multiple times to compute the digest of long or discontinuous data streams.
777 SHA-384 context should be already correctly initialized by Sha384Init(), and should not be finalized
778 by Sha384Final(). Behavior with invalid context is undefined.
780 If Sha384Context is NULL, then return FALSE.
782 @param[in, out] Sha384Context Pointer to the SHA-384 context.
783 @param[in] Data Pointer to the buffer containing the data to be hashed.
784 @param[in] DataSize Size of Data buffer in bytes.
786 @retval TRUE SHA-384 data digest succeeded.
787 @retval FALSE SHA-384 data digest failed.
792 CryptoServiceSha384Update (
793 IN OUT VOID
*Sha384Context
,
798 return CALL_BASECRYPTLIB (Sha384
.Services
.Update
, Sha384Update
, (Sha384Context
, Data
, DataSize
), FALSE
);
802 Completes computation of the SHA-384 digest value.
804 This function completes SHA-384 hash computation and retrieves the digest value into
805 the specified memory. After this function has been called, the SHA-384 context cannot
807 SHA-384 context should be already correctly initialized by Sha384Init(), and should not be
808 finalized by Sha384Final(). Behavior with invalid SHA-384 context is undefined.
810 If Sha384Context is NULL, then return FALSE.
811 If HashValue is NULL, then return FALSE.
813 @param[in, out] Sha384Context Pointer to the SHA-384 context.
814 @param[out] HashValue Pointer to a buffer that receives the SHA-384 digest
817 @retval TRUE SHA-384 digest computation succeeded.
818 @retval FALSE SHA-384 digest computation failed.
823 CryptoServiceSha384Final (
824 IN OUT VOID
*Sha384Context
,
828 return CALL_BASECRYPTLIB (Sha384
.Services
.Final
, Sha384Final
, (Sha384Context
, HashValue
), FALSE
);
832 Computes the SHA-384 message digest of a input data buffer.
834 This function performs the SHA-384 message digest of a given data buffer, and places
835 the digest value into the specified memory.
837 If this interface is not supported, then return FALSE.
839 @param[in] Data Pointer to the buffer containing the data to be hashed.
840 @param[in] DataSize Size of Data buffer in bytes.
841 @param[out] HashValue Pointer to a buffer that receives the SHA-384 digest
844 @retval TRUE SHA-384 digest computation succeeded.
845 @retval FALSE SHA-384 digest computation failed.
846 @retval FALSE This interface is not supported.
851 CryptoServiceSha384HashAll (
857 return CALL_BASECRYPTLIB (Sha384
.Services
.HashAll
, Sha384HashAll
, (Data
, DataSize
, HashValue
), FALSE
);
861 Retrieves the size, in bytes, of the context buffer required for SHA-512 hash operations.
863 @return The size, in bytes, of the context buffer required for SHA-512 hash operations.
868 CryptoServiceSha512GetContextSize (
872 return CALL_BASECRYPTLIB (Sha512
.Services
.GetContextSize
, Sha512GetContextSize
, (), 0);
876 Initializes user-supplied memory pointed by Sha512Context as SHA-512 hash context for
879 If Sha512Context is NULL, then return FALSE.
881 @param[out] Sha512Context Pointer to SHA-512 context being initialized.
883 @retval TRUE SHA-512 context initialization succeeded.
884 @retval FALSE SHA-512 context initialization failed.
889 CryptoServiceSha512Init (
890 OUT VOID
*Sha512Context
893 return CALL_BASECRYPTLIB (Sha512
.Services
.Init
, Sha512Init
, (Sha512Context
), FALSE
);
897 Makes a copy of an existing SHA-512 context.
899 If Sha512Context is NULL, then return FALSE.
900 If NewSha512Context is NULL, then return FALSE.
901 If this interface is not supported, then return FALSE.
903 @param[in] Sha512Context Pointer to SHA-512 context being copied.
904 @param[out] NewSha512Context Pointer to new SHA-512 context.
906 @retval TRUE SHA-512 context copy succeeded.
907 @retval FALSE SHA-512 context copy failed.
908 @retval FALSE This interface is not supported.
913 CryptoServiceSha512Duplicate (
914 IN CONST VOID
*Sha512Context
,
915 OUT VOID
*NewSha512Context
918 return CALL_BASECRYPTLIB (Sha512
.Services
.Duplicate
, Sha512Duplicate
, (Sha512Context
, NewSha512Context
), FALSE
);
922 Digests the input data and updates SHA-512 context.
924 This function performs SHA-512 digest on a data buffer of the specified size.
925 It can be called multiple times to compute the digest of long or discontinuous data streams.
926 SHA-512 context should be already correctly initialized by Sha512Init(), and should not be finalized
927 by Sha512Final(). Behavior with invalid context is undefined.
929 If Sha512Context is NULL, then return FALSE.
931 @param[in, out] Sha512Context Pointer to the SHA-512 context.
932 @param[in] Data Pointer to the buffer containing the data to be hashed.
933 @param[in] DataSize Size of Data buffer in bytes.
935 @retval TRUE SHA-512 data digest succeeded.
936 @retval FALSE SHA-512 data digest failed.
941 CryptoServiceSha512Update (
942 IN OUT VOID
*Sha512Context
,
947 return CALL_BASECRYPTLIB (Sha512
.Services
.Update
, Sha512Update
, (Sha512Context
, Data
, DataSize
), FALSE
);
951 Completes computation of the SHA-512 digest value.
953 This function completes SHA-512 hash computation and retrieves the digest value into
954 the specified memory. After this function has been called, the SHA-512 context cannot
956 SHA-512 context should be already correctly initialized by Sha512Init(), and should not be
957 finalized by Sha512Final(). Behavior with invalid SHA-512 context is undefined.
959 If Sha512Context is NULL, then return FALSE.
960 If HashValue is NULL, then return FALSE.
962 @param[in, out] Sha512Context Pointer to the SHA-512 context.
963 @param[out] HashValue Pointer to a buffer that receives the SHA-512 digest
966 @retval TRUE SHA-512 digest computation succeeded.
967 @retval FALSE SHA-512 digest computation failed.
972 CryptoServiceSha512Final (
973 IN OUT VOID
*Sha512Context
,
977 return CALL_BASECRYPTLIB (Sha512
.Services
.Final
, Sha512Final
, (Sha512Context
, HashValue
), FALSE
);
981 Computes the SHA-512 message digest of a input data buffer.
983 This function performs the SHA-512 message digest of a given data buffer, and places
984 the digest value into the specified memory.
986 If this interface is not supported, then return FALSE.
988 @param[in] Data Pointer to the buffer containing the data to be hashed.
989 @param[in] DataSize Size of Data buffer in bytes.
990 @param[out] HashValue Pointer to a buffer that receives the SHA-512 digest
993 @retval TRUE SHA-512 digest computation succeeded.
994 @retval FALSE SHA-512 digest computation failed.
995 @retval FALSE This interface is not supported.
1000 CryptoServiceSha512HashAll (
1001 IN CONST VOID
*Data
,
1003 OUT UINT8
*HashValue
1006 return CALL_BASECRYPTLIB (Sha512
.Services
.HashAll
, Sha512HashAll
, (Data
, DataSize
, HashValue
), FALSE
);
1010 Retrieves the size, in bytes, of the context buffer required for SM3 hash operations.
1012 @return The size, in bytes, of the context buffer required for SM3 hash operations.
1017 CryptoServiceSm3GetContextSize (
1021 return CALL_BASECRYPTLIB (Sm3
.Services
.GetContextSize
, Sm3GetContextSize
, (), 0);
1025 Initializes user-supplied memory pointed by Sm3Context as SM3 hash context for
1028 If Sm3Context is NULL, then return FALSE.
1030 @param[out] Sm3Context Pointer to SM3 context being initialized.
1032 @retval TRUE SM3 context initialization succeeded.
1033 @retval FALSE SM3 context initialization failed.
1038 CryptoServiceSm3Init (
1039 OUT VOID
*Sm3Context
1042 return CALL_BASECRYPTLIB (Sm3
.Services
.Init
, Sm3Init
, (Sm3Context
), FALSE
);
1046 Makes a copy of an existing SM3 context.
1048 If Sm3Context is NULL, then return FALSE.
1049 If NewSm3Context is NULL, then return FALSE.
1050 If this interface is not supported, then return FALSE.
1052 @param[in] Sm3Context Pointer to SM3 context being copied.
1053 @param[out] NewSm3Context Pointer to new SM3 context.
1055 @retval TRUE SM3 context copy succeeded.
1056 @retval FALSE SM3 context copy failed.
1057 @retval FALSE This interface is not supported.
1062 CryptoServiceSm3Duplicate (
1063 IN CONST VOID
*Sm3Context
,
1064 OUT VOID
*NewSm3Context
1067 return CALL_BASECRYPTLIB (Sm3
.Services
.Duplicate
, Sm3Duplicate
, (Sm3Context
, NewSm3Context
), FALSE
);
1071 Digests the input data and updates SM3 context.
1073 This function performs SM3 digest on a data buffer of the specified size.
1074 It can be called multiple times to compute the digest of long or discontinuous data streams.
1075 SM3 context should be already correctly initialized by Sm3Init(), and should not be finalized
1076 by Sm3Final(). Behavior with invalid context is undefined.
1078 If Sm3Context is NULL, then return FALSE.
1080 @param[in, out] Sm3Context Pointer to the SM3 context.
1081 @param[in] Data Pointer to the buffer containing the data to be hashed.
1082 @param[in] DataSize Size of Data buffer in bytes.
1084 @retval TRUE SM3 data digest succeeded.
1085 @retval FALSE SM3 data digest failed.
1090 CryptoServiceSm3Update (
1091 IN OUT VOID
*Sm3Context
,
1092 IN CONST VOID
*Data
,
1096 return CALL_BASECRYPTLIB (Sm3
.Services
.Update
, Sm3Update
, (Sm3Context
, Data
, DataSize
), FALSE
);
1100 Completes computation of the SM3 digest value.
1102 This function completes SM3 hash computation and retrieves the digest value into
1103 the specified memory. After this function has been called, the SM3 context cannot
1105 SM3 context should be already correctly initialized by Sm3Init(), and should not be
1106 finalized by Sm3Final(). Behavior with invalid SM3 context is undefined.
1108 If Sm3Context is NULL, then return FALSE.
1109 If HashValue is NULL, then return FALSE.
1111 @param[in, out] Sm3Context Pointer to the SM3 context.
1112 @param[out] HashValue Pointer to a buffer that receives the SM3 digest
1115 @retval TRUE SM3 digest computation succeeded.
1116 @retval FALSE SM3 digest computation failed.
1121 CryptoServiceSm3Final (
1122 IN OUT VOID
*Sm3Context
,
1123 OUT UINT8
*HashValue
1126 return CALL_BASECRYPTLIB (Sm3
.Services
.Final
, Sm3Final
, (Sm3Context
, HashValue
), FALSE
);
1130 Computes the SM3 message digest of a input data buffer.
1132 This function performs the SM3 message digest of a given data buffer, and places
1133 the digest value into the specified memory.
1135 If this interface is not supported, then return FALSE.
1137 @param[in] Data Pointer to the buffer containing the data to be hashed.
1138 @param[in] DataSize Size of Data buffer in bytes.
1139 @param[out] HashValue Pointer to a buffer that receives the SM3 digest
1142 @retval TRUE SM3 digest computation succeeded.
1143 @retval FALSE SM3 digest computation failed.
1144 @retval FALSE This interface is not supported.
1149 CryptoServiceSm3HashAll (
1150 IN CONST VOID
*Data
,
1152 OUT UINT8
*HashValue
1155 return CALL_BASECRYPTLIB (Sm3
.Services
.HashAll
, Sm3HashAll
, (Data
, DataSize
, HashValue
), FALSE
);
1158 //=====================================================================================
1159 // MAC (Message Authentication Code) Primitive
1160 //=====================================================================================
1163 HMAC MD5 is deprecated and unsupported any longer.
1164 Keep the function field for binary compability.
1166 @retval NULL This interface is not supported.
1171 DeprecatedCryptoServiceHmacMd5New (
1175 return BaseCryptLibServiceDeprecated ("HmacMd5New"), NULL
;
1179 HMAC MD5 is deprecated and unsupported any longer.
1180 Keep the function field for binary compability.
1182 @param[in] HmacMd5Ctx Pointer to the HMAC_CTX context to be released.
1187 DeprecatedCryptoServiceHmacMd5Free (
1191 BaseCryptLibServiceDeprecated ("HmacMd5Free");
1195 HMAC MD5 is deprecated and unsupported any longer.
1196 Keep the function field for binary compability.
1198 @param[out] HmacMd5Context Pointer to HMAC-MD5 context.
1199 @param[in] Key Pointer to the user-supplied key.
1200 @param[in] KeySize Key size in bytes.
1202 @retval FALSE This interface is not supported.
1207 DeprecatedCryptoServiceHmacMd5SetKey (
1208 OUT VOID
*HmacMd5Context
,
1209 IN CONST UINT8
*Key
,
1213 return BaseCryptLibServiceDeprecated ("HmacMd5SetKey"), FALSE
;
1217 HMAC MD5 is deprecated and unsupported any longer.
1218 Keep the function field for binary compability.
1220 @param[in] HmacMd5Context Pointer to HMAC-MD5 context being copied.
1221 @param[out] NewHmacMd5Context Pointer to new HMAC-MD5 context.
1223 @retval FALSE This interface is not supported.
1228 DeprecatedCryptoServiceHmacMd5Duplicate (
1229 IN CONST VOID
*HmacMd5Context
,
1230 OUT VOID
*NewHmacMd5Context
1233 return BaseCryptLibServiceDeprecated ("HmacMd5Duplicate"), FALSE
;
1237 HMAC MD5 is deprecated and unsupported any longer.
1238 Keep the function field for binary compability.
1240 @param[in, out] HmacMd5Context Pointer to the HMAC-MD5 context.
1241 @param[in] Data Pointer to the buffer containing the data to be digested.
1242 @param[in] DataSize Size of Data buffer in bytes.
1244 @retval FALSE This interface is not supported.
1249 DeprecatedCryptoServiceHmacMd5Update (
1250 IN OUT VOID
*HmacMd5Context
,
1251 IN CONST VOID
*Data
,
1255 return BaseCryptLibServiceDeprecated ("HmacMd5Update"), FALSE
;
1259 HMAC MD5 is deprecated and unsupported any longer.
1260 Keep the function field for binary compability.
1262 @param[in, out] HmacMd5Context Pointer to the HMAC-MD5 context.
1263 @param[out] HmacValue Pointer to a buffer that receives the HMAC-MD5 digest
1266 @retval FALSE This interface is not supported.
1271 DeprecatedCryptoServiceHmacMd5Final (
1272 IN OUT VOID
*HmacMd5Context
,
1273 OUT UINT8
*HmacValue
1276 return BaseCryptLibServiceDeprecated ("HmacMd5Final"), FALSE
;
1280 HMAC SHA1 is deprecated and unsupported any longer.
1281 Keep the function field for binary compability.
1283 @return NULL This interface is not supported.
1288 DeprecatedCryptoServiceHmacSha1New (
1292 return BaseCryptLibServiceDeprecated ("HmacSha1New"), NULL
;
1296 HMAC SHA1 is deprecated and unsupported any longer.
1297 Keep the function field for binary compability.
1299 @param[in] HmacSha1Ctx Pointer to the HMAC_CTX context to be released.
1304 DeprecatedCryptoServiceHmacSha1Free (
1305 IN VOID
*HmacSha1Ctx
1308 BaseCryptLibServiceDeprecated ("HmacSha1Free");
1312 HMAC SHA1 is deprecated and unsupported any longer.
1313 Keep the function field for binary compability.
1315 @param[out] HmacSha1Context Pointer to HMAC-SHA1 context.
1316 @param[in] Key Pointer to the user-supplied key.
1317 @param[in] KeySize Key size in bytes.
1319 @retval FALSE This interface is not supported.
1324 DeprecatedCryptoServiceHmacSha1SetKey (
1325 OUT VOID
*HmacSha1Context
,
1326 IN CONST UINT8
*Key
,
1330 return BaseCryptLibServiceDeprecated ("HmacSha1SetKey"), FALSE
;
1334 HMAC SHA1 is deprecated and unsupported any longer.
1335 Keep the function field for binary compability.
1337 @param[in] HmacSha1Context Pointer to HMAC-SHA1 context being copied.
1338 @param[out] NewHmacSha1Context Pointer to new HMAC-SHA1 context.
1340 @retval FALSE This interface is not supported.
1345 DeprecatedCryptoServiceHmacSha1Duplicate (
1346 IN CONST VOID
*HmacSha1Context
,
1347 OUT VOID
*NewHmacSha1Context
1350 return BaseCryptLibServiceDeprecated ("HmacSha1Duplicate"), FALSE
;
1354 HMAC SHA1 is deprecated and unsupported any longer.
1355 Keep the function field for binary compability.
1357 @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
1358 @param[in] Data Pointer to the buffer containing the data to be digested.
1359 @param[in] DataSize Size of Data buffer in bytes.
1361 @retval FALSE This interface is not supported.
1366 DeprecatedCryptoServiceHmacSha1Update (
1367 IN OUT VOID
*HmacSha1Context
,
1368 IN CONST VOID
*Data
,
1372 return BaseCryptLibServiceDeprecated ("HmacSha1Update"), FALSE
;
1376 HMAC SHA1 is deprecated and unsupported any longer.
1377 Keep the function field for binary compability.
1379 @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
1380 @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA1 digest
1383 @retval FALSE This interface is not supported.
1388 DeprecatedCryptoServiceHmacSha1Final (
1389 IN OUT VOID
*HmacSha1Context
,
1390 OUT UINT8
*HmacValue
1393 return BaseCryptLibServiceDeprecated ("HmacSha1Final"), FALSE
;
1397 Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.
1399 @return Pointer to the HMAC_CTX context that has been initialized.
1400 If the allocations fails, HmacSha256New() returns NULL.
1405 CryptoServiceHmacSha256New (
1409 return CALL_BASECRYPTLIB (HmacSha256
.Services
.New
, HmacSha256New
, (), NULL
);
1413 Release the specified HMAC_CTX context.
1415 @param[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.
1420 CryptoServiceHmacSha256Free (
1421 IN VOID
*HmacSha256Ctx
1424 CALL_VOID_BASECRYPTLIB (HmacSha256
.Services
.Free
, HmacSha256Free
, (HmacSha256Ctx
));
1428 Set user-supplied key for subsequent use. It must be done before any
1429 calling to HmacSha256Update().
1431 If HmacSha256Context is NULL, then return FALSE.
1432 If this interface is not supported, then return FALSE.
1434 @param[out] HmacSha256Context Pointer to HMAC-SHA256 context.
1435 @param[in] Key Pointer to the user-supplied key.
1436 @param[in] KeySize Key size in bytes.
1438 @retval TRUE The Key is set successfully.
1439 @retval FALSE The Key is set unsuccessfully.
1440 @retval FALSE This interface is not supported.
1445 CryptoServiceHmacSha256SetKey (
1446 OUT VOID
*HmacSha256Context
,
1447 IN CONST UINT8
*Key
,
1451 return CALL_BASECRYPTLIB (HmacSha256
.Services
.SetKey
, HmacSha256SetKey
, (HmacSha256Context
, Key
, KeySize
), FALSE
);
1455 Makes a copy of an existing HMAC-SHA256 context.
1457 If HmacSha256Context is NULL, then return FALSE.
1458 If NewHmacSha256Context is NULL, then return FALSE.
1459 If this interface is not supported, then return FALSE.
1461 @param[in] HmacSha256Context Pointer to HMAC-SHA256 context being copied.
1462 @param[out] NewHmacSha256Context Pointer to new HMAC-SHA256 context.
1464 @retval TRUE HMAC-SHA256 context copy succeeded.
1465 @retval FALSE HMAC-SHA256 context copy failed.
1466 @retval FALSE This interface is not supported.
1471 CryptoServiceHmacSha256Duplicate (
1472 IN CONST VOID
*HmacSha256Context
,
1473 OUT VOID
*NewHmacSha256Context
1476 return CALL_BASECRYPTLIB (HmacSha256
.Services
.Duplicate
, HmacSha256Duplicate
, (HmacSha256Context
, NewHmacSha256Context
), FALSE
);
1480 Digests the input data and updates HMAC-SHA256 context.
1482 This function performs HMAC-SHA256 digest on a data buffer of the specified size.
1483 It can be called multiple times to compute the digest of long or discontinuous data streams.
1484 HMAC-SHA256 context should be initialized by HmacSha256New(), and should not be finalized
1485 by HmacSha256Final(). Behavior with invalid context is undefined.
1487 If HmacSha256Context is NULL, then return FALSE.
1488 If this interface is not supported, then return FALSE.
1490 @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
1491 @param[in] Data Pointer to the buffer containing the data to be digested.
1492 @param[in] DataSize Size of Data buffer in bytes.
1494 @retval TRUE HMAC-SHA256 data digest succeeded.
1495 @retval FALSE HMAC-SHA256 data digest failed.
1496 @retval FALSE This interface is not supported.
1501 CryptoServiceHmacSha256Update (
1502 IN OUT VOID
*HmacSha256Context
,
1503 IN CONST VOID
*Data
,
1507 return CALL_BASECRYPTLIB (HmacSha256
.Services
.Update
, HmacSha256Update
, (HmacSha256Context
, Data
, DataSize
), FALSE
);
1511 Completes computation of the HMAC-SHA256 digest value.
1513 This function completes HMAC-SHA256 hash computation and retrieves the digest value into
1514 the specified memory. After this function has been called, the HMAC-SHA256 context cannot
1516 HMAC-SHA256 context should be initialized by HmacSha256New(), and should not be finalized
1517 by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.
1519 If HmacSha256Context is NULL, then return FALSE.
1520 If HmacValue is NULL, then return FALSE.
1521 If this interface is not supported, then return FALSE.
1523 @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
1524 @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest
1527 @retval TRUE HMAC-SHA256 digest computation succeeded.
1528 @retval FALSE HMAC-SHA256 digest computation failed.
1529 @retval FALSE This interface is not supported.
1534 CryptoServiceHmacSha256Final (
1535 IN OUT VOID
*HmacSha256Context
,
1536 OUT UINT8
*HmacValue
1539 return CALL_BASECRYPTLIB (HmacSha256
.Services
.Final
, HmacSha256Final
, (HmacSha256Context
, HmacValue
), FALSE
);
1542 //=====================================================================================
1543 // Symmetric Cryptography Primitive
1544 //=====================================================================================
1547 TDES is deprecated and unsupported any longer.
1548 Keep the function field for binary compability.
1550 @retval 0 This interface is not supported.
1555 DeprecatedCryptoServiceTdesGetContextSize (
1559 return BaseCryptLibServiceDeprecated ("TdesGetContextSize"), 0;
1563 TDES is deprecated and unsupported any longer.
1564 Keep the function field for binary compability.
1566 @param[out] TdesContext Pointer to TDES context being initialized.
1567 @param[in] Key Pointer to the user-supplied TDES key.
1568 @param[in] KeyLength Length of TDES key in bits.
1570 @retval FALSE This interface is not supported.
1575 DeprecatedCryptoServiceTdesInit (
1576 OUT VOID
*TdesContext
,
1577 IN CONST UINT8
*Key
,
1581 return BaseCryptLibServiceDeprecated ("TdesInit"), FALSE
;
1585 TDES is deprecated and unsupported any longer.
1586 Keep the function field for binary compability.
1588 @param[in] TdesContext Pointer to the TDES context.
1589 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1590 @param[in] InputSize Size of the Input buffer in bytes.
1591 @param[out] Output Pointer to a buffer that receives the TDES encryption output.
1593 @retval FALSE This interface is not supported.
1598 DeprecatedCryptoServiceTdesEcbEncrypt (
1599 IN VOID
*TdesContext
,
1600 IN CONST UINT8
*Input
,
1605 return BaseCryptLibServiceDeprecated ("TdesEcbEncrypt"), FALSE
;
1609 TDES is deprecated and unsupported any longer.
1610 Keep the function field for binary compability.
1612 @param[in] TdesContext Pointer to the TDES context.
1613 @param[in] Input Pointer to the buffer containing the data to be decrypted.
1614 @param[in] InputSize Size of the Input buffer in bytes.
1615 @param[out] Output Pointer to a buffer that receives the TDES decryption output.
1617 @retval FALSE This interface is not supported.
1622 DeprecatedCryptoServiceTdesEcbDecrypt (
1623 IN VOID
*TdesContext
,
1624 IN CONST UINT8
*Input
,
1629 return BaseCryptLibServiceDeprecated ("TdesEcbDecrypt"), FALSE
;
1633 TDES is deprecated and unsupported any longer.
1634 Keep the function field for binary compability.
1636 @param[in] TdesContext Pointer to the TDES context.
1637 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1638 @param[in] InputSize Size of the Input buffer in bytes.
1639 @param[in] Ivec Pointer to initialization vector.
1640 @param[out] Output Pointer to a buffer that receives the TDES encryption output.
1642 @retval FALSE This interface is not supported.
1647 DeprecatedCryptoServiceTdesCbcEncrypt (
1648 IN VOID
*TdesContext
,
1649 IN CONST UINT8
*Input
,
1651 IN CONST UINT8
*Ivec
,
1655 return BaseCryptLibServiceDeprecated ("TdesCbcEncrypt"), FALSE
;
1659 TDES is deprecated and unsupported any longer.
1660 Keep the function field for binary compability.
1662 @param[in] TdesContext Pointer to the TDES context.
1663 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1664 @param[in] InputSize Size of the Input buffer in bytes.
1665 @param[in] Ivec Pointer to initialization vector.
1666 @param[out] Output Pointer to a buffer that receives the TDES encryption output.
1668 @retval FALSE This interface is not supported.
1673 DeprecatedCryptoServiceTdesCbcDecrypt (
1674 IN VOID
*TdesContext
,
1675 IN CONST UINT8
*Input
,
1677 IN CONST UINT8
*Ivec
,
1681 return BaseCryptLibServiceDeprecated ("TdesCbcDecrypt"), FALSE
;
1685 Retrieves the size, in bytes, of the context buffer required for AES operations.
1687 If this interface is not supported, then return zero.
1689 @return The size, in bytes, of the context buffer required for AES operations.
1690 @retval 0 This interface is not supported.
1695 CryptoServiceAesGetContextSize (
1699 return CALL_BASECRYPTLIB (Aes
.Services
.GetContextSize
, AesGetContextSize
, (), 0);
1703 Initializes user-supplied memory as AES context for subsequent use.
1705 This function initializes user-supplied memory pointed by AesContext as AES context.
1706 In addition, it sets up all AES key materials for subsequent encryption and decryption
1708 There are 3 options for key length, 128 bits, 192 bits, and 256 bits.
1710 If AesContext is NULL, then return FALSE.
1711 If Key is NULL, then return FALSE.
1712 If KeyLength is not valid, then return FALSE.
1713 If this interface is not supported, then return FALSE.
1715 @param[out] AesContext Pointer to AES context being initialized.
1716 @param[in] Key Pointer to the user-supplied AES key.
1717 @param[in] KeyLength Length of AES key in bits.
1719 @retval TRUE AES context initialization succeeded.
1720 @retval FALSE AES context initialization failed.
1721 @retval FALSE This interface is not supported.
1726 CryptoServiceAesInit (
1727 OUT VOID
*AesContext
,
1728 IN CONST UINT8
*Key
,
1732 return CALL_BASECRYPTLIB (Aes
.Services
.Init
, AesInit
, (AesContext
, Key
, KeyLength
), FALSE
);
1736 AES ECB Mode is deprecated and unsupported any longer.
1737 Keep the function field for binary compability.
1739 @param[in] AesContext Pointer to the AES context.
1740 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1741 @param[in] InputSize Size of the Input buffer in bytes.
1742 @param[out] Output Pointer to a buffer that receives the AES encryption output.
1744 @retval FALSE This interface is not supported.
1749 DeprecatedCryptoServiceAesEcbEncrypt (
1750 IN VOID
*AesContext
,
1751 IN CONST UINT8
*Input
,
1756 return BaseCryptLibServiceDeprecated ("AesEcbEncrypt"), FALSE
;
1760 AES ECB Mode is deprecated and unsupported any longer.
1761 Keep the function field for binary compability.
1763 @param[in] AesContext Pointer to the AES context.
1764 @param[in] Input Pointer to the buffer containing the data to be decrypted.
1765 @param[in] InputSize Size of the Input buffer in bytes.
1766 @param[out] Output Pointer to a buffer that receives the AES decryption output.
1768 @retval FALSE This interface is not supported.
1773 DeprecatedCryptoServiceAesEcbDecrypt (
1774 IN VOID
*AesContext
,
1775 IN CONST UINT8
*Input
,
1780 return BaseCryptLibServiceDeprecated ("AesEcbDecrypt"), FALSE
;
1784 Performs AES encryption on a data buffer of the specified size in CBC mode.
1786 This function performs AES encryption on data buffer pointed by Input, of specified
1787 size of InputSize, in CBC mode.
1788 InputSize must be multiple of block size (16 bytes). This function does not perform
1789 padding. Caller must perform padding, if necessary, to ensure valid input data size.
1790 Initialization vector should be one block size (16 bytes).
1791 AesContext should be already correctly initialized by AesInit(). Behavior with
1792 invalid AES context is undefined.
1794 If AesContext is NULL, then return FALSE.
1795 If Input is NULL, then return FALSE.
1796 If InputSize is not multiple of block size (16 bytes), then return FALSE.
1797 If Ivec is NULL, then return FALSE.
1798 If Output is NULL, then return FALSE.
1799 If this interface is not supported, then return FALSE.
1801 @param[in] AesContext Pointer to the AES context.
1802 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1803 @param[in] InputSize Size of the Input buffer in bytes.
1804 @param[in] Ivec Pointer to initialization vector.
1805 @param[out] Output Pointer to a buffer that receives the AES encryption output.
1807 @retval TRUE AES encryption succeeded.
1808 @retval FALSE AES encryption failed.
1809 @retval FALSE This interface is not supported.
1814 CryptoServiceAesCbcEncrypt (
1815 IN VOID
*AesContext
,
1816 IN CONST UINT8
*Input
,
1818 IN CONST UINT8
*Ivec
,
1822 return CALL_BASECRYPTLIB (Aes
.Services
.CbcEncrypt
, AesCbcEncrypt
, (AesContext
, Input
, InputSize
, Ivec
, Output
), FALSE
);
1826 Performs AES decryption on a data buffer of the specified size in CBC mode.
1828 This function performs AES decryption on data buffer pointed by Input, of specified
1829 size of InputSize, in CBC mode.
1830 InputSize must be multiple of block size (16 bytes). This function does not perform
1831 padding. Caller must perform padding, if necessary, to ensure valid input data size.
1832 Initialization vector should be one block size (16 bytes).
1833 AesContext should be already correctly initialized by AesInit(). Behavior with
1834 invalid AES context is undefined.
1836 If AesContext is NULL, then return FALSE.
1837 If Input is NULL, then return FALSE.
1838 If InputSize is not multiple of block size (16 bytes), then return FALSE.
1839 If Ivec is NULL, then return FALSE.
1840 If Output is NULL, then return FALSE.
1841 If this interface is not supported, then return FALSE.
1843 @param[in] AesContext Pointer to the AES context.
1844 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1845 @param[in] InputSize Size of the Input buffer in bytes.
1846 @param[in] Ivec Pointer to initialization vector.
1847 @param[out] Output Pointer to a buffer that receives the AES encryption output.
1849 @retval TRUE AES decryption succeeded.
1850 @retval FALSE AES decryption failed.
1851 @retval FALSE This interface is not supported.
1856 CryptoServiceAesCbcDecrypt (
1857 IN VOID
*AesContext
,
1858 IN CONST UINT8
*Input
,
1860 IN CONST UINT8
*Ivec
,
1864 return CALL_BASECRYPTLIB (Aes
.Services
.CbcDecrypt
, AesCbcDecrypt
, (AesContext
, Input
, InputSize
, Ivec
, Output
), FALSE
);
1868 ARC4 is deprecated and unsupported any longer.
1869 Keep the function field for binary compability.
1871 @retval 0 This interface is not supported.
1876 DeprecatedCryptoServiceArc4GetContextSize (
1880 return BaseCryptLibServiceDeprecated ("Arc4GetContextSize"), 0;
1884 ARC4 is deprecated and unsupported any longer.
1885 Keep the function field for binary compability.
1887 @param[out] Arc4Context Pointer to ARC4 context being initialized.
1888 @param[in] Key Pointer to the user-supplied ARC4 key.
1889 @param[in] KeySize Size of ARC4 key in bytes.
1891 @retval FALSE This interface is not supported.
1896 DeprecatedCryptoServiceArc4Init (
1897 OUT VOID
*Arc4Context
,
1898 IN CONST UINT8
*Key
,
1902 return BaseCryptLibServiceDeprecated ("Arc4Init"), FALSE
;
1906 ARC4 is deprecated and unsupported any longer.
1907 Keep the function field for binary compability.
1909 @param[in, out] Arc4Context Pointer to the ARC4 context.
1910 @param[in] Input Pointer to the buffer containing the data to be encrypted.
1911 @param[in] InputSize Size of the Input buffer in bytes.
1912 @param[out] Output Pointer to a buffer that receives the ARC4 encryption output.
1914 @retval FALSE This interface is not supported.
1919 DeprecatedCryptoServiceArc4Encrypt (
1920 IN OUT VOID
*Arc4Context
,
1921 IN CONST UINT8
*Input
,
1926 return BaseCryptLibServiceDeprecated ("Arc4Encrypt"), FALSE
;
1930 ARC4 is deprecated and unsupported any longer.
1931 Keep the function field for binary compability.
1933 @param[in, out] Arc4Context Pointer to the ARC4 context.
1934 @param[in] Input Pointer to the buffer containing the data to be decrypted.
1935 @param[in] InputSize Size of the Input buffer in bytes.
1936 @param[out] Output Pointer to a buffer that receives the ARC4 decryption output.
1938 @retval FALSE This interface is not supported.
1943 DeprecatedCryptoServiceArc4Decrypt (
1944 IN OUT VOID
*Arc4Context
,
1950 return BaseCryptLibServiceDeprecated ("Arc4Decrypt"), FALSE
;
1954 ARC4 is deprecated and unsupported any longer.
1955 Keep the function field for binary compability.
1957 @param[in, out] Arc4Context Pointer to the ARC4 context.
1959 @retval FALSE This interface is not supported.
1964 DeprecatedCryptoServiceArc4Reset (
1965 IN OUT VOID
*Arc4Context
1968 return BaseCryptLibServiceDeprecated ("Arc4Reset"), FALSE
;
1971 //=====================================================================================
1972 // Asymmetric Cryptography Primitive
1973 //=====================================================================================
1976 Allocates and initializes one RSA context for subsequent use.
1978 @return Pointer to the RSA context that has been initialized.
1979 If the allocations fails, RsaNew() returns NULL.
1984 CryptoServiceRsaNew (
1988 return CALL_BASECRYPTLIB (Rsa
.Services
.New
, RsaNew
, (), NULL
);
1992 Release the specified RSA context.
1994 If RsaContext is NULL, then return FALSE.
1996 @param[in] RsaContext Pointer to the RSA context to be released.
2001 CryptoServiceRsaFree (
2005 CALL_VOID_BASECRYPTLIB (Rsa
.Services
.Free
, RsaFree
, (RsaContext
));
2009 Sets the tag-designated key component into the established RSA context.
2011 This function sets the tag-designated RSA key component into the established
2012 RSA context from the user-specified non-negative integer (octet string format
2013 represented in RSA PKCS#1).
2014 If BigNumber is NULL, then the specified key component in RSA context is cleared.
2016 If RsaContext is NULL, then return FALSE.
2018 @param[in, out] RsaContext Pointer to RSA context being set.
2019 @param[in] KeyTag Tag of RSA key component being set.
2020 @param[in] BigNumber Pointer to octet integer buffer.
2021 If NULL, then the specified key component in RSA
2023 @param[in] BnSize Size of big number buffer in bytes.
2024 If BigNumber is NULL, then it is ignored.
2026 @retval TRUE RSA key component was set successfully.
2027 @retval FALSE Invalid RSA key component tag.
2032 CryptoServiceRsaSetKey (
2033 IN OUT VOID
*RsaContext
,
2034 IN RSA_KEY_TAG KeyTag
,
2035 IN CONST UINT8
*BigNumber
,
2039 return CALL_BASECRYPTLIB (Rsa
.Services
.SetKey
, RsaSetKey
, (RsaContext
, KeyTag
, BigNumber
, BnSize
), FALSE
);
2043 Gets the tag-designated RSA key component from the established RSA context.
2045 This function retrieves the tag-designated RSA key component from the
2046 established RSA context as a non-negative integer (octet string format
2047 represented in RSA PKCS#1).
2048 If specified key component has not been set or has been cleared, then returned
2050 If the BigNumber buffer is too small to hold the contents of the key, FALSE
2051 is returned and BnSize is set to the required buffer size to obtain the key.
2053 If RsaContext is NULL, then return FALSE.
2054 If BnSize is NULL, then return FALSE.
2055 If BnSize is large enough but BigNumber is NULL, then return FALSE.
2056 If this interface is not supported, then return FALSE.
2058 @param[in, out] RsaContext Pointer to RSA context being set.
2059 @param[in] KeyTag Tag of RSA key component being set.
2060 @param[out] BigNumber Pointer to octet integer buffer.
2061 @param[in, out] BnSize On input, the size of big number buffer in bytes.
2062 On output, the size of data returned in big number buffer in bytes.
2064 @retval TRUE RSA key component was retrieved successfully.
2065 @retval FALSE Invalid RSA key component tag.
2066 @retval FALSE BnSize is too small.
2067 @retval FALSE This interface is not supported.
2072 CryptoServiceRsaGetKey (
2073 IN OUT VOID
*RsaContext
,
2074 IN RSA_KEY_TAG KeyTag
,
2075 OUT UINT8
*BigNumber
,
2076 IN OUT UINTN
*BnSize
2079 return CALL_BASECRYPTLIB (Rsa
.Services
.GetKey
, RsaGetKey
, (RsaContext
, KeyTag
, BigNumber
, BnSize
), FALSE
);
2083 Generates RSA key components.
2085 This function generates RSA key components. It takes RSA public exponent E and
2086 length in bits of RSA modulus N as input, and generates all key components.
2087 If PublicExponent is NULL, the default RSA public exponent (0x10001) will be used.
2089 Before this function can be invoked, pseudorandom number generator must be correctly
2090 initialized by RandomSeed().
2092 If RsaContext is NULL, then return FALSE.
2093 If this interface is not supported, then return FALSE.
2095 @param[in, out] RsaContext Pointer to RSA context being set.
2096 @param[in] ModulusLength Length of RSA modulus N in bits.
2097 @param[in] PublicExponent Pointer to RSA public exponent.
2098 @param[in] PublicExponentSize Size of RSA public exponent buffer in bytes.
2100 @retval TRUE RSA key component was generated successfully.
2101 @retval FALSE Invalid RSA key component tag.
2102 @retval FALSE This interface is not supported.
2107 CryptoServiceRsaGenerateKey (
2108 IN OUT VOID
*RsaContext
,
2109 IN UINTN ModulusLength
,
2110 IN CONST UINT8
*PublicExponent
,
2111 IN UINTN PublicExponentSize
2114 return CALL_BASECRYPTLIB (Rsa
.Services
.GenerateKey
, RsaGenerateKey
, (RsaContext
, ModulusLength
, PublicExponent
, PublicExponentSize
), FALSE
);
2118 Validates key components of RSA context.
2119 NOTE: This function performs integrity checks on all the RSA key material, so
2120 the RSA key structure must contain all the private key data.
2122 This function validates key components of RSA context in following aspects:
2123 - Whether p is a prime
2124 - Whether q is a prime
2126 - Whether d*e = 1 mod lcm(p-1,q-1)
2128 If RsaContext is NULL, then return FALSE.
2129 If this interface is not supported, then return FALSE.
2131 @param[in] RsaContext Pointer to RSA context to check.
2133 @retval TRUE RSA key components are valid.
2134 @retval FALSE RSA key components are not valid.
2135 @retval FALSE This interface is not supported.
2140 CryptoServiceRsaCheckKey (
2144 return CALL_BASECRYPTLIB (Rsa
.Services
.CheckKey
, RsaCheckKey
, (RsaContext
), FALSE
);
2148 Carries out the RSA-SSA signature generation with EMSA-PKCS1-v1_5 encoding scheme.
2150 This function carries out the RSA-SSA signature generation with EMSA-PKCS1-v1_5 encoding scheme defined in
2152 If the Signature buffer is too small to hold the contents of signature, FALSE
2153 is returned and SigSize is set to the required buffer size to obtain the signature.
2155 If RsaContext is NULL, then return FALSE.
2156 If MessageHash is NULL, then return FALSE.
2157 If HashSize is not equal to the size of MD5, SHA-1 or SHA-256 digest, then return FALSE.
2158 If SigSize is large enough but Signature is NULL, then return FALSE.
2159 If this interface is not supported, then return FALSE.
2161 @param[in] RsaContext Pointer to RSA context for signature generation.
2162 @param[in] MessageHash Pointer to octet message hash to be signed.
2163 @param[in] HashSize Size of the message hash in bytes.
2164 @param[out] Signature Pointer to buffer to receive RSA PKCS1-v1_5 signature.
2165 @param[in, out] SigSize On input, the size of Signature buffer in bytes.
2166 On output, the size of data returned in Signature buffer in bytes.
2168 @retval TRUE Signature successfully generated in PKCS1-v1_5.
2169 @retval FALSE Signature generation failed.
2170 @retval FALSE SigSize is too small.
2171 @retval FALSE This interface is not supported.
2176 CryptoServiceRsaPkcs1Sign (
2177 IN VOID
*RsaContext
,
2178 IN CONST UINT8
*MessageHash
,
2180 OUT UINT8
*Signature
,
2181 IN OUT UINTN
*SigSize
2184 return CALL_BASECRYPTLIB (Rsa
.Services
.Pkcs1Sign
, RsaPkcs1Sign
, (RsaContext
, MessageHash
, HashSize
, Signature
, SigSize
), FALSE
);
2188 Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme defined in
2191 If RsaContext is NULL, then return FALSE.
2192 If MessageHash is NULL, then return FALSE.
2193 If Signature is NULL, then return FALSE.
2194 If HashSize is not equal to the size of MD5, SHA-1, SHA-256 digest, then return FALSE.
2196 @param[in] RsaContext Pointer to RSA context for signature verification.
2197 @param[in] MessageHash Pointer to octet message hash to be checked.
2198 @param[in] HashSize Size of the message hash in bytes.
2199 @param[in] Signature Pointer to RSA PKCS1-v1_5 signature to be verified.
2200 @param[in] SigSize Size of signature in bytes.
2202 @retval TRUE Valid signature encoded in PKCS1-v1_5.
2203 @retval FALSE Invalid signature or invalid RSA context.
2208 CryptoServiceRsaPkcs1Verify (
2209 IN VOID
*RsaContext
,
2210 IN CONST UINT8
*MessageHash
,
2212 IN CONST UINT8
*Signature
,
2216 return CALL_BASECRYPTLIB (Rsa
.Services
.Pkcs1Verify
, RsaPkcs1Verify
, (RsaContext
, MessageHash
, HashSize
, Signature
, SigSize
), FALSE
);
2220 Retrieve the RSA Private Key from the password-protected PEM key data.
2222 If PemData is NULL, then return FALSE.
2223 If RsaContext is NULL, then return FALSE.
2224 If this interface is not supported, then return FALSE.
2226 @param[in] PemData Pointer to the PEM-encoded key data to be retrieved.
2227 @param[in] PemSize Size of the PEM key data in bytes.
2228 @param[in] Password NULL-terminated passphrase used for encrypted PEM key data.
2229 @param[out] RsaContext Pointer to new-generated RSA context which contain the retrieved
2230 RSA private key component. Use RsaFree() function to free the
2233 @retval TRUE RSA Private Key was retrieved successfully.
2234 @retval FALSE Invalid PEM key data or incorrect password.
2235 @retval FALSE This interface is not supported.
2240 CryptoServiceRsaGetPrivateKeyFromPem (
2241 IN CONST UINT8
*PemData
,
2243 IN CONST CHAR8
*Password
,
2244 OUT VOID
**RsaContext
2247 return CALL_BASECRYPTLIB (Rsa
.Services
.GetPrivateKeyFromPem
, RsaGetPrivateKeyFromPem
, (PemData
, PemSize
, Password
, RsaContext
), FALSE
);
2251 Retrieve the RSA Public Key from one DER-encoded X509 certificate.
2253 If Cert is NULL, then return FALSE.
2254 If RsaContext is NULL, then return FALSE.
2255 If this interface is not supported, then return FALSE.
2257 @param[in] Cert Pointer to the DER-encoded X509 certificate.
2258 @param[in] CertSize Size of the X509 certificate in bytes.
2259 @param[out] RsaContext Pointer to new-generated RSA context which contain the retrieved
2260 RSA public key component. Use RsaFree() function to free the
2263 @retval TRUE RSA Public Key was retrieved successfully.
2264 @retval FALSE Fail to retrieve RSA public key from X509 certificate.
2265 @retval FALSE This interface is not supported.
2270 CryptoServiceRsaGetPublicKeyFromX509 (
2271 IN CONST UINT8
*Cert
,
2273 OUT VOID
**RsaContext
2276 return CALL_BASECRYPTLIB (Rsa
.Services
.GetPublicKeyFromX509
, RsaGetPublicKeyFromX509
, (Cert
, CertSize
, RsaContext
), FALSE
);
2280 Retrieve the subject bytes from one X.509 certificate.
2282 If Cert is NULL, then return FALSE.
2283 If SubjectSize is NULL, then return FALSE.
2284 If this interface is not supported, then return FALSE.
2286 @param[in] Cert Pointer to the DER-encoded X509 certificate.
2287 @param[in] CertSize Size of the X509 certificate in bytes.
2288 @param[out] CertSubject Pointer to the retrieved certificate subject bytes.
2289 @param[in, out] SubjectSize The size in bytes of the CertSubject buffer on input,
2290 and the size of buffer returned CertSubject on output.
2292 @retval TRUE The certificate subject retrieved successfully.
2293 @retval FALSE Invalid certificate, or the SubjectSize is too small for the result.
2294 The SubjectSize will be updated with the required size.
2295 @retval FALSE This interface is not supported.
2300 CryptoServiceX509GetSubjectName (
2301 IN CONST UINT8
*Cert
,
2303 OUT UINT8
*CertSubject
,
2304 IN OUT UINTN
*SubjectSize
2307 return CALL_BASECRYPTLIB (X509
.Services
.GetSubjectName
, X509GetSubjectName
, (Cert
, CertSize
, CertSubject
, SubjectSize
), FALSE
);
2311 Retrieve the common name (CN) string from one X.509 certificate.
2313 @param[in] Cert Pointer to the DER-encoded X509 certificate.
2314 @param[in] CertSize Size of the X509 certificate in bytes.
2315 @param[out] CommonName Buffer to contain the retrieved certificate common
2316 name string (UTF8). At most CommonNameSize bytes will be
2317 written and the string will be null terminated. May be
2318 NULL in order to determine the size buffer needed.
2319 @param[in,out] CommonNameSize The size in bytes of the CommonName buffer on input,
2320 and the size of buffer returned CommonName on output.
2321 If CommonName is NULL then the amount of space needed
2322 in buffer (including the final null) is returned.
2324 @retval RETURN_SUCCESS The certificate CommonName retrieved successfully.
2325 @retval RETURN_INVALID_PARAMETER If Cert is NULL.
2326 If CommonNameSize is NULL.
2327 If CommonName is not NULL and *CommonNameSize is 0.
2328 If Certificate is invalid.
2329 @retval RETURN_NOT_FOUND If no CommonName entry exists.
2330 @retval RETURN_BUFFER_TOO_SMALL If the CommonName is NULL. The required buffer size
2331 (including the final null) is returned in the
2332 CommonNameSize parameter.
2333 @retval RETURN_UNSUPPORTED The operation is not supported.
2338 CryptoServiceX509GetCommonName (
2339 IN CONST UINT8
*Cert
,
2341 OUT CHAR8
*CommonName
, OPTIONAL
2342 IN OUT UINTN
*CommonNameSize
2345 return CALL_BASECRYPTLIB (X509
.Services
.GetCommonName
, X509GetCommonName
, (Cert
, CertSize
, CommonName
, CommonNameSize
), RETURN_UNSUPPORTED
);
2349 Retrieve the organization name (O) string from one X.509 certificate.
2351 @param[in] Cert Pointer to the DER-encoded X509 certificate.
2352 @param[in] CertSize Size of the X509 certificate in bytes.
2353 @param[out] NameBuffer Buffer to contain the retrieved certificate organization
2354 name string. At most NameBufferSize bytes will be
2355 written and the string will be null terminated. May be
2356 NULL in order to determine the size buffer needed.
2357 @param[in,out] NameBufferSize The size in bytes of the Name buffer on input,
2358 and the size of buffer returned Name on output.
2359 If NameBuffer is NULL then the amount of space needed
2360 in buffer (including the final null) is returned.
2362 @retval RETURN_SUCCESS The certificate Organization Name retrieved successfully.
2363 @retval RETURN_INVALID_PARAMETER If Cert is NULL.
2364 If NameBufferSize is NULL.
2365 If NameBuffer is not NULL and *CommonNameSize is 0.
2366 If Certificate is invalid.
2367 @retval RETURN_NOT_FOUND If no Organization Name entry exists.
2368 @retval RETURN_BUFFER_TOO_SMALL If the NameBuffer is NULL. The required buffer size
2369 (including the final null) is returned in the
2370 CommonNameSize parameter.
2371 @retval RETURN_UNSUPPORTED The operation is not supported.
2376 CryptoServiceX509GetOrganizationName (
2377 IN CONST UINT8
*Cert
,
2379 OUT CHAR8
*NameBuffer
, OPTIONAL
2380 IN OUT UINTN
*NameBufferSize
2383 return CALL_BASECRYPTLIB (X509
.Services
.GetOrganizationName
, X509GetOrganizationName
, (Cert
, CertSize
, NameBuffer
, NameBufferSize
), RETURN_UNSUPPORTED
);
2387 Verify one X509 certificate was issued by the trusted CA.
2389 If Cert is NULL, then return FALSE.
2390 If CACert is NULL, then return FALSE.
2391 If this interface is not supported, then return FALSE.
2393 @param[in] Cert Pointer to the DER-encoded X509 certificate to be verified.
2394 @param[in] CertSize Size of the X509 certificate in bytes.
2395 @param[in] CACert Pointer to the DER-encoded trusted CA certificate.
2396 @param[in] CACertSize Size of the CA Certificate in bytes.
2398 @retval TRUE The certificate was issued by the trusted CA.
2399 @retval FALSE Invalid certificate or the certificate was not issued by the given
2401 @retval FALSE This interface is not supported.
2406 CryptoServiceX509VerifyCert (
2407 IN CONST UINT8
*Cert
,
2409 IN CONST UINT8
*CACert
,
2413 return CALL_BASECRYPTLIB (X509
.Services
.VerifyCert
, X509VerifyCert
, (Cert
, CertSize
, CACert
, CACertSize
), FALSE
);
2417 Construct a X509 object from DER-encoded certificate data.
2419 If Cert is NULL, then return FALSE.
2420 If SingleX509Cert is NULL, then return FALSE.
2421 If this interface is not supported, then return FALSE.
2423 @param[in] Cert Pointer to the DER-encoded certificate data.
2424 @param[in] CertSize The size of certificate data in bytes.
2425 @param[out] SingleX509Cert The generated X509 object.
2427 @retval TRUE The X509 object generation succeeded.
2428 @retval FALSE The operation failed.
2429 @retval FALSE This interface is not supported.
2434 CryptoServiceX509ConstructCertificate (
2435 IN CONST UINT8
*Cert
,
2437 OUT UINT8
**SingleX509Cert
2440 return CALL_BASECRYPTLIB (X509
.Services
.ConstructCertificate
, X509ConstructCertificate
, (Cert
, CertSize
, SingleX509Cert
), FALSE
);
2444 Construct a X509 stack object from a list of DER-encoded certificate data.
2446 If X509Stack is NULL, then return FALSE.
2447 If this interface is not supported, then return FALSE.
2449 @param[in, out] X509Stack On input, pointer to an existing or NULL X509 stack object.
2450 On output, pointer to the X509 stack object with new
2451 inserted X509 certificate.
2452 @param[in] Args VA_LIST marker for the variable argument list.
2453 A list of DER-encoded single certificate data followed
2454 by certificate size. A NULL terminates the list. The
2455 pairs are the arguments to X509ConstructCertificate().
2457 @retval TRUE The X509 stack construction succeeded.
2458 @retval FALSE The construction operation failed.
2459 @retval FALSE This interface is not supported.
2464 CryptoServiceX509ConstructCertificateStackV (
2465 IN OUT UINT8
**X509Stack
,
2469 return CALL_BASECRYPTLIB (X509
.Services
.ConstructCertificateStackV
, X509ConstructCertificateStackV
, (X509Stack
, Args
), FALSE
);
2473 Construct a X509 stack object from a list of DER-encoded certificate data.
2475 If X509Stack is NULL, then return FALSE.
2476 If this interface is not supported, then return FALSE.
2478 @param[in, out] X509Stack On input, pointer to an existing or NULL X509 stack object.
2479 On output, pointer to the X509 stack object with new
2480 inserted X509 certificate.
2481 @param ... A list of DER-encoded single certificate data followed
2482 by certificate size. A NULL terminates the list. The
2483 pairs are the arguments to X509ConstructCertificate().
2485 @retval TRUE The X509 stack construction succeeded.
2486 @retval FALSE The construction operation failed.
2487 @retval FALSE This interface is not supported.
2492 CryptoServiceX509ConstructCertificateStack (
2493 IN OUT UINT8
**X509Stack
,
2500 VA_START (Args
, X509Stack
);
2501 Result
= CryptoServiceX509ConstructCertificateStackV (X509Stack
, Args
);
2507 Release the specified X509 object.
2509 If the interface is not supported, then ASSERT().
2511 @param[in] X509Cert Pointer to the X509 object to be released.
2516 CryptoServiceX509Free (
2520 CALL_VOID_BASECRYPTLIB (X509
.Services
.Free
, X509Free
, (X509Cert
));
2524 Release the specified X509 stack object.
2526 If the interface is not supported, then ASSERT().
2528 @param[in] X509Stack Pointer to the X509 stack object to be released.
2533 CryptoServiceX509StackFree (
2537 CALL_VOID_BASECRYPTLIB (X509
.Services
.StackFree
, X509StackFree
, (X509Stack
));
2541 Retrieve the TBSCertificate from one given X.509 certificate.
2543 @param[in] Cert Pointer to the given DER-encoded X509 certificate.
2544 @param[in] CertSize Size of the X509 certificate in bytes.
2545 @param[out] TBSCert DER-Encoded To-Be-Signed certificate.
2546 @param[out] TBSCertSize Size of the TBS certificate in bytes.
2548 If Cert is NULL, then return FALSE.
2549 If TBSCert is NULL, then return FALSE.
2550 If TBSCertSize is NULL, then return FALSE.
2551 If this interface is not supported, then return FALSE.
2553 @retval TRUE The TBSCertificate was retrieved successfully.
2554 @retval FALSE Invalid X.509 certificate.
2559 CryptoServiceX509GetTBSCert (
2560 IN CONST UINT8
*Cert
,
2562 OUT UINT8
**TBSCert
,
2563 OUT UINTN
*TBSCertSize
2566 return CALL_BASECRYPTLIB (X509
.Services
.GetTBSCert
, X509GetTBSCert
, (Cert
, CertSize
, TBSCert
, TBSCertSize
), FALSE
);
2570 Derives a key from a password using a salt and iteration count, based on PKCS#5 v2.0
2571 password based encryption key derivation function PBKDF2, as specified in RFC 2898.
2573 If Password or Salt or OutKey is NULL, then return FALSE.
2574 If the hash algorithm could not be determined, then return FALSE.
2575 If this interface is not supported, then return FALSE.
2577 @param[in] PasswordLength Length of input password in bytes.
2578 @param[in] Password Pointer to the array for the password.
2579 @param[in] SaltLength Size of the Salt in bytes.
2580 @param[in] Salt Pointer to the Salt.
2581 @param[in] IterationCount Number of iterations to perform. Its value should be
2582 greater than or equal to 1.
2583 @param[in] DigestSize Size of the message digest to be used (eg. SHA256_DIGEST_SIZE).
2584 NOTE: DigestSize will be used to determine the hash algorithm.
2585 Only SHA1_DIGEST_SIZE or SHA256_DIGEST_SIZE is supported.
2586 @param[in] KeyLength Size of the derived key buffer in bytes.
2587 @param[out] OutKey Pointer to the output derived key buffer.
2589 @retval TRUE A key was derived successfully.
2590 @retval FALSE One of the pointers was NULL or one of the sizes was too large.
2591 @retval FALSE The hash algorithm could not be determined from the digest size.
2592 @retval FALSE The key derivation operation failed.
2593 @retval FALSE This interface is not supported.
2598 CryptoServicePkcs5HashPassword (
2599 IN UINTN PasswordLength
,
2600 IN CONST CHAR8
*Password
,
2601 IN UINTN SaltLength
,
2602 IN CONST UINT8
*Salt
,
2603 IN UINTN IterationCount
,
2604 IN UINTN DigestSize
,
2609 return CALL_BASECRYPTLIB (Pkcs
.Services
.Pkcs5HashPassword
, Pkcs5HashPassword
, (PasswordLength
, Password
, SaltLength
, Salt
, IterationCount
, DigestSize
, KeyLength
, OutKey
), FALSE
);
2613 Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the
2614 encrypted message in a newly allocated buffer.
2616 Things that can cause a failure include:
2617 - X509 key size does not match any known key size.
2618 - Fail to parse X509 certificate.
2619 - Fail to allocate an intermediate buffer.
2620 - Null pointer provided for a non-optional parameter.
2621 - Data size is too large for the provided key size (max size is a function of key size
2622 and hash digest size).
2624 @param[in] PublicKey A pointer to the DER-encoded X509 certificate that
2625 will be used to encrypt the data.
2626 @param[in] PublicKeySize Size of the X509 cert buffer.
2627 @param[in] InData Data to be encrypted.
2628 @param[in] InDataSize Size of the data buffer.
2629 @param[in] PrngSeed [Optional] If provided, a pointer to a random seed buffer
2630 to be used when initializing the PRNG. NULL otherwise.
2631 @param[in] PrngSeedSize [Optional] If provided, size of the random seed buffer.
2633 @param[out] EncryptedData Pointer to an allocated buffer containing the encrypted
2635 @param[out] EncryptedDataSize Size of the encrypted message buffer.
2637 @retval TRUE Encryption was successful.
2638 @retval FALSE Encryption failed.
2643 CryptoServicePkcs1v2Encrypt (
2644 IN CONST UINT8
*PublicKey
,
2645 IN UINTN PublicKeySize
,
2647 IN UINTN InDataSize
,
2648 IN CONST UINT8
*PrngSeed
, OPTIONAL
2649 IN UINTN PrngSeedSize
, OPTIONAL
2650 OUT UINT8
**EncryptedData
,
2651 OUT UINTN
*EncryptedDataSize
2654 return CALL_BASECRYPTLIB (Pkcs
.Services
.Pkcs1v2Encrypt
, Pkcs1v2Encrypt
, (PublicKey
, PublicKeySize
, InData
, InDataSize
, PrngSeed
, PrngSeedSize
, EncryptedData
, EncryptedDataSize
), FALSE
);
2658 Get the signer's certificates from PKCS#7 signed data as described in "PKCS #7:
2659 Cryptographic Message Syntax Standard". The input signed data could be wrapped
2660 in a ContentInfo structure.
2662 If P7Data, CertStack, StackLength, TrustedCert or CertLength is NULL, then
2663 return FALSE. If P7Length overflow, then return FALSE.
2664 If this interface is not supported, then return FALSE.
2666 @param[in] P7Data Pointer to the PKCS#7 message to verify.
2667 @param[in] P7Length Length of the PKCS#7 message in bytes.
2668 @param[out] CertStack Pointer to Signer's certificates retrieved from P7Data.
2669 It's caller's responsibility to free the buffer with
2671 This data structure is EFI_CERT_STACK type.
2672 @param[out] StackLength Length of signer's certificates in bytes.
2673 @param[out] TrustedCert Pointer to a trusted certificate from Signer's certificates.
2674 It's caller's responsibility to free the buffer with
2676 @param[out] CertLength Length of the trusted certificate in bytes.
2678 @retval TRUE The operation is finished successfully.
2679 @retval FALSE Error occurs during the operation.
2680 @retval FALSE This interface is not supported.
2685 CryptoServicePkcs7GetSigners (
2686 IN CONST UINT8
*P7Data
,
2688 OUT UINT8
**CertStack
,
2689 OUT UINTN
*StackLength
,
2690 OUT UINT8
**TrustedCert
,
2691 OUT UINTN
*CertLength
2694 return CALL_BASECRYPTLIB (Pkcs
.Services
.Pkcs7GetSigners
, Pkcs7GetSigners
, (P7Data
, P7Length
, CertStack
, StackLength
, TrustedCert
, CertLength
), FALSE
);
2698 Wrap function to use free() to free allocated memory for certificates.
2700 If this interface is not supported, then ASSERT().
2702 @param[in] Certs Pointer to the certificates to be freed.
2707 CryptoServicePkcs7FreeSigners (
2711 CALL_VOID_BASECRYPTLIB (Pkcs
.Services
.Pkcs7FreeSigners
, Pkcs7FreeSigners
, (Certs
));
2715 Retrieves all embedded certificates from PKCS#7 signed data as described in "PKCS #7:
2716 Cryptographic Message Syntax Standard", and outputs two certificate lists chained and
2717 unchained to the signer's certificates.
2718 The input signed data could be wrapped in a ContentInfo structure.
2720 @param[in] P7Data Pointer to the PKCS#7 message.
2721 @param[in] P7Length Length of the PKCS#7 message in bytes.
2722 @param[out] SignerChainCerts Pointer to the certificates list chained to signer's
2723 certificate. It's caller's responsibility to free the buffer
2724 with Pkcs7FreeSigners().
2725 This data structure is EFI_CERT_STACK type.
2726 @param[out] ChainLength Length of the chained certificates list buffer in bytes.
2727 @param[out] UnchainCerts Pointer to the unchained certificates lists. It's caller's
2728 responsibility to free the buffer with Pkcs7FreeSigners().
2729 This data structure is EFI_CERT_STACK type.
2730 @param[out] UnchainLength Length of the unchained certificates list buffer in bytes.
2732 @retval TRUE The operation is finished successfully.
2733 @retval FALSE Error occurs during the operation.
2738 CryptoServicePkcs7GetCertificatesList (
2739 IN CONST UINT8
*P7Data
,
2741 OUT UINT8
**SignerChainCerts
,
2742 OUT UINTN
*ChainLength
,
2743 OUT UINT8
**UnchainCerts
,
2744 OUT UINTN
*UnchainLength
2747 return CALL_BASECRYPTLIB (Pkcs
.Services
.Pkcs7GetCertificatesList
, Pkcs7GetCertificatesList
, (P7Data
, P7Length
, SignerChainCerts
, ChainLength
, UnchainCerts
, UnchainLength
), FALSE
);
2751 Creates a PKCS#7 signedData as described in "PKCS #7: Cryptographic Message
2752 Syntax Standard, version 1.5". This interface is only intended to be used for
2753 application to perform PKCS#7 functionality validation.
2755 If this interface is not supported, then return FALSE.
2757 @param[in] PrivateKey Pointer to the PEM-formatted private key data for
2759 @param[in] PrivateKeySize Size of the PEM private key data in bytes.
2760 @param[in] KeyPassword NULL-terminated passphrase used for encrypted PEM
2762 @param[in] InData Pointer to the content to be signed.
2763 @param[in] InDataSize Size of InData in bytes.
2764 @param[in] SignCert Pointer to signer's DER-encoded certificate to sign with.
2765 @param[in] OtherCerts Pointer to an optional additional set of certificates to
2766 include in the PKCS#7 signedData (e.g. any intermediate
2768 @param[out] SignedData Pointer to output PKCS#7 signedData. It's caller's
2769 responsibility to free the buffer with FreePool().
2770 @param[out] SignedDataSize Size of SignedData in bytes.
2772 @retval TRUE PKCS#7 data signing succeeded.
2773 @retval FALSE PKCS#7 data signing failed.
2774 @retval FALSE This interface is not supported.
2779 CryptoServicePkcs7Sign (
2780 IN CONST UINT8
*PrivateKey
,
2781 IN UINTN PrivateKeySize
,
2782 IN CONST UINT8
*KeyPassword
,
2784 IN UINTN InDataSize
,
2786 IN UINT8
*OtherCerts OPTIONAL
,
2787 OUT UINT8
**SignedData
,
2788 OUT UINTN
*SignedDataSize
2791 return CALL_BASECRYPTLIB (Pkcs
.Services
.Pkcs7Sign
, Pkcs7Sign
, (PrivateKey
, PrivateKeySize
, KeyPassword
, InData
, InDataSize
, SignCert
, OtherCerts
, SignedData
, SignedDataSize
), FALSE
);
2795 Verifies the validity of a PKCS#7 signed data as described in "PKCS #7:
2796 Cryptographic Message Syntax Standard". The input signed data could be wrapped
2797 in a ContentInfo structure.
2799 If P7Data, TrustedCert or InData is NULL, then return FALSE.
2800 If P7Length, CertLength or DataLength overflow, then return FALSE.
2801 If this interface is not supported, then return FALSE.
2803 @param[in] P7Data Pointer to the PKCS#7 message to verify.
2804 @param[in] P7Length Length of the PKCS#7 message in bytes.
2805 @param[in] TrustedCert Pointer to a trusted/root certificate encoded in DER, which
2806 is used for certificate chain verification.
2807 @param[in] CertLength Length of the trusted certificate in bytes.
2808 @param[in] InData Pointer to the content to be verified.
2809 @param[in] DataLength Length of InData in bytes.
2811 @retval TRUE The specified PKCS#7 signed data is valid.
2812 @retval FALSE Invalid PKCS#7 signed data.
2813 @retval FALSE This interface is not supported.
2818 CryptoServicePkcs7Verify (
2819 IN CONST UINT8
*P7Data
,
2821 IN CONST UINT8
*TrustedCert
,
2822 IN UINTN CertLength
,
2823 IN CONST UINT8
*InData
,
2827 return CALL_BASECRYPTLIB (Pkcs
.Services
.Pkcs7Verify
, Pkcs7Verify
, (P7Data
, P7Length
, TrustedCert
, CertLength
, InData
, DataLength
), FALSE
);
2831 This function receives a PKCS7 formatted signature, and then verifies that
2832 the specified Enhanced or Extended Key Usages (EKU's) are present in the end-entity
2833 leaf signing certificate.
2834 Note that this function does not validate the certificate chain.
2836 Applications for custom EKU's are quite flexible. For example, a policy EKU
2837 may be present in an Issuing Certificate Authority (CA), and any sub-ordinate
2838 certificate issued might also contain this EKU, thus constraining the
2839 sub-ordinate certificate. Other applications might allow a certificate
2840 embedded in a device to specify that other Object Identifiers (OIDs) are
2841 present which contains binary data specifying custom capabilities that
2842 the device is able to do.
2844 @param[in] Pkcs7Signature The PKCS#7 signed information content block. An array
2845 containing the content block with both the signature,
2846 the signer's certificate, and any necessary intermediate
2848 @param[in] Pkcs7SignatureSize Number of bytes in Pkcs7Signature.
2849 @param[in] RequiredEKUs Array of null-terminated strings listing OIDs of
2850 required EKUs that must be present in the signature.
2851 @param[in] RequiredEKUsSize Number of elements in the RequiredEKUs string array.
2852 @param[in] RequireAllPresent If this is TRUE, then all of the specified EKU's
2853 must be present in the leaf signer. If it is
2854 FALSE, then we will succeed if we find any
2855 of the specified EKU's.
2857 @retval EFI_SUCCESS The required EKUs were found in the signature.
2858 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2859 @retval EFI_NOT_FOUND One or more EKU's were not found in the signature.
2864 CryptoServiceVerifyEKUsInPkcs7Signature (
2865 IN CONST UINT8
*Pkcs7Signature
,
2866 IN CONST UINT32 SignatureSize
,
2867 IN CONST CHAR8
*RequiredEKUs
[],
2868 IN CONST UINT32 RequiredEKUsSize
,
2869 IN BOOLEAN RequireAllPresent
2872 return CALL_BASECRYPTLIB (Pkcs
.Services
.VerifyEKUsInPkcs7Signature
, VerifyEKUsInPkcs7Signature
, (Pkcs7Signature
, SignatureSize
, RequiredEKUs
, RequiredEKUsSize
, RequireAllPresent
), FALSE
);
2877 Extracts the attached content from a PKCS#7 signed data if existed. The input signed
2878 data could be wrapped in a ContentInfo structure.
2880 If P7Data, Content, or ContentSize is NULL, then return FALSE. If P7Length overflow,
2881 then return FALSE. If the P7Data is not correctly formatted, then return FALSE.
2883 Caution: This function may receive untrusted input. So this function will do
2884 basic check for PKCS#7 data structure.
2886 @param[in] P7Data Pointer to the PKCS#7 signed data to process.
2887 @param[in] P7Length Length of the PKCS#7 signed data in bytes.
2888 @param[out] Content Pointer to the extracted content from the PKCS#7 signedData.
2889 It's caller's responsibility to free the buffer with FreePool().
2890 @param[out] ContentSize The size of the extracted content in bytes.
2892 @retval TRUE The P7Data was correctly formatted for processing.
2893 @retval FALSE The P7Data was not correctly formatted for processing.
2898 CryptoServicePkcs7GetAttachedContent (
2899 IN CONST UINT8
*P7Data
,
2902 OUT UINTN
*ContentSize
2905 return CALL_BASECRYPTLIB (Pkcs
.Services
.Pkcs7GetAttachedContent
, Pkcs7GetAttachedContent
, (P7Data
, P7Length
, Content
, ContentSize
), FALSE
);
2909 Verifies the validity of a PE/COFF Authenticode Signature as described in "Windows
2910 Authenticode Portable Executable Signature Format".
2912 If AuthData is NULL, then return FALSE.
2913 If ImageHash is NULL, then return FALSE.
2914 If this interface is not supported, then return FALSE.
2916 @param[in] AuthData Pointer to the Authenticode Signature retrieved from signed
2917 PE/COFF image to be verified.
2918 @param[in] DataSize Size of the Authenticode Signature in bytes.
2919 @param[in] TrustedCert Pointer to a trusted/root certificate encoded in DER, which
2920 is used for certificate chain verification.
2921 @param[in] CertSize Size of the trusted certificate in bytes.
2922 @param[in] ImageHash Pointer to the original image file hash value. The procedure
2923 for calculating the image hash value is described in Authenticode
2925 @param[in] HashSize Size of Image hash value in bytes.
2927 @retval TRUE The specified Authenticode Signature is valid.
2928 @retval FALSE Invalid Authenticode Signature.
2929 @retval FALSE This interface is not supported.
2934 CryptoServiceAuthenticodeVerify (
2935 IN CONST UINT8
*AuthData
,
2937 IN CONST UINT8
*TrustedCert
,
2939 IN CONST UINT8
*ImageHash
,
2943 return CALL_BASECRYPTLIB (Pkcs
.Services
.AuthenticodeVerify
, AuthenticodeVerify
, (AuthData
, DataSize
, TrustedCert
, CertSize
, ImageHash
, HashSize
), FALSE
);
2947 Verifies the validity of a RFC3161 Timestamp CounterSignature embedded in PE/COFF Authenticode
2950 If AuthData is NULL, then return FALSE.
2951 If this interface is not supported, then return FALSE.
2953 @param[in] AuthData Pointer to the Authenticode Signature retrieved from signed
2954 PE/COFF image to be verified.
2955 @param[in] DataSize Size of the Authenticode Signature in bytes.
2956 @param[in] TsaCert Pointer to a trusted/root TSA certificate encoded in DER, which
2957 is used for TSA certificate chain verification.
2958 @param[in] CertSize Size of the trusted certificate in bytes.
2959 @param[out] SigningTime Return the time of timestamp generation time if the timestamp
2962 @retval TRUE The specified Authenticode includes a valid RFC3161 Timestamp CounterSignature.
2963 @retval FALSE No valid RFC3161 Timestamp CounterSignature in the specified Authenticode data.
2968 CryptoServiceImageTimestampVerify (
2969 IN CONST UINT8
*AuthData
,
2971 IN CONST UINT8
*TsaCert
,
2973 OUT EFI_TIME
*SigningTime
2976 return CALL_BASECRYPTLIB (Pkcs
.Services
.ImageTimestampVerify
, ImageTimestampVerify
, (AuthData
, DataSize
, TsaCert
, CertSize
, SigningTime
), FALSE
);
2979 //=====================================================================================
2980 // DH Key Exchange Primitive
2981 //=====================================================================================
2984 Allocates and Initializes one Diffie-Hellman Context for subsequent use.
2986 @return Pointer to the Diffie-Hellman Context that has been initialized.
2987 If the allocations fails, DhNew() returns NULL.
2988 If the interface is not supported, DhNew() returns NULL.
2993 CryptoServiceDhNew (
2997 return CALL_BASECRYPTLIB (Dh
.Services
.New
, DhNew
, (), NULL
);
3001 Release the specified DH context.
3003 If the interface is not supported, then ASSERT().
3005 @param[in] DhContext Pointer to the DH context to be released.
3010 CryptoServiceDhFree (
3014 CALL_VOID_BASECRYPTLIB (Dh
.Services
.Free
, DhFree
, (DhContext
));
3018 Generates DH parameter.
3020 Given generator g, and length of prime number p in bits, this function generates p,
3021 and sets DH context according to value of g and p.
3023 Before this function can be invoked, pseudorandom number generator must be correctly
3024 initialized by RandomSeed().
3026 If DhContext is NULL, then return FALSE.
3027 If Prime is NULL, then return FALSE.
3028 If this interface is not supported, then return FALSE.
3030 @param[in, out] DhContext Pointer to the DH context.
3031 @param[in] Generator Value of generator.
3032 @param[in] PrimeLength Length in bits of prime to be generated.
3033 @param[out] Prime Pointer to the buffer to receive the generated prime number.
3035 @retval TRUE DH parameter generation succeeded.
3036 @retval FALSE Value of Generator is not supported.
3037 @retval FALSE PRNG fails to generate random prime number with PrimeLength.
3038 @retval FALSE This interface is not supported.
3043 CryptoServiceDhGenerateParameter (
3044 IN OUT VOID
*DhContext
,
3046 IN UINTN PrimeLength
,
3050 return CALL_BASECRYPTLIB (Dh
.Services
.GenerateParameter
, DhGenerateParameter
, (DhContext
, Generator
, PrimeLength
, Prime
), FALSE
);
3054 Sets generator and prime parameters for DH.
3056 Given generator g, and prime number p, this function and sets DH
3057 context accordingly.
3059 If DhContext is NULL, then return FALSE.
3060 If Prime is NULL, then return FALSE.
3061 If this interface is not supported, then return FALSE.
3063 @param[in, out] DhContext Pointer to the DH context.
3064 @param[in] Generator Value of generator.
3065 @param[in] PrimeLength Length in bits of prime to be generated.
3066 @param[in] Prime Pointer to the prime number.
3068 @retval TRUE DH parameter setting succeeded.
3069 @retval FALSE Value of Generator is not supported.
3070 @retval FALSE Value of Generator is not suitable for the Prime.
3071 @retval FALSE Value of Prime is not a prime number.
3072 @retval FALSE Value of Prime is not a safe prime number.
3073 @retval FALSE This interface is not supported.
3078 CryptoServiceDhSetParameter (
3079 IN OUT VOID
*DhContext
,
3081 IN UINTN PrimeLength
,
3082 IN CONST UINT8
*Prime
3085 return CALL_BASECRYPTLIB (Dh
.Services
.SetParameter
, DhSetParameter
, (DhContext
, Generator
, PrimeLength
, Prime
), FALSE
);
3089 Generates DH public key.
3091 This function generates random secret exponent, and computes the public key, which is
3092 returned via parameter PublicKey and PublicKeySize. DH context is updated accordingly.
3093 If the PublicKey buffer is too small to hold the public key, FALSE is returned and
3094 PublicKeySize is set to the required buffer size to obtain the public key.
3096 If DhContext is NULL, then return FALSE.
3097 If PublicKeySize is NULL, then return FALSE.
3098 If PublicKeySize is large enough but PublicKey is NULL, then return FALSE.
3099 If this interface is not supported, then return FALSE.
3101 @param[in, out] DhContext Pointer to the DH context.
3102 @param[out] PublicKey Pointer to the buffer to receive generated public key.
3103 @param[in, out] PublicKeySize On input, the size of PublicKey buffer in bytes.
3104 On output, the size of data returned in PublicKey buffer in bytes.
3106 @retval TRUE DH public key generation succeeded.
3107 @retval FALSE DH public key generation failed.
3108 @retval FALSE PublicKeySize is not large enough.
3109 @retval FALSE This interface is not supported.
3114 CryptoServiceDhGenerateKey (
3115 IN OUT VOID
*DhContext
,
3116 OUT UINT8
*PublicKey
,
3117 IN OUT UINTN
*PublicKeySize
3120 return CALL_BASECRYPTLIB (Dh
.Services
.GenerateKey
, DhGenerateKey
, (DhContext
, PublicKey
, PublicKeySize
), FALSE
);
3124 Computes exchanged common key.
3126 Given peer's public key, this function computes the exchanged common key, based on its own
3127 context including value of prime modulus and random secret exponent.
3129 If DhContext is NULL, then return FALSE.
3130 If PeerPublicKey is NULL, then return FALSE.
3131 If KeySize is NULL, then return FALSE.
3132 If Key is NULL, then return FALSE.
3133 If KeySize is not large enough, then return FALSE.
3134 If this interface is not supported, then return FALSE.
3136 @param[in, out] DhContext Pointer to the DH context.
3137 @param[in] PeerPublicKey Pointer to the peer's public key.
3138 @param[in] PeerPublicKeySize Size of peer's public key in bytes.
3139 @param[out] Key Pointer to the buffer to receive generated key.
3140 @param[in, out] KeySize On input, the size of Key buffer in bytes.
3141 On output, the size of data returned in Key buffer in bytes.
3143 @retval TRUE DH exchanged key generation succeeded.
3144 @retval FALSE DH exchanged key generation failed.
3145 @retval FALSE KeySize is not large enough.
3146 @retval FALSE This interface is not supported.
3151 CryptoServiceDhComputeKey (
3152 IN OUT VOID
*DhContext
,
3153 IN CONST UINT8
*PeerPublicKey
,
3154 IN UINTN PeerPublicKeySize
,
3156 IN OUT UINTN
*KeySize
3159 return CALL_BASECRYPTLIB (Dh
.Services
.ComputeKey
, DhComputeKey
, (DhContext
, PeerPublicKey
, PeerPublicKeySize
, Key
, KeySize
), FALSE
);
3162 //=====================================================================================
3163 // Pseudo-Random Generation Primitive
3164 //=====================================================================================
3167 Sets up the seed value for the pseudorandom number generator.
3169 This function sets up the seed value for the pseudorandom number generator.
3170 If Seed is not NULL, then the seed passed in is used.
3171 If Seed is NULL, then default seed is used.
3172 If this interface is not supported, then return FALSE.
3174 @param[in] Seed Pointer to seed value.
3175 If NULL, default seed is used.
3176 @param[in] SeedSize Size of seed value.
3177 If Seed is NULL, this parameter is ignored.
3179 @retval TRUE Pseudorandom number generator has enough entropy for random generation.
3180 @retval FALSE Pseudorandom number generator does not have enough entropy for random generation.
3181 @retval FALSE This interface is not supported.
3186 CryptoServiceRandomSeed (
3187 IN CONST UINT8
*Seed OPTIONAL
,
3191 return CALL_BASECRYPTLIB (Random
.Services
.Seed
, RandomSeed
, (Seed
, SeedSize
), FALSE
);
3195 Generates a pseudorandom byte stream of the specified size.
3197 If Output is NULL, then return FALSE.
3198 If this interface is not supported, then return FALSE.
3200 @param[out] Output Pointer to buffer to receive random value.
3201 @param[in] Size Size of random bytes to generate.
3203 @retval TRUE Pseudorandom byte stream generated successfully.
3204 @retval FALSE Pseudorandom number generator fails to generate due to lack of entropy.
3205 @retval FALSE This interface is not supported.
3210 CryptoServiceRandomBytes (
3215 return CALL_BASECRYPTLIB (Random
.Services
.Bytes
, RandomBytes
, (Output
, Size
), FALSE
);
3218 //=====================================================================================
3219 // Key Derivation Function Primitive
3220 //=====================================================================================
3223 Derive key data using HMAC-SHA256 based KDF.
3225 @param[in] Key Pointer to the user-supplied key.
3226 @param[in] KeySize Key size in bytes.
3227 @param[in] Salt Pointer to the salt(non-secret) value.
3228 @param[in] SaltSize Salt size in bytes.
3229 @param[in] Info Pointer to the application specific info.
3230 @param[in] InfoSize Info size in bytes.
3231 @param[out] Out Pointer to buffer to receive hkdf value.
3232 @param[in] OutSize Size of hkdf bytes to generate.
3234 @retval TRUE Hkdf generated successfully.
3235 @retval FALSE Hkdf generation failed.
3240 CryptoServiceHkdfSha256ExtractAndExpand (
3241 IN CONST UINT8
*Key
,
3243 IN CONST UINT8
*Salt
,
3245 IN CONST UINT8
*Info
,
3251 return CALL_BASECRYPTLIB (Hkdf
.Services
.Sha256ExtractAndExpand
, HkdfSha256ExtractAndExpand
, (Key
, KeySize
, Salt
, SaltSize
, Info
, InfoSize
, Out
, OutSize
), FALSE
);
3255 Initializes the OpenSSL library.
3257 This function registers ciphers and digests used directly and indirectly
3258 by SSL/TLS, and initializes the readable error messages.
3259 This function must be called before any other action takes places.
3261 @retval TRUE The OpenSSL library has been initialized.
3262 @retval FALSE Failed to initialize the OpenSSL library.
3267 CryptoServiceTlsInitialize (
3271 return CALL_BASECRYPTLIB (Tls
.Services
.Initialize
, TlsInitialize
, (), FALSE
);
3275 Free an allocated SSL_CTX object.
3277 @param[in] TlsCtx Pointer to the SSL_CTX object to be released.
3282 CryptoServiceTlsCtxFree (
3286 CALL_VOID_BASECRYPTLIB (Tls
.Services
.CtxFree
, TlsCtxFree
, (TlsCtx
));
3290 Creates a new SSL_CTX object as framework to establish TLS/SSL enabled
3293 @param[in] MajorVer Major Version of TLS/SSL Protocol.
3294 @param[in] MinorVer Minor Version of TLS/SSL Protocol.
3296 @return Pointer to an allocated SSL_CTX object.
3297 If the creation failed, TlsCtxNew() returns NULL.
3302 CryptoServiceTlsCtxNew (
3307 return CALL_BASECRYPTLIB (Tls
.Services
.CtxNew
, TlsCtxNew
, (MajorVer
, MinorVer
), NULL
);
3311 Free an allocated TLS object.
3313 This function removes the TLS object pointed to by Tls and frees up the
3314 allocated memory. If Tls is NULL, nothing is done.
3316 @param[in] Tls Pointer to the TLS object to be freed.
3321 CryptoServiceTlsFree (
3325 CALL_VOID_BASECRYPTLIB (Tls
.Services
.Free
, TlsFree
, (Tls
));
3329 Create a new TLS object for a connection.
3331 This function creates a new TLS object for a connection. The new object
3332 inherits the setting of the underlying context TlsCtx: connection method,
3333 options, verification setting.
3335 @param[in] TlsCtx Pointer to the SSL_CTX object.
3337 @return Pointer to an allocated SSL object.
3338 If the creation failed, TlsNew() returns NULL.
3343 CryptoServiceTlsNew (
3347 return CALL_BASECRYPTLIB (Tls
.Services
.New
, TlsNew
, (TlsCtx
), NULL
);
3351 Checks if the TLS handshake was done.
3353 This function will check if the specified TLS handshake was done.
3355 @param[in] Tls Pointer to the TLS object for handshake state checking.
3357 @retval TRUE The TLS handshake was done.
3358 @retval FALSE The TLS handshake was not done.
3363 CryptoServiceTlsInHandshake (
3367 return CALL_BASECRYPTLIB (Tls
.Services
.InHandshake
, TlsInHandshake
, (Tls
), FALSE
);
3371 Perform a TLS/SSL handshake.
3373 This function will perform a TLS/SSL handshake.
3375 @param[in] Tls Pointer to the TLS object for handshake operation.
3376 @param[in] BufferIn Pointer to the most recently received TLS Handshake packet.
3377 @param[in] BufferInSize Packet size in bytes for the most recently received TLS
3379 @param[out] BufferOut Pointer to the buffer to hold the built packet.
3380 @param[in, out] BufferOutSize Pointer to the buffer size in bytes. On input, it is
3381 the buffer size provided by the caller. On output, it
3382 is the buffer size in fact needed to contain the
3385 @retval EFI_SUCCESS The required TLS packet is built successfully.
3386 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
3388 BufferIn is NULL but BufferInSize is NOT 0.
3389 BufferInSize is 0 but BufferIn is NOT NULL.
3390 BufferOutSize is NULL.
3391 BufferOut is NULL if *BufferOutSize is not zero.
3392 @retval EFI_BUFFER_TOO_SMALL BufferOutSize is too small to hold the response packet.
3393 @retval EFI_ABORTED Something wrong during handshake.
3398 CryptoServiceTlsDoHandshake (
3400 IN UINT8
*BufferIn
, OPTIONAL
3401 IN UINTN BufferInSize
, OPTIONAL
3402 OUT UINT8
*BufferOut
, OPTIONAL
3403 IN OUT UINTN
*BufferOutSize
3406 return CALL_BASECRYPTLIB (Tls
.Services
.DoHandshake
, TlsDoHandshake
, (Tls
, BufferIn
, BufferInSize
, BufferOut
, BufferOutSize
), EFI_UNSUPPORTED
);
3410 Handle Alert message recorded in BufferIn. If BufferIn is NULL and BufferInSize is zero,
3411 TLS session has errors and the response packet needs to be Alert message based on error type.
3413 @param[in] Tls Pointer to the TLS object for state checking.
3414 @param[in] BufferIn Pointer to the most recently received TLS Alert packet.
3415 @param[in] BufferInSize Packet size in bytes for the most recently received TLS
3417 @param[out] BufferOut Pointer to the buffer to hold the built packet.
3418 @param[in, out] BufferOutSize Pointer to the buffer size in bytes. On input, it is
3419 the buffer size provided by the caller. On output, it
3420 is the buffer size in fact needed to contain the
3423 @retval EFI_SUCCESS The required TLS packet is built successfully.
3424 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
3426 BufferIn is NULL but BufferInSize is NOT 0.
3427 BufferInSize is 0 but BufferIn is NOT NULL.
3428 BufferOutSize is NULL.
3429 BufferOut is NULL if *BufferOutSize is not zero.
3430 @retval EFI_ABORTED An error occurred.
3431 @retval EFI_BUFFER_TOO_SMALL BufferOutSize is too small to hold the response packet.
3436 CryptoServiceTlsHandleAlert (
3438 IN UINT8
*BufferIn
, OPTIONAL
3439 IN UINTN BufferInSize
, OPTIONAL
3440 OUT UINT8
*BufferOut
, OPTIONAL
3441 IN OUT UINTN
*BufferOutSize
3444 return CALL_BASECRYPTLIB (Tls
.Services
.HandleAlert
, TlsHandleAlert
, (Tls
, BufferIn
, BufferInSize
, BufferOut
, BufferOutSize
), EFI_UNSUPPORTED
);
3448 Build the CloseNotify packet.
3450 @param[in] Tls Pointer to the TLS object for state checking.
3451 @param[in, out] Buffer Pointer to the buffer to hold the built packet.
3452 @param[in, out] BufferSize Pointer to the buffer size in bytes. On input, it is
3453 the buffer size provided by the caller. On output, it
3454 is the buffer size in fact needed to contain the
3457 @retval EFI_SUCCESS The required TLS packet is built successfully.
3458 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
3461 Buffer is NULL if *BufferSize is not zero.
3462 @retval EFI_BUFFER_TOO_SMALL BufferSize is too small to hold the response packet.
3467 CryptoServiceTlsCloseNotify (
3469 IN OUT UINT8
*Buffer
,
3470 IN OUT UINTN
*BufferSize
3473 return CALL_BASECRYPTLIB (Tls
.Services
.CloseNotify
, TlsCloseNotify
, (Tls
, Buffer
, BufferSize
), EFI_UNSUPPORTED
);
3477 Attempts to read bytes from one TLS object and places the data in Buffer.
3479 This function will attempt to read BufferSize bytes from the TLS object
3480 and places the data in Buffer.
3482 @param[in] Tls Pointer to the TLS object.
3483 @param[in,out] Buffer Pointer to the buffer to store the data.
3484 @param[in] BufferSize The size of Buffer in bytes.
3486 @retval >0 The amount of data successfully read from the TLS object.
3487 @retval <=0 No data was successfully read.
3492 CryptoServiceTlsCtrlTrafficOut (
3494 IN OUT VOID
*Buffer
,
3498 return CALL_BASECRYPTLIB (Tls
.Services
.CtrlTrafficOut
, TlsCtrlTrafficOut
, (Tls
, Buffer
, BufferSize
), 0);
3502 Attempts to write data from the buffer to TLS object.
3504 This function will attempt to write BufferSize bytes data from the Buffer
3507 @param[in] Tls Pointer to the TLS object.
3508 @param[in] Buffer Pointer to the data buffer.
3509 @param[in] BufferSize The size of Buffer in bytes.
3511 @retval >0 The amount of data successfully written to the TLS object.
3512 @retval <=0 No data was successfully written.
3517 CryptoServiceTlsCtrlTrafficIn (
3523 return CALL_BASECRYPTLIB (Tls
.Services
.CtrlTrafficIn
, TlsCtrlTrafficIn
, (Tls
, Buffer
, BufferSize
), 0);
3527 Attempts to read bytes from the specified TLS connection into the buffer.
3529 This function tries to read BufferSize bytes data from the specified TLS
3530 connection into the Buffer.
3532 @param[in] Tls Pointer to the TLS connection for data reading.
3533 @param[in,out] Buffer Pointer to the data buffer.
3534 @param[in] BufferSize The size of Buffer in bytes.
3536 @retval >0 The read operation was successful, and return value is the
3537 number of bytes actually read from the TLS connection.
3538 @retval <=0 The read operation was not successful.
3543 CryptoServiceTlsRead (
3545 IN OUT VOID
*Buffer
,
3549 return CALL_BASECRYPTLIB (Tls
.Services
.Read
, TlsRead
, (Tls
, Buffer
, BufferSize
), 0);
3553 Attempts to write data to a TLS connection.
3555 This function tries to write BufferSize bytes data from the Buffer into the
3556 specified TLS connection.
3558 @param[in] Tls Pointer to the TLS connection for data writing.
3559 @param[in] Buffer Pointer to the data buffer.
3560 @param[in] BufferSize The size of Buffer in bytes.
3562 @retval >0 The write operation was successful, and return value is the
3563 number of bytes actually written to the TLS connection.
3564 @retval <=0 The write operation was not successful.
3569 CryptoServiceTlsWrite (
3575 return CALL_BASECRYPTLIB (Tls
.Services
.Write
, TlsWrite
, (Tls
, Buffer
, BufferSize
), 0);
3579 Set a new TLS/SSL method for a particular TLS object.
3581 This function sets a new TLS/SSL method for a particular TLS object.
3583 @param[in] Tls Pointer to a TLS object.
3584 @param[in] MajorVer Major Version of TLS/SSL Protocol.
3585 @param[in] MinorVer Minor Version of TLS/SSL Protocol.
3587 @retval EFI_SUCCESS The TLS/SSL method was set successfully.
3588 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3589 @retval EFI_UNSUPPORTED Unsupported TLS/SSL method.
3594 CryptoServiceTlsSetVersion (
3600 return CALL_BASECRYPTLIB (TlsSet
.Services
.Version
, TlsSetVersion
, (Tls
, MajorVer
, MinorVer
), EFI_UNSUPPORTED
);
3604 Set TLS object to work in client or server mode.
3606 This function prepares a TLS object to work in client or server mode.
3608 @param[in] Tls Pointer to a TLS object.
3609 @param[in] IsServer Work in server mode.
3611 @retval EFI_SUCCESS The TLS/SSL work mode was set successfully.
3612 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3613 @retval EFI_UNSUPPORTED Unsupported TLS/SSL work mode.
3618 CryptoServiceTlsSetConnectionEnd (
3623 return CALL_BASECRYPTLIB (TlsSet
.Services
.ConnectionEnd
, TlsSetConnectionEnd
, (Tls
, IsServer
), EFI_UNSUPPORTED
);
3627 Set the ciphers list to be used by the TLS object.
3629 This function sets the ciphers for use by a specified TLS object.
3631 @param[in] Tls Pointer to a TLS object.
3632 @param[in] CipherId Array of UINT16 cipher identifiers. Each UINT16
3633 cipher identifier comes from the TLS Cipher Suite
3634 Registry of the IANA, interpreting Byte1 and Byte2
3635 in network (big endian) byte order.
3636 @param[in] CipherNum The number of cipher in the list.
3638 @retval EFI_SUCCESS The ciphers list was set successfully.
3639 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3640 @retval EFI_UNSUPPORTED No supported TLS cipher was found in CipherId.
3641 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
3646 CryptoServiceTlsSetCipherList (
3648 IN UINT16
*CipherId
,
3652 return CALL_BASECRYPTLIB (TlsSet
.Services
.CipherList
, TlsSetCipherList
, (Tls
, CipherId
, CipherNum
), EFI_UNSUPPORTED
);
3656 Set the compression method for TLS/SSL operations.
3658 This function handles TLS/SSL integrated compression methods.
3660 @param[in] CompMethod The compression method ID.
3662 @retval EFI_SUCCESS The compression method for the communication was
3664 @retval EFI_UNSUPPORTED Unsupported compression method.
3669 CryptoServiceTlsSetCompressionMethod (
3673 return CALL_BASECRYPTLIB (TlsSet
.Services
.CompressionMethod
, TlsSetCompressionMethod
, (CompMethod
), EFI_UNSUPPORTED
);
3677 Set peer certificate verification mode for the TLS connection.
3679 This function sets the verification mode flags for the TLS connection.
3681 @param[in] Tls Pointer to the TLS object.
3682 @param[in] VerifyMode A set of logically or'ed verification mode flags.
3687 CryptoServiceTlsSetVerify (
3689 IN UINT32 VerifyMode
3692 CALL_VOID_BASECRYPTLIB (TlsSet
.Services
.Verify
, TlsSetVerify
, (Tls
, VerifyMode
));
3696 Set the specified host name to be verified.
3698 @param[in] Tls Pointer to the TLS object.
3699 @param[in] Flags The setting flags during the validation.
3700 @param[in] HostName The specified host name to be verified.
3702 @retval EFI_SUCCESS The HostName setting was set successfully.
3703 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3704 @retval EFI_ABORTED Invalid HostName setting.
3709 CryptoServiceTlsSetVerifyHost (
3715 return CALL_BASECRYPTLIB (TlsSet
.Services
.VerifyHost
, TlsSetVerifyHost
, (Tls
, Flags
, HostName
), EFI_UNSUPPORTED
);
3719 Sets a TLS/SSL session ID to be used during TLS/SSL connect.
3721 This function sets a session ID to be used when the TLS/SSL connection is
3724 @param[in] Tls Pointer to the TLS object.
3725 @param[in] SessionId Session ID data used for session resumption.
3726 @param[in] SessionIdLen Length of Session ID in bytes.
3728 @retval EFI_SUCCESS Session ID was set successfully.
3729 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3730 @retval EFI_UNSUPPORTED No available session for ID setting.
3735 CryptoServiceTlsSetSessionId (
3737 IN UINT8
*SessionId
,
3738 IN UINT16 SessionIdLen
3741 return CALL_BASECRYPTLIB (TlsSet
.Services
.SessionId
, TlsSetSessionId
, (Tls
, SessionId
, SessionIdLen
), EFI_UNSUPPORTED
);
3745 Adds the CA to the cert store when requesting Server or Client authentication.
3747 This function adds the CA certificate to the list of CAs when requesting
3748 Server or Client authentication for the chosen TLS connection.
3750 @param[in] Tls Pointer to the TLS object.
3751 @param[in] Data Pointer to the data buffer of a DER-encoded binary
3752 X.509 certificate or PEM-encoded X.509 certificate.
3753 @param[in] DataSize The size of data buffer in bytes.
3755 @retval EFI_SUCCESS The operation succeeded.
3756 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3757 @retval EFI_OUT_OF_RESOURCES Required resources could not be allocated.
3758 @retval EFI_ABORTED Invalid X.509 certificate.
3763 CryptoServiceTlsSetCaCertificate (
3769 return CALL_BASECRYPTLIB (TlsSet
.Services
.CaCertificate
, TlsSetCaCertificate
, (Tls
, Data
, DataSize
), EFI_UNSUPPORTED
);
3773 Loads the local public certificate into the specified TLS object.
3775 This function loads the X.509 certificate into the specified TLS object
3776 for TLS negotiation.
3778 @param[in] Tls Pointer to the TLS object.
3779 @param[in] Data Pointer to the data buffer of a DER-encoded binary
3780 X.509 certificate or PEM-encoded X.509 certificate.
3781 @param[in] DataSize The size of data buffer in bytes.
3783 @retval EFI_SUCCESS The operation succeeded.
3784 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3785 @retval EFI_OUT_OF_RESOURCES Required resources could not be allocated.
3786 @retval EFI_ABORTED Invalid X.509 certificate.
3791 CryptoServiceTlsSetHostPublicCert (
3797 return CALL_BASECRYPTLIB (TlsSet
.Services
.HostPublicCert
, TlsSetHostPublicCert
, (Tls
, Data
, DataSize
), EFI_UNSUPPORTED
);
3801 Adds the local private key to the specified TLS object.
3803 This function adds the local private key (PEM-encoded RSA or PKCS#8 private
3804 key) into the specified TLS object for TLS negotiation.
3806 @param[in] Tls Pointer to the TLS object.
3807 @param[in] Data Pointer to the data buffer of a PEM-encoded RSA
3808 or PKCS#8 private key.
3809 @param[in] DataSize The size of data buffer in bytes.
3811 @retval EFI_SUCCESS The operation succeeded.
3812 @retval EFI_UNSUPPORTED This function is not supported.
3813 @retval EFI_ABORTED Invalid private key data.
3818 CryptoServiceTlsSetHostPrivateKey (
3824 return CALL_BASECRYPTLIB (TlsSet
.Services
.HostPrivateKey
, TlsSetHostPrivateKey
, (Tls
, Data
, DataSize
), EFI_UNSUPPORTED
);
3828 Adds the CA-supplied certificate revocation list for certificate validation.
3830 This function adds the CA-supplied certificate revocation list data for
3831 certificate validity checking.
3833 @param[in] Data Pointer to the data buffer of a DER-encoded CRL data.
3834 @param[in] DataSize The size of data buffer in bytes.
3836 @retval EFI_SUCCESS The operation succeeded.
3837 @retval EFI_UNSUPPORTED This function is not supported.
3838 @retval EFI_ABORTED Invalid CRL data.
3843 CryptoServiceTlsSetCertRevocationList (
3848 return CALL_BASECRYPTLIB (TlsSet
.Services
.CertRevocationList
, TlsSetCertRevocationList
, (Data
, DataSize
), EFI_UNSUPPORTED
);
3852 Gets the protocol version used by the specified TLS connection.
3854 This function returns the protocol version used by the specified TLS
3857 If Tls is NULL, then ASSERT().
3859 @param[in] Tls Pointer to the TLS object.
3861 @return The protocol version of the specified TLS connection.
3866 CryptoServiceTlsGetVersion (
3870 return CALL_BASECRYPTLIB (TlsGet
.Services
.Version
, TlsGetVersion
, (Tls
), 0);
3874 Gets the connection end of the specified TLS connection.
3876 This function returns the connection end (as client or as server) used by
3877 the specified TLS connection.
3879 If Tls is NULL, then ASSERT().
3881 @param[in] Tls Pointer to the TLS object.
3883 @return The connection end used by the specified TLS connection.
3888 CryptoServiceTlsGetConnectionEnd (
3892 return CALL_BASECRYPTLIB (TlsGet
.Services
.ConnectionEnd
, TlsGetConnectionEnd
, (Tls
), 0);
3896 Gets the cipher suite used by the specified TLS connection.
3898 This function returns current cipher suite used by the specified
3901 @param[in] Tls Pointer to the TLS object.
3902 @param[in,out] CipherId The cipher suite used by the TLS object.
3904 @retval EFI_SUCCESS The cipher suite was returned successfully.
3905 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3906 @retval EFI_UNSUPPORTED Unsupported cipher suite.
3911 CryptoServiceTlsGetCurrentCipher (
3913 IN OUT UINT16
*CipherId
3916 return CALL_BASECRYPTLIB (TlsGet
.Services
.CurrentCipher
, TlsGetCurrentCipher
, (Tls
, CipherId
), EFI_UNSUPPORTED
);
3920 Gets the compression methods used by the specified TLS connection.
3922 This function returns current integrated compression methods used by
3923 the specified TLS connection.
3925 @param[in] Tls Pointer to the TLS object.
3926 @param[in,out] CompressionId The current compression method used by
3929 @retval EFI_SUCCESS The compression method was returned successfully.
3930 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3931 @retval EFI_ABORTED Invalid Compression method.
3932 @retval EFI_UNSUPPORTED This function is not supported.
3937 CryptoServiceTlsGetCurrentCompressionId (
3939 IN OUT UINT8
*CompressionId
3942 return CALL_BASECRYPTLIB (TlsGet
.Services
.CurrentCompressionId
, TlsGetCurrentCompressionId
, (Tls
, CompressionId
), EFI_UNSUPPORTED
);
3946 Gets the verification mode currently set in the TLS connection.
3948 This function returns the peer verification mode currently set in the
3949 specified TLS connection.
3951 If Tls is NULL, then ASSERT().
3953 @param[in] Tls Pointer to the TLS object.
3955 @return The verification mode set in the specified TLS connection.
3960 CryptoServiceTlsGetVerify (
3964 return CALL_BASECRYPTLIB (TlsGet
.Services
.Verify
, TlsGetVerify
, (Tls
), 0);
3968 Gets the session ID used by the specified TLS connection.
3970 This function returns the TLS/SSL session ID currently used by the
3971 specified TLS connection.
3973 @param[in] Tls Pointer to the TLS object.
3974 @param[in,out] SessionId Buffer to contain the returned session ID.
3975 @param[in,out] SessionIdLen The length of Session ID in bytes.
3977 @retval EFI_SUCCESS The Session ID was returned successfully.
3978 @retval EFI_INVALID_PARAMETER The parameter is invalid.
3979 @retval EFI_UNSUPPORTED Invalid TLS/SSL session.
3984 CryptoServiceTlsGetSessionId (
3986 IN OUT UINT8
*SessionId
,
3987 IN OUT UINT16
*SessionIdLen
3990 return CALL_BASECRYPTLIB (TlsGet
.Services
.SessionId
, TlsGetSessionId
, (Tls
, SessionId
, SessionIdLen
), EFI_UNSUPPORTED
);
3994 Gets the client random data used in the specified TLS connection.
3996 This function returns the TLS/SSL client random data currently used in
3997 the specified TLS connection.
3999 @param[in] Tls Pointer to the TLS object.
4000 @param[in,out] ClientRandom Buffer to contain the returned client
4001 random data (32 bytes).
4006 CryptoServiceTlsGetClientRandom (
4008 IN OUT UINT8
*ClientRandom
4011 CALL_VOID_BASECRYPTLIB (TlsGet
.Services
.ClientRandom
, TlsGetClientRandom
, (Tls
, ClientRandom
));
4015 Gets the server random data used in the specified TLS connection.
4017 This function returns the TLS/SSL server random data currently used in
4018 the specified TLS connection.
4020 @param[in] Tls Pointer to the TLS object.
4021 @param[in,out] ServerRandom Buffer to contain the returned server
4022 random data (32 bytes).
4027 CryptoServiceTlsGetServerRandom (
4029 IN OUT UINT8
*ServerRandom
4032 CALL_VOID_BASECRYPTLIB (TlsGet
.Services
.ServerRandom
, TlsGetServerRandom
, (Tls
, ServerRandom
));
4036 Gets the master key data used in the specified TLS connection.
4038 This function returns the TLS/SSL master key material currently used in
4039 the specified TLS connection.
4041 @param[in] Tls Pointer to the TLS object.
4042 @param[in,out] KeyMaterial Buffer to contain the returned key material.
4044 @retval EFI_SUCCESS Key material was returned successfully.
4045 @retval EFI_INVALID_PARAMETER The parameter is invalid.
4046 @retval EFI_UNSUPPORTED Invalid TLS/SSL session.
4051 CryptoServiceTlsGetKeyMaterial (
4053 IN OUT UINT8
*KeyMaterial
4056 return CALL_BASECRYPTLIB (TlsGet
.Services
.KeyMaterial
, TlsGetKeyMaterial
, (Tls
, KeyMaterial
), EFI_UNSUPPORTED
);
4060 Gets the CA Certificate from the cert store.
4062 This function returns the CA certificate for the chosen
4065 @param[in] Tls Pointer to the TLS object.
4066 @param[out] Data Pointer to the data buffer to receive the CA
4067 certificate data sent to the client.
4068 @param[in,out] DataSize The size of data buffer in bytes.
4070 @retval EFI_SUCCESS The operation succeeded.
4071 @retval EFI_UNSUPPORTED This function is not supported.
4072 @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
4077 CryptoServiceTlsGetCaCertificate (
4080 IN OUT UINTN
*DataSize
4083 return CALL_BASECRYPTLIB (TlsGet
.Services
.CaCertificate
, TlsGetCaCertificate
, (Tls
, Data
, DataSize
), EFI_UNSUPPORTED
);
4087 Gets the local public Certificate set in the specified TLS object.
4089 This function returns the local public certificate which was currently set
4090 in the specified TLS object.
4092 @param[in] Tls Pointer to the TLS object.
4093 @param[out] Data Pointer to the data buffer to receive the local
4095 @param[in,out] DataSize The size of data buffer in bytes.
4097 @retval EFI_SUCCESS The operation succeeded.
4098 @retval EFI_INVALID_PARAMETER The parameter is invalid.
4099 @retval EFI_NOT_FOUND The certificate is not found.
4100 @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
4105 CryptoServiceTlsGetHostPublicCert (
4108 IN OUT UINTN
*DataSize
4111 return CALL_BASECRYPTLIB (TlsGet
.Services
.HostPublicCert
, TlsGetHostPublicCert
, (Tls
, Data
, DataSize
), EFI_UNSUPPORTED
);
4115 Gets the local private key set in the specified TLS object.
4117 This function returns the local private key data which was currently set
4118 in the specified TLS object.
4120 @param[in] Tls Pointer to the TLS object.
4121 @param[out] Data Pointer to the data buffer to receive the local
4123 @param[in,out] DataSize The size of data buffer in bytes.
4125 @retval EFI_SUCCESS The operation succeeded.
4126 @retval EFI_UNSUPPORTED This function is not supported.
4127 @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
4132 CryptoServiceTlsGetHostPrivateKey (
4135 IN OUT UINTN
*DataSize
4138 return CALL_BASECRYPTLIB (TlsGet
.Services
.HostPrivateKey
, TlsGetHostPrivateKey
, (Tls
, Data
, DataSize
), EFI_UNSUPPORTED
);
4142 Gets the CA-supplied certificate revocation list data set in the specified
4145 This function returns the CA-supplied certificate revocation list data which
4146 was currently set in the specified TLS object.
4148 @param[out] Data Pointer to the data buffer to receive the CRL data.
4149 @param[in,out] DataSize The size of data buffer in bytes.
4151 @retval EFI_SUCCESS The operation succeeded.
4152 @retval EFI_UNSUPPORTED This function is not supported.
4153 @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
4158 CryptoServiceTlsGetCertRevocationList (
4160 IN OUT UINTN
*DataSize
4163 return CALL_BASECRYPTLIB (TlsGet
.Services
.CertRevocationList
, TlsGetCertRevocationList
, (Data
, DataSize
), EFI_UNSUPPORTED
);
4166 const EDKII_CRYPTO_PROTOCOL mEdkiiCrypto
= {
4168 CryptoServiceGetCryptoVersion
,
4169 /// HMAC MD5 - deprecated and unsupported
4170 DeprecatedCryptoServiceHmacMd5New
,
4171 DeprecatedCryptoServiceHmacMd5Free
,
4172 DeprecatedCryptoServiceHmacMd5SetKey
,
4173 DeprecatedCryptoServiceHmacMd5Duplicate
,
4174 DeprecatedCryptoServiceHmacMd5Update
,
4175 DeprecatedCryptoServiceHmacMd5Final
,
4176 /// HMAC SHA1 - deprecated and unsupported
4177 DeprecatedCryptoServiceHmacSha1New
,
4178 DeprecatedCryptoServiceHmacSha1Free
,
4179 DeprecatedCryptoServiceHmacSha1SetKey
,
4180 DeprecatedCryptoServiceHmacSha1Duplicate
,
4181 DeprecatedCryptoServiceHmacSha1Update
,
4182 DeprecatedCryptoServiceHmacSha1Final
,
4184 CryptoServiceHmacSha256New
,
4185 CryptoServiceHmacSha256Free
,
4186 CryptoServiceHmacSha256SetKey
,
4187 CryptoServiceHmacSha256Duplicate
,
4188 CryptoServiceHmacSha256Update
,
4189 CryptoServiceHmacSha256Final
,
4190 /// Md4 - deprecated and unsupported
4191 DeprecatedCryptoServiceMd4GetContextSize
,
4192 DeprecatedCryptoServiceMd4Init
,
4193 DeprecatedCryptoServiceMd4Duplicate
,
4194 DeprecatedCryptoServiceMd4Update
,
4195 DeprecatedCryptoServiceMd4Final
,
4196 DeprecatedCryptoServiceMd4HashAll
,
4198 CryptoServiceMd5GetContextSize
,
4199 CryptoServiceMd5Init
,
4200 CryptoServiceMd5Duplicate
,
4201 CryptoServiceMd5Update
,
4202 CryptoServiceMd5Final
,
4203 CryptoServiceMd5HashAll
,
4205 CryptoServicePkcs1v2Encrypt
,
4206 CryptoServicePkcs5HashPassword
,
4207 CryptoServicePkcs7Verify
,
4208 CryptoServiceVerifyEKUsInPkcs7Signature
,
4209 CryptoServicePkcs7GetSigners
,
4210 CryptoServicePkcs7FreeSigners
,
4211 CryptoServicePkcs7Sign
,
4212 CryptoServicePkcs7GetAttachedContent
,
4213 CryptoServicePkcs7GetCertificatesList
,
4214 CryptoServiceAuthenticodeVerify
,
4215 CryptoServiceImageTimestampVerify
,
4218 CryptoServiceDhFree
,
4219 CryptoServiceDhGenerateParameter
,
4220 CryptoServiceDhSetParameter
,
4221 CryptoServiceDhGenerateKey
,
4222 CryptoServiceDhComputeKey
,
4224 CryptoServiceRandomSeed
,
4225 CryptoServiceRandomBytes
,
4227 CryptoServiceRsaPkcs1Verify
,
4228 CryptoServiceRsaNew
,
4229 CryptoServiceRsaFree
,
4230 CryptoServiceRsaSetKey
,
4231 CryptoServiceRsaGetKey
,
4232 CryptoServiceRsaGenerateKey
,
4233 CryptoServiceRsaCheckKey
,
4234 CryptoServiceRsaPkcs1Sign
,
4235 CryptoServiceRsaPkcs1Verify
,
4236 CryptoServiceRsaGetPrivateKeyFromPem
,
4237 CryptoServiceRsaGetPublicKeyFromX509
,
4239 CryptoServiceSha1GetContextSize
,
4240 CryptoServiceSha1Init
,
4241 CryptoServiceSha1Duplicate
,
4242 CryptoServiceSha1Update
,
4243 CryptoServiceSha1Final
,
4244 CryptoServiceSha1HashAll
,
4246 CryptoServiceSha256GetContextSize
,
4247 CryptoServiceSha256Init
,
4248 CryptoServiceSha256Duplicate
,
4249 CryptoServiceSha256Update
,
4250 CryptoServiceSha256Final
,
4251 CryptoServiceSha256HashAll
,
4253 CryptoServiceSha384GetContextSize
,
4254 CryptoServiceSha384Init
,
4255 CryptoServiceSha384Duplicate
,
4256 CryptoServiceSha384Update
,
4257 CryptoServiceSha384Final
,
4258 CryptoServiceSha384HashAll
,
4260 CryptoServiceSha512GetContextSize
,
4261 CryptoServiceSha512Init
,
4262 CryptoServiceSha512Duplicate
,
4263 CryptoServiceSha512Update
,
4264 CryptoServiceSha512Final
,
4265 CryptoServiceSha512HashAll
,
4267 CryptoServiceX509GetSubjectName
,
4268 CryptoServiceX509GetCommonName
,
4269 CryptoServiceX509GetOrganizationName
,
4270 CryptoServiceX509VerifyCert
,
4271 CryptoServiceX509ConstructCertificate
,
4272 CryptoServiceX509ConstructCertificateStack
,
4273 CryptoServiceX509Free
,
4274 CryptoServiceX509StackFree
,
4275 CryptoServiceX509GetTBSCert
,
4276 /// TDES - deprecated and unsupported
4277 DeprecatedCryptoServiceTdesGetContextSize
,
4278 DeprecatedCryptoServiceTdesInit
,
4279 DeprecatedCryptoServiceTdesEcbEncrypt
,
4280 DeprecatedCryptoServiceTdesEcbDecrypt
,
4281 DeprecatedCryptoServiceTdesCbcEncrypt
,
4282 DeprecatedCryptoServiceTdesCbcDecrypt
,
4283 /// AES - ECB mode is deprecated and unsupported
4284 CryptoServiceAesGetContextSize
,
4285 CryptoServiceAesInit
,
4286 DeprecatedCryptoServiceAesEcbEncrypt
,
4287 DeprecatedCryptoServiceAesEcbDecrypt
,
4288 CryptoServiceAesCbcEncrypt
,
4289 CryptoServiceAesCbcDecrypt
,
4290 /// Arc4 - deprecated and unsupported
4291 DeprecatedCryptoServiceArc4GetContextSize
,
4292 DeprecatedCryptoServiceArc4Init
,
4293 DeprecatedCryptoServiceArc4Encrypt
,
4294 DeprecatedCryptoServiceArc4Decrypt
,
4295 DeprecatedCryptoServiceArc4Reset
,
4297 CryptoServiceSm3GetContextSize
,
4298 CryptoServiceSm3Init
,
4299 CryptoServiceSm3Duplicate
,
4300 CryptoServiceSm3Update
,
4301 CryptoServiceSm3Final
,
4302 CryptoServiceSm3HashAll
,
4304 CryptoServiceHkdfSha256ExtractAndExpand
,
4305 /// X509 (Continued)
4306 CryptoServiceX509ConstructCertificateStackV
,
4308 CryptoServiceTlsInitialize
,
4309 CryptoServiceTlsCtxFree
,
4310 CryptoServiceTlsCtxNew
,
4311 CryptoServiceTlsFree
,
4312 CryptoServiceTlsNew
,
4313 CryptoServiceTlsInHandshake
,
4314 CryptoServiceTlsDoHandshake
,
4315 CryptoServiceTlsHandleAlert
,
4316 CryptoServiceTlsCloseNotify
,
4317 CryptoServiceTlsCtrlTrafficOut
,
4318 CryptoServiceTlsCtrlTrafficIn
,
4319 CryptoServiceTlsRead
,
4320 CryptoServiceTlsWrite
,
4322 CryptoServiceTlsSetVersion
,
4323 CryptoServiceTlsSetConnectionEnd
,
4324 CryptoServiceTlsSetCipherList
,
4325 CryptoServiceTlsSetCompressionMethod
,
4326 CryptoServiceTlsSetVerify
,
4327 CryptoServiceTlsSetVerifyHost
,
4328 CryptoServiceTlsSetSessionId
,
4329 CryptoServiceTlsSetCaCertificate
,
4330 CryptoServiceTlsSetHostPublicCert
,
4331 CryptoServiceTlsSetHostPrivateKey
,
4332 CryptoServiceTlsSetCertRevocationList
,
4334 CryptoServiceTlsGetVersion
,
4335 CryptoServiceTlsGetConnectionEnd
,
4336 CryptoServiceTlsGetCurrentCipher
,
4337 CryptoServiceTlsGetCurrentCompressionId
,
4338 CryptoServiceTlsGetVerify
,
4339 CryptoServiceTlsGetSessionId
,
4340 CryptoServiceTlsGetClientRandom
,
4341 CryptoServiceTlsGetServerRandom
,
4342 CryptoServiceTlsGetKeyMaterial
,
4343 CryptoServiceTlsGetCaCertificate
,
4344 CryptoServiceTlsGetHostPublicCert
,
4345 CryptoServiceTlsGetHostPrivateKey
,
4346 CryptoServiceTlsGetCertRevocationList