Go to file
Richard Levitte ec9f67f610 Make sure manual pages are properly linked to on systems that have case
insensitive file names, as well as those that do not have symlinks.
Incidently, both these cases apply on DOS/Windows...
2002-12-15 06:45:43 +00:00
apps Update the make system for installations: 2002-12-15 05:59:13 +00:00
bugs Make all configuration macros available for application by making 2001-02-19 16:06:34 +00:00
certs Oops: It's RegTP, not RegPT ... 2001-02-10 13:35:34 +00:00
crypto Don't define macros in terms of asm() when __STRICT_ANSI is defined. 2002-12-15 05:54:56 +00:00
demos Make 'tunala' link with zlib if possible (so it works if openssl was 2002-12-11 19:07:03 +00:00
doc BIO_new_bio_pair() was unnecessarily described in it's own page as well as in 2002-12-12 22:12:02 +00:00
engines Update the make system for installations: 2002-12-15 05:59:13 +00:00
include Add include dir 1998-12-23 07:55:37 +00:00
MacOS Constification needed. 2002-11-13 23:47:31 +00:00
ms WinCE patches 2002-11-15 22:37:18 +00:00
os2 Add support for shared libraries with OS/2. 2002-07-17 13:27:43 +00:00
perl Remove the perl/ subdirectory. It hasn't been worked on for ages, is 2002-02-28 22:07:50 +00:00
shlib Add missing '"' 2002-05-12 20:37:44 +00:00
ssl This is a first-cut at improving the callback mechanisms used in 2002-12-08 05:24:31 +00:00
test Skip DH-specific tests when no-dh has been configured. 2002-12-12 18:43:10 +00:00
times I forgot this file that Assar provided as well... 2000-08-14 14:20:52 +00:00
tools Update the make system for installations: 2002-12-15 05:59:13 +00:00
util make update 2002-12-09 02:19:27 +00:00
VMS Since we're currently assuming VMS can deal with dynamic engines, 2002-11-04 00:29:26 +00:00
.cvsignore Ignore openssl.pc. This way, there's no risk that I'll add it again :-). 2002-11-17 08:07:08 +00:00
CHANGES OK, there's at least one application author who has provided dynamic locking 2002-12-13 07:30:53 +00:00
CHANGES.SSLeay *** empty log message *** 1998-12-23 07:42:26 +00:00
config linux64-sparcv9 support finally debugged and tested. 2002-12-05 13:17:52 +00:00
Configure Solaris shared build fix-ups. See RT#238,239 for details. 2002-12-14 21:46:46 +00:00
e_os2.h WinCE patches 2002-11-15 22:37:18 +00:00
e_os.h DJGPP patches. 2002-12-04 09:54:10 +00:00
FAQ BN_sqr test failure entry. 2002-12-09 13:43:38 +00:00
INSTALL Fix wrong URI. 2002-12-09 08:49:58 +00:00
install.com There is no RSAREF any more, so do not ty to install it. 2002-06-27 09:18:45 +00:00
INSTALL.DJGPP DJGPP patches. 2002-12-04 09:54:10 +00:00
INSTALL.MacOS Typos (Chris Pepper <pepper@mail.reppep.com>) 2001-10-01 14:43:47 +00:00
INSTALL.OS2 Add support for shared libraries with OS/2. 2002-07-17 13:27:43 +00:00
INSTALL.VMS ispell 2001-09-07 06:13:40 +00:00
INSTALL.W32 WinCE patches 2002-11-15 22:37:18 +00:00
INSTALL.WCE Windows CE updates, contributed by Steven Reddie <smr@essemer.com.au> 2002-12-03 14:20:44 +00:00
LICENSE fix ssl3_pending 2002-03-15 10:52:32 +00:00
Makefile.org Make sure manual pages are properly linked to on systems that have case 2002-12-15 06:45:43 +00:00
Makefile.shared Solaris shared build fix-ups. See RT#238,239 for details. 2002-12-14 21:46:46 +00:00
makevms.com Remove all referenses to RSAref, since that's been gone for more than 2002-10-31 16:46:52 +00:00
NEWS Keep NEWS in HEAD up to date. 2002-12-06 00:39:03 +00:00
openssl.doxy Add functions to add certs to stacks, used for CA file/path stuff in servers. 1999-02-28 17:41:55 +00:00
openssl.spec Modify the main trunk version to 0.9.8-dev. 2002-02-13 17:46:38 +00:00
PROBLEMS A gcc 3.0 bug is triggered by our code. Add a section about it in PROBLEMS. 2002-12-04 08:24:18 +00:00
README test commit (just removing tailing blanks) #2 after migration 2002-12-10 12:01:39 +00:00
README.ASN1 Merge from the ASN1 branch of new ASN1 code 2000-12-08 19:09:35 +00:00
README.ENGINE oops, there were other cases of "ENGINE_ID" to change too. 2002-07-08 15:16:10 +00:00
STATUS I forgot one item I intend to work on. 2002-12-12 19:40:55 +00:00
TABLE linux64-sparcv9 support finally debugged and tested. 2002-12-05 13:17:52 +00:00

 OpenSSL 0.9.8-dev XX xxx XXXX

 Copyright (c) 1998-2002 The OpenSSL Project
 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
 All rights reserved.

 DESCRIPTION
 -----------

 The OpenSSL Project is a collaborative effort to develop a robust,
 commercial-grade, fully featured, and Open Source toolkit implementing the
 Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1)
 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
 related documentation.

 OpenSSL is based on the excellent SSLeay library developed from Eric A. Young
 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
 purposes as long as you fulfill the conditions of both licenses.

 OVERVIEW
 --------

 The OpenSSL toolkit includes:

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

 libcrypto.a:
     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:

     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,
        MDC2 message digest. A DES based hash that is popular on smart cards.

     Public Key
        RSA encryption/decryption/generation.
            There is no limit on the number of bits.
        DSA encryption/decryption/generation.
            There is no limit on the number of bits.
        Diffie-Hellman key-exchange/key generation.
            There is no limit on the number of bits.

     X.509v3 certificates
        X509 encoding/decoding into/from binary ASN1 and a PEM
             based ASCII-binary encoding which supports encryption with a
             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.

 openssl: 
     A command line tool that can be used for:
        Creation of RSA, DH and DSA key parameters
        Creation of X.509 certificates, CSRs and CRLs 
        Calculation of Message Digests
        Encryption and Decryption with Ciphers
        SSL/TLS Client and Server Tests
        Handling of S/MIME signed or encrypted mail

        
 PATENTS
 -------

 Various companies hold various patents for various algorithms in various
 locations around the world. _YOU_ are responsible for ensuring that your use
 of any algorithms is legal by checking if there are any patents in your
 country.  The file contains some of the patents that we know about or are
 rumored to exist. This is not a definitive list.

 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/.

 RC4 is a trademark of RSA Security, so use of this label should perhaps
 only be used with RSA Security's permission. 

 The IDEA algorithm is patented by Ascom in Austria, France, Germany, Italy,
 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
 http://www.ascom.ch/.

 INSTALLATION
 ------------

 To install this package under a Unix derivative, read the INSTALL file.  For
 a Win32 platform, read the INSTALL.W32 file.  For OpenVMS systems, read
 INSTALL.VMS.

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

 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.

 SUPPORT 
 -------

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

    - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
      to see if the problem has already been addressed
    - Remove ASM versions of libraries
    - Remove compiler optimisation flags 

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

    - 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)

 Report the bug to the OpenSSL project via the Request Tracker
 (http://www.openssl.org/rt2.html) by mail to:

    openssl-bugs@openssl.org

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

 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
 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.

 Note: For legal reasons, contributions from the US can be accepted only
 if a TSA notification and a copy of the patch is sent to crypt@bis.doc.gov;
 see 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)).

 The preferred format for changes is "diff -u" output. You might
 generate it like this:

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