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