Metadata-Version: 2.0
Name: edx-auth-backends
Version: 0.2.3
Summary: Custom edX authentication backends and pipeline steps
Home-page: https://github.com/edx/auth-backends
Author: edX
Author-email: oscm@edx.org
License: AGPL
Keywords: authentication edx
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Topic :: Internet
Requires-Dist: Django (>=1.8,<1.10)
Requires-Dist: python-social-auth (>=0.2.19,<1.0.0)
Requires-Dist: six (>=1.10.0,<2.0.0)

auth-backends  |Travis|_ |Codecov|_
===================================
.. |Travis| image:: https://travis-ci.org/edx/auth-backends.svg?branch=master
.. _Travis: https://travis-ci.org/edx/auth-backends

.. |Codecov| image:: http://codecov.io/github/edx/auth-backends/coverage.svg?branch=master
.. _Codecov: http://codecov.io/github/edx/auth-backends?branch=master

This repo houses custom authentication backends and pipeline steps used by edX
projects such as the `edx-analytics-dashboard <https://github.com/edx/edx-analytics-dashboard>`_
and `edx-ecommerce <https://github.com/edx/edx-ecommerce>`_.

This project is new and under active development.

Installation
------------

The `auth_backends` package can be installed from PyPI using pip::

    pip install edx-auth-backends

Overview
--------

Included backends:

===============  ============================================
Backend          Purpose
---------------  --------------------------------------------
Open ID Connect  Authenticate with the LMS, an OIDC provider.
===============  ============================================

`auth_backends` has been tested with Django 1.8 and 1.9.

Required Django settings:

============================================  ============================================
Setting                                       Default
--------------------------------------------  --------------------------------------------
SOCIAL_AUTH_EDX_OIDC_KEY                      None
SOCIAL_AUTH_EDX_OIDC_SECRET                   None
SOCIAL_AUTH_EDX_OIDC_ID_TOKEN_DECRYPTION_KEY  None
SOCIAL_AUTH_EDX_OIDC_URL_ROOT                 None
EXTRA_SCOPE                                   []
COURSE_PERMISSIONS_CLAIMS                     []
============================================  ============================================

Set these to the correct values for your OAuth2/OpenID Connect provider. ``SOCIAL_AUTH_EDX_OIDC_ID_TOKEN_DECRYPTION_KEY``
should be the same as ``SOCIAL_AUTH_EDX_OIDC_SECRET``. Set ``EXTRA_SCOPE`` equal to a list of scope strings to request
additional information from the edX OAuth2 provider at the moment of authentication (e.g., provide course permissions bits
to get a full list of courses).

Testing
-------

Call ``make test``.

License
-------

The code in this repository is licensed under the AGPL unless otherwise noted.

Please see ``LICENSE.txt`` for details.

How To Contribute
-----------------

Contributions are very welcome!

Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.

Even though it was written with `edx-platform <https://github.com/edx/edx-platform>`_ in mind,
the guidelines should be followed for Open edX code in general.

Reporting Security Issues
-------------------------

Please do not report security issues in public. Please email security@edx.org.

Mailing List and IRC Channel
----------------------------

You can discuss this code on the `edx-code Google Group <https://groups.google.com/forum/#!forum/edx-code>`_ or in the
``#edx-code`` IRC channel on Freenode.


.. :changelog:

History
=======

0.1.3 (2015-03-31)
------------------

- Update required version of Python Social Auth to 0.2.3.

0.1.2 (2015-02-23)
------------------

- Update required version of Python Social Auth to 0.2.2.

0.1.1 (2015-02-20)
------------------

- Initial release.


Renzo Lucioni <renzo@edx.org>


