1Net::LDAP::Examples(3)User Contributed Perl DocumentationNet::LDAP::Examples(3)
2
6 Net::LDAP::Examples - PERL LDAP by Example
7
9 The following examples are of course PERL code, found to work with the
10 Net::LDAP modules.
11 The intent of this document is to give the reader a cut and paste jump
13 start to getting an LDAP application working.
14 Below you will find snippets of code that should work as-is with only a
16 small amount of work to correct any variable assignments and LDAP
17 specifics, e.g. Distinguished Name Syntax, related to the user's own
18 implementation.
19 The Standard Operating Proceedure that is followed here is:
21 1 Package - use Net::LDAP
23 2 Initialization - new
24 3 Binding - bind
25 4 Operation - add modify moddn search
26 4.1 Processing - displaying data from a search
27 5 Error - displaying error information
28 6 Unbinding - unbind
29 Look to each of these for a snippet of code to meet your needs.
31 What is not covered in these examples at this time:
33 abandon and compare methods
35 callback subroutines
36
38 PACKAGE - Definitions
39 use Net::LDAP;
41 INITIALIZING
43 $ldap = Net::LDAP->new ( "yourLDAPhost.yourCompany.com" ) or die "$@";
45 BINDING
47 $mesg = $ldap->bind ( version => 3 ); # use for searches
49 $mesg = $ldap->bind ( "$userToAuthenticate",
51 password => "$passwd",
52 version => 3 ); # use for changes/edits
53 # see your LDAP administrator for information concerning the
55 # user authentication setup at your site.
56 OPERATION - Generating a SEARCH
58 sub LDAPsearch
60 {
61 my ($ldap,$searchString,$attrs,$base) = @_;
62 # if they don't pass a base... set it for them
64 if (!$base ) { $base = "o=mycompany, c=mycountry"; }
66 # if they don't pass an array of attributes...
68 # set up something for them
69 if (!$attrs ) { $attrs = [ 'cn','mail' ]; }
71 my $result = $ldap->search ( base => "$base",
73 scope => "sub",
74 filter => "$searchString",
75 attrs => $attrs
76 );
77 }
79 my @Attrs = ( ); # request all available attributes
81 # to be returned.
82 my $result = LDAPsearch ( $ldap, "sn=*", \@Attrs );
84 PROCESSING - Displaying SEARCH Results
86 #------------
88 #
89 # Accessing the data as if in a structure
90 # i.e. Using the "as_struct" method
91 #
92 my $href = $result->as_struct;
94 # get an array of the DN names
96 my @arrayOfDNs = keys %$href; # use DN hashes
98 # process each DN using it as a key
100 foreach ( @arrayOfDNs ) {
102 print $_, "\n";
103 my $valref = $$href{$_};
104 # get an array of the attribute names
106 # passed for this one DN.
107 my @arrayOfAttrs = sort keys %$valref; #use Attr hashes
108 my $attrName;
110 foreach $attrName (@arrayOfAttrs) {
111 # skip any binary data: yuck!
113 next if ( $attrName =~ /;binary$/ );
114 # get the attribute value (pointer) using the
116 # attribute name as the hash
117 my $attrVal = @$valref{$attrName};
118 print "\t $attrName: @$attrVal \n";
119 }
120 print "#-------------------------------\n";
121 # End of that DN
122 }
123 #
124 # end of as_struct method
125 #
126 #--------
127 #------------
129 #
130 # handle each of the results independently
131 # ... i.e. using the walk through method
132 #
133 my @entries = $result->entries;
134 my $entr;
136 foreach $entr ( @entries ) {
137 print "DN: ", $entr->dn, "\n";
138 my $attr;
140 foreach $attr ( sort $entr->attributes ) {
141 # skip binary we can't handle
142 next if ( $attr =~ /;binary$/ );
143 print " $attr : ", $entr->get_value ( $attr ) ,"\n";
144 }
145 print "#-------------------------------\n";
147 }
148 #
150 # end of walk through method
151 #------------
152 OPERATION - Modifying entries
154 #
156 # Modify
157 #
158 # for each of the modifies below you'll need to supply
159 # a full DN (Distinguished Name) for the $dn variable.
160 # example:
161 # cn=Jo User,ou=person,o=mycompany,c=mycountry
162 #
163 # I would recommend doing a search (listed above)
164 # then use the dn returned to populate the $dn variable.
165 #
167 # Do we only have one result returned from the search?
168 if ( $result->count != 1 ) { exit; } # Nope.. exit
170 my $dn = $entries[0]->dn; # yes.. get the DN
172 #######################################
174 #
175 # MODIFY using a HASH
176 #
177 my %ReplaceHash = ( keyword => "x", proxy => "x" );
179 my $result = LDAPmodifyUsingHash ( $ldap, $dn, \%ReplaceHash );
181 sub LDAPmodifyUsingHash
183 {
184 my ($ldap, $dn, $whatToChange ) = @_;
185 my $result = $ldap->modify ( $dn,
186 replace => { %$whatToChange }
187 );
188 return $result;
189 }
190 #######################################
192 #
193 # MODIFY using a ARRAY List
194 #
195 my @ReplaceArrayList = [ 'keyword', "xxxxxxxxxx",
197 'proxy' , "yyyyyyyyyy" ];
198 my $result = LDAPmodifyUsingArrayList ( $ldap, $dn, \@ReplaceArrayList );
200 sub LDAPmodifyUsingArrayList
202 {
203 my ($ldap, $dn, $whatToChange ) = @_;
204 my $result = $ldap->modify ( $dn,
205 changes => [
206 replace => @$whatToChange
207 ]
208 );
209 return $result;
210 }
211 #######################################
213 #
214 # MODIFY using a ARRAY
215 #
216 my @ReplaceArray = ( 'keyword', "xxxxxxxxxx" ,
218 'proxy' , "yyyyyyyyyy" );
219 my $result = LDAPmodifyUsingArray ( $ldap, $dn, \@ReplaceArray );
221 sub LDAPmodifyUsingArray
223 {
224 my ($ldap, $dn, $whatToChange ) = @_;
225 my $result = $ldap->modify ( $dn,
226 changes => [
227 replace => [ @$whatToChange ]
228 ]
229 );
230 return $result;
231 }
232 #######################################
234 #
235 # MODIFY an existing record using 'Changes'
236 # (or combination of add/delete/replace)
237 #
238 my @whatToChange;
240 my @ReplaceArray;
241 my @DeleteArray;
242 my @AddArray;
243 push @AddArray, 'cn', "me myself";
245 push @ReplaceArray, 'sn', '!@#$%^&*()__+Hello THere';
246 push @ReplaceArray, 'cn', "me myself I";
247 push @DeleteArray, 'cn', "me myself";
248 if ( $#ReplaceArray > 0 ) {
250 push @whatToChange, 'replace';
251 push @whatToChange, \@ReplaceArray;
252 }
253 if ( $#DeleteArray > 0 ) {
254 push @whatToChange, 'delete';
255 push @whatToChange, \@DeleteArray;
256 }
257 if ( $#AddArray > 0 ) {
258 push @whatToChange, 'add';
259 push @whatToChange, \@AddArray;
260 }
261 $result = LDAPmodify ( $ldap, $dn, \@whatToChange );
263 sub LDAPmodify
265 {
266 my ($ldap, $dn, $whatToChange) = @_;
267 my $result = $ldap->modify ( $dn,
269 changes => [
270 @$whatToChange
271 ]
272 );
273 return $result;
274 }
275 OPERATION - Changing the RDN
277 my $newRDN = "cn=Joseph User";
279 my $result = LDAPrdnChange ( $ldap, $dn, $newRDN, "archive" );
281 sub LDAPrdnChange
283 {
284 my ($ldap,$dn,$whatToChange,$action) = @_;
285 my $branch;
287 #
289 # if the archive action is selected, move this
290 # entry to another place in the directory.
291 #
292 if ( $action =~ /archive/i ) {
293 $branch = "ou=newbranch, o=mycompany, c=mycountry";
294 }
295 #
297 # use the 'deleteoldrdn' to keep from getting
298 # multivalues in the NAMING attribute.
299 # in most cases that would be the 'CN' attribute
300 #
301 my $result = $ldap->moddn ( $dn,
302 newrdn => $whatToChange,
303 deleteoldrdn => '1',
304 newsuperior => $branch
305 );
306 return $result;
308 }
310 OPERATION - Adding a new Record
312 my $DNbranch = "ou=bailiwick, o=mycompany, c=mycountry";
314 #
316 # check with your Directory Schema or Administrator
317 # for the correct objectClass... I'm sure it'll be different
318 #
319 my $CreateArray = [
320 objectClass => [ "top", "person", "organizationalPerson", "inetOrgPerson" ],
321 cn => "Jane User",
322 uid => "0000001",
323 sn => "User",
324 mail => "JaneUser@mycompany.com"
325 ];
326 #
328 # create the new DN to look like this
329 # " cn=Jo User + uid=0000001 , ou=bailiwick, o=mycompany, c=mycountry "
330 #
331 # NOTE: this DN MUST be changed to meet your implementation
332 #
333 my $NewDN = "@$CreateArray[2]=".
335 "@$CreateArray[3]+".
336 "@$CreateArray[4]=".
337 "@$CreateArray[5],".
338 $DNbranch;
339 LDAPentryCreate($ldap, $NewDN, $CreateArray);
341 #
343 # CreateArray is a reference to an anonymous array
344 # you have to dereference it in the subroutine it's
345 # passed to.
346 #
347 sub LDAPentryCreate
349 {
350 my ($ldap, $dn, $whatToCreate) = @_;
351 my $result = $ldap->add ( $dn, attrs => [ @$whatToCreate ] );
352 return $result;
353 }
354 ERROR - Retrieving and Displaying ERROR information
356 if ( $result->code ) {
358 #
359 # if we've got an error... record it
360 #
361 LDAPerror ( "Searching", $result );
362 }
363 sub LDAPerror
365 {
366 my ($from, $mesg) = @_;
367 print "Return code: ", $mesg->code;
368 print "\tMessage: ", $mesg->error_name;
369 print " :", $mesg->error_text;
370 print "MessageID: ", $mesg->mesg_id;
371 print "\tDN: ", $mesg->dn;
372 #---
374 # Programmer note:
375 #
376 # "$mesg->error" DOESN'T work!!!
377 #
378 #print "\tMessage: ", $mesg->error;
379 #-----
380 }
381 UNBIND
383 $ldap->unbind;
385
387 The following code snippet shows how to retrieve schema information.
388 The first procedure is to initialize a new LDAP object using the same
390 procedures as listed at the beginning of this document.
391 The second procedure is to bind to your directory server. Some servers
393 may require authentication to retrieve the schema from the directory
394 server. This procedure is listed at the beginning of this document
395 too.
396 After a successful bind you are ready to retrieve the schema informa‐
398 tion. You do this by initializing a schema object.
399 $schema = $ldap->schema ( );
401 In this case Net::LDAP will attempt to determine the dn under which the
403 schema can be found. First it will look for the attribute "subschema‐
404 subentry" in the root DSE. If that cannot be found then it will default
405 to the assumption of "cn=schema"
406 Alternatively you can specify the dn where the schema is to be found
408 with
409 $schema = $ldap->schema ( dn => $dn );
411 Once we have a dn to search for, Net::LDAP will fetch the schema entry
413 with
414 $mesg = $self->search ( base => $dn,
416 scope => 'base',
417 filter => '(objectClass=subschema)',
418 );
419 Once the schema object has been initialized, schema methods are used to
421 retrieve the data. There are a number of ways this can be done.
422 Information on the schema methods can be found in the Net::LDAP::Schema
423 pod documentation.
424 The following is a code snippet showing how to get and display informa‐
426 tion about returned attributes.
427 #
429 # Get the attributes
430 #
431 @attributes = $schema->all_attributes ( );
433 #
435 # Display the attributes
436 #
437 foreach $ar ( @attributes ) {
439 print "attributeType: ", $ar->{name}, "\n";
440 #
442 # Print all the details
443 #
444 foreach $key ( keys %{$ar} ) {
446 print join ( "\n\t\t", "\t$key:",
447 ref ( $ar->{$key} ) ? @{$ar->{$key}} : $ar->{$key}
448 ), "\n";
449 }
450 }
451 The process is the basically the same for getting objectClass informa‐
453 tion. Where schema->all_attributes() is used, substitute
454 schema->all_objectclasses(). From that point on the process is the
455 same for both objectClasses and attributes.
456
458 None known, but there may be some
459
461 Russell Biggs <rgb@ticnet.com>
462
464 All rights to this document are hereby relinquished to Graham Barr.
465perl v5.8.8 2007-02-10 Net::LDAP::Examples(3)