org.linguafranca.pwdb.kdbx.Util Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of example Show documentation
Examples of how to use PWDB
There is a newer version: 2.2.3
package org.linguafranca.pwdb.kdbx;

import com.google.common.io.CharStreams;
import org.linguafranca.pwdb.Credentials;
import org.linguafranca.pwdb.Database;
import org.linguafranca.pwdb.StreamFormat;
import org.linguafranca.pwdb.kdbx.dom.DomDatabaseWrapper;
import org.linguafranca.pwdb.kdbx.jaxb.JaxbDatabase;
import org.linguafranca.pwdb.kdbx.simple.SimpleDatabase;

import java.io.*;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

public class Util {

    List implementations = new ArrayList<>(Arrays.asList(DomDatabaseWrapper.class, SimpleDatabase.class, JaxbDatabase.class));

    @FunctionalInterface
    public interface DatabaseLoader {
        Database load(Credentials c, InputStream i) throws IOException;
    }

    List dbLoader = Arrays.asList(DomDatabaseWrapper::load, SimpleDatabase::load, JaxbDatabase::load);

    public static InputStream getDecryptedInputStream (String resourceName, Credentials credentials) throws IOException {
        return getDecryptedInputStream(resourceName, credentials, new KdbxHeader());
    }

    public static InputStream getDecryptedInputStream (String resourceName, Credentials credentials, KdbxHeader header) throws IOException {
        InputStream is = Util.class.getClassLoader().getResourceAsStream(resourceName);
        return KdbxSerializer.createUnencryptedInputStream(credentials, header, is);
    }

    public static String streamToString(InputStream inputStream) throws IOException {
        return CharStreams.toString(new InputStreamReader(inputStream, StandardCharsets.UTF_8));
    }

    /**
     * Example shows how to list XML from a database (but not decrypted passwords)
     */
    public static void listDatabase(String resourceName, Credentials creds, OutputStream outputStream) throws IOException {
        SimpleDatabase database = SimpleDatabase.load(creds, Util.class.getClassLoader().getResourceAsStream(resourceName));
        database.save(new StreamFormat.None(), new KdbxCreds.None(), outputStream);
    }

    /**
     * Example shows how to list XML from a database using specified loader
     */
    public static void listDatabase(DatabaseLoader loader, String resourceName, Credentials creds, OutputStream outputStream) throws IOException {
        Database database = loader.load(creds, Util.class.getClassLoader().getResourceAsStream(resourceName));
        database.save(new StreamFormat.None(), new KdbxCreds.None(), outputStream);
    }


    /**
     * Example shows how to list the XML of a database in a raw form
     * @param resourceName the name of a resource to find on the classpath
     * @param credentials the credentials for the resource
     * @param printWriter a PrintWriter to list the contents
     */
    public static void listXml(String resourceName, Credentials credentials, PrintWriter printWriter) throws IOException {
        printWriter.println(streamToString(getDecryptedInputStream(resourceName, credentials)));
        printWriter.println();
        printWriter.flush();
    }

    /**
     * Example shows how to list KdbxParameters of a KdbxHeader. You don't need a password as the
     * header is not encrypted. From V4 InnerStream encryption is defined in the Inner Header
     * which is stored encrypted and is not read until the database is read.
     * @param resourceName the name of a resource to find on the classpath
     * @param printWriter a PrintWriter to list the contents
     */
    public static void listKdbxHeaderProperties(String resourceName, PrintWriter printWriter) throws IOException {
        printWriter.format(resourceName + "\n");
        KdbxHeader kdbxHeader = new KdbxHeader();
        InputStream is = Util.class.getClassLoader().getResourceAsStream(resourceName);
        KdbxSerializer.readOuterHeader(is, kdbxHeader);
        printWriter.format("Version: %d\n", kdbxHeader.getVersion());
        printWriter.format("Cipher Algorithm: %s\n", kdbxHeader.getCipherAlgorithm().getName());
        printWriter.format("Key Derivation Function: %s\n", kdbxHeader.getKeyDerivationFunction().getName());
        String pseName = kdbxHeader.getVersion() == 3 ? kdbxHeader.getProtectedStreamAlgorithm().name() :
                        "Inner Stream Algorithm not in header in V4";
        printWriter.format("Inner Stream Algorithm: %s\n", pseName);
        printWriter.println();
        printWriter.flush();
    }
}