Class
zope.app.authentication.httpplugins.HTTPBasicAuthCredentialsPlugin

• persistent.Persistent
• zope.app.container.contained.Contained

• zope.app.authentication.interfaces.ICredentialsPlugin
• zope.app.authentication.httpplugins.IHTTPBasicAuthRealm
• zope.annotation.interfaces.IAttributeAnnotatable
• persistent.interfaces.IPersistent
• zope.app.container.interfaces.IContained

• protocol (type: str)
  Value: 'http auth'
  Permissions: n/a (read), n/a (write)
• realm (type: str)
  Value: 'Zope'
  Interface: zope.app.authentication.httpplugins.IHTTPBasicAuthRealm
  Permissions: zope.ManageServices (read), zope.ManageServices (write)

• challenge(request)
  

  Issues an HTTP basic auth challenge for credentials.

  The challenge is issued by setting the appropriate response headers. To illustrate, we'll create a plugin:

  >>> plugin = HTTPBasicAuthCredentialsPlugin()
  

  The plugin adds its challenge to the HTTP response.

  >>> from zope.publisher.browser import TestRequest
  >>> request = TestRequest()
  >>> response = request.response
  >>> plugin.challenge(request)
  True
  >>> response._status
  401
  >>> response.getHeader('WWW-Authenticate', literal=True)
  'basic realm="Zope"'
  

  Notice that the realm is quoted, as per RFC 2617.

  The plugin only works with HTTP requests.

  >>> from zope.publisher.base import TestRequest
  >>> request = TestRequest('/')
  >>> response = request.response
  >>> print plugin.challenge(request)
  False
  

  Interface: zope.app.authentication.interfaces.ICredentialsPlugin
  Permissions: n/a (read), n/a (write)
• extractCredentials(request)
  

  Extracts HTTP basic auth credentials from a request.

  First we need to create a request that contains some credentials.

  >>> from zope.publisher.browser import TestRequest
  >>> request = TestRequest(
  ...     environ={'HTTP_AUTHORIZATION': u'Basic bWdyOm1ncnB3'})
  

  Now create the plugin and get the credentials.

  >>> plugin = HTTPBasicAuthCredentialsPlugin()
  >>> plugin.extractCredentials(request)
  {'login': u'mgr', 'password': u'mgrpw'}
  

  Make sure we return None, if no authentication header has been specified.

  >>> print plugin.extractCredentials(TestRequest())
  None
  

  Also, this plugin can only handle basic authentication.

  >>> request = TestRequest(environ={'HTTP_AUTHORIZATION': 'foo bar'})
  >>> print plugin.extractCredentials(TestRequest())
  None
  

  This plugin only works with HTTP requests.

  >>> from zope.publisher.base import TestRequest
  >>> print plugin.extractCredentials(TestRequest('/'))
  None
  

  Interface: zope.app.authentication.interfaces.ICredentialsPlugin
  Permissions: n/a (read), n/a (write)
• logout(request)
  

  Always returns False as logout is not supported by basic auth.

  >>> plugin = HTTPBasicAuthCredentialsPlugin()
  >>> from zope.publisher.browser import TestRequest
  >>> plugin.logout(TestRequest())
  False
  

  Interface: zope.app.authentication.interfaces.ICredentialsPlugin
  Permissions: n/a (read), n/a (write)

There are no known subclasses.