Go to file
Matt Caswell f3b9257f82 Minor documentation tweak
Update the return type for SSL_state in the documentation.

Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-10-30 08:39:46 +00:00
apps Remove a call to SSL_set_state from s_server 2015-10-30 08:38:18 +00:00
certs
Configurations Configurations: move -Wno-pedantic-ms-format to .travis.yml. 2015-10-12 12:07:29 +02:00
crypto Reorganise state machine files 2015-10-30 08:38:18 +00:00
demos Move crypto/threads to demo/threads 2015-10-26 16:36:01 -04:00
doc Minor documentation tweak 2015-10-30 08:39:46 +00:00
engines Remove Obsolete engines 2015-10-15 17:02:06 +01:00
include Move PACKET creation into the state machine 2015-10-30 08:38:18 +00:00
ms Fix various windows compilation issues 2015-01-28 22:55:15 +00:00
Netware Remove SSLv2 support 2014-12-04 11:55:03 +01:00
os2
ssl Fix a comment 2015-10-30 08:38:18 +00:00
test Reorganise state machine files 2015-10-30 08:38:18 +00:00
tools Unwriteable directories are errors 2015-09-10 16:13:55 -04:00
util make update 2015-10-30 08:38:18 +00:00
VMS
.gitignore Rationalize .gitignore and harmonize pair of Makefiles. 2015-09-29 18:02:35 +02:00
.travis.yml Run tests on Travis for mingw builds as well 2015-10-16 11:20:22 -04:00
ACKNOWLEDGEMENTS Cleanup some doc files 2015-03-01 20:46:38 -05:00
CHANGES Update CHANGES 2015-10-30 08:39:46 +00:00
config Remove remaining Kerberos references 2015-05-13 15:08:10 +01:00
Configure Make Configure die when unsupported options are given 2015-10-22 17:37:10 +02:00
CONTRIBUTING Move contributing info to CONTRIBUTING 2015-10-17 18:28:03 +05:30
e_os.h Explicitly cast INVALID_SOCKET to (int) to address warnings on Windows. 2015-10-05 09:22:54 +02:00
FAQ Move FAQ to the web. 2015-08-16 19:02:29 -04:00
GitConfigure Remove remaining variables for symlinked/copied headers and tests 2015-03-31 20:16:01 +02:00
GitMake Build on MacOS. 2014-02-09 12:49:04 +00:00
INSTALL Extend the notes on how to do testing 2015-09-15 15:26:32 +02:00
install.com
INSTALL.DJGPP
INSTALL.NW misspellings fixes by https://github.com/vlajos/misspell_fixer 2013-09-05 21:39:42 +01:00
INSTALL.OS2
INSTALL.VMS Add a few notes on perl 2015-09-15 13:14:49 +02:00
INSTALL.W32
INSTALL.W64
INSTALL.WCE
LICENSE
Makefile.org Handle CT error macros separately 2015-10-21 23:57:29 +02:00
Makefile.shared RT3548: Remove some unsupported platforms. 2015-01-12 10:40:00 -05:00
makevms.com RT3992: Make SCT #ifdeffable. 2015-09-09 18:28:13 -04:00
NEWS Update CHANGES and NEWS for the new release 2015-07-09 09:30:46 +01:00
openssl.doxy
openssl.spec Simplify and update openssl.spec 2013-11-30 14:11:05 +00:00
PROBLEMS Fixing typo in PROBLEMS 2015-09-27 20:50:40 -04:00
README Move contributing info to CONTRIBUTING 2015-10-17 18:28:03 +05:30
README.ECC
README.ENGINE
README.FIPS

 OpenSSL 1.1.0-dev

 Copyright (c) 1998-2015 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:

    rt@openssl.org

 In order to avoid spam, this is a moderated mailing list, and it might
 take a day for the ticket to show up.  (We also scan posts to make sure
 that security disclosures aren't publically posted by mistake.) Mail to
 this address is recorded in the public RT (request tracker) database (see
 https://www.openssl.org/support/rt.html for details) and also forwarded
 the public openssl-dev mailing list.  Confidential mail may be sent to
 openssl-security@openssl.org (PGP key available from the key servers).

 Please do NOT use this 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.

 You can also make GitHub pull requests. If you do this, please also send
 mail to rt@openssl.org with a link to the PR so that we can more easily
 keep track of it.

 HOW TO CONTRIBUTE TO OpenSSL
 ----------------------------

 See CONTRIBUTING