Authenticator

java.lang.Object
- org.apache.directory.shared.kerberos.messages.KerberosMessage
- - org.apache.directory.shared.kerberos.messages.Authenticator

All Implemented Interfaces:: org.apache.directory.api.asn1.Asn1Object

public class Authenticator
extends KerberosMessage

A structure to hold the authenticator data. It will store the object described by the ASN.1 grammar :

 Authenticator   ::= [APPLICATION 2] SEQUENCE  {
         authenticator-vno       [0] INTEGER (5),
         crealm                  [1] Realm,
         cname                   [2] ,
         cksum                   [3]  OPTIONAL,
         cusec                   [4] Microseconds,
         ctime                   [5] KerberosTime,
         subkey                  [6]  OPTIONAL,
         seq-number              [7] UInt32 OPTIONAL,
         authorization-data      [8]  OPTIONAL
 }

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`authenticatorLength`
`private int`	`authenticatorSeqLength`
`private int`	`authenticatorVnoLength`
`private AuthorizationData`	`authorizationData` The authorization Data
`private int`	`authorizationDataLength`
`private Checksum`	`cksum` The checksum
`private int`	`cksumLength`
`private PrincipalName`	`cname` The client principalName
`private int`	`cnameLength`
`private java.lang.String`	`crealm` The client realm
`private byte[]`	`crealmBytes`
`private int`	`crealmLength`
`private KerberosTime`	`ctime` The client time
`private int`	`ctimeLength`
`private int`	`cusec` The client microseconds
`private int`	`cusecLength`
`private static boolean`	`IS_DEBUG` Speedup for logs
`private static org.slf4j.Logger`	`LOG` The logger
`private java.lang.Integer`	`seqNumber` The sequence number
`private int`	`seqNumberLength`
`private EncryptionKey`	`subKey` The sub-session key
`private int`	`subkeyLength`
`private int`	`versionNumber` The authenticator version number

Constructor Summary

Constructors
Constructor and Description

Authenticator()
Creates a new instance of Authenticator.

Constructors
Constructor and Description
`Authenticator()` Creates a new instance of Authenticator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`computeLength()` Compute the Authenticator length
`java.nio.ByteBuffer`	`encode(java.nio.ByteBuffer buffer)` Encode the Authenticator message to a PDU.
`AuthorizationData`	`getAuthorizationData()` Returns the `AuthorizationData`.
`Checksum`	`getCksum()`
`PrincipalName`	`getCName()`
`java.lang.String`	`getCRealm()`
`KerberosTime`	`getCtime()`
`int`	`getCusec()`
`java.lang.Integer`	`getSeqNumber()`
`EncryptionKey`	`getSubKey()`
`int`	`getVersionNumber()` Returns the version number of the `Authenticator`.
`private void`	`reset()` reset the fields used while computing length
`void`	`setAuthorizationData(AuthorizationData authorizationData)`
`void`	`setCksum(Checksum cksum)`
`void`	`setCName(PrincipalName cname)`
`void`	`setCRealm(java.lang.String crealm)`
`void`	`setCTime(KerberosTime ctime)`
`void`	`setCusec(int cusec)`
`void`	`setSeqNumber(int seqNumber)`
`void`	`setSubKey(EncryptionKey subKey)`
`void`	`setVersionNumber(int versionNumber)`
`java.lang.String`	`toString()`

Methods inherited from class org.apache.directory.shared.kerberos.messages.KerberosMessage
getMessageType, getProtocolVersionNumber, setMessageType, setProtocolVersionNumber

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

The logger

IS_DEBUG
```
private static final boolean IS_DEBUG
```
Speedup for logs

versionNumber
```
private int versionNumber
```
The authenticator version number

crealm
```
private java.lang.String crealm
```
The client realm

cname
```
private PrincipalName cname
```
The client principalName

cksum
```
private Checksum cksum
```
The checksum

cusec
```
private int cusec
```
The client microseconds

ctime
```
private KerberosTime ctime
```
The client time

subKey
```
private EncryptionKey subKey
```
The sub-session key

seqNumber
```
private java.lang.Integer seqNumber
```
The sequence number

authorizationData

private AuthorizationData authorizationData

The authorization Data

authenticatorVnoLength
```
private int authenticatorVnoLength
```

crealmLength
```
private int crealmLength
```

crealmBytes
```
private byte[] crealmBytes
```

cnameLength
```
private int cnameLength
```

cksumLength
```
private int cksumLength
```

cusecLength
```
private int cusecLength
```

ctimeLength
```
private int ctimeLength
```

subkeyLength
```
private int subkeyLength
```

seqNumberLength
```
private int seqNumberLength
```

authorizationDataLength
```
private int authorizationDataLength
```

authenticatorSeqLength
```
private int authenticatorSeqLength
```

authenticatorLength
```
private int authenticatorLength
```

Constructor Detail
- Authenticator
```
public Authenticator()
```
  Creates a new instance of Authenticator.

Method Detail

getAuthorizationData
```
public AuthorizationData getAuthorizationData()
```
Returns the AuthorizationData.

Returns:

The AuthorizationData.

setAuthorizationData
```
public void setAuthorizationData(AuthorizationData authorizationData)
```
Parameters:

authorizationData - the authorizationData to set

getCksum
```
public Checksum getCksum()
```
Returns:

the cksum

setCksum
```
public void setCksum(Checksum cksum)
```
Parameters:

cksum - the cksum to set

getCName
```
public PrincipalName getCName()
```
Returns:

the cname

setCName

public void setCName(PrincipalName cname)

Parameters:: cname - the cname to set

getCRealm
```
public java.lang.String getCRealm()
```
Returns:

the crealm

setCRealm

public void setCRealm(java.lang.String crealm)

Parameters:: crealm - the crealm to set

getCtime
```
public KerberosTime getCtime()
```
Returns:

the ctime

setCTime

public void setCTime(KerberosTime ctime)

Parameters:: ctime - the ctime to set

getCusec
```
public int getCusec()
```
Returns:

the cusec

setCusec
```
public void setCusec(int cusec)
```
Parameters:

cusec - the cusec to set

getSeqNumber

public java.lang.Integer getSeqNumber()

Returns:: the seqNumber

setSeqNumber
```
public void setSeqNumber(int seqNumber)
```
Parameters:

seqNumber - the seqNumber to set

getSubKey
```
public EncryptionKey getSubKey()
```
Returns:

the subKey

setSubKey

public void setSubKey(EncryptionKey subKey)

Parameters:: subKey - the subKey to set

getVersionNumber
```
public int getVersionNumber()
```
Returns the version number of the Authenticator.

Returns:

The version number of the Authenticator.

setVersionNumber
```
public void setVersionNumber(int versionNumber)
```
Parameters:

versionNumber - the versionNumber to set

computeLength

public int computeLength()

Compute the Authenticator length

 Authenticator :
 
 0x62 L1 Authenticator [APPLICATION 2]
  |
  +--> 0x30 L2 Authenticator SEQUENCE
        |
        +--> 0xA0 03 authenticator-vno tag
        |     |
        |     +--> 0x02 0x01 0x05 authenticator-vno (int, 5)
        |
        +--> 0xA1 L3 crealm tag
        |     |
        |     +--> 0x1B L3-1 crealm (KerberosString)
        |
        +--> 0xA2 L4 cname (PrincipalName)
        |
        +--> 0xA3 L5 cksum (CheckSum)
        |
        +--> 0xA4 L6 cusec tag
        |     |
        |     +--> 0x02 L6-1 nnn cusec value (Integer)
        |
        +--> 0xA5 0x11 ctime tag
        |     |
        |     +--> 0x18 0x0F ttt ctime (KerberosTime)
        |
        +--> 0xA6 L7 subkey (EncryptionKey)
        |
        +--> 0xA7 L8 seq-number tag
        |     |
        |     +--> 0x02 L8-1 nnn seq-number (Integer)
        |
        +--> 0xA8 L9 authorization-data (AuthorizationData)

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.api.asn1.EncoderException

Encode the Authenticator message to a PDU.

 Authenticator :
 
 0x62 LL
   0x30 LL
     0xA0 0x03
       0x02 0x01 0x05 authenticator-vno
     0xA1 LL
       0x1B LL abcd crealm
     0xA2 LL
       0x30 LL abcd cname
    [0xA3 LL
       0x30 LL abcd] cksum
     0xA4 LL
       0x02 LL nnn  cusec
     0xA5 0x11
       0x18 0x0F ttt ctime
    [0xA6 LL
       0x30 LL abcd] subkey
    [0xA7 LL
       0x02 LL nnn] seq-number
    [0xA8 LL
       0x30 LL abcd] authorization-data

Returns:: The constructed PDU.
Throws:: org.apache.directory.api.asn1.EncoderException

reset
```
private void reset()
```
reset the fields used while computing length

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

Class Authenticator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.directory.shared.kerberos.messages.KerberosMessage

Methods inherited from class java.lang.Object

Field Detail

LOG

IS_DEBUG

versionNumber

crealm

cname

cksum

cusec

ctime

subKey

seqNumber

authorizationData

authenticatorVnoLength

crealmLength

crealmBytes

cnameLength

cksumLength

cusecLength

ctimeLength

subkeyLength

seqNumberLength

authorizationDataLength

authenticatorSeqLength

authenticatorLength

Constructor Detail

Authenticator

Method Detail

getAuthorizationData

setAuthorizationData

getCksum

setCksum

getCName

setCName

getCRealm

setCRealm

getCtime

setCTime

getCusec

setCusec

getSeqNumber

setSeqNumber

getSubKey

setSubKey

getVersionNumber

setVersionNumber

computeLength

encode

reset

toString