org.apache.kerby.kerberos.kerb.client.preauth

Class AbstractPreauthPlugin

java.lang.Object

org.apache.kerby.kerberos.kerb.client.preauth.AbstractPreauthPlugin

All Implemented Interfaces:

KrbPreauth, PreauthPluginMeta

Direct Known Subclasses:

EncTsPreauth, PkinitPreauth, TgtPreauth, TokenPreauth

public class AbstractPreauthPlugin
extends Object
implements KrbPreauth

Field Summary

Fields

Modifier and Type	Field and Description
protected KrbContext	context

Constructor Summary

Constructors

Constructor and Description
AbstractPreauthPlugin(PreauthPluginMeta meta)

Method Summary

Modifier and Type	Method and Description
void	destroy() When exiting...
List<EncryptionType>	getEncTypes(KdcRequest kdcRequest, PluginRequestContext requestContext) Get supported encryption types
PaFlags	getFlags(PaDataType paType) Return PA_REAL if pa_type is a real preauthentication type or PA_INFO if it is an informational type.
String	getName() Get plugin name.
PaDataType[]	getPaTypes() Get padata type.
int	getVersion() Get plugin version.
void	init(KrbContext context) Initializing preauth plugin context
PluginRequestContext	initRequestContext(KdcRequest kdcRequest) Initializing request context
void	prepareQuestions(KdcRequest kdcRequest, PluginRequestContext requestContext) Prepare questions to prompt to you asking for credential
boolean	process(KdcRequest kdcRequest, PluginRequestContext requestContext, PaDataEntry inPadata, PaData outPadata) Process server returned paData and return back any result paData
void	setPreauthOptions(KdcRequest kdcRequest, PluginRequestContext requestContext, org.apache.kerby.KOptions options) Set krb options passed from user
boolean	tryAgain(KdcRequest kdcRequest, PluginRequestContext requestContext, PaDataType preauthType, PaData errPadata, PaData outPadata) When another request to server in the 4 pass, any paData to provide?
void	tryFirst(KdcRequest kdcRequest, PluginRequestContext requestContext, PaData outPadata) Attempt to try any initial padata derived from user options

Methods inherited from class java.lang.Object

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

Field Detail

context

protected KrbContext context

Constructor Detail

AbstractPreauthPlugin

public AbstractPreauthPlugin(PreauthPluginMeta meta)

Method Detail

getName

public String getName()

Get plugin name.

Specified by:

getName in interface PreauthPluginMeta

getVersion

public int getVersion()

Get plugin version.

Specified by:

getVersion in interface PreauthPluginMeta

getPaTypes

public PaDataType[] getPaTypes()

Get padata type.

Specified by:

getPaTypes in interface PreauthPluginMeta

init

public void init(KrbContext context)

Initializing preauth plugin context

Specified by:

init in interface KrbPreauth

Parameters:

context - The krb context

initRequestContext

public PluginRequestContext initRequestContext(KdcRequest kdcRequest)

Initializing request context

Specified by:

initRequestContext in interface KrbPreauth

Parameters:

kdcRequest - The kdc request

Returns:

PluginRequestContext

prepareQuestions

public void prepareQuestions(KdcRequest kdcRequest,
                             PluginRequestContext requestContext)
                      throws KrbException

Prepare questions to prompt to you asking for credential

Specified by:

prepareQuestions in interface KrbPreauth

Parameters:

kdcRequest - The kdc request

requestContext - The request context

Throws:

KrbException - e

getEncTypes

public List<EncryptionType> getEncTypes(KdcRequest kdcRequest,
                                        PluginRequestContext requestContext)

Get supported encryption types

Specified by:

getEncTypes in interface KrbPreauth

Parameters:

kdcRequest - The kdc request

requestContext - The request context

Returns:

The encryption type list

setPreauthOptions

public void setPreauthOptions(KdcRequest kdcRequest,
                              PluginRequestContext requestContext,
                              org.apache.kerby.KOptions options)

Set krb options passed from user

Specified by:

setPreauthOptions in interface KrbPreauth

Parameters:

kdcRequest - The kdc request

requestContext - The request context

options - The preauth options

tryFirst

public void tryFirst(KdcRequest kdcRequest,
                     PluginRequestContext requestContext,
                     PaData outPadata)
              throws KrbException

Attempt to try any initial padata derived from user options

Specified by:

tryFirst in interface KrbPreauth

Parameters:

kdcRequest - The kdc request

requestContext - The request context

outPadata - The outPadata

Throws:

KrbException - e

process

public boolean process(KdcRequest kdcRequest,
                       PluginRequestContext requestContext,
                       PaDataEntry inPadata,
                       PaData outPadata)
                throws KrbException

Process server returned paData and return back any result paData

Specified by:

process in interface KrbPreauth

Parameters:

kdcRequest - The kdc request

requestContext - The request context

inPadata - The inPadata

outPadata - The outPadata

Returns:

true indicating padata is added

Throws:

KrbException - e

tryAgain

public boolean tryAgain(KdcRequest kdcRequest,
                        PluginRequestContext requestContext,
                        PaDataType preauthType,
                        PaData errPadata,
                        PaData outPadata)

When another request to server in the 4 pass, any paData to provide?

Specified by:

tryAgain in interface KrbPreauth

Parameters:

kdcRequest - The kdc request

requestContext - The request context

preauthType - The preauth type

errPadata - The error padata

outPadata - The outPadata

Returns:

true indicating padata is added

getFlags

public PaFlags getFlags(PaDataType paType)

Return PA_REAL if pa_type is a real preauthentication type or PA_INFO if it is an informational type.

Specified by:

getFlags in interface KrbPreauth

Parameters:

paType - The pa_type

Returns:

PaFlags

destroy

public void destroy()

When exiting...

Specified by:

destroy in interface KrbPreauth