PGP Decryption¶

Introduction¶

The PGP Decryption plugin decrypts source files encrypted with PGP.

This plugin is available by default on Jitterbit Cloud Agent Groups and can also be associated with Private Agent Groups.

Important

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

Download and Add the Plugin¶

The PGP Decryption 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).

PGP Decrypt 3.0 (.ZIP)

Associate the Plugin with an Agent Group¶

The PGP Decryption plugin is associated with Jitterbit Cloud Agent Groups by default.

If using a Private Agent Group, before you can use the plugin you must associate it with the 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 PGP Decryption.

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 PGP Decryption plugin uses these variables:

Name	Type	Required	Description
`Jitterbit.PGP.PrivateKeyData`	String	Optional	The ASCII representation of the private key. Alternatively, place the private key file directly on the Private Agent itself and set the variable `Jitterbit.PGP.PrivateKeyFile` to the path of the file.
`Jitterbit.PGP.PrivateKeyFile`	String	Optional	The path to the private key file, in the case where the private key file is stored on the Private Agent. The file must be readable by the user that runs the agent (more specifically the Jitterbit Process Engine). Alternatively, pass in the ASCII representation of the key itself in the variable `Jitterbit.PGP.PrivateKeyData`.
`Jitterbit.PGP.Passphrase`	String	Required	The passphrase with which the private key has been encrypted.
`Jitterbit.PGP.KeyDataForVerification`	String	Optional	If the message has been signed as well as encrypted, this variable should hold the ASCII representation of the key that will be used for verifying the message signature. This is typically the public key file of the message sender. The file must be placed on the Private Agent itself, and must be readable by the user that runs the agent (more specifically the Jitterbit Process Engine). Alternatively, place the key file directly on the Private Agent and set the path to the file in the variable `Jitterbit.PGP.KeyFileForVerification`. If neither of these variables is set, the message signature will not be verified, even if the message is signed.
`Jitterbit.PGP.KeyFileForVerification`	String	Optional	If the message has been signed as well as encrypted, this variable should point to a key file containing the key that will be used for verifying the message signature. This is typically the public key file of the message sender. The file must be placed on the Private Agent itself, and must be readable by the user that runs the agent (more specifically the Jitterbit Process Engine). Alternatively, pass in the ASCII representation of the key itself in the variable `Jitterbit.PGP.KeyDataForVerification`. If neither of these variables is set, the message signature will not be verified, even if the message is signed.
`Jitterbit.PGP.WriteLog`	Boolean	Optional	Turns plugin logging on or off. Logging is turned off by default; set this variable to `true` to turn on logging. The log messages are written to the file `jitterbit.plugin.pgp.decrypt.log` in the folder `[JITTERBIT_HOME]/log/plugin/`.