Module com.aoapps.security

Package com.aoapps.security

Class UnprotectedPassword

java.lang.Object

com.aoapps.security.Password

com.aoapps.security.UnprotectedPassword

All Implemented Interfaces:

AutoCloseable, Cloneable, Destroyable

public final class UnprotectedPassword
extends Password

Unlike Password, which goes out of its way to protect the password, an unprotected password provides access to the password value. This is intended for when the password needs to be accessible to the application, such as providing a generated password to the user.

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class com.aoapps.security.Password

MASKED_PASSWORD

Constructor Summary

Constructors

Constructor	Description
UnprotectedPassword()	Generates a new password using the default password generator and a default SecureRandom instance, which is not a strong instance to avoid blocking.
UnprotectedPassword(char[] password)
UnprotectedPassword(SupplierE<? extends char[],Ex> generator)	Generates a new password using the provided password generator.
UnprotectedPassword(SecureRandom secureRandom)	Generates a new password using the default password generator and the provided SecureRandom source.
UnprotectedPassword(Random random)	Deprecated. Please use SecureRandom.

Method Summary

Modifier and Type	Method	Description
<Ex extends Throwable> void	accept(ConsumerE<? super char[],Ex> consumer)	Calls a consumer, providing a copy of the password.
UnprotectedPassword	clone()
int	hashCode()	Implements hash code via Arrays.hashCode(char[]) on the password.
<R, Ex extends Throwable> R	invoke(FunctionE<? super char[],R,Ex> function)	Calls a function, providing a copy of the password.
<Ex extends Throwable> boolean	test(PredicateE<? super char[],Ex> predicate)	Calls a predicate, providing a copy of the password.

Methods inherited from class com.aoapps.security.Password

close, destroy, equals, isDestroyed, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UnprotectedPassword

public UnprotectedPassword(char[] password)
                    throws IllegalArgumentException

Parameters:

password - Is zeroed before this method returns. If the original password is needed, pass a copy to this method.

Throws:

IllegalArgumentException - when password == null || password.length == 0 or when password is already destroyed (contains all zeroes).

UnprotectedPassword

public UnprotectedPassword(SupplierE<? extends char[],Ex> generator)
                    throws Ex

Generates a new password using the provided password generator.

The password will never be all-zeroes, since this would conflict with the representation of already destroyed. In the unlikely event the generator creates an all-zero password, the password will be discarded and another will be generated. We do recognize that disallowing certain values from the password space may provide an advantage to attackers (i.e. Enigma), losing the all-zero password is probably a good choice anyway.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

Ex

UnprotectedPassword

@Deprecated
public UnprotectedPassword(Random random)

Deprecated.

Please use SecureRandom. This method will stay, but will remain deprecated since it should only be used after careful consideration.

Generates a new password using the default password generator and the provided Random source.

UnprotectedPassword

public UnprotectedPassword(SecureRandom secureRandom)

Generates a new password using the default password generator and the provided SecureRandom source.

UnprotectedPassword

public UnprotectedPassword()

Generates a new password using the default password generator and a default SecureRandom instance, which is not a strong instance to avoid blocking.

Method Details

hashCode

public int hashCode()

Implements hash code via Arrays.hashCode(char[]) on the password. Please note that the hash code may change when destroyed.

Overrides:

hashCode in class Password

clone

public UnprotectedPassword clone()

Overrides:

clone in class Password

invoke

public <R,
Ex extends Throwable> R invoke(FunctionE<? super char[],R,Ex> function)
                                   throws IllegalStateException,
Ex

Calls a function, providing a copy of the password. The copy of the password is zeroed once the function returns.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

IllegalStateException - when Password.isDestroyed()

Ex

accept

public <Ex extends Throwable> void accept(ConsumerE<? super char[],Ex> consumer)
                                   throws IllegalStateException,
Ex

Calls a consumer, providing a copy of the password. The copy of the password is zeroed once the consumer returns.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

IllegalStateException - when Password.isDestroyed()

Ex

test

public <Ex extends Throwable> boolean test(PredicateE<? super char[],Ex> predicate)
                                    throws IllegalStateException,
Ex

Calls a predicate, providing a copy of the password. The copy of the password is zeroed once the predicate returns.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

IllegalStateException - when Password.isDestroyed()

Ex