README 4.0 KB
Newer Older
1

R
Richard Levitte 已提交
2
 OpenSSL 1.1.0-pre3-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
R
Rich Salz 已提交
13 14 15 16 17
 Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
 well as a full-strength general purpose cryptograpic 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.
18

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

25 26 27
 OVERVIEW
 --------

28
 The OpenSSL toolkit includes:
29 30

 libssl.a:
R
Rich Salz 已提交
31
     Provides the client and server-side implementations for SSLv3 and TLS.
32 33

 libcrypto.a:
R
Rich Salz 已提交
34 35
     Provides general cryptographic and X.509 support needed by SSL/TLS but
     not logically part of it.
36

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

47 48 49
 INSTALLATION
 ------------

R
Rich Salz 已提交
50 51 52 53 54 55 56 57 58
 See the appropriate file:
        INSTALL         Linux, Unix, etc.
        INSTALL.DJGPP   DOS platform with DJGPP
        INSTALL.NW      Netware
        INSTALL.OS2     OS/2
        INSTALL.VMS     VMS
        INSTALL.W32     Windows (32bit)
        INSTALL.W64     Windows (64bit)
        INSTALL.WCE     Windows CE
59

B
Bodo Möller 已提交
60
 SUPPORT
61 62
 -------

R
Rich Salz 已提交
63
 See the OpenSSL website www.openssl.org for details on how to obtain
64 65
 commercial technical support.

66 67 68
 If you have any problems with OpenSSL then please take the following steps
 first:

69 70
    - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
      to see if the problem has already been addressed
71
    - Remove ASM versions of libraries
B
Bodo Möller 已提交
72
    - Remove compiler optimisation flags
73 74 75 76

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

77 78 79 80 81 82 83 84 85
    - 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)
86

R
Rich Salz 已提交
87
 Email the report to:
88

89
    rt@openssl.org
90

91 92
 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
R
Rich Salz 已提交
93 94 95 96 97 98
 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).
99

100 101 102 103 104 105 106
 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.
107

U
Ulf Möller 已提交
108 109 110
 HOW TO CONTRIBUTE TO OpenSSL
 ----------------------------

111
 See CONTRIBUTING
R
Rich Salz 已提交
112 113 114 115 116 117 118 119

 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.