authentik.stages.user_login.models

 1"""login stage models"""
 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
 9from authentik.lib.utils.time import timedelta_string_validator
10
11
12class NetworkBinding(models.TextChoices):
13    """Network session binding modes"""
14
15    NO_BINDING = "no_binding"
16    BIND_ASN = "bind_asn"  # Bind to ASN only
17    BIND_ASN_NETWORK = "bind_asn_network"  # Bind to ASN and Network
18    BIND_ASN_NETWORK_IP = "bind_asn_network_ip"  # Bind to ASN, Network and IP
19
20
21class GeoIPBinding(models.TextChoices):
22    """Geo session binding modes"""
23
24    NO_BINDING = "no_binding"
25    BIND_CONTINENT = "bind_continent"  # Bind to continent only
26    BIND_CONTINENT_COUNTRY = "bind_continent_country"  # Bind to continent and country
27    BIND_CONTINENT_COUNTRY_CITY = (
28        "bind_continent_country_city"  # Bind to continent, country and city
29    )
30
31
32class UserLoginStage(Stage):
33    """Attach the pending user to the current session."""
34
35    session_duration = models.TextField(
36        default="seconds=0",
37        validators=[timedelta_string_validator],
38        help_text=_(
39            "Determines how long a session lasts. Default of 0 means "
40            "that the sessions lasts until the browser is closed. "
41            "(Format: hours=-1;minutes=-2;seconds=-3)"
42        ),
43    )
44    network_binding = models.TextField(
45        choices=NetworkBinding.choices,
46        default=NetworkBinding.NO_BINDING,
47        help_text=_("Bind sessions created by this stage to the configured network"),
48    )
49    geoip_binding = models.TextField(
50        choices=GeoIPBinding.choices,
51        default=GeoIPBinding.NO_BINDING,
52        help_text=_("Bind sessions created by this stage to the configured GeoIP location"),
53    )
54    terminate_other_sessions = models.BooleanField(
55        default=False, help_text=_("Terminate all other sessions of the user logging in.")
56    )
57    remember_me_offset = models.TextField(
58        default="seconds=0",
59        validators=[timedelta_string_validator],
60        help_text=_(
61            "Offset the session will be extended by when the user picks the remember me option. "
62            "Default of 0 means that the remember me option will not be shown. "
63            "(Format: hours=-1;minutes=-2;seconds=-3)"
64        ),
65    )
66    remember_device = models.TextField(
67        default="days=30",
68        validators=[timedelta_string_validator],
69        help_text=_(
70            "When set to a non-zero value, authentik will save a cookie with a longer expiry,"
71            "to remember the device the user is logging in from. "
72            "(Format: hours=-1;minutes=-2;seconds=-3)"
73        ),
74    )
75
76    @property
77    def serializer(self) -> type[BaseSerializer]:
78        from authentik.stages.user_login.api import UserLoginStageSerializer
79
80        return UserLoginStageSerializer
81
82    @property
83    def view(self) -> type[View]:
84        from authentik.stages.user_login.stage import UserLoginStageView
85
86        return UserLoginStageView
87
88    @property
89    def component(self) -> str:
90        return "ak-stage-user-login-form"
91
92    class Meta:
93        verbose_name = _("User Login Stage")
94        verbose_name_plural = _("User Login Stages")