Como utilizar a integração hCaptcha® através do Marketplace da Azion
O hCaptcha® é um serviço CAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart, em inglês) que visa melhorar a privacidade e a segurança do usuário usando desafios que são mais difíceis para os bots resolverem, bem como usando os desafios resolvidos para treinar modelos de aprendizado de máquina para melhorar a segurança geral da internet. Você pode usá-lo para evitar bots, web crawlers e outras ferramentas automatizadas que abusam de seus recursos.
A integração da Azion com hCaptcha® roda nos edge nodes da Azion. Ela garante que apenas requisições autênticas tenham acesso à sua infraestrutura, identificando se a requisição é válida antes de acessar a origem. Em vez de descobrir a lógica de quando, onde e como exibir requisições, você pode acelerar suas requisições simplesmente ativando e configurando os argumentos JSON.
Obtenha a integração
Para instalar a integração fornecida pelo Marketplace da Azion, siga estes passos:
- 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, localizado no canto inferior da direita.
Aparecerá uma mensagem indicando que a integração foi instalada com sucesso.
- Acesse o Real-Time Manager (RTM) > Marketplace.
- Na homepage do Marketplace, selecione o card da integração.
- Quando a página da integração abrir, clique no botão Get It Now, localizado no canto inferior da direita.
Aparecerá uma mensagem indicando que a integração foi instalada com sucesso.
Obtenha as credenciais
Para configurar a integração, você deve fornecer duas chaves: sua secret-key
e sua site-key
. Para obter essas credenciais, você terá que se registrar no site do hCaptcha.
Para fazer isso, siga os passos:
- Acesse o painel do hCaptcha.
- Se você não tem uma conta, você pode criar uma.
- Preste atenção ao criar uma nova conta, porque o site fornecerá sua secret-key. Esta chave secreta será usada para configurar a integração da Azion mais tarde.
- No painel, clique no botão New Site.
- É opcional, mas recomendado, nomear sua instância de hCaptcha.
- Indique os
hostnames
nos quais deseja usar o desafio e clique no botão Add Domain. - Escolha o seu modo de desafio. Você tem três opções:
- Always Challenge (Grátis. Cada requisição carregará um desafio.)
- Passive (Pago. Não há desafio e o CAPTCHA será acionado de acordo com o comportamento do usuário.)
- 99,9% Passive (Pago. O desafio só aparecerá para usuários com alto risco de serem bots.)
- Escolha o limite de aprovação que deseja para o seu site de acordo com o nível de dificuldade: auto (automático), easy (fácil), moderate(moderado) e difficult (difícil). Esses modos determinarão a precisão das respostas do usuário para passar no teste.
- Com tudo preenchido, clique no botão Save no canto superior direito.
Agora seu site está configurado para usar a integração hCaptcha.
Para configurar a integração da Azion, agora você precisa obter a site-key do hCaptcha. Ainda no site hCaptcha, siga estes passos:
- No seu painel, no menu superior, clique em Sites.
- Depois de carregar seus sites listados, encontre o que você configurou na etapa acima.
Na primeira coluna, você verá uma label com uma cadeia de caracteres semelhante a esta:
efdb42c7-10ee-4969-8013-cfcb5f7ad007
. Esta é sua site key. - Passe o cursor sobre a cadeia de caracteres e clique para copiar sua site key.
- Salve a site key e a secret key para configurar a integração da Azion, conforme explicado nas próximas seções.
Configure a integração
Configure uma regra dentro do Edge Firewall
Para iniciar a configuração da integração, 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 seu edge firewall.
- Selecione os domínios que deseja proteger com a função.
- Habilite o switch de Edge Functions.
- Clique no botão Save.
Pronto. Agora você instanciou o edge firewall para sua função e tem acesso a edge functions no seu edge firewall.
- No Products menu, selecione Edge Firewall na seção SECURE.
- Clique no botão Add Rule Set.
- Dê um nome fácil de lembrar ao seu edge firewall.
- Selecione os domínios que deseja proteger com a função.
- Habilite o switch de Edge Functions.
- Clique no botão Save.
Pronto. Agora você instanciou o edge firewall para sua função e tem acesso a edge functions no seu edge firewall.
Configure uma função no Edge Firewall
Para instanciar a integração, enquanto ainda estiver na página do Edge Firewall
- Selecione a aba Functions e siga estas etapas:
- Clique no botão Add Function.
- Dê um nome à sua instância.
- No menu suspenso, selecione a função hCaptcha.
- 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.
- Na aba Args, você passará as suas chaves e suas variáveis:
Onde:
Variável | Obrigatório | Descrição |
---|---|---|
site_key | Sim | A site key que você obteve na página do hCaptcha |
secret_key | Sim | A secret key que você obteve na página do hCaptcha |
expiration_in_seconds | Sim | O tempo em segundos até que o hCaptcha 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 |
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 |
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 do hCaptcha está salva.
- Selecione a aba Functions Instances e siga estas etapas:
- Clique no botão + Function Instance.
- Dê um nome à sua instância.
- No menu suspenso, selecione a função hCaptcha.
- Esta ação irá carregar a aba Arguments, onde você pode adicionar os parâmetros para executar sua aplicação.
- Na aba Arguments, você passará as suas chaves e suas variáveis:
Onde:
Variável | Obrigatório | Descrição |
---|---|---|
site_key | Sim | A site key que você obteve na página do hCaptcha |
secret_key | Sim | A secret key que você obteve na página do hCaptcha |
expiration_in_seconds | Sim | O tempo em segundos até que o hCaptcha 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 |
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 |
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 do hCaptcha 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 à regra.
- 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
. - 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.
Pronto. Agora, a integração está em execução para cada requisição feita ao domínio que você indicou.
- Selecione a aba Rules Engine.
- Clique no botão New Rule.
- Dê um nome à regra.
- 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
. - 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.
Pronto. Agora, a integração está em execução para cada requisição feita ao domínio que você indicou.
Marca registrada
hCaptcha é uma marca registrada da Intuition Machines, Inc.