ktls: Initial support for ChaCha20-Poly1305
[openssl.git] / README.md
1 Welcome to the OpenSSL Project
2 ==============================
3
4 [![openssl logo]][www.openssl.org]
5
6 [![travis badge]][travis jobs]
7 [![appveyor badge]][appveyor jobs]
8
9 OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit
10 for the Transport Layer Security (TLS) protocol formerly known as the
11 Secure Sockets Layer (SSL) protocol. The protocol implementation is based
12 on a full-strength general purpose cryptographic library, which can also
13 be used stand-alone.
14
15 OpenSSL is descended from the SSLeay library developed by Eric A. Young
16 and Tim J. Hudson.
17
18 The official Home Page of the OpenSSL Project is [www.openssl.org].
19
20 Table of Contents
21 =================
22
23  - [Overview](#overview)
24  - [Download](#download)
25  - [Build and Install](#build-and-install)
26  - [Documentation](#documentation)
27  - [License](#license)
28  - [Support](#support)
29  - [Contributing](#contributing)
30  - [Legalities](#legalities)
31
32 Overview
33 ========
34
35 The OpenSSL toolkit includes:
36
37 - **libssl**
38   an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446]).
39
40 - **libcrypto**
41   a full-strength general purpose cryptographic library. It constitutes the
42   basis of the TLS implementation, but can also be used independently.
43
44 - **openssl**
45   the OpenSSL command line tool, a swiss army knife for cryptographic tasks,
46   testing and analyzing. It can be used for
47   - creation of key parameters
48   - creation of X.509 certificates, CSRs and CRLs
49   - calculation of message digests
50   - encryption and decryption
51   - SSL/TLS client and server tests
52   - handling of S/MIME signed or encrypted mail
53   - and more...
54
55 Download
56 ========
57
58 For Production Use
59 ------------------
60
61 Source code tarballs of the official releases can be downloaded from
62 [www.openssl.org/source](https://www.openssl.org/source).
63 The OpenSSL project does not distribute the toolkit in binary form.
64
65 However, for a large variety of operating systems precompiled versions
66 of the OpenSSL toolkit are available. In particular on Linux and other
67 Unix operating systems it is normally recommended to link against the
68 precompiled shared libraries provided by the distributor or vendor.
69
70 For Testing and Development
71 ---------------------------
72
73 Although testing and development could in theory also be done using
74 the source tarballs, having a local copy of the git repository with
75 the entire project history gives you much more insight into the
76 code base.
77
78 The official OpenSSL Git Repository is located at [git.openssl.org].
79 There is a GitHub mirror of the repository at [github.com/openssl/openssl],
80 which is updated automatically from the former on every commit.
81
82 A local copy of the Git Repository can be obtained by cloning it from
83 the original OpenSSL repository using
84
85     git clone git://git.openssl.org/openssl.git
86
87 or from the GitHub mirror using
88
89     git clone https://github.com/openssl/openssl.git
90
91 If you intend to contribute to OpenSSL, either to fix bugs or contribute
92 new features, you need to fork the OpenSSL repository openssl/openssl on
93 GitHub and clone your public fork instead.
94
95     git clone https://github.com/yourname/openssl.git
96
97 This is necessary, because all development of OpenSSL nowadays is done via
98 GitHub pull requests. For more details, see [Contributing](#contributing).
99
100 Build and Install
101 =================
102
103 After obtaining the Source, have a look at the [INSTALL](INSTALL.md) file for
104 detailed instructions about building and installing OpenSSL. For some
105 platforms, the installation instructions are amended by a platform specific
106 document.
107
108  * [NOTES-Android.md](NOTES-Android.md)
109  * [NOTES-DJGPP.md](NOTES-DJGPP.md)
110  * [NOTES-Unix.md](NOTES-Unix.md)
111  * [NOTES-VMS.md](NOTES-VMS.md)
112  * [NOTES-Windows.txt](NOTES-Windows.txt)
113  * [NOTES-Perl.md](NOTES-Perl.md)
114  * [NOTES-Valgrind.md](NOTES-Valgrind.md)
115
116 Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as
117 known issues are available on the [OpenSSL 3.0 Wiki] page.
118
119 Documentation
120 =============
121
122 Manual Pages
123 ------------
124
125 The manual pages for the master branch and all current stable releases are
126 available online.
127
128 - [OpenSSL master](https://www.openssl.org/docs/manmaster)
129 - [OpenSSL 1.1.1](https://www.openssl.org/docs/man1.1.1)
130
131 Wiki
132 ----
133
134 There is a Wiki at [wiki.openssl.org] which is currently not very active.
135 It contains a lot of useful information, not all of which is up to date.
136
137 License
138 =======
139
140 OpenSSL is licensed under the Apache License 2.0, which means that
141 you are free to get and use it for commercial and non-commercial
142 purposes as long as you fulfill its conditions.
143
144 See the [LICENSE.txt](LICENSE.txt) file for more details.
145
146 Support
147 =======
148
149 There are various ways to get in touch. The correct channel depends on
150 your requirement. see the [SUPPORT](SUPPORT.md) file for more details.
151
152 Contributing
153 ============
154
155 If you are interested and willing to contribute to the OpenSSL project,
156 please take a look at the [CONTRIBUTING](CONTRIBUTING.md) file.
157
158 Legalities
159 ==========
160
161 A number of nations restrict the use or export of cryptography. If you are
162 potentially subject to such restrictions you should seek legal advice before
163 attempting to develop or distribute cryptographic code.
164
165 Copyright
166 =========
167
168 Copyright (c) 1998-2020 The OpenSSL Project
169
170 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
171
172 All rights reserved.
173
174 <!-- Links  -->
175
176 [www.openssl.org]:
177     <https://www.openssl.org>
178     "OpenSSL Homepage"
179
180 [git.openssl.org]:
181     <https://git.openssl.org>
182     "OpenSSL Git Repository"
183
184 [git.openssl.org]:
185     <https://git.openssl.org>
186     "OpenSSL Git Repository"
187
188 [github.com/openssl/openssl]:
189     <https://github.com/openssl/openssl>
190     "OpenSSL GitHub Mirror"
191
192 [wiki.openssl.org]:
193     <https://wiki.openssl.org>
194     "OpenSSL Wiki"
195
196 [OpenSSL 3.0 Wiki]:
197     <https://wiki.openssl.org/index.php/OpenSSL_3.0>
198     "OpenSSL 3.0 Wiki"
199
200 [RFC 8446]:
201      <https://tools.ietf.org/html/rfc8446>
202
203 <!-- Logos and Badges -->
204
205 [openssl logo]:
206     doc/images/openssl.svg
207     "OpenSSL Logo"
208
209 [travis badge]:
210     <https://travis-ci.com/openssl/openssl.svg?branch=master>
211     "Travis Build Status"
212
213 [travis jobs]:
214     <https://travis-ci.com/openssl/openssl>
215     "Travis Jobs"
216
217 [appveyor badge]:
218     <https://ci.appveyor.com/api/projects/status/8e10o7xfrg73v98f/branch/master?svg=true>
219     "AppVeyor Build Status"
220
221 [appveyor jobs]:
222     <https://ci.appveyor.com/project/openssl/openssl/branch/master>
223     "AppVeyor Jobs"