]>
Commit | Line | Data |
---|---|---|
257e9d03 RS |
1 | Welcome to the OpenSSL Project |
2 | ============================== | |
3 | ||
6c8149df | 4 | [![openssl logo]][www.openssl.org] |
d02b48c6 | 5 | |
b897b353 | 6 | [![github actions ci badge]][github actions ci] |
6c8149df | 7 | [![appveyor badge]][appveyor jobs] |
dac5138e | 8 | |
dac5138e DMSP |
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. | |
651d0aff | 14 | |
5f8e6c50 DMSP |
15 | OpenSSL is descended from the SSLeay library developed by Eric A. Young |
16 | and Tim J. Hudson. | |
dfca822f | 17 | |
6c8149df | 18 | The official Home Page of the OpenSSL Project is [www.openssl.org]. |
dac5138e | 19 | |
dac5138e DMSP |
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) | |
651d0aff | 31 | |
5f8e6c50 DMSP |
32 | Overview |
33 | ======== | |
15133316 | 34 | |
5f8e6c50 | 35 | The OpenSSL toolkit includes: |
651d0aff | 36 | |
dac5138e | 37 | - **libssl** |
6c8149df | 38 | an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446]). |
dac5138e DMSP |
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 | |
257e9d03 RS |
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... | |
dac5138e DMSP |
54 | |
55 | Download | |
56 | ======== | |
651d0aff | 57 | |
dac5138e DMSP |
58 | For Production Use |
59 | ------------------ | |
651d0aff | 60 | |
dac5138e DMSP |
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. | |
d7f0ab5f | 64 | |
dac5138e DMSP |
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. | |
dfca822f | 69 | |
dac5138e DMSP |
70 | For Testing and Development |
71 | --------------------------- | |
dfca822f | 72 | |
dac5138e DMSP |
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 | ||
6c8149df DMSP |
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], | |
dac5138e DMSP |
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 | ||
257e9d03 | 85 | git clone git://git.openssl.org/openssl.git |
dac5138e DMSP |
86 | |
87 | or from the GitHub mirror using | |
88 | ||
257e9d03 | 89 | git clone https://github.com/openssl/openssl.git |
dac5138e DMSP |
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 | ||
257e9d03 | 95 | git clone https://github.com/yourname/openssl.git |
dac5138e DMSP |
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 | ||
dac5138e DMSP |
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 | ||
4148581e DMSP |
108 | * [Notes for UNIX-like platforms](NOTES-UNIX.md) |
109 | * [Notes for Android platforms](NOTES-ANDROID.md) | |
110 | * [Notes for Windows platforms](NOTES-WINDOWS.md) | |
111 | * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md) | |
112 | * [Notes for the OpenVMS platform](NOTES-VMS.md) | |
113 | * [Notes on Perl](NOTES-PERL.md) | |
114 | * [Notes on Valgrind](NOTES-VALGRIND.md) | |
dac5138e | 115 | |
75dbc66e | 116 | Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as |
84dd002f | 117 | known issues are available on the [OpenSSL 3.0 Wiki] page. |
dac5138e DMSP |
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 | ||
6c8149df | 134 | There is a Wiki at [wiki.openssl.org] which is currently not very active. |
dac5138e DMSP |
135 | It contains a lot of useful information, not all of which is up to date. |
136 | ||
137 | License | |
5f8e6c50 | 138 | ======= |
0e37c909 | 139 | |
dac5138e DMSP |
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. | |
dfca822f | 143 | |
036cbb6b | 144 | See the [LICENSE.txt](LICENSE.txt) file for more details. |
dfca822f | 145 | |
dac5138e DMSP |
146 | Support |
147 | ======= | |
dfca822f | 148 | |
dac5138e DMSP |
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. | |
dfca822f | 151 | |
dac5138e DMSP |
152 | Contributing |
153 | ============ | |
932af161 | 154 | |
dac5138e DMSP |
155 | If you are interested and willing to contribute to the OpenSSL project, |
156 | please take a look at the [CONTRIBUTING](CONTRIBUTING.md) file. | |
b282fdae | 157 | |
dac5138e DMSP |
158 | Legalities |
159 | ========== | |
b06935f4 | 160 | |
dac5138e DMSP |
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. | |
5f8e6c50 | 164 | |
5f8e6c50 DMSP |
165 | Copyright |
166 | ========= | |
167 | ||
4333b89f | 168 | Copyright (c) 1998-2021 The OpenSSL Project |
5f8e6c50 DMSP |
169 | |
170 | Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson | |
171 | ||
172 | All rights reserved. | |
dac5138e | 173 | |
dac5138e DMSP |
174 | <!-- Links --> |
175 | ||
176 | [www.openssl.org]: | |
257e9d03 | 177 | <https://www.openssl.org> |
dac5138e DMSP |
178 | "OpenSSL Homepage" |
179 | ||
180 | [git.openssl.org]: | |
257e9d03 | 181 | <https://git.openssl.org> |
dac5138e DMSP |
182 | "OpenSSL Git Repository" |
183 | ||
184 | [git.openssl.org]: | |
257e9d03 | 185 | <https://git.openssl.org> |
dac5138e DMSP |
186 | "OpenSSL Git Repository" |
187 | ||
188 | [github.com/openssl/openssl]: | |
257e9d03 | 189 | <https://github.com/openssl/openssl> |
dac5138e DMSP |
190 | "OpenSSL GitHub Mirror" |
191 | ||
dac5138e | 192 | [wiki.openssl.org]: |
257e9d03 | 193 | <https://wiki.openssl.org> |
dac5138e DMSP |
194 | "OpenSSL Wiki" |
195 | ||
84dd002f DMSP |
196 | [OpenSSL 3.0 Wiki]: |
197 | <https://wiki.openssl.org/index.php/OpenSSL_3.0> | |
198 | "OpenSSL 3.0 Wiki" | |
199 | ||
dac5138e | 200 | [RFC 8446]: |
257e9d03 | 201 | <https://tools.ietf.org/html/rfc8446> |
dac5138e DMSP |
202 | |
203 | <!-- Logos and Badges --> | |
dac5138e DMSP |
204 | |
205 | [openssl logo]: | |
206 | doc/images/openssl.svg | |
207 | "OpenSSL Logo" | |
208 | ||
b897b353 RL |
209 | [github actions ci badge]: |
210 | <https://github.com/openssl/openssl/workflows/GitHub%20CI/badge.svg> | |
211 | "GitHub Actions CI Status" | |
dac5138e | 212 | |
b897b353 RL |
213 | [github actions ci]: |
214 | <https://github.com/openssl/openssl/actions?query=workflow%3A%22GitHub+CI%22> | |
215 | "GitHub Actions CI" | |
dac5138e DMSP |
216 | |
217 | [appveyor badge]: | |
0799b79a | 218 | <https://ci.appveyor.com/api/projects/status/8e10o7xfrg73v98f/branch/master?svg=true> |
dac5138e DMSP |
219 | "AppVeyor Build Status" |
220 | ||
221 | [appveyor jobs]: | |
257e9d03 | 222 | <https://ci.appveyor.com/project/openssl/openssl/branch/master> |
dac5138e | 223 | "AppVeyor Jobs" |