]> git.ipfire.org Git - thirdparty/openssl.git/blame - README
Add C++ settings in the Linux config targets
[thirdparty/openssl.git] / README
CommitLineData
d02b48c6 1
156e34f2 2 OpenSSL 1.1.1-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
26dee42d
MC
13 Transport Layer Security (TLS) protocols (including SSLv3) as well as a
14 full-strength general purpose cryptographic library.
651d0aff 15
b06935f4 16 OpenSSL is descended from the SSLeay library developed by Eric A. Young
1c308226 17 and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the
b06935f4
RS
18 OpenSSL license plus the SSLeay license), which means that you are free to
19 get and use it for commercial and non-commercial purposes as long as you
20 fulfill the conditions of both licenses.
651d0aff 21
dfca822f
RE
22 OVERVIEW
23 --------
24
1c308226 25 The OpenSSL toolkit includes:
651d0aff 26
f33d63c9 27 libssl (with platform specific naming):
b06935f4 28 Provides the client and server-side implementations for SSLv3 and TLS.
651d0aff 29
f33d63c9 30 libcrypto (with platform specific naming):
b06935f4
RS
31 Provides general cryptographic and X.509 support needed by SSL/TLS but
32 not logically part of it.
651d0aff 33
a2c96d88 34 openssl:
d7f0ab5f 35 A command line tool that can be used for:
b06935f4 36 Creation of key parameters
a2c96d88 37 Creation of X.509 certificates, CSRs and CRLs
b06935f4
RS
38 Calculation of message digests
39 Encryption and decryption
40 SSL/TLS client and server tests
d7f0ab5f 41 Handling of S/MIME signed or encrypted mail
b06935f4 42 And more...
d7f0ab5f 43
dfca822f
RE
44 INSTALLATION
45 ------------
46
b06935f4 47 See the appropriate file:
07930a75
RL
48 INSTALL Linux, Unix, Windows, OpenVMS, ...
49 NOTES.* INSTALL addendums for different platforms
80e1495b 50
a2c96d88 51 SUPPORT
dfca822f
RE
52 -------
53
b06935f4 54 See the OpenSSL website www.openssl.org for details on how to obtain
26dee42d
MC
55 commercial technical support. Free community support is available through the
56 openssl-users email list (see
57 https://www.openssl.org/community/mailinglists.html for further details).
0e37c909 58
dfca822f
RE
59 If you have any problems with OpenSSL then please take the following steps
60 first:
61
d7f0ab5f
UM
62 - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
63 to see if the problem has already been addressed
dfca822f 64 - Remove ASM versions of libraries
a2c96d88 65 - Remove compiler optimisation flags
dfca822f
RE
66
67 If you wish to report a bug then please include the following information in
68 any bug report:
69
26dee42d
MC
70 - OpenSSL version: output of 'openssl version -a'
71 - Any "Configure" options that you selected during compilation of the
72 library if applicable (see INSTALL)
73 - OS Name, Version, Hardware platform
74 - Compiler Details (name, version)
d7f0ab5f
UM
75 - Application Details (name, version)
76 - Problem Description (steps that will reproduce the problem, if known)
77 - Stack Traceback (if the application dumps core)
dfca822f 78
468ab1c2 79 Email the report to:
dfca822f 80
932af161 81 rt@openssl.org
dfca822f 82
932af161 83 In order to avoid spam, this is a moderated mailing list, and it might
26dee42d 84 take a couple of days for the ticket to show up. (We also scan posts to make
f430ba31 85 sure that security disclosures aren't publicly posted by mistake.) Mail
41977c53
RS
86 to this address is recorded in the public RT (request tracker) database
87 (see https://www.openssl.org/community/index.html#bugs for details) and
88 also forwarded the public openssl-dev mailing list. Confidential mail
89 may be sent to openssl-security@openssl.org (PGP key available from the
90 key servers).
0e37c909 91
932af161
RS
92 Please do NOT use this for general assistance or support queries.
93 Just because something doesn't work the way you expect does not mean it
26dee42d
MC
94 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
95 of query.
932af161 96
26dee42d
MC
97 You can also make GitHub pull requests. See the CONTRIBUTING file for more
98 details.
a5ec86d1 99
b282fdae
UM
100 HOW TO CONTRIBUTE TO OpenSSL
101 ----------------------------
102
eb05f173 103 See CONTRIBUTING
b06935f4
RS
104
105 LEGALITIES
106 ----------
107
108 A number of nations, in particular the U.S., restrict the use or export
109 of cryptography. If you are potentially subject to such restrictions
110 you should seek competent professional legal advice before attempting to
111 develop or distribute cryptographic code.