Go to file
Richard Levitte 2f44c8151e config: Turn into a simple wrapper
Now that Configure called config.pm's functions directly, the 'config'
script doesn't have much else to do than to pass arguments.

Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/11230)
2020-06-28 18:34:36 +02:00
.github Add github sponsor button 2020-06-04 21:04:13 +02:00
Configurations Configuration: do not overwrite BASE_unix ex_libs in AIX 2020-06-27 09:21:42 +02:00
VMS
apps Update copyright year 2020-06-25 14:13:12 +01:00
boringssl@2070f8ad91
crypto Make the ASYNC code default libctx aware 2020-06-28 10:55:52 +02:00
demos Cleanup cert config files for tests 2020-06-03 09:56:56 +02:00
dev dev/release.sh: Add --reviewer to set reviewers 2020-05-15 11:20:31 +01:00
doc Make the ASYNC code default libctx aware 2020-06-28 10:55:52 +02:00
engines Update copyright year 2020-05-15 14:09:49 +01:00
external/perl
fuzz Improve ossl_cmp_msg_check_received() and rename to ossl_cmp_msg_check_update() 2020-06-13 15:13:21 +02:00
gost-engine@30860f9403 Update gost-engine submodule to match EVP_MAC renaming 2020-06-17 09:09:11 +10:00
include CORE: Add an internal function to distinguish the global default context 2020-06-28 10:55:52 +02:00
krb5@890ca2f401 Update the krb5 submodule 2019-12-25 12:45:32 -08:00
ms
os-dep
providers Update copyright year 2020-06-25 14:13:12 +01:00
pyca-cryptography@09403100de
ssl Reduce the security bits for MD5 and SHA1 based signatures in TLS 2020-06-27 08:41:40 +02:00
test Add a test to make sure ASYNC aware code gets the right default libctx 2020-06-28 10:55:52 +02:00
tools
util util/perl/OpenSSL/config.pm: refactor map_guess() 2020-06-28 18:34:35 +02:00
.gitattributes Developer scripts: Release script 2020-04-21 10:11:41 +02:00
.gitignore Add evp_extra_test2 to .gitignore 2020-06-19 10:34:58 +01:00
.gitmodules GOST external tests 2020-05-23 22:04:21 +03:00
.travis-apt-pin.preferences
.travis-create-release.sh
.travis.yml Avoid undefined behavior with unaligned accesses 2020-05-27 20:11:20 +02:00
ACKNOWLEDGEMENTS.md Fix issues reported by markdownlint 2020-05-08 16:22:02 +02:00
AUTHORS.md Fix issues reported by markdownlint 2020-05-08 16:22:02 +02:00
CHANGES.md Update NEWS and CHANGES 2020-06-28 10:55:51 +02:00
CONTRIBUTING.md Fix issues reported by markdownlint 2020-05-08 16:22:02 +02:00
Configure util/perl/OpenSSL/config.pm: refactor map_guess() 2020-06-28 18:34:35 +02:00
FAQ.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
HACKING
INSTALL.md INSTALL.md: Restore $ as command prompt indicator 2020-06-27 10:20:27 +02:00
LICENSE
NEWS.md Update NEWS and CHANGES 2020-06-28 10:55:51 +02:00
NOTES.ANDROID Andoid cross compile: change ANDROID_NDK_HOME to ANDROID_NDK_ROOT 2020-03-14 04:26:56 +01:00
NOTES.DJGPP
NOTES.PERL Update and extend NOTES.WIN, adding 'Quick start' subsection 2020-06-13 15:21:38 +02:00
NOTES.UNIX
NOTES.VALGRIND Replace util/shlib_wrap.sh with util/wrap.pl in diverse docs 2020-02-27 08:49:14 +01:00
NOTES.VMS
NOTES.WIN Update and extend NOTES.WIN, adding 'Quick start' subsection 2020-06-13 15:21:38 +02:00
README.ENGINE
README.FIPS
README.md Fix issues reported by markdownlint 2020-05-08 16:22:02 +02:00
SUPPORT.md Fix issues reported by markdownlint 2020-05-08 16:22:02 +02:00
VERSION Prepare for 3.0 alpha 5 2020-06-25 15:00:39 +01:00
appveyor.yml Prevent extended tests run unexpectedly in appveyor 2020-06-02 11:34:32 +02:00
build.info Add better support for using deprecated symbols internally 2019-12-13 10:09:49 +01:00
config config: Turn into a simple wrapper 2020-06-28 18:34:36 +02:00
config.com
configdata.pm.in configdata.pm.in: Don't try to quotify undefined values 2019-12-04 00:19:40 +01:00
e_os.h Update copyright year 2020-04-23 13:55:52 +01:00

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