mirror of https://github.com/openssl/openssl.git synced 2024-11-27 05:21:51 +08:00

Go to file

olszomal d6aafeb107 Use the untrusted certificate chain to create a valid certificate ID for OCSP_request Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22192)		2024-03-12 14:02:13 +01:00
.ctags.d
.github	Dont run the self-hosted workflows when not available	2024-03-07 18:27:02 +01:00
apps	Use the untrusted certificate chain to create a valid certificate ID for OCSP_request	2024-03-12 14:02:13 +01:00
cloudflare-quiche@7ab6a55cfe
Configurations	Ensure `$(MAKE)` commands and `CFLAGS` are appropriately quoted in the Makefile.	2024-02-25 08:57:16 +01:00
crypto	PKCS7: Remove one of the duplicate checks	2024-03-11 15:19:15 +01:00
demos	demos/http3: Use `SSL_write_ex2()` together with `SSL_WRITE_FLAG_CONCLUDE`	2024-03-01 10:56:16 +01:00
dev
doc	Doc: fix style	2024-03-12 06:44:45 +01:00
engines
exporters
external/perl
fuzz	Don't print excessively long ASN1 items in fuzzer	2024-02-21 16:45:33 +00:00
gost-engine@2a8a5e0eca
include	Fix BIO_get_new_index() to return an error when it is exhausted.	2024-03-11 11:34:25 +00:00
krb5@aa9b4a2a64
ms
oqs-provider@8c746d7e29
os-dep
providers	Implement PCT for EDDSA	2024-03-01 11:06:03 +01:00
pyca-cryptography@7e33b0e773
python-ecdsa@4de8d5bf89
ssl	QUIC: Add stream write buffer queries	2024-03-09 08:56:59 +00:00
test	Fix BIO_get_new_index() to return an error when it is exhausted.	2024-03-11 11:34:25 +00:00
tlsfuzzer@dbd56c1490
tlslite-ng@771e9f59d6
tools
util	Make the generated params_idx.c file deterministic if run multiple	2024-03-11 12:08:00 +00:00
VMS
wycheproof@2196000605
.git-blame-ignore-revs	Add reformatting commit to .git-blame-ignore-revs	2024-03-11 12:18:03 +00:00
.gitattributes
.gitignore
.gitmodules
ACKNOWLEDGEMENTS.md
AUTHORS.md
build.info
CHANGES.md	Fix BIO_get_new_index() to return an error when it is exhausted.	2024-03-11 11:34:25 +00:00
CODE-OF-CONDUCT.md
config
config.com
configdata.pm.in
Configure	Enable qlog support by default	2024-03-06 20:44:48 +00:00
CONTRIBUTING.md	CONTRIBUTING.md: add missing "on"	2024-02-07 11:11:57 +01:00
HACKING.md
INSTALL.md	Minor wording fixes related to no-atexit	2024-02-22 10:37:13 +01:00
LICENSE.txt
NEWS.md	Amend CHANGES.md/NEWS.md to reflect DN output changes	2024-02-09 12:54:20 +01:00
NOTES-ANDROID.md	Add support in configuration for android-riscv64	2024-02-05 10:08:23 +01:00
NOTES-DJGPP.md
NOTES-NONSTOP.md	Add atexit configuration option to using atexit() in libcrypto at build-time.	2024-02-01 20:26:42 -05:00
NOTES-PERL.md
NOTES-UNIX.md
NOTES-VALGRIND.md
NOTES-VMS.md
NOTES-WINDOWS.md
README-ENGINES.md
README-FIPS.md
README-PROVIDERS.md
README-QUIC.md
README.md
SUPPORT.md
VERSION.dat

README.md

Welcome to the OpenSSL Project

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.

Overview
Download
Build and Install
Documentation
License
Support
Contributing
Legalities

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.