OpenJDK 27 · sun.security.krb5.Credentials · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
pack-priv static boolean	alreadyLoaded
private static boolean	alreadyTried
pack-priv KerberosTime	authTime
pack-priv AuthorizationData	authzData
pack-priv HostAddresses	cAddr
pack-priv PrincipalName	client
pack-priv PrincipalName	clientAlias
pack-priv KerberosTime	endTime
pack-priv TicketFlags	flags
pack-priv EncryptionKey	key
private Credentials	proxy
pack-priv KerberosTime	renewTill
public static final boolean	S4U2PROXY_ACCEPT_NON_FORWARDABLE
pack-priv PrincipalName	server
pack-priv PrincipalName	serverAlias
pack-priv KerberosTime	startTime
pack-priv Ticket	ticket

Constructor Summary

Access	Constructor and Description
public	Credentials(Ticket new_ticket, PrincipalName new_client, PrincipalName new_client_alias, PrincipalName new_server, PrincipalName new_server_alias, EncryptionKey new_key, TicketFlags new_flags, KerberosTime authTime, KerberosTime new_startTime, KerberosTime new_endTime, KerberosTime renewTill, HostAddresses cAddr, AuthorizationData authzData)
public	Credentials(Ticket new_ticket, PrincipalName new_client, PrincipalName new_client_alias, PrincipalName new_server, PrincipalName new_server_alias, EncryptionKey new_key, TicketFlags new_flags, KerberosTime authTime, KerberosTime new_startTime, KerberosTime new_endTime, KerberosTime renewTill, HostAddresses cAddr)
public	Credentials(byte[] encoding, String client, String clientAlias, String server, String serverAlias, byte[] keyBytes, int keyType, boolean[] flags, Date authTime, Date startTime, Date endTime, Date renewTill, InetAddress[] cAddrs)

Method Summary

Modifier and Type	Method and Description
public static synchronized Credentials	Returns: a `KrbCreds` object if the credential is found, otherwise return null. acquireDefaultCreds() Acquires default credentials.
private static native Credentials	acquireDefaultNativeCreds(int[] eTypes)
public static Credentials	acquireS4U2proxyCreds(String service, Credentials userCreds, PrincipalName client, Credentials middleTGT)
public static Credentials	acquireS4U2selfCreds(PrincipalName user, Credentials middleTGT)
public static Credentials	Returns: a `Credentials` object. acquireServiceCreds(String the name of service principal using format components@realm service, Credentials client's initial credential. initCreds) Acquires credentials for a specified service using initial credential.
public static Credentials	Returns: the TGT credentials or null if none were found. If the tgt expired, it is the responsibility of the caller to determine this. acquireTGTFromCache(PrincipalName the client principal. A value of null means that the default principal name in the credentials cache will be used. princ, String the path to the tickets file. A value of null will be accepted to indicate that the default path should be searched ticketCache) Returns a TGT for the given client principal from a ticket cache.
public boolean	Returns: true if OK-AS_DELEGATE flag is set, otherwise, return false. checkDelegate() Checks if the service ticket returned by the KDC has the OK-AS-DELEGATE flag set
private static KerberosTime	date2kt(Date d)
pack-priv static void	ensureLoaded()
public final Date	getAuthTime()
public AuthorizationData	getAuthzData()
public final PrincipalName	getClient() Acquires a service ticket for the specified service principal.
public final InetAddress[]	getClientAddresses()
public final PrincipalName	getClientAlias()
public final byte[]	getEncoded()
public final Date	getEndTime()
public final boolean[]	getFlags()
public Credentials	getProxy()
public final Date	getRenewTill()
public final PrincipalName	getServer()
public final PrincipalName	getServerAlias()
public final EncryptionKey	getSessionKey()
public final Date	getStartTime()
public Ticket	getTicket()
public TicketFlags	getTicketFlags()
public boolean	isForwardable()
public boolean	isRenewable()
public static void	printDebug(Credentials c)
public Credentials	renew()
public void	resetDelegate() Reset TKT_OPTS_DELEGATE to false, called at credentials acquirement when one of the cross-realm TGTs does not have the OK-AS-DELEGATE flag set.
public Credentials	setProxy(Credentials proxy)
public Credentials	toCCacheCreds()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

alreadyLoaded	back to summary
pack-priv static boolean alreadyLoaded

alreadyTried	back to summary
private static boolean alreadyTried

authTime	back to summary
pack-priv KerberosTime authTime

authzData	back to summary
pack-priv AuthorizationData authzData

cAddr	back to summary
pack-priv HostAddresses cAddr

client	back to summary
pack-priv PrincipalName client

clientAlias	back to summary
pack-priv PrincipalName clientAlias

endTime	back to summary
pack-priv KerberosTime endTime

flags	back to summary
pack-priv TicketFlags flags

key	back to summary
pack-priv EncryptionKey key

proxy	back to summary
private Credentials proxy

renewTill	back to summary
pack-priv KerberosTime renewTill

S4U2PROXY_ACCEPT_NON_FORWARDABLE	back to summary
public static final boolean S4U2PROXY_ACCEPT_NON_FORWARDABLE

server	back to summary
pack-priv PrincipalName server

serverAlias	back to summary
pack-priv PrincipalName serverAlias

startTime	back to summary
pack-priv KerberosTime startTime

ticket	back to summary
pack-priv Ticket ticket

Constructor Detail

Credentials	back to summary
public Credentials(Ticket new_ticket, PrincipalName new_client, PrincipalName new_client_alias, PrincipalName new_server, PrincipalName new_server_alias, EncryptionKey new_key, TicketFlags new_flags, KerberosTime authTime, KerberosTime new_startTime, KerberosTime new_endTime, KerberosTime renewTill, HostAddresses cAddr, AuthorizationData authzData)

Credentials	back to summary
public Credentials(Ticket new_ticket, PrincipalName new_client, PrincipalName new_client_alias, PrincipalName new_server, PrincipalName new_server_alias, EncryptionKey new_key, TicketFlags new_flags, KerberosTime authTime, KerberosTime new_startTime, KerberosTime new_endTime, KerberosTime renewTill, HostAddresses cAddr)

Credentials	back to summary
public Credentials(byte[] encoding, String client, String clientAlias, String server, String serverAlias, byte[] keyBytes, int keyType, boolean[] flags, Date authTime, Date startTime, Date endTime, Date renewTill, InetAddress[] cAddrs) throws KrbException, IOException

Method Detail

acquireDefaultCreds back to summary

acquireDefaultCreds	back to summary
public static synchronized Credentials acquireDefaultCreds() Acquires default credentials. The possible locations for default credentials cache is searched in the following order: The directory and cache file name specified by "KRB5CCNAME" system. property. The directory and cache file name specified by "KRB5CCNAME" environment variable. A cache file named krb5cc_{user.name} at {user.home} directory. Returns:Credentials a `KrbCreds` object if the credential is found, otherwise return null.

public static synchronized Credentials acquireDefaultCreds()

Acquires default credentials.
The possible locations for default credentials cache is searched in the following order:

The directory and cache file name specified by "KRB5CCNAME" system. property.
The directory and cache file name specified by "KRB5CCNAME" environment variable.
A cache file named krb5cc_{user.name} at {user.home} directory.

Returns:Credentials: a KrbCreds object if the credential is found, otherwise return null.

acquireDefaultNativeCreds	back to summary
private static native Credentials acquireDefaultNativeCreds(int[] eTypes)

acquireS4U2proxyCreds	back to summary
public static Credentials acquireS4U2proxyCreds(String service, Credentials userCreds, PrincipalName client, Credentials middleTGT) throws KrbException, IOException

acquireS4U2selfCreds	back to summary
public static Credentials acquireS4U2selfCreds(PrincipalName user, Credentials middleTGT) throws KrbException, IOException

acquireServiceCreds back to summary

acquireServiceCreds	back to summary
public static Credentials acquireServiceCreds(String service, Credentials initCreds) throws KrbException, IOException Acquires credentials for a specified service using initial credential. When the service has a different realm from the initial credential, we do cross-realm authentication - first, we use the current credential to get a cross-realm credential from the local KDC, then use that cross-realm credential to request service credential from the foreigh KDC. Parameters service:String the name of service principal using format components@realm initCreds:Credentials client's initial credential. Returns:Credentials a `Credentials` object. Exceptions KrbException: if an error occurs specific to Kerberos IOException: if an error occurs in reading the credentials cache

public static Credentials acquireServiceCreds(String service, Credentials initCreds) throws KrbException, IOException

Acquires credentials for a specified service using initial credential. When the service has a different realm from the initial credential, we do cross-realm authentication - first, we use the current credential to get a cross-realm credential from the local KDC, then use that cross-realm credential to request service credential from the foreigh KDC.

Parameters

service:String: the name of service principal using format components@realm
initCreds:Credentials: client's initial credential.

Returns:Credentials

a Credentials object.

Exceptions

KrbException:: if an error occurs specific to Kerberos
IOException:: if an error occurs in reading the credentials cache

acquireTGTFromCache	back to summary
public static Credentials acquireTGTFromCache(PrincipalName princ, String ticketCache) throws KrbException, IOException Returns a TGT for the given client principal from a ticket cache. Parameters princ:PrincipalName the client principal. A value of null means that the default principal name in the credentials cache will be used. ticketCache:String the path to the tickets file. A value of null will be accepted to indicate that the default path should be searched Returns:Credentials the TGT credentials or null if none were found. If the tgt expired, it is the responsibility of the caller to determine this.

acquireTGTFromCache

back to summary

public static Credentials acquireTGTFromCache(PrincipalName princ, String ticketCache) throws KrbException, IOException

Returns a TGT for the given client principal from a ticket cache.

Parameters

princ:PrincipalName: the client principal. A value of null means that the default principal name in the credentials cache will be used.
ticketCache:String: the path to the tickets file. A value of null will be accepted to indicate that the default path should be searched

Returns:Credentials

the TGT credentials or null if none were found. If the tgt expired, it is the responsibility of the caller to determine this.

checkDelegate	back to summary
public boolean checkDelegate() Checks if the service ticket returned by the KDC has the OK-AS-DELEGATE flag set Returns:boolean true if OK-AS_DELEGATE flag is set, otherwise, return false.

checkDelegate

back to summary

public boolean checkDelegate()

Checks if the service ticket returned by the KDC has the OK-AS-DELEGATE flag set

Returns:boolean: true if OK-AS_DELEGATE flag is set, otherwise, return false.

date2kt	back to summary
private static KerberosTime date2kt(Date d)

ensureLoaded	back to summary
pack-priv static void ensureLoaded() Annotations @SuppressWarnings:restricted

getAuthTime	back to summary
public final Date getAuthTime()

getAuthzData	back to summary
public AuthorizationData getAuthzData()

getClient	back to summary
public final PrincipalName getClient() Acquires a service ticket for the specified service principal. If the service ticket is not already available, it obtains a new one from the KDC.

getClientAddresses	back to summary
public final InetAddress[] getClientAddresses()

getClientAlias	back to summary
public final PrincipalName getClientAlias()

getEncoded	back to summary
public final byte[] getEncoded()

getEndTime	back to summary
public final Date getEndTime()

getFlags	back to summary
public final boolean[] getFlags()

getProxy	back to summary
public Credentials getProxy()

getRenewTill	back to summary
public final Date getRenewTill()

getServer	back to summary
public final PrincipalName getServer()

getServerAlias	back to summary
public final PrincipalName getServerAlias()

getSessionKey	back to summary
public final EncryptionKey getSessionKey()

getStartTime	back to summary
public final Date getStartTime()

getTicket	back to summary
public Ticket getTicket()

getTicketFlags	back to summary
public TicketFlags getTicketFlags()

isForwardable	back to summary
public boolean isForwardable()

isRenewable	back to summary
public boolean isRenewable()

printDebug	back to summary
public static void printDebug(Credentials c)

renew	back to summary
public Credentials renew() throws KrbException, IOException

resetDelegate	back to summary
public void resetDelegate() Reset TKT_OPTS_DELEGATE to false, called at credentials acquirement when one of the cross-realm TGTs does not have the OK-AS-DELEGATE flag set. This info must be preservable and restorable through the Krb5Util.credsToTicket/ticketToCreds() methods so that even if the service ticket is cached it still remembers the cross-realm authentication result.

setProxy	back to summary
public Credentials setProxy(Credentials proxy)

toCCacheCreds	back to summary
public Credentials toCCacheCreds()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.