Segurança do Cliente

A política Client Security pode ser usada para estender o acesso de autenticação de cliente para suas APIs.

Tabela 1. Tabela que mostra quais gateways suportam esta política e a versão correspondente da política
Gateway	Versão da política
DataPower® API Gateway	2.0.0

Este tópico descreve como configurar a política na interface de usuário do Assembly; para obter detalhes sobre como configurar a política na sua fonte do OpenAPI, consulte client-security.

Sobre

Use a política Segurança do cliente para criar uma ação de conjunto que seja separada da especificação OpenAPI para permitir mais opções para autenticar um aplicativo. Observe que não é possível usar a política client-security para executar o cumprimento de limitação de taxa

Em uma ação de segurança do cliente, você define as seguintes configurações.

Determina se o processamento deve ser interrompido caso a segurança do cliente falhe. Quando a segurança do cliente falha, o processamento da montagem é interrompido e é retornado um erro.
Controle se o segredo do cliente deve ser exigido. Quando necessário, o segredo é comparado ao segredo registrado no aplicativo identificado pelo ID do cliente.
Defina o método para extrair as credenciais do cliente da solicitação.
- Para todos os métodos, exceto HTTP use as propriedades ID Name e Secret Name para especificar o local que contém o ID e o local que contém o segredo.
  - Ao referir-se a um cookie, especifique qual.
  - Se for uma variável de contexto, especifique qual variável de contexto de tempo de execução.
  - Quando Formulário, especifique os dados do formulário..
  - Ao selecionar “Cabeçalho”, especifique qual cabeçalho.
  - Quando Consultar, especifique qual parâmetro de consulta.
- Para o método HTTP use a propriedade HTTP Type para especificar o formato do cabeçalho de autorização, que espera o formulário Basic no formato basic base64_id:secret .
Defina o método para autenticar as credenciais do cliente extraídas. Os métodos suportados são Nativo (isso significa usar IBM® API Connect) ou usando um registro do usuário Terceiro especificado.
- Se Terceiro, use a propriedade Nome do Registro do Usuário para especificar o registro do usuário para autenticar as credenciais do cliente extraídas. Os tipos de registro suportados são LDAP e URL de autenticação.

Propriedades

A tabela a seguir lista as propriedades de política, indica se uma propriedade é necessária, especifica os valores válidos e padrão para entrada e especifica o tipo de dados dos valores.

Tabela 2. Propriedades da política de segurança do cliente
Rótulo da propriedade	Obrigatório	Descrição	Tipo de dados
Título	Não	O título da política. O valor padrão é `client-security`.	sequência
Descrição	Não	Uma descrição da política.	sequência
Parar em caso de erro	True	Se essa configuração estiver ativada, o processamento do conjunto será parado se a segurança do cliente falhar e um erro será retornado. A caixa de opções é selecionada por padrão.	booleano
Segredo necessário	True	Se essa configuração estiver ativada, o segredo do cliente deverá ser enviado na solicitação. O segredo é comparado com o segredo registrado no aplicativo que é identificado pelo ID do cliente. A caixa de opções é selecionada por padrão.	booleano
Método de extração de credencial	True	Selecione uma das opções a seguir para definir como o aplicativo de chamada é autenticado: Cabeçalho: as credenciais de ID e segredo do cliente devem ser fornecidas no cabeçalho da solicitação. Consulta: as credenciais de ID e segredo do cliente devem ser fornecidas na URL da solicitação. Formulário: as credenciais de ID e segredo do cliente devem ser fornecidas como dados de formulário enviados em uma solicitação de POST. Cookie: as credenciais de ID e segredo do cliente devem ser fornecidas em um cabeçalho denominado `Cookie`. HTTP: o aplicativo de chamada deve ser autenticado usando a autenticação básica. Variável de contexto : as credenciais utilizadas para autenticar o cliente são obtidas a partir das variáveis de contexto definidas no fluxo de montagem antes da política de segurança do cliente, utilizando, por exemplo, uma política de autenticação de usuário ( GatewayScript ). Os nomes dessas variáveis de contexto são determinados pelos valores fornecidos nas propriedades Nome do ID e Nome do segredo da política de segurança do cliente. O valor padrão é Cabeçalho.	sequência
Nome do ID	Sim, a menos que o valor selecionado de Método de extração de credencial seja HTTP	O nome do parâmetro cujo valor especifica o ID do cliente. Para todas as opções de Método de extração de credencial diferentes de Variável de contexto e de HTTP, o aplicativo de chamada deve fornecer um parâmetro com esse nome, no local definido pela opção Método de extração de credencial. Para a opção Variável de contexto, essa propriedade especifica o nome de uma variável de contexto. Essa propriedade não será aplicável se o Método de extração de credencial for HTTP.	sequência
Nome do segredo	Sim, se Segredo necessário estiver ativado e o valor selecionado de Método de extração de credencial for diferente de HTTP	O nome do parâmetro cujo valor especifica o segredo do cliente. Para todas as opções de Método de extração de credencial diferentes de Variável de contexto e de HTTP, o aplicativo de chamada deve fornecer um parâmetro com esse nome, no local definido pela opção Método de extração de credencial. Para a opção Variável de contexto, essa propriedade especifica o nome de uma variável de contexto. Essa propriedade não será aplicável se o Método de extração de credencial for HTTP.	sequência
Tipo de HTTP	Sim, se o valor selecionado de Método de extração de credencial for HTTP	O tipo de autenticação. Atualmente, a única opção disponível é Básica.
Método de autenticação do cliente	True	Selecione uma das opções a seguir: Nativo: somente o ID e o segredo do cliente são usados para autenticar o cliente. Se o valor selecionado de Método de extração de credencial for HTTP, o aplicativo de chamada deverá fornecer o ID do cliente para o nome do usuário e o segredo do cliente para a senha. Terceiro: um registro do usuário é usado para autenticar o cliente. Se o valor selecionado de Método de extração de credencial for diferente de HTTP, o aplicativo de chamada deverá fornecer o nome do usuário para o ID do cliente e a senha para o segredo do cliente. O valor padrão é Nativo.	sequência
Nome do registro do usuário	Sim, se o valor selecionado de Método de autenticação do cliente for Terceiro	Selecione o registro do usuário que será usado para autenticar o cliente. Os tipos de registro suportados são LDAP e URL de autenticação.	sequência