Go to file
Leonabcd123 9968040194 Fix typos and whitespace
Added "the" before "use"
Add missing whitespace
Removed unnecessary apostrophe in FIPS.md

CLA: trivial

Reviewed-by: Paul Yang <paulyang.inf@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/28362)
2025-08-30 09:38:01 -04:00
.ctags.d Call ctags on *.inc files as well 2025-08-08 12:22:10 -04:00
.github Remove unnecessary fetch-depth in GitHub Actions workflow 2025-08-20 08:23:14 -04:00
Configurations Add targets to skip build of non-installable programs 2025-08-29 09:01:47 -04:00
VMS
apps apps/speed.c: Support more signature algorithms 2025-08-20 16:14:09 +02:00
cloudflare-quiche@7ab6a55cfe
crypto rsa: convert to transient error state on import failure in FIPS provider 2025-08-30 09:10:59 -04:00
demos Fix: Add free to avoid memory leak. 2025-08-29 08:27:13 -04:00
dev Point to new docs location 2025-04-15 15:56:16 +01:00
doc Document the OSSL_SELF_TEST_TYPE_PCT_IMPORT failure state 2025-08-30 09:11:13 -04:00
engines Eliminate indentation tabs from *.c and *.h files 2025-08-06 08:17:05 +10:00
exporters
external/perl
fuzz Fix failure checking on rcu_read_lock 2025-08-09 09:22:13 -04:00
gost-engine@74b1f4fddb update to latest version of gost-engine 2025-04-09 14:04:09 -04:00
include Add OSSL_SELF_TEST_TYPE_PCT_IMPORT transient error state 2025-08-30 09:10:59 -04:00
krb5@784c38f50e
ms libapps + libcrypto: Silence warnings on Win64 builds 2025-07-02 17:26:26 +02:00
oqs-provider@7bc597c04b Update oqsprovider git submodule and start testing with it again 2025-02-21 17:17:54 +01:00
os-dep
pkcs11-provider@61bd6af6cc Update pkcs11-provider submodule 2025-05-20 21:29:14 +02:00
providers ml-kem: convert to transient error state on import failure in FIPS provider 2025-08-30 09:11:13 -04:00
pyca-cryptography@0e855f9526 update pyca-cryptography to latest master 2025-04-01 09:23:02 -04:00
python-ecdsa@4096fa0171
ssl Fix: Check for wrong object. The converted sc should be checked instead of the original s 2025-08-22 11:06:25 -04:00
test test/bioprinttest.c: move the %n result to the field that is later checked 2025-08-29 17:20:26 -04:00
tlsfuzzer@61f45d9701
tlslite-ng@77ef321dde
tools Better lookup for openssl executable 2025-06-30 10:42:05 +01:00
util Add targets to skip build of non-installable programs 2025-08-29 09:01:47 -04:00
wycheproof@aca4706625 update wycheproof submodule to latest master 2025-04-01 09:23:02 -04:00
.git-blame-ignore-revs
.gitattributes More polish and renamed codec tests 2025-02-14 10:50:58 +01:00
.gitignore Ignore generated assembler files for cpuid functions 2025-08-22 10:44:07 -04:00
.gitmodules the rpki-client external test should use relase version not a master branch on github 2025-08-09 09:38:39 -04:00
ACKNOWLEDGEMENTS.md
AUTHORS.md EVP_DecodeUpdate() should not produce padding zeros to the decoded output (Fixes #26677) 2025-02-27 17:38:57 +00:00
CHANGES.md changes: add a CHANGES.md entry covering the generated parameter name decoding 2025-08-22 15:33:20 +10:00
CODE-OF-CONDUCT.md
CONTRIBUTING.md
Configure fix: Apply cascade-disables before showing status 2025-08-11 16:52:01 +02:00
HACKING.md Add more instructions in HACKING.md 2025-05-23 18:08:51 +02:00
INSTALL.md add a handshake memory failure test 2025-08-06 09:07:40 -04:00
LICENSE.txt
NEWS.md fips: add news & changes entry for DetECDSA 2025-08-21 09:59:55 +10:00
NOTES-ANDROID.md
NOTES-C99.md Document transition from ANSI-C towards C-99 2025-06-10 19:58:41 +02:00
NOTES-DJGPP.md
NOTES-NONSTOP.md
NOTES-PERL.md
NOTES-POSIX.md
NOTES-UNIX.md
NOTES-VALGRIND.md
NOTES-VMS.md
NOTES-WINDOWS.md NOTES-WINDOWS.md: correct the Windows context macro name 2025-08-29 11:07:30 -04:00
README-ENGINES.md
README-FIPS.md Fix typos and whitespace 2025-08-30 09:38:01 -04:00
README-PROVIDERS.md Point to new docs location 2025-04-15 15:56:16 +01:00
README-QUIC.md Fix typos and whitespace 2025-08-30 09:38:01 -04:00
README.md README.md: Improve links to GH workflow badges 2025-05-29 16:32:54 +02:00
SUPPORT.md
VERSION.dat Prepare for 3.6 2025-03-12 13:37:30 +00:00
build.info keymgmt: update template 2025-08-22 15:33:20 +10:00
config
config.com
configdata.pm.in
funding.json Fix a funding.json error 2025-01-07 17:18:36 +00:00

README.md

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 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 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 openssl-library.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 main OpenSSL Git repository is private. There is a public GitHub mirror of it 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 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 GitHub mirror 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

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

Wiki

There is a GitHub Wiki which is currently not very active.

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

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

All rights reserved.