PGP tools by Workato

SUMMARY

• PGP tools by Workato enables encryption, decryption, signing, and verifying of files using AES256 and SHA256 algorithms.
• PGP encryption setup may require public, private, or both types of keys.
• Users can generate a new PGP key pair using terminal commands.

The PGP tools by Workato connector uses the AES256 cipher algorithm and SHA256 digest algorithm to encrypt, decrypt, sign, and verify files based on the common PGP standard.

Depending on the actions you plan to perform, you may need to provide the public, private, or both keys to set up PGP tools by Workato.

---

Generate PGP Keys

Complete the following steps to generate a set of PGP keys, if you don't already have one:

1

Download and install the GPG command line tools (opens new window) for your operating system. Ensure that the GPG version used is v2.2.x or lower.

2

Open the Terminal or Command Prompt.

3

Run the following command to generate a PGP key pair:

gpg --full-generate-key

4

Select RSA key and 3072 bits using the command prompts.

5

Enter your user ID information, including a valid name and email address.

6

Enter a secure passphrase. Save this passphrase for use in the PGP tools by Workato setup.

7

Run the following command to list the PGP keys for which you have both a public and private key:

gpg --list-secret-keys --keyid-format LONG

8

Copy the PGP key ID you plan to use from the list of PGP keys. The PGP key ID in the following example is 7F87F1F21EEAAAB9:

9

Run the following commands with your PGP key ID in place of 7F87F1F21EEAAAB9 to display your Public Key and Private Key:

gpg --armor --export 7F87F1F21EEAAAB9

gpg --armor --export-secret-key 7F87F1F21EEAAAB9

Return to Workato to finish setting up your connection.

Complete setup in Workato

Complete the following steps to configure PGP tools by Workato:

1

Click Create > Connection.

2

Search for and select PGP tools by Workato as your connection in the New connection page.

3

Provide a name for your connection in the Connection name field.

4

Use the Location drop-down menu to select the project where you plan to store the connection.

5

Enter your PGP Private key. This field is required for the Decrypt data and Sign a message actions.

6

Enter your PGP Passphrase.

7

Enter your PGP Public key. This field is required for the legacy Encrypt action.

8

Click Connect to complete the setup. Complete the connection fields and click Connect

Actions

The PGP tools by Workato connector supports the following actions:

• Encrypt data
• Decrypt data
• Sign a message
• Verify a signed message

Encrypt data

The Encrypt data action encrypts data using a public key.

Input

Input fields	Description
File content	Map a File content data pill or enter the text you plan to encrypt directly.
Public key	Provide a public key to encrypt the File content with or leave this field blank to use the public key specified in the connection setup.
Sign	Select whether to sign the data using the private key and passphrase from the connection fields. You can also sign a message using the Sign a message action.
ASCII armor	Select whether to generate the encrypted content as printable ASCII characters. This allows you to send the content in a standard messaging format such as email.

Output

Output fields	Description
Encrypted contents	The encrypted contents of the file.
File name	The name of the encrypted file.

Decrypt data

The Decrypt data action decrypts data using the private key and passphrase specified in the connection setup.

Input

Input fields	Description
Encrypted content	Map a File content data pill or enter encrypted text directly.
Use public key from connection?	Select whether to use the public key from the connection fields to decrypt the data.
Verification public key	Provide a public key to verify the signature of the file contents with. This field generates when you set Use public key from connection? to No.

Output

Output fields	Description
Decrypted contents	The decrypted contents of the file.

Sign a message

The Sign a message action signs data using the private key and passphrase specified in the connection setup. You can also sign a message as part of the Encrypt data action.

Input

Input fields	Description
File content	Map a File content data pill or enter the text you plan to sign directly.
ASCII armor	Select whether to generate the encrypted content as printable ASCII characters. This allows you to send the content in a standard messaging format such as email.

Output

Output fields	Description
PGP Signature	The signed message.

Verify a signed message

The Verify a signed message action verifies signed data using a public key.

Input

Input fields	Description
Signed document	Map a File content data pill or enter the signed text directly.
Use public key from connection?	Select whether to use the public key from the connection fields to verify the signed data.
Verification public key	Provide a public key to verify the signature of the file contents with. This field generates when you set Use public key from connection? to No.

Output

The Verify a signed message action has no output fields.