Code

- Added patch from LHM commit r15601 Closes: #849
[gosa.git] / gosa-si / gosa-si-client
1 #!/usr/bin/perl
2 #===============================================================================
3 #
4 #         FILE:  gosa-si-client
5 #
6 #        USAGE:  gosa-si-client
7 #
8 #  DESCRIPTION:
9 #
10 #      OPTIONS:  ---
11 # REQUIREMENTS:  libnetaddr-ip-perl
12 #         BUGS:  ---
13 #        NOTES:
14 #       AUTHOR:   (Andreas Rettenberger), <rettenberger@gonicus.de>
15 #      COMPANY:
16 #      VERSION:  1.0
17 #      CREATED:  12.09.2007 08:54:41 CEST
18 #     REVISION:  ---
19 #===============================================================================
21 my $client_version = '$HeadURL$:$Rev$';
23 use strict;
24 use warnings;
25 use Getopt::Long;
26 use Config::IniFiles;
27 use POSIX;
28 use Time::HiRes qw( gettimeofday );
30 use POE qw(Component::Server::TCP Wheel::FollowTail Wheel::Run);
31 use IO::Socket::INET;
32 use NetAddr::IP;
33 use Crypt::Rijndael;
34 use GOSA::GosaSupportDaemon;
35 use Digest::MD5  qw(md5_hex md5 md5_base64);
36 use MIME::Base64;
37 use XML::Simple;
38 use File::Basename;
39 use File::Spec;
40 use Fcntl;
42 # Workaround: need pure perl to make it work with UTF-8 :-(
43 $XML::Simple::PREFERRED_PARSER= "XML::SAX::PurePerl";
45 my $client_headURL;
46 my $client_revision;
47 my $client_status;
48 my $event_dir = "/usr/lib/gosa-si/client/events";
49 use lib "/usr/lib/gosa-si/client/events";
51 my (%cfg_defaults, $foreground, $verbose, $pid_file, $procid, $pid, $log_file, $fai_logpath);
52 my ($server_ip, $server_port, $server_timeout, $server_domain, $server_key_lifetime);
53 my ($client_port, $ldap_enabled, $ldap_config, $pam_config, $nss_config);
54 my ($root_uid, $adm_gid);
55 my $xml;
56 my $event_hash;
57 my $default_server_key;
58 my @servers;
59 my $gotoHardwareChecksum;
60 my $system_com;
61 $verbose= 1;
63 # globalise variables which are used in imported events
64 our $global_kernel;
65 our $cfg_file;
66 our $opts_file;
67 our $server_address;
68 our $client_address;
69 our $client_ip;
70 our $client_mac_address;
71 our $client_dnsname;
72 our $client_force_hostname;
73 our $server_key;
74 our $terminal_server_hash;
76 # default variables
77 my $REGISTERED = 0;
79 # path to fifo for non-gosa-si-client messages to gosa-si-server
80 my $fai_com_fifo = "/var/run/gosa-si-client.socket";
81 my $system_com_fifo = "/var/run/gosa-si-client-system-com.socket";
82 my %files_to_watch = (fai_fifo => $fai_com_fifo, system_fifo => $system_com_fifo); 
84 # in function register_at_gosa_si_server, after which period of seconds a new registration should be tried if a registration was 
85 # not successful until now
86 my $delay_set_time = 10;
87 our $prg= basename($0);
89 # all n seconds the client reports logged_in users to gosa-si-server
90 my $trigger_logged_in_users_report_delay = 600;
92 # all n seconds the client reports messages seen by user
93 my $trigger_seen_messages_delay = 30;
95 # directory where all log files from installation are stored
96 my $fai_log_dir = "/var/log/fai"; 
98 %cfg_defaults = (
99 "general" =>
100     {"log-file"           => [\$log_file, "/var/run/".$prg.".log"],
101     "pid-file"            => [\$pid_file, "/var/run/".$prg.".pid"],
102     "opts-file"            => [\$opts_file, "/var/run/".$prg.".opts"],
103     },
104 "client" => 
105     {"port"        => [\$client_port, "20083"],
106      "ip"          => [\$client_ip, "0.0.0.0"],
107      "mac-address" => [\$client_mac_address, "00:00:00:00:00:00"],
108      "server-domain"      => [\$server_domain, ""],
109      "ldap"               => [\$ldap_enabled, 1],
110      "ldap-config"        => [\$ldap_config, "/etc/ldap/ldap.conf"],
111      "pam-config"         => [\$pam_config, "/etc/pam_ldap.conf"],
112      "nss-config"         => [\$nss_config, "/etc/libnss-ldap.conf"],
113      "fai-logpath"        => [\$fai_logpath, "/var/log/fai/fai.log"],
114      "force-hostname"     => [\$client_force_hostname, "false"],
115      "system-com"         => [\$system_com, "disabled"],
116     },
117 "server" => {
118     "ip"          => [\$server_ip, "127.0.0.1"],
119     "port"         => [\$server_port, "20081"],
120     "key"          => [\$server_key, ""],
121     "timeout"      => [\$server_timeout, 10],
122     "key-lifetime" => [\$server_key_lifetime, 600], 
123     },
125 );
128 #=== FUNCTIONS = functions =====================================================
130 sub usage {
131     print STDERR << "EOF" ;
132 usage: $prg [-hvf] [-c config]
134            -h        : this (help) message
135            -c <file> : config file
136            -f        : foreground, process will not be forked to background
137            -v        : be verbose (multiple to increase verbosity)
138  
139 EOF
140     print "\n" ;
143 #===  FUNCTION  ================================================================
144 #         NAME: check_cmdline_param
145 #   PARAMETERS: 
146 #      RETURNS:  
147 #  DESCRIPTION: 
148 #===============================================================================
149 sub check_cmdline_param () {
150     my $err_config;
151     my $err_counter = 0;
152         if(not defined($cfg_file)) {
153                 $cfg_file = "/etc/gosa-si/client.conf";
154                 if(! -r $cfg_file) {
155                         $err_config = "please specify a config file";
156                         $err_counter += 1;
157                 }
158     }
159     if( $err_counter > 0 ) {
160         &usage( "", 1 );
161         if( defined( $err_config)) { print STDERR "$err_config\n"}
162         print STDERR "\n";
163         exit( -1 );
164     }
168 #===  FUNCTION  ================================================================
169 #         NAME: check_pid
170 #   PARAMETERS:
171 #      RETURNS:
172 #  DESCRIPTION:
173 #===============================================================================
174 sub check_pid {
175     $pid = -1;
176     # Check, if we are already running
177     if( open(LOCK_FILE, "<$pid_file") ) {
178         $pid = <LOCK_FILE>;
179         if( defined $pid ) {
180             chomp( $pid );
181             if( -f "/proc/$pid/stat" ) {
182                 my($stat) = `cat /proc/$pid/stat` =~ m/$pid \((.+)\).*/;
183                 if( $0 eq $stat ) {
184                     close( LOCK_FILE );
185                     exit -1;
186                 }
187             }
188         }
189         close( LOCK_FILE );
190         unlink( $pid_file );
191     }
193     # create a syslog msg if it is not to possible to open PID file
194     if (not sysopen(LOCK_FILE, $pid_file, O_WRONLY|O_CREAT|O_EXCL, 0644)) {
195         my($msg) = "Couldn't obtain lockfile '$pid_file' ";
196         if (open(LOCK_FILE, '<', $pid_file)
197                 && ($pid = <LOCK_FILE>))
198         {
199             chomp($pid);
200             $msg .= "(PID $pid)\n";
201         } else {
202             $msg .= "(unable to read PID)\n";
203         }
204         if( ! ($foreground) ) {
205             openlog( $0, "cons,pid", "daemon" );
206             syslog( "warning", $msg );
207             closelog();
208         }
209         else {
210             print( STDERR " $msg " );
211         }
212         exit( -1 );
213     }
217 sub sig_int_handler {
218     my ($signal) = @_;
219         
220     daemon_log("shutting down gosa-si-client", 1);
221     system("kill `ps -C gosa-si-client -o pid=`");
223 $SIG{INT} = \&sig_int_handler;
226 #===  FUNCTION  ================================================================
227 #         NAME:  logging
228 #   PARAMETERS:  level - string - default 'info' 
229 #                msg - string - 
230 #                facility - string - default 'LOG_DAEMON' 
231 #      RETURNS:  
232 #  DESCRIPTION: 
233 #===============================================================================
234 sub daemon_log {
235 # log into log_file
236     my( $msg, $level ) = @_;
237     if(not defined $msg) { return }
238     if(not defined $level) { $level = 1 }
239     if(defined $log_file){
240                 my $open_log_fh = sysopen(LOG_HANDLE, $log_file, O_WRONLY | O_CREAT | O_APPEND , 0440); 
241                 if(not $open_log_fh) {
242                         print STDERR "cannot open $log_file: $!";
243                         return;
244                 }       
245                 # check owner and group of log_file and update settings if necessary       
246                 my ($dev, $ino, $mode, $nlink, $uid, $gid, $rdev, $size, $atime, $mtime, $ctime, $blksize, $blocks) = stat($log_file);
247                 if((not $uid eq $root_uid) || (not $gid eq $adm_gid)) {
248                         chown($root_uid, $adm_gid, $log_file);
249                 }
251         chomp($msg);
252         if($level <= $verbose){
253             my ($seconds, $minutes, $hours, $monthday, $month,
254                     $year, $weekday, $yearday, $sommertime) = localtime(time);
255             $hours = $hours < 10 ? $hours = "0".$hours : $hours;
256             $minutes = $minutes < 10 ? $minutes = "0".$minutes : $minutes;
257             $seconds = $seconds < 10 ? $seconds = "0".$seconds : $seconds;
258             my @monthnames = ("Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec");
259             $month = $monthnames[$month];
260             $monthday = $monthday < 10 ? $monthday = "0".$monthday : $monthday;
261             $year+=1900;
263                         # Microseconds since epoch
264                         my $microSeconds = sprintf("%.2f", &Time::HiRes::clock_gettime());
265                         $microSeconds =~ s/^\d*(.\d\d)$/$1/;
268             my $log_msg = "$month $monthday $hours:$minutes:$seconds$microSeconds $prg $msg\n";
269             print LOG_HANDLE $log_msg;
270             if( $foreground ) { 
271                 print STDERR $log_msg;
272             }
273         }
274         close( LOG_HANDLE );
275     }
279 #===  FUNCTION  ================================================================
280 #         NAME:  get_mac 
281 #   PARAMETERS:  interface name (i.e. eth0)
282 #      RETURNS:  (mac address) 
283 #  DESCRIPTION:  Uses ioctl to get mac address directly from system.
284 #===============================================================================
285 sub get_mac {
286         my $ifreq= shift;
287         my $result;
288         if ($ifreq && length($ifreq) > 0) { 
289                 if($ifreq eq "all") {
290                         if(defined($server_ip)) {
291                                 $result = &get_local_mac_for_remote_ip($server_ip);
292                         } 
293                         elsif ($client_mac_address && length($client_mac_address) > 0 && !($client_mac_address eq "00:00:00:00:00:00")){
294                                 $result = &client_mac_address;
295                         } 
296                         else {
297                                 $result = "00:00:00:00:00:00";
298                         }
299                 } else {
300                         my $SIOCGIFHWADDR= 0x8927;     # man 2 ioctl_list
302                         # A configured MAC Address should always override a guessed value
303                         if ($client_mac_address and length($client_mac_address) > 0 and not($client_mac_address eq "00:00:00:00:00:00")) {
304                                 $result= $client_mac_address;
305                         }
306                         else {
307                                 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
308                                         or die "socket: $!";
310                                 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
311                                         my ($if, $mac)= unpack 'h36 H12', $ifreq;
313                                         if (length($mac) > 0) {
314                                                 $mac=~ m/^([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])$/;
315                                                 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
316                                                 $result = $mac;
317                                         }
318                                 }
319                         }
320                 }
321         }
322         return $result;
327 #===  FUNCTION  ================================================================
328 #         NAME:  get_local_mac_for_remote_ip
329 #   PARAMETERS:  none (takes server_ip from global variable)
330 #      RETURNS:  (ip address from interface that is used for communication) 
331 #  DESCRIPTION:  Uses ioctl to get routing table from system, checks which entry
332 #                matches (defaultroute last).
333 #===============================================================================
334 sub get_local_mac_for_remote_ip {
335         my $server_ip= shift;
336         my $result= "00:00:00:00:00:00";
338         if($server_ip =~ /^[a-z][a-z0-9\.]+/i) {
339                 my $ip_address = inet_ntoa(scalar gethostbyname($server_ip));
340                 if(defined($ip_address) && $ip_address =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/) {
341                         # Write ip address to $server_ip variable
342                         $server_ip = $ip_address;
343                 }
344         }
346         if($server_ip =~ /^(\d\d?\d?\.){3}\d\d?\d?$/) {
347                 my $PROC_NET_ROUTE= ('/proc/net/route');
349                 open(PROC_NET_ROUTE, "<$PROC_NET_ROUTE")
350                         or die "Could not open $PROC_NET_ROUTE";
352                 my @ifs = <PROC_NET_ROUTE>;
354                 close(PROC_NET_ROUTE);
356                 # Eat header line
357                 shift @ifs;
358                 chomp @ifs;
359                 foreach my $line(@ifs) {
360                         my ($Iface,$Destination,$Gateway,$Flags,$RefCnt,$Use,$Metric,$Mask,$MTU,$Window,$IRTT)=split(/\s/, $line);
361                         my $destination;
362                         my $mask;
363                         my ($d,$c,$b,$a)=unpack('a2 a2 a2 a2', $Destination);
364                         $destination= sprintf("%d.%d.%d.%d", hex($a), hex($b), hex($c), hex($d));
365                         ($d,$c,$b,$a)=unpack('a2 a2 a2 a2', $Mask);
366                         $mask= sprintf("%d.%d.%d.%d", hex($a), hex($b), hex($c), hex($d));
367                         if(new NetAddr::IP($server_ip)->within(new NetAddr::IP($destination, $mask))) {
368                                 # destination matches route, save mac and exit
369                                 $result= &get_mac($Iface);
370                                 last;
371                         }
372                 }
373         } else {
374                 daemon_log("get_local_mac_for_remote_ip was called with a non-ip parameter: $server_ip", 1);
375         }
376         return $result;
380 sub generate_hw_digest {
381         my $hw_data;
382         foreach my $line (split /\n/, `cat /proc/bus/pci/devices`) {
383                 $hw_data.= sprintf "%s", $line =~ /[^\s]+\s([^\s]+)\s.*/;
384         }
385         # linux-vserver has no /proc/bus/pci/devices 
386         if ( !$hw_data ) { 
387                 foreach my $line (split /\n/, `ifconfig | grep HWaddr`) { 
388                         $hw_data.= sprintf "%s", $line =~ /[^\s]+\s([^\s]+)\s.*/; 
389                 } 
390         } 
391         return(md5_base64($hw_data));
395 sub create_ciphering {
396     my ($passwd) = @_;
397         if((!defined($passwd)) || length($passwd)==0) {
398                 $passwd = "";
399         }
400     $passwd = substr(md5_hex("$passwd") x 32, 0, 32);
401     my $iv = substr(md5_hex('GONICUS GmbH'),0, 16);
402     my $my_cipher = Crypt::Rijndael->new($passwd , Crypt::Rijndael::MODE_CBC());
403     $my_cipher->set_iv($iv);
404     return $my_cipher;
408 sub encrypt_msg {
409     my ($msg, $key) = @_;
410     my $my_cipher = &create_ciphering($key);
411     my $len;
412     {
413             use bytes;
414             $len= 16-length($msg)%16;
415     }
416     $msg = "\0"x($len).$msg;
417     $msg = $my_cipher->encrypt($msg);
418     chomp($msg = &encode_base64($msg));
419     # there are no newlines allowed inside msg
420     $msg=~ s/\n//g;
421     return $msg;
425 sub decrypt_msg {
427     my ($msg, $key) = @_ ;
428     $msg = &decode_base64($msg);
429     my $my_cipher = &create_ciphering($key);
430     $msg = $my_cipher->decrypt($msg); 
431     $msg =~ s/\0*//g;
432     return $msg;
436 #===  FUNCTION  ================================================================
437 #         NAME:  send_msg_hash_to_target
438 #   PARAMETERS:  msg_hash - hash - xml_hash created with function create_xml_hash
439 #                PeerAddr string - socket address to send msg
440 #                PeerPort string - socket port, if not included in socket address
441 #      RETURNS:  nothing
442 #  DESCRIPTION:  ????
443 #===============================================================================
444 sub send_msg_hash_to_target {
445     my ($msg_hash, $address, $encrypt_key) = @_ ;
446     my $msg = &create_xml_string($msg_hash);
447     my $header = @{$msg_hash->{'header'}}[0];
448     my $error = &send_msg_to_target($msg, $address, $encrypt_key, $header);
449     
450     return $error;
453 sub _setREGISTERED {
454         my $newStatus = shift;
455         &daemon_log("DEBUG: set REGISTERED flag from '$REGISTERED' to '$newStatus'", 7);
456         $REGISTERED = $newStatus;
457         return;
460 sub send_msg_to_target {
461     my ($msg, $address, $encrypt_key, $msg_header) = @_ ;
462     my $error = 0;
464     if( $msg_header ) { $msg_header = "'$msg_header'-"; }
465     else { $msg_header = ""; }
467     # Memorize own source address
468     $msg =~ /<source>(\S+)<\/source>/;
469     my $own_source_address = $1;
471     # encrypt xml msg
472     my $crypted_msg = &encrypt_msg($msg, $encrypt_key);
474     # opensocket
475     my $socket = &open_socket($address);
476     if( !$socket ) {
477         daemon_log("WARNING: cannot send ".$msg_header."msg to '$address', host not reachable", 3);
478         if ($REGISTERED == 1) {
479             &_setREGISTERED(0);        # if server is not available, cause reregistering
480             daemon_log("INFO: cause reregistering at gosa-si-server", 5); 
481             $global_kernel->yield('register_at_gosa_si_server');
483         }
484         $error++;
485     }
486     
487     # send xml msg
488     if( $error == 0 ) {
489         print $socket $crypted_msg.";$own_source_address\n";
490         daemon_log("INFO: send ".$msg_header."msg to $address", 5);
491         daemon_log("DEBUG: message:\n$msg", 9);
492     }
494     # close socket in any case
495     if( $socket ) {
496         close $socket;
497     }
499     return $error;
503 sub write_to_file {
504     my ($string, $file) = @_;
505     my $error = 0;
507     if( not defined $file || not -f $file ) {
508         &main::daemon_log("ERROR: $prg: check '-f file' failed: $file", 1);
509         $error++;
510     }
511     if( not defined $string || 0 == length($string)) {
512         &main::daemon_log("ERROR: $prg: empty string to write to file '$file'", 1);
513         $error++;
514     }
515     
516     if( $error == 0 ) {
518         chomp($string);
519     
520         if (open(FILE, ">> $file")){
521           print FILE $string."\n";
522           close(FILE);
523         }
524     }
526     return;    
530 sub open_socket {
531     my ($PeerAddr, $PeerPort) = @_ ;
532     if(defined($PeerPort)){
533         $PeerAddr = $PeerAddr.":".$PeerPort;
534     }
535     my $socket;
536     $socket = new IO::Socket::INET(PeerAddr => $PeerAddr,
537             Porto => "tcp",
538             Type => SOCK_STREAM,
539             Timeout => 5,
540             );
541     if(not defined $socket) {
542         return;
543     }
544     &daemon_log("DEBUG: open_socket: $PeerAddr", 7);
545     return $socket;
549 #===  FUNCTION  ================================================================
550 #         NAME:  register_at_server
551 #   PARAMETERS:  
552 #      RETURNS:  
553 #  DESCRIPTION:  
554 #===============================================================================
555 sub register_at_gosa_si_server {
556         my ($kernel) = $_[KERNEL];
557         my $try_to_register = 0;
559         if ($REGISTERED) {
560                 # Client is already registered, clear all other registration events
561                 $kernel->delay('register_at_gosa_si_server');
562         } else {
563                 # Client is not registered, start registration process
564                 # Clear all other events and wait till registration was successful
565                 $kernel->delay('register_at_gosa_si_server');
566                 $kernel->delay('trigger_new_key');
568                 # Create new passwd and ciphering object for client-server communication
569                 $server_key = &create_passwd();
571                 my $events = join( ",", keys %{$event_hash} );
572                 while(1) {
573                         $try_to_register++;
575                         # after one complete round through all server, stop trying to register           
576                         if( $try_to_register > @servers )  { last; }
578                         # fetch first gosa-si-server from @servers
579                         # append shifted gosa-si-server at the end of @servers, so looking for servers never stop if
580                         # a registration never occured
581                         my $server = shift(@servers);
582                         push( @servers, $server );
584                         # Check if $server is a valid server address
585                         if(!(defined($server) && $server =~ m/^[0-9\.]*?:.*$/)) {
586                                 &main::daemon_log("ERROR: Server with address '".defined($server)?$server:""."' is invalid!", 1);
587                                 if (length(@servers) == 1) {
588                                         &main::daemon_log("ERROR: No valid servers found!", 1);
589                                         exit(1);
590                                 }
591                         }
593                         # Check if our ip is resolvable - if not: don't try to register
594                         my $ip= &get_local_ip_for_remote_ip(sprintf("%s", $server =~ /^([0-9\.]*?):.*$/));
595                         my $dnsname= gethostbyaddr(inet_aton($ip), AF_INET);
596                         if(!defined($dnsname)) {
597                                 if( defined($client_force_hostname) && $client_force_hostname eq "true") {
598                                         $dnsname = `hostname`;
599                                 } else {
600                                         &write_to_file("goto-error-dns:$ip", $fai_logpath);
601                                         &main::daemon_log("ERROR: ip is not resolvable, no registration possible. Write 'goto-error-dns:$ip' to $fai_logpath", 1);
602                                         exit(1);
603                                 }
604                         }
606                         # create registration msg
607                         my $local_ip = &get_local_ip_for_remote_ip(sprintf("%s", $server =~ /^([0-9\.]*?):.*$/));
608                         my $local_mac = &get_local_mac_for_remote_ip(sprintf("%s", $server =~ /^([0-9\.]*?):.*$/));
609                         my $register_hash = &create_xml_hash("here_i_am", $local_ip.":".$client_port, $server);
610                         &add_content2xml_hash($register_hash, "new_passwd", $server_key);
611                         &add_content2xml_hash($register_hash, "mac_address", $local_mac);
612                         &add_content2xml_hash($register_hash, "events", $events);
613                         &add_content2xml_hash($register_hash, "client_status", $client_status);
614                         &add_content2xml_hash($register_hash, "client_revision", $client_revision);
615                         &add_content2xml_hash($register_hash, "gotoHardwareChecksum", $gotoHardwareChecksum);
616                         &add_content2xml_hash($register_hash, "key_lifetime", $server_key_lifetime);
618                         # Add $HOSTNAME from ENV if force-hostname is set
619                         if( defined($client_force_hostname) && $client_force_hostname eq "true") {
620                                 if(defined($ENV{HOSTNAME}) && length($ENV{HOSTNAME}) >0 ) {
621                                         &add_content2xml_hash($register_hash, "force-hostname", $ENV{HOSTNAME});
622                                 } else {
623                                         &main::daemon_log("force-hostname was set to true, but no \$HOSTNAME was found in Environment!",0);
624                                 }
625                         }
627                         # send xml hash to server with general server passwd
628                         my $res = &send_msg_hash_to_target($register_hash, $server, $default_server_key);
630                         # if delivery of registration msg succeed
631                         if($res eq "0") {
632                                 # reset try_to_register
633                                 $try_to_register = 0;
635                                 # Set fixed client address and mac address
636                                 $client_ip= &get_local_ip_for_remote_ip(sprintf("%s", $server =~ /^([0-9\.]*?):.*$/));
637                                 $client_address= "$client_ip:$client_port";
638                                 $client_mac_address = $local_mac;
639                                 $client_dnsname = $dnsname;
640                                 last;
642                         # delivery of registration msg failed   
643                         } else {
644                                 # wait 1 sec until trying to register again
645                                 sleep(1);
646                                 next;
647                         }
649                 } # end of while
651                 if ( $try_to_register >= @servers )  {
652                         # One circle through all servers finished and no registration succeed
653                         &write_to_file("gosa-si-no-server-available", $fai_logpath);
654                 } else {
655                         # Delivery of registraion msg succeed, waiting for server response
656                         daemon_log("INFO: waiting for msg 'register_at_gosa_si_server'",5);
657                         # Clear old settings and set it again
658                         $kernel->delay('trigger_new_key');
659                         $kernel->delay_set('trigger_new_key', $server_key_lifetime);
660                 }
662                 # Set waiting time for 'register_at_gosa_si_server'-event
663                 $kernel->delay_set('register_at_gosa_si_server', $delay_set_time);
664         }
665         return;
667     
669 sub check_key_and_xml_validity {
670     my ($crypted_msg, $module_key) = @_;
672     my $msg;
673     my $msg_hash;
674     eval{
675         $msg = &decrypt_msg($crypted_msg, $module_key);
676         &main::daemon_log("decrypted_msg: \n$msg", 9);
678         $msg_hash = $xml->XMLin($msg, ForceArray=>1);
680         ##############
681         # check header
682         my $header_l = $msg_hash->{'header'};
683         if( 1 != @{$header_l} ) {
684             die 'no or more headers specified';
685         }
686         my $header = @{$header_l}[0];
687         if( 0 == length $header) {
688             die 'header has length 0';
689         }
691         ##############
692         # check source
693         my $source_l = $msg_hash->{'source'};
694         if( 1 != @{$source_l} ) {
695             die 'no or more than 1 sources specified';
696         }
697         my $source = @{$source_l}[0];
698         if( 0 == length $source) {
699             die 'source has length 0';
700         }
701         unless( $source =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:\d+$/ ) {
702             die "source '$source' is neither a complete ip-address with port nor 'GOSA'";
703         }
704         
705         ##############
706         # check target  
707         my $target_l = $msg_hash->{'target'};
708         if( 1 != @{$target_l} ) {
709             die 'no or more than 1 targets specified ';
710         }
711         my $target = @{$target_l}[0];
712         if( 0 == length $target) {
713             die 'target has length 0 ';
714         }
715         unless( $target =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:\d+$/ ){
716             die "source is neither a complete ip-address with port nor 'GOSA'";
717         }
718     };
719     if($@) {
720         &main::daemon_log("WARNING: do not understand the message or msg is not gosa-si envelope conform:", 5);
721         &main::daemon_log("$@", 8);
722         $msg = undef;
723         $msg_hash = undef;
724     }
726     return ($msg, $msg_hash);
730 sub check_outgoing_xml_validity {
731     my ($msg) = @_;
733     my $msg_hash;
734     eval{
735         $msg_hash = $xml->XMLin($msg, ForceArray=>1);
737         ##############
738         # check header
739         my $header_l = $msg_hash->{'header'};
740         if( 1 != @{$header_l} ) {
741             die 'no or more than one headers specified';
742         }
743         my $header = @{$header_l}[0];
744         if( 0 == length $header) {
745             die 'header has length 0';
746         }
748         ##############
749         # check source
750         my $source_l = $msg_hash->{'source'};
751         if( 1 != @{$source_l} ) {
752             die 'no or more than 1 sources specified';
753         }
754         my $source = @{$source_l}[0];
755         if( 0 == length $source) {
756             die 'source has length 0';
757         }
758         unless( $source =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:\d+$/ ||
759                 $source =~ /^GOSA$/i ) {
760             die "source '$source' is neither a complete ip-address with port";
761         }
762         
763         ##############
764         # check target  
765         my $target_l = $msg_hash->{'target'};
766         if( 1 != @{$target_l} ) {
767             die "no or more than one targets specified";
768         }
769         foreach my $target (@$target_l) {
770             if( 0 == length $target) {
771                 die "target has length 0";
772             }
773             unless( $target =~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:\d+$/ ) {
774                 die "target '$target' is not a complete ip-address with port or a valid target name";
775             }
776         }
777     };
778     if($@) {
779         daemon_log("WARNING: outgoing msg is not gosa-si envelope conform", 5);
780         daemon_log("$@ $msg", 8);
781         $msg_hash = undef;
782     }
783     return ($msg_hash);
787 sub trigger_new_key {
788     my ($kernel) = $_[KERNEL] ;   
790     my $msg = "<xml><header>new_key</header><source>$client_address</source><target>$client_address</target></xml>";
791     &send_msg_to_target($msg, $client_address, $server_key, 'new_key');
793     $kernel->delay_set('trigger_new_key', $server_key_lifetime);
797 sub trigger_logged_in_users_report {
798     my ($kernel) = $_[KERNEL] ;  
800     # just do if client is registered already
801     if( $REGISTERED ) {
802         my $result = qx(/usr/bin/users);
803                 my @logged_in_user_list;
804                 if( defined $result ) {
805                         chomp($result);
806                         @logged_in_user_list = split(/\s/, $result);
807                 }
808                 
809         system("echo 'CURRENTLY_LOGGED_IN ".join(" ", @logged_in_user_list)."' > /var/run/gosa-si-client.socket"); 
810         $kernel->delay_set('trigger_logged_in_users_report', $trigger_logged_in_users_report_delay);
811     } else {
812         # try it in 10 sec again
813         $kernel->delay_set('trigger_logged_in_users_report', 10);
814     }
817 sub trigger_set_terminal_server
819         # Function is defined in load_reporter.pm
820         if (exists $event_hash->{set_terminal_server}) 
821         {
822                 no strict 'refs';
823                 &{$event_hash->{set_terminal_server}."::set_terminal_server"};
824         }
825         else
826         {
827                 &daemon_log("0 ERROR: load_reporter.pm needs function set_terminal_server to write terminal server load information to client. Processing aborted!", 1);
828         }
829         return;
832 sub trigger_seen_messages {
833     my ($kernel) = $_[KERNEL] ;
835     # Select all files under /tmp with prefix 'goto_notify'
836     my $goto_dir = "/tmp";
837     opendir(DIR, $goto_dir);
838     my @goto_files = grep { /.+\.goto_notify$/ && -f "$goto_dir/$_" } readdir(DIR);
839     closedir DIR;
841     # Check if file has 'seen' tag
842     foreach my $goto_file (@goto_files) {
843         open(FILE, "$goto_dir/$goto_file");
844         my @lines = <FILE>;
845         close FILE;
847         my $source;
848         my $target;
849         my $usr;
850         my $subject;
851         my $message;
852         my $seen = 0;
853         chomp(@lines);
854         foreach my $line (@lines) {
855             if ($line =~ /^source:([\S\s]*)$/) {
856                 $source = $1
857             }
858             if ($line =~ /^target:([\S\s]*)$/) {
859                 $target = $1;
860             }
861             if ($line =~ /^usr:([\S\s]*)$/) {
862                 $usr = $1;
863             }
864             if ($line =~ /^subject:([\S\s]*)$/) {
865                 $subject = $1;
866             }
867             if ($line =~ /^message:([\S\s]*)$/) {
868                 $message = $1;
869             }
870             if ($line =~ /^seen$/) {
871                 $seen++;        
872             }
873         }
875         # Send 'confirm_usr_msg' back to msg-hosting server
876         if ($seen) {
877             my %data = ('usr'=>$usr, 'subject'=>$subject, 'message'=>$message);
878             my $confirm_msg = &build_msg("confirm_usr_msg", $target, $source, \%data);
879             my $send_error = &send_msg_to_target($confirm_msg, $server_address, $server_key);
881             # Delete file
882             if (not $send_error) {
883                 system("rm $goto_dir/$goto_file");
884             }
885         }
886     }
888     $kernel->delay_set('trigger_seen_messages', $trigger_seen_messages_delay);
890     return;
894 sub generic_file_error {
895     my ( $heap, $operation, $errno, $error_string, $wheel_id ) =
896       @_[ HEAP, ARG0, ARG1, ARG2, ARG3 ];
898     my $service = $heap->{services}->{$wheel_id};
899     daemon_log("ERROR: '$service' watcher $operation error $errno: $error_string", 1);
900     daemon_log("ERROR: shutting down '$service' file watcher", 1);
902     delete $heap->{services}->{$wheel_id};
903     delete $heap->{watchers}->{$wheel_id};
904     return;
908 sub fai_fifo_got_record {
909     my $file_record = $_[ARG0];
910     my $header;
911     my $content = "";
912     daemon_log("DEBUG: fifo got record: $file_record", 7); 
914     $file_record =~ /^(\S+)[ ]?([\s\S]+)?$/;
915     if( defined $1 ) {
916         $header = $1;
917     } else {
918         return;
919     }
921     if( defined $2 ) {
922         $content = $2;
923     }
925     my $clmsg_hash = &create_xml_hash("CLMSG_$header", $client_address, $server_address, $content);
926     &add_content2xml_hash($clmsg_hash, "macaddress", $client_mac_address);
927     my $utc_ts = &main::get_utc_time(); 
928     &add_content2xml_hash($clmsg_hash, "timestamp", $utc_ts);
929     my $clmsg = &create_xml_string($clmsg_hash);
930     &send_msg_to_target($clmsg, $server_address, $server_key, "CLMSG_$header");
932     # if installation finished, save all log files 
933     if ($file_record eq "TASKBEGIN finish") {
934         &save_fai_log($fai_log_dir); 
935     }
937     return;
941 sub system_fifo_got_record {
942         my ($kernel, $socket_com_record) = @_[KERNEL, ARG0];
943         $socket_com_record =~ /^(\S+)\s?([\s\S]*)$/; 
944         my $function = $1; 
945         my $content = $2;
947         if( exists $event_hash->{$function} ) 
948         {
949                 # a event exists with the header as name
950                 daemon_log("INFO: found event '$function' at event-module '".$event_hash->{$function}."'", 5);
951                 no strict 'refs';
952                 my $answer = &{$event_hash->{$function}."::$function"}($content, $kernel);
953                 &post_processing_and_sending($answer)
954         }
955         else 
956         {
957                 daemon_log("ERROR: Got input '$socket_com_record' from socket '$system_com_fifo'", 1);
958                 daemon_log("ERROR: No event '$function' found in event modules under '$event_dir'.", 1);
959         }
961 #       # Sanity check of fifo record
963 #       # Create record message
964 #       my $lr_msg_hash = &create_xml_hash("load_report", $client_address, $server_address, $file_record);
965 #       &add_content2xml_hash($lr_msg_hash, "macaddress", $client_mac_address);
966 #    my $utc_ts = &main::get_utc_time();
967 #    &add_content2xml_hash($lr_msg_hash, "timestamp", $utc_ts);
968 #    my $lr_msg = &create_xml_string($lr_msg_hash);
970 #       # Report message to si-server
971 #    &send_msg_to_target($lr_msg, $server_address, $server_key, "load_report");
972         
973         return;
977 sub save_fai_log {
978     my ($fai_log_dir) = @_ ;
979     my $FAI_DIR;
981         # Directory for log files after a softupdate
982     my $log_dir = File::Spec->catdir($fai_log_dir, "localhost/last");
984     if (not -d $log_dir) { 
985                 # Directory for log files after a new installation
986                 $log_dir = "/tmp/fai";
987                 if (not -d $log_dir) {
988                                 daemon_log("ERROR: cannot open directory $log_dir", 1);
989                                 return; 
990                 }
991     }
993     opendir($FAI_DIR, "$log_dir");
994     my @log_files = readdir($FAI_DIR);
995     closedir($FAI_DIR);   
997     my @log_list;
998     foreach my $log_file (@log_files) {
999         if( $log_file eq "." || $log_file eq ".." ) { next; }
1001         my $log = "log_file:$log_file:";
1002         $log_file = File::Spec->catfile( $log_dir, $log_file );
1004         if (not -f $log_file) {
1005             daemon_log("ERROR: cannot read $log_file", 1);
1006             next;
1007         }
1009         open(FILE, "<$log_file");
1010         my @lines = <FILE> ;
1011         close (FILE);
1012         my $log_string = join("", @lines); 
1013         $log .= &encode_base64($log_string);
1014         push(@log_list, $log); 
1015     }
1017     my $all_log_string = join("\n", @log_list); 
1018     my $msg_hash = &create_xml_hash("CLMSG_save_fai_log", $client_address, $server_address, $all_log_string);
1019     &add_content2xml_hash($msg_hash, "macaddress", $client_mac_address);
1020     my $msg = &create_xml_string($msg_hash);
1021     &send_msg_to_target($msg, $server_address, $server_key, "CLMSG_save_fai_log");
1026 sub sig_handler {
1027         my ($kernel, $signal) = @_[KERNEL, ARG0] ;
1028         daemon_log("0 INFO got signal '$signal'", 1); 
1029         $kernel->sig_handled();
1030         return;
1034 sub _start {
1035     my ($kernel, $heap) = @_[KERNEL, HEAP];
1036     $kernel->alias_set('client_session');
1037     $global_kernel = $kernel;       # this is used to throw events at each point of the skript
1038  
1039     $kernel->sig(USR1 => "sig_handler");
1041     # force a registration at a gosa-si-server
1042     $kernel->yield('register_at_gosa_si_server');
1043     
1044     # install all file watcher defined
1045     while( my($name, $file) = each %files_to_watch ) {
1046         my $watcher = POE::Wheel::FollowTail->new(
1047             Filename   => $file,
1048             InputEvent => $name."_record",
1049             ErrorEvent => "file_error",
1050             );
1051         $heap->{services}->{ $watcher->ID } = $name;
1052         $heap->{watchers}->{ $watcher->ID } = $watcher;
1053     }
1054     $kernel->yield('trigger_logged_in_users_report'); 
1055     $kernel->yield('trigger_seen_messages');
1059 sub _default {
1060     daemon_log("ERROR: can not handle incoming msg with header '$_[ARG0]'", 1);
1061     return;
1065 sub server_input {
1066     my ($kernel, $heap, $input, $wheel) = @_[KERNEL, HEAP, ARG0, ARG1];
1067     my $remote_ip = $heap->{'remote_ip'},
1068     my $error = 0;
1069     my $answer;
1070     
1071     daemon_log("INFO: Incoming msg from '$remote_ip'", 5);
1072     daemon_log("DEBUG: Incoming msg:\n$input\n", 9);
1074         # Cut of ip and port from msgs tail
1075         my ($encrypted_msg, $msg_source) = split(/;/, $input);
1077     my ($msg, $msg_hash) = &check_key_and_xml_validity($encrypted_msg, $server_key);
1078     if( (!$msg) || (!$msg_hash) ) {
1079         daemon_log("WARNING: Deciphering of incoming msg failed", 3);
1080         if($server_address =~ /$remote_ip/) {
1081             # Got a msg from gosa-si-server which can not be decrypted, the secrete is not up-to-date
1082             # cause a reregistering with a new secrete handshake
1083                         daemon_log("ERROR: Message from gosa-si-server could not be understood, cause reregistering at server", 1);
1084                         if ($REGISTERED) {
1085                                 daemon_log("INFO: Client has currently status registered so throw new registering event", 5);
1086                                 &_setREGISTERED(0);
1087                                 $kernel->post('client_session', 'register_at_gosa_si_server');
1088                         } else {
1089                                 daemon_log("INFO: Client is currently within a registration process so wait for the next registration itteration", 5);
1090                         }
1091         }
1092         $error++;
1093     }
1096     ######################
1097     # process incoming msg
1098     if( $error == 0 ) {
1099         my $header = @{$msg_hash->{header}}[0];
1100         my $source = @{$msg_hash->{source}}[0];
1102         if( exists $event_hash->{$header} ) {
1104             # a event exists with the header as name
1105             daemon_log("INFO: found event '$header' at event-module '".$event_hash->{$header}."'", 5);
1106             no strict 'refs';
1107             $answer = &{$event_hash->{$header}."::$header"}($msg, $msg_hash);
1108         }
1109         else {
1110             daemon_log("WARNING: no event '$header' found in event modules under $event_dir", 3);
1111         }
1112     }
1114     ########
1115     # answer
1116         &post_processing_and_sending($answer);
1118     return;
1121 sub post_processing_and_sending
1123         my ($answer) = @_ ;
1125         # Do nothing if answer does not exists
1126         if (not defined $answer) { return; }
1128         # Check gosa-si envelope validity
1129         my $answer_hash = &check_outgoing_xml_validity($answer);
1131         # If answer is valid go ahead
1132         if( not defined $answer_hash ) { return; }
1133         
1134         # Sending
1135         $answer =~ /<header>(\S+)<\/header>/;
1136         &send_msg_to_target($answer, $server_address, $server_key, $1);
1137         
1138         return;
1142 #==== MAIN = main ==============================================================
1143 #  parse commandline options
1144 Getopt::Long::Configure( "bundling" );
1145 GetOptions("h|help" => \&usage,
1146            "c|config=s" => \$cfg_file,
1147            "f|foreground" => \$foreground,
1148            "v|verbose+" => \$verbose,
1149            );
1151 #  read and set config parameters
1152 &check_cmdline_param ;
1153 &read_configfile($cfg_file, %cfg_defaults);
1154 &check_pid;
1157 # forward error messages to logfile
1158 if ( ! $foreground ) {
1159   open( STDIN,  '+>/dev/null' );
1160   open( STDOUT, '+>&STDIN'    );
1161   open( STDERR, '+>&STDIN'    );
1164 # Just fork, if we are not in foreground mode
1165 if( ! $foreground ) { 
1166     chdir '/'                 or die "Can't chdir to /: $!";
1167     $pid = fork;
1168     setsid                    or die "Can't start a new session: $!";
1169     umask 0;
1170 } else { 
1171     $pid = $$; 
1174 # Do something useful - put our PID into the pid_file
1175 if( 0 != $pid ) {
1176     open( LOCK_FILE, ">$pid_file" );
1177     print LOCK_FILE "$pid\n";
1178     close( LOCK_FILE );
1179     if( !$foreground ) { 
1180         exit( 0 ) 
1181     };
1184 # parse head url and revision from svn
1185 my $client_status_hash = { 'developmental'=>'revision', 'stable'=>'release'};
1186 $client_version =~ /^\$HeadURL: (\S+) \$:\$Rev: (\d+) \$$/;
1187 $client_headURL = defined $1 ? $1 : 'unknown' ;
1188 $client_revision = defined $2 ? $2 : 'unknown' ;
1189 if ($client_headURL =~ /\/tag\// || 
1190         $client_headURL =~ /\/branches\// ) {
1191     $client_status = "stable"; 
1192 } else {
1193     $client_status = "developmental" ;
1196 # Determine root uid and adm gid, used for creating log files
1197 $root_uid = getpwnam('root');
1198 $adm_gid = getgrnam('adm');
1199 if(not defined $adm_gid){
1200         $adm_gid = getgrnam('root');
1203 daemon_log(" ", 1);
1204 daemon_log("$prg started!", 1);
1205 daemon_log("INFO: status: $client_status", 1);
1206 daemon_log("INFO: ".$client_status_hash->{$client_status}.": $client_revision", 1); 
1208 # delete old DBsqlite lock files
1209 system('rm -f /tmp/gosa_si_lock*gosa-si-client*');
1211 # detect ip and mac address and complete host address
1212 $client_address = $client_ip.":".$client_port;
1213 my $network_interface= &get_interface_for_ip($client_ip);
1214 $client_mac_address= &get_mac($network_interface);
1215 daemon_log("INFO: ip address detected: $client_ip", 1);
1216 daemon_log("INFO: gosa-si-client mac address detected: $client_mac_address", 1);
1219 # import events
1220 my ($error, $result, $tmp_hash) = &import_events($event_dir);
1221 while (my ($module, $mod_event_hash) = each %$tmp_hash) {
1222     while (my ($event_name, $nothing) = each %$mod_event_hash) {
1223         $event_hash->{$event_name} = $module;
1224     }
1227 foreach my $log_line (@$result) {
1228     if ($log_line =~ / succeed: /) {
1229         &main::daemon_log("0 DEBUG: $log_line", 7);
1230     } else {
1231         &main::daemon_log("0 ERROR: $log_line", 1);
1232     }
1236 # compute hardware checksum
1237 $gotoHardwareChecksum= &generate_hw_digest();
1238 daemon_log("INFO: gotoHardwareChecksum detected: $gotoHardwareChecksum", 1);
1241 # create socket for incoming xml messages
1242 POE::Component::Server::TCP->new(
1243     Alias => 'gosa-si-client',
1244         Port => $client_port,
1245         ClientInput => \&server_input,
1246 );
1247 daemon_log("INFO: start socket for incoming xml messages at port '$client_port' ", 1);
1250 # prepare variables
1251 if( inet_aton($server_ip) ){ $server_ip = inet_ntoa(inet_aton($server_ip)); }
1252 if (defined $server_ip && defined $server_port) {
1253     $server_address = $server_ip.":".$server_port;
1255 $xml = new XML::Simple();
1256 $default_server_key = $server_key;
1258 # add gosa-si-server address from config file at first position of server list
1259 my $server_check_cfg = Config::IniFiles->new( -file => $cfg_file );
1260 my $server_check = (defined($server_check_cfg))?$server_check_cfg->val( "server", "ip"):undef;
1261 if( defined $server_check ) {
1262         unshift(@servers, $server_address);
1263         my $servers_string = join(", ", @servers);
1264         daemon_log("INFO: found servers in configuration file: $servers_string", 1);
1265 } else {
1266         my @tmp_servers;
1267         if ( !$server_domain) {
1268                 # Try our DNS Searchlist
1269                 my @domain_list = &get_dns_domains();
1270                 my $tmp_domains;
1271                 my $error_string;
1272                 for my $domain (@domain_list) {
1273                         chomp($domain);
1274                         ($tmp_domains, $error_string) = &get_server_addresses($domain);
1275                         if(@$tmp_domains) {
1276                                 for my $tmp_server(@$tmp_domains) {
1277                                         push @tmp_servers, $tmp_server;
1278                                 }
1279                         }
1280                 }
1281                 if (0 == @tmp_servers) {
1282                         my $log_string = "no gosa-si-server found in DNS for domain: ".join(", ", @domain_list) if (@domain_list);
1283                         my $log_string2 = "server addresses in domain: ".join(", ",@$tmp_domains) if (defined($tmp_domains));
1284                         daemon_log("ERROR: $log_string", 1) if (defined($log_string));
1285                         daemon_log("ERROR: $log_string2", 1) if (defined($log_string2));
1286                         daemon_log("ERROR: $error_string", 1) if (defined($error_string));
1287                         daemon_log("ERROR: please specify a gosa-si-server address or a domain in config file", 1);
1288                         kill 2, $$;
1289                 }
1290         } else {
1291                 @tmp_servers = &get_server_addresses($server_domain);
1292                 if( 0 == @tmp_servers ) {
1293                         daemon_log("ERROR: no gosa-si-server found in DNS for domain '$server_domain'",1);
1294                         daemon_log("ERROR: please specify a gosa-si-server address or a domain in config file", 1);
1295                         kill 2, $$;
1296                 } 
1297         }
1299         foreach my $server (@tmp_servers) { 
1300                 unshift(@servers, $server); 
1301         }
1302         my $servers_string = join(", ", @servers);
1303         daemon_log("INFO: found servers in DNS: $servers_string", 1);
1307 # Open a new fifo for FAI messages to gosa-si-server
1308 if (-p $fai_com_fifo) { unlink $fai_com_fifo }
1309 POSIX::mkfifo("$fai_com_fifo", 0600);
1311 # Open a new fifo for system communication, 
1312 if (-p $system_com_fifo) { unlink $system_com_fifo }
1313 if ($system_com eq "enabled") 
1314
1315         POSIX::mkfifo("$system_com_fifo", 0600); 
1318 POE::Session->create(
1319         inline_states => {
1320                 _start => \&_start, 
1321         _default => \&_default,
1322         sig_handler => \&sig_handler,
1323         register_at_gosa_si_server => \&register_at_gosa_si_server,
1325         # trigger periodical tasks
1326         trigger_new_key => \&trigger_new_key,
1327         trigger_logged_in_users_report => \&trigger_logged_in_users_report,
1328         trigger_seen_messages => \&trigger_seen_messages,
1330                 # trigger non periodical tasks
1331                 trigger_set_terminal_server => \&trigger_set_terminal_server,
1332         
1333         # handle records from each defined file differently
1334         fai_fifo_record => \&fai_fifo_got_record,
1335                 system_fifo_record => \&system_fifo_got_record,
1337         # handle file resets and errors the same way for each file
1338         file_reset => \&generic_file_reset,
1339         file_error => \&generic_file_error,
1340         }
1341 );
1343 POE::Kernel->run();
1344 exit;