Skip to content
README 3.93 KiB
Newer Older
Matt Caswell's avatar
Matt Caswell committed
 OpenSSL 1.1.0-pre6-dev
 Copyright (c) 1998-2016 The OpenSSL Project
 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
 The OpenSSL Project is a collaborative effort to develop a robust,
 commercial-grade, fully featured, and Open Source toolkit implementing the
Rich Salz's avatar
Rich Salz committed
 Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
Zhao Junwang's avatar
Zhao Junwang committed
 well as a full-strength general purpose cryptographic library. The project is
Rich Salz's avatar
Rich Salz committed
 managed by a worldwide community of volunteers that use the Internet to
 communicate, plan, and develop the OpenSSL toolkit and its related
 documentation.
Rich Salz's avatar
Rich Salz committed
 OpenSSL is descended from the SSLeay library developed by Eric A. Young
 and Tim J. Hudson.  The OpenSSL toolkit is licensed under a dual-license (the
Rich Salz's avatar
Rich Salz committed
 OpenSSL license plus the SSLeay license), which 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.
Richard Levitte's avatar
Richard Levitte committed
 libssl (with platform specific naming):
Rich Salz's avatar
Rich Salz committed
     Provides the client and server-side implementations for SSLv3 and TLS.
Richard Levitte's avatar
Richard Levitte committed
 libcrypto (with platform specific naming):
Rich Salz's avatar
Rich Salz committed
     Provides general cryptographic and X.509 support needed by SSL/TLS but
     not logically part of it.
 openssl:
     A command line tool that can be used for:
Rich Salz's avatar
Rich Salz committed
        Creation of key parameters
        Creation of X.509 certificates, CSRs and CRLs
Rich Salz's avatar
Rich Salz committed
        Calculation of message digests
        Encryption and decryption
        SSL/TLS client and server tests
        Handling of S/MIME signed or encrypted mail
Rich Salz's avatar
Rich Salz committed
        And more...
Rich Salz's avatar
Rich Salz committed
 See the appropriate file:
Richard Levitte's avatar
Richard Levitte committed
        INSTALL         Linux, Unix, Windows, OpenVMS
Rich Salz's avatar
Rich Salz committed
        INSTALL.DJGPP   DOS platform with DJGPP
        INSTALL.WCE     Windows CE
 SUPPORT
Rich Salz's avatar
Rich Salz committed
 See the OpenSSL website www.openssl.org for details on how to obtain
 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
Rich Salz's avatar
Rich Salz committed
 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/community/index.html#bugs 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
Rich Salz's avatar
Rich Salz committed

 LEGALITIES
 ----------

 A number of nations, in particular the U.S., restrict the use or export
 of cryptography. If you are potentially subject to such restrictions
 you should seek competent professional legal advice before attempting to
 develop or distribute cryptographic code.