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 django.http import HttpResponse, HttpResponseBadRequest
  37 from django.utils.http import urlencode
  38 #from django.utils.cache import patch_vary_headers
  39
  40 from models import User
  41
  42
  43 class Tokens:
  44     # these are mapped by the Shibboleth SP software
  45     SHIB_EPPN = "HTTP_EPPN" # eduPersonPrincipalName
  46     SHIB_NAME = "HTTP_SHIB_INETORGPERSON_GIVENNAME"
  47     SHIB_SURNAME = "HTTP_SHIB_PERSON_SURNAME"
  48     SHIB_CN = "HTTP_SHIB_PERSON_COMMONNAME"
  49     SHIB_DISPLAYNAME = "HTTP_SHIB_INETORGPERSON_DISPLAYNAME"
  50     SHIB_EP_AFFILIATION = "HTTP_SHIB_EP_AFFILIATION"
  51     SHIB_SESSION_ID = "HTTP_SHIB_SESSION_ID"
  52
  53
  54 def login(request):
  55     """Register a user into the internal database
  56        and issue a token for subsequent requests.
  57        Users are authenticated by Shibboleth.
  58
  59        Return the unique username and the token
  60        as 'X-Auth-User' and 'X-Auth-Token' headers,
  61        or redirect to the URL provided in 'next'
  62        with the 'user' and 'token' as parameters.
  63
  64        Reissue the token even if it has not yet
  65        expired, if the 'renew' parameter is present.
  66     """
  67
  68     try:
  69         user = User.objects.get(uniq=request.META[Tokens.SHIB_EPPN])
  70     except:
  71         user = None
  72     if user is None:
  73         try:
  74             eppn = tokens[Tokens.SHIB_EPPN]
  75         except KeyError:
  76             return HttpResponseBadRequest("Missing unique token in request")
  77
  78         if Tokens.SHIB_DISPLAYNAME in tokens:
  79             realname = tokens[Tokens.SHIB_DISPLAYNAME]
  80         elif Tokens.SHIB_CN in tokens:
  81             realname = tokens[Tokens.SHIB_CN]
  82         elif Tokens.SHIB_NAME in tokens and Tokens.SHIB_SURNAME in tokens:
  83             realname = tokens[Tokens.SHIB_NAME] + ' ' + tokens[Tokens.SHIB_SURNAME]
  84         else:
  85             return HttpResponseBadRequest("Missing user name in request")
  86
  87         user = User()
  88         user.uniq = eppn
  89         user.realname = realname
  90         user.affiliation = tokens.get(Tokens.SHIB_EP_AFFILIATION, '')
  91         user.renew_token()
  92         user.save()
  93
  94     if 'renew' in request.GET or user.auth_token_expires < datetime.datetime.now():
  95         user.renew_token()
  96         user.save()
  97     next = request.GET.get('next')
  98     if next is not None:
  99         # TODO: Avoid redirect loops.
 100         if '?' in next:
 101             next = next[:next.find('?')]
 102         next += '?' + urlencode({'user': user.uniq,
 103                                  'token': user.auth_token})
 104
 105     response = HttpResponse()
 106     expire_fmt = user.auth_token_expires.strftime('%a, %d-%b-%Y %H:%M:%S %Z')
 107     response.set_cookie('X-Auth-Token', value=user.auth_token, expires=expire_fmt, path='/')
 108     if not next:
 109         response['X-Auth-User'] = user.uniq
 110         response['X-Auth-Token'] = user.auth_token
 111         response.content = user.uniq + '\n' + user.auth_token + '\n'
 112         response.status_code = 200
 113     else:
 114         response['Location'] = next
 115         response.status_code = 302
 116     return response