Redirect to login view instead of partially reimplementing it. Remove unusable flows...
[django-cas-provider.git] / cas_provider / views.py
1 import logging
2 logger = logging.getLogger('cas_provider.views')
3
4 from urllib.error import HTTPError, URLError
5 from urllib.parse import parse_qsl, urlencode, urlparse, urlsplit, urlunsplit
6 from urllib.request import urlopen
7 from functools import wraps
8
9 from django.views.decorators.cache import cache_control
10 from django.utils.cache import patch_cache_control
11
12 from django.http import HttpResponse, HttpResponseRedirect
13 from django.conf import settings
14 from django.contrib.auth import logout as auth_logout
15 from django.contrib.auth.views import redirect_to_login
16 from django.core.exceptions import ImproperlyConfigured
17
18 from django.shortcuts import render, resolve_url
19 from django.utils.translation import gettext as _
20 from django.template import RequestContext
21
22 from lxml import etree
23 from cas_provider.attribute_formatters import NSMAP, CAS
24 from cas_provider.models import ProxyGrantingTicket, ProxyTicket
25 from cas_provider.models import ServiceTicket
26
27 from . import signals
28
29 from django.urls import get_callable, reverse
30
31 __all__ = ['login', 'validate', 'logout', 'service_validate']
32
33 INVALID_TICKET = 'INVALID_TICKET'
34 INVALID_SERVICE = 'INVALID_SERVICE'
35 INVALID_REQUEST = 'INVALID_REQUEST'
36 INTERNAL_ERROR = 'INTERNAL_ERROR'
37
38 ERROR_MESSAGES = (
39     (INVALID_TICKET, 'The provided ticket is invalid.'),
40     (INVALID_SERVICE, 'Service is invalid'),
41     (INVALID_REQUEST, 'Not all required parameters were sent.'),
42     (INTERNAL_ERROR, 'An internal error occurred during ticket validation'),
43     )
44
45
46 logger = logging.getLogger(__name__)
47
48
49 _never_cache = cache_control(no_cache=True, must_revalidate=True)
50
51
52 def never_cache(view_func):
53     """
54     Decorator that adds headers to a response so that it will
55     never be cached.
56     """
57     @wraps(view_func)
58     def _wrapped_view_func(request, *args, **kwargs):
59         response = view_func(request, *args, **kwargs)
60         patch_cache_control(response, no_cache=True,
61                             must_revalidate=True, proxy_revalidate=True)
62         response['Pragma'] = 'no-cache'
63         return response
64     return _wrapped_view_func
65
66
67 @never_cache
68 def login(request, success_redirect=None, warn_template_name='cas/warn.html'):
69     """CAS login endpoint (credential requestor).
70
71     Authentication itself is delegated to the regular Django login view
72     at settings.LOGIN_URL, which brings the user back here (via `next`)
73     once logged in. Then a service ticket is issued for the service.
74     """
75     if not request.user.is_authenticated:
76         login_url = resolve_url(settings.LOGIN_URL)
77         if urlsplit(login_url).path == request.path:
78             raise ImproperlyConfigured(
79                 "settings.LOGIN_URL must point to a regular login view, "
80                 "not to the CAS login endpoint.")
81         return redirect_to_login(request.get_full_path(), login_url)
82
83     service = request.GET.get('service') or None
84
85     # Send the on_cas_login signal. If we get an HttpResponse, return that.
86     for receiver, response in signals.on_cas_login.send(sender=login, request=request):
87         if isinstance(response, HttpResponse):
88             return response
89
90     signals.on_cas_login_success.send(sender=login, request=request, service=service)
91
92     if service is None:
93         # Normal internal success redirection.
94         return HttpResponseRedirect(resolve_url(success_redirect or settings.LOGIN_REDIRECT_URL))
95
96     if request.GET.get('warn', False):
97         return render(request, warn_template_name, {
98             'service': service,
99             'warn': False
100         })
101
102     # Create a service ticket and redirect to the service.
103     ticket = ServiceTicket.objects.create(service=service, user=request.user)
104     url = ticket.get_redirect_url()
105     logger.debug('Redirecting to %s', url)
106     return HttpResponseRedirect(url)
107
108
109 @never_cache
110 def validate(request):
111     """Validate ticket via CAS v.1 protocol
112     """
113     service = request.GET.get('service', None)
114     ticket_string = request.GET.get('ticket', None)
115     logger.info('Validating ticket %s for %s', ticket_string, service)
116     if service is not None and ticket_string is not None:
117         #renew = request.GET.get('renew', True)
118         #if not renew:
119         # TODO: check user SSO session
120         try:
121             ticket = ServiceTicket.objects.get(ticket=ticket_string)
122             assert ticket.service == service
123         except ServiceTicket.DoesNotExist:
124             logger.exception("Tried to validate with an invalid ticket %s for %s", ticket_string, service)
125         except Exception as e:
126             logger.exception('Got an exception: %s', e)
127         else:
128             username = ticket.user.username
129             ticket.delete()
130
131             results = signals.on_cas_collect_histories.send(sender=validate, for_user=ticket.user)
132             histories = '\n'.join('\n'.join(rs) for rc, rs in results)
133             logger.info('Validated %s %s', username, "(also %s)" % histories if histories else '')
134             return HttpResponse("yes\n%s\n%s" % (username, histories))
135
136     logger.info('Validation failed.')
137     return HttpResponse("no\n\n")
138
139
140 @never_cache
141 def logout(request, template_name='cas/logout.html',
142            auto_redirect=settings.CAS_AUTO_REDIRECT_AFTER_LOGOUT):
143     url = request.GET.get('url', None)
144     if request.user.is_authenticated:
145         for ticket in ServiceTicket.objects.filter(user=request.user):
146             ticket.delete()
147         auth_logout(request)
148         if url and auto_redirect:
149             return HttpResponseRedirect(url)
150     return render(request, template_name, {'url': url})
151
152
153 @never_cache
154 def proxy(request):
155     targetService = request.GET['targetService']
156     pgt_id = request.GET['pgt']
157
158     try:
159         proxyGrantingTicket = ProxyGrantingTicket.objects.get(ticket=pgt_id)
160     except ProxyGrantingTicket.DoesNotExist:
161         return _cas2_error_response(INVALID_TICKET)
162
163     pt = ProxyTicket.objects.create(proxyGrantingTicket=proxyGrantingTicket,
164         user=proxyGrantingTicket.user,
165         service=targetService)
166     return _cas2_proxy_success(pt.ticket)
167
168
169 def ticket_validate(service, ticket_string, pgtUrl):
170     if service is None or ticket_string is None:
171         return _cas2_error_response(INVALID_REQUEST)
172
173     try:
174         if ticket_string.startswith('ST'):
175             ticket = ServiceTicket.objects.get(ticket=ticket_string)
176         elif ticket_string.startswith('PT'):
177             ticket = ProxyTicket.objects.get(ticket=ticket_string)
178         else:
179             return _cas2_error_response(INVALID_TICKET,
180                 '%(ticket)s is neither Service (ST-...) nor Proxy Ticket (PT-...)' % {
181                     'ticket': ticket_string})
182     except ServiceTicket.DoesNotExist:
183         return _cas2_error_response(INVALID_TICKET)
184
185     ticketUrl = urlparse(ticket.service)
186     serviceUrl = urlparse(service)
187
188     if not(ticketUrl.hostname == serviceUrl.hostname and ticketUrl.path == serviceUrl.path and ticketUrl.port == serviceUrl.port):
189         return _cas2_error_response(INVALID_SERVICE)
190
191     pgtIouId = None
192     proxies = ()
193     if pgtUrl is not None:
194         pgt = generate_proxy_granting_ticket(pgtUrl, ticket)
195         if pgt:
196             pgtIouId = pgt.pgtiou
197
198     try:
199         proxyTicket = ticket.proxyticket
200     except ProxyTicket.DoesNotExist:
201         pass
202     else:
203         pgt = proxyTicket.proxyGrantingTicket
204         # I am issued by this proxy granting ticket
205         while pgt.pgt is not None:
206             proxies += (pgt.service,)
207             pgt = pgt.pgt
208
209     user = ticket.user
210     ticket.delete()
211     return _cas2_sucess_response(user, pgtIouId, proxies)
212
213
214 @never_cache
215 def service_validate(request):
216     """Validate ticket via CAS v.2 protocol"""
217     service = request.GET.get('service', None)
218     ticket_string = request.GET.get('ticket', None)
219     pgtUrl = request.GET.get('pgtUrl', None)
220     if ticket_string.startswith('PT-'):
221         return _cas2_error_response(INVALID_TICKET, "serviceValidate cannot verify proxy tickets")
222     else:
223         return ticket_validate(service, ticket_string, pgtUrl)
224
225
226 @never_cache
227 def proxy_validate(request):
228     """Validate ticket via CAS v.2 protocol"""
229     service = request.GET.get('service', None)
230     ticket_string = request.GET.get('ticket', None)
231     pgtUrl = request.GET.get('pgtUrl', None)
232     return ticket_validate(service, ticket_string, pgtUrl)
233
234
235 def generate_proxy_granting_ticket(pgt_url, ticket):
236     proxy_callback_good_status = (200, 202, 301, 302, 304)
237     uri = list(urlsplit(pgt_url))
238
239     pgt = ProxyGrantingTicket()
240     pgt.user = ticket.user
241     pgt.service = ticket.service
242     # Remember if it's a chained PGT.
243     pgt.pgt = getattr(ticket, 'proxyGrantingTicket', None)
244
245     params = {'pgtId': pgt.ticket, 'pgtIou': pgt.pgtiou}
246
247     query = dict(parse_qsl(uri[4]))
248     query.update(params)
249
250     uri[3] = urlencode(query)
251
252     try:
253         urlopen(urlunsplit(uri))
254     except HTTPError as e:
255         if not e.code in proxy_callback_good_status:
256             logger.debug('Checking Proxy Callback URL {0} returned {1}. Not issuing PGT.'.format(uri, e.code))
257             return
258     except URLError as e:
259         logger.debug('Checking Proxy Callback URL {0} raised URLError. Not issuing PGT.'.format(uri))
260         return
261
262     pgt.save()
263     return pgt
264
265
266 def _cas2_proxy_success(pt):
267     return HttpResponse(proxy_success(pt))
268
269
270 def _cas2_sucess_response(user, pgt=None, proxies=None):
271     return HttpResponse(auth_success_response(user, pgt, proxies), content_type='text/xml')
272
273
274 def _cas2_error_response(code, message=None):
275     return HttpResponse('''<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">
276             <cas:authenticationFailure code="%(code)s">
277                 %(message)s
278             </cas:authenticationFailure>
279         </cas:serviceResponse>''' % {
280         'code': code,
281         'message': message if message else dict(ERROR_MESSAGES).get(code)
282     }, content_type='text/xml')
283
284
285 def proxy_success(pt):
286     response = etree.Element(CAS + 'serviceResponse', nsmap=NSMAP)
287     proxySuccess = etree.SubElement(response, CAS + 'proxySuccess')
288     proxyTicket = etree.SubElement(proxySuccess, CAS + 'proxyTicket')
289     proxyTicket.text = pt
290     return etree.tostring(response, encoding='unicode')
291
292
293 def auth_success_response(user, pgt, proxies):
294     response = etree.Element(CAS + 'serviceResponse', nsmap=NSMAP)
295     auth_success = etree.SubElement(response, CAS + 'authenticationSuccess')
296     username = etree.SubElement(auth_success, CAS + 'user')
297     username.text = user.username
298
299     attrs = {}
300     for receiver, custom in signals.cas_collect_custom_attributes.send(sender=auth_success_response, user=user):
301         if custom:
302             attrs.update(custom)
303
304     identifiers = [i for sr, rr in signals.on_cas_collect_histories.send(sender=validate, for_user=user)
305                    for i in rr]
306
307     if identifiers:
308         # Singular `identifier`, as that is the name of the element tag(s).
309         attrs['identifier'] = identifiers
310
311     if attrs:
312         formatter = get_callable(settings.CAS_CUSTOM_ATTRIBUTES_FORMATER)
313         formatter(auth_success, attrs)
314
315     if pgt:
316         pgtElement = etree.SubElement(auth_success, CAS + 'proxyGrantingTicket')
317         pgtElement.text = pgt
318
319     if proxies:
320         proxiesElement = etree.SubElement(auth_success, CAS + "proxies")
321         for proxy in proxies:
322             proxyElement = etree.SubElement(proxiesElement, CAS + "proxy")
323             proxyElement.text = proxy
324
325     return etree.tostring(response, encoding='unicode')