de.slackspace.openkeepass

Class KeePassDatabase

java.lang.Object

de.slackspace.openkeepass.KeePassDatabase

public class KeePassDatabase
extends Object

A KeePassDatabase is the central API class to read and write a KeePass database file.

Currently the following KeePass files are supported:

• KeePass Database V2 with password
• KeePass Database V2 with keyfile
• KeePass Database V2 with combined password and keyfile

A typical read use-case should use the following idiom:

 // open database
 KeePassFile database = KeePassDatabase.getInstance("keePassDatabasePath").openDatabase("secret");

 // get password entries
 List<Entry> entries = database.getEntries();
 ...
 

If the database could not be opened an exception of type KeePassDatabaseUnreadable will be thrown.

A typical write use-case should use the following idiom:

 // build an entry
 Entry entryOne = new EntryBuilder("First entry").username("Carl").password("secret").build();

 // build more entries or groups as you like
 ...

 // build KeePass model
 KeePassFile keePassFile = new KeePassFileBuilder("testDB").addTopEntries(entryOne).build();

 // write KeePass database file
 KeePassDatabase.write(keePassFile, "secret", new FileOutputStream("keePassDatabasePath"));
 

See Also:

KeePassFile

Method Summary

Modifier and Type	Method and Description
KeePassHeader	getHeader() Gets the KeePassDatabase header.
static KeePassDatabase	getInstance(File keePassDatabaseFile) Retrieves a KeePassDatabase instance.
static KeePassDatabase	getInstance(InputStream keePassDatabaseStream) Retrieves a KeePassDatabase instance.
static KeePassDatabase	getInstance(String keePassDatabaseFile) Retrieves a KeePassDatabase instance.
KeePassFile	openDatabase(File keyFile) Opens a KeePass database with the given keyfile and returns the KeePassFile for further processing.
KeePassFile	openDatabase(InputStream keyFileStream) Opens a KeePass database with the given keyfile stream and returns the KeePassFile for further processing.
KeePassFile	openDatabase(String password) Opens a KeePass database with the given password and returns the KeePassFile for further processing.
KeePassFile	openDatabase(String password, File keyFile) Opens a KeePass database with the given password and keyfile and returns the KeePassFile for further processing.
KeePassFile	openDatabase(String password, InputStream keyFileStream) Opens a KeePass database with the given password and keyfile stream and returns the KeePassFile for further processing.
static void	write(KeePassFile keePassFile, String password, OutputStream stream) Encrypts a KeePassFile with the given password and writes it to the given stream.
static void	write(KeePassFile keePassFile, String password, String keePassDatabaseFile) Encrypts a KeePassFile with the given password and writes it to the given file location.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static KeePassDatabase getInstance(String keePassDatabaseFile)

Retrieves a KeePassDatabase instance. The instance returned is based on the given database filename and tries to parse the database header of it.

Parameters:

keePassDatabaseFile - a KeePass database filename, must not be NULL

Returns:

a KeePassDatabase

getInstance

public static KeePassDatabase getInstance(File keePassDatabaseFile)

Retrieves a KeePassDatabase instance. The instance returned is based on the given database file and tries to parse the database header of it.

Parameters:

keePassDatabaseFile - a KeePass database file, must not be NULL

Returns:

a KeePassDatabase

getInstance

public static KeePassDatabase getInstance(InputStream keePassDatabaseStream)

Retrieves a KeePassDatabase instance. The instance returned is based on the given input stream and tries to parse the database header of it.

Parameters:

keePassDatabaseStream - an input stream of a KeePass database, must not be NULL

Returns:

a KeePassDatabase

openDatabase

public KeePassFile openDatabase(String password)

Opens a KeePass database with the given password and returns the KeePassFile for further processing.

If the database cannot be decrypted with the provided password an exception will be thrown.

Parameters:

password - the password to open the database

Returns:

a KeePassFile

See Also:

KeePassFile

openDatabase

public KeePassFile openDatabase(String password,
                                File keyFile)

Opens a KeePass database with the given password and keyfile and returns the KeePassFile for further processing.

If the database cannot be decrypted with the provided password and keyfile an exception will be thrown.

Parameters:

password - the password to open the database

keyFile - the password to open the database

Returns:

a KeePassFile

See Also:

KeePassFile

openDatabase

public KeePassFile openDatabase(String password,
                                InputStream keyFileStream)

Opens a KeePass database with the given password and keyfile stream and returns the KeePassFile for further processing.

If the database cannot be decrypted with the provided password and keyfile stream an exception will be thrown.

Parameters:

password - the password to open the database

keyFileStream - the keyfile to open the database as stream

Returns:

a KeePassFile

See Also:

KeePassFile

openDatabase

public KeePassFile openDatabase(File keyFile)

Opens a KeePass database with the given keyfile and returns the KeePassFile for further processing.

If the database cannot be decrypted with the provided password an exception will be thrown.

Parameters:

keyFile - the password to open the database

Returns:

a KeePassFile the keyfile to open the database

See Also:

KeePassFile

openDatabase

public KeePassFile openDatabase(InputStream keyFileStream)

Opens a KeePass database with the given keyfile stream and returns the KeePassFile for further processing.

If the database cannot be decrypted with the provided keyfile an exception will be thrown.

Parameters:

keyFileStream - the keyfile to open the database as stream

Returns:

a KeePassFile

See Also:

KeePassFile

getHeader

public KeePassHeader getHeader()

Gets the KeePassDatabase header.

Returns:

the database header

write

public static void write(KeePassFile keePassFile,
                         String password,
                         String keePassDatabaseFile)

Encrypts a KeePassFile with the given password and writes it to the given file location.

If the KeePassFile cannot be encrypted an exception will be thrown.

Parameters:

keePassFile - the keePass model which should be written

password - the password to encrypt the database

keePassDatabaseFile - the target location where the database file will be written

See Also:

KeePassFile

write

public static void write(KeePassFile keePassFile,
                         String password,
                         OutputStream stream)

Encrypts a KeePassFile with the given password and writes it to the given stream.

If the KeePassFile cannot be encrypted an exception will be thrown.

Parameters:

keePassFile - the keePass model which should be written

password - the password to encrypt the database

stream - the target stream where the output will be written

See Also:

KeePassFile