]> git.ipfire.org Git - thirdparty/openssl.git/blame - README
Fix threading issue that at best will leak memory
[thirdparty/openssl.git] / README
CommitLineData
d02b48c6 1
d979e7f5 2 OpenSSL 1.1.0-pre6-dev
651d0aff 3
58add896 4 Copyright (c) 1998-2016 The OpenSSL Project
058bf559 5 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
651d0aff
RE
6 All rights reserved.
7
dfca822f
RE
8 DESCRIPTION
9 -----------
10
f1c236f8 11 The OpenSSL Project is a collaborative effort to develop a robust,
651d0aff 12 commercial-grade, fully featured, and Open Source toolkit implementing the
b06935f4 13 Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
57a143fd 14 well as a full-strength general purpose cryptographic library. The project is
b06935f4
RS
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.
651d0aff 18
b06935f4 19 OpenSSL is descended from the SSLeay library developed by Eric A. Young
1c308226 20 and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the
b06935f4
RS
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.
651d0aff 24
dfca822f
RE
25 OVERVIEW
26 --------
27
1c308226 28 The OpenSSL toolkit includes:
651d0aff 29
f33d63c9 30 libssl (with platform specific naming):
b06935f4 31 Provides the client and server-side implementations for SSLv3 and TLS.
651d0aff 32
f33d63c9 33 libcrypto (with platform specific naming):
b06935f4
RS
34 Provides general cryptographic and X.509 support needed by SSL/TLS but
35 not logically part of it.
651d0aff 36
a2c96d88 37 openssl:
d7f0ab5f 38 A command line tool that can be used for:
b06935f4 39 Creation of key parameters
a2c96d88 40 Creation of X.509 certificates, CSRs and CRLs
b06935f4
RS
41 Calculation of message digests
42 Encryption and decryption
43 SSL/TLS client and server tests
d7f0ab5f 44 Handling of S/MIME signed or encrypted mail
b06935f4 45 And more...
d7f0ab5f 46
dfca822f
RE
47 INSTALLATION
48 ------------
49
b06935f4 50 See the appropriate file:
07930a75
RL
51 INSTALL Linux, Unix, Windows, OpenVMS, ...
52 NOTES.* INSTALL addendums for different platforms
80e1495b 53
a2c96d88 54 SUPPORT
dfca822f
RE
55 -------
56
b06935f4 57 See the OpenSSL website www.openssl.org for details on how to obtain
0e37c909
DSH
58 commercial technical support.
59
dfca822f
RE
60 If you have any problems with OpenSSL then please take the following steps
61 first:
62
d7f0ab5f
UM
63 - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
64 to see if the problem has already been addressed
dfca822f 65 - Remove ASM versions of libraries
a2c96d88 66 - Remove compiler optimisation flags
dfca822f
RE
67
68 If you wish to report a bug then please include the following information in
69 any bug report:
70
d7f0ab5f
UM
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)
dfca822f 80
468ab1c2 81 Email the report to:
dfca822f 82
932af161 83 rt@openssl.org
dfca822f 84
932af161
RS
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
41977c53
RS
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).
0e37c909 93
932af161
RS
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.
a5ec86d1 101
b282fdae
UM
102 HOW TO CONTRIBUTE TO OpenSSL
103 ----------------------------
104
eb05f173 105 See CONTRIBUTING
b06935f4
RS
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.