authentik.brands.models

  1"""brand models"""
  2
  3from uuid import uuid4
  4
  5from django.db import models
  6from django.http import HttpRequest
  7from django.utils.translation import gettext_lazy as _
  8from rest_framework.serializers import Serializer
  9from structlog.stdlib import get_logger
 10
 11from authentik.admin.files.fields import FileField
 12from authentik.admin.files.manager import get_file_manager
 13from authentik.admin.files.usage import FileUsage
 14from authentik.crypto.models import CertificateKeyPair
 15from authentik.flows.models import Flow
 16from authentik.lib.models import SerializerModel
 17
 18LOGGER = get_logger()
 19
 20
 21class Brand(SerializerModel):
 22    """Single brand"""
 23
 24    brand_uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4)
 25    domain = models.TextField(
 26        help_text=_(
 27            "Domain that activates this brand. Can be a superset, i.e. `a.b` for `aa.b` and `ba.b`"
 28        )
 29    )
 30    default = models.BooleanField(
 31        default=False,
 32    )
 33
 34    branding_title = models.TextField(default="authentik")
 35
 36    branding_logo = FileField(default="/static/dist/assets/icons/icon_left_brand.svg")
 37    branding_favicon = FileField(default="/static/dist/assets/icons/icon.png")
 38    branding_custom_css = models.TextField(default="", blank=True)
 39    branding_default_flow_background = FileField(
 40        default="/static/dist/assets/images/flow_background.jpg",
 41    )
 42
 43    flow_authentication = models.ForeignKey(
 44        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_authentication"
 45    )
 46    flow_invalidation = models.ForeignKey(
 47        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_invalidation"
 48    )
 49    flow_recovery = models.ForeignKey(
 50        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_recovery"
 51    )
 52    flow_unenrollment = models.ForeignKey(
 53        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_unenrollment"
 54    )
 55    flow_user_settings = models.ForeignKey(
 56        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_user_settings"
 57    )
 58    flow_device_code = models.ForeignKey(
 59        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_device_code"
 60    )
 61    flow_lockdown = models.ForeignKey(
 62        Flow, null=True, on_delete=models.SET_NULL, related_name="brand_lockdown"
 63    )
 64
 65    default_application = models.ForeignKey(
 66        "authentik_core.Application",
 67        null=True,
 68        default=None,
 69        on_delete=models.SET_DEFAULT,
 70        help_text=_(
 71            "When set, external users will be redirected to this application after authenticating."
 72        ),
 73    )
 74
 75    web_certificate = models.ForeignKey(
 76        CertificateKeyPair,
 77        null=True,
 78        default=None,
 79        on_delete=models.SET_DEFAULT,
 80        help_text=_("Web Certificate used by the authentik Core webserver."),
 81        related_name="+",
 82    )
 83    client_certificates = models.ManyToManyField(
 84        CertificateKeyPair,
 85        default=None,
 86        blank=True,
 87        help_text=_("Certificates used for client authentication."),
 88    )
 89    attributes = models.JSONField(default=dict, blank=True)
 90
 91    def branding_logo_url(self) -> str:
 92        """Get branding_logo URL"""
 93        return get_file_manager(FileUsage.MEDIA).file_url(self.branding_logo)
 94
 95    def branding_logo_themed_urls(self) -> dict[str, str] | None:
 96        """Get themed URLs for branding_logo if it contains %(theme)s"""
 97        return get_file_manager(FileUsage.MEDIA).themed_urls(self.branding_logo)
 98
 99    def branding_favicon_url(self) -> str:
100        """Get branding_favicon URL"""
101        return get_file_manager(FileUsage.MEDIA).file_url(self.branding_favicon)
102
103    def branding_favicon_themed_urls(self) -> dict[str, str] | None:
104        """Get themed URLs for branding_favicon if it contains %(theme)s"""
105        return get_file_manager(FileUsage.MEDIA).themed_urls(self.branding_favicon)
106
107    def branding_default_flow_background_url(self, request=None, use_cache: bool = True) -> str:
108        """Get branding_default_flow_background URL"""
109        return get_file_manager(FileUsage.MEDIA).file_url(
110            self.branding_default_flow_background,
111            request,
112            use_cache=use_cache,
113        )
114
115    def branding_default_flow_background_themed_urls(
116        self, request=None, use_cache: bool = True
117    ) -> dict[str, str] | None:
118        """Get themed URLs for branding_default_flow_background if it contains %(theme)s"""
119        return get_file_manager(FileUsage.MEDIA).themed_urls(
120            self.branding_default_flow_background,
121            request,
122            use_cache=use_cache,
123        )
124
125    @property
126    def serializer(self) -> type[Serializer]:
127        from authentik.brands.api import BrandSerializer
128
129        return BrandSerializer
130
131    @property
132    def default_locale(self) -> str:
133        """Get default locale"""
134        try:
135            return self.attributes.get("settings", {}).get("locale", "")
136
137        except Exception as exc:  # noqa
138            LOGGER.warning("Failed to get default locale", exc=exc)
139            return ""
140
141    def __str__(self) -> str:
142        if self.default:
143            return "Default brand"
144        return f"Brand {self.domain}"
145
146    class Meta:
147        verbose_name = _("Brand")
148        verbose_name_plural = _("Brands")
149        indexes = [
150            models.Index(fields=["domain"]),
151            models.Index(fields=["default"]),
152        ]
153
154
155class WebfingerProvider(models.Model):
156    """Provider which supports webfinger discovery"""
157
158    class Meta:
159        abstract = True
160
161    def webfinger(self, resource: str, request: HttpRequest) -> dict:
162        raise NotImplementedError()