org.pgpainless.util

Class Passphrase

java.lang.Object

org.pgpainless.util.Passphrase

public class Passphrase
extends Object

Constructor Summary

Constructors

Constructor and Description
Passphrase(char[] chars) Passphrase for keys etc.

Method Summary

Modifier and Type	Method and Description
void	clear() Overwrite the char array with spaces and mark the Passphrase as invalidated.
static Passphrase	emptyPassphrase() Represents a Passphrase instance that represents no password.
protected void	finalize() Call clear() to make sure the memory is overwritten.
char[]	getChars() Return a copy of the underlying char array.
boolean	isValid() Return true if the passphrase has not yet been cleared.

Methods inherited from class java.lang.Object

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

Constructor Detail

Passphrase

public Passphrase(@Nullable
                  char[] chars)

Passphrase for keys etc.

Parameters:

chars - may be null for empty passwords.

Method Detail

clear

public void clear()

Overwrite the char array with spaces and mark the Passphrase as invalidated.

finalize

protected void finalize()
                 throws Throwable

Call clear() to make sure the memory is overwritten.

Overrides:

finalize in class Object

Throws:

Throwable - bad things might happen in Object.finalize().

getChars

@Nullable
public char[] getChars()

Return a copy of the underlying char array. A return value of null represents no password.

Returns:

passphrase chars.

Throws:

IllegalStateException - in case the password has been cleared at this point.

isValid

public boolean isValid()

Return true if the passphrase has not yet been cleared.

Returns:

valid

emptyPassphrase

public static Passphrase emptyPassphrase()

Represents a Passphrase instance that represents no password.

Returns:

empty passphrase