iaik.utils

Class IAIKPasswordStore

java.lang.Object

iaik.utils.IAIKPasswordStore

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public final class IAIKPasswordStore
extends java.lang.Object
implements java.io.Externalizable

This class implements a password store, which can be used in a similar fashion as JCE key stores. It uses AES and CMAC/AES in combination with PBKDF2 to securely store the password data.

See Also:

PBKDF2, Rijndael, CMacAES, PasswordGenerator, PasswordStrengthChecker, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IAIKPasswordStore() Constructs a new instance.
IAIKPasswordStore(java.security.SecureRandom random) Constructs a new instance using a specific secure PRNG.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Enumeration	aliases() Returns an enumeration of the aliases.
void	clear() Clears the password store.
boolean	containsAlias(java.lang.String alias) Returns true, if the password store contains an entry for some alias.
void	deleteEntry(java.lang.String alias) Returns the password entry for the given alias.
protected void	finalize() Destroy critical data.
char[]	generatePasswordEntry(java.lang.String alias, int length, int usedSymbolMask) Creates a new password entry consisting of an alias and a generated password.
char[]	getPassword(java.lang.String alias) Returns the stored password for some alias.
void	load(java.io.File file, char[] password) Loads a key store from a file.
void	load(java.io.InputStream in, char[] password) Loads a key store from an input stream.
void	load(java.lang.String filename, char[] password) Loads a key store from a file.
void	readExternal(java.io.ObjectInput in) Responsible for reading the encrypted input and restoring it.
void	setPasswordEntry(java.lang.String alias, char[] password) Creates a new password entry consisting of an alias and the password.
int	size() Returns the size of the password store.
void	store(java.io.File file, char[] password) Encrypts the current state of this key store and stores it to a file.
void	store(java.io.OutputStream out, char[] password) Encrypts the current state of this key store and stores it to an output stream.
void	store(java.lang.String filename, char[] password) Encrypts the current state of this key store and stores it to a file.
void	writeExternal(java.io.ObjectOutput out) Responsible for creating the encrypted output of this.

Methods inherited from class java.lang.Object

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

Constructor Detail

IAIKPasswordStore

public IAIKPasswordStore()

Constructs a new instance.

IAIKPasswordStore

public IAIKPasswordStore(java.security.SecureRandom random)
                  throws java.security.ProviderException

Constructs a new instance using a specific secure PRNG.

Parameters:

random - the random generator to be used for the iv and salt generation

Throws:

java.security.ProviderException - if the IAIK provider is not installed

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Destroy critical data.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

load

public void load(java.lang.String filename,
        char[] password)
          throws java.io.IOException

Loads a key store from a file. Note the password is being copied. Hence, the user has to take care of clearing it.

Parameters:

filename - the file name

password - the password to decrypt this key store

Throws:

java.io.IOException - thrown, if a file format error occurred

load

public void load(java.io.File file,
        char[] password)
          throws java.io.IOException

Loads a key store from a file. Note the password is being copied. Hence, the user has to take care of clearing it.

Parameters:

file - the file

password - the password to decrypt this key store

Throws:

java.io.IOException - thrown, if the file could not be read or if a file format error occurred

load

public void load(java.io.InputStream in,
        char[] password)
          throws java.io.IOException

Loads a key store from an input stream. Note the password is being copied. Hence, the user has to take care of clearing it.

Parameters:

in - the input stream

password - the password to decrypt this key store

Throws:

java.io.IOException - thrown, if the file could not be read or if a file format error occurred

store

public void store(java.lang.String filename,
         char[] password)
           throws java.io.IOException

Encrypts the current state of this key store and stores it to a file. Note the password is being copied. Hence, the user has to take care of clearing it.

Parameters:

filename - the file name

password - the password to be used to encrypt the key store

Throws:

java.io.IOException - thrown, if the file could not be written

store

public void store(java.io.File file,
         char[] password)
           throws java.io.IOException

Encrypts the current state of this key store and stores it to a file. Note the password is being copied. Hence, the user has to take care of clearing it.

Parameters:

file - the file

password - the password to be used to encrypt the key store

Throws:

java.io.IOException - thrown, if the file could not be written

store

public void store(java.io.OutputStream out,
         char[] password)
           throws java.io.IOException

Encrypts the current state of this key store and stores it to an output stream. Note the password is being copied. Hence, the user has to take care of clearing it.

Parameters:

out - the output stream

password - the password to be used to encrypt the key store

Throws:

java.io.IOException - thrown, if the file could not be written

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Responsible for creating the encrypted output of this.

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Responsible for reading the encrypted input and restoring it.

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getPassword

public char[] getPassword(java.lang.String alias)

Returns the stored password for some alias.

Parameters:

alias - the alias

Returns:

the corresponding password

setPasswordEntry

public void setPasswordEntry(java.lang.String alias,
                    char[] password)

Creates a new password entry consisting of an alias and the password. Note the password is being copied. Hence, the user has to take care of clearing it.

Parameters:

alias - the alias for identifying this entry

password - the password as character array

generatePasswordEntry

public char[] generatePasswordEntry(java.lang.String alias,
                           int length,
                           int usedSymbolMask)

Creates a new password entry consisting of an alias and a generated password. The user can specify the password length and the character sets to be used.

Parameters:

alias - the alias for identifying this entry

length - the password length

usedSymbolMask - the symbol mask for determining the character set, which is an OR-combination of the values USE_CHARS_LOWER, USE_CHARS_UPPER, USE_NUMBERS, USE_SPECIAL_BASIC, and USE_SPECIAL_EXTENDED from PasswordGenerator

Returns:

the generated password as character array

See Also:

PasswordGenerator

containsAlias

public boolean containsAlias(java.lang.String alias)

Returns true, if the password store contains an entry for some alias.

Parameters:

alias - the alias

Returns:

true, iff the password contains the corresponding entry

deleteEntry

public void deleteEntry(java.lang.String alias)

Returns the password entry for the given alias.

Parameters:

alias - the alias

size

public int size()

Returns the size of the password store.

Returns:

the number of entries

aliases

public java.util.Enumeration aliases()

Returns an enumeration of the aliases.

Returns:

an enumeration holding the aliases

clear

public void clear()

Clears the password store.