django-cas-ng 3.1.0

Features

• Support [CAS](http://www.jasig.org/cas) version 1.0 and 2.0.

• Support Django 1.5+ [user custom model](https://docs.djangoproject.com/en/1.5/topics/auth/customizing/).

Installation

Install with pip:

pip install django-cas-ng

Install from source:

python setup.py install

Now add it to the middleware and authentication backends in your settings. Make sure you also have the authentication middleware installed. Here’s an example:

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

AUTHENTICATION_BACKENDS = (
    'django.contrib.auth.backends.ModelBackend',
    'django_cas_ng.backends.CASBackend',
)

Set the following required setting in settings.py:

• CAS_SERVER_URL: This is the only setting you must explicitly define.

  Set it to the base URL of your CAS source (e.g. https://account.example.com/cas/).

Optional settings include:

• CAS_ADMIN_PREFIX: The URL prefix of the Django administration site. If undefined, the CAS middleware will check the view being rendered to see if it lives in django.contrib.admin.views.

• CAS_EXTRA_LOGIN_PARAMS: Extra URL parameters to add to the login URL when redirecting the user.

• CAS_IGNORE_REFERER: If True, logging out of the application will always send the user to the URL specified by CAS_REDIRECT_URL.

• CAS_LOGOUT_COMPLETELY: If False, logging out of the application won’t log the user out of CAS as well.

• CAS_REDIRECT_URL: Where to send a user after logging in or out if there is no referrer and no next page set. Default is /.

• CAS_RETRY_LOGIN: If True and an unknown or invalid ticket is received, the user is redirected back to the login page.

• CAS_VERSION: The CAS protocol version to use. ‘1’ and ‘2’ are supported, with ‘2’ being the default.

Make sure your project knows how to log users in and out by adding these to your URL mappings:

(r'^accounts/login$', 'django_cas_ng.views.login'),
(r'^accounts/logout$', 'django_cas_ng.views.logout'),

Users should now be able to log into your site using CAS.

Contribute

Contributions are welcome! If you would like to contribute this project, please feel free to fork and send pull request. New code should follow both PEP8 and the Django coding style.

Credits

This is project is inherited from CCPC’s [django-cas](https://bitbucket.org/cpcc/django-cas). It seems django-cas not update since 2013-4-1. I moved it github for bugfix and continue new feature develop.

• [django-cas](https://bitbucket.org/cpcc/django-cas)

References

• [django-cas](https://bitbucket.org/cpcc/django-cas)

• [CAS Protocol](http://www.jasig.org/cas/protocol)