README 7.7 KB
Newer Older
1

2
 OpenSSL 0.9.8-dev XX xxx XXXX
3

4
 Copyright (c) 1998-2005 The OpenSSL Project
5
 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
6 7
 All rights reserved.

8 9 10
 DESCRIPTION
 -----------

R
Ralf S. Engelschall 已提交
11
 The OpenSSL Project is a collaborative effort to develop a robust,
12
 commercial-grade, fully featured, and Open Source toolkit implementing the
13
 Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1)
14 15 16
 protocols as well as a full-strength general purpose cryptography library.
 The project is managed by a worldwide community of volunteers that use the
 Internet to communicate, plan, and develop the OpenSSL toolkit and its
17
 related documentation.
18

R
Ralf S. Engelschall 已提交
19
 OpenSSL is based on the excellent SSLeay library developed from Eric A. Young
20 21 22
 and Tim J. Hudson.  The OpenSSL toolkit is licensed under a dual-license (the
 OpenSSL license plus the SSLeay license) situation, which basically means
 that you are free to get and use it for commercial and non-commercial
23
 purposes as long as you fulfill the conditions of both licenses.
24

25 26 27
 OVERVIEW
 --------

28
 The OpenSSL toolkit includes:
29 30 31

 libssl.a:
     Implementation of SSLv2, SSLv3, TLSv1 and the required code to support
32
     both SSLv2, SSLv3 and TLSv1 in the one server and client.
33 34

 libcrypto.a:
35 36
     General encryption and X.509 v1/v3 stuff needed by SSL/TLS but not
     actually logically part of it. It includes routines for the following:
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

     Ciphers
        libdes - EAY's libdes DES encryption package which has been floating
                 around the net for a few years.  It includes 15
                 'modes/variations' of DES (1, 2 and 3 key versions of ecb,
                 cbc, cfb and ofb; pcbc and a more general form of cfb and
                 ofb) including desx in cbc mode, a fast crypt(3), and
                 routines to read passwords from the keyboard.
        RC4 encryption,
        RC2 encryption      - 4 different modes, ecb, cbc, cfb and ofb.
        Blowfish encryption - 4 different modes, ecb, cbc, cfb and ofb.
        IDEA encryption     - 4 different modes, ecb, cbc, cfb and ofb.

     Digests
        MD5 and MD2 message digest algorithms, fast implementations,
        SHA (SHA-0) and SHA-1 message digest algorithms,
U
Typos.  
Ulf Möller 已提交
53
        MDC2 message digest. A DES based hash that is popular on smart cards.
54 55

     Public Key
56
        RSA encryption/decryption/generation.
57
            There is no limit on the number of bits.
58
        DSA encryption/decryption/generation.
59
            There is no limit on the number of bits.
60
        Diffie-Hellman key-exchange/key generation.
61 62 63 64
            There is no limit on the number of bits.

     X.509v3 certificates
        X509 encoding/decoding into/from binary ASN1 and a PEM
U
ispell  
Ulf Möller 已提交
65
             based ASCII-binary encoding which supports encryption with a
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
             private key.  Program to generate RSA and DSA certificate
             requests and to generate RSA and DSA certificates.

     Systems
        The normal digital envelope routines and base64 encoding.  Higher
        level access to ciphers and digests by name.  New ciphers can be
        loaded at run time.  The BIO io system which is a simple non-blocking
        IO abstraction.  Current methods supported are file descriptors,
        sockets, socket accept, socket connect, memory buffer, buffering, SSL
        client/server, file pointer, encryption, digest, non-blocking testing
        and null.

     Data structures
        A dynamically growing hashing system
        A simple stack.
        A Configuration loader that uses a format similar to MS .ini files.

B
Bodo Möller 已提交
83
 openssl:
84 85
     A command line tool that can be used for:
        Creation of RSA, DH and DSA key parameters
B
Bodo Möller 已提交
86
        Creation of X.509 certificates, CSRs and CRLs
87 88 89 90 91
        Calculation of Message Digests
        Encryption and Decryption with Ciphers
        SSL/TLS Client and Server Tests
        Handling of S/MIME signed or encrypted mail

B
Bodo Möller 已提交
92

93 94 95 96
 PATENTS
 -------

 Various companies hold various patents for various algorithms in various
97
 locations around the world. _YOU_ are responsible for ensuring that your use
U
Typos.  
Ulf Möller 已提交
98
 of any algorithms is legal by checking if there are any patents in your
99
 country.  The file contains some of the patents that we know about or are
U
ispell  
Ulf Möller 已提交
100
 rumored to exist. This is not a definitive list.
101

102 103 104
 RSA Security holds software patents on the RC5 algorithm.  If you
 intend to use this cipher, you must contact RSA Security for
 licensing conditions. Their web page is http://www.rsasecurity.com/.
105

106
 RC4 is a trademark of RSA Security, so use of this label should perhaps
B
Bodo Möller 已提交
107
 only be used with RSA Security's permission.
108 109

 The IDEA algorithm is patented by Ascom in Austria, France, Germany, Italy,
110 111
 Japan, the Netherlands, Spain, Sweden, Switzerland, UK and the USA.  They
 should be contacted if that algorithm is to be used; their web page is
112 113
 http://www.ascom.ch/.

B
Bodo Möller 已提交
114 115
 The MDC2 algorithm is patented by IBM.

116 117 118
 INSTALLATION
 ------------

119
 To install this package under a Unix derivative, read the INSTALL file.  For
U
Ulf Möller 已提交
120 121
 a Win32 platform, read the INSTALL.W32 file.  For OpenVMS systems, read
 INSTALL.VMS.
122

123
 Read the documentation in the doc/ directory.  It is quite rough, but it
124 125
 lists the functions; you will probably have to look at the code to work out
 how to use them. Look at the example programs.
126

127 128 129 130 131 132 133
 PROBLEMS
 --------

 For some platforms, there are some known problems that may affect the user
 or application author.  We try to collect those in doc/PROBLEMS, with current
 thoughts on how they should be solved in a future of OpenSSL.

B
Bodo Möller 已提交
134
 SUPPORT
135 136 137 138 139
 -------

 If you have any problems with OpenSSL then please take the following steps
 first:

140 141
    - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
      to see if the problem has already been addressed
142
    - Remove ASM versions of libraries
B
Bodo Möller 已提交
143
    - Remove compiler optimisation flags
144 145 146 147

 If you wish to report a bug then please include the following information in
 any bug report:

148 149 150 151 152 153 154 155 156
    - On Unix systems:
        Self-test report generated by 'make report'
    - On other systems:
        OpenSSL version: output of 'openssl version -a'
        OS Name, Version, Hardware platform
        Compiler Details (name, version)
    - Application Details (name, version)
    - Problem Description (steps that will reproduce the problem, if known)
    - Stack Traceback (if the application dumps core)
157

158
 Report the bug to the OpenSSL project via the Request Tracker
B
Bodo Möller 已提交
159
 (http://www.openssl.org/support/rt2.html) by mail to:
160

U
Ulf Möller 已提交
161
    openssl-bugs@openssl.org
162

163 164
 Note that mail to openssl-bugs@openssl.org is recorded in the publicly
 readable request tracker database and is forwarded to a public
165
 mailing list. Confidential mail may be sent to openssl-security@openssl.org
166
 (PGP key available from the key servers).
167

U
Ulf Möller 已提交
168 169 170 171 172
 HOW TO CONTRIBUTE TO OpenSSL
 ----------------------------

 Development is coordinated on the openssl-dev mailing list (see
 http://www.openssl.org for information on subscribing). If you
173 174 175
 would like to submit a patch, send it to openssl-dev@openssl.org with
 the string "[PATCH]" in the subject. Please be sure to include a
 textual explanation of what your patch does.
U
Ulf Möller 已提交
176

177
 Note: For legal reasons, contributions from the US can be accepted only
B
Bodo Möller 已提交
178 179 180 181 182 183 184
 if a TSU notification and a copy of the patch are sent to crypt@bis.doc.gov
 (formerly BXA) with a copy to the ENC Encryption Request Coordinator;
 please take some time to look at
    http://www.bis.doc.gov/Encryption/PubAvailEncSourceCodeNofify.html [sic]
 and
    http://w3.access.gpo.gov/bis/ear/pdf/740.pdf (EAR Section 740.13(e))
 for the details. If "your encryption source code is too large to serve as
B
Bodo Möller 已提交
185
 an email attachment", they are glad to receive it by fax instead; hope you
B
Bodo Möller 已提交
186 187 188
 have a cheap long-distance plan.

 Our preferred format for changes is "diff -u" output. You might
U
Ulf Möller 已提交
189 190 191 192 193 194
 generate it like this:

 # cd openssl-work
 # [your changes]
 # ./Configure dist; make clean
 # cd ..
195
 # diff -ur openssl-orig openssl-work > mydiffs.patch
196