openssl_strerror_r: Fix handling of GNU strerror_r
[openssl.git] / README
1
2  OpenSSL 3.0.0-dev
3
4  Copyright (c) 1998-2018 The OpenSSL Project
5  Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
6  All rights reserved.
7
8  DESCRIPTION
9  -----------
10
11  The OpenSSL Project is a collaborative effort to develop a robust,
12  commercial-grade, fully featured, and Open Source toolkit implementing the
13  Transport Layer Security (TLS) protocols (including SSLv3) as well as a
14  full-strength general purpose cryptographic library.
15
16  OpenSSL is descended from the SSLeay library developed by Eric A. Young
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.
22
23  OVERVIEW
24  --------
25
26  The OpenSSL toolkit includes:
27
28  libssl (with platform specific naming):
29      Provides the client and server-side implementations for SSLv3 and TLS.
30
31  libcrypto (with platform specific naming):
32      Provides general cryptographic and X.509 support needed by SSL/TLS but
33      not logically part of it.
34
35  openssl:
36      A command line tool that can be used for:
37         Creation of key parameters
38         Creation of X.509 certificates, CSRs and CRLs
39         Calculation of message digests
40         Encryption and decryption
41         SSL/TLS client and server tests
42         Handling of S/MIME signed or encrypted mail
43         And more...
44
45  INSTALLATION
46  ------------
47
48  See the appropriate file:
49         INSTALL         Linux, Unix, Windows, OpenVMS, ...
50         NOTES.*         INSTALL addendums for different platforms
51
52  SUPPORT
53  -------
54
55  See the OpenSSL website www.openssl.org for details on how to obtain
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).
59
60  If you have any problems with OpenSSL then please take the following steps
61  first:
62
63     - Download the latest version from the repository
64       to see if the problem has already been addressed
65     - Configure with no-asm
66     - Remove compiler optimization flags
67
68  If you wish to report a bug then please include the following information
69  and create an issue on GitHub:
70
71     - OpenSSL version: output of 'openssl version -a'
72     - Configuration data: output of 'perl configdata.pm --dump'
73     - OS Name, Version, Hardware platform
74     - Compiler Details (name, version)
75     - Application Details (name, version)
76     - Problem Description (steps that will reproduce the problem, if known)
77     - Stack Traceback (if the application dumps core)
78
79  Just because something doesn't work the way you expect does not mean it
80  is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
81  of query.
82
83  HOW TO CONTRIBUTE TO OpenSSL
84  ----------------------------
85
86  See CONTRIBUTING
87
88  LEGALITIES
89  ----------
90
91  A number of nations restrict the use or export of cryptography. If you
92  are potentially subject to such restrictions you should seek competent
93  professional legal advice before attempting to develop or distribute
94  cryptographic code.