openkeepass

openkeepass is a java library for reading and writing KeePass databases. It is the only java library that supports KeePass 2.x database files.

Only KeePass files created with version 2.x are supported. KeePass files created with version 1.x are NOT supported.

Features included so far:

• Reading and writing support for KeePass 2.x
• Password or Keyfile credentials: openkeepass can open password protected databases as well as keyfile protected databases.
• Easy to learn API: openkeepass has a simple API with convenient methods that makes it easy to read data from a KeePass database.
• Very lean: openkeepass tries to keep the necessary dependencies to an absolute minimum.
• Backward compatible until Java 6

Installation

The easiest way is to add openkeepass as a maven dependency.

<dependency>
<groupId>de.slackspace</groupId>
<artifactId>openkeepass</artifactId>
<version>0.5.1</version>
</dependency>

Prerequisites

Before using this library make sure that you have the Java Cryptography Extension (JCE) installed on your system.

You can download JCE here:

• Download JCE for JDK 7
• Download JCE for JDK 8

Examples for reading

The basic usage is very simple. This example will show you how to retrieve all entries and the top groups of the KeePass database.

// Open DatabaseKeePassFiledatabase = KeePassDatabase.getInstance("Database.kdbx").openDatabase("MasterPassword");
// Retrieve all entriesList<Entry> entries = database.getEntries();
for (Entryentry : entries) {
System.out.println("Title: " + entry.getTitle() + " Password: " + entry.getPassword());
}
// Retrieve all top groupsList<Group> groups = database.getTopGroups();
for (Groupgroup : groups) {
System.out.println(group.getName());
}

You can also search for specific entries in the database:

// Search for single entryEntrysampleEntry = database.getEntryByTitle("Sample Entry");
System.out.println("Title: " + sampleEntry.getTitle() + " Password: " + sampleEntry.getPassword());
// Search for all entries that contain 'Sample' in titleList<Entry> entriesByTitle = database.getEntriesByTitle("Sample", false);
for (Entryentry : entriesByTitle) {
System.out.println("Title: " + entry.getTitle() + " Password: " + entry.getPassword());
}

Open a database with a key file:

// Open database with keyfileKeePassFiledatabase = KeePassDatabase.getInstance("DatabaseProtectedByKeyfile.kdbx").openDatabase(newFile("Keyfile.key"));
// Print all entries List<Entry> entries = database.getEntries();
for (Entryentry : entries) {
System.out.println(entry.getTitle() + ":" + entry.getPassword());
}

Retrieve custom string fields (Advanced tab) from a database:

// Retrieve all properties including custom string fields of an entrySet<Property> properties = database.getEntryByTitle("1st Entry").getProperties();
for (Propertyproperty : properties) {
System.out.println(property.getKey() + ":" + property.getValue());
}

For more usages have a look into the unit test classes.

Examples for writing

If you want to start writing a new KeePass file from scratch you first have to build up your database model. This will be done using the provided builders. After the model has been constructed you can use the KeePassDatabase class to write the KeePass database to a stream.

// Build KeePass modelGrouproot = newGroupBuilder()
.addEntry(newEntryBuilder("First entry").username("Peter").password("Peters secret").build())
.addGroup(newGroupBuilder("Banking")
.addEntry(newEntryBuilder("Second entry").username("Paul").password("secret").build())
.build())
.build();
KeePassFilekeePassFile = newKeePassFileBuilder("writingDB")
.addTopGroups(root)
.build();
// Write KeePass file to diskKeePassDatabase.write(keePassFile, "MasterPassword", newFileOutputStream("Database.kdbx"));

For more usages have a look into the unit test classes.