Gerenciamento de chaves de API para a API JS CAPTCHA - AWS WAF, AWS Firewall Manager, e AWS Shield Advanced

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Gerenciamento de chaves de API para a API JS CAPTCHA

Para integrar o AWS WAF CAPTCHA em um aplicativo cliente com a JavaScript API, você precisa da tag de integração da JavaScript API e da chave de API criptografada para o domínio do cliente em que deseja executar o quebra-cabeça do CAPTCHA.

A integração do aplicativo CAPTCHA JavaScript usa as chaves de API criptografadas para verificar se o domínio do aplicativo cliente tem permissão para usar a API AWS WAF CAPTCHA. Ao chamar a API CAPTCHA do seu JavaScript cliente, 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 em window.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 API mySubdomain.myApex.com é uma correspondência exata e a chave de API myApex.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 AWS WAF serão aceitos, com base no domínio de host protegido e na lista de domínios de token configurada para a Web ACL. Para ter mais informações, consulte AWS WAF configuração da lista de domínios do token Web ACL.

Como escolher a região para sua chave de API

AWS WAF pode gerar chaves de API CAPTCHA em qualquer região onde 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, pode obter uma tag de JavaScript integração CAPTCHA com escopo CloudFront e uma chave de API com escopo definido e usá-las com uma ACL da web regional. CloudFront Essa abordagem permite que os clientes carreguem um quebra-cabeça CAPTCHA da região mais próxima a eles, o que reduz a latência.

As chaves da API CAPTCHA com escopo definido para regiões diferentes das não CloudFront são suportadas para uso em várias regiões. Eles só podem ser usados na região para a qual se destinam.

Para gerar uma chave de API para seus domínios de clientes

Para obter o URL de integração e gerar e recuperar as chaves de API por meio do console.

  1. Faça login no AWS Management Console e abra o AWS WAF console em https://console.aws.amazon.com/wafv2/.

  2. No painel de navegação, escolha Integração de aplicativos.

  3. No painel Web ACLs habilitadas para integração de aplicativos, selecione a região que você deseja usar para sua chave de API. Você também pode selecionar a região no painel de chaves de API da guia de integração CAPTCHA.

  4. Escolha a guia Integração de CAPTCHA. Essa guia fornece a tag de JavaScript integração CAPTCHA, que você pode usar em sua integração, e a lista de chaves de API. Ambos têm como escopo a região selecionada.

  5. No painel Chaves de API, escolha Gerar chave. A caixa de diálogo de geração de chaves é exibida.

  6. 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.

  7. (Opcional) Copie a chave recém-gerada para uso em sua integração.

Você também pode usar as APIs REST ou um dos AWS SDKs específicos da linguagem para esse trabalho. As chamadas da 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 AWS SDKs específicos da linguagem. A chamada da API REST é DeleteApiKey. Você não pode usar o console para excluir uma chave.

Depois de excluir uma chave, pode levar até 24 horas para AWS WAF proibir o uso da chave em todas as regiões.