Go to file
Pauli c788f1c6be Add CHANGES entry
To match changes in #25526

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/25536)
2024-09-30 17:58:23 +10:00
.ctags.d
.github Add some more tests to the interop matrix and fixup a typo 2024-09-13 15:37:08 -04:00
apps http_server.{c,h}: make clear that IPv4 or IPv6 is used by http_server_init() 2024-09-23 22:15:49 +02:00
cloudflare-quiche@7ab6a55cfe
Configurations Build: Fix circular object deps with old GCC 2024-09-17 07:19:33 +02:00
crypto Check file name for not being NULL before opening it 2024-09-26 20:35:26 +02:00
demos review fixups for quic-hq-interop 2024-09-13 15:37:08 -04:00
dev Add known issues section 2023-11-29 08:35:17 +00:00
doc doc: fix typo in CRNG test documentation. 2024-09-30 17:57:18 +10:00
engines Prefer ARRAY_SIZE(...) 2024-07-22 06:55:35 -04:00
exporters exporters for pkg-config: align with the changes for CMake 2024-08-30 05:20:48 +02:00
external/perl
fuzz feat: add TCG / platform certificate OIDs 2024-09-05 17:22:40 +02:00
gost-engine@ede3886cc5 Update gost-engine submodule to fix the CI 2024-03-26 15:09:22 +01:00
include Rename list macros 2024-09-26 10:02:30 +02:00
krb5@784c38f50e Update krb5 to latest master to pick up CVE fixes 2024-08-14 17:57:43 +02:00
ms Copyright year updates 2024-04-09 13:43:26 +02:00
oqs-provider@0ec51eca39 updated to oqs-provider 0.6.0 2024-04-29 10:29:22 +02:00
os-dep Add an Apple privacy info file for OpenSSL 2024-04-26 14:01:36 +02:00
providers fips: Prohibit SHA1 in DH & ECDH exchange 2024-09-27 09:13:05 +02:00
pyca-cryptography@7e33b0e773
python-ecdsa@4de8d5bf89
ssl Check file name for not being NULL before opening it 2024-09-26 20:35:26 +02:00
test test: fix unit tests for fips CRNG tests 2024-09-30 17:58:09 +10:00
tlsfuzzer@dbd56c1490
tlslite-ng@771e9f59d6
tools
util check-format.pl: do checks regarding statement/block after for() also on {OSSL_,}LIST_FOREACH{,_*} 2024-09-24 22:19:12 +02:00
VMS Fix VMS installation - update vmsconfig.pm for consistency 2024-01-08 07:28:19 +01:00
wycheproof@2196000605
.git-blame-ignore-revs Add reformatting commit to .git-blame-ignore-revs 2024-03-11 12:18:03 +00:00
.gitattributes .ctags.d is previous, include it in our tarballs 2024-04-17 18:41:59 +02:00
.gitignore gitignore: add .DS_Store 2024-07-21 12:09:15 -04:00
.gitmodules
ACKNOWLEDGEMENTS.md
AUTHORS.md
build.info fix: for exporters to work for build config, there may be two include dirs 2024-08-27 17:20:12 +02:00
CHANGES.md Add CHANGES entry 2024-09-30 17:58:23 +10:00
CODE-OF-CONDUCT.md
config
config.com
configdata.pm.in
Configure Add debuginfo build target 2024-08-21 15:50:17 +02:00
CONTRIBUTING.md Use parent directory instead of index.html 2024-08-07 04:57:29 -04:00
HACKING.md
INSTALL.md Add debuginfo build target 2024-08-21 15:50:17 +02:00
LICENSE.txt
NEWS.md CHANGES.md, NEWS.md: Add 3.5 sections 2024-09-06 16:14:52 +02:00
NOTES-ANDROID.md Add support in configuration for android-riscv64 2024-02-05 10:08:23 +01:00
NOTES-ANSI.md Add installation documentation and notes on ANSI C and POSIX 2024-05-22 09:59:32 +02:00
NOTES-DJGPP.md
NOTES-NONSTOP.md Build: Fix circular object deps with old GCC 2024-09-17 07:19:33 +02:00
NOTES-PERL.md
NOTES-POSIX.md Add installation documentation and notes on ANSI C and POSIX 2024-05-22 09:59:32 +02:00
NOTES-UNIX.md
NOTES-VALGRIND.md Updated list formatting, added hyperlinks, modernized syntax 2024-04-18 11:02:29 +02:00
NOTES-VMS.md
NOTES-WINDOWS.md Fixes for defaults code 2024-07-09 04:01:44 -04:00
README-ENGINES.md
README-FIPS.md fips: allow to customize provider vendor name 2024-08-15 08:33:48 +10:00
README-PROVIDERS.md
README-QUIC.md Add a separate README for the guide demos 2023-10-30 07:54:00 +00:00
README.md Add interop status badge 2024-09-10 11:38:09 -04:00
SUPPORT.md
VERSION.dat Update the version to 3.5.0-dev 2024-09-12 19:22:48 +02:00

Welcome to the OpenSSL Project

openssl logo

github actions ci badge Nightly OS Zoo ci badge Provider Compatibility Quic Interop Daily checks

OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit for the TLS (formerly SSL), DTLS and QUIC (currently client side only) protocols.

The protocol implementations are based on a full-strength general purpose cryptographic library, which can also be used stand-alone. Also included is a cryptographic module validated to conform with FIPS standards.

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), DTLS protocol versions up to DTLSv1.2 (RFC 6347) and the QUIC (currently client side only) version 1 protocol (RFC 9000).

  • 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/DTLS and client and server tests
    • QUIC client 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.

We also maintain a list of third parties that produce OpenSSL binaries for various Operating Systems (including Windows) on the Binaries page on our wiki.

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.x from previous versions can be found in the ossl-guide-migration(7ossl) manual page.

Documentation

README Files

There are some README.md files in the top level of the source distribution containing additional information on specific topics.

The OpenSSL Guide

There are some tutorial and introductory pages on some important OpenSSL topics within the OpenSSL Guide.

Manual Pages

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

Demos

The are numerous source code demos for using various OpenSSL capabilities in the demos subfolder.

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-2024 The OpenSSL Project Authors

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

All rights reserved.