Go to file
Richard Levitte a6a5dec611 APPS: Make it possible for apps to set the base (fallback) UI_METHOD
The apps UI method acts as a proxy that bases its activity on a base
(was called fallback) UI_METHOD, which defaults to UI_OpenSSL() under
normal circumstances.

However, some apps might want to have it based on another UI_METHOD,
such as UI_null() to avoid prompting (typical for a -batch run).  The
new function set_base_ui_method() allows them to do precisely this.

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/13512)
2020-11-26 17:04:21 +01:00
.github Turn on Github CI 2020-11-24 12:02:53 +00:00
Configurations Modify the ERR init functions to use the internal ERR string loaders 2020-11-24 15:21:44 +01:00
VMS
apps APPS: Make it possible for apps to set the base (fallback) UI_METHOD 2020-11-26 17:04:21 +01:00
boringssl@2070f8ad91
crypto Update copyright year 2020-11-26 14:18:57 +00:00
demos Update copyright year 2020-08-06 13:22:30 +01:00
dev dev/release.sh: improve instruction for pushing the tag 2020-10-17 11:54:34 +02:00
doc DOC: Add note on how to terminate an OSSL_PARAM array 2020-11-26 11:10:43 +01:00
engines ERR: Rebuild all generated error headers and source files 2020-11-24 15:22:33 +01:00
external/perl
fuzz Deprecate RSA harder 2020-11-18 23:38:34 +01:00
gost-engine@b008f2a0ff Update gost-engine to fix API rename 2020-08-07 23:13:14 +03:00
include Update copyright year 2020-11-26 14:18:57 +00:00
krb5@890ca2f401
ms
os-dep
providers Update copyright year 2020-11-26 14:18:57 +00:00
pyca-cryptography@09403100de
ssl Update copyright year 2020-11-26 14:18:57 +00:00
test Update copyright year 2020-11-26 14:18:57 +00:00
tools
util Add missing ERR_load_KDF_strings(3) to util/missingcrypto111.txt as well. 2020-11-24 15:22:33 +01:00
.gitattributes TEST: Make our test data binary 2020-11-24 11:01:58 +01:00
.gitignore Fix some missed usage of DEFINE_LHASH_OF() 2020-10-30 14:24:30 +00:00
.gitmodules
.travis-apt-pin.preferences
.travis-create-release.sh
.travis.yml Fix dsa securitycheck for fips. 2020-11-16 17:21:57 +10:00
ACKNOWLEDGEMENTS.md
AUTHORS.md
CHANGES.md Prepare for 3.0 alpha 10 2020-11-26 14:53:26 +00:00
CONTRIBUTING.md Change markdown link style in README, INSTALL, SUPPORT and CONTRIBUTING 2020-10-18 13:28:08 +02:00
Configure Configure: handle undefined shared_target. 2020-09-29 16:08:04 +02:00
FAQ.md
HACKING.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
INSTALL.md Change markdown link style in README, INSTALL, SUPPORT and CONTRIBUTING 2020-10-18 13:28:08 +02:00
LICENSE.txt
NEWS.md Prepare for 3.0 alpha 10 2020-11-26 14:53:26 +00:00
NOTES-Android.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
NOTES-DJGPP.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
NOTES-NONSTOP.md Rewrite the HPE NonStop Notes file in Markdown with more explanations. 2020-10-28 17:18:26 +01:00
NOTES-Perl.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
NOTES-Unix.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
NOTES-VMS.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
NOTES-Valgrind.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
NOTES-Windows.txt Fix markdown nits in NOTES-Windows.txt 2020-09-10 08:57:55 +10:00
README-Engine.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
README-FIPS.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
README.md fix typo in README 2020-11-03 17:58:12 +01:00
SUPPORT.md Fix SUPPORT.md for better readability 2020-11-14 16:42:41 +01:00
VERSION.dat Prepare for 3.0 alpha 10 2020-11-26 14:53:26 +00:00
appveyor.yml appveyor.yml: Clean up minimal configuration, adding no-ec and pruning cascaded no-* 2020-09-28 15:51:54 +02:00
build.info Fix some missed usage of DEFINE_LHASH_OF() 2020-10-30 14:24:30 +00:00
config
config.com Update copyright year 2020-07-16 14:47:04 +02:00
configdata.pm.in configdata.pm.in, util/dofile.pl: Make a HERE document stricter. 2020-10-27 10:17:19 +01:00
e_os.h Implement OpenSSL secure memory for Windows 2020-10-22 12:11:35 +10: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 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.

Copyright

Copyright (c) 1998-2020 The OpenSSL Project

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

All rights reserved.