168 lines
5.0 KiB
Python
168 lines
5.0 KiB
Python
"""
|
|
This module allows importing AbstractBaseUser even when django.contrib.auth is
|
|
not in INSTALLED_APPS.
|
|
"""
|
|
import unicodedata
|
|
import warnings
|
|
|
|
from django.conf import settings
|
|
from django.contrib.auth import password_validation
|
|
from django.contrib.auth.hashers import (
|
|
check_password,
|
|
is_password_usable,
|
|
make_password,
|
|
)
|
|
from django.db import models
|
|
from django.utils.crypto import get_random_string, salted_hmac
|
|
from django.utils.deprecation import RemovedInDjango51Warning
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
|
|
class BaseUserManager(models.Manager):
|
|
@classmethod
|
|
def normalize_email(cls, email):
|
|
"""
|
|
Normalize the email address by lowercasing the domain part of it.
|
|
"""
|
|
email = email or ""
|
|
try:
|
|
email_name, domain_part = email.strip().rsplit("@", 1)
|
|
except ValueError:
|
|
pass
|
|
else:
|
|
email = email_name + "@" + domain_part.lower()
|
|
return email
|
|
|
|
def make_random_password(
|
|
self,
|
|
length=10,
|
|
allowed_chars="abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789",
|
|
):
|
|
"""
|
|
Generate a random password with the given length and given
|
|
allowed_chars. The default value of allowed_chars does not have "I" or
|
|
"O" or letters and digits that look similar -- just to avoid confusion.
|
|
"""
|
|
warnings.warn(
|
|
"BaseUserManager.make_random_password() is deprecated.",
|
|
category=RemovedInDjango51Warning,
|
|
stacklevel=2,
|
|
)
|
|
return get_random_string(length, allowed_chars)
|
|
|
|
def get_by_natural_key(self, username):
|
|
return self.get(**{self.model.USERNAME_FIELD: username})
|
|
|
|
|
|
class AbstractBaseUser(models.Model):
|
|
password = models.CharField(_("password"), max_length=128)
|
|
last_login = models.DateTimeField(_("last login"), blank=True, null=True)
|
|
|
|
is_active = True
|
|
|
|
REQUIRED_FIELDS = []
|
|
|
|
# Stores the raw password if set_password() is called so that it can
|
|
# be passed to password_changed() after the model is saved.
|
|
_password = None
|
|
|
|
class Meta:
|
|
abstract = True
|
|
|
|
def __str__(self):
|
|
return self.get_username()
|
|
|
|
def save(self, *args, **kwargs):
|
|
super().save(*args, **kwargs)
|
|
if self._password is not None:
|
|
password_validation.password_changed(self._password, self)
|
|
self._password = None
|
|
|
|
def get_username(self):
|
|
"""Return the username for this User."""
|
|
return getattr(self, self.USERNAME_FIELD)
|
|
|
|
def clean(self):
|
|
setattr(self, self.USERNAME_FIELD, self.normalize_username(self.get_username()))
|
|
|
|
def natural_key(self):
|
|
return (self.get_username(),)
|
|
|
|
@property
|
|
def is_anonymous(self):
|
|
"""
|
|
Always return False. This is a way of comparing User objects to
|
|
anonymous users.
|
|
"""
|
|
return False
|
|
|
|
@property
|
|
def is_authenticated(self):
|
|
"""
|
|
Always return True. This is a way to tell if the user has been
|
|
authenticated in templates.
|
|
"""
|
|
return True
|
|
|
|
def set_password(self, raw_password):
|
|
self.password = make_password(raw_password)
|
|
self._password = raw_password
|
|
|
|
def check_password(self, raw_password):
|
|
"""
|
|
Return a boolean of whether the raw_password was correct. Handles
|
|
hashing formats behind the scenes.
|
|
"""
|
|
|
|
def setter(raw_password):
|
|
self.set_password(raw_password)
|
|
# Password hash upgrades shouldn't be considered password changes.
|
|
self._password = None
|
|
self.save(update_fields=["password"])
|
|
|
|
return check_password(raw_password, self.password, setter)
|
|
|
|
def set_unusable_password(self):
|
|
# Set a value that will never be a valid hash
|
|
self.password = make_password(None)
|
|
|
|
def has_usable_password(self):
|
|
"""
|
|
Return False if set_unusable_password() has been called for this user.
|
|
"""
|
|
return is_password_usable(self.password)
|
|
|
|
def get_session_auth_hash(self):
|
|
"""
|
|
Return an HMAC of the password field.
|
|
"""
|
|
return self._get_session_auth_hash()
|
|
|
|
def get_session_auth_fallback_hash(self):
|
|
for fallback_secret in settings.SECRET_KEY_FALLBACKS:
|
|
yield self._get_session_auth_hash(secret=fallback_secret)
|
|
|
|
def _get_session_auth_hash(self, secret=None):
|
|
key_salt = "django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash"
|
|
return salted_hmac(
|
|
key_salt,
|
|
self.password,
|
|
secret=secret,
|
|
algorithm="sha256",
|
|
).hexdigest()
|
|
|
|
@classmethod
|
|
def get_email_field_name(cls):
|
|
try:
|
|
return cls.EMAIL_FIELD
|
|
except AttributeError:
|
|
return "email"
|
|
|
|
@classmethod
|
|
def normalize_username(cls, username):
|
|
return (
|
|
unicodedata.normalize("NFKC", username)
|
|
if isinstance(username, str)
|
|
else username
|
|
)
|