Skip to content

Fix algorithm case preservation in DigestAuthMiddleware #11352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 28, 2025

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jul 28, 2025

What do these changes do?

This PR fixes a case sensitivity issue in DigestAuthMiddleware where the algorithm name from the server's challenge was being converted to uppercase in the Authorization header response. Some servers (like Prusa printers) are case-sensitive and expect the exact algorithm case to be preserved.

The fix preserves the original algorithm case from the WWW-Authenticate challenge while still using uppercase internally for hash function lookups and algorithm type checking.

Are there changes in behavior for the user?

Yes, but only for users connecting to case-sensitive digest auth servers. The middleware will now preserve the exact algorithm case from the server's challenge instead of converting it to uppercase. This improves compatibility with servers that expect exact case matching (e.g., servers sending algorithm="MD5-sess" will now receive algorithm=MD5-sess instead of algorithm=MD5-SESS).

Is it a substantial burden for the maintainers to support this?

No. This is a minimal change that adds one variable to store the original algorithm case. The fix is backward compatible and doesn't change the API. The implementation is straightforward and includes comprehensive tests to prevent regression.

Related issue number

Fixes home-assistant/core#149196

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES/ folder
    • name it <issue_or_pr_num>.<type>.rst (e.g. 588.bugfix.rst)

    • if you don't have an issue number, change it to the pull request
      number after creating the PR

      • .bugfix: A bug fix for something the maintainers deemed an
        improper undesired behavior that got corrected to match
        pre-agreed expectations.
      • .feature: A new behavior, public APIs. That sort of stuff.
      • .deprecation: A declaration of future API removals and breaking
        changes in behavior.
      • .breaking: When something public is removed in a breaking way.
        Could be deprecated in an earlier release.
      • .doc: Notable updates to the documentation structure or build
        process.
      • .packaging: Notes for downstreams about unobvious side effects
        and tooling. Changes in the test invocation considerations and
        runtime assumptions.
      • .contrib: Stuff that affects the contributor experience. e.g.
        Running tests, building the docs, setting up the development
        environment.
      • .misc: Changes that are hard to assign to any of the above
        categories.
    • Make sure to use full sentences with correct case and punctuation,
      for example:

      Fixed issue with non-ascii contents in doctest text files
      -- by :user:`contributor-gh-handle`.

      Use the past tense or the present tense a non-imperative mood,
      referring to what's changed compared to the last released version
      of this project.

@bdraco bdraco added backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot backport-3.13 Trigger automatic backporting to the 3.13 release branch by Patchback robot labels Jul 28, 2025
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jul 28, 2025
@bdraco bdraco marked this pull request as ready for review July 28, 2025 22:12
@bdraco bdraco requested review from webknjaz and asvetlov as code owners July 28, 2025 22:12
@bdraco
Copy link
Member Author

bdraco commented Jul 28, 2025

Screenshot 2025-07-28 at 12 12 10 PM

Copy link

codecov bot commented Jul 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.76%. Comparing base (eac0ef9) to head (d0bc3b1).
⚠️ Report is 1 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #11352   +/-   ##
=======================================
  Coverage   98.76%   98.76%           
=======================================
  Files         129      129           
  Lines       43375    43416   +41     
  Branches     2323     2324    +1     
=======================================
+ Hits        42838    42879   +41     
  Misses        383      383           
  Partials      154      154           
Flag Coverage Δ
CI-GHA 98.64% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.38% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.80% <100.00%> (-0.01%) ⬇️
OS-macOS 97.68% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.32% <100.00%> (+<0.01%) ⬆️
Py-3.10.18 97.72% <100.00%> (-0.01%) ⬇️
Py-3.11.13 97.92% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.52% <100.00%> (-0.02%) ⬇️
Py-3.12.10 97.62% <100.00%> (-0.01%) ⬇️
Py-3.12.11 98.02% <100.00%> (-0.01%) ⬇️
Py-3.13.5 98.28% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.22% <100.00%> (-0.01%) ⬇️
Py-3.9.23 97.61% <100.00%> (-0.01%) ⬇️
Py-pypy7.3.16 89.70% <100.00%> (-2.52%) ⬇️
VM-macos 97.68% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 98.38% <100.00%> (+<0.01%) ⬆️
VM-windows 96.80% <100.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link

codspeed-hq bot commented Jul 28, 2025

CodSpeed Performance Report

Merging #11352 will not alter performance

Comparing digest_auth_preserve_case (d0bc3b1) with master (eac0ef9)

Summary

✅ 59 untouched benchmarks

@bdraco bdraco merged commit 6deecea into master Jul 28, 2025
40 of 41 checks passed
@bdraco bdraco deleted the digest_auth_preserve_case branch July 28, 2025 22:54
Copy link
Contributor

patchback bot commented Jul 28, 2025

Backport to 3.12: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.12/6deeceafa55e17fbc9114c96188715fedbd46a7b/pr-11352

Backported as #11353

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link
Contributor

patchback bot commented Jul 28, 2025

Backport to 3.13: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.13/6deeceafa55e17fbc9114c96188715fedbd46a7b/pr-11352

Backported as #11354

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jul 28, 2025
bdraco added a commit that referenced this pull request Jul 28, 2025
bdraco added a commit that referenced this pull request Jul 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot backport-3.13 Trigger automatic backporting to the 3.13 release branch by Patchback robot bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update 2025.7 broke Digest REST authorization with prusa printer
1 participant