From 0ac6c4448638f4f6c13aeb126136e6efd8f82d01 Mon Sep 17 00:00:00 2001 From: Bret McGuire Date: Tue, 19 Sep 2023 12:24:01 -0500 Subject: [PATCH 1/4] Add brief section on OpenSSL 3.x to building doc --- topics/building/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/topics/building/README.md b/topics/building/README.md index 69fe9a89f..b59c72c96 100644 --- a/topics/building/README.md +++ b/topics/building/README.md @@ -27,7 +27,7 @@ The C/C++ driver depends on the following software: * [CMake] v2.8.12+ * [libuv] 1.x * Kerberos v5 ([Heimdal] or [MIT]) \* -* [OpenSSL] v1.0.x or v1.1.x \*\* +* [OpenSSL] v1.0.x, v1.1.x or v3.x \*\* * [zlib] v1.x \*\*\* __\*__ Use the `CASS_USE_KERBEROS` CMake option to enable/disable Kerberos @@ -42,6 +42,16 @@ __\*\*\*__ Use the `CASS_USE_ZLIB` CMake option to enable/disable zlib support. Disabling this option will disable DataStax Astra support within the driver; defaults to `On`. +### A Brief Note on OpenSSL 3.x + +Migrating from OpenSSL 1.1.x to 3.x largely involves avoiding the use of many functions which are now deprecated (consult +the [migration guide] for much more detail on this point). The driver does not use any of these functions so we expect +the transition to OpenSSL 3.x to be relatively painless. We will also note that two officially supported platforms +(Ubuntu 22.04 and Rocky Linux 9.2) come with OpenSSL 3.x by default and the unit and integration tests all pass on these +platforms. + +Given these results we expect the driver to behave well with OpenSSL 3.x. + ## Linux/Mac OS The driver is known to build on CentOS/RHEL 6/7/8, Mac OS X 10.10/10.11 (Yosemite @@ -335,3 +345,4 @@ cmake -G "Visual Studio 16 2019" -A x64 -DCASS_BUILD_UNIT_TESTS=On .. [MIT]: https://web.mit.edu/kerberos [OpenSSL]: https://www.openssl.org [zlib]: https://www.zlib.net +[migration guide]: https://www.openssl.org/docs/man3.0/man7/migration_guide.html \ No newline at end of file From e7266c0887d85e95aea5381a984feb6b88bd15e0 Mon Sep 17 00:00:00 2001 From: Bret McGuire Date: Thu, 28 Sep 2023 16:53:06 -0500 Subject: [PATCH 2/4] Update topics/building/README.md Co-authored-by: Emelia <105240296+emeliawilkinson24@users.noreply.github.com> --- topics/building/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/topics/building/README.md b/topics/building/README.md index b59c72c96..8cd3b30c5 100644 --- a/topics/building/README.md +++ b/topics/building/README.md @@ -45,7 +45,7 @@ __\*\*\*__ Use the `CASS_USE_ZLIB` CMake option to enable/disable zlib support. ### A Brief Note on OpenSSL 3.x Migrating from OpenSSL 1.1.x to 3.x largely involves avoiding the use of many functions which are now deprecated (consult -the [migration guide] for much more detail on this point). The driver does not use any of these functions so we expect +the [migration guide] for details). The driver does not use any of these functions so we expect the transition to OpenSSL 3.x to be relatively painless. We will also note that two officially supported platforms (Ubuntu 22.04 and Rocky Linux 9.2) come with OpenSSL 3.x by default and the unit and integration tests all pass on these platforms. From c1a55c16ccbb189ba6351960d4a2487273b5b3b1 Mon Sep 17 00:00:00 2001 From: Bret McGuire Date: Thu, 28 Sep 2023 16:53:36 -0500 Subject: [PATCH 3/4] Update topics/building/README.md Co-authored-by: Emelia <105240296+emeliawilkinson24@users.noreply.github.com> --- topics/building/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/topics/building/README.md b/topics/building/README.md index 8cd3b30c5..f8958e57b 100644 --- a/topics/building/README.md +++ b/topics/building/README.md @@ -46,7 +46,7 @@ __\*\*\*__ Use the `CASS_USE_ZLIB` CMake option to enable/disable zlib support. Migrating from OpenSSL 1.1.x to 3.x largely involves avoiding the use of many functions which are now deprecated (consult the [migration guide] for details). The driver does not use any of these functions so we expect -the transition to OpenSSL 3.x to be relatively painless. We will also note that two officially supported platforms +the transition to OpenSSL 3.x to be relatively painless. Note that two officially supported platforms (Ubuntu 22.04 and Rocky Linux 9.2) come with OpenSSL 3.x by default and the unit and integration tests all pass on these platforms. From bd6eaaa6fe30819943ae16302139fde733e9f32d Mon Sep 17 00:00:00 2001 From: Bret McGuire Date: Thu, 28 Sep 2023 17:07:02 -0500 Subject: [PATCH 4/4] Trying to simplify the text into something workable --- topics/building/README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/topics/building/README.md b/topics/building/README.md index f8958e57b..fd45b2237 100644 --- a/topics/building/README.md +++ b/topics/building/README.md @@ -45,12 +45,9 @@ __\*\*\*__ Use the `CASS_USE_ZLIB` CMake option to enable/disable zlib support. ### A Brief Note on OpenSSL 3.x Migrating from OpenSSL 1.1.x to 3.x largely involves avoiding the use of many functions which are now deprecated (consult -the [migration guide] for details). The driver does not use any of these functions so we expect -the transition to OpenSSL 3.x to be relatively painless. Note that two officially supported platforms -(Ubuntu 22.04 and Rocky Linux 9.2) come with OpenSSL 3.x by default and the unit and integration tests all pass on these -platforms. - -Given these results we expect the driver to behave well with OpenSSL 3.x. +the [migration guide] for details). The driver does not use any of these functions so we expect the transition to OpenSSL +3.x to be relatively painless. Note that two officially supported platforms (Ubuntu 22.04 and Rocky Linux 9.2) come with +OpenSSL 3.x by default and the unit and integration tests all pass on these platforms. ## Linux/Mac OS