Index of the authenticate module
-
m
authkit.authenticate
...
- Authentication middleware
- a no_authkit_users_in_environ ...
- a log ...
- C AddToEnviron ... - Simple middleware which adds a key to the environ dictionary.
- C RequireEnvironKey ...
-
C
AuthKitAuthHandler
...
- The base class for all middleware responsible for handling
authentication and setting whatever needs to be set so that the
AuthKitUserSetter middleware can set REMOTE_USER on subsequent
requests. AuthKitAuthHandler``s only get inserted into the
middleware stack if an appropriate status code (as set in the
``authkit.setup.intercept config option) is intercepted by the
authentication middleware.
- C AddDictToEnviron ... - Simple middleware which adds the values of a dict to the environ.
-
C
AuthKitUserSetter
...
- The base class for all middleware responsible for attempting to set
REMOTE_USER on each request. The class is overridden by the induvidual
handlers.
- f get_methods ... - Get a dictionary of the available method entry points.
- f load_config ...
- f valid_password ... - A function which can be used with the basic and form authentication methods to validate a username and passowrd.
- f swap_underscore ...
- f load_method ...
- f strip_base ...
- f get_template ... - Another utility method to reduce code duplication. This function parses a template from one of the available template options:
- f digest_password ... - This is similar to valid_password() but is used with the digest authentication method and rather than checking a username and password and returning True or False it takes the realm and username as input, looks up the correct password and and returns a digest by calling the authkit.authenticate.digest.digest_password() function with the parameters realm, username and password respectively. The digest returned is then compared with the one submitted by the browser.
- f sample_app ... - A sample WSGI application that returns a 401 status code when the path /private is entered, triggering the authenticate middleware to prompt the user to sign in.
- f middleware ... - This function sets up the AuthKit authenticate middleware and its use and options are described in detail in the AuthKit manual.
- f get_authenticate_function ... - Sets up the users object, adds the middleware to add the users object to the environ and then returns authenticate methods to check a password and a digest.
-
m
digest
...
- HTTP digest authentication middleware
- a AGE ...
- a SCRIPT_NAME ...
- a PROXY_AUTHORIZATION ...
- a REQUEST_METHOD ...
- a USER_AGENT ...
- a IF_UNMODIFIED_SINCE ...
- a CONTENT_LENGTH ...
- a AUTHORIZATION ...
- a CONTENT_LANGUAGE ...
- a VIA ...
- a CONTENT_DISPOSITION ...
- a TRANSFER_ENCODING ...
- a SERVER ...
- a REFERER ...
- a ACCEPT ...
- a COOKIE ...
- a PATH_INFO ...
- a ACCEPT_ENCODING ...
- a REMOTE_USER ...
- a IF_NONE_MATCH ...
- a WARNING ...
- a LOCATION ...
- a CONTENT_LOCATION ...
- a ACCEPT_RANGES ...
- a MAX_FORWARDS ...
- a RANGE ...
- a CONTENT_ENCODING ...
- a TRAILER ...
- a SET_COOKIE ...
- a CONNECTION ...
- a PROXY_AUTHENTICATE ...
- a EXPECT ...
- a AUTH_TYPE ...
- a ALLOW ...
- a log ...
- a EXPIRES ...
- a HOST ...
- a WWW_AUTHENTICATE ...
- a IF_MATCH ...
- a ETAG ...
- a UPGRADE ...
- a REMOTE_SESSION ...
- a VARY ...
- a RETRY_AFTER ...
- a ACCEPT_LANGUAGE ...
- a DATE ...
- a ACCEPT_CHARSET ...
- a IF_RANGE ...
- a TE ...
- a CACHE_CONTROL ...
- a IF_MODIFIED_SINCE ...
- a PRAGMA ...
- a CONTENT_MD5 ...
- a FROM ...
- a LAST_MODIFIED ...
- a CONTENT_RANGE ...
- a CONTENT_TYPE ...
- C DigestUserSetter ...
- C DigestAuthHandler ... - middleware for HTTP Digest authentication (RFC 2617)
-
C
AuthDigestAuthenticator
...
- implementation of RFC 2617 - HTTP Digest Authentication
- f __call__ ... - This function takes the value of the 'Authorization' header, the method used (e.g. GET), and the path of the request relative to the server. The function either returns an authenticated user or it returns the authentication error.
- f authenticate ... - This function takes the value of the 'Authorization' header, the method used (e.g. GET), and the path of the request relative to the server. The function either returns an authenticated user or it returns the authentication error.
- f compute ... - Computes the authentication, raises error if unsuccessful
- f __init__ ...
- f build_authentication ... - builds the authentication error
- f make_digest_handler ...
- f load_digest_config ...
- f digest_password ... - construct the appropriate hashcode needed for HTTP digest
- m redirect ... - Redirect middleware to redirect the browser to a different URL for sign in
-
m
open_id
...
- Highly flexible OpenID based authentication middleware
- C OpenIDAuthHandler ... - This middleware is triggered when the authenticate middleware catches a 401 response. The form is submitted to the verify URL which the other middleware handles
- C AuthOpenIDHandler ... - The template should be setup from authkit.open_id.template.file or authkit.open_id.template.obj before we get here!
- C OpenIDUserSetter ...
- f render ...
- f make_store ...
- f make_passurl_handler ...
- f template ...
- f load_openid_config ...
- f passurl_urltouser ...
-
m
basic
...
- HTTP basic authentication middleware
- C BasicUserSetter ...
- C middleware ... - HTTP/1.0 Basic authentication middleware
-
C
AuthBasicAuthenticator
...
- implements Basic authentication details
- a type ...
- f __call__ ...
- f authenticate ...
- f __init__ ...
- f build_authentication ...
- f make_basic_auth_handler ...
- f load_basic_config ...
- m forward ... - Internal forward middleware for manual authentication handling
- m form ... - Form and cookie based authentication middleware
-
m
sso
...
- Authenticate Single Sign-On Middleware
-
m
cas
...
- CAS 1.0 and 2.0 SSO Implementation
- a log ...
- C AuthCASHandler ... - CAS 1.0 and 2.0 Redirect Handler
- C AuthCASMiddleware ... - CAS 1.0 and 2.0 Capable Authentication Handler
- f make_cas_handler ...
-
m
api
...
- SSO API's
- a log ...
- C RedirectingAuthMiddleware ...
- C RedirectingAuthHandler ... - Handles generating redirect to SSO system
- C LoginFailure ... - The exception raised if the verification fails
- f find_multi_app ... - Walks an app assuming it is a middleware stack with apps glued on at either self.app or self.application
-
m
cas
...
- CAS 1.0 and 2.0 SSO Implementation
-
m
cookie
...
- Cookie handling based on paste.auth.auth_tkt but with some bug fixes and
improvements
- a log ...
- C CookieUserSetter ... - Same as paste's AuthTKTMiddleware except you can choose your own ticket class and your cookie is removed if there is a bad ticket. Also features server-side cookie expiration and IP-based cookies which use the correct IP address when a proxy server is used.
- C AuthKitTicket ... - This is a standard paste AuthTicket class except that it also supports a cookie_params dictionary which can have the following options: expires, path, comment, domain, max-age, secure and version.
- f parse_ticket ... - Parse the ticket, returning (timestamp, userid, tokens, user_data).
- f load_cookie_config ...
- f calculate_digest ...
- f make_cookie_user_setter ...
- f encode_ip_timestamp ...
-
m
multi
...
- Middleware that can dynamically change the stack based on status or headers
- a log ...
- C AuthSwitcher ...
- C MultiHandler ...
- f status_checker ... - Used by AuthKit to intercept statuses specified in the config file option authkit.intercept.