PBE Cryptography

Saiba mais sobre o conector PGP (Pretty Good Privacy) e como utilizá-lo na Digibee Integration Platform.

O PBE Cryptography realiza operações de criptografia e descriptografia utilizando o algoritmo PBE (Password-Based Encryption).

Parâmetros

Configure o conector utilizando os parâmetros abaixo. Os campos que suportam expressões Double Braces estão marcados na coluna Suporta DB.

General

Parâmetro	Descrição	Tipo de dado	Suporta DB	Valor padrão	Visível quando
Crypto Operation	Define o tipo de operação a ser executada: Encrypt Fields, Decrypt Fields, Encrypt Payload ou Decrypt Payload.	String	❌	Encrypt Fields	—
Use Dynamic Account	Se habilitado, o conector usa a conta de forma dinâmica via o conector Store Account; caso contrário, usa a conta estática configurada em Contas na Plataforma.	Boolean	❌	false	—
Scoped	Se habilitado, isola a conta armazenada de outros subprocessos. Não é suportado para contas usadas em headers ou body. Para saber mais, consulte a documentação de Dynamic Accounts.	Boolean	❌	false	Use Dynamic Account está habilitado
Account Name	Nome da conta definida no conector Store Account.	String	✅	N/A	Use Dynamic Account está habilitado
Account	Conta a ser usada pelo conector. Deve ser do tipo de conta Secret Key, configurada em Contas na Plataforma.	String	❌	N/A	Use Dynamic Account está desabilitado
Iteration Count	Número de iterações a serem realizadas com o valor de Salt.	Integer	❌	1000	—
Algorithm	Algoritmo a ser utilizado na operação de criptografia ou descriptografia.	String	❌	PBEWithMD5AndDES	—
Fields To Encrypt/Decrypt	Campos a serem criptografados ou descriptografados, especificados usando notação com pontos (ex.: body.field1, body.field2, body).	String	❌	a.test	—
Payload To Encrypt/Decrypt	Payload a ser criptografado ou descriptografado, especificado usando notação com pontos.	String	✅	N/A	—
Charset	Codificação de caracteres usada para interpretar o texto.	String	❌	UTF-8	—
Secret Key Type	Formato da secret key: String, Hexadecimal ou Base64.	String	❌	Base64	—
Fail On Error	Se habilitado, interrompe a execução do pipeline quando ocorre um erro. Caso contrário, a execução prossegue e o resultado retorna false para a propriedade "success".	Boolean	❌	false	—
Advanced Settings	Habilita o acesso a opções de configuração avançadas.	Boolean	❌	false	—
Use Key From Payload	Se habilitado, utiliza a secret key fornecida no payload em vez de uma chave fixa.	Boolean	❌	false	Advanced Settings está habilitado
Secret Key	Valor da secret key, fornecido em formato Hexadecimal ou Base64.	String	❌	N/A	Use Key From Payload está habilitado
Use Salt From Payload	Se habilitado, utiliza o valor de Salt fornecido no payload; caso contrário, um novo Salt é gerado automaticamente.	Boolean	❌	false	Advanced Settings está habilitado
Salt	String de dados aleatórios usada para modificar um hash de senha.	String	❌	N/A	Use Salt From Payload está habilitado
Encryption Key As Hex Value	Se habilitado, retorna a secret key em formato hexadecimal; caso contrário, ela é retornada em formato Base64 quando a opção Use Key From Payload também estiver habilitada.	Boolean	❌	false	Advanced Settings está habilitado
Salt As Hex Value	Se habilitado, retorna o valor de Salt em formato hexadecimal; caso contrário, ele é retornado em formato Base64.	Boolean	❌	false	Advanced Settings está habilitado
Encrypted Message As Hex	Se habilitado, retorna a mensagem criptografada em formato hexadecimal; caso contrário, ela é retornada em formato Base64.	Boolean	❌	false	Advanced Settings está habilitado

Documentation

Parameter	Descrição	Tipo de dado	Supports DB	Valor default
Documentation	Campo opcional para descrever a configuração do conector e quaisquer regras de negócio relevantes.	String	❌	N/A

Fluxo de mensagens

Criptografar via fields

Entrada

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

Payload

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

Saída

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

Descriptografar via fields

Entrada

{  
    "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=="
}

Saída

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

Criptografar via payload

Entrada

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

Payload

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

Saída

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

Descriptografar via payload

Entrada

{
    "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=="  
    }
}

Saída

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