PGPConnector
Erick Rubiales avatar
Written by Erick Rubiales
Updated over a week ago

IMPORTANT: This documentation has been discontinued. Read the updated PGP documentation on our new documentation portal.

Connector configuration parameters:

PGPConnector:

charset = the encoding name to read value

operation = types of operation of this connector: ENCRYPT_FIELDS, DECRYPT_FIELDS, ENCRYPT_PAYLOAD, DECRYPT_PAYLOAD

encryptedFields = fields, separated by comma, that it'll be encrypted/decrypted

payload = You can define as single value or by double brackets to get and set an payload. Used in ENCRYPT_PAYLOAD and DECRYPT_PAYLOAD operation

encryptedMessageAsHex = if true the message will be signed or verified as hexadecimal value, otherwise as base64

zipped = if true will zip the data before encrypt

armored = if true will encrypt messaging in ASCII so that they can be sent in a standard messaging format such as email.

integrityCheck = if true will check the message integrity

failOnError = if true will throw an exception and stop the route

For the encrypt you must configure an PUBLIC_KEY Account or passing via body the property key with the following key.

For the verify you must configure an PRIVATE_KEY Account or passing via body the property key with the following key.

Example - ENCRYPT_FIELDS:

Config:

{

   "operation": "ENCRYPT_FIELDS",

   "encryptedFields": "parameter",

   "failOnError": true,

   "encryptedMessageAsHex": true

}

Payload:

{"parameter": "Test for encryption"}

Result:

{

  "parameter": "....032281762E01B6C50C1DE825A2FD5A177CCFD5C1DB54E88ADD188A0B80311E672EDE5F8B......"

}

 Example - DECRYPT_FIELDS:

Config:

{

   "operation": "DECRYPT_FIELDS",
   "encryptedFields": "parameter",
   "failOnError": true,
   "encryptedMessageAsHex": true
}

Payload:

{
  "parameter": "....032281762E01B6C50C1DE825A2FD5A177CCFD5C1DB54E88ADD188A0B80311E672EDE5F8B......"
}

Result:

{"parameter": "Test for encryption"}

Example - ENCRYPT_PAYLOAD

{
   "operation": "ENCRYPT_PAYLOAD",
   "encryptedFields": "parameter",
   "payload": "Test for encryption",
   "failOnError": true,
   "encryptedMessageAsHex": true
}

Result:

{
"operation": "DECRYPT_PAYLOAD",
   "encryptedFields": "parameter",
   "failOnError": true,
   "payload": "{{message.$.parameter}}",
   "encryptedMessageAsHex": true
}

Payload:

{
   "parameter": "...032281762E01B6C50C1DE825A2FD5A177CCFD5C1DB54E...."
}

Result:

{"parameter": "Test for encryption"}
Did this answer your question?