port => N

Port to connect to on the remote server. May be overridden by "HOST".

scheme => 'ldap' | 'ldaps' | 'ldapi'

Connection scheme to use when not using an URI as "HOST". (Default: ldap)

keepalive => 1

If given, set the socket's SO_KEEPALIVE option depending on the Boolean value of the option. (Default: use system default)

Failures in changing the socket's SO_KEEPALIVE option are ignored.

timeout => N

Timeout passed to IO::Socket when connecting the remote server. (Default: 120)

multihomed => N

Will be passed to IO::Socket as the "MultiHomed" parameter when connecting to the remote server

localaddr => HOST

Will be passed to IO::Socket as the "LocalAddr" parameter, which sets the client's IP address (as opposed to the server's IP address.)

debug => N

Set the debug level. See the debug method for details.

async => 1

Perform all operations asynchronously.

onerror => 'die' | 'warn' | 'undef' | sub { ... }

In synchronous mode, change what happens when an error is detected.

version => N

Set the protocol version being used (default is LDAPv3). This is useful if you want to talk to an old server and therefore have to use LDAPv2.

raw => REGEX

Use REGEX to denote the names of attributes that are to be considered binary in search results.

When this option is given, Net::LDAP converts all values of attributes not matching this REGEX into Perl UTF-8 strings so that the regular Perl operators (pattern matching, ...) can operate as one expects even on strings with international characters.

If this option is not given, attribute values are treated as byte strings.

Example: raw => qr/(?i:^jpegPhoto|;binary)/

inet4 => N

inet6 => N

Try to connect to the server using the specified IP protocol only, i.e. either IPv4 or IPv6. If the protocol selected is not supported, connecting will fail.

The default is to use any of the two protocols.

Example

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

LDAPS connections have some extra valid options, see the start_tls method for details. Note the default port for LDAPS is 636, and the default value for 'sslversion' is the value used as default by IO::Socket::SSL.

For LDAPI connections, HOST is actually the location of a UNIX domain socket to connect to. The default location is '/var/run/ldapi'.

control => CONTROL

control => [ CONTROL, ... ]

See "CONTROLS" below

callback => CALLBACK

See "CALLBACKS" below

Example

  $res = $ldap->search( @search_args );
  $mesg = $ldap->abandon( $res ); # This could be written as $res->abandon

attrs => [ ATTR => VALUE, ... ]

"VALUE" should be a string if only a single value is wanted, or a reference to an array of strings if multiple values are wanted.

This argument is not used if "DN" is a Net::LDAP::Entry object.

control => CONTROL

control => [ CONTROL, ... ]

See "CONTROLS" below

callback => CALLBACK

See "CALLBACKS" 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)]
                      ]
                    );

control => CONTROL

control => [ CONTROL, ... ]

See "CONTROLS" below

callback => CALLBACK

See "CALLBACKS" below

noauth | anonymous => 1

Bind without any password. The value passed with this option is ignored.

password => PASSWORD

Bind with the given password.

sasl => SASLOBJ

Bind using a SASL mechanism. The argument given should be a sub-class of Authen::SASL or an Authen::SASL client connection by calling "client_new" on an Authen::SASL object.

If passed an Authen::SASL object then "client_new" will be called to create a client connection object. The hostname passed by "Net::LDAP" to "client_new" can be set using the "sasl_host" option below. If this is not correct for your environment, consider calling "client_new" yourself and passing the client connection object as "SASLOBJ".

sasl_host => SASLHOST

When binding using SASL, allow the hostname used in the SASL communication to differ from the hostname connected to.

If "SASLHOST" evaluates to TRUE, then it is used as the SASL hostname.

If it evaluates to FALSE, then the value is determined by calling "peerhost" on the socket. In older versions of Net::LDAP this was the standard behaviour, but it turned out to cause more trouble than it fixed.

When the option is not given, the SASL host name used defaults to the host name / IP address taken from the "HOST" parameter when connecting.

Example

  $mesg = $ldap->bind; # Anonymous bind
  $mesg = $ldap->bind( $dn, password => $password );
  # $sasl is an object of class Authen::SASL
  $mesg = $ldap->bind( $dn, sasl => $sasl, version => 3 );

attr => ATTR

The name of the attribute to compare.

value => VALUE

The value to compare with.

control => CONTROL

control => [ CONTROL, ... ]

See "CONTROLS" below.

callback => CALLBACK

See "CALLBACKS" below.

Example

  $mesg = $ldap->compare( $dn,
                          attr  => 'cn',
                          value => 'Graham Barr'
                        );

control => CONTROL

control => [ CONTROL, ... ]

See "CONTROLS" below.

callback => CALLBACK

See "CALLBACKS" below.

Example

 $mesg = $ldap->delete( $dn );

newrdn => RDN

This value should be a new RDN to assign to "DN".

deleteoldrdn => 1

This option should be passed if the existing RDN is to be deleted.

newsuperior => NEWDN

If given this value should be the DN of the new superior for "DN".

control => CONTROL

control => [ CONTROL, ... ]

See "CONTROLS" below.

callback => CALLBACK

See "CALLBACKS" below.

Example

 $mesg = $ldap->moddn( $dn, newrdn => 'cn=Graham Barr' );

add => { ATTR => VALUE, ... }

Add more attributes or values to the entry. "VALUE" should be a string if only a single value is wanted in the attribute, or a reference to an array of strings if multiple values are wanted.

  $mesg = $ldap->modify( $dn,
    add => {
      description => 'List of members',    # Add description attribute
      member      => [
        'cn=member1,ou=people,dc=example,dc=com',    # Add to attribute
        'cn=member2,ou=people,dc=example,dc=com',
      ]
    }
  );
    

delete => [ ATTR, ... ]

Delete complete attributes from the entry.

  $mesg = $ldap->modify( $dn,
    delete => ['member','description'] # Delete attributes
  );
    

delete => { ATTR => VALUE, ... }

Delete individual values from an attribute. "VALUE" should be a string if only a single value is being deleted from the attribute, or a reference to an array of strings if multiple values are being deleted.

If "VALUE" is a reference to an empty array or all existing values of the attribute are being deleted, then the attribute will be deleted from the entry.

  $mesg = $ldap->modify( $dn,
    delete => {
      description => 'List of members',
      member      => [
        'cn=member1,ou=people,dc=example,dc=com',    # Remove members
        'cn=member2,ou=people,dc=example,dc=com',
      ],
      seeAlso => [],   # Remove attribute
    }
  );
    

replace => { ATTR => VALUE, ... }

Replace any existing values in each given attribute with "VALUE". "VALUE" should be a string if only a single value is wanted in the attribute, or a reference to an array of strings if multiple values are wanted. A reference to an empty array will remove the entire attribute. If the attribute does not already exist in the entry, it will be created.

  $mesg = $ldap->modify( $dn,
    replace => {
      description => 'New List of members', # Change the description
      member      => [ # Replace whole list with these
        'cn=member1,ou=people,dc=example,dc=com',
        'cn=member2,ou=people,dc=example,dc=com',
      ],
      seeAlso => [],   # Remove attribute
    }
  );
    

increment => { ATTR => VALUE, ... }

Atomically increment the existing value in each given attribute by the provided "VALUE". The attributes need to have integer syntax, or be otherwise "incrementable". Note this will only work if the server advertises support for LDAP_FEATURE_MODIFY_INCREMENT. Use "supported_feature" in Net::LDAP::RootDSE to check this.

  $mesg = $ldap->modify( $dn,
    increment => {
      uidNumber => 1 # increment uidNumber by 1
    }
  );
    

changes => [ OP => [ ATTR => VALUE ], ... ]

This is an alternative to add, delete, replace and increment where the whole operation can be given in a single argument. "OP" should be add, delete, replace or increment. "VALUE" should be either a string or a reference to an array of strings, as before.

Use this form if you want to control the order in which the operations will be performed.

  $mesg = $ldap->modify( $dn,
    changes => [
      add => [
        description => 'A description',
        member      => $newMember,
      ],
      delete => [
        seeAlso => [],
      ],
      add => [
        anotherAttribute => $value,
      ],
    ]
  );
    

control => CONTROL

control => [ CONTROL, ... ]

See "CONTROLS" below.

callback => CALLBACK

See "CALLBACKS" below.

Example

 $mesg = $ldap->modify( $dn, add => { sn => 'Barr' } );
 $mesg = $ldap->modify( $dn, delete => [qw(faxNumber)] );
 $mesg = $ldap->modify( $dn, delete => { 'telephoneNumber' => '911' } );
 $mesg = $ldap->modify( $dn, replace => { 'mail' => 'gbarr@pobox.com' } );
 $mesg = $ldap->modify( $dn,
                        changes => [
                            # add sn=Barr
                          add     => [ sn => 'Barr' ],
                            # delete all fax numbers
                          delete  => [ faxNumber => []],
                            # delete phone number 911
                          delete  => [ telephoneNumber => ['911']],
                            # change email address
                          replace => [ mail => 'gbarr@pobox.com']
                        ]
                      );

base => DN

The DN that is the base object entry relative to which the search is to be performed.

scope => 'base' | 'one' | 'sub' | 'subtree' | 'children'

By default the search is performed on the whole tree below the specified base object. This maybe changed by specifying a "scope" parameter with one of the following values:

deref => 'never' | 'search' | 'find' | 'always'

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:

sizelimit => N

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.

timelimit => N

A timelimit that restricts the maximum time (in seconds) allowed for a search. A value of 0 (the default), means that no timelimit will be requested.

typesonly => 1

Only attribute types (no values) should be returned. Normally attribute types and values are returned.

filter => FILTER

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. Values inside filters may need to be escaped to avoid security problems; see Net::LDAP::Filter for a definition of the filter format, including the escaping rules.

attrs => [ ATTR, ... ]

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:

  $mesg = $ldap->search( ... ,
                         attrs => ['createTimestamp']
                       );
    

To retrieve the default attributes and additional ones, use '*'.

  $mesg = $ldap->search( ... ,
                         attrs => ['*', 'createTimestamp']
                       );
    

To retrieve no attributes (the server only returns the DNs of matching entries), use '1.1':

  $mesg = $ldap->search( ... ,
                         attrs => ['1.1']
                       );
    

control => CONTROL

control => [ CONTROL, ... ]

See "CONTROLS" below.

callback => CALLBACK

See "CALLBACKS" below.

raw => REGEX

Use REGEX to denote the names of attributes that are to be considered binary in search results.

When this option is given, Net::LDAP converts all values of attributes not matching this REGEX into Perl UTF-8 strings so that the regular Perl operators (pattern matching, ...) can operate as one expects even on strings with international characters.

If this option is not given, attribute values are treated as byte strings.

The value provided here overwrites the value inherited from the constructor.

Example: raw => qr/(?i:^jpegPhoto|;binary)/

Example

 $mesg = $ldap->search(
                        base   => $base_dn,
                        scope  => 'sub',
                        filter => '(|(objectclass=rfc822mailgroup)(sn=jones))'
                      );
 Net::LDAP::LDIF->new( \*STDOUT,"w" )->write( $mesg->entries );

verify => 'none' | 'optional' | 'require'

How to verify the server's certificate:

sslversion => 'sslv2' | 'sslv3' | 'sslv23' | 'tlsv1' | 'tlsv1_1' | 'tlsv1_2'

This defines the version of the SSL/TLS protocol to use. Default is to use the value that IO::Socket::SSL uses as default.

See "SSL_version" in IO::Socket::SSL for more details.

sslserver => SSLHOST

Allow changing the server name to use in certificate hostname verification in case the target hostname does not match the LDAP server's certificate. If not given it defaults to the name of the HOST connected to.

See "SSL_verifycn_name" in IO::Socket::SSL for more details.

ciphers => CIPHERS

Specify which subset of cipher suites are permissible for this connection, using the standard OpenSSL string format. The default behavior is to keep the decision on the underlying cryptographic library.

clientcert => '/path/to/cert.pem'

clientkey => '/path/to/key.pem'

keydecrypt => sub { ... }

If you want to use the client to offer a certificate to the server for SSL authentication (which is not the same as for the LDAP Bind operation) then set clientcert to the user's certificate file, and clientkey to the user's private key file. These files must be in PEM format.

If the private key is encrypted (highly recommended) then keydecrypt should be a subroutine that returns the decrypting key. For example:

 $ldap = Net::LDAP->new( 'myhost.example.com', version => 3 );
 $mesg = $ldap->start_tls(
                           verify => 'require',
                           clientcert => 'mycert.pem',
                           clientkey => 'mykey.pem',
                           keydecrypt => sub { 'secret'; },
                           capath => '/usr/local/cacerts/'
                         );
    

capath => '/path/to/servercerts/'

cafile => '/path/to/servercert.pem'

When verifying the server's certificate, either set capath to the pathname of the directory containing CA certificates, or set cafile to the filename containing the certificate of the CA who signed the server's certificate. These certificates must all be in PEM format.

The directory in 'capath' must contain certificates named using the hash value of the certificates' subject names. To generate these names, use OpenSSL like this in Unix:

    ln -s cacert.pem `openssl x509 -hash -noout < cacert.pem`.0
    

(assuming that the certificate of the CA is in cacert.pem.)

checkcrl => 1

If capath has been configured, then it will also be searched for certificate revocation lists (CRLs) when verifying the server's certificate. The CRLs' names must follow the form hash.rnum where hash is the hash over the issuer's DN and num is a number starting with 0.

See "SSL_check_crl" in IO::Socket::SSL for further information.

attrs => [ ATTR, ... ]

A reference to a list of attributes to be returned. If not specified, then the following attributes will be requested

  subschemaSubentry
  namingContexts
  altServer
  supportedExtension
  supportedFeatures
  supportedControl
  supportedSASLMechanisms
  supportedLDAPVersion
    

The result is an object of class Net::LDAP::RootDSE.

Example

 my $root = $ldap->root_dse;
 # get naming Context
 $root->get_value( 'namingContexts', asref => 1 );
 # get supported LDAP versions
 $root->supported_version;

As the root DSE may change in certain circumstances - for instance when you change the connection using start_tls - you should always use the root_dse method to return the most up-to-date copy of the root DSE.

dn => DN

If a DN is supplied, it will become the base object entry from which the search for schema information will be conducted. If no DN is supplied the base object entry will be determined from the rootDSE entry.

Example

 my $schema = $ldap->schema;
 # get objectClasses
 @ocs = $schema->all_objectclasses;
 # Get the attributes
 @atts = $schema->all_attributes;

sasl_layer => FLAG

This option is only relevant if SASL layers are established.

If it it missing or if is set to a TRUE value, then the SASL layer handle is returned. Depending on the SASL library used, the object returned is not necessarily an "IO::Socket" object.

If it exists, but is set to a value evaluating to FALSE, then the base "IO::Socket" object underneath the SASL layer is returned.