From abef0bb5f3f4cbade4a0f64102c85018110a15f9 Mon Sep 17 00:00:00 2001 From: stroeder Date: Sat, 24 Oct 2015 12:49:41 +0000 Subject: [PATCH] Added stub for ldap.sasl --- Doc/index.rst | 3 ++- Doc/ldap-sasl.rst | 69 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 Doc/ldap-sasl.rst diff --git a/Doc/index.rst b/Doc/index.rst index ad86059..2338eb2 100644 --- a/Doc/index.rst +++ b/Doc/index.rst @@ -2,7 +2,7 @@ python-ldap Documentation ########################## -.. % $Id: index.rst,v 1.8 2011/10/26 19:42:45 stroeder Exp $ +.. % $Id: index.rst,v 1.9 2015/10/24 12:49:41 stroeder Exp $ .. topic:: Abstract @@ -30,6 +30,7 @@ Contents ldap-resiter.rst ldap-schema.rst ldap-syncrepl.rst + ldap-sasl.rst ldif.rst ldapurl.rst dsml.rst diff --git a/Doc/ldap-sasl.rst b/Doc/ldap-sasl.rst new file mode 100644 index 0000000..dd5fce3 --- /dev/null +++ b/Doc/ldap-sasl.rst @@ -0,0 +1,69 @@ +.. % $Id: ldap-sasl.rst,v 1.1 2015/10/24 12:49:41 stroeder Exp $ + + +******************************************** +:py:mod:`ldap.sasl` Handling LDAPv3 schema +******************************************** + +.. py:module:: ldap.sasl + +This module implements various authentication methods for SASL bind. + +.. seealso:: + + :rfc:`4422` - Simple Authentication and Security Layer (SASL) + + +:py:mod:`ldap.sasl` SASL bind requests +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. py:module:: ldap.sasl + + +.. py:data:: CB_USER + +.. py:data:: CB_AUTHNAME + +.. py:data:: CB_LANGUAGE + +.. py:data:: CB_PASS + +.. py:data:: CB_ECHOPROMPT + +.. py:data:: CB_NOECHOPROMPT + +.. py:data:: CB_GETREALM + + +Functions +========= + +.. autofunction:: ldap.sasl.subentry.urlfetch + +Classes +======= + +.. autoclass:: ldap.sasl.sasl + :members: + +.. autoclass:: ldap.sasl.cram_md5 + :members: + +.. autoclass:: ldap.sasl.digest_md5 + :members: + +.. autoclass:: ldap.sasl.gssapi + :members: + +.. autoclass:: ldap.sasl.external + :members: + + +.. _ldap.sasl-example: + +Examples for ldap.sasl +^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + import ldap.sasl