com.github.triceo.robozonky.common.secrets

Class KeyStoreHandler

java.lang.Object

com.github.triceo.robozonky.common.secrets.KeyStoreHandler

public class KeyStoreHandler
extends Object

Simple abstraction for dealing with the overly complicated KeyStore API. Always call save() to persist changes made.

Method Summary

Modifier and Type	Method and Description
static KeyStoreHandler	create(File keyStoreFile, char[] password) Create brand new key store protected by a given password, and store it in a file.
boolean	delete(String alias) Remove an entry from the key store.
Optional<char[]>	get(String alias) Retrieve a previously stored key.
boolean	isDirty() Whether or not there are unsaved changes.
static KeyStoreHandler	open(File keyStoreFile, char[] password) Open an existing key store, protected by a given password.
void	save() Persist whatever operations that have been made using this API.
boolean	set(String alias, char[] value) Set a key in the key store.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static KeyStoreHandler create(File keyStoreFile,
                                     char[] password)
                              throws IOException,
                                     KeyStoreException

Create brand new key store protected by a given password, and store it in a file.

Parameters:

keyStoreFile - The file where the key store should be.

password - Password to protect the key store.

Returns:

Freshly instantiated key store, in a newly created file.

Throws:

IOException - If file already exists or there is a problem writing the file.

KeyStoreException - If something's happened to the key store.

open

public static KeyStoreHandler open(File keyStoreFile,
                                   char[] password)
                            throws IOException,
                                   KeyStoreException

Open an existing key store, protected by a given password.

Parameters:

keyStoreFile - The file where the key store is.

password - Password that protects the key store.

Returns:

Key store that previously existed.

Throws:

IOException - If file does not exist or there is a problem writing the file.

KeyStoreException - If something's happened to the key store.

set

public boolean set(String alias,
                   char[] value)

Set a key in the key store. Uses SecretKey as the implementation. Overwrites previous contents, if any.

Parameters:

alias - Alias to store the key under.

value - The value to be stored.

Returns:

True if stored in the key store.

get

public Optional<char[]> get(String alias)

Retrieve a previously stored key.

Parameters:

alias - The alias under which the key will be looked up.

Returns:

Present if the alias is present in the key store.

delete

public boolean delete(String alias)

Remove an entry from the key store.

Parameters:

alias - The alias to locate the entry.

Returns:

True if there is now no entry with a given key.

isDirty

public boolean isDirty()

Whether or not there are unsaved changes.

Returns:

Whether a set(String, char[]) occurred after last save().

save

public void save()
          throws IOException

Persist whatever operations that have been made using this API. Unless this method is called, no other methods have effect.

Throws:

IOException - If saving the key store failed.