Go to file
Richard Levitte 1296c2ec78 Restore the meaning of EVP_PKEY_print_private()
With pre-3.0 OpenSSL, EVP_PKEY_print_private() calls the EVP_PKEY_ASN1_METHOD
function "priv_print", effectively asking the backend to print whatever it
regards as private key components.

In all backends that were built into libcrypto, this function printed what
was included in the private key structure, which usually includes the
public key components as well.

With OpenSSL 3.0, some of the corresponding key2text encoders got a
slightly different behavior, where the presence of the selector
OSSL_KEYMGMT_SELECT_PRIVATE_KEY without the presence of the selector
OSSL_KEYMGMT_SELECT_PUBLIC_KEY would only get what would intuitively be
regarded as private key components printed.  This isn't entirely consistent,
though, as the RSA key2text encoder will still print the public key
components regardless.

To compensate for the changed backend behavior, EVP_PKEY_print_private()
was made to ask the encoder to print the keypair rather than just the
private key, thereby moving the backend semantics to the application API.
Unfortunately, this causes confusion for providers where the key2text
encoder really should print the private key only.

This change restores the built-in 1.1.1 backend behavior in the encoders
that OpenSSL provides, and renders EVP_PKEY_print_private() more true to its
documented behavior, leaving it to the backend to decide what it regards as
"private key components".

Fixes #22233

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22237)
2023-10-04 08:10:55 +02:00
.ctags.d util/ctags.sh: a script for generating tags file with expanding macros 2023-05-18 13:29:43 +02:00
.github coveralls: Drop no-shared and -DFUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION 2023-10-03 17:23:58 +02:00
Configurations Configurations/unix-Makefile.tmpl: Ensure that md-nits always works 2023-10-02 12:38:51 +02:00
VMS Fix VMS installation - Check the presence of providers in the IVP script 2021-12-14 11:50:16 +00:00
apps Copyright year updates 2023-09-28 14:23:29 +01:00
cloudflare-quiche@7ab6a55cfe Update Cloudflare Quiche to fix a build issue 2023-08-29 14:51:33 +02:00
crypto Restore the meaning of EVP_PKEY_print_private() 2023-10-04 08:10:55 +02:00
demos Bad function definition 2023-09-11 10:15:30 +02:00
dev doc: add the migration guide to the new guide series 2023-08-23 18:17:53 +01:00
doc Remove duplicates of EVP_aes_xxx_wrap() from EVP_aes_128_gcm.pod 2023-10-04 10:54:46 +11:00
engines "foo * bar" should be "foo *bar" 2023-09-11 10:15:30 +02:00
external/perl Update the bundled external perl module Text-Template to version 1.56 2019-09-12 12:53:32 +02:00
fuzz Copyright year updates 2023-09-07 09:59:15 +01:00
gost-engine@2a8a5e0eca Update GOST engine commit to deal with test failure 2023-07-31 14:01:54 +01:00
include Restore the meaning of EVP_PKEY_print_private() 2023-10-04 08:10:55 +02:00
krb5@aa9b4a2a64 Update dependencies for krb5 external test 2021-06-23 10:26:53 +02:00
ms Copyright year updates 2023-09-07 09:59:15 +01:00
oqs-provider@8c746d7e29 updated (lib+)oqsprovider to latest releases 2023-06-15 08:39:10 +10:00
os-dep Fix copyrights 2022-02-03 13:56:38 +01:00
providers Restore the meaning of EVP_PKEY_print_private() 2023-10-04 08:10:55 +02:00
pyca-cryptography@7e33b0e773 Update pyca-cryptography submodule to fix CI 2022-12-16 18:24:16 +01:00
python-ecdsa@4de8d5bf89 TLSfuzzer: submodules 2022-01-05 11:24:51 +01:00
ssl Call post_process_record for dtls records 2023-10-04 10:54:01 +11:00
test Back off on generating noise in the event of a PING frame 2023-10-04 10:51:51 +11:00
tlsfuzzer@dbd56c1490 TLSfuzzer: submodules 2022-01-05 11:24:51 +01:00
tlslite-ng@771e9f59d6 TLSfuzzer: submodules 2022-01-05 11:24:51 +01:00
tools c_rehash: Fix file extension matching 2022-10-20 11:26:17 +02:00
util All lh_stats functions were deprecated in 3.1 2023-10-04 07:52:41 +11:00
wycheproof@2196000605 add wycheproof submodule 2021-04-27 19:09:03 +10:00
.gitattributes Remove the external BoringSSL test 2021-03-26 14:24:06 +01:00
.gitignore Update .gitignore with LSP files 2023-07-02 16:51:54 +10:00
.gitmodules Add openssl/fuzz-corpora repository as submodule 2023-04-11 10:41:56 +02:00
ACKNOWLEDGEMENTS.md Fix various typos, repeated words, align some spelling to LDP. 2022-10-12 16:55:28 +11:00
AUTHORS.md Add some missing committers to the AUTHORS list 2021-02-02 16:45:44 +01:00
CHANGES.md CHANGES.md: Mention new features added after 3.2 alpha1 2023-10-04 10:51:01 +11:00
CODE-OF-CONDUCT.md Add CODE-OF-CONDUCT.md 2022-08-18 16:32:23 +02:00
CONTRIBUTING.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
Configure Copyright year updates 2023-09-07 09:59:15 +01:00
FAQ.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
HACKING.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
INSTALL.md Optimize SM2 on aarch64 2023-08-24 14:57:35 +02:00
LICENSE.txt Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 2020-07-05 11:29:43 +02:00
NEWS.md Prepare for 3.2 alpha 3 2023-09-28 14:24:47 +01:00
NOTES-ANDROID.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02: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 Document limits on static and dynamic linking for HPE NonStop platforms. 2023-02-08 16:09:58 +01:00
NOTES-PERL.md Fix various typos, repeated words, align some spelling to LDP. 2022-10-12 16:55:28 +11:00
NOTES-UNIX.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
NOTES-VALGRIND.md changes opensssl typos to openssl 2021-12-10 15:18:22 +11:00
NOTES-VMS.md Add information on the 'ias' port for OpenVMS 2023-05-19 10:02:04 +10:00
NOTES-WINDOWS.md Update documentation to reflect new Windows on Arm configurations 2023-03-20 14:44:19 +01:00
README-ENGINES.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
README-FIPS.md Add FIPS build instructions 2023-07-14 11:35:23 +10:00
README-PROVIDERS.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
README.md doc: add the migration guide to the new guide series 2023-08-23 18:17:53 +01:00
SUPPORT.md Fix Markdown links in SUPPORT.md 2021-12-08 15:09:36 +11:00
VERSION.dat Prepare for 3.2 alpha 3 2023-09-28 14:24:47 +01:00
build.info build.info: Introduce special syntax for dependencies on script modules 2023-06-08 07:53:10 +02: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 Use $config{build_file} instead of $target{build_file} 2023-02-01 08:30:04 +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 can be found in the ossl-guide-migration(7ossl) manual 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-2023 The OpenSSL Project Authors

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

All rights reserved.