Fix standard urls. Test for Django up to 5.0.

[django-cas-provider.git] / cas_provider / views.py

diff --git a/cas_provider/views.py b/cas_provider/views.py
index be6c4d4..a8e166c 100644 (file)
--- a/cas_provider/views.py
+++ b/cas_provider/views.py
@@ -1,31 +1,36 @@
 import logging
 logger = logging.getLogger('cas_provider.views')
 import logging
 logger = logging.getLogger('cas_provider.views')

-import urllib

 
 

-import logging
-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 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.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.shortcuts import render
+from django.utils.translation import gettext as _

 from django.template import RequestContext
 from django.contrib.auth import authenticate
 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.exceptions import SameEmailMismatchedPasswords

 from cas_provider.forms import LoginForm, MergeLoginForm
 
 from . import signals
 
 from cas_provider.forms import LoginForm, MergeLoginForm
 
 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'


@@ -34,16 +39,37 @@ 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'),

     )
 
 
 logger = logging.getLogger(__name__)
 
 
     )
 
 
 logger = logging.getLogger(__name__)
 
 

+_never_cache = cache_control(no_cache=True, must_revalidate=True)
+
+
+def never_cache(view_func):
+    """
+    Decorator that adds headers to a response so that it will
+    never be cached.
+    """
+    @wraps(view_func)
+    def _wrapped_view_func(request, *args, **kwargs):
+        response = view_func(request, *args, **kwargs)
+        patch_cache_control(response, no_cache=True,
+                            must_revalidate=True, proxy_revalidate=True)
+        response['Pragma'] = 'no-cache'
+        return response
+    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):
 def login(request, template_name='cas/login.html',
           success_redirect=settings.LOGIN_REDIRECT_URL,
           warn_template_name='cas/warn.html', **kwargs):


@@ -70,7 +96,7 @@ def login(request, template_name='cas/login.html',
         if form.is_valid():
             service = form.cleaned_data.get('service', None)
             try:
         if form.is_valid():
             service = form.cleaned_data.get('service', None)
             try:

-                auth_args = dict(username=form.cleaned_data['email'],
+                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
                                  password=form.cleaned_data['password'])
                 if merge:
                     # We only want to send the merge argument if it's


@@ -78,7 +104,7 @@ def login(request, template_name='cas/login.html',
                     # through the auth backends properly.
                     auth_args['merge'] = merge
                 user = authenticate(**auth_args)
                     # through the auth backends properly.
                     auth_args['merge'] = merge
                 user = authenticate(**auth_args)

-            except SameEmailMismatchedPasswords:
+            except:

                 # Need to merge the accounts?
                 if merge:
                     # We shouldn't get here...
                 # Need to merge the accounts?
                 if merge:
                     # We shouldn't get here...


@@ -87,53 +113,56 @@ def login(request, template_name='cas/login.html',
                     base_url = reverse('cas_provider_merge')
                     args = dict(
                         success_redirect=success_redirect,
                     base_url = reverse('cas_provider_merge')
                     args = dict(
                         success_redirect=success_redirect,

-                        email=form.cleaned_data['email'],
+                        username=form.cleaned_data['username'],

                         )
                     if service is not None:
                         args['service'] = service
                         )
                     if service is not None:
                         args['service'] = service

-                    args = urllib.urlencode(args)
+                    args = urlencode(args)

 
                     url = '%s?%s' % (base_url, args)
                     logging.debug('Redirecting to %s', url)
                     return HttpResponseRedirect(url)
 
                     url = '%s?%s' % (base_url, args)
                     logging.debug('Redirecting to %s', url)
                     return HttpResponseRedirect(url)

-            
+

             if user is None:
             if user is None:

-                errors.append('Incorrect username and/or password.')
+                errors.append(_('Incorrect username and/or password.'))

             else:
                 if user.is_active:
                     auth_login(request, user)
 
     else:  # Not a POST...
         if merge:
             else:
                 if user.is_active:
                     auth_login(request, user)
 
     else:  # Not a POST...
         if merge:

-            form = MergeLoginForm(initial={'service': service, 'email': request.GET.get('email')})
+            form = MergeLoginForm(initial={'service': service, 'username': request.GET.get('username')})

         else:
             form = LoginForm(initial={'service': service})
 
         else:
             form = LoginForm(initial={'service': service})
 

-    if user is not None and user.is_authenticated():
+    if user is not None and user.is_authenticated:

         # We have an authenticated user.
         if not user.is_active:
         # We have an authenticated user.
         if not user.is_active:

-            errors.append('This account is disabled.')
+            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
         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)
             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):
             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, {
+                    return render(request, warn_template_name, {

                         'service': service,
                         'warn': False
                         '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:
                 # Create a service ticket and redirect to the service.
                 ticket = ServiceTicket.objects.create(service=service, user=user)
                 if 'service' in request.session:


@@ -145,9 +174,10 @@ def login(request, template_name='cas/login.html',
                 return HttpResponseRedirect(url)
 
     logging.debug('Rendering response on %s, merge is %s', template_name, merge)
                 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))
+    return render(request, template_name, {'form': form, 'errors': errors})

 
 
 
 

+@never_cache

 def validate(request):
     """Validate ticket via CAS v.1 protocol
     """
 def validate(request):
     """Validate ticket via CAS v.1 protocol
     """


@@ -176,21 +206,22 @@ def validate(request):
 
     logger.info('Validation failed.')
     return HttpResponse("no\n\n")
 
     logger.info('Validation failed.')
     return HttpResponse("no\n\n")

-    

 
 

+
+@never_cache

 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

 def proxy(request):
     targetService = request.GET['targetService']
     pgt_id = request.GET['pgt']
 def proxy(request):
     targetService = request.GET['targetService']
     pgt_id = request.GET['pgt']


@@ -201,7 +232,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)
 


@@ -222,8 +253,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)


@@ -235,22 +266,23 @@ 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()
     return _cas2_sucess_response(user, pgtIouId, proxies)
 
 
 
     user = ticket.user
     ticket.delete()
     return _cas2_sucess_response(user, pgtIouId, proxies)
 
 

+@never_cache

 def service_validate(request):
     """Validate ticket via CAS v.2 protocol"""
     service = request.GET.get('service', None)
 def service_validate(request):
     """Validate ticket via CAS v.2 protocol"""
     service = request.GET.get('service', None)


@@ -262,6 +294,7 @@ def service_validate(request):
         return ticket_validate(service, ticket_string, pgtUrl)
 
 
         return ticket_validate(service, ticket_string, pgtUrl)
 
 

+@never_cache

 def proxy_validate(request):
     """Validate ticket via CAS v.2 protocol"""
     service = request.GET.get('service', None)
 def proxy_validate(request):
     """Validate ticket via CAS v.2 protocol"""
     service = request.GET.get('service', None)


@@ -272,31 +305,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:

-        response = 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()


@@ -308,18 +339,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):


@@ -327,7 +358,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):


@@ -341,7 +372,12 @@ def auth_success_response(user, pgt, proxies):
         if custom:
             attrs.update(custom)
 
         if custom:
             attrs.update(custom)
 

-    attrs['identifiers'] = [i for r, i in signals.on_cas_collect_histories.send(sender=validate, for_user=user)]
+    identifiers = [i for sr, rr in signals.on_cas_collect_histories.send(sender=validate, for_user=user)
+                   for i in rr]
+
+    if identifiers:
+        # Singular `identifier`, as that is the name of the element tag(s).
+        attrs['identifier'] = identifiers

 
     if attrs:
         formatter = get_callable(settings.CAS_CUSTOM_ATTRIBUTES_FORMATER)
 
     if attrs:
         formatter = get_callable(settings.CAS_CUSTOM_ATTRIBUTES_FORMATER)


@@ -357,4 +393,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')