README 3.1 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:

R
Rich Salz 已提交
62
    - Download the latest version from the repository
63
      to see if the problem has already been addressed
R
Rich Salz 已提交
64
    - Configure with no-asm
B
Bodo Möller 已提交
65
    - Remove compiler optimisation flags
66

R
Rich Salz 已提交
67 68
 If you wish to report a bug then please include the following information
 and create an issue on GitHub:
69

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

79
 Just because something doesn't work the way you expect does not mean it
M
Matt Caswell 已提交
80 81
 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
 of query.
82

U
Ulf Möller 已提交
83 84 85
 HOW TO CONTRIBUTE TO OpenSSL
 ----------------------------

86
 See CONTRIBUTING
R
Rich Salz 已提交
87 88 89 90

 LEGALITIES
 ----------

91
 A number of nations restrict the use or export of cryptography. If you
R
Rich Salz 已提交
92 93 94
 are potentially subject to such restrictions you should seek competent
 professional legal advice before attempting to develop or distribute
 cryptographic code.