paula.authentication/trunk/src/paula/authentication/pauplugins.py

   1 # Copyright (c) 2008 by Florian Friesdorf
   2 #
   3 # GNU Affero General Public License (AGPL)
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU Affero General Public License as
   7 # published by the Free Software Foundation; either version 3 of the
   8 # License, or (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU Affero General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Affero General Public
  16 # License along with this program.  If not, see
  17 # <http://www.gnu.org/licenses/>.
  18 """
  19 """
  20 __author__ = "Florian Friesdorf <flo@chaoflow.net>"
  21 __docformat__ = "plaintext"
  22
  23 # this should be moved from zope.app.authentication to zope.authentication
  24 from zope.app.authentication.interfaces import ICredentialsPlugin
  25 from zope.app.authentication.principalfolder import PrincipalInfo
  26
  27 from zope.app.container.contained import Contained
  28 from zope.interface import implements, alsoProvides
  29 from zope.component import getUtility
  30 from zope.publisher.interfaces import IRequest
  31
  32 from paula.authentication.interfaces import IAuthProviders
  33 from paula.authentication.interfaces import IAuthenticatorPlugin
  34 from paula.authentication.interfaces import ILocalAuthenticatorPlugin
  35 from paula.authentication.interfaces import ICredentialsFromMappingPlugin
  36
  37
  38 class AuthenticatorPlugin(object):
  39     """Authenticate users with auth providers from an IAuthProviders
  40
  41     May be registered globally, as only functionality is implemented.
  42
  43         >>> import UserDict
  44         >>> apu = UserDict.UserDict()
  45         >>> alsoProvides(apu, IAuthProviders)
  46         >>> provideUtility(apu)
  47
  48         >>> m = Mock(
  49         ...         id='login',
  50         ...         validate = lambda login=None,password=None: \\
  51         ...                 password == 'correct',
  52         ...         )
  53
  54         >>> apu['login'] = m
  55
  56         >>> ap = AuthenticatorPlugin()
  57
  58         >>> p = ap.authenticateCredentials(None)
  59         >>> p is None
  60         True
  61
  62         >>> credentials = {
  63         ...     'login': 'login',
  64         ...     }
  65         >>> p = ap.authenticateCredentials(credentials)
  66         >>> p is None
  67         True
  68
  69         >>> credentials = {
  70         ...     'password': 'correct',
  71         ...     }
  72         >>> p = ap.authenticateCredentials(credentials)
  73         >>> p is None
  74         True
  75
  76         >>> credentials = {
  77         ...     'login': 'wrong',
  78         ...     'password': 'correct',
  79         ...     }
  80         >>> p = ap.authenticateCredentials(credentials)
  81         >>> p is None
  82         True
  83
  84         >>> credentials['login'] = 'login'
  85         >>> p = ap.authenticateCredentials(credentials)
  86         >>> from zope.app.authentication.interfaces import IPrincipalInfo
  87         >>> IPrincipalInfo.providedBy(p)
  88         True
  89         >>> p.id
  90         'login'
  91
  92         >>> credentials['password'] = 'wrong'
  93         >>> p = ap.authenticateCredentials(credentials)
  94         >>> p is None
  95         True
  96     """
  97     implements(IAuthenticatorPlugin)
  98
  99     def _getAPU(self):
 100         """
 101         """
 102         return getUtility(IAuthProviders)
 103
 104     def authenticateCredentials(self, creds):
 105         try:
 106             if not (creds.has_key('login') and creds.has_key('password')):
 107                 return None
 108         except AttributeError:
 109             return None
 110
 111         # retrieve auth provider utility
 112         apu = self._getAPU()
 113         id = creds["login"]
 114         try:
 115             # retrieve auth provider for principal
 116             ap = apu[id]
 117         except KeyError:
 118             return None
 119
 120         # use authprovider to verify credentials
 121         if not ap.validate(login=creds['login'],password=creds['password']):
 122             return None
 123
 124         login = id
 125         title = description = u""
 126         return PrincipalInfo( id, login, title, description)
 127
 128     def principalInfo(self, id):
 129         apu = self._getAPU()
 130         if not id in apu:
 131             return None
 132         login = id
 133         title = description = u""
 134         return PrincipalInfo( id, login, title, description)
 135
 136
 137 class LocalAuthenticatorPlugin(
 138         AuthenticatorPlugin,
 139         Contained,
 140         ):
 141     """XXX: still not sure whether this could be the same as AP
 142     """
 143     implements(ILocalAuthenticatorPlugin)
 144
 145 #    def _getAPU(self):
 146 #        """when doing this in the version above, I am getting a
 147 #        ComponentLookupError...
 148 #        """
 149 #        return getUtility(IAuthProviders, context=getSite())
 150
 151
 152 class CredentialsFromMappingPlugin(Contained):
 153     """Just returns a mapping it is passed
 154
 155     Useful, if you use paula and PAU just for authentication but not for
 156     challenging, i.e./e.g. from PlonePAS you already get the credentials in a
 157     mapping and don't need to bother with challenging.
 158
 159     May be registered globally, as only functionality is implemented.
 160
 161         >>> cp = CredentialsFromMappingPlugin()
 162         >>> m = UserDict()
 163         >>> c = cp.extractCredentials(m)
 164         >>> c is m
 165         True
 166         >>> IRequest.providedBy(m)
 167         True
 168     """
 169     implements(ICredentialsFromMappingPlugin)
 170
 171     def extractCredentials(self, mapping):
 172         """
 173         """
 174         # tune the mapping, PAU needs an IRequest to find its factories
 175         # If this does not work, better let the AttributeError go here, than
 176         # later in the getMultiAdapter lookup of PAU
 177         if not IRequest.providedBy(mapping):
 178             alsoProvides(mapping, IRequest)
 179
 180         return mapping
 181
 182     def challenge(self, request):
 183         pass # challenge is a no-op for this plugin
 184
 185     def logout(self, request):
 186         pass # logout is a no-op for this plugin
 187