code.grnet.gr Git - pithos/blob - pithos/im/shibboleth.py

   1 # Copyright 2011 GRNET S.A. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or
   4 # without modification, are permitted provided that the following
   5 # conditions are met:
   6 #
   7 #   1. Redistributions of source code must retain the above
   8 #      copyright notice, this list of conditions and the following
   9 #      disclaimer.
  10 #
  11 #   2. Redistributions in binary form must reproduce the above
  12 #      copyright notice, this list of conditions and the following
  13 #      disclaimer in the documentation and/or other materials
  14 #      provided with the distribution.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  17 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  20 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  26 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 # POSSIBILITY OF SUCH DAMAGE.
  28 #
  29 # The views and conclusions contained in the software and
  30 # documentation are those of the authors and should not be
  31 # interpreted as representing official policies, either expressed
  32 # or implied, of GRNET S.A.
  33
  34 import datetime
  35
  36 from urlparse import urlsplit, urlunsplit
  37
  38 from django.http import HttpResponse, HttpResponseBadRequest
  39 from django.utils.http import urlencode
  40 #from django.utils.cache import patch_vary_headers
  41
  42 from models import User
  43
  44
  45 class Tokens:
  46     # these are mapped by the Shibboleth SP software
  47     SHIB_EPPN = "HTTP_EPPN" # eduPersonPrincipalName
  48     SHIB_NAME = "HTTP_SHIB_INETORGPERSON_GIVENNAME"
  49     SHIB_SURNAME = "HTTP_SHIB_PERSON_SURNAME"
  50     SHIB_CN = "HTTP_SHIB_PERSON_COMMONNAME"
  51     SHIB_DISPLAYNAME = "HTTP_SHIB_INETORGPERSON_DISPLAYNAME"
  52     SHIB_EP_AFFILIATION = "HTTP_SHIB_EP_AFFILIATION"
  53     SHIB_SESSION_ID = "HTTP_SHIB_SESSION_ID"
  54
  55
  56 def login(request):
  57     """Register a user into the internal database
  58        and issue a token for subsequent requests.
  59        Users are authenticated by Shibboleth.
  60
  61        Return the unique username and the token
  62        as 'X-Auth-User' and 'X-Auth-Token' headers,
  63        or redirect to the URL provided in 'next'
  64        with the 'user' and 'token' as parameters.
  65
  66        Reissue the token even if it has not yet
  67        expired, if the 'renew' parameter is present.
  68     """
  69
  70     try:
  71         user = User.objects.get(uniq=request.META[Tokens.SHIB_EPPN])
  72     except:
  73         user = None
  74     if user is None:
  75         tokens = request.META
  76
  77         try:
  78             eppn = tokens[Tokens.SHIB_EPPN]
  79         except KeyError:
  80             return HttpResponseBadRequest("Missing unique token in request")
  81
  82         if Tokens.SHIB_DISPLAYNAME in tokens:
  83             realname = tokens[Tokens.SHIB_DISPLAYNAME]
  84         elif Tokens.SHIB_CN in tokens:
  85             realname = tokens[Tokens.SHIB_CN]
  86         elif Tokens.SHIB_NAME in tokens and Tokens.SHIB_SURNAME in tokens:
  87             realname = tokens[Tokens.SHIB_NAME] + ' ' + tokens[Tokens.SHIB_SURNAME]
  88         else:
  89             return HttpResponseBadRequest("Missing user name in request")
  90
  91         user = User()
  92         user.uniq = eppn
  93         user.realname = realname
  94         user.affiliation = tokens.get(Tokens.SHIB_EP_AFFILIATION, '')
  95         user.renew_token()
  96         user.save()
  97
  98     if 'renew' in request.GET or user.auth_token_expires < datetime.datetime.now():
  99         user.renew_token()
 100         user.save()
 101     next = request.GET.get('next')
 102     if next is not None:
 103         # TODO: Avoid redirect loops.
 104         parts = list(urlsplit(next))
 105         parts[3] = urlencode({'user': user.uniq, 'token': user.auth_token})
 106         next = urlunsplit(parts)
 107
 108     response = HttpResponse()
 109     # TODO: Cookie should only be set at the client side...
 110     #expire_fmt = user.auth_token_expires.strftime('%a, %d-%b-%Y %H:%M:%S %Z')
 111     #response.set_cookie('X-Auth-Token', value=user.auth_token, expires=expire_fmt, path='/')
 112     if not next:
 113         response['X-Auth-User'] = user.uniq
 114         response['X-Auth-Token'] = user.auth_token
 115         response.content = user.uniq + '\n' + user.auth_token + '\n'
 116         response.status_code = 200
 117     else:
 118         response['Location'] = next
 119         response.status_code = 302
 120     return response