Metadata-Version: 1.1
Name: django-federated-login
Version: 1.0.0
Summary: Provides federated login (SSO) to Django projects
Home-page: http://github.com/Bouke/django-federated-login
Author: Bouke Haarsma
Author-email: bouke@webatoom.nl
License: MIT
Description: ======================
        Django Federated Login
        ======================
        
        .. image:: https://travis-ci.org/Bouke/django-federated-login.png?branch=master
            :alt: Build Status
            :target: https://travis-ci.org/Bouke/django-federated-login
        
        .. image:: https://coveralls.io/repos/Bouke/django-federated-login/badge.png?branch=master
            :alt: Test Coverage
            :target: https://coveralls.io/r/Bouke/django-federated-login?branch=master
        
        .. image:: https://badge.fury.io/py/django-federated-login.png
            :alt: PyPI
            :target: https://pypi.python.org/pypi/django-federated-login
        
        Django Federated Login provides an authentication bridge between Django
        projects and OpenID-enabled identity providers. The bridge is pre-wired to be
        used with a single Google Apps domain, but could be extended to be linked with
        other OpenID providers also. It is different from other OpenID consumers as
        this consumer only allows connecting to a pre-defined identity provider.
        
        The provided backend matches users based on the e-mail address returned from
        the identity provider. If no matching user could be found, a user account can
        optionally be created.
        
        I would love to hear your feedback on this package. If you run into
        problems, please file an issue on GitHub, or contribute to the project by
        forking the repository and sending some pull requests.
        
        Compatible with Django 1.4, 1.5 and 1.6 on Python 2.6, 2.7, 3.2 and 3.3. Python
        3 is supported through the python3-openid fork.
        
        Installation
        ============
        
        Installation with ``pip``::
        
            $ pip install django-federated-login
        
        Add ``'federated_login.auth_backend.EmailBackend'`` as authentication backend::
        
            settings.py:
            AUTHENTICATION_BACKENDS = (
                'federated_login.auth_backends.EmailBackend',
                'django.contrib.auth.backends.ModelBackend',
            )
        
        Add ``'federated_login'`` as installed app::
        
            settings.py:
            INSTALLED_APPS = (
                ...
                'federated_login',
            )
        
        Provide the Google Apps domain to identify against::
        
            settings.py:
            FL_APPS_DOMAIN = 'webatoom.nl'
        
        For Django 1.6, need to configure session serializer::
        
            settings.py:
            SESSION_SERIALIZER = 'django.contrib.sessions.serializers.PickleSerializer'
        
        Register the views::
        
            urls.py:
            url(r'^federated/', include('federated_login.urls')),
        
        Sync or migrate your database::
        
            python manage.py syncdb
            # or if you use South:
            python manage.py migrate federated_login
        
        Usage
        =====
        
        Point your browser to ``/federated/login/``. You might want to include a
        button to this url on the regular login page. You could also use the federated
        login page as the default login page, replacing the username and password login
        pages. To do this, configure the ``LOGIN_`` settings:
        ::
        
            settings.py:
            LOGIN_REDIRECT_URL = '/'
            LOGIN_URL = '/federated/login/'
        
        
        Settings
        ========
        
        These are the customizable settings:
        
        ``FL_APPS_DOMAIN``
            Google Apps domain to identify against. Can be overriden by
            ``FL_SSO_ENDPOINT``.
        
        ``FL_USER_FACTORY`` (Default: ``'federated_login.user_factories.normal'``)
            Function that is called when creating a user account. Set to `None` to
            disable creation of new users. There is also
            ``'federated_login.user_factories.staff'`` that creates staff users and
            ``'federated_login.user_factories.superuser'`` that creates superusers.
        
        ``FL_SSO_ENDPOINT`` (Default: Google Apps)
            Override this setting to link with another OpenID identity provider. The
            ``FL_APPS_DOMAIN`` setting will have no effect when providing a custom
            ``FL_SSO_ENDPOINT``.
        
        ``FL_USER_CLASS`` (Default: ``'django.contrib.auth.models.User'``)
            Django model class to used to create and query for users.
        
        ``FL_PATCH_ADMIN`` (Default: ``True``)
            Django's admin site is automatically patched to use federated login. Set
            this setting to ``False`` to disable this feature. You can call
            ``federated_login.admin.patch_admin()`` and
            ``federated_login.admin.unpatch_admin()`` to respectively patch and
            unpatch the admin site.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Security
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
