JWT (Descontinuado)

Descubra mais sobre o componente JWT e saiba como utilizá-lo na Digibee Integration Platform.

O componente JWT foi descontinuado e não recebe mais atualizações. Por favor, acesse o documento com a versão mais recente da funcionalidade: JWT V2.

O JWT realiza criação de JWS e JWE assim como a verificação de JWS e decodificação de JWE.

Parâmetros

Dê uma olhada nos parâmetros de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetro	Descrição	Valor padrão	Tipo de dado
Operation	Generate JWS realiza a criação de tokens JWS. Generate JWE realiza a criação de tokens JWE. Verify JWS verifica a assinatura de um token JWS e Decode JWE descriptografa o token JWE e retorna o payload desse token.	Generate JWS	String
Public Key	Conta do tipo PUBLIC-KEY utilizada para assinar tokens JWS com os seguintes algoritmos: RS256, RS384, RS512, PS256, PS384 e PS512. Utilizada também para criptografar tokens JWE com os seguintes algoritmos: RSA1_5, RSA-OAEP e RSA-OAEP-256. A chave pública deverá ser do tipo RSA e derivada de uma chave privada de no mínimo 2048 bits.	N/A	String
Private Key	Conta do tipo PRIVATE-KEY utilizada para verificar tokens JWS com os seguintes algoritmos: RS256, RS384, RS512, PS256, PS384 e PS512. Utilizada também para descriptografar tokens JWE com os seguintes algoritmos: RSA1_5, RSA-OAEP e RSA-OAEP-256. A chave privada deverá ser do tipo RSA e de no mínimo 2048 bits.	N/A	String
Secret Key	Conta do tipo SECRET-KEY utilizada para assinar tokens JWS com os seguintes algoritmos: HS256, HS384 e HS512. Utilizada também para criptografar e descriptografar tokens JWE com os seguintes algoritmos: A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW e A256GCMKW.	N/A	String
Key as Base64	Se habilitada, a conta Secret Key deverá estar no formato base64; do contrário, deverá conter o valor da chave a ser utilizada.	False	Booleano
Key Charset	Se a propriedade Key as Base64 estiver habilitada, o charset da chave deve ser informado.	UTF-8	String
JWS Algorithm	Algoritmos utilizados para assinar e verificar tokens JWS, sendo eles: HS256, HS384, HS512, RS256, RS384, RS512, PS256, PS384 e PS512.	HS256	N/A
JWE Algorithm	Algoritmos utilizados para criptografar e descriptografar tokens JWE, sendo eles: A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW, RSA1_5, RSA-OAEP e RSA-OAEP-256.	RSA-OAEP	N/A
Encrypted Payload Algorithm	Algoritmos utilizados para criptografar e descriptografar o payload dos tokens JWE, sendo eles: A128KW, A192KW, A256KW e A256GCM.	A128KW	N/A
Issuer (iss)	A claim iss (issuer) identifica o principal que emitiu o JWT. O processamento dessa claim é geralmente específico da aplicação. O uso dessa claim é opcional.	N/A	String
Expiration Time (exp)	A claim exp (expiration time) identifica o tempo de expiração no qual ou após o qual o JWT não deve ser aceito para processamento. O processamento da solicitação exp exige que a data / hora atual devem ser anteriores à data / hora de vencimento listada na solicitação exp. O uso dessa claim é opcional.	N/A	Inteiro
Issued at (iat)	A claim iat (Issued at) identifica a hora em que o JWT foi emitido. Essa declaração pode ser utilizada para determinar a idade do JWT. O seu valor deve ser um número. O uso dessa claim é opcional.	N/A	Inteiro
Subject (sub)	A claim sub (subject) identifica o assunto do JWT. As afirmações em um JWT são normalmente afirmações sobre o assunto. O valor do assunto deve ter como escopo ser exclusivo localmente no contexto do emissor ou ser globalmente exclusivo. O processamento dessa claim é geralmente específico da aplicação. O uso dessa claim é opcional.	N/A	String
Token Id (jti)	A claim jti (JWT ID) fornece um identificador exclusivo para o JWT. O valor do identificador deve ser atribuído de maneira a diminuir ao máximo as chances de que o mesmo valor seja acidentalmente atribuído a um objeto de dados diferentes. Se o aplicativo utilizar vários emissores, as colisões devem ser evitadas também entre os valores produzidos por diferentes emissores. A claim jti pode ser utilizada para evitar que o JWT seja repetido. O uso dessa claim é opcional.	N/A	String
Audience (aud)	Valor único. A claim aud (público) identifica os destinatários do JWT. Cada principal que pretende processar o JWT deve se identificar com um valor dentro da reivindicação dentro da claim. Se o responsável pelo processamento da claim não se identificar com um valor na claim aud quando essa claim estiver presente, o JWT DEVE ser rejeitado. O uso dessa claim é opcional.	N/A	String
Not Before (nbf)	A claim nbf (não antes) identifica o tempo antes do qual o JWT não deve ser aceito para processamento. O processamento da reclamação nbf requer que a data / hora atual SEJA posterior ou igual à data / hora não anterior listada na reclamação nbf. Os implementadores PODEM prever uma pequena margem de segurança - geralmente não mais do que alguns minutos - para compensar a distorção do relógio. O seu valor DEVE ser um número. O uso dessa claim é opcional.	N/A	Inteiro
Custom Claims	Para especificar claims customizadas basta informar a chave (nome da claim) e o valor da claim.	N/A	String
Custom Headers	Para especificar headers customizados, basta informar a chave e o valor do header nos respectivos campos.	N/A	String
JWE	Campo para informar o token JWE.	N/A	String
JWS	Campo para informar o token JWS.	N/A	String
Payload Charset	Charset do payload utilizado na criação de tokens JWE. Valor padrão: UTF-8	UTF-8	String
Payload	Payload que será utilizado na criação do token JWE.	N/A	String
Use JWK	Se a opção estiver habilitada, um JWK é esperado para verificar o token JWT. Esta opção está disponível apenas se Verify JWS estiver selecionada no parâmetro Operation. O Use JWK também desabilita todas as opções de conta (parâmetros Secret Key, Private Key e Public Key), além dos parâmetros Key Charset, Key as Base64 e JWS Algorithm.	False	Booleano
JWK	JWK que será utilizado para verificar o token JWS.	N/A	String
Fail On Error	Se a opção estiver habilitada, a execução do pipeline com erro será interrompida; do contrário, a execução do pipeline continua, mas o resultado mostrará um valor falso para a propriedade success.	False	Booleano

Fluxo de mensagens

Entrada

Não é esperado uma mensagem de entrada específica, bastando apenas preencher os campos necessários de cada operação.

Saída

Para as operações “Generate JWS”:

{
"success": true,
"jws": "<JWS TOKEN>",
}

Para as operações “Generate JWE":

{
"success": true,
"jwe": "<JWE TOKEN>",
}

Para as operações “Verify JWS":

{
"success": true,
"verified": true,
"claims": [
"subject": ".....",
"issuedAt": 11111111
]
}

Para as operações “Decode JWE":

{
"success": true,
"payload": "<PAYLOAD DESCRIPTOGRAFADO>"
}