Skip to content

Commit

Permalink
CryptoPkg: Add basic Readme for BaseCryptLibMbedTls
Browse files Browse the repository at this point in the history
Update Readme for BaseCryptLibMbedTls.

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4177

Cc: Jiewen Yao <[email protected]>
Cc: Yi Li <[email protected]>
Cc: Xiaoyu Lu <[email protected]>
Cc: Guomin Jiang <[email protected]>
Signed-off-by: Wenxing Hou <[email protected]>
Reviewed-by: Yi Li <[email protected]>
  • Loading branch information
Wenxing-hou authored and mergify[bot] committed Oct 12, 2023
1 parent 26754b3 commit c109e4a
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions CryptoPkg/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit c109e4a

Please sign in to comment.