Skip to main content

googleappsauth authenticates Django Users against a Google Apps Domain

Project description

# Authentication agains Google Apps Domains for Django

*googleappsauth* allows you to authenticate your [Django][1] users against an Google Apps[2] domain.
This means you basically get a single sign-on solution, provided that all users of your django application
also have Accounts in Google Apps for your Domain.

[1]: http://www.djangoproject.com/
[2]: http://www.google.com/apps/

## Usage

To use googleappsauth, configuration in `settings.py` should look like this:

GOOGLE_APPS_DOMAIN = 'example.com'
GOOGLE_APPS_CONSUMER_KEY = 'example.com'
GOOGLE_APPS_CONSUMER_SECRET = '*sekret*'
GOOGLE_OPENID_ENDPOINT = 'https://www.google.com/a/%s/o8/ud?be=o8' % GOOGLE_APPS_DOMAIN
GOOGLE_API_SCOPE = 'http://www.google.com/m8/feeds/+http://docs.google.com/feeds/+http://spreadsheets.google.com/feeds/'
# domain where your application is running
GOOGLE_OPENID_REALM = 'http://*.hudora.biz/'

You also have to tell googleappsauth where various views life:

LOGIN_URL = '/login'
LOGIN_REDIRECT_URL = '/admin'
LOGOUT_URL = '/logout'

To activate googleappsauth, set the appropriate Authentication backend and include a callback view.

settings.py:
AUTHENTICATION_BACKENDS = ('googleappsauth.backends.GoogleAuthBackend',)

urls.py:
(r'^callback_googleappsauth/', 'googleappsauth.views.callback'),


Using a special middleware which is included int he package, you can block access to a compete site.

MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'googleappsauth.middleware.GoogleAuthMiddleware',
)

In addition you can set `AUTH_PROTECTED_AREAS` to authenticate only access to certain parts of a site, e.g.

AUTH_PROTECTED_AREAS = '/admin'

## Download

Get it at the [Python Cheeseshop][3] or at [GitHub][4].

[3]: http://pypi.python.org/pypi/googleappsauth/
[4]: http://github.com/hudora/django-googleappsauth

## See also

* Tim Garthwaite: [Google Apps Auth Backend for Django][5]
* http://github.com/flashingpumpkin/django-socialregistration/
* http://github.com/uswaretech/Django-Socialauth/

[5]: http://techblog.appirio.com/2008/10/google-apps-auth-backend-for-django.html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

googleappsauth-1.01p3.tar.gz (12.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page