Add CryptoPkg (from UDK2010.UP3)

[mirror_edk2.git] / CryptoPkg / Library / OpensslLib / Patch-HOWTO.txt

diff --git a/CryptoPkg/Library/OpensslLib/Patch-HOWTO.txt b/CryptoPkg/Library/OpensslLib/Patch-HOWTO.txt
new file mode 100644 (file)
index 0000000..c35f88d
--- /dev/null
+++ b/CryptoPkg/Library/OpensslLib/Patch-HOWTO.txt
@@ -0,0 +1,61 @@
+\r
+================================================================================\r
+                                 Introduction\r
+================================================================================\r
+  OpenSSL is a well-known open source implementation of SSL and TLS protocols.\r
+The core library implements the basic cryptographic functions and provides various\r
+utility functions. The OpenSSL library is widely used in variety of security \r
+products development as base crypto provider. (See http://www.openssl.org for more \r
+information for OpenSSL).\r
+  UEFI (Unified Extensible Firmware Interface) is a specification detailing the \r
+interfaces between OS and platform firmware. Several security features were \r
+introduced (e.g. Authenticated Variable Service, Driver Signing, etc) from UEFI \r
+2.2 (http://www.uefi.org). These security features highly depends on the \r
+cryptography. This patch will enable openssl building under UEFI environment.\r
+\r
+\r
+================================================================================\r
+                                OpenSSL-Version\r
+================================================================================\r
+  Current supported OpenSSL version for UEFI Crypto Library is 0.9.8l.\r
+    http://www.openssl.org/source/openssl-0.9.8l.tar.gz\r
+\r
+\r
+================================================================================\r
+                      HOW to Install Openssl for UEFI Building\r
+================================================================================\r
+1.  Download OpenSSL 0.9.8l from official website:\r
+       http://www.openssl.org/source/openssl-0.9.8l.tar.gz\r
+\r
+    NOTE: Some web browsers may rename the downloaded TAR file to openssl-0.9.8l.tar.tar.\r
+          When you do the download, rename the "openssl-0.9.8l.tar.tar" to\r
+          "openssl-0.9.8l.tar.gz" or rename the local downloaded file with ".tar.tar"\r
+          extension to ".tar.gz".\r
+\r
+2.  Extract TAR into CryptoPkg/Library/OpenSslLib/openssl-0.9.8l\r
+\r
+    NOTE: If you use WinZip to unpack the openssl source in Windows, please \r
+          uncheck the WinZip smart CR/LF conversion option (WINZIP: Options --> \r
+          Configuration --> Miscellaneous --> "TAR file smart CR/LF conversion").\r
+  \r
+3.  Apply this patch: EDKII_openssl-0.9.8l.patch, and make installation\r
+\r
+    For Windows Environment:\r
+    ------------------------\r
+    1) Make sure the patch utility has been installed in your machine.\r
+       Install Cygwin or get the patch utility binary from \r
+          http://gnuwin32.sourceforge.net/packages/patch.htm\r
+    2) cd $(WORKSPACE)\CryptoPkg\Library\OpensslLib\openssl-0.9.8l\r
+    3) patch -p0 -i ..\EDKII_openssl-0.9.8l.patch\r
+    4) cd ..\r
+    5) install.cmd\r
+\r
+    For Linux* Environment:\r
+    -----------------------\r
+    1) Make sure the patch utility has been installed in your machine.\r
+       Patch utility is available from http://directory.fsf.org/project/patch/\r
+    2) cd $(WORKSPACE)/CryptoPkg/Library/OpensslLib/openssl-0.9.8l\r
+    3) patch -p0 -i ../EDKII_openssl-0.9.8l.patch\r
+    4) cd ..\r
+    5) ./install.sh\r
+\r