NAME

ApTest::LDAP - class for ATM LDAP support

AUTHOR

Shane P. McCarron <shane@aptest.com>

COPYRIGHT

Copyright 2001-2009 Applied Testing and Technology, Inc. All Rights Reserved.

SYNOPSIS

The methods in this class manipulate the LDAP server configuration and provide an abstraction layer for connecting to the LDAP server. Once connected, the returned handler is to a Net::LDAP object, and all operations on the LDAP store should be conducted through that object, including closing the connection when done with it.

METHODS

new - Create a new, unpopulated test session

$file = new ApTest::LDAP( [ cfg ,] serverID );

Creates a new LDAP connection object.

cfg is an optional reference to a configuration data structure.

serverID is an integer which uniquely identify a previously configured LDAP server. If the cfg reference is specified, the server number is taken from this configuration.

Returns a reference to the LDAP connection object.

authenticate - authenticate a userid / password via bind

my $auth = ApTest::LDAP::authenticate( userid, passwd [, user] ) ;

my $auth = ApTest::LDAP::authenticate( userid, passwd [, LDAP server number] ) ;

my $auth = $ldap->authenticate( userid, passwd ) ;

userid is a userid to check.

passwd is the passwd to use.

user is an optional reference to a UserInfo object. If provided, then if authentication succeeds the LDAP-bound fields will be updated to match their entries in the LDAP repository.

If the user reference is not specified, the (optional) LDAP server number must be, otherwise it becomes impossible to find the one associated with this user.

Uses the userid and other information associated with the connection to search the connected repository for a matching DN. If there is one, then binds using that DN and the passwd parameter. If the bind succeeds, then returns true. Otherwise returns false.

bind - bind to the associated LDAP server

$conn = $ldap->bind( ) ;

Returns 1 on success, 0 on failure.

config - get/set configuration parameters for connection

$cfgHashRef = ApTest::LDAP::config( serverNum [, cfgHashRef] ) ;

$cfgHashRef = $ldap->config( [cfgHashRef ] ) ;

If called as an object method, the object is already bound to a specific LDAP server. If called as a class method, then the first parameter MUST be the server number to operate upon.

cfgHashRef is an optional reference to a populated set of connection configuration information. If provided, this data is updated into the persistent store. The contains the following data items:

active

Boolean indicating if the LDAP connection is active at all.

host

The host on which the LDAP server resides.

port

The port on which the LDAP server is listening.

protocol

The LDAP protocol to use when communicating with the server.

user

The username to use with the server, if any.

password

The password to use with the server, if any.

uidF

The name of the field in the database that provides user IDs. This is only used when data minig for accounts.

fnF

The name of the field that defines a fullname, if any.

phoneF

The name of the field that defines a phone number, if any.

emailF

The name of the field that defines an email address, if any.

Returns a reference to a hash containing the connection configuration information. If there is no definition, then returns an unpopulated structure.

connect - connect to an LDAP server

my $conn = $ldap->connect ( ) ;

Returns a handle to a LDAP server connection. Returns undef if there was a problem initializing the connection.

delete - delete an LDAP server

$result = ApTest::LDAP::delete(serverNum)

Deletes the configuration for server serverNum.

Returns 1 on success, 0 on failure.

getActiveServers - return a reference to a hash of active server numbers

$ref->getActiveServers()

This method will return a reference to a hash, keyed on LDAP server number, of those servers actually active. The value of the hash entry is the hostname of the server.

getEntry - get the LDAP Entry associated with a uid

$entry = $ldap->getEntry ( uid [, limit ] ) ;

uid is the user id to match.

limit is the maximum number of entries to match - this defaults to 2.

Returns an LDAP::Entry object or undef if the UID is not matched.

In an array context, returns up to limit entries that matched the uid pattern.

isActive - check whether LDAP is active or not

$state = $ldap->isActive() ;

$state = ApTest::LDAP::isActive(serverNum) ;

Returns true of LDAP is configured and active.

serverNum is the ID of the LDAP server to use. This is normally set when the LDAP object is created. If LDAP::isActive is called as a class method, and not an object method, it must be specified to learn if a specific LDAP server is active. If it is not specified, this function will look at all LDAP servers and return true if ANY are active.

numServers - count the number of configured servers

$ref->numServers();

This method will return an integer corresponding to the number of the highest numbered LDAP server. If the datadir can't be opened, 0 is returned. If the number of servers is 0, but a single LDAPCONFIG file exist, -1 is returned to signal the config() method to use legacy code.

release - release the object

$ref->release();

This method undefines the data structures associated with the session and releases the lock on the session.

Copyright © 2000-2013 Applied Testing and Technology, Inc. All rights reserved.