Skip to content

[CHANGED] TLS/Build: Requires SSL 1.1.1+ to compile, init/cleanup removed#905

Merged
kozlovic merged 1 commit into
mainfrom
fix_904
Sep 8, 2025
Merged

[CHANGED] TLS/Build: Requires SSL 1.1.1+ to compile, init/cleanup removed#905
kozlovic merged 1 commit into
mainfrom
fix_904

Conversation

@kozlovic

@kozlovic kozlovic commented Sep 5, 2025

Copy link
Copy Markdown
Member

Code was still trying to support SSL versions prior to 1.1, and some of the code for 1.1+ has been marked as deprecated and were no-ops.

This PR removes the openssl initialization and cleanup calls (that may have caused issues if application themselves try to cleanup SSL on exit), and has changed the CMakeLists.txt file to:

  • Remove the NATS_BUILD_TLS_USE_OPENSSL_1_1_API option
  • Requires OpenSSL 1.1.1 at minimum

Users that use -DNATS_BUILD_TLS_USE_OPENSSL_1_1_API=ON (which has been already the default for quite some time) would need to upgrade their script to avoid a warning. If this was explicitly set to OFF, and users use a SSL library pre 1.1.1, they may need to upgrade their SSL library.

Internal: also removed .travis.yml since we have been using GitHub actions.

Resolves #904

Signed-off-by: Ivan Kozlovic ivan@synadia.com

@codecov

codecov Bot commented Sep 5, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 70.23%. Comparing base (358f569) to head (a4f0e0d).
⚠️ Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
src/opts.c 50.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #905      +/-   ##
==========================================
+ Coverage   70.02%   70.23%   +0.21%     
==========================================
  Files          47       48       +1     
  Lines       15643    17236    +1593     
  Branches     3226     3538     +312     
==========================================
+ Hits        10954    12106    +1152     
- Misses       1589     1726     +137     
- Partials     3100     3404     +304     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kozlovic
kozlovic force-pushed the fix_904 branch 3 times, most recently from 0989887 to 23cb7f6 Compare September 5, 2025 15:59
…oved

Code was still trying to support SSL versions prior to 1.1, and some
of the code for 1.1+ has been marked as deprecated and were no-ops.

This PR removes the openssl initialization and cleanup calls (that may
have caused issues if application themselves try to cleanup SSL on exit),
and has changed the CMakeLists.txt file to:
- Remove the `NATS_BUILD_TLS_USE_OPENSSL_1_1_API` option
- Requires OpenSSL 1.1.1 at minimum

Users that use `-DNATS_BUILD_TLS_USE_OPENSSL_1_1_API=ON` (which has been
already the default for quite some time) would need to upgrade their script
to avoid a warning. If this was explicitly set to `OFF`, and users use a
SSL library pre 1.1.1, they may need to upgrade their SSL library.

Internal: also removed `.travis.yml` since we have been using GitHub actions
and `buildOnTravis.sh` and added additional tests (nonats and checkcpp) to GA.

Resolves #904

Signed-off-by: Ivan Kozlovic <ivan@synadia.com>

@mtmk mtmk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kozlovic
kozlovic marked this pull request as draft September 7, 2025 16:49
@kozlovic

kozlovic commented Sep 7, 2025

Copy link
Copy Markdown
Member Author

Switching to Draft at the moment because I am inquiring with an user that has to use older OpenSSL versions (that are indeed no longer supported), and since there is no actual reason to drop support for older OpenSSL versions at this time, I may revisit this PR, and still solve the issue originally reported about the cleanup on library unload (for OpenSSL versions past 1.1). I am waiting to hear from the user that uses older OpenSSL version.

@kozlovic

kozlovic commented Sep 8, 2025

Copy link
Copy Markdown
Member Author

Since the user that is known to use OpenSSL 1.0.2 agreed that it would be ok to drop support now, let's bite the bullet and drop support for the next NATS C client 3.11 release. I will also make some "breaking" changes in another PR to remove the OpenSSL dependency in nats.h.

@kozlovic
kozlovic marked this pull request as ready for review September 8, 2025 15:28
@kozlovic
kozlovic merged commit 67801b9 into main Sep 8, 2025
28 checks passed
@kozlovic
kozlovic deleted the fix_904 branch September 8, 2025 15:28
github-actions Bot pushed a commit that referenced this pull request Sep 8, 2025
kozlovic added a commit that referenced this pull request Sep 26, 2025
Release notes will be:

This release contains some breaking changes. See the "Changed" section below.

* Build
  * Disable NATS Streaming by default by @mtmk in #770
  * TLS
    * Require OpenSSL 1.1.1+ to compile. Removed the `NATS_BUILD_TLS_USE_OPENSSL_1_1_API` CMake variable by @kozlovic in #905
    * The option `natsOptions_SetSSLVerificationCallback` signature was changed to replace the use of `SSL_verify_cb` (which required OpenSSL dependency in the `nats.h` file), to the new callback `natsSSLVerifyCb`. See documentation of `natsSSLVerifyCb` to see the cast needed to compile with this new header file by @kozlovic in #908
* Modification of a `natsOptions` object if it has TLS/SSL configuration and is actively used by connections will now return a `NATS_ILLEGAL_STATE` by @kozlovic in #912

* Options
  * Ability to load the trusted CA certificates from a directory using the new option `natsOptions_LoadCATrustedCertificatesPath` by @kerbert101 in #862
  * Ability to connect via HTTP proxy for instance by adding a proxy connection handler using the new option `natsOptions_SetProxyConnHandler` by @wolfkor in #871 and @kozlovic in #897
  * Ability to load the certificate chain and key from a file on every connection attempt using the new option `natsOptions_LoadCertificatesChainDynamic` by @Matus-p in #901
  * Ability to perform concurrent TLS handshakes that may improve time it takes for concurrent connections to be established using the new option `natsOptions_AllowConcurrentTLSHandshakes ` by @kozlovic in #914. Issue was reported by @yanyongcheng in #899
* JetStream
  * Per-message TTL support (a NATS Server v2.11 feature) by @levb in #863
  * Pull consumer priority groups (a NATS Server v2.11 feature) by @levb in #869
* ObjectStore support by @kozlovic in #902. Thanks to @jfflynn41 and @alex1891 for the feedback in #876

* JetStream
  * Handling of publish asynchronous timeouts by @kozlovic in #886. Issue reported by @yanyongcheng in #880
* Timer insertion by @kozlovic in #883. Issue reported by @yanyongcheng in #881

* EventLoop:
  * Handling of possible failure on initial attach by @kozlovic in #918
  * LibEvent: `natsConnection_Close()` not closing the TCP connection by @kozlovic in #882. Issue was reported by @yanyongcheng in #879
  * Libuv: Possible crash if connection is destroyed while receiving data by @kozlovic in #889. Issue was reported by @yanyongcheng in #888
* KeyValue
  * Keys, History or watcher's next may incorrectly return `NATS_TIMEOUT` by @kozlovic in #917/ Issue was reported by @ArashPartow in #916
* MicroServices:
  * Wrong marshaling of `average_processing_time` by @kozlovic in #892. Issue was reported by @Archie3d in #890
  * Statistics error was always incremented by @kozlovic in #894. Issue was reported by @Archie3d in #893
* TLS
  * Unknown type name `SSL_verify_cb` by @kozlovic in #878. Issue was reported by @philipfoulkes in #877
  * Initialization and cleanup code related to OpenSSL was removed since it was deprecated for versions post OpenSSL 1.1. A cleanup function pertinent to 1.1+ code was possibly causing a problem. By @kozlovic in #905. Issue was reported by @vdeters in #904
  * Possible hang during handshake by @kozlovic in #907. Issue was reported by @etrochim in #906
  * Protect calls to `SSL_read` and `SSL_write` with a mutex. Since the same `SSL` object is shared between different threads, the OpenSSL library requires a mutex to be used by @kozlovic in #913
* Memory allocation check by @wooffie in #868
* Add missing status text string by @oldnick85 in #872 and @kozlovic in #874 (the issue was not present in any published release and was introduced in #869)
* Parsing of message headers with `NULL` or all-whitespace values by @habbbe in #873
* Removed some unused code related to handling of responses and added custom inbox with very long prefix test by @kozlovic in #885. Issue was reported by @yanyongcheng in #884
* Connection drain could cause missed reply and/or a 100ms delay by @kozlovic in #915. Issue was reported by @T-Maxxx in #911

* Build
  * Deprecated Ubuntu 20.04 in GitHub actions by @levb in #864
  * Removed the older compiler jobs by @levb in #865
  * Fixed Windows build to use the NATS Server main branch by @levb in #866

* @kerbert101 made their first contribution in #862
* @habbbe made their first contribution in #873
* @wolfkor made their first contribution in #871
* @Matus-p made their first contribution in #901

Signed-off-by: Ivan Kozlovic <ivan@synadia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

TLS cleanup calls sk_SSL_COMP_free() but does not reset pointers

2 participants