Skip to content

Latest commit

 

History

History
194 lines (131 loc) · 5.49 KB

README.rst

File metadata and controls

194 lines (131 loc) · 5.49 KB
Raw

Django CAS NG

https://travis-ci.org/mingchen/django-cas-ng.svg?branch=master

django-cas-ng is CAS (Central Authentication Service) client implementation. This project inherit from django-cas. django-cas is not updated since 2013-4-1. This project will include new bugfix and new feature development.

Features

  • Support CAS version 1.0, 2.0 and 3.0.
  • Support Django 1.5, 1.6, 1.7 with User custom model
  • Support Python 2.7, 3.x

Installation

Install with pip:

pip install django-cas-ng

Install the latest code:

pip install https://github.com/mingchen/django-cas-ng/archive/master.zip

Install from source code:

python setup.py install

Settings

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:

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_CREATE_USER: Create a user when the CAS authentication is successful. The default is True.

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

    CAS_EXTRA_LOGIN_PARAMS = {'renew': true}

  • CAS_RENEW: whether pass renew parameter on login and verification of ticket to enforce that the login is made with a fresh username and password verification in the CAS server. Default is False.

  • 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/#$', '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.

Signals

django_cas_ng.signals.cas_user_authenticated

Sent on successful authentication, the CASBackend will fire the cas_user_authenticated signal.

Arguments sent with this signal

sender
The authentication backend instance that authenticated the user.
user
The user instance that was just authenticated.
created
Boolean as to whether the user was just created.
attributes
Attributes returned during by the CAS during authentication.
ticket
The ticket used to authenticate the user with the CAS.
service
The service used to authenticate the user with the CAS.

Testing

Every code commit triggers a travis-ci build. checkout current build status at https://travis-ci.org/mingchen/django-cas-ng

Testing is managed by pytest and tox. Before run install, you need install required packages for testing:

pip install -r requirements-dev.txt

To run testing on locally:

py.test

To run all testing on all enviroments locally:

tox

Contribution

Contributions are welcome!

If you would like to contribute this project. Please feel free to fork and send pull request. Please make sure tests are passed. Also welcome to add your name to Credits section of this document.

New code should follow both PEP8 and the Django coding style.

Credits

References