Back to index

plone3  3.1.7
Public Member Functions
PluggableAuthService.interfaces.plugins.ILoginPasswordHostExtractionPlugin Class Reference
Inheritance diagram for PluggableAuthService.interfaces.plugins.ILoginPasswordHostExtractionPlugin:
Inheritance graph
[legend]
Collaboration diagram for PluggableAuthService.interfaces.plugins.ILoginPasswordHostExtractionPlugin:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def extractCredentials

Detailed Description

Common-case derivative.

Definition at line 61 of file plugins.py.


Member Function Documentation

Common-case derivative.
request -> { 'login' : login 
       , 'password' : password 
       , 'remote_host' : remote_host
       , 'remote_addr' : remote_addr
       , k1 : v1
       ,   ...
       , kN : vN
       } | {}

o If credentials are found, the returned mapping will contain at
  least 'login', 'password', 'remote_host' and 'remote_addr' keys,
  with the password in plaintext.

o Return an empty mapping to indicate that the plugin found no
  appropriate credentials.

Reimplemented from PluggableAuthService.interfaces.plugins.ILoginPasswordExtractionPlugin.

Definition at line 66 of file plugins.py.

00066 
00067     def extractCredentials( request ):
00068 
00069         """ request -> { 'login' : login 
00070                        , 'password' : password 
00071                        , 'remote_host' : remote_host
00072                        , 'remote_addr' : remote_addr
00073                        , k1 : v1
00074                        ,   ...
00075                        , kN : vN
00076                        } | {}
00077 
00078         o If credentials are found, the returned mapping will contain at
00079           least 'login', 'password', 'remote_host' and 'remote_addr' keys,
00080           with the password in plaintext.
00081 
00082         o Return an empty mapping to indicate that the plugin found no
00083           appropriate credentials.
00084         """


The documentation for this class was generated from the following file: