This page applies to an earlier version of the AppDynamics App IQ Platform.
See the latest version of the documentation.
On this page: Related pages: Works with:
On this page:
- Controller account access key
- Controller keystore/agent truststore password
- Proxy server password
For environments where security policies require you to secure credentials stored on disk, you can use the Secure Credential Store to encrypt credentials for use in agent configuration.
Two components comprise the Secure Credential Store:
- scs-tool.jar: a utility to create the secure credential store, encrypt credentials, and obfuscate the credential store password
- Secure credential keystore: a keystore for the secret encryption key
The secure credential store utility encrypts plain text using the strongest encryption available according to the system's encryption jurisdiction policy.
For the .NET Agent, see Encrypt Credentials in .NET Agent Configuration.
Required: Update Agent Properties
After you set up the Credential Keystore, you must specify the following settings in the Java Agent Properties:
Initialize the Secure Credential Store
Before you can encrypt or obfuscate passwords, you must run the secure credential store utility to create the keystore for your secret encryption key. The agent distribution includes the secure credential store utility in the following locations :
- Java Agent: <javaagent_home>/<version>/utils/scs/scs-tool.jar
- Machine Agent: <machine_agent_home>/lib/scs-tool.jar
- Database Agent: <database_agent_home>/lib/scs-tool.jar
Run the secure credential store utility
generate_ks command with the following parameters:
filename: absolute path where the utility will create the secure credential keystore. Use this path for
<credential-store-filename>in agent configuration.
storepass: the secure credential keystore password. Use the obfuscated version of this password as the value for
<credential-store-password>in agent configuration.
/<full path to application JRE>/bin/java -jar ./scs-tool.jar generate_ks -filename '/opt/appdynamics/secretKeyStore' -storepass 'MyCredentialStorePassword'
The secure credential store utility confirms it created and initialized the keystore:
Successfully created and initialized new KeyStore file: /opt/appdynamics/secretKeyStore Verification - New KeyStore file: /opt/appdynamics/secretKeyStore is properly initialized.
To encrypt passwords using the secure credential store utility, run the
encrypt command with the following parameters:
filename: absolute path to the secure credential keystore file.
storepass: password for the secure credential keystore. You can use either a plain-text password or a password that has been obfuscated as described in the following section.
plaintext: any plain text to encrypt. For instance, account access key or password.
Here is an example using a plain-text password (the
-storepass argument) for the secure credential keystore:
/<full path to application JRE>/bin/java -jar ./scs-tool.jar encrypt -filename '/opt/appdynamics/secretKeyStore' -storepass 'MyCredentialStorePassword' -plaintext 'MyAccessKeyOrPassword'
Here is the same example using an obfuscated password:
/<full path to application JRE>/bin/java -jar ./scs-tool.jar encrypt -filename '/opt/appdynamics/secretKeyStore' -storepass 's_gsnwR6+LDch8JBf1RamiBoWfMvjjipkrtJMZXAYEkw8=' -plaintext 'MyAccessKeyOrPassword'
The secure credential store utility writes out an encrypted password for use in agent configuration files:
Obfuscate the Secure Credential Store Password
In order to access the secret key in the secure credential keystore, the agent needs the obfuscated credential store password. Run the secure credential store utility
obfuscate command with the following parameter:
plaintext: the plain text secure credential keystore password.
/<full path to application JRE>/bin/java -jar /opt/appdynamics/scs-tool.jar obfuscate -plaintext 'MyCredentialStorePassword'
The secure credential store utility writes out an obfuscated password for use in the
<credential-store-password> in agent configuration. For example:
Sample Agent Configuration
The following example demonstrates the agent configuration properties for the Secure Credential Store. For more information see the agent-specific configuration property documentation.
<?xml version="1.0" encoding="UTF-8"?> <controller-info> ... <!-- Encrypted account access key --> <account-access-key>r9iDWPzHRCNDM1B6KTag4A/cA5B4pouVPkv48ovRm6c=</account-access-key> <!-- Encrypted Controller keystore / agent trust store password --> <controller-keystore-password>Tw49bd0hdCMBoQ5pfMMuYA/cA5B4pouVPkv48ovRm6c=</controller-keystore-password> <!-- Enable the Secure Credential Store --> <use-encrypted-credentials>true</use-encrypted-credentials> <!-- Path to they secure credential keystore --> <credential-store-filename>/opt/appdynamics/secretKeyStore</credential-store-filename> <!-- Obfuscated secure credential keystore password --> <credential-store-password>n/8GvAZsKk4gM3Z6g+XQ1w==</credential-store-password> ... </controller-info>