Redirect to login view instead of partially reimplementing it. Remove unusable flows...
[django-cas-provider.git] / cas_provider / views.py
index 6cc322a..a6b92fd 100644 (file)
@@ -1,37 +1,33 @@
 import logging
 logger = logging.getLogger('cas_provider.views')
 import logging
 logger = logging.getLogger('cas_provider.views')
-import urllib
 
 
-from urllib import urlencode
-import urllib2
-import urlparse
+from urllib.error import HTTPError, URLError
+from urllib.parse import parse_qsl, urlencode, urlparse, urlsplit, urlunsplit
+from urllib.request import urlopen
 from functools import wraps
 
 from functools import wraps
 
-from django.utils.decorators import available_attrs
-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.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.http import HttpResponse, HttpResponseRedirect
 from django.conf import settings
-from django.contrib.auth import login as auth_login, logout as auth_logout
-from django.core.urlresolvers import get_callable
-from django.shortcuts import render_to_response
-from django.utils.translation import ugettext as _
+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, resolve_url
+from django.utils.translation import gettext as _
 from django.template import RequestContext
 from django.template import RequestContext
-from django.contrib.auth import authenticate
-from django.core.urlresolvers import reverse
 
 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 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 . import signals
 
+from django.urls import get_callable, reverse
+
 __all__ = ['login', 'validate', 'logout', 'service_validate']
 
 INVALID_TICKET = 'INVALID_TICKET'
 __all__ = ['login', 'validate', 'logout', 'service_validate']
 
 INVALID_TICKET = 'INVALID_TICKET'
@@ -40,10 +36,10 @@ INVALID_REQUEST = 'INVALID_REQUEST'
 INTERNAL_ERROR = 'INTERNAL_ERROR'
 
 ERROR_MESSAGES = (
 INTERNAL_ERROR = 'INTERNAL_ERROR'
 
 ERROR_MESSAGES = (
-    (INVALID_TICKET, u'The provided ticket is invalid.'),
-    (INVALID_SERVICE, u'Service is invalid'),
-    (INVALID_REQUEST, u'Not all required parameters were sent.'),
-    (INTERNAL_ERROR, u'An internal error occurred during ticket validation'),
+    (INVALID_TICKET, 'The provided ticket is invalid.'),
+    (INVALID_SERVICE, 'Service is invalid'),
+    (INVALID_REQUEST, 'Not all required parameters were sent.'),
+    (INTERNAL_ERROR, 'An internal error occurred during ticket validation'),
     )
 
 
     )
 
 
@@ -58,7 +54,7 @@ def never_cache(view_func):
     Decorator that adds headers to a response so that it will
     never be cached.
     """
     Decorator that adds headers to a response so that it will
     never be cached.
     """
-    @wraps(view_func, assigned=available_attrs(view_func))
+    @wraps(view_func)
     def _wrapped_view_func(request, *args, **kwargs):
         response = view_func(request, *args, **kwargs)
         patch_cache_control(response, no_cache=True,
     def _wrapped_view_func(request, *args, **kwargs):
         response = view_func(request, *args, **kwargs)
         patch_cache_control(response, no_cache=True,
@@ -68,114 +64,46 @@ def never_cache(view_func):
     return _wrapped_view_func
 
 
     return _wrapped_view_func
 
 
-@sensitive_post_parameters()
-@csrf_protect
 @never_cache
 @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)
+def login(request, success_redirect=None, warn_template_name='cas/warn.html'):
+    """CAS login endpoint (credential requestor).
 
 
-    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
+    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)
 
 
-    user = request.user
+    service = request.GET.get('service') or None
 
 
-    errors = []
+    # 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
 
 
-    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 = urllib.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})
+    signals.on_cas_login_success.send(sender=login, request=request, 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_to_response(warn_template_name, {
-                        'service': service,
-                        'warn': False
-                    }, context_instance=RequestContext(request))
-
-                # 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_to_response(template_name, {'form': form, 'errors': errors}, context_instance=RequestContext(request))
+    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
 
 
 @never_cache
@@ -213,14 +141,13 @@ def validate(request):
 def logout(request, template_name='cas/logout.html',
            auto_redirect=settings.CAS_AUTO_REDIRECT_AFTER_LOGOUT):
     url = request.GET.get('url', None)
 def logout(request, template_name='cas/logout.html',
            auto_redirect=settings.CAS_AUTO_REDIRECT_AFTER_LOGOUT):
     url = request.GET.get('url', None)
-    if request.user.is_authenticated():
+    if request.user.is_authenticated:
         for ticket in ServiceTicket.objects.filter(user=request.user):
             ticket.delete()
         auth_logout(request)
         if url and auto_redirect:
             return HttpResponseRedirect(url)
         for ticket in ServiceTicket.objects.filter(user=request.user):
             ticket.delete()
         auth_logout(request)
         if url and auto_redirect:
             return HttpResponseRedirect(url)
-    return render_to_response(template_name, {'url': url},
-        context_instance=RequestContext(request))
+    return render(request, template_name, {'url': url})
 
 
 @never_cache
 
 
 @never_cache
@@ -234,7 +161,7 @@ def proxy(request):
         return _cas2_error_response(INVALID_TICKET)
 
     pt = ProxyTicket.objects.create(proxyGrantingTicket=proxyGrantingTicket,
         return _cas2_error_response(INVALID_TICKET)
 
     pt = ProxyTicket.objects.create(proxyGrantingTicket=proxyGrantingTicket,
-        user=proxyGrantingTicket.serviceTicket.user,
+        user=proxyGrantingTicket.user,
         service=targetService)
     return _cas2_proxy_success(pt.ticket)
 
         service=targetService)
     return _cas2_proxy_success(pt.ticket)
 
@@ -255,8 +182,8 @@ def ticket_validate(service, ticket_string, pgtUrl):
     except ServiceTicket.DoesNotExist:
         return _cas2_error_response(INVALID_TICKET)
 
     except ServiceTicket.DoesNotExist:
         return _cas2_error_response(INVALID_TICKET)
 
-    ticketUrl = urlparse.urlparse(ticket.service)
-    serviceUrl = urlparse.urlparse(service)
+    ticketUrl = urlparse(ticket.service)
+    serviceUrl = urlparse(service)
 
     if not(ticketUrl.hostname == serviceUrl.hostname and ticketUrl.path == serviceUrl.path and ticketUrl.port == serviceUrl.port):
         return _cas2_error_response(INVALID_SERVICE)
 
     if not(ticketUrl.hostname == serviceUrl.hostname and ticketUrl.path == serviceUrl.path and ticketUrl.port == serviceUrl.port):
         return _cas2_error_response(INVALID_SERVICE)
@@ -268,16 +195,16 @@ def ticket_validate(service, ticket_string, pgtUrl):
         if pgt:
             pgtIouId = pgt.pgtiou
 
         if pgt:
             pgtIouId = pgt.pgtiou
 
-    if hasattr(ticket, 'proxyticket'):
-        pgt = ticket.proxyticket.proxyGrantingTicket
+    try:
+        proxyTicket = ticket.proxyticket
+    except ProxyTicket.DoesNotExist:
+        pass
+    else:
+        pgt = proxyTicket.proxyGrantingTicket
         # I am issued by this proxy granting ticket
         # I am issued by this proxy granting ticket
-        if hasattr(pgt.serviceTicket, 'proxyticket'):
-            while pgt:
-                if hasattr(pgt.serviceTicket, 'proxyticket'):
-                    proxies += (pgt.serviceTicket.service,)
-                    pgt = pgt.serviceTicket.proxyticket.proxyGrantingTicket
-                else:
-                    pgt = None
+        while pgt.pgt is not None:
+            proxies += (pgt.service,)
+            pgt = pgt.pgt
 
     user = ticket.user
     ticket.delete()
 
     user = ticket.user
     ticket.delete()
@@ -307,31 +234,29 @@ def proxy_validate(request):
 
 def generate_proxy_granting_ticket(pgt_url, ticket):
     proxy_callback_good_status = (200, 202, 301, 302, 304)
 
 def generate_proxy_granting_ticket(pgt_url, ticket):
     proxy_callback_good_status = (200, 202, 301, 302, 304)
-    uri = list(urlparse.urlsplit(pgt_url))
+    uri = list(urlsplit(pgt_url))
 
     pgt = ProxyGrantingTicket()
 
     pgt = ProxyGrantingTicket()
-    pgt.serviceTicket = ticket
-    pgt.targetService = pgt_url
-
-    if hasattr(ticket, 'proxyGrantingTicket'):
-        # here we got a proxy ticket! tata!
-        pgt.pgt = ticket.proxyGrantingTicket
+    pgt.user = ticket.user
+    pgt.service = ticket.service
+    # Remember if it's a chained PGT.
+    pgt.pgt = getattr(ticket, 'proxyGrantingTicket', None)
 
     params = {'pgtId': pgt.ticket, 'pgtIou': pgt.pgtiou}
 
 
     params = {'pgtId': pgt.ticket, 'pgtIou': pgt.pgtiou}
 
-    query = dict(urlparse.parse_qsl(uri[4]))
+    query = dict(parse_qsl(uri[4]))
     query.update(params)
 
     uri[3] = urlencode(query)
 
     try:
     query.update(params)
 
     uri[3] = urlencode(query)
 
     try:
-        urllib2.urlopen(urlparse.urlunsplit(uri))
-    except urllib2.HTTPError as e:
+        urlopen(urlunsplit(uri))
+    except HTTPError as e:
         if not e.code in proxy_callback_good_status:
         if not e.code in proxy_callback_good_status:
-            logger.debug('Checking Proxy Callback URL {} returned {}. Not issuing PGT.'.format(uri, e.code))
+            logger.debug('Checking Proxy Callback URL {0} returned {1}. Not issuing PGT.'.format(uri, e.code))
             return
             return
-    except urllib2.URLError as e:
-        logger.debug('Checking Proxy Callback URL {} raised URLError. Not issuing PGT.'.format(uri))
+    except URLError as e:
+        logger.debug('Checking Proxy Callback URL {0} raised URLError. Not issuing PGT.'.format(uri))
         return
 
     pgt.save()
         return
 
     pgt.save()
@@ -343,18 +268,18 @@ def _cas2_proxy_success(pt):
 
 
 def _cas2_sucess_response(user, pgt=None, proxies=None):
 
 
 def _cas2_sucess_response(user, pgt=None, proxies=None):
-    return HttpResponse(auth_success_response(user, pgt, proxies), mimetype='text/xml')
+    return HttpResponse(auth_success_response(user, pgt, proxies), content_type='text/xml')
 
 
 def _cas2_error_response(code, message=None):
 
 
 def _cas2_error_response(code, message=None):
-    return HttpResponse(u'''<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">
+    return HttpResponse('''<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">
             <cas:authenticationFailure code="%(code)s">
                 %(message)s
             </cas:authenticationFailure>
         </cas:serviceResponse>''' % {
         'code': code,
         'message': message if message else dict(ERROR_MESSAGES).get(code)
             <cas:authenticationFailure code="%(code)s">
                 %(message)s
             </cas:authenticationFailure>
         </cas:serviceResponse>''' % {
         'code': code,
         'message': message if message else dict(ERROR_MESSAGES).get(code)
-    }, mimetype='text/xml')
+    }, content_type='text/xml')
 
 
 def proxy_success(pt):
 
 
 def proxy_success(pt):
@@ -362,7 +287,7 @@ def proxy_success(pt):
     proxySuccess = etree.SubElement(response, CAS + 'proxySuccess')
     proxyTicket = etree.SubElement(proxySuccess, CAS + 'proxyTicket')
     proxyTicket.text = pt
     proxySuccess = etree.SubElement(response, CAS + 'proxySuccess')
     proxyTicket = etree.SubElement(proxySuccess, CAS + 'proxyTicket')
     proxyTicket.text = pt
-    return unicode(etree.tostring(response, encoding='utf-8'), 'utf-8')
+    return etree.tostring(response, encoding='unicode')
 
 
 def auth_success_response(user, pgt, proxies):
 
 
 def auth_success_response(user, pgt, proxies):
@@ -397,4 +322,4 @@ def auth_success_response(user, pgt, proxies):
             proxyElement = etree.SubElement(proxiesElement, CAS + "proxy")
             proxyElement.text = proxy
 
             proxyElement = etree.SubElement(proxiesElement, CAS + "proxy")
             proxyElement.text = proxy
 
-    return unicode(etree.tostring(response, encoding='utf-8'), 'utf-8')
+    return etree.tostring(response, encoding='unicode')