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
|
import datetime
from authkit.users import *
from paste.util.import_string import eval_import
"""
def authkit_get_conn(mode='write'):
return g.pool.connection()
def authkit_release_conn(conn):
conn.close()
"""
class UsersDriver(Users):
"""
Raw SQL Version
"""
api_version = 0.4
def __init__(self, environ, data, encrypt=None):
if encrypt is None:
def encrypt(password):
return password
self.encrypt = encrypt
if isinstance(data, (str, unicode)):
data_parts = data.split('\n')
data = []
if len(data_parts) == 2:
data.append(eval_import(data_parts[0].strip()))
data.append(eval_import(data_parts[1].strip()))
else:
raise AuthKitError(
"Expected two lines in the user configuration, not %s"%(
len(data_parts)
)
)
self.get_conn, self.release_conn = data
self.environ = environ
def create_tables(self):
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute("""
-- DROP TABLE groups;
-- DROP TABLE roles;
-- DROP TABLE users;
-- DROP TABLE users_roles;
CREATE TABLE groups (
uid serial UNIQUE NOT NULL,
name character varying(255) UNIQUE NOT NULL
);
CREATE TABLE roles (
uid serial UNIQUE NOT NULL,
name character varying(255) UNIQUE NOT NULL
);
CREATE TABLE users (
uid serial UNIQUE NOT NULL,
username character varying(255) UNIQUE NOT NULL,
password character varying(255) NOT NULL,
group_uid integer REFERENCES groups (uid)
);
CREATE TABLE users_roles (
uid serial UNIQUE NOT NULL,
user_uid integer REFERENCES users (uid),
role_uid integer REFERENCES roles (uid)
);
""")
conn.commit()
cursor.close()
self.release_conn(conn)
# Create Methods
def user_create(self, username, password, group=None):
"""
Create a new user with the username, password and group name specified.
"""
if ' ' in username:
raise AuthKitError("Usernames cannot contain space characters")
if self.user_exists(username):
raise AuthKitError("User %r already exists"%username)
if group is not None and not self.group_exists(group):
raise AuthKitNoSuchGroupError(
"There is no such group %r"%group
)
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT uid FROM groups WHERE name=%s
""",
(group.lower(),)
)
group_uid = cursor.fetchall()[0][0]
cursor.execute(
"""
INSERT INTO users (username, password, group_uid) VALUES (%s, %s, %s)
""",
(username, self.encrypt(password), group_uid)
)
conn.commit()
cursor.close()
self.release_conn(conn)
def role_create(self, role):
"""
Add a new role to the system
"""
if ' ' in role:
raise AuthKitError("Roles cannot contain space characters")
if self.role_exists(role):
raise AuthKitError("Role %r already exists"%role)
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
INSERT INTO roles (name) VALUES (%s)
""",
(role.lower(),)
)
conn.commit()
cursor.close()
self.release_conn(conn)
def group_create(self, group):
"""
Add a new group to the system
"""
if ' ' in group:
raise AuthKitError("Groups cannot contain space characters")
if self.group_exists(group):
raise AuthKitError("Group %r already exists"%group)
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
INSERT INTO groups (name) VALUES (%s)
""",
(group.lower(),)
)
conn.commit()
cursor.close()
self.release_conn(conn)
# Delete Methods
def user_delete(self, username):
"""
Remove the user with the specified username
"""
if not self.user_exists(username.lower()):
raise AuthKitError("There is no such user %r"%username)
else:
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
DELETE FROM users WHERE username=%s
""",
(username.lower(),)
)
conn.commit()
cursor.close()
self.release_conn(conn)
def role_delete(self, role):
"""
Remove the role specified. Rasies an exception if the role is still in use.
To delete the role and remove it from all existing users use
``role_delete_cascade()``
"""
if not self.role_exists(role.lower()):
raise AuthKitError("There is no such role %r"%role)
else:
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT count(name) FROM users_roles
LEFT OUTER JOIN roles ON users_roles.role_uid = roles.uid
WHERE roles.name=%s
""",
(role.lower(),)
)
if cursor.fetchall()[0][0] > 0:
raise AuthKitError("The role is still being used and therefore cannot be deleted"%(role.lower()))
cursor.execute(
"""
DELETE FROM roles WHERE name=%s
""",
(role.lower(),)
)
conn.commit()
cursor.close()
self.release_conn(conn)
def group_delete(self, group):
"""
Remove the group specified. Rasies an exception if the group is still in use.
To delete the group and remove it from all existing users use ``group_delete_cascade()``
"""
if not self.group_exists(group.lower()):
raise AuthKitError("There is no such group %r"%group)
else:
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT count(group_uid) FROM users
LEFT OUTER JOIN groups ON users.group_uid = groups.uid
WHERE groups.name=%s
""",
(group.lower(),)
)
if cursor.fetchall()[0][0] > 0:
raise AuthKitError("The group %r is still being used and therefore cannot be deleted"%(group.lower()))
cursor.execute(
"""
DELETE FROM groups WHERE name=%s
""",
(group.lower(),)
)
conn.commit()
cursor.close()
self.release_conn(conn)
# Existence Methods
def user_exists(self, username):
"""
Returns ``True`` if a user exists with the given username, ``False``
otherwise. Usernames are case insensitive.
"""
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT count(username) FROM users WHERE username=%s
""",
(username.lower(),)
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return rows[0][0] > 0
def role_exists(self, role):
"""
Returns ``True`` if the role exists, ``False`` otherwise. Roles are
case insensitive.
"""
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT count(name) FROM roles WHERE name=%s
""",
(role.lower(),)
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return rows[0][0] > 0
def group_exists(self, group):
"""
Returns ``True`` if the group exists, ``False`` otherwise. Groups
are case insensitive.
"""
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT count(name) FROM groups WHERE name=%s
""",
(group.lower(),)
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return rows[0][0] > 0
# List Methods
def list_roles(self):
"""
Returns a lowercase list of all roll names ordered alphabetically
"""
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT name FROM roles ORDER BY name
""",
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return [row[0] for row in rows]
def list_users(self):
"""
Returns a lowecase list of all usernames ordered alphabetically
"""
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT username FROM users ORDER BY username
""",
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return [row[0] for row in rows]
def list_groups(self):
"""
Returns a lowercase list of all groups ordered alphabetically
"""
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT name FROM groups ORDER BY name
""",
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return [row[0] for row in rows]
# User Methods
def user(self, username):
"""
Returns a dictionary in the following format:
.. code-block :: Python
{
'username': username,
'group': group,
'password': password,
'roles': [role1,role2,role3... etc]
}
Role names are ordered alphabetically
Raises an exception if the user doesn't exist.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT username, name, password FROM users
LEFT OUTER JOIN groups on users.group_uid=groups.uid
WHERE users.username=%s
ORDER BY username
""",
(username.lower(),)
)
rows = cursor.fetchall()[0]
cursor.close()
self.release_conn(conn)
return {
'username': rows[0],
'group': rows[1],
'password': rows[2],
'roles': self.user_roles(username)
}
def user_roles(self, username):
"""
Returns a list of all the role names for the given username ordered
alphabetically. Raises an exception if the username doesn't exist.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT roles.name FROM users_roles
JOIN users on users.uid = users_roles.user_uid
JOIN roles on users_roles.role_uid = roles.uid
WHERE users.username=%s
ORDER BY roles.name
""",
(username.lower(),)
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return [x[0] for x in rows]
def user_group(self, username):
"""
Returns the group associated with the user or ``None`` if no group is
associated. Raises an exception is the user doesn't exist.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT groups.name FROM groups
LEFT OUTER JOIN users on users.group_uid = groups.uid
WHERE users.username=%s
ORDER BY groups.name
""",
(username.lower(),)
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return rows[0][0]
def user_password(self, username):
"""
Returns the password associated with the user or ``None`` if no
password exists. Raises an exception is the user doesn't exist.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT password FROM users
WHERE username=%s
""",
(username.lower(),)
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return rows[0][0]
def user_has_role(self, username, role):
"""
Returns ``True`` if the user has the role specified, ``False``
otherwise. Raises an exception if the user doesn't exist.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
if not self.role_exists(role.lower()):
raise AuthKitNoSuchRoleError("No such role %r"%role.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT count(users_roles.role_uid) FROM users_roles
LEFT OUTER JOIN users on users.uid = users_roles.user_uid
LEFT OUTER JOIN roles on users_roles.role_uid = roles.uid
WHERE roles.name=%s and users.username = %s
""",
(role.lower(), username.lower())
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return rows[0][0] > 0
def user_has_group(self, username, group):
"""
Returns ``True`` if the user has the group specified, ``False``
otherwise. The value for ``group`` can be ``None`` to test that
the user doesn't belong to a group. Raises an exception if the
user doesn't exist.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
if group is not None and not self.group_exists(group.lower()):
raise AuthKitNoSuchGroupError("No such group %r"%group.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT groups.name FROM users
LEFT OUTER JOIN groups on users.group_uid = groups.uid
WHERE groups.name=%s and users.username = %s
""",
(group.lower(), username.lower())
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
if rows:
group_ = rows[0][0]
else:
return False
if group is None:
if group_ == None:
return True
else:
if group is not None and group_ == group.lower():
return True
return False
def user_has_password(self, username, password):
"""
Returns ``True`` if the user has the password specified, ``False``
otherwise. Passwords are case sensitive. Raises an exception if the
user doesn't exist.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT password FROM users
WHERE username = %s
""",
(username.lower(),)
)
rows = cursor.fetchall()
cursor.close()
self.release_conn(conn)
return rows[0][0] == self.encrypt(password)
def user_set_username(self, username, new_username):
"""
Sets the user's username to the lowercase of new_username.
Raises an exception if the user doesn't exist or if there is already
a user with the username specified by ``new_username``.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
if self.user_exists(new_username.lower()):
raise AuthKitError(
"A user with the username %r already exists"%username.lower()
)
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
UPDATE users SET username=%s WHERE username=%s
""",
(new_username.lower(), username.lower())
)
cursor.close()
conn.commit()
self.release_conn(conn)
def user_set_group(self, username, group, auto_add_group=False):
"""
Sets the user's group to the lowercase of ``group`` or ``None``. If
the group doesn't exist and ``add_if_necessary`` is ``True`` the
group will also be added. Otherwise an ``AuthKitNoSuchGroupError``
will be raised. Raises an exception if the user doesn't exist.
"""
if group is None:
return self.user_remove_group(username)
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
if not self.group_exists(group.lower()):
if auto_add_group:
self.group_create(group.lower())
else:
raise AuthKitNoSuchGroupError("No such group %r"%group.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT uid FROM groups WHERE name=%s
""",
(group.lower(),)
)
group_uid = cursor.fetchall()[0][0]
cursor.execute(
"""
UPDATE users SET group_uid=%s WHERE username=%s
""",
(group_uid, username.lower())
)
cursor.close()
conn.commit()
self.release_conn(conn)
def user_add_role(self, username, role, auto_add_role=False):
"""
Sets the user's role to the lowercase of ``role``. If the role doesn't
exist and ``add_if_necessary`` is ``True`` the role will also be
added. Otherwise an ``AuthKitNoSuchRoleError`` will be raised. Raises
an exception if the user doesn't exist.
"""
if self.user_has_role(username, role):
return
if not self.role_exists(role.lower()):
if auto_add_role:
self.role_create(role.lower())
else:
raise AuthKitNoSuchRoleError("No such role %r"%role.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT uid FROM users WHERE username=%s
""",
(username.lower(),)
)
user_uid = cursor.fetchall()[0][0]
cursor.execute(
"""
SELECT uid FROM roles WHERE name=%s
""",
(role.lower(),)
)
role_uid = cursor.fetchall()[0][0]
cursor.execute(
"""
INSERT INTO users_roles (user_uid, role_uid) VALUES (%s, %s);
""",
(user_uid, role_uid)
)
cursor.close()
conn.commit()
self.release_conn(conn)
def user_remove_role(self, username, role):
"""
Removes the role from the user specified by ``username``. Raises
an exception if the user doesn't exist.
"""
if not self.user_has_role(username, role):
raise AuthKitError(
"No role %r found for user %r"%(role.lower(), username.lower())
)
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
SELECT uid FROM users WHERE username=%s
""",
(username.lower(),)
)
user_uid = cursor.fetchall()[0][0]
cursor.execute(
"""
SELECT uid FROM roles WHERE name=%s
""",
(role.lower(),)
)
role_uid = cursor.fetchall()[0][0]
cursor.execute(
"""
DELETE FROM users_roles WHERE user_uid=%s and role_uid=%s;
""",
(user_uid, role_uid)
)
cursor.close()
conn.commit()
self.release_conn(conn)
def user_remove_group(self, username):
"""
Sets the group to ``None`` for the user specified by ``username``.
Raises an exception if the user doesn't exist.
"""
if not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
conn = self.get_conn()
cursor = conn.cursor()
cursor.execute(
"""
UPDATE users SET group_uid=%s WHERE username=%s
""",
(None, username.lower())
)
cursor.close()
conn.commit()
self.release_conn(conn)
|
