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:
- Acesse o Azion Console > Marketplace.
- Na homepage do Marketplace, selecione o card da integração.
- 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:
- Se você não tiver uma Conta do Google, será solicitado que crie uma.
- Uma vez inscrito, você será redirecionado para a página de registro no site.
- 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://
ouhttps://
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.
- 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:
- No Products menu, selecione Edge Firewall na seção SECURE.
- Clique no botão + Edge Firewall.
- Dê um nome fácil de lembrar ao edge firewall.
- Habilite o switch Edge Functions para habilitar que você rode edge functions.
- 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:
- Selecione a aba Functions Instances.
- Clique no botão + Function Instance.
- Dê um nome fácil de lembrar à sua instância.
- No menu suspenso, selecione a função reCAPTCHA.
- Esta ação carregará a aba Arguments.
- Na aba Arguments, 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ável | Obrigatório | Descrição |
---|---|---|
site_key | Sim | A site key que você obteve na página reCAPTCHA |
secret_key | Sim | A secret key que você obteve na página reCAPTCHA |
expiration_in_seconds | Sim | O tempo em segundos até que o reCAPTCHA expire |
origin_address | Sim | Seu domínio a partir do qual a função buscará o conteúdo após o usuário resolver o desafio CAPTCHA |
origin_headers | Não | Sempre que o acesso à origem exigir o uso de cabeçalhos de requisição específicos |
captcha_args | Não | Essas variáveis modificam e personalizam o layout da caixa de desafio |
custom_message | Não | Uma mensagem personalizada que você deseja mostrar aos usuários |
custom_html | Não | O HTML personalizado para renderizar a caixa de desafio do reCaptcha |
cookie_secret | Sim | Este cookie é gerado pela função e usado para que as funções não sejam executadas novamente |
- 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:
- Selecione a aba Rules Engine.
- Clique no botão + Rule Engine.
- Dê um nome fácil de lembrar à sua nova regra.
- Selecione um criteria (critério) para executar a integração.
- Exemplo: if
Host
matchesyourdomain.com
.
- Abaixo, selecione um behavior (comportamento) para os criteria (critérios). Neste caso, será Run Function.
- Selecione a função adequada de acordo com o nome que você deu na etapa de instanciação.
- Clique no botão Save.
Agora, no Console, você deve configurar seu domínio para que ele seja protegido pelo seu edge firewall.
- No Products menu, selecione Domains.
- Clique no domínio que você deseja proteger com sua função reCAPTCHA.
- Na seção Settings, clique no seletor de
Edge Firewall
e escolha o edge firewall que você acabou de criar. - 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