Help Desk

Submit a ticket My Tickets
Welcome
Login

Encryption Command Reference

Encrypt and decrypt files and plaintext using PGP or X509 certificates

Connections

Encryption

Encryption BizApp

Inputs

Input Type Detail Notes
PGP Public Key File TextField PGP Public Key File. This is only required if you are encrypting files or text using PGP.
PGP Private Key File TextField PGP Private Key File. This is only required if you are decrypting files or text using PGP. If the key includes a password, you must include it in the PGP Private Key Password field
PGP Private Key Password TextField Password to your accompanying PGP Private Key. Leave this field blank if your PGP Private Key was not created with a password
X509 Public Key File TextField X509 Public Key File. This is only required if you are using an X509 certificate to encrypt a file or text
X509 Private Key File TextField X509 Private Key File. This is only required if you are decrypting files or text that were encrypted with an X509 certificate
X509 Private Key Password TextField If your X509 Private Key was created with a password, enter it here. If not, you may leave this field blank.

Commands

Decrypt With PGP Key

Decrypt a file or text using your PGP key

Inputs

Input Type Detail Notes
File to Decrypt FileField A file to be decrypted. Leave this field blank if you plan on decrypting text (entered in the field below)
Text to Decrypt TextField Text to be decrypted. Leave this field blank if you have already specified a file to be decrypted
Armored Message BooleanField Select this field if the ciphertext to be decrypted is "armored" (i.e. starts with -----BEGIN)

Outputs

Output Output Type Notes
PGP Decrypted File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Decrypt With X509 Certificate

Decrypt a file or text using an X509 certificate

Inputs

Input Type Detail Notes
File to Decrypt FileField A file to be decrypted. Leave this field blank if you plan on decrypting text (entered in the field below)
Text to Decrypt TextField Text to be decrypted. Leave this field blank if you have already specified a file to be decrypted
Hash DropdownField Hash function that is used as a random oracle. Both encrypting and decrypting using an X509 certificate must use the same hash function.

Outputs

Output Output Type Notes
X509 Decrypted File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Encrypt With PGP Key

Encrypt a file or text using your PGP key

Inputs

Input Type Detail Notes
File to Encrypt FileField A file to be encrypted. Leave this field blank if you plan on encrypting text (entered in the field below)
Text to Encrypt TextField Text to be encrypted. Leave this field blank if you have already specified a file to be encrypted
Armored Message BooleanField Select this field if you want the encrypted text to be "armored" (i.e. starts with -----BEGIN)

Outputs

Output Output Type Notes
PGP Encrypted File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Encrypt With X509 Certificate

Encrypt a file or text using an X509 Certificate

Inputs

Input Type Detail Notes
File to Encrypt FileField A file to be encrypted. Leave this field blank if you plan on encrypting text (entered in the field below)
Text to Encrypt TextField Text to be encrypted. Leave this field blank if you have already specified a file to be encrypted
Hash DropdownField The hash function to be used as a random oracle to ensure the ciphertext generated is not the same each time. You must use the same hash you choose here to successfully decrypt a file you encrypted with this command.

Outputs

Output Output Type Notes
X509 Encrypted File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.