python / python/cpython

Ensure builtin hashlib implementations honor usedforsecurity=True when _hashlib is in FIPS mode

Open
#127,298 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

extension-modules topic-SSL type-feature type-security
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Feature or enhancement

Proposal:

When OpenSSL is not available, or is not in FIPS mode:

  • no change of behaviour

When OpenSSL is available and is in FIPS mode:

  • ensure that only OpenSSL implementations are used when usedforsecurity=True
  • ensure that all built-in (fallback) implementations require usedforsecurity=False

This addresses all needs of FIPS users that expect approved only cryptography from hashlib by default.
It satisfies Python guarantees of always available algorithms, as built-in fallbacks remain accessible with an explicit consent from the user that unapproved (an FIPS/ISO term) implementation is acceptable to the user.

In FIPS mode it means that all users can gain access to blake2/shake/md5, even when these algorithms are either blocked or unavailable from the runtime OpenSSL in FIPS mode. As long as usedforsecurity=False is used.

This also removes need to recompile or configure python somehow different for a non-fips & fips build, specifically one can safely compile python with all with-builtin-hashlib-hashes enabled.

Diagrams and full details of the current state of hashlib; and FIPS user desires are documented in this issue is opened as a reference for potential implementations to resolve all needs and desires listed there.

This issue will be used as a reference for potential implementations.

Has this already been discussed elsewhere?

I have already discussed this feature proposal on Discourse

Links to previous discussion of this feature:

Discuss:

(note there are some off-topic messages there)

Linked PRs
  • gh-127301
  • gh-127492

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked PRs gh-127301 and gh-127492, then read the Discourse discussion linked in the issue for context. Compare the requested hashlib behavior in and outside OpenSSL FIPS mode; done means OpenSSL implementations are used for usedforsecurity=True and fallback implementations require usedforsecurity=False in FIPS mode.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cryptography, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.