AES Encrypt

You can use this Snap to encrypt the binary documents that it receives on its input view using the AES algorithm and user-specified encryption parameters.
Note: The default security in the JRE limits the key length for encryption keys. For stronger encryption keys, you would need to manually install the Java Cryptographic Extension JARs on your JCC nodes.


Prerequisites

  • A valid account with the required permissions.

Snap views

View Description Examples of upstream and downstream Snaps
Input (binary) The AES Encrypt Snap accepts binary documents through its single input view. These are the documents that will be encrypted using the AES algorithm.
Output (binary) The AES Encrypt Snap outputs the encrypted binary documents through its single output view. The documents are encrypted using the AES algorithm with the user-specified encryption parameters configured in the Snap.
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Legend:
  • Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: AES Encrypt

Example: AES Encrypt
Password String Specify the string used to generate a secret key and an initialization vector.
Note:

  • If Password is set, the Secret key is ignored.

  • This field is currently not encrypted at rest and is saved and exported in plaintext. For any shareable secrets that require encryption at rest, we recommend you use a Secret key in the Symmetric Crypto Account . Using a Symmetric Crypto Account ensures that your sensitive information is protected and secure.

Default value: N/A

Example: K1qjoeFQTr
Secret key String Specify the secret key to use for encryption.
Note:

  • If Password is set, the Secret key is ignored.

  • This field is currently not encrypted at rest and is saved and exported in plaintext. For any shareable secrets that require encryption at rest, we recommend you use a Secret key in the Symmetric Crypto Account . Using a Symmetric Crypto Account ensures that your sensitive information is protected and secure.

Default value: N/A

Example: VsWLDQMvz9LaCaB3aaDHBw==
Initialization vector String Specify the initialization vector used for encryption. It should be in hexadecimal format, and is not used in ECB mode.

Default value: N/A

Example: 6df68cdf3a6c48b2fde727541f3cecc
Cipher mode Dropdown list Select the mode of operation for a block cipher.

The available options include: ECB, CBC, PCBC, CTR, CTS, CFB, CFB8, CFB16, CFB24, CFB32, CFB40, CFB48, CFB56, CFB64, CFB72, CFB80, CFB88, CFB96, CFB104, CFB112, CFB120, CFB128, OFB, OFB8, OFB16, OFB24, OFB32, OFB40, OFB48, OFB56, OFB64, OFB72, OFB80, OFB88, OFB96, OFB104, OFB112, OFB120, OFB128.

Default value: ECB

Example: CFBB
Encryption padding Dropdown list Select the encryption padding. The available options include: PKCS5PADDING, ISO10126PADDING, NOPADDING.

Default value: PKCS5PADDING

Example: NOPADDING
Snap execution Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Execute only

Example: Validate & Execute