https://github.com/pior/pyramid_debugauth

Debug Authentication Policy for Pyramid
https://github.com/pior/pyramid_debugauth

pyramid-framework

Last synced: 2 days ago
JSON representation

Debug Authentication Policy for Pyramid

• Host: GitHub
• URL: https://github.com/pior/pyramid_debugauth
• Owner: pior
• Created: 2018-02-10T03:55:32.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-10T05:19:40.000Z (almost 7 years ago)
• Last Synced: 2024-12-27T22:57:41.420Z (about 1 month ago)
• Topics: pyramid-framework
• Language: Python
• Homepage: https://pypi.python.org/pypi/pyramid_debugauth
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst

Awesome Lists containing this project

README

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

Pyramid_debugauth

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

Debug Authentication Policy for Pyramid. Provide a simple and standard way to

define the pyramid principals from the HTTP client.

**Warning**: This pyramid is totally unsafe for production and should be

restricted to debug usage / development phase.

* PyPI: https://pypi.python.org/pypi/pyramid_debugauth

* Code: https://github.com/pior/pyramid_debugauth

* |travis-ci|

.. |travis-ci| image::

   https://travis-ci.org/pior/pyramid_debugauth.svg?branch=master

   :target: https://travis-ci.org/pior/pyramid_debugauth

   :alt: Tests on Travis-CI

Installation

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

Install using setuptools, e.g. (within a virtualenv)::

  $ pip install pyramid_debugauth

Setup

=====

Once ``pyramid_debugauth`` is installed, you can define a authentication policy

with ``config.set_authentication_policy``.

In your Pyramid project:

.. code-block:: python

   from pyramid.authorization import ACLAuthorizationPolicy

   from pyramid_debugauth import DebugAuthenticationPolicy

   config = Configurator(.....)

   config.set_authentication_policy(DebugAuthenticationPolicy())

   config.set_authorization_policy(ACLAuthorizationPolicy())

Usage

=====

The DebugAuthenticationPolicy allows a client to impersonate any user and

specify any number of principals desired using the standard *Authorization*

http header and a non-standard auth-scheme *Debug* (:rfc:`7235`):

``Authorization: Debug user_id [principal_1] [principal_2] ...``

With common http clients:

.. code-block:: bash

   $ curl http://localhost:6543 -H 'Authorization: Debug bob admin'

   $ http http://localhost:6543 'Authorization: Debug bob admin'

Or using a non-standard *authorization* query parameter:

``http://localhost:6543/protected?authorization=debug%20user_id%20principal_1``

With common http clients:

.. code-block:: bash

   $ curl http://localhost:6543?authorization=debug%20bob%20admin

   $ http http://localhost:6543?authorization=debug\ bob\ admin

Development

===========

Running tests::

   $ virtualenv venv

   $ . venv/bin/activate

   (venv)$ pip install -e .[dev]

   (venv)$ nosetests

Release

-------

::

   $ python setup.py sdist bdist_wheel

   ...

   $ twine upload dist/*

   ...