1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
% $Id: ldap-dn.tex,v 1.3 2007/03/27 22:16:45 stroeder Exp $
\section{\module{ldap.dn} ---
LDAP Distinguished Name handling }
\declaremodule{standard}{ldap.dn}
% Author of the module code;
\moduleauthor{Michael Str\"oder}{python-ldap-dev@lists.sourceforge.net}
% Author of the documentation,
\sectionauthor{Michael Str\"oder}{michael@stroeder.com}
\modulesynopsis{LDAP Distinguished Name handling.}
\begin{seealso}
\seerfc{4514}{Lightweight Directory Access Protocol (LDAP): String Representation of Distinguished Names.}{}
\end{seealso}
The \module{ldap.dn} module defines the following functions:
\begin{funcdesc}{escape_dn_chars}{s} % -> string
This function escapes characters in string \var{s} which
are special in LDAP distinguished names. You should use this function when
building LDAP DN strings from arbitrary input.
\end{funcdesc}
\begin{funcdesc}{str2dn}{s} % -> list
This function takes \var{dn} and breaks it up into its component parts
down to AVA level.
\end{funcdesc}
\begin{funcdesc}{explode_dn}{dn \optional{, notypes=\constant{0}}} % -> list
This function takes \var{dn} and breaks it up into its component parts.
Each part is known as an RDN (Relative Distinguished Name). The
\var{notypes} parameter is used to specify that only the RDN values be
returned and not their types.
For example, the DN \code{"cn=Bob, c=US"} would be
returned as either \code{["cn=Bob", "c=US"]} or \code{["Bob","US"]}
depending on whether \var{notypes} was \constant{0} or \constant{1},
respectively.
\end{funcdesc}
\begin{funcdesc}{explode_rdn}{rdn \optional{, notypes=\constant{0}}} % -> list
This function takes a (multi-valued) \var{rdn} and breaks it up
into a list of characteristic attributes. The
\var{notypes} parameter is used to specify that only the RDN values be
returned and not their types.
\end{funcdesc}
|
