-
-
Notifications
You must be signed in to change notification settings - Fork 70
/
auth.py
2061 lines (1867 loc) · 79.9 KB
/
auth.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""
weppy.tools.auth
----------------
Provides the authorization system.
:copyright: (c) 2015 by Giovanni Barillari
Based on the web2py's auth module (http://www.web2py.com)
:copyright: (c) by Massimo Di Pierro <mdipierro@cs.depaul.edu>
:license: LGPLv3 (http://www.gnu.org/licenses/lgpl.html)
"""
## NOTE for developers by gi0baro:
## This code is in alpha stage. It's very dirty.
## Stuffs I've missed (until now):
## - captcha is not ported, but I want to
## - CAS is not ported, but I want to
## - impersonate() is not ported (want to?)
## - ajax behaviours are missing, need to re-design the flow
## - generally, all code needs a lot of cleaning
## - maybe some flows can be optimized (since in web2py
## everything was built on request, not here)
import urllib
from datetime import datetime, timedelta
from pydal.objects import Table, Field, Row, Set, Query
from ..globals import current, request, response, session
from ..datastructures import sdict
from ..http import HTTP, redirect
from ..forms import Form, DALForm
from ..tags import tag
from ..handlers import Handler
from ..security import uuid
from ..helpers import flash
from ..language import T
from . import Mail
DEFAULT = lambda: None
default_settings = dict(
password_min_length=6,
cas_maps=None,
reset_password_requires_verification=False,
registration_requires_verification=False,
registration_requires_approval=False,
login_after_registration=False,
login_after_password_change=True,
create_user_groups=None,
everybody_group_id=None,
#login_captcha=None,
#register_captcha=None,
#retrieve_username_captcha=None,
#retrieve_password_captcha=None,
#captcha=None,
expiration=3600, # one hour
long_expiration=3600 * 30 * 24, # one month
remember_me_form=True,
allow_basic_login=False,
on_failed_authentication=lambda x: redirect(x),
logging_enabled=True,
allow_delete_accounts=False,
password_field='password',
table_user_name='auth_user',
table_group_name='auth_group',
table_membership_name='auth_membership',
table_permission_name='auth_permission',
table_event_name='auth_event',
#table_cas_name='auth_cas',
use_username=False,
login_userfield='email',
logout_onlogout=None,
register_fields=None,
profile_fields=None,
email_case_sensitive=True,
username_case_sensitive=True,
update_fields=['email'],
ondelete="CASCADE",
extra_fields={},
actions_disabled=[],
login_onvalidation=[],
login_onaccept=[],
login_onfail=[],
register_onvalidation=[],
register_onaccept=[],
verify_email_onaccept=[],
profile_onvalidation=[],
profile_onaccept=[],
change_password_onvalidation=[],
change_password_onaccept=[],
retrieve_password_onvalidation=[],
reset_password_onvalidation=[],
reset_password_onaccept=[]
)
default_messages = dict(
login_button='Login',
register_button='Register',
password_reset_button='Request reset password',
password_change_button='Change password',
profile_save_button='Apply changes',
submit_button='Submit',
verify_password='Verify Password',
delete_label='Check to delete',
function_disabled='Function disabled',
access_denied='Insufficient privileges',
registration_verifying='Registration needs verification',
registration_pending='Registration is pending approval',
email_taken='This email already has an account',
invalid_username='Invalid username',
username_taken='Username already taken',
login_disabled='Login disabled by administrator',
logged_in='Logged in',
email_sent='Email sent',
unable_to_send_email='Unable to send email',
email_verified='Email verified',
logged_out='Logged out',
registration_successful='Registration successful',
invalid_email='Invalid email',
unable_send_email='Unable to send email',
invalid_login='Invalid login',
invalid_user='Invalid user',
invalid_password='Invalid password',
is_empty="Cannot be empty",
mismatched_password="Password fields don't match",
verify_email='Welcome %(username)s! Click on the link %(link)s to verify your email',
verify_email_subject='Email verification',
username_sent='Your username was emailed to you',
new_password_sent='A new password was emailed to you',
password_changed='Password changed',
retrieve_username='Your username is: %(username)s',
retrieve_username_subject='Username retrieve',
retrieve_password='Your password is: %(password)s',
retrieve_password_subject='Password retrieve',
reset_password=
'Click on the link %(link)s to reset your password',
reset_password_subject='Password reset',
invalid_reset_password='Invalid reset password',
profile_updated='Profile updated',
new_password='New password',
old_password='Old password',
group_description='Group uniquely assigned to user %(id)s',
register_log='User %(id)s Registered',
login_log='User %(id)s Logged-in',
login_failed_log=None,
logout_log='User %(id)s Logged-out',
profile_log='User %(id)s Profile updated',
verify_email_log='User %(id)s Verification email sent',
retrieve_username_log='User %(id)s Username retrieved',
retrieve_password_log='User %(id)s Password retrieved',
reset_password_log='User %(id)s Password reset',
change_password_log='User %(id)s Password changed',
add_group_log='Group %(group_id)s created',
del_group_log='Group %(group_id)s deleted',
add_membership_log=None,
del_membership_log=None,
has_membership_log=None,
add_permission_log=None,
del_permission_log=None,
has_permission_log=None,
impersonate_log='User %(id)s is impersonating %(other_id)s',
label_first_name='First name',
label_last_name='Last name',
label_username='Username',
label_email='E-mail',
label_password='Password',
label_registration_key='Registration key',
label_reset_password_key='Reset Password key',
label_registration_id='Registration identifier',
label_role='Role',
label_description='Description',
label_user_id='User ID',
label_group_id='Group ID',
label_name='Name',
label_table_name='Object or table name',
label_record_id='Record ID',
label_time_stamp='Timestamp',
label_client_ip='Client IP',
label_origin='Origin',
label_remember_me="Remember me (for 30 days)",
verify_password_comment='please input your password again',
)
class Auth(object):
"""
Class for authentication, authorization, role based access control.
Includes:
- registration and profile
- login and logout
- username and password retrieval
- event logging
- role creation and assignment
- user defined group/role based permission
exposes:
- http://.../{base_url}/login
- http://.../{base_url}/logout
- http://.../{base_url}/register
- http://.../{base_url}/verify_email
- http://.../{base_url}/retrieve_username
- http://.../{base_url}/retrieve_password
- http://.../{base_url}/reset_password
- http://.../{base_url}/change_password
- http://.../{base_url}/profile
"""
registered_actions = {}
def get_or_create_key(self, app, filename=None, alg='sha512'):
import os
if not filename:
path = os.path.join(app.root_path, 'private')
if not os.path.exists(path):
os.mkdir(path)
filename = os.path.join(path, 'auth.key')
else:
filename = os.path.join(app.root_path, filename)
if os.path.exists(filename):
key = open(filename, 'r').read().strip()
else:
key = alg + ':' + uuid()
open(filename, 'w').write(key)
return key
def url(self, args=[], vars=None, scheme=False):
q = urllib.quote
u = self.settings.base_url
if not isinstance(args, (list, tuple)):
args = [args]
u = u + '/' + '/'.join(q(a) for a in args)
if vars:
u = u + '?' + '&'.join('%s=%s' % (q(k), q(v))
for k, v in vars.iteritems())
return u
def _init_usermodel(self, usermodel, use_signature):
usermodel.auth = self
usermodel.db = self.db
user = usermodel()
self.define_tables(use_signature)
usermodel.entity = self.table_user
usermodel.id = user.entity.id
# load user's definitions
getattr(user, '_AuthModel__define')()
# set reference in db for datamodel name
setattr(self.db, usermodel.__name__, user.entity)
self.entity = user.entity
self._usermodel = user
#if app.config.get('auth', {}).get('server', 'default') != "default":
# self.settings.mailer.server = app.config.auth.server
# self.settings.mailer.sender = app.config.auth.sender
# self.settings.mailer.login = app.config.auth.login
def __init__(self, app, db, usermodel=None, mailer=True, hmac_key=None,
hmac_key_file=None, signature=True, base_url=None,
csrf_prevention=True, **kwargs):
"""
auth=Auth(app, db)
- db has to be the database where to create tables for authentication
- mailer=Mail(...) or None (no mailed) or True (make a mailer)
- hmac_key can be a hmac_key or hmac_key=Auth.get_or_create_key()
- base_url (where is the user action?)
- cas_provider (delegate authentication to the URL, CAS2)
"""
self.db = db
self.csrf_prevention = csrf_prevention
if hmac_key is None:
hmac_key = self.get_or_create_key(app, hmac_key_file)
url_index = base_url or "/account"
url_login = url_index + "/login"
settings = self.settings = sdict()
settings.update(default_settings)
settings.update(
base_url=url_index,
#cas_domains=[request.env.http_host],
#cas_provider=cas_provider,
#cas_actions=dict(login='login',
# validate='validate',
# servicevalidate='serviceValidate',
# proxyvalidate='proxyValidate',
# logout='logout'),
login_url=url_login,
logged_url=url_index+"/profile",
download_url="/download",
mailer=(mailer == True) and Mail(app) or mailer,
on_failed_authorization = url_index+"/not_authorized",
login_next = url_index+"/profile",
login_methods = [self],
login_form = self,
logout_next = url_index,
register_next = url_index,
verify_email_next = url_login,
profile_next = url_index,
retrieve_username_next = url_index,
retrieve_password_next = url_index,
request_reset_password_next = url_login,
reset_password_next = url_index,
change_password_next = url_index,
hmac_key = hmac_key
)
#: load user's settings
for key, value in app.config.auth.items():
if key in self.settings.keys():
self.settings[key] = value
# ## these are messages that can be customized
messages = self.messages = sdict()
messages.update(default_messages)
if signature:
self.define_signature()
else:
self.signature = None
#: define allowed actions
default_actions = [
'login', 'logout', 'register', 'verify_email',
'retrieve_username', 'retrieve_password',
'reset_password', 'request_reset_password',
'change_password', 'profile', 'groups',
#'impersonate',
'not_authorized']
for k in default_actions:
if k not in self.settings.actions_disabled:
self.register_action(k, getattr(self, k))
_use_signature = kwargs.get('sign_tables')
self._usermodel = None
if usermodel:
from ..dal import AuthModel
if not issubclass(usermodel, AuthModel):
raise RuntimeError('%s is an invalid user model' %
usermodel.__name__)
self._init_usermodel(usermodel, _use_signature)
else:
self.define_tables(_use_signature)
@property
def _auth(self):
return session.auth
@property
def user(self):
try:
u = session.auth.user if session.auth.user else None
except:
u = None
return u
def get_vars_next(self):
next = request.vars._next
if isinstance(next, (list, tuple)):
next = next[0]
return next
@property
def user_id(self):
"accessor for auth.user_id"
return self.user and self.user.id or None
@property
def table_user(self):
return self.db[self.settings.table_user_name]
@property
def table_group(self):
return self.db[self.settings.table_group_name]
@property
def table_membership(self):
return self.db[self.settings.table_membership_name]
@property
def table_permission(self):
return self.db[self.settings.table_permission_name]
@property
def table_event(self):
return self.db[self.settings.table_event_name]
#@property
#def table_cas(self):
# return self.db[self.settings.table_cas_name]
@property
def handler(self):
return AuthManager(self)
def register_action(self, name, f):
self.registered_actions[name] = f
def __call__(self, f, a):
"""
usage:
def authentication(): return dict(form=auth())
"""
if not f:
redirect(self.url(args='login', vars=request.vars))
elif f in self.settings.actions_disabled:
raise HTTP(404)
if f in self.registered_actions:
if a is not None:
return self.registered_actions[f](a)
else:
return self.registered_actions[f]()
else:
raise HTTP(404)
def __get_migrate(self, tablename, migrate=True):
if type(migrate).__name__ == 'str':
return (migrate + tablename + '.table')
elif migrate == False:
return False
else:
return True
def enable_record_versioning(self, tables, archive_db=None,
archive_names='%(tablename)s_archive',
current_record='current_record',
current_record_label=None):
"""
to enable full record versioning (including auth tables):
auth = Auth(db)
auth.define_tables(signature=True)
# define our own tables
db.define_table('mything',Field('name'),auth.signature)
auth.enable_record_versioning(tables=db)
tables can be the db (all table) or a list of tables.
only tables with modified_by and modified_on fiels (as created
by auth.signature) will have versioning. Old record versions will be
in table 'mything_archive' automatically defined.
when you enable enable_record_versioning, records are never
deleted but marked with is_active=False.
enable_record_versioning enables a common_filter for
every table that filters out records with is_active = False
Important: If you use auth.enable_record_versioning,
do not use auth.archive or you will end up with duplicates.
auth.archive does explicitly what enable_record_versioning
does automatically.
"""
current_record_label = current_record_label or T(
current_record.replace('_', ' ').title())
for table in tables:
fieldnames = table.fields()
if 'id' in fieldnames and 'modified_on' in fieldnames and \
not current_record in fieldnames:
table._enable_record_versioning(
archive_db=archive_db,
archive_name=archive_names,
current_record=current_record,
current_record_label=current_record_label)
def define_signature(self):
settings = self.settings
reference_user = 'reference %s' % settings.table_user_name
def lazy_user(auth=self):
return auth.user_id
def represent(id, record=None, s=settings):
try:
user = s.table_user(id)
return '%s %s' % (user.get("first_name", user.get("email")),
user.get("last_name", ''))
except:
return id
ondelete = self.settings.ondelete
self.signature = Table(
self.db, 'auth_signature',
Field('is_active', 'boolean',
default=True,
readable=False, writable=False,
label='Is Active'),
Field('created_on', 'datetime',
default=lambda: datetime.now(),
writable=False, readable=False,
label='Created On'),
Field('created_by',
reference_user,
default=lazy_user, represent=represent,
writable=False, readable=False,
label='Created By', ondelete=ondelete),
Field('modified_on', 'datetime',
update=lambda: datetime.now(),
default=lambda: datetime.now(),
writable=False, readable=False,
label='Modified On'),
Field('modified_by',
reference_user, represent=represent,
default=lazy_user, update=lazy_user,
writable=False, readable=False,
label='Modified By', ondelete=ondelete))
def define_tables(self, signature=None, migrate=None, fake_migrate=None):
"""
to be called unless tables are defined manually
usages:
# defines all needed tables and table files
# 'myprefix_auth_user.table', ...
auth.define_tables(migrate='myprefix_')
# defines all needed tables without migration/table files
auth.define_tables(migrate=False)
"""
from ..validators import isntEmpty, Crypt, isEmail, Lower, \
Matches, isInt, inRange, hasLength
from ..validators._old import notInDb
db = self.db
if migrate is None:
migrate = db._migrate
if fake_migrate is None:
fake_migrate = db._fake_migrate
settings = self.settings
if not self.signature:
self.define_signature()
if signature == True:
signature_list = [self.signature]
elif not signature:
signature_list = []
elif isinstance(signature, Table):
signature_list = [signature]
else:
signature_list = signature
is_not_empty = isntEmpty(message=self.messages.is_empty)
is_crypted = Crypt(key=settings.hmac_key)
is_unique_email = [
isEmail(message=self.messages.invalid_email),
notInDb(db, '%s.email' % settings.table_user_name,
error_message=self.messages.email_taken)]
if not settings.email_case_sensitive:
is_unique_email.insert(1, Lower())
if not settings.table_user_name in db.tables:
passfield = settings.password_field
extra_fields = settings.extra_fields.get(
settings.table_user_name, []) + signature_list
if settings.use_username or settings.cas_provider:
is_unique_username = \
[Matches('[\w\.\-]+', strict=True,
message=self.messages.invalid_username),
notInDb(db, '%s.username' % settings.table_user_name,
message=self.messages.username_taken)]
if not settings.username_case_sensitive:
is_unique_username.insert(1, Lower())
db.define_table(
settings.table_user_name,
Field('first_name', length=128, default='',
label=self.messages.label_first_name,
requires=is_not_empty),
Field('last_name', length=128, default='',
label=self.messages.label_last_name,
requires=is_not_empty),
Field('email', length=512, default='',
label=self.messages.label_email,
requires=is_unique_email),
Field('username', length=128, default='',
label=self.messages.label_username,
requires=is_unique_username),
Field(passfield, 'password', length=512,
readable=False, label=self.messages.label_password,
requires=[hasLength(minsize=settings.password_min_length), is_crypted]),
Field('registration_key', length=512,
writable=False, readable=False, default='',
label=self.messages.label_registration_key),
Field('reset_password_key', length=512,
writable=False, readable=False, default='',
label=self.messages.label_reset_password_key),
Field('registration_id', length=512,
writable=False, readable=False, default='',
label=self.messages.label_registration_id),
*extra_fields,
**dict(
migrate=self.__get_migrate(settings.table_user_name,
migrate),
fake_migrate=fake_migrate,
format='%(username)s'))
else:
db.define_table(
settings.table_user_name,
Field('first_name', length=128, default='',
label=self.messages.label_first_name,
requires=is_not_empty),
Field('last_name', length=128, default='',
label=self.messages.label_last_name,
requires=is_not_empty),
Field('email', length=512, default='',
label=self.messages.label_email,
requires=is_unique_email),
Field(passfield, 'password', length=512,
readable=False, label=self.messages.label_password,
requires=[is_crypted]),
Field('registration_key', length=512,
writable=False, readable=False, default='',
label=self.messages.label_registration_key),
Field('reset_password_key', length=512,
writable=False, readable=False, default='',
label=self.messages.label_reset_password_key),
Field('registration_id', length=512,
writable=False, readable=False, default='',
label=self.messages.label_registration_id),
*extra_fields,
**dict(
migrate=self.__get_migrate(settings.table_user_name,
migrate),
fake_migrate=fake_migrate,
format='%(first_name)s %(last_name)s (%(id)s)'))
reference_table_user = 'reference %s' % settings.table_user_name
if not settings.table_group_name in db.tables:
extra_fields = settings.extra_fields.get(
settings.table_group_name, []) + signature_list
db.define_table(
settings.table_group_name,
Field(
'role', length=512, default='',
label=self.messages.label_role,
requires=notInDb(
db, '%s.role' % settings.table_group_name)),
Field('description', 'text',
label=self.messages.label_description),
*extra_fields,
**dict(
migrate=self.__get_migrate(
settings.table_group_name, migrate),
fake_migrate=fake_migrate,
format='%(role)s (%(id)s)'))
reference_table_group = 'reference %s' % settings.table_group_name
if not settings.table_membership_name in db.tables:
extra_fields = settings.extra_fields.get(
settings.table_membership_name, []) + signature_list
db.define_table(
settings.table_membership_name,
Field('user_id', reference_table_user,
label=self.messages.label_user_id),
Field('group_id', reference_table_group,
label=self.messages.label_group_id),
*extra_fields,
**dict(
migrate=self.__get_migrate(
settings.table_membership_name, migrate),
fake_migrate=fake_migrate))
if not settings.table_permission_name in db.tables:
extra_fields = settings.extra_fields.get(
settings.table_permission_name, []) + signature_list
db.define_table(
settings.table_permission_name,
Field('group_id', reference_table_group,
label=self.messages.label_group_id),
Field('name', default='default', length=512,
label=self.messages.label_name,
requires=is_not_empty),
Field('table_name', length=512,
label=self.messages.label_table_name),
Field('record_id', 'integer', default=0,
label=self.messages.label_record_id,
requires=[isInt(), inRange(0, 10 ** 9)]),
*extra_fields,
**dict(
migrate=self.__get_migrate(
settings.table_permission_name, migrate),
fake_migrate=fake_migrate))
if not settings.table_event_name in db.tables:
db.define_table(
settings.table_event_name,
Field('time_stamp', 'datetime',
default=lambda: datetime.now(),
label=self.messages.label_time_stamp),
Field('client_ip',
default=lambda: request.client if
hasattr(current, 'request') else 'unavailable',
label=self.messages.label_client_ip),
Field('user_id', reference_table_user, default=None,
label=self.messages.label_user_id),
Field('origin', default='auth', length=512,
label=self.messages.label_origin,
requires=is_not_empty),
Field('description', 'text', default='',
label=self.messages.label_description,
requires=is_not_empty),
*settings.extra_fields.get(settings.table_event_name, []),
**dict(
migrate=self.__get_migrate(
settings.table_event_name, migrate),
fake_migrate=fake_migrate))
#if settings.cas_domains:
# if not settings.table_cas_name in db.tables:
# db.define_table(
# settings.table_cas_name,
# Field('user_id', reference_table_user, default=None,
# label=self.messages.label_user_id),
# Field('created_on', 'datetime', default=lambda: datetime.now()),
# Field('service', requires=IS_URL()),
# Field('ticket'),
# Field('renew', 'boolean', default=False),
# *settings.extra_fields.get(settings.table_cas_name, []),
# **dict(
# migrate=self.__get_migrate(
# settings.table_cas_name, migrate),
# fake_migrate=fake_migrate))
#if settings.cas_provider: # THIS IS NOT LAZY
# settings.actions_disabled = \
# ['profile', 'register', 'change_password',
# 'request_reset_password', 'retrieve_username']
# from gluon.contrib.login_methods.cas_auth import CasAuth
# maps = settings.cas_maps
# if not maps:
# table_user = self.table_user()
# maps = dict((name, lambda v, n=name: v.get(n, None)) for name in
# table_user.fields if name != 'id'
# and table_user[name].readable)
# maps['registration_id'] = \
# lambda v, p=settings.cas_provider: '%s/%s' % (p, v['user'])
# actions = [settings.cas_actions['login'],
# settings.cas_actions['servicevalidate'],
# settings.cas_actions['logout']]
# settings.login_form = CasAuth(
# casversion=2,
# urlbase=settings.cas_provider,
# actions=actions,
# maps=maps)
return self
def log_event(self, description, vars=None, origin='auth'):
"""
usage:
auth.log_event(description='this happened', origin='auth')
"""
if not self.settings.logging_enabled or not description:
return
elif self.is_logged_in():
user_id = self.user.id
else:
user_id = None # user unknown
vars = vars or {}
# log messages should not be translated
if type(description).__name__ == 'TElement':
description = description.m
self.table_event.insert(
description=str(description % vars),
origin=origin, user_id=user_id)
def get_or_create_user(self, keys, update_fields=['email'],
login=True, get=True):
"""
Used for alternate login methods:
If the user exists already then password is updated.
If the user doesn't yet exist, then they are created.
"""
#table_user = self.table_user()
user = None
checks = []
# make a guess about who this user is
for fieldname in ['registration_id', 'username', 'email']:
if fieldname in self.table_user.fields() and \
keys.get(fieldname, None):
checks.append(fieldname)
value = keys[fieldname]
user = self.table_user(**{fieldname: value})
if user:
break
if not checks:
return None
if not 'registration_id' in keys:
keys['registration_id'] = keys[checks[0]]
# if we think we found the user but registration_id does not match,
# make new user
if 'registration_id' in checks and user and user.registration_id \
and ('registration_id' not in keys or user.registration_id !=
str(keys['registration_id'])):
user = None # THINK MORE ABOUT THIS? DO WE TRUST OPENID PROVIDER?
if user:
if not get:
# added for register_bare to avoid overwriting users
return None
update_keys = dict(registration_id=keys['registration_id'])
for key in update_fields:
if key in keys:
update_keys[key] = keys[key]
user.update_record(**update_keys)
elif checks:
if not 'first_name' in keys and 'first_name' in \
self.table_user.fields:
guess = keys.get('email', 'anonymous').split('@')[0]
keys['first_name'] = keys.get('username', guess)
user_id = self.table_user.insert(
**self.table_user._filter_fields(keys))
user = self.table_user[user_id]
if self.settings.create_user_groups:
group_id = self.add_group(
self.settings.create_user_groups % user)
self.add_membership(group_id, user_id)
if self.settings.everybody_group_id:
self.add_membership(self.settings.everybody_group_id, user_id)
if login:
self.login_user(user)
return user
def basic(self, basic_auth_realm=False):
"""
perform basic login.
:param basic_auth_realm: optional basic http authentication realm.
:type basic_auth_realm: str or unicode or function or callable or boolean.
reads current.request.env.http_authorization
and returns basic_allowed,basic_accepted,user.
if basic_auth_realm is defined is a callable it's return value
is used to set the basic authentication realm, if it's a string
its content is used instead. Otherwise basic authentication realm
is set to the application name.
If basic_auth_realm is None or False (the default) the behavior
is to skip sending any challenge.
"""
import base64
if not self.settings.allow_basic_login:
return (False, False, False)
basic = request.env.http_authorization
if basic_auth_realm:
if callable(basic_auth_realm):
basic_auth_realm = basic_auth_realm()
elif isinstance(basic_auth_realm, (unicode, str)):
basic_realm = unicode(basic_auth_realm)
elif basic_auth_realm is True:
basic_realm = u'' + request.application
http_401 = HTTP(
401, u'Not Authorized',
**{'WWW-Authenticate': u'Basic realm="' + basic_realm + '"'})
if not basic or not basic[:6].lower() == 'basic ':
if basic_auth_realm:
raise http_401
return (True, False, False)
(username, sep, password) = base64.b64decode(basic[6:]).partition(':')
is_valid_user = sep and self.login_bare(username, password)
if not is_valid_user and basic_auth_realm:
raise http_401
return (True, True, is_valid_user)
def login_user(self, user):
"""
login the user = db.auth_user(id)
"""
user = Row(user)
for key, value in user.items():
if callable(value) or key == 'password':
delattr(user, key)
session.auth = sdict(
user=user,
last_visit=request.now,
expiration=self.settings.expiration,
hmac_key=uuid())
self.update_groups()
def _get_login_settings(self):
userfield = self.settings.login_userfield or 'username' \
if 'username' in self.table_user.fields else 'email'
passfield = self.settings.password_field
return sdict({"table_user": self.table_user,
"userfield": userfield,
"passfield": passfield})
def login_bare(self, username, password):
"""
logins user as specified by username (or email) and password
"""
settings = self._get_login_settings()
user = self.table_user(**{settings.userfield: username})
if user and user.get(settings.passfield, False):
password = self.table_user[settings.passfield].validate(
password)[0]
if not user.registration_key and password == \
user[settings.passfield]:
self.login_user(user)
return user
else:
# user not in database try other login methods
for login_method in self.settings.login_methods:
if login_method != self and \
login_method(username, password):
self.user = username
return username
return False
def register_bare(self, **fields):
"""
registers a user as specified by username (or email)
and a raw password.
"""
settings = self._get_login_settings()
if not fields.get(settings.passfield):
raise ValueError("register_bare: " +
"password not provided or invalid")
elif not fields.get(settings.userfield):
raise ValueError("register_bare: " +
"userfield not provided or invalid")
fields[settings.passfield] = \
self.table_user[settings.passfield].validate(
fields[settings.passfield])[0]
user = self.get_or_create_user(
fields, login=False, get=False,
update_fields=self.settings.update_fields)
if not user:
# get or create did not create a user (it ignores
# duplicate records)
return False
return user
def _login_with_handler(self, handler, env=None):
if not issubclass(handler, AuthLoginHandler):
raise RuntimeError('Provided handler for login is invalid')
settings = self.settings
passfield = settings.password_field
log = self.messages['login_log']
# redirect user if it's already logged in
if self.user:
redirect(settings.login_next)
handler = handler(self, env)
# use session for federated login
snext = self.get_vars_next()
if snext:
session._auth_next = snext
elif session._auth_next:
snext = session._auth_next
if handler.next is None:
unext = settings.login_next
if snext:
unext = snext
else:
unext = handler.next
#: init handler form if required
# note: we need to load the form before calling `get_user()`, as the
# handler could use the form itself to init the user var
loginform = None
if hasattr(handler, 'login_form'):
loginform = handler.login_form()
#: get user from handler
user = handler.get_user()
if user:
if not handler.store_password:
user[passfield] = None
if handler.create_user_onlogin:
user = self.get_or_create_user(
self.table_user._filter_fields(user),
settings.update_fields)
#: return form if required
elif loginform is not None:
return loginform
#: use external login url
else:
redirect(handler.login_url(unext))
#: process authenticated users
user = Row(self.table_user._filter_fields(user, id=True))
self.login_user(user)
#: use the right session expiration
session.auth.expiration = \
request.vars.get('remember', False) and \
settings.long_expiration or \
settings.expiration
session.auth.remember = 'remember' in request.vars
#: log login
self.log_event(log, user)
#: handler callback
handler.onsuccess()
#: clean session next
if unext == session._auth_next:
del session._auth_next
#: proceed
redirect(unext)