org.linguafranca.pwdb.kdbx.stream_3_1

Class KdbxHeader

java.lang.Object

org.linguafranca.pwdb.kdbx.stream_3_1.KdbxHeader

public class KdbxHeader
extends Object

This class represents the header portion of a KeePass KDBX file or stream. The header is received in plain text and describes the encryption and compression of the remainder of the file.

It is a factory for encryption and decryption streams and contains a hash of its own serialization.

While KDBX streams are Little-Endian, data is passed to and from this class in standard Java byte order.

Author:

jo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KdbxHeader.CompressionFlags The ordinal 0 represents uncompressed and 1 GZip compressed
static class	KdbxHeader.ProtectedStreamAlgorithm The ordinals represent various types of encryption that may be applied to fields within the unencrypted data

Field Summary

Fields

Modifier and Type	Field and Description
static UUID	AES_CIPHER This UUID denotes that AES Cipher is in use.

Constructor Summary

Constructors

Constructor and Description
KdbxHeader() Construct a default KDBX header

Method Summary

Modifier and Type	Method and Description
InputStream	createDecryptedStream(byte[] digest, InputStream inputStream) Create a decrypted input stream using supplied digest and this header apply decryption to the passed encrypted input stream
OutputStream	createEncryptedStream(byte[] digest, OutputStream outputStream) Create an unencrypted outputstream using the supplied digest and this header and use the supplied output stream to write encrypted data.
UUID	getCipherUuid()
KdbxHeader.CompressionFlags	getCompressionFlags()
byte[]	getEncryptionIv()
byte[]	getHeaderHash()
byte[]	getMasterSeed()
KdbxHeader.ProtectedStreamAlgorithm	getProtectedStreamAlgorithm()
byte[]	getProtectedStreamKey()
byte[]	getStreamStartBytes()
long	getTransformRounds()
byte[]	getTransformSeed()
void	setCipherUuid(byte[] uuid)
void	setCompressionFlags(int flags)
void	setEncryptionIv(byte[] encryptionIv)
void	setHeaderHash(byte[] headerHash)
void	setInnerRandomStreamId(int innerRandomStreamId)
void	setMasterSeed(byte[] masterSeed)
void	setProtectedStreamKey(byte[] protectedStreamKey)
void	setStreamStartBytes(byte[] streamStartBytes)
void	setTransformRounds(long transformRounds)
void	setTransformSeed(byte[] transformSeed)

Methods inherited from class java.lang.Object

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

Field Detail

AES_CIPHER

public static final UUID AES_CIPHER

This UUID denotes that AES Cipher is in use. No other values are known.

Constructor Detail

KdbxHeader

public KdbxHeader()

Construct a default KDBX header

Method Detail

createDecryptedStream

public InputStream createDecryptedStream(byte[] digest,
                                         InputStream inputStream)
                                  throws IOException

Create a decrypted input stream using supplied digest and this header apply decryption to the passed encrypted input stream

Parameters:

digest - the key digest

inputStream - the encrypted input stream

Returns:

a decrypted stream

Throws:

IOException - if something bad happens

createEncryptedStream

public OutputStream createEncryptedStream(byte[] digest,
                                          OutputStream outputStream)
                                   throws IOException

Create an unencrypted outputstream using the supplied digest and this header and use the supplied output stream to write encrypted data.

Parameters:

digest - the key digest

outputStream - the output stream which is the destination for encrypted data

Returns:

an output stream to write unencrypted data to

Throws:

IOException - if something bad happens

getCipherUuid

public UUID getCipherUuid()

getCompressionFlags

public KdbxHeader.CompressionFlags getCompressionFlags()

getMasterSeed

public byte[] getMasterSeed()

getTransformSeed

public byte[] getTransformSeed()

getTransformRounds

public long getTransformRounds()

getEncryptionIv

public byte[] getEncryptionIv()

getProtectedStreamKey

public byte[] getProtectedStreamKey()

getStreamStartBytes

public byte[] getStreamStartBytes()

getProtectedStreamAlgorithm

public KdbxHeader.ProtectedStreamAlgorithm getProtectedStreamAlgorithm()

getHeaderHash

public byte[] getHeaderHash()

setCipherUuid

public void setCipherUuid(byte[] uuid)

setCompressionFlags

public void setCompressionFlags(int flags)

setMasterSeed

public void setMasterSeed(byte[] masterSeed)

setTransformSeed

public void setTransformSeed(byte[] transformSeed)

setTransformRounds

public void setTransformRounds(long transformRounds)

setEncryptionIv

public void setEncryptionIv(byte[] encryptionIv)

setProtectedStreamKey

public void setProtectedStreamKey(byte[] protectedStreamKey)

setStreamStartBytes

public void setStreamStartBytes(byte[] streamStartBytes)

setInnerRandomStreamId

public void setInnerRandomStreamId(int innerRandomStreamId)

setHeaderHash

public void setHeaderHash(byte[] headerHash)