Django - 用户认证、用户组、用户权限
https://www.cnblogs.com/ccorz/p/6358074.html
auth模块是Django提供的标准权限管理系统,可以提供用户身份认证, 用户组和权限管理。
auth可以和admin模块配合使用, 快速建立网站的管理系统。
在INSTALLED_APPS中添加'django.contrib.auth'使用该APP, auth模块默认启用。
User
User是auth模块中维护用户信息的关系模式(继承了models.Model), 数据库中该表被命名为auth_user.
User表的SQL描述:
CREATE TABLE "auth_user" (
"id" integer NOT NULL PRIMARY KEY AUTOINCREMENT,
"password" varchar(128) NOT NULL, "last_login" datetime NULL,
"is_superuser" bool NOT NULL,
"first_name" varchar(30) NOT NULL,
"last_name" varchar(30) NOT NULL,
"email" varchar(254) NOT NULL,
"is_staff" bool NOT NULL,
"is_active" bool NOT NULL,
"date_joined" datetime NOT NULL,
"username" varchar(30) NOT NULL UNIQUE
)
auth模块提供了很多API管理用户信息, 在必要的时候我们可以导入User表进行操作, 比如其它表需要与User建立关联时:
from django.contrib.auth.models import User
创建用户
user = User.objects.create_user(username, email, password)
建立user对象:
user.save()
在此,需要调用save()方法才可将此新用户保存到数据库中。
auth
模块不存储用户密码明文而是存储一个Hash值, 比如迭代使用Md5算法.
认证用户
使用authenticate
模块,使用时,先导入模块:
from django.contrib.auth import authenticate
使用关键字参数传递账户和凭据:
user = authenticate(username=username, password=password)
认证用户的密码是否有效, 若有效则返回代表该用户的user对象, 若无效则返回None。
需要注意的是:该方法不检查is_active
标志位。
修改用户密码
修改密码是User的实例方法, 该方法不验证用户身份:
user.set_password(new_password)
通常该方法需要和authenticate配合使用:
user = auth.authenticate(username=username, password=old_password)
if user is not None:
user.set_password(new_password)
user.save()
登录
先导入模块:
from django.contrib.auth import login
login向session中添加SESSION_KEY, 便于对用户进行跟踪:
login(request, user)
login不进行认证,也不检查is_active标志位, 一般和authenticate配合使用:
user = authenticate(username=username, password=password)
if user is not None:
if user.is_active:
login(request, user)
在auth/__init__.py
中可以看到login的源代码。
退出登录
logout会移除request中的user信息, 并刷新session:
from django.contrib.auth import logout
def logout_view(request):
logout(request)
权限判断,只允许登录用户访问
@login_required
修饰器修饰的view函数会先通过session key检查是否登录, 已登录用户可以正常的执行操作, 未登录用户将被重定向到login_url
指定的位置。若未指定login_url参数, 则重定向到settings.LOGIN_URL
。
from django.contrib.auth.decorators import login_required
@login_required(login_url='/accounts/login/')
def my_view(request):
...
Group
django.contrib.auth.models.Group
定义了用户组的模型, 每个用户组拥有id
和name
两个字段, 该模型在数据库被映射为auth_group
数据表。
User对象中有一个名为groups
的多对多字段, 多对多关系由auth_user_groups
数据表维护。Group对象可以通过user_set
反向查询用户组中的用户。
我们可以通过创建删除Group对象来添加或删除用户组:
# add
group = Group.objects.create(name=group_name)
group.save()
# del
group.delete()
我们可以通过标准的多对多字段操作管理用户与用户组的关系:
#用户加入用户组
user.groups.add(group)
#或者
group.user_set.add(user)
#用户退出用户组
user.groups.remove(group)
#或者
group.user_set.remove(user)
#用户退出所有用户组
user.groups.clear()
#用户组中所有用户退出组
group.user_set.clear()
Permission
Django的auth系统提供了模型级的权限控制, 即可以检查用户是否对某个数据表拥有增(add), 改(change), 删(delete)权限。
auth系统无法提供对象级的权限控制, 即检查用户是否对数据表中某条记录拥有增改删的权限。如果需要对象级权限控制可以使用django-guardian
。
假设在博客系统中有一张article数据表管理博文, auth可以检查某个用户是否拥有对所有博文的管理权限, 但无法检查用户对某一篇博文是否拥有管理权限。
检查用户权限
user.has_perm
方法用于检查用户是否拥有操作某个模型的权限:
user.has_perm('blog.add_article')
user.has_perm('blog.change_article')
user.has_perm('blog.delete_article')
上述语句检查用户是否拥有blog这个app中article模型的添加权限, 若拥有权限则返回True。
has_perm
仅是进行权限检查, 即是用户没有权限它也不会阻止程序员执行相关操作。
@permission_required
装饰器可以代替has_perm
并在用户没有相应权限时重定向到登录页或者抛出异常。
# permission_required(perm[, login_url=None, raise_exception=False])
@permission_required('blog.add_article')
def post_article(request):
pass
每个模型默认拥有增(add), 改(change), 删(delete)权限。在django.contrib.auth.models.Permission
模型中保存了项目中所有权限。
该模型在数据库中被保存为auth_permission
数据表。每条权限拥有id
,name
, content_type_id
, codename
四个字段。
管理用户权限
User和Permission通过多对多字段user.user_permissions
关联,在数据库中由auth_user_user_permissions
数据表维护。
#添加权限
user.user_permissions.add(permission)
#删除权限:
user.user_permissions.delete(permission)
#清空权限:
user.user_permissions.clear()
用户拥有他所在用户组的权限, 使用用户组管理权限是一个更方便的方法。Group中包含多对多字段permissions
, 在数据库中由auth_group_permissions
数据表维护。
#添加权限:
group.permissions.add(permission)
#删除权限:
group.permissions.delete(permission)
#清空权限:
group.permissions.clear()
自定义权限
在定义Model时可以使用Meta自定义权限:
class Discussion(models.Model):
...
class Meta:
permissions = (
("create_discussion", "Can create a discussion"),
("reply_discussion", "Can reply discussion"),
)
判断用户是否拥有自定义权限:
user.has_perm('blog.create_discussion')
若需建立py文件进行测试,则在文件开始加入以下代码即可
#coding:utf-8 import os os.environ.setdefault("DJANGO_SETTINGS_MODULE", "www.settings") ''' Django 版本大于等于1.7的时候,需要加上下面两句 import django django.setup() 否则会抛出错误 django.core.exceptions.AppRegistryNotReady: Models aren't loaded yet. ''' import django from django.contrib.auth.models import Permission, User #用户 权限 if django.VERSION >= (1, 7):#自动判断版本 django.setup()
查询一个用户所有权限,并使其结果转为list列表
User.objects.get(username='').user_permissions.values()
#方法一
list(User.objects.get(username='').get_all_permissions())
#方法二
查询所有权限,并循环输出
c = Permission.objects.values() for i in c: print i
添加指定权限,此处注意content_type_id是int类型,对应于model的数字
Permission.objects.create(name='add_logentry',content_type_id=1,codename='Can add log entry')
#例:利用查询权限语句,查看到{u'content_type_id': 1L, 'codename': u'add_logentry', u'id': 1L, 'name': u'Can add log entry'}]类似这样的列表,
删除指定权限
Permission.objects.get(codename='Can add log entry').delete()
1. Django权限机制概述
权限机制能够约束用户行为,控制页面的显示内容,也能使API更加安全和灵活;用好权限机制,能让系统更加强大和健壮。因此,基于Django的开发,理清Django权限机制是非常必要的。
1.1 Django的权限控制
Django用user, group和permission完成了权限机制,这个权限机制是将属于model的某个permission赋予user或group,可以理解为全局的权限,即如果用户A对数据模型(model)B有可写权限,那么A能修改model B的所有实例(objects)。group的权限也是如此,如果为group C 赋予model B的可写权限,则隶属于group C 的所有用户,都可以修改model B的所有实例。
这种权限机制只能解决一些简单的应用需求,而大部分应用场景下,需要更细分的权限机制。以博客系统为例,博客系统的用户可分为『管理员』、『编辑』、『作者』和『读者』四个用户组;博客系统管理员和编辑具有查看、修改和删除所有的文章的权限,作者只能修改和删除自己写的文章,而读者则只有阅读权限。管理员、编辑和读者的权限,我们可以用全局权限做控制,而对于作者,全局权限无法满足需求,仅通过全局权限,要么允许作者编辑不属于自己的文章,要么让作者连自己的文章都无法修改。
上述的应用场景,Django自带的权限机制无法满足需求,需要引入另一种更细的权限机制:对象权限(object permission)。
Object Permission是一种对象颗粒度上的权限机制,它允许为每个具体对象授权。仍沿用最开始的例子,如果model B有三个实例 B1,B2 和B3,如果我们把B1的可写权限赋予用户A,则A可以修改B1对象,而对B2,B3无法修改。
对group也一样,如果将B2的可写权限赋予group C,则隶属于group C的所有用户均可以修改B2,但无法修改B1和B3。结合Django自带权限机制和object permission,博客系统中作者的权限控制迎刃而解:系统全局上不允许作者编辑文章,而对于属于作者的具体文章,赋予编辑权限即可。
Django其实包含了object permission的框架,但没有具体实现,object permission的实现需要借助第三方app django-guardian,我们在开发中用调用django guradian封装好的方法即可。
1.2 Django的权限项
Django用permission对象存储权限项,每个model默认都有三个permission,即add model, change model和delete model。例如,定义一个名为『Car』model,定义好Car之后,会自动创建相应的三个permission:add_car, change_car和delete_car。Django还允许自定义permission,例如,我们可以为Car创建新的权限项:drive_car, clean_car, fix_car等等
需要注意的是,permission总是与model对应的,如果一个object不是model的实例,我们无法为它创建/分配权限。
2. Django 自带权限机制的应用
2.1 Permission
如上文所述,Django定义每个model后,默认都会添加该model的add, change和delete三个permission,自定义的permission可以在我们定义model时手动添加:
1
2
3
4
5
6
7
8
|
class Task(models.Model): ... class Meta: permissions = ( ( "view_task" , "Can see available tasks" ), ( "change_task_status" , "Can change the status of tasks" ), ( "close_task" , "Can remove a task by setting its status as closed" ), ) |
每个permission都是django.contrib.auth.Permission
类型的实例,该类型包含三个字段name, codename 和 content_type,其中 content_type反应了permission属于哪个model,codename如上面的view_task,代码逻辑中检查权限时要用, name是permission的描述,将permission打印到屏幕或页面时默认显示的就是name。
在model中创建自定义权限,从系统开发的角度,可理解为创建系统的内置权限,如果需求中涉及到用户使用系统时创建自定义权限,则要通过下面方法:
1
2
3
4
5
6
7
8
|
from myapp.models import BlogPost from django.contrib.auth.models import Permission from django.contrib.contenttypes.models import ContentType content_type = ContentType.objects.get_for_model(BlogPost) permission = Permission.objects.create(codename = 'can_publish' , name = 'Can Publish Posts' , content_type = content_type) |
2.2 User Permission管理
User对象的user_permission字段管理用户的权限:
1
2
3
4
5
6
7
8
|
myuser.user_permissions = [permission_list] myuser.user_permissions.add(permission, permission, ...) #增加权限 myuser.user_permissions.remove(permission, permission, ...) #删除权限 myuser.user_permissions.clear() #清空权限 ############################################################## # 注:上面的permission为django.contrib.auth.Permission类型的实例 ############################################################## |
检查用户权限用has_perm()方法:
1
|
myuser.has_perm( 'myapp.fix_car' ) |
has_perm()
方法的参数,即permission的codename,但传递参数时需要加上model 所属app的前缀,格式为<app label>.<permission codename>
。
无论permission赋予user还是group,has_perm()
方法均适用
附注:
user.get_all_permissions()方法列出用户的所有权限,返回值是permission name的list
user.get_group_permissions()方法列出用户所属group的权限,返回值是permission name的list
2.3 Group Permission管理
group permission管理逻辑与user permission管理一致,group中使用permissions字段做权限管理:
1
2
3
4
|
group.permissions = [permission_list] group.permissions.add(permission, permission, ...) group.permissions.remove(permission, permission, ...) group.permissions.clear() |
权限检查:
依然使用user.has_perm()
方法。
2.4 permission_required 装饰器
权限能约束用户行为,当业务逻辑中涉及到权限检查时,decorator能够分离权限验证和核心的业务逻辑,使代码更简洁,逻辑更清晰。permission的decorator为permission_required
:
1
2
3
4
|
from django.contrib.auth.decorators import permission_required @permission_required ( 'car.drive_car' ) def my_view(request): |
2.5 Template中的权限检查
Template中使用全局变量perms存储当前用户的所有权限,权限检查可以参考下面例子:
1
2
3
4
5
6
7
8
9
10
|
{ % if perms.main.add_page % } <li class = "dropdown" > <a href = "#" rel = "external nofollow" class = "dropdown-toggle" data - toggle = "dropdown" role = "button" aria - expanded = "false" >Pages <span class = "caret" >< / span>< / a> <ul class = "dropdown-menu" role = "menu" > <li><a href = "{% url 'main:admin_pages' %}" rel = "external nofollow" > All Pages< / a>< / li> <li><a href = "{% url 'main:admin_page' %}" rel = "external nofollow" >New Page< / a>< / li> <li><a href = "{% url 'main:admin_pages' %}?draft=true" rel = "external nofollow" >Drafts< / a>< / li> < / ul> < / li> { % endif % } |
3. 基于Django-guardian的object permission的应用
Django-guardian基于django的原生逻辑扩展了django的权限机制,应用django-guardian后,可以使用django-guardian提供的方法以及django的原生方法检查全局权限,django-guardian提供的object permission机制使django的权限机制更加完善。
django-guardian详细的使用文档请参考官方文档,其object permission常用方法如下:
1
2
3
|
from guardian.shortcuts import assign_perm, get_perms from guardian.core import ObjectPermissionChecker from guardian.decorators import permission_required |
3.1 添加object permission
添加object permission使用assign_perm()
方法,如为用户添加对mycar对象的drive_car权限:
1
|
assign_perm( 'myapp.drive_car' , request.user, mycar) |
assign_perm()方法也可用于group
1
|
assign_perm( 'myapp.drive_car' , mygroup, mycar) |
3.2 权限检查
3.2.1 Global permission
get_perms()方法用于检查用户的“全局权限”(global permission),与user.has_perm()异曲同工,如:
1
2
3
4
5
6
7
8
9
10
11
|
############################# # It works! ############################# if not 'main.change_post' in get_perms(request.user, post): raise HttpResponse( 'Forbidden' ) ############################# # It works, too! ############################# if not request.user.has_perm( 'main.change_post' ) return HttpResponse( 'Forbidden' ) |
例子中虽然把post object作为参数传给get_perms()
方法,但它只检查user的全局权限中是否有main.change_post权限,很多情况下可用原生的user.has_perm
取代,但user和group均可作为get_perms()
的传入参数,某些情况下可以使代码更简洁。
3.2.2 Object permission
Django-guardian中使用ObjectPermissionChecker
检查用户的object permission,示例如下:
1
2
|
checker = ObjectPermissionChecker(request.user) print checker.has_perm( 'main.change_post' , post) |
3.3 permission_required装饰器
guardian.decorators.permission_required
是django-guardian权限检查的decorator,既可以检查全局权限,又可以检查对象权限(object permission),其中,accept_global_perms
参数指出是否检查user的global permission,如:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
from guardian.decorators import permission_required class DeletePost(View): @method_decorator (permission_required( 'main.delete_post' , (models.Post, 'id' , 'pk' ), accept_global_perms = True )) def get( self , request, pk): try : pk = int (pk) cur_post = models.Post.objects.get(pk = pk) is_draft = cur_post.is_draft url = reverse( 'main:admin_posts' ) if is_draft: url = '{0}?draft=true' . format (url) cur_post.delete() except models.Post.DoesNotExist: raise Http404 return redirect(url) |
注:
decorator中的(models.Post, ‘id', ‘pk')部分,用于指定object实例,如果忽略这个参数,则不论accept_global_perms值为True还是False,均仅仅检查全局权限。
4. 结论
Django原生提供了一种简单的全局权限(global permission)控制机制,但很多应用场景下,对象权限(object permission)更加有用;django-guardian是目前比较活跃的一个django extension,提供了一种有效的object permission控制机制,与django原生机制一脉相承,推荐使用。
以上就是本文关于Django权限机制实现代码详解的全部内容,希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题,如有不足之处,欢迎留言指出。感谢朋友们对本站的支持!