Package net.shibboleth.idp.cas.ticket.impl

Class EncodingTicketService

java.lang.Object

net.shibboleth.idp.cas.ticket.impl.AbstractTicketService

net.shibboleth.idp.cas.ticket.impl.EncodingTicketService

All Implemented Interfaces:

TicketService

public class EncodingTicketService
extends AbstractTicketService

Ticket service that uses two different strategies for ticket persistence:

1. Service tickets, proxy tickets, and root proxy-granting tickets are persisted by serializing ticket data and encrypting it into the opaque part of the ticket ID using a DataSealer.
2. Chained proxy-granting tickets are persisted using a StorageService.

NOTE: The service tickets, proxy tickets, and root proxy-granting tickets produced by this component do not support one-time use. More precisely, removeServiceTicket(String) and removeProxyTicket(String) simply return a decoded ticket and do not invalidate the ticket in any way. Since there is no backing store for those types of tickets, they can be reused until one of the following conditions is met:

1. The value of Ticket.getExpirationInstant() is exceeded.
2. The DataSealer key used to encrypt data is revoked.

Since:

3.3.0

Field Summary

Fields

Modifier and Type	Field	Description
private DataSealer	dataSealer	Data sealer that handles encryption of serialized service ticket data.
private org.slf4j.Logger	log	Class logger.
private static String	NOT_USED	Non-null marker value for unused ServiceTicket#id field and storage context name.
static String	PROXY_GRANTING_TICKET_PREFIX	Default proxy granting ticket prefix.
static String	PROXY_TICKET_PREFIX	Default proxy ticket prefix.
private String	proxyGrantingTicketPrefix	Proxy granting ticket prefix.
private String	proxyTicketPrefix	Proxy ticket prefix.
static String	SERVICE_TICKET_PREFIX	Default service ticket prefix.
private String	serviceTicketPrefix	Service ticket prefix.

Constructor Summary

Constructors

Constructor	Description
EncodingTicketService(StorageService service, DataSealer sealer)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
ProxyGrantingTicket	createProxyGrantingTicket(String id, Instant expiry, ServiceTicket serviceTicket)
ProxyTicket	createProxyTicket(String id, Instant expiry, ProxyGrantingTicket pgt, String service)
ServiceTicket	createServiceTicket(String id, Instant expiry, String service, TicketState state, boolean renew)
private <T extends Ticket> T	decode(Class<T> ticketClass, String id, String prefix)	Decode a ticket.
private <T extends Ticket> T	encode(Class<T> ticketClass, T ticket, String prefix)	Encode a ticket.
ProxyGrantingTicket	fetchProxyGrantingTicket(String id)
ProxyGrantingTicket	removeProxyGrantingTicket(String id)
ProxyTicket	removeProxyTicket(String id)
ServiceTicket	removeServiceTicket(String id)
void	setProxyGrantingTicketPrefix(String prefix)	Sets the proxy granting ticket prefix.
void	setProxyTicketPrefix(String prefix)	Sets the proxy ticket prefix.
void	setServiceTicketPrefix(String prefix)	Sets the service ticket prefix.

Methods inherited from class net.shibboleth.idp.cas.ticket.impl.AbstractTicketService

context, createProxyGrantingTicket, delete, read, serializer, store

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_TICKET_PREFIX

public static final String SERVICE_TICKET_PREFIX

Default service ticket prefix.

See Also:

Constant Field Values

PROXY_TICKET_PREFIX

public static final String PROXY_TICKET_PREFIX

Default proxy ticket prefix.

See Also:

Constant Field Values

PROXY_GRANTING_TICKET_PREFIX

public static final String PROXY_GRANTING_TICKET_PREFIX

Default proxy granting ticket prefix.

See Also:

Constant Field Values

NOT_USED

private static final String NOT_USED

Non-null marker value for unused ServiceTicket#id field and storage context name.

See Also:

Constant Field Values

log

private final org.slf4j.Logger log

Class logger.

dataSealer

@Nonnull
private final DataSealer dataSealer

Data sealer that handles encryption of serialized service ticket data.

serviceTicketPrefix

@NotEmpty
private String serviceTicketPrefix

Service ticket prefix.

proxyTicketPrefix

@NotEmpty
private String proxyTicketPrefix

Proxy ticket prefix.

proxyGrantingTicketPrefix

@NotEmpty
private String proxyGrantingTicketPrefix

Proxy granting ticket prefix.

Constructor Detail

EncodingTicketService

public EncodingTicketService(@Nonnull @ParameterName(name="service")
                             StorageService service,
                             @Nonnull @ParameterName(name="sealer")
                             DataSealer sealer)

Creates a new instance.

Parameters:

service - Storage service to which tickets are persisted.

sealer - data sealer

Method Detail

setServiceTicketPrefix

public void setServiceTicketPrefix(String prefix)

Sets the service ticket prefix. Default is ST.

Parameters:

prefix - Service ticket prefix.

setProxyTicketPrefix

public void setProxyTicketPrefix(String prefix)

Sets the proxy ticket prefix. Default is PT.

Parameters:

prefix - Proxy ticket prefix.

setProxyGrantingTicketPrefix

public void setProxyGrantingTicketPrefix(String prefix)

Sets the proxy granting ticket prefix. Default is PGT-E. Note that this MUST be distinct from the proxy granting ticket prefix used for regular proxy-granting ticket identifiers.

Parameters:

prefix - Proxy granting ticket prefix.

createServiceTicket

@Nonnull
public ServiceTicket createServiceTicket(@Nonnull
                                         String id,
                                         @Nonnull
                                         Instant expiry,
                                         @Nonnull
                                         String service,
                                         @Nullable
                                         TicketState state,
                                         boolean renew)

removeServiceTicket

@Nullable
public ServiceTicket removeServiceTicket(@Nonnull
                                         String id)

createProxyTicket

@Nonnull
public ProxyTicket createProxyTicket(@Nonnull
                                     String id,
                                     @Nonnull
                                     Instant expiry,
                                     @Nonnull
                                     ProxyGrantingTicket pgt,
                                     @Nonnull
                                     String service)

removeProxyTicket

@Nullable
public ProxyTicket removeProxyTicket(@Nonnull
                                     String id)

createProxyGrantingTicket

@Nullable
public ProxyGrantingTicket createProxyGrantingTicket(@Nonnull
                                                     String id,
                                                     @Nonnull
                                                     Instant expiry,
                                                     @Nonnull
                                                     ServiceTicket serviceTicket)

Specified by:

createProxyGrantingTicket in interface TicketService

Overrides:

createProxyGrantingTicket in class AbstractTicketService

fetchProxyGrantingTicket

@Nullable
public ProxyGrantingTicket fetchProxyGrantingTicket(@Nonnull
                                                    String id)

Specified by:

fetchProxyGrantingTicket in interface TicketService

Overrides:

fetchProxyGrantingTicket in class AbstractTicketService

removeProxyGrantingTicket

@Nullable
public ProxyGrantingTicket removeProxyGrantingTicket(@Nonnull
                                                     String id)

Specified by:

removeProxyGrantingTicket in interface TicketService

Overrides:

removeProxyGrantingTicket in class AbstractTicketService

encode

private <T extends Ticket> T encode(Class<T> ticketClass,
                                    T ticket,
                                    String prefix)

Encode a ticket.

Type Parameters:

T - type of ticket

Parameters:

ticketClass - class of ticket

ticket - ticket

prefix - ticket ID prefix

Returns:

ticket encoded ticket

decode

private <T extends Ticket> T decode(Class<T> ticketClass,
                                    String id,
                                    String prefix)

Decode a ticket.

Type Parameters:

T - type of ticket

Parameters:

ticketClass - class of ticket

id - ticket ID

prefix - ticket ID prefix

Returns:

decoded ticket