Class BasicAuthMiddleware

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:

• app - is a WSGI application.
• check_function - is a function taking three arguments username, password and environment returning a bool indicating whether the request may is allowed. The older interface of taking only the first two arguments is still supported via catching a TypeError.
• app401 - is an optional WSGI application to be used for error messages
• realm (str)

Overrides: object.__init__

Try to authenticate a request. The Authorization header is examined and checked agains the authorization_method before being passed to this method. This method must either raise an AuthenticationRequired instance or return a dictionary explaining what was successfully authenticated.

Parameters:

• auth - is the part of the Authorization header after the method
• environ - is the environment passed with a WSGI request

Returns: {str: object}

a dictionary that provides a key "user" listing the authenticated username as a string. It may also provide the key "outheaders" with a [(str, str)] value to extend the response headers.

Raises:

• AuthenticationRequired - if the authentication was unsuccessful

Overrides: authentication.AuthenticationMiddleware.authenticate

(inherited documentation)

Generates a WWW-Authenticate header. Subclasses must implement this method.

Parameters:

• exception - reason for generating the header

Returns: (str, str)

the header as (part_before_colon, part_after_colon)

Overrides: authentication.AuthenticationMiddleware.www_authenticate

(inherited documentation)

Generate an error page after failed authentication. Apart from the exception parameter, this method behaves like a WSGI application.

Parameters:

• exception - reason for the authentication failure

Overrides: authentication.AuthenticationMiddleware.authorization_required

(inherited documentation)