root / snf-astakos-app / astakos / im / auth_providers.py @ b22de10a
History | View | Annotate | Download (5.9 kB)
1 | d2633501 | Kostas Papadimitriou | # Copyright 2011 GRNET S.A. All rights reserved.
|
---|---|---|---|
2 | d2633501 | Kostas Papadimitriou | #
|
3 | d2633501 | Kostas Papadimitriou | # Redistribution and use in source and binary forms, with or
|
4 | d2633501 | Kostas Papadimitriou | # without modification, are permitted provided that the following
|
5 | d2633501 | Kostas Papadimitriou | # conditions are met:
|
6 | d2633501 | Kostas Papadimitriou | #
|
7 | d2633501 | Kostas Papadimitriou | # 1. Redistributions of source code must retain the above
|
8 | d2633501 | Kostas Papadimitriou | # copyright notice, this list of conditions and the following
|
9 | d2633501 | Kostas Papadimitriou | # disclaimer.
|
10 | d2633501 | Kostas Papadimitriou | #
|
11 | d2633501 | Kostas Papadimitriou | # 2. Redistributions in binary form must reproduce the above
|
12 | d2633501 | Kostas Papadimitriou | # copyright notice, this list of conditions and the following
|
13 | d2633501 | Kostas Papadimitriou | # disclaimer in the documentation and/or other materials
|
14 | d2633501 | Kostas Papadimitriou | # provided with the distribution.
|
15 | d2633501 | Kostas Papadimitriou | #
|
16 | d2633501 | Kostas Papadimitriou | # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 | d2633501 | Kostas Papadimitriou | # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 | d2633501 | Kostas Papadimitriou | # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 | d2633501 | Kostas Papadimitriou | # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 | d2633501 | Kostas Papadimitriou | # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 | d2633501 | Kostas Papadimitriou | # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 | d2633501 | Kostas Papadimitriou | # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 | d2633501 | Kostas Papadimitriou | # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 | d2633501 | Kostas Papadimitriou | # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 | d2633501 | Kostas Papadimitriou | # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 | d2633501 | Kostas Papadimitriou | # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 | d2633501 | Kostas Papadimitriou | # POSSIBILITY OF SUCH DAMAGE.
|
28 | d2633501 | Kostas Papadimitriou | #
|
29 | d2633501 | Kostas Papadimitriou | # The views and conclusions contained in the software and
|
30 | d2633501 | Kostas Papadimitriou | # documentation are those of the authors and should not be
|
31 | d2633501 | Kostas Papadimitriou | # interpreted as representing official policies, either expressed
|
32 | d2633501 | Kostas Papadimitriou | # or implied, of GRNET S.A.
|
33 | d2633501 | Kostas Papadimitriou | |
34 | d2633501 | Kostas Papadimitriou | |
35 | d2633501 | Kostas Papadimitriou | from django.core.urlresolvers import reverse |
36 | d2633501 | Kostas Papadimitriou | from django.utils.translation import ugettext as _ |
37 | 081070a5 | Kostas Papadimitriou | from django.utils.datastructures import SortedDict |
38 | d2633501 | Kostas Papadimitriou | |
39 | 081070a5 | Kostas Papadimitriou | from django.conf import settings |
40 | 081070a5 | Kostas Papadimitriou | from astakos.im import settings as astakos_settings |
41 | d2633501 | Kostas Papadimitriou | |
42 | d2633501 | Kostas Papadimitriou | import logging |
43 | d2633501 | Kostas Papadimitriou | |
44 | d2633501 | Kostas Papadimitriou | logger = logging.getLogger(__name__) |
45 | d2633501 | Kostas Papadimitriou | |
46 | d2633501 | Kostas Papadimitriou | # providers registry
|
47 | 6012535a | Kostas Papadimitriou | PROVIDERS = {} |
48 | d2633501 | Kostas Papadimitriou | |
49 | d2633501 | Kostas Papadimitriou | class AuthProviderBase(type): |
50 | d2633501 | Kostas Papadimitriou | |
51 | d2633501 | Kostas Papadimitriou | def __new__(cls, name, bases, dct): |
52 | d2633501 | Kostas Papadimitriou | include = False
|
53 | d2633501 | Kostas Papadimitriou | if [b for b in bases if isinstance(b, AuthProviderBase)]: |
54 | d2633501 | Kostas Papadimitriou | type_id = dct.get('module')
|
55 | d2633501 | Kostas Papadimitriou | if type_id:
|
56 | d2633501 | Kostas Papadimitriou | include = True
|
57 | 081070a5 | Kostas Papadimitriou | if type_id in astakos_settings.IM_MODULES: |
58 | d2633501 | Kostas Papadimitriou | dct['module_enabled'] = True |
59 | d2633501 | Kostas Papadimitriou | |
60 | d2633501 | Kostas Papadimitriou | newcls = super(AuthProviderBase, cls).__new__(cls, name, bases, dct)
|
61 | d2633501 | Kostas Papadimitriou | if include:
|
62 | 6012535a | Kostas Papadimitriou | PROVIDERS[type_id] = newcls |
63 | d2633501 | Kostas Papadimitriou | return newcls
|
64 | d2633501 | Kostas Papadimitriou | |
65 | d2633501 | Kostas Papadimitriou | |
66 | d2633501 | Kostas Papadimitriou | class AuthProvider(object): |
67 | d2633501 | Kostas Papadimitriou | |
68 | d2633501 | Kostas Papadimitriou | __metaclass__ = AuthProviderBase |
69 | d2633501 | Kostas Papadimitriou | |
70 | d2633501 | Kostas Papadimitriou | module = None
|
71 | d2633501 | Kostas Papadimitriou | module_active = False
|
72 | d2633501 | Kostas Papadimitriou | module_enabled = False
|
73 | d2633501 | Kostas Papadimitriou | one_per_user = False
|
74 | d2633501 | Kostas Papadimitriou | |
75 | d2633501 | Kostas Papadimitriou | def __init__(self, user=None): |
76 | d2633501 | Kostas Papadimitriou | self.user = user
|
77 | d2633501 | Kostas Papadimitriou | |
78 | 081070a5 | Kostas Papadimitriou | def __getattr__(self, key): |
79 | 081070a5 | Kostas Papadimitriou | if not key.startswith('get_'): |
80 | 081070a5 | Kostas Papadimitriou | return super(AuthProvider, self).__getattr__(key) |
81 | 081070a5 | Kostas Papadimitriou | |
82 | 081070a5 | Kostas Papadimitriou | if key.endswith('_display') or key.endswith('template'): |
83 | 081070a5 | Kostas Papadimitriou | attr = key.replace('_display', '').replace('get_','') |
84 | 081070a5 | Kostas Papadimitriou | settings_attr = self.get_setting(attr.upper())
|
85 | 081070a5 | Kostas Papadimitriou | if not settings_attr: |
86 | 081070a5 | Kostas Papadimitriou | return getattr(self, attr) |
87 | 081070a5 | Kostas Papadimitriou | return settings_attr
|
88 | 081070a5 | Kostas Papadimitriou | else:
|
89 | 081070a5 | Kostas Papadimitriou | return super(AuthProvider, self).__getattr__(key) |
90 | 081070a5 | Kostas Papadimitriou | |
91 | d2633501 | Kostas Papadimitriou | def get_setting(self, name, default=None): |
92 | 081070a5 | Kostas Papadimitriou | attr = 'ASTAKOS_AUTH_PROVIDER_%s_%s' % (self.module.upper(), name.upper()) |
93 | d2633501 | Kostas Papadimitriou | return getattr(settings, attr, default) |
94 | d2633501 | Kostas Papadimitriou | |
95 | d2633501 | Kostas Papadimitriou | def is_available_for_login(self): |
96 | d2633501 | Kostas Papadimitriou | """ A user can login using authentication provider"""
|
97 | d2633501 | Kostas Papadimitriou | return self.is_active() and self.get_setting('CAN_LOGIN', |
98 | d2633501 | Kostas Papadimitriou | self.is_active())
|
99 | d2633501 | Kostas Papadimitriou | |
100 | d2633501 | Kostas Papadimitriou | def is_available_for_create(self): |
101 | d2633501 | Kostas Papadimitriou | """ A user can create an account using this provider"""
|
102 | d2633501 | Kostas Papadimitriou | return self.is_active() and self.get_setting('CAN_CREATE', |
103 | d2633501 | Kostas Papadimitriou | self.is_active())
|
104 | d2633501 | Kostas Papadimitriou | |
105 | d2633501 | Kostas Papadimitriou | def is_available_for_add(self): |
106 | d2633501 | Kostas Papadimitriou | """ A user can assign provider authentication method"""
|
107 | d2633501 | Kostas Papadimitriou | return self.is_active() and self.get_setting('CAN_ADD', |
108 | d2633501 | Kostas Papadimitriou | self.is_active())
|
109 | d2633501 | Kostas Papadimitriou | |
110 | d2633501 | Kostas Papadimitriou | def is_active(self): |
111 | 081070a5 | Kostas Papadimitriou | return self.module in astakos_settings.IM_MODULES |
112 | d2633501 | Kostas Papadimitriou | |
113 | d2633501 | Kostas Papadimitriou | |
114 | d2633501 | Kostas Papadimitriou | class LocalAuthProvider(AuthProvider): |
115 | d2633501 | Kostas Papadimitriou | module = 'local'
|
116 | d2633501 | Kostas Papadimitriou | title = _('Local password')
|
117 | d2633501 | Kostas Papadimitriou | description = _('Create a local password for your account')
|
118 | 081070a5 | Kostas Papadimitriou | create_prompt = _('Create an account')
|
119 | 081070a5 | Kostas Papadimitriou | add_prompt = _('Create a local password for your account')
|
120 | d2633501 | Kostas Papadimitriou | |
121 | d2633501 | Kostas Papadimitriou | |
122 | d2633501 | Kostas Papadimitriou | @property
|
123 | d2633501 | Kostas Papadimitriou | def add_url(self): |
124 | d2633501 | Kostas Papadimitriou | return reverse('password_change') |
125 | d2633501 | Kostas Papadimitriou | |
126 | d2633501 | Kostas Papadimitriou | one_per_user = True
|
127 | 081070a5 | Kostas Papadimitriou | |
128 | 081070a5 | Kostas Papadimitriou | login_template = 'im/auth/local_login_form.html'
|
129 | 081070a5 | Kostas Papadimitriou | login_prompt_template = 'im/auth/local_login_prompt.html'
|
130 | 081070a5 | Kostas Papadimitriou | signup_prompt_template = 'im/auth/local_signup_prompt.html'
|
131 | d2633501 | Kostas Papadimitriou | details_tpl = _('You can login to your account using your'
|
132 | d2633501 | Kostas Papadimitriou | ' %(auth_backend)s password.')
|
133 | d2633501 | Kostas Papadimitriou | |
134 | d2633501 | Kostas Papadimitriou | @property
|
135 | d2633501 | Kostas Papadimitriou | def extra_actions(self): |
136 | d2633501 | Kostas Papadimitriou | return [(_('Change password'), reverse('password_change')), ] |
137 | d2633501 | Kostas Papadimitriou | |
138 | d2633501 | Kostas Papadimitriou | |
139 | d2633501 | Kostas Papadimitriou | class ShibbolethAuthProvider(AuthProvider): |
140 | d2633501 | Kostas Papadimitriou | module = 'shibboleth'
|
141 | d2633501 | Kostas Papadimitriou | title = _('Academic credentials (Shibboleth)')
|
142 | d2633501 | Kostas Papadimitriou | description = _('Allows you to login to your account using your academic '
|
143 | d2633501 | Kostas Papadimitriou | 'credentials')
|
144 | 081070a5 | Kostas Papadimitriou | add_prompt = _('Add academic credentials to your account.')
|
145 | d2633501 | Kostas Papadimitriou | |
146 | d2633501 | Kostas Papadimitriou | @property
|
147 | d2633501 | Kostas Papadimitriou | def add_url(self): |
148 | d2633501 | Kostas Papadimitriou | return reverse('astakos.im.target.shibboleth.login') |
149 | d2633501 | Kostas Papadimitriou | |
150 | 081070a5 | Kostas Papadimitriou | login_template = 'im/auth/shibboleth_login.html'
|
151 | 081070a5 | Kostas Papadimitriou | login_prompt_template = 'im/auth/shibboleth_login_prompt.html'
|
152 | d2633501 | Kostas Papadimitriou | |
153 | d2633501 | Kostas Papadimitriou | |
154 | c101b32b | Kostas Papadimitriou | class TwitterAuthProvider(AuthProvider): |
155 | c101b32b | Kostas Papadimitriou | module = 'twitter'
|
156 | c101b32b | Kostas Papadimitriou | title = _('Twitter')
|
157 | c101b32b | Kostas Papadimitriou | description = _('Allows you to login to your account using your twitter '
|
158 | c101b32b | Kostas Papadimitriou | 'account')
|
159 | c101b32b | Kostas Papadimitriou | add_prompt = _('Connect with your Twitter account.')
|
160 | c101b32b | Kostas Papadimitriou | |
161 | c101b32b | Kostas Papadimitriou | @property
|
162 | c101b32b | Kostas Papadimitriou | def add_url(self): |
163 | c101b32b | Kostas Papadimitriou | return reverse('astakos.im.target.twitter.login') |
164 | c101b32b | Kostas Papadimitriou | |
165 | c101b32b | Kostas Papadimitriou | login_template = 'im/auth/twitter_login.html'
|
166 | c101b32b | Kostas Papadimitriou | login_prompt_template = 'im/auth/twitter_login_prompt.html'
|
167 | c101b32b | Kostas Papadimitriou | |
168 | d2633501 | Kostas Papadimitriou | def get_provider(id, user_obj=None, default=None): |
169 | d2633501 | Kostas Papadimitriou | """
|
170 | d2633501 | Kostas Papadimitriou | Return a provider instance from the auth providers registry.
|
171 | d2633501 | Kostas Papadimitriou | """
|
172 | d2633501 | Kostas Papadimitriou | return PROVIDERS.get(id, default)(user_obj) |