/usr/share/pyshared/zope/authentication/principal.py is in python-zope.authentication 3.7.1-3fakesync1.
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 | ##############################################################################
#
# Copyright (c) 2009 Zope Corporation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL 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.
#
##############################################################################
"""Principal source and helper function
$Id: principal.py 97941 2009-03-12 00:09:21Z nadako $
"""
from zope.browser.interfaces import ITerms
from zope.component import getUtility, queryNextUtility, adapts
from zope.interface import implements, Interface
from zope.schema.interfaces import ISourceQueriables
from zope.authentication.interfaces import IAuthentication, IPrincipalSource
from zope.authentication.interfaces import PrincipalLookupError
def checkPrincipal(context, principal_id):
"""An utility function to check if there's a principal for given principal id.
Raises ValueError when principal doesn't exists for given context and
principal id.
To test it, let's create and register a dummy authentication utility.
>>> class DummyUtility:
...
... implements(IAuthentication)
...
... def getPrincipal(self, id):
... if id == 'bob':
... return id
... raise PrincipalLookupError(id)
>>> from zope.component import provideUtility
>>> provideUtility(DummyUtility())
Now, let's the behaviour of this function.
>>> checkPrincipal(None, 'bob')
>>> checkPrincipal(None, 'dan')
Traceback (most recent call last):
...
ValueError: ('Undefined principal id', 'dan')
"""
auth = getUtility(IAuthentication, context=context)
try:
if auth.getPrincipal(principal_id):
return
except PrincipalLookupError:
pass
raise ValueError("Undefined principal id", principal_id)
class PrincipalSource(object):
"""Generic Principal Source"""
implements(IPrincipalSource, ISourceQueriables)
def __contains__(self, id):
"""Test for the existence of a user.
We want to check whether the system knows about a particular
principal, which is referenced via its id. The source will go through
the most local authentication utility to look for the
principal. Whether the utility consults other utilities to give an
answer is up to the utility itself.
First we need to create a dummy utility that will return a user, if
the id is 'bob'.
>>> class DummyUtility:
... implements(IAuthentication)
... def getPrincipal(self, id):
... if id == 'bob':
... return id
... raise PrincipalLookupError(id)
Let's register our dummy auth utility.
>>> from zope.component import provideUtility
>>> provideUtility(DummyUtility())
Now initialize the principal source and test the method
>>> source = PrincipalSource()
>>> 'jim' in source
False
>>> 'bob' in source
True
"""
auth = getUtility(IAuthentication)
try:
auth.getPrincipal(id)
except PrincipalLookupError:
return False
else:
return True
def getQueriables(self):
"""Returns an iteratable of queriables.
Queriables are responsible for providing interfaces to search for
principals by a set of given parameters (can be different for the
various queriables). This method will walk up through all of the
authentication utilities to look for queriables.
>>> class DummyUtility1:
... implements(IAuthentication)
... __parent__ = None
... def __repr__(self): return 'dummy1'
>>> dummy1 = DummyUtility1()
>>> class DummyUtility2:
... implements(ISourceQueriables, IAuthentication)
... __parent__ = None
... def getQueriables(self):
... return ('1', 1), ('2', 2), ('3', 3)
>>> dummy2 = DummyUtility2()
>>> class DummyUtility3(DummyUtility2):
... implements(IAuthentication)
... def getQueriables(self):
... return ('4', 4),
>>> dummy3 = DummyUtility3()
>>> from zope.component.nexttesting import testingNextUtility
>>> testingNextUtility(dummy1, dummy2, IAuthentication)
>>> testingNextUtility(dummy2, dummy3, IAuthentication)
>>> from zope.component import provideUtility
>>> provideUtility(dummy1)
>>> source = PrincipalSource()
>>> list(source.getQueriables())
[(u'0', dummy1), (u'1.1', 1), (u'1.2', 2), (u'1.3', 3), (u'2.4', 4)]
"""
i = 0
auth = getUtility(IAuthentication)
yielded = []
while True:
queriables = ISourceQueriables(auth, None)
if queriables is None:
yield unicode(i), auth
else:
for qid, queriable in queriables.getQueriables():
# ensure that we dont return same yielded utility more
# then once
if queriable not in yielded:
yield unicode(i)+'.'+unicode(qid), queriable
yielded.append(queriable)
auth = queryNextUtility(auth, IAuthentication)
if auth is None:
break
i += 1
class PrincipalTerms(object):
implements(ITerms)
adapts(IPrincipalSource, Interface)
def __init__(self, context, request):
self.context = context
def getTerm(self, principal_id):
if principal_id not in self.context:
raise LookupError(principal_id)
auth = getUtility(IAuthentication)
principal = auth.getPrincipal(principal_id)
if principal is None:
# TODO: is this a possible case?
raise LookupError(principal_id)
return PrincipalTerm(principal_id.encode('base64').strip().replace('=', '_'),
principal.title)
def getValue(self, token):
return token.replace('_', '=').decode('base64')
class PrincipalTerm(object):
def __init__(self, token, title):
self.token = token
self.title = title
|