Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.crypto

Class KeePassXC

java.lang.Object

page.codeberg.friedolyn.crypto.KeePassXC

public class KeePassXC
extends Object

An easy-to-use wrapper around KeepassProxyAccess to access the KeePassXC password manager. This class provides methods to

• connect to KeePassXC,
• ask the user to grant access permission to their password database
• and get the Friedolin login credentials from the database.

KeepassProxyAccess stores the credentials needed to access the KeePassXC database for us, so we don't have to worry about that.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	KeePassXC.AssociateAndLoginTask	A Task that does connect(), associate(), and getFriedolinLogins() all in one go.
static final record	KeePassXC.KeePassEntry

Field Summary

Fields

Modifier and Type	Field	Description
private final org.purejava.KeepassProxyAccess	keepass	The KeepassProxyAccess object that we use to access the KeePassXC database.

Constructor Summary

Constructors

Constructor	Description
KeePassXC()

Method Summary

Modifier and Type	Method	Description
boolean	associate()	Asks the user to allow us to access their password database.
boolean	connect()
boolean	connectionIsAvailable()
boolean	databaseIsLocked()
@NonNull Task<KeePassXC.KeePassEntry>	getAssociateAndLoginTask()
KeePassXC.KeePassEntry	getFriedolinLogins()
@NonNull KeePassXC.KeePassEntry	getLogins(@NonNull URL url)	Gets the user's login credentials for the given URL from the user's KeePassXC database.
boolean	storePassword(@NonNull URL url, @NonNull String user, char[] password)	Saves the given password for the given URL in the KeePassXC database.

Methods inherited from class java.lang.Object

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

Field Details

keepass

private final org.purejava.KeepassProxyAccess keepass

The KeepassProxyAccess object that we use to access the KeePassXC database.

Constructor Details

KeePassXC

public KeePassXC()

Method Details

connect

public boolean connect()

Returns:

KeepassProxyAccess.connect()

connectionIsAvailable

public boolean connectionIsAvailable()

Returns:

KeepassProxyAccess.connectionAvailable()

databaseIsLocked

public boolean databaseIsLocked()

Returns:

KeepassProxyAccess.isDatabaseLocked()

associate

public boolean associate()

Asks the user to allow us to access their password database. Requires a prior call to connect().

Returns:

True if we successfully connected to KeePassXC and were granted permission to access the database, false otherwise.

API Note:

This method will block the current thread until the user has granted access or a timeout of 60 seconds has passed.

getLogins

@NonNull
public @NonNull KeePassXC.KeePassEntry getLogins(@NonNull
 @NonNull URL url)
                                          throws org.openqa.selenium.NotFoundException,
IllegalStateException

Gets the user's login credentials for the given URL from the user's KeePassXC database.

Parameters:

url - The URL for which to get the user's login credentials.

Returns:

The user's login credentials for the given URL as stored in the KeePassXC database.

Throws:

org.openqa.selenium.NotFoundException - If there are no login credentials for the given URL in the KeePassXC database.

IllegalStateException - If the KeePassXC database is locked or otherwise not accessible to us.

getFriedolinLogins

@NonNull
public KeePassXC.KeePassEntry getFriedolinLogins()
                                          throws org.openqa.selenium.NotFoundException,
IllegalStateException

Returns:

The first KeePassXC.KeePassEntry in the user's KeePassXC database whose URL matches Friedolyn.BASE_URL.

Throws:

org.openqa.selenium.NotFoundException - If there are no Friedolin login credentials in the KeePassXC database.

IllegalStateException - If the KeePassXC database is locked or otherwise not accessible to us.

getAssociateAndLoginTask

@NonNull
public @NonNull Task<KeePassXC.KeePassEntry> getAssociateAndLoginTask()

Returns:

A Task that does connect(), associate(), and getFriedolinLogins() all in one go. The task's result is an Optional containing the KeePassXC.KeePassEntry if everything went well or Optional.empty() if an error occurred.

storePassword

public boolean storePassword(@NonNull
 @NonNull URL url,
 @NonNull
 @NonNull String user,
 char[] password)
                      throws IllegalStateException

Saves the given password for the given URL in the KeePassXC database.

Parameters:

url - The URL which the login credentials are valid for.

user - The user name used to log in to the given URL.

password - The password to authenticate with the service at the given URL.

Returns:

true if the password was stored successfully, false otherwise.

Throws:

IllegalStateException - If the KeePassXC database is locked or otherwise inaccessible.