Go to file
Tomas Mraz 0778364f8e Document the stack functions that are forgiving
I.e., those that can be called with NULL stack parameter or invalid index.

Reviewed-by: Todd Short <todd.short@me.com>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19400)
2022-10-21 18:02:35 +02:00
.github CI: add Clang 15 2022-10-21 15:56:32 +02:00
apps Replace BIO_free(bio_err) with BIO_free_all(bio_err) 2022-10-21 16:09:57 +02:00
Configurations Add ZSTD compression support (RFC8478bis) 2022-10-18 09:30:21 -04:00
crypto stack: Do not add error if pop/shift/value accesses outside of the stack 2022-10-21 18:02:35 +02:00
demos apps & al : Fix various typos, repeated words, align some spelling to LDP. 2022-10-12 16:55:28 +11:00
dev Use --release in dev/release.sh 2022-05-18 18:44:42 +02:00
doc Document the stack functions that are forgiving 2022-10-21 18:02:35 +02:00
engines Add af_alg errors to the error queue 2022-10-21 12:59:14 +02:00
external/perl Update the bundled external perl module Text-Template to version 1.56 2019-09-12 12:53:32 +02:00
fuzz Add Content Type OID for RPKI id-ct-signedTAL 2022-10-03 11:49:04 +11:00
gost-engine@b2b4d629f1 Update gost-engine to the last changes 2022-05-24 12:06:11 +02:00
include crypto: thread: serialize concurrent joins 2022-10-21 12:44:56 +02:00
krb5@aa9b4a2a64 Update dependencies for krb5 external test 2021-06-23 10:26:53 +02:00
ms Update copyright year 2021-04-22 14:38:44 +01:00
oqs-provider@3f3d8a8cf3 update oqsprovider/liboqs to v0.7.2 2022-09-12 08:40:45 +02:00
os-dep Fix copyrights 2022-02-03 13:56:38 +01:00
providers Avoid putting ripemd_prov.c in libcommon otherwise it is regarded as fips source 2022-10-19 13:21:01 +02:00
pyca-cryptography@277ee0d58c update pyca cryptography to 38.0.2 2022-10-21 10:31:58 +11:00
python-ecdsa@4de8d5bf89 TLSfuzzer: submodules 2022-01-05 11:24:51 +01:00
ssl stack: Do not add error if pop/shift/value accesses outside of the stack 2022-10-21 18:02:35 +02:00
test stack: Do not add error if pop/shift/value accesses outside of the stack 2022-10-21 18:02:35 +02:00
tlsfuzzer@dbd56c1490 TLSfuzzer: submodules 2022-01-05 11:24:51 +01:00
tlslite-ng@771e9f59d6 TLSfuzzer: submodules 2022-01-05 11:24:51 +01:00
tools c_rehash: Fix file extension matching 2022-10-20 11:26:17 +02:00
util Add support for compressed certificates (RFC8879) 2022-10-18 09:30:22 -04:00
VMS Fix VMS installation - Check the presence of providers in the IVP script 2021-12-14 11:50:16 +00:00
wycheproof@2196000605 add wycheproof submodule 2021-04-27 19:09:03 +10:00
.gitattributes Remove the external BoringSSL test 2021-03-26 14:24:06 +01:00
.gitignore Update gitignore 2022-08-19 13:11:36 -04:00
.gitmodules Add external testing with oqsprovider 2022-03-09 17:57:37 +01:00
ACKNOWLEDGEMENTS.md Fix various typos, repeated words, align some spelling to LDP. 2022-10-12 16:55:28 +11:00
appveyor.yml Simplify AppVeyor configuration 2021-05-01 13:13:11 +10:00
AUTHORS.md Add some missing committers to the AUTHORS list 2021-02-02 16:45:44 +01:00
build.info Remove include/openssl/configuration.h from mandatory dependencies 2022-05-25 22:41:06 +02:00
CHANGES.md Remove changes entry for RIPEMD160 in 3.2 2022-10-21 17:53:25 +02:00
CODE-OF-CONDUCT.md Add CODE-OF-CONDUCT.md 2022-08-18 16:32:23 +02:00
config config: Turn into a simple wrapper 2020-06-28 18:34:36 +02:00
config.com Update copyright year 2020-07-16 14:47:04 +02:00
configdata.pm.in Configuration: produce include/openssl/configuration.h when configuring 2022-05-22 17:33:08 +02:00
Configure Convert ZLIB defines to OPENSSL_NO_ZLIB 2022-10-18 09:30:21 -04:00
CONTRIBUTING.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
FAQ.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
HACKING.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
INSTALL.md Add ZSTD compression support (RFC8478bis) 2022-10-18 09:30:21 -04:00
LICENSE.txt Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 2020-07-05 11:29:43 +02:00
NEWS.md Add support for compressed certificates (RFC8879) 2022-10-18 09:30:22 -04:00
NOTES-ANDROID.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
NOTES-DJGPP.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
NOTES-NONSTOP.md Add multilib to the NonStop configuration definitions. 2021-08-25 16:51:47 +02:00
NOTES-PERL.md Fix various typos, repeated words, align some spelling to LDP. 2022-10-12 16:55:28 +11:00
NOTES-UNIX.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
NOTES-VALGRIND.md changes opensssl typos to openssl 2021-12-10 15:18:22 +11:00
NOTES-VMS.md Fix issues found by md-nits 2021-05-28 11:14:46 +02:00
NOTES-WINDOWS.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
README-ENGINES.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
README-FIPS.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
README-PROVIDERS.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
README.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
SUPPORT.md Fix Markdown links in SUPPORT.md 2021-12-08 15:09:36 +11:00
VERSION.dat Change all references to OpenSSL 3.1 to OpenSSL 3.2 in the master branch 2022-10-07 10:05:50 +02:00

Welcome to the OpenSSL Project

openssl logo

github actions ci badge appveyor badge

OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit for the Transport Layer Security (TLS) protocol formerly known as the Secure Sockets Layer (SSL) protocol. The protocol implementation is based on a full-strength general purpose cryptographic library, which can also be used stand-alone.

OpenSSL is descended from the SSLeay library developed by Eric A. Young and Tim J. Hudson.

The official Home Page of the OpenSSL Project is www.openssl.org.

Table of Contents

Overview

The OpenSSL toolkit includes:

  • libssl an implementation of all TLS protocol versions up to TLSv1.3 (RFC 8446).

  • libcrypto a full-strength general purpose cryptographic library. It constitutes the basis of the TLS implementation, but can also be used independently.

  • openssl the OpenSSL command line tool, a swiss army knife for cryptographic tasks, testing and analyzing. It can be used for

    • creation of key parameters
    • creation of X.509 certificates, CSRs and CRLs
    • calculation of message digests
    • encryption and decryption
    • SSL/TLS client and server tests
    • handling of S/MIME signed or encrypted mail
    • and more...

Download

For Production Use

Source code tarballs of the official releases can be downloaded from www.openssl.org/source. The OpenSSL project does not distribute the toolkit in binary form.

However, for a large variety of operating systems precompiled versions of the OpenSSL toolkit are available. In particular, on Linux and other Unix operating systems, it is normally recommended to link against the precompiled shared libraries provided by the distributor or vendor.

For Testing and Development

Although testing and development could in theory also be done using the source tarballs, having a local copy of the git repository with the entire project history gives you much more insight into the code base.

The official OpenSSL Git Repository is located at git.openssl.org. There is a GitHub mirror of the repository at github.com/openssl/openssl, which is updated automatically from the former on every commit.

A local copy of the Git Repository can be obtained by cloning it from the original OpenSSL repository using

git clone git://git.openssl.org/openssl.git

or from the GitHub mirror using

git clone https://github.com/openssl/openssl.git

If you intend to contribute to OpenSSL, either to fix bugs or contribute new features, you need to fork the OpenSSL repository openssl/openssl on GitHub and clone your public fork instead.

git clone https://github.com/yourname/openssl.git

This is necessary because all development of OpenSSL nowadays is done via GitHub pull requests. For more details, see Contributing.

Build and Install

After obtaining the Source, have a look at the INSTALL file for detailed instructions about building and installing OpenSSL. For some platforms, the installation instructions are amended by a platform specific document.

Specific notes on upgrading to OpenSSL 3.0 from previous versions can be found in the migration_guide(7ossl) manual page.

Documentation

Manual Pages

The manual pages for the master branch and all current stable releases are available online.

Wiki

There is a Wiki at wiki.openssl.org which is currently not very active. It contains a lot of useful information, not all of which is up-to-date.

License

OpenSSL is licensed under the Apache License 2.0, which means that you are free to get and use it for commercial and non-commercial purposes as long as you fulfill its conditions.

See the LICENSE.txt file for more details.

Support

There are various ways to get in touch. The correct channel depends on your requirement. See the SUPPORT file for more details.

Contributing

If you are interested and willing to contribute to the OpenSSL project, please take a look at the CONTRIBUTING file.

Legalities

A number of nations restrict the use or export of cryptography. If you are potentially subject to such restrictions, you should seek legal advice before attempting to develop or distribute cryptographic code.

Copyright

Copyright (c) 1998-2022 The OpenSSL Project

Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson

All rights reserved.