DOCS: Define the request line Evidence keys for signature verification - #24
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The problem
A Web Bot Auth signature names the parts of the request it covers, and
the strongest coverage an agent can choose takes in the request line,
being the method, the path and the query string. Verification rebuilds
each covered part byte for byte, so a verifier that cannot rebuild the
request line can only answer "could not check" for exactly the
best behaved agents. The specification defined no Evidence keys for
the request line, so no implementation had a contract to build
against. This is a specification concern, not a .NET one, because
every language's web integration must supply the same keys under the
same names.
What was changed
Three pages on
pipeline-specification:features/web-integration.md, the Populating Evidence list gainsthree keys,
server.request-method,server.request-pathandserver.request-query, with a paragraph requiring the values bytefor byte as sent with no decoding, requiring all three on every
request (the query key empty when the request has no query string,
so an absent key always means the integration does not supply the
request line), and noting the accepted-Evidence feature means a
Pipeline without an element asking for the keys carries no new
values.
features/evidence.md, the defined key examples gain the samethree, with a pointer to the web integration page for the detail.
pipeline-elements/agent-signature-element.md, the derivedcomponent rules now say how
@method,@path,@queryand@target-uriare built from the three keys, including the RFC 9421section 2.2.7 leading
?rule, in place of the previous statementthat the request line is not in Evidence.
The
serverprefix is the specification's existing category forrequest values that fit no other prefix, the same family as
server.client-ip. The whole query string is carried separately fromthe decoded
query.[parameter name]pairs because the decoded pairslose ordering and encoding and cannot rebuild the original.
What follows
51Degrees/pipeline-dotnet#374 implements the keys in the .NET web
integrations, and the other language ports follow the same contract
from this page.