Versions Compared

Key

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

...

Overview

You can use this Snap to Decrypt decrypt fields in input documents Using using the Passphrase Account with Selected Algorithmthe selected algorithm.

...

Snap Type

The Decrypt Field is a Transform-Type Snap that decrypts the fields in the input documents.

...

Field Name

Field Type

Description

Label*

Default ValueDecrypt Field
ExampleDecrypt_Field

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.

 

Fields to decrypt

Default Value: None
Example: $msg, $num

String

Specify the table for JSON-path expressions to decrypt. Use the suggest button to select the field to decrypt.

Advanced Options

Use this fieldset to specify the key when no account is selected.

Key

Default Value: None
Example: $key

String

Specify the JSON-path expression to be evaluated with input documents or pipeline parameters to the base64 or PEM-encoded key. Do not copy-and-paste directly to the property.

For a sample pipeline using X.509 certificate, refer to this Pipeline. You can also download this Pipeline from the Downloads section below.

Transform type

Default Value: auto
Example:

  • AES/GCM/NoPadding

  • DES/CBC/PKCS5Padding

String/Expression/Suggestion

Specify the cryptographic transformation the Snap needs to perform. The transform type is expressed as algorithm/mode/padding.
When set to auto the transformation will be automatically selected based on the type of encryption key using the following table:

Use the suggestion button to select a desired transformation type. When set to auto, the transformation is automatically selected based on the type of encryption key using the following table:

Initialization vector

Default: N/A
Example: $iv

String/Expression

Specify the base64-encoded initialization vector.

Output type

Default: N/A
Example: String

 

String/Expression/Suggestion

Specify either of the following output types you want the Snap to produce:

  • String

  • Document

Key salt

Default: N/A
Example: $key_params.passphrase.keys_salt

String/Expression

Specify the salt used in generating the key.

  • The salt is the data you incorporate in the passphrase to generate the encryption key in order to improve the security of the passphrase or key.

  • If no salt is provided to the Decrypt Field Snap, none will be used.

Key generation algorithm

Default: N/A
Example: $key_params.passphrase.key_gen_algorithm

String/Expression

Specify the algorithm to use to generate the encryption key.

Key generation iterations

Default: N/A
Example: $key_params.passphrase.key_gen_iterations

String/Expression

Specify the number of iterations to run when generating the encryption key.

Snap Execution

Default ValueValidate & 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.

...

In this pipeline, the JSON Generator Snap, passes the values to the Encrypt Field Snap that provides the fields to be encrypted. The Upstream Mapper Snap maps the values to be decrypted to the Decrypt Field Snap.

...

The JSON Generator Snap passes the values to the Encrypt Field Snap. Note that the key value is also provided.

...

The Encrypt Field Snap provides the values to be encrypted. The key value $key is passed via the input document.

The output preview from the Encrypt Field Snap:

The Mapper Snap maps the values including the key value to the Decrypt Field Snap.

The Decrypt Field Snap decrypts the provided fields.

The output preview from the Decrypt Field Snap:

...