Metadata-Version: 1.1
Name: pyramid-debugauth
Version: 0.2.0
Summary: Debug Authentication Policy for Pyramid
Home-page: https://github.com/pior/pyramid_debugauth
Author: Pior Bastida
Author-email: pior@pbastida.net
License: BSD-derived (http://www.repoze.org/LICENSE.txt)
Description-Content-Type: UNKNOWN
Description: =================
        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
        
        
        Changelog
        =========
        
        0.2.0 (2018-02-09)
        ------------------
        
        * Switch to Github
        * Switch to setuptools (from d2to1)
        * Fix crash in tests with recent versions of Pyramid
        
        0.1.2 (2014-12-03)
        ------------------
        
        * Permit setting a custom callback.
        
        0.1.1 (2014-09-09)
        ------------------
        
        * Add ability to authenticate via Query String
        
        0.0.2 (2014-09-08)
        ------------------
        
        * Minimal feature set
        * First release on PyPI
        
Keywords: wsgi pylons pyramid auth authentication debug
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Framework :: Pyramid
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
