de.unkrig.commons.lang.crypto

Class SecretKeys

java.lang.Object

de.unkrig.commons.lang.crypto.SecretKeys

public final class SecretKeys
extends Object

Utility methods related to SecretKeys.

Method Summary

Modifier and Type	Method and Description
static SecretKey	adHocSecretKey(File keyStoreFile, char[] keyStorePassword, String keyAlias, char[] keyProtectionPassword) If the keyStoreFile does not exist, then this method generates a new SecretKey and stores it in the keyStoreFile).
static SecretKey	adHocSecretKey(File keyStoreFile, char[] keyStorePassword, String keyAlias, String dialogTitle, String messageCreateKey, String messageUseExistingKey) If the keyStoreFile does not exist, then this method asks the user interactively to (optionally) choose a "key protection password", generates a new SecretKey and stores it in the keyStoreFile).

Methods inherited from class java.lang.Object

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

Method Detail

adHocSecretKey

public static SecretKey adHocSecretKey(File keyStoreFile,
                                       @Nullable
                                       char[] keyStorePassword,
                                       String keyAlias,
                                       char[] keyProtectionPassword)
                                throws GeneralSecurityException,
                                       IOException

If the keyStoreFile does not exist, then this method generates a new SecretKey and stores it in the keyStoreFile).

Otherwise, if the keyStoreFile does exist, then this method loads the SecretKey from the keyStoreFile.

Parameters:

keyStorePassword - See KeyStore.load(InputStream, char[])

keyProtectionPassword - See KeyStore.getKey(String, char[]); null to prompt the user

Throws:

GeneralSecurityException

IOException

See Also:

adHocSecretKey(File, char[], String, String, String, String)

adHocSecretKey

@Nullable
public static SecretKey adHocSecretKey(File keyStoreFile,
                                                  @Nullable
                                                  char[] keyStorePassword,
                                                  String keyAlias,
                                                  String dialogTitle,
                                                  String messageCreateKey,
                                                  String messageUseExistingKey)
                                           throws GeneralSecurityException,
                                                  IOException

If the keyStoreFile does not exist, then this method asks the user interactively to (optionally) choose a "key protection password", generates a new SecretKey and stores it in the keyStoreFile).

Otherwise, if the keyStoreFile does exist, then this method asks the user interactively for the "key protection password" (if one was given when the key was previously generated), and loads the SecretKey from the keyStoreFile.

Parameters:

keyStorePassword - See KeyStore.load(InputStream, char[])

dialogTitle - E.g. "Authentication store"

messageCreateKey - E.g. "Do you want to create an authentication store for user names and passwords?"

messageUseExistingKey - E.g. "Do you want to use the existing authentication store for user names and passwords?"

Returns:

null indicates that the user cancelled the operation

Throws:

GeneralSecurityException

IOException

See Also:

adHocSecretKey(File, char[], String, char[])