adamcharnock / django-su

Login as any user from the Django admin interface, then switch back when done

django-su

Login as any user from the Django admin interface, then switch back when done

Authored by Adam Charnock, and some great contributors.

Installation

1. Either checkout django_su from GitHub, or install using pip :

   pip install django-su

2. Add django_su to your INSTALLED_APPS. Make sure you put it before django.contrib.admin :

   INSTALLED_APPS = (
       ...
       'django_su',  # must be before ``django.contrib.admin``
       'django.contrib.admin',
   )

3. Add SuBackend to AUTHENTICATION_BACKENDS :

   AUTHENTICATION_BACKENDS = (
       ...
       'django_su.backends.SuBackend',
   )

4. Update your urls.py file :

   urlpatterns = [
       url(r'^su/', include('django_su.urls')),
       ...
   ]

And that should be it!

Please see example application. This application is used to manually test the functionalities of this package. This also serves as a good example.

django-su is tested on Django 2.2 or above, lower versions may work, but are considered unsupported.

External dependencies (optional, but recommended)

The following apps are optional but will enhance the user experience:

• The 'login su' form will render using django-form-admin
• The user selection widget will render using django-ajax-selects

Note that django-ajax-selects requires the following settings:

AJAX_LOOKUP_CHANNELS = {'django_su':  dict(model='auth.user', search_field='username')}

Configuration (optional)

There are various optional configuration options you can set in your settings.py

# URL to redirect after the login.
# Default: "/"
SU_LOGIN_REDIRECT_URL = "/"

# URL to redirect after the logout.
# Default: "/"
SU_LOGOUT_REDIRECT_URL = "/"

# A function specifying the permissions a user requires in order
# to use the django-su functionality.
# Default: None
SU_LOGIN_CALLBACK = "example.utils.su_login_callback"

# A function to override the django.contrib.auth.login(request, user)
# view, thereby allowing one to set session data, etc.
# Default: None
SU_CUSTOM_LOGIN_ACTION = "example.utils.custom_login"

Usage

Go and view a user in the admin interface and look for a new "Login as" button in the top right.

Once you have su'ed into a user, you can get exit back into your original user by navigating to /su/ in your browser.

How to

How to Notify superuser when connected with another user

This option warns the superuser when working with another user as initially logged in. To activate this option perform:

1. Add django_su.context_processors.is_su to TEMPLATE_CONTEXT_PROCESSORS :

   TEMPLATE_CONTEXT_PROCESSORS = (
       ...
       'django_su.context_processors.is_su',
   )

2. In your base.html include su/is_su.html snippet :

   {% include "su/is_su.html" %}

How to use django-su with a custom user model (AUTH_USER_MODEL)

Django-su should function normally with a custom user model. However, your ModelAdmin in your admin.py file will need tweaking as follows:

# Within your admin.py file
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin

from . import models

 @admin.register(models.CustomUser)
 class CustomUserAdmin(UserAdmin):
     # The following two lines are needed:
     change_form_template = "admin/auth/user/change_form.html"
     change_list_template = "admin/auth/user/change_list.html"

This ensures the Django admin will use the correct template customisations for your custom user model.

Credits

This app was put together by Adam Charnock, but was largely based on ideas, code and comments at:

• http://bitkickers.blogspot.com/2010/06/add-button-to-django-admin-to-login-as.html
• http://copiousfreetime.blogspot.com/2006/12/django-su.html

django-su is packaged using seed.

django-su's Issues

New release in pypi

New release in pypi. @adamcharnock or @katzj, could you tell me our users in pypi?, And I will add to the manteiners in pypi, and then you will be able to create a new release.

https://pypi.python.org/pypi/django-su

Update category @ Django Packages / Feature Request

Just thought you may like to know your app is listed externally here:
https://www.djangopackages.com/packages/p/django-su/

However, there appears to be a more appropriate category and when searching for packages that provide similar functionality yours may not get evaluated:
https://www.djangopackages.com/grids/g/user-switching/

Since I already knew about and utilize your app, I thought you should know. It's extremely useful. I would also like to request one feature:

Please allow the ability to enable staff users to impersonate users and/or the ability for a super-user to assign the permission to staff user to impersonate a user.

ModuleNotFoundError: No module named 'django_sudjango'

Hi, I am trying to use this library but for some reason I cannot get it to work. I have followed all of the instructions but still I am getting an error saying that django_sudjango was not found (although I did not use django_sudjago anywhere as import)

I am pretty sure that I am doing something silly, but I would love to hear back from you.

Add a License...

I noticed that your package doesn't have a license... Could you please add one?

I hope you'll select an open-source licence (BSD, MIT, GPL -- in that order), but it's up to you. I can't really use any of your code without a license... :-/

Django 1.10 compatibility: RemovedInDjango110Warning

There is warning about future incompatibility with Django 1.10

/home/petr/soubory/programovani/Auto-mat/DPNK/dpnk/env/lib/python3.4/site-packages/django_su/urls.py:12: RemovedInDjango110Warning: django.conf.urls.patterns() is deprecated and will be removed in Django 1.10. Update your urlpatterns to be a list of django.conf.urls.url() instances instead.

Urls use deprecated syntax

Consider changing to simply

from . import views
urlpatterns = patterns("django_su.views",
    url(r"^$", views.su_logout, name="su_logout"),
    url(r"^login/$", views.su_login, name="su_login"),
    url(r"^(?P<user_id>-?[\d]+)/$", views.login_as_user, name="login_as_user"),
)

urlpatterns = patterns("django_su.views",
    url(r"^$", "su_logout", name="su_logout"),
    url(r"^login/$", "su_login", name="su_login"),
    url(r"^(?P<user_id>-?[\d]+)/$", "login_as_user", name="login_as_user"),
)

Customize presentation of text on the admin site

I am using django-suit.
I made a small change in my base_site.html (extended) file to set the text display otherwise to the accessed user.

After access:

The code:

{% block welcome-msg %}
  {% if IS_SU %}
    <a href="/su/" title="{% trans 'Restabelecer papel original' %}">{% trans 'Você' %}</a>{% trans ' acessou como,' %}
  {% else %}
    {% trans 'Welcome,' %}
  {% endif %}
  <strong>
    {% filter force_escape %}
      {% firstof user.first_name user.username %}
    {% endfilter %}
  </strong>.
{% endblock %}

Adding SuBackend to AUTHENTICATION_BACKENDS

I didn't see this in the documentation but it appears that one needs to add this to the authentication backends for django_su to work:

AUTHENTICATION_BACKENDS = (
    # Needed to login by username in Django admin
    "django.contrib.auth.backends.ModelBackend",

    # Needed for django su to work
    "django_su.backends.SuBackend",
)

Please advise.

Django==1.5.2
django-su==0.3.2

Allow negative user id?

Some situation like ANONYMOUS_USER_ID = -1 for django-guardian.

Broken link to log in as "group"

The "Login as" object tool shows up in Group. I don't see any reason for this. If I'm not mistaken, it would make sense to place the change_form.html in /admin/auth/user/ instead of /admin/auth/

Consider using Django's module loading utils

I'm pretty sure the overly complex importpath function can be removed in favor of Django's own module loading utils.

avoid entering user_logged_in when using django-su

Hi!

I want to log user log in date using something like this:

from django.contrib.auth.signals import user_logged_in
def set_last_seen(sender, user, request, **kwargs):
    if not len(request.session.get("exit_users_pk", default=[])):
       user.profile.last_seen = timezone.now()
       user.profile.save()
user_logged_in.connect(set_last_seen)

But looks like exit_users_pk is being populated after the signal is sent, cause it's always empty.
Is there a way we can check in this signal if the login is triggered by django-su?

Only admin can login with other user credentials?

Hi,

I need a feature like Netflix users management, that one users can impersonate the "children"

Thanks for support!

Error in setup.py

Change:
from tz_detect import __version__
to:
from django_su import __version__

Pass the target user to the SU_LOGIN function where available

Adam, thanks for your sweet little app. My use case needs us to restrict su permissions for users based on who they're trying to become. So I'd like the target user passed as a second parameter to the SU_LOGIN function.

I've forked and committed something that's working for me so far. It maintains backwards compatibility by using introspection to discover how many arguments the SU_LOGIN function takes. It only passes the second argument if the function takes two arguments. I wondered what you thought so far, before I issue a pull request.

After using this not able to login as super admin.

I have setup a fresh Django project in my local with super admin and install the plugin after that I am facing problem. The Dijango landing page is not opening up it say 404 and I am not able to login into other Django admin after using this but if I remove this plugin I am able to login in the Django admin with my existing superuser account . I have followed the step for 1 to 4 written in the description for the plugin. I am very new to Django can anyone help me. If anyone need screenshot or code sample I can give that . Thank You

error updating to 0.3.2

I get the following error trying to --update django-su. Any ideas?

Downloading/unpacking django-su==0.3.2 (from -r statuspath/Documentation/requirements.txt (line 30))
Running setup.py egg_info for package django-su
Traceback (most recent call last):
File "", line 16, in
File "/tmp/pip-build/django-su/setup.py", line 6, in
from django_su import version
ImportError: cannot import name version
Complete output from command python setup.py egg_info:
Traceback (most recent call last):

File "", line 16, in

File "/tmp/pip-build/django-su/setup.py", line 6, in

from django_su import __version__

ImportError: cannot import name version

---

Command python setup.py egg_info failed with error code 1 in /tmp/pip-build/django-su
Storing complete log in /root/.pip/pip.log
[ec2-user@qa1 ~]$ sudo pip install django-su --upgrade
Downloading/unpacking django-su from https://pypi.python.org/packages/source/d/django-su/django-su-0.3.2.tar.gz#md5=6ce232bb52d0124d3e957e9c634e91de
Running setup.py egg_info for package django-su
Traceback (most recent call last):
File "", line 16, in
File "/tmp/pip-build/django-su/setup.py", line 6, in
from django_su import version
ImportError: cannot import name version
Complete output from command python setup.py egg_info:
Traceback (most recent call last):

File "", line 16, in

File "/tmp/pip-build/django-su/setup.py", line 6, in

from django_su import __version__

ImportError: cannot import name version

---

Command python setup.py egg_info failed with error code 1 in /tmp/pip-build/django-su

Update ``example`` project

Make sure example project works without PYTHONPATH manipulations

(Django 1.4) Reverse for ''login_as_user'' with arguments '(u'111',)' and keyword arguments '{}' not found.

Logging in as a user shouldn't change the user's `last_login` timestamp

This happens when we call Django's login() function, which triggers the user_logged_in signal. This in turn triggers django's update_last_login().

The only obvious way I can see to achieve this is to change the last_login value back after it has been set, but this does not feel ideal. Better suggestions welcome!

CSRF error when selecting user in /su/login

Couldn't reopen issue #48, so I'll copy and paste here:

Hi, bashu!

Sorry it took me a bit more to test your changes.

User admin page now looks great and works great as well. In the beginning it was deleting my session, but I think it was because I didn't remove 0.5.0 before installing 0.5.1.

However, now selecting a user in the /su/login page gives me a CSRF error. It was working ok with 0.5.0 (which I reinstalled to be sure).

Also, I don't know why, the "Login as another user" button in that page looks different because the anchor tag is inside a List Item. I don't know if there's a way to fix that in the plug-in or if I should retouch the template. Here's a screenshot:

Thank you!

Breaks user admin in django-suit

Hi!.

Great work with the plugin, it's really useful.

However, it looks like it doesn't like to work with django-suit. "Login as" works ok in the changelist, but it breaks completely the user form in the admin.

Thanks!

Staff can login as superuser

This package is great work, thanks !

I've tested it for my app, and because I need any of my staff to login as a user, I added the login callback:
SU_LOGIN_CALLBACK = "example.utils.su_login_callback"

The problem is that now, any staff can login as superuser and edit their own permissions...

How can I restrict the login as to non-staff user only ?

Thanks

Incompatible with Django 1.5

Two deprecations:

• url template tag with unquoted views
• adminmedia

Python 3 support

Does django-su support Python 3?

If so, it would be nice to designate that on PyPI using classifiers in setup.py (see https://pypi.python.org/pypi?%3Aaction=list_classifiers).

If not, what does the path forward look like?

Usage with custom AUTH_USER_MODEL

The django-su application doesn't work out of the box. It requires setting of template paths. Please mention this in the README for future developers. My code looks like:

@admin.register(models.UserProfile)
class UserProfileAdmin(UserAdmin):
    change_form_template = "admin/auth/user/change_form.html"
    change_list_template = "admin/auth/user/change_list.html"

TypeError: get() takes no keyword arguments

Error message:

File "/usr/local/lib/python3.5/dist-packages/django_su/context_processors.py", line 5, in is_su
    return {"IS_SU": len(request.session.get("exit_users_pk", default=[]))}
TypeError: get() takes no keyword arguments

It may be a good idea to refactor this line into:

return {"IS_SU": len(request.session.get("exit_users_pk", []))}

See: https://stackoverflow.com/questions/24463202/typeerror-get-takes-no-keyword-arguments

Any chance of a new version on pypi?

I prefer installing from pypi. Version 0.8 does what I need, but I no longer have any django projects that use anything older than Django 1.11. It'd be nice to have a version that explicitly supports 1.11 and pythons newer than 3.4, which is after all end-of-lifed. When 1.11 is eol, another version that officially does not support python 2 would also be appreciated.

A couple of quick suggestions

Hello!.

A couple of quick suggestions for the module, hoping you guys like them:

• Combo/Autocomplete selector: since many times user logins are dictated by ids, or national id, or whatever, add Name and Surname both in the displayed options and as searchable strings for the ajax selects, i.e., instead of user "100000065" show "100000065 (Pepe Pérez)".
• Add a link to stop _su_ing a user, perhaps one besides "change password" and "logout". Another alternative could be showing the user being _su_ed and the real user in brackets, and clicking in the real user login would bring you back to your own profile. Example: "Welcome, 100000065 [pperez]"

Thank you, and again, great work!

Support for string view arguments is deprecated

According to logs (running with Django 1.9.4):
django_su/urls.py:10: RemovedInDjango110Warning: Support for string view arguments to url() is deprecated and will be removed in Django 1.10 (got su_logout). Pass the callable instead.

User not found

Hello,

When I attempt to use django-su to switch to a different user, I get the error "User not found". Nothing comes back in the output of the built in Django server and that is all that shows. I am using Django 1.5.1 with the latest version of django-su.

Any ideas?

Order user dropdown alphabetically

The user selection drop-down in the admin UI shows unordered users, which makes it hard to find the desired user in the list.

django-admin-tools base template conflict with su base_site.html

https://github.com/django-admin-tools/django-admin-tools/blob/master/admin_tools/menu/templates/admin/base_site.html

INSTALLED_APPS = (
    'django_su',

    'admin_tools',
    'admin_tools.theming',
    'admin_tools.menu',
    'admin_tools.dashboard',

    'django.contrib.auth',
    ........
)