]> git.ipfire.org Git - thirdparty/openssl.git/blame - README
Adapt test/keymgmt_internal_test.c to the redesigned interface
[thirdparty/openssl.git] / README
CommitLineData
d02b48c6 1
6738bf14 2 Copyright (c) 1998-2018 The OpenSSL Project
058bf559 3 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
651d0aff
RE
4 All rights reserved.
5
dfca822f
RE
6 DESCRIPTION
7 -----------
8
f1c236f8 9 The OpenSSL Project is a collaborative effort to develop a robust,
651d0aff 10 commercial-grade, fully featured, and Open Source toolkit implementing the
26dee42d
MC
11 Transport Layer Security (TLS) protocols (including SSLv3) as well as a
12 full-strength general purpose cryptographic library.
651d0aff 13
b06935f4 14 OpenSSL is descended from the SSLeay library developed by Eric A. Young
15133316
RL
15 and Tim J. Hudson.
16
17 The OpenSSL toolkit is licensed under the Apache License 2.0, which means
18 that you are free to get and use it for commercial and non-commercial
19 purposes as long as you fulfill its conditions.
651d0aff 20
dfca822f
RE
21 OVERVIEW
22 --------
23
1c308226 24 The OpenSSL toolkit includes:
651d0aff 25
f33d63c9 26 libssl (with platform specific naming):
b06935f4 27 Provides the client and server-side implementations for SSLv3 and TLS.
651d0aff 28
f33d63c9 29 libcrypto (with platform specific naming):
b06935f4
RS
30 Provides general cryptographic and X.509 support needed by SSL/TLS but
31 not logically part of it.
651d0aff 32
a2c96d88 33 openssl:
d7f0ab5f 34 A command line tool that can be used for:
b06935f4 35 Creation of key parameters
a2c96d88 36 Creation of X.509 certificates, CSRs and CRLs
b06935f4
RS
37 Calculation of message digests
38 Encryption and decryption
39 SSL/TLS client and server tests
d7f0ab5f 40 Handling of S/MIME signed or encrypted mail
b06935f4 41 And more...
d7f0ab5f 42
dfca822f
RE
43 INSTALLATION
44 ------------
45
b06935f4 46 See the appropriate file:
07930a75
RL
47 INSTALL Linux, Unix, Windows, OpenVMS, ...
48 NOTES.* INSTALL addendums for different platforms
80e1495b 49
a2c96d88 50 SUPPORT
dfca822f
RE
51 -------
52
b06935f4 53 See the OpenSSL website www.openssl.org for details on how to obtain
26dee42d
MC
54 commercial technical support. Free community support is available through the
55 openssl-users email list (see
56 https://www.openssl.org/community/mailinglists.html for further details).
0e37c909 57
dfca822f
RE
58 If you have any problems with OpenSSL then please take the following steps
59 first:
60
7954dced 61 - Download the latest version from the repository
d7f0ab5f 62 to see if the problem has already been addressed
7954dced 63 - Configure with no-asm
46f4e1be 64 - Remove compiler optimization flags
dfca822f 65
7954dced
RS
66 If you wish to report a bug then please include the following information
67 and create an issue on GitHub:
dfca822f 68
26dee42d 69 - OpenSSL version: output of 'openssl version -a'
917a1b2e 70 - Configuration data: output of 'perl configdata.pm --dump'
26dee42d
MC
71 - OS Name, Version, Hardware platform
72 - Compiler Details (name, version)
d7f0ab5f
UM
73 - Application Details (name, version)
74 - Problem Description (steps that will reproduce the problem, if known)
75 - Stack Traceback (if the application dumps core)
dfca822f 76
932af161 77 Just because something doesn't work the way you expect does not mean it
26dee42d
MC
78 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
79 of query.
932af161 80
b282fdae
UM
81 HOW TO CONTRIBUTE TO OpenSSL
82 ----------------------------
83
eb05f173 84 See CONTRIBUTING
b06935f4
RS
85
86 LEGALITIES
87 ----------
88
12a7715e 89 A number of nations restrict the use or export of cryptography. If you
7954dced
RS
90 are potentially subject to such restrictions you should seek competent
91 professional legal advice before attempting to develop or distribute
92 cryptographic code.