Migrating from Triple DES to AES-128 encryption

Upgrade your default WebSphere Commerce database encryption to a stronger standard to reduce the chances of a successful brute force attack.

WebSphere Commerce DeveloperWebSphere Commerce Version 8.0.3.0 or laterFor WebSphere Commerce Developer environments on Mod Pack 3 or later, see Migrating from Triple DES to AES-128 encryption on Mod Pack 3 or later.

About this task

By default, the WebSphere Commerce database is encrypted using a Triple Data Encryption algorithm Standard (Triple DES) encryption algorithm. This standard was implemented at a time when a smaller cipher size was considered safe. While still considered a relevant industry standard, Triple DES has since been superseded with a stronger standard known as Advanced Encryption Standard (AES). With a stronger cipher standard, AES is less susceptible to brute force attacks that have become feasible with the continual improvements in computational power over the years.

Upgrading to AES-128 is part of updating to NIST SP 800-131A security standards. Consider NIST SP 800-131A for more enhancements to site security. See, Updating to NIST SP 800-131A security standards.

Procedure
  1. Migrate encrypted data in the database to use AES 128-bit encryption. To complete this migration, you must run MigrateEncryptedInfo by using the Key Locator Framework (-k) to specify the new AES merchant key. Add the algorithm="AES" attribute to the new key definition in the custom key configuration file. Use 32 hex characters (128 bits) for the new key and optional key encryption key values.
    Note: Switching to an AES merchant key can result in temporary session cookie decryption errors for any existing sessions that were created before you upgrade to the AES merchant key.
    1. Specify that the new key in the keys configuration file is using AES algorithm by adding algorithm="AES" attribute to the new key definition in the custom keys configuration file. For example, create or update the WC_eardir/xml/config/CustomKeys.xml file to have a new key definition similar to the following example.
      <key name="MerchantKey" providerName="WC" status="new" 
      className="com.ibm.commerce.security.keys.WCExternalFileMerchantKeyImpl" version="2" algorithm="AES">
      <config name="keyFile" value="merchantKey.xml"/>
      <config name="keyEncryptionKeyFile" value="KeyEncryptionKey.xml"/>
      <config name="newKeyFile1" value="newMerchantKey1.xml"/>
      <config name="newKeyFile2" value="newMerchantKey2.xml"/>
      </key>

      For more information about the Key Locator Framework, see Key Locator Framework (KLF).

    2. Ensure that the new keys files combine to form 32 hex characters.
    3. Ensure that the key encryption key, if specified, is also 32 hex characters.
    4. Open a command prompt and go to the following directory:
    5. Run the MigrateEncryptedInfo utility for each instance, with the Key Locator Framework (-k) option:
  2. Update the Business Audit Key that is defined in BusinessAuditDataCapture.xml so it can be used with AES. The default audit key is an encrypted 16 character audit key. To encrypt with AES, the key must be replaced by the encrypted value of a new default 32 character audit key.
    1. Go to the following directory:
    2. Open BusinessAuditDataCapture.xml for editing.
    3. Optional: If you modified the default audit key to a custom value, rename the original AuditKey to CustomAuditKey. The CustomAuditKey node must be defined to continue validating existing records/signatures in the database.
      1. Search for the default audit key value: <AuditKey value="rZ15ws0ely9yHk3zCs3sTMv/ho8fY17s" />
      2. If the value matches your search, then you do not have to rename to CustomAuditKey. Continue to 2.d.
      3. If the value does not match your search, copy the <AuditKey> node.
      4. Paste the node into the file.
      5. For the node that you pasted, replace the word "AuditKey" with "CustomAuditKey".
    4. Update the <AuditKey> node with the following 32 character audit key:
      <AuditKey value="Jmz6ON1Y+573xkNVuOPbfRhZLEJTcW0kqgbCVJv4Jv7UlAGSVFHw6g=="/>
    5. Save and close the file.
    6. Deploy this file for each instance. For steps on how to deploy a single file, see Deploying J2EE assets for a single file.
  3. Update the instance configuration file, for each instance, to include the AES_DB="true" parameter.
    1. In a text editor, open the WebSphere Commerce configuration file for the instance:
    2. In the configuration file, search for the parameter AES_DB. If the parameter does not exist, add the parameter.
      Example
      <config>
         <InstanceProperties name="Instance Properties">
      		...	
        <Security AES_DB="true"
                  AdminPwd="0gYsW5onfbvbp7Q3MYrc917pU0EFWcJPgwsgCjE/Btg="
                  AdminUser="configadmin" AuthMode="" Realm="" RunAsID=""
                  RunAsPwd="" enabled="false" enabledGlobal="true" passwordpolicy="true"/>
      		...
          </InstanceProperties>
          ...
      </config>
      If the parameter exists, ensure that the value is set to "true".
    3. Save and close the file.
    4. If your site uses a clustered environment, you must manually sync the nodes by using the deployment manager for the changes to take effect.
    5. AIXLinuxFor IBM i OS operating systemWindowsPropagate the changes that are made to the WebSphere Commerce configuration file. For steps on how to propagate changes, see Propagating changes to the WebSphere Commerce configuration file.
  4. AIXLinuxFor IBM i OS operating systemWindowsUpdate product.xml to include the AES_DB="true" parameter.
    1. Open WC_installdir\xml\product.xml
    2. Search for the parameter, AES_DB. If the parameter does not exist, add the parameter. For example:
      <websphere>
      	<commercesuite>
      		...
      		<security>
      			<AES_DB>true</AES_DB>
      		</security>
      	</commercesuite>
      </websphere>
      If the parameter exists, ensure that the value is set to "true".
  5. Restart the server.
  6. Run the MigrateEncryptedFiles utility. For the utility to complete successfully, ensure that the WebSphere Application Server is continuously up and running during the process.
    1. In a command prompt, go to the following directory:
    2. Run the following command:
      • AIXLinuxFor IBM i OS operating systemMigrateEncryptedFiles.sh
      • WindowsMigrateEncryptedFiles.bat
      • WebSphere Commerce DeveloperMigrateEncryptedFiles.bat
      To verify that the utility ran successfully, in each of the wc-server.xml or product.xml files that you updated in step 3 and step 4, ensure that the AES_FILES parameter is set to "true".
  7. Restart the WebSphere Application Server.
  8. Enable AES on the Search server:
    1. Set the following namespace bindings in the WebSphere Application Server for each Search machine.
      1. In the WebSphere Commerce Search server WebSphere Application Server administrative console, go to Environments > Naming > Name space bindings > scope:Node=demo_search_node,Server=solrServer.
      2. Add the following name-value pair.
        Table 1.
        Name Value
        com.ibm.commerce.foundation.server.services.search.aes.files true
      3. Update the following name-value pair.
        Table 2.
        Name Value
        com.ibm.commerce.foundation.server.services.commerce.integration.sessionkey The sessionKey value from the WebSphere Commerce wc-server.xml file.
      4. Required if application security is enabled on the Search server:
        1. Set the following namespace binding in WebSphere Application Server for each WebSphere Commerce Authoring and Production machine:In the WebSphere Commerce server WebSphere Application Server administrative console, go to Environments > Naming > Name space bindings > scope:Node=WC_demo_node,Server=server1.
        2. Update the following name-value pair.
          Table 3.
          Name Value
          com.ibm.commerce.foundation.server.services.search.application.security.password The Search server's application security password, encrypted by thewcs_encrypt utility in WebSphere Commerce. You do not need to specify the merchant key because WebSphere Commerce and Search are now using AES protocol.

          For more information, see Generate encrypted data (wcs_encrypt).

        3. Set the following namespace binding in WebSphere Application Server for each Search Production and Repeater machine. In the Search server WebSphere Application Server administrative console, go to Environments > Naming > Name space bindings > scope:Node=demo_search_node,Server=solrServer.
    2. This step is only required if you are using the Commerce Insights BAC SFTP Server password (used by Commerce Insights Product Sequencing), and assuming that WebSphere Commerce is already using AES for its files.
      1. Edit or create the file Search_eardir/xml/config/com.ibm.commerce.foundation/wc-component.xml.
      2. Set the property <_config:property name="BACSFTPServerSetting/userPassword" value="" /> by running the wcs_encrypt utility (without the merchant key) from the WC_install/bin directory.
      3. Set the AES flags to true in under Search_eardir/xml/config/com.ibm.commerce.foundation/wc-component.xml:
        <_config:property name="CommerceServerSetting/Security/AESDBEnabled" value="true"/> 
        <_config:property name="CommerceServerSetting/Security/AESFilesEnabled" value="true"/>
      4. Restart the servers that were updated above.
  9. Edit the file Search_eardir/xml/config/com.ibm.commerce.foundation/wc-component.xml. Set the AES flags in the file to true.
    <_config:property name="CommerceServerSetting/Security/AESDBEnabled" value="true"/> 
    <_config:property name="CommerceServerSetting/Security/AESFilesEnabled" value="true"/>
  10. Restart the search server.