org.jasig.cas.authentication.handler.support

Class HttpBasedServiceCredentialsAuthenticationHandler

java.lang.Object

org.jasig.cas.authentication.AbstractAuthenticationHandler

org.jasig.cas.authentication.handler.support.HttpBasedServiceCredentialsAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler

public final class HttpBasedServiceCredentialsAuthenticationHandler
extends AbstractAuthenticationHandler

Class to validate the credential presented by communicating with the web server and checking the certificate that is returned against the hostname, etc.

This class is concerned with ensuring that the protocol is HTTPS and that a response is returned. The SSL handshake that occurs automatically by opening a connection does the heavy process of authenticating.

Since:

3.0

Author:

Scott Battaglia

Constructor Summary

Constructors

Constructor and Description
HttpBasedServiceCredentialsAuthenticationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
HandlerResult	authenticate(Credential credential) Authenticates the given credential.
void	setHttpClient(HttpClient httpClient) Sets the HttpClient which will do all of the connection stuff.
void	setRequireSecure(boolean requireSecure) Set whether a secure url is required or not.
boolean	supports(Credential credential) Determines whether the handler has the capability to authenticate the given credential.

Methods inherited from class org.jasig.cas.authentication.AbstractAuthenticationHandler

getName, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpBasedServiceCredentialsAuthenticationHandler

public HttpBasedServiceCredentialsAuthenticationHandler()

Method Detail

authenticate

public HandlerResult authenticate(Credential credential)
                           throws GeneralSecurityException

Description copied from interface: AuthenticationHandler

Authenticates the given credential. There are three possible outcomes of this process, and implementers MUST adhere to the following contract:

1. Success -- return HandlerResult
2. Failure -- throw GeneralSecurityException
3. Indeterminate -- throw PreventedException

Parameters:

credential - The credential to authenticate.

Returns:

A result object containing metadata about a successful authentication event that includes at a minimum the name of the handler that authenticated the credential and some credential metadata. The following data is optional:

• Principal
• Messages issued by the handler about the credential (e.g. impending password expiration warning)

Throws:

GeneralSecurityException - On authentication failures where the root cause is security related, e.g. invalid credential. Implementing classes SHOULD be as specific as possible in communicating the reason for authentication failure. Recommendations for common cases:

• Bad password: FailedLoginException
• Expired password: CredentialExpiredException
• User account expired: AccountExpiredException
• User account locked: AccountLockedException
• User account not found: AccountNotFoundException
• Time of authentication not allowed: InvalidLoginTimeException
• Location of authentication not allowed: InvalidLoginLocationException
• Expired X.509 certificate: CertificateExpiredException

supports

public boolean supports(Credential credential)

Description copied from interface: AuthenticationHandler

Determines whether the handler has the capability to authenticate the given credential. In practical terms, the AuthenticationHandler.authenticate(Credential) method MUST be capable of processing a given credential if supports returns true on the same credential.

Parameters:

credential - The credential to check.

Returns:

true if the credential provided are not null and the credential are a subclass of (or equal to) HttpBasedServiceCredential.

setHttpClient

public void setHttpClient(HttpClient httpClient)

Sets the HttpClient which will do all of the connection stuff.

Parameters:

httpClient - http client instance to use

setRequireSecure

public void setRequireSecure(boolean requireSecure)

Set whether a secure url is required or not.

Parameters:

requireSecure - true if its required, false if not. Default is true.