backends.py 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. from __future__ import unicode_literals
  2. from django.contrib.auth import get_user_model
  3. from django.contrib.auth.models import Permission
  4. class ModelBackend(object):
  5. """
  6. Authenticates against settings.AUTH_USER_MODEL.
  7. """
  8. def authenticate(self, username=None, password=None, **kwargs):
  9. UserModel = get_user_model()
  10. if username is None:
  11. username = kwargs.get(UserModel.USERNAME_FIELD)
  12. try:
  13. user = UserModel._default_manager.get_by_natural_key(username)
  14. if user.check_password(password):
  15. return user
  16. except UserModel.DoesNotExist:
  17. # Run the default password hasher once to reduce the timing
  18. # difference between an existing and a non-existing user (#20760).
  19. UserModel().set_password(password)
  20. def get_group_permissions(self, user_obj, obj=None):
  21. """
  22. Returns a set of permission strings that this user has through his/her
  23. groups.
  24. """
  25. if user_obj.is_anonymous() or obj is not None:
  26. return set()
  27. if not hasattr(user_obj, '_group_perm_cache'):
  28. if user_obj.is_superuser:
  29. perms = Permission.objects.all()
  30. else:
  31. user_groups_field = get_user_model()._meta.get_field('groups')
  32. user_groups_query = 'group__%s' % user_groups_field.related_query_name()
  33. perms = Permission.objects.filter(**{user_groups_query: user_obj})
  34. perms = perms.values_list('content_type__app_label', 'codename').order_by()
  35. user_obj._group_perm_cache = set("%s.%s" % (ct, name) for ct, name in perms)
  36. return user_obj._group_perm_cache
  37. def get_all_permissions(self, user_obj, obj=None):
  38. if user_obj.is_anonymous() or obj is not None:
  39. return set()
  40. if not hasattr(user_obj, '_perm_cache'):
  41. user_obj._perm_cache = set("%s.%s" % (p.content_type.app_label, p.codename) for p in user_obj.user_permissions.select_related())
  42. user_obj._perm_cache.update(self.get_group_permissions(user_obj))
  43. return user_obj._perm_cache
  44. def has_perm(self, user_obj, perm, obj=None):
  45. if not user_obj.is_active:
  46. return False
  47. return perm in self.get_all_permissions(user_obj, obj)
  48. def has_module_perms(self, user_obj, app_label):
  49. """
  50. Returns True if user_obj has any permissions in the given app_label.
  51. """
  52. if not user_obj.is_active:
  53. return False
  54. for perm in self.get_all_permissions(user_obj):
  55. if perm[:perm.index('.')] == app_label:
  56. return True
  57. return False
  58. def get_user(self, user_id):
  59. UserModel = get_user_model()
  60. try:
  61. return UserModel._default_manager.get(pk=user_id)
  62. except UserModel.DoesNotExist:
  63. return None
  64. class RemoteUserBackend(ModelBackend):
  65. """
  66. This backend is to be used in conjunction with the ``RemoteUserMiddleware``
  67. found in the middleware module of this package, and is used when the server
  68. is handling authentication outside of Django.
  69. By default, the ``authenticate`` method creates ``User`` objects for
  70. usernames that don't already exist in the database. Subclasses can disable
  71. this behavior by setting the ``create_unknown_user`` attribute to
  72. ``False``.
  73. """
  74. # Create a User object if not already in the database?
  75. create_unknown_user = True
  76. def authenticate(self, remote_user):
  77. """
  78. The username passed as ``remote_user`` is considered trusted. This
  79. method simply returns the ``User`` object with the given username,
  80. creating a new ``User`` object if ``create_unknown_user`` is ``True``.
  81. Returns None if ``create_unknown_user`` is ``False`` and a ``User``
  82. object with the given username is not found in the database.
  83. """
  84. if not remote_user:
  85. return
  86. user = None
  87. username = self.clean_username(remote_user)
  88. UserModel = get_user_model()
  89. # Note that this could be accomplished in one try-except clause, but
  90. # instead we use get_or_create when creating unknown users since it has
  91. # built-in safeguards for multiple threads.
  92. if self.create_unknown_user:
  93. user, created = UserModel._default_manager.get_or_create(**{
  94. UserModel.USERNAME_FIELD: username
  95. })
  96. if created:
  97. user = self.configure_user(user)
  98. else:
  99. try:
  100. user = UserModel._default_manager.get_by_natural_key(username)
  101. except UserModel.DoesNotExist:
  102. pass
  103. return user
  104. def clean_username(self, username):
  105. """
  106. Performs any cleaning on the "username" prior to using it to get or
  107. create the user object. Returns the cleaned username.
  108. By default, returns the username unchanged.
  109. """
  110. return username
  111. def configure_user(self, user):
  112. """
  113. Configures a user after creation and returns the updated user.
  114. By default, returns the user unmodified.
  115. """
  116. return user