org.apache.directory.server.kerberos.shared.keytab

Class Keytab

java.lang.Object

org.apache.directory.server.kerberos.shared.keytab.Keytab

public class Keytab
extends Object

Keytab file. The format is the following :

 { 
   version : 2 bytes (0x05 0x02)
   keytabEntry*
 }

 keytab_entry 
 {
     size : int
     numComponents :  short
     realm : countedOctetString
     components[numComponents] : countedOctetString
     nameType : int
     timestamp : int
     vno8 : byte
     key : keyBlock
     vno : int // only present if >= 4 bytes left in entry
 };

 keyblock 
 {
     type : int
     data : countedOctetString
 }

 countedOctetString 
 {
     length : short
     data[length] : bytes
 }

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static short	VERSION_0X501
static byte[]	VERSION_0X501_BYTES Byte array constant for keytab file format 5.1.
static short	VERSION_0X502
static byte[]	VERSION_0X502_BYTES Byte array constant for keytab file format 5.2.

Constructor Summary

Constructors

Constructor and Description
Keytab()

Method Summary

Methods

Modifier and Type	Method and Description
protected static byte[]	getBytesFromFile(File file) Returns the contents of the File in a byte array.
List<KeytabEntry>	getEntries()
static Keytab	getInstance() Returns a new instance of a keytab with the version defaulted to 5.2.
byte[]	getKeytabVersion()
static Keytab	read(File file) Read a keytab file.
void	setEntries(List<KeytabEntry> entries)
void	setKeytabVersion(byte[] keytabVersion)
void	write(File file) Write the keytab to a File.
protected void	writeFile(ByteBuffer buffer, File file) Write the contents of the ByteBuffer to a File.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_0X501_BYTES

public static final byte[] VERSION_0X501_BYTES

Byte array constant for keytab file format 5.1.

VERSION_0X501

public static final short VERSION_0X501

See Also:

Constant Field Values

VERSION_0X502_BYTES

public static final byte[] VERSION_0X502_BYTES

Byte array constant for keytab file format 5.2.

VERSION_0X502

public static final short VERSION_0X502

See Also:

Constant Field Values

Constructor Detail

Keytab

public Keytab()

Method Detail

read

public static Keytab read(File file)
                   throws IOException

Read a keytab file.

Parameters:

file -

Returns:

The keytab.

Throws:

IOException

getInstance

public static Keytab getInstance()

Returns a new instance of a keytab with the version defaulted to 5.2.

Returns:

The keytab.

write

public void write(File file)
           throws IOException

Write the keytab to a File.

Parameters:

file -

Throws:

IOException

setEntries

public void setEntries(List<KeytabEntry> entries)

Parameters:

entries - The entries to set.

setKeytabVersion

public void setKeytabVersion(byte[] keytabVersion)

Parameters:

keytabVersion - The keytabVersion to set.

getEntries

public List<KeytabEntry> getEntries()

Returns:

The entries.

getKeytabVersion

public byte[] getKeytabVersion()

Returns:

The keytabVersion.

getBytesFromFile

protected static byte[] getBytesFromFile(File file)
                                  throws IOException

Returns the contents of the File in a byte array.

Parameters:

file -

Returns:

The byte array of the file contents.

Throws:

IOException

writeFile

protected void writeFile(ByteBuffer buffer,
             File file)
                  throws IOException

Write the contents of the ByteBuffer to a File.

Parameters:

buffer -

file -

Throws:

IOException