Metadata-Version: 2.1
Name: Products.LDAPMultiPlugins
Version: 3.0
Summary: LDAP-backed plugins for the Zope PluggableAuthService
Home-page: https://github.com/dataflake/LDAPMultiPlugins
Author: Jens Vagelpohl and contributors
Author-email: jens@dataflake.org
License: ZPL 2.1
Project-URL: Issue Tracker, https://github.com/dataflake/Products.LDAPMultiPlugins/issues
Project-URL: Sources, https://github.com/dataflake/Products.LDAPMultiPlugins
Keywords: web application server zope zope2 ldap
Platform: UNKNOWN
Classifier: Development Status :: 6 - Mature
Classifier: Framework :: Zope
Classifier: Framework :: Zope :: 4
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 2 :: Only
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory :: LDAP
Requires-Python: >=2.7,<3
Requires-Dist: setuptools
Requires-Dist: Zope (<5,>=4.0b5)
Requires-Dist: Products.LDAPUserFolder (<4)
Requires-Dist: Products.PluggableAuthService (<3)
Provides-Extra: docs
Requires-Dist: Sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: repoze.sphinx.autointerface ; extra == 'docs'
Requires-Dist: pkginfo ; extra == 'docs'
Provides-Extra: exportimport
Requires-Dist: Products.GenericSetup (>=2.0b1) ; extra == 'exportimport'

.. image:: https://github.com/dataflake/Products.LDAPMultiPlugins/actions/workflows/tests.yml/badge.svg?branch=3.x
   :target: https://github.com/dataflake/Products.LDAPMultiPlugins/actions/workflows/tests.yml
   :alt: Automated test results

.. image:: https://coveralls.io/repos/github/dataflake/Products.LDAPMultiPlugins/badge.svg?branch=3.x
   :target: https://coveralls.io/github/dataflake/Products.LDAPMultiPlugins?branch=3.x
   :alt: Test coverage

.. image:: https://img.shields.io/pypi/v/Products.LDAPMultiPlugins.svg
   :target: https://pypi.python.org/pypi/Products.LDAPMultiPlugins
   :alt: Current version on PyPI

.. image:: https://img.shields.io/pypi/pyversions/Products.LDAPMultiPlugins.svg
   :target: https://pypi.org/project/Products.LDAPMultiPlugins
   :alt: Supported Python versions


===========================
 Products.LDAPMultiPlugins
===========================

The LDAPMultiPlugins package provides `PluggableAuthService
<https://productspluggableauthservice.readthedocs.io>`_ plugins that use
LDAP as the backend for the services they provide. The PluggableAuthService
is a Zope user folder product that can be extended in modular fashion using
so-called plugins.

The plugins in this package provide a PluggableAuthService-compatible shim
around a `LDAPUserFolder <https://productsldapuserfolder.readthedocs.io>`_
instance. After instantiating a plugin all further configuration is done on the
LDAPUserFolder object itself, which is created automatically inside the plugin.
Visit the `ZMI` `Configure` tab to find it.


Bug tracker
===========
Please post questions, bug reports or feature requests to the bug tracker
at https://github.com/dataflake/Products.LDAPMultiPlugins/issues


Special features - Active Directory Multi Plugin
================================================
Properties of the ADMultiPlugin instance:

- groupid_attr - the LDAP attribute used for group ids.

- grouptitle_attr - the LDAP attribute used to compose group titles.

- group_class - the LDAP class of group objects.

- group_recurse - boolean indicating whether to determine group
  memberships of a user by unrolling nested group relationships
  (expensive). This feature is not guaranteed to work at this moment.


Active Directory configuration hints
====================================
In order for groups support to work correctly, you may have to set the
following properties. Every situation is different, but this has helped
some people succeed:

- On the "Properties" tab for the ActiveDirectoryMultiPlugin, set the
  groupid_attr property to "name".

- On the contained LDAPUserFolder's "Configure" tab, choose a 
  property other than "objectGUID", e.g. "sAMAccountName" for the
  User ID property. To get to the LDAPUserFolder, click on the
  ActiveDirectoryMultiPlugin "Content" tab.

Please see README.ActiveDirectory from the LDAPUserFolder package for
additional information.


