NAME
Net::LDAP::Server - LDAP server side protocol handling
SYNOPSIS
package MyServer;
use Net::LDAP::Server;
use Net::LDAP::Constant qw(LDAP_SUCCESS);
use base 'Net::LDAP::Server';
sub search {
my $self = shift;
my $reqData = shift;
print "Searching\n";
...
return {
'matchedDN' => '',
'errorMessage' => '',
'resultCode' => LDAP_SUCCESS
}, @entries;
}
package main;
my $handler = MyServer->new($socket);
$handler->handle;
ABSTRACT
This class provides the protocol handling for an LDAP server. You can subclass it and implement the methods you need (see below). Then you just instantiate your subclass and call its handle
method to establish a connection with the client.
SUBCLASSING
You can subclass Net::LDAP::Server using the following lines:
package MyServer;
use Net::LDAP::Server;
use base 'Net::LDAP::Server';
Then you can add your custom methods by just implementing a subroutine named after the name of each method. These are supported methods:
bind
unbind
search
add
modify
delete
modifyDN
compare
For any method that is not supplied, Net::LDAP::Server will return an LDAP_UNWILLING_TO_PERFORM
.
You can also subclass the new
constructor to do something at connection time:
sub new {
my ($class, $sock) = @_;
my $self = $class->SUPER::new($sock);
printf "Accepted connection from: %s\n", $sock->peerhost();
return $self;
}
Note that $self is constructed using the fields pragma, so if you want to add data to it you should add a line like this in your subclass:
use fields qw(myCustomField1 myCustomField2);
When a method is invoked it will be passed $self
as generated by new
and the Request datastructure that is specific for this method (e.g. BindRequest). You can look at Net::LDAP::ASN or use Data::Dumper to find out what is presented to your method.
If anything goes wrong in the module you specify (e.g. it died or the result is not a correct ldapresult structure) Net::LDAP::Server will return an LDAP_OPERATIONS_ERROR
where the errorMessage will specify what went wrong.
All methods should return a LDAPresult hashref, for example:
return({
'matchedDN' => '',
'errorMessage' => '',
'resultCode' => LDAP_SUCCESS
});
search
should return a LDAPresult hashref followed by a list of entries (if applicable). Entries may be coded either as searchResEntry or searchRefEntry structures or as Net::LDAP::Entry or Net::LDAP::Reference objects.
CLIENT HANDLING
When you got a socket from a client you can instantiate the class and handle the request:
my $handler = MyServer->new($socket);
$handler->handle;
See examples in examples/ directory for sample servers, using IO::Select or Net::Daemon.
DEPENDENCIES
Net::LDAP::ASN
Net::LDAP::Constant
SEE ALSO
- Net::LDAP
- Examples in examples directory.
BUGS AND FEEDBACK
There are no known bugs. You are very welcome to write mail to the maintainer (aar@cpan.org) with your contributions, comments, suggestions, bug reports or complaints.
COPYRIGHT
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
AUTHOR
Alessandro Ranellucci <aar@cpan.org> The original author of a Net::LDAP::Daemon module is Hans Klunder <hans.klunder@bigfoot.com>
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 280:
=back without =over