https://github.com/Kinto/kinto-portier

Kinto authentication backend for Portier
https://github.com/Kinto/kinto-portier

Last synced: about 2 months ago
JSON representation

Kinto authentication backend for Portier

• Host: GitHub
• URL: https://github.com/Kinto/kinto-portier
• Owner: Kinto
• License: other
• Created: 2016-12-12T15:32:39.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-08T01:13:27.000Z (over 1 year ago)
• Last Synced: 2024-04-23T16:21:50.353Z (5 months ago)
• Language: Python
• Size: 139 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 19
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - Kinto/kinto-portier - Kinto authentication backend for Portier (others)

README

        
Portier authentication support for Kinto

========================================

|travis| |master-coverage|

.. |travis| image:: https://travis-ci.org/Kinto/kinto-portier.svg?branch=master

    :target: https://travis-ci.org/Kinto/kinto-portier

.. |master-coverage| image::

    https://coveralls.io/repos/Kinto/kinto-portier/badge.png?branch=master

    :alt: Coverage

    :target: https://coveralls.io/r/Kinto/kinto-portier

*kinto-portier* enables authentication in *Kinto* applications using

an email address.

It provides:

* An authentication policy class;

* Integration with *Kinto* cache backend for token verifications;

* Integration with *Kinto* for heartbeat view checks;

* Some optional endpoints to perform the *OAuth* dance (*optional*).

* `Kinto documentation `_

* `Issue tracker `_

Installation

------------

Install the Python package:

::

    pip install kinto-portier

Include the package in the project configuration:

.. code-block:: ini

    kinto.includes = kinto_portier

And configure authentication policy using `pyramid_multiauth

`_ formalism:

.. code-block:: ini

    multiauth.policies = portier

    multiauth.policy.portier.use = kinto_portier.authentication.PortierOAuthAuthenticationPolicy

By default, it will rely on the cache configured in *Kinto*.

Configuration

-------------

Fill those settings with the values obtained during the application registration:

.. code-block:: ini

    kinto.portier.broker_url = https://broker.portier.io

    kinto.portier.webapp.authorized_domains = *.github.io

    # kinto.portier.cache_ttl_seconds = 300

    # kinto.portier.state.ttl_seconds = 3600

Login flow

----------

OAuth Bearer token

::::::::::::::::::

Use the OAuth token with this header:

::

    Authorization: Portier 

:notes:

    If the token is not valid, this will result in a ``401`` error response.