security-and-privacy/ldapcherry
security-and-privacy
/
ldapcherry
mirror of https://github.com/kakwa/ldapcherry
1
0
Fork 0
Code Releases Activity

documentation for ppolicy API

This commit is contained in:
kakwa 2015-07-20 01:11:28 +02:00
parent 324eddf04f
commit 29abe4b1a8
1 changed files with 32 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/ppolicy_api.rst
View File

@ -1,7 +1,34 @@
Package ldapcherry.ppolicy
==========================
Implementing password policy modules
====================================
.. automodule:: ldapcherry.ppolicy
:members:
:undoc-members:
API
---
The password policy modules must respect following API:
.. autoclass:: ldapcherry.ppolicy.PPolicy
:members: check, info, __init__
:undoc-members: check
:show-inheritance:
Configuration
-------------
Parameters are declared in the main configuration file, inside the **ppolicy** section.
After having set **self.config** to **config** in the constructor, parameters can be recovered
by **self.get_param**:
.. autoclass:: ldapcherry.ppolicy.PPolicy
:members: get_param
:undoc-members: check
:show-inheritance:
Example
-------
Here is the simple default ppolicy module that comes with LdapCherry:
.. literalinclude:: ../ldapcherry/ppolicy/simple.py
:language: python