List undocumented macros
[openssl.git] / README
1
2  OpenSSL 1.1.1-dev
3
4  Copyright (c) 1998-2016 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.  The OpenSSL toolkit is licensed under a dual-license (the
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.
21
22  OVERVIEW
23  --------
24
25  The OpenSSL toolkit includes:
26
27  libssl (with platform specific naming):
28      Provides the client and server-side implementations for SSLv3 and TLS.
29
30  libcrypto (with platform specific naming):
31      Provides general cryptographic and X.509 support needed by SSL/TLS but
32      not logically part of it.
33
34  openssl:
35      A command line tool that can be used for:
36         Creation of key parameters
37         Creation of X.509 certificates, CSRs and CRLs
38         Calculation of message digests
39         Encryption and decryption
40         SSL/TLS client and server tests
41         Handling of S/MIME signed or encrypted mail
42         And more...
43
44  INSTALLATION
45  ------------
46
47  See the appropriate file:
48         INSTALL         Linux, Unix, Windows, OpenVMS, ...
49         NOTES.*         INSTALL addendums for different platforms
50
51  SUPPORT
52  -------
53
54  See the OpenSSL website www.openssl.org for details on how to obtain
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).
58
59  If you have any problems with OpenSSL then please take the following steps
60  first:
61
62     - Download the latest version from the repository
63       to see if the problem has already been addressed
64     - Configure with no-asm
65     - Remove compiler optimisation flags
66
67  If you wish to report a bug then please include the following information
68  and create an issue on GitHub:
69
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)
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.