自定义认证后台

17633 46 2017年8月7日

Django auth 应用默认支持用户名(username)进行登录。但是在实践中,网站可能还需要邮箱、手机号、身份证号等进行登录,这就需要我们自己写一个认证后台,用于验证用户输入的用户信息是否正确,从而对拥有正确凭据的用户进行登录认证。

Django 验证用户合法性的方式

Django 对用户登录的验证工作均在一个被称作认证后台(Authentication Backend)的类中进行。这个类是一个普通的 Python 类,它有一个 authenticate 方法,接收登录用户提供的凭据(如用户名或者邮箱以及密码)作为参数,并根据这些凭据判断用户是否合法(即是否是已注册用户,密码是否正确等)。下面是 Django 内置的认证后台的部分源代码,从代码中可以清晰地看到其工作方式:

django.contrib.auth.backends

class ModelBackend(object):
    """
    Authenticates against settings.AUTH_USER_MODEL.
    """

    def authenticate(self, request, username=None, password=None, **kwargs):
        if username is None:
            username = kwargs.get(UserModel.USERNAME_FIELD)
        try:
            user = UserModel._default_manager.get_by_natural_key(username)
        except UserModel.DoesNotExist:
            # Run the default password hasher once to reduce the timing
            # difference between an existing and a non-existing user (#20760).
            UserModel().set_password(password)
        else:
            if user.check_password(password) and self.user_can_authenticate(user):
                return user

这段代码根据用户传入的 username 和 password,验证该 username 对应的用户是否存在以及密码是否正确,是则返回该 user 对象。

可以定义多个认证后台,Django 内部会逐一调用这些后台的 authenticate 方法来验证用户提供登录凭据的合法性,一旦通过某个后台的验证,表明用户提供的凭据合法,从而允许登录该用户。

Email Backend

在本示例项目中,用户注册时需要填写邮箱。因为 Django auth 应用内置只支持用户名和密码的认证方式,所以目前用户是无法使用 Email 进行登录的。为了实现邮箱登录,我们需要编写一个认证后台。这个后台的作用便是验证用户提供的凭据(这里是邮箱以及密码)是合法的,完全仿照内置的 ModelBackend 代码即可。首先在 users 应用下新建一个 backends.py 文件,然后写入如下代码:

users/backends.py

from .models import User

class EmailBackend(object):
    def authenticate(self, request, **credentials):
        # 要注意登录表单中用户输入的用户名或者邮箱的 field 名均为 username
        email = credentials.get('email', credentials.get('username'))
        try:
            user = User.objects.get(email=email)
        except User.DoesNotExist:
            pass
        else:
            if user.check_password(credentials["password"]):
                return user

    def get_user(self, user_id):
        """
        该方法是必须的
        """
        try:
            return User.objects.get(pk=user_id)
        except User.DoesNotExist:
            return None

逻辑非常简单,就是根据用户提供的 Email 和密码,检查该 emai 对应的用户是否存在,如果存在则检查密码是否正确,如果密码也没有问题,则返回该 user 对象。

配置 Backend

接下来就要告诉 Django,需要使用哪些 Backends 对用户的凭据信息进行验证,这需要在 settings.py 中设置:

settings.py

AUTHENTICATION_BACKENDS = (
    'django.contrib.auth.backends.ModelBackend',
    'users.backends.EmailBackend',
)

第一个 Backend 是 Django 内置的 Backend,当用户提供的是用户名和正确的密码时该 Backend 会通过验证;第二个 Backend 是刚刚自定义的 Backend,当用户提供的是 Email 和正确的密码时该 Backend 会通过验证。

测试

在登录界面输入注册时的邮箱和正确的密码,可以发现也可以登录成功了,说明我们自定义的 Backend 是有效的。大功告成!

总结

本教程的示例项目代码位于 GitHub:Django Auth Example

如果遇到问题,请通过下面的方式寻求帮助。

更多 Django 相关教程,请访问我的个人博客:追梦人物的博客

-- EOF --

最后更新:2018-11-11 12:21:12

46 条评论 / 27 人参与
suxianglun

博主,前前后后断断续续花费了两个月时间看完了你的前两个教程,写的很好,遇到的问题基本都能在评论里找到解决办法,非常感谢博主。自定义后台这篇文章中 user = User.objects.get(email=email)应该是写成user = User.objects.get(email=email)[0] ,前者user是一个QuerySet 即对象列表,再使用user.check_password()时候会报错'QuerySet' object has no attribute 'check_password',后者user是一个User对象了,就可以调用check_password函数了,自己实践的时候发现的一个问题。


fbckf

User 模型中 email 字段需要设置 unique=True ,否则注册时邮箱可重复,注册账户使用同一个邮箱会在密码重置和邮箱认证登录处出现 bug


SamK6517433923 fbckf

unique = True 这个方法可以,比在表单中添加 clean_email 方法验证表单要好使


linoer

自定义的backend和后台混掉了,找了半天问题,知道发现博主的

AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'users.backends.EmailBackend',
)

原来是漏掉了内置backend

感谢


-Ni

博主我发现这个项目的后台http://127.0.0.1:8080/admin登陆的时候会发生错误。是怎么回事,要如何修复?


-Ni

希望博主可以添加一些test case和写test的技巧.平时想写test但是request不会构造


追梦人物 [博主] -Ni

嗯,这个建议很好,在完善教程的时候我会考虑添加一些测试的技巧


SamK6517433923 追梦人物 [博主]

期待


yuqiangwu

有一个问题就是,我注册的时候不同的账号但是注册邮箱填相同的,也是能够注册成功的,然后我用自定义的邮箱账号去认证就会报数据不只有一条, 请问如何在注册的时候添加一个验证邮箱是否已经注册呢。


yiwozai yuqiangwu

覆盖AbstractUser.email字段,可以这样定义:

email = models.EmailField('邮箱', unique=True, error_messages={ 'unique': "该邮箱地址已被占用。",},)


pidada yuqiangwu

注册不同的账号你能够成功吗?我用同一个邮箱好像不成功的!直接提示:用该邮箱注册的用户已经存在


shaunsyb_weibo

youyong ~~~~~~


yawuplus

请问下博主,你的博客如何退出登录呢?


追梦人物 [博主] yawuplus

Sorry,目前暂时不支持注销登录!


zzfeng2012

前面几节都正常,这一节没实现成功,可是这一节也就只编辑backends.py 和 settings这两个文件。用邮箱登录时不成功,提示“登录请输入一个正确的 用户名 和密码.”,不知道是哪里出了问题。

我把github上的 “Django Auth Example” 这个例子拿下来在本地试的也是用邮箱登录不了。


追梦人物 [博主] zzfeng2012

你的邮箱输入不正确吧?


jamswu 追梦人物 [博主]

000


各种迷惘的大明

博主,问你个问题,就是怎么避免提交评论的时候重复提交呢???