README 3.9 KB
Newer Older
1

2
 OpenSSL 1.1.1-dev
3

4
 Copyright (c) 1998-2016 The OpenSSL Project
5
 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
6 7
 All rights reserved.

8 9 10
 DESCRIPTION
 -----------

R
Ralf S. Engelschall 已提交
11
 The OpenSSL Project is a collaborative effort to develop a robust,
12
 commercial-grade, fully featured, and Open Source toolkit implementing the
M
Matt Caswell 已提交
13 14
 Transport Layer Security (TLS) protocols (including SSLv3) as well as a
 full-strength general purpose cryptographic library.
15

R
Rich Salz 已提交
16
 OpenSSL is descended from the SSLeay library developed by Eric A. Young
17
 and Tim J. Hudson.  The OpenSSL toolkit is licensed under a dual-license (the
R
Rich Salz 已提交
18 19 20
 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.
21

22 23 24
 OVERVIEW
 --------

25
 The OpenSSL toolkit includes:
26

R
Richard Levitte 已提交
27
 libssl (with platform specific naming):
R
Rich Salz 已提交
28
     Provides the client and server-side implementations for SSLv3 and TLS.
29

R
Richard Levitte 已提交
30
 libcrypto (with platform specific naming):
R
Rich Salz 已提交
31 32
     Provides general cryptographic and X.509 support needed by SSL/TLS but
     not logically part of it.
33

B
Bodo Möller 已提交
34
 openssl:
35
     A command line tool that can be used for:
R
Rich Salz 已提交
36
        Creation of key parameters
B
Bodo Möller 已提交
37
        Creation of X.509 certificates, CSRs and CRLs
R
Rich Salz 已提交
38 39 40
        Calculation of message digests
        Encryption and decryption
        SSL/TLS client and server tests
41
        Handling of S/MIME signed or encrypted mail
R
Rich Salz 已提交
42
        And more...
43

44 45 46
 INSTALLATION
 ------------

R
Rich Salz 已提交
47
 See the appropriate file:
48 49
        INSTALL         Linux, Unix, Windows, OpenVMS, ...
        NOTES.*         INSTALL addendums for different platforms
50

B
Bodo Möller 已提交
51
 SUPPORT
52 53
 -------

R
Rich Salz 已提交
54
 See the OpenSSL website www.openssl.org for details on how to obtain
M
Matt Caswell 已提交
55 56 57
 commercial technical support. Free community support is available through the
 openssl-users email list (see
 https://www.openssl.org/community/mailinglists.html for further details).
58

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

62 63
    - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
      to see if the problem has already been addressed
64
    - Remove ASM versions of libraries
B
Bodo Möller 已提交
65
    - Remove compiler optimisation flags
66 67 68 69

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

M
Matt Caswell 已提交
70 71 72 73 74
    - OpenSSL version: output of 'openssl version -a'
    - Any "Configure" options that you selected during compilation of the
      library if applicable (see INSTALL)
    - OS Name, Version, Hardware platform
    - Compiler Details (name, version)
75 76 77
    - Application Details (name, version)
    - Problem Description (steps that will reproduce the problem, if known)
    - Stack Traceback (if the application dumps core)
78

R
Rich Salz 已提交
79
 Email the report to:
80

81
    rt@openssl.org
82

83
 In order to avoid spam, this is a moderated mailing list, and it might
M
Matt Caswell 已提交
84
 take a couple of days for the ticket to show up.  (We also scan posts to make
F
FdaSilvaYY 已提交
85
 sure that security disclosures aren't publicly posted by mistake.) Mail
R
Rich Salz 已提交
86 87 88 89 90
 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).
91

92 93
 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
M
Matt Caswell 已提交
94 95
 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
 of query.
96

M
Matt Caswell 已提交
97 98
 You can also make GitHub pull requests. See the CONTRIBUTING file for more
 details.
99

U
Ulf Möller 已提交
100 101 102
 HOW TO CONTRIBUTE TO OpenSSL
 ----------------------------

103
 See CONTRIBUTING
R
Rich Salz 已提交
104 105 106 107 108 109 110 111

 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.