mirror of https://github.com/openssl/openssl.git synced 2024-11-21 01:15:20 +08:00

Go to file

Richard Levitte 2ac569a67b Clean up exporters, specifically those we have for pkg-config The pkg-config exporters were a special hack, all in Configurations/unix-Makefile.tmpl, and this was well and good as long as that was the only main package interface configuration system that we cared about. Things have changed, though, so we move the pkg-config production to be templatable in a more flexible manner. Additional templates for other interface configuration systems can then be added fairly easily. Two variants of the .pc files are produced: - Those in 'exporters/' are installed in the location that 'pkg-config' itself prefers for installed packages. - Those in the top directory are to be used when it's desirable to build directly against an OpenSSL build tree. Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20878)		2023-11-15 08:22:29 +01:00
.ctags.d
.github	Rearrange some CI jobs	2023-11-14 13:57:23 +01:00
apps	Augment rand argument parsing to allow scaling	2023-11-13 12:21:34 +01:00
cloudflare-quiche@7ab6a55cfe
Configurations	Clean up exporters, specifically those we have for pkg-config	2023-11-15 08:22:29 +01:00
crypto	Enable AES and SHA3 optimisations on Apple Silicon M3-based macOS systems	2023-11-14 08:10:54 +01:00
demos	cms demos: print signingTime attributes	2023-11-10 13:06:46 +01:00
dev
doc	Augment rand argument parsing to allow scaling	2023-11-13 12:21:34 +01:00
engines
exporters	Clean up exporters, specifically those we have for pkg-config	2023-11-15 08:22:29 +01:00
external/perl
fuzz	Exclude more in the fuzz introspector report	2023-11-14 17:00:07 +01:00
gost-engine@2a8a5e0eca
include	Add EVP_DigestSqueeze() API.	2023-11-10 13:27:00 +01:00
krb5@aa9b4a2a64
ms
oqs-provider@8c746d7e29
os-dep
providers	Properly limit the variable output size for BLAKE2	2023-11-13 12:13:17 +01:00
pyca-cryptography@7e33b0e773
python-ecdsa@4de8d5bf89
ssl	set_client_ciphersuite(): Fix for potential UB if session->cipher is NULL	2023-11-13 12:52:43 +01:00
test	Augment rand argument parsing to allow scaling	2023-11-13 12:21:34 +01:00
tlsfuzzer@dbd56c1490
tlslite-ng@771e9f59d6
tools
util	Clean up exporters, specifically those we have for pkg-config	2023-11-15 08:22:29 +01:00
VMS
wycheproof@2196000605
.gitattributes
.gitignore	Clean up exporters, specifically those we have for pkg-config	2023-11-15 08:22:29 +01:00
.gitmodules
ACKNOWLEDGEMENTS.md
AUTHORS.md
build.info	Clean up exporters, specifically those we have for pkg-config	2023-11-15 08:22:29 +01:00
CHANGES.md	Add CHANGES.md and NEWS.md entry for CVE-2023-5678	2023-11-08 17:35:56 +01:00
CODE-OF-CONDUCT.md
config
config.com
configdata.pm.in
Configure
CONTRIBUTING.md
FAQ.md
HACKING.md
INSTALL.md	Fix parenthesis, use a colon	2023-10-13 17:23:50 +02:00
LICENSE.txt
NEWS.md	Add CHANGES.md and NEWS.md entry for CVE-2023-5678	2023-11-08 17:35:56 +01:00
NOTES-ANDROID.md
NOTES-DJGPP.md
NOTES-NONSTOP.md
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	Add a separate README for the guide demos	2023-10-30 07:54:00 +00:00
README.md	Add a separate README for the guide demos	2023-10-30 07:54:00 +00:00
SUPPORT.md
VERSION.dat	Prepare for 3.3	2023-10-27 17:01:44 +01:00

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.