gosa-si/modules/GosaPackages.pm

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