AES Encryption¶

Introduction¶

The AES Encryption plugin encrypts and decrypts using the AES algorithm.

This plugin can be associated only with Private Agent Groups and is not available on the Jitterbit Cloud Agent Groups.

Important

Plugins provided by Jitterbit are deprecated. See Deprecation and Support in Plugins.

Download and Add the Plugin¶

The AES Encryption plugin is a standard Jitterbit plugin that is already available in the Management Console Plugins page and does not need to be downloaded or added to the organization.

If directed by Jitterbit Support, this plugin can be downloaded at the link provided below and added to the organization (see Add New Plugins in Customizations > Plug-ins).

AES Encryption v1.1.0 (.ZIP)

Associate the Plugin with an Agent Group¶

The AES Encryption plugin must be associated with a Private Agent Group to make the plugin available on all agents in the group (see Associate Agent Groups in Customizations > Plug-ins).

The plugin is listed in the Management Console Plugins page with a display name of Jitterbit AES Encryption.

Set Variables and Use the Plugin in a Project¶

Refer to these topics for information about using plugins in a project:

Plugins (Cloud Studio)
Plugins (Design Studio)

The plugin can be used for decrypting encrypted source files, encrypting target files, or encrypting or decrypting variables in a script.

When used from a script, the variable Jitterbit.AES.Action should be set to either "encrypt" or "decrypt"; the variable Jitterbit.AES.Input holds the input data to encrypt or decrypt (see below for details); and the result of the plugin is stored in the output variable Jitterbit.AES.Output. When encrypting a clear text value from a script, the output will be a string representation of the base64-encoded encrypted bytes.

The AES Encryption plugin uses these variables:

Name	Type	Required	Description
`Jitterbit.AES.Passphrase`	String	Required	Pass-phrase to use for encryption/decryption.
`Jitterbit.AES.KeyLength`	Integer	Required	The length of the passphrase-generated key. Must be one of 128, 196, or 256.
`Jitterbit.AES.PBEGenerator`	String	Required	The type of PBE key generator to use. Supported values are PKCS5S2 and OpenSSL.
`Jitterbit.AES.Salt`	String	Optional	An optional salt for the key generation. This should be a series of bytes, in hex-string format. For example, the salt {0x10, 0xF5, 0x5B, 0x70, 0x3D, 0xA8, 0x19, 0xE0} would be represented by the string "10F55B703DA819E0".
`Jitterbit.AES.IterationCount`	Integer	Optional	The iteration count for the key generation. This value is ignored if PBEGenerator is OpenSSL (which always uses a fixed iteration count of 1).
`Jitterbit.AES.Action`	String	Optional	Used when encrypting or decrypting a value from a script. The variable value should be set to "encrypt" when encrypting, or "decrypt" when decrypting.
`Jitterbit.AES.Input`	String	Optional	Holds the value to encrypt or decrypt when this plugin is called from a script. When encrypting, this variable should hold the clear text string to encrypt. When decrypting, this value should be a string containing the base64-encoded form of the encrypted data.