From: Radek Czajka Date: Fri, 20 Nov 2026 23:58:34 +0000 (+0100) Subject: Redirect to login view instead of partially reimplementing it. Remove unusable flows... X-Git-Tag: 26.11 X-Git-Url: https://git.mdrn.pl/django-cas-provider.git/commitdiff_plain/82bdc6de3fbe4463fcb13520c6c62f9b0715524c?ds=inline Redirect to login view instead of partially reimplementing it. Remove unusable flows. Test up to Django 5.1 --- diff --git a/AUTHORS.txt b/AUTHORS.txt index 9900ace..f677ee8 100644 --- a/AUTHORS.txt +++ b/AUTHORS.txt @@ -4,3 +4,4 @@ Alex Kamedov Marek Stepniowski Fred Wenzel Sebastian Annies +Radek Czajka diff --git a/README.rst b/README.rst index d7bed27..b093c3f 100644 --- a/README.rst +++ b/README.rst @@ -23,9 +23,11 @@ USAGE ====== #. Add ``'cas_provider'`` to your ``INSTALLED_APPS`` tuple in *settings.py*. -#. In *settings.py*, set ``LOGIN_URL`` to ``'/cas/login/'`` and ``LOGOUT_URL`` to ``'/cas/logout/'`` -#. In *urls.py*, put the following line: ``(r'^cas/', include('cas_provider.urls')),`` -#. Create login/logout templates (or modify the samples) +#. In *urls.py*, put the following line: ``path('cas/', include('cas_provider.urls')),`` +#. Set up a regular Django login view (e.g. ``django.contrib.auth.views.LoginView``, + included in ``django.contrib.auth.urls``) and point ``LOGIN_URL`` to it. + ``LOGIN_URL`` must *not* point to the CAS login endpoint. +#. Create logout and warn templates (or modify the samples) #. Use 'cleanuptickets' management command to clean up expired tickets SETTINGS @@ -62,11 +64,17 @@ PROVIDED VIEWS login --------- +This is the CAS login endpoint (``/login?service=...``). It doesn't display a login form: +if the user is not authenticated, it redirects to ``settings.LOGIN_URL`` +with ``next`` pointing back to itself. Once the user is authenticated, it issues +a Service Ticket and redirects to the service. + +The ``renew`` and ``gateway`` parameters are not supported. + It has not required arguments. Optional arguments: -* template_name - login form template name (default is 'cas/login.html') * success_redirect - redirect after successful login if service GET argument is not provided (default is settings.LOGIN_REDIRECT_URL) * warn_template_name - warning page template name to allow login user to service if he diff --git a/cas_provider/fixtures/cas_users.json b/cas_provider/fixtures/cas_users.json index f31d5cb..523e5b2 100644 --- a/cas_provider/fixtures/cas_users.json +++ b/cas_provider/fixtures/cas_users.json @@ -28,7 +28,7 @@ "last_login": "2011-04-24 11:29:11", "groups": [], "user_permissions": [], - "password": "sha1$602c5$ba8608296f6bfcb352e978084b337a90d586ecc3", + "password": "md5$-$ca044838c4145364b91f5041e846f483", "email": "root@example.com", "date_joined": "2010-07-04 13:33:14" } @@ -46,7 +46,7 @@ "last_login": "2011-04-01 12:42:53", "groups": [], "user_permissions": [], - "password": "sha1$7dfb4$d19f8340a01b597089dfde6dc17bc5288c1f863e", + "password": "md5$-$ca044838c4145364b91f5041e846f483", "email": "active@example.com", "date_joined": "2011-04-01 11:12:45" } @@ -66,7 +66,7 @@ 2 ], "user_permissions": [], - "password": "sha1$6c580$01509bea19e3ade9f1bcf303205a7cb10ce6762d", + "password": "md5$-$ca044838c4145364b91f5041e846f483", "email": "", "date_joined": "2011-04-24 11:32:16" } @@ -86,7 +86,7 @@ 1 ], "user_permissions": [], - "password": "sha1$3be01$b6aa05c61fc52edae3055c55e160d4cfd4756d91", + "password": "md5$-$ca044838c4145364b91f5041e846f483", "email": "editor@exapmle.com", "date_joined": "2011-04-24 11:31:50" } @@ -104,7 +104,7 @@ "last_login": "2011-04-24 11:31:00", "groups": [], "user_permissions": [], - "password": "sha1$0bf10$d60f146d15e4fe3cb0de5a607a17902d0f63a95c", + "password": "md5$-$ca044838c4145364b91f5041e846f483", "email": "", "date_joined": "2011-04-24 11:31:00" } @@ -122,9 +122,9 @@ "last_login": "2011-04-24 11:31:26", "groups": [], "user_permissions": [], - "password": "sha1$5df85$bb4c1894a866fb86465d28831000af20316233d5", + "password": "md5$-$ca044838c4145364b91f5041e846f483", "email": "staff@example.com", "date_joined": "2011-04-24 11:31:26" } } -] \ No newline at end of file +] diff --git a/cas_provider/forms.py b/cas_provider/forms.py deleted file mode 100644 index 4a9a931..0000000 --- a/cas_provider/forms.py +++ /dev/null @@ -1,22 +0,0 @@ -from django import forms -from django.utils.translation import gettext_lazy as _ - - -class LoginForm(forms.Form): - username = forms.CharField(widget=forms.TextInput(attrs={'autofocus': 'autofocus', - 'max_length': '255'}), - label=_('Username')) - password = forms.CharField(widget=forms.PasswordInput(), label=_('Password')) - service = forms.CharField(widget=forms.HiddenInput, required=False) - - def __init__(self, *args, **kwargs): - # renew = kwargs.pop('renew', None) - # gateway = kwargs.pop('gateway', None) - request = kwargs.pop('request', None) - super(LoginForm, self).__init__(*args, **kwargs) - self.request = request - - -class MergeLoginForm(LoginForm): - username = forms.CharField(max_length=255, widget=forms.HiddenInput, - label=_('Username')) diff --git a/cas_provider/templates/cas/login.html b/cas_provider/templates/cas/login.html deleted file mode 100644 index ea1377e..0000000 --- a/cas_provider/templates/cas/login.html +++ /dev/null @@ -1,25 +0,0 @@ -{% extends "admin/base.html" %} - -{% block title %} -Login -{% endblock %} - -{% block content %} -
-
- Log in to your account - {% csrf_token %} - {% if errors %} -
    - {% for error in errors %} -
  • {{ error|escape }}
  • - {% endfor %} -
- {% endif %} - - {{ form.as_table }} -
-

-
-
-{% endblock %} diff --git a/cas_provider/templates/cas/merge.html b/cas_provider/templates/cas/merge.html deleted file mode 100644 index 5a362f7..0000000 --- a/cas_provider/templates/cas/merge.html +++ /dev/null @@ -1,24 +0,0 @@ -{% extends "base.html" %} - -{% block title %} -Merge -{% endblock %} - -{% block content %} -
-
- Merge your accounts - {% if errors %} -
    - {% for error in errors %} -
  • {{ error|escape }}
  • - {% endfor %} -
- {% endif %} - - {{ form.as_table }} -
-

-
-
-{% endblock %} diff --git a/cas_provider/urls.py b/cas_provider/urls.py index 7f32a48..6a84058 100644 --- a/cas_provider/urls.py +++ b/cas_provider/urls.py @@ -3,9 +3,7 @@ from cas_provider import views urlpatterns = [ - path('login/merge/', views.login, {'merge': True, 'template_name': 'cas/merge.html'}), path('login', views.login, name='cas_login'), - path('socialauth-login/', views.login, name='cas_socialauth_login'), path('validate', views.validate, name='cas_validate'), path('proxy', views.proxy, name='proxy'), path('serviceValidate', views.service_validate, name='cas_service_validate'), diff --git a/cas_provider/views.py b/cas_provider/views.py index a8e166c..a6b92fd 100644 --- a/cas_provider/views.py +++ b/cas_provider/views.py @@ -6,27 +6,24 @@ from urllib.parse import parse_qsl, urlencode, urlparse, urlsplit, urlunsplit from urllib.request import urlopen from functools import wraps -from django.views.decorators.debug import sensitive_post_parameters from django.views.decorators.cache import cache_control from django.utils.cache import patch_cache_control -from django.views.decorators.csrf import csrf_protect from django.http import HttpResponse, HttpResponseRedirect from django.conf import settings -from django.contrib.auth import login as auth_login, logout as auth_logout +from django.contrib.auth import logout as auth_logout +from django.contrib.auth.views import redirect_to_login +from django.core.exceptions import ImproperlyConfigured -from django.shortcuts import render +from django.shortcuts import render, resolve_url from django.utils.translation import gettext as _ from django.template import RequestContext -from django.contrib.auth import authenticate from lxml import etree from cas_provider.attribute_formatters import NSMAP, CAS from cas_provider.models import ProxyGrantingTicket, ProxyTicket from cas_provider.models import ServiceTicket -from cas_provider.forms import LoginForm, MergeLoginForm - from . import signals from django.urls import get_callable, reverse @@ -67,114 +64,46 @@ def never_cache(view_func): return _wrapped_view_func -@sensitive_post_parameters() -@csrf_protect @never_cache -def login(request, template_name='cas/login.html', - success_redirect=settings.LOGIN_REDIRECT_URL, - warn_template_name='cas/warn.html', **kwargs): - merge = kwargs.get('merge', False) - logging.debug('CAS Provider Login view. Method is %s, merge is %s, template is %s.', - request.method, merge, template_name) - - service = request.GET.get('service', None) - if service is not None: - # Save the service on the session, for later use if we end up - # in one of the more complicated workflows. - request.session['service'] = service - - user = request.user - - errors = [] +def login(request, success_redirect=None, warn_template_name='cas/warn.html'): + """CAS login endpoint (credential requestor). - if request.method == 'POST': - if merge: - form = MergeLoginForm(request.POST, request=request) - else: - form = LoginForm(request.POST, request=request) - - if form.is_valid(): - service = form.cleaned_data.get('service', None) - try: - auth_args = dict(username=form.cleaned_data['username'], - password=form.cleaned_data['password']) - if merge: - # We only want to send the merge argument if it's - # True. If it it's False, we want it to propagate - # through the auth backends properly. - auth_args['merge'] = merge - user = authenticate(**auth_args) - except: - # Need to merge the accounts? - if merge: - # We shouldn't get here... - raise - else: - base_url = reverse('cas_provider_merge') - args = dict( - success_redirect=success_redirect, - username=form.cleaned_data['username'], - ) - if service is not None: - args['service'] = service - args = urlencode(args) - - url = '%s?%s' % (base_url, args) - logging.debug('Redirecting to %s', url) - return HttpResponseRedirect(url) - - if user is None: - errors.append(_('Incorrect username and/or password.')) - else: - if user.is_active: - auth_login(request, user) - - else: # Not a POST... - if merge: - form = MergeLoginForm(initial={'service': service, 'username': request.GET.get('username')}) - else: - form = LoginForm(initial={'service': service}) - - if user is not None and user.is_authenticated: - # We have an authenticated user. - if not user.is_active: - errors.append(_('This account is disabled. Please contact us if you feel it should be enabled again.')) - else: - # Send the on_cas_login signal. If we get an HttpResponse, return that. - for receiver, response in signals.on_cas_login.send(sender=login, request=request, **kwargs): - if isinstance(response, HttpResponse): - return response - - if service is None: - # Try and pull the service off the session - service = request.session.pop('service', service) - - signals.on_cas_login_success.send(sender=login, request=request, - service=service, **kwargs) - - if service is None: - # Normal internal success redirection. - logging.debug('Redirecting to %s', success_redirect) - return HttpResponseRedirect(success_redirect) - else: - if request.GET.get('warn', False): - return render(request, warn_template_name, { - 'service': service, - 'warn': False - }) - - # Create a service ticket and redirect to the service. - ticket = ServiceTicket.objects.create(service=service, user=user) - if 'service' in request.session: - # Don't need this any more. - del request.session['service'] - - url = ticket.get_redirect_url() - logging.debug('Redirecting to %s', url) - return HttpResponseRedirect(url) - - logging.debug('Rendering response on %s, merge is %s', template_name, merge) - return render(request, template_name, {'form': form, 'errors': errors}) + Authentication itself is delegated to the regular Django login view + at settings.LOGIN_URL, which brings the user back here (via `next`) + once logged in. Then a service ticket is issued for the service. + """ + if not request.user.is_authenticated: + login_url = resolve_url(settings.LOGIN_URL) + if urlsplit(login_url).path == request.path: + raise ImproperlyConfigured( + "settings.LOGIN_URL must point to a regular login view, " + "not to the CAS login endpoint.") + return redirect_to_login(request.get_full_path(), login_url) + + service = request.GET.get('service') or None + + # Send the on_cas_login signal. If we get an HttpResponse, return that. + for receiver, response in signals.on_cas_login.send(sender=login, request=request): + if isinstance(response, HttpResponse): + return response + + signals.on_cas_login_success.send(sender=login, request=request, service=service) + + if service is None: + # Normal internal success redirection. + return HttpResponseRedirect(resolve_url(success_redirect or settings.LOGIN_REDIRECT_URL)) + + if request.GET.get('warn', False): + return render(request, warn_template_name, { + 'service': service, + 'warn': False + }) + + # Create a service ticket and redirect to the service. + ticket = ServiceTicket.objects.create(service=service, user=request.user) + url = ticket.get_redirect_url() + logger.debug('Redirecting to %s', url) + return HttpResponseRedirect(url) @never_cache diff --git a/cas_provider_examples/simple/settings.py b/cas_provider_examples/simple/settings.py index e594559..e089b8a 100644 --- a/cas_provider_examples/simple/settings.py +++ b/cas_provider_examples/simple/settings.py @@ -51,7 +51,7 @@ MEDIA_URL = '' # Allow SHA1, because it's used in the fixture. PASSWORD_HASHERS = [ - 'django.contrib.auth.hashers.SHA1PasswordHasher', + 'django.contrib.auth.hashers.MD5PasswordHasher', ] # Absolute path to the directory static files should be collected to. diff --git a/cas_provider_examples/simple/templates/registration/login.html b/cas_provider_examples/simple/templates/registration/login.html new file mode 100644 index 0000000..9895b03 --- /dev/null +++ b/cas_provider_examples/simple/templates/registration/login.html @@ -0,0 +1,14 @@ +{% extends "base.html" %} + +{% block title %} +Login +{% endblock %} + +{% block content %} +
+ {% csrf_token %} + {{ form.as_p }} + +

+
+{% endblock %} diff --git a/cas_provider_examples/simple/tests.py b/cas_provider_examples/simple/tests.py index 4e8b05e..a6e0c46 100644 --- a/cas_provider_examples/simple/tests.py +++ b/cas_provider_examples/simple/tests.py @@ -1,5 +1,5 @@ from io import StringIO -from urllib.parse import urlparse, parse_qsl, parse_qs +from urllib.parse import urlparse, parse_qsl, parse_qs, urlencode from urllib.request import install_opener from xml import etree from xml.etree import ElementTree @@ -11,6 +11,7 @@ from cas_provider.views import _cas2_sucess_response, INVALID_TICKET, _cas2_erro from django.contrib.auth.models import User, UserManager from django.test import TestCase from django.conf import settings +from django.core.exceptions import ImproperlyConfigured from django.urls import reverse @@ -160,6 +161,38 @@ class ViewsTest(TestCase): self.assertTemplateUsed(response, 'cas/warn.html') + def test_login_redirects_to_login_url(self): + response = self.client.get(reverse('cas_login'), {'service': self.service, 'warn': 'true'}) + self.assertEqual(response.status_code, 302) + login_url = response['location'] + self.assertTrue(login_url.startswith(settings.LOGIN_URL + '?next='), login_url) + + response = self.client.get(login_url) + self.assertEqual(response.status_code, 200) + self.assertTemplateUsed(response, 'registration/login.html') + + response = self.client.post(login_url, {'username': 'root', 'password': '123'}) + self.assertEqual(response.status_code, 302) + self.assertEqual( + response['location'], + reverse('cas_login') + '?' + urlencode({'service': self.service, 'warn': 'true'})) + + response = self.client.get(response['location']) + self.assertEqual(response.status_code, 200) + self.assertTemplateUsed(response, 'cas/warn.html') + + def test_login_empty_service(self): + self.client.login(username='root', password='123') + response = self.client.get(reverse('cas_login'), {'service': ''}, follow=False) + self.assertEqual(response.status_code, 302) + self.assertEqual(response['location'], settings.LOGIN_REDIRECT_URL) + self.assertFalse(ServiceTicket.objects.exists()) + + def test_login_url_loop(self): + with self.settings(LOGIN_URL=reverse('cas_login')): + with self.assertRaises(ImproperlyConfigured): + self.client.get(reverse('cas_login'), {'service': self.service}) + def _cas_logout(self): response = self.client.get(reverse('cas_logout'), follow=False) self.assertEqual(response.status_code, 200) @@ -172,8 +205,9 @@ class ViewsTest(TestCase): self._cas_logout() response = self.client.get(reverse('cas_login'), follow=False) - self.assertEqual(response.status_code, 200) - self.assertTrue(response.context['user'].is_anonymous) + self.assertEqual(response.status_code, 302) + self.assertTrue(response['location'].startswith(settings.LOGIN_URL)) + self.assertNotIn('_auth_user_id', self.client.session) def test_broken_pwd(self): @@ -291,24 +325,31 @@ class ViewsTest(TestCase): self._validate_cas1(response, False) response = self.client.get(reverse('cas_login'), {'service': self.service}, follow=False) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 302) + self.assertTrue(response['location'].startswith(settings.LOGIN_URL)) response = self.client.get(reverse('cas_login'), follow=False) - self.assertEqual(response.status_code, 200) + self.assertEqual(response.status_code, 302) + self.assertTrue(response['location'].startswith(settings.LOGIN_URL)) def _login_user(self, username, password): + """Go through the CAS login endpoint and the regular login view. + + Returns the response of the CAS login endpoint after logging in, + or the login form response if the login failed. + """ self.username = username response = self.client.get(reverse('cas_login'), {'service': self.service}) - self.assertEqual(response.status_code, 200) - self.assertTemplateUsed(response, 'cas/login.html') - form = response.context['form'] - service = form['service'].value() - return self.client.post(reverse('cas_login'), { + self.assertEqual(response.status_code, 302) + login_url = response['location'] + response = self.client.post(login_url, { 'username': username, 'password': password, - 'service': service }, follow=False) + if response.status_code != 302: + return response + return self.client.get(response['location'], follow=False) def _validate_cas1(self, response, is_correct=True): @@ -323,7 +364,7 @@ class ViewsTest(TestCase): self.assertEqual(response.content.decode('utf-8'), 'yes\n%s\n' % self.username) else: self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.context['errors']), 1) + self.assertEqual(len(response.context['form'].non_field_errors()), 1) response = self.client.get(reverse('cas_validate'), {'ticket': 'ST-12312312312312312312312', 'service': self.service}, follow=False) self.assertEqual(response.status_code, 200) @@ -343,7 +384,7 @@ class ViewsTest(TestCase): self.assertEqual(response.status_code, 200) else: self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.context['errors']), 1) + self.assertEqual(len(response.context['form'].non_field_errors()), 1) response = self.client.get(reverse('cas_service_validate'), {'ticket': 'ST-12312312312312312312312', 'service': self.service}, follow=False) self.assertEqual(response.status_code, 200) diff --git a/cas_provider_examples/simple/urls.py b/cas_provider_examples/simple/urls.py index dfa9975..22501c2 100644 --- a/cas_provider_examples/simple/urls.py +++ b/cas_provider_examples/simple/urls.py @@ -5,6 +5,7 @@ from django import VERSION urlpatterns = [ path('admin/', admin.site.urls), + path('accounts/', include('django.contrib.auth.urls')), path('', include('cas_provider.urls')), path('accounts/profile/', TemplateView.as_view(template_name='login-success-redirect-target.html')), ] diff --git a/setup.py b/setup.py index b5c3ae0..c1b9429 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ def read(fname): setup( name='django-cas-provider', - version='24.6', + version='26.11', description='A "provider" for the Central Authentication Service (http://jasig.org/cas)', author='(Chris Williams), Sebastian Annies', author_email='(chris@nitron.org), sebastian.annies@googlemail.com', @@ -17,7 +17,7 @@ setup( long_description=read('README.rst'), zip_safe=False, install_requires=[ - 'Django>=2.0,<5.1', + 'Django>=2.0,<6.2', 'lxml', ], classifiers = [ diff --git a/tox.ini b/tox.ini index 2a0de15..ca32c03 100644 --- a/tox.ini +++ b/tox.ini @@ -1,30 +1,33 @@ [tox] envlist=clear, - d20-py{37}, - d21-py{37}, - d22-py{37,38,39}, - d{30,31}-py{37,38,39}, - d32-py{37,38,39,310}, - d40-py{38,39,310}, + d{22,30,31}-py{38,39}, + d{32,40}-py{38,39,310}, d41-py{38,39,310,311}, d42-py{38,39,310,311,312}, d50-py{310,311,312}, + d51-py{310,311,312,313}, + d52-py{310,311,312,313,314}, + d60-py{312,313,314}, + d61-py{312,313,314,315}, stats [testenv] commands=coverage run --source=cas_provider --append --branch cas_provider_examples/manage.py test simple deps= - d111: Django>=1.11,<2.0 - d20: Django>=2.0,<2.1 - d21: Django>=2.1,<2.2 - d22: Django>=2.2,<3.0 - d30: Django>=3.0,<3.1 - d31: Django>=3.1,<3.2 - d32: Django>=3.2,<4.0 - d40: Django>=4.0,<4.1 - d41: Django>=4.1,<4.2 - d42: Django>=4.2,<5.0 - d50: Django>=5.0,<5.1 + d20: Django~=2.0.0 + d21: Django~=2.1.0 + d22: Django~=2.2.0 + d30: Django~=3.0.0 + d31: Django~=3.1.0 + d32: Django~=3.2.0 + d40: Django~=4.0.0 + d41: Django~=4.1.0 + d42: Django~=4.2.0 + d50: Django~=5.0.0 + d51: Django~=5.1.0 + d52: Django~=5.2.0 + d60: Django~=6.0.0 + d61: Django~=6.1.0 coverage usedevelop=True