org.apache.kerby.kerberos.kerb.client.request

Class KdcRequest

java.lang.Object

org.apache.kerby.kerberos.kerb.client.request.KdcRequest

Direct Known Subclasses:

AsRequest, TgsRequest

public abstract class KdcRequest
extends Object

A wrapper for KdcReq request

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	credCache

Constructor Summary

Constructors

Constructor and Description
KdcRequest(KrbContext context)

Method Summary

Modifier and Type	Method and Description
void	addHost(String hostNameOrIpAddress)
void	askQuestion(String question, String challenge)
void	cacheValue(String key, Object value) Set a state item which will be recorded to an output ccache, if the calling application supplied one.
protected byte[]	decryptWithClientKey(EncryptedData data, KeyUsage usage)
int	generateNonce()
EncryptionKey	getArmorKey() Get a pointer to the FAST armor key, or NULL if the client is not using FAST.
EncryptionKey	getAsKey()
Object	getCacheValue(String key) Get a state item from an input ccache, which may allow it to retrace the steps it took last time.
EncryptionType	getChosenEncryptionType()
int	getChosenNonce()
abstract EncryptionKey	getClientKey()
abstract PrincipalName	getClientPrincipal()
KrbContext	getContext()
Map<String,Object>	getCredCache()
List<EncryptionType>	getEncryptionTypes()
EncryptionType	getEncType() Get the enctype expected to be used to encrypt the encrypted portion of the AS_REP packet.
KrbFastRequestState	getFastRequestState()
HostAddresses	getHostAddresses()
KdcOptions	getKdcOptions()
KdcRep	getKdcRep()
KdcReq	getKdcReq()
byte[]	getOuterRequestBody()
PreauthContext	getPreauthContext()
protected PreauthHandler	getPreauthHandler()
org.apache.kerby.KOptions	getPreauthOptions()
KerberosTime	getPreauthTime() Get the current time for use in a preauth response.
protected KdcReqBody	getReqBody()
org.apache.kerby.KOptions	getRequestOptions()
PrincipalName	getServerPrincipal()
Object	getSessionData()
KerberosTime	getTicketTillTime()
long	getTicketValidTime()
boolean	isRetrying()
protected KdcReqBody	makeReqBody()
void	needAsKey() Indicate interest in the AS key.
protected void	preauth()
void	process()
protected void	processKdcOptions()
abstract void	processResponse(KdcRep kdcRep)
void	resetPrequthContxt()
void	setAllowedPreauth(PaDataType paType)
void	setAsKey(EncryptionKey asKey)
void	setChosenEncryptionType(EncryptionType chosenEncryptionType)
void	setChosenNonce(int nonce)
void	setContext(KrbContext context)
void	setEncryptionTypes(List<EncryptionType> encryptionTypes)
void	setFastRequestState(KrbFastRequestState state)
void	setHostAddresses(List<HostAddress> hostAddresses)
void	setKdcOptions(KdcOptions kdcOptions)
void	setKdcRep(KdcRep kdcRep)
void	setKdcReq(KdcReq kdcReq)
void	setOuterRequestBody(byte[] outerRequestBody)
void	setPreauthRequired(boolean preauthRequired)
void	setRequestOptions(org.apache.kerby.KOptions options)
void	setServerPrincipal(PrincipalName serverPrincipal)
void	setSessionData(Object sessionData)

Methods inherited from class java.lang.Object

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

Field Detail

credCache

protected Map<String,Object> credCache

Constructor Detail

KdcRequest

public KdcRequest(KrbContext context)

Method Detail

getFastRequestState

public KrbFastRequestState getFastRequestState()

setFastRequestState

public void setFastRequestState(KrbFastRequestState state)

getOuterRequestBody

public byte[] getOuterRequestBody()

setOuterRequestBody

public void setOuterRequestBody(byte[] outerRequestBody)

getSessionData

public Object getSessionData()

setSessionData

public void setSessionData(Object sessionData)

getRequestOptions

public org.apache.kerby.KOptions getRequestOptions()

setRequestOptions

public void setRequestOptions(org.apache.kerby.KOptions options)

isRetrying

public boolean isRetrying()

getAsKey

public EncryptionKey getAsKey()
                       throws KrbException

Throws:

KrbException

setAsKey

public void setAsKey(EncryptionKey asKey)

setAllowedPreauth

public void setAllowedPreauth(PaDataType paType)

getCredCache

public Map<String,Object> getCredCache()

setPreauthRequired

public void setPreauthRequired(boolean preauthRequired)

resetPrequthContxt

public void resetPrequthContxt()

getPreauthContext

public PreauthContext getPreauthContext()

getKdcReq

public KdcReq getKdcReq()

setKdcReq

public void setKdcReq(KdcReq kdcReq)

getReqBody

protected KdcReqBody getReqBody()
                         throws KrbException

Throws:

KrbException

getKdcRep

public KdcRep getKdcRep()

setKdcRep

public void setKdcRep(KdcRep kdcRep)

makeReqBody

protected KdcReqBody makeReqBody()
                          throws KrbException

Throws:

KrbException

getKdcOptions

public KdcOptions getKdcOptions()

setKdcOptions

public void setKdcOptions(KdcOptions kdcOptions)

getHostAddresses

public HostAddresses getHostAddresses()

setHostAddresses

public void setHostAddresses(List<HostAddress> hostAddresses)

getContext

public KrbContext getContext()

setContext

public void setContext(KrbContext context)

decryptWithClientKey

protected byte[] decryptWithClientKey(EncryptedData data,
                                      KeyUsage usage)
                               throws KrbException

Throws:

KrbException

getClientPrincipal

public abstract PrincipalName getClientPrincipal()

getServerPrincipal

public PrincipalName getServerPrincipal()

setServerPrincipal

public void setServerPrincipal(PrincipalName serverPrincipal)

getEncryptionTypes

public List<EncryptionType> getEncryptionTypes()

setEncryptionTypes

public void setEncryptionTypes(List<EncryptionType> encryptionTypes)

getChosenEncryptionType

public EncryptionType getChosenEncryptionType()

setChosenEncryptionType

public void setChosenEncryptionType(EncryptionType chosenEncryptionType)

generateNonce

public int generateNonce()

getChosenNonce

public int getChosenNonce()

setChosenNonce

public void setChosenNonce(int nonce)

getClientKey

public abstract EncryptionKey getClientKey()
                                    throws KrbException

Throws:

KrbException

getTicketValidTime

public long getTicketValidTime()

getTicketTillTime

public KerberosTime getTicketTillTime()

addHost

public void addHost(String hostNameOrIpAddress)
             throws UnknownHostException

Throws:

UnknownHostException

process

public void process()
             throws KrbException

Throws:

KrbException

processResponse

public abstract void processResponse(KdcRep kdcRep)
                              throws KrbException

Throws:

KrbException

getPreauthOptions

public org.apache.kerby.KOptions getPreauthOptions()

preauth

protected void preauth()
                throws KrbException

Throws:

KrbException

getPreauthHandler

protected PreauthHandler getPreauthHandler()

needAsKey

public void needAsKey()
               throws KrbException

Indicate interest in the AS key.

Throws:

KrbException - e

getEncType

public EncryptionType getEncType()

Get the enctype expected to be used to encrypt the encrypted portion of the AS_REP packet. When handling a PREAUTH_REQUIRED error, this typically comes from etype-info2. When handling an AS reply, it is initialized from the AS reply itself.

Returns:

The encryption type

askQuestion

public void askQuestion(String question,
                        String challenge)

getArmorKey

public EncryptionKey getArmorKey()

Get a pointer to the FAST armor key, or NULL if the client is not using FAST.

Returns:

The encryption key

getPreauthTime

public KerberosTime getPreauthTime()

Get the current time for use in a preauth response. If allow_unauth_time is true and the library has been configured to allow it, the current time will be offset using unauthenticated timestamp information received from the KDC in the preauth-required error, if one has been received. Otherwise, the timestamp in a preauth-required error will only be used if it is protected by a FAST channel. Only set allow_unauth_time if using an unauthenticated time offset would not create a security issue.

Returns:

The current kerberos time

getCacheValue

public Object getCacheValue(String key)

Get a state item from an input ccache, which may allow it to retrace the steps it took last time. The returned data string is an alias and should not be freed.

Parameters:

key - The key string

Returns:

The item

cacheValue

public void cacheValue(String key,
                       Object value)

Set a state item which will be recorded to an output ccache, if the calling application supplied one. Both key and data should be valid UTF-8 text.

Parameters:

key - The key string

value - The value

processKdcOptions

protected void processKdcOptions()