Net::LDAP - Lightweight Directory Access Protocol
use Net::LDAP;
$ldap = Net::LDAP->new('ldap.bigfoot.com') or die "$@";
$ldap->bind ; # an anonymous bind
$mesg = $ldap->search ( # perform a search
base => "c=US",
filter => "(&(sn=Barr) (o=Texas Instruments))"
);
$mesg->code && die $mesg->error;
foreach $entry ($mesg->all_entries) { $entry->dump; }
$ldap->unbind; # take down session
$ldap = Net::LDAP->new('ldap.umich.edu');
$ldap->bind ( # bind to a directory with dn and password
dn => 'cn=root, o=University of Michigan, c=us',
password => 'secret'
);
$result = $ldap->add (
dn => 'cn = Barbara Jensen, o=University of Michigan, c=us',
attr => [ 'cn' => ['Barbara Jensen', 'Barbs Jensen'],
'sn => 'Jensen',
'mail' => 'b.jensen@umich.edu',
'objectclass' => ['top', 'person',
'organizationalPerson',
'inetOrgPerson' ],
]
);
$result->code && warn "failed to add entry: ", $result->error ;
Net::LDAP is a collection of modules that implements a LDAP services API for Perl programs. The module may be used to search directories or perform maintenance functions such as add, deleting or modify entries in an LDAP directory.
This document assumes that the reader has some knowledge of the LDAP protocol.
STDERR. The
bits of this value are :-
1 Show outgoing packets (using asn_hexdump). 2 Show incoming packets (using asn_hexdump). 4 Show outgoing packets (using asn_dump). 8 Show incoming packets (using asn_dump).
Example
$ldap = Net::LDAP->new('remote.host', async => 1);
Each of the following methods take as arguments some number of fixed parameters followed by options, these options are passed in a named fashion, for example
$mesg = $ldap->bind( "me", password => "mypasswd");
The return value from these methods is an object derived from the Net::LDAP::Message class. The methods of this class allow you to examine the status of request.
Example
$mesg = $ldap->search( @search_args );
$ldap->abandon( $mesg ); # This could be written as $mesg->abandon
This argument is not used if DN is a Net::LDAP::Entry object.
Example
# $entry is an object of class Net::LDAP::Entry $mesg = $ldap->add( $entry );
$mesg = $ldap->add( $DN,
attrs => [
name => 'Graham Barr',
attr => 'value1',
attr => 'value2',
multi => [qw(value1 value2)]
]
);
Only one of the following should be given, if none are given then noauth is assumed.
Example
$ldap->bind; # Anonymous bind
$ldap->bind( $DN, password => $password);
# $sasl is an object of class Authen::SASL $ldap->bind( $DN, sasl => $sasl, version => 3);
Example
$ldap->compare( $DN,
attr => 'cn',
value => 'Graham Barr'
);
Example
$ldap->delete( $dn );
Example
$ldap->moddn( $dn, newrdn => 'cn=Graham Barr');
Values in the ARRAY are used in pairs, the first is the operation add, delete or replace and the second is a reference to an ARRAY of attribute values.
The attribute value list is also used in pairs. The first value in each pair is the attribute name and the second is a reference to a list of values.
Use this form if you want to control the order in which the operations will be performed.
Example
$ldap->modify( $dn, add => { sn => 'Barr' } );
$ldap->modify( $dn, delete => [qw(faxNumber)]);
$ldap->modify( $dn, delete => { 'telephoneNumber' => '911' });
$ldap->modify( $dn, replace => { 'email' => 'gbarr@pobox.com' });
$ldap->modify( $dn,
changes => [
add => [ sn => 'Barr' ], # Add sn=Barr
delete => [ faxNumber => []], # Delete all fax numbers
delete => [ telephoneNumber => ['911']], # delete phone number 911
replace => [ email => 'gbarr@pobox.com'] # change email address
]
);
Certain additional attributes such as ``createtimestamp'' and other operational attributes may also be available for the asking:
$ldap->search( ... , attrs => ['createtimestamp'] , ... );
To retreive the default attributes and additional ones, use '*'.
$ldap->search( ... , attrs => ['*', 'createtimestamp'] , ... );
Example
$mesg = $ldap->search( base => $base_dn, scope => 'sub', filter => '(|(objectclass=rfc822mailgroup)(sn=jones))' );
Net::LDAP::LDIF->new(\*STDOUT,"w")->write($mesg->entries);
Example
$ldap->unbind;
The following methods are for convenience.
Returns an error code defined in Net::LDAP::Constant.
Many of the methods described above accept a control option. This allows the user to pass controls to the server as described in LDAPv3. The value to the control argument may be either a single control or a reference to an array of controls.
A control is a reference to a HASH and should contain the three
elements below. If any of the controls are blessed then the
methoc to_asn will be called which should return a reference
to a HASH containing the three elements described below.
Most of the above commands accept a callback option. This option should be a reference to a subroutine. This subroutine will be called for each packet received from the server as a response to the request sent.
When the subroutine is called the first argument will be the Net::LDAP::Message object which was returned from the method.
If the request is a search then multiple packets can be received from the server. Each entry is received as a separate packet. For each of these the subroutine will be called with a Net::LDAP::Entry object as the second argument.
During a search the server may also send a list of references. When such a list is received then the subroutine will be called with a Net::LDAP::Reference object as the second argument.
Net::LDAP also exports constants for the error codes that can be received from the server, see Net::LDAP::Constant.
Net::LDAP::Constant, Net::LDAP::Control, Net::LDAP::Entry, Net::LDAP::Filter, Net::LDAP::Message, Net::LDAP::Reference, Net::LDAP::Search, Other online documentation
The homepage for the perl-ldap modules can be found at http://www.pobox.com/~gbarr/perl-ldap/.
This document is based on a document originally written by Russell Fulton <r.fulton@auckland.ac.nz>.
Chris Ridd @isode.com for the many hours spent testing and contribution of the ldap* command line utilities.
Graham Barr <gbarr@pobox.com>
Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap-dev@lists.sourceforge.net>
Copyright (c) 1997-2000 Graham Barr. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
$Id: //depot/ldap-asn/lib/Net/LDAP.pod#3 $