Module com.aoapps.security

Package com.aoapps.security

Class Password

java.lang.Object

com.aoapps.security.Password

All Implemented Interfaces:

AutoCloseable, Cloneable, Destroyable

Direct Known Subclasses:

UnprotectedPassword

public class Password
extends Object
implements Destroyable, AutoCloseable, Cloneable

Represents plaintext password characters, with support for wiping the contents. This is used in preference to char[] as a matter of both convenience and protection.

This does not provide any access to the given password. It is a password black hole: gone forever from outside observers.

Instances of this class are thread-safe.

This class intentionally does not implement equals(java.lang.Object) and hashCode(), as it is not intended to be used in data structures or any complex manipulation. It is solely meant to safely carry a password.

This class also does not implement Serializable or Externalizable. Applications that need to send passwords across the wire must use another mechanism. Applications that need to store passwords should be using HashedPassword.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MASKED_PASSWORD	A constant used to mask passwords.

Constructor Summary

Constructors

Constructor	Description
Password(char[] password)

Method Summary

Modifier and Type	Method	Description
Password	clone()
void	close()	Destroys the password on auto-close.
void	destroy()
boolean	equals(Object obj)
int	hashCode()	Uses default implementation from Object.hashCode().
boolean	isDestroyed()
String	toString()
static Optional<Password>	valueOf(char[] password)	Gets a new password or Optional.empty() when password == null || password.length == 0.

Methods inherited from class java.lang.Object

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

Field Details

MASKED_PASSWORD

public static final String MASKED_PASSWORD

A constant used to mask passwords. This is always returned by toString().

See Also:

• Constant Field Values

Constructor Details

Password

public Password(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).

See Also:

• valueOf(char[])

Method Details

valueOf

public static Optional<Password> valueOf(char[] password)
                                  throws IllegalArgumentException

Gets a new password or Optional.empty() when password == null || password.length == 0.

Parameters:

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

Throws:

IllegalArgumentException - when password is already destroyed (contains all zeroes).

See Also:

• Password(char[])

toString

public String toString()

Overrides:

toString in class Object

Returns:

Returns MASKED_PASSWORD always.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Uses default implementation from Object.hashCode(). Any meaningful implementation could leak private password information. Use UnprotectedPassword instead when needing to use in hash-based data structures.

Overrides:

hashCode in class Object

clone

public Password clone()

Overrides:

clone in class Object

destroy

public void destroy()

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

close

public void close()

Destroys the password on auto-close. This use for support of try-with-resources.

Specified by:

close in interface AutoCloseable