Name Date Size #Lines LOC

..28-Sep-2023-

.github/H02-Sep-2021-

Configurations/H23-Aug-2022-

VMS/H14-Dec-2021-

apps/H31-Aug-2022-

crypto/H27-Aug-2022-

demos/H12-Apr-2022-

dev/H18-May-2022-

doc/H24-Aug-2022-

engines/H02-Jun-2022-

external/perl/H24-Feb-2020-

fuzz/H28-Jun-2022-

gost-engine/H23-May-2020-

include/H24-Feb-2020-

krb5/H24-Feb-2020-

ms/H23-May-2021-

oqs-provider/H09-Mar-2022-

os-dep/H03-Feb-2022-

providers/H23-Aug-2022-

pyca-cryptography/H24-Feb-2020-

python-ecdsa/H05-Jan-2022-

ssl/H26-Aug-2022-

test/H26-Aug-2022-

tlsfuzzer/H05-Jan-2022-

tlslite-ng/H05-Jan-2022-

tools/H21-Jun-2022-

util/H24-Aug-2022-

wycheproof/H23-May-2021-

.gitattributesH A D23-May-2021514 1513

.gitignoreH A D19-Aug-20224.3 KiB241220

.gitmodulesH A D09-Mar-2022757 2825

ACKNOWLEDGEMENTS.mdH A D02-Sep-2021157 74

AUTHORS.mdH A D02-Feb-2021990 5246

CHANGES.mdH A D18-Aug-2022715.3 KiB19,55113,571

CODE-OF-CONDUCT.mdH A D18-Aug-2022169 74

CONTRIBUTING.mdH A D04-Apr-20224.3 KiB9572

ConfigureH A D23-Aug-2022132.5 KiB3,5962,840

FAQ.mdH A D26-Feb-2020197 74

HACKING.mdH A D05-Jul-20201.2 KiB3425

INSTALL.mdH A D27-Jul-202261.1 KiB1,8121,248

LICENSE.txtH A D05-Jul-20209.9 KiB178150

NEWS.mdH A D21-Jun-202269 KiB1,5581,256

NOTES-ANDROID.mdH A D12-Feb-20214.5 KiB9172

NOTES-DJGPP.mdH A D12-Feb-20212.1 KiB4736

NOTES-NONSTOP.mdH A D25-Aug-20219.8 KiB243183

NOTES-PERL.mdH A D28-May-20214.9 KiB12895

NOTES-UNIX.mdH A D23-Aug-20215.6 KiB11693

NOTES-VALGRIND.mdH A D10-Dec-20212.7 KiB7352

NOTES-VMS.mdH A D28-May-20214.1 KiB11681

NOTES-WINDOWS.mdH A D25-Mar-20229 KiB266182

README-ENGINES.mdH A D05-Jan-202215.3 KiB318264

README-FIPS.mdH A D23-May-20212.8 KiB6847

README-PROVIDERS.mdH A D28-May-20215.3 KiB146111

README.mdH A D11-Mar-20226.5 KiB225161

SUPPORT.mdH A D08-Dec-20213.8 KiB9469

VERSION.datH A D03-Sep-202192 87

appveyor.ymlH A D23-May-20212 KiB8375

build.infoH A D25-May-20223.7 KiB9384

configH A D28-Jun-2020378 112

config.comH A D16-Jul-20202.5 KiB9490

configdata.pm.inH A D22-May-202216.3 KiB488375

README-ENGINES.md

1Engines
2=======
3
4Deprecation Note
5----------------
6
7The ENGINE API was introduced in OpenSSL version 0.9.6 as a low level
8interface for adding alternative implementations of cryptographic
9primitives, most notably for integrating hardware crypto devices.
10
11The ENGINE interface has its limitations and it has been superseded
12by the [PROVIDER API](README-PROVIDERS.md), it is deprecated in OpenSSL
13version 3.0. The following documentation is retained as an aid for
14users who need to maintain or support existing ENGINE implementations.
15Support for new hardware devices or new algorithms should be added
16via providers, and existing engines should be converted to providers
17as soon as possible.
18
19Built-in ENGINE implementations
20-------------------------------
21
22There are currently built-in ENGINE implementations for the following
23crypto devices:
24
25  * Microsoft CryptoAPI
26  * VIA Padlock
27  * nCipher CHIL
28
29In addition, dynamic binding to external ENGINE implementations is now
30provided by a special ENGINE called "dynamic". See the "DYNAMIC ENGINE"
31section below for details.
32
33At this stage, a number of things are still needed and are being worked on:
34
35  1. Integration of EVP support.
36  2. Configuration support.
37  3. Documentation!
38
39Integration of EVP support
40--------------------------
41
42With respect to EVP, this relates to support for ciphers and digests in
43the ENGINE model so that alternative implementations of existing
44algorithms/modes (or previously unimplemented ones) can be provided by
45ENGINE implementations.
46
47Configuration support
48---------------------
49
50Configuration support currently exists in the ENGINE API itself, in the
51form of "control commands". These allow an application to expose to the
52user/admin the set of commands and parameter types a given ENGINE
53implementation supports, and for an application to directly feed string
54based input to those ENGINEs, in the form of name-value pairs. This is an
55extensible way for ENGINEs to define their own "configuration" mechanisms
56that are specific to a given ENGINE (eg. for a particular hardware
57device) but that should be consistent across *all* OpenSSL-based
58applications when they use that ENGINE. Work is in progress (or at least
59in planning) for supporting these control commands from the CONF (or
60NCONF) code so that applications using OpenSSL's existing configuration
61file format can have ENGINE settings specified in much the same way.
62Presently however, applications must use the ENGINE API itself to provide
63such functionality. To see first hand the types of commands available
64with the various compiled-in ENGINEs (see further down for dynamic
65ENGINEs), use the "engine" openssl utility with full verbosity, i.e.:
66
67    openssl engine -vvvv
68
69Documentation
70-------------
71
72Documentation? Volunteers welcome! The source code is reasonably well
73self-documenting, but some summaries and usage instructions are needed -
74moreover, they are needed in the same POD format the existing OpenSSL
75documentation is provided in. Any complete or incomplete contributions
76would help make this happen.
77
78STABILITY & BUG-REPORTS
79=======================
80
81What already exists is fairly stable as far as it has been tested, but
82the test base has been a bit small most of the time. For the most part,
83the vendors of the devices these ENGINEs support have contributed to the
84development and/or testing of the implementations, and *usually* (with no
85guarantees) have experience in using the ENGINE support to drive their
86devices from common OpenSSL-based applications. Bugs and/or inexplicable
87behaviour in using a specific ENGINE implementation should be sent to the
88author of that implementation (if it is mentioned in the corresponding C
89file), and in the case of implementations for commercial hardware
90devices, also through whatever vendor support channels are available.  If
91none of this is possible, or the problem seems to be something about the
92ENGINE API itself (ie. not necessarily specific to a particular ENGINE
93implementation) then you should mail complete details to the relevant
94OpenSSL mailing list. For a definition of "complete details", refer to
95the OpenSSL "README" file. As for which list to send it to:
96
97  * openssl-users: if you are *using* the ENGINE abstraction, either in an
98    pre-compiled application or in your own application code.
99
100  * openssl-dev: if you are discussing problems with OpenSSL source code.
101
102USAGE
103=====
104
105The default "openssl" ENGINE is always chosen when performing crypto
106operations unless you specify otherwise. You must actively tell the
107openssl utility commands to use anything else through a new command line
108switch called "-engine". Also, if you want to use the ENGINE support in
109your own code to do something similar, you must likewise explicitly
110select the ENGINE implementation you want.
111
112Depending on the type of hardware, system, and configuration, "settings"
113may need to be applied to an ENGINE for it to function as expected/hoped.
114The recommended way of doing this is for the application to support
115ENGINE "control commands" so that each ENGINE implementation can provide
116whatever configuration primitives it might require and the application
117can allow the user/admin (and thus the hardware vendor's support desk
118also) to provide any such input directly to the ENGINE implementation.
119This way, applications do not need to know anything specific to any
120device, they only need to provide the means to carry such user/admin
121input through to the ENGINE in question. Ie. this connects *you* (and
122your helpdesk) to the specific ENGINE implementation (and device), and
123allows application authors to not get buried in hassle supporting
124arbitrary devices they know (and care) nothing about.
125
126A new "openssl" utility, "openssl engine", has been added in that allows
127for testing and examination of ENGINE implementations. Basic usage
128instructions are available by specifying the "-?" command line switch.
129
130DYNAMIC ENGINES
131===============
132
133The new "dynamic" ENGINE provides a low-overhead way to support ENGINE
134implementations that aren't pre-compiled and linked into OpenSSL-based
135applications. This could be because existing compiled-in implementations
136have known problems and you wish to use a newer version with an existing
137application. It could equally be because the application (or OpenSSL
138library) you are using simply doesn't have support for the ENGINE you
139wish to use, and the ENGINE provider (eg. hardware vendor) is providing
140you with a self-contained implementation in the form of a shared-library.
141The other use-case for "dynamic" is with applications that wish to
142maintain the smallest foot-print possible and so do not link in various
143ENGINE implementations from OpenSSL, but instead leaves you to provide
144them, if you want them, in the form of "dynamic"-loadable
145shared-libraries. It should be possible for hardware vendors to provide
146their own shared-libraries to support arbitrary hardware to work with
147applications based on OpenSSL 0.9.7 or later. If you're using an
148application based on 0.9.7 (or later) and the support you desire is only
149announced for versions later than the one you need, ask the vendor to
150backport their ENGINE to the version you need.
151
152How does "dynamic" work?
153------------------------
154
155The dynamic ENGINE has a special flag in its implementation such that
156every time application code asks for the 'dynamic' ENGINE, it in fact
157gets its own copy of it. As such, multi-threaded code (or code that
158multiplexes multiple uses of 'dynamic' in a single application in any
159way at all) does not get confused by 'dynamic' being used to do many
160independent things. Other ENGINEs typically don't do this so there is
161only ever 1 ENGINE structure of its type (and reference counts are used
162to keep order). The dynamic ENGINE itself provides absolutely no
163cryptographic functionality, and any attempt to "initialise" the ENGINE
164automatically fails. All it does provide are a few "control commands"
165that can be used to control how it will load an external ENGINE
166implementation from a shared-library. To see these control commands,
167use the command-line;
168
169    openssl engine -vvvv dynamic
170
171The "SO_PATH" control command should be used to identify the
172shared-library that contains the ENGINE implementation, and "NO_VCHECK"
173might possibly be useful if there is a minor version conflict and you
174(or a vendor helpdesk) is convinced you can safely ignore it.
175"ID" is probably only needed if a shared-library implements
176multiple ENGINEs, but if you know the engine id you expect to be using,
177it doesn't hurt to specify it (and this provides a sanity check if
178nothing else). "LIST_ADD" is only required if you actually wish the
179loaded ENGINE to be discoverable by application code later on using the
180ENGINE's "id". For most applications, this isn't necessary - but some
181application authors may have nifty reasons for using it. The "LOAD"
182command is the only one that takes no parameters and is the command
183that uses the settings from any previous commands to actually *load*
184the shared-library ENGINE implementation. If this command succeeds, the
185(copy of the) 'dynamic' ENGINE will magically morph into the ENGINE
186that has been loaded from the shared-library. As such, any control
187commands supported by the loaded ENGINE could then be executed as per
188normal. Eg. if ENGINE "foo" is implemented in the shared-library
189"libfoo.so" and it supports some special control command "CMD_FOO", the
190following code would load and use it (NB: obviously this code has no
191error checking);
192
193    ENGINE *e = ENGINE_by_id("dynamic");
194    ENGINE_ctrl_cmd_string(e, "SO_PATH", "/lib/libfoo.so", 0);
195    ENGINE_ctrl_cmd_string(e, "ID", "foo", 0);
196    ENGINE_ctrl_cmd_string(e, "LOAD", NULL, 0);
197    ENGINE_ctrl_cmd_string(e, "CMD_FOO", "some input data", 0);
198
199For testing, the "openssl engine" utility can be useful for this sort
200of thing. For example the above code excerpt would achieve much the
201same result as;
202
203    openssl engine dynamic \
204              -pre SO_PATH:/lib/libfoo.so \
205              -pre ID:foo \
206              -pre LOAD \
207              -pre "CMD_FOO:some input data"
208
209Or to simply see the list of commands supported by the "foo" ENGINE;
210
211    openssl engine -vvvv dynamic \
212              -pre SO_PATH:/lib/libfoo.so \
213              -pre ID:foo \
214              -pre LOAD
215
216Applications that support the ENGINE API and more specifically, the
217"control commands" mechanism, will provide some way for you to pass
218such commands through to ENGINEs. As such, you would select "dynamic"
219as the ENGINE to use, and the parameters/commands you pass would
220control the *actual* ENGINE used. Each command is actually a name-value
221pair and the value can sometimes be omitted (eg. the "LOAD" command).
222Whilst the syntax demonstrated in "openssl engine" uses a colon to
223separate the command name from the value, applications may provide
224their own syntax for making that separation (eg. a win32 registry
225key-value pair may be used by some applications). The reason for the
226"-pre" syntax in the "openssl engine" utility is that some commands
227might be issued to an ENGINE *after* it has been initialised for use.
228Eg. if an ENGINE implementation requires a smart-card to be inserted
229during initialisation (or a PIN to be typed, or whatever), there may be
230a control command you can issue afterwards to "forget" the smart-card
231so that additional initialisation is no longer possible. In
232applications such as web-servers, where potentially volatile code may
233run on the same host system, this may provide some arguable security
234value. In such a case, the command would be passed to the ENGINE after
235it has been initialised for use, and so the "-post" switch would be
236used instead. Applications may provide a different syntax for
237supporting this distinction, and some may simply not provide it at all
238("-pre" is almost always what you're after, in reality).
239
240How do I build a "dynamic" ENGINE?
241----------------------------------
242
243This question is trickier - currently OpenSSL bundles various ENGINE
244implementations that are statically built in, and any application that
245calls the "ENGINE_load_builtin_engines()" function will automatically
246have all such ENGINEs available (and occupying memory). Applications
247that don't call that function have no ENGINEs available like that and
248would have to use "dynamic" to load any such ENGINE - but on the other
249hand such applications would only have the memory footprint of any
250ENGINEs explicitly loaded using user/admin provided control commands.
251The main advantage of not statically linking ENGINEs and only using
252"dynamic" for hardware support is that any installation using no
253"external" ENGINE suffers no unnecessary memory footprint from unused
254ENGINEs. Likewise, installations that do require an ENGINE incur the
255overheads from only *that* ENGINE once it has been loaded.
256
257Sounds good? Maybe, but currently building an ENGINE implementation as
258a shared-library that can be loaded by "dynamic" isn't automated in
259OpenSSL's build process. It can be done manually quite easily however.
260Such a shared-library can either be built with any OpenSSL code it
261needs statically linked in, or it can link dynamically against OpenSSL
262if OpenSSL itself is built as a shared library. The instructions are
263the same in each case, but in the former (statically linked any
264dependencies on OpenSSL) you must ensure OpenSSL is built with
265position-independent code ("PIC"). The default OpenSSL compilation may
266already specify the relevant flags to do this, but you should consult
267with your compiler documentation if you are in any doubt.
268
269This example will show building the "atalla" ENGINE in the
270crypto/engine/ directory as a shared-library for use via the "dynamic"
271ENGINE.
272
273  1. "cd" to the crypto/engine/ directory of a pre-compiled OpenSSL
274     source tree.
275
276  2. Recompile at least one source file so you can see all the compiler
277     flags (and syntax) being used to build normally. Eg;
278
279         touch hw_atalla.c ; make
280
281     will rebuild "hw_atalla.o" using all such flags.
282
283  3. Manually enter the same compilation line to compile the
284     "hw_atalla.c" file but with the following two changes;
285      * add "-DENGINE_DYNAMIC_SUPPORT" to the command line switches,
286      * change the output file from "hw_atalla.o" to something new,
287        eg. "tmp_atalla.o"
288
289  4. Link "tmp_atalla.o" into a shared-library using the top-level
290     OpenSSL libraries to resolve any dependencies. The syntax for doing
291     this depends heavily on your system/compiler and is a nightmare
292     known well to anyone who has worked with shared-library portability
293     before. 'gcc' on Linux, for example, would use the following syntax;
294
295         gcc -shared -o dyn_atalla.so tmp_atalla.o -L../.. -lcrypto
296
297  5. Test your shared library using "openssl engine" as explained in the
298     previous section. Eg. from the top-level directory, you might try
299
300         apps/openssl engine -vvvv dynamic \
301               -pre SO_PATH:./crypto/engine/dyn_atalla.so -pre LOAD
302
303If the shared-library loads successfully, you will see both "-pre"
304commands marked as "SUCCESS" and the list of control commands
305displayed (because of "-vvvv") will be the control commands for the
306*atalla* ENGINE (ie. *not* the 'dynamic' ENGINE). You can also add
307the "-t" switch to the utility if you want it to try and initialise
308the atalla ENGINE for use to test any possible hardware/driver issues.
309
310PROBLEMS
311========
312
313It seems like the ENGINE part doesn't work too well with CryptoSwift on Win32.
314A quick test done right before the release showed that trying "openssl speed
315-engine cswift" generated errors. If the DSO gets enabled, an attempt is made
316to write at memory address 0x00000002.
317
318

README-FIPS.md

1OpenSSL FIPS support
2====================
3
4This release of OpenSSL includes a cryptographic module that is intended to be
5FIPS 140-2 validated. The module is implemented as an OpenSSL provider.
6A provider is essentially a dynamically loadable module which implements
7cryptographic algorithms, see the [README-PROVIDERS](README-PROVIDERS.md) file
8for further details.
9
10The OpenSSL FIPS provider comes as shared library called `fips.so` (on Unix)
11resp. `fips.dll` (on Windows). The FIPS provider does not get built and
12installed automatically. To enable it, you need to configure OpenSSL using
13the `enable-fips` option.
14
15Installing the FIPS module
16==========================
17
18If the FIPS provider is enabled, it gets installed automatically during the
19normal installation process. Simply follow the normal procedure (configure,
20make, make test, make install) as described in the [INSTALL](INSTALL.md) file.
21
22For example, on Unix the final command
23
24    $ make install
25
26effectively executes the following install targets
27
28    $ make install_sw
29    $ make install_ssldirs
30    $ make install_docs
31    $ make install_fips     # for `enable-fips` only
32
33The `install_fips` make target can also be invoked explicitly to install
34the FIPS provider independently, without installing the rest of OpenSSL.
35
36The Installation of the FIPS provider consists of two steps. In the first step,
37the shared library is copied to its installed location, which by default is
38
39    /usr/local/lib/ossl-modules/fips.so                  on Unix, and
40    C:\Program Files\OpenSSL\lib\ossl-modules\fips.dll   on Windows.
41
42In the second step, the `openssl fipsinstall` command is executed, which completes
43the installation by doing the following two things:
44
45- Runs the FIPS module self tests
46- Generates the so-called FIPS module configuration file containing information
47  about the module such as the self test status, and the module checksum.
48
49The FIPS module must have the self tests run, and the FIPS module config file
50output generated on every machine that it is to be used on. You must not copy
51the FIPS module config file output data from one machine to another.
52
53On Unix the `openssl fipsinstall` command will be invoked as follows by default:
54
55    $ openssl fipsinstall -out /usr/local/ssl/fipsmodule.cnf -module /usr/local/lib/ossl-modules/fips.so
56
57If you configured OpenSSL to be installed to a different location, the paths will
58vary accordingly. In the rare case that you need to install the fipsmodule.cnf
59to non-standard location, you can execute the `openssl fipsinstall` command manually.
60
61Using the FIPS Module in applications
62=====================================
63
64Documentation about using the FIPS module is available on the [fips_module(7)]
65manual page.
66
67 [fips_module(7)]: https://www.openssl.org/docs/manmaster/man7/fips_module.html
68

README-PROVIDERS.md

1Providers
2=========
3
4 - [Standard Providers](#standard-providers)
5    - [The Default Provider](#the-default-provider)
6    - [The Legacy Provider](#the-legacy-provider)
7    - [The FIPS Provider](#the-fips-provider)
8    - [The Base Provider](#the-base-provider)
9    - [The Null Provider](#the-null-provider)
10 - [Loading Providers](#loading-providers)
11
12Standard Providers
13==================
14
15Providers are containers for algorithm implementations. Whenever a cryptographic
16algorithm is used via the high level APIs a provider is selected. It is that
17provider implementation that actually does the required work. There are five
18providers distributed with OpenSSL. In the future we expect third parties to
19distribute their own providers which can be added to OpenSSL dynamically.
20Documentation about writing providers is available on the [provider(7)]
21manual page.
22
23 [provider(7)]: https://www.openssl.org/docs/manmaster/man7/provider.html
24
25The Default Provider
26--------------------
27
28The default provider collects together all of the standard built-in OpenSSL
29algorithm implementations. If an application doesn't specify anything else
30explicitly (e.g. in the application or via config), then this is the provider
31that will be used. It is loaded automatically the first time that we try to
32get an algorithm from a provider if no other provider has been loaded yet.
33If another provider has already been loaded then it won't be loaded
34automatically. Therefore if you want to use it in conjunction with other
35providers then you must load it explicitly.
36
37This is a "built-in" provider which means that it is compiled and linked
38into the libcrypto library and does not exist as a separate standalone module.
39
40The Legacy Provider
41-------------------
42
43The legacy provider is a collection of legacy algorithms that are either no
44longer in common use or considered insecure and strongly discouraged from use.
45However, some applications may need to use these algorithms for backwards
46compatibility reasons. This provider is **not** loaded by default.
47This may mean that some applications upgrading from earlier versions of OpenSSL
48may find that some algorithms are no longer available unless they load the
49legacy provider explicitly.
50
51Algorithms in the legacy provider include MD2, MD4, MDC2, RMD160, CAST5,
52BF (Blowfish), IDEA, SEED, RC2, RC4, RC5 and DES (but not 3DES).
53
54The FIPS Provider
55-----------------
56
57The FIPS provider contains a sub-set of the algorithm implementations available
58from the default provider, consisting of algorithms conforming to FIPS standards.
59It is intended that this provider will be FIPS140-2 validated.
60
61In some cases there may be minor behavioural differences between algorithm
62implementations in this provider compared to the equivalent algorithm in the
63default provider. This is typically in order to conform to FIPS standards.
64
65The Base Provider
66-----------------
67
68The base provider contains a small sub-set of non-cryptographic algorithms
69available in the default provider. For example, it contains algorithms to
70serialize and deserialize keys to files. If you do not load the default
71provider then you should always load this one instead (in particular, if
72you are using the FIPS provider).
73
74The Null Provider
75-----------------
76
77The null provider is "built-in" to libcrypto and contains no algorithm
78implementations. In order to guarantee that the default provider is not
79automatically loaded, the null provider can be loaded instead.
80
81This can be useful if you are using non-default library contexts and want
82to ensure that the default library context is never used unintentionally.
83
84Loading Providers
85=================
86
87Providers to be loaded can be specified in the OpenSSL config file.
88See the [config(5)] manual page for information about how to configure
89providers via the config file, and how to automatically activate them.
90
91 [config(5)]: https://www.openssl.org/docs/manmaster/man5/config.html
92
93The following is a minimal config file example to load and activate both
94the legacy and the default provider in the default library context.
95
96    openssl_conf = openssl_init
97
98    [openssl_init]
99    providers = provider_sect
100
101    [provider_sect]
102    default = default_sect
103    legacy = legacy_sect
104
105    [default_sect]
106    activate = 1
107
108    [legacy_sect]
109    activate = 1
110
111It is also possible to load providers programmatically. For example you can
112load the legacy provider into the default library context as shown below.
113Note that once you have explicitly loaded a provider into the library context
114the default provider will no longer be automatically loaded. Therefore you will
115often also want to explicitly load the default provider, as is done here:
116
117    #include <stdio.h>
118    #include <stdlib.h>
119
120    #include <openssl/provider.h>
121
122    int main(void)
123    {
124        OSSL_PROVIDER *legacy;
125        OSSL_PROVIDER *deflt;
126
127        /* Load Multiple providers into the default (NULL) library context */
128        legacy = OSSL_PROVIDER_load(NULL, "legacy");
129        if (legacy == NULL) {
130            printf("Failed to load Legacy provider\n");
131            exit(EXIT_FAILURE);
132        }
133        deflt = OSSL_PROVIDER_load(NULL, "default");
134        if (deflt == NULL) {
135            printf("Failed to load Default provider\n");
136            OSSL_PROVIDER_unload(legacy);
137            exit(EXIT_FAILURE);
138        }
139
140        /* Rest of application */
141
142        OSSL_PROVIDER_unload(legacy);
143        OSSL_PROVIDER_unload(deflt);
144        exit(EXIT_SUCCESS);
145    }
146

README.md

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