376 lines
11 KiB
Python
376 lines
11 KiB
Python
|
class AppSettings(object):
|
||
|
|
class AuthenticationMethod:
|
||
|
|
USERNAME = "username"
|
||
|
|
EMAIL = "email"
|
||
|
|
USERNAME_EMAIL = "username_email"
|
||
|
|
|
||
|
|
class EmailVerificationMethod:
|
||
|
|
# After signing up, keep the user account inactive until the email
|
||
|
|
# address is verified
|
||
|
|
MANDATORY = "mandatory"
|
||
|
|
# Allow login with unverified e-mail (e-mail verification is
|
||
|
|
# still sent)
|
||
|
|
OPTIONAL = "optional"
|
||
|
|
# Don't send e-mail verification mails during signup
|
||
|
|
NONE = "none"
|
||
|
|
|
||
|
|
def __init__(self, prefix):
|
||
|
|
self.prefix = prefix
|
||
|
|
# If login is by email, email must be required
|
||
|
|
assert (
|
||
|
|
not self.AUTHENTICATION_METHOD == self.AuthenticationMethod.EMAIL
|
||
|
|
) or self.EMAIL_REQUIRED
|
||
|
|
# If login includes email, login must be unique
|
||
|
|
assert (
|
||
|
|
self.AUTHENTICATION_METHOD == self.AuthenticationMethod.USERNAME
|
||
|
|
) or self.UNIQUE_EMAIL
|
||
|
|
assert (
|
||
|
|
self.EMAIL_VERIFICATION != self.EmailVerificationMethod.MANDATORY
|
||
|
|
) or self.EMAIL_REQUIRED
|
||
|
|
if not self.USER_MODEL_USERNAME_FIELD:
|
||
|
|
assert not self.USERNAME_REQUIRED
|
||
|
|
assert self.AUTHENTICATION_METHOD not in (
|
||
|
|
self.AuthenticationMethod.USERNAME,
|
||
|
|
self.AuthenticationMethod.USERNAME_EMAIL,
|
||
|
|
)
|
||
|
|
if self.MAX_EMAIL_ADDRESSES is not None:
|
||
|
|
assert self.MAX_EMAIL_ADDRESSES > 0
|
||
|
|
|
||
|
|
def _setting(self, name, dflt):
|
||
|
|
from django.conf import settings
|
||
|
|
|
||
|
|
getter = getattr(
|
||
|
|
settings,
|
||
|
|
"ALLAUTH_SETTING_GETTER",
|
||
|
|
lambda name, dflt: getattr(settings, name, dflt),
|
||
|
|
)
|
||
|
|
return getter(self.prefix + name, dflt)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def PREVENT_ENUMERATION(self):
|
||
|
|
return self._setting("PREVENT_ENUMERATION", True)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def DEFAULT_HTTP_PROTOCOL(self):
|
||
|
|
return self._setting("DEFAULT_HTTP_PROTOCOL", "http").lower()
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_CONFIRMATION_EXPIRE_DAYS(self):
|
||
|
|
"""
|
||
|
|
Determines the expiration date of e-mail confirmation mails (#
|
||
|
|
of days)
|
||
|
|
"""
|
||
|
|
from django.conf import settings
|
||
|
|
|
||
|
|
return self._setting(
|
||
|
|
"EMAIL_CONFIRMATION_EXPIRE_DAYS",
|
||
|
|
getattr(settings, "EMAIL_CONFIRMATION_DAYS", 3),
|
||
|
|
)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_CONFIRMATION_AUTHENTICATED_REDIRECT_URL(self):
|
||
|
|
"""
|
||
|
|
The URL to redirect to after a successful e-mail confirmation, in
|
||
|
|
case of an authenticated user
|
||
|
|
"""
|
||
|
|
return self._setting("EMAIL_CONFIRMATION_AUTHENTICATED_REDIRECT_URL", None)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_CONFIRMATION_ANONYMOUS_REDIRECT_URL(self):
|
||
|
|
"""
|
||
|
|
The URL to redirect to after a successful e-mail confirmation, in
|
||
|
|
case no user is logged in
|
||
|
|
"""
|
||
|
|
from django.conf import settings
|
||
|
|
|
||
|
|
return self._setting(
|
||
|
|
"EMAIL_CONFIRMATION_ANONYMOUS_REDIRECT_URL", settings.LOGIN_URL
|
||
|
|
)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_CONFIRMATION_COOLDOWN(self):
|
||
|
|
"""
|
||
|
|
The cooldown in seconds during which, after an email confirmation has
|
||
|
|
been sent, a second confirmation email will not be sent.
|
||
|
|
"""
|
||
|
|
return self._setting("EMAIL_CONFIRMATION_COOLDOWN", 3 * 60)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_REQUIRED(self):
|
||
|
|
"""
|
||
|
|
The user is required to hand over an e-mail address when signing up
|
||
|
|
"""
|
||
|
|
return self._setting("EMAIL_REQUIRED", False)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_VERIFICATION(self):
|
||
|
|
"""
|
||
|
|
See e-mail verification method
|
||
|
|
"""
|
||
|
|
ret = self._setting("EMAIL_VERIFICATION", self.EmailVerificationMethod.OPTIONAL)
|
||
|
|
# Deal with legacy (boolean based) setting
|
||
|
|
if ret is True:
|
||
|
|
ret = self.EmailVerificationMethod.MANDATORY
|
||
|
|
elif ret is False:
|
||
|
|
ret = self.EmailVerificationMethod.OPTIONAL
|
||
|
|
return ret
|
||
|
|
|
||
|
|
@property
|
||
|
|
def MAX_EMAIL_ADDRESSES(self):
|
||
|
|
return self._setting("MAX_EMAIL_ADDRESSES", None)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def AUTHENTICATION_METHOD(self):
|
||
|
|
ret = self._setting("AUTHENTICATION_METHOD", self.AuthenticationMethod.USERNAME)
|
||
|
|
return ret
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_MAX_LENGTH(self):
|
||
|
|
"""
|
||
|
|
Adjust max_length of e-mail addresses
|
||
|
|
"""
|
||
|
|
return self._setting("EMAIL_MAX_LENGTH", 254)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def UNIQUE_EMAIL(self):
|
||
|
|
"""
|
||
|
|
Enforce uniqueness of e-mail addresses
|
||
|
|
"""
|
||
|
|
return self._setting("UNIQUE_EMAIL", True)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def SIGNUP_EMAIL_ENTER_TWICE(self):
|
||
|
|
"""
|
||
|
|
Signup email verification
|
||
|
|
"""
|
||
|
|
return self._setting("SIGNUP_EMAIL_ENTER_TWICE", False)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def SIGNUP_PASSWORD_ENTER_TWICE(self):
|
||
|
|
"""
|
||
|
|
Signup password verification
|
||
|
|
"""
|
||
|
|
legacy = self._setting("SIGNUP_PASSWORD_VERIFICATION", True)
|
||
|
|
return self._setting("SIGNUP_PASSWORD_ENTER_TWICE", legacy)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def SIGNUP_REDIRECT_URL(self):
|
||
|
|
from django.conf import settings
|
||
|
|
|
||
|
|
return self._setting("SIGNUP_REDIRECT_URL", settings.LOGIN_REDIRECT_URL)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def PASSWORD_MIN_LENGTH(self):
|
||
|
|
"""
|
||
|
|
Minimum password Length
|
||
|
|
"""
|
||
|
|
from django.conf import settings
|
||
|
|
|
||
|
|
ret = None
|
||
|
|
if not settings.AUTH_PASSWORD_VALIDATORS:
|
||
|
|
ret = self._setting("PASSWORD_MIN_LENGTH", 6)
|
||
|
|
return ret
|
||
|
|
|
||
|
|
@property
|
||
|
|
def RATE_LIMITS(self):
|
||
|
|
dflt = {
|
||
|
|
# Change password view (for users already logged in)
|
||
|
|
"change_password": "5/m",
|
||
|
|
# Email management (e.g. add, remove, change primary)
|
||
|
|
"manage_email": "10/m",
|
||
|
|
# Request a password reset, global rate limit per IP
|
||
|
|
"reset_password": "20/m",
|
||
|
|
# Rate limit measured per individual email address
|
||
|
|
"reset_password_email": "5/m",
|
||
|
|
# Password reset (the view the password reset email links to).
|
||
|
|
"reset_password_from_key": "20/m",
|
||
|
|
# Signups.
|
||
|
|
"signup": "20/m",
|
||
|
|
# NOTE: Login is already protected via `ACCOUNT_LOGIN_ATTEMPTS_LIMIT`
|
||
|
|
}
|
||
|
|
return self._setting("RATE_LIMITS", dflt)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_SUBJECT_PREFIX(self):
|
||
|
|
"""
|
||
|
|
Subject-line prefix to use for email messages sent
|
||
|
|
"""
|
||
|
|
return self._setting("EMAIL_SUBJECT_PREFIX", None)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def SIGNUP_FORM_CLASS(self):
|
||
|
|
"""
|
||
|
|
Signup form
|
||
|
|
"""
|
||
|
|
return self._setting("SIGNUP_FORM_CLASS", None)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def USERNAME_REQUIRED(self):
|
||
|
|
"""
|
||
|
|
The user is required to enter a username when signing up
|
||
|
|
"""
|
||
|
|
return self._setting("USERNAME_REQUIRED", True)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def USERNAME_MIN_LENGTH(self):
|
||
|
|
"""
|
||
|
|
Minimum username Length
|
||
|
|
"""
|
||
|
|
return self._setting("USERNAME_MIN_LENGTH", 1)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def USERNAME_BLACKLIST(self):
|
||
|
|
"""
|
||
|
|
List of usernames that are not allowed
|
||
|
|
"""
|
||
|
|
return self._setting("USERNAME_BLACKLIST", [])
|
||
|
|
|
||
|
|
@property
|
||
|
|
def PASSWORD_INPUT_RENDER_VALUE(self):
|
||
|
|
"""
|
||
|
|
render_value parameter as passed to PasswordInput fields
|
||
|
|
"""
|
||
|
|
return self._setting("PASSWORD_INPUT_RENDER_VALUE", False)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def ADAPTER(self):
|
||
|
|
return self._setting("ADAPTER", "allauth.account.adapter.DefaultAccountAdapter")
|
||
|
|
|
||
|
|
@property
|
||
|
|
def CONFIRM_EMAIL_ON_GET(self):
|
||
|
|
return self._setting("CONFIRM_EMAIL_ON_GET", False)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def AUTHENTICATED_LOGIN_REDIRECTS(self):
|
||
|
|
return self._setting("AUTHENTICATED_LOGIN_REDIRECTS", True)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def LOGIN_ON_EMAIL_CONFIRMATION(self):
|
||
|
|
"""
|
||
|
|
Automatically log the user in once they confirmed their email address
|
||
|
|
"""
|
||
|
|
return self._setting("LOGIN_ON_EMAIL_CONFIRMATION", False)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def LOGIN_ON_PASSWORD_RESET(self):
|
||
|
|
"""
|
||
|
|
Automatically log the user in immediately after resetting
|
||
|
|
their password.
|
||
|
|
"""
|
||
|
|
return self._setting("LOGIN_ON_PASSWORD_RESET", False)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def LOGOUT_REDIRECT_URL(self):
|
||
|
|
from django.conf import settings
|
||
|
|
|
||
|
|
return self._setting("LOGOUT_REDIRECT_URL", settings.LOGOUT_REDIRECT_URL or "/")
|
||
|
|
|
||
|
|
@property
|
||
|
|
def LOGOUT_ON_GET(self):
|
||
|
|
return self._setting("LOGOUT_ON_GET", False)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def LOGOUT_ON_PASSWORD_CHANGE(self):
|
||
|
|
return self._setting("LOGOUT_ON_PASSWORD_CHANGE", False)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def USER_MODEL_USERNAME_FIELD(self):
|
||
|
|
return self._setting("USER_MODEL_USERNAME_FIELD", "username")
|
||
|
|
|
||
|
|
@property
|
||
|
|
def USER_MODEL_EMAIL_FIELD(self):
|
||
|
|
return self._setting("USER_MODEL_EMAIL_FIELD", "email")
|
||
|
|
|
||
|
|
@property
|
||
|
|
def SESSION_COOKIE_AGE(self):
|
||
|
|
"""
|
||
|
|
Deprecated -- use Django's settings.SESSION_COOKIE_AGE instead
|
||
|
|
"""
|
||
|
|
from django.conf import settings
|
||
|
|
|
||
|
|
return self._setting("SESSION_COOKIE_AGE", settings.SESSION_COOKIE_AGE)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def SESSION_REMEMBER(self):
|
||
|
|
"""
|
||
|
|
Controls the life time of the session. Set to `None` to ask the user
|
||
|
|
("Remember me?"), `False` to not remember, and `True` to always
|
||
|
|
remember.
|
||
|
|
"""
|
||
|
|
return self._setting("SESSION_REMEMBER", None)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def TEMPLATE_EXTENSION(self):
|
||
|
|
"""
|
||
|
|
A string defining the template extension to use, defaults to `html`.
|
||
|
|
"""
|
||
|
|
return self._setting("TEMPLATE_EXTENSION", "html")
|
||
|
|
|
||
|
|
@property
|
||
|
|
def FORMS(self):
|
||
|
|
return self._setting("FORMS", {})
|
||
|
|
|
||
|
|
@property
|
||
|
|
def LOGIN_ATTEMPTS_LIMIT(self):
|
||
|
|
"""
|
||
|
|
Number of failed login attempts. When this number is
|
||
|
|
exceeded, the user is prohibited from logging in for the
|
||
|
|
specified `LOGIN_ATTEMPTS_TIMEOUT`
|
||
|
|
"""
|
||
|
|
return self._setting("LOGIN_ATTEMPTS_LIMIT", 5)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def LOGIN_ATTEMPTS_TIMEOUT(self):
|
||
|
|
"""
|
||
|
|
Time period from last unsuccessful login attempt, during
|
||
|
|
which the user is prohibited from trying to log in. Defaults to
|
||
|
|
5 minutes.
|
||
|
|
"""
|
||
|
|
return self._setting("LOGIN_ATTEMPTS_TIMEOUT", 60 * 5)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def EMAIL_CONFIRMATION_HMAC(self):
|
||
|
|
return self._setting("EMAIL_CONFIRMATION_HMAC", True)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def SALT(self):
|
||
|
|
return self._setting("SALT", "account")
|
||
|
|
|
||
|
|
@property
|
||
|
|
def PRESERVE_USERNAME_CASING(self):
|
||
|
|
return self._setting("PRESERVE_USERNAME_CASING", True)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def USERNAME_VALIDATORS(self):
|
||
|
|
from django.core.exceptions import ImproperlyConfigured
|
||
|
|
|
||
|
|
from allauth.utils import get_user_model, import_attribute
|
||
|
|
|
||
|
|
path = self._setting("USERNAME_VALIDATORS", None)
|
||
|
|
if path:
|
||
|
|
ret = import_attribute(path)
|
||
|
|
if not isinstance(ret, list):
|
||
|
|
raise ImproperlyConfigured(
|
||
|
|
"ACCOUNT_USERNAME_VALIDATORS is expected to be a list"
|
||
|
|
)
|
||
|
|
else:
|
||
|
|
if self.USER_MODEL_USERNAME_FIELD is not None:
|
||
|
|
ret = (
|
||
|
|
get_user_model()
|
||
|
|
._meta.get_field(self.USER_MODEL_USERNAME_FIELD)
|
||
|
|
.validators
|
||
|
|
)
|
||
|
|
else:
|
||
|
|
ret = []
|
||
|
|
return ret
|
||
|
|
|
||
|
|
|
||
|
|
# Ugly? Guido recommends this himself ...
|
||
|
|
# http://mail.python.org/pipermail/python-ideas/2012-May/014969.html
|
||
|
|
import sys # noqa
|
||
|
|
|
||
|
|
|
||
|
|
app_settings = AppSettings("ACCOUNT_")
|
||
|
|
app_settings.__name__ = __name__
|
||
|
|
sys.modules[__name__] = app_settings
|