Class SensitiveString

java.lang.Object

org.jpos.security.SensitiveString

All Implemented Interfaces:

AutoCloseable, Supplier<String>

public class SensitiveString
extends Object
implements Supplier<String>, AutoCloseable

Holds a sensitive string in memory under AES-GCM encryption with a per-instance key, exposing the cleartext only on demand and zeroing the buffer when the instance is cleaned.

Constructor Summary

Constructors

Constructor	Description
SensitiveString(String s)	Constructs a new SensitiveString holding the encrypted form of s.

Method Summary

Modifier and Type	Method	Description
void	clean()	Zeroes the encrypted buffer so the cleartext is no longer recoverable.
void	close()
boolean	equals(Object o)
String	get()

Methods inherited from class Object

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

Constructor Details

SensitiveString

public SensitiveString(String s)
                throws NoSuchAlgorithmException,
NoSuchPaddingException,
InvalidKeyException,
IllegalBlockSizeException,
BadPaddingException,
NoSuchProviderException,
InvalidAlgorithmParameterException

Constructs a new SensitiveString holding the encrypted form of s.

Parameters:

s - plaintext to protect

Throws:

NoSuchAlgorithmException - if AES is unavailable

NoSuchPaddingException - if the configured padding is unavailable

InvalidKeyException - if the generated key is rejected

IllegalBlockSizeException - on AES-GCM block-size errors

BadPaddingException - on AES-GCM padding errors

NoSuchProviderException - if the configured provider is unavailable

InvalidAlgorithmParameterException - if the IV/parameters are rejected

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

clean

public void clean()

Zeroes the encrypted buffer so the cleartext is no longer recoverable.

get

public String get()

Specified by:

get in interface Supplier<String>

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception