Rework client authentication in SkeletonValidator for clarity #716
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.
SkeletonValidator was seemingly written to not support public clients at
all. Its authenticate_client_id() explicitly returned
False
, rather thanpass
-ing like the other methods, and client_authentication_required()was missing entirely (the default implementation always returns
True
).This opinionated approach is confusing, especially when writing an
implementation that allows public clients.
The comment on the authenticate_client_id() method is particularly
confusing. Unlike the comments on other methods, which explain the method,
it explains the implementation (returning
False
). As a result, it appearsto say the method should return
False
for public clients, when it shouldactually return
False
for confidential clients (andTrue
for validpublic clients).
To reduce this confusion, include a client_authentication_required() stub,
pass
rather than returningFalse
in authenticate_client_id(), andupdate its comment to describe the method.