NAME
Net::LDAP::SimpleServer - Minimal-configuration, read-only LDAP server
VERSION
version 0.0.21
SYNOPSIS
use Net::LDAP::SimpleServer;
# Or, specifying a Net::Server personality
use Net::LDAP::SimpleServer 'PreFork';
# using default configuration file
my $server = Net::LDAP::SimpleServer->new();
# passing a specific configuration file
my $server = Net::LDAP::SimpleServer->new({
conf_file => '/etc/ldapconfig.conf'
});
# passing configurations in a hash
my $server = Net::LDAP::SimpleServer->new({
port => 5000,
data_file => '/path/to/data.ldif',
});
# make it spin
$server->run();
# make it spin with options
$server->run({ allow_anon => 0 });DESCRIPTION
As the name suggests, this module aims to implement a simple LDAP server, using many components already available in CPAN. It can be used for prototyping and/or development purposes. This is NOT intended to be a production-grade server, although some brave souls in small offices might use it as such.
The server will load a LDIF file and serve its contents through the LDAP protocol. Many operations are NOT available yet, some will never be.
The constructors will follow the rules defined by Net::Server, but the most useful are the two forms described below.
Net::LDAP::SimpleServer will use the directory ${HOME}/.ldapsimple as a BASEDIR for server files. If there exists a file:
BASEDIR/server.confit will be used as the default configuration file. Similarly, if there exists a file:
BASEDIR/server.ldifit will be used as the default data file for this server.
METHODS
new()
Instantiates a server object. If the default configuration file is available, the options in it will be used.
new( HASHREF )
Instantiates a server object using the options specified in a hash reference.
options()
As specified in Net::Server, this method creates new options for the server. Hence, in addition to Net::Server options, this module also allows setting the following parameters:
data_file - the LDIF data file used by LDIFStore
root_dn - the administrator DN of the repository
root_pw - the password for root_dn
allow_anon - whether to allow for anonymous binds
user_filter - LDAP filter to find user entries
user_id_attr - attribute of a LDAP entry that contains the username
user_pw_attr - attribute of a LDAP entry that contains the password
user_passwords - whether to return password values in searches
default_values()
As specified in Net::Server, this method provides default values for a number of options.
Notice that we do set a default password for the cn=root DN. This allows for out-of-the-box testing, but make sure you change the password when putting this to use.
post_configure_hook()
Method specified by Net::Server to validate the parameters used in the server instance.
process_request()
Method specified by Net::Server to actually handle one connection. In this module it basically delegates the processing to Net::LDAP::SimpleServer::ProtocolHandler.
CONFIGURATION AND ENVIRONMENT
Net::LDAP::SimpleServer may use a configuration file to specify the server settings. If no file is specified and options are not passed in a hash, this module will look for a default configuration file named BASEDIR/server.conf.
data_file /path/to/a/ldif/file.ldif
#port 389
#root_dn cn=root
#root_pw somepasswordTODO
We plan to implement more options in Net::LDAP::SimpleServer. Some ideas are:
#objectclass_req (true|false)
#user_tree dc=some,dc=subtree,dc=comKeeping in mind we do NOT want to implement a full blown LDAP server.
Contributors in CPAN RT
Ian Puleston <ipuleston@SonicWALL.com>
SUPPORT
Perldoc
You can find documentation for this module with the perldoc command.
perldoc Net::LDAP::SimpleServerWebsites
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
Search CPAN
The default CPAN search engine, useful to view POD in HTML format.
AnnoCPAN
The AnnoCPAN is a website that allows community annotations of Perl module documentation.
CPAN Ratings
The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.
CPAN Forum
The CPAN Forum is a web forum for discussing Perl modules.
CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
CPAN Testers
The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
You can email the author of this module at RUSSOZ at cpan.org asking for help with any problems you have.
Internet Relay Chat
You can get live help by using IRC ( Internet Relay Chat ). If you don't know what IRC is, please read this excellent guide: http://en.wikipedia.org/wiki/Internet_Relay_Chat. Please be courteous and patient when talking to us, as we might be busy or sleeping! You can join those networks/channels and get help:
irc.perl.org
You can connect to the server at 'irc.perl.org' and join this channel: #sao-paulo.pm then talk to this person for help: russoz.
Bugs / Feature Requests
Please report any bugs or feature requests by email to bug-net-ldap-simpleserver at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=Net-LDAP-SimpleServer. You will be automatically notified of any progress on the request by the system.
Source Code
The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)
https://github.com/russoz/Net-LDAP-SimpleServer
git clone https://github.com/russoz/Net-LDAP-SimpleServer.gitAUTHOR
Alexei Znamensky <russoz@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2012 - 2017 by Alexei Znamensky.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
BUGS AND LIMITATIONS
You can make new bug reports, and view existing ones, through the web interface at http://rt.cpan.org.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.