Comment on page
PGP
Discover more about the PGP component and how to use it on the Digibee Integration Platform.
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. Parameters supported by Double Braces expressions are marked with
(DB)
.Parameter | Description | Default value | Data type |
---|---|---|---|
Account | Sets the account to be used by the component. The account should be either Public or Private key. | N/A | String |
Operation | Defines the operation type (Encrypt Fields, Decrypt Fields, Encrypt Payload, Decrypt Payload, Encrypt File, or Decrypt File). | Encrypt Fields | String |
Fields | Name of the fields to be encrypted inside the JSON entry. The fields must be separated by a comma (e.g., param1, param2). This parameter is available only when Encrypt Fields or Decrypt Fields are selected in the Operation parameter. | parameter | String |
Payload (DB) | Can be defined as a single value or by Double Braces to get and set a payload. This parameter is available only when Encrypt Payload or Decrypt Payload are selected in the Operation parameter. | N/A | String |
Charset | Charset of the text. | UTF-8 | String |
File Name (DB) | Name of the file or full file path (i.e. tmp/processed/file.txt) to be encrypted/decrypted. This parameter supports Double Braces expressions and is available only when Encrypt File or Decrypt File are selected in the Operation parameter. | N/A | String |
Output File Name (DB) | Name of the encrypted file to be generated. This parameter supports Double Braces expressions and is available only when Encrypt File or Decrypt File are selected in the Operation parameter. | N/A | String |
Hexadecimal | If the option is active, the value to be verified/signed must be informed in hex format; otherwise, it will be signed or verified as base64. | True | Boolean |
Armor | If the option is active, it will encrypt the messages in ASCII so they are sent in a standard format, such as email. | False | Boolean |
Zip | If the option is active, it will zip the message before it gets encrypted. | False | Boolean |
Integrity Check | If the option is active, it will check the message integrity. | True | Boolean |
Fail On Error | If the option is active, the execution of the pipeline with an error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property. | False | Boolean |
{
"parameter": "TEXT TO BE ENCRYPTED"
}
{
"parameter": "AA01FF" // text encrypted
}
{
"parameter": "AA01FF" // text encrypted
}
{
"parameter": "TEXT DECRYPTED"
}
{
"parameter": "TEXT TO BE ENCRYPTED"
}
{
"result": "AA01FF" // text encrypted
}
{
"parameter": "AA01FF" // text encrypted
}
Output
{
"result": "TEXT DECRYPTED"
}
{
"fileName": "file.txt"
}
{
"outputFileName": "file.txt.pgp" // file encrypted
}
{
"fileName": "file.txt.pgp" // file encrypted
}
{
"outputFileName": "file.txt.dec" // file decrypted
}
{
"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.
Last modified 1mo ago