Back to index

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

List of all members.

Public Member Functions

def challenge

Detailed Description

Initiate a challenge to the user to provide credentials.

    Challenge plugins have an attribute 'protocol' representing
    the protocol the plugin operates under, defaulting to None.

    Plugins operating under the same protocol will all be given an
    attempt to fire. The first plugin of a protocol group that
    successfully fires establishes the protocol of the overall
    challenge.

Definition at line 102 of file plugins.py.


Member Function Documentation

Initiate a challenge to the user to provide credentials.

Challenge plugins have an attribute 'protocol' representing
the protocol the plugin operates under, defaulting to None.

Plugins operating under the same protocol will all be given an
attempt to fire. The first plugin of a protocol group that
successfully fires establishes the protocol of the overall
challenge.
Assert via the response that credentials will be gathered.

Takes a REQUEST object and a RESPONSE object.

Returns True if it fired, False otherwise.

Two common ways to initiate a challenge:

  - Add a 'WWW-Authenticate' header to the response object.

    NOTE: add, since the HTTP spec specifically allows for
    more than one challenge in a given response.

  - Cause the response object to redirect to another URL (a
    login form page, for instance)

Definition at line 115 of file plugins.py.

00115 
00116     def challenge( request, response ):
00117 
00118         """ Assert via the response that credentials will be gathered.
00119 
00120         Takes a REQUEST object and a RESPONSE object.
00121 
00122         Returns True if it fired, False otherwise.
00123 
00124         Two common ways to initiate a challenge:
00125 
00126           - Add a 'WWW-Authenticate' header to the response object.
00127 
00128             NOTE: add, since the HTTP spec specifically allows for
00129             more than one challenge in a given response.
00130 
00131           - Cause the response object to redirect to another URL (a
00132             login form page, for instance)
00133         """

Here is the caller graph for this function:


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