~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to twisted/web2/auth/interfaces.py

• browse files at revision 15
• compare with another revision
• download diff
• download tarball
• view history from revision 15

Show diffs side-by-side

added

removed

twisted/web2/auth/interfaces.py

 

1

from zope.interface import Interface, Attribute

 

2

 

 

3

class ICredentialFactory(Interface):

 

4

    scheme = Attribute("string indicated the authentication scheme this factory is associated with.")

 

5

 

 

6

    def getChallenge(peer):

 

7

        """Generate a challenge the client may respond to.

 

8

 

 

9

        @type peer: L{twisted.internet.interfaces.IAddress}

 

10

        @param peer: The client's address

 

11

 

 

12

        @rtype: C{dict}

 

13

        @return: dictionary of challenge arguments

 

14

        """

 

15

 

 

16

    def decode(response, request):

 

17

        """Create a credentials object from the given response.

 

18

        May raise twisted.cred.error.LoginFailed if the response is invalid.

 

19

    

 

20

        @type response: C{str}

 

21

        @param response: scheme specific response string

 

22

 

 

23

        @type request: L{twisted.web2.server.Request}

 

24

        @param request: the request being processed

 

25

 

 

26

        @return: ICredentials

 

27

        """

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1