Django OpenID Provider v0.6 documentation¶

Introduction¶

Django OpenID Provider application acts as OpenID provider (in lame terms Server) for your django.contrib.auth accounts.

If you have your own Django powered website you might want to use your admin account to authenticate on other sites like stackoverflow or even in other django websites you manage (with django_openid_auth for example).

Reasons to do that:

• forget about dozens of passwords on different sites,
• manage and revoke OpenID authorization for sites you log on,
• http://openidexplained.com/

Requirements¶

The Python OpenID library is required to run openid_provider. By default it’ll use openid.store.filestore.FileOpenIDStore for persistent storage of OpenID related data.

To change the file system location that the default storage uses, you can optionally provide a OPENID_PROVIDER_FILESTORE_PATH setting.

In case you don’t want to store the OpenID related data on a file system, it’s also possible to make use of the DjangoOpenIDStore contained in the django_openid_auth app. Simply add an OPENID_PROVIDER_STORE setting to your settings:

OPENID_PROVIDER_STORE = 'django_openid_auth.store.DjangoOpenIDStore'

This is especially useful in case your site is deployed in shared hosting environments.

Basic Installation¶

1. Copy/install openid_provider into your project directory (or link to it).

2. Add 'openid_provider' to INSTALLED_APPS and its dependencies:

   INSTALLED_APPS = (
       # ...
       'django.contrib.auth',
       'django.contrib.sessions',
       'openid_provider',
       # ...
   )
   

3. Add openid_provider/urls.py to your urlpatterns, e.g.:

   urlpatterns = patterns('',
       # ...
       url(r'^openid/', include('openid_provider.urls')),
       # ...
   )
   

4. To create required tables in your database, run:

   python manage.py syncdb
   

   or (if you are using south):

   python manage.py migrate openid_provider
   

Upgrading¶

python manage.py migrate openid_provider 0001 --fake

What is not provided¶

This application does not include most basic template every django project should have: base.html. You should have base.html file in one of your settings.TEMPLATE_DIRS directories and it should contain 3 base blocks:

• title
• extrahead
• content

(see DosAndDontsForApplicationWriters and django template inheritance)

If your base template is named differently you should override openid_provider/base.html to contain something like:

{% extends "your_base_template_name.html" %}

If your base template have different blocks you could easily remap those:

{% block your_content_block_name %}{% block content %}{% endblock %}{% endblock %}

Usage¶

After instalation and database sync login to your django admin site. You’ll notice new application and it’s model OpenIDs.

Click add and at least select User from select box. If you want that user to have human-friendly openid identifier enter it into Openid field. Hit Save and your first OpenID is ready.

Your OpenID Claimed Identifier URL will be:

<your host>/<your openid base url>/<contents of Openid field>/

When you will use it to login on the web, Relaying Party [1] will redirect you to your site. If you aren’t logged in on your site you’ll first have to log in, then you’ll be asked if you want to add Relaying Party to your “Trusted Roots” [2]. Add it and next time you’ll log in it’ll be automatic - you won’t even notice your site appearance if you’ll be still logged in.

from django.contrib.auth.models import User
user = User.objects.get(pk=...)
# create openid for that user:
user.openid_set.create(openid=user.username)

# note that there can be few openids associated with each user
openid = OpenID.objects.filter(user=request.user, default=True)[0]

# remove all relaying parties with google.com in URL
openid.trustedroot_set.filter(trust_root__contains='google.com').delete()

History¶

Credits¶

Django OpenID Provider is developed by Roman Barczyński based on code from:

• simon (django code snippets)
• python-openid-2.2.4 examples/djopenid

LICENSE¶

Copyright (C) 2014 Roman Barczyński

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this software except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.