Task Factory PGP

PGP Task 

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

Encrypting

Encrypting a File

Task Factory PGP Task Encrypt File

Select the source file to be encrypted

OptionDescription
File location is stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if File location is stored in a variable is selected.
Source file contains a signatureWith 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 encryptionThis option removes the source file after the encryption process is finished.

Select the destination of the encrypted file

OptionDescription
Destination location is stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Destination location is stored in a variable is selected.
Overwrite the file if it already existsSelecting 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 / textSelect 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

OptionDescription
Public key ring location is store in variableSelecting 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 ManagerAvailable 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 VariableAvailable if Public key ring location is stored in variable is selected.
Select the public keys you want to use to encrypt this fileThis 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.

Task Factory Generate Keys

Decrypting

Decrypting a File

Task Factory PGP Task Decrypt File

Select the source file to be decrypted

OptionDescription
Is the source file location stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the source file location stored in a variable is selected.

Select the destination of the decrypted file

OptionDescription
Is the destination file location stored in a variableAvailable 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 ManagerAvailable 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 VariableAvailable if Is the destination file location stored in a variable is selected.
Do you want to overwrite the destination file if already existsSelecting 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

OptionDescription
Is the private key ring file location stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the private key ring location stored in variable is selected.
Private key passwordThis is the password associated with the private key selected.

Verify file signature

OptionDescription
Verify file signatureSelecting 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 variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the public key ring location stored in variable is selected.
Create Signature File

Create Signature File

Task Factory PGP Task Create Signature File

Select the source file to be signed

OptionDescription
Is the source file location stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the source file location stored in a variable is selected.

Select the destination of the signed file

OptionDescription
Is the destination file location stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the destination file location stored in a variable is selected.
Do you want to overwrite the destination file if already existsSelecting 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 fileSelecting 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:

  1. Create the signature file, with the Include file contents... check box selected.
  2. 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 / textThis 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

OptionDescription
Is the private key ring file location stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the private key ring location stored in variable is selected.
Select private keySelect a private key from the key ring.
Private key passwordThis is the password associated with the private key selected.
Verify Signature File

Verify Signature File

Task Factory PGP Task Verify Signature File

Select the source file to be verified

OptionDescription
Is the source file location stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the source file location stored in a variable is selected.

Select the signature file

OptionDescription
Is the signature file location stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the signature file location stored in a variable is selected.

Select public key ring to verify signature

OptionDescription
Is the public key file location stored in a variableSelecting 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 ManagerAvailable 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 VariableAvailable if Is the public key file location stored in a variable is selected.

Select a variable to hold the result of the verification

OptionDescription
Select variableSelect the variable that contains the result of the verification. The variable either contains true or false.