| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class KerberosTicket extends Object implements Destroyable, Refreshable, Serializable
This class encapsulates a Kerberos ticket and associated information as viewed from the client's point of view. It captures all information that the Key Distribution Center (KDC) sends to the client in the reply message KDC-REP defined in the Kerberos Protocol Specification (RFC 1510).
All Kerberos JAAS login modules that authenticate a user to a KDC should use this class. Where available, the login module might even read this information from a ticket cache in the operating system instead of directly communicating with the KDC. During the commit phase of the JAAS authentication process, the JAAS login module should instantiate this class and store the instance in the private credential set of a {@link javax.security.auth.Subject Subject}.
It might be necessary for the application to be granted a {@link javax.security.auth.PrivateCredentialPermission PrivateCredentialPermission} if it needs to access a KerberosTicket instance from a Subject. This permission is not needed when the application depends on the default JGSS Kerberos mechanism to access the KerberosTicket. In that case, however, the application will need an appropriate {@link javax.security.auth.kerberos.ServicePermission ServicePermission}.
Note that this class is applicable to both ticket granting tickets and other regular service tickets. A ticket granting ticket is just a special case of a more generalized service ticket.
Constructor Summary | |
---|---|
KerberosTicket(byte[] asn1Encoding, KerberosPrincipal client, KerberosPrincipal server, byte[] sessionKey, int keyType, boolean[] flags, Date authTime, Date startTime, Date endTime, Date renewTill, InetAddress[] clientAddresses) Constructs a KerberosTicket using credentials information that a client either receives from a KDC or reads from a cache. |
Method Summary | |
---|---|
void |
destroy() Destroys the ticket and destroys any sensitive information stored in it. |
boolean |
Compares the specified Object with this KerberosTicket for equality. |
Date |
Returns the time that the client was authenticated. |
KerberosPrincipal |
Returns the client principal associated with this ticket. |
InetAddress[] |
Returns a list of addresses from where the ticket can be used. |
byte[] |
Returns an ASN.1 encoding of the entire ticket. |
Date |
Returns the expiration time for this ticket's validity period. |
boolean[] |
getFlags() Returns the flags associated with this ticket. |
Date |
Returns the latest expiration time for this ticket, including all renewals. |
KerberosPrincipal |
Returns the service principal associated with this ticket. |
SecretKey |
Returns the session key associated with this ticket. |
int |
Returns the key type of the session key associated with this ticket as defined by the Kerberos Protocol Specification. |
Date |
Returns the start time for this ticket's validity period. |
int |
hashCode() Returns a hashcode for this KerberosTicket. |
boolean |
Determines if this ticket is still current. |
boolean |
Determines if this ticket has been destroyed. |
boolean |
Determines if this ticket is forwardable. |
boolean |
Determines if this ticket had been forwarded or was issued based on authentication involving a forwarded ticket-granting ticket. |
boolean |
Determines if this ticket was issued using the Kerberos AS-Exchange protocol, and not issued based on some ticket-granting ticket. |
boolean |
Determines is this ticket is post-dated. |
boolean |
Determines if this ticket is proxiable. |
boolean |
isProxy() Determines is this ticket is a proxy-ticket. |
boolean |
Determines is this ticket is renewable. |
void |
refresh() Extends the validity period of this ticket. |
String |
toString() Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public KerberosTicket(byte[] asn1Encoding, KerberosPrincipal client, KerberosPrincipal server, byte[] sessionKey, int keyType, boolean[] flags, Date authTime, Date startTime, Date endTime, Date renewTill, InetAddress[] clientAddresses)
asn1Encoding
- the ASN.1 encoding of the ticket as defined by
the Kerberos protocol specification.client
- the client that owns this service
ticketserver
- the service that this ticket is forsessionKey
- the raw bytes for the session key that must be
used to encrypt the authenticator that will be sent to the serverkeyType
- the key type for the session key as defined by the
Kerberos protocol specification.flags
- the ticket flags. Each element in this array indicates
the value for the corresponding bit in the ASN.1 BitString that
represents the ticket flags. If the number of elements in this array
is less than the number of flags used by the Kerberos protocol,
then the missing flags will be filled in with false.authTime
- the time of initial authentication for the clientstartTime
- the time after which the ticket will be valid. This
may be null in which case the value of authTime is treated as the
startTime.endTime
- the time after which the ticket will no longer be
validrenewTill
- an absolute expiration time for the ticket,
including all renewal that might be possible. This field may be null
for tickets that are not renewable.clientAddresses
- the addresses from where the ticket may be
used by the client. This field may be null when the ticket is usable
from any address.Method Detail |
---|
public void destroy() throws DestroyFailedException
DestroyFailedException
public boolean equals(Object other)
KerberosTicket
and the two
KerberosTicket
instances are equivalent.
equals
in class Object
other
- the Object to compare topublic final Date getAuthTime()
public final KerberosPrincipal getClient()
public final InetAddress[] getClientAddresses()
public final byte[] getEncoded()
public final Date getEndTime()
public final boolean[] getFlags()
public final Date getRenewTill()
public final KerberosPrincipal getServer()
public final SecretKey getSessionKey()
public final int getSessionKeyType()
public final Date getStartTime()
public int hashCode()
hashCode
in class Object
KerberosTicket
public boolean isCurrent()
public boolean isDestroyed()
public final boolean isForwardable()
public final boolean isForwarded()
public final boolean isInitial()
public final boolean isPostdated()
public final boolean isProxiable()
public final boolean isProxy()
public final boolean isRenewable()
public void refresh() throws RefreshFailedException
RefreshFailedException
- if the ticket is not renewable, or
the latest allowable renew time has passed, or the KDC returns some
error.public String toString()
toString
in class Object
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |