Go to file
Neil Horman bbfffbcaf3 Fix SSL_stream_reset for stream objects which have FIN bit set
When calling SSL_stream_reset on a QUIC stream object that has received
all data that is expected to be sent (i.e. when the sender has sent a
STREAM frame with the FIN bit set), we encounter the following segfault:

Program received signal SIGSEGV, Segmentation fault.
0x00007ffff7f0bd28 in ossl_quic_sstream_get_final_size (qss=0x0, final_size=0x0) at ssl/quic/quic_sstream.c:273
273	    if (!qss->have_final_size)
(gdb) bt
0)  0x00007ffff7f0bd28 in ossl_quic_sstream_get_final_size (qss=0x0, final_size=0x0) at ssl/quic/quic_sstream.c:273
1)  0x00007ffff7ef65bf in quic_validate_for_write (xso=0x5555555efcb0, err=0x7fffffffd5e0) at ssl/quic/quic_impl.c:2513
2)  0x00007ffff7ef8ae3 in ossl_quic_stream_reset (ssl=0x5555555efcb0, args=0x0, args_len=0) at ssl/quic/quic_impl.c:3657
3)  0x00007ffff7ebdaa6 in SSL_stream_reset (s=0x5555555efcb0, args=0x0, args_len=0) at ssl/ssl_lib.c:7635
4)  0x0000555555557527 in build_request_set (
    req_list=0x55555555ebd0 "neil1.txt neil2.txt neil3.txt neil4.txt neil5.txt neil6.txt neil7.txt neil8.txt neil9.txt neil10.txt neil11.txt neil12.txt neil13.txt neil14.txt neil15.txt neil16.txt neil17.txt neil18.txt neil19.txt "..., ssl=0x5555555b6f80)
    at demos/guide/quic-hq-interop.c:545
5)  0x00005555555587b2 in main (argc=4, argv=0x7fffffffe568) at demos/guide/quic-hq-interop.c:941

This occurs because:
1) When the stream FIN bit is set, the quic stack frees the underlying
   stream structures immediately within the QUIC stack
and
2) when SSL_stream_reset is called, the call stack indicates we call
   quic_validate_for_write, which attempts to access the
   xso->stream->sstream QUIC_SSTREAM object, which was already freed in
   (1)

The fix I think is pretty straightforward.  On receipt of a STREAM frame
with a FIN bit set, the QUIC stack sets the QUIC_STREAM object state to
QUIC_SSTREAM_STATE_DATA_RECVD, which means we can use that state to
simply assert that the stream is valid for write, which allows it to be
reset properly.

Fixes #25410

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/25910)
2024-11-13 10:55:08 -05:00
.ctags.d util/ctags.sh: a script for generating tags file with expanding macros 2023-05-18 13:29:43 +02:00
.github Adjustments for the on schedule workflows 2024-11-13 12:15:35 +01:00
apps APPS/load_key_certs_crls(): refactor to clean up the code a little and add clarifying comments 2024-11-12 12:27:46 +01:00
cloudflare-quiche@7ab6a55cfe Update Cloudflare Quiche to fix a build issue 2023-08-29 14:51:33 +02:00
Configurations Build: Fix circular object deps with old GCC 2024-09-17 07:19:33 +02:00
crypto feat: define and use ossl_bio_print_hex 2024-11-13 11:53:34 +01:00
demos Remove sslkeylog file setup from quic-hq-interop 2024-10-30 11:49:11 +00:00
dev Add known issues section 2023-11-29 08:35:17 +00:00
doc feat: define and use ossl_bio_print_hex 2024-11-13 11:53:34 +01:00
engines Avoid undefined behaviour with the <ctype.h> functions. 2024-10-10 20:47:48 +02:00
exporters exporters for pkg-config: align with the changes for CMake 2024-08-30 05:20:48 +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 feat: add TCG / platform certificate OIDs 2024-09-05 17:22:40 +02:00
gost-engine@ede3886cc5 Update gost-engine submodule to fix the CI 2024-03-26 15:09:22 +01:00
include feat: define and use ossl_bio_print_hex 2024-11-13 11:53:34 +01:00
krb5@784c38f50e Update krb5 to latest master to pick up CVE fixes 2024-08-14 17:57:43 +02:00
ms Copyright year updates 2024-04-09 13:43:26 +02:00
oqs-provider@c0ee292723 Updated oqsprovider to v0.7.0 2024-10-23 11:12:33 +11:00
os-dep Add an Apple privacy info file for OpenSSL 2024-04-26 14:01:36 +02:00
pkcs11-provider@8757cf26a8 test: Add external test for pkcs11-provider 2024-10-21 11:43:03 +01:00
providers fips no-des: compile out TDES KAT 2024-10-24 15:27:43 +02:00
pyca-cryptography@7e33b0e773 Update pyca-cryptography submodule to fix CI 2022-12-16 18:24:16 +01:00
python-ecdsa@4096fa0171 update tlsfuzzer to new version 2024-10-21 11:40:16 +01:00
ssl Fix SSL_stream_reset for stream objects which have FIN bit set 2024-11-13 10:55:08 -05:00
test test: the attributeDescriptor X.509v3 extension 2024-11-13 11:53:34 +01:00
tlsfuzzer@61f45d9701 update tlsfuzzer to new version 2024-10-21 11:40:16 +01:00
tlslite-ng@77ef321dde update tlsfuzzer to new version 2024-10-21 11:40:16 +01:00
tools c_rehash: Fix file extension matching 2022-10-20 11:26:17 +02:00
util doc: the attributeDescriptor X.509v3 extension 2024-11-13 11:53:34 +01:00
VMS Fix VMS installation - update vmsconfig.pm for consistency 2024-01-08 07:28:19 +01:00
wycheproof@2196000605 add wycheproof submodule 2021-04-27 19:09:03 +10:00
.git-blame-ignore-revs Add reformatting commit to .git-blame-ignore-revs 2024-03-11 12:18:03 +00:00
.gitattributes .ctags.d is previous, include it in our tarballs 2024-04-17 18:41:59 +02:00
.gitignore gitignore: add .DS_Store 2024-07-21 12:09:15 -04:00
.gitmodules test: Add external test for pkcs11-provider 2024-10-21 11:43:03 +01: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
build.info fix: for exporters to work for build config, there may be two include dirs 2024-08-27 17:20:12 +02:00
CHANGES.md Support DEFAULT keyword and '-' prefix in SSL_CTX_set1_groups_list() 2024-11-04 11:49:49 +01:00
CODE-OF-CONDUCT.md Add CODE-OF-CONDUCT.md 2022-08-18 16:32:23 +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
Configure Add sslkeylog config option and implementation 2024-10-21 11:34:35 +01:00
CONTRIBUTING.md Use parent directory instead of index.html 2024-08-07 04:57:29 -04:00
HACKING.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
INSTALL.md updating comments in test recipie 2024-10-21 11:34:35 +01:00
LICENSE.txt Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 2020-07-05 11:29:43 +02:00
NEWS.md apps: Change default cipher to aes-256-cbc for req, cms and smime apps 2024-11-04 09:56:55 +01:00
NOTES-ANDROID.md Add support in configuration for android-riscv64 2024-02-05 10:08:23 +01:00
NOTES-ANSI.md Add installation documentation and notes on ANSI C and POSIX 2024-05-22 09:59:32 +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 Build: Fix circular object deps with old GCC 2024-09-17 07:19:33 +02:00
NOTES-PERL.md Fix various typos, repeated words, align some spelling to LDP. 2022-10-12 16:55:28 +11:00
NOTES-POSIX.md Add installation documentation and notes on ANSI C and POSIX 2024-05-22 09:59:32 +02:00
NOTES-UNIX.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
NOTES-VALGRIND.md Updated list formatting, added hyperlinks, modernized syntax 2024-04-18 11:02:29 +02:00
NOTES-VMS.md Add information on the 'ias' port for OpenVMS 2023-05-19 10:02:04 +10:00
NOTES-WINDOWS.md Fixes for defaults code 2024-07-09 04:01:44 -04:00
README-ENGINES.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
README-FIPS.md fips: mention the internal jitter source in the FIPS README 2024-10-09 13:53:10 +11:00
README-PROVIDERS.md Fixed some grammar and spelling 2022-10-09 17:40:29 +02:00
README-QUIC.md Add a separate README for the guide demos 2023-10-30 07:54:00 +00:00
README.md Add interop status badge 2024-09-10 11:38:09 -04:00
SUPPORT.md Fix Markdown links in SUPPORT.md 2021-12-08 15:09:36 +11:00
VERSION.dat Update the version to 3.5.0-dev 2024-09-12 19:22:48 +02:00

Welcome to the OpenSSL Project

openssl logo

github actions ci badge Nightly OS Zoo ci badge Provider Compatibility Quic Interop Daily checks

OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit for the TLS (formerly SSL), DTLS and QUIC (currently client side only) protocols.

The protocol implementations are based on a full-strength general purpose cryptographic library, which can also be used stand-alone. Also included is a cryptographic module validated to conform with FIPS standards.

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), DTLS protocol versions up to DTLSv1.2 (RFC 6347) and the QUIC (currently client side only) version 1 protocol (RFC 9000).

  • 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/DTLS and client and server tests
    • QUIC client 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.

We also maintain a list of third parties that produce OpenSSL binaries for various Operating Systems (including Windows) on the Binaries page on our wiki.

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.x from previous versions can be found in the ossl-guide-migration(7ossl) manual page.

Documentation

README Files

There are some README.md files in the top level of the source distribution containing additional information on specific topics.

The OpenSSL Guide

There are some tutorial and introductory pages on some important OpenSSL topics within the OpenSSL Guide.

Manual Pages

The manual pages for the master branch and all current stable releases are available online.

Demos

The are numerous source code demos for using various OpenSSL capabilities in the demos subfolder.

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-2024 The OpenSSL Project Authors

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

All rights reserved.