Como utilizar a integração reCaptcha através do Marketplace da Azion

reCaptcha é uma integração serverless disponível no Marketplace da Azion. Esse tipo de integração é usado principalmente para proteger domínios contra bots e permite que você monitore o tráfego em seu site usando o Painel do Google para reCAPTCHA.

reCAPTCHA é uma integração CAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart, em inglês) projetada para proteger sites de bots e scripts automatizados utilizando um teste de desafio-resposta para determinar se o usuário é um humano ou uma máquina.

O Google é dono e responsável da manutenção do reCAPTCHA e usa os dados coletados pelo reCAPTCHA para melhorar seus serviços.


Obtenha a integração

Para instalar a integração reCAPTCHA fornecida pelo Marketplace da Azion:

  1. Acesse o Azion Console > Marketplace.
  2. Na homepage do Marketplace, selecione o card da integração.
  3. Quando a página da integração abrir, clique no botão Install.

Você receberá uma mensagem indicando que sua integração foi instalada com sucesso.


Obtenha as credenciais no site reCAPTCHA do Google

Para usar a integração reCAPTCHA da Azion, você deve fornecer duas chaves: sua secret-key e sua site-key. Para obter essas credenciais, você terá que se registrar no Google.

Para fazer isso, siga os passos:

  1. Acesse o painel de administração do Google reCAPTCHA.
  • Se você não tiver uma Conta do Google, será solicitado que crie uma.
  1. Uma vez inscrito, você será redirecionado para a página de registro no site.
  2. Nesta página, você deve preencher:
    • Um nome para o seu novo site que usará reCAPTCHA.
    • A versão do reCAPTCHA que você deseja usar (você pode escolher entre v2 ou v3).
      • Se você escolher a v2, será solicitado que escolha o tipo de teste que deseja aplicar em seu site. As opções são: “I’m not a robot checkbox”, “Invisible reCaptcha” e “reCaptcha Android”.
      • Importante: a integração reCAPTCHA da Azion foi concebida para funcionar com a opção v2 invisível.
    • O domínio onde você deseja executar o reCAPTCHA. Lembre-se de ignorar o http://ou https:// para adicionar o nome de domínio.
    • Você precisa aceitar os termos de serviço.
    • Você tem que escolher se deseja receber alertas do Google sobre seu site, como erros de configuração e outros.
  3. Depois de preencher todas as informações, clique no botão Submit.

Agora você tem seu site registrado para usar o reCAPTCHA. Na próxima tela, você receberá suas chaves: Site Key e Secret Key.

Essas duas chaves serão usadas para configurar a integração reCAPTCHA da Azion posteriormente.


Configure a integração

Configure um edge firewall

Para iniciar a configuração da reCaptcha, complete estes passos:

  1. No Products menu, selecione Edge Firewall na seção SECURE.
  2. Clique no botão + Edge Firewall.
  3. Dê um nome fácil de lembrar ao edge firewall.
  4. Selecione os domínios que deseja proteger com a função.
  5. Habilite o switch Edge Functions para habilitar que você rode edge functions.
  6. Clique no botão Save.

Pronto. Você instanciou o edge firewall para sua função.

Configure uma função no Edge Firewall

Para instanciar a integração hCaptcha, enquanto ainda estiver na página do Edge Firewall:

  1. Selecione a aba Functions e siga estas etapas:
  2. Clique no botão Add⁠ Function.
  3. Dê um nome fácil de lembrar à sua instância.
  4. No menu suspenso, selecione a função reCAPTCHA.
  • Esta ação carregará a função, mostrando um formulário com o código-fonte desta e, logo acima dele, duas abas: Code e Args. Ao clicar na aba Code, você poderá navegar pelo código-fonte, mas não poderá alterá-lo.
  1. Na aba Args, você passará as duas chaves que você obteve no site hCaptcha e suas variáveis:
{
"site_key": "efdb42c7-10ee-4969-8013-cfcb5f7ad007",
"secret_key": "0x11c8eB6e78Bd45f058876aF59ac2fB782nbdswqu",
"cookie_secret": "A key to sign the cookies",
"expiration_in_seconds": 3600,
"origin_address": "https://xxxxxxxx.map.azionedge.net",
"origin_headers": {
"X-Custom": "value",
"X-Another-Custom": "another-value"
},
"captcha_args": {
"theme": "dark",
"size": "compact",
"custom_message": "My message",
"custom_html": "<html>... <!-- azion_captcha --> .. </html>"
}
}

Onde:

VariávelObrigatórioDescrição
site_keySimA site key que você obteve na página reCAPTCHA
secret_keySimA secret key que você obteve na página reCAPTCHA
expiration_in_secondsSimO tempo em segundos até que o reCAPTCHA expire
origin_addressSimSeu domínio a partir do qual a função buscará o conteúdo após o usuário resolver o desafio CAPTCHA
origin_headersNãoSempre que o acesso à origem exigir o uso de cabeçalhos de requisição específicos
captcha_argsNãoEssas variáveis modificam e personalizam o layout da caixa de desafio
custom_messageNãoUma mensagem personalizada que você deseja mostrar aos usuários
custom_htmlNãoO HTML personalizado para renderizar a caixa de desafio do reCaptcha
cookie_secretSimEste cookie é gerado pela função e usado para que as funções não sejam executadas novamente
  1. Clique no botão Save para salvar suas configurações.

Pronto. Agora sua instância reCAPTCHA está salva.

Configure o Rules Engine

Para finalizar o processo, é necessário configurar os parâmetros behavior (comportamento) e criteria (critério) para executar a função.

Ainda na página do Edge Firewall:

  1. Selecione a aba Rules Engine.
  2. Clique no botão + Rule Engine.
  3. Dê um nome à regra.
  4. Selecione um criteria para executar e selecione os domínios nos quais você deseja executar a integração. Exemplo: if Hostname is equal xxxxxxxxxxxx.map.azionedge.net/classes.
  5. Abaixo, selecione um behavior (comportamento) para os criteria (critérios). Neste caso, será Run Function.
    • Selecione a função reCaptcha adequada de acordo com o nome que você deu na etapa de instanciação.
  6. Clique no botão Save.

Pronto. Agora a integração reCAPTCHA está em execução para cada requisição feita ao domínio que você indicou.


Contribuidores