Overview

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.

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.

Snap Type

AES Encrypt Snap is a TRANSFORM-type Snap.

Prerequisites

A valid account with the required permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations and Known Issues

None.

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Input

Binary

Min: 1
Max: 1

File Reader
Compress

Output

Binary

Min: 1
Max: 1

File Writer
Decompress

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 while 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 the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the 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

Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.

Field Name	Field Type	Description

Field Name	Field Type	Description
Label Default Value: AES Encrypt Example: AES Encrypt	String	Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.
Password Default Value: N/A Example: K1qjoeFQTr	String	Specify the string used to generate a secret key and an initialization vector. 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.
Secret key Default Value: N/A Example:VsWLDQMvz9LaCaB3aaDHBw==	String	Specify the secret key to use for encryption. 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.
Initialization vector Default Value: N/A Example: 6df68cdf3a6c48b2fde727541f3cecc	String	Specify the initialization vector used for encryption. It should be in hexadecimal format, and is not used in ECB mode.
Cipher mode* Default Value: ECB Example: CFB8	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.
Encryption padding* Default Value:PKCS5PADDING Example:NOPADDING	Dropdown list	Select the encryption padding. The available options include: PKCS5PADDING, ISO10126PADDING, NOPADDING.
Snap Execution Default Value: Validate & Execute Example: Execute only	Dropdown list	Select one of the following three modes in which the Snap executes: 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.