Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents

Overview

This Snap decrypts 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.

Snap Type

AES Decrypt Snap is a TRANSFORM-type Snap that transforms the binary documents.

Prerequisites

None.

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

Input 

Document

Binary

Binary or Document


  • Min:1

  • Max:1

Any Snap that produces binary data in the output view such as File Reader or Compress.

Output

Document

Binary

Binary or Document


  • Min:1

  • Max:1

Any Snap that accepts binary data in the input view such as File Writer or 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

Field Name

Field Type

Description

Label*


Default ValueAES Decrypt
Example
AES Decrypt

String

Specify the name for the Snap. You can use a more specific label, especially if you have more than one of the same Snap in your Pipeline.

Password


Default Value:N/A
Example
K1qjoeFQTr



String

The string used to generate a secret key and an initialization vector. If Password is set, the Secret key is ignored.

 

Secret key


Default Value: N/A
Example
VsWLDQMvz9LaCaB3aaDHBw==


String

The secret key used for decryption. If Password is set, the Secret key is ignored.

 

Initialization vector


Default Value: N/A
Example
6df68cdf3a6c48b2fde727541f3cecc


String

The initialization vector used for decryption. It should be in hexadecimal format, and should not be used in ECB mode.
 

Cipher mode


Default ValueECB
Example
CFB

Dropdown list

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

Choose the encryption padding from the list. The available options include: 

  • PKCS5PADDING
  • ISO10126PADDING
  • NOPADDING

Snap Execution


Default Value: Validate & Execute
Example
: Execute only


Dropdown list

Select 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.


Insert excerpt
Binary Snap Pack
Binary Snap Pack
nopaneltrue