PBE Cryptography

Discover more about the PGP (Pretty Good Privacy) connector and how to use it on the Digibee Integration Platform.

PBE Cryptography performs encryption and decryption using the PBE algorithm (Password-Based Encryption).

Parameters

Configure the connector using the parameters below. Fields that support Double Braces expressions are marked in the Supports DB column.

General

Parameter	Description	Data type	Supports DB	Default value	Visible when
Crypto Operation	Defines the type of operation to be performed: Encrypt Fields, Decrypt Fields, Encrypt Payload, or Decrypt Payload.	String	❌	Encrypt Fields	—
Use Dynamic Account	If enabled, the connector uses the account dynamically via the Store Account connector; otherwise, it uses the account statically as configured in Accounts on the Platform.	Boolean	❌	false	—
Scoped	If enabled, isolates the stored account from other sub-processes. Not supported for accounts used in headers or body. To learn more, read the Dynamic Accounts documentation.	Boolean	❌	false	Use Dynamic Account is enabled
Account Name	Name of the account defined in the Store Account connector.	String	✅	N/A	Use Dynamic Account is enabled
Account	Account to be used by the connector. Must be a Secret Key account type, configured in Accounts on the Platform.	String	❌	N/A	Use Dynamic Account is disabled
Iteration Count	Number of iterations to be performed with the Salt value.	Integer	❌	1000	—
Algorithm	Algorithm to be used for the encryption or decryption operation.	String	❌	PBEWithMD5AndDES	—
Fields To Encrypt/Decrypt	Fields to be encrypted or decrypted, specified using dotted notation (e.g., body.field1, body.field2, body).	String	❌	a.test	—
Payload To Encrypt/Decrypt	Payload to be encrypted or decrypted, specified using dotted notation.	String	✅	N/A	—
Charset	Character encoding used to interpret the text.	String	❌	UTF-8	—
Secret Key Type	Format of the secret key: String, Hexadecimal, or Base64.	String	❌	Base64	—
Fail On Error	If enabled, interrupts pipeline execution when an error occurs. Otherwise, execution proceeds and the result returns false for the "success" property.	Boolean	❌	false	—
Advanced Settings	Enables access to advanced configuration options.	Boolean	❌	false	—
Use Key From Payload	If enabled, uses the secret key provided in the payload instead of a fixed key.	Boolean	❌	false	Advanced Settings is enabled
Secret Key	Secret key value, provided in Hexadecimal or Base64 format.	String	❌	N/A	Use Key From Payload is enabled
Use Salt From Payload	If enabled, uses the Salt value provided in the payload; otherwise, a new Salt is generated automatically.	Boolean	❌	false	Advanced Settings is enabled
Salt	Random data string used to modify a password hash.	String	❌	N/A	Use Salt From Payload is enabled
Encryption Key As Hex Value	If enabled, returns the secret key in hexadecimal format; otherwise, it is returned in Base64 format when the Use Key From Payload option is also enabled.	Boolean	❌	false	Advanced Settings is enabled
Salt As Hex Value	If enabled, returns the Salt value in hexadecimal format; otherwise, it is returned in Base64 format.	Boolean	❌	false	Advanced Settings is enabled
Encrypted Message As Hex	If enabled, returns the encrypted message in hexadecimal format; otherwise, it is returned in Base64 format.	Boolean	❌	false	Advanced Settings is enabled

Documentation

Parameter	Description	Data type	Supports DB	Default value
Documentation	Optional field to describe the connector configuration and any relevant business rules.	String	❌	N/A

Messages flow

Encrypt via fields

Input

{  
    "accountLabel": "account",  
    "params": {    
        "operation": "encrypt_fields",    
        "iterationCount": 1000,    
        "keyType": "STRING",    
        "algorithm": "PBEWithMD5AndDES",    
        "encryptedFields": "a.test",    
        "failOnError": true  
    }
}

Payload

{  
    "a": {    
        "test": "test"  
    }
}

Output

{  
    "a": {    
        "test": "ZmRmcw=="  
    },  
    "_salt": "ZmRmcwZmRmcw=="
}

Decrypt via fields

Input

{  
    "accountLabel": "account",  
    "params": {    
        "operation": "decrypt_fields",    
        "iterationCount": 1000,    
        "keyType": "STRING",    
        "algorithm": "PBEWithMD5AndDES",    
        "encryptedFields": "a.test",    
        "useSaltFromPayload": true,    
        "salt": "{{ message._salt }}",    
        "failOnError": true  
    }
}

Payload

{  
    "a": {    
        "test": "ZmRmcw=="  
    },  
    "_salt": "ZmRmcwZmRmcw=="
}

Output

{  
    "a": {    
        "test": "test"  
    },  
    "_salt": "ZmRmcwZmRmcw=="
}

Encrypt via payload

Input

{
    "accountLabel": "pbe",    
        "params": {        
            "operation": "encrypt_payload",        
            "iterationCount": 1000,        
            "payload": "{{ message.a.test }}",        
            "keyType": "STRING",        
            "algorithm": "PBEWithMD5AndDES",        
            "failOnError": true    
        }
    }

Payload

{  
    "a": {    
        "test": "test"  
    }
}

Output

{  
    "a": {    
        "test": "test"  
    },  
    "result": "ZmRmcw==",  
    "_salt": "ZmRmcwZmRmcw=="
}

Decrypt via payload

Input

{
    "accountLabel": "pbe",    
    "params": {        
            "operation": "decrypt_payload",        
            "iterationCount": 1000,        
            "payload": "{{ message.a.test }}",        
            "keyType": "STRING",        
            "algorithm": "PBEWithMD5AndDES",        
            "useSaltFromPayload": true,
            "salt": "{{ message._salt }}",        
            "failOnError": true    
     }
}

Payload

{  
    "a": {    
        "test": "ZmRmcw=="  
    }
}

Output

{  
    "a": {    
        "test": "ZmRmcw=="  
    },  
    "result": "test",  
    "_salt": "ZmRmcwZmRmcw=="
}