Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Transform


Description:

Pretty Good Privacy (PGP) is an encryption/decryption program that provides cryptographic privacy and authentication for data communication. PGP is popularly used to digitally sign, encrypt or decrypt email messages or files being transferred over the Internet.

Note
The default security in the JRE limits the key length for encryption keys. For stronger encryption keys, you would need to manually install the Java Cryptographic Extension JARs on your JCC nodes.

This Snap decrypts PGP-encrypted data provided as an input stream using the private key and passphrase.  This Snap should be attached to the input binary data stream to be decrypted in the pipeline. 

  • Expected upstream Snaps: Any Snap, such as PGP Encrypt, that produces PGP encrypted data in the output view.
  • Expected downstream Snaps: Any Snap, such as File Writer or JSON Parser, that accepts decrypted data in the input view.
  • Expected input: Stream of PGP encrypted data.
  • Expected output: Stream of PGP decrypted data.
Prerequisites:

[None]


Support and limitations:Ultra Pipelines: 

Works in Ultra Pipelines.

  • Spark mode: Not supported in Spark mode.
  • Account: 

    This Snap uses account references created on the Accounts page of SnapLogic Manager called PGP Private Key Account that stores the private key and pass phrase used for decryption. See Configuring Binary Accounts for information on setting up this type of account. 

    When setting up the account, enter your private PGP key and your PGP passphrase. The credentials setup will automatically decrypt the PGP-encrypted message.


    Views:


    Input

    This Snap has exactly one binary input view. The data that has to be decrypted is passed through this view.
    Note: The decryption action is taken on files that end with a "pgp" the file extension. The input files to be decrypted must be presented as .pgp files.

    OutputThis Snap has exactly one binary output view.  The decrypted data is passed through this view as output.
    ErrorThis Snap has at most one document error view and produces zero or more documents in the view.  If you supply the proper PGP private key and passphrase/password, then you will be able to read the decrypted message, otherwise you will see an error message the indicating unable to decrypt the message.


    Settings

    Label


    Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

    Is signed file?


    Select this option to specify if the selected file is a signed file.

    Multiexcerpt include macro
    nameSnap Execution
    pageAnaplan Read


    Multiexcerpt include macro
    nameSnap_Execution_Introduced
    pageAnaplan Read


    Examples


    The following example includes: Sample input data which is successfully encrypted using the PGP Encrypt Snap and then decrypted using the PGP Decrypt Snap.

    Encrypting Data Using the PGP Encrypt Snap 

    We will start with a JSON Generator Snap which has a sample message "Hello World", which is formatted and written as JSON binary data for the PGP Encrypt Snap to ingest.

    We can see that the Message is Encrypted as the output of the PGP Encrypt Snap.

    Decrypting Data Using the PGP Decrypt Snap

    We will write the file out as File_encrypt.pgp to the SnapLogic DB. Then we proceed to decrypt the encrypted file and write it to the SnapLogic DB as File_decrypt.txt.
    We can see that the output from the Decrypt Snap matches our original raw unencrypted data: 

    We have successfully decrypted the message.

    Download the sample pipeline.

    Attachments

    Attachments
    uploadfalse
    oldfalse
    patterns*.slp, *.zip

    Insert excerpt
    Binary Snap Pack
    Binary Snap Pack
    nopaneltrue