summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWenxing Hou <wenxing.hou@intel.com>2023-09-02 21:54:34 +0800
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2023-10-12 05:31:19 +0000
commitc109e4a2448b5ed861e6227b0b9949089f39b378 (patch)
treef197b3e5679be9f590f56ee9e726e2047270ffb9
parent26754b37075909f3eed8f5666835c2c3d6146987 (diff)
downloadedk2-c109e4a2448b5ed861e6227b0b9949089f39b378.tar.gz
edk2-c109e4a2448b5ed861e6227b0b9949089f39b378.tar.bz2
edk2-c109e4a2448b5ed861e6227b0b9949089f39b378.zip
CryptoPkg: Add basic Readme for BaseCryptLibMbedTls
Update Readme for BaseCryptLibMbedTls. REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4177 Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Yi Li <yi1.li@intel.com> Cc: Xiaoyu Lu <xiaoyu1.lu@intel.com> Cc: Guomin Jiang <guomin.jiang@intel.com> Signed-off-by: Wenxing Hou <wenxing.hou@intel.com> Reviewed-by: Yi Li <yi1.li@intel.com>
-rw-r--r--CryptoPkg/Readme.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/CryptoPkg/Readme.md b/CryptoPkg/Readme.md
index 284a16f299..5a68dfb6ab 100644
--- a/CryptoPkg/Readme.md
+++ b/CryptoPkg/Readme.md
@@ -3,7 +3,8 @@
This package provides cryptographic services that are used to implement firmware
features such as UEFI Secure Boot, Measured Boot, firmware image authentication,
and network boot. The cryptographic service implementation in this package uses
-services from the [OpenSSL](https://www.openssl.org/) project.
+services from the [OpenSSL](https://www.openssl.org/) project and
+[MbedTLS](https://www.trustedfirmware.org/projects/mbed-tls/) project.
EDK II firmware modules/libraries that requires the use of cryptographic
services can either statically link all the required services, or the EDK II
@@ -18,14 +19,19 @@ provides the smallest overall firmware overhead.
# Public Library Classes
-* **BaseCryptLib** - Provides library functions for cryptographic primitives.
-* **TlsLib** - Provides TLS library functions for EFI TLS protocol.
-* **HashApiLib** - Provides Unified API for different hash implementations.
+* **BaseCryptLib** - Provides library functions based on OpenSSL for
+ cryptographic primitives.
+* **BaseCryptLibMbedTls** - Provides library functions based on MbedTLS for
+ cryptographic primitives.
+* **TlsLib** - Provides TLS library functions for EFI TLS protocol.
+* **HashApiLib** - Provides Unified API for different hash implementations.
# Private Library Classes
* **OpensslLib** - Provides library functions from the openssl project.
-* **IntrinsicLib** - Provides C runtime library (CRT) required by openssl.
+* **MbedTlsLib** - Provides library functions from the mbedtls project.
+* **IntrinsicLib** - Provides C runtime library (CRT) required by openssl
+ and mbedtls.
# Private Protocols and PPIs