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

Class Keytab

java.lang.Object

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

public class Keytab
extends java.lang.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
 }

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<KeytabEntry>	entries
private byte[]	keytabVersion
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

Modifier and Type	Method and Description
protected static byte[]	getBytesFromFile(java.io.File file) Returns the contents of the File in a byte array.
java.util.List<KeytabEntry>	getEntries()
static Keytab	getInstance() Returns a new instance of a keytab with the version defaulted to 5.2.
byte[]	getKeytabVersion()
(package private) static Keytab	read(byte[] bytes) Read bytes into a keytab.
static Keytab	read(java.io.File file) Read a keytab file.
private static Keytab	readKeytab(java.nio.ByteBuffer buffer) Read the contents of the buffer into a keytab.
void	setEntries(java.util.List<KeytabEntry> entries)
void	setKeytabVersion(byte[] keytabVersion)
(package private) java.nio.ByteBuffer	write() Write the keytab to a ByteBuffer.
void	write(java.io.File file) Write the keytab to a File.
protected void	writeFile(java.nio.ByteBuffer buffer, java.io.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

keytabVersion

private byte[] keytabVersion

entries

private java.util.List<KeytabEntry> entries

Constructor Detail

Keytab

public Keytab()

Method Detail

read

public static Keytab read(java.io.File file)
                   throws java.io.IOException

Read a keytab file.

Parameters:

file -

Returns:

The keytab.

Throws:

java.io.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(java.io.File file)
           throws java.io.IOException

Write the keytab to a File.

Parameters:

file -

Throws:

java.io.IOException

setEntries

public void setEntries(java.util.List<KeytabEntry> entries)

Parameters:

entries - The entries to set.

setKeytabVersion

public void setKeytabVersion(byte[] keytabVersion)

Parameters:

keytabVersion - The keytabVersion to set.

getEntries

public java.util.List<KeytabEntry> getEntries()

Returns:

The entries.

getKeytabVersion

public byte[] getKeytabVersion()

Returns:

The keytabVersion.

read

static Keytab read(byte[] bytes)

Read bytes into a keytab.

Parameters:

bytes -

Returns:

The keytab.

write

java.nio.ByteBuffer write()

Write the keytab to a ByteBuffer.

Returns:

The buffer.

readKeytab

private static Keytab readKeytab(java.nio.ByteBuffer buffer)

Read the contents of the buffer into a keytab.

Parameters:

buffer -

Returns:

The keytab.

getBytesFromFile

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

Returns the contents of the File in a byte array.

Parameters:

file -

Returns:

The byte array of the file contents.

Throws:

java.io.IOException

writeFile

protected void writeFile(java.nio.ByteBuffer buffer,
                         java.io.File file)
                  throws java.io.IOException

Write the contents of the ByteBuffer to a File.

Parameters:

buffer -

file -

Throws:

java.io.IOException