class ICredentialsPlugin(IPlugin):
"""Handles credentials extraction and challenges per request."""
containers(IPluggableAuthentication)
challengeProtocol = zope.interface.Attribute(
"""A challenge protocol used by the plugin.
If a credentials plugin works with other credentials pluggins, it
and the other cooperating plugins should specify a common (non-None)
protocol. If a plugin returns True from its challenge method, then
other credentials plugins will be called only if they have the same
protocol.
""")
def extractCredentials(request):
"""Ties to extract credentials from a request.
A return value of None indicates that no credentials could be found.
Any other return value is treated as valid credentials.
"""
def challenge(request):
"""Possibly issues a challenge.
This is typically done in a protocol-specific way.
If a challenge was issued, return True, otherwise return False.
"""
def logout(request):
"""Possibly logout.
class IAuthenticatorPlugin(IPlugin):
"""Authenticates a principal using credentials.
An authenticator may also be responsible for providing information
about and creating principals.
"""
containers(IPluggableAuthentication)
def authenticateCredentials(credentials):
"""Authenticates credentials.
If the credentials can be authenticated, return an object that provides
IPrincipalInfo. If the plugin cannot authenticate the credentials,
returns None.
"""
def principalInfo(id):
"""Returns an IPrincipalInfo object for the specified principal id.
class bar(object):
interface.implements(iusers)
containers(IUserContainer)
class IOrganizationContained(IContained):
"""Interface that specifies type of objects that can contain in an organization"""
containers(".IGsoc")
class IInternalPrincipalContained(interface.Interface):
"""Principal information"""
containers(IInternalPrincipalContainer)