PGP

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

PGP (Pretty Good Privacy) é um conector de criptografia que oferece autenticação e privacidade para comunicação de dados.

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
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 Public Key ou Private Key, configurada em Contas na Plataforma.	String	❌	N/A	Use Dynamic Account está desabilitado
Operation	Define o tipo de operação a ser executada: Encrypt Fields, Decrypt Fields, Encrypt Payload, Decrypt Payload, Encrypt File ou Decrypt File.	String	❌	Encrypt Fields	—
Fields	Nomes dos campos a serem criptografados ou descriptografados dentro da entrada JSON. Múltiplos campos devem ser separados por vírgula (ex.: param1, param2).	String	❌	parameter	Operation é Encrypt Fields ou Decrypt Fields
Payload	Conteúdo a ser criptografado ou descriptografado. Pode ser definido como um valor fixo único ou referenciado dinamicamente usando uma expressão Double Braces para obter e definir o payload.	String	✅	N/A	Operation é Encrypt Payload ou Decrypt Payload
Charset	Codificação de caracteres usada para interpretar o texto.	String	❌	UTF-8	—
File Name	Nome ou caminho completo do arquivo a ser criptografado ou descriptografado (ex.: tmp/processed/file.txt).	String	✅	N/A	Operation é Encrypt File ou Decrypt File
Output File Name	Nome a ser atribuído ao arquivo resultante, já criptografado ou descriptografado.	String	✅	N/A	Operation é Encrypt File ou Decrypt File
Hexadecimal	Se habilitado, o valor a ser assinado ou verificado deve ser informado em formato hexadecimal; caso contrário, é assinado ou verificado em formato base64.	Boolean	❌	true	—
Armor	Se habilitado, criptografa a mensagem usando ASCII armor, permitindo que seja transmitida em formatos de texto padrão, como e-mail.	Boolean	❌	false	Operation é Encrypt Fields, Encrypt Payload, Encrypt File
Zip	Se habilitado, compacta a mensagem antes da criptografia.	Boolean	❌	false	Operation é Encrypt Fields, Encrypt Payload, Encrypt File
Integrity Check	Se habilitado, verifica a integridade da mensagem durante a operação.	Boolean	❌	true	Operation é Encrypt Fields, Encrypt Payload, Encrypt File
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	—

Documentation

Fluxo de mensagens

Operation Encrypt Fields

Entrada

{  
    "parameter": "TEXT TO BE ENCRYPTED"
}

Saída

{  
    "parameter": "AA01FF" // text encrypted
}

Operation Decrypt Fields

Entrada

{  
    "parameter": "AA01FF" // text encrypted
}

Saída

{  
    "parameter": "TEXT DECRYPTED"
}

Operation Encrypt Payload

Entrada

{  
    "parameter": "TEXT TO BE ENCRYPTED"
}

Saída

{  
    "result": "AA01FF" // text encrypted
}

Operation Decrypt Payload

Entrada

{  
    "parameter": "AA01FF" // text encrypted
}

Saída

{  
    "result": "TEXT DECRYPTED"
}

Operation Encrypt File

Entrada

{  
    "fileName": "file.txt"
}

Saída

{  
    "outputFileName": "file.txt.pgp" // file encrypted
}

Operation Decrypt File

Entrada

{  
    "fileName": "file.txt.pgp" // file encrypted
}

Saída

{  
    "outputFileName": "file.txt.dec" // file decrypted
}

Saída com erro

{   
    "error": "java.io.FileNotFoundException: data1.csv (No such file or directory)",  
    "success": false
}

• success: "false" quando a operação falha.

• error: informações sobre o erro ocorrido.