/usr/share/pyshared/repoze/what/predicates.py is in python-repoze.what 1.0.9-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2007, Agendaless Consulting and Contributors.
# Copyright (c) 2008, Florent Aide <florent.aide@gmail.com>.
# Copyright (c) 2008-2009, Gustavo Narea <me@gustavonarea.net>.
# All Rights Reserved.
#
# This software is subject to the provisions of the BSD-like license at
# http://www.repoze.org/LICENSE.txt. A copy of the license should accompany
# this distribution. THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
# EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND
# FITNESS FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""
Built-in predicate checkers.
This is module provides the predicate checkers that were present in the
original "identity" framework of TurboGears 1, plus others.
"""
from paste.request import parse_formvars, parse_dict_querystring
__all__ = ['Predicate', 'CompoundPredicate', 'All', 'Any',
'has_all_permissions', 'has_any_permission', 'has_permission',
'in_all_groups', 'in_any_group', 'in_group', 'is_user',
'is_anonymous', 'not_anonymous', 'PredicateError',
'NotAuthorizedError']
#{ Predicates
class Predicate(object):
"""
Generic predicate checker.
This is the base predicate class. It won't do anything useful for you,
unless you subclass it.
"""
def __init__(self, msg=None):
"""
Create a predicate and use ``msg`` as the error message if it fails.
:param msg: The error message, if you want to override the default one
defined by the predicate.
:type msg: str
You may use the ``msg`` keyword argument with any predicate.
"""
if msg:
self.message = msg
def evaluate(self, environ, credentials):
"""
Raise an exception if the predicate is not met.
:param environ: The WSGI environment.
:type environ: dict
:param credentials: The :mod:`repoze.what` ``credentials`` dictionary
as a short-cut.
:type credentials: dict
:raise NotImplementedError: When the predicate doesn't define this
method.
:raises NotAuthorizedError: If the predicate is not met (use
:meth:`unmet` to raise it).
This is the method that must be overridden by any predicate checker.
For example, if your predicate is "The current month is the specified
one", you may define the following predicate checker::
from datetime import date
from repoze.what.predicates import Predicate
class is_month(Predicate):
message = 'The current month must be %(right_month)s'
def __init__(self, right_month, **kwargs):
self.right_month = right_month
super(is_month, self).__init__(**kwargs)
def evaluate(self, environ, credentials):
today = date.today()
if today.month != self.right_month:
# Raise an exception because the predicate is not met.
self.unmet()
.. versionadded:: 1.0.2
.. attention::
Do not evaluate predicates by yourself using this method. See
:meth:`check_authorization` and :meth:`is_met`.
.. warning::
To make your predicates thread-safe, keep in mind that they may
be instantiated at module-level and then shared among many threads,
so avoid predicates from being modified after their evaluation.
This is, the ``evaluate()`` method should not add, modify or
delete any attribute of the predicate.
"""
self.eval_with_environ(environ)
def _eval_with_environ(self, environ):
"""
Check whether the predicate is met.
:param environ: The WSGI environment.
:type environ: dict
:return: Whether the predicate is met or not.
:rtype: bool
:raise NotImplementedError: This must be defined by the predicate
itself.
.. deprecated:: 1.0.2
Only :meth:`evaluate` will be used as of :mod:`repoze.what` v2.
"""
raise NotImplementedError
def eval_with_environ(self, environ):
"""
Make sure this predicate is met.
:param environ: The WSGI environment.
:raises NotAuthorizedError: If the predicate is not met.
.. versionchanged:: 1.0.1
In :mod:`repoze.what`<1.0.1, this method returned a ``bool`` and
set the ``error`` instance attribute of the predicate to the
predicate message.
.. deprecated:: 1.0.2
Define :meth:`evaluate` instead.
"""
from warnings import warn
msg = 'Predicate._eval_with_environ(environ) is deprecated ' \
'for forward compatibility with repoze.what v2; define ' \
'Predicate.evaluate(environ, credentials) instead'
warn(msg, DeprecationWarning, stacklevel=2)
if not self._eval_with_environ(environ):
self.unmet()
def unmet(self, msg=None, **placeholders):
"""
Raise an exception because this predicate is not met.
:param msg: The error message to be used; overrides the predicate's
default one.
:type msg: str
:raises NotAuthorizedError: If the predicate is not met.
``placeholders`` represent the placeholders for the predicate message.
The predicate's attributes will also be taken into account while
creating the message with its placeholders.
For example, if you have a predicate that checks that the current
month is the specified one, where the predicate message is defined with
two placeholders as in::
The current month must be %(right_month)s and it is %(this_month)s
and the predicate has an attribute called ``right_month`` which
represents the expected month, then you can use this method as in::
self.unmet(this_month=this_month)
Then :meth:`unmet` will build the message using the ``this_month``
keyword argument and the ``right_month`` attribute as the placeholders
for ``this_month`` and ``right_month``, respectively. So, if
``this_month`` equals ``3`` and ``right_month`` equals ``5``,
the message for the exception to be raised will be::
The current month must be 5 and it is 3
If you have a context-sensitive predicate checker and thus you want
to change the error message on evaluation, you can call :meth:`unmet`
as::
self.unmet('%(this_month)s is not a good month',
this_month=this_month)
The exception raised would contain the following message::
3 is not a good month
.. versionadded:: 1.0.2
.. versionchanged:: 1.0.4
Introduced the ``msg`` argument.
.. attention::
This method should only be called from :meth:`evaluate`.
"""
if msg:
message = msg
else:
message = self.message
# Let's convert it into unicode because it may be just a class, as a
# Pylons' "lazy" translation message:
message = unicode(message)
# Include the predicate attributes in the placeholders:
all_placeholders = self.__dict__.copy()
all_placeholders.update(placeholders)
raise NotAuthorizedError(message % all_placeholders)
def check_authorization(self, environ):
"""
Evaluate the predicate and raise an exception if it's not met.
:param environ: The WSGI environment.
:raise NotAuthorizedError: If it the predicate is not met.
Example::
>>> from repoze.what.predicates import is_user
>>> environ = gimme_the_environ()
>>> p = is_user('gustavo')
>>> p.check_authorization(environ)
# ...
repoze.what.predicates.NotAuthorizedError: The current user must be "gustavo"
.. versionadded:: 1.0.4
Backported from :mod:`repoze.what` v2; deprecates
:func:`repoze.what.authorize.check_authorization`.
"""
logger = environ.get('repoze.who.logger')
credentials = environ.get('repoze.what.credentials', {})
try:
self.evaluate(environ, credentials)
except NotAuthorizedError, error:
logger and logger.info(u'Authorization denied: %s' % error)
raise
logger and logger.info('Authorization granted')
def is_met(self, environ):
"""
Find whether the predicate is met or not.
:param environ: The WSGI environment.
:return: Whether the predicate is met or not.
:rtype: bool
Example::
>>> from repoze.what.predicates import is_user
>>> environ = gimme_the_environ()
>>> p = is_user('gustavo')
>>> p.is_met(environ)
False
.. versionadded:: 1.0.4
Backported from :mod:`repoze.what` v2.
"""
credentials = environ.get('repoze.what.credentials', {})
try:
self.evaluate(environ, credentials)
return True
except NotAuthorizedError, error:
return False
def parse_variables(self, environ):
"""
Return the GET and POST variables in the request, as well as
``wsgiorg.routing_args`` arguments.
:param environ: The WSGI environ.
:return: The GET and POST variables and ``wsgiorg.routing_args``
arguments.
:rtype: dict
This is a handy method for request-sensitive predicate checkers.
It will return a dictionary for the POST and GET variables, as well as
the `wsgiorg.routing_args
<http://www.wsgi.org/wsgi/Specifications/routing_args>`_'s
``positional_args`` and ``named_args`` arguments, in the ``post``,
``get``, ``positional_args`` and ``named_args`` items (respectively) of
the returned dictionary.
For example, if the user submits a form using the POST method to
``http://example.com/blog/hello-world/edit_post?wysiwyg_editor=Yes``,
this method may return::
{
'post': {'new_post_contents': 'These are the new contents'},
'get': {'wysiwyg_editor': 'Yes'},
'named_args': {'post_slug': 'hello-world'},
'positional_args': (),
}
But note that the ``named_args`` and ``positional_args`` items depend
completely on how you configured the dispatcher.
.. versionadded:: 1.0.4
"""
get_vars = parse_dict_querystring(environ) or {}
try:
post_vars = parse_formvars(environ, False) or {}
except KeyError:
post_vars = {}
routing_args = environ.get('wsgiorg.routing_args', ([], {}))
positional_args = routing_args[0] or ()
named_args = routing_args[1] or {}
variables = {
'post': post_vars,
'get': get_vars,
'positional_args': positional_args,
'named_args': named_args}
return variables
class CompoundPredicate(Predicate):
"""A predicate composed of other predicates."""
def __init__(self, *predicates, **kwargs):
super(CompoundPredicate, self).__init__(**kwargs)
self.predicates = predicates
class Not(Predicate):
"""
Negate the specified predicate.
:param predicate: The predicate to be negated.
Example::
# The user *must* be anonymous:
p = Not(not_anonymous())
"""
message = u"The condition must not be met"
def __init__(self, predicate, **kwargs):
super(Not, self).__init__(**kwargs)
self.predicate = predicate
def evaluate(self, environ, credentials):
try:
self.predicate.evaluate(environ, credentials)
except NotAuthorizedError, error:
return
self.unmet()
class All(CompoundPredicate):
"""
Check that all of the specified predicates are met.
:param predicates: All of the predicates that must be met.
Example::
# Grant access if the current month is July and the user belongs to
# the human resources group.
p = All(is_month(7), in_group('hr'))
"""
def evaluate(self, environ, credentials):
"""
Evaluate all the predicates it contains.
:param environ: The WSGI environment.
:param credentials: The :mod:`repoze.what` ``credentials``.
:raises NotAuthorizedError: If one of the predicates is not met.
"""
for p in self.predicates:
p.evaluate(environ, credentials)
class Any(CompoundPredicate):
"""
Check that at least one of the specified predicates is met.
:param predicates: Any of the predicates that must be met.
Example::
# Grant access if the currest user is Richard Stallman or Linus
# Torvalds.
p = Any(is_user('rms'), is_user('linus'))
"""
message = u"At least one of the following predicates must be met: " \
"%(failed_predicates)s"
def evaluate(self, environ, credentials):
"""
Evaluate all the predicates it contains.
:param environ: The WSGI environment.
:param credentials: The :mod:`repoze.what` ``credentials``.
:raises NotAuthorizedError: If none of the predicates is met.
"""
errors = []
for p in self.predicates:
try:
p.evaluate(environ, credentials)
return
except NotAuthorizedError, exc:
errors.append(unicode(exc))
failed_predicates = ', '.join(errors)
self.unmet(failed_predicates=failed_predicates)
class is_user(Predicate):
"""
Check that the authenticated user's username is the specified one.
:param user_name: The required user name.
:type user_name: str
Example::
p = is_user('linus')
"""
message = u'The current user must be "%(user_name)s"'
def __init__(self, user_name, **kwargs):
super(is_user, self).__init__(**kwargs)
self.user_name = user_name
def evaluate(self, environ, credentials):
if credentials and \
self.user_name == credentials.get('repoze.what.userid'):
return
self.unmet()
class in_group(Predicate):
"""
Check that the user belongs to the specified group.
:param group_name: The name of the group to which the user must belong.
:type group_name: str
Example::
p = in_group('customers')
"""
message = u'The current user must belong to the group "%(group_name)s"'
def __init__(self, group_name, **kwargs):
super(in_group, self).__init__(**kwargs)
self.group_name = group_name
def evaluate(self, environ, credentials):
if credentials and self.group_name in credentials.get('groups'):
return
self.unmet()
class in_all_groups(All):
"""
Check that the user belongs to all of the specified groups.
:param groups: The name of all the groups the user must belong to.
Example::
p = in_all_groups('developers', 'designers')
"""
def __init__(self, *groups, **kwargs):
group_predicates = [in_group(g) for g in groups]
super(in_all_groups,self).__init__(*group_predicates, **kwargs)
class in_any_group(Any):
"""
Check that the user belongs to at least one of the specified groups.
:param groups: The name of any of the groups the user may belong to.
Example::
p = in_any_group('directors', 'hr')
"""
message = u"The member must belong to at least one of the following " \
"groups: %(group_list)s"
def __init__(self, *groups, **kwargs):
self.group_list = ", ".join(groups)
group_predicates = [in_group(g) for g in groups]
super(in_any_group,self).__init__(*group_predicates, **kwargs)
class is_anonymous(Predicate):
"""
Check that the current user is anonymous.
Example::
# The user must be anonymous!
p = is_anonymous()
.. versionadded:: 1.0.7
"""
message = u"The current user must be anonymous"
def evaluate(self, environ, credentials):
if credentials:
self.unmet()
class not_anonymous(Predicate):
"""
Check that the current user has been authenticated.
Example::
# The user must have been authenticated!
p = not_anonymous()
"""
message = u"The current user must have been authenticated"
def evaluate(self, environ, credentials):
if not credentials:
self.unmet()
class has_permission(Predicate):
"""
Check that the current user has the specified permission.
:param permission_name: The name of the permission that must be granted to
the user.
Example::
p = has_permission('hire')
"""
message = u'The user must have the "%(permission_name)s" permission'
def __init__(self, permission_name, **kwargs):
super(has_permission, self).__init__(**kwargs)
self.permission_name = permission_name
def evaluate(self, environ, credentials):
if credentials and \
self.permission_name in credentials.get('permissions'):
return
self.unmet()
class has_all_permissions(All):
"""
Check that the current user has been granted all of the specified
permissions.
:param permissions: The names of all the permissions that must be
granted to the user.
Example::
p = has_all_permissions('view-users', 'edit-users')
"""
def __init__(self, *permissions, **kwargs):
permission_predicates = [has_permission(p) for p in permissions]
super(has_all_permissions, self).__init__(*permission_predicates,
**kwargs)
class has_any_permission(Any):
"""
Check that the user has at least one of the specified permissions.
:param permissions: The names of any of the permissions that have to be
granted to the user.
Example::
p = has_any_permission('manage-users', 'edit-users')
"""
message = u"The user must have at least one of the following " \
"permissions: %(permission_list)s"
def __init__(self, *permissions, **kwargs):
self.permission_list = ", ".join(permissions)
permission_predicates = [has_permission(p) for p in permissions]
super(has_any_permission,self).__init__(*permission_predicates,
**kwargs)
#{ Exceptions
class PredicateError(Exception):
"""
Former exception raised by a :class:`Predicate` if it's not met.
.. deprecated:: 1.0.4
Deprecated in favor of :class:`NotAuthorizedError`, for forward
compatibility with :mod:`repoze.what` v2.
"""
# Ugly workaround for Python < 2.6:
if not hasattr(Exception, '__unicode__'):
def __unicode__(self):
return unicode(self.args and self.args[0] or '')
class NotAuthorizedError(PredicateError):
"""
Exception raised by :meth:`Predicate.check_authorization` if the subject
is not allowed to access the requested source.
This exception deprecates :class:`PredicateError` as of v1.0.4, but
extends it to avoid breaking backwards compatibility.
.. versionchanged:: 1.0.4
This exception was defined at :mod:`repoze.what.authorize` until
version 1.0.3, but is still imported into that module to keep backwards
compatibility with v1.X releases -- but it won't work in
:mod:`repoze.what` v2.
"""
pass
#}
|