Task Factory PGP

PGP Task 

Task Icon	Task Description
	The PGP Task can be used to encrypt or decrypt a file using PGP encryption. It's also used to create and verify the signature of a file.

Encrypting a File

Select the source file to be encrypted

Option	Description
File location is stored in a variable	Selecting this option changes the Select Connection Manager drop-down menu to a drop-down containing the string variables in the SSIS package. The location of the source file must be stored in the variable selected.
Select Connection Manager	Available if File location is stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if File location is stored in a variable is selected.
Source file contains a signature	With the PGP Task it's possible to create a file with a signature that is part of the file. Choose this option if the task encrypts a file with a signature.
Remove source file after encryption	This option removes the source file after the encryption process is finished.

Select the destination of the encrypted file

Option	Description
Destination location is stored in a variable	Selecting this option changes the Select Connection Manager drop-down menu to a drop-down containing the string variables in the SSIS package. The location of the destination file must be stored in the variable selected.
Select Connection Manager	Available if Destination location is stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Destination location is stored in a variable is selected.
Overwrite the file if it already exists	Selecting this option overwrites the destination file if it already exists. If the files exists, and this option is not selected, then the task fails.
Save the file as ASCII / text	Select this option if the task encrypts text and the text needs to be transmitted in an email or read by another text decryption program.
Encrypt using PGP Version 2 (Old Format)	This option is for legacy systems that need to decrypt the file using the old format of PGP.

Select public key ring to encrypt file

Option	Description
Public key ring location is store in variable	Selecting this option changes the Select Connection Manager drop-down menu to a drop-down containing the string variables in the SSIS package. The location of the public key ring file must be stored in the variable selected.
Select Connection Manager	Available if Public key ring location is stored in variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Public key ring location is stored in variable is selected.
Select the public keys you want to use to encrypt this file	This is where the available public keys form the public key ring file display. At least one public key must be selected to encrypt the file. Multiple public keys can be used to encrypt the file.

Generate Keys Button - The PGP Task (in encryption mode) can be used to generate key rings (public and private) to be used with the PGP task. Ideally these key rings are generated elsewhere but this is a good way to test the PGP Task during development. To generate a key, simply fill out all of the data in the Key Information form and select Generate Keys.

Select the cipher

Option	Description
Cipher	Select the Cipher you want to use from the following options: Aes128 Aes192 Aes256 Blowfish Camellia128 Camellia192 Camellia256 Cast5 Des Idea Safer TripleDes Twofish

Decrypting a File

Select the source file to be decrypted

Option	Description
Is the source file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSIS package. The location of the source file must be stored in the variable selected.
Select Connection Manager	Available if Is the source file location stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the source file location stored in a variable is selected.

Select the destination of the decrypted file

Option	Description
Is the destination file location stored in a variable	Available if Is the destination location is stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Connection Manager	Available if Is the destination file location stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the destination file location stored in a variable is selected.
Do you want to overwrite the destination file if already exists	Selecting this option overwrites the destination file if the file already exists. If the file exists and this option is not selected, then the task fails.

Select private key to decrypt the file

Option	Description
Is the private key ring file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSI package. The location of the private key ring file must be stored in the variable selected.
Select Connection Manager	Available if Is the private key ring location stored in variable is not selected. Here the user selects or creates a connection manager that points to the source file
Select Variable	Available if Is the private key ring location stored in variable is selected.
Private key password	This is the password associated with the private key selected.

Verify file signature

Option	Description
Verify file signature	Selecting this option causes the task to look for an embedded file signature and verify it was signed using the public key ring selected.
Is public key ring file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSI package. The location of the private key ring file must be stored in the variable selected.
Select Connection Manager	Available if Is the public key ring location stored in variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the public key ring location stored in variable is selected.

Create Signature File

Select the source file to be signed

Option	Description
Is the source file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSIS package. The location of the source file must be stored in the variable selected.
Select Connection Manager	Available if Is the source file location stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the source file location stored in a variable is selected.

Select the destination of the signed file

Option	Description
Is the destination file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSIS package. The location of the destination file must be stored in the variable selected.
Select Connection Manager	Available if Is the destination file location stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the destination file location stored in a variable is selected.
Do you want to overwrite the destination file if already exists	Selecting this option overwrites the destination file if the file already exists. If the file exists and this option is not selected then the task fails.
Include file contents from the source in the signature file	Selecting this option include the contents of the file being signed as part of the signature file. This is part of a two step process to sign and encrypt a file: Create the signature file, with the Include file contents... check box selected. Encrypt the signed file in another PGP Task (Encryption Mode) with the Source File Contains a Signature option selected.
Do you want the destination file saved as ASCII / text	This option saves the file as a text file. Only select this if the source file being signed is a text document.

Select a private key to decrypt file

Option	Description
Is the private key ring file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSI package. The location of the private key ring file must be stored in the variable selected.
Select Connection Manager	Available if Is the private key ring location stored in variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the private key ring location stored in variable is selected.
Select private key	Select a private key from the key ring.
Private key password	This is the password associated with the private key selected.

Verify Signature File

Select the source file to be verified

Option	Description
Is the source file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSIS package. The location of the source file must be stored in the variable selected.
Select Connection Manager	Available if Is the source file location stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the source file location stored in a variable is selected.

Select the signature file

Option	Description
Is the signature file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSIS package. The location of the signature file must be stored in the variable selected.
Select Connection Manager	Available if Is the signature file location stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the signature file location stored in a variable is selected.

Select public key ring to verify signature

Option	Description
Is the public key file location stored in a variable	Selecting this option changes the Select Connection Manager drop down menu to a drop down containing the string variables in the SSIS package. The location of the signature file must be stored in the variable selected.
Select Connection Manager	Available if Is the public key file location stored in a variable is not selected. Here the user selects or creates a connection manager that points to the source file.
Select Variable	Available if Is the public key file location stored in a variable is selected.

Select a variable to hold the result of the verification

Option	Description
Select variable	Select the variable that contains the result of the verification. The variable either contains true or false.