Rework the provider digest constructor to provide implementation get_params
[thirdparty/openssl.git] / README
CommitLineData
d02b48c6 1
3a63dbef 2 OpenSSL 3.0.0-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
15133316
RL
17 and Tim J. Hudson.
18
19 The OpenSSL toolkit is licensed under the Apache License 2.0, which means
20 that you are free to get and use it for commercial and non-commercial
21 purposes as long as you fulfill its conditions.
651d0aff 22
dfca822f
RE
23 OVERVIEW
24 --------
25
1c308226 26 The OpenSSL toolkit includes:
651d0aff 27
f33d63c9 28 libssl (with platform specific naming):
b06935f4 29 Provides the client and server-side implementations for SSLv3 and TLS.
651d0aff 30
f33d63c9 31 libcrypto (with platform specific naming):
b06935f4
RS
32 Provides general cryptographic and X.509 support needed by SSL/TLS but
33 not logically part of it.
651d0aff 34
a2c96d88 35 openssl:
d7f0ab5f 36 A command line tool that can be used for:
b06935f4 37 Creation of key parameters
a2c96d88 38 Creation of X.509 certificates, CSRs and CRLs
b06935f4
RS
39 Calculation of message digests
40 Encryption and decryption
41 SSL/TLS client and server tests
d7f0ab5f 42 Handling of S/MIME signed or encrypted mail
b06935f4 43 And more...
d7f0ab5f 44
dfca822f
RE
45 INSTALLATION
46 ------------
47
b06935f4 48 See the appropriate file:
07930a75
RL
49 INSTALL Linux, Unix, Windows, OpenVMS, ...
50 NOTES.* INSTALL addendums for different platforms
80e1495b 51
a2c96d88 52 SUPPORT
dfca822f
RE
53 -------
54
b06935f4 55 See the OpenSSL website www.openssl.org for details on how to obtain
26dee42d
MC
56 commercial technical support. Free community support is available through the
57 openssl-users email list (see
58 https://www.openssl.org/community/mailinglists.html for further details).
0e37c909 59
dfca822f
RE
60 If you have any problems with OpenSSL then please take the following steps
61 first:
62
7954dced 63 - Download the latest version from the repository
d7f0ab5f 64 to see if the problem has already been addressed
7954dced 65 - Configure with no-asm
46f4e1be 66 - Remove compiler optimization flags
dfca822f 67
7954dced
RS
68 If you wish to report a bug then please include the following information
69 and create an issue on GitHub:
dfca822f 70
26dee42d 71 - OpenSSL version: output of 'openssl version -a'
917a1b2e 72 - Configuration data: output of 'perl configdata.pm --dump'
26dee42d
MC
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
932af161 79 Just because something doesn't work the way you expect does not mean it
26dee42d
MC
80 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
81 of query.
932af161 82
b282fdae
UM
83 HOW TO CONTRIBUTE TO OpenSSL
84 ----------------------------
85
eb05f173 86 See CONTRIBUTING
b06935f4
RS
87
88 LEGALITIES
89 ----------
90
12a7715e 91 A number of nations restrict the use or export of cryptography. If you
7954dced
RS
92 are potentially subject to such restrictions you should seek competent
93 professional legal advice before attempting to develop or distribute
94 cryptographic code.