ffc99840c0ca5496ac9c4dd00dff843449a42b22
1 package GosaPackages;
3 use Exporter;
4 @ISA = ("Exporter");
6 use strict;
7 use warnings;
8 use GOSA::GosaSupportDaemon;
9 use IO::Socket::INET;
10 use XML::Simple;
11 use File::Spec;
12 use Data::Dumper;
13 use GOSA::DBsqlite;
14 use MIME::Base64;
16 BEGIN{}
17 END{}
19 my ($server_activ, $server_ip, $server_mac_address, $server_port, $server_passwd, $max_clients, $server_event_dir);
20 my ($bus_activ, $bus_passwd, $bus_ip, $bus_port);
21 my ($gosa_activ, $gosa_ip, $gosa_mac_address, $gosa_port, $gosa_passwd, $network_interface);
22 my ($job_queue_timeout, $job_queue_file_name);
24 my $gosa_server;
26 my %cfg_defaults =
27 ("general" =>
28 {"job_queue_file_name" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
29 },
30 "server" =>
31 {"server_activ" => [\$server_activ, "on"],
32 "server_ip" => [\$server_ip, "0.0.0.0"],
33 "server_port" => [\$server_port, "20081"],
34 "server_passwd" => [\$server_passwd, ""],
35 "max_clients" => [\$max_clients, 100],
36 "server_event_dir" => [\$server_event_dir, '/usr/lib/gosa-si/server/events'],
37 },
38 "bus" =>
39 {"bus_activ" => [\$bus_activ, "on"],
40 "bus_passwd" => [\$bus_passwd, ""],
41 "bus_ip" => [\$bus_ip, "0.0.0.0"],
42 "bus_port" => [\$bus_port, "20080"],
43 },
44 "gosa" =>
45 {"gosa_activ" => [\$gosa_activ, "on"],
46 "gosa_ip" => [\$gosa_ip, "0.0.0.0"],
47 "gosa_port" => [\$gosa_port, "20082"],
48 "gosa_passwd" => [\$gosa_passwd, "none"],
49 },
50 );
53 ## START ##########################
55 # read configfile and import variables
56 &read_configfile();
57 $network_interface= &get_interface_for_ip($server_ip);
58 $gosa_mac_address= &get_mac($network_interface);
60 # complete addresses
61 my $server_address = "$server_ip:$server_port";
62 my $bus_address = "$bus_ip:$bus_port";
63 my $gosa_address = "$gosa_ip:$gosa_port";
65 # create general settings for this module
66 my $gosa_cipher = &create_ciphering($gosa_passwd);
67 my $xml = new XML::Simple();
69 # open gosa socket
70 if ($gosa_activ eq "on") {
71 &main::daemon_log(" ",1);
72 $gosa_server = IO::Socket::INET->new(LocalPort => $gosa_port,
73 Type => SOCK_STREAM,
74 Reuse => 1,
75 Listen => 1,
76 );
77 if (not defined $gosa_server) {
78 &main::daemon_log("cannot start tcp server at $gosa_port for communication to gosa: $@", 1);
79 die;
80 } else {
81 &main::daemon_log("start server for communication to gosa: $gosa_address", 1);
83 }
84 }
86 # create gosa job queue as a SQLite DB
87 my $table_name = "jobs";
88 my $sqlite = GOSA::DBsqlite->new($job_queue_file_name);
93 ## FUNCTIONS #################################################################
95 sub get_module_info {
96 my @info = ($gosa_address,
97 $gosa_passwd,
98 $gosa_server,
99 $gosa_activ,
100 "socket",
101 );
102 return \@info;
103 }
106 #=== FUNCTION ================================================================
107 # NAME: read_configfile
108 # PARAMETERS: cfg_file - string -
109 # RETURNS: nothing
110 # DESCRIPTION: read cfg_file and set variables
111 #===============================================================================
112 sub read_configfile {
113 my $cfg;
114 if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
115 if( -r $main::cfg_file ) {
116 $cfg = Config::IniFiles->new( -file => $main::cfg_file );
117 } else {
118 print STDERR "Couldn't read config file!";
119 }
120 } else {
121 $cfg = Config::IniFiles->new() ;
122 }
123 foreach my $section (keys %cfg_defaults) {
124 foreach my $param (keys %{$cfg_defaults{ $section }}) {
125 my $pinfo = $cfg_defaults{ $section }{ $param };
126 ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
127 }
128 }
129 }
131 #=== FUNCTION ================================================================
132 # NAME: get_interface_for_ip
133 # PARAMETERS: ip address (i.e. 192.168.0.1)
134 # RETURNS: array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
135 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
136 #===============================================================================
137 sub get_interface_for_ip {
138 my $result;
139 my $ip= shift;
140 if ($ip && length($ip) > 0) {
141 my @ifs= &get_interfaces();
142 if($ip eq "0.0.0.0") {
143 $result = "all";
144 } else {
145 foreach (@ifs) {
146 my $if=$_;
147 if(get_ip($if) eq $ip) {
148 $result = $if;
149 }
150 }
151 }
152 }
153 return $result;
154 }
156 #=== FUNCTION ================================================================
157 # NAME: get_interfaces
158 # PARAMETERS: none
159 # RETURNS: (list of interfaces)
160 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
161 #===============================================================================
162 sub get_interfaces {
163 my @result;
164 my $PROC_NET_DEV= ('/proc/net/dev');
166 open(PROC_NET_DEV, "<$PROC_NET_DEV")
167 or die "Could not open $PROC_NET_DEV";
169 my @ifs = <PROC_NET_DEV>;
171 close(PROC_NET_DEV);
173 # Eat first two line
174 shift @ifs;
175 shift @ifs;
177 chomp @ifs;
178 foreach my $line(@ifs) {
179 my $if= (split /:/, $line)[0];
180 $if =~ s/^\s+//;
181 push @result, $if;
182 }
184 return @result;
185 }
187 #=== FUNCTION ================================================================
188 # NAME: get_mac
189 # PARAMETERS: interface name (i.e. eth0)
190 # RETURNS: (mac address)
191 # DESCRIPTION: Uses ioctl to get mac address directly from system.
192 #===============================================================================
193 sub get_mac {
194 my $ifreq= shift;
195 my $result;
196 if ($ifreq && length($ifreq) > 0) {
197 if($ifreq eq "all") {
198 $result = "00:00:00:00:00:00";
199 } else {
200 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
202 # A configured MAC Address should always override a guessed value
203 if ($gosa_mac_address and length($gosa_mac_address) > 0) {
204 $result= $gosa_mac_address;
205 }
207 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
208 or die "socket: $!";
210 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
211 my ($if, $mac)= unpack 'h36 H12', $ifreq;
213 if (length($mac) > 0) {
214 $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])$/;
215 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
216 $result = $mac;
217 }
218 }
219 }
220 }
221 return $result;
222 }
224 #=== FUNCTION ================================================================
225 # NAME: get_ip
226 # PARAMETERS: interface name (i.e. eth0)
227 # RETURNS: (ip address)
228 # DESCRIPTION: Uses ioctl to get ip address directly from system.
229 #===============================================================================
230 sub get_ip {
231 my $ifreq= shift;
232 my $result= "";
233 my $SIOCGIFADDR= 0x8915; # man 2 ioctl_list
234 my $proto= getprotobyname('ip');
236 socket SOCKET, PF_INET, SOCK_DGRAM, $proto
237 or die "socket: $!";
239 if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
240 my ($if, $sin) = unpack 'a16 a16', $ifreq;
241 my ($port, $addr) = sockaddr_in $sin;
242 my $ip = inet_ntoa $addr;
244 if ($ip && length($ip) > 0) {
245 $result = $ip;
246 }
247 }
249 return $result;
250 }
252 #=== FUNCTION ================================================================
253 # NAME: open_socket
254 # PARAMETERS: PeerAddr string something like 192.168.1.1 or 192.168.1.1:10000
255 # [PeerPort] string necessary if port not appended by PeerAddr
256 # RETURNS: socket IO::Socket::INET
257 # DESCRIPTION: open a socket to PeerAddr
258 #===============================================================================
259 sub open_socket {
260 my ($PeerAddr, $PeerPort) = @_ ;
261 if(defined($PeerPort)){
262 $PeerAddr = $PeerAddr.":".$PeerPort;
263 }
264 my $socket;
265 $socket = new IO::Socket::INET(PeerAddr => $PeerAddr ,
266 Porto => "tcp" ,
267 Type => SOCK_STREAM,
268 Timeout => 5,
269 );
270 if(not defined $socket) {
271 return;
272 }
273 &main::daemon_log("open_socket to: $PeerAddr", 7);
274 return $socket;
275 }
278 #=== FUNCTION ================================================================
279 # NAME: process_incoming_msg
280 # PARAMETERS: crypted_msg - string - incoming crypted message
281 # RETURNS: nothing
282 # DESCRIPTION: handels the proceeded distribution to the appropriated functions
283 #===============================================================================
284 sub process_incoming_msg {
285 my ($crypted_msg) = @_ ;
286 if( (not(defined($crypted_msg))) || (length($crypted_msg) <= 0)) {
287 &main::daemon_log("function 'process_incoming_msg': got no msg", 7);
288 return;
289 }
291 $crypted_msg =~ /^([\s\S]*?)\.(\d{1,3}?)\.(\d{1,3}?)\.(\d{1,3}?)\.(\d{1,3}?)$/;
292 $crypted_msg = $1;
293 my $host = sprintf("%s.%s.%s.%s", $2, $3, $4, $5);
295 # collect addresses from possible incoming clients
296 # only gosa is allowd as incoming client
297 &main::daemon_log("GosaPackages: host_key: $host", 7);
298 &main::daemon_log("GosaPackages: key_passwd: $gosa_passwd", 7);
300 $gosa_cipher = &create_ciphering($gosa_passwd);
302 # determine the correct passwd for deciphering of the incoming msgs
303 my $msg = "";
304 my $msg_hash;
305 eval{
306 $msg = &decrypt_msg($crypted_msg, $gosa_cipher);
307 &main::daemon_log("GosaPackages: decrypted_msg: \n$msg", 7);
309 $msg_hash = $xml->XMLin($msg, ForceArray=>1);
310 };
311 if($@) {
312 &main::daemon_log("WARNING: GosaPackages do not understand the message:", 5);
313 &main::daemon_log("$@", 7);
314 return;
315 }
317 my $header = @{$msg_hash->{header}}[0];
319 &main::daemon_log("GosaPackages: receive '$header' from $host", 1);
321 my $out_msg;
322 if ($header =~ /^job_/) {
323 $out_msg = &process_job_msg($msg, $msg_hash);
324 } elsif ($header =~ /^gosa_/) {
325 $out_msg = &process_gosa_msg($msg, $header);
326 } else {
327 &main::daemon_log("ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix");
328 }
330 if (not defined $out_msg) {
331 return;
332 }
334 if ($out_msg =~ /<jobdb_id>(\d*?)<\/jobdb_id>/) {
335 my $job_id = $1;
336 my $sql = "BEGIN TRANSATION; UPDATE '".$main::job_queue_table_name.
337 "' SET status='done', result='".$out_msg.
338 "' WHERE id='$job_id'; COMMIT;";
339 my $res = $main::job_db->exec_statement($sql);
340 return;
342 } else {
344 my $out_cipher = &create_ciphering($gosa_passwd);
345 $out_msg = &encrypt_msg($out_msg, $out_cipher);
346 return $out_msg;
347 }
349 }
351 sub process_gosa_msg {
352 my ($msg, $header) = @_ ;
353 my $out_msg;
354 $header =~ s/gosa_//;
356 # decide wether msg is a core function or a event handler
357 if ( $header eq 'query_jobdb') { $out_msg = &query_jobdb }
358 elsif ($header eq 'delete_jobdb_entry') { $out_msg = &delete_jobdb_entry }
359 elsif ($header eq 'clear_jobdb') { $out_msg = &clear_jobdb }
360 elsif ($header eq 'update_status_jobdb_entry' ) { $out_msg = &update_status_jobdb_entry }
361 elsif ($header eq 'update_timestamp_jobdb_entry' ) { $out_msg = &update_timestamp_jobdb_entry }
362 else {
363 # msg could not be assigned to core function
364 # fetch all available eventhandler under $server_event_dir
365 opendir (DIR, $server_event_dir) or &main::daemon_log("ERROR cannot open $server_event_dir: $!\n", 1) and return;
366 while (defined (my $file = readdir (DIR))) {
367 if (not $file eq $header) {
368 next;
369 }
370 # try to deliver incoming msg to eventhandler
371 my $cmd = File::Spec->join($server_event_dir, $header)." '$msg'";
372 &main::daemon_log("GosaPackages: execute event_handler $header", 3);
373 &main::daemon_log("GosaPackages: cmd: $cmd", 7);
375 $out_msg = "";
376 open(PIPE, "$cmd 2>&1 |");
377 while(<PIPE>) {
378 $out_msg.=$_;
379 }
380 close(PIPE);
381 &main::daemon_log("GosaPackages: answer of cmd: $out_msg", 5);
382 last;
383 }
384 }
386 # if delivery not possible raise error and return
387 if (not defined $out_msg) {
388 &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
389 } elsif ($out_msg eq "") {
390 &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
391 }
392 return $out_msg;
394 }
397 sub process_job_msg {
398 my ($msg, $msg_hash)= @_ ;
400 my $header = @{$msg_hash->{header}}[0];
401 $header =~ s/job_//;
403 # check wether mac address is already known in known_daemons or known_clients
404 my $target = 'none';
406 # add job to job queue
407 my $func_dic = {table=>$main::job_queue_table_name,
408 primkey=>'id',
409 timestamp=>@{$msg_hash->{timestamp}}[0],
410 status=>'waiting',
411 result=>'none',
412 headertag=>$header,
413 targettag=>$target,
414 xmlmessage=>$msg,
415 macaddress=>@{$msg_hash->{mac}}[0],
416 };
417 my $res = $main::job_db->add_dbentry($func_dic);
418 if (not $res == 0) {
419 &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
420 }
422 &main::daemon_log("GosaPackages: $header job successfully added to job queue", 3);
423 return "<xml><1>$res</1></xml>";
425 }
428 sub db_res_2_xml {
429 my ($db_res) = @_ ;
430 my $xml = "<xml>";
432 while ( my ($hit, $hash) = each %{ $db_res } ) {
433 $xml .= "\n<answer$hit>";
435 while ( my ($column_name, $column_value) = each %{$hash} ) {
436 $xml .= "<$column_name>";
437 my $xml_content;
438 if( $column_name eq "xmlmessage" ) {
439 $xml_content = &encode_base64($column_value);
440 } else {
441 $xml_content = $column_value;
442 }
443 $xml .= $xml_content;
444 $xml .= "</$column_name>";
445 }
447 $xml .= "</answer$hit>";
448 }
450 $xml .= "</xml>";
451 return $xml;
452 }
455 ## CORE FUNCTIONS ############################################################
457 sub query_jobdb {
458 my ($msg) = @_;
459 my $msg_hash = &transform_msg2hash($msg);
461 # prepare query sql statement
462 my @where = @{$msg_hash->{where}};
463 my $where_hash = {table=>$main::job_queue_table_name };
464 foreach my $where_pram (@where) {
465 my $where_val = @{$msg_hash->{$where_pram}}[0];
466 if (defined $where_val) {
467 $where_hash->{$where_pram} = $where_val;
468 }
469 }
471 # execute db query
472 my $res_hash = $main::job_db->select_dbentry($where_hash);
474 my $out_xml = &db_res_2_xml($res_hash);
475 return $out_xml;
476 }
478 sub delete_jobdb_entry {
479 my ($msg) = @_ ;
480 my $msg_hash = &transform_msg2hash($msg);
482 # prepare query sql statement
483 my @where = @{$msg_hash->{where}};
484 my $where_hash = {table=>$main::job_queue_table_name };
485 foreach my $where_pram (@where) {
486 my $where_val = @{$msg_hash->{$where_pram}}[0];
487 if (defined $where_val) {
488 $where_hash->{$where_pram} = $where_val;
489 }
490 }
492 # execute db query
493 my $db_res = $main::job_db->del_dbentry($where_hash);
495 my $res;
496 if( $db_res > 0 ) {
497 $res = 0 ;
498 } else {
499 $res = 1;
500 }
502 # prepare xml answer
503 my $out_xml = "<xml><answer1>$res</answer1></xml>";
504 return $out_xml;
506 }
508 sub clear_jobdb {
509 my ($msg) = @_ ;
510 my $msg_hash = &transform_msg2hash($msg);
512 my $where_hash = {table=>$main::job_queue_table_name };
514 # execute db query
515 my $db_res = $main::job_db->del_dbentry($where_hash);
516 print STDERR "db_res=$db_res\n";
517 my $res;
518 if( $db_res eq '0E0' ) {
519 $res = 0 ;
520 } else {
521 $res = 1;
522 }
524 # prepare xml answer
525 my $out_xml = "<xml><answer1>$res</answer1></xml>";
526 return $out_xml;
527 }
529 sub update_status_jobdb_entry {
530 my ($msg) = @_ ;
531 my $msg_hash = &transform_msg2hash($msg);
533 # prepare query sql statement
534 my $update_hash = {table=>$main::job_queue_table_name };
535 if( exists $msg_hash->{where} ) {
536 $update_hash->{where} = $msg_hash->{where};
537 } else {
538 $update_hash->{where} = [];
539 }
541 if( not exists $msg_hash->{update}[0]->{status} ) {
542 return "<xml><answer1>1</answer1></xml>";
543 }
544 $update_hash->{update} = [ { status=>$msg_hash->{update}[0]->{status} } ];
546 # execute db query
547 my $db_res = $main::job_db->update_dbentry($update_hash);
549 # transform db answer to error returnment
550 my $res;
551 if( $db_res > 0 ) {
552 $res = 0 ;
553 } else {
554 $res = 1;
555 }
557 # prepare xml answer
558 my $out_xml = "<xml><answer1>$res</answer1></xml>";
559 return $out_xml;
560 }
562 sub update_timestamp_jobdb_entry {
563 my ($msg) = @_ ;
564 my $msg_hash = &transform_msg2hash($msg);
566 # prepare query sql statement
567 my $update_hash = {table=>$main::job_queue_table_name };
568 if( exists $msg_hash->{where} ) {
569 $update_hash->{where} = $msg_hash->{where};
570 } else {
571 $update_hash->{where} = [];
572 }
574 if( not exists $msg_hash->{update}[0]->{timestamp} ) {
575 return "<xml><answer1>1</answer1></xml>";
576 }
578 $update_hash->{update} = [ { timestamp=>$msg_hash->{update}[0]->{timestamp} } ];
580 # execute db query
581 my $db_res = $main::job_db->update_dbentry($update_hash);
583 # transform db answer to error returnment
584 my $res;
585 if( $db_res > 0 ) {
586 $res = 0 ;
587 } else {
588 $res = 1;
589 }
591 # prepare xml answer
592 my $out_xml = "<xml><answer1>$res</answer1></xml>";
593 return $out_xml;
595 }
598 1;