[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces/security - __init__.py:1.1.2.3
Tim Peters
tim.one@comcast.net
Tue, 24 Dec 2002 21:21:36 -0500
Update of /cvs-repository/Zope3/src/zope/app/interfaces/security
In directory cvs.zope.org:/tmp/cvs-serv19240/src/zope/app/interfaces/security
Modified Files:
Tag: NameGeddon-branch
__init__.py
Log Message:
Whitespace normalization, via Python's Tools/scripts/reindent.py. The
files are fixed-points of that script now. Fixed a few cases where
code relied on significant trailing whitespace (ouch).
=== Zope3/src/zope/app/interfaces/security/__init__.py 1.1.2.2 => 1.1.2.3 ===
--- Zope3/src/zope/app/interfaces/security/__init__.py:1.1.2.2 Mon Dec 23 17:22:37 2002
+++ Zope3/src/zope/app/interfaces/security/__init__.py Tue Dec 24 21:20:36 2002
@@ -25,7 +25,7 @@
security assertions (e.g. role or permission
assignments) about principals.
"""
-
+
def getDescription():
"""Return a description of the principal."""
@@ -40,19 +40,19 @@
This is implemented by performing protocol-specific actions,
such as issuing challenges or providing login interfaces.
-
+
IAuthenticationService objects are used to implement
authentication services. Because they implement services, they are
expected to collaborate with services in other contexts. Client
code doesn't search a context and call multiple services. Instead,
client code will call the most specific service in a place and
rely on the service to delegate to other services as necessary.
-
+
The interface doesn't include methods for data
management. Services may use external data and not allow
management in Zope. Simularly, the data to be managed may vary
with different implementations of a service.
- """
+ """
def authenticate(request):
"""Identify a principal for a request.
@@ -85,26 +85,26 @@
def unauthenticatedPrincipal():
"""Return the unauthenticated principal, if one is defined.
-
+
Return None if no unauthenticated principal is defined.
The unauthenticated principal must be an IUnauthenticatedPrincipal.
"""
-
+
def unauthorized(id, request):
"""Signal an authorization failure.
-
+
This method is called when an auhorization problem
occurs. It can perform a variety of actions, such
as issuing an HTTP authentication challenge or
displaying a login interface.
-
+
Note that the authentication service nearest to the
requested resource is called. It is up to
authentication service implementations to
colaborate with services higher in the object
hierarchy.
-
+
If no principal has been identified, id will be
None.
"""
@@ -138,13 +138,13 @@
to discover the login/password passed from the user, or to
indicate that a login is required.
"""
-
+
def getLogin():
"""Return login name, or None if no login name found."""
def getPassword():
"""Return password, or None if no login name found.
-
+
If there's a login but no password, return empty string.
"""
@@ -206,7 +206,7 @@
class IPermissionService(Interface):
"""Manage information about permissions
-
+
'IPermissionService' objects are used to implement
permission-definition services. Because they implement services,
they are expected to collaborate with services in other
@@ -243,7 +243,7 @@
def getPrincipalsForRole(role_id):
"""Get the principals that have been granted a role.
- Return the list of (principal, setting) who have been assigned or
+ Return the list of (principal, setting) who have been assigned or
removed from a role.
If no principals have been assigned this role,
@@ -253,7 +253,7 @@
def getRolesForPrincipal(principal_id):
"""Get the roles granted to a principal.
- Return the list of (role, setting) assigned or removed from
+ Return the list of (role, setting) assigned or removed from
this principal.
If no roles have been assigned to
@@ -272,7 +272,7 @@
role, principal, and setting, in that order.
"""
-
+
class IPrincipalRoleManager(IPrincipalRoleMap):
"""Management interface for mappings between principals and roles."""
@@ -285,8 +285,8 @@
""" remove a role from the principal """
def unsetRoleForPrincipal(role_id, principal_id):
- """ unset the role for the principal
- """
+ """ unset the role for the principal
+ """
class IRolePermissionMap(Interface):
@@ -309,7 +309,7 @@
permission.
If no roles have been granted this permission, then the empty list is
- returned.
+ returned.
"""
def getSetting(permission_id, role_id):
@@ -324,7 +324,7 @@
The settings are returned as a sequence of permission, role,
setting tuples.
- If no principal/role assertions have been made here, then the empty
+ If no principal/role assertions have been made here, then the empty
list is returned.
"""
@@ -356,7 +356,7 @@
security assertions for this permission.
If no principals have been set for this permission, then the empty
- list is returned.
+ list is returned.
"""
def getPermissionsForPrincipal(principal_id):
@@ -366,21 +366,21 @@
security assertions for this principal.
If no permissions have been set for this principal, then the empty
- list is returned.
+ list is returned.
"""
-
- def getSetting(permission_id, principal_id):
+
+ def getSetting(permission_id, principal_id):
"""Get the setting for a permission and principal.
Get the setting (Allow/Deny/Unset) for a given permission and
- principal.
+ principal.
"""
def getPrincipalsAndPermissions():
"""Get all principal permission settings.
Get the principal security assertions here in the form
- of a list of three tuple containing
+ of a list of three tuple containing
(permission id, principal id, setting)
"""