Como gerenciar chaves de API para a API JS CAPTCHA
Esta seção fornece instruções para gerar e excluir chaves de API.
Para integrar o CAPTCHA do AWS WAF em um aplicativo cliente com a API JavaScript, você precisa da tag de integração da API JavaScript e da chave de API criptografada para o domínio do cliente em que deseja executar o quebra-cabeça CAPTCHA.
A integração do aplicativo CAPTCHA para JavaScript usa chaves de API criptografadas para verificar se o domínio do aplicativo do cliente tem permissão para usar a API CAPTCHA do AWS WAF. Ao chamar a API CAPTCHA do seu cliente JavaScript, você fornece uma chave de API com uma lista de domínios que inclui um domínio para o cliente atual. Você pode listar até 5 domínios em uma única chave criptografada.
Requisitos de chaves de API
A chave de API que você usa na integração do CAPTCHA deve conter um domínio que se aplique ao cliente em que você usa a chave.
-
Se você especificar um
window.awsWafCookieDomainList
na integração de ameaças inteligentes do seu cliente, pelo menos um domínio em sua chave de API deverá corresponder exatamente a um dos domínios de token emwindow.awsWafCookieDomainList
ou deverá ser o domínio apex de um desses domínios de token.Por exemplo, para o domínio do token
mySubdomain.myApex.com
, a chave de APImySubdomain.myApex.com
é uma correspondência exata e a chave de APImyApex.com
é o domínio apex. Qualquer chave corresponde ao domínio do token.Para obter informações sobre a configuração da lista de domínios de tokens, consulte Fornecimento de domínios para uso nos tokens.
-
Caso contrário, o domínio atual deverá estar contido na chave da API. O domínio atual é o domínio que você pode ver na barra de endereço do navegador.
Os domínios que você usa devem ser aqueles que serão aceitos pelo AWS WAF, com base no domínio do host protegido e na lista de domínios de tokens configurada para a web ACL. Para ter mais informações, consulte Configuração da lista de domínios de tokens da ACL da Web no AWS WAF.
Como escolher a região da sua chave de API
O AWS WAF pode gerar chaves de API CAPTCHA em qualquer região em que o AWS WAF esteja disponível.
Como regra geral, você deve usar a mesma região para sua chave de API CAPTCHA que usa para sua ACL da Web. No entanto, se você espera um público global para uma ACL da Web regional, você pode obter uma tag de integração CAPTCHA JavaScript com escopo para o CloudFront e uma chave de API com escopo para o CloudFront, e usá-las com uma ACL da Web regional. Essa abordagem permite que os clientes carreguem um código CAPTCHA da região mais próxima a eles, o que reduz a latência.
As chaves da API CAPTCHA que têm como escopo regiões diferentes do CloudFront não são compatíveis com uso em várias regiões. Elas só podem ser usadas na região para a qual estão previstas.
Para gerar uma chave de API para seus domínios de clientes
Para obter a URL de integração e gerar e recuperar as chaves de API por meio do console.
Faça login no AWS Management Console e abra o console do AWS WAF em https://console.aws.amazon.com/wafv2/
. -
No painel de navegação, escolha Integração de aplicativos.
-
No painel ACLs da Web que estão habilitadas para integração de aplicativos, selecione a região que você deseja usar para a chave de API. Você também pode selecionar a região no painel de Chaves de API da guia de Integração do CAPTCHA.
-
Escolha a guia Integração de CAPTCHA. Essa guia fornece a tag de integração de CAPTCHA JavaScript, que você pode usar em sua integração, e a lista de chaves de API. Ambos têm como escopo a região selecionada.
-
No painel Chaves de API, escolha Gerar chave. A caixa de diálogo de geração de chaves é exibida.
-
Insira os domínios de cliente que você deseja incluir na chave. Você pode inserir até 5. Quando terminar, escolha Gerar chave. A interface retorna à guia de integração do CAPTCHA, onde sua nova chave está listada.
Depois de criada, uma chave de API é imutável. Se você precisar fazer alterações em uma chave, gere uma nova chave e use-a em vez disso.
-
(Opcional) Copie a chave recém-gerada para uso em sua integração.
Você também pode usar as APIs REST ou um dos SDKs da AWS específicos do idioma para esse trabalho. As chamadas de API REST são CreateAPIKey e ListAPIKeys.
Para excluir uma chave de API
Para excluir uma chave de API, você deve usar a API REST ou um dos SDKs da AWS específicos do idioma. A chamada da API REST é DeleteApiKey. Você não pode usar o console para excluir uma chave.
Depois de excluir a chave, pode demorar até 24 horas para o AWS WAF proibir o uso da chave em todas as regiões.