Class DefaultSecurityLogic
- All Implemented Interfaces:
SecurityLogic
Default security logic:
If the HTTP request matches the matchers
configuration (or no matchers
are defined),
the security is applied. Otherwise, the user is automatically granted access.
First, if the user is not authenticated (no profile) and if some clients have been defined in the clients
parameter,
a login is tried for the direct clients.
Then, if the user has profile, authorizations are checked according to the authorizers
configuration.
If the authorizations are valid, the user is granted access. Otherwise, a 403 error page is displayed.
Finally, if the user is not authenticated (no profile), he is redirected to the appropriate identity provider
if the first defined client is an indirect one in the clients
configuration. Otherwise, a 401 error page is displayed.
- Since:
- 1.9.0
- Author:
- Jerome Leleu
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected HttpAction
forbidden
(WebContext context, SessionStore sessionStore, List<Client> currentClients, List<UserProfile> profiles, String authorizers) Return a forbidden error.boolean
protected List<UserProfile>
loadProfiles
(ProfileManager manager, WebContext context, SessionStore sessionStore, List<Client> clients) Load the profiles.perform
(WebContext context, SessionStore sessionStore, Config config, SecurityGrantedAccessAdapter securityGrantedAccessAdapter, HttpActionAdapter httpActionAdapter, String clients, String authorizers, String matchers, Object... parameters) Perform the security logic.protected HttpAction
redirectToIdentityProvider
(WebContext context, SessionStore sessionStore, List<Client> currentClients) Perform a redirection to start the login process of the first indirect client.protected void
saveRequestedUrl
(WebContext context, SessionStore sessionStore, List<Client> currentClients, AjaxRequestResolver ajaxRequestResolver) Save the requested url.void
setAuthorizationChecker
(AuthorizationChecker authorizationChecker) void
setClientFinder
(ClientFinder clientFinder) void
setLoadProfilesFromSession
(boolean loadProfilesFromSession) void
setMatchingChecker
(MatchingChecker matchingChecker) void
setSavedRequestHandler
(SavedRequestHandler savedRequestHandler) protected boolean
startAuthentication
(WebContext context, SessionStore sessionStore, List<Client> currentClients) Return whether we must start a login process if the first client is an indirect one.toString()
protected HttpAction
unauthorized
(WebContext context, SessionStore sessionStore, List<Client> currentClients) Return an unauthorized error.Methods inherited from class org.pac4j.core.engine.AbstractExceptionAwareLogic
getErrorUrl, handleException, runtimeException, setErrorUrl
Methods inherited from class org.pac4j.core.profile.factory.ProfileManagerFactoryAware
getProfileManager, getProfileManagerFactory, setProfileManagerFactory
-
Field Details
-
INSTANCE
-
-
Constructor Details
-
DefaultSecurityLogic
public DefaultSecurityLogic()
-
-
Method Details
-
perform
public Object perform(WebContext context, SessionStore sessionStore, Config config, SecurityGrantedAccessAdapter securityGrantedAccessAdapter, HttpActionAdapter httpActionAdapter, String clients, String authorizers, String matchers, Object... parameters) Description copied from interface:SecurityLogic
Perform the security logic.- Specified by:
perform
in interfaceSecurityLogic
- Parameters:
context
- the web contextsessionStore
- the session storeconfig
- the configurationsecurityGrantedAccessAdapter
- the success adapterhttpActionAdapter
- the HTTP action adapterclients
- the defined clientsauthorizers
- the defined authorizersmatchers
- the defined matchersparameters
- additional parameters- Returns:
- the resulting action of the security
-
loadProfiles
protected List<UserProfile> loadProfiles(ProfileManager manager, WebContext context, SessionStore sessionStore, List<Client> clients) Load the profiles.- Parameters:
manager
- the profile managercontext
- the web contextsessionStore
- the session storeclients
- the current clients- Returns:
-
forbidden
protected HttpAction forbidden(WebContext context, SessionStore sessionStore, List<Client> currentClients, List<UserProfile> profiles, String authorizers) Return a forbidden error.- Parameters:
context
- the web contextsessionStore
- the session storecurrentClients
- the current clientsprofiles
- the current profilesauthorizers
- the authorizers- Returns:
- a forbidden error
-
startAuthentication
protected boolean startAuthentication(WebContext context, SessionStore sessionStore, List<Client> currentClients) Return whether we must start a login process if the first client is an indirect one.- Parameters:
context
- the web contextsessionStore
- the session storecurrentClients
- the current clients- Returns:
- whether we must start a login process
-
saveRequestedUrl
protected void saveRequestedUrl(WebContext context, SessionStore sessionStore, List<Client> currentClients, AjaxRequestResolver ajaxRequestResolver) Save the requested url.- Parameters:
context
- the web contextsessionStore
- the session storecurrentClients
- the current clientsajaxRequestResolver
- the AJAX request resolver
-
redirectToIdentityProvider
protected HttpAction redirectToIdentityProvider(WebContext context, SessionStore sessionStore, List<Client> currentClients) Perform a redirection to start the login process of the first indirect client.- Parameters:
context
- the web contextsessionStore
- the session storecurrentClients
- the current clients- Returns:
- the performed redirection
-
unauthorized
protected HttpAction unauthorized(WebContext context, SessionStore sessionStore, List<Client> currentClients) Return an unauthorized error.- Parameters:
context
- the web contextsessionStore
- the session storecurrentClients
- the current clients- Returns:
- an unauthorized error
-
getClientFinder
-
setClientFinder
-
getAuthorizationChecker
-
setAuthorizationChecker
-
getMatchingChecker
-
setMatchingChecker
-
getSavedRequestHandler
-
setSavedRequestHandler
-
setLoadProfilesFromSession
public void setLoadProfilesFromSession(boolean loadProfilesFromSession) -
isLoadProfilesFromSession
public boolean isLoadProfilesFromSession() -
toString
-