PGP Module
- 06 Oct 2022
- 2 Minutes to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
PGP Module
- Updated on 06 Oct 2022
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The PGP Module provides Flows steps that can be used to encrypt, decrypt sign or verify messages or files through PGP. The module cannot be used to generate PGP public or private keys. These keys will need to be generated outside of Decisions, using other third party systems.
Prerequisites
- Installation of the PGP module.
- General knowledge of PGP
- A generated public and private PGP key,
- Public Key: locks the message and converts the key into an encrypted file.
- Private Key: Unlocks the encrypted file key and converts the message back into plain text.
Example PGP Encryption/Decryption
PGP Steps
Clear Sign File
The Clear Sign File step allows users to sign a file using a private key digitally but keeps the file contents in plain text.
| Input Parameter | Description |
|---|---|
| Algorithm | Algorithm parameter to use. Uses Constant options of MD5, Sha1, RipeMD160, DoubleSha, MD2, Tiger192, and Havel5pass160. |
| Data | File to be signed |
| Output File Name | Filename to use after the file is completed |
| Private Key | Generated key for encrypting or decrypting a file |
| Private Key Password | Password for the private key |
Decrypt File
This Decrypt File step takes in the encrypted file output and uses the private key password to unlock the private key. The Decrypt File step then uses the private key to decrypt the encrypted file.
| Input Parameter | Description |
|---|---|
| File | Encrypted file output |
| Private Key | Generated key for encrypting or decrypting a file |
| Private Key Password | Password for the private key |
Decrypt String
The Decrypt String step takes in the data from the Encrypted String output and uses the private Key Password to unlock the private key string. After the private key is unlocked, the message is decrypted into a string using plain text.
| Input Parameter | Description |
|---|---|
| Data | Encrypted String output |
| Private Key Password | Password for the private key |
| Private Key String | String value of the private key |
Encrypt File
The Encrypt File step takes in data contents and encrypts the message.
| Input Parameters | Description |
|---|---|
| Binary | State whether the input file is a binary type |
| Data | File data to be encrypted |
| Internal File Name | The filename of the file when decrypting the file |
| Output File Name | The filename of the file after being encrypted |
| Public Key | The public key used to encrypt file |
Encrypt String
The Encrypt String step takes in data and encrypts the data into a string with a public Key String. It allows a user to view the Public Key String in plain text.
| Input Parameter | Description |
|---|---|
| Data | String value to encrypt |
| Public Key String | String value of public key |
Sign and Encrypt File
The Sign and Encrypt File step uses a private key to digitally sign a file and a public key to encrypt it.
| Input Parameter | Description |
|---|---|
| Algorithm | Algorithm parameter to use. Uses Constant options of MD5, Sha1, RipeMD160, DoubleSha, MD2, Tiger192, and Havel5pass160. |
| Binary | State whether the input file is a binary type |
| Data | String value to encrypt |
| Internal File Label | File label |
| Output File Name | Name for file after sign and encryption |
| Private Key | Generated key for encrypting or decrypting a file |
| Private Key Password | Password for the private key |
| Public Key | Public key used to encrypt file |
| With Integrity Check | Perform an integrity check on file |
Sign File Step
The Sign File step uses a private key to digitally sign a file. This Step outputs a signed text file and then a Decrypt File step is needed to decrypt and read the file.
| Input Parameter | Descriptions |
|---|---|
| Algorithm | Algorithm parameter to use. Uses Constant options of MD5, Sha1, RipeMD160, DoubleSha, MD2, Tiger192, and Havel5pass160. |
| Binary | State whether the input file is a binary type |
| Data | String value to encrypt |
| Internal File Label | File label |
| Output File Name | Name for file after signing |
| Private Key | Generated key for encrypting or decrypting a file |
| Private Key Password | Password for the private key |
Verify File
The Verify File step takes in the output data and then uses the public key to verify that the digital signature is authentic.
| Input Parameter | Description |
|---|---|
| Data | Output contents of Sign FIle step |
| Sender Public Key | Sender public key file |
Was this article helpful?
