org.linguafranca.pwdb

Interface SerializableDatabase

public interface SerializableDatabase

This interface allows for serialization and deserialization of databases, which is theoretically decoupled from the actual format they use for serialization.

Databases instantiate themselves from a stream and serialize to a stream, and need to be able to encrypt and decrypt data (e.g. Protected fields in KDBX format).

KDBX V3 databases contain a header hash (i.e. a hash of the contents of some portion of the StreamFormat they have been loaded from or saved to). Which means that databases must support the setting of this value after the header has been written on save, and reading the value after load to allow for integrity checking.

KDBX V4 databases have their attachments in the header so databases need to support setting and getting of attachments for serialization

Method Summary

Modifier and Type	Method and Description
void	addBinary(int index, byte[] payload)
byte[]	getBinary(int index)
int	getBinaryCount()
StreamEncryptor	getEncryption()
byte[]	getHeaderHash()
SerializableDatabase	load(InputStream inputStream)
void	save(OutputStream outputStream)
void	setEncryption(StreamEncryptor encryption)
void	setHeaderHash(byte[] hash)

Method Detail

load

SerializableDatabase load(InputStream inputStream)
                   throws IOException

Throws:

IOException

save

void save(OutputStream outputStream)
   throws IOException

Throws:

IOException

getEncryption

StreamEncryptor getEncryption()

setEncryption

void setEncryption(StreamEncryptor encryption)

getHeaderHash

byte[] getHeaderHash()

setHeaderHash

void setHeaderHash(byte[] hash)

addBinary

void addBinary(int index,
               byte[] payload)

getBinary

byte[] getBinary(int index)

getBinaryCount

int getBinaryCount()