% $Id: ldapurl.tex,v 1.9 2007/03/27 22:10:17 stroeder Exp $

% ==== 1. ====
% The section prologue.  Give the section a title and provide some
% meta-information.  References to the module should use
% \refbimodindex, \refstmodindex, \refexmodindex or \refmodindex, as
% appropriate.

\section{\module{ldapurl} ---
         LDAP URL handling}

\declaremodule{standard}{ldapurl}

% Author of the module code;
\moduleauthor{python-ldap developers}{python-ldap-dev@lists.sourceforge.net}
% Author of the documentation,
\sectionauthor{Michael Str\"oder}{michael@stroeder.com}

% Leave at least one blank line after this, to simplify ad-hoc tools
% that are sometimes used to massage these files.
\modulesynopsis{Parses and generates LDAP URLs}


% ==== 2. ====
% Give a short overview of what the module does.
% If it is platform specific, mention this.
% Mention other important restrictions or general operating principles.

This module parses and generates LDAP URLs.

It is implemented in pure Python and does not rely on any
non-standard modules. Therefore it can be used stand-alone without
the rest of the python-ldap package.

Compability note: This module has been solely tested on Python 2.x and above.

The \module{ldapurl} module exports the following constants:

\begin{datadesc}{SEARCH_SCOPE}
  This dictionary maps a search scope string identifier
  to the corresponding integer value used with search operations
  in \module{ldap}.
\end{datadesc}

\begin{datadesc}{SEARCH_SCOPE_STR}
  This dictionary is the inverse to \constant{SEARCH_SCOPE}. It
  maps a search scope integer value to the corresponding string identifier
  used in a LDAP URL string representation.
\end{datadesc}

\begin{datadesc}{LDAP_SCOPE_BASE}
  
\end{datadesc}

\begin{datadesc}{LDAP_SCOPE_ONELEVEL}
  
\end{datadesc}

\begin{datadesc}{LDAP_SCOPE_SUBTREE}
  
\end{datadesc}


\begin{seealso}
\seerfc{4516}{The LDAP URL Format}{}
\end{seealso}

\subsection{LDAPUrl Objects \label{ldapurl-ldapurl}}
A \class{LDAPUrl} object represents a complete LDAP URL.

All class methods:

Class attributes:

Instance attributes:


\subsection{LDAPUrlExtension Objects \label{ldapurl-ldapurlextension}}
A \class{LDAPUrlExension} object represents a single LDAP URL extension.

All class methods:

Class attributes:

Instance attributes:


\subsection{Example \label{ldapurl-example}}

Important security advice:
For security reasons you shouldn't specify passwords in LDAP URLs
unless you really know what you are doing.

The following example demonstrates how to parse a LDAP URL
with \module{ldapurl} module.

\begin{verbatim}
>>> import ldapurl
>>> ldap_url = ldapurl.LDAPUrl('ldap://localhost:1389/dc=stroeder,dc=com?cn,mail???bindname=cn=Michael%2cdc=stroeder%2cdc=com,X-BINDPW=secret')
>>> # Using the parsed LDAP URL by reading the class attributes
>>> ldap_url.dn
'dc=stroeder,dc=com'
>>> ldap_url.hostport
'localhost:1389'
>>> ldap_url.attrs
['cn','mail']
>>> ldap_url.filterstr
'(objectclass=*)'
>>> ldap_url.who
'cn=Michael,dc=stroeder,dc=com'
>>> ldap_url.cred
'secret'
>>> ldap_url.scope
0
\end{verbatim}

The following example demonstrates how to generate a LDAP URL
with \module{ldapurl} module.

\begin{verbatim}
>>> import ldapurl
>>> ldap_url = ldapurl.LDAPUrl(hostport='localhost:1389',dn='dc=stroeder,dc=com',attrs=['cn','mail'],who='cn=Michael,dc=stroeder,dc=com',cred='secret')
>>> ldap_url.unparse()
'ldap://localhost:1389/dc=stroeder,dc=com?cn,mail?base?(objectclass=*)?bindname=cn=Michael%2Cdc=stroeder%2Cdc=com,X-BINDPW=secret'
\end{verbatim}
