Class AuthKeyAuthenticationHandler
- All Implemented Interfaces:
PluginComponent,Comparable<AuthenticationHandler>
The Authentication key parameter name can be configured by changing
property "auth-mgr.authkey-name", see getAuthKeyName().
Default duration of AuthenticationKey can be configured by changing
property "auth-mgr.authkey-duration", see getDefaultAuthKeyDuration().
- Since:
- jcms-5.7.4
- Author:
- Olivier Jaquemet
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumPossible AuthKey state after handler invocation. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringName of request attribute indicating that this request was authenticated using AuthKeystatic final StringName of the HTTP header providing authentication through authkey (without query parameter).static final intOrder used by the AuthKeyAuthenticationHandlerFields inherited from class com.jalios.jcms.authentication.AuthenticationHandler
channel, GENERIC_BAD_AUTHENTICATION_MSG -
Method Summary
Modifier and TypeMethodDescriptionstatic final MembercheckAuthenticationFromAuthKey(javax.servlet.http.HttpServletRequest request) Returns the member corresponding to the credentials given in the authkey parameter, if any.static final StringRetrieves the authentication key parameter name.
Default is"authKey"and can be changed using property"auth-mgr.authkey-name".static final StringRetrieves the server seed used in auth key digest.
Default is""and can be changed using property"auth-mgr.authkey-server-seed".static final StringgetAuthKeyValue(String url, Member member) Retrieves a valid authentication key parameter value for the specified URL.static final StringgetAuthKeyValue(String url, Member member, long duration) Retrieves a valid authentication key parameter value for the specified URL.static final StringgetAuthKeyValue(String url, Member member, AccessTokenOptions options) Retrieves a new authentication key value for the specified options.static final StringgetAuthKeyValue(String url, Member member, AuthKeyHints hints) Deprecated.static final longRetrieves the default authentication key duration (expiration time) to be used when no expiration duration as been specified.
Default is one year and can be changed using property"auth-mgr.authkey-duration".
Warning : this default duration is only used when developper did not specified an explicit duration when generating the authkey value or url.static final AuthKeyAuthenticationHandlerstatic final StringgetUrlWithAddedAuthKeyParam(String url, Member member) Append a valid authentication key parameter name/value to the specified URL.static final StringgetUrlWithAddedAuthKeyParam(String url, Member member, long duration) Append a valid authentication key parameter name/value to the specified URL.static final StringgetUrlWithAddedAuthKeyParam(String url, Member member, long duration, boolean escapeAmpersand) Append a valid authentication key parameter name/value to the specified URL.static final StringgetUrlWithAddedAuthKeyParam(String url, Member member, AccessTokenOptions options, boolean escapeAmpersand) Append a valid authentication key parameter name/value to the specified URL.static final StringgetUrlWithAddedAuthKeyParam(String url, Member member, AuthKeyHints hints, boolean escapeAmpersand) static final StringgetUrlWithAddedAuthKeyParam(String url, String authKeyValue, boolean escapeAmpersand) Append the specified authentication key value as paramater.static final StringgetUrlWithAddedAuthKeyParam(javax.servlet.http.HttpServletRequest request, Member member) Retrieve the absolute url of the specified request with a valid authentication key parameter name/value appended.static final StringgetUrlWithAddedAuthKeyParam(javax.servlet.http.HttpServletRequest request, Member member, long duration) Retrieve the absolute url of the specified request with a valid authentication key parameter name/value appended.static booleanisAuthenticatedWithAuthKey(javax.servlet.http.HttpServletRequest request) Check if the specified request was authenticated using an AuthKeystatic final MemberisValidAuthKey(String url, String authKey, javax.servlet.http.HttpServletRequest request) Checks if the given auth key is valid and if it is, returns the member to login.static final MemberisValidAuthKey(String url, String authKey, javax.servlet.http.HttpServletRequest request, AuthenticationContext ctxt) Checks if the given auth key is valid and if it is, returns the member to login.voidThis method will be called by the AuthenticationManager each time the Channel properties are loaded/reloaded.
You can use it to reload properties that might have been changed.
This method is called during initialization of the AuthenticationManagervoidlogin(AuthenticationContext ctxt) Authenticate a member.
-
Field Details
-
AUTHENTICATION_FROM_AUTHKEY
Name of request attribute indicating that this request was authenticated using AuthKey- Since:
- jcms-7.1
- See Also:
-
AUTHKEY_HTTP_HEADER_NAME
Name of the HTTP header providing authentication through authkey (without query parameter).- Since:
- JCMS-3953 (value modified since JCMS-10153)
- See Also:
-
ORDER_AUTHKEY_HANDLER
public static final int ORDER_AUTHKEY_HANDLEROrder used by the AuthKeyAuthenticationHandler- See Also:
-
-
Method Details
-
getInstance
-
loadProperties
public void loadProperties()Description copied from class:AuthenticationHandlerThis method will be called by the AuthenticationManager each time the Channel properties are loaded/reloaded.
You can use it to reload properties that might have been changed.
This method is called during initialization of the AuthenticationManager- Overrides:
loadPropertiesin classAuthenticationHandler
-
login
Description copied from class:AuthenticationHandlerAuthenticate a member.
This method is invoked by the authentication chain on each request.
A typical implementation of this method would follow the following pattern :- Examine informations required to perform the authentication through
the
AuthenticationContextobject (request, response, login.. etc) - Perform your authentication before chain invokation and set the logged Member
AuthenticationContext.setLoggedMember(com.jalios.jcms.Member) - a) Either invoke the next entity in the chain using
AuthenticationContext.doChain(), - b) or else skip the chain invokation and block other authentication handler of the chain (do this with caution...)
- Perform redirection, set information/warning/error message or any
other process, after chain invokation, using
AuthenticationContext.
Default implementation is to invoke the next handler in the chain.- Overrides:
loginin classAuthenticationHandler- Parameters:
ctxt- theAuthenticationContextused for this login- Throws:
IOException
- Examine informations required to perform the authentication through
the
-
isAuthenticatedWithAuthKey
public static boolean isAuthenticatedWithAuthKey(javax.servlet.http.HttpServletRequest request) Check if the specified request was authenticated using an AuthKey- Parameters:
request- the current HttpServletRequest, may be null- Returns:
- true if request was authenticated with autkey, false otherwise
- Since:
- jcms-7.1
-
checkAuthenticationFromAuthKey
public static final Member checkAuthenticationFromAuthKey(javax.servlet.http.HttpServletRequest request) Returns the member corresponding to the credentials given in the authkey parameter, if any.- Parameters:
request- the request where to look for authkey param- Returns:
- the authenticated member or null if not found
- Since:
- jcms-5.7.4
-
getUrlWithAddedAuthKeyParam
public static final String getUrlWithAddedAuthKeyParam(javax.servlet.http.HttpServletRequest request, Member member) Retrieve the absolute url of the specified request with a valid authentication key parameter name/value appended. The default duration is used.If the specified member is null, the url of the request is returned.
If there are existing parameter(s) to the specified request, the html entity & will be used for the ampersand required to append the parameter.
- Parameters:
request- the request for which an authentication key will be computedmember- the member that will be allowed to access the resource of the specified url- Returns:
- an absolute URL with the added authentication key value that can be used to access the exact same URL without being logged,
- Throws:
IllegalArgumentException- if request is null- Since:
- jcms-5.7.4
-
getUrlWithAddedAuthKeyParam
public static final String getUrlWithAddedAuthKeyParam(javax.servlet.http.HttpServletRequest request, Member member, long duration) Retrieve the absolute url of the specified request with a valid authentication key parameter name/value appended. The default duration is used.If the specified member is null, the url of the request is returned.
If there are existing parameter(s) to the specified request, the html entity & will be used for the ampersand required to append the parameter.
- Parameters:
request- the request for which an authentication key will be computedmember- the member that will be allowed to access the resource of the specified urlduration- a duration (in millisecond) after which the returned authkey will be expired (no longer valid). If set to 0, no expiration is used, if set to -1 (or any negative number) default expiration time is used.- Returns:
- an absolute URL with the added authentication key value that can be used to access the exact same URL without being logged,
- Throws:
IllegalArgumentException- if request is null- Since:
- jcms-5.7.4
-
getUrlWithAddedAuthKeyParam
Append a valid authentication key parameter name/value to the specified URL.If the specified member is null, the url is returned untouched.
If there are existing parameter(s) to the specified url, the html entity & will be used for the ampersand required to append the parameter.
- Parameters:
url- the absolute URL for which an authentication key will be computedmember- the member that will be allowed to access the resource of the specified url- Returns:
- an absolute URL with the added authentication key value that can be used to access the exact same URL without being logged,
- Throws:
IllegalArgumentException- if url is null- Since:
- jcms-5.7.4
-
getUrlWithAddedAuthKeyParam
Append a valid authentication key parameter name/value to the specified URL.If the specified member is null, the url is returned untouched.
If there are existing parameter(s) to the specified url, the html entity & will be used for the ampersand required to append the parameter.
- Parameters:
url- the absolute URL for which an authentication key will be computedmember- the member that will be allowed to access the resource of the specified urlduration- a duration (in millisecond) after which the returned authkey will be expired (no longer valid). If set to 0, no expiration is used, if set to -1 (or any negative number) default expiration time is used.- Returns:
- an absolute URL with the added authentication key value that can be used to access the exact same URL without being logged
- Throws:
IllegalArgumentException- if url is null- Since:
- jcms-5.7.4
-
getUrlWithAddedAuthKeyParam
public static final String getUrlWithAddedAuthKeyParam(String url, Member member, long duration, boolean escapeAmpersand) Append a valid authentication key parameter name/value to the specified URL.If the specified member is null, the url is returned untouched.
- Parameters:
url- the absolute URL for which an authentication key will be computedmember- the member that will be allowed to access the resource of the specified urlduration- a duration (in millisecond) after which the returned authkey will be expired (no longer valid). If set to 0, no expiration is used, if set to -1 (or any negative number) default expiration time is used.escapeAmpersand- will use "&" if true, "&" if false- Returns:
- an absolute URL with the added authentication key value that can be used to access the exact same URL without being logged
- Throws:
IllegalArgumentException- if url is null- Since:
- jcms-5.7.4
-
getUrlWithAddedAuthKeyParam
public static final String getUrlWithAddedAuthKeyParam(String url, Member member, AuthKeyHints hints, boolean escapeAmpersand) Append a valid authentication key parameter name/value to the specified URL.If the specified member is null, the url is returned untouched.
- Parameters:
url- the absolute URL for which an authentication key will be computedmember- the member that will be allowed to access the resource of the specified urlhints- the specific parametersescapeAmpersand- will use "&" if true, "&" if false- Returns:
- an absolute URL with the added authentication key value that can be used to access the exact same URL without being logged
- Throws:
IllegalArgumentException- if url is null- Since:
- jcms-6.0
-
getUrlWithAddedAuthKeyParam
public static final String getUrlWithAddedAuthKeyParam(String url, Member member, AccessTokenOptions options, boolean escapeAmpersand) Append a valid authentication key parameter name/value to the specified URL.If the specified member is null, the url is returned untouched.
- Parameters:
url- the absolute URL for which an authentication key will be computed, MUST NOT be nullmember- the member that will be allowed to access the resource of the specified url, MUST NOT be nulloptions- the autkey options, MUST NOT be nullescapeAmpersand- will use "&" if true, "&" if false- Returns:
- an absolute URL with the added authentication key value that can be used to access the exact same URL without being logged
- Throws:
IllegalArgumentException- if url is null- Since:
- 10.0.8 / JCMS-4770
-
getUrlWithAddedAuthKeyParam
public static final String getUrlWithAddedAuthKeyParam(String url, String authKeyValue, boolean escapeAmpersand) Append the specified authentication key value as paramater.- Parameters:
url- the absolute URL for which an authentication key will be computedauthKeyValue- an existing authkey or a new authkey value generated withgetAuthKeyValue(String, Member, AccessTokenOptions)escapeAmpersand- will use "&" if true, "&" if false- Returns:
- an absolute URL with the added authentication key value that can be used to access the exact same URL without being logged
- Throws:
IllegalArgumentException- if url is null- Since:
- jcms-6.0
-
getDefaultAuthKeyDuration
public static final long getDefaultAuthKeyDuration()Retrieves the default authentication key duration (expiration time) to be used when no expiration duration as been specified.
Default is one year and can be changed using property"auth-mgr.authkey-duration".
Warning : this default duration is only used when developper did not specified an explicit duration when generating the authkey value or url.- Returns:
- a duration in milliseconds
- Since:
- jcms-5.7.4
-
getAuthKeyName
Retrieves the authentication key parameter name.
Default is"authKey"and can be changed using property"auth-mgr.authkey-name".- Returns:
- the authentication key parameter name
- Since:
- jcms-5.7.4
-
getAuthKeyServerSeed
Retrieves the server seed used in auth key digest.
Default is""and can be changed using property"auth-mgr.authkey-server-seed".- Returns:
- the authentication key parameter name
- Since:
- jcms-8.0.0
-
getAuthKeyValue
Retrieves a valid authentication key parameter value for the specified URL. The default duration is used.- Parameters:
url- the absolute URL for which an authentication key will be computedmember- the member that will be allowed to access the resource of the specified url, MUST NOT be null- Returns:
- an authentication key value that can be used to access the exact same URL without being logged
- Throws:
IllegalArgumentException- if url or member is null- Since:
- jcms-5.7.4
-
getAuthKeyValue
Retrieves a valid authentication key parameter value for the specified URL.- Parameters:
url- the absolute URL for which an authentication key will be computed, MUST NOT be nullmember- the member that will be allowed to access the resource of the specified url, MUST NOT be nullduration- a duration (in millisecond) after which the returned authkey will be expired (no longer valid). If set to 0, no expiration is used, if set to -1 (or any negative number) default expiration time is used.- Returns:
- an authentication key value that can be used to access the exact same URL without being logged
- Throws:
IllegalArgumentException- if url or member is null- Since:
- jcms-5.7.4
-
getAuthKeyValue
Deprecated.Retrieves a valid authentication key parameter value for the specified URL.- Parameters:
url- the absolute URL for which an authentication key will be computed, MUST NOT be nullmember- the member that will be allowed to access the resource of the specified url, MUST NOT be nullhints- additional parameter set in this javabean- Returns:
- an authentication key value that can be used to access the exact same URL without being logged
- Throws:
IllegalArgumentException- if url, member or options is null- Since:
- jcms-5.7.4
-
getAuthKeyValue
Retrieves a new authentication key value for the specified options.- Parameters:
url- the absolute URL for which an authentication key will be computed, MUST NOT be nullmember- the member that will be allowed to access the resource of the specified url, MUST NOT be nulloptions- options of the authkey, MUST NOT be null- Returns:
- an authentication key value that can be used to access the URL without being logged
- Throws:
NullPointerException- if url or member is null- Since:
- 10.0.8 / JCMS-4770
-
isValidAuthKey
public static final Member isValidAuthKey(String url, String authKey, javax.servlet.http.HttpServletRequest request) Checks if the given auth key is valid and if it is, returns the member to login.- Parameters:
url- the absolute url against which the auth key will be checkedauthKey- the authentication key to checksrequest- the current request- Returns:
- the Member authorized to login, or null otherwise
- Since:
- jcms-5.7.4
-
isValidAuthKey
public static final Member isValidAuthKey(String url, String authKey, javax.servlet.http.HttpServletRequest request, AuthenticationContext ctxt) Checks if the given auth key is valid and if it is, returns the member to login.- Parameters:
url- the absolute url against which the auth key will be checkedauthKey- the authentication key to checksrequest- the current requestctxt- the the current authentication context to inform of current state, may be null- Returns:
- the Member authorized to login, or null otherwise
- Since:
- jcms-10.0.5 / JCMS-7956
-
getAuthKeyValue(String, Member, AccessTokenOptions)