docs: improve documentation about SensitiveEndpointRule replacement #619
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
oscarcitoz
approved these changes
Apr 12, 2021
ilopmar
reviewed
Apr 12, 2021
Comment on lines
+105
to
+113
| Boolean sensitive = endpointMethods.get(method); | ||
| if (sensitive) { | ||
| if (claims == null) { | ||
| return checkSensitiveAnonymous(request, method); | ||
| } | ||
| return checkSensitiveAuthenticated(request, claims, method); | ||
| } | ||
| return checkNotSensitive(request, claims, method); | ||
| } |
There was a problem hiding this comment.
I'm not sure if this is the best way to encapsulate everything calling the threes protected methods from here. All three methods are the same in the sense that they log a message and return the appropriate SecurityRuleResult but they don't check any condition. Everything is decided in this method.
Did you create those three methods in other for users to be able to override them without override this one?
There was a problem hiding this comment.
Yes, three protected methods makes easier the replacement. See example, in the tests which I show in the docs.
ilopmar
approved these changes
Apr 12, 2021
|
thanks @oscarcitoz for pointing us to improving this part of the security module. Really valuable feedback. |
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.
close: #606
close: #589
@oscarcitoz this PR refactors
SensitiveEndpointRuleto ease replacement. Moreover, it documents how to restrict management endpoints for a particular role.