]> git.ipfire.org Git - thirdparty/openssl.git/blame - README
Duplicate entries ssl_handshake_tbl trace entries...
[thirdparty/openssl.git] / README
CommitLineData
d02b48c6 1
9763f15e 2 OpenSSL 1.1.1-pre3-dev
651d0aff 3
6738bf14 4 Copyright (c) 1998-2018 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
7954dced 62 - Download the latest version from the repository
d7f0ab5f 63 to see if the problem has already been addressed
7954dced 64 - Configure with no-asm
46f4e1be 65 - Remove compiler optimization flags
dfca822f 66
7954dced
RS
67 If you wish to report a bug then please include the following information
68 and create an issue on GitHub:
dfca822f 69
26dee42d 70 - OpenSSL version: output of 'openssl version -a'
917a1b2e 71 - Configuration data: output of 'perl configdata.pm --dump'
26dee42d
MC
72 - OS Name, Version, Hardware platform
73 - Compiler Details (name, version)
d7f0ab5f
UM
74 - Application Details (name, version)
75 - Problem Description (steps that will reproduce the problem, if known)
76 - Stack Traceback (if the application dumps core)
dfca822f 77
932af161 78 Just because something doesn't work the way you expect does not mean it
26dee42d
MC
79 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
80 of query.
932af161 81
b282fdae
UM
82 HOW TO CONTRIBUTE TO OpenSSL
83 ----------------------------
84
eb05f173 85 See CONTRIBUTING
b06935f4
RS
86
87 LEGALITIES
88 ----------
89
12a7715e 90 A number of nations restrict the use or export of cryptography. If you
7954dced
RS
91 are potentially subject to such restrictions you should seek competent
92 professional legal advice before attempting to develop or distribute
93 cryptographic code.