Introduction
Shiro can use multi-realm authentication and authorization - for example, against a shiro.ini account and an LDAP account or against one or more of LDAP accounts.
Scope
This article describes multi-realm authentication in detail - example configurations showing multi-realm authentication and authorization have already been presented in the Authentication and Authorization - Configuration and LDAP Configuration articles.
Behavior for Accounts with a Common Password
Consider the case of a user account that is registered for both a Shiro and an LDAP realm. An example configuration is shown in the listing below:
In this example:
- One "newton" account is configured in the
[users]
section of theshiro.ini
file for the iniRealm and assigned the administrator role. - A second "newton" account that accesses a publicly open LDAP server is configured in the the
[main]
section of theshiro.ini
file and assigned the it_operator role. - Both accounts have the same password.
- If the
securityManager.realms
parameter is specified:- The authorization information provided by the user logging in will be checked against each realm account in the order in which realms are specified in a
securityManager.realms
parameter.(explicit ordering). In the example, this would be first thepublicLdapRealm
and then theiniRealm
.
- The authorization information provided by the user logging in will be checked against each realm account in the order in which realms are specified in a
- If the
securityManager.realms
parameter is not specified:- The authorization information provided by the user logging in will be checked against each realm account in the order in which realms are listed in the [main] section of the shiro.ini file.(implicit ordering). In the example, this would be first the
iniRealm
and then thepublicLdapRealm
.
- The authorization information provided by the user logging in will be checked against each realm account in the order in which realms are listed in the [main] section of the shiro.ini file.(implicit ordering). In the example, this would be first the
Note that Explicit and implicit realm ordering is described in more detail in the 'Realm Authentication' section of on the Shiro Authentication web site.
Alternative Authentication Behavior Strategies
Shiro allows a number of Authentication Behavior Strategies to be followed. These are configured with the authcStrategy
parameter and are:
org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy
- If one (or more) Realms authenticate successfully, the overall attempt is considered successful. If none authenticate successfully, the attempt fails.
- Roles from all authenticated realms are merged.
org.apache.shiro.authc.pam.FirstSuccessfulStrategy
- Only the information returned from the first successfully authenticated Realm will be used. All further Realms will be ignored. If none authenticate successfully, the attempt fails.
- Roles from the first authenticated realm are used.
org.apache.shiro.authc.pam.AllSuccessfulStrategy
- All Realms listed in the
securityManager.realms
parameter must authenticate successfully for the overall attempt to be considered successful. If any one does not authenticate successfully, the attempt fails. - Roles from all realms are merged.
- All Realms listed in the
By default, Shiro authentication uses the authcStrategy = org.apache.shiro.authc.pam.AtLeastOneSuccessful
strategy. This strategy causes a login to be attempted for all the realms listed in the securityManager.realms
parameter or, if this is not set, in all the realms listen in the shiro.ini configuration file.
Note that roles from the iniRealm
for authenticated user accounts are always merged to the list of roles. This happens for all strategies (This seems to be an error in Shiro.)
Multi-Realm Authentication and Authorization up to Release 1.12.3
Note that the FirstSuccessfulStrategy
strategy is incorrectly implemented and that a login will be attempted for all the realms, even after a successful login has been noted. Login attempts carried out after a successful login has been noted will be logged at the [error]
level. See issue JOC-437 for more information.
Multi-Realm Authentication and Authorization from Release 1.12.4 onwards
The Shiro authenticator is replaced by one written by the SOS, which is called by default.The SOS authenticator can also be called explicitly using the following lines of code
authenticator = com.sos.auth.shiro.SOSAuthenticator securityManager.authenticator=$authenticator
The SOS authenticator replaces the Shiro authenticator and allows the use of the three Shiro Authentication strategies listed above without unnecessary log file entries being made.
Note: roles from the iniRealm
for authenticated users are always merged to the list of roles regardless of the strategy specified (This seems to be an error in Shiro.)
Behavior for Accounts with Differing Passwords
The following points apply for a multi-realm environment, where one of the realms is the iniRealm and when the user accounts have a common name but different passwords:
When the SOS Authenticator is used with the First Successful strategy:
- If the authorization occurs through the ini realm then the user account will only be assigned the roles specified for the ini realm. The LDAP realm(s) will be ignored.
- If the authorization occurs through an LDAP realm then, regardless of whether or not the same password is used in each realm:
- The user account will be assigned the role(s) specified for the account in the (first) authorizing realm.
- The user account will also be assigned the role(s) specified for the account in the ini realm.
- This behavior ensures that a login is possible in the event of problems with the LDAP realm(s).
- The order in which the realms are specified in the
securityManager.realms
parameter is not significant here. - The ldap.roleAssignmentFromIni=false setting (default true) can be used to modify the behavior of the First Successful strategy so that roles from the ini realm are not assigned.