summaryrefslogtreecommitdiff
path: root/CryptoPkg/Library
diff options
context:
space:
mode:
authorQin Long <qin.long@intel.com>2017-03-23 20:06:00 +0800
committerQin Long <qin.long@intel.com>2017-03-29 16:10:58 +0800
commitd2cd3b683055a69670b975e3de4513d4344b7508 (patch)
tree22656564a68682f584c65916157adedc03f7585e /CryptoPkg/Library
parentda9676f89cc4b0e5ab5b89b5f92b0dc86bcf347e (diff)
downloadedk2-platforms-d2cd3b683055a69670b975e3de4513d4344b7508.tar.xz
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 <ting.ye@intel.com> Cc: Laszlo Ersek <lersek@redhat.com> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org> Cc: Gary Lin <glin@suse.com> Cc: Ronald Cron <ronald.cron@arm.com> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: David Woodhouse <dwmw2@infradead.org> Signed-off-by: Qin Long <qin.long@intel.com> Reviewed-by: Ting Ye <ting.ye@intel.com> Acked-by: Laszlo Ersek <lersek@redhat.com> Tested-by: Laszlo Ersek <lersek@redhat.com> Acked-by: Gary Lin <glin@suse.com> Tested-by: Gary Lin <glin@suse.com>
Diffstat (limited to 'CryptoPkg/Library')
-rw-r--r--CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt53
-rw-r--r--CryptoPkg/Library/OpensslLib/buildinf.h2
2 files changed, 54 insertions, 1 deletions
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"