Por padrão, uma chave de API funciona de qualquer lugar. Uma lista de IPs permitidos a prende aos lugares onde o seu código realmente roda.
Como funciona
A borda da API compara o IP de origem de cada requisição com uma lista. Se o endereço estiver na lista, ou dentro de uma faixa listada, a requisição segue para a verificação normal da chave. Caso contrário, é recusada.
As faixas são escritas em notação CIDR: um endereço, uma barra e o tamanho do prefixo. O RFC 4632 explica que o tamanho do prefixo é a quantidade de bits iniciais fixos. Para IPv4:
| Entrada | Abrange |
|---|---|
203.0.113.7 |
um endereço |
198.51.100.0/24 |
256 endereços, de 198.51.100.0 a 198.51.100.255 |
10.0.0.0/16 |
65.536 endereços |
O IPv6 usa a mesma ideia com endereços de 128 bits, como 2001:db8::/48.
O endereço que importa é o seu IP de saída (egress): o endereço público de onde sai o tráfego do servidor. Atrás de NAT, de um load balancer ou de um proxy corporativo, muitas vezes ele não é o endereço que a máquina mostra para si mesma.
Por que importa
Chaves de API são bearer tokens: quem tiver uma pode usá-la. Chaves vazam por commits, logs, capturas de tela e notebooks. Com uma lista de IPs permitidos, uma chave roubada não funciona a partir da rede do atacante, o que transforma um vazamento de incidente de gastos em um não-evento. O GitHub, por exemplo, aplica a sua lista às chamadas de API e aos personal access tokens, além dos logins na web.
O custo é algum trabalho operacional. Cada novo servidor, região ou runner de CI exige adicionar o seu IP de saída, e IPs dinâmicos exigem um caminho de saída fixo.
Na BroadNet Inference
Na página da conta, adicione um endereço IPv4 ou IPv6 ou uma faixa CIDR por linha, até 32 entradas. Uma lista vazia significa nenhuma restrição. Novas chaves herdam a lista da conta. Um allowed_ips por chave a substitui para aquela chave:
curl -X POST https://inference.broadnet.ai/portal/keys \
-H "Authorization: Bearer $BROADNET_PORTAL_CREDENTIAL" \
-H "Content-Type: application/json" \
-d '{"label":"worker-1","allowed_ips":["203.0.113.7","198.51.100.0/24"]}'
Requisições de outros endereços recebem um 403. Depois de uma alteração ou da revogação de uma chave, novas requisições param em até cinco segundos. O passo a passo completo está em chaves de API e listas de IPs permitidos, e a tabela de erros está em erros e novas tentativas. Para o quadro mais amplo de proteção de dados, veja o checklist de ZDR.
Erros comuns
- Listar o endereço privado de um servidor, como
10.x.x.x, em vez do seu IP público de saída. - Usar uma faixa muito ampla para fazer os erros sumirem. Um
/8abrange mais de 16 milhões de endereços.