Configurando a autenticação do aplicativo para uma API.

Editar online

Com este tópico, você pode configurar a autenticação de aplicativos para uma API.

Sobre essa tarefa

Lembre-se: enviar o certificado do cliente no cabeçalho ` HTTP ` não permite a verificação criptográfica de que o remetente possui a chave privada correspondente. A única validação realizada é uma comparação de strings entre o arquivo base64-encoded PEM e o certificado público, que você pode configurar seguindo as etapas abaixo.
Nota: esta tarefa está relacionada à configuração de uma definição de API do OpenAPI 2.0 Para obter detalhes sobre como configurar uma definição de API OpenAPI 3.0 , consulte Editando uma definição de API OpenAPI 3.0.

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

A qualquer momento, você pode acessar diretamente o arquivo YAML de origem do ` OpenAPI ` clicando no ícone "Fonte Ícone de origem OpenAPI". Para voltar ao formulário de criação, clique no ícone Ícone de formulárioFormulário.

Procedimento

  1. Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 2.0 ..
  2. Ativar autenticação do aplicativo, conforme a seguir:
    Nota: para identificar o aplicativo, você deve ativar um requisito de segurança do tipo clientID.
    1. Na página “Design da API”, selecione a guia “Gateway” e expanda “Configurações do gateway e do portal ”.
    2. No painel de navegação, clique em "Autenticação de aplicativos".
  3. Você pode escolher se um certificado de cliente será enviado como um certificado de cliente do tipo ` TLS ` ou no cabeçalho ` HTTP `. Especifique como o certificado do cliente é enviado ao gateway, da seguinte forma:

    Você pode optar por enviar o certificado do cliente como um certificado de cliente do tipo ` TLS ` ou incluí-lo no cabeçalho ` HTTP ` da API.

    1. No painel de navegação, clique em "Autenticação de aplicativos".
      Quaisquer definições de origem de autenticação do aplicativo existentes são listadas
    2. Na página "Autenticação do aplicativo ", selecione "Certificado".
    3. No painel "Aplicativo ", clique em "Fonte de autenticação do aplicativo".
    4. Na página “Fonte de autenticação do aplicativo ”, clique em “Adicionar ”.
    5. Na caixa de diálogo “Adicionar shema ”, selecione.
      • tls-cert - Quando a API é chamada, o certificado do cliente TLS é enviado ao serviço Gateway e é usado para verificar se o chamador da API possui a chave privada correspondente.
      • cabeçalho - Ao chamar a API, é necessário fornecer um certificado de cliente do tipo “ X509 ” no cabeçalho “ HTTP ” especificado. Para qualquer aplicativo do Catálogo de Consumidores que chame a API, o certificado deve ser inserido na interface do usuário do Catálogo de Consumidores; para mais detalhes, consulte “Registrando um aplicativo”. Se você estiver usando um balanceador de carga, ele deverá ser configurado para usar o cabeçalho de HTTP especificado para retransmitir o certificado de cliente apropriado para o serviço de Gateway após o balanceador de carga finalizar a comunicação TLS.
      Atenção: o envio do certificado do cliente no cabeçalho ` HTTP ` não permite a verificação criptográfica de que o remetente possui a chave privada correspondente. A única validação realizada é uma comparação de strings entre o arquivo base64-encoded PEM e o certificado do cliente.
  4. Clique em Incluir.
  5. Clique em Salvar para salvar as mudanças.