org.jboss.as.security.vault

Class VaultSession

java.lang.Object

org.jboss.as.security.vault.VaultSession

public final class VaultSession
extends Object

Non-interactive session for VaultTool

Author:

Peter Skopek

Field Summary

Fields

Modifier and Type	Field and Description
static String	VAULT_ENC_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
VaultSession(String keystoreURL, String keystorePassword, String encryptionDirectory, String salt, int iterationCount) Constructor to create VaultSession.
VaultSession(String keystoreURL, String keystorePassword, String encryptionDirectory, String salt, int iterationCount, boolean createKeystore) Constructor to create VaultSession with possibility to create keystore automaticaly.

Method Summary

Modifier and Type	Method and Description
String	addSecuredAttribute(String vaultBlock, String attributeName, char[] attributeValue) Add secured attribute to specified vault block.
void	addSecuredAttributeWithDisplay(String vaultBlock, String attributeName, char[] attributeValue) Add secured attribute to specified vault block.
boolean	checkSecuredAttribute(String vaultBlock, String attributeName) Check whether secured attribute is already set for given vault block and attribute name.
String	getKeystoreMaskedPassword() Method to get keystore masked password to use further in configuration.
boolean	removeSecuredAttribute(String vaultBlock, String attributeName) This method removes secured attribute stored in SecurityVault.
char[]	retrieveSecuredAttribute(String vaultBlock, String attributeName) Retrieves secured attribute from specified vault block with specified attribute name.
void	startVaultSession(String vaultAlias) Start the vault with given alias.
protected void	validateEncryptionDirectory()
protected void	validateIterationCount()
protected void	validateKeystorePassword()
protected void	validateKeystoreURL()
protected void	validateSalt()
String	vaultConfiguration() Returns vault configuration string in user readable form.
void	vaultConfigurationDisplay() Display info about vault itself in form of AS7 configuration file.

Methods inherited from class java.lang.Object

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

Field Detail

VAULT_ENC_ALGORITHM

public static final String VAULT_ENC_ALGORITHM

See Also:

Constant Field Values

Constructor Detail

VaultSession

public VaultSession(String keystoreURL,
                    String keystorePassword,
                    String encryptionDirectory,
                    String salt,
                    int iterationCount)
             throws Exception

Constructor to create VaultSession.

Parameters:

keystoreURL -

keystorePassword -

encryptionDirectory -

salt -

iterationCount -

Throws:

Exception

VaultSession

public VaultSession(String keystoreURL,
                    String keystorePassword,
                    String encryptionDirectory,
                    String salt,
                    int iterationCount,
                    boolean createKeystore)
             throws Exception

Constructor to create VaultSession with possibility to create keystore automaticaly.

Parameters:

keystoreURL -

keystorePassword -

encryptionDirectory -

salt -

iterationCount -

createKeystore -

Throws:

Exception

Method Detail

validateKeystoreURL

protected void validateKeystoreURL()
                            throws Exception

Throws:

Exception

validateKeystorePassword

protected void validateKeystorePassword()
                                 throws Exception

Throws:

Exception

validateEncryptionDirectory

protected void validateEncryptionDirectory()
                                    throws Exception

Throws:

Exception

validateIterationCount

protected void validateIterationCount()
                               throws Exception

Throws:

Exception

validateSalt

protected void validateSalt()
                     throws Exception

Throws:

Exception

startVaultSession

public void startVaultSession(String vaultAlias)
                       throws Exception

Start the vault with given alias.

Parameters:

vaultAlias -

Throws:

Exception

addSecuredAttribute

public String addSecuredAttribute(String vaultBlock,
                                  String attributeName,
                                  char[] attributeValue)
                           throws Exception

Add secured attribute to specified vault block. This method can be called only after successful startVaultSession() call.

Parameters:

vaultBlock -

attributeName -

attributeValue -

Returns:

secured attribute configuration

Throws:

Exception

addSecuredAttributeWithDisplay

public void addSecuredAttributeWithDisplay(String vaultBlock,
                                           String attributeName,
                                           char[] attributeValue)
                                    throws Exception

Add secured attribute to specified vault block. This method can be called only after successful startVaultSession() call. After successful storage the secured attribute information will be displayed at standard output. For silent method @see addSecuredAttribute

Parameters:

vaultBlock -

attributeName -

attributeValue -

Throws:

Exception

checkSecuredAttribute

public boolean checkSecuredAttribute(String vaultBlock,
                                     String attributeName)
                              throws Exception

Check whether secured attribute is already set for given vault block and attribute name. This method can be called only after successful startVaultSession() call.

Parameters:

vaultBlock -

attributeName -

Returns:

true is password already exists for given vault block and attribute name.

Throws:

Exception

removeSecuredAttribute

public boolean removeSecuredAttribute(String vaultBlock,
                                      String attributeName)
                               throws Exception

This method removes secured attribute stored in SecurityVault. After successful remove operation returns true. Otherwise false.

Parameters:

vaultBlock - security vault block

attributeName - Attribute name stored in security vault

Returns:

true is operation is successful, otherwise false

Throws:

Exception

retrieveSecuredAttribute

public char[] retrieveSecuredAttribute(String vaultBlock,
                                       String attributeName)
                                throws Exception

Retrieves secured attribute from specified vault block with specified attribute name. This method can be called only after successful startVaultSession() call.

Parameters:

vaultBlock - security vault block

attributeName - Attribute name stored in security vault

Returns:

value of secured attribute if exists, otherwise null

Throws:

Exception

vaultConfigurationDisplay

public void vaultConfigurationDisplay()

Display info about vault itself in form of AS7 configuration file.

vaultConfiguration

public String vaultConfiguration()

Returns vault configuration string in user readable form.

Returns:

getKeystoreMaskedPassword

public String getKeystoreMaskedPassword()

Method to get keystore masked password to use further in configuration. Has to be used after startVaultSession method.

Returns:

the keystoreMaskedPassword