authentik.stages.captcha.models

 1"""authentik captcha stage"""
 2
 3from django.db import models
 4from django.utils.translation import gettext_lazy as _
 5from django.views import View
 6from rest_framework.serializers import BaseSerializer
 7
 8from authentik.flows.models import Stage
 9
10
11class CaptchaStage(Stage):
12    """Verify the user is human using Google's reCaptcha/other compatible CAPTCHA solutions."""
13
14    public_key = models.TextField(help_text=_("Public key, acquired your captcha Provider."))
15    private_key = models.TextField(help_text=_("Private key, acquired your captcha Provider."))
16
17    interactive = models.BooleanField(default=False)
18
19    score_min_threshold = models.FloatField(default=0.5)  # Default values for reCaptcha
20    score_max_threshold = models.FloatField(default=1.0)  # Default values for reCaptcha
21
22    error_on_invalid_score = models.BooleanField(
23        default=True,
24        help_text=_(
25            "When enabled and the received captcha score is outside of the given threshold, "
26            "the stage will show an error message. When not enabled, the flow will continue, "
27            "but the data from the captcha will be available in the context for policy decisions"
28        ),
29    )
30
31    js_url = models.TextField(default="https://www.recaptcha.net/recaptcha/api.js")
32    api_url = models.TextField(default="https://www.recaptcha.net/recaptcha/api/siteverify")
33
34    @property
35    def serializer(self) -> type[BaseSerializer]:
36        from authentik.stages.captcha.api import CaptchaStageSerializer
37
38        return CaptchaStageSerializer
39
40    @property
41    def view(self) -> type[View]:
42        from authentik.stages.captcha.stage import CaptchaStageView
43
44        return CaptchaStageView
45
46    @property
47    def component(self) -> str:
48        return "ak-stage-captcha-form"
49
50    class Meta:
51        verbose_name = _("Captcha Stage")
52        verbose_name_plural = _("Captcha Stages")