Skip to content

docs: update hmac-auth body validation example to sign Digest header#13423

Open
moying2026 wants to merge 1 commit into
apache:masterfrom
moying2026:fix/hmac-auth-docs-digest-signature-13395-v2
Open

docs: update hmac-auth body validation example to sign Digest header#13423
moying2026 wants to merge 1 commit into
apache:masterfrom
moying2026:fix/hmac-auth-docs-digest-signature-13395-v2

Conversation

@moying2026
Copy link
Copy Markdown

Fixes #13395

Summary

Updates the body validation example in hmac-auth.md to include the Digest header in the signing string and signed headers list.

Changes

  • Moved body digest calculation before building signing string
  • Added digest line to signing string
  • Added "digest" to the headers list in Authorization header
  • Added a note explaining that validate_request_body only checks Digest header matching, and to bind body integrity to the signature you must also include Digest in signed headers.

Testing

  • Verified Python example runs correctly and generates proper signatures

- Include digest in signing string and signed headers list
- Add note explaining validate_request_body vs signature binding

Fixes apache#13395
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. doc Documentation things labels May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: hmac-auth body validation example should sign the Digest header

1 participant