2 # Copyright (C) 2006-2008 Georgia Public Library Service
4 # Author: David J. Fiander
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of version 2 of the GNU General Public
8 # License as published by the Free Software Foundation.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public
16 # License along with this program; if not, write to the Free
17 # Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
25 use Sys::Syslog qw(syslog);
26 use Net::Server::PreFork;
27 use Net::Server::Proto;
29 use Socket qw(:crlf SOL_SOCKET SO_KEEPALIVE IPPROTO_TCP TCP_KEEPALIVE);
30 use Data::Dumper; # For debugging
31 require UNIVERSAL::require;
33 #use Sip qw(readline);
34 use Sip::Constants qw(:all);
35 use Sip::Configuration;
36 use Sip::Checksum qw(checksum verify_cksum);
39 use constant LOG_SIP => "local6"; # Local alias for the logging facility
42 our @ISA = qw(Net::Server::PreFork);
48 RAW => \&raw_transport,
49 telnet => \&telnet_transport,
50 http => \&http_transport,
55 my $config = Sip::Configuration->new($ARGV[0]);
62 foreach my $svc (keys %{$config->{listeners}}) {
63 push @parms, "port=" . $svc;
69 # Log lines look like this:
70 # Jun 16 21:21:31 server08 steve_sip: Sip::MsgType::_initialize('Login', ...)
71 # [ TIMESTAMP ] [ HOST ] [ IDENT ]: Message...
73 # The IDENT is determined by $ENV{SIP_LOG_IDENT}, if present.
74 # Otherwise it is "_sip" appended to $USER, if present, or "acs-server" as a fallback.
77 my $syslog_ident = $ENV{SIP_LOG_IDENT} || ($ENV{USER} ? $ENV{USER} . "_sip" : 'acs-server');
80 "log_file=Sys::Syslog",
81 "syslog_ident=$syslog_ident",
82 "syslog_facility=" . LOG_SIP;
85 # Server Management: set parameters for the Net::Server::PreFork
86 # module. The module silently ignores parameters that it doesn't
87 # recognize, and complains about invalid values for parameters
90 if (defined($config->{'server-params'})) {
91 while (my ($key, $val) = each %{$config->{'server-params'}}) {
92 push @parms, $key . '=' . $val;
99 # This is the main event.
100 SIPServer->run(@parms);
106 # process_request is the callback used by Net::Server to handle
107 # an incoming connection request.
109 sub process_request {
113 my ($sockaddr, $port, $proto);
116 # This is kind of kinky, but allows us to avoid requiring Socket::Linux.
117 # A simple "Socket::Linux"->use won't suffice since we need access to
118 # all of it's bareword constants as well.
120 use Socket::Linux qw(TCP_KEEPINTVL TCP_KEEPIDLE TCP_KEEPCNT);
121 setsockopt($self->{server}->{client}, SOL_SOCKET, SO_KEEPALIVE, 1);
122 setsockopt($self->{server}->{client}, IPPROTO_TCP, TCP_KEEPIDLE, 120);
123 setsockopt($self->{server}->{client}, IPPROTO_TCP, TCP_KEEPINTVL, 10);
127 "Consider installing Socket::Linux for TCP keepalive: $@") if $@;
129 $self->{account} = undef; # New connection, no need to keep login info
130 $self->{config} = $config;
132 $sockaddr = $self->{server}->{sockaddr};
133 $port = $self->{server}->{sockport};
134 $proto = $self->{server}->{client}->NS_proto();
135 syslog('LOG_INFO', "Inbound connection from $sockaddr on port $port and proto $proto");
137 $self->{service} = $config->find_service( $sockaddr, $port, $proto );
139 if (! defined($self->{service})) {
140 syslog( "LOG_ERR", "process_request: Unrecognized server connection: %s:%s/%s",
141 $sockaddr, $port, $proto );
142 die "process_request: Bad server connection";
145 $transport = $transports{ $self->{service}->{transport} };
147 if ( !defined($transport) ) {
148 syslog("LOG_WARNING", "Unknown transport '%s', dropping", $service->{transport});
152 # Transport has shut down, remove any lingering login info
153 $self->{account} = undef;
165 my $service = $self->{service};
168 my $timeout = $self->{service}->{timeout} || $self->{config}->{timeout} || 0;
171 local $SIG{ALRM} = sub { die "raw_transport Timed Out!\n"; };
172 syslog("LOG_DEBUG", "raw_transport: timeout is $timeout");
176 $input = Sip::read_SIP_packet(*STDIN);
181 syslog("LOG_INFO", "raw_transport: shutting down: EOF during login");
183 } elsif ($input !~ /\S/) {
184 syslog("LOG_INFO", "raw_transport: received whitespace line (length %s) during login, skipping", length($input));
187 $input =~ s/[\r\n]+$//sm; # Strip off trailing line terminator
188 if ($input =~ /^99/) { # SC Status
189 unless ($service->allow_sc_status_then_login()) {
190 die 'raw_transport: sending SC status before login not enabled, exiting';
192 Sip::MsgType::handle($input, $self, SC_STATUS);
195 last if Sip::MsgType::handle($input, $self, LOGIN);
200 syslog("LOG_ERR", "raw_transport: LOGIN ERROR: '$@'");
201 die "raw_transport: login error (timeout? $@), exiting";
202 } elsif (!$self->{account}) {
203 syslog("LOG_ERR", "raw_transport: LOGIN FAILED");
204 die "raw_transport: Login failed (no account), exiting";
207 syslog("LOG_DEBUG", "raw_transport: uname/inst: '%s/%s'",
208 $self->{account}->{id},
209 $self->{account}->{institution});
211 $self->sip_protocol_loop();
213 syslog("LOG_INFO", "raw_transport: shutting down");
216 sub telnet_transport {
222 my $config = $self->{config};
223 my $timeout = $self->{service}->{timeout} || $config->{timeout} || 0;
224 syslog("LOG_DEBUG", "telnet_transport: timeout is %s", $timeout);
226 # Until the terminal has logged in, we don't trust it
227 # so use a timeout to protect ourselves from hanging.
229 local $SIG{ALRM} = sub { die "telnet_transport: Timed Out ($timeout seconds)!\n";; };
230 local $| = 1; # Unbuffered output
243 $uid =~ s/[\r\n]+$//;
244 $pwd =~ s/[\r\n]+$//;
246 if (exists($config->{accounts}->{$uid})
247 && ($pwd eq $config->{accounts}->{$uid}->password())) {
248 $account = $config->{accounts}->{$uid};
251 syslog("LOG_WARNING", "Invalid login attempt: '%s'", $uid);
252 print("Invalid login$CRLF");
258 syslog("LOG_ERR", "telnet_transport: Login timed out");
259 die "Telnet Login Timed out";
260 } elsif (!defined($account)) {
261 syslog("LOG_ERR", "telnet_transport: Login Failed");
264 print "Login OK. Initiating SIP$CRLF";
267 $self->{account} = $account;
268 syslog("LOG_DEBUG", "telnet_transport: uname/inst: '%s/%s'", $account->{id}, $account->{institution});
269 $self->sip_protocol_loop();
270 syslog("LOG_INFO", "telnet_transport: shutting down");
278 # The terminal has logged in, using either the SIP login process
279 # over a raw socket, or via the pseudo-unix login provided by the
280 # telnet transport. From that point on, both the raw and the telnet
281 # processes are the same:
282 sub sip_protocol_loop {
285 my $service = $self->{service};
286 my $config = $self->{config};
288 my $timeout = $self->{service}->{timeout} || $config->{timeout} || 0;
290 # Now that the terminal has logged in, the first message
291 # we recieve must be an SC_STATUS message. But it might be
292 # an SC_REQUEST_RESEND. So, as long as we keep receiving
293 # SC_REQUEST_RESEND, we keep waiting for an SC_STATUS
295 # Comprise reports that no other ILS actually enforces this
296 # constraint, so we'll relax about it too. As long as everybody
297 # uses the SIP "raw" login process, rather than telnet, this
298 # will be fine, becaues the LOGIN protocol exchange will force
299 # us into SIP 2.00 anyway. Machines that want to log in using
300 # telnet MUST send an SC Status message first, even though we're
303 #$expect = SC_STATUS;
306 alarm $timeout; # First loop timeout
307 while ( $input = Sip::read_SIP_packet(*STDIN) ) {
308 alarm 0; # Don't timeout while we are processing
309 $input =~ s/[\r\n]+$//sm; # Strip off any trailing line ends
311 my $status = Sip::MsgType::handle($input, $self, $expect);
312 next if $status eq REQUEST_ACS_RESEND;
315 syslog("LOG_ERR", "raw_transport: failed to handle %s", substr($input,0,2));
316 die "sip_protocol_loop: failed Sip::MsgType::handle('$input', $self, '$expect')";
318 elsif ($expect && ($status ne $expect)) {
319 # We received a non-"RESEND" that wasn't what we were expecting.
320 syslog("LOG_ERR", "raw_transport: expected %s, received %s, exiting", $expect, $input);
321 die "sip_protocol_loop: exiting: expected '$expect', received '$status'";
324 # We successfully received and processed what we were expecting
326 alarm $timeout; # Next loop timeout