Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

Administration

Quick Start

search

Please Note:

Quick Start

Use CipherTrust Batch Data Transformation (BDT) to transform your data through encryption and tokenization. This section describes how to run BDT in its simplest form, that is, performing a file-to-file transformation through encryption.

BDT supports various other transformations, but the scope of this section is limited to file encryption (file-to-file transformation) only.

Prerequisites

  • To perform tokenization, a compatible version (2.2 or higher) of Vormetric Tokenization Server (now renamed as CipherTrust Vaultless Tokenization (CT-VL)) is up and running. Refer to the CT-VL Quick Start document for details.

  • A CipherTrust Manager version compatible with the installed CT-VL/CADP for Java version is up and running. Refer to the CipherTrust Manager Getting Started document for details.

Encrypting Files

Commands to encrypt files on Linux and Windows are detailed below. Click the desired tab for details.

Installation

  1. Download the BDT distribution file. You can use wget at a terminal prompt.

    wget https://<path to download site>/bdt-x.x.x.tar.gz

  2. Create a BDT home directory at a convenient location. sudo may be required.

    cd /usr/local/bin
sudo mkdir bdt

  3. Extract the distribution to the BDT home directory.

    sudo tar -xzvf <filename.tgz> -C /usr/local/bin/bdt

  4. Add the Java bin directory path to the PATH environment variable. Edit the .bashrc file (or equivalent for other shells) for the admin user and add the following lines:

    export JAVA_HOME=/usr/lib/java/jre
export PATH=$JAVA_HOME/bin:$PATH

  5. Verify the installation by ensuring the following directory structure is created in the installation directory.

    DirectoryDescription
    binContains executable scripts for validating configuration, testing, and execution.
    confContains configuration files such as bdt.config, logging properties, bdt.properties, and bdt.mv.db (H2 database file).

    Note: H2 database is upgraded from 1.4.199 to 2.1.212 for the backup of old version file. Refer to Backup using the Script Tool and Restore from a Script for details.
    libContains required JAVA library dependencies.
    logContains log file directory.
    samplesContains sample policy and configuration files.

  6. Configure at least the following properties in the BDT properties file:

    • NAE_IP.1= CM_IP

    • NAE_Port= TCP_PORT

    • Protocol= tcp

  1. Download the BDT distribution file.

  2. Create a BDT home directory at a convenient location. You can use the File Explorer's New Folder option to create a new folder named BDT under the folder C:\Program Files, for example.

  3. Extract the distribution to the BDT home directory. Use your favorite file compression/extraction utility (winzip, pkzip, or 7zip etc).

  4. Add the Java bin directory path to the PATH environment variable:

    1. Open the Control Panel.

    2. Click System.

    3. Click Advanced System Settings.

    4. Click the Environment Variables button.

    5. Under System Variables, select Path and then click Edit.

      Note

      Do not delete any of the existing text here.

    6. Append the following to whatever you already have:

      ;C:\Program Files\BDT

    7. Click OK.

  5. Verify the installation by ensuring the following directory structure is created in the installation directory.

    DirectoryDescription
    binContains executable scripts for validating configuration, testing, and execution.
    confContains configuration files such as bdt.config, logging properties, bdt.properties, and bdt.mv.db (H2 database file).

    Note: H2 database is upgraded from 1.4.199 to 2.1.212 for the backup of old version file. Refer to Backup using the Script Tool and Restore from a Script for details.
    libContains required JAVA library dependencies.
    logContains log file directory.
    samplesContains sample policy and configuration files.

  6. Configure at least the following properties in the BDT properties file:

    • NAE_IP.1= CM_IP

    • NAE_Port= TCP_PORT

    • Protocol= tcp

File-to-File Transformation

  1. Create a user test_user and a key test_key for this user on the CipherTrust Manager.

  2. On the CipherTrust Manager, configure the NAE interface to work with No TLS, allow anonymous logins.

  3. Download and copy the QuickStartEncryptInput.csv and QuickStartEncrypt.config files to the $BDT_HOME/conf/ directory. The ContactDetails column of the QuickStartEncryptInput.csv file will get encrypted using these steps.

  4. Download and copy the QuickStartEncrypt.policy file to $BDT_HOME/samples/.

  5. Configure properties of default crypto library. Open command prompt from $BDT_HOME/bin/ and run the following command:

    bdt.sh -f

    Enter values as per the prompt messages and you are all set to run BDT.

  6. Run the following command to write encrypted NAE user test_user password in QuickStartEncrypt.config file:

    bdt.sh -e -c ../conf/QuickStartEncrypt.config

  7. Run the following command:

    bdt.sh -t -c ../conf/QuickStartEncrypt.config -p ../samples/QuickStartEncrypt.policy

  8. Check the QuickStartEncryptOutput csv file created in $BDT_HOME/conf/.

  1. Create a user test_user and a key test_key for this user on the CipherTrust Manager.

  2. On the CipherTrust Manager, configure the NAE interface to work with No TLS, allow anonymous logins.

  3. Download and copy the QuickStartEncryptInput.csv and QuickStartEncrypt.config files to the $BDT_HOME/conf/ directory. The ContactDetails column of the QuickStartEncryptInput.csv file will get encrypted using these steps.

  4. Download and copy the QuickStartEncrypt.policy file to $BDT_HOME/samples/.

  5. Configure properties of default crypto library. Open command prompt from $BDT_HOME/bin/ and run the following command:

    bdt.bat -f

    Enter values as per the prompt messages and you are all set to run BDT.

  6. Run the following command to write encrypted NAE user test_user password in QuickStartEncrypt.config file:

    bdt.bat -e -c ../conf/QuickStartEncrypt.config

  7. Run the following command:

    bdt.bat -t -c ../conf/QuickStartEncrypt.config -p ../samples/QuickStartEncrypt.policy

  8. Check the QuickStartEncryptOutput csv file created in $BDT_HOME/conf/.

Tip

Your demo of the file-to-file transformation using encryption is complete. Now, you can explore all the supported transformations and the transformation process. Also, you can explore the tasks that you can perform using BDT, advanced topics, samples, best practices, and troubleshooting information. Use the left pane to navigate to the desired sections.

On this page