Global principal registry component for Zope3
Project description
zope.principalregistry README
This package provides an authentication utility for zope.authentication that uses simple non-persistent principal registry.
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 = sorted(principalRegistry.getPrincipals(''), ... key=lambda p: p.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 = sorted(principalRegistry.getPrincipals(''), ... key=lambda p: p.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
Changes
4.0.0 (2014-12-24)
Add support for PyPy. (PyPy3 is pending release of a fix for: https://bitbucket.org/pypy/pypy/issue/1946)
Add support for Python 3.4.
Add support for testing under Travis.
4.0.0a2 (2013-03-03)
Make sure that the password is always bytes when passed into the principal registry.
Fix deprecation warnings.
4.0.0a1 (2013-02-22)
Add support for Python 3.3.
Replace deprecated zope.interface.implements usage with equivalent zope.interface.implementer decorator.
Dropd support for Python 2.4 and 2.5.
3.7.1 (2010-09-25)
Add test extra to declare test dependency on zope.component [test].
Use Python’s doctest module instead of depreacted zope.testing.doctest.
3.7.0 (2009-03-14)
Remove zope.container dependency, as contained principals didn’t make any sense, since PrincipalRegistry never provided IContainer. Also, zope.container pulls a number dependencies, that are not needed for non-persistent principal registry (like, ZCML, for example).
Set __name__ and __parent__ by hand to provide some backward-compatibility and to save a pointer to registry from principal objects.
Initial release. This package was splitted from zope.app.security as a part of the refactoring process to provide global principal registry without extra dependencies.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for zope.principalregistry-4.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96c4e79fc47f7aacb34f292dd47d2f70483ec53e080a7bdad555c7e451d549ef |
|
MD5 | c4de04558e567dde268095f15a940638 |
|
BLAKE2b-256 | c0ecbc77a99803509605c66d652d6d60208a1a728644d3a35f989ddd5999757b |