Propagate request ID when webhook requests are made #1542
Merged
Conversation
This file contains 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
Technically the webhook request is a new request, so maybe the `X-Request-ID` should not be set to the value of the original request? But then the original request ID should be propageted in the webhook request body, or using a different header. The way the request ID is used in this functionality is actually more like a tracing ID, so that may be an option too.
github-actions
bot
added
the
needs triage
hslatman
changed the title
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.
This PR adds support for propagating the request ID to the webhook receiver. The request ID is sent in the
X-Request-IDheader and uses the value that is originally created by and sent by the client in theX-Smallstep-IDheader. If it's not set, it'll be created by the CA.The request ID is propagated through a
context.Context. This required adding theSignWithContextmethod to the (TLS) authority and interfaces related to the authority. By adding the method, we can deprecate the existingSignmethod, and soon default to only using the context-aware method. I think the latter makes sense, because there are already some methods that takectxas the first argument, so we can make that the standard way.Technically, the request ID is used more like a tracing ID in this case, so I'm fine with using a different header name.X-Smallstep-IDcould be used for that? I choseX-Request-IDbecause the value is reported asrequest-idin the logs, so it's easier to ascertain that these are the same values and can be used for correlating/tracing requests to the CA and onwards to the webhook receiver.Currently this relies on the existing logic for setting the request ID based on the
loggingpackage, which takes the ID to forward from theX-Smallstep-Idrequest header. Will follow up with a more end-to-end implementation and testing for theX-Request-IDheader.