This document describes how repoze.who is integrated into TurboGears
and how to get started with it. For more information, you may want to check
repoze.who’s website.
repoze.who is a powerful and extensible authentication package for
arbitrary WSGI applications. By default TurboGears2 configures it to log using
a form and retrieving the user information through the user_name field of the
User class. This is made possible by the authenticator plugin that TurboGears2
uses by default which asks base_config.sa_auth.authmetadata to authenticate
the user against given login and password.
The authentication layer is a WSGI middleware that is able to authenticate the user through the method you want (e.g., LDAP or HTTP authentication), “remember” the user in future requests and log the user out.
You can customize the interaction with the user through four kinds of plugins, sorted by the order in which they are run on each request:
identifier plugin, with no action required on the user’s side, is able
to tell whether it’s possible to authenticate the user (e.g., if it finds
HTTP Authentication headers in the HTTP request). If so, it will extract the
data required for the authentication (e.g., username and password, or a
session cookie). There may be many identifiers and repoze.who will run
each of them until one finds the required data to authenticate the user.authenticator plugin will try to use the
extracted data to authenticate the user. There may be many authenticators
and repoze.who will run each of them until one authenticates the user.challenger plugin will come up to request an action from the user (e.g.,
enter a user name and password and then submit the form). The user’s response
will start another request on the application, which should be caught by
an identifier to extract the login data and then such data will be used
by the authenticator.IdentityApplicationWrapper
provides the ability to load related data (e.g., real name, email) so that it can
be easily used in the application. Such a functionality is provided by
so-called ApplicationAuthMetadata in your app_cfg.py.When the IdentityApplicationWrapper retrieves the user identity and its
metadata it makes them available inside request as request.identity.
For example, to check whether the user has been authenticated you may use:
# ...
from tg import request
# ...
if request.identity:
flash('You are authenticated!')
request.identity will equal to None if the user has not been
authenticated.
Also the whole repoze.who authentication information are available
in WSGI environment with repoze.who.identity key, which can be
accessed using the code below:
from tg import request
# The authenticated user's data kept by repoze.who:
who_identity = request.environ.get('repoze.who.identity')
The username will be available in identity['repoze.who.userid']
(or request.identity['repoze.who.userid'], depending on the method you
select).
By default, TurboGears 2.4.3 configures repoze.who to use
tg.configuration.auth.fastform.FastFormPlugin as the first
identifier and challenger – using /login as the relative URL that will
display the login form, /login_handler as the relative URL where the
form will be sent and /logout_handler as the relative URL where the
user will be logged out. The so-called rememberer of such identifier will
be an instance of repoze.who.plugins.cookie.AuthTktCookiePlugin.
All these settings can be customized through the config.app_cfg.base_config.sa_auth
options in your project. Identifiers, Authenticators and Challengers can be overridden
providing a different list for each of them as:
base_config.sa_auth['identifiers'] = [('myidentifier', myidentifier)]
You don’t have to use repoze.who directly either, unless you decide not
to use it the way TurboGears configures it.
It’s very easy for you to customize authentication and identification settings
in repoze.who from {yourproject}.config.app_cfg.base_config.sa_auth.
TurboGears provides an easy shortcut to customize how your authorization
data is retrieved without having to face the complexity of the underlying
authentication layer. This is performed by the TGAuthMetadata object
which is configured in your project config.app_cfg.base_config.
This object provides three methods which have to return respectively the user, its groups and its permissions. You can freely change them as you wish as they are part of your own application behavior.
For more advanced customizations or to use repoze plugins to implement
different forms of authentication you can freely customize the whole
authentication layer using through the {yourproject}.config.app_cfg.base_config.sa_auth
options.
The available directives are all optional:
form_plugin: This is a replacement for the FriendlyForm plugin and will beform_identifies option is True it will
also be appended to the list of identifiers.ìdentifiers: A custom list of repoze.who identifiers.form_plugin and the AuthTktCookiePlugin.challengers: A custom list of repoze.who challengers.form_plugin is always appended to this list, so if you have
only one challenger you will want to change the form_plugin instead
of overridding this list.authmetadata: This is the object that TG will use to fetch authorization metadata.mdproviders: This is a list of repoze.who metadata providers.authmetadata does and in case
a repoze.who metadata provider already provided identity metadata
it will be available inside identity in authmetadata and can be used.Your auth-related model doesn’t have to be like the default one, where the
class for your users, groups and permissions are, respectively, User,
Group and Permission, and your users’ user name is available in
User.user_name. What if you prefer Member and Team instead of
User and Group, respectively?
First of all we need to inform the authentication layer that our user is stored
in a different class. This makes repoze.who know where to look for the user
to check its password:
# what is the class you want to use to search for users in the database
base_config.sa_auth.user_class = model.Member
Then we have to tell out authmetadata how to retrieve the user, its groups
and permissions:
from tg.configuration.auth import TGAuthMetadata
#This tells to TurboGears how to retrieve the data for your user
class ApplicationAuthMetadata(TGAuthMetadata):
def __init__(self, sa_auth):
self.sa_auth = sa_auth
def authenticate(self, environ, identity):
user = self.sa_auth.dbsession.query(self.sa_auth.user_class).filter_by(user_name=identity['login']).first()
if user and user.validate_password(identity['password']):
return identity['login']
def get_user(self, identity, userid):
return self.sa_auth.user_class.query.get(user_name=userid)
def get_groups(self, identity, userid):
return [team.team_name for team in identity['user'].teams]
def get_permissions(self, identity, userid):
return [p.permission_name for p in identity['user'].permissions]
base_config.sa_auth.authmetadata = ApplicationAuthMetadata(base_config.sa_auth)
Now our application is able to fetch the user from the Member table and
its groups from the Team table. Using TGAuthMetadata makes also possible
to introduce a caching layer to avoid performing too many queries to fetch
the authentication data for each request.
The following is an example of a customization of the authentication stack to allow identification of the user through a token provided through a custom header.
This example is not secure and the token is simply the username itself, it’s simply intended to showcase how to implement your own identification, never use this in production.
We will be identifying the user through the value provided in X-LogMeIn header.
This can be done by registering in TurboGears an object with identify, remember
and forget methods.
The identify method is the one we are looking to catch the token value
and return an identity that TGAuthMetadata can use to authenticate our user.
remember and forget methods are intended when the server can also drive
the fact that the values requred to identify the user must be provided on subsequent
requests or not (IE: set or remove cookies). In this case we are not concerned
as we expect the client to explicitly provide the token for each request:
class SimpleTokenIdentifier(object):
def identify(self, environ):
logmein_header = environ.get('HTTP_X_LOGMEIN')
if logmein_header:
return {'login': logmein_header, 'password': None, 'identifier': 'simpletoken'}
def forget(self, environ, identity):
return None
def remember(self, environ, identity):
return None
Then our SimpleTokenIdentifier must be registered in identifiers list of
simple authentication options to allow its usaged:
base_config.sa_auth.identifiers = [('simpletoken', SimpleTokenIdentifier()), ('default', None)]
We also keep the ('default', None) entry to have TurboGears configure cookie based
identification for us, such that we can continue to login through the usual username and
password form.
Once we have an identity for the user it’s authenticators job to ensure that identity
is valid. This means that the identity will be passed to TGAuthMetadata for
authentication.
Note
It’s required that your identity has a password field even though it doesn’t
have a password. Or it will be discarded and won’t be passed to TGAuthMetadata.
We need to modify TGAuthMetadata.authenticate a little to allow identities
that do not provide a valid password but has been identified by SimpleTokenIdentifier.
We can do this by adding a specific check before the one for password:
def authenticate(self, environ, identity):
login = identity['login']
user = self.sa_auth.dbsession.query(self.sa_auth.user_class).filter_by(
user_name=login
).first()
if not user:
login = None
elif identity.get('identifier') in ('simpletoken', ):
# User exists and was identified by simpletoken, skip password validation
pass
elif not user.validate_password(identity['password']):
login = None
# ... rest of method here ...
Now you can try sending requests with X-LogMeIn: manager header and you should
be able to get recognised as the site manager.
The following is an example of an advanced authentication stack customization to use browser basic authentication instead of form based authentication.
First required step is to declare that we are going to use a custom authentication backend:
base_config.auth_backend = 'htpasswd'
When this is valued to ming or sqlalchemy TurboGears will configure
a default authentication stack based on users stored on the according database,
if auth_backend is None the whole stack will be disabled.
Then we must remove all the simple authentication options, deleting all the
basic_config.sa_auth from app_cfg.py is usually enough. Leaving
unexpected options behind (options our authentication stack doesn’t use)
might lead to a crash on application startup.
Next step is storing our users inside an htpasswd file,
this can be achieved by using the HTPasswdPlugin authenticator:
from repoze.who.plugins.htpasswd import HTPasswdPlugin, plain_check
base_config.sa_auth.authenticators = [('htpasswd', HTPasswdPlugin('./htpasswd', plain_check))]
This will make TurboGears load users from an htpasswd file inside the directory
we are starting the application from. The plain_check function is the
one used to decode password stored inside the htpasswd file. In this case
passwords are expected to be in plain text in the form:
manager:managepass
Now that we are correctly able to authenticate users from an htpasswd file, we need to use BasicAuth for identifying returning users:
from repoze.who.plugins.basicauth import BasicAuthPlugin
base_auth = BasicAuthPlugin('MyTGApp')
base_config.sa_auth.identifiers = [('basicauth', base_auth)]
This will correctly identify users that are already logged using BasicAuth, but we are still sending users to login form to perform the actual login.
As BasicAuth requires the login to be performed through the browser we must disable the login form and set the basic auth plugin as a challenger:
# Disable the login form, it won't work anyway as the credentials
# for basic auth must be provided through the browser itself
base_config.sa_auth.form_identifies = False
# Use BasicAuth plugin to ask user for credentials, this will replace
# the whole login form.
base_config.sa_auth.challengers = [('basicauth', base_auth)]
The previous steps are focused on providing a working authentication layer,
but we will need to also identify the authenticated user so that
also request.identity and the authorization layer can work as
expected.
This is achieved through the authmetadata option, which tells
TurboGears how to retrieve the user and it’s informations. In this
case as we don’t have a database of users we will just provide a
simple user with only display_name and user_name so that
most things can work. For manager user we will also provide the
managers group so that user can access the TurboGears admin:
from tg.configuration.auth import TGAuthMetadata
class ApplicationAuthMetadata(TGAuthMetadata):
def __init__(self, sa_auth):
self.sa_auth = sa_auth
def get_user(self, identity, userid):
# As we use htpasswd for authentication
# we cannot lookup the user in a database,
# so just return a fake user object
from tg.util import Bunch
return Bunch(display_name=userid, user_name=userid)
def get_groups(self, identity, userid):
# If the user is manager we give him the
# managers group, otherwise no groups
if userid == 'manager':
return ['managers']
else:
return []
def get_permissions(self, identity, userid):
return []
base_config.sa_auth.authmetadata = ApplicationAuthMetadata(base_config.sa_auth)
As the whole authentication is now performed through BasicAuth the login form is now unused, so probably want to remove the login form related urls which are now unused:
- /login
- /post_login
- /post_logout
If you need more flexibility than that provided by the quickstart, or you are
not going to use repoze.who, you should prevent TurboGears from dealing
with authentication/authorization by removing (or commenting) the following
line from {yourproject}.config.app_cfg:
base_config.auth_backend = '{whatever you find here}'
Then you may also want to delete those settings like base_config.sa_auth.*
– they’ll be ignored.