org.apache.kerby.kerberos.kerb.client

Class KrbClientBase

java.lang.Object

org.apache.kerby.kerberos.kerb.client.KrbClientBase

Direct Known Subclasses:

KrbClient, KrbPkinitClient, KrbTokenClient

public class KrbClientBase
extends Object

A Krb client API for applications to interact with KDC

Constructor Summary

Constructors

Constructor and Description
KrbClientBase() Default constructor.
KrbClientBase(File confDir) Constructor with conf dir
KrbClientBase(KrbClientBase krbClient) Constructor with prepared KrbClientBase.
KrbClientBase(KrbConfig krbConfig) Construct with prepared KrbConfig.

Method Summary

Modifier and Type	Method and Description
Credential	getCredentialFromFile(File ccFile)
KrbConfig	getKrbConfig()
KrbSetting	getSetting() Get krb client settings from options and configs.
TgtTicket	getTgtTicketFromCredential(Credential cc)
void	init() Init the client.
void	renewTicket(SgtTicket sgtTicket, File ccacheFile) Store sgt into the specified credential cache file.
SgtTicket	requestSgt(File ccFile, String servicePrincipal) Request a service ticket
SgtTicket	requestSgt(org.apache.kerby.KOptions requestOptions) Request a service ticket provided request options
SgtTicket	requestSgt(TgtTicket tgt, String serverPrincipal) Request a service ticket with a TGT targeting for a server
TgtTicket	requestTgt(org.apache.kerby.KOptions requestOptions) Request a TGT with using well prepared requestOptions.
CredentialCache	resolveCredCache(File ccacheFile)
void	setAllowTcp(boolean allowTcp) Set to allow TCP or not.
void	setAllowUdp(boolean allowUdp) Set to allow UDP or not.
void	setKdcHost(String kdcHost) Set KDC host.
void	setKdcRealm(String realm) Set KDC realm for ticket request
void	setKdcTcpPort(int kdcTcpPort) Set KDC tcp port.
void	setKdcUdpPort(int kdcUdpPort) Set KDC udp port.
void	setTimeout(int timeout) Set time out for connection
void	storeTicket(SgtTicket sgtTicket, File ccacheFile) Store sgt into the specified credential cache file.
void	storeTicket(TgtTicket tgtTicket, File ccacheFile) Store tgt into the specified credential cache file.

Methods inherited from class java.lang.Object

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

Constructor Detail

KrbClientBase

public KrbClientBase()
              throws KrbException

Default constructor.

Throws:

KrbException - e

KrbClientBase

public KrbClientBase(KrbConfig krbConfig)

Construct with prepared KrbConfig.

Parameters:

krbConfig - The krb config

KrbClientBase

public KrbClientBase(File confDir)
              throws KrbException

Constructor with conf dir

Parameters:

confDir - The conf dir

Throws:

KrbException - e

KrbClientBase

public KrbClientBase(KrbClientBase krbClient)

Constructor with prepared KrbClientBase.

Parameters:

krbClient - The krb client

Method Detail

setKdcRealm

public void setKdcRealm(String realm)

Set KDC realm for ticket request

Parameters:

realm - The realm

setKdcHost

public void setKdcHost(String kdcHost)

Set KDC host.

Parameters:

kdcHost - The kdc host

setKdcTcpPort

public void setKdcTcpPort(int kdcTcpPort)

Set KDC tcp port.

Parameters:

kdcTcpPort - The kdc tcp port

setAllowUdp

public void setAllowUdp(boolean allowUdp)

Set to allow UDP or not.

Parameters:

allowUdp - true if allow udp

setAllowTcp

public void setAllowTcp(boolean allowTcp)

Set to allow TCP or not.

Parameters:

allowTcp - true if allow tcp

setKdcUdpPort

public void setKdcUdpPort(int kdcUdpPort)

Set KDC udp port. Only makes sense when allowUdp is set.

Parameters:

kdcUdpPort - The kdc udp port

setTimeout

public void setTimeout(int timeout)

Set time out for connection

Parameters:

timeout - in seconds

init

public void init()
          throws KrbException

Init the client.

Throws:

KrbException - e

getSetting

public KrbSetting getSetting()

Get krb client settings from options and configs.

Returns:

setting

getKrbConfig

public KrbConfig getKrbConfig()

requestTgt

public TgtTicket requestTgt(org.apache.kerby.KOptions requestOptions)
                     throws KrbException

Request a TGT with using well prepared requestOptions.

Parameters:

requestOptions - The request options

Returns:

TGT

Throws:

KrbException - e

requestSgt

public SgtTicket requestSgt(TgtTicket tgt,
                            String serverPrincipal)
                     throws KrbException

Request a service ticket with a TGT targeting for a server

Parameters:

tgt - The tgt ticket

serverPrincipal - The server principal

Returns:

Service ticket

Throws:

KrbException - e

requestSgt

public SgtTicket requestSgt(org.apache.kerby.KOptions requestOptions)
                     throws KrbException

Request a service ticket provided request options

Parameters:

requestOptions - The request options

Returns:

service ticket

Throws:

KrbException - e

requestSgt

public SgtTicket requestSgt(File ccFile,
                            String servicePrincipal)
                     throws KrbException

Request a service ticket

Parameters:

ccFile - The credential cache file

servicePrincipal - The service principal

Returns:

service ticket

Throws:

KrbException - e

storeTicket

public void storeTicket(TgtTicket tgtTicket,
                        File ccacheFile)
                 throws KrbException

Store tgt into the specified credential cache file.

Parameters:

tgtTicket - The tgt ticket

ccacheFile - The credential cache file

Throws:

KrbException - e

storeTicket

public void storeTicket(SgtTicket sgtTicket,
                        File ccacheFile)
                 throws KrbException

Store sgt into the specified credential cache file.

Parameters:

sgtTicket - The sgt ticket

ccacheFile - The credential cache file

Throws:

KrbException - e

renewTicket

public void renewTicket(SgtTicket sgtTicket,
                        File ccacheFile)
                 throws KrbException

Store sgt into the specified credential cache file.

Parameters:

sgtTicket - The sgt ticket

ccacheFile - The credential cache file

Throws:

KrbException - e

getTgtTicketFromCredential

public TgtTicket getTgtTicketFromCredential(Credential cc)

getCredentialFromFile

public Credential getCredentialFromFile(File ccFile)
                                 throws KrbException

Throws:

KrbException

resolveCredCache

public CredentialCache resolveCredCache(File ccacheFile)
                                 throws IOException

Throws:

IOException