third_party/apache-win32/OPENSSL-README.txt

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