From b86e8e7e9c4d4191d556a52fbd2c3e614ddb246e Mon Sep 17 00:00:00 2001 From: Peter Jones Date: Mon, 8 Oct 2018 13:31:30 -0400 Subject: Add CryptoPkg/Library/BaseCryptLib/ and CryptoPkg/Library/OpensslLib/ --- CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt | 53 ++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt (limited to 'CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt') diff --git a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt new file mode 100644 index 00000000..db45eb88 --- /dev/null +++ b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt @@ -0,0 +1,53 @@ + +============================================================================= + Introduction +============================================================================= + OpenSSL is a well-known open source implementation of SSL/TLS protocols. +The core library implements the cryptographic and SSL/TLS functions and +also provides various utility functions. The OpenSSL library is widely used +in variety of security products development as base crypto provider. +(See http://www.openssl.org/ for more information about OpenSSL). + UEFI (Unified Extensible Firmware Interface) is a specification detailing +the interfaces between OS and platform firmware. Several security features +were introduced (e.g. Authenticated Variable Service, Driver Signing, etc) +from UEFI 2.2 (http://www.uefi.org/). These security features highly depend +on the cryptography. + This HOWTO documents OpenSSL building under UEFI/EDKII environment. + +============================================================================= + OpenSSL-Version +============================================================================= + EDKII supports building with the latest release of OpenSSL. + NOTE: Only latest release version was fully validated. + And no guarantees on build & functionality if using other versions. + +============================================================================= + HOW to Install OpenSSL for UEFI Building +============================================================================= + OpenSSL repository was added as one submodule of EDKII project. + + The user can use the following commands to clone both main EDKII repo and +openssl submodule: + 1) Add the "--recursive" flag to the git clone command: + $ git clone --recursive https://github.com/tianocore/edk2 +or + 2) Manually initialize and update the submodules after the clone operation + on main project: + $ git clone https://github.com/tianocore/edk2 + $ git submodule update --init --recursive + + And use the following combined commands to pull the remote submodule updates +(e.g. Updating the new supported OpenSSL release tag): + $ git pull --recurse-submodules && \ + git submodule update --recursive + +============================================================================= + About process_files.pl +============================================================================= + "process_files.pl" is one Perl script which runs the OpenSSL Configure, +then processes the resulting file list into our local OpensslLib.inf and +OpensslLibCrypto.inf. + This only needs to be done once by the maintainer / developer when +updating to a new version of OpenSSL (or changing options, etc.). +Normal users do not need do this, since the results are already stored in +the EDKII git repository for them. -- cgit v1.2.3