PGP

Parent Previous Next


PGP Task


The "PGP Task" can be used to encrypt or decrypt a file using PGP encryption. It is also used to create and verify a signature of a file.



  Select the source file to be encrypted

o   File location is stored in a variable - Checking this option will change 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.

o  Select Connection Manager - Available if "File location is stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "File location is stored in a variable" is checked.

o  Source file contains a signature - With the PGP Task it is possible to create a file with a signature that is part of the file. Choose this option if the task will encrypt a file with a signature

o  Remove source file after encryption - This option will remove the source file after the encryption process is finished.

 Select the destination of the encrypted file

o   Destination location is stored in a variable - Checking this option will change 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.

o  Select Connection Manager -  Available if "Destination location is stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "Destination location is stored in a variable" is checked.

o  Overwrite the file if it already exists - Checking this option will overwrite the destination file if it already exists. If the files exists and this option is not selected then the task will fail.

o  Save the file as ASCII / text - Check this option if the task will encrypt text and the text needs to be transmitted in an email or read by another text decryption program.

o  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

o   Public key ring location is store in variable - Checking this option will change 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.

o   Select Connection Manager -  Available if "Public key ring location is stored in variable" is not checked. Here the user will select or create a connection manager that points to the source file

o   Select Variable - Available if "Public key ring location is stored in variable" is checked.

o   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 will be displayed. 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 will be generated elsewhere but this is a god 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 click "Generate Keys".



Decrypting a File


  Select the source file to be decrypted

o   Is the source file location stored in a variable - Checking this option will change 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.

o  Select Connection Manager - Available if "Is the source file location stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "Is the source file location stored in a variable" is checked.

 Select the destination of the decrypted file

o   Is the destination file location stored in a variable  - Available if "Is the destination location is stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Connection Manager - Available if "Is the destination file location stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "Is the destination file location stored in a variable" is checked.

o  Do you want to overwrite the destination file if already exists - Checking this option will overwrite the destination file if the file already exists. If the file exists and this option is not selected then the task will fail.

 Select private key to decrypt the file

o   Is the private key ring file location stored in a variable - Checking this option will change 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.

o  Select Connection Manager -  Available if "Is the private key ring location stored in variable" is not checked. Here the user will select or create a connection manager that points to the source file

o   Select Variable - Available if "Is the private key ring location stored in variable" is checked.

o  Private key password - This is the password associated with the private key selected.

 Verify file signature

o  Verify file signature - Checking this option will cause the task to look for an embedded file signature and verify it was signed using the public key ring selected

o  Is public key ring file location stored in a variable - Checking this option will change 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.

o  Select Connection Manager - Available if "Is the public key ring location stored in variable" is not checked. Here the user will select or create a connection manager that points to the source file

o  Select Variable - Available if "Is the public key ring location stored in variable" is checked


Create Signature File


  Select the source file to be signed

o   Is the source file location stored in a variable - Checking this option will change 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.

o  Select Connection Manager - Available if "Is the source file location stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "Is the source file location stored in a variable" is checked

  Select the destination of the signed file

o  Is the destination file location stored in a variable  - Checking this option will change 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

o  Select Connection Manager - Available if "Is the destination file location stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "Is the destination file location stored in a variable" is checked.

o  Do you want to overwrite the destination file if already exists - Checking this option will overwrite the destination file if the file already exists. If the file exists and this option is not selected then the task will fail.

o  Include file contents from the source in the signature file - Checking this option will 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 checked.

o  Do you want the destination file saved as ASCII / text  - This option will save 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

o  Is the private key ring file location stored in a variable - Checking this option will change 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.

o  Select Connection Manager -  Available if "Is the private key ring location stored in variable" is not checked. Here the user will select or create a connection manager that points to the source file

o  Select Variable - Available if "Is the private key ring location stored in variable" is checked.

o  Select private key - Select a private key from the key ring

o  Private key password - This is the password associated with the private key selected.


Verify Signature File


  Select the source file to be verified

o   Is the source file location stored in a variable - Checking this option will change 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.

o  Select Connection Manager - Available if "Is the source file location stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "Is the source file location stored in a variable" is checked

 Select the signature file

o   Is the signature file location stored in a variable - Checking this option will change 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.

o  Select Connection Manager - Available if "Is the signature file location stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "Is the signature file location stored in a variable" is checked

 Select public key ring to verify signature

o   Is the public key file location stored in a variable - Checking this option will change 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.

o  Select Connection Manager - Available if "Is the public key file location stored in a variable" is not checked. Here the user will select or create a connection manager that points to the source file.

o  Select Variable - Available if "Is the public key file location stored in a variable" is checked

 Select a variable to hold the result of the verification

o   Select variable - Select the variable that will contain the result of the verification. The variable will either contain true or false.


Encrypt / Decrypt Tutorial


Create / Verify Signature Tutorial