From d2cd3b683055a69670b975e3de4513d4344b7508 Mon Sep 17 00:00:00 2001 From: Qin Long Date: Thu, 23 Mar 2017 20:06:00 +0800 Subject: [PATCH] CryptoPkg/OpensslLib: Add new OpenSSL-HOWTO document. Add one new OpenSSL-HOWTO.txt to introduce how to clone / download the latest OpenSSL release source for build. ALso update buildinf.h to reflect the latest update time. Cc: Ting Ye Cc: Laszlo Ersek Cc: Ard Biesheuvel Cc: Gary Lin Cc: Ronald Cron Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: David Woodhouse Signed-off-by: Qin Long Reviewed-by: Ting Ye Acked-by: Laszlo Ersek Tested-by: Laszlo Ersek Acked-by: Gary Lin Tested-by: Gary Lin --- .../Library/OpensslLib/OpenSSL-HOWTO.txt | 53 +++++++++++++++++++ CryptoPkg/Library/OpensslLib/buildinf.h | 2 +- 2 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 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 0000000000..e8b0bab010 --- /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. + The latest official release is OpenSSL-1.1.0e (Released at 2017-Feb-16). + 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 +============================================================================= +1. Clone the latest official OpenSSL release into the directory + CryptoPkg/Library/OpensslLib/openssl/ + + Use OpenSSL-1.1.0e release as one example: + (OpenSSL_1_1_0e below is the tag name for the OpenSSL-1.1.0e release) + > cd CryptoPkg/Library/OpensslLib + > git clone -b OpenSSL_1_1_0e https://github.com/openssl/openssl openssl + or + > git clone https://github.com/openssl/openssl openssl + > git checkout OpenSSL_1_1_0e +Or +2. Download the latest OpenSSL release package from the official website: + https://www.openssl.org/source/ + and unpack the OpenSSL source into: + CryptoPkg/Library/OpensslLib/openssl/ + +============================================================================= + 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. diff --git a/CryptoPkg/Library/OpensslLib/buildinf.h b/CryptoPkg/Library/OpensslLib/buildinf.h index 673bf787c1..3d967d2a86 100644 --- a/CryptoPkg/Library/OpensslLib/buildinf.h +++ b/CryptoPkg/Library/OpensslLib/buildinf.h @@ -1,2 +1,2 @@ #define PLATFORM "UEFI" -#define DATE "Mon Mar 8 14:17:05 PDT 2010" +#define DATE "Tues Mar 21 01:23:45 PDT 2017" -- 2.39.2