Managing Credentials

In order for user segment security to work, you must add credentials in two places:

Modifications to REST security credentials stored in the credentialStoreMap are effective immediately after they are saved. Modifications to the Workbench security credential require a restart before those changes become available for use.

Managing Credentials in the credentialStoreMap

You can add a credential to the credentialStoreMap using either CIM or Dynamo Server Admin. Follow the instructions below to add a security credential to the credentialStoreMap using CIM.

  1. In the CIM MAIN MENU, select [2] Configure OPSS Security.

  2. In the SECURITY DEPLOYMENT MENU, choose [1] Enter the location to deploy OPSS files.

  3. Press Enter to accept the default location for OPSS files.

  4. In the SECURITY DEPLOYMENT MENU, choose [2] Enter the security credential for REST Services.

  5. Enter the new credential at the prompt. The credential can be any text, similar to a password, however it should correspond to your organization’s OPSS security platform requirements.

  6. Re-enter the credential to confirm it.

  7. In the SECURITY DEPLOYMENT MENU, choose [3] Deploy configuration files.

  8. In the COPY CREDENTIALS TO SHARED DIRECTORY menu, choose [D] Deploy to /<ATG11dir>/home/../home/security.

  9. In the VERIFY WHETHER TO OVERWRITE CURRENT DIRECTORY CONTENTS menu, choose [D] Deploy OPSS configuration files.

  10. In the SECURITY DEPLOYMENT MENU, choose [D] Done.

Alternatively, you can add or delete security credentials using Dynamo Server Admin.

To enter security credentials in Dynamo Server Admin:

  1. In a browser, navigate to the instance of Dynamo Server Admin that is running on the user segment server:

    http://<user_segment_server_host>:<user_segment_server_HTTP_port>/dyn/admin

  2. In the authentication dialog box, enter the Dynamo Server Admin username and password click OK.

  3. (WebLogic only) Depending on how you configured your environment, WebLogic may require an additional login for the WebLogic server. If necessary, enter your WebLogic username and password, and then click OK.

    You see the Administration home page.

  4. Click the Component Browser link.

  5. Navigate to /atg/dynamo/security/opss/csf/CredentialStoreManager.

  6. From the Action drop-down menu, choose Create Generic Credential and then click Select.

  7. In the Map Name field, enter requestCredentialMap.

  8. Enter a key name in the Credential Key Name field, for example, key1. Use a unique key name to enter a new credential. Use an existing key name to replace the credential for that key name.

  9. Enter the new credential in the Enter Credential area. The credential can be any text, similar to a password, however it should correspond to your organization’s OPSS security platform requirements.

  10. Click Submit Credentials.

To delete an existing REST security credential:

  1. In a browser, navigate to the instance of Dynamo Server Admin that is running on the user segment server. See the previous section for detailed instructions on how to do this.

  2. Click the Component Browser link.

  3. Navigate to /atg/dynamo/security/opss/csf/CredentialStoreManager.

  4. From the Action drop-down menu, choose Delete Credential and then click Select.

  5. Select the credential you want to delete.

  6. Click Delete Credential.

Managing Credentials in the Workbench

To manage credentials in the Workbench, you use the manage_credentials script in the /credential_store/bin directory under ToolsAndFrameworks.

To add a credential to the Workbench:

  1. In a UNIX shell or command prompt, navigate to the ENDECA_TOOLS_ROOT/credential_store/bin directory, for example, /usr/local/endeca/ToolsAndFrameworks/version/credential_store/bin or C:\Endeca\ToolsAndFrameworks\version\credential_store\bin.

  2. Enter one of the following commands.

    On UNIX, enter:

    ./manage_credentials.sh add --user admin --config [path to jps-config.xml] --type generic --mapName restService --key clientCredential

    For example:

    ./manage_credentials.sh add --user admin --config $ENDECA_TOOLS_ROOT/server/workspace/credential_store/jps-config.xml --type generic --mapName restService --key clientCredential

    On Windows, enter:

    manage_credentials.bat add --user admin --config [path to jps-config.xml] --type generic --mapName restService --key clientCredential

    For example:

    manage_credentials.bat add --user admin --config %ENDECA_TOOLS_ROOT%\server\workspace\credential_store\jps-config.xml --type generic --mapName restService --key clientCredential

  3. Enter the new credential at the prompt.

  4. Re-enter the credential to confirm the addition.

  5. Follow the instructions below to restart the ToolsAndFrameworks service.

To restart the ToolsAndFrameworks service:

  1. In a UNIX shell or command prompt, navigate to the ENDECA_TOOLS_ROOT/server/bin directory, for example, /usr/local/endeca/ToolsAndFrameworks/version/server/bin or C:\Endeca\ToolsAndFrameworks\version\server\bin.

  2. Execute the shutdown script.

    On UNIX, enter:

    ./shutdown.sh

    On Windows, enter:

    shutdown.bat

  3. Execute the startup script.

    On UNIX, enter:

    ./startup.sh

    On Windows, enter:

    startup.bat

To delete a credential:

  1. In a UNIX shell or command prompt, navigate to the ENDECA_TOOLS_ROOT/credential_store/bin directory, for example, /usr/local/endeca/ToolsAndFrameworks/version/credential_store/bin or C:\Endeca\ToolsAndFrameworks\version\credential_store\bin.

  2. Enter one of the following commands.

    On UNIX, enter:

    ./manage_credentials delete --user admin --config [path to jps-config.xml] --mapName restService --key clientCredential

    For example:

    ./manage_credentials delete --user admin --config $ENDECA_TOOLS_ROOT/server/workspace/credential_store/jps-config.xml --mapName restService --key clientCredential

    On Windows, enter:

    manage_credentials.bat delete --user admin --config [path to jps-config.xml] --mapName restService --key clientCredential

    For example:

    manage_credentials.bat delete --user admin --config %ENDECA_TOOLS_ROOT%\server\workspace\credential_store\jps-config.xml --mapName restService --key clientCredential

    You are notified when the credential is successfully deleted.

Copyright © 1997, 2017 Oracle and/or its affiliates. All rights reserved. Legal Notices