Go to file
Dr. Stephen Henson f8f5f8369d add CCM docs
Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-08-14 06:57:32 +01:00
apps Remove Gost94 signature algorithm. 2015-08-11 18:23:29 -04:00
bugs Run util/openssl-format-source -v -c . 2015-01-22 09:20:09 +00:00
certs grammar 2008-05-27 18:43:20 +00:00
Configurations Build with --strict-warnings on FreeBSD. 2015-08-02 02:21:46 +01:00
crypto CCM support. 2015-08-14 06:56:11 +01:00
demos Update demo. 2015-07-21 13:56:24 +01:00
doc add CCM docs 2015-08-14 06:57:32 +01:00
engines Remove Gost94 signature algorithm. 2015-08-11 18:23:29 -04:00
include Add CCM ciphersuites from RFC6655 and RFC7251 2015-08-14 06:57:32 +01: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 Make a number of changes to the OS/2 build. Submitter's comment below. 2003-11-28 14:51:30 +00:00
ssl Add CCM ciphersuites from RFC6655 and RFC7251 2015-08-14 06:57:32 +01:00
test Use -I to add to @INC, and use -w to produce warnings 2015-08-13 22:05:25 +02:00
times Updates from 1.0.0-stable branch. 2009-04-20 11:33:12 +00:00
tools GH249: Fix bad regexp in arg parsing. 2015-06-02 11:24:44 -04:00
util for test_sslvertol, add a value to display SSL version < 3 in debug 2015-08-13 22:05:25 +02:00
VMS Teach mkshared.com to have a look for disabled algorithms in opensslconf.h 2011-10-30 11:40:54 +00:00
.gitignore Ignore files from other branches 2015-05-22 11:09:19 +01:00
ACKNOWLEDGEMENTS Cleanup some doc files 2015-03-01 20:46:38 -05:00
CHANGES Various doc fixes from GH pull requests 2015-07-31 12:27:27 -04:00
config Remove remaining Kerberos references 2015-05-13 15:08:10 +01:00
Configure Add -Wconditional-uninitialized to clang strict warnings. 2015-08-02 02:45:44 +01:00
e_os.h Identify and move OpenSSL internal header files 2015-05-14 15:13:49 +02:00
FAQ Fix FAQ formatting for new website. 2015-08-13 15:47:37 -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 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 support for OPENSSL_NO_TLSEXT 2015-05-22 23:10:51 +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 Set numeric IDs for tar as well 2015-07-10 20:29:16 +02:00
Makefile.shared RT3548: Remove some unsupported platforms. 2015-01-12 10:40:00 -05:00
makevms.com Add CHANGES entry for OPENSSL_NO_TLSEXT removal 2015-05-22 23:11:22 +01:00
NEWS Update CHANGES and NEWS for the new release 2015-07-09 09:30:46 +01: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 Various doc fixes from GH pull requests 2015-07-31 12:27:27 -04: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

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

 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 our coding style
 (see http://openssl.org/about/codingstyle.txt) and compile without
 warnings using the --strict-warnings flag.  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