Metadata-Version: 1.1
Name: kinto-ldap
Version: 0.2.1
Summary: LDAP support for Kinto
Home-page: https://github.com/Kinto/kinto-ldap
Author: Mozilla Services
Author-email: services-dev@mozilla.com
License: Apache License (2.0)
Description: kinto-ldap
        ==========
        
        |travis| |master-coverage|
        
        .. |master-coverage| image::
            https://coveralls.io/repos/Kinto/kinto-ldap/badge.svg?branch=master
            :alt: Coverage
            :target: https://coveralls.io/r/Kinto/kinto-ldap
        
        .. |travis| image:: https://travis-ci.org/Kinto/kinto-ldap.svg?branch=master
            :target: https://travis-ci.org/Kinto/kinto-ldap
        
        
        Validate Basic Auth provided user login and password with an LDAP server.
        
        
        Dependencies
        ------------
        
        Before installing you will need the following system dependencies:
        
        On Debian based systems::
        
            sudo apt-get install libsasl2-dev python-dev libldap2-dev libssl-dev
        
        On RPM based systems::
        
            sudo yum install openldap-devel openssl-devel python-devel
        
        Installation
        ------------
        
        Install the Python package:
        
        ::
        
            pip install kinto-ldap
        
        
        Include the package in the project configuration:
        
        ::
        
            kinto.includes = kinto_ldap
        
        And configure authentication policy using `pyramid_multiauth
        <https://github.com/mozilla-services/pyramid_multiauth#deployment-settings>`_ formalism:
        
        ::
        
            multiauth.policies = ldap
        
        By default, it will rely on the cache configured in *Kinto*.
        
        
        Configuration
        -------------
        
        ::
        
            multiauth.policy.ldap.use = kinto_ldap.authentication.LDAPBasicAuthAuthenticationPolicy
        
            # kinto.ldap.cache_ttl_seconds = 30
            # kinto.ldap.endpoint = ldap://ldap.prod.mozaws.net
            # kinto.ldap.fqn = "uid={uid},ou=users,dc=mozilla"
        
        If necessary, override default values for authentication policy:
        
        ::
        
            # multiauth.policy.ldap.realm = Realm
            # kinto.ldap.pool_size = 10
            # kinto.ldap.pool_retry_max = 3
            # kinto.ldap.pool_retry_delay = .1
            # kinto.ldap.pool_timeout = 30
        
        
        CHANGELOG
        =========
        
        This document describes changes between each past release.
        
        
        0.2.1 (2016-11-03)
        ------------------
        
        **Bug fixes**
        
        - Fix heartbeat that would always return False
        
        
        0.2.0 (2016-11-02)
        ------------------
        
        - Set default value for ``multiauth.policy.ldap.use`` (fixes #3)
        - Add the plugin version in the capability.
        
        **New features**
        
        - Add connection pool settings (fixes #10)
        
        **Bug fixes**
        
        - Fix heartbeat when server is unreachable (fixes #8)
        - Returns None and log exception if LDAP backend cannot be reached (fixes #9)
        
        0.1.0 (2016-06-27)
        ------------------
        
        - Basic Auth Authentication for LDAP.
        
        
        Contributors
        ============
        
        * Rémy Hubscher <rhubscher@mozilla.com>
        * Tarek Ziade <tarek@mozilla.com>
        
Keywords: web services
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: License :: OSI Approved :: Apache Software License
