Skip to content

docs(hmac-auth): include Digest header in signed headers for body validation example#13421

Open
moying2026 wants to merge 2 commits into
apache:masterfrom
moying2026:auto/issue-13395
Open

docs(hmac-auth): include Digest header in signed headers for body validation example#13421
moying2026 wants to merge 2 commits into
apache:masterfrom
moying2026:auto/issue-13395

Conversation

@moying2026
Copy link
Copy Markdown

Fixes #13395\n\nThis PR improves the body validation example in the hmac-auth documentation. Currently, the example computes and sends a Digest header but does not include it in the signed headers list, which could mislead readers about how to properly bind the request body to the HMAC signature.\n\nChanges:\n- Add a note clarifying that validate_request_body alone does not bind the Digest header to the signature\n- Update the Python example to compute the body digest before building the signing string\n- Include the Digest header in both the signing string and the headers list in Authorization\n- Adjust the signing string construction order to match the updated headers list\n\nThis is a docs-only change with no code modifications.

@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. doc Documentation things labels May 22, 2026
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels May 22, 2026
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels May 22, 2026
@dosubot dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. 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:XXL This PR changes 1000+ 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