python-zope.principalregistry 3.7.1-0ubuntu3 / usr / share / pyshared / zope / principalregistry / README.txt

This file is indexed.

/usr/share/pyshared/zope/principalregistry/README.txt is in python-zope.principalregistry 3.7.1-0ubuntu3.

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
===========================
Global principal definition
===========================

Global principals are defined via ZCML.  There are several kinds of
principals that can be defined.

Authenticated Users
-------------------

There are principals that can log in:

    >>> zcml("""
    ...    <configure xmlns="http://namespaces.zope.org/zope">
    ...
    ...      <principal
    ...         id="zope.manager"
    ...         title="Manager"
    ...         description="System Manager"
    ...         login="admin"
    ...         password_manager="SHA1"
    ...         password="40bd001563085fc35165329ea1ff5c5ecbdbbeef"
    ...         />
    ...
    ...    </configure>
    ... """)

    >>> import pprint
    >>> from zope.principalregistry.principalregistry import principalRegistry
    >>> [p] = principalRegistry.getPrincipals('')
    >>> p.id, p.title, p.description, p.getLogin(), p.validate('123')
    ('zope.manager', u'Manager', u'System Manager', u'admin', True)

The unauthenticated principal
-----------------------------

There is the unauthenticated principal:

    >>> zcml("""
    ...    <configure
    ...        xmlns="http://namespaces.zope.org/zope"
    ...        >
    ...
    ...      <unauthenticatedPrincipal
    ...         id="zope.unknown"
    ...         title="Anonymous user"
    ...         description="A person we don't know"
    ...         />
    ...
    ...    </configure>
    ... """)

    >>> p = principalRegistry.unauthenticatedPrincipal()
    >>> p.id, p.title, p.description
    ('zope.unknown', u'Anonymous user', u"A person we don't know")

The unauthenticated principal will also be registered as a utility.
This is to provide easy access to the data defined for the principal so
that other (more featureful) principal objects can be created for the
same principal.

    >>> from zope import component
    >>> from zope.authentication import interfaces
    >>> p = component.getUtility(interfaces.IUnauthenticatedPrincipal)
    >>> p.id, p.title, p.description
    ('zope.unknown', u'Anonymous user', u"A person we don't know")

The unauthenticated group
-------------------------

An unauthenticated group can also be defined in ZCML:

    >>> zcml("""
    ...    <configure
    ...        xmlns="http://namespaces.zope.org/zope"
    ...        >
    ...
    ...      <unauthenticatedGroup
    ...         id="zope.unknowngroup"
    ...         title="Anonymous users"
    ...         description="People we don't know"
    ...         />
    ...
    ...    </configure>
    ... """)

This directive creates a group and registers it as a utility providing
IUnauthenticatedGroup:

    >>> g = component.getUtility(interfaces.IUnauthenticatedGroup)
    >>> g.id, g.title, g.description
    ('zope.unknowngroup', u'Anonymous users', u"People we don't know")

The unauthenticatedGroup directive also updates the group of the
unauthenticated principal:

    >>> p = principalRegistry.unauthenticatedPrincipal()
    >>> g.id in p.groups
    True
    >>> p = component.getUtility(interfaces.IUnauthenticatedPrincipal)
    >>> g.id in p.groups
    True

If the unauthenticated principal is defined after the unauthenticated
group, it will likewise have the group added to it:

    >>> reset()
    >>> zcml("""
    ...    <configure xmlns="http://namespaces.zope.org/zope">
    ...
    ...      <unauthenticatedGroup
    ...         id="zope.unknowngroup2"
    ...         title="Anonymous users"
    ...         description="People we don't know"
    ...         />
    ...      <unauthenticatedPrincipal
    ...         id="zope.unknown2"
    ...         title="Anonymous user"
    ...         description="A person we don't know"
    ...         />
    ...
    ...    </configure>
    ... """)

    >>> g = component.getUtility(interfaces.IUnauthenticatedGroup)
    >>> g.id, g.title, g.description
    ('zope.unknowngroup2', u'Anonymous users', u"People we don't know")
    >>> p = principalRegistry.unauthenticatedPrincipal()
    >>> p.id, g.id in p.groups
    ('zope.unknown2', True)
    >>> p = component.getUtility(interfaces.IUnauthenticatedPrincipal)
    >>> p.id, g.id in p.groups
    ('zope.unknown2', True)

The unauthenticated group shows up as a principal in the principal
registry:

    >>> principalRegistry.getPrincipal(g.id) == g
    True

    >>> list(principalRegistry.getPrincipals("Anonymous")) == [g]
    True

The authenticated group
-----------------------

There is an authenticated group:

    >>> reset()
    >>> zcml("""
    ...    <configure xmlns="http://namespaces.zope.org/zope">
    ...
    ...      <unauthenticatedPrincipal
    ...         id="zope.unknown3"
    ...         title="Anonymous user"
    ...         description="A person we don't know"
    ...         />
    ...      <principal
    ...         id="zope.manager2"
    ...         title="Manager"
    ...         description="System Manager"
    ...         login="admin"
    ...         password="123"
    ...         />
    ...      <authenticatedGroup
    ...         id="zope.authenticated"
    ...         title="Authenticated users"
    ...         description="People we know"
    ...         />
    ...      <principal
    ...         id="zope.manager3"
    ...         title="Manager 3"
    ...         login="admin3"
    ...         password="123"
    ...         />
    ...
    ...    </configure>
    ... """)

It defines an IAuthenticatedGroup utility:

    >>> g = component.getUtility(interfaces.IAuthenticatedGroup)
    >>> g.id, g.title, g.description
    ('zope.authenticated', u'Authenticated users', u'People we know')

It also adds it self to the groups of any non-group principals already
defined, and, when non-group principals are defined, they put
themselves in the group if it's defined:

    >>> principals = list(principalRegistry.getPrincipals(''))
    >>> principals.sort(lambda p1, p2: cmp(p1.id, p2.id))
    >>> for p in principals:
    ...    print p.id, p.groups == [g.id]
    zope.authenticated False
    zope.manager2 True
    zope.manager3 True

Excluding unauthenticated principals, of course:

    >>> p = principalRegistry.unauthenticatedPrincipal()
    >>> p.id, g.id in p.groups
    ('zope.unknown3', False)
    >>> p = component.getUtility(interfaces.IUnauthenticatedPrincipal)
    >>> p.id, g.id in p.groups
    ('zope.unknown3', False)


The everybody group
-------------------

Finally, there is an everybody group:

    >>> reset()
    >>> zcml("""
    ...    <configure xmlns="http://namespaces.zope.org/zope">
    ...
    ...      <unauthenticatedPrincipal
    ...         id="zope.unknown4"
    ...         title="Anonymous user"
    ...         description="A person we don't know"
    ...         />
    ...      <principal
    ...         id="zope.manager4"
    ...         title="Manager"
    ...         description="System Manager"
    ...         login="admin"
    ...         password="123"
    ...         />
    ...      <everybodyGroup
    ...         id="zope.everybody"
    ...         title="Everybody"
    ...         description="All People"
    ...         />
    ...      <principal
    ...         id="zope.manager5"
    ...         title="Manager 5"
    ...         login="admin5"
    ...         password="123"
    ...         />
    ...
    ...    </configure>
    ... """)

The everybodyGroup directive defines an IEveryoneGroup utility:

    >>> g = component.getUtility(interfaces.IEveryoneGroup)
    >>> g.id, g.title, g.description
    ('zope.everybody', u'Everybody', u'All People')

It also adds it self to the groups of any non-group principals already
defined, and, when non-group principals are defined, they put
themselves in the group if it's defined:

    >>> principals = list(principalRegistry.getPrincipals(''))
    >>> principals.sort(lambda p1, p2: cmp(p1.id, p2.id))
    >>> for p in principals:
    ...    print p.id, p.groups == [g.id]
    zope.everybody False
    zope.manager4 True
    zope.manager5 True

Including unauthenticated principals, of course:

    >>> p = principalRegistry.unauthenticatedPrincipal()
    >>> p.id, g.id in p.groups
    ('zope.unknown4', True)
    >>> p = component.getUtility(interfaces.IUnauthenticatedPrincipal)
    >>> p.id, g.id in p.groups
    ('zope.unknown4', True)

Note that it is up to IAuthentication implementations to associate
these groups with their principals, as appropriate.


The system_user
---------------

There is also a system_user that is defined in the code.  It will be returned
from the getPrincipal method of the registry.

    >>> import zope.security.management
    >>> import zope.principalregistry.principalregistry
    >>> auth = zope.principalregistry.principalregistry.PrincipalRegistry()
    >>> system_user = auth.getPrincipal(u'zope.security.management.system_user')
    >>> system_user is zope.security.management.system_user
    True

APT Browse - Built by Thomas Orozco.