Go to file
Andy Polyakov 1e8f69c6a5 modes/modes_lcl.h: make it indent-friendly.
Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-01-22 09:20:08 +00:00
apps indent has problems with comments that are on the right hand side of a line. 2015-01-22 09:20:08 +00:00
bugs More comments 2015-01-22 09:20:06 +00:00
certs grammar 2008-05-27 18:43:20 +00:00
crypto modes/modes_lcl.h: make it indent-friendly. 2015-01-22 09:20:08 +00:00
demos indent has problems with comments that are on the right hand side of a line. 2015-01-22 09:20:08 +00:00
doc Some cleanup of L<> markup in pod files 2015-01-06 12:16:24 -05:00
engines engines/e_ubsec.c: make it indent-friendly. 2015-01-22 09:20:07 +00:00
ms indent has problems with comments that are on the right hand side of a line. 2015-01-22 09:20:08 +00:00
Netware Remove SSLv2 support 2014-12-04 11:55:03 +01:00
os2 Make a number of changes to the OS/2 build. Submitter's comment below. 2003-11-28 14:51:30 +00:00
shlib Apply mingw patches as supplied by Roumen Petrov an Alon Bar-Lev 2008-04-17 10:19:16 +00:00
ssl indent has problems with comments that are on the right hand side of a line. 2015-01-22 09:20:08 +00:00
test RT478: Add uninstall make target 2015-01-12 10:28:05 -05:00
times Updates from 1.0.0-stable branch. 2009-04-20 11:33:12 +00:00
tools RT478: Add uninstall make target 2015-01-12 10:28:05 -05:00
util Fix logic to check for indent.pro 2015-01-22 09:20:07 +00:00
VMS Teach mkshared.com to have a look for disabled algorithms in opensslconf.h 2011-10-30 11:40:54 +00:00
.gitignore Further windows specific .gitignore entries 2015-01-09 23:39:54 +00:00
ACKNOWLEDGMENTS Add new sponsors 2014-04-24 12:33:03 +01:00
CHANGES Cleanup OPENSSL_NO_xxx, part 1 2015-01-14 15:57:28 -05:00
CHANGES.SSLeay misspellings fixes by https://github.com/vlajos/misspell_fixer 2013-09-05 21:39:42 +01:00
config RT3548: Remove some unsupported platforms. 2015-01-12 10:40:00 -05:00
Configure RT3548: Remove some unsupported platforms. 2015-01-12 10:40:00 -05:00
e_os2.h RT3548: Remove some unsupported platforms. 2015-01-12 10:40:00 -05:00
e_os.h Cleanup OPENSSL_NO_xxx, part 1 2015-01-14 15:57:28 -05:00
FAQ New location on website for binaries. 2014-12-03 10:55:31 -05:00
GitConfigure Build on MacOS. 2014-02-09 12:49:04 +00:00
GitMake Build on MacOS. 2014-02-09 12:49:04 +00:00
INSTALL misspellings fixes by https://github.com/vlajos/misspell_fixer 2013-09-05 21:39:42 +01:00
install.com After some adjustments, apply the changes OpenSSL 1.0.0d on OpenVMS 2011-03-19 10:58:14 +00:00
INSTALL.DJGPP INSTALL.DJGPP sync. 2005-01-14 16:25:36 +00:00
INSTALL.NW misspellings fixes by https://github.com/vlajos/misspell_fixer 2013-09-05 21:39:42 +01:00
INSTALL.OS2 Add support for shared libraries with OS/2. 2002-07-17 13:27:43 +00:00
INSTALL.VMS Remove SSLv2 support 2014-12-04 11:55:03 +01:00
INSTALL.W32 FAQ/README: we are now using Git instead of CVS 2013-02-11 11:33:29 +01:00
INSTALL.W64 Pull up Win64 support from 0.9.8. 2005-07-05 11:44:45 +00:00
INSTALL.WCE First draft for WCE PortSDK support. Once again! It's *draft* which requires 2005-11-06 20:52:26 +00:00
LICENSE OCSP stapling fix (OpenSSL 0.9.8r/1.0.0d) 2011-02-08 17:48:57 +00:00
Makefile.org RT478: Add uninstall make target 2015-01-12 10:28:05 -05:00
Makefile.shared RT3548: Remove some unsupported platforms. 2015-01-12 10:40:00 -05:00
makevms.com Remove SSLv2 support 2014-12-04 11:55:03 +01:00
NEWS Updates to NEWS file 2014-10-15 08:56:16 -04: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 Simplify and update openssl.spec 2013-11-30 14:11:05 +00:00
PROBLEMS ./Configure: libcrypto.a can grow to many GB because of ar bug. 2012-08-13 16:10:08 +00:00
README RT2196: Clear up some README wording 2014-09-09 17:48:27 -04:00
README.ASN1 Merge from the ASN1 branch of new ASN1 code 2000-12-08 19:09:35 +00:00
README.ECC Add NSA sublicense info. 2011-05-11 12:50:57 +00:00
README.ENGINE oops, there were other cases of "ENGINE_ID" to change too. 2002-07-08 15:16:10 +00:00
README.FIPS Build fipscanister.o only by default. Utility build now needs 2011-10-19 11:47:21 +00:00
TABLE RT3548: Remove some unsupported platforms. 2015-01-12 10:40:00 -05:00

 OpenSSL 1.1.0-dev

 Copyright (c) 1998-2011 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 was floating
                 around the net for a few years, and was then relicensed by
                 him as part of SSLeay.  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

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

 See the OpenSSL website www.openssl.org for details of how to obtain
 commercial technical 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)

 Email the report to:

    openssl-bugs@openssl.org

 Note that the request tracker should NOT be used for general assistance
 or support queries. Just because something doesn't work the way you expect
 does not mean it is necessarily a bug in OpenSSL.

 Note that mail to openssl-bugs@openssl.org is recorded in the public
 request tracker database (see https://www.openssl.org/support/rt.html
 for details) and also 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-bugs@openssl.org with
 the string "[PATCH]" in the subject. Please be sure to include a
 textual explanation of what your patch does.

 If you are unsure as to whether a feature will be useful for the general
 OpenSSL community please discuss it on the openssl-dev mailing list first.
 Someone may be already working on the same thing or there may be a good
 reason as to why that feature isn't implemented.

 Patches should be as up to date as possible, preferably relative to the
 current Git or the last snapshot. They should follow the coding style of
 OpenSSL and compile without warnings. Some of the core team developer targets
 can be used for testing purposes, (debug-steve64, debug-geoff etc). OpenSSL
 compiles on many varied platforms: try to ensure you only use portable
 features.

 Note: For legal reasons, contributions from the US can be accepted only
 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
 an email attachment", they are glad to receive it by fax instead; hope you
 have a cheap long-distance plan.

 Our 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