org.picketbox.plugins.vault

Class PicketBoxSecurityVault

java.lang.Object

org.picketbox.plugins.vault.PicketBoxSecurityVault

All Implemented Interfaces:

SecurityVault

public class PicketBoxSecurityVault
extends Object
implements SecurityVault

An instance of SecurityVault that uses a KeyStore The shared key just uses a concatenation of a java.uti.UUID and a keystore alias. The following options are expected in the SecurityVault.init(Map) call: ENC_FILE_DIR: the location where the encoded files will be kept. End with "/" or "\" based on your platform KEYSTORE_URL: location where your keystore is located KEYSTORE_PASSWORD: Masked keystore password. Has to be prepended with MASK- KEYSTORE_ALIAS: Alias where the keypair is located SALT: salt of the masked password. Ensured it is 8 characters in length ITERATION_COUNT: Iteration Count of the masked password. KEY_SIZE: Key size of encryption. Default is 128 bytes.

Since:

Aug 12, 2011

Author:

Anil.Saldhana@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ADMIN_KEY
protected String	decodedEncFileDir
static String	ENC_FILE_DIR
protected static String	ENCODED_FILE
protected String	encryptionAlgorithm
protected boolean	finishedInit
static String	ITERATION_COUNT
static String	KEY_SIZE
protected int	keySize
protected KeyStore	keystore
static String	KEYSTORE_ALIAS
static String	KEYSTORE_PASSWORD
static String	KEYSTORE_URL
protected String	LINE_BREAK
protected static org.jboss.logging.Logger	log
static String	PASS_MASK_PREFIX
static String	PUBLIC_CERT
static String	SALT
protected static String	SHARED_KEY_FILE
protected Map<String,byte[]>	sharedKeyMap
protected Map<String,byte[]>	theContent

Constructor Summary

Constructors

Constructor and Description
PicketBoxSecurityVault()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists(String vaultBlock, String attributeName) Check whether an attribute value exists in the vault
byte[]	handshake(Map<String,Object> handshakeOptions) Retrieve the shared key from the vault
void	init(Map<String,Object> options) Initialize the vault
boolean	isInitialized() Determine if the vault is initialized
Set<String>	keyList() Get the currently vaulted VaultBlock_attribute Names
boolean	remove(String vaultBlock, String attributeName, byte[] sharedKey) Remove an existing attribute value
char[]	retrieve(String vaultBlock, String attributeName, byte[] sharedKey) Retrieve the attribute value
void	store(String vaultBlock, String attributeName, char[] attributeValue, byte[] sharedKey) Store an attribute value

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.jboss.logging.Logger log

finishedInit

protected boolean finishedInit

keystore

protected KeyStore keystore

encryptionAlgorithm

protected String encryptionAlgorithm

keySize

protected int keySize

theContent

protected Map<String,byte[]> theContent

sharedKeyMap

protected Map<String,byte[]> sharedKeyMap

ENC_FILE_DIR

public static final String ENC_FILE_DIR

See Also:

Constant Field Values

KEYSTORE_URL

public static final String KEYSTORE_URL

See Also:

Constant Field Values

KEYSTORE_PASSWORD

public static final String KEYSTORE_PASSWORD

See Also:

Constant Field Values

KEYSTORE_ALIAS

public static final String KEYSTORE_ALIAS

See Also:

Constant Field Values

SALT

public static final String SALT

See Also:

Constant Field Values

ITERATION_COUNT

public static final String ITERATION_COUNT

See Also:

Constant Field Values

PASS_MASK_PREFIX

public static final String PASS_MASK_PREFIX

See Also:

Constant Field Values

PUBLIC_CERT

public static final String PUBLIC_CERT

See Also:

Constant Field Values

KEY_SIZE

public static final String KEY_SIZE

See Also:

Constant Field Values

ENCODED_FILE

protected static final String ENCODED_FILE

See Also:

Constant Field Values

SHARED_KEY_FILE

protected static final String SHARED_KEY_FILE

See Also:

Constant Field Values

ADMIN_KEY

protected static final String ADMIN_KEY

See Also:

Constant Field Values

decodedEncFileDir

protected String decodedEncFileDir

LINE_BREAK

protected String LINE_BREAK

Constructor Detail

PicketBoxSecurityVault

public PicketBoxSecurityVault()

Method Detail

init

public void init(Map<String,Object> options)
          throws SecurityVaultException

Description copied from interface: SecurityVault

Initialize the vault

Specified by:

init in interface SecurityVault

Throws:

SecurityVaultException

isInitialized

public boolean isInitialized()

Description copied from interface: SecurityVault

Determine if the vault is initialized

Specified by:

isInitialized in interface SecurityVault

Returns:

handshake

public byte[] handshake(Map<String,Object> handshakeOptions)
                 throws SecurityVaultException

Description copied from interface: SecurityVault

Retrieve the shared key from the vault

Specified by:

handshake in interface SecurityVault

Parameters:

handshakeOptions - a set of options that the vault identifies for handshake

Returns:

Throws:

SecurityVaultException

keyList

public Set<String> keyList()
                    throws SecurityVaultException

Description copied from interface: SecurityVault

Get the currently vaulted VaultBlock_attribute Names

Specified by:

keyList in interface SecurityVault

Returns:

Throws:

SecurityVaultException

store

public void store(String vaultBlock,
         String attributeName,
         char[] attributeValue,
         byte[] sharedKey)
           throws SecurityVaultException

Description copied from interface: SecurityVault

Store an attribute value

Specified by:

store in interface SecurityVault

Parameters:

vaultBlock - a string value that brings in the uniqueness

attributeName - name of the attribute

Throws:

SecurityVaultException

retrieve

public char[] retrieve(String vaultBlock,
              String attributeName,
              byte[] sharedKey)
                throws SecurityVaultException

Description copied from interface: SecurityVault

Retrieve the attribute value

Specified by:

retrieve in interface SecurityVault

Returns:

Throws:

SecurityVaultException

exists

public boolean exists(String vaultBlock,
             String attributeName)
               throws SecurityVaultException

Description copied from interface: SecurityVault

Check whether an attribute value exists in the vault

Specified by:

exists in interface SecurityVault

Returns:

Throws:

SecurityVaultException

See Also:

SecurityVault.exists(String, String)

remove

public boolean remove(String vaultBlock,
             String attributeName,
             byte[] sharedKey)
               throws SecurityVaultException

Description copied from interface: SecurityVault

Remove an existing attribute value

Specified by:

remove in interface SecurityVault

Returns:

true if remove was successful, false otherwise

Throws:

SecurityVaultException