README 8.9 KB

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