Metadata-Version: 1.1
Name: django-cas-ng
Version: 3.2.0
Summary: CAS 1.0/2.0 client authentication backend for Django (inherited from django-cas)
Home-page: https://github.com/mingchen/django-cas-ng
Author: Ming Chen
Author-email: mockey.chen@gmail.com
License: BSD
Download-URL: https://github.com/mingchen/django-cas-ng/releases
Description: Django CAS NG
        =============
        
        
        ``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+ `User custom model`_
        
        
        Installation
        ------------
        
        Install with `pip`_::
        
            pip install django-cas-ng
        
        Install from source::
        
            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``:
        
        * ``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. 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/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
        -------
        
        * `django-cas`_.
        * `Stefan Horomnea`_.
        * `Piotr Buliński`_.
        
        
        References
        ----------
        
        * `django-cas`_
        * `CAS protocol`_
        
        .. _CAS: http://www.jasig.org/cas
        .. _CAS protocol: http://www.jasig.org/cas/protocol
        .. _django-cas: https://bitbucket.org/cpcc/django-cas
        .. _pip: http://www.pip-installer.org/
        .. _PEP8: http://www.python.org/dev/peps/pep-0008
        .. _Django coding style: https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style
        .. _User custom model: https://docs.djangoproject.com/en/1.5/topics/auth/customizing/
        .. _Piotr Buliński: https://github.com/piotrbulinski
        .. _Stefan Horomnea: https://github.com/choosy
        
Keywords: django,cas,cas2,cas3,client,sso,single sign-on,authentication,auth
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP
