org.owasp.esapi.interfaces
Interface ISecurityConfiguration

All Known Implementing Classes:
SecurityConfiguration

public interface ISecurityConfiguration

The ISecurityConfiguration interface stores all configuration information that directs the behavior of the ESAPI implementation.

Protection of this configuration information is critical to the secure operation of the application using the ESAPI. You should use operating system access controls to limit access to wherever the configuration information is stored. Please note that adding another layer of encryption does not make the attackers job much more difficult. Somewhere there must be a master "secret" that is stored unencrypted on the application platform. Creating another layer of indirection doesn't provide any real additional security.

Since:
June 1, 2007
Author:
Jeff Williams (jeff.williams .at. aspectsecurity.com) Aspect Security

Method Summary
 java.util.List getAllowedFileExtensions()
          Gets the allowed file extensions.
 int getAllowedFileUploadSize()
          Gets the allowed file upload size.
 int getAllowedLoginAttempts()
          Gets the allowed login attempts.
 java.lang.String getApplicationName()
          Gets the application name, used for logging
 java.lang.String getCharacterEncoding()
          Gets the character encoding.
 java.lang.String getDigitalSignatureAlgorithm()
          Gets the digital signature algorithm.
 java.lang.String getEncryptionAlgorithm()
          Gets the encryption algorithm.
 java.lang.String getHashAlgorithm()
          Gets the hasing algorithm.
 java.io.File getKeystore()
          Gets the keystore.
 char[] getMasterPassword()
          Gets the master password.
 byte[] getMasterSalt()
          Gets the master salt.
 int getMaxOldPasswordHashes()
          Gets the max old password hashes.
 java.lang.String getPasswordParameterName()
          Gets the password parameter name.
 Threshold getQuota(java.lang.String eventName)
          Gets an intrusion detection Quota.
 java.lang.String getRandomAlgorithm()
          Gets the random number generation algorithm.
 java.lang.String getResourceDirectory()
          Gets the ESAPI resource directory as a String.
 java.lang.String getUsernameParameterName()
          Gets the username parameter name.
 void setResourceDirectory(java.lang.String dir)
          Sets the ESAPI resource directory.
 

Method Detail

getApplicationName

public java.lang.String getApplicationName()
Gets the application name, used for logging

Returns:
the application name

getMasterPassword

public char[] getMasterPassword()
Gets the master password.

Returns:
the master password

getKeystore

public java.io.File getKeystore()
Gets the keystore.

Returns:
the keystore

getMasterSalt

public byte[] getMasterSalt()
Gets the master salt.

Returns:
the master salt

getAllowedFileExtensions

public java.util.List getAllowedFileExtensions()
Gets the allowed file extensions.

Returns:
the allowed file extensions

getAllowedFileUploadSize

public int getAllowedFileUploadSize()
Gets the allowed file upload size.

Returns:
the allowed file upload size

getPasswordParameterName

public java.lang.String getPasswordParameterName()
Gets the password parameter name.

Returns:
the password parameter name

getUsernameParameterName

public java.lang.String getUsernameParameterName()
Gets the username parameter name.

Returns:
the username parameter name

getEncryptionAlgorithm

public java.lang.String getEncryptionAlgorithm()
Gets the encryption algorithm.

Returns:
the algorithm

getHashAlgorithm

public java.lang.String getHashAlgorithm()
Gets the hasing algorithm.

Returns:
the algorithm

getCharacterEncoding

public java.lang.String getCharacterEncoding()
Gets the character encoding.

Returns:
encoding name

getDigitalSignatureAlgorithm

public java.lang.String getDigitalSignatureAlgorithm()
Gets the digital signature algorithm.

Returns:
encoding name

getRandomAlgorithm

public java.lang.String getRandomAlgorithm()
Gets the random number generation algorithm.

Returns:
encoding name

getAllowedLoginAttempts

public int getAllowedLoginAttempts()
Gets the allowed login attempts.

Returns:
the allowed login attempts

getMaxOldPasswordHashes

public int getMaxOldPasswordHashes()
Gets the max old password hashes.

Returns:
the max old password hashes

getQuota

public Threshold getQuota(java.lang.String eventName)
Gets an intrusion detection Quota.

Parameters:
eventName -
Returns:
the matching Quota

getResourceDirectory

public java.lang.String getResourceDirectory()
Gets the ESAPI resource directory as a String.


setResourceDirectory

public void setResourceDirectory(java.lang.String dir)
Sets the ESAPI resource directory.