Metadata-Version: 2.1
Name: django-cognito-jwt
Version: 0.0.2
Summary: Django backends for AWS Cognito JWT
Home-page: https://github.com/LabD/django-cognito-jwt
Author: Michael van Tellingen
Author-email: m.vantellingen@labdigital.nl
License: MIT
Description: ==================
        django-cognito-jwt
        ==================
        
        An Authentication backend for Django Rest Framework for AWS Cognito JWT tokens
        
        Status
        ======
        .. image:: https://travis-ci.org/labd/django-cognito-jwt.svg?branch=master
            :target: https://travis-ci.org/labd/django-cognito-jwt
        
        .. image:: http://codecov.io/github/LabD/django-cognito-jwt/coverage.svg?branch=master
            :target: http://codecov.io/github/LabD/django-cognito-jwt?branch=master
        
        .. image:: https://img.shields.io/pypi/v/django-cognito-jwt.svg
            :target: https://pypi.python.org/pypi/django-cognito-jwt/
        
        .. image:: https://readthedocs.org/projects/django-cognito-jwt/badge/?version=latest
            :target: https://django-cognito-jwt.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        Installation
        ============
        
        .. code-block:: shell
        
           pip install django-cognito-jwt
        
        Usage
        =====
        
        Add the following lines to your Django ``settings.py`` file:
        
        .. code-block:: python
        
            COGNITO_AWS_REGION = '<aws region>' # 'eu-central-1'
            COGNITO_USER_POOL = '<user pool>'   # 'eu-central-1_xYzaq'
            COGNITO_AUDIENCE = '<client id>'
        
        (Optional) If you want to cache the Cognito public keys between requests you can
        enable the ``COGNITO_PUBLIC_KEYS_CACHING_ENABLED`` setting (it only works if you
        have the Django ``CACHES`` setup to anything other than the dummy backend).
        
        .. code-block:: python
        
            COGNITO_PUBLIC_KEYS_CACHING_ENABLED = True
            COGNITO_PUBLIC_KEYS_CACHING_TIMEOUT = 60*60*24  # 24h caching, default is 300s
        
        Also update the rest framework settings to use the correct authentication backend:
        
        .. code-block:: python
        
            REST_FRAMEWORK = {
                'DEFAULT_AUTHENTICATION_CLASSES': [
                    ...
                    'django_cognito_jwt.JSONWebTokenAuthentication',
                   ...
                ],
                ...
             }
        
        Be sure you are passing the ID Token JWT from Cognito as the authentication header. Using the Access Token will work for authentication only but we're unable to use the `get_or_create_for_cognito` method with the Access Token.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: docs
Provides-Extra: test
