This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/passbook/sources/oauth/models.py

179 lines
5.3 KiB
Python
Raw Normal View History

2018-11-11 12:41:48 +00:00
"""OAuth Client models"""
from django.db import models
2019-03-13 15:49:30 +00:00
from django.urls import reverse, reverse_lazy
from django.utils.translation import gettext_lazy as _
2018-11-11 12:41:48 +00:00
from passbook.core.models import Source, UserSourceConnection
2020-02-20 16:23:05 +00:00
from passbook.core.types import UILoginButton, UIUserSettings
2019-10-07 14:33:48 +00:00
from passbook.sources.oauth.clients import get_client
2018-11-11 12:41:48 +00:00
class OAuthSource(Source):
"""Configuration for OAuth provider."""
provider_type = models.CharField(max_length=255)
request_token_url = models.CharField(
blank=True, max_length=255, verbose_name=_("Request Token URL"),
help_text=_("URL used to request the initial token. This URL is only required for OAuth 1.")
)
authorization_url = models.CharField(
max_length=255, verbose_name=_("Authorization URL"),
help_text=_("URL the user is redirect to to conest the flow.")
)
access_token_url = models.CharField(
max_length=255, verbose_name=_("Access Token URL"),
help_text=_("URL used by passbook to retrive tokens.")
)
profile_url = models.CharField(
max_length=255, verbose_name=_("Profile URL"),
help_text=_("URL used by passbook to get user information."))
2018-11-11 12:41:48 +00:00
consumer_key = models.TextField()
consumer_secret = models.TextField()
2019-12-31 11:51:16 +00:00
form = "passbook.sources.oauth.forms.OAuthSourceForm"
2018-11-22 12:12:24 +00:00
@property
def ui_login_button(self) -> UILoginButton:
return UILoginButton(
url=reverse_lazy(
"passbook_sources_oauth:oauth-client-login",
kwargs={"source_slug": self.slug},
),
icon_path=f"passbook/sources/{self.provider_type}.svg",
name=self.name,
2019-12-31 11:51:16 +00:00
)
@property
def ui_additional_info(self) -> str:
url = reverse_lazy(
2019-12-31 11:51:16 +00:00
"passbook_sources_oauth:oauth-client-callback",
kwargs={"source_slug": self.slug},
)
return f"Callback URL: <pre>{url}</pre>"
@property
def ui_user_settings(self) -> UIUserSettings:
2019-03-14 20:18:13 +00:00
icon_type = self.provider_type
2019-12-31 11:51:16 +00:00
if icon_type == "azure ad":
icon_type = "windows"
2020-02-21 17:00:09 +00:00
icon_class = f"fab fa-{icon_type}"
2019-12-31 11:51:16 +00:00
view_name = "passbook_sources_oauth:oauth-client-user"
return UIUserSettings(
name=self.name,
icon=icon_class,
view_name=reverse((view_name), kwargs={"source_slug": self.slug}),
2019-12-31 11:51:16 +00:00
)
2019-03-13 15:49:30 +00:00
def __str__(self) -> str:
return f"OAuth Source {self.name}"
2018-11-11 12:41:48 +00:00
class Meta:
2019-12-31 11:51:16 +00:00
verbose_name = _("Generic OAuth Source")
verbose_name_plural = _("Generic OAuth Sources")
2018-11-11 12:41:48 +00:00
class GitHubOAuthSource(OAuthSource):
"""Abstract subclass of OAuthSource to specify GitHub Form"""
2019-12-31 11:51:16 +00:00
form = "passbook.sources.oauth.forms.GitHubOAuthSourceForm"
class Meta:
abstract = True
2019-12-31 11:51:16 +00:00
verbose_name = _("GitHub OAuth Source")
verbose_name_plural = _("GitHub OAuth Sources")
class TwitterOAuthSource(OAuthSource):
"""Abstract subclass of OAuthSource to specify Twitter Form"""
2019-12-31 11:51:16 +00:00
form = "passbook.sources.oauth.forms.TwitterOAuthSourceForm"
class Meta:
abstract = True
2019-12-31 11:51:16 +00:00
verbose_name = _("Twitter OAuth Source")
verbose_name_plural = _("Twitter OAuth Sources")
class FacebookOAuthSource(OAuthSource):
"""Abstract subclass of OAuthSource to specify Facebook Form"""
2019-12-31 11:51:16 +00:00
form = "passbook.sources.oauth.forms.FacebookOAuthSourceForm"
class Meta:
abstract = True
2019-12-31 11:51:16 +00:00
verbose_name = _("Facebook OAuth Source")
verbose_name_plural = _("Facebook OAuth Sources")
class DiscordOAuthSource(OAuthSource):
"""Abstract subclass of OAuthSource to specify Discord Form"""
2019-12-31 11:51:16 +00:00
form = "passbook.sources.oauth.forms.DiscordOAuthSourceForm"
class Meta:
abstract = True
2019-12-31 11:51:16 +00:00
verbose_name = _("Discord OAuth Source")
verbose_name_plural = _("Discord OAuth Sources")
class GoogleOAuthSource(OAuthSource):
"""Abstract subclass of OAuthSource to specify Google Form"""
2019-12-31 11:51:16 +00:00
form = "passbook.sources.oauth.forms.GoogleOAuthSourceForm"
class Meta:
abstract = True
2019-12-31 11:51:16 +00:00
verbose_name = _("Google OAuth Source")
verbose_name_plural = _("Google OAuth Sources")
2019-03-14 20:18:13 +00:00
class AzureADOAuthSource(OAuthSource):
"""Abstract subclass of OAuthSource to specify AzureAD Form"""
2019-12-31 11:51:16 +00:00
form = "passbook.sources.oauth.forms.AzureADOAuthSourceForm"
2019-03-14 20:18:13 +00:00
class Meta:
abstract = True
2019-12-31 11:51:16 +00:00
verbose_name = _("Azure AD OAuth Source")
verbose_name_plural = _("Azure AD OAuth Sources")
2019-03-14 20:18:13 +00:00
class OpenIDOAuthSource(OAuthSource):
"""Abstract subclass of OAuthSource to specify OpenID Form"""
form = "passbook.sources.oauth.forms.OAuthSourceForm"
class Meta:
abstract = True
verbose_name = _("OpenID OAuth Source")
verbose_name_plural = _("OpenID OAuth Sources")
2019-03-14 20:18:13 +00:00
2018-11-11 12:41:48 +00:00
class UserOAuthSourceConnection(UserSourceConnection):
"""Authorized remote OAuth provider."""
identifier = models.CharField(max_length=255)
access_token = models.TextField(blank=True, null=True, default=None)
def save(self, *args, **kwargs):
self.access_token = self.access_token or None
super().save(*args, **kwargs)
@property
def api_client(self):
"""Get API Client"""
2019-12-31 11:51:16 +00:00
return get_client(self.source, self.access_token or "")
2018-11-11 12:41:48 +00:00
class Meta:
2019-12-31 11:51:16 +00:00
verbose_name = _("User OAuth Source Connection")
verbose_name_plural = _("User OAuth Source Connections")