RSA Cryptography

Discover more about the RSA Cryptography connector and how to use it on the Digibee Integration Platform.

The RSA Cryptography connector encrypts and decrypts based on the RSA algorithm.

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
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. Encrypt and wrap operations require a Public Key account; decrypt and unwrap operations require a Private Key account. Encrypt operations also support providing the key directly in the message body. Account configuration is done in Accounts on the Platform.	String	❌	N/A	Use Dynamic Account is disabled
Crypto Operation	Defines the type of operation to be performed: Encrypt Fields, Decrypt Fields, Encrypt Payload, Decrypt Payload, Unwrap Key, or Wrap Key.	String	❌	Encrypt Fields	—
Fields To Encrypt/Decrypt	Fields to be encrypted or decrypted, specified using dotted notation (e.g., body.field1, body.field2, body).	String	❌	a.test	Crypto Operation is Encrypt Fields or Decrypt Fields
Payload To Encrypt/Decrypt	Payload to be encrypted or decrypted, specified using dotted notation.	String	❌	N/A	Crypto Operation is Encrypt Payload or Decrypt Payload
Secret Key	Secret key to be wrapped or unwrapped, specified using dotted notation.	String	❌	N/A	Crypto Operation is Wrap Key or Unwrap Key
Operation Mode	Operation mode to be used for the cryptographic operation.	String	❌	ECB	Crypto Operation is Encrypt Fields, Decrypt Fields, Encrypt Payload, or Decrypt Payload
Padding	Padding scheme used in block cipher operations to fill blocks with padding bytes (e.g., AES 128-bit uses 16 padding bytes).	String	❌	OAEPWithSHA-512AndMGF1Padding	—
Charset	Character encoding of the provided key when the key type is string.	String	❌	UTF-8	—
Encrypted Message As Hexa	If enabled, returns the secret key response in hexadecimal format; otherwise, it is returned in Base64 format.	Boolean	❌	false	—
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	—

Documentation

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

Parameters additional information

Wrap and Unwrap Key

Wrap and unwrap operations differ slightly from standard encrypt and decrypt operations. When you wrap a key, you not only encrypt it but also add integrity protection to ensure the key has not been tampered with. Similarly, when you unwrap a key, you decrypt it while simultaneously validating its integrity.

In the RSA Cryptography connector, these operations are designed to securely encapsulate a session (or secret) key for transfer through other Digibee connectors, ensuring both confidentiality and integrity.

Since these are experimental features, only one specific configuration is currently supported.

For the Wrap Key Crypto Operation

In the Account field, select a public key from an RSA 2048-bit key pair.

In the Secret Key field, specify a 256-bit AES key from the input payload. Use dotted notation to reference the corresponding key field.

Values are encrypted in hexadecimal format.

The RSA wrapping operation is performed with the following parameters:

• Operation Mode: ECB

• Padding Scheme: OAEPWithSHA-256AndMGF1Padding

For the Unwrap Key Crypto Operation

In the Account field, select a private key from an RSA 2048-bit key pair.

In the Secret Key field, specify a 256-bit AES key from the input payload. Use dotted notation to reference the corresponding key field.

Values are encrypted in hexadecimal format.

The RSA unwrapping operation is performed with the following parameters:

• Operation Mode: ECB

• Padding Scheme: OAEPWithSHA-256AndMGF1Padding

Messages flow

Operation: Encrypt Fields

Input

{
    "operation": "encrypt_fields",
    "operationMode": "ECB",
    "padding": "OAEPWithSHA1AndMGF1Padding",
    "encryptedFields": "data,data1",
    "failOnError": true,
    "key": "PoeK/VBTcUyRHFkmWYjckbhsRLnZur6S83lKZ78V51EL3KlDNnPJZkdz+m7joRfOxFuEqU=" // Provide the Key parameter if the Account is not configured
}

Payload

{
    "data": someData,
    "data1": someData1
}

Output

{
    "data": "RXZlbiBpZiBwZXJmZWN0IGNyeXB0b2dyYXBoaWMgcm91dGluZXMgYXJlIH=",
    "data1": "RXZlbiBpZifd441mZWN0IGNyeXB0b2dyYXBoaWMgcm91dGluZXMgYXJlIH="
}

Operation: Decrypt Fields

Input

{
    "operation": "decrypt_fields",
    "operationMode": "ECB",
    "padding": "OAEPWithSHA1AndMGF1Padding",
    "encryptedFields": "data,data1",
    "failOnError": true
}

Payload

{
    "data": "RXZlbiBpZiBwZXJmZWN0IGNyeXB0b2dyYXBoaWMgcm91dGluZXMgYXJlIH=",
    "data1": "RXZlbiBpZifd441mZWN0IGNyeXB0b2dyYXBoaWMgcm91dGluZXMgYXJlIH="
}

Output

{
    "data": someData,
    "data1": someData1
}

Operation: Wrap Key

Payload

{
  "encryptedData": {
    "key": "D379C385D6234349046ABCFD42160E5B461E852A63F53B8FDA3B6ED044332E34"
  }
}

Output

{
  "encryptedData": {
    "key": "1e9fbbe9f77020cd05318d71ae242c68ab62981cc40b0e88c42ad89bb24807e46c6589edbb81bc7271c3824d60c2fa754651325eb2510a7cd82125f4ca9356b0b48d2dea8e8348f68173eabecb096a4c41a4a852ec2fb7cd9b0381d080e9d1e09a0bb614d3bbf550e52fe4583a5fdd47623e13256c69ee434b6c44d2e90de89804f0e0ff1c83f25adeef9ae89e657b79d8270511b9be5ce56a8955b2c8c5356c9639e6556c12c208a58e2d30e554a51d3a45317de54ab7380482f2d9f6d70c0223594b39c1c2f6f1d28301cb128167946082085c6dbf89825b6fc41929380305d4a5009d85c97d3d08f9672e66e71188b02eb23dffcb40271f1bb7b4d2f4fd5b"
  }
}

Operation: Unwrap Key

Payload

{
  "encryptedData": {
    "key": "1e9fbbe9f77020cd05318d71ae242c68ab62981cc40b0e88c42ad89bb24807e46c6589edbb81bc7271c3824d60c2fa754651325eb2510a7cd82125f4ca9356b0b48d2dea8e8348f68173eabecb096a4c41a4a852ec2fb7cd9b0381d080e9d1e09a0bb614d3bbf550e52fe4583a5fdd47623e13256c69ee434b6c44d2e90de89804f0e0ff1c83f25adeef9ae89e657b79d8270511b9be5ce56a8955b2c8c5356c9639e6556c12c208a58e2d30e554a51d3a45317de54ab7380482f2d9f6d70c0223594b39c1c2f6f1d28301cb128167946082085c6dbf89825b6fc41929380305d4a5009d85c97d3d08f9672e66e71188b02eb23dffcb40271f1bb7b4d2f4fd5b"
  }
}

Output

{
  "encryptedData": {
    "key": "D379C385D6234349046ABCFD42160E5B461E852A63F53B8FDA3B6ED044332E34"
  }
}