root / snf-astakos-app / astakos / im / auth_providers.py @ 9d20fe23
History | View | Annotate | Download (20.2 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 |
import copy |
35 |
import json |
36 |
|
37 |
from synnefo.lib.ordereddict import OrderedDict |
38 |
|
39 |
from django.core.urlresolvers import reverse |
40 |
from django.utils.translation import ugettext as _ |
41 |
from django.contrib.auth.models import Group |
42 |
from django import template |
43 |
|
44 |
from django.conf import settings |
45 |
|
46 |
from astakos.im import settings as astakos_settings |
47 |
from astakos.im import messages as astakos_messages |
48 |
|
49 |
import logging |
50 |
|
51 |
logger = logging.getLogger(__name__) |
52 |
|
53 |
# providers registry
|
54 |
PROVIDERS = {} |
55 |
REQUIRED_PROVIDERS = {} |
56 |
|
57 |
|
58 |
class AuthProviderBase(type): |
59 |
|
60 |
def __new__(cls, name, bases, dct): |
61 |
include = False
|
62 |
if [b for b in bases if isinstance(b, AuthProviderBase)]: |
63 |
type_id = dct.get('module')
|
64 |
if type_id:
|
65 |
include = True
|
66 |
if type_id in astakos_settings.IM_MODULES: |
67 |
dct['module_enabled'] = True |
68 |
|
69 |
newcls = super(AuthProviderBase, cls).__new__(cls, name, bases, dct)
|
70 |
if include:
|
71 |
PROVIDERS[type_id] = newcls |
72 |
if newcls().get_required_policy:
|
73 |
REQUIRED_PROVIDERS[type_id] = newcls |
74 |
return newcls
|
75 |
|
76 |
|
77 |
class AuthProvider(object): |
78 |
|
79 |
__metaclass__ = AuthProviderBase |
80 |
|
81 |
module = None
|
82 |
module_enabled = False
|
83 |
|
84 |
message_tpls = OrderedDict(( |
85 |
('title', '{module_title}'), |
86 |
('login_title', '{title} LOGIN'), |
87 |
('method_prompt', '{title} login'), |
88 |
('account_prompt', '{title} account'), |
89 |
('signup_title', '{title}'), |
90 |
('profile_title', '{title}'), |
91 |
('method_details', '{account_prompt}: {identifier}'), |
92 |
('primary_login_prompt', 'Login using '), |
93 |
('required', '{title} is required. You can assign it ' |
94 |
'from your profile page'),
|
95 |
('login_prompt', ''), |
96 |
('add_prompt', 'Allows you to login using {title}'), |
97 |
('login_extra', ''), |
98 |
('username', '{username}'), |
99 |
('disabled_for_create', '{title} is not available for signup.'), |
100 |
('switch_success', 'Account changed successfully.'), |
101 |
('cannot_login', '{title} is not available for login. ' |
102 |
'Please use one of your other available methods '
|
103 |
'to login ({available_methods_links}'),
|
104 |
|
105 |
# icons should end with _icon
|
106 |
('module_medium_icon', 'im/auth/icons-medium/{module}.png'), |
107 |
('module_icon', 'im/auth/icons/{module}.png')) |
108 |
) |
109 |
|
110 |
messages = {} |
111 |
module_urls = {} |
112 |
|
113 |
remote_authenticate = True
|
114 |
remote_logout_url = None
|
115 |
|
116 |
# templates
|
117 |
primary_login_template = 'im/auth/generic_primary_login.html'
|
118 |
login_template = 'im/auth/generic_login.html'
|
119 |
signup_template = 'im/signup.html'
|
120 |
login_prompt_template = 'im/auth/generic_login_prompt.html'
|
121 |
signup_prompt_template = 'im/auth/signup_prompt.html'
|
122 |
|
123 |
default_policies = { |
124 |
'login': True, |
125 |
'create': True, |
126 |
'add': True, |
127 |
'remove': True, |
128 |
'limit': 1, |
129 |
'switch': True, |
130 |
'add_groups': [],
|
131 |
'creation_groups': [],
|
132 |
'required': False, |
133 |
'automoderate': not astakos_settings.MODERATION_ENABLED |
134 |
} |
135 |
|
136 |
policies = {} |
137 |
|
138 |
def __init__(self, user=None, identifier=None, **provider_params): |
139 |
"""
|
140 |
3 ways to initialize (no args, user, user and identifier).
|
141 |
|
142 |
no args: Used for anonymous unauthenticated users.
|
143 |
>>> p = auth_providers.get_provider('local')
|
144 |
>>> # check that global settings allows us to create a new account
|
145 |
>>> # using `local` provider.
|
146 |
>>> print p.is_available_for_create()
|
147 |
|
148 |
user and identifier: Used to provide details about a user's specific
|
149 |
login method.
|
150 |
>>> p = auth_providers.get_provider('google', identifier='1421421')
|
151 |
>>> # provider (google) details prompt
|
152 |
>>> print p.get_method_details()
|
153 |
"Google account: 1421421"
|
154 |
"""
|
155 |
|
156 |
# handle AnonymousUser instance
|
157 |
self.user = None |
158 |
if user and hasattr(user, 'pk') and user.pk: |
159 |
self.user = user
|
160 |
|
161 |
self.identifier = identifier
|
162 |
self._instance = None |
163 |
if 'instance' in provider_params: |
164 |
self._instance = provider_params['instance'] |
165 |
del provider_params['instance'] |
166 |
|
167 |
# initialize policies
|
168 |
self.module_policies = copy.copy(self.default_policies) |
169 |
self.module_policies['automoderate'] = not \ |
170 |
astakos_settings.MODERATION_ENABLED |
171 |
for policy, value in self.policies.keys(): |
172 |
setting_key = "%s_POLICY" % policy.upper()
|
173 |
if self.has_setting(setting_key): |
174 |
self.module_policies[policy] = self.get_setting(setting_key) |
175 |
|
176 |
# messages cache
|
177 |
self.message_tpls_compiled = OrderedDict()
|
178 |
|
179 |
# module specific messages
|
180 |
self.message_tpls = OrderedDict(self.message_tpls) |
181 |
for key, value in self.messages.iteritems(): |
182 |
self.message_tpls[key] = value
|
183 |
|
184 |
self._provider_details = provider_params
|
185 |
|
186 |
self.resolve_available_methods = True |
187 |
|
188 |
def get_provider_model(self): |
189 |
from astakos.im.models import AstakosUserAuthProvider as AuthProvider |
190 |
return AuthProvider
|
191 |
|
192 |
def remove_from_user(self): |
193 |
if not self.get_remove_policy: |
194 |
raise Exception("Provider cannot be removed") |
195 |
|
196 |
self._instance.delete()
|
197 |
|
198 |
def add_to_user(self, **params): |
199 |
if self._instance: |
200 |
raise Exception("Cannot add an existing provider") |
201 |
|
202 |
create = False
|
203 |
if self.get_user_providers().count() == 0: |
204 |
create = True
|
205 |
|
206 |
if create and not self.get_create_policy: |
207 |
raise Exception("Provider not available for create") |
208 |
|
209 |
if not self.get_add_policy: |
210 |
raise Exception("Provider cannot be added") |
211 |
|
212 |
if create:
|
213 |
for group_name in self.get_creation_groups_policy: |
214 |
group, created = Group.objects.get_or_create(name=group_name) |
215 |
self.user.groups.add(group)
|
216 |
|
217 |
for group_name in self.get_add_groups_policy: |
218 |
group, created = Group.objects.get_or_create(name=group_name) |
219 |
self.user.groups.add(group)
|
220 |
|
221 |
if self.identifier: |
222 |
pending = self.get_provider_model().objects.unverified(
|
223 |
self.module, identifier=self.identifier) |
224 |
|
225 |
if pending:
|
226 |
pending._instance.delete() |
227 |
|
228 |
create_params = { |
229 |
'module': self.module, |
230 |
'info_data': json.dumps(self.provider_details.get('info', {})), |
231 |
'active': True, |
232 |
'identifier': self.identifier |
233 |
} |
234 |
if 'info' in self.provider_details: |
235 |
del self.provider_details['info'] |
236 |
|
237 |
create_params.update(self.provider_details)
|
238 |
create_params.update(params) |
239 |
return self.user.auth_providers.create(**create_params) |
240 |
|
241 |
def __repr__(self): |
242 |
r = "'%s' module" % self.__class__.__name__ |
243 |
if self.user: |
244 |
r += ' (user: %s)' % self.user |
245 |
if self.identifier: |
246 |
r += ' (identifier: %s)' % self.identifier |
247 |
return r
|
248 |
|
249 |
def _message_params(self, **extra_params): |
250 |
"""
|
251 |
Retrieve message formating parameters.
|
252 |
"""
|
253 |
params = {'module': self.module, 'module_title': self.module.title()} |
254 |
if self.identifier: |
255 |
params['identifier'] = self.identifier |
256 |
|
257 |
if self.user: |
258 |
for key, val in self.user.__dict__.iteritems(): |
259 |
params["user_%s" % key.lower()] = val
|
260 |
|
261 |
if self.provider_details: |
262 |
for key, val in self.provider_details.iteritems(): |
263 |
params["provider_%s" % key.lower()] = val
|
264 |
|
265 |
if 'info' in self.provider_details: |
266 |
if isinstance(self.provider_details['info'], basestring): |
267 |
self.provider_details['info'] = \ |
268 |
json.loads(self.provider_details['info']) |
269 |
for key, val in self.provider_details['info'].iteritems(): |
270 |
params['provider_info_%s' % key.lower()] = val
|
271 |
|
272 |
# resolve username, handle unexisting defined username key
|
273 |
if self.user and self.username_key in params: |
274 |
params['username'] = params[self.username_key] |
275 |
else:
|
276 |
params['username'] = self.identifier |
277 |
|
278 |
if not self.message_tpls_compiled: |
279 |
for key, message_tpl in self.message_tpls.iteritems(): |
280 |
msg = self.messages.get(key, self.message_tpls.get(key)) |
281 |
override_in_settings = self.get_setting(key)
|
282 |
if override_in_settings is not None: |
283 |
msg = override_in_settings |
284 |
try:
|
285 |
self.message_tpls_compiled[key] = msg.format(**params)
|
286 |
params.update(self.message_tpls_compiled)
|
287 |
except KeyError, e: |
288 |
continue
|
289 |
else:
|
290 |
params.update(self.message_tpls_compiled)
|
291 |
|
292 |
for key, value in self.urls.iteritems(): |
293 |
params['%s_url' % key] = value
|
294 |
|
295 |
if self.user and self.resolve_available_methods: |
296 |
available_providers = self.user.get_enabled_auth_providers()
|
297 |
for p in available_providers: |
298 |
p.resolve_available_methods = False
|
299 |
if p.module == self.module and p.identifier == self.identifier: |
300 |
available_providers.remove(p) |
301 |
|
302 |
get_msg = lambda p: p.get_method_prompt_msg
|
303 |
params['available_methods'] = \
|
304 |
','.join(map(get_msg, available_providers)) |
305 |
|
306 |
get_msg = lambda p: "<a href='%s'>%s</a>" % \ |
307 |
(p.get_method_prompt_msg, p.get_login_url) |
308 |
|
309 |
params['available_methods_links'] = \
|
310 |
','.join(map(get_msg, available_providers)) |
311 |
|
312 |
params.update(extra_params) |
313 |
return params
|
314 |
|
315 |
def get_template(self, tpl): |
316 |
tpls = ['im/auth/%s_%s.html' % (self.module, tpl), |
317 |
getattr(self, '%s_template' % tpl)] |
318 |
found = None
|
319 |
for tpl in tpls: |
320 |
try:
|
321 |
found = template.loader.get_template(tpl) |
322 |
return tpl
|
323 |
except template.TemplateDoesNotExist:
|
324 |
continue
|
325 |
if not found: |
326 |
raise template.TemplateDoesNotExist
|
327 |
return tpl
|
328 |
|
329 |
def get_username(self): |
330 |
return self.get_username_msg |
331 |
|
332 |
def get_user_providers(self): |
333 |
return self.user.auth_providers.active() |
334 |
|
335 |
def get_user_module_providers(self): |
336 |
return self.user.auth_providers.active().filter(module=self.module) |
337 |
|
338 |
def get_existing_providers(self): |
339 |
return "" |
340 |
|
341 |
def verified_exists(self): |
342 |
return self.get_provider_model().objects.verified( |
343 |
self.module, identifier=self.identifier) |
344 |
|
345 |
def get_user_policy(self, policy, default=None): |
346 |
|
347 |
if policy == 'switch' and default and not self.get_add_policy: |
348 |
return not self.get_policy('remove') |
349 |
|
350 |
if not self.user: |
351 |
return default
|
352 |
|
353 |
if policy == 'remove' and default is True: |
354 |
return self.get_user_providers().count() > 1 |
355 |
|
356 |
if policy == 'add' and default is True: |
357 |
limit = self.get_policy('limit') |
358 |
if limit <= self.get_user_module_providers().count(): |
359 |
return False |
360 |
|
361 |
if self.identifier: |
362 |
if self.verified_exists(): |
363 |
return False |
364 |
|
365 |
return default
|
366 |
|
367 |
def get_user_policies(self): |
368 |
from astakos.im.models import AuthProviderPolicyProfile |
369 |
return AuthProviderPolicyProfile.objects.for_user(self.user, |
370 |
self.module)
|
371 |
|
372 |
def get_policy(self, policy): |
373 |
module_default = self.module_policies.get(policy)
|
374 |
settings_key = '%s_POLICY' % policy.upper()
|
375 |
settings_default = self.get_setting(settings_key, module_default)
|
376 |
|
377 |
if self.user: |
378 |
user_policies = self.get_user_policies()
|
379 |
settings_default = user_policies.get(policy, settings_default) |
380 |
|
381 |
return self.get_user_policy(policy, settings_default) |
382 |
|
383 |
def get_message(self, msg, **extra_params): |
384 |
"""
|
385 |
Retrieve an auth provider message
|
386 |
"""
|
387 |
if msg.endswith('_msg'): |
388 |
msg = msg.replace('_msg', '') |
389 |
params = self._message_params(**extra_params)
|
390 |
|
391 |
# is message ???
|
392 |
tpl = self.message_tpls_compiled.get(msg.lower(), None) |
393 |
if not tpl: |
394 |
msg_key = 'AUTH_PROVIDER_%s' % msg.upper()
|
395 |
try:
|
396 |
tpl = getattr(astakos_messages, msg_key)
|
397 |
except AttributeError, e: |
398 |
try:
|
399 |
msg_key = msg.upper() |
400 |
tpl = getattr(astakos_messages, msg_key)
|
401 |
except AttributeError, e: |
402 |
tpl = ''
|
403 |
|
404 |
in_settings = self.get_setting(msg)
|
405 |
if in_settings:
|
406 |
tpl = in_settings |
407 |
|
408 |
return tpl.format(**params)
|
409 |
|
410 |
@property
|
411 |
def urls(self): |
412 |
urls = { |
413 |
'login': reverse(self.login_view), |
414 |
'add': reverse(self.login_view), |
415 |
'profile': reverse('edit_profile'), |
416 |
} |
417 |
if self.user: |
418 |
urls.update({ |
419 |
'resend_activation': self.user.get_resend_activation_url(), |
420 |
}) |
421 |
if self.identifier and self._instance: |
422 |
urls.update({ |
423 |
'switch': reverse(self.login_view) + '?switch_from=%d' % \ |
424 |
self._instance.pk,
|
425 |
'remove': reverse('remove_auth_provider', |
426 |
kwargs={'pk': self._instance.pk}) |
427 |
}) |
428 |
urls.update(self.module_urls)
|
429 |
return urls
|
430 |
|
431 |
def get_setting_key(self, name): |
432 |
return 'ASTAKOS_AUTH_PROVIDER_%s_%s' % (self.module.upper(), |
433 |
name.upper()) |
434 |
|
435 |
def get_global_setting_key(self, name): |
436 |
return 'ASTAKOS_AUTH_PROVIDERS_%s' % name.upper() |
437 |
|
438 |
def has_global_setting(self, name): |
439 |
return hasattr(settings, self.get_global_setting_key(name)) |
440 |
|
441 |
def has_setting(self, name): |
442 |
return hasattr(settings, self.get_setting_key(name)) |
443 |
|
444 |
def get_setting(self, name, default=None): |
445 |
attr = self.get_setting_key(name)
|
446 |
if not self.has_setting(name): |
447 |
return self.get_global_setting(name, default) |
448 |
return getattr(settings, attr, default) |
449 |
|
450 |
def get_global_setting(self, name, default=None): |
451 |
attr = self.get_global_setting_key(name)
|
452 |
if not self.has_global_setting(name): |
453 |
return default
|
454 |
return getattr(settings, attr, default) |
455 |
|
456 |
@property
|
457 |
def provider_details(self): |
458 |
if self._provider_details: |
459 |
return self._provider_details |
460 |
|
461 |
self._provider_details = {}
|
462 |
|
463 |
if self._instance: |
464 |
self._provider_details = self._instance.__dict__ |
465 |
|
466 |
if self.user and self.identifier: |
467 |
if self.identifier: |
468 |
try:
|
469 |
self._provider_details = \
|
470 |
self.user.get_auth_providers().get(
|
471 |
module=self.module,
|
472 |
identifier=self.identifier).__dict__
|
473 |
except Exception: |
474 |
return {}
|
475 |
return self._provider_details |
476 |
|
477 |
def __getattr__(self, key): |
478 |
if not key.startswith('get_'): |
479 |
return super(AuthProvider, self).__getattribute__(key) |
480 |
|
481 |
key = key.replace('get_', '') |
482 |
if key.endswith('_msg'): |
483 |
return self.get_message(key) |
484 |
|
485 |
if key.endswith('_policy'): |
486 |
return self.get_policy(key.replace('_policy', '')) |
487 |
|
488 |
if key.endswith('_url'): |
489 |
key = key.replace('_url', '') |
490 |
return self.urls.get(key) |
491 |
|
492 |
if key.endswith('_icon'): |
493 |
key = key.replace('_msg', '_icon') |
494 |
return settings.MEDIA_URL + self.get_message(key) |
495 |
|
496 |
if key.endswith('_setting'): |
497 |
key = key.replace('_setting', '') |
498 |
return self.get_message(key) |
499 |
|
500 |
if key.endswith('_template'): |
501 |
key = key.replace('_template', '') |
502 |
return self.get_template(key) |
503 |
|
504 |
return super(AuthProvider, self).__getattribute__(key) |
505 |
|
506 |
def is_active(self): |
507 |
return self.module_enabled |
508 |
|
509 |
|
510 |
class LocalAuthProvider(AuthProvider): |
511 |
module = 'local'
|
512 |
|
513 |
login_view = 'password_change'
|
514 |
remote_authenticate = False
|
515 |
username_key = 'user_email'
|
516 |
|
517 |
messages = { |
518 |
'title': _('Classic'), |
519 |
'login_prompt': _('Classic login (username/password)'), |
520 |
'login_success': _('Logged in successfully.'), |
521 |
'method_details': 'Username: {username}', |
522 |
'logout_success_extra': ' ' |
523 |
} |
524 |
|
525 |
@property
|
526 |
def urls(self): |
527 |
urls = super(LocalAuthProvider, self).urls |
528 |
urls['change_password'] = reverse('password_change') |
529 |
if self.user: |
530 |
urls['add'] = reverse('password_change') |
531 |
if self._instance: |
532 |
urls.update({ |
533 |
'remove': reverse('remove_auth_provider', |
534 |
kwargs={'pk': self._instance.pk}) |
535 |
}) |
536 |
if 'switch' in urls: |
537 |
del urls['switch'] |
538 |
return urls
|
539 |
|
540 |
def remove_from_user(self): |
541 |
super(LocalAuthProvider, self).remove_from_user() |
542 |
self.user.set_unusable_password()
|
543 |
self.user.save()
|
544 |
for group_name in self.get_add_groups_policy: |
545 |
group = Group.objects.get(name=group_name) |
546 |
self.user.groups.remove(group)
|
547 |
|
548 |
|
549 |
class ShibbolethAuthProvider(AuthProvider): |
550 |
module = 'shibboleth'
|
551 |
login_view = 'astakos.im.target.shibboleth.login'
|
552 |
username_key = 'identifier'
|
553 |
|
554 |
messages = { |
555 |
'title': _('Academic'), |
556 |
'login_description': _('If you are a student, professor or researcher' |
557 |
' you can login using your academic account.'),
|
558 |
'method_details': 'Account: {username}', |
559 |
'logout_extra': _('Please close all browser windows to complete ' |
560 |
'logout from your Academic account, too.')
|
561 |
} |
562 |
|
563 |
|
564 |
class TwitterAuthProvider(AuthProvider): |
565 |
module = 'twitter'
|
566 |
login_view = 'astakos.im.target.twitter.login'
|
567 |
username_key = 'provider_info_screen_name'
|
568 |
|
569 |
messages = { |
570 |
'title': _('Twitter'), |
571 |
'method_details': 'Screen name: {username}', |
572 |
} |
573 |
|
574 |
|
575 |
class GoogleAuthProvider(AuthProvider): |
576 |
module = 'google'
|
577 |
login_view = 'astakos.im.target.google.login'
|
578 |
username_key = 'provider_info_email'
|
579 |
|
580 |
messages = { |
581 |
'title': _('Google'), |
582 |
'method_details': 'Email: {username}', |
583 |
} |
584 |
|
585 |
|
586 |
class LinkedInAuthProvider(AuthProvider): |
587 |
module = 'linkedin'
|
588 |
login_view = 'astakos.im.target.linkedin.login'
|
589 |
username_key = 'provider_info_email'
|
590 |
|
591 |
messages = { |
592 |
'title': _('LinkedIn'), |
593 |
'method_details': 'Email: {username}', |
594 |
} |
595 |
|
596 |
|
597 |
# Utility method
|
598 |
def get_provider(module, user_obj=None, identifier=None, **params): |
599 |
"""
|
600 |
Return a provider instance from the auth providers registry.
|
601 |
"""
|
602 |
if not module in PROVIDERS: |
603 |
raise Exception('Invalid auth provider "%s"' % id) |
604 |
|
605 |
return PROVIDERS.get(module)(user_obj, identifier, **params)
|