Funções criptográficas no Jitterbit Design Studio
Funções criptográficas são usadas para executar criptografia e descriptografia básicas usando algoritmos e funções padrão.
Ler e escrever arquivos usando Base-64
As funções Base64 podem ser usadas ao ler e gravar arquivos, seguindo estes cenários comuns:
Um cenário é ler um arquivo existente (talvez um PDF) usando o Base64EncodeFile
função e, em seguida, gravar o conteúdo desse arquivo em um endpoint, como o Salesforce.
Para fazer isso, crie um script que leia o arquivo de uma fonte e defina variáveis globais apropriadas. Você criaria então uma transformação que pega essas variáveis globais e as usa em um mapeamento para gravar no Salesforce:
// Read a PDF File
$docName = "Test.pdf";
$fileContents = Base64EncodeFile("<TAG>Sources/PDF Files</TAG>", $docName);
$docLength = Length($fileContents);
$docType = "pdf";
$mimeType = "application/pdf";
Um segundo cenário é ler de um arquivo, colocando o conteúdo em uma variável e, em seguida, usar o Base64Encode
função no conteúdo antes de salvar em um novo arquivo de texto.
AESDecryption
Declaração
string AESDecryption(string encryptedText, string passphrase, [string salt, int keyLength, int iterations])
Sintaxe
AESDecryption(<encryptedText>, <passphrase>[, <salt>, <keyLength>, <iterations>])
Parâmetros obrigatórios
encryptedText
: Um valor criptografado AES codificado em base64passphrase
: Senha usada para criptografar a string com a funçãoAESencryption
Parâmetros opcionais
salt
: Sal de string hexadecimal usado para criptografar a string com a funçãoAESencryption
keyLength
: Comprimento da chave usada para criptografar a string com a funçãoAESencryption
iterations
: Número de iterações usadas para criptografar a string com a funçãoAESencryption
Descrição
Esta função descriptografa uma string criptografada com o algoritmo AES.
A saída descriptografada é retornada como uma string. Veja AESEncryption
para detalhes adicionais.
Exemplos
// Encrypting a string
encrypted = AESEncryption("Hello world!", "password");
// Decrypted as "Hello world!"
decrypted = AESDecryption(encrypted, "password");
// Encrypting (and decrypting) a string using
// a passphrase and salt, 256-bit key, and 1024 iterations
encrypted = AESEncryption("Hello world!", "password", "00FFAE01", 256, 1024);
decrypted = AESDecryption(encrypted, "password", "00FFAE01", 256, 1024);
AESEncryption
Declaração
string AESEncryption(string plainText, string passphrase[, string salt, int keyLength, int iterations])
Sintaxe
AESEncryption(<plainText>, <passphrase>[, <salt>, <keyLength>, <iterations>])
Parâmetros obrigatórios
plainText
: Uma string a ser criptografadapassphrase
: Senha a ser usada para criptografar a string
Parâmetros opcionais
salt
: Sal de string hexadecimal usado para criptografar a string; se especificado, o valor deve ser fornecido em formato hexadecimal (como"A034DD"
)**keyLength
: Comprimento da chave a ser usada para criptografar a string e deve ser 128, 192 ou 256; o padrão é 256iterations
: Número de iterações usadas para gerar a chave; o padrão é 1
Descrição
Esta função criptografa uma string usando o algoritmo AES. A chave é gerada de acordo com Password-Based Cryptography Specification Version 2.0 (PKCS5S2).
A saída criptografada é uma string codificada em base64. A saída de AESEncryption
pode ser passado diretamente para a função AESDecryption
para descriptografia, usando os mesmos parâmetros de quando a sequência de texto simples foi criptografada.
Exemplos
// Encrypting a string
encrypted = AESEncryption("Hello world!", "password");
// Decrypted as "Hello world!"
decrypted = AESDecryption(encrypted, "password");
// Encrypting (and decrypting) a string using
// a passphrase and salt, 256-bit key, and 1024 iterations
encrypted = AESEncryption("Hello world!", "password", "00FFAE01", 256, 1024);
decrypted = AESDecryption(encrypted, "password", "00FFAE01", 256, 1024);
Base64Decode
Declaração
binary Base64Decode(string encryptedText)
Sintaxe
Base64Decode(<encryptedText>)
Parâmetros obrigatórios
encryptedText
: Uma string codificada em base64
Descrição
Decodifica uma string codificada em base64, retornando dados binários. Veja também Base64Encode
.
Cuidado
Ao usar a versão 11.33 ou anterior do agente, o Base64Decode
a função pode retornar um valor truncado ou incorreto quando a string codificada em base64 não é anexada com =
ou ==
. Ao usar a versão 11.34 ou posterior do agente, as strings codificadas em base64 são manipuladas conforme pretendido.
Exemplos
// Encrypting a string after first converting it to binary
binary = HexToBinary(StringToHex("Hello world!"));
encrypted = Base64Encode(binary);
decrypted = Base64Decode(encrypted);
result = HexToString(BinaryToHex(decrypted));
// Returns original string "Hello world!"
Base64Encode
Declaração
string Base64Encode(type arg)
Sintaxe
Base64Encode(<arg>)
Parâmetros obrigatórios
arg
: Valor a ser codificado
Descrição
Codifica os dados do argumento, tratando os caracteres em uma string como dados binários, a menos que a entrada já seja binária. Se o tipo do argumento não for binário ou uma string, então o valor do argumento é primeiro convertido para uma string antes da criptografia.
Um caractere de nova linha (\n
) é adicionado após cada 64º caractere da string de resultado codificado. Como muitas implementações do Base64 incluem novas linhas para limitar o comprimento máximo da linha do resultado codificado, isso deve ser explicitamente desabilitado somente quando necessário. Para desabilitar isso, defina o jitterbit.base64.encoded.string.no.wrap
Variável Jitterbit para true
antes de chamar esta função. Esta variável é suportada com dados de string ao usar agentes 10.49 e posteriores, e com dados binários ao usar agentes 10.x 10.66 e posteriores e agentes 11.x 11.4 e posteriores.
Veja também Base64Decode
.
Exemplos
// Encrypting a string after first converting it to binary
binary = HexToBinary(StringToHex("Hello world!"));
encrypted = Base64Encode(binary);
decrypted = Base64Decode(encrypted);
result = HexToString(BinaryToHex(decrypted));
// Returns original string "Hello world!"
encrypted = Base64Encode(Now());
decrypted = Base64Decode(encrypted);
result = HexToString(BinaryToHex(decrypted));
// Returns a date string such as "2017-12-14 01:25:31"
// Encrypting credentials for use in an HTTP header
Base64Encode("exampleuser"+":"+"examplepassword")
Base64EncodeFile
Declaração
string Base64EncodeFile(string sourceId[, string filename])
Sintaxe
Base64EncodeFile(<sourceId>[, <filename>])
Parâmetros obrigatórios
sourceId
: Uma fonte de string no projeto atual que retorna um arquivo binário. Se uma matriz de nomes de arquivo for retornada, o primeiro será usado.
Parâmetros opcionais
filename
: Um nome de arquivo de string usado para substituir o valor retornado pelosourceId
fonte
Descrição
Lê um arquivo binário da fonte especificada e retorna o conteúdo como uma string codificada em base64. Este método é geralmente usado para arquivos que podem ser binários. Para ler um arquivo de texto, use a função ReadFile
em vez disso.
A fonte do tipo de arquivo usada nesta função deve ser definida como uma fonte no projeto atual. Veja as instruções em inserir itens do projeto.
Este método retorna o conteúdo do arquivo apontado pela fonte especificada. Se o filtro de fonte selecionar mais de um arquivo, o primeiro será usado. É recomendado especificar uma fonte que identifique exclusivamente um único arquivo.
O segundo parâmetro, filename
, é opcional e pode ser usado para substituir o nome do arquivo retornado na definição de origem. Alternativamente, uma variável global pode ser usada para substituir o nome do arquivo na definição de origem. Variáveis globais são referenciadas como [de_name]
na definição de origem.
Se um arquivo não for encontrado, um erro será gerado.
Um caractere de nova linha (\n
) é adicionado após cada 64º caractere da string de resultado codificado. Como muitas implementações do Base64 incluem novas linhas para limitar o comprimento máximo da linha do resultado codificado, isso deve ser explicitamente desabilitado somente quando necessário. Para desabilitar isso, defina o jitterbit.base64.encoded.string.no.wrap
Variável Jitterbit para true
antes de chamar esta função. Esta variável é suportada com dados de string ao usar agentes 10.49 e posteriores, e com dados binários ao usar agentes 10.x 10.66 e posteriores e agentes 11.x 11.4 e posteriores.
Veja também Base64Decode
.
Exemplos
// Reads the first file found at the source "Word Documents FTP"
// and returns it as base64-encoded string
fileContents1 = Base64EncodeFile("<TAG>Sources/Word Documents FTP</TAG>");
// Reads the binary file called "requirements.doc" from
// the FTP directory defined by the source "Word Documents FTP"
fileContents2 = Base64EncodeFile("<TAG>Sources/Word Documents FTP</TAG>",
"requirements.doc");
// Decodes the file contents; they can now be re-written
// as a binary file to another target
fileContents2Decoded = Base64Decode(fileContents2);
MD5
Declaração
string MD5(type arg)
Sintaxe
MD5(<arg>)
Parâmetros obrigatórios
arg
: Valor a ser hash
Descrição
Aplica a função hash MD5 ao argumento fornecido. O hash é retornado como uma sequência de 64 bits de números hexadecimais. Dados não-sequenciais serão primeiro convertidos para uma sequência.
Cuidado
Quando usado com agentes versão 10.63 e anteriores ou 11.1 e anteriores, esta função não gera os valores corretos para arquivos binários como ZIP ou PDF. Este comportamento pode ser aplicado a versões posteriores do agente usando a variável Jitterbit $jitterbit.md5.hash.use.file.mode.string.only
.
Exemplos
MD5("hello world!");
// Returns "fc3ff98e8c6a0d3087d515c0473f8677"
MD5AsTwoNumbers
Declaração
array MD5AsTwoNumbers(type arg)
Sintaxe
MD5AsTwoNumbers(<arg>)
Parâmetros obrigatórios
arg
: Valor a ser hash
Descrição
Aplica a função hash MD5 a uma string de entrada e retorna o resultado como uma matriz com dois números de 64 bits. Dados não string serão primeiro convertidos para uma string.
Exemplos
MD5AsTwoNumbers("hello world!");
// Returns "{8612640914790536583, 3462540840444444668}"
SHA256
Declaração
string SHA256(type arg)
Sintaxe
SHA256(<arg>)
Parâmetros obrigatórios
arg
: Valor a ser hash
Descrição
Aplica a função hash SHA-256 a uma string de entrada. O hash retornado é uma string de 64 números hexadecimais.
Se a entrada for uma string, ela será primeiro convertida para a representação de bytes UTF-8. Dados que não sejam strings serão primeiro convertidos para uma string.
Cuidado
Quando usado com agentes versão 10.63 e anteriores ou 11.1 e anteriores, esta função não gera os valores corretos para arquivos binários como ZIP ou PDF. Este comportamento pode ser aplicado a versões posteriores do agente usando a variável Jitterbit $jitterbit.md5.hash.use.file.mode.string.only
.
Exemplos
SHA256("hello world!");
// Returns "7509e5bda0c762d2bac7f90d758b5b2263fa01ccbc542ab5e3df163be08e6ca9"