public interface EncryptedProperties
EncryptedProperties
interface represents a properties file
where all the data is encrypted before it is added, and decrypted when it
retrieved. This interface can be implemented in a number of ways, the
simplest being extending Properties
and overloading
the getProperty
and setProperty
methods. In all cases,
the master encryption key, as given by the Encryptor.MasterKey
property in ESAPI.properties
file.Modifier and Type | Method and Description |
---|---|
String |
getProperty(String key)
Gets the property value from the encrypted store, decrypts it, and
returns the plaintext value to the caller.
|
Set<?> |
keySet()
Returns a
Set view of properties. |
void |
load(InputStream in)
Reads a property list (key and element pairs) from the input stream.
|
String |
setProperty(String key,
String value)
Encrypts the plaintext property value and stores the ciphertext value
in the encrypted store.
|
void |
store(OutputStream out,
String comments)
Writes this property list (key and element pairs) in this Properties table to
the output stream in a format suitable for loading into a Properties table using the load method.
|
String getProperty(String key) throws EncryptionException
key
- the name of the property to getEncryptionException
- if the property could not be decryptedString setProperty(String key, String value) throws EncryptionException
key
- the name of the property to setvalue
- the value of the property to setnull
if it did not have one.EncryptionException
- if the property could not be encryptedSet<?> keySet()
Set
view of properties. The Set
is backed by a
java.util.Hashtable
, so changes to the Hashtable
are
reflected in the Set
, and vice-versa. The Set
supports element
removal (which removes the corresponding entry from the Hashtable
,
but not element addition.void load(InputStream in) throws IOException
in
- the input stream that contains the properties fileIOException
- Signals that an I/O exception has occurred.void store(OutputStream out, String comments) throws IOException
out
- the output stream that contains the properties filecomments
- a description of the property list (ex. "Encrypted Properties File").IOException
- Signals that an I/O exception has occurred.Copyright © 2023 The Open Web Application Security Project (OWASP). All rights reserved.