2cc5b97022e8f3c14c6374035c510ccd00e818e5
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) {
287 &main::daemon_log("function 'process_incoming_msg': got no msg", 7);
288 }
289 &main::daemon_log("GosaPackages: incoming msg: \n$crypted_msg", 7);
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: recieve '$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 = "UPDATE '$main::job_queue_table_name' SET status='done', result='$out_msg' WHERE id='$job_id'";
337 my $res = $main::job_db->exec_statement($sql);
338 return;
340 } else {
341 my $out_cipher = &create_ciphering($gosa_passwd);
342 $out_msg = &encrypt_msg($out_msg, $out_cipher);
343 return $out_msg;
344 }
346 }
348 sub process_gosa_msg {
349 my ($msg, $header) = @_ ;
350 my $out_msg;
351 $header =~ s/gosa_//;
352 &main::daemon_log("GosaPackages: got a gosa msg $header", 5);
354 # decide wether msg is a core function or a event handler
355 if ( $header eq 'query_jobdb') { $out_msg = &query_jobdb }
356 elsif ($header eq 'delete_jobdb_entry') { $out_msg = &delete_jobdb_entry }
357 elsif ($header eq 'clear_jobdb') { $out_msg = &clear_jobdb }
358 elsif ($header eq 'update_status_jobdb_entry' ) { $out_msg = &update_status_jobdb_entry }
359 elsif ($header eq 'update_timestamp_jobdb_entry' ) { $out_msg = &update_timestamp_jobdb_entry }
360 else {
361 # msg could not be assigned to core function
362 # fetch all available eventhandler under $server_event_dir
363 opendir (DIR, $server_event_dir) or &main::daemon_log("ERROR cannot open $server_event_dir: $!\n", 1) and return;
364 while (defined (my $file = readdir (DIR))) {
365 if (not $file eq $header) {
366 next;
367 }
368 # try to deliver incoming msg to eventhandler
369 my $cmd = File::Spec->join($server_event_dir, $header)." '$msg'";
370 &main::daemon_log("GosaPackages: execute event_handler $header", 3);
371 &main::daemon_log("GosaPackages: cmd: $cmd", 7);
373 $out_msg = "";
374 open(PIPE, "$cmd 2>&1 |");
375 while(<PIPE>) {
376 $out_msg.=$_;
377 }
378 close(PIPE);
379 &main::daemon_log("GosaPackages: answer of cmd: $out_msg", 5);
380 last;
381 }
382 }
384 # if delivery not possible raise error and return
385 if (not defined $out_msg) {
386 &main::daemon_log("ERROR: GosaPackages: no event handler or core function defined for $header", 1);
387 } elsif ($out_msg eq "") {
388 &main::daemon_log("ERROR: GosaPackages got not answer from event_handler $header", 1);
389 }
390 return $out_msg;
392 }
395 sub process_job_msg {
396 my ($msg, $msg_hash)= @_ ;
398 my $header = @{$msg_hash->{header}}[0];
399 $header =~ s/job_//;
400 &main::daemon_log("GosaPackages: got a job msg for queue: $header", 5);
402 # check wether mac address is already known in known_daemons or known_clients
403 my $target = 'none';
405 # add job to job queue
406 my $func_dic = {table=>$main::job_queue_table_name,
407 primkey=>'id',
408 timestamp=>@{$msg_hash->{timestamp}}[0],
409 status=>'waiting',
410 result=>'none',
411 headertag=>$header,
412 targettag=>$target,
413 xmlmessage=>$msg,
414 macaddress=>@{$msg_hash->{mac}}[0],
415 };
416 my $res = $main::job_db->add_dbentry($func_dic);
417 if (not $res == 0) {
418 &main::daemon_log("ERROR: GosaPackages: process_job_msg: $res", 1);
419 }
421 &main::daemon_log("GosaPackages: $header job successfully added to job queue", 3);
422 return "<xml><1>$res</1></xml>";
424 }
427 sub db_res_2_xml {
428 my ($db_res) = @_ ;
429 my $xml = "<xml>";
431 while ( my ($hit, $hash) = each %{ $db_res } ) {
432 $xml .= "<answer$hit>";
434 while ( my ($column_name, $column_value) = each %{$hash} ) {
435 $xml .= "<$column_name>";
436 my $xml_content = $column_value;
437 if( $column_name eq "xml" ) {
438 $xml_content = &encode_base64($column_value);
439 }
440 $xml .= $xml_content;
441 $xml .= "</$column_name>";
442 }
444 $xml .= "</answer$hit>";
445 }
447 $xml .= "</xml>";
448 return $xml;
449 }
452 ## CORE FUNCTIONS ############################################################
454 sub query_jobdb {
455 my ($msg) = @_;
456 my $msg_hash = &transform_msg2hash($msg);
458 # prepare query sql statement
459 my @where = @{$msg_hash->{where}};
460 my $where_hash = {table=>$main::job_queue_table_name };
461 foreach my $where_pram (@where) {
462 my $where_val = @{$msg_hash->{$where_pram}}[0];
463 if (defined $where_val) {
464 $where_hash->{$where_pram} = $where_val;
465 }
466 }
468 # execute db query
469 my $res_hash = $main::job_db->select_dbentry($where_hash);
471 my $out_xml = &db_res_2_xml($res_hash);
472 return $out_xml;
473 }
475 sub delete_jobdb_entry {
476 my ($msg) = @_ ;
477 my $msg_hash = &transform_msg2hash($msg);
479 # prepare query sql statement
480 my @where = @{$msg_hash->{where}};
481 my $where_hash = {table=>$main::job_queue_table_name };
482 foreach my $where_pram (@where) {
483 my $where_val = @{$msg_hash->{$where_pram}}[0];
484 if (defined $where_val) {
485 $where_hash->{$where_pram} = $where_val;
486 }
487 }
489 # execute db query
490 my $db_res = $main::job_db->del_dbentry($where_hash);
492 my $res;
493 if( $db_res > 0 ) {
494 $res = 0 ;
495 } else {
496 $res = 1;
497 }
499 # prepare xml answer
500 my $out_xml = "<xml><answer1>$res</answer1></xml>";
501 return $out_xml;
503 }
505 sub clear_jobdb {
506 my ($msg) = @_ ;
507 my $msg_hash = &transform_msg2hash($msg);
509 my $where_hash = {table=>$main::job_queue_table_name };
511 # execute db query
512 my $db_res = $main::job_db->del_dbentry($where_hash);
513 print STDERR "db_res=$db_res\n";
514 my $res;
515 if( $db_res eq '0E0' ) {
516 $res = 0 ;
517 } else {
518 $res = 1;
519 }
521 # prepare xml answer
522 my $out_xml = "<xml><answer1>$res</answer1></xml>";
523 return $out_xml;
524 }
526 sub update_status_jobdb_entry {
527 my ($msg) = @_ ;
528 my $msg_hash = &transform_msg2hash($msg);
530 # prepare query sql statement
531 my $update_hash = {table=>$main::job_queue_table_name };
532 if( exists $msg_hash->{where} ) {
533 $update_hash->{where} = $msg_hash->{where};
534 } else {
535 $update_hash->{where} = [];
536 }
538 if( not exists $msg_hash->{update}[0]->{status} ) {
539 return "<xml><answer1>1</answer1></xml>";
540 }
541 $update_hash->{update} = [ { status=>$msg_hash->{update}[0]->{status} } ];
543 # execute db query
544 my $db_res = $main::job_db->update_dbentry($update_hash);
546 # transform db answer to error returnment
547 my $res;
548 if( $db_res > 0 ) {
549 $res = 0 ;
550 } else {
551 $res = 1;
552 }
554 # prepare xml answer
555 my $out_xml = "<xml><answer1>$res</answer1></xml>";
556 return $out_xml;
557 }
559 sub update_timestamp_jobdb_entry {
560 my ($msg) = @_ ;
561 my $msg_hash = &transform_msg2hash($msg);
563 # prepare query sql statement
564 my $update_hash = {table=>$main::job_queue_table_name };
565 if( exists $msg_hash->{where} ) {
566 $update_hash->{where} = $msg_hash->{where};
567 } else {
568 $update_hash->{where} = [];
569 }
571 if( not exists $msg_hash->{update}[0]->{timestamp} ) {
572 return "<xml><answer1>1</answer1></xml>";
573 }
575 $update_hash->{update} = [ { timestamp=>$msg_hash->{update}[0]->{timestamp} } ];
577 # execute db query
578 my $db_res = $main::job_db->update_dbentry($update_hash);
580 # transform db answer to error returnment
581 my $res;
582 if( $db_res > 0 ) {
583 $res = 0 ;
584 } else {
585 $res = 1;
586 }
588 # prepare xml answer
589 my $out_xml = "<xml><answer1>$res</answer1></xml>";
590 return $out_xml;
592 }
595 1;