-
Notifications
You must be signed in to change notification settings - Fork 194
docs: complete authenticator and authorizer documentation #290
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
GaneshPatil7517
wants to merge
9
commits into
apache:main
Choose a base branch
from
GaneshPatil7517:docs-fill-authenticator-authorizer
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d66569b
docs: migrate issue tracking to GitHub Issues and Discussions
GaneshPatil7517 36dc354
review comments
lprimak 0d145ef
docs: address PR review feedback
GaneshPatil7517 ffe8456
docs: complete authenticator and authorizer documentation
GaneshPatil7517 818b154
merge: resolve conflicts by accepting latest changes from main
GaneshPatil7517 c911576
fix: update issues.adoc to use GitHub Issues instead of Jira
GaneshPatil7517 76294ef
docs: clarify FirstSuccessfulStrategy description for better clarity
GaneshPatil7517 f61a4ff
Merge branch 'main' into docs-fill-authenticator-authorizer
lprimak 2c9744d
reverted unnecssary files
lprimak File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,110 @@ | ||
| = Authenticator | ||
| :jbake-type: lend_a_hand | ||
| [#Authenticator-UnderstandingAuthenticators] | ||
| = Apache Shiro Authenticators | ||
| :jbake-date: 2010-03-18 00:00:00 | ||
| :jbake-type: page | ||
| :jbake-status: published | ||
| :jbake-tags: documentation, todo, lend-a-hand | ||
| :jbake-tags: authenticator, authentication, security, realms | ||
| :jbake-description: Understanding Apache Shiro Authenticators - the component responsible for verifying user identity. Learn how Authenticators work with Realms and AuthenticationStrategies. | ||
| :idprefix: | ||
| :icons: font | ||
| :toc: | ||
|
|
||
| TODO | ||
| An `Authenticator` is a component responsible for verifying that a user actually is who they claim to be. | ||
| It is the core component that executes the authentication process on behalf of the link:/subject.html[Subject]. | ||
|
|
||
| While the link:/authentication.html[Authentication] documentation explains the concepts and workflow of authentication in Shiro, | ||
| the Authenticator represents the actual implementation component that performs identity verification. | ||
|
|
||
| [#Authenticator-Role] | ||
| == Role in the SecurityManager | ||
|
|
||
| The link:/securitymanager.html[SecurityManager] does not perform authentication directly. | ||
| Instead, it delegates authentication requests to its internal `Authenticator` instance. | ||
| When a link:/subject.html[Subject] calls link:/static/current/apidocs/org/apache/shiro/subject/Subject.html#login(org.apache.shiro.authc.AuthenticationToken)[`login(token)`], | ||
| the SecurityManager receives the request and immediately delegates to the Authenticator by calling | ||
| link:/static/current/apidocs/org/apache/shiro/authc/Authenticator.html#authenticate(org.apache.shiro.authc.AuthenticationToken)[`authenticate(token)`]. | ||
|
|
||
| The Authenticator takes the submitted link:/static/current/apidocs/org/apache/shiro/authc/AuthenticationToken.html[`AuthenticationToken`] | ||
| and uses it to verify the Subject's identity. | ||
| If verification succeeds, it returns an link:/static/current/apidocs/org/apache/shiro/authc/AuthenticationInfo.html[`AuthenticationInfo`] object. | ||
| If verification fails, it throws an link:/static/current/apidocs/org/apache/shiro/authc/AuthenticationException.html[`AuthenticationException`]. | ||
|
|
||
| [#Authenticator-ModularRealmAuthenticator] | ||
| == ModularRealmAuthenticator | ||
|
|
||
| Shiro uses the link:/static/current/apidocs/org/apache/shiro/authc/pam/ModularRealmAuthenticator.html[`ModularRealmAuthenticator`] | ||
| by default. | ||
| This implementation supports coordinating one or more link:/realm.html[Realms] during the authentication process. | ||
|
|
||
| When an authentication token is submitted, the ModularRealmAuthenticator: | ||
|
|
||
| * Iterates through configured Realms | ||
| * Calls each Realm's link:/static/current/apidocs/org/apache/shiro/realm/Realm.html#supports(org.apache.shiro.authc.AuthenticationToken)[`supports(token)`] method to determine if the Realm can process the token | ||
| * If a Realm supports the token, its link:/static/current/apidocs/org/apache/shiro/realm/Realm.html#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)[`getAuthenticationInfo(token)`] method is invoked | ||
| * Returns authentication information if successful, or throws an exception if failed | ||
|
|
||
| [#Authenticator-SingleVsMultipleRealms] | ||
| == Single vs. Multiple Realms | ||
|
|
||
| The ModularRealmAuthenticator supports both configurations: | ||
|
|
||
| *Single Realm*: | ||
| When only one Realm is configured, the Authenticator directly invokes that Realm to verify the Subject's credentials. | ||
|
|
||
| *Multiple Realms*: | ||
| When multiple Realms are configured, the Authenticator uses an link:/static/current/apidocs/org/apache/shiro/authc/pam/AuthenticationStrategy.html[`AuthenticationStrategy`] | ||
| to determine how to coordinate authentication across the Realms. | ||
| This is a link:https://en.wikipedia.org/wiki/Pluggable_Authentication_Modules[PAM]-style approach where each Realm can be consulted in sequence. | ||
|
|
||
| [#Authenticator-AuthenticationStrategy] | ||
| == AuthenticationStrategy | ||
|
|
||
| When multiple Realms are configured, the Authenticator must determine if the overall authentication attempt succeeds or fails. | ||
| The link:/static/current/apidocs/org/apache/shiro/authc/pam/AuthenticationStrategy.html[`AuthenticationStrategy`] makes this determination. | ||
|
|
||
| Shiro provides three built-in strategies: | ||
|
|
||
| * *FirstSuccessfulStrategy*: Consults Realms in order until one succeeds. Remaining Realms are not consulted. | ||
| * *AtLeastOneSuccessfulStrategy*: Returns success if at least one Realm succeeds. Other Realms continue to be consulted. | ||
| * *AllSuccessfulStrategy*: All Realms must succeed for authentication to succeed. This is the most restrictive. | ||
|
|
||
| You can configure which strategy the Authenticator uses, or implement your own strategy for custom behavior. | ||
|
|
||
| [#Authenticator-Configuration] | ||
| == Configuration | ||
|
|
||
| You can configure a custom Authenticator in your Shiro configuration if needed: | ||
|
|
||
| [source,ini] | ||
| ---- | ||
| authenticator = com.foo.bar.CustomAuthenticator | ||
| securityManager.authenticator = $authenticator | ||
| ---- | ||
|
|
||
| You can also configure the AuthenticationStrategy: | ||
|
|
||
| [source,ini] | ||
| ---- | ||
| authenticationStrategy = org.apache.shiro.authc.pam.FirstSuccessfulStrategy | ||
| authenticator.authenticationStrategy = $authenticationStrategy | ||
| ---- | ||
|
|
||
| However, in most cases, the default ModularRealmAuthenticator with the default strategy is sufficient for typical applications. | ||
|
|
||
| [#Authenticator-RealmInteraction] | ||
| == How Authenticators Work with Realms | ||
|
|
||
| The Authenticator does not directly know how to verify credentials. | ||
| Instead, it coordinates with configured Realms to perform the actual verification. | ||
|
|
||
| A link:/realm.html[Realm] is a security-specific data access object that can locate and validate user credentials from a data source | ||
| (database, LDAP, file system, etc.). | ||
| The Realm is responsible for: | ||
|
|
||
| * Determining if it understands the submitted AuthenticationToken via its `supports(token)` method | ||
| * Looking up the user in the data source | ||
| * Comparing submitted credentials with those stored in the data source | ||
| * Returning the user's authentication information if credentials match | ||
| * Throwing an exception if credentials do not match | ||
|
|
||
| The Authenticator simply orchestrates this process by delegating to Realms in order and handling the results according to its configured strategy. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,134 @@ | ||
| = Authorizer | ||
| :jbake-type: lend_a_hand | ||
| [#Authorizer-UnderstandingAuthorizers] | ||
| = Apache Shiro Authorizers | ||
| :jbake-date: 2010-03-18 00:00:00 | ||
| :jbake-type: page | ||
| :jbake-status: published | ||
| :jbake-tags: documentation, todo, lend-a-hand | ||
| :jbake-tags: authorizer, authorization, access-control, permissions, roles | ||
| :jbake-description: Understanding Apache Shiro Authorizers - the component that determines what authenticated users are allowed to do. Learn how Authorizers work with Realms to evaluate permissions and roles. | ||
| :idprefix: | ||
| :icons: font | ||
| :toc: | ||
|
|
||
| TODO | ||
| An `Authorizer` is a component responsible for determining whether a user is allowed to perform a certain action. | ||
| It evaluates whether a `Subject` has the necessary permissions or roles to access a resource or perform an operation. | ||
|
|
||
| While the link:/authorization.html[Authorization] documentation explains the concepts and workflow of access control in Shiro, | ||
| the Authorizer represents the actual implementation component that performs access control decisions. | ||
|
|
||
| [#Authorizer-Role] | ||
| == Role in the SecurityManager | ||
|
|
||
| The link:/securitymanager.html[SecurityManager] does not perform authorization checks directly. | ||
| Instead, it delegates authorization decisions to its internal `Authorizer` instance. | ||
| When a link:/subject.html[Subject] calls authorization methods such as | ||
| link:/static/current/apidocs/org/apache/shiro/subject/Subject.html#hasRole(java.lang.String)[`hasRole(role)`], | ||
| link:/static/current/apidocs/org/apache/shiro/subject/Subject.html#isPermitted(org.apache.shiro.authz.Permission)[`isPermitted(permission)`], | ||
| or their variants, the SecurityManager delegates to the Authorizer. | ||
|
|
||
| The Authorizer determines whether the Subject is permitted to perform the requested action by checking the Subject's roles and permissions. | ||
| If the Subject has the necessary role or permission, the authorization check passes. | ||
| If not, an link:/static/current/apidocs/org/apache/shiro/authz/AuthorizationException.html[`AuthorizationException`] may be thrown. | ||
|
|
||
| [#Authorizer-ModularRealmAuthorizer] | ||
| == ModularRealmAuthorizer | ||
|
|
||
| Shiro uses the link:/static/current/apidocs/org/apache/shiro/authz/ModularRealmAuthorizer.html[`ModularRealmAuthorizer`] | ||
| by default. | ||
| This implementation supports coordinating one or more link:/realm.html[Realms] during the authorization process. | ||
|
|
||
| When an authorization check is performed, the ModularRealmAuthorizer: | ||
|
|
||
| * Iterates through configured Realms | ||
| * For each Realm that implements the `Authorizer` interface, calls the corresponding authorization method | ||
| (`hasRole*`, `checkRole*`, `isPermitted*`, or `checkPermission*`) | ||
| * Aggregates and evaluates the results according to Shiro's authorization semantics | ||
| * Returns the authorization decision to the caller | ||
|
|
||
| It is important to note that the ModularRealmAuthorizer treats Realms differently depending on whether they implement the `Authorizer` interface. | ||
| If a Realm does not implement `Authorizer`, it is not consulted for authorization checks. | ||
|
|
||
| [#Authorizer-PermissionAndRoleChecks] | ||
| == Permission and Role Checks | ||
|
|
||
| The Authorizer performs two types of authorization checks: | ||
|
|
||
| [#Authorizer-PermissionChecks] | ||
| === Permission Checks | ||
|
|
||
| Permission checks verify whether a Subject is allowed to perform a specific action on a specific resource. | ||
| Methods for permission checks include: | ||
|
|
||
| * link:/static/current/apidocs/org/apache/shiro/subject/Subject.html#isPermitted(org.apache.shiro.authz.Permission)[`isPermitted(permission)`] - returns `true` or `false` | ||
| * link:/static/current/apidocs/org/apache/shiro/subject/Subject.html#checkPermission(org.apache.shiro.authz.Permission)[`checkPermission(permission)`] - throws an exception on failure | ||
|
|
||
| For example: | ||
|
|
||
| [source,java] | ||
| ---- | ||
| if (subject.isPermitted("account:read")) { | ||
| //User can read accounts | ||
| } | ||
|
|
||
| subject.checkPermission("document:delete:report123"); | ||
| ---- | ||
|
|
||
| [#Authorizer-RoleChecks] | ||
| === Role Checks | ||
|
|
||
| Role checks verify whether a Subject has a specific role. Methods for role checks include: | ||
|
|
||
| * link:/static/current/apidocs/org/apache/shiro/subject/Subject.html#hasRole(java.lang.String)[`hasRole(role)`] - returns `true` or `false` | ||
| * link:/static/current/apidocs/org/apache/shiro/subject/Subject.html#checkRole(java.lang.String)[`checkRole(role)`] - throws an exception on failure | ||
|
|
||
| For example: | ||
|
|
||
| [source,java] | ||
| ---- | ||
| if (subject.hasRole("admin")) { | ||
| //User is an administrator | ||
| } | ||
|
|
||
| subject.checkRole("user"); | ||
| ---- | ||
|
|
||
| [#Authorizer-Configuration] | ||
| == Configuration | ||
|
|
||
| You can configure a custom Authorizer in your Shiro configuration if needed: | ||
|
|
||
| [source,ini] | ||
| ---- | ||
| authorizer = com.foo.bar.CustomAuthorizer | ||
| securityManager.authorizer = $authorizer | ||
| ---- | ||
|
|
||
| However, in most cases, the default ModularRealmAuthorizer is sufficient for typical applications. | ||
|
|
||
| [#Authorizer-RealmInteraction] | ||
| == How Authorizers Work with Realms | ||
|
|
||
| The Authorizer does not directly know where to retrieve authorization data. | ||
| Instead, it coordinates with configured Realms to perform the actual authorization checks. | ||
|
|
||
| A link:/realm.html[Realm] is a security-specific data access object that knows how to retrieve authorization data from a data source | ||
| (database, LDAP, file system, etc.). | ||
| The Realm is responsible for: | ||
|
|
||
| * Determining if it implements the `Authorizer` interface (which indicates it can perform authorization checks) | ||
| * Retrieving the Subject's roles and permissions from the data source | ||
| * Evaluating whether the Subject has the requested role or permission | ||
| * Returning the results of the authorization check | ||
|
|
||
| The Authorizer simply orchestrates this process by delegating to Realms and aggregating their results. | ||
| This allows you to use multiple Realms where authorization data may come from different sources, | ||
| and Shiro will coordinate the results appropriately. | ||
|
|
||
| [#Authorizer-MultipleRealms] | ||
| == Authorization with Multiple Realms | ||
|
|
||
| When multiple Realms are configured, the ModularRealmAuthorizer consults all Realms that implement the `Authorizer` interface. | ||
| The results are aggregated to determine the final authorization decision. | ||
|
|
||
| Typically, if any Realm grants permission or role membership, the authorization check succeeds. | ||
| However, the exact behavior depends on the authorization data model and how the Realms are configured. | ||
| Custom Authorizer implementations can be used to implement different aggregation strategies if needed. |
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
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.
Uh oh!
There was an error while loading. Please reload this page.