LDAP(1)

NAME
Net::LDAP - Lightweight Directory Access Protocol

SYNOPSIS
 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 ;

DESCRIPTION
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.

CONSTRUCTOR
Creates a new Net::LDAP object and opens a connection to the named host. OPTIONS is a list of key-value pairs, valid options are :-
    Port to connect to on the remote server. Timeout passed to IO::Socket when connecting the remote server. (Default: 120) If passed a non-zero value then debug data will be sent to `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).
    Perform all operations asynchronously if passed a true value. If set then Net::LDAP will check all responses for errors on all methods if the object is in synchronous mode. If an error is detected then the specified action will be taken. Valid values and their actions are.
        Net::LDAP will croak with an appropriate message. Net::LDAP will warn with an appropriate message. Net::LDAP will warn with an appropriate message if `-w' is in effect. The method that was called will return `undef' The given coderef will be called in a scalar context with a single argument, the result message. The value returned will be the return value for the method that was called.

    Example

      $ldap = Net::LDAP->new('remote.host', async => 1);

METHODS
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. Request server to abandon a request. The id to abandon may be passed as the first parameter or as part of the options list. The ID may be a number or a object which is a sub-class of Net::LDAP::Message, returned from a previous method call.
    This option is here for compatibility only, and may be removed in future. Previous releases did not take the ID argument which replaces this option. See the CONTROLS entry elsewhere in this document below See the CALLBACKS entry elsewhere in this document below

    Example

      $mesg = $ldap->search( @search_args );
      $ldap->abandon( $mesg ); # This could be written as $mesg->abandon
Add an entry to the directory. The DN argument can be either a Net::LDAP::Entry object or a string.
    This option is here for compatibility only, and may be removed in future. Previous releases did not take the DN argument which replaces this option. This argument is a reference to a list of attribute-value pairs. Attributes with multiple values can be added as either multiple entries or the value could be a reference to a list of values.

    This argument is not used if DN is a Net::LDAP::Entry object. See the CONTROLS entry elsewhere in this document below See the CALLBACKS entry elsewhere in this document below

    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)]
        ]
      );
Bind to the server. DN is the DN to bind as. An anonymous bind may be done by calling bind without any arguments.
    This option is here for compatibility only, and may be removed in future. Previous releases did not take the DN argument which replaces this option. See the CONTROLS entry elsewhere in this document below See the CALLBACKS entry elsewhere in this document below

    Only one of the following should be given, if none are given then noauth is assumed.
    Bind without any password, the value passed with this option is ignored. This is the default if no arguments are given. Bind with the given password. Bind using Kerberos V4.1 not supported. Bind using Kerberos V4.2 not supported. Bind using a SASL mechanism. The argument given should be a sub-class of Authen::SASL.

    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);
Perform a comparison on the server. DN is the DN which the comparison is to be performed. DN May be a string or a Net::LDAP::Entry object.
    This option is here for compatibility only, and may be removed in future. Previous releases did not take the DN argument which replaces this option. The name of the attribute to compare. The value to compare with. See the CONTROLS entry elsewhere in this document below. See the CALLBACKS entry elsewhere in this document below.

    Example

      $ldap->compare( $DN,
        attr  => 'cn',
        value => 'Graham Barr'
      );
Delete DN from the server. DN May be a string or a Net::LDAP::Entry object.
    This option is here for compatibility only, and may be removed in future. Previous releases did not take the DN argument which replaces this option. See the CONTROLS entry elsewhere in this document below. See the CALLBACKS entry elsewhere in this document below.

    Example

     $ldap->delete( $dn );
Modify the DN for DN on the server. DN May be a string or a Net::LDAP::Entry object.
    This option is here for compatibility only, and may be removed in future. Previous releases did not take the DN argument which replaces this option. This value should be a new RDN to assign to DN. This value should be true if the existing RDN is to be deleted. If given this value should be the DN of the new superior for DN. See the CONTROLS entry elsewhere in this document below. See the CALLBACKS entry elsewhere in this document below.

    Example

     $ldap->moddn( $dn, newrdn => 'cn=Graham Barr');
Modify the contents of DN on the server. DN May be a string or a Net::LDAP::Entry object.
    This option is here for compatibility only, and may be removed in future. Previous releases did not take the DN argument which replaces this option. The add option should be a reference to a HASH. The values of the HASH are the attributes to add, and the values may be a string or a reference to a list of values. A reference to an ARRAY of attributes to delete or a reference to a HASH (as in add) if only specific values should be deleted. If the value for any attribute in the HASH is a reference to an empty ARRAY the all instances of the attribute will be deleted. The <replace> option takes a argument in the same form as add, but will cause any existing attributes with the same name to be replaced. If the value for any attribute in the HASH is a reference to an empty ARRAY the all instances of the attribute will be deleted. This is an alternative to add, delete and replace where the whole operation can be given in a single argument. The argument should be a reference to an ARRAY.

    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. See the CONTROLS entry elsewhere in this document below. See the CALLBACKS entry elsewhere in this document below.

    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
       ]
     );
Request that a search be performed. This can be used to read attributes from a single entry, from entries immediately below a particular entry, or a whole subtree of entries.

The result is an object of class Net::LDAP::Search.
    The DN that is the base object entry relative to which the search is to be performed. By default the search is performed on the whole tree below the specified base object. This may be chaned by specifying a `scope' parameter with one of the following values.
        Search only the base object. Search the entries immediately below the base object. Search the whole tree below the base object. This is the default.
    By default aliases are dereferenced to locate the base object for the search, but not when searching subordinates of the base object. This may be changed by specifying a `deref' parameter with one of the following values.
        Do not dereference aliases in searching or in locating the base object of the search. Dereference aliases in subordinates of the base object in searching, but not in locating the base object of the search. Dereference aliases in locating the base object of the search, but not when searching subordinates of the base object. This is the default. Dereference aliases both in searching and in locating the base object of the search.
    A sizelimit that restricts the maximum number of entries to be returned as a result of the search. A value of 0, and the default, means that no restriction is requested. Servers may enforce a maximum number of entries to return. A timelimit that restricts the maximum time (in seconds) allowed for a search. A value of 0, and the default, means that no timelimit will be requested. An indicator as to whether search results should contain both attribute types and values, or just attribute types. Setting this parameter to a true value causes only attribute types (no values) to be returned. Setting this field to a false causes both attribute types and values to be returned. The default is to return both attribute types and values. A filter that defines the conditions an entry in the directory must meet in order for it to be returned by the search. This may be a string or a Net::LDAP::Filter object. See Net::LDAP::Filter for a defintion of the filter format. A reference to a list of attributes to be returned for each entry that matches the search filter.

    If not specified, then the server will return the attributes that are specified as accessible by default given your bind credentials.

    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'] , ... );
    See the CONTROLS entry elsewhere in this document below. See the CALLBACKS entry elsewhere in this document below.

    Example

     $mesg = $ldap->search(
       base   => $base_dn,
       scope  => 'sub',
       filter => '(|(objectclass=rfc822mailgroup)(sn=jones))'
     );
     Net::LDAP::LDIF->new(\*STDOUT,"w")->write($mesg->entries);
The unbind method does not take any parameters and will unbind you from the server. While some servers may allow you to re-bind or perform other operations after unbinding, the only portable operation is closing the connection. In the case that you wish to switch to another set of credentials while continuing to use the same connection, re-binding with another DN and password, without unbind-ing, will generally work.

Example

 $ldap->unbind;

The following methods are for convenience. Returns true if the LDAP operations are being performed asynchronously. If VALUE is given the debug bit-value will be set to VALUE and the previous value will be returned. If not given the bit-value will remain unchanged and will be returned. Calling this method will synchronize the client with the server. It will not return until all requests have been completed, or id MESG is given it will return when MESG has been completed.

Returns an error code defined in Net::LDAP::Constant. Returns the version of the LDAP protocol that is being used.

CONTROLS
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. This element must be present and is the name of the type of control being requested. critical is optional and should be a boolean value, if it is not specified then it is assumed to be false. If the control being requested requires a value then this element should hold the value for the server.

CALLBACKS
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.

LDAP ERROR CODES
Net::LDAP also exports constants for the error codes that can be received from the server, see Net::LDAP::Constant.

SEE ALSO
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/.

ACKNOWLEDGEMENTS
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.

AUTHOR
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
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 $