PGP (Pretty Good Privacy) is a cryptography component that provides authentication and cryptographic privacy for data communication.

Take a look at the configuration parameters of the component:

  • File Name: name of the file do be compressed.

  • Zip Operation: defines the operation type, that can be "Encrypt Fields", "Decrypt Fields" , "Encrypt Payload" , "Decrypt Payload", "Encrypt File" or "Decrypt File".

  • Fields: name of the fields to be encrypted inside the JSON entry (they must be separated by comma - eg.: param1,param2).

  • Charset: charset of the text.

  • File Name: name of the file to be encrypted/decrypted.

  • Output File Name: name of the encrypted file to be generated.

  • Hexadecimal: if “true”, the value to be verified/signed must be informed in hex format; otherwise, it will be signed or verified as base64.

  • Armor: if activated, the option will encrypt the messages in ASCII so they are sent in standard format, such as email.

  • Zip: if activated, the option zips the message before it gets encrypted.

  • Fail On Error: if the option is enabled, the execution of the pipeline with error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.

Messages flow

Operation ENCRYPT FIELDS

Input

{
"parameter": "TEXT TO BE ENCRYPTED"
}

Output

{
"parameter": "AA01FF" // text encrypted
}

Operation DECRYPT FIELDS

Input

{
"parameter": "AA01FF" // text encrypted
}

Output

{
"parameter": "TEXT DECRYPTED"
}

Operation ENCRYPT PAYLOAD

Input

{
"parameter": "TEXT TO BE ENCRYPTED"
}

Output

{
"result": "AA01FF" // text encrypted
}

Operation DECRYPT PAYLOAD

Input

{
"parameter": "AA01FF" // text encrypted
}

Output

{
"result": "TEXT DECRYPTED"
}

Operation ENCRYPT FILE

Input

{
"fileName": "file.txt"
}

Output

{
"outputFileName": "file.txt.pgp" // file encrypted
}

Operation DECRYPT FILE

Input

{
"fileName": "file.txt.pgp" // file encrypted
}

Output

{
"outputFileName": "file.txt.dec" // file decrypted
}

Output with error

{ 
"error": "java.io.FileNotFoundException: data1.csv (No such file or directory)",
"success": false
}

  • success: “false” when the operation fails

  • error: information about the occurred error

Did this answer your question?