Net::L...:Server(3pm)

💖 Net::LDAP::Server — LDAP server side protocol handling 💖

okay so bestie, welcome to Net::LDAP::Server 💅 this is the Perl page for it, from the User Contributed Perl Documentation (that's the 3pm bit, iykyk). It's giving server-side LDAP protocol energy and honestly? she eats. Let's get into it 🫶

---

✨ 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, $fullRequest) = @_;
    print "Searching\n";
    ...
    return {
        'matchedDN' => '',
        'errorMessage' => '',
        'resultCode' => LDAP_SUCCESS
    }, @entries;
}

package main;
my $handler = MyServer->new($socket);
$handler->handle;

# or with distinct input and output handles
package main;
my $handler = MyServer->new( $input_handle, $output_handle );
$handler->handle;

---

✨ ABSTRACT ✨

So basically 💁‍♀️ this class does the protocol handling for an LDAP server. You subclass it, you implement the methods you actually care about (they're all listed below, don't worry), and then you just instantiate your subclass and call its handle method to establish a connection with the client. That's it. That's the whole vibe. ✨

---

✨ SUBCLASSING ✨

You can subclass Net::LDAP::Server with these lines right here:

package MyServer;
use Net::LDAP::Server;
use base 'Net::LDAP::Server';

Then you just add your own custom methods by implementing a subroutine named after the name of each method 🎀 These are the supported methods, bestie:

• "bind"
• "unbind"
• "search"
• "add"
• "modify"
• "delete"
• "modifyDN"
• "compare"
• "abandon"

For any method that is not supplied, Net::LDAP::Server will return an "LDAP_UNWILLING_TO_PERFORM". She's not being rude, she's just not doing it 💀

🌸 new() 🌸

You can also subclass the "new" constructor to do something at connection time, like so:

sub new {
   my ($class, $sock) = @_;
   my $self = $class->SUPER::new($sock);
   printf "Accepted connection from: %s\n", $sock->peerhost();
   return $self;
}

Quick heads up though 🫶 $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);

🌈 Methods 🌈

When a method is invoked it will be obviously passed $self as generated by "new", and two variables:

• the Request datastructure that is specific for this method (e.g. BindRequest) 👀
• the full request message (useful if you want to access messageID or controls parts) 💅

You can look at Net::LDAP::ASN or use Data::Dumper to find out what is presented to your method:

use Data::Dumper;
sub search {
   print Dumper \@_;
}

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. Not ideal, but at least she tells you 😭

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. Slay, options ✨

---

✨ CLIENT HANDLING ✨

🎀 handle() 🎀

When you get a socket from a client you can instantiate the class and handle the request:

my $handler = MyServer->new($socket);
$handler->handle;

Or, alternatively, you can pass two handles for input and output, respectively. Very main character of you 💅

my $handler = MyServer->new(*STDIN{IO},*STDOUT{IO});
$handler->handle;

See examples in examples/ directory for sample servers, using IO::Select, Net::Daemon or Net::Server. Go look, they're iconic 🦋

---

✨ DEPENDENCIES ✨

 Net::LDAP::ASN
 Net::LDAP::Constant

---

✨ SEE ALSO ✨

• Net::LDAP
• Examples in "examples" directory.

---

✨ BUGS AND FEEDBACK ✨

There are no known bugs 🙈 (we love a clean record). You are very welcome to write mail to the maintainer (aar@cpan.org) with your contributions, comments, suggestions, bug reports or complaints. Fr fr, she wants to hear from you 🫶

---

✨ 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> 💜

---

and that's the whole page bestie, no cap 🌸 this was perl v5.36.0, dated 2022-12-11, brought to you by the User Contributed Perl Documentation for Net::LDAP::Server(3pm) — go forth and handle some protocols 💅✨🦋