Configuring a customPasswordEncryption provider for command line utilities and developer tools

Enable the customPasswordEncryption provider to encrypt sensitive strings by using the command line utilities such as securityUtility. You can also use the customPasswordEncryption provider as an encoding option in WebSphere® Developer Tools.

Before you begin

Obtain an Enterprise Systems Architecture (ESA) file that contains the customPasswordEncryption provider. The customPasswordEncryption provider implements the com.ibm.wsspi.security.crypto.CustomPasswordEncryption interface and contains the extension manifest file as described in Developing a customPasswordEncryption Provider. If you do not have an ESA file that contains the customPasswordEncryption provider, obtain a Java™ archive (JAR) file and one or more manifest files that include installation instructions.

About this task

Install the customPasswordEncryption provider so that you can use it in the Liberty runtime environment and WebSphere Developer Tools. You can use the customPasswordEncryption provider in the Liberty runtime environment to encrypt sensitive strings. After you install the customPasswordEncryption provider in the Liberty runtime environment, WebSphere Developer Tools adds the customPasswordEncryption option as an encoding option in the Password panel.

Procedure

  1. Install the ESA file by using the installUtility command.

    If the customPasswordEncryption provider is packaged differently from the ESA file, follow the installation instructions for the customPasswordEncryption provider.

  2. Verify that the installation was successful.

    Issue the following command:

    wlp/bin/securityUtility encode --listCustom

    The expected output is the information from the customPasswordEncryption provider. The following output is an example:

    [{"name":"custom","featurename":"usr:customPasswordEncryption-1.0","description":"MyCompany custom password encryption"}]
  3. Optional: To use the customPasswordEncryption provider from the command line tools, add the following parameter: --encoding=custom

    This parameter is accepted by the following command line utilities:

    securityUtility
    configUtility
    collective

Results

The customPasswordEncryption provider is installed in the Liberty runtime environment. You optionally used the customPasswordEncryption provider with command line utilities.

What to do next

On the Password panel in WebSphere Developer Tools, you can use the customPasswordEncryption provider as an encoding option.