KdcReqBody

java.lang.Object
- org.apache.directory.shared.kerberos.components.KdcReqBody

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

public class KdcReqBody
extends java.lang.Object
implements org.apache.directory.api.asn1.Asn1Object

The KDC-REQ-BODY data structure. It will store the object described by the ASN.1 grammar :

 KDC-REQ-BODY    ::= SEQUENCE {
      kdc-options             [0] KDCOptions,
      cname                   [1] PrincipalName OPTIONAL
                                  -- Used only in AS-REQ --,
      realm                   [2] Realm
                                  -- Server's realm
                                  -- Also client's in AS-REQ --,
      sname                   [3] PrincipalName OPTIONAL,
      from                    [4] KerberosTime OPTIONAL,
      till                    [5] KerberosTime,
      rtime                   [6] KerberosTime OPTIONAL,
      nonce                   [7] UInt32,
      etype                   [8] SEQUENCE OF Int32 -- EncryptionType
                                  -- in preference order --,
      addresses               [9] HostAddresses OPTIONAL,
      enc-authorization-data  [10] EncryptedData OPTIONAL
                                  -- AuthorizationData --,
      additional-tickets      [11] SEQUENCE OF Ticket OPTIONAL
                                      -- NOTE: not empty
 }

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`additionalTicketLength`
`private java.util.List<Ticket>`	`additionalTickets` Additional tickets
`private int`	`additionalTicketSeqLength`
`private int[]`	`additionalTicketsLengths`
`private HostAddresses`	`addresses` Addresses valid for the requested ticket
`private int`	`addressesLength`
`private PrincipalName`	`cName` The Client Principal, if the request is an AS-REQ
`private int`	`cNameLength`
`private EncryptedData`	`encAuthorizationData` Encoded authorizationData, used by the TGS-REQ only
`private int`	`encAuthzDataLength`
`private java.util.Set<EncryptionType>`	`eType` Set of desired encryption types
`private int`	`eTypeLength`
`private int[]`	`eTypeLengths`
`private int`	`eTypeSeqLength`
`private KerberosTime`	`from` The start time for the requested ticket
`private int`	`fromLength`
`private KdcOptions`	`kdcOptions` The KDC options
`private int`	`kdcOptionsLength`
`private int`	`kdcReqBodyLength`
`private int`	`kdcReqBodySeqLength`
`private int`	`nonce` Random number to avoid MiM attacks
`private int`	`nonceLength`
`private java.lang.String`	`realm` The realm
`private byte[]`	`realmBytes`
`private int`	`realmLength`
`private KerberosTime`	`rtime` The renew-till date for the requested ticket
`private int`	`rtimeLength`
`private PrincipalName`	`sName` The Server Principal
`private int`	`sNameLength`
`private KerberosTime`	`till` The expiration date for the requested ticket
`private int`	`tillLength`

Constructor Summary

Constructors
Constructor and Description

KdcReqBody()
Creates a new instance of RequestBody.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalTicket(Ticket additionalTicket)` Add a new Ticket to the list of additional tickets
`void`	`addEType(EncryptionType eType)`
`int`	`computeLength()` Compute the KdcReqBody length
`java.nio.ByteBuffer`	`encode(java.nio.ByteBuffer buffer)` Encode the KDC-REQ-BODY component
`Ticket[]`	`getAdditionalTickets()` Returns the additional `Ticket`s.
`HostAddresses`	`getAddresses()` Returns the `HostAddresses`.
`PrincipalName`	`getCName()`
`EncryptedData`	`getEncAuthorizationData()` Returns the encrypted `AuthorizationData` as `EncryptedData`.
`java.util.Set<EncryptionType>`	`getEType()` Returns the requested `EncryptionType`s.
`KerberosTime`	`getFrom()` Returns the from `KerberosTime`.
`KdcOptions`	`getKdcOptions()` Returns the `KdcOptions`.
`int`	`getNonce()` Returns the nonce.
`java.lang.String`	`getRealm()`
`KerberosTime`	`getRTime()` Returns the RenewTime `KerberosTime`.
`PrincipalName`	`getSName()` Returns the server `PrincipalName`.
`KerberosTime`	`getTill()` Returns the till `KerberosTime`.
`private void`	`reset()` reset the fields used while computing length
`void`	`setAdditionalTickets(java.util.List<Ticket> additionalTickets)` Set the list of additional Ticket
`void`	`setAddresses(HostAddresses addresses)`
`void`	`setCName(PrincipalName cName)`
`void`	`setEncAuthorizationData(EncryptedData encAuthorizationData)`
`void`	`setEType(java.util.Set<EncryptionType> eType)`
`void`	`setFrom(KerberosTime from)`
`void`	`setKdcOptions(KdcOptions kdcOptions)`
`void`	`setNonce(int nonce)`
`void`	`setRealm(java.lang.String realm)`
`void`	`setRtime(KerberosTime rtime)`
`void`	`setSName(PrincipalName sName)`
`void`	`setTill(KerberosTime till)`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(java.lang.String tabs)` Pretty print the instance

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

Field Detail

kdcOptions
```
private KdcOptions kdcOptions
```
The KDC options

cName
```
private PrincipalName cName
```
The Client Principal, if the request is an AS-REQ

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

sName
```
private PrincipalName sName
```
The Server Principal

from
```
private KerberosTime from
```
The start time for the requested ticket

till
```
private KerberosTime till
```
The expiration date for the requested ticket

rtime
```
private KerberosTime rtime
```
The renew-till date for the requested ticket

nonce
```
private int nonce
```
Random number to avoid MiM attacks

eType

private java.util.Set<EncryptionType> eType

Set of desired encryption types

addresses
```
private HostAddresses addresses
```
Addresses valid for the requested ticket

encAuthorizationData
```
private EncryptedData encAuthorizationData
```
Encoded authorizationData, used by the TGS-REQ only

additionalTickets

private java.util.List<Ticket> additionalTickets

Additional tickets

kdcOptionsLength
```
private int kdcOptionsLength
```

cNameLength
```
private int cNameLength
```

realmLength
```
private int realmLength
```

realmBytes
```
private byte[] realmBytes
```

sNameLength
```
private int sNameLength
```

fromLength
```
private int fromLength
```

tillLength
```
private int tillLength
```

rtimeLength
```
private int rtimeLength
```

nonceLength
```
private int nonceLength
```

eTypeLength
```
private int eTypeLength
```

eTypeSeqLength
```
private int eTypeSeqLength
```

eTypeLengths
```
private int[] eTypeLengths
```

addressesLength
```
private int addressesLength
```

encAuthzDataLength
```
private int encAuthzDataLength
```

additionalTicketLength
```
private int additionalTicketLength
```

additionalTicketSeqLength
```
private int additionalTicketSeqLength
```

additionalTicketsLengths
```
private int[] additionalTicketsLengths
```

kdcReqBodySeqLength
```
private int kdcReqBodySeqLength
```

kdcReqBodyLength
```
private int kdcReqBodyLength
```

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

Method Detail

getAdditionalTickets
```
public Ticket[] getAdditionalTickets()
```
Returns the additional Tickets.

Returns:

The additional Tickets.

setAdditionalTickets
```
public void setAdditionalTickets(java.util.List<Ticket> additionalTickets)
```
Set the list of additional Ticket

Parameters:

additionalTickets - the additionalTickets to set

addAdditionalTicket
```
public void addAdditionalTicket(Ticket additionalTicket)
```
Add a new Ticket to the list of additional tickets

Parameters:

additionalTickets - the additionalTickets to set

getAddresses
```
public HostAddresses getAddresses()
```
Returns the HostAddresses.

Returns:

The HostAddresses.

setAddresses

public void setAddresses(HostAddresses addresses)

Parameters:: addresses - the addresses to set

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

the client PrincipalName

setCName

public void setCName(PrincipalName cName)

Parameters:: cName - the cName to set

getEncAuthorizationData
```
public EncryptedData getEncAuthorizationData()
```
Returns the encrypted AuthorizationData as EncryptedData.

Returns:

The encrypted AuthorizationData as EncryptedData.

setEncAuthorizationData
```
public void setEncAuthorizationData(EncryptedData encAuthorizationData)
```
Parameters:

encAuthorizationData - the encAuthorizationData to set

getEType
```
public java.util.Set<EncryptionType> getEType()
```
Returns the requested EncryptionTypes.

Returns:

The requested EncryptionTypes.

setEType

public void setEType(java.util.Set<EncryptionType> eType)

Parameters:: eType - the eType to set

addEType

public void addEType(EncryptionType eType)

Parameters:: eType - the eType to add

getFrom
```
public KerberosTime getFrom()
```
Returns the from KerberosTime.

Returns:

The from KerberosTime.

setFrom

public void setFrom(KerberosTime from)

Parameters:: from - the from to set

getKdcOptions
```
public KdcOptions getKdcOptions()
```
Returns the KdcOptions.

Returns:

The KdcOptions.

setKdcOptions
```
public void setKdcOptions(KdcOptions kdcOptions)
```
Parameters:

kdcOptions - the kdcOptions to set

getNonce
```
public int getNonce()
```
Returns the nonce.

Returns:

The nonce.

setNonce
```
public void setNonce(int nonce)
```
Parameters:

nonce - the nonce to set

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

the realm

setRealm

public void setRealm(java.lang.String realm)

Parameters:: realm - the realm to set

getRTime
```
public KerberosTime getRTime()
```
Returns the RenewTime KerberosTime.

Returns:

The RenewTime KerberosTime.

setRtime
```
public void setRtime(KerberosTime rtime)
```
Parameters:

rtime - the renewTime to set

getSName
```
public PrincipalName getSName()
```
Returns the server PrincipalName.

Returns:

The server PrincipalName.

setSName

public void setSName(PrincipalName sName)

Parameters:: sName - the sName to set

getTill
```
public KerberosTime getTill()
```
Returns the till KerberosTime.

Returns:

The till KerberosTime.

setTill

public void setTill(KerberosTime till)

Parameters:: till - the till to set

computeLength

public int computeLength()

Compute the KdcReqBody length

 KdcReqBody :

 0x30 L1 KdcReqBody sequence
  |
  +--> 0xA0 L2 kdc-options tag
  |     |
  |     +--> 0x03 L2-1 kdc-options (BitString)
  |
  +--> 0xA1 L3 cname tag
  |     |
  |     +--> 0x30 L3-1 cname (PrincipalName)
  |
  +--> 0xA2 L4 realm tag
  |     |
  |     +--> 0x1B L4-1 realm (Realm, KerberosString)
  |
  +--> 0xA3 L5 sname tag
  |     |
  |     +--> 0x30 L5-1 sname (PrincipalName)
  |
  +--> 0xA4 L6 from tag
  |     |
  |     +--> 0x18 L6-1 from (KerberosTime)
  |
  +--> 0xA5 L7 till tag
  |     |
  |     +--> 0x18 L7-1 till (KerberosTime)
  |
  +--> 0xA6 L8 rtime tag
  |     |
  |     +--> 0x18 L8-1 rtime (KerberosTime)
  |
  +--> 0xA7 L9 nonce tag
  |     |
  |     +--> 0x02 L9-1 nonce (Int)
  |
  +--> 0xA8 L10 etype tag
  |     |
  |     +--> 0x30 L10-1 SEQ
  |           |
  |           +--> 0x02 L10-1-1 etype
  |           |
  |           +--> 0x02 L10-1-2 etype
  |           |
  |           :
  |
  +--> 0xA9 L11 addresses tag
  |     |
  |     +--> 0x30 L11-1 addresses (HostAddresses)
  |
  +--> 0xAA L12 enc-authorization-data tag
  |     |
  |     +--> 0x30 L12-1 enc-authorization-data
  |
  +--> 0xAB L13 additional-tickets tag
        |
        +--> 0x30 L13-1 additional-tickets
              |
              +--> 0x61 L13-1-1 Ticket
              |
              +--> 0x61 L13-1-2 Ticket
              |
              :

Specified by:: computeLength in interface org.apache.directory.api.asn1.Asn1Object

encode
```
public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.api.asn1.EncoderException
```
Encode the KDC-REQ-BODY component

Specified by:

encode in interface org.apache.directory.api.asn1.Asn1Object

Parameters:

buffer - The buffer containing the encoded result

Returns:

The encoded component

Throws:

org.apache.directory.api.asn1.EncoderException - If the encoding failed

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

toString

public java.lang.String toString(java.lang.String tabs)

Pretty print the instance

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

toString in class java.lang.Object

See Also:

Object.toString()

Class KdcReqBody

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

kdcOptions

cName

realm

sName

from

till

rtime

nonce

eType

addresses

encAuthorizationData

additionalTickets

kdcOptionsLength

cNameLength

realmLength

realmBytes

sNameLength

fromLength

tillLength

rtimeLength

nonceLength

eTypeLength

eTypeSeqLength

eTypeLengths

addressesLength

encAuthzDataLength

additionalTicketLength

additionalTicketSeqLength

additionalTicketsLengths

kdcReqBodySeqLength

kdcReqBodyLength

Constructor Detail

KdcReqBody

Method Detail

getAdditionalTickets

setAdditionalTickets

addAdditionalTicket

getAddresses

setAddresses

getCName

setCName

getEncAuthorizationData

setEncAuthorizationData

getEType

setEType

addEType

getFrom

setFrom

getKdcOptions

setKdcOptions

getNonce

setNonce

getRealm

setRealm

getRTime

setRtime

getSName

setSName

getTill

setTill

computeLength

encode

reset

toString

toString