Cipher adapter commands

Cipher adapter commands are valid for input data sources and output data targets.

Cipher adapter command aliases

Use CIPHER as the adapter command alias on input and output cards and in GET and PUT rules. For example:
Input source override execution command -IACIPHER card_num
Output target override execution command -OACIPHER card_num

Cipher adapter commands

-MKF filename

Specifies the name of the master key file (MKF) in which to locate an existing master key or store a new master key. When the MKF contains multiple existing master keys, Integration Platform uses the last key in the MKF by default. Use the -ID option to select a different key.

This keyword is optional. If you omit it, the adapter automatically creates a new cryptographic key in the hip_install_dir\itx.mkf file on Windows systems or the hip_install_dir/configs/itx.mkf file on UNIX systems.

-ID key_ID
Specifies the ID of the cryptographic key to use to decipher encrypted data. This keyword is optional. If you omit it, the adapter uses the last key in the MKF.
-BIN
Specifies binary encryption. This keyword is optional. If you omit it, the adapter uses ASCII encryption.
-ACTION { ENCRYPT | DECRYPT }
Specifies whether to encrypt or decrypt the data. This keyword is optional on GET and PUT rules. If you omit it, Integration Platform encrypts or decrypts the data based on whether the specified file has an encryption header.
-FILE filename
Specifies the name of the file to read from or write to. This keyword is required on input cards and output cards.
-T [E | V] [+] [file_path]
The adapter trace level and full path to the adapter trace log.
-T
Log adapter informational messages.
-TE
Log only adapter errors during map execution.
-TV
Use verbose (debug) logging. The log file records all activity that occurs while the adapter is enciphering or deciphering data.
+
Appends the trace information to the existing log file. Omit this keyword to create a new log file.
file_path
The full path to the adapter trace log. If you omit this keyword, the adapter creates the m4cipher.mtr log file in the map directory.

Examples

This command enciphers data stored in Mydata text item.

= Valid(GET("CIPHER","-MKF bulk_key_multiple.mkf -ACTION encipher -T", Mydata), FAIL("Err Msg: " + LASTERRORMSG() + " Err Code: " +LASTERRORCODE()))

This command deciphers data stored in Myencrypteddata text item.

= Valid(GET("CIPHER","-MKF bulk_key.mkf -ACTION decipher -T", Myencrypteddata), FAIL("Err Msg: " + LASTERRORMSG() + " Err Code: " +LASTERRORCODE()))

On a map input card with CIPHER as the input source, the following Source > Command deciphers data in EncryptedInput.txt input file.

-FILE EncryptedInput.txt -ACTION decipher -MKF bulk_key.mkf -T