mirror of https://github.com/openssl/openssl.git synced 2024-12-21 06:09:35 +08:00

Go to file

Tomas Mraz 2741128e9d Move the PROV_R reason codes to a public header The PROV_R codes can be returned to applications so it is useful to have some common set of provider reason codes for the applications or third party providers. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/14086)		2021-02-11 09:34:31 +01:00
.github	Add a CI job to run the threads test with threads sanitizer on	2021-02-02 12:21:33 +00:00
apps	Simplify the EVP_PKEY_XXX_fromdata_XX methods.	2021-02-08 16:33:43 +10:00
boringssl@2070f8ad91
Configurations	Makefile template: Allow separate generation of .pod.in -> .pod	2021-02-05 15:51:31 +01:00
crypto	Move the PROV_R reason codes to a public header	2021-02-11 09:34:31 +01:00
demos
dev	dev/release.sh: Fix typo	2021-02-05 14:13:52 +01:00
doc	Match description with actual output of dgst	2021-02-11 10:19:21 +10:00
engines	ERR: Rebuild all generated error headers and source files	2021-02-05 14:09:16 +01:00
external/perl
fuzz	Add some PKIX-RPKI objects	2021-02-02 10:32:27 +01:00
gost-engine@b008f2a0ff
include	Move the PROV_R reason codes to a public header	2021-02-11 09:34:31 +01:00
krb5@890ca2f401
ms
os-dep
providers	Move the PROV_R reason codes to a public header	2021-02-11 09:34:31 +01:00
pyca-cryptography@09403100de
ssl	Remove unused 'peer_type' from SSL_SESSION	2021-02-09 20:26:16 -08:00
test	test: turn off parallel tests in verbose mode.	2021-02-11 08:16:29 +10:00
tools
util	Deprecate BN_pseudo_rand() and BN_pseudo_rand_range()	2021-02-09 13:41:11 +01:00
VMS
.gitattributes
.gitignore
.gitmodules
.travis-apt-pin.preferences
.travis-create-release.sh
ACKNOWLEDGEMENTS.md
appveyor.yml	{.travis,ci,appveyor}.yml: Make minimal config consistent, add no-deprecated no-ec no-ktls no-siv	2020-12-04 16:20:53 +01:00
AUTHORS.md	Add some missing committers to the AUTHORS list	2021-02-02 16:45:44 +01:00
build.info	Configuration: ensure that 'no-tests' works correctly	2021-02-09 17:05:06 +10:00
CHANGES.md	CHANGES.md: Mention RSA key generation slowdown related changes	2021-02-09 13:45:04 +01:00
config
config.com
configdata.pm.in
Configure	Stop disabling TLSv1.3 if ec and dh are disabled	2021-02-05 15:22:40 +00:00
CONTRIBUTING.md	Drop Travis	2021-01-25 13:41:23 +01:00
e_os.h
FAQ.md
HACKING.md
INSTALL.md	{.travis,ci,appveyor}.yml: Make minimal config consistent, add no-deprecated no-ec no-ktls no-siv	2020-12-04 16:20:53 +01:00
LICENSE.txt
NEWS.md	Prepare for 3.0 alpha 12	2021-01-28 14:08:31 +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.txt
README-Engine.md
README-FIPS.md
README.md	Update copyright year	2021-01-28 13:54:57 +01:00
SUPPORT.md
VERSION.dat	Prepare for 3.0 alpha 12	2021-01-28 14:08:31 +01:00

README.md

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.

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

Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as known issues are available on the OpenSSL 3.0 Wiki page.

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