root / snf-astakos-app / astakos / im / auth_providers.py @ dd5f8f4d
History | View | Annotate | Download (8.4 kB)
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 |
|
35 |
from django.core.urlresolvers import reverse |
36 |
from django.utils.translation import ugettext as _ |
37 |
from django.utils.datastructures import SortedDict |
38 |
|
39 |
from django.conf import settings |
40 |
|
41 |
from astakos.im import settings as astakos_settings |
42 |
from astakos.im import messages as astakos_messages |
43 |
|
44 |
import logging |
45 |
import urllib |
46 |
|
47 |
logger = logging.getLogger(__name__) |
48 |
|
49 |
# providers registry
|
50 |
PROVIDERS = {} |
51 |
REQUIRED_PROVIDERS = {} |
52 |
|
53 |
class AuthProviderBase(type): |
54 |
|
55 |
def __new__(cls, name, bases, dct): |
56 |
include = False
|
57 |
if [b for b in bases if isinstance(b, AuthProviderBase)]: |
58 |
type_id = dct.get('module')
|
59 |
if type_id:
|
60 |
include = True
|
61 |
if type_id in astakos_settings.IM_MODULES: |
62 |
dct['module_enabled'] = True |
63 |
|
64 |
newcls = super(AuthProviderBase, cls).__new__(cls, name, bases, dct)
|
65 |
if include:
|
66 |
PROVIDERS[type_id] = newcls |
67 |
if newcls().is_required():
|
68 |
REQUIRED_PROVIDERS[type_id] = newcls |
69 |
return newcls
|
70 |
|
71 |
|
72 |
class AuthProvider(object): |
73 |
|
74 |
__metaclass__ = AuthProviderBase |
75 |
|
76 |
module = None
|
77 |
module_active = False
|
78 |
module_enabled = False
|
79 |
one_per_user = False
|
80 |
login_prompt = _('Login using ')
|
81 |
primary_login_prompt = _('Login using ')
|
82 |
|
83 |
def get_message(self, msg, **kwargs): |
84 |
params = kwargs |
85 |
params.update({'provider': self.get_title_display}) |
86 |
|
87 |
override_msg = getattr(self, 'get_%s_message_display' % msg.lower(), None) |
88 |
msg = 'AUTH_PROVIDER_%s' % msg
|
89 |
return override_msg or getattr(astakos_messages, msg, msg) % params |
90 |
|
91 |
@property
|
92 |
def add_url(self): |
93 |
return reverse(self.login_view) |
94 |
|
95 |
def __init__(self, user=None): |
96 |
self.user = user
|
97 |
for tpl in ['login_prompt', 'login', 'signup_prompt']: |
98 |
tpl_name = '%s_%s' % (tpl, 'template') |
99 |
override = self.get_setting(tpl_name)
|
100 |
if override:
|
101 |
setattr(self, tpl_name, override) |
102 |
|
103 |
def __getattr__(self, key): |
104 |
if not key.startswith('get_'): |
105 |
return super(AuthProvider, self).__getattribute__(key) |
106 |
|
107 |
if key.endswith('_display') or key.endswith('template'): |
108 |
attr = key.replace('_display', '').replace('get_','') |
109 |
settings_attr = self.get_setting(attr.upper())
|
110 |
if not settings_attr: |
111 |
return getattr(self, attr) |
112 |
return _(settings_attr)
|
113 |
else:
|
114 |
return super(AuthProvider, self).__getattr__(key) |
115 |
|
116 |
def get_setting(self, name, default=None): |
117 |
attr = 'ASTAKOS_AUTH_PROVIDER_%s_%s' % (self.module.upper(), name.upper()) |
118 |
attr_sec = 'ASTAKOS_%s_%s' % (self.module.upper(), name.upper()) |
119 |
if not hasattr(settings, attr): |
120 |
return getattr(settings, attr_sec, default) |
121 |
return getattr(settings, attr, default) |
122 |
|
123 |
def is_available_for_login(self): |
124 |
""" A user can login using authentication provider"""
|
125 |
return self.is_active() and self.get_setting('CAN_LOGIN', |
126 |
self.is_active())
|
127 |
|
128 |
def is_available_for_create(self): |
129 |
""" A user can create an account using this provider"""
|
130 |
return self.is_active() and self.get_setting('CAN_CREATE', |
131 |
self.is_active())
|
132 |
|
133 |
def is_available_for_add(self): |
134 |
""" A user can assign provider authentication method"""
|
135 |
return self.is_active() and self.get_setting('CAN_ADD', |
136 |
self.is_active())
|
137 |
|
138 |
def is_required(self): |
139 |
"""Provider required (user cannot remove the last one)"""
|
140 |
return self.is_active() and self.get_setting('REQUIRED', False) |
141 |
|
142 |
def is_active(self): |
143 |
return self.module in astakos_settings.IM_MODULES |
144 |
|
145 |
|
146 |
class LocalAuthProvider(AuthProvider): |
147 |
module = 'local'
|
148 |
title = _('Local password')
|
149 |
description = _('Create a local password for your account')
|
150 |
add_prompt = _('Create a local password for your account')
|
151 |
login_prompt = _('if you already have a username and password')
|
152 |
signup_prompt = _('New to ~okeanos ?')
|
153 |
signup_link_prompt = _('create an account now')
|
154 |
login_view = 'password_change'
|
155 |
|
156 |
one_per_user = True
|
157 |
|
158 |
login_template = 'im/auth/local_login_form.html'
|
159 |
login_prompt_template = 'im/auth/local_login_prompt.html'
|
160 |
signup_prompt_template = 'im/auth/local_signup_prompt.html'
|
161 |
details_tpl = _('You can login to your account using your'
|
162 |
' %(auth_backend)s password.')
|
163 |
|
164 |
@property
|
165 |
def extra_actions(self): |
166 |
return [(_('Change password'), reverse('password_change')), ] |
167 |
|
168 |
|
169 |
class ShibbolethAuthProvider(AuthProvider): |
170 |
module = 'shibboleth'
|
171 |
title = _('Academic credentials (Shibboleth)')
|
172 |
add_prompt = _('Allows you to login to your account using your academic '
|
173 |
'account')
|
174 |
details_tpl = _('Shibboleth account \'%(identifier)s\' is connected to your '
|
175 |
' account.')
|
176 |
user_title = _('Academic credentials (%(identifier)s)')
|
177 |
primary_login_prompt = _('If you are a student/researcher/faculty you can'
|
178 |
' login using your university-credentials in'
|
179 |
' the following page')
|
180 |
login_view = 'astakos.im.target.shibboleth.login'
|
181 |
|
182 |
login_template = 'im/auth/shibboleth_login.html'
|
183 |
login_prompt_template = 'im/auth/third_party_provider_generic_login_prompt.html'
|
184 |
|
185 |
|
186 |
class TwitterAuthProvider(AuthProvider): |
187 |
module = 'twitter'
|
188 |
title = _('Twitter')
|
189 |
add_prompt = _('Allows you to login to your account using Twitter')
|
190 |
details_tpl = _('Twitter screen name: %(info_screen_name)s')
|
191 |
user_title = _('Twitter (%(info_screen_name)s)')
|
192 |
login_view = 'astakos.im.target.twitter.login'
|
193 |
|
194 |
login_template = 'im/auth/third_party_provider_generic_login.html'
|
195 |
login_prompt_template = 'im/auth/third_party_provider_generic_login_prompt.html'
|
196 |
|
197 |
|
198 |
class GoogleAuthProvider(AuthProvider): |
199 |
module = 'google'
|
200 |
title = _('Google')
|
201 |
add_prompt = _('Allows you to login to your account using Google')
|
202 |
details_tpl = _('Google account: %(info_email)s')
|
203 |
user_title = _('Google (%(info_email)s)')
|
204 |
login_view = 'astakos.im.target.google.login'
|
205 |
|
206 |
login_template = 'im/auth/third_party_provider_generic_login.html'
|
207 |
login_prompt_template = 'im/auth/third_party_provider_generic_login_prompt.html'
|
208 |
|
209 |
|
210 |
class LinkedInAuthProvider(AuthProvider): |
211 |
module = 'linkedin'
|
212 |
title = _('LinkedIn')
|
213 |
add_prompt = _('Allows you to login to your account using LinkedIn')
|
214 |
user_title = _('LinkedIn (%(info_emailAddress)s)')
|
215 |
details_tpl = _('LinkedIn account: %(info_emailAddress)s')
|
216 |
login_view = 'astakos.im.target.linkedin.login'
|
217 |
|
218 |
login_template = 'im/auth/third_party_provider_generic_login.html'
|
219 |
login_prompt_template = 'im/auth/third_party_provider_generic_login_prompt.html'
|
220 |
|
221 |
|
222 |
def get_provider(id, user_obj=None, default=None): |
223 |
"""
|
224 |
Return a provider instance from the auth providers registry.
|
225 |
"""
|
226 |
return PROVIDERS.get(id, default)(user_obj) |
227 |
|