Go to file
Richard Levitte 16feca7154 STORE: Move the built-in 'file:' loader to become an engine module
From this point on, this engine must be specifically specified.

To replace the internal EMBEDDED hack with something unique for the
new module, functions to create application specific OSSL_STORE_INFO
types were added.

Furthermore, the following function had to be exported:

ossl_do_blob_header()
ossl_do_PVK_header()
asn1_d2i_read_bio()

Finally, evp_pkcs82pkey_int() has become public under a new name,
EVP_PKCS82PKEY_with_libctx()

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12587)
2020-09-03 17:48:32 +02:00
.github Fix typos and repeated words 2020-07-05 01:49:20 +02:00
Configurations STORE: Move the built-in 'file:' loader to become an engine module 2020-09-03 17:48:32 +02:00
VMS
apps apps/cmp.c: Clean up loading of certificates and CRLs 2020-09-02 14:00:10 +02:00
boringssl@2070f8ad91
crypto STORE: Move the built-in 'file:' loader to become an engine module 2020-09-03 17:48:32 +02:00
demos Update copyright year 2020-08-06 13:22:30 +01:00
dev Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 2020-07-05 11:29:43 +02:00
doc STORE: Move the built-in 'file:' loader to become an engine module 2020-09-03 17:48:32 +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 libctx and propq parameters to OSSL_CMP_{SRV_},CTX_new() and ossl_cmp_mock_srv_new() 2020-08-21 09:04:11 +02:00
gost-engine@b008f2a0ff Update gost-engine to fix API rename 2020-08-07 23:13:14 +03:00
include STORE: Move the built-in 'file:' loader to become an engine module 2020-09-03 17:48:32 +02:00
krb5@890ca2f401 Update the krb5 submodule 2019-12-25 12:45:32 -08:00
ms Unify all assembler file generators 2019-09-16 16:29:57 +02:00
os-dep
providers STORE: Move the built-in 'file:' loader to become an engine module 2020-09-03 17:48:32 +02:00
pyca-cryptography@09403100de
ssl Convert ssl3_cbc_digest_record() to use EVP_MD_is_a() 2020-09-03 09:40:52 +01:00
test Avoid uninitialised variable warning for jobs 2020-09-02 09:05:31 +03:00
tools
util STORE: Move the built-in 'file:' loader to become an engine module 2020-09-03 17:48:32 +02:00
.gitattributes Developer scripts: Release script 2020-04-21 10:11:41 +02:00
.gitignore Change the provider implementation of X942kdf to use wpacket to do der encoding of sharedInfo 2020-08-04 12:18:51 +10:00
.gitmodules GOST external tests 2020-05-23 22:04:21 +03:00
.travis-apt-pin.preferences
.travis-create-release.sh
.travis.yml Travis: default to HARNESS_JOBS=4 2020-07-02 16:48:15 +03: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 Rename OSSL_SERIALIZER / OSSL_DESERIALIZER to OSSL_ENCODE / OSSL_DECODE 2020-08-21 09:23:58 +02:00
CONTRIBUTING.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
Configure deprecate engines in 3.0 2020-07-16 09:12:26 +02:00
FAQ.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
HACKING.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
INSTALL.md install: add notes about ignored seed sources in the FIPS provider. 2020-07-17 22:16:11 +10:00
LICENSE.txt Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 2020-07-05 11:29:43 +02:00
NEWS.md Rename OSSL_SERIALIZER / OSSL_DESERIALIZER to OSSL_ENCODE / OSSL_DECODE 2020-08-21 09:23:58 +02: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-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 Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 2020-07-05 11:29:43 +02: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 README.md: remove incorrect link to openssl.github.io 2020-08-11 12:28:02 +02:00
SUPPORT.md Fix issues reported by markdownlint 2020-05-08 16:22:02 +02:00
VERSION.dat Prepare for 3.0 alpha 7 2020-08-06 14:02:31 +01:00
appveyor.yml Prevent extended tests run unexpectedly in appveyor 2020-06-02 11:34:32 +02:00
build.info engines: fixed to work with EVP_*_meth calls deprecated 2020-07-22 20:19:01 +10:00
config config: Turn into a simple wrapper 2020-06-28 18:34:36 +02:00
config.com Update copyright year 2020-07-16 14:47:04 +02:00
configdata.pm.in configdata.pm.in: Don't try to quotify undefined values 2019-12-04 00:19:40 +01:00
e_os.h Enable WinCE build without deceiving _MSC_VER. 2020-07-15 23:03:22 +02: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.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.