Uma parte importante do gerenciamento de APIs ao longo de seu ciclo de vida é o controle granular do acesso às APIs e do roteamento de tráfego. Os tokens de acesso se consolidaram como o padrão de fato para gerenciar o acesso às APIs. Uma das vantagens dos esquemas de autenticação baseados em JSON Web Tokens (JWTs) é a possibilidade de aproveitar as declarações contidas no JWT para implementar esse nível granular de controle de acesso. As permissões podem ser codificadas como declarações personalizadas, que os proprietários de APIs podem usar para controlar o acesso às suas APIs. Depois que o proxy de API valida o JWT, ele passa a ter acesso a todos os campos do token como variáveis e pode usá-los como base para tomar decisões de acesso.
Em uma publicação anterior, discutimos como o API Connectivity Manager pode ajudar operadores e desenvolvedores a trabalharem melhor em conjunto. As equipes das diferentes linhas de negócios que possuem e operam APIs precisam de controle total à medida que desenvolvem e aprimoram a experiência de suas APIs e serviços.
API Connectivity Manager fornece políticas que permitem aos proprietários de APIs definir configurações no nível do serviço, como autenticação e autorização de APIs, além de requisitos adicionais de segurança. Neste artigo, mostramos como os proprietários de APIs podem usar a política de Access Control Routing para aplicar um controle granular a rotas específicas e ajustá-lo ainda mais para que seja aplicado por método HTTP e por rota, com base em declarações específicas contidas no token.
Pré-requisitos
Você deve ter uma assinatura de avaliação ou paga do F5 NGINX Management Suite, que inclui o Instance Manager e o API Connectivity Manager, além do NGINX Plus como gateway de API e do NGINX App Protect para proteger suas APIs. Para começar, solicite uma avaliação gratuita de 30 dias do NGINX Management Suite.
Para obter instruções sobre como instalar o NGINX Management Suite e o API Connectivity Manager, consulte o Guia de instalação.
Concessão de acesso e roteamento de tráfego para um serviço específico
Digamos que publicamos um proxy de API de armazém com vários endpoints, como inventory, orders e assim por diante. Agora, queremos introduzir um novo serviço chamado pricing, mas torná-lo acessível apenas a alguns clientes que se inscreveram para uma avaliação beta. Esses clientes são identificados por uma declaração chamada betatester. Neste token de acesso de exemplo, essa declaração é true para o usuário identificado na declaração sub, user1@abc.com.
Header
{
"kid": "123WoAbc4xxxX-o8LiartvSA9zzzzzLIiAbcdzYx",
"alg": "RS256"
}
Payload
{
"ver": 1,
"jti": "AT.xxxxxxxxxxxx",
"iss": "https://oauthserver/oauth2/", "aud": "inventoryAPI", "iat": 1670290877, "exp": 1670294477, "cid": "AcvfDzzzzzzzzz", "uid": "yyyyyyyWPXulqE4x6", "scp": [ "apigw" ], "auth_time": 1670286138, "sub": "user1@abc.com", "betatester": true, "domain": "abc" }Para user2@abc.com, que não foi selecionado para o programa beta, a declaração betatester é definida como
false:
"sub": "user2@abc.com","betatester": false,Agora, configuramos a política de Roteamento de Controle de Acesso (access-control-routing) para conceder acesso ao serviço pricing aos usuários cujo JWT contém a declaração betatester com o valor true.
Para simplificar, mostramos apenas o payload da política. Essa política funciona somente com políticas baseadas em token no API Connectivity Manager, como JWT Assertion e OAuth2 Introspection.
"policies": { "access-control-routing": [
{
"action": {
"conditions": [
{
"allowAccess": {
"uri": "/pricing"
},
"when": [
{
"key": "token.betatester",
"matchOneOf": {
"values": [
"true"
]
}
}
]
}
],
"returnCode": 403
}
}
]
}Depois que aplicamos a política, o proxy de API valida as declarações no JWT dos usuários autenticados, realizando um controle de acesso granular para encaminhar as solicitações de user1@abc.com e rejeitar as solicitações de user2@abc.com.
Controle do uso de métodos específicos
Podemos ajustar ainda mais a política access-control-routing para controlar quais usuários podem usar métodos HTTP específicos. Neste exemplo, o proxy de API permite que apenas administradores (usuários cujo token inclui o valor Admin) usem o método DELETE.
"policies":{ "access-control-routing":[
"action":{
"conditions":[
{
"when":[
{
"key":"token.{claims}",
"matchOneOf":{
"values":[
"Admin"
]
}
}
],
"allowAccess":{
"uri":"/v1/customer",
"httpMethods":[
"DELETE"
]
},
"routeTo" : {
"targetBackendLabel" : ""
}
}
]
}
]
}Roteamento baseado em cabeçalhos
Outro uso da política access-control-routing é tomar decisões de roteamento com base nos valores dos cabeçalhos das solicitações recebidas. Os proprietários de APIs podem configurar regras ou condições que especifiquem os valores de cabeçalho que devem corresponder para que a solicitação seja roteada. As solicitações que contêm o cabeçalho são encaminhadas; caso contrário, são descartadas.
Neste exemplo, uma solicitação é encaminhada para o endpoint /seasons somente quando o cabeçalho de solicitação version tem o valor v1. O valor de returnCode especifica o código de erro a ser retornado quando version não for v1 – neste caso, 403 (Proibido).
"access-control-routing": [ {
"action": {
"conditions": [
{
"allowAccess": {
"uri": "/seasons"
},
"when": [
{
"key": "header.version",
"matchOneOf": {
"values": [
"v1"
]
}
}
]
}
],
"returnCode": 403
}
}
]Neste exemplo de requisição curl, enviamos uma solicitação ao serviço seasons com o cabeçalho version definido como v2:
curl -H "version: v2" http://example.com/seasonsComo o valor do cabeçalho version não é v1, conforme exigido pela política, o serviço retorna o código de status 403.
Inclusão de várias regras na política
Você pode incluir várias regras em uma política de roteamento com controle de acesso para controlar o roteamento com base em um, dois ou todos os três critérios abordados nesta publicação: declarações JWT, métodos válidos e valores de cabeçalhos de solicitação. Para ser roteada, uma solicitação deve atender às condições de todas as regras; caso contrário, ela será bloqueada.
Resumo
O API Connectivity Manager permite que os proprietários de APIs controlem e aprimorem a experiência de suas APIs e serviços com políticas no nível da API que aplicam um controle de acesso granular e tomam decisões de roteamento dinâmico.
Para começar a usar o API Connectivity Manager, solicite uma avaliação gratuita de 30 dias do NGINX Management Suite.
Publicações relacionadas no blog

Como o F5 NGINX One aprimora o gerenciamento e a observabilidade
Descubra como o F5 NGINX One aprimora o gerenciamento e a observabilidade de ambientes híbridos e multicloud ao oferecer um console web centralizado baseado em SaaS, com insights em tempo real, conformidade automatizada e gerenciamento simplificado de configurações.

Do OpenAPI ao NGINX como gateway de API usando uma API declarativa
Descubra como transformar uma definição de esquema OpenAPI em uma configuração NGINX totalmente funcional, operando como um API Gateway com a segurança de um Web Application Firewall e um Portal do Desenvolvedor, usando uma abordagem declarativa de API.

Como gerenciar picos repentinos de tráfego e sobrecarga do servidor
Picos de tráfego e sobrecarga de servidores são preocupações sérias para varejistas online em qualquer época, mas especialmente durante a “Cyber Season” de compras de fim de ano. Detalhamos como você pode aproveitar as soluções de entrega de aplicações de nível de produção da NGINX para se preparar para aumentos repentinos de tráfego.

Distribuição segura de chaves privadas SSL com o NGINX
Descrevemos três maneiras progressivamente mais seguras de proteger chaves privadas SSL ao configurar o NGINX para processar tráfego HTTPS: permitir acesso de leitura apenas ao usuário root, criptografar as chaves com senhas armazenadas separadamente e distribuir as senhas a partir de um repositório central.
Agrupando solicitações de API em lotes com NGINX Plus e o módulo JavaScript do NGINX
O módulo JavaScript do NGINX lançado com o NGINX Plus R15 oferece suporte a subsolicitações, possibilitando uma classe totalmente nova de casos de uso para o NGINX Plus. Este exemplo completo também usa a API do NGINX Plus e os módulos de chave-valor para converter solicitações de API dos clientes em solicitações separadas para as APIs dos microsserviços que compõem um aplicativo.
Como superar o esgotamento de portas efêmeras no NGINX e no NGINX Plus
Confira dicas para evitar o esgotamento de portas efêmeras com ajustes no kernel do Linux, conexões keepalive e conexões vinculadas dinamicamente a endereços IP locais.