2 OpenSSL 0.9.8f-fips-dev test version
4 Copyright (c) 1998-2007 The OpenSSL Project
5 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
11 This version of OpenSSL is an initial port of the FIPS 140-2 code to OpenSSL
12 0.9.8. See the file README.FIPS for brief usage details.
17 The OpenSSL Project is a collaborative effort to develop a robust,
18 commercial-grade, fully featured, and Open Source toolkit implementing the
19 Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1)
20 protocols as well as a full-strength general purpose cryptography library.
21 The project is managed by a worldwide community of volunteers that use the
22 Internet to communicate, plan, and develop the OpenSSL toolkit and its
23 related documentation.
25 OpenSSL is based on the excellent SSLeay library developed from Eric A. Young
26 and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the
27 OpenSSL license plus the SSLeay license) situation, which basically means
28 that you are free to get and use it for commercial and non-commercial
29 purposes as long as you fulfill the conditions of both licenses.
34 The OpenSSL toolkit includes:
37 Implementation of SSLv2, SSLv3, TLSv1 and the required code to support
38 both SSLv2, SSLv3 and TLSv1 in the one server and client.
41 General encryption and X.509 v1/v3 stuff needed by SSL/TLS but not
42 actually logically part of it. It includes routines for the following:
45 libdes - EAY's libdes DES encryption package which was floating
46 around the net for a few years, and was then relicensed by
47 him as part of SSLeay. It includes 15 'modes/variations'
48 of DES (1, 2 and 3 key versions of ecb, cbc, cfb and ofb;
49 pcbc and a more general form of cfb and ofb) including desx
50 in cbc mode, a fast crypt(3), and routines to read
51 passwords from the keyboard.
53 RC2 encryption - 4 different modes, ecb, cbc, cfb and ofb.
54 Blowfish encryption - 4 different modes, ecb, cbc, cfb and ofb.
55 IDEA encryption - 4 different modes, ecb, cbc, cfb and ofb.
58 MD5 and MD2 message digest algorithms, fast implementations,
59 SHA (SHA-0) and SHA-1 message digest algorithms,
60 MDC2 message digest. A DES based hash that is popular on smart cards.
63 RSA encryption/decryption/generation.
64 There is no limit on the number of bits.
65 DSA encryption/decryption/generation.
66 There is no limit on the number of bits.
67 Diffie-Hellman key-exchange/key generation.
68 There is no limit on the number of bits.
71 X509 encoding/decoding into/from binary ASN1 and a PEM
72 based ASCII-binary encoding which supports encryption with a
73 private key. Program to generate RSA and DSA certificate
74 requests and to generate RSA and DSA certificates.
77 The normal digital envelope routines and base64 encoding. Higher
78 level access to ciphers and digests by name. New ciphers can be
79 loaded at run time. The BIO io system which is a simple non-blocking
80 IO abstraction. Current methods supported are file descriptors,
81 sockets, socket accept, socket connect, memory buffer, buffering, SSL
82 client/server, file pointer, encryption, digest, non-blocking testing
86 A dynamically growing hashing system
88 A Configuration loader that uses a format similar to MS .ini files.
91 A command line tool that can be used for:
92 Creation of RSA, DH and DSA key parameters
93 Creation of X.509 certificates, CSRs and CRLs
94 Calculation of Message Digests
95 Encryption and Decryption with Ciphers
96 SSL/TLS Client and Server Tests
97 Handling of S/MIME signed or encrypted mail
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.
109 RSA Security holds software patents on the RC5 algorithm. If you
110 intend to use this cipher, you must contact RSA Security for
111 licensing conditions. Their web page is http://www.rsasecurity.com/.
113 RC4 is a trademark of RSA Security, so use of this label should perhaps
114 only be used with RSA Security's permission.
116 The IDEA algorithm is patented by Ascom in Austria, France, Germany, Italy,
117 Japan, the Netherlands, Spain, Sweden, Switzerland, UK and the USA. They
118 should be contacted if that algorithm is to be used; their web page is
119 http://www.ascom.ch/.
121 The MDC2 algorithm is patented by IBM.
123 NTT and Mitsubishi have patents and pending patents on the Camellia
124 algorithm, but allow use at no charge without requiring an explicit
125 licensing agreement: http://info.isl.ntt.co.jp/crypt/eng/info/chiteki.html
130 To install this package under a Unix derivative, read the INSTALL file. For
131 a Win32 platform, read the INSTALL.W32 file. For OpenVMS systems, read
134 Read the documentation in the doc/ directory. It is quite rough, but it
135 lists the functions; you will probably have to look at the code to work out
136 how to use them. Look at the example programs.
141 For some platforms, there are some known problems that may affect the user
142 or application author. We try to collect those in doc/PROBLEMS, with current
143 thoughts on how they should be solved in a future of OpenSSL.
148 If you have any problems with OpenSSL then please take the following steps
151 - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
152 to see if the problem has already been addressed
153 - Remove ASM versions of libraries
154 - Remove compiler optimisation flags
156 If you wish to report a bug then please include the following information in
160 Self-test report generated by 'make report'
162 OpenSSL version: output of 'openssl version -a'
163 OS Name, Version, Hardware platform
164 Compiler Details (name, version)
165 - Application Details (name, version)
166 - Problem Description (steps that will reproduce the problem, if known)
167 - Stack Traceback (if the application dumps core)
169 Report the bug to the OpenSSL project via the Request Tracker
170 (http://www.openssl.org/support/rt2.html) by mail to:
172 openssl-bugs@openssl.org
174 Note that mail to openssl-bugs@openssl.org is recorded in the publicly
175 readable request tracker database and is forwarded to a public
176 mailing list. Confidential mail may be sent to openssl-security@openssl.org
177 (PGP key available from the key servers).
179 HOW TO CONTRIBUTE TO OpenSSL
180 ----------------------------
182 Development is coordinated on the openssl-dev mailing list (see
183 http://www.openssl.org for information on subscribing). If you
184 would like to submit a patch, send it to openssl-dev@openssl.org with
185 the string "[PATCH]" in the subject. Please be sure to include a
186 textual explanation of what your patch does.
188 Note: For legal reasons, contributions from the US can be accepted only
189 if a TSU notification and a copy of the patch are sent to crypt@bis.doc.gov
190 (formerly BXA) with a copy to the ENC Encryption Request Coordinator;
191 please take some time to look at
192 http://www.bis.doc.gov/Encryption/PubAvailEncSourceCodeNofify.html [sic]
194 http://w3.access.gpo.gov/bis/ear/pdf/740.pdf (EAR Section 740.13(e))
195 for the details. If "your encryption source code is too large to serve as
196 an email attachment", they are glad to receive it by fax instead; hope you
197 have a cheap long-distance plan.
199 Our preferred format for changes is "diff -u" output. You might
200 generate it like this:
204 # ./Configure dist; make clean
206 # diff -ur openssl-orig openssl-work > mydiffs.patch