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
|
from paste.util.import_string import eval_import
from authkit.users import *
from sqlalchemy import types, ForeignKey, Table, Column, types
from sqlalchemy.orm import mapper, relation
def setup_model(model, metadata, **p):
class User(object):
def __init__(
self,
username,
uid=None,
password=None,
group_uid=None,
):
self.uid = uid
self.username = username
self.password = password
self.group_uid = group_uid
def __repr__(self):
return "User(%(username)s)" % self.__dict__
model.User = User
class Group(object):
def __init__(self, name=None):
self.name = name
def __repr__(self):
return "Group(%(name)s)" % self.__dict__
model.Group = Group
class Role(object):
def __init__(self, name=None):
self.name = name
def __repr__(self):
return "Role(%(name)s)" % self.__dict__
model.Role = Role
# Tables
model.groups_table = Table(
"groups",
metadata,
Column("uid", types.Integer, primary_key=True),
Column("name", types.String(255), unique=True, nullable=False),
)
model.roles_table = Table(
"roles",
metadata,
Column("uid", types.Integer, primary_key=True),
Column("name", types.String(255), unique=True, nullable=False),
)
model.users_table = Table(
"users",
metadata,
Column("uid", types.Integer, primary_key=True),
Column("username", types.String(255), unique=True, nullable=False),
Column("password", types.String(255), nullable=False),
Column("group_uid", types.Integer, ForeignKey("groups.uid")),
)
model.users_roles_table = Table( # many:many relation table
"users_roles",
metadata,
Column("user_uid", types.Integer, ForeignKey("users.uid")),
Column("role_uid", types.Integer, ForeignKey("roles.uid")),
)
model.groups_mapper = mapper(
Group,
model.groups_table,
properties={
"users": relation(User)
}
)
model.users_mapper = mapper(
User,
model.users_table,
properties={
"roles": relation(Role, lazy=True, secondary=model.users_roles_table),
"group": relation(Group),
}
)
model.roles_mapper = mapper(
Role,
model.roles_table,
properties={
"users": relation(User, lazy=True, secondary=model.users_roles_table)
}
)
class UsersFromDatabase(Users):
"""
Database Version
"""
api_version = 0.4
def __init__(self, environ, data=None, encrypt=None):
if encrypt is None:
def encrypt(password):
return password
self.encrypt = encrypt
self.environ = environ
if not environ.has_key('sqlalchemy.model') or not environ.has_key('sqlalchemy.session'):
raise AuthKitError("The required SQLAlchemyManager middleware is not present")
self.model = environ['sqlalchemy.model']
# This object is set up on each request so we can assign the session
self.session = environ['sqlalchemy.session']
self.autoflush = False
# 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 None:
new_user = self.model.User(
username=username.lower(),
password=self.encrypt(password)
)
else:
if not self.group_exists(group):
raise AuthKitNoSuchGroupError(
"There is no such group %r"%group
)
new_user = self.model.User(
username=username.lower(),
password=self.encrypt(password),
group_uid=self.session.query(self.model.Group).filter_by(name=group.lower()).one().uid
)
self.session.save(new_user)
if self.autoflush:
self.session.flush()
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)
new_role = self.model.Role(role.lower())
self.session.save(new_role)
if self.autoflush:
self.session.flush()
#~ new_role2 = self.model.Role("test")
#~ #new_role2.flush()
#~ from pysqlite2 import dbapi2 as sqlite
#~ conn = sqlite.connect("mydb.db")
#~ cur = conn.cursor()
#~ cur.execute("SELECT * FROM roles;")
#~ raise Exception(cur.fetchall(), self.model.Role.get(1))
#~ raise Exception([repr(obj) for obj in self.model.ctx.current], self.model.ctx.current.identity_map.values())
#~ self.model.ctx.current.flush()
#~ raise Exception([u.name for u in self.model.Role.select(order_by=self.model.Role.c.name)])
#new_role.flush()
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)
new_group = self.model.Group(group.lower())
self.session.save(new_group)
if self.autoflush:
self.session.flush()
# Delete Methods
def user_delete(self, username):
"""
Remove the user with the specified username
"""
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
if not user:
raise AuthKitNoSuchUserError("There is no such user %r"%username)
else:
self.session.delete(user)
if self.autoflush:
session.flush()
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()``
"""
role = self.session.query(self.model.Role).filter_by(name=role.lower()).one()
if not role:
raise AuthKitNoRoleUserError("There is no such role %r"%role)
else:
self.session.delete(role)
if self.autoflush:
self.session.flush()
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()``
"""
group = self.session.query(self.model.Group).filter_by(name=group.lower()).one()
if not group:
raise AuthKitNoGroupUserError("There is no such group %r"%group)
else:
self.session.delete(group)
if self.autoflush:
session.flush()
#~ # Delete Cascade Methods
#~ def role_delete_cascade(self, role):
#~ """
#~ Remove the role specified and remove the role from any users who used it
#~ """
#~ raise AuthKitNotSupportedError(
#~ "The %s implementation of the User Management API doesn't support this method"%(
#~ self.__class__.__name__
#~ )
#~ )
#~ def group_delete_cascade(self, group):
#~ """
#~ Remove the group specified and remove the group from any users who used it
#~ """
#~ raise AuthKitNotSupportedError(
#~ "The %s implementation of the User Management API doesn't support this method"%(
#~ self.__class__.__name__
#~ )
#~ )
# Existence Methods
def user_exists(self, username):
"""
Returns ``True`` if a user exists with the given username, ``False``
otherwise. Usernames are case insensitive.
"""
user = self.session.query(self.model.User).filter_by(username=username.lower()).all()
if user:
return True
return False
def role_exists(self, role):
"""
Returns ``True`` if the role exists, ``False`` otherwise. Roles are
case insensitive.
"""
role = self.session.query(self.model.Role).filter_by(name=role.lower()).all()
if role:
return True
return False
def group_exists(self, group):
"""
Returns ``True`` if the group exists, ``False`` otherwise. Groups
are case insensitive.
"""
group = self.session.query(self.model.Group).filter_by(name=group.lower()).all()
if group:
return True
return False
# List Methods
def list_roles(self):
"""
Returns a lowercase list of all roll names ordered alphabetically
"""
return [r.name for r in self.session.query(self.model.Role).order_by(self.model.roles_table.c.name).all()]
def list_users(self):
"""
Returns a lowecase list of all usernames ordered alphabetically
"""
return [u.username for u in self.session.query(self.model.User).order_by(self.model.users_table.c.username).all()]
def list_groups(self):
"""
Returns a lowercase list of all groups ordered alphabetically
"""
return [g.name for g in self.session.query(self.model.Group).order_by(self.model.groups_table.c.name).all()]
# 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]
}
The 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())
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
roles = [r.name for r in user.roles]
roles.sort()
return {
'username': user.username,
'group': user.group and user.group.name or None,
'password': user.password,
'roles': roles
}
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())
roles = [r.name for r in self.session.query(self.model.User).filter_by(username=username.lower()).one().roles]
roles.sort()
return roles
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())
return self.session.query(self.model.User).filter_by(username=username.lower()).one().group.name
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())
return self.session.query(self.model.User).filter_by(username=username.lower()).one().password
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())
for role_ in self.session.query(self.model.User).filter_by(username=username.lower()).one().roles:
if role_.name == role.lower():
return True
return False
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())
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
if user.group is None:
if group == None:
return True
else:
if group is not None and user.group.name == 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())
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
if user.password == self.encrypt(password):
return True
return False
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()
)
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
user.username = new_username.lower()
if self.autoflush:
self.session.flush()
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 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())
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
user.group = self.session.query(self.model.Group).filter_by(name=group.lower()).one()
if self.autoflush:
self.session.flush()
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 not self.user_exists(username.lower()):
raise AuthKitNoSuchUserError("No such user %r"%username.lower())
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())
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
role = self.session.query(self.model.Role).filter_by(name=role.lower()).one()
user.roles.append(role)
if self.autoflush:
self.session.flush()
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())
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
user.group = None
if self.autoflush:
self.session.flush()
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_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())
user = self.session.query(self.model.User).filter_by(username=username.lower()).one()
for role_ in user.roles:
if role_.name == role.lower():
user.roles.pop(user.roles.index(role_))
if self.autoflush:
self.session.flush()
return
raise AuthKitError(
"No role %r found for user %r"%(role.lower(), username.lower())
)
|