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

Interface KrbPreauth

All Superinterfaces:

PreauthPluginMeta

All Known Implementing Classes:

AbstractPreauthPlugin, EncTsPreauth, PkinitPreauth, TgtPreauth, TokenPreauth

public interface KrbPreauth
extends PreauthPluginMeta

Client side preauth plugin module

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.
void	init(KrbContext krbContext) 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 preauthOptions) 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 interface org.apache.kerby.kerberos.kerb.preauth.PreauthPluginMeta

getName, getPaTypes, getVersion

Method Detail

init

void init(KrbContext krbContext)

Initializing preauth plugin context

Parameters:

krbContext - The krb context

initRequestContext

PluginRequestContext initRequestContext(KdcRequest kdcRequest)

Initializing request context

Parameters:

kdcRequest - The kdc request

Returns:

PluginRequestContext

prepareQuestions

void prepareQuestions(KdcRequest kdcRequest,
                      PluginRequestContext requestContext)
               throws KrbException

Prepare questions to prompt to you asking for credential

Parameters:

kdcRequest - The kdc request

requestContext - The request context

Throws:

KrbException - e

getEncTypes

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

Get supported encryption types

Parameters:

kdcRequest - The kdc request

requestContext - The request context

Returns:

The encryption type list

setPreauthOptions

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

Set krb options passed from user

Parameters:

kdcRequest - The kdc request

requestContext - The request context

preauthOptions - The preauth options

tryFirst

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

Attempt to try any initial padata derived from user options

Parameters:

kdcRequest - The kdc request

requestContext - The request context

outPadata - The outPadata

Throws:

KrbException - e

process

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

Process server returned paData and return back any result paData

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

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?

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

PaFlags getFlags(PaDataType paType)

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

Parameters:

paType - The pa_type

Returns:

PaFlags

destroy

void destroy()

When exiting...