Go to file
Richard Levitte 1e55cbc874 DOCS: Move implementation specific docs away from provider-digest(7)
The provider- manuals are meant to describe the general interface for
their respective operation.  This is not the place to describe
implementation specific details.

This change creates a number of doc/man7/EVP_MD manuals, one for each
algorithm or set of algorithms, as well as doc/man7/EVP_MD-common.pod
to describe what's common to them all.

While we're at it, correct the SHA3 settable context params array to
match what's actually settable.

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/11270)
2020-03-10 13:32:06 +01:00
.github Add CIFuzz action 2020-03-05 17:34:11 +00:00
apps spkac: Check return values of NETSCAPE_SPKI functions 2020-03-09 11:51:51 +03:00
boringssl@2070f8ad91 Update ossl_config.json for later BoringSSL commit 2017-03-14 12:12:13 +00:00
Configurations Build: Generate apps/progs.c and apps/progs.h in build time 2020-03-02 03:34:30 +01:00
crypto DH: add internal dh_get_method() 2020-03-09 10:54:34 +01:00
demos Remove RANDFILE settings from configuration files 2019-11-24 08:35:14 +01:00
doc DOCS: Move implementation specific docs away from provider-digest(7) 2020-03-10 13:32:06 +01:00
engines Deprecate the low level RSA functions. 2020-02-20 18:58:40 +10:00
external/perl Update the bundled external perl module Text-Template to version 1.56 2019-09-12 12:53:32 +02:00
fuzz Deprecate the low level Diffie-Hellman functions. 2020-02-20 19:04:57 +10:00
include DH: add internal dh_get_method() 2020-03-09 10:54:34 +01:00
krb5@890ca2f401 Update the krb5 submodule 2019-12-25 12:45:32 -08:00
ms Unify all assembler file generators 2019-09-16 16:29:57 +02:00
os-dep Move Haiku configuration to separate config file to denote 2016-05-19 22:39:52 +02:00
providers DOCS: Move implementation specific docs away from provider-digest(7) 2020-03-10 13:32:06 +01:00
pyca-cryptography@09403100de Update the pyca-cryptography submodule 2018-09-10 12:04:03 +01:00
ssl Deprecate the low level Diffie-Hellman functions. 2020-02-20 19:04:57 +10:00
test Add -section option to 'req' command 2020-03-07 12:58:02 +03:00
tools Following the license change, modify the boilerplates in util/, tools/ 2018-12-06 14:17:23 +01:00
util Renew and extend the tool for checking adherence to C coding style rules 2020-03-09 11:03:21 +01:00
VMS Following the license change, modify the boilerplates in last few 2018-12-06 15:40:33 +01:00
.gitattributes Don't export the submodules 'boringssl', 'krb5' and 'pyca-cryptography' 2018-11-24 18:40:31 +01:00
.gitignore man1: make all openssl command line tool documentation generated. 2020-03-07 11:46:47 +10:00
.gitmodules [extended tests] Enable krb5 tests in Travis 2017-04-18 19:10:25 +02:00
.travis-apt-pin.preferences Fix travis clang-3.9 builds 2017-06-23 17:57:02 +01:00
.travis-create-release.sh Remove all 'make dist' artifacts 2018-11-23 12:40:32 +01:00
.travis.yml .travis.yml: where it matters, have build and source nesting levels differ 2020-03-04 12:55:57 +01:00
ACKNOWLEDGEMENTS.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
appveyor.yml Add a minimal build target for Travis and Appveyor 2020-02-11 13:22:39 +01:00
AUTHORS.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
build.info Add better support for using deprecated symbols internally 2019-12-13 10:09:49 +01:00
CHANGES.md Deprecate ASN1_sign(), ASN1_verify() and ASN1_digest() 2020-02-27 23:21:14 +01:00
config config, Configure: move the check of removed crypto/ sub-systems 2020-03-04 17:12:52 +01:00
config.com Following the license change, modify the boilerplates in last few 2018-12-06 15:40:33 +01:00
configdata.pm.in configdata.pm.in: Don't try to quotify undefined values 2019-12-04 00:19:40 +01:00
Configure config, Configure: move the check of removed crypto/ sub-systems 2020-03-04 17:12:52 +01:00
CONTRIBUTING.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
e_os.h Make secure-memory be a config option 2020-02-14 15:18:27 +01:00
FAQ.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
HACKING A very brief explanation of how to add custom functions to OpenSSL. 2019-07-08 20:09:13 +10:00
INSTALL.md Replace util/shlib_wrap.sh with util/wrap.pl in diverse docs 2020-02-27 08:49:14 +01:00
LICENSE Change license to the Apache License v2.0 2018-12-06 13:27:18 +01:00
NEWS.md doc: add missing NEWS entries for all versions >= 1.0.0 2020-02-26 21:06:17 +01:00
NOTES.ANDROID Remove spurious space from file. 2019-12-05 07:25:52 +10:00
NOTES.DJGPP Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
NOTES.PERL Fix typo in NOTES.PERL 2019-05-16 11:46:59 +10:00
NOTES.UNIX NOTES.UNIX: add "Linking your application" paragraph 2018-06-26 12:28:06 +02:00
NOTES.VALGRIND Replace util/shlib_wrap.sh with util/wrap.pl in diverse docs 2020-02-27 08:49:14 +01:00
NOTES.VMS Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
NOTES.WIN Configure: final cleanup of asm related things 2019-06-17 16:08:53 +02:00
README.ENGINE Remove bsd_cryptodev engine 2017-06-19 09:31:45 -04:00
README.FIPS
README.md doc: revamp the README file 2020-02-26 21:04:38 +01:00
SUPPORT.md doc: revamp the SUPPORT file 2020-02-26 21:06:17 +01:00
VERSION Configure: get version from the file 'VERSION' instead of 'opensslv.h' 2019-10-18 12:22:00 +02:00

openssl logo

travis badge appveyor badge

Welcome to the OpenSSL Project

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.

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 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.

Since 2016, development takes place in public on the GitHub open source platform. The OpenSSL Project Pages at openssl.github.io are a valuable source of information if you want to get familiar with our development process on GitHub.

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-2020 The OpenSSL Project

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

All rights reserved.