Skip to content

gh-158010: Avoid recommending out-of-date OpenSSL in configure doc - #158266

Open
zware wants to merge 1 commit into
python:mainfrom
zware:fix_configure_doc_openssl_rec
Open

zware wants to merge 1 commit into
python:mainfrom
zware:fix_configure_doc_openssl_rec

Conversation

@zware

@zware zware commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

To address @hugovk's comment on GH-158015, this adjusts the configure doc to avoid recommending a concrete version of OpenSSL at all, but instead point to what should be up-to-date resources and explain things a bit in prose.

This patch won't backport all the way to 3.13, but I plan to backport the idea manually after there's some agreement on the message.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34780984 | 📁 Comparing 85da051 against main (6af40a6)

  🔍 Preview build  

1 file changed
± using/configure.html

Comment thread Doc/using/configure.rst
but the latest public release of the series has known vulnerabilities.
For best compatibility and security it is recommended to always use
the latest patch release of a current LTS release series (see the
`OpenSSL Roadmap <https://openssl-library.org/roadmap/index.html>`_),

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.

Prefer anon links:

Suggested change
`OpenSSL Roadmap <https://openssl-library.org/roadmap/index.html>`_),
`OpenSSL Roadmap <https://openssl-library.org/roadmap/index.html>`__),

Comment thread Doc/using/configure.rst
:mod:`zlib` module.
.. [8] OpenSSL 1.1.1 is the minimum possible version to build against,
but the latest public release of the series has known vulnerabilities.
For best compatibility and security it is recommended to always use

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.

Suggested change
For best compatibility and security it is recommended to always use
For best compatibility and security it is recommended to use

Comment thread Doc/using/configure.rst
* - `OpenSSL <https://openssl-library.org/>`_
- | 3.0.18 recommended
| (1.1.1 minimum)
- [8]_

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.

Suggested change
- [8]_
- 1.1.1 [8]_

I think keeping the bare minimum here would be reasonable?

Comment thread Doc/using/configure.rst
Comment on lines +133 to +140
.. [8] OpenSSL 1.1.1 is the minimum possible version to build against,
but the latest public release of the series has known vulnerabilities.
For best compatibility and security it is recommended to always use
the latest patch release of a current LTS release series (see the
`OpenSSL Roadmap <https://openssl-library.org/roadmap/index.html>`_),
or the package provided by your operating system if available. Other
libraries that offer an API compatible with OpenSSL 1.1.1 or later may
also be usable, but are not officially supported.

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.

Suggested change
.. [8] OpenSSL 1.1.1 is the minimum possible version to build against,
but the latest public release of the series has known vulnerabilities.
For best compatibility and security it is recommended to always use
the latest patch release of a current LTS release series (see the
`OpenSSL Roadmap <https://openssl-library.org/roadmap/index.html>`_),
or the package provided by your operating system if available. Other
libraries that offer an API compatible with OpenSSL 1.1.1 or later may
also be usable, but are not officially supported.
.. [8] OpenSSL 1.1.1 is the minimum possible version to build against,
but that series is end-of-life and no longer receives
security fixes. Use the latest patch release of a currently supported
LTS series (see the `OpenSSL Roadmap
<https://openssl-library.org/roadmap/index.html>`_), or the package
provided by your operating system. Other libraries with an API
compatible with OpenSSL 1.1.1 or later may work, but are not
officially supported.

Some little wording suggestions, feel free to reject as you see fit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants