.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::LDAP::Server 3"
.TH Net::LDAP::Server 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::LDAP::Server \- LDAP server side protocol handling
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 10
\&  package MyServer;
\&  use Net::LDAP::Server;
\&  use Net::LDAP::Constant qw(LDAP_SUCCESS);
\&  use base \*(AqNet::LDAP::Server\*(Aq;
\&  sub search {
\&      my $self = shift;
\&      my ($reqData, $fullRequest) = @_;
\&      print "Searching\en";
\&      ...
\&      return {
\&          \*(AqmatchedDN\*(Aq => \*(Aq\*(Aq,
\&          \*(AqerrorMessage\*(Aq => \*(Aq\*(Aq,
\&          \*(AqresultCode\*(Aq => 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;
.Ve
.SH ABSTRACT
.IX Header "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 \f(CW\*(C`handle\*(C'\fR method to establish a connection with the client.
.SH SUBCLASSING
.IX Header "SUBCLASSING"
You can subclass Net::LDAP::Server with the following lines:
.PP
.Vb 3
\&  package MyServer;
\&  use Net::LDAP::Server;
\&  use base \*(AqNet::LDAP::Server\*(Aq;
.Ve
.PP
Then you can add your custom methods by just implementing a subroutine
named after the name of each method. These are supported methods:
.ie n .IP """bind""" 4
.el .IP \f(CWbind\fR 4
.IX Item "bind"
.PD 0
.ie n .IP """unbind""" 4
.el .IP \f(CWunbind\fR 4
.IX Item "unbind"
.ie n .IP """search""" 4
.el .IP \f(CWsearch\fR 4
.IX Item "search"
.ie n .IP """add""" 4
.el .IP \f(CWadd\fR 4
.IX Item "add"
.ie n .IP """modify""" 4
.el .IP \f(CWmodify\fR 4
.IX Item "modify"
.ie n .IP """delete""" 4
.el .IP \f(CWdelete\fR 4
.IX Item "delete"
.ie n .IP """modifyDN""" 4
.el .IP \f(CWmodifyDN\fR 4
.IX Item "modifyDN"
.ie n .IP """compare""" 4
.el .IP \f(CWcompare\fR 4
.IX Item "compare"
.ie n .IP """abandon""" 4
.el .IP \f(CWabandon\fR 4
.IX Item "abandon"
.PD
.PP
For any method that is not supplied, Net::LDAP::Server will return an 
\&\f(CW\*(C`LDAP_UNWILLING_TO_PERFORM\*(C'\fR.
.SS \fBnew()\fP
.IX Subsection "new()"
You can also subclass the \f(CW\*(C`new\*(C'\fR constructor to do something at connection time:
.PP
.Vb 6
\&  sub new {
\&     my ($class, $sock) = @_;
\&     my $self = $class\->SUPER::new($sock);
\&     printf "Accepted connection from: %s\en", $sock\->peerhost();
\&     return $self;
\&  }
.Ve
.PP
Note that \f(CW$self\fR 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:
.PP
.Vb 1
\&  use fields qw(myCustomField1 myCustomField2);
.Ve
.SS Methods
.IX Subsection "Methods"
When a method is invoked it will be obviously passed \f(CW$self\fR as generated by 
\&\f(CW\*(C`new\*(C'\fR, and two variables:
.IP \(bu 4
the Request datastructure that is specific for this method (e.g. BindRequest);
.IP \(bu 4
the full request message (useful if you want to access \fImessageID\fR or \fIcontrols\fR parts)
.PP
You can look at Net::LDAP::ASN or use Data::Dumper to find out what is 
presented to your method:
.PP
.Vb 4
\&  use Data::Dumper;
\&  sub search {
\&     print Dumper \e@_;
\&  }
.Ve
.PP
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 
\&\f(CW\*(C`LDAP_OPERATIONS_ERROR\*(C'\fR where the errorMessage will specify what went 
wrong.
.PP
All methods should return a LDAPresult hashref, for example:
.PP
.Vb 5
\&  return({
\&      \*(AqmatchedDN\*(Aq => \*(Aq\*(Aq,
\&      \*(AqerrorMessage\*(Aq => \*(Aq\*(Aq,
\&      \*(AqresultCode\*(Aq => LDAP_SUCCESS
\&  });
.Ve
.PP
\&\f(CW\*(C`search\*(C'\fR 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.
.SH "CLIENT HANDLING"
.IX Header "CLIENT HANDLING"
.SS \fBhandle()\fP
.IX Subsection "handle()"
When you get a socket from a client you can instantiate the class and handle 
the request:
.PP
.Vb 2
\&  my $handler = MyServer\->new($socket);
\&  $handler\->handle;
.Ve
.PP
Or, alternatively, you can pass two handles for input and output, respectively.
.PP
.Vb 2
\&  my $handler = MyServer\->new(*STDIN{IO},*STDOUT{IO});
\&  $handler\->handle;
.Ve
.PP
See examples in \fIexamples/\fR directory for sample servers, using IO::Select,
Net::Daemon or Net::Server.
.SH DEPENDENCIES
.IX Header "DEPENDENCIES"
.Vb 2
\& Net::LDAP::ASN
\& Net::LDAP::Constant
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP Net::LDAP 4
.IX Item "Net::LDAP"
.PD 0
.ie n .IP "Examples in ""examples"" directory." 4
.el .IP "Examples in \f(CWexamples\fR directory." 4
.IX Item "Examples in examples directory."
.PD
.SH "BUGS AND FEEDBACK"
.IX Header "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.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH AUTHOR
.IX Header "AUTHOR"
Alessandro Ranellucci <aar@cpan.org>
The original author of a Net::LDAP::Daemon module is 
Hans Klunder <hans.klunder@bigfoot.com>