Ir para o conteúdo

Autenticação de cliente no Jitterbit App Builder

O App Builder pode funcionar como um servidor de autorização OpenID Connect (OIDC). O servidor de autorização permite que aplicações cliente, incluindo outras instâncias do App Builder, autentiquem usuários. O processo de login OIDC produz um token de acesso que permite à aplicação cliente acessar recursos protegidos em nome do usuário. Os recursos protegidos incluem APIs REST e Webhook hospedadas pelo App Builder, bem como fontes de dados do Conector do App Builder.

Suporte a protocolos

O protocolo OIDC é definido pelo padrão OpenID Connect Core 1.0. O OIDC é uma camada de identidade construída sobre a estrutura de autorização OAuth 2.0, que é definida por RFC-6749. Em conjunto, esses padrões descrevem:

  • Fluxos - Um fluxo é um processo pelo qual o cliente obtém tokens de identidade e acesso. Por esse motivo, os fluxos também são chamados de concessões.
  • Endpoints - Cada fluxo envolve uma ou mais solicitações HTTP para URLs conhecidas.
  • Escopos - As aplicações cliente podem solicitar um ou mais escopos. Os escopos determinam quais tokens são emitidos (identidade, atualização), o que está incluído nesses tokens (claims) e quais APIs podem ser acessadas com esses tokens.
  • Claims - Conforme descrito pelo padrão, o token de identidade é fundamentalmente um JSON Web Token (JWT). JWTs são baseados em claims. O escopo solicitado determina quais claims são incluídos no token de identidade.

Fluxos suportados

O servidor de autorização do App Builder suporta os seguintes fluxos OAuth 2.0 básicos:

  • Código de autorização. O fluxo de Código de Autorização permite que o cliente obtenha um token de acesso, que permite ao cliente acessar recursos protegidos em nome do usuário. O fluxo de Código de Autorização é um fluxo interativo: um usuário deve estar presente para iniciar o fluxo de Código de Autorização.
  • Credenciais do cliente. O fluxo de Credenciais do Cliente permite que a aplicação cliente obtenha um token de acesso em nome de si mesma. Este é um fluxo servidor-para-servidor, normalmente operando como uma conta de serviço.
  • Token de atualização. O fluxo de Token de Atualização permite que o cliente solicite um novo token de acesso após o token atual expirar. Isso às vezes é chamado de "acesso offline". O fluxo de token de atualização pode ser usado em combinação com os fluxos de Código de Autorização ou Credenciais do Cliente. O escopo offline_access ativa o fluxo de Token de Atualização (veja abaixo).

Conforme observado acima, o OIDC é construído sobre a estrutura de autorização OAuth 2.0. O OIDC aproveita os fluxos OAuth 2.0, usando o parâmetro scope para ativar a funcionalidade específica de OIDC. O servidor de autorização do App Builder suporta os seguintes fluxos OIDC:

  • Código de autorização. Quando o escopo openid é especificado, o fluxo de Código de Autorização permite que o cliente autentique um usuário retornando um token de identidade adicional. Escopos adicionais determinam quais claims são incluídos no token.
  • Token de atualização. O fluxo de Token de Atualização opera da mesma forma no OIDC que no OAuth 2.0.

O servidor de autorização não suporta nem os fluxos OIDC Implícito nem Híbrido. O fluxo OAuth 2.0 de Credenciais do Cliente não é um fluxo OIDC.

O fluxo de Código de Autorização pode ser usado com ou sem a extensão Proof Key for Code Exchange (PKCE), conforme definido por RFC-7636.

Endpoints suportados

O servidor de autorização do App Builder publica os seguintes endpoints:

Endpoint Padrão Descrição
/connect/authorize RFC-6749 Emite um código de autorização.
/connect/token RFC-6749 Emite um token de acesso.
/connect/introspect RFC-7662 Introspecção de token de acesso.
/connect/userinfo OIDC Core Introspecção de token de identidade.
/.well-known/openid-configuration OIDC Discovery Configuração do provedor OpenID Connect.

Escopos suportados

O servidor de autorização do App Builder suporta os seguintes escopos:

Escopo Descrição
openid Emite um token de identidade OIDC.
profile Inclui claims de perfil do usuário no token de identidade.
email Inclui claims de endereço de e-mail no token de identidade.
phone Inclui claims de número de telefone no token de identidade.
offline_access Emite um token de atualização para uso no fluxo de Token de Atualização.
* Não disponível para clientes públicos
api Autoriza o acesso às APIs REST, Webhook e App Builder Connector hospedadas pelo App Builder.

Claims suportados

Conforme mencionado acima, o token de identidade é um token JWT baseado em claims. O cliente pode determinar quais claims são incluídos no token de identidade especificando escopos.

Escopo Claims
openid sub
profile name, nickname, locale e zoneinfo
email email e email_verified
phone phone_number e phone_number_verified

Para uma descrição de cada um desses claims, consulte a seção 5.1 Standard Claims do padrão OIDC. Qualquer claim padrão não explicitamente listado acima não é suportado.

Configuração

Para usar o servidor de autorização, o administrador do App Builder deve primeiro:

  1. Ativar o servidor de autorização.
  2. Registrar uma aplicação cliente.
  3. Configurar a aplicação cliente.

Ativar o servidor de autorização

Para ativar o servidor de autorização, comece fazendo login no App Builder como administrador:

  1. Clique no link IDE.
  2. Clique no botão Security Providers.
  3. No painel Security Providers, localize o provedor de segurança Authorization Server e clique no ícone Details (Chevron).
  4. Clique no botão Edit.
  5. Marque a opção Enabled.
  6. Clique no botão Save.

Registrar uma aplicação cliente

Cada aplicação cliente que pretende autenticar usuários ou acessar recursos protegidos deve ser registrada. Para registrar uma aplicação cliente, comece fazendo login no App Builder como administrador e siga estas etapas:

  1. Clique no link IDE.
  2. Clique no botão User Management.
  3. Clique no botão Clients.
  4. Clique no botão +Client para registrar uma nova aplicação cliente.
  5. Forneça os seguintes itens:

    • Name: Um nome descritivo e amigável para a aplicação cliente.
    • Description: Uma descrição opcional.
    • User: Selecione a conta do usuário de serviço. Obrigatório para o fluxo Client Credentials. Caso contrário, deixe em branco.
    • Authentication Provider: Selecione um provedor ou deixe em branco.
    • Enabled: Ative ou desative a aplicação cliente.
  6. Clique no botão Save.

  7. (Opcional) Clique em More, depois em Advanced. A caixa de diálogo Advanced Settings é aberta. Ela contém duas abas:

    • Properties: Defina as seguintes configurações conforme necessário:

      • Requires PKCE: Quando selecionado, o cliente deve usar a extensão PKCE. Isso se aplica apenas ao fluxo Authorization Code e é obrigatório para clientes públicos.

      • Public: Quando selecionado, o cliente é público e os segredos não podem ser armazenados com segurança. Quando desmarcado, o cliente é confidencial e pode armazenar segredos com segurança.

    • Token Lifetimes: Insira valores para os seguintes campos conforme necessário:

      • Access Token: Tempo de expiração do token de acesso, em minutos. Padrão: 60.

      • Refresh Token: Tempo de expiração do token de atualização, em minutos. Padrão: 20160 (14 dias).

      • Identity Token: Tempo de expiração do token de identidade, em minutos. Padrão: 20.

      • Authorization Code: Tempo de expiração do código de autorização, em minutos. Padrão: 5.

Gerar um segredo do cliente

A aplicação cliente deve fornecer suas próprias credenciais ao solicitar um token de acesso. As credenciais do cliente consistem no ID do cliente e um segredo do cliente. Segredos do cliente só podem ser gerados para clientes confidenciais. O painel Secrets será oculto para clientes públicos.

Para gerar um segredo do cliente:

  1. No painel Secrets, clique no botão +Secret.
  2. Forneça o seguinte:

    • Description: Descrição opcional do segredo do cliente.
    • Expires On: Se o segredo deve expirar, defina a data e a hora de expiração. Caso contrário, deixe este campo em branco.
  3. Clique no botão Save.

  4. Copie o Client ID e o Client Secret.

AVISO: Esta é a única vez que o segredo ficará visível.

Registrar URI de redirecionamento do cliente

Conforme observado acima, o fluxo de Código de Autorização é um fluxo interativo. Durante este fluxo, o usuário é redirecionado para o endpoint de autorização. Após a autenticação do usuário, ele é redirecionado de volta para a aplicação cliente.

A URL de callback da aplicação cliente é chamada de "redirect URI". Cada redirect URI deve ser registrada. Os redirect URIs do cliente devem estar em conformidade com as seguintes restrições:

  • A URL de redirecionamento do cliente deve ser uma URL absoluta.
  • A URL de redirecionamento do cliente deve usar o protocolo HTTPS. No entanto, a URL de redirecionamento do cliente pode usar o protocolo HTTP ao redirecionar para localhost.
  • A URL de redirecionamento do cliente pode conter uma string de consulta.
  • A URL de redirecionamento do cliente não deve conter um fragmento.

Para registrar um redirect URI do cliente:

  1. No painel Redirects, clique no botão +URL.
  2. Forneça a URL.
  3. Clique no botão Save.

Configurar a aplicação cliente

Qualquer aplicação cliente OIDC ou OAuth 2.0 compatível com os padrões que ofereça suporte aos fluxos de Código de Autorização ou Credenciais do Cliente pode utilizar o servidor de autorização do App Builder. Isso inclui o próprio App Builder: é possível configurar uma segunda instância do App Builder como cliente.

Para configurar o cliente do App Builder, você precisará de:

  • URL raiz do servidor de autorização do App Builder, por exemplo https://example.com/Vinyl.
  • Client ID e segredo (veja acima)

Comece fazendo login na instância cliente do App Builder como administrador:

  1. Clique no link IDE.
  2. Clique no botão Security Providers.
  3. Clique no botão + Security Provider.
  4. Forneça o seguinte:

    • Name: Nome do provedor de segurança, por exemplo App Builder.
    • Type: App Builder / OpenID Connect
    • Show On Login Form: Marque esta opção para exibir a opção de login no formulário de login.
    • User Provisioning: Marque esta opção para ativar o provisionamento de usuários.
  5. Clique no botão Save.

  6. No painel Endpoints, clique no botão +Endpoint.
  7. Forneça o seguinte:

    • Endpoint Type: OpenID Connect Issuer
    • URL: A URL raiz do servidor de autorização do App Builder.
  8. Clique no botão Save.

  9. No painel Credentials, clique no botão +Credential.
  10. Forneça o seguinte:

    • Type: Client
    • User Name: O Client ID (veja acima).
    • Password: O Client Secret (veja acima).
  11. Clique no botão Save.

  12. No painel Provider, clique no botão Edit.
  13. Marque a opção Enabled.
  14. Clique no botão Save.

Após a conclusão, os usuários poderão fazer login na instância cliente do App Builder usando o servidor de autorização do App Builder.

Limitações conhecidas

O servidor de autorização do App Builder não oferece suporte aos seguintes recursos

  • Consentimento do usuário.
  • Fluxos OIDC Implicit ou Hybrid