org.cryptomator.integrations.keychain.KeychainAccessProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integrations-api Show documentation
Defines optional service interfaces that may be used by Cryptomator
There is a newer version: 2.0.0-alpha1
package org.cryptomator.integrations.keychain;

/**
 * This is the interface used by Cryptomator to store passwords securely in external keychains, such as system keychains or password managers.
 */
public interface KeychainAccessProvider {

	/**
	 * A name to display in UI elements. If required, this should be localized.
	 *
	 * @return user-friendly name (must not be null or empty)
	 */
	String displayName();

	/**
	 * Associates a passphrase with a given key.
	 *
	 * @param key        Key used to retrieve the passphrase via {@link #loadPassphrase(String)}.
	 * @param passphrase The secret to store in this keychain.
	 * @throws KeychainAccessException If storing the password failed
	 * @deprecated Please use {@link #storePassphrase(String, String, CharSequence)} instead
	 */
	@Deprecated
	void storePassphrase(String key, CharSequence passphrase) throws KeychainAccessException;

	/**
	 * Associates a passphrase with a given key and a name for that key.
	 *
	 * @param key         Key used to retrieve the passphrase via {@link #loadPassphrase(String)}.
	 * @param displayName The according name to the key. That's the name of the vault displayed in the UI.
	 *                    It's passed to the keychain as an additional information about the vault besides the key.
	 *                    The parameter does not need to be unique or be checked by the keychain.
	 * @param passphrase  The secret to store in this keychain.
	 * @throws KeychainAccessException If storing the password failed
	 */
	default void storePassphrase(String key, String displayName, CharSequence passphrase) throws KeychainAccessException {
		storePassphrase(key, passphrase);
	}

	/**
	 * @param key Unique key previously used while {@link #storePassphrase(String, String, CharSequence)}  storing a passphrase}.
	 * @return The stored passphrase for the given key or null if no value for the given key could be found.
	 * @throws KeychainAccessException If loading the password failed
	 */
	char[] loadPassphrase(String key) throws KeychainAccessException;

	/**
	 * Deletes a passphrase with a given key.
	 *
	 * @param key Unique key previously used while {@link #storePassphrase(String, String, CharSequence)}  storing a passphrase}.
	 * @throws KeychainAccessException If deleting the password failed
	 */
	void deletePassphrase(String key) throws KeychainAccessException;

	/**
	 * Updates a passphrase with a given key. Noop, if there is no item for the given key.
	 *
	 * @param key        Unique key previously used while {@link #storePassphrase(String, String, CharSequence)}  storing a passphrase}.
	 * @param passphrase The secret to be updated in this keychain.
	 * @throws KeychainAccessException If changing the password failed
	 * @deprecated Please use {@link #changePassphrase(String, String, CharSequence)} instead
	 */
	@Deprecated
	void changePassphrase(String key, CharSequence passphrase) throws KeychainAccessException;

	/**
	 * Updates a passphrase with a given key and stores a name for that key. Noop, if there is no item for the given key.
	 *
	 * @param key         Unique key previously used while {@link #storePassphrase(String, String, CharSequence)}  storing a passphrase}.
	 * @param displayName The according name to the key. That's the name of the vault displayed in the UI.
	 *                    It's passed to the keychain as an additional information about the vault besides the key.
	 *                    The parameter does not need to be unique or be checked by the keychain.
	 * @param passphrase  The secret to be updated in this keychain.
	 * @throws KeychainAccessException If changing the password failed
	 */
	default void changePassphrase(String key, String displayName, CharSequence passphrase) throws KeychainAccessException {
		changePassphrase(key, passphrase);
	}

	/**
	 * @return true if this KeychainAccessIntegration works on the current machine.
	 * @implSpec This method must not throw any exceptions and should fail fast
	 * returning false if it can't determine availability of the checked strategy
	 */
	boolean isSupported();

	/**
	 * @return true if the keychain to be accessed is locked. Accesing a locked keychain
	 * requires to unlock the keychain. The keychain backend will show an unlock dialog.
	 * returning false if the keychain to be accessed is unlocked
	 */
	boolean isLocked();

}