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

Go to file

Richard Levitte b830e00429 Diverse build.info: Adjust paths Fixes #12815 Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/12816)		2020-09-10 09:50:56 +02:00
.github
apps	bugfix in apps/cmp.c and cmp_client.c: inconsistencies on retrieving extraCerts in code and doc	2020-09-10 07:40:45 +02:00
boringssl@2070f8ad91
Configurations	Fix markdown nits in NOTES-Windows.txt	2020-09-10 08:57:55 +10:00
crypto	Diverse build.info: Adjust paths	2020-09-10 09:50:56 +02:00
demos
dev
doc	bugfix in apps/cmp.c and cmp_client.c: inconsistencies on retrieving extraCerts in code and doc	2020-09-10 07:40:45 +02:00
engines	STORE: Move the built-in 'file:' loader to become an engine module	2020-09-03 17:48:32 +02:00
external/perl
fuzz	Add 4 new OIDs for PKIX key purposes and 3 new CMP information types	2020-09-08 23:22:29 +02:00
gost-engine@b008f2a0ff
include	ENCODER: Refactor provider implementations, and some cleanup	2020-09-09 16:35:22 +02:00
krb5@890ca2f401
ms
os-dep
providers	ENCODER: Refactor provider implementations, and some cleanup	2020-09-09 16:35:22 +02:00
pyca-cryptography@09403100de
ssl	TLS fixes for CBC mode and no-deprecated	2020-09-09 17:59:08 +10:00
test	Diverse build.info: Adjust paths	2020-09-10 09:50:56 +02:00
tools
util	Deprecate SHA and MD5 again.	2020-09-09 17:58:54 +10:00
VMS
.gitattributes
.gitignore
.gitmodules
.travis-apt-pin.preferences
.travis-create-release.sh
.travis.yml
ACKNOWLEDGEMENTS.md
appveyor.yml
AUTHORS.md
build.info
CHANGES.md	Support writing RSA keys using the traditional format again	2020-09-09 18:32:10 +02:00
config
config.com
configdata.pm.in
Configure
CONTRIBUTING.md
e_os.h
FAQ.md
HACKING.md
INSTALL.md
LICENSE.txt
NEWS.md
NOTES-Android.md
NOTES-DJGPP.md
NOTES-Perl.md
NOTES-Unix.md
NOTES-Valgrind.md
NOTES-VMS.md
NOTES-Windows.txt	Fix markdown nits in NOTES-Windows.txt	2020-09-10 08:57:55 +10:00
README-Engine.md
README-FIPS.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 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 wiki.

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.