Go to file
Shane Lontis 884314cab7 Add OSSL_PARAM_dup() and OSSL_PARAM_merge().
These functions are prerequisites for implementing EVP_PKEY_todata().

OSSL_PARAM_dup() is required to make a deep copy of the exported
params (since the provider export() uses a OSSL_PARAM_BLD which throws away the
data after the call), and then use OSSL_PARAM_merge() to add some additional params
that can be passed to the EVP_PKEY_todata().

Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14785)
2021-04-12 16:55:29 +10:00
.github Add macosx build 2021-04-01 16:46:42 +10:00
Configurations Corrected missing definitions from NonStop SPT build. 2021-04-01 15:52:25 +02:00
VMS VMS documentation fixes 2021-02-12 15:57:25 +01:00
apps apps: fix warning about size_t / int conversion 2021-04-09 16:20:47 +02:00
crypto Add OSSL_PARAM_dup() and OSSL_PARAM_merge(). 2021-04-12 16:55:29 +10:00
demos Update copyright year 2021-04-08 13:04:41 +01:00
dev Update copyright year 2021-02-18 15:05:17 +00:00
doc Add OSSL_PARAM_dup() and OSSL_PARAM_merge(). 2021-04-12 16:55:29 +10:00
engines Update copyright year 2021-03-11 13:27:36 +00:00
external/perl
fuzz Add a local perl module to get year last changed 2021-03-31 13:59:53 +02:00
gost-engine@28a0a19354 CI: add job with external tests 2021-03-05 14:27:46 +01:00
include Add OSSL_PARAM_dup() and OSSL_PARAM_merge(). 2021-04-12 16:55:29 +10:00
krb5@890ca2f401
ms
os-dep
providers kmac: fix customistation string overflow bug 2021-04-12 14:59:09 +10:00
pyca-cryptography@e09cd90f77 CI: add job with external tests 2021-03-05 14:27:46 +01:00
ssl Fix typo in statem_clnt.c 2021-04-09 17:02:58 +10:00
test Add OSSL_PARAM_dup() and OSSL_PARAM_merge(). 2021-04-12 16:55:29 +10:00
tools Update copyright year 2021-03-11 13:27:36 +00:00
util Add OSSL_PARAM_dup() and OSSL_PARAM_merge(). 2021-04-12 16:55:29 +10:00
.gitattributes Remove the external BoringSSL test 2021-03-26 14:24:06 +01:00
.gitignore
.gitmodules Remove the external BoringSSL test 2021-03-26 14:24:06 +01:00
.travis-apt-pin.preferences
.travis-create-release.sh
ACKNOWLEDGEMENTS.md
AUTHORS.md Add some missing committers to the AUTHORS list 2021-02-02 16:45:44 +01:00
CHANGES.md Prepare for 3.0 alpha 15 2021-04-08 13:15:59 +01:00
CONTRIBUTING.md Drop Travis 2021-01-25 13:41:23 +01:00
Configure Configure: Check if 128-bit integers are supported by compiler 2021-04-08 12:18:10 +01:00
FAQ.md
HACKING.md
INSTALL.md Moved build instructions from the man page 2021-03-29 15:09:58 +02:00
LICENSE.txt
NEWS.md Prepare for 3.0 alpha 15 2021-04-08 13:15:59 +01:00
NOTES-ANDROID.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
NOTES-DJGPP.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
NOTES-NONSTOP.md
NOTES-PERL.md Reformat some NOTES and README files 2021-02-12 20:41:27 +01:00
NOTES-UNIX.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
NOTES-VALGRIND.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
NOTES-VMS.md Reformat some NOTES and README files 2021-02-12 20:41:27 +01:00
NOTES-WINDOWS.md NOTES-WINDOWS: fix typo 2021-02-12 20:41:58 +01:00
README-ENGINES.md README-ENGINES: fix the link to the provider API README 2021-02-15 19:33:53 +01:00
README-FIPS.md Update README-FIPS.md 2021-03-19 13:44:32 +10:00
README-PROVIDERS.md Add a skeleton README-PROVIDERS file 2021-02-12 20:41:58 +01:00
README.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +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 15 2021-04-08 13:15:59 +01:00
appveyor.yml appveyor.yml: clarify conditions for building the plain configuration 2021-02-23 19:08:39 +01:00
build.info Configuration: ensure that 'no-tests' works correctly 2021-02-09 17:05:06 +10:00
config
config.com
configdata.pm.in
e_os.h Update copyright year 2021-04-08 13:04:41 +01:00

README.md

Welcome to the OpenSSL Project

openssl logo

github actions ci 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-2021 The OpenSSL Project

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

All rights reserved.