org.apache.directory.shared.kerberos.components

Class EncryptionKey

java.lang.Object

org.apache.directory.shared.kerberos.components.EncryptionKey

All Implemented Interfaces:

org.apache.directory.api.asn1.Asn1Object

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

A Kerberos symmetric encryption key, which includes metadata support for the associated key type and key version number. The ASN.1 description for this structure is :

 EncryptionKey   ::= SEQUENCE {
       keytype         [0] Int32 -- actually encryption type --,
       keyvalue        [1] OCTET STRING
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
private int	encryptionKeyLength
private static boolean	IS_DEBUG Speedup for logs
private EncryptionType	keyType The encryption type
private int	keyTypeLength
private byte[]	keyValue The encrypted value
private int	keyValueLength
private int	keyVersion The key version
private static org.slf4j.Logger	log The logger

Constructor Summary

Constructors

Constructor and Description
EncryptionKey() Creates a new instance of EncryptionKey.
EncryptionKey(EncryptionType keyType, byte[] keyValue) Creates a new instance of EncryptionKey.
EncryptionKey(EncryptionType keyType, byte[] keyValue, int keyVersion) Creates a new instance of EncryptionKey.

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the EncryptionKey length
void	destroy() Destroys this key by overwriting the symmetric key material with zeros.
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encode the EncryptionKey message to a PDU.
boolean	equals(java.lang.Object o)
EncryptionType	getKeyType() Returns the key type.
byte[]	getKeyValue() Returns the key value.
int	getKeyVersion() Returns the key version.
int	hashCode()
void	setKeyType(EncryptionType keyType) Set the encryption type
void	setKeyValue(byte[] keyValue) Set the key value
void	setKeyVersion(int keyVersion) Set the key value
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

keyType

private EncryptionType keyType

The encryption type

keyValue

private byte[] keyValue

The encrypted value

keyVersion

private int keyVersion

The key version

keyTypeLength

private int keyTypeLength

keyValueLength

private int keyValueLength

encryptionKeyLength

private int encryptionKeyLength

Constructor Detail

EncryptionKey

public EncryptionKey()

Creates a new instance of EncryptionKey.

EncryptionKey

public EncryptionKey(EncryptionType keyType,
                     byte[] keyValue)

Creates a new instance of EncryptionKey.

Parameters:

keyType - The encryptionType

keyValue - The value

EncryptionKey

public EncryptionKey(EncryptionType keyType,
                     byte[] keyValue,
                     int keyVersion)

Creates a new instance of EncryptionKey.

Parameters:

keyType - The encryptionType

keyValue - The value

keyVersion - ???

Method Detail

destroy

public void destroy()

Destroys this key by overwriting the symmetric key material with zeros.

getKeyType

public EncryptionType getKeyType()

Returns the key type.

Returns:

The key type.

setKeyType

public void setKeyType(EncryptionType keyType)

Set the encryption type

Parameters:

keyType - The encryption type

getKeyValue

public byte[] getKeyValue()

Returns the key value.

Returns:

The key value.

getKeyVersion

public int getKeyVersion()

Returns the key version.

Returns:

The key version.

setKeyVersion

public void setKeyVersion(int keyVersion)

Set the key value

Parameters:

keyVersion - The key version

setKeyValue

public void setKeyValue(byte[] keyValue)

Set the key value

Parameters:

keyValue - The key value

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)

computeLength

public int computeLength()

Compute the EncryptionKey length

 EncryptionKey :
 
 0x30 L1 EncryptionKey
  |
  +--> 0xA0 L2 keyType tag
  |     |
  |     +--> 0x02 L2-1 keyType (int)
  |
  +--> 0xA1 L3 keyValue tag
        |
        +--> 0x04 L3-1 keyValue (OCTET STRING)
        
  where L1 = L2 + lenght(0xA0) + length(L2) +
             L3 + lenght(0xA1) + length(L3) 
  and
  L2 = L2-1 + length(0x02) + length( L2-1) 
  L3 = L3-1 + length(0x04) + length( L3-1)
  

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 EncryptionKey message to a PDU.

 EncryptionKey :
 
 0x30 LL
   0xA0 LL 
     0x02 0x01 keyType
   0xA1 LL 
     0x04 LL keyValue
 

Specified by:

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

Parameters:

buffer - The buffer where to put the PDU. It should have been allocated before, with the right size.

Returns:

The constructed PDU.

Throws:

org.apache.directory.api.asn1.EncoderException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()