forked from russoz/Net-LDAP-SimpleServer
/
SimpleServer.pm
379 lines (264 loc) · 10.5 KB
/
SimpleServer.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
package Net::LDAP::SimpleServer;
use strict;
use warnings;
use Carp;
use version; our $VERSION = qv('0.0.10');
our $personality = undef;
sub import {
my $pkg = shift;
$personality = shift || 'Fork';
use Net::Server;
eval 'use base qw/Net::Server::' . $personality . '/';
die $@ if $@;
}
use File::Basename;
use File::HomeDir;
use File::Spec;
use File::Path qw{make_path};
use Scalar::Util qw{reftype};
use Net::LDAP::SimpleServer::LDIFStore;
use Net::LDAP::SimpleServer::ProtocolHandler;
use constant BASEDIR => File::Spec->catfile( home(), '.ldapsimpleserver' );
use constant LOGDIR => File::Spec->catfile( BASEDIR, 'log' );
use constant DEFAULT_CONFIG_FILE => File::Spec->catfile( BASEDIR, 'config' );
use constant DEFAULT_DATA_FILE => File::Spec->catfile( BASEDIR, 'server.ldif' );
my $_add_option = sub {
my ( $prop, $template, $opt, $initial ) = @_;
$prop->{$opt} = $initial;
$template->{$opt} = \$prop->{$opt};
};
sub options {
my ( $self, $template ) = @_;
my $prop = $self->{'ldap'};
### setup options in the parent classes
$self->SUPER::options($template);
### add a single value option
$_add_option->( $prop, $template, 'data', undef );
$_add_option->( $prop, $template, 'root_dn', undef );
$_add_option->( $prop, $template, 'root_pw', undef );
}
sub default_values {
return {
host => '*',
port => 389,
proto => 'tcp',
root_dn => 'cn=root',
root_pw => 'ldappw',
log_file => File::Spec->catfile( LOGDIR, 'server.log' ),
pid_file => File::Spec->catfile( LOGDIR, 'server.pid' ),
conf_file => -r DEFAULT_CONFIG_FILE ? DEFAULT_CONFIG_FILE : undef,
data => -r DEFAULT_DATA_FILE ? DEFAULT_DATA_FILE : undef,
syslog_ident => 'Net::LDAP::SimpleServer-'
. $Net::LDAP::SimpleServer::VERSION,
};
}
sub _make_dir {
my $file = shift;
return unless $file;
my $dir = dirname($file);
return unless $dir;
return if -d $dir;
make_path($dir);
}
sub post_configure_hook {
my $self = shift;
my $prop = $self->{'ldap'};
croak q{Cannot find conf file "} . $self->{server}->{conf_file} . q{"}
if $self->{server}->{conf_file} and not -r $self->{server}->{conf_file};
_make_dir($self->{server}->{log_file});
_make_dir($self->{server}->{pid_file});
croak q{Configuration has no "data" file!}
unless exists $prop->{data};
croak qq{Cannot read data file "} . $prop->{data} . q{"}
unless -r $prop->{data};
$prop->{store} = LDIFStore->new( $prop->{data} );
}
sub process_request {
my $self = shift;
my $in = *STDIN{IO};
my $out = *STDOUT{IO};
my $handler = ProtocolHandler->new( $self->{ldap}->{store}, $in, $out );
until ( $handler->handle ) {
# empty loop
}
return;
}
1; # Magic true value required at end of module
__END__
=head1 NAME
Net::LDAP::SimpleServer - Minimal-configuration, read-only LDAP server
=head1 SYNOPSIS
B<< WORK IN PROGRESS!! NOT READY TO USE YET!! >>
package MyServer;
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 => '/path/to/data.ldif',
});
# make it spin
$server->run();
The default configuration file is:
${HOME}/.ldapsimpleserver/config
=head1 DESCRIPTION
=for author to fill in:
Write a full description of the module and its features here.
Use subsections (=head2, =head3) as appropriate.
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 B<NOT> intended to be a
production-grade server, altough some brave souls in small offices might
use it as such.
As of November 2010, the server will simply load a LDIF file and serve its
contents through the LDAP protocol. Many operations are B<NOT> available yet,
notably writing into the directory tree, but we would like to implement that
in a near future.
=head1 CONSTRUCTOR
The constructors will follow the rules defined by L<Net::Server>, but most
notably we have the two forms below:
=over
=item new()
Attempts to create a server by using the default configuration file,
C<< ${HOME}/.ldapsimpleserver/config >>.
=item new( HASHREF )
Attempts to create a server by using the options specified in a hash
reference rather than reading them from a configuration file.
=back
=head1 METHODS
=over
=item options()
As specified in L<Net::Server>, this method creates new options for the,
server, namely:
=over
data - the LDIF data file used by LDIFStore
root_dn - the administrator DN of the repository
root_pw - the password for root_dn
=back
=item default_values()
As specified in L<Net::Server>, this method provides default values for a
number of options. In Net::LDAP::SimpleServer, this method is defined as:
sub default_values {
return {
host => '*',
port => 389,
proto => 'tcp',
root_id => 'cn=root',
root_pw => 'ldappw',
syslog_ident => 'Net::LDAP::SimpleServer-'
. $Net::LDAP::SimpleServer::VERSION,
conf_file => DEFAULT_CONFIG_FILE,
};
}
Notice that we do set a default password for the C<< cn=root >> DN. This
allows for out-of-the-box testing, but make sure you change the password
when putting this to production use.
=item post_configure_hook()
Method specified by L<Net::Server> to validate the passed options
=item process_request()
Method specified by L<Net::Server> to actually handle one connection. In this
module it basically delegates the processing to
L<Net::LDAP::SimpleServer::ProtocolHandler>.
=back
=head1 DIAGNOSTICS
=for author to fill in:
List every single error and warning message that the module can
generate (even the ones that will "never happen"), with a full
explanation of each problem, one or more likely causes, and any
suggested remedies.
=over
=item C<< Error message here, perhaps with %s placeholders >>
[Description of error here]
=item C<< Another error message here >>
[Description of error here]
[Et cetera, et cetera]
=back
=head1 CONFIGURATION AND ENVIRONMENT
=for author to fill in:
A full explanation of any configuration system(s) used by the
module, including the names and locations of any configuration
files, and the meaning of any environment variables or properties
that can be set. These descriptions must also include details of any
configuration language used.
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
C<< ${HOME}/.ldapsimpleserver/config >>.
data /path/to/a/ldif/file.ldif
#port 389
#root_id cn=root
#root_pw somepassword
#objectclass_req (true|false)
#user_tree dc=some,dc=subtree,dc=com
#user_id_attr uid
#user_pw_attr password
=head1 DEPENDENCIES
=for author to fill in:
A list of all the other modules that this module relies upon,
including any restrictions on versions, and an indication whether
the module is part of the standard Perl distribution, part of the
module's distribution, or must be installed separately. ]
L<< Net::LDAP >>
L<< Net::LDAP::Server >>
L<< Net::Server >>
L<< UNIVERSAL::isa >>
L<< Carp >>
L<< File::HomeDir >>
L<< File::Spec::Functions >>
L<< Scalar::Util >>
L<< Config::General >>
L<< Net::LDAP::SimpleServer::LDIFStore >>
=head1 INCOMPATIBILITIES
=for author to fill in:
A list of any modules that this module cannot be used in conjunction
with. This may be due to name conflicts in the interface, or
competition for system or program resources, or due to internal
limitations of Perl (for example, many modules that use source code
filters are mutually incompatible).
None reported.
=head1 BUGS AND LIMITATIONS
=for author to fill in:
A list of known problems with the module, together with some
indication Whether they are likely to be fixed in an upcoming
release. Also a list of restrictions on the features the module
does provide: data types that cannot be handled, performance issues
and the circumstances in which they may arise, practical
limitations on the size of data sets, special cases that are not
(yet) handled, etc.
No bugs have been reported.
Please report any bugs or feature requests to
C<bug-net-ldap-simpleserver@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.
=head1 AUTHOR
Alexei Znamensky C<< <russoz@cpan.org> >>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2010, Alexei Znamensky C<< <russoz@cpan.org> >>. All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=head1 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.