Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a new authentication backend for case-insensitive emails #31

Merged
merged 8 commits into from
Apr 2, 2015
Merged

Add a new authentication backend for case-insensitive emails #31

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c367c8a
Add a new authentication backend for case-insensitive emails as a pos…
Mar 25, 2015
2353bcb
Add **kwargs to method signature, check to see if username is passed in
Mar 25, 2015
999786e
Add cautionary message to potential users of the backend
Mar 26, 2015
23ec089
Add mixin to make the case-insensitive email auth backend more flexible
Apr 2, 2015
50aa976
Move docstring to mixin, and remove redundant functionality in CaseIn…
Apr 2, 2015
70f8804
Add docs for new authentication backend classes
Apr 2, 2015
bfd7dd6
Add new UserCreationForm subclass and corresponding documentation
Apr 2, 2015
4ab3445
Add suggestion in backends docs, fix typo in backends.py
Apr 2, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions authtools/backends.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
from django.contrib.auth.backends import ModelBackend


class CaseInsensitiveEmailBackend(ModelBackend):
"""
This authentication backend assumes that usernames are email addresses and simply lowercases
a username before an attempt is made to authenticate said username using Django's ModelBackend.

Example usage:
# In settings.py
AUTHENTICATION_BACKENDS = ('authtools.backends.CaseInsensitiveEmailBackend',)
"""
def authenticate(self, username=None, password=None):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have an app that requires me to pass in the request to the authenticate calls.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rockymeza Are you saying this because of the method signature?

If so, django handles the TypeError https://github.com/django/django/blob/master/django/contrib/auth/__init__.py#L69

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

He wants the lower() to be called, though, so this should just be changed to be **credentials instead.

username = username.lower()
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I think this is going to raise an AttributeError that will bubble out of authenticate if called like authenticate(password='foo').

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

def authenticate(self, username, **credentials):

This would require that a username is passed in.


return super(CaseInsensitiveEmailBackend, self).authenticate(
username=username,
password=password
)