Close #19695 : Add Basic and Bearer Authorization to the CPP Pistache generator #19978
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 implements a solution to #19695 .
The implementation is a bit different than what agreed upon in #19695. Because none of teh ApiImplementations share a common object apart from a Pistache::Router instance, there are no central object to install a shared credentials/token check on. I do not feel that would belong in the Pistache::Router class.
However, a shared authentication mechanism can be obtained by assigning a such in main. For example:
and it may be overwritten in the individual implementations like
and the same holds true for Basic.
If the expected headers are missing or malformed or the assigned validators returns false, a 401 is returned.
User Data
Both
HttpBearerToken
andHttpBasicCredentials
can carry userdata asvoid*
from the validator to the endpoint implementation. This can be used to propagate data from the validator that is expected to be reused in the endpoint. For example user ids. this can be accomplished like this:PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*
.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master
(upcoming7.x.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)Tagging
@ravinikam , @stkrwork , @etherealjoy , @MartinDelille , @muttleyxd