A local copy of OpenSSL from GitHub
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Dr. Matthias St. Pierre d8dc853825 Change CVE link style in CHANGES and NEWS
Replace [collapsed reference links][] for the CVEs by
[shortcut reference links], in order to to improve the
readability of the raw markdown text.

Consistently add parentheses around the CVE links at the
end of the CVE descriptions. (The NEWS file already had
the parentheses, in the CHANGES file they where missing.)

[collapsed reference links]:
  https://github.github.com/gfm/#collapsed-reference-link

[shortcut reference links]:
  https://github.github.com/gfm/#shortcut-reference-link

Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/12967)
3 years ago
.github Fix typos and repeated words 3 years ago
Configurations Configure: handle undefined shared_target. 3 years ago
VMS Following the license change, modify the boilerplates in last few 5 years ago
apps APPS: Reduce deprecation warning suppression - ENGINE 3 years ago
boringssl@2070f8ad91 Update ossl_config.json for later BoringSSL commit 6 years ago
crypto ffc: add _ossl to exported but internal functions 3 years ago
demos Update copyright year 3 years ago
dev dev/release.sh: Rework to be smoother 3 years ago
doc doc: remove duplicated code in example 3 years ago
engines Fix some things the rename script didn't quite get right 3 years ago
external/perl Update the bundled external perl module Text-Template to version 1.56 4 years ago
fuzz Some OIDs used in Russian X.509 certificates. 3 years ago
gost-engine@b008f2a0ff Update gost-engine to fix API rename 3 years ago
include ffc: add _ossl to exported but internal functions 3 years ago
krb5@890ca2f401 Update the krb5 submodule 3 years ago
ms Unify all assembler file generators 4 years ago
os-dep Move Haiku configuration to separate config file to denote 7 years ago
providers ffc: add _ossl to exported but internal functions 3 years ago
pyca-cryptography@09403100de Update the pyca-cryptography submodule 5 years ago
ssl TLS AEAD ciphers: more bytes for key_block than needed 3 years ago
test ffc: add _ossl to exported but internal functions 3 years ago
tools Following the license change, modify the boilerplates in util/, tools/ 5 years ago
util Configuration: add initial NonStop values in OpenSSL::config 3 years ago
.gitattributes Developer scripts: Release script 3 years ago
.gitignore Add auto-gen SM2 der files into .gitignore 3 years ago
.gitmodules GOST external tests 3 years ago
.travis-apt-pin.preferences Fix travis clang-3.9 builds 6 years ago
.travis-create-release.sh Remove all 'make dist' artifacts 5 years ago
.travis.yml Travis: default to HARNESS_JOBS=4 3 years ago
ACKNOWLEDGEMENTS.md Fix issues reported by markdownlint 3 years ago
AUTHORS.md Fix issues reported by markdownlint 3 years ago
CHANGES.md Change CVE link style in CHANGES and NEWS 3 years ago
CONTRIBUTING.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
Configure Configure: handle undefined shared_target. 3 years ago
FAQ.md doc: introduce some minimalistic markdown without essential changes 3 years ago
HACKING.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
INSTALL.md Add option to fipsinstall to disable fips security checks at run time. 3 years ago
LICENSE.txt Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 3 years ago
NEWS.md Change CVE link style in CHANGES and NEWS 3 years ago
NOTES-Android.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
NOTES-DJGPP.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
NOTES-Perl.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
NOTES-Unix.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
NOTES-VMS.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
NOTES-Valgrind.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
NOTES-Windows.txt Fix markdown nits in NOTES-Windows.txt 3 years ago
NOTES.HPNS NonStop port updates for 3.0.0. 3 years ago
README-Engine.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
README-FIPS.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 3 years ago
README.md README.md: remove incorrect link to openssl.github.io 3 years ago
SUPPORT.md Fix issues reported by markdownlint 3 years ago
VERSION.dat Prepare for 3.0 alpha 7 3 years ago
appveyor.yml appveyor.yml: Clean up minimal configuration, adding no-ec and pruning cascaded no-* 3 years ago
build.info Update err.h to use the new lhash generation code 3 years ago
config config: Turn into a simple wrapper 3 years ago
config.com Update copyright year 3 years ago
configdata.pm.in configdata.pm.in: Don't try to quotify undefined values 4 years ago
e_os.h NonStop port updates for 3.0.0. 3 years ago

README.md

Welcome to the OpenSSL Project

openssl logo

travis badge appveyor badge

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.

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.

Copyright

Copyright (c) 1998-2020 The OpenSSL Project

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

All rights reserved.