Package org.apereo.cas

Interface CentralAuthenticationService

public interface CentralAuthenticationService

CAS viewed as a set of services to generate and validate Tickets.

This is the interface between a Web HTML, Web Services, RMI, or any other request processing layer and the CAS Service viewed as a mechanism to generate, store, validate, and retrieve Tickets containing Authentication information. The features of the request processing layer (the HttpXXX Servlet objects) are not visible here or in any modules behind this layer. In theory, a standalone application could call these methods directly as a private authentication service.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BEAN_NAME	Default bean name.
static java.lang.String	NAMESPACE	CAS namespace.

Method Summary

Modifier and Type	Method	Description
org.apereo.cas.ticket.proxy.ProxyGrantingTicket	createProxyGrantingTicket(java.lang.String serviceTicketId, org.apereo.cas.authentication.AuthenticationResult authenticationResult)	Delegate a TicketGrantingTicket to a Service for proxying authentication to other Services.
org.apereo.cas.ticket.TicketGrantingTicket	createTicketGrantingTicket(org.apereo.cas.authentication.AuthenticationResult authenticationResult)	Create a TicketGrantingTicket by authenticating credentials.
org.apereo.cas.ticket.TicketFactory	getTicketFactory()	Gets ticket factory.
org.apereo.cas.ticket.proxy.ProxyTicket	grantProxyTicket(java.lang.String proxyGrantingTicket, org.apereo.cas.authentication.principal.Service service)	Grant a ProxyTicket that may be used to access the given service by authenticating the given credentials.
org.apereo.cas.ticket.ServiceTicket	grantServiceTicket(java.lang.String ticketGrantingTicketId, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.authentication.AuthenticationResult authenticationResult)	Grant a ServiceTicket that may be used to access the given service by authenticating the given credentials.
org.apereo.cas.validation.Assertion	validateServiceTicket(java.lang.String serviceTicketId, org.apereo.cas.authentication.principal.Service service)	Validate a ServiceTicket for a particular Service.

Field Detail

BEAN_NAME

static final java.lang.String BEAN_NAME

Default bean name.

See Also:

Constant Field Values

NAMESPACE

static final java.lang.String NAMESPACE

CAS namespace.

Method Detail

createTicketGrantingTicket

org.apereo.cas.ticket.TicketGrantingTicket createTicketGrantingTicket(org.apereo.cas.authentication.AuthenticationResult authenticationResult)
                                                               throws org.apereo.cas.authentication.AuthenticationException,
                                                                      org.apereo.cas.ticket.AbstractTicketException

Create a TicketGrantingTicket by authenticating credentials. The details of the security policy around credential authentication and the definition of authentication success are dependent on the implementation, but it SHOULD be safe to assume that at least one credential MUST be authenticated for ticket creation to succeed.

Parameters:

authenticationResult - the current authentication result in order to create the ticket.

Returns:

Non -null ticket-granting ticket identifier.

Throws:

org.apereo.cas.authentication.AuthenticationException - on errors authenticating the credentials

org.apereo.cas.ticket.AbstractTicketException - if ticket cannot be created

grantServiceTicket

org.apereo.cas.ticket.ServiceTicket grantServiceTicket(java.lang.String ticketGrantingTicketId,
                                                       org.apereo.cas.authentication.principal.Service service,
                                                       org.apereo.cas.authentication.AuthenticationResult authenticationResult)
                                                throws org.apereo.cas.authentication.AuthenticationException,
                                                       org.apereo.cas.ticket.AbstractTicketException

Grant a ServiceTicket that may be used to access the given service by authenticating the given credentials. The details of the security policy around credential authentication and the definition of authentication success are dependent on the implementation, but it SHOULD be safe to assume that at least one credential MUST be authenticated for ticket creation to succeed.

The principal that is resolved from the authenticated credentials MUST be the same as that to which the given ticket-granting ticket was issued.

Parameters:

ticketGrantingTicketId - Proof of prior authentication.

service - The target service of the ServiceTicket.

authenticationResult - The authentication context established if credentials provided

Returns:

Non -null service ticket identifier.

Throws:

org.apereo.cas.authentication.AuthenticationException - on errors authenticating the credentials

org.apereo.cas.ticket.AbstractTicketException - if the ticket could not be created.

grantProxyTicket

org.apereo.cas.ticket.proxy.ProxyTicket grantProxyTicket(java.lang.String proxyGrantingTicket,
                                                         org.apereo.cas.authentication.principal.Service service)
                                                  throws org.apereo.cas.ticket.AbstractTicketException

Grant a ProxyTicket that may be used to access the given service by authenticating the given credentials. The details of the security policy around credential authentication and the definition of authentication success are dependent on the implementation, but it SHOULD be safe to assume that at least one credential MUST be authenticated for ticket creation to succeed.

The principal that is resolved from the authenticated credentials MUST be the same as that to which the given ticket-granting ticket was issued.

Parameters:

proxyGrantingTicket - Proof of prior authentication.

service - The target service of the ServiceTicket.

Returns:

Non -null service ticket identifier.

Throws:

org.apereo.cas.ticket.AbstractTicketException - if the ticket could not be created.

validateServiceTicket

org.apereo.cas.validation.Assertion validateServiceTicket(java.lang.String serviceTicketId,
                                                          org.apereo.cas.authentication.principal.Service service)
                                                   throws org.apereo.cas.ticket.AbstractTicketException

Validate a ServiceTicket for a particular Service.

Parameters:

serviceTicketId - Proof of prior authentication.

service - Service wishing to validate a prior authentication.

Returns:

Non -null ticket validation assertion.

Throws:

org.apereo.cas.ticket.AbstractTicketException - if there was an error validating the ticket.

createProxyGrantingTicket

org.apereo.cas.ticket.proxy.ProxyGrantingTicket createProxyGrantingTicket(java.lang.String serviceTicketId,
                                                                          org.apereo.cas.authentication.AuthenticationResult authenticationResult)
                                                                   throws org.apereo.cas.authentication.AuthenticationException,
                                                                          org.apereo.cas.ticket.AbstractTicketException

Delegate a TicketGrantingTicket to a Service for proxying authentication to other Services.

Parameters:

serviceTicketId - The service ticket identifier that will delegate to a TicketGrantingTicket.

authenticationResult - The current authentication context before this ticket can be granted.

Returns:

Non -null ticket-granting ticket identifier that can grant ServiceTicket that proxy authentication.

Throws:

org.apereo.cas.authentication.AuthenticationException - on errors authenticating the credentials

org.apereo.cas.ticket.AbstractTicketException - if there was an error creating the ticket

getTicketFactory

org.apereo.cas.ticket.TicketFactory getTicketFactory()

Gets ticket factory.

Returns:

the ticket factory