cherry pick pr-512 changes
[openssl.git] / README
1
2  OpenSSL 1.1.0-pre6-dev
3
4  Copyright (c) 1998-2016 The OpenSSL Project
5  Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
6  All rights reserved.
7
8  DESCRIPTION
9  -----------
10
11  The OpenSSL Project is a collaborative effort to develop a robust,
12  commercial-grade, fully featured, and Open Source toolkit implementing the
13  Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
14  well as a full-strength general purpose cryptographic library. The project is
15  managed by a worldwide community of volunteers that use the Internet to
16  communicate, plan, and develop the OpenSSL toolkit and its related
17  documentation.
18
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
21  OpenSSL license plus the SSLeay license), which means that you are free to
22  get and use it for commercial and non-commercial purposes as long as you
23  fulfill the conditions of both licenses.
24
25  OVERVIEW
26  --------
27
28  The OpenSSL toolkit includes:
29
30  libssl (with platform specific naming):
31      Provides the client and server-side implementations for SSLv3 and TLS.
32
33  libcrypto (with platform specific naming):
34      Provides general cryptographic and X.509 support needed by SSL/TLS but
35      not logically part of it.
36
37  openssl:
38      A command line tool that can be used for:
39         Creation of key parameters
40         Creation of X.509 certificates, CSRs and CRLs
41         Calculation of message digests
42         Encryption and decryption
43         SSL/TLS client and server tests
44         Handling of S/MIME signed or encrypted mail
45         And more...
46
47  INSTALLATION
48  ------------
49
50  See the appropriate file:
51         INSTALL         Linux, Unix, Windows, OpenVMS, ...
52         NOTES.*         INSTALL addendums for different platforms
53
54  SUPPORT
55  -------
56
57  See the OpenSSL website www.openssl.org for details on how to obtain
58  commercial technical support.
59
60  If you have any problems with OpenSSL then please take the following steps
61  first:
62
63     - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
64       to see if the problem has already been addressed
65     - Remove ASM versions of libraries
66     - Remove compiler optimisation flags
67
68  If you wish to report a bug then please include the following information in
69  any bug report:
70
71     - On Unix systems:
72         Self-test report generated by 'make report'
73     - On other systems:
74         OpenSSL version: output of 'openssl version -a'
75         OS Name, Version, Hardware platform
76         Compiler Details (name, version)
77     - Application Details (name, version)
78     - Problem Description (steps that will reproduce the problem, if known)
79     - Stack Traceback (if the application dumps core)
80
81  Email the report to:
82
83     rt@openssl.org
84
85  In order to avoid spam, this is a moderated mailing list, and it might
86  take a day for the ticket to show up.  (We also scan posts to make sure
87  that security disclosures aren't publically posted by mistake.) Mail
88  to this address is recorded in the public RT (request tracker) database
89  (see https://www.openssl.org/community/index.html#bugs for details) and
90  also forwarded the public openssl-dev mailing list.  Confidential mail
91  may be sent to openssl-security@openssl.org (PGP key available from the
92  key servers).
93
94  Please do NOT use this for general assistance or support queries.
95  Just because something doesn't work the way you expect does not mean it
96  is necessarily a bug in OpenSSL.
97
98  You can also make GitHub pull requests. If you do this, please also send
99  mail to rt@openssl.org with a link to the PR so that we can more easily
100  keep track of it.
101
102  HOW TO CONTRIBUTE TO OpenSSL
103  ----------------------------
104
105  See CONTRIBUTING
106
107  LEGALITIES
108  ----------
109
110  A number of nations, in particular the U.S., restrict the use or export
111  of cryptography. If you are potentially subject to such restrictions
112  you should seek competent professional legal advice before attempting to
113  develop or distribute cryptographic code.