OPENSSL-README.txt 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  1. Apache HTTP Server 2.4 Limited OpenSSL Distribution
  2. This binary installation of OpenSSL is a limited distribution of the
  3. files derived from the OpenSSL project:
  4. LICENSE.txt (includes openssl LICENSE)
  5. OPENSSL-NEWS.txt
  6. OPENSSL-README.txt
  7. conf\openssl.cnf
  8. bin\libeay32.dll
  9. bin\ssleay32.dll
  10. bin\openssl.exe
  11. These are the minimal libraries and tools required to use mod_ssl as
  12. distributed with Apache HTTP Server version 2.4. No library link files,
  13. headers or sources are distributed with this binary distribution. Please
  14. refer to the <http://www.openssl.org/> site for complete source or binary
  15. distributions.
  16. These OpenSSL binaries were built for distribution from the U.S. without
  17. support for the patented encryption methods IDEA, MDC-2 or RC5.
  18. The Apache HTTP Project only supports the binary distribution of these files
  19. and development of the mod_ssl module. We cannot provide support assistance
  20. for using or configuring the OpenSSL package or these modules. Please refer
  21. all installation and configuration questions to the appropriate forum,
  22. such as the user supported lists, <http://httpd.apache.org/userslist.html>
  23. the Apache HTTP Server user's list or <http://www.openssl.org/support/> the
  24. OpenSSL support page.
  25. --------------------------------------------------------------------------------
  26. OpenSSL 1.0.1h 5 Jun 2014
  27. Copyright (c) 1998-2011 The OpenSSL Project
  28. Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
  29. All rights reserved.
  30. DESCRIPTION
  31. -----------
  32. The OpenSSL Project is a collaborative effort to develop a robust,
  33. commercial-grade, fully featured, and Open Source toolkit implementing the
  34. Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1)
  35. protocols as well as a full-strength general purpose cryptography library.
  36. The project is managed by a worldwide community of volunteers that use the
  37. Internet to communicate, plan, and develop the OpenSSL toolkit and its
  38. related documentation.
  39. OpenSSL is based on the excellent SSLeay library developed from Eric A. Young
  40. and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the
  41. OpenSSL license plus the SSLeay license) situation, which basically means
  42. that you are free to get and use it for commercial and non-commercial
  43. purposes as long as you fulfill the conditions of both licenses.
  44. OVERVIEW
  45. --------
  46. The OpenSSL toolkit includes:
  47. libssl.a:
  48. Implementation of SSLv2, SSLv3, TLSv1 and the required code to support
  49. both SSLv2, SSLv3 and TLSv1 in the one server and client.
  50. libcrypto.a:
  51. General encryption and X.509 v1/v3 stuff needed by SSL/TLS but not
  52. actually logically part of it. It includes routines for the following:
  53. Ciphers
  54. libdes - EAY's libdes DES encryption package which was floating
  55. around the net for a few years, and was then relicensed by
  56. him as part of SSLeay. It includes 15 'modes/variations'
  57. of DES (1, 2 and 3 key versions of ecb, cbc, cfb and ofb;
  58. pcbc and a more general form of cfb and ofb) including desx
  59. in cbc mode, a fast crypt(3), and routines to read
  60. passwords from the keyboard.
  61. RC4 encryption,
  62. RC2 encryption - 4 different modes, ecb, cbc, cfb and ofb.
  63. Blowfish encryption - 4 different modes, ecb, cbc, cfb and ofb.
  64. IDEA encryption - 4 different modes, ecb, cbc, cfb and ofb.
  65. Digests
  66. MD5 and MD2 message digest algorithms, fast implementations,
  67. SHA (SHA-0) and SHA-1 message digest algorithms,
  68. MDC2 message digest. A DES based hash that is popular on smart cards.
  69. Public Key
  70. RSA encryption/decryption/generation.
  71. There is no limit on the number of bits.
  72. DSA encryption/decryption/generation.
  73. There is no limit on the number of bits.
  74. Diffie-Hellman key-exchange/key generation.
  75. There is no limit on the number of bits.
  76. X.509v3 certificates
  77. X509 encoding/decoding into/from binary ASN1 and a PEM
  78. based ASCII-binary encoding which supports encryption with a
  79. private key. Program to generate RSA and DSA certificate
  80. requests and to generate RSA and DSA certificates.
  81. Systems
  82. The normal digital envelope routines and base64 encoding. Higher
  83. level access to ciphers and digests by name. New ciphers can be
  84. loaded at run time. The BIO io system which is a simple non-blocking
  85. IO abstraction. Current methods supported are file descriptors,
  86. sockets, socket accept, socket connect, memory buffer, buffering, SSL
  87. client/server, file pointer, encryption, digest, non-blocking testing
  88. and null.
  89. Data structures
  90. A dynamically growing hashing system
  91. A simple stack.
  92. A Configuration loader that uses a format similar to MS .ini files.
  93. openssl:
  94. A command line tool that can be used for:
  95. Creation of RSA, DH and DSA key parameters
  96. Creation of X.509 certificates, CSRs and CRLs
  97. Calculation of Message Digests
  98. Encryption and Decryption with Ciphers
  99. SSL/TLS Client and Server Tests
  100. Handling of S/MIME signed or encrypted mail
  101. PATENTS
  102. -------
  103. Various companies hold various patents for various algorithms in various
  104. locations around the world. _YOU_ are responsible for ensuring that your use
  105. of any algorithms is legal by checking if there are any patents in your
  106. country. The file contains some of the patents that we know about or are
  107. rumored to exist. This is not a definitive list.
  108. RSA Security holds software patents on the RC5 algorithm. If you
  109. intend to use this cipher, you must contact RSA Security for
  110. licensing conditions. Their web page is http://www.rsasecurity.com/.
  111. RC4 is a trademark of RSA Security, so use of this label should perhaps
  112. only be used with RSA Security's permission.
  113. The IDEA algorithm is patented by Ascom in Austria, France, Germany, Italy,
  114. Japan, the Netherlands, Spain, Sweden, Switzerland, UK and the USA. They
  115. should be contacted if that algorithm is to be used; their web page is
  116. http://www.ascom.ch/.
  117. NTT and Mitsubishi have patents and pending patents on the Camellia
  118. algorithm, but allow use at no charge without requiring an explicit
  119. licensing agreement: http://info.isl.ntt.co.jp/crypt/eng/info/chiteki.html
  120. INSTALLATION
  121. ------------
  122. To install this package under a Unix derivative, read the INSTALL file. For
  123. a Win32 platform, read the INSTALL.W32 file. For OpenVMS systems, read
  124. INSTALL.VMS.
  125. Read the documentation in the doc/ directory. It is quite rough, but it
  126. lists the functions; you will probably have to look at the code to work out
  127. how to use them. Look at the example programs.
  128. PROBLEMS
  129. --------
  130. For some platforms, there are some known problems that may affect the user
  131. or application author. We try to collect those in doc/PROBLEMS, with current
  132. thoughts on how they should be solved in a future of OpenSSL.
  133. SUPPORT
  134. -------
  135. See the OpenSSL website www.openssl.org for details of how to obtain
  136. commercial technical support.
  137. If you have any problems with OpenSSL then please take the following steps
  138. first:
  139. - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
  140. to see if the problem has already been addressed
  141. - Remove ASM versions of libraries
  142. - Remove compiler optimisation flags
  143. If you wish to report a bug then please include the following information in
  144. any bug report:
  145. - On Unix systems:
  146. Self-test report generated by 'make report'
  147. - On other systems:
  148. OpenSSL version: output of 'openssl version -a'
  149. OS Name, Version, Hardware platform
  150. Compiler Details (name, version)
  151. - Application Details (name, version)
  152. - Problem Description (steps that will reproduce the problem, if known)
  153. - Stack Traceback (if the application dumps core)
  154. Report the bug to the OpenSSL project via the Request Tracker
  155. (http://www.openssl.org/support/rt.html) by mail to:
  156. openssl-bugs@openssl.org
  157. Note that the request tracker should NOT be used for general assistance
  158. or support queries. Just because something doesn't work the way you expect
  159. does not mean it is necessarily a bug in OpenSSL.
  160. Note that mail to openssl-bugs@openssl.org is recorded in the publicly
  161. readable request tracker database and is forwarded to a public
  162. mailing list. Confidential mail may be sent to openssl-security@openssl.org
  163. (PGP key available from the key servers).
  164. HOW TO CONTRIBUTE TO OpenSSL
  165. ----------------------------
  166. Development is coordinated on the openssl-dev mailing list (see
  167. http://www.openssl.org for information on subscribing). If you
  168. would like to submit a patch, send it to openssl-bugs@openssl.org with
  169. the string "[PATCH]" in the subject. Please be sure to include a
  170. textual explanation of what your patch does.
  171. If you are unsure as to whether a feature will be useful for the general
  172. OpenSSL community please discuss it on the openssl-dev mailing list first.
  173. Someone may be already working on the same thing or there may be a good
  174. reason as to why that feature isn't implemented.
  175. Patches should be as up to date as possible, preferably relative to the
  176. current Git or the last snapshot. They should follow the coding style of
  177. OpenSSL and compile without warnings. Some of the core team developer targets
  178. can be used for testing purposes, (debug-steve64, debug-geoff etc). OpenSSL
  179. compiles on many varied platforms: try to ensure you only use portable
  180. features.
  181. Note: For legal reasons, contributions from the US can be accepted only
  182. if a TSU notification and a copy of the patch are sent to crypt@bis.doc.gov
  183. (formerly BXA) with a copy to the ENC Encryption Request Coordinator;
  184. please take some time to look at
  185. http://www.bis.doc.gov/Encryption/PubAvailEncSourceCodeNofify.html [sic]
  186. and
  187. http://w3.access.gpo.gov/bis/ear/pdf/740.pdf (EAR Section 740.13(e))
  188. for the details. If "your encryption source code is too large to serve as
  189. an email attachment", they are glad to receive it by fax instead; hope you
  190. have a cheap long-distance plan.
  191. Our preferred format for changes is "diff -u" output. You might
  192. generate it like this:
  193. # cd openssl-work
  194. # [your changes]
  195. # ./Configure dist; make clean
  196. # cd ..
  197. # diff -ur openssl-orig openssl-work > mydiffs.patch
  198.