code.grnet.gr Git - pithos/blob - pithos/aai/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 from util import register_user
  35
  36
  37 class Tokens:
  38     # these are mapped by the Shibboleth SP software
  39     SHIB_EPPN = "HTTP_EPPN" # eduPersonPrincipalName
  40     SHIB_NAME = "HTTP_SHIB_INETORGPERSON_GIVENNAME"
  41     SHIB_SURNAME = "HTTP_SHIB_PERSON_SURNAME"
  42     SHIB_CN = "HTTP_SHIB_PERSON_COMMONNAME"
  43     SHIB_DISPLAYNAME = "HTTP_SHIB_INETORGPERSON_DISPLAYNAME"
  44     SHIB_EP_AFFILIATION = "HTTP_SHIB_EP_AFFILIATION"
  45     SHIB_SESSION_ID = "HTTP_SHIB_SESSION_ID"
  46
  47
  48 class NoUniqueToken(BaseException):
  49     def __init__(self, msg):
  50         self.msg = msg
  51
  52
  53 class NoRealName(BaseException):
  54     def __init__(self, msg):
  55         self.msg = msg
  56
  57
  58 def register_shibboleth_user(tokens):
  59     """Registers a Shibboleth user using the input hash as a source for data."""
  60
  61     try:
  62         eppn = tokens[Tokens.SHIB_EPPN]
  63     except KeyError:
  64         raise NoUniqueToken("Authentication does not return a unique token")
  65
  66     if Tokens.SHIB_DISPLAYNAME in tokens:
  67         realname = tokens[Tokens.SHIB_DISPLAYNAME]
  68     elif Tokens.SHIB_CN in tokens:
  69         realname = tokens[Tokens.SHIB_CN]
  70     elif Tokens.SHIB_NAME in tokens and Tokens.SHIB_SURNAME in tokens:
  71         realname = tokens[Tokens.SHIB_NAME] + ' ' + tokens[Tokens.SHIB_SURNAME]
  72     else:
  73         raise NoRealName("Authentication does not return the user's name")
  74
  75     affiliation = tokens.get(Tokens.SHIB_EP_AFFILIATION, '')
  76
  77     return register_user(eppn, realname, affiliation)