1Net::LDAP::Util(3) User Contributed Perl Documentation Net::LDAP::Util(3)
2
6 Net::LDAP::Util - Utility functions
7
9 use Net::LDAP::Util qw(ldap_error_text
10 ldap_error_name
11 ldap_error_desc
12 );
13 $mesg = $ldap->search( .... );
15 die "Error ",ldap_error_name($mesg) if $mesg->code;
17
19 Net::LDAP::Util is a collection of utility functions for use with the
20 Net::LDAP modules.
21
23 ldap_error_name ( ERR )
24 Returns the name corresponding with ERR. ERR can either be an LDAP
25 error number, or a "Net::LDAP::Message" object containing an error
26 code. If the error is not known the a string in the form ""LDAP
27 error code %d(0x%02X)"" is returned.
28 ldap_error_text ( ERR )
30 Returns the text from the POD description for the given error. ERR
31 can either be an LDAP error code, or a "Net::LDAP::Message" object
32 containing an LDAP error code. If the error code given is unknown
33 then "undef" is returned.
34 ldap_error_desc ( ERR )
36 Returns a short text description of the error. ERR can either be an
37 LDAP error code or a "Net::LDAP::Message" object containing an LDAP
38 error code.
39 canonical_dn ( DN [ , OPTIONS ] )
41 Returns the given DN in a canonical form. Returns undef if DN is
42 not a valid Distinguished Name. (Note: The empty string "" is a
43 valid DN.) DN can either be a string or reference to an array of
44 hashes as returned by ldap_explode_dn, which is useful when con‐
45 structing a DN.
46 It performs the following operations on the given DN:
48 * Removes the leading 'OID.' characters if the type is an OID
50 instead of a name.
51 * Escapes all RFC 2253 special characters (",", "+", """, "\",
53 "<", ">", ";", "#", "=", " "), slashes ("/"), and any other
54 character where the ASCII code is < 32 as \hexpair.
55 * Converts all leading and trailing spaces in values to be \20.
57 * If an RDN contains multiple parts, the parts are re-ordered so
59 that the attribute type names are in alphabetical order.
60 OPTIONS is a list of name/value pairs, valid options are:
62 casefold
64 Controls case folding of attribute type names. Attribute values
65 are not affected by this option. The default is to uppercase.
66 Valid values are:
67 lower
69 Lowercase attribute type names.
70 upper
72 Uppercase attribute type names. This is the default.
73 none
75 Do not change attribute type names.
76 mbcescape
78 If TRUE, characters that are encoded as a multi-octet UTF-8
79 sequence will be escaped as \(hexpair){2,*}.
80 reverse
82 If TRUE, the RDN sequence is reversed.
83 separator
85 Separator to use between RDNs. Defaults to comma (',').
86 ldap_explode_dn ( DN [ , OPTIONS ] )
88 Explodes the given DN into an array of hashes and returns a refer‐
89 ence to this array. Returns undef if DN is not a valid Distin‐
90 guished Name.
91 A Distinguished Name is a sequence of Relative Distinguished Names
93 (RDNs), which themselves are sets of Attributes. For each RDN a
94 hash is constructed with the attribute type names as keys and the
95 attribute values as corresponding values. These hashes are then
96 stored in an array in the order in which they appear in the DN.
97 For example, the DN 'OU=Sales+CN=J. Smith,DC=example,DC=net' is
99 exploded to:
100 [
101 {
102 'OU' => 'Sales',
103 'CN' => 'J. Smith'
104 },
105 {
106 'DC' => 'example'
107 },
108 {
109 'DC' => 'net'
110 }
111 ]
112 (RFC2253 string) DNs might also contain values, which are the bytes
114 of the BER encoding of the X.500 AttributeValue rather than some
115 LDAP string syntax. These values are hex-encoded and prefixed with
116 a #. To distinguish such BER values, ldap_explode_dn uses refer‐
117 ences to the actual values, e.g.
118 '1.3.6.1.4.1.1466.0=#04024869,DC=example,DC=com' is exploded to:
119 [
120 {
121 '1.3.6.1.4.1.1466.0' => "\004\002Hi"
122 },
123 {
124 'DC' => 'example'
125 },
126 {
127 'DC' => 'com'
128 }
129 ];
130 It also performs the following operations on the given DN:
132 * Unescape "\" followed by ",", "+", """, "\", "<", ">", ";",
134 "#", "=", " ", or a hexpair and and strings beginning with "#".
135 * Removes the leading 'OID.' characters if the type is an OID
137 instead of a name.
138 OPTIONS is a list of name/value pairs, valid options are:
140 casefold
142 Controls case folding of attribute types names. Attribute val‐
143 ues are not affected by this option. The default is to upper‐
144 case. Valid values are:
145 lower
147 Lowercase attribute types names.
148 upper
150 Uppercase attribute type names. This is the default.
151 none
153 Do not change attribute type names.
154 reverse
156 If TRUE, the RDN sequence is reversed.
157 escape_filter_value ( VALUES )
159 Escapes the given VALUES according to RFC 2254 so that they can be
160 safely used in LDAP filters.
161 Any control characters with an ACII code < 32 as well as the char‐
163 acters with special meaning in LDAP filters "*", "(", ")", and "\"
164 the backslash are converted into the representation of a backslash
165 followed by two hex digits representing the hexadecimal value of
166 the character.
167 Returns the converted list in list mode and the first element in
169 scalar mode.
170 unescape_filter_value ( VALUES )
172 Undoes the conversion done by escape_filter_value().
173 Converts any sequences of a backslash followed by two hex digits
175 into the corresponding character.
176 Returns the converted list in list mode and the first element in
178 scalar mode.
179 escape_dn_value ( VALUES )
181 Escapes the given VALUES according to RFC 2253 so that they can be
182 safely used in LDAP DNs.
183 The characters ",", "+", """, "\", "<", ">", ";", "#", "=" with a
185 special meaning in RFC 2252 are preceeded by ba backslash. Control
186 characters with an ASCII code < 32 are represented as \hexpair.
187 Finally all leading and trailing spaces are converted to sequences
188 of \20.
189 Returns the converted list in list mode and the first element in
191 scalar mode.
192 unescape_dn_value ( VALUES )
194 Undoes the conversion done by escape_dn_value().
195 Any escape sequence starting with a baskslash - hexpair or special
197 character - will be transformed back to the corresponding charac‐
198 ter.
199 Returns the converted list in list mode and the first element in
201 scalar mode.
202
204 Graham Barr <gbarr@pobox.com>
205
207 Copyright (c) 1999-2004 Graham Barr. All rights reserved. This program
208 is free software; you can redistribute it and/or modify it under the
209 same terms as Perl itself.
210 ldap_explode_dn and canonical_dn also
212 (c) 2002 Norbert Klasen, norbert.klasen@daasi.de, All Rights Reserved.
214perl v5.8.8 2007-02-10 Net::LDAP::Util(3)