register email returned by shibboleth (either as a primary or additional email)
[astakos] / snf-astakos-app / astakos / im / target / shibboleth.py
1 # Copyright 2011-2012 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 django.http import HttpResponseBadRequest
35 from django.utils.translation import ugettext as _
36 from django.contrib import messages
37 from django.template import RequestContext
38 from django.forms.models import inlineformset_factory
39
40 from astakos.im.util import prepare_response, get_context, get_invitation
41 from astakos.im.views import requires_anonymous, render_response
42 from astakos.im.settings import DEFAULT_USER_LEVEL
43 from astakos.im.models import AstakosUser, Invitation, AdditionalMail
44 from astakos.im.forms import LoginForm
45 from astakos.im.activation_backends import get_backend, SimpleBackend
46
47 class Tokens:
48     # these are mapped by the Shibboleth SP software
49     SHIB_EPPN = "HTTP_EPPN" # eduPersonPrincipalName
50     SHIB_NAME = "HTTP_SHIB_INETORGPERSON_GIVENNAME"
51     SHIB_SURNAME = "HTTP_SHIB_PERSON_SURNAME"
52     SHIB_CN = "HTTP_SHIB_PERSON_COMMONNAME"
53     SHIB_DISPLAYNAME = "HTTP_SHIB_INETORGPERSON_DISPLAYNAME"
54     SHIB_EP_AFFILIATION = "HTTP_SHIB_EP_AFFILIATION"
55     SHIB_SESSION_ID = "HTTP_SHIB_SESSION_ID"
56     SHIB_MAIL = "HTTP_SHIB_MAIL"
57
58 @requires_anonymous
59 def login(request,  backend=None, on_login_template='im/login.html', on_creation_template='im/third_party_registration.html', extra_context={}):
60     tokens = request.META
61     
62     try:
63         eppn = tokens[Tokens.SHIB_EPPN]
64     except KeyError:
65         return HttpResponseBadRequest("Missing unique token in request")
66     
67     if Tokens.SHIB_DISPLAYNAME in tokens:
68         realname = tokens[Tokens.SHIB_DISPLAYNAME]
69     elif Tokens.SHIB_CN in tokens:
70         realname = tokens[Tokens.SHIB_CN]
71     elif Tokens.SHIB_NAME in tokens and Tokens.SHIB_SURNAME in tokens:
72         realname = tokens[Tokens.SHIB_NAME] + ' ' + tokens[Tokens.SHIB_SURNAME]
73     else:
74         return HttpResponseBadRequest("Missing user name in request")
75     
76     affiliation = tokens.get(Tokens.SHIB_EP_AFFILIATION, '')
77     email = tokens.get(Tokens.SHIB_MAIL, None)
78     
79     try:
80         user = AstakosUser.objects.get(provider='shibboleth', third_party_identifier=eppn)
81         if user.is_active:
82             return prepare_response(request,
83                                     user,
84                                     request.GET.get('next'),
85                                     'renew' in request.GET)
86         else:
87             message = _('Inactive account')
88             messages.add_message(request, messages.ERROR, message)
89             return render_response(on_login_template,
90                                    login_form = LoginForm(request=request),
91                                    context_instance=RequestContext(request))
92     except AstakosUser.DoesNotExist, e:
93         user = AstakosUser(third_party_identifier=eppn, realname=realname,
94                            affiliation=affiliation, provider='shibboleth',
95                            email=email)
96         try:
97             if not backend:
98                 backend = get_backend(request)
99             form = backend.get_signup_form(provider='shibboleth', instance=user)
100         except Exception, e:
101             form = SimpleBackend(request).get_signup_form(provider='shibboleth', instance=user)
102             messages.add_message(request, messages.ERROR, e)
103         return render_response(on_creation_template,
104                                signup_form = form,
105                                provider = 'shibboleth',
106                                context_instance=get_context(request, extra_context))