Specifying Workbench authentication credentials for the Endeca Configuration Repository

By default, Workbench authenticates itself to the Endeca Configuration Repository using the JCR repository's administrator credentials. These are the admin user credentials that you initially specify when you install Tools and Frameworks.

Workbench uses Oracle Wallet, a file-based credential store, to safely store administrator authentication credentials. The credential store is represented as cwallet.sso and is located at ToolsAndFrameworks\<version>\server\workspace\credential_store. The administrator credential in the store is composed of a user name and password that is uniquely identified by a map name and a credentials key combination. Therefore, one set of credentials containing a map name and a credentials key maps to one set of a username and a password pair. This map name and credentials key for the administrator user are stored as properties in the WorkbenchConfig.xml file.

Note

The mapName property must be set to endecaToolsAndFrameworks. 

<custom-bean id="csfManager" class="com.endeca.soleng.eac.toolkit.util.CSFManager">
      <property name="jpsConfigPath" value="C:\Endeca\ToolsAndFrameworks\11.2.0\server\workspace\credential_store\jps-config.xml" />
      <property name="mapName" value="endecaToolsAndFrameworks"/>
</custom-bean>

    <custom-component id="IFCR" host-id="ITLHost" class="com.endeca.soleng.eac.toolkit.component.IFCRComponent">
      <properties>
        <property name="repositoryUrl" value="http://@@HOST@@:@@WORKBENCH_PORT@@/ifcr" />
        <property name="numExportBackups" value="3" />
        <property name="credentialsKey" value="ifcr"/>
      </properties>
      <custom-bean ref="csfManager"/>
    </custom-component>

To specify the Workbench authentication credentials for the Endeca Configuration Repository:

  1. Change the administrator password in the Endeca Configuration Repository by submitting a POST request to http://<WorkbenchHost>:8006/ifcr/system/userManager/user/admin.changePassword.json with the following parameters:

    ParameterValue
    oldPwd The current password.
    newPwd The value for the new password.
    newPwdConfirm The value for the new password.

    The following is an example using the curl tool: 

    curl -FoldPwd=admin -FnewPwd=newpassword -FnewPwdConfirm=newpassword \
http://admin:admin@localhost:8006/ifcr/system/userManager/user/admin.changePassword.json

  2. Update the administrator credentials used by Deployment Template scripts to connect to the Endeca Configuration Repository. Workbench stores these credentials in the Oracle Wallet credentials store.

    1. Navigate to the <installation path>\ToolsAndFrameworks\<version>\credential_store\bin directory.

    2. Run the manage_credentials script using this format 

      manage_credentials.bat/sh add [--config path] [--mapName map_name] [–-user user_id] [--key key_name] [--type (password|generic)]

      Flags

      Description

      config

      Path to jps-config.xml. This file defines this instance of the credentials store. The default value is ..\..\server\workspace\credential_store\jps-config.xml.

      mapName

      Must match the mapName specified in the config\script\WorkbenchConfig.xml file. The default value is endecaToolsAndFrameworks.

      user

      The administrator user name. The default value is admin.

      key

      The key name that can be of your choosing. The value must match the credentialsKey value specified in the config\script\WorkbenchConfig.xml file.

      type

      Password is the default.

      For example, 

      manage_credentials.bat add --user admin --key ifcr

      The config, mapName, and type flags are not specified and the corresponding default values are used.

      Note

      For LDAP passphrases, only the default config and mapName can be used.

    3. Since the credential already exists, you are prompted to replace it. Enter yes.

    4. When you are prompted for your new password, enter and confirm the password that you want to use.

      The credentials store is updated with the new administrator password.

  3. Update the credentials that Workbench uses to connect to the Endeca Configuration Repository.

    1. Stop the Endeca Tools Service.

    2. Navigate to %ENDECA_TOOLS_CONF%\conf (on Windows) or $ENDECA_TOOLS_CONF\conf (on UNIX).

    3. Open the webstudio.properties file.

    4. Locate the ifcr.password property, for example: 

      # The password Workbench uses to authenticate as the admin user for the Endeca Configuration Repository
# ifcr.password=admin

    5. Uncomment the line and set the value of the property to the new password, for example: 

      ifcr.password=newpassword

    6. Save and close the webstudio.properties file.

    7. Start the Endeca Tools Service.

For further information about Sling user management, consult the Apache documentation.

Copyright © Legal Notices