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 Socket;
11 use XML::Simple;
12 use File::Spec;
13 use Data::Dumper;
14 use GOSA::DBsqlite;
15 use MIME::Base64;
17 my $event_dir = "/usr/lib/gosa-si/server/events";
18 use lib "/usr/lib/gosa-si/server/events";
20 BEGIN{}
21 END{}
23 my ($server_ip, $server_port, $server_passwd, $max_clients);
24 my ($gosa_ip, $gosa_mac_address, $gosa_port, $gosa_passwd, $network_interface);
25 my ($job_queue_timeout, $job_queue_file_name);
27 my $gosa_server;
28 my $event_hash;
30 my %cfg_defaults = (
31 "server" => {
32 "ip" => [\$server_ip, "0.0.0.0"],
33 "port" => [\$server_port, "20081"],
34 "key" => [\$server_passwd, ""],
35 "max-clients" => [\$max_clients, 100],
36 },
37 "GOsaPackages" => {
38 "ip" => [\$gosa_ip, "0.0.0.0"],
39 "port" => [\$gosa_port, "20082"],
40 "key" => [\$gosa_passwd, "none"],
41 "job-queue" => [\$job_queue_file_name, '/var/lib/gosa-si/jobs.db'],
42 },
43 );
46 ## START ##########################
48 # read configfile and import variables
49 &read_configfile();
50 $network_interface= &get_interface_for_ip($server_ip);
51 $gosa_mac_address= &get_mac($network_interface);
53 # complete addresses
54 if( inet_aton($server_ip) ){ $server_ip = inet_ntoa(inet_aton($server_ip)); }
55 our $server_address = "$server_ip:$server_port";
56 if( inet_aton($gosa_ip) ){ $gosa_ip = inet_ntoa(inet_aton($gosa_ip)); }
57 my $gosa_address = "$gosa_ip:$gosa_port";
59 # create general settings for this module
60 #y $gosa_cipher = &create_ciphering($gosa_passwd);
61 my $xml = new XML::Simple();
64 # import events
65 &import_events();
67 ## FUNCTIONS #################################################################
69 sub get_module_info {
70 my @info = ($gosa_address,
71 $gosa_passwd,
72 );
73 return \@info;
74 }
77 #=== FUNCTION ================================================================
78 # NAME: read_configfile
79 # PARAMETERS: cfg_file - string -
80 # RETURNS: nothing
81 # DESCRIPTION: read cfg_file and set variables
82 #===============================================================================
83 sub read_configfile {
84 my $cfg;
85 if( defined( $main::cfg_file) && ( (-s $main::cfg_file) > 0 )) {
86 if( -r $main::cfg_file ) {
87 $cfg = Config::IniFiles->new( -file => $main::cfg_file );
88 } else {
89 print STDERR "Couldn't read config file!";
90 }
91 } else {
92 $cfg = Config::IniFiles->new() ;
93 }
94 foreach my $section (keys %cfg_defaults) {
95 foreach my $param (keys %{$cfg_defaults{ $section }}) {
96 my $pinfo = $cfg_defaults{ $section }{ $param };
97 ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
98 }
99 }
100 }
102 #=== FUNCTION ================================================================
103 # NAME: get_interface_for_ip
104 # PARAMETERS: ip address (i.e. 192.168.0.1)
105 # RETURNS: array: list of interfaces if ip=0.0.0.0, matching interface if found, undef else
106 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
107 #===============================================================================
108 sub get_interface_for_ip {
109 my $result;
110 my $ip= shift;
111 if ($ip && length($ip) > 0) {
112 my @ifs= &get_interfaces();
113 if($ip eq "0.0.0.0") {
114 $result = "all";
115 } else {
116 foreach (@ifs) {
117 my $if=$_;
118 if(get_ip($if) eq $ip) {
119 $result = $if;
120 }
121 }
122 }
123 }
124 return $result;
125 }
127 #=== FUNCTION ================================================================
128 # NAME: get_interfaces
129 # PARAMETERS: none
130 # RETURNS: (list of interfaces)
131 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
132 #===============================================================================
133 sub get_interfaces {
134 my @result;
135 my $PROC_NET_DEV= ('/proc/net/dev');
137 open(PROC_NET_DEV, "<$PROC_NET_DEV")
138 or die "Could not open $PROC_NET_DEV";
140 my @ifs = <PROC_NET_DEV>;
142 close(PROC_NET_DEV);
144 # Eat first two line
145 shift @ifs;
146 shift @ifs;
148 chomp @ifs;
149 foreach my $line(@ifs) {
150 my $if= (split /:/, $line)[0];
151 $if =~ s/^\s+//;
152 push @result, $if;
153 }
155 return @result;
156 }
158 #=== FUNCTION ================================================================
159 # NAME: get_mac
160 # PARAMETERS: interface name (i.e. eth0)
161 # RETURNS: (mac address)
162 # DESCRIPTION: Uses ioctl to get mac address directly from system.
163 #===============================================================================
164 sub get_mac {
165 my $ifreq= shift;
166 my $result;
167 if ($ifreq && length($ifreq) > 0) {
168 if($ifreq eq "all") {
169 $result = "00:00:00:00:00:00";
170 } else {
171 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
173 # A configured MAC Address should always override a guessed value
174 if ($gosa_mac_address and length($gosa_mac_address) > 0) {
175 $result= $gosa_mac_address;
176 }
178 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
179 or die "socket: $!";
181 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
182 my ($if, $mac)= unpack 'h36 H12', $ifreq;
184 if (length($mac) > 0) {
185 $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])$/;
186 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
187 $result = $mac;
188 }
189 }
190 }
191 }
192 return $result;
193 }
195 #=== FUNCTION ================================================================
196 # NAME: get_ip
197 # PARAMETERS: interface name (i.e. eth0)
198 # RETURNS: (ip address)
199 # DESCRIPTION: Uses ioctl to get ip address directly from system.
200 #===============================================================================
201 sub get_ip {
202 my $ifreq= shift;
203 my $result= "";
204 my $SIOCGIFADDR= 0x8915; # man 2 ioctl_list
205 my $proto= getprotobyname('ip');
207 socket SOCKET, PF_INET, SOCK_DGRAM, $proto
208 or die "socket: $!";
210 if(ioctl SOCKET, $SIOCGIFADDR, $ifreq) {
211 my ($if, $sin) = unpack 'a16 a16', $ifreq;
212 my ($port, $addr) = sockaddr_in $sin;
213 my $ip = inet_ntoa $addr;
215 if ($ip && length($ip) > 0) {
216 $result = $ip;
217 }
218 }
220 return $result;
221 }
224 sub import_events {
225 if (not -e $event_dir) {
226 &main::daemon_log("G ERROR: cannot find directory or directory is not readable: $event_dir", 1);
227 }
228 opendir (DIR, $event_dir) or die "ERROR while loading gosa-si-events from directory $event_dir : $!\n";
230 while (defined (my $event = readdir (DIR))) {
231 if( $event eq "." || $event eq ".." ) { next; }
232 if( $event eq "siTriggered.pm" ) { next; } # SI specific events not needed in GosaPackages.pm
233 if( $event eq "clMessages.pm" ) { next; } # SI specific events not needed in GosaPackages.pm
235 eval{ require $event; };
236 if( $@ ) {
237 &main::daemon_log("G ERROR: import of event module '$event' failed", 1);
238 &main::daemon_log("$@", 1);
239 next;
240 }
242 $event =~ /(\S*?).pm$/;
243 my $event_module = $1;
244 my $events_l = eval( $1."::get_events()") ;
245 foreach my $event_name (@{$events_l}) {
246 $event_hash->{$event_name} = $event_module;
247 }
248 my $events_string = join( ", ", @{$events_l});
249 &main::daemon_log("G DEBUG: GosaPackages from '$1' imported events $events_string", 8);
250 }
251 }
254 #=== FUNCTION ================================================================
255 # NAME: process_incoming_msg
256 # PARAMETERS: crypted_msg - string - incoming crypted message
257 # RETURNS: nothing
258 # DESCRIPTION: handels the proceeded distribution to the appropriated functions
259 #===============================================================================
260 sub process_incoming_msg {
261 my ($msg, $msg_hash, $session_id) = @_ ;
262 my $header = @{$msg_hash->{header}}[0];
263 my @msg_l;
264 my @out_msg_l;
266 &main::daemon_log("$session_id DEBUG: GosaPackages: msg to process '$header'", 7);
268 if ($header =~ /^job_/) {
269 @msg_l = &process_job_msg($msg, $msg_hash, $session_id);
270 }
271 elsif ($header =~ /^gosa_/) {
272 @msg_l = &process_gosa_msg($msg, $msg_hash, $session_id);
273 }
274 else {
275 &main::daemon_log("$session_id ERROR: $header is not a valid GosaPackage-header, need a 'job_' or a 'gosa_' prefix", 1);
276 }
278 foreach my $out_msg ( @msg_l ) {
279 # substitute in all outgoing msg <source>GOSA</source> of <source>$server_address</source>
280 $out_msg =~ s/<source>GOSA<\/source>/<source>$server_address<\/source>/g;
281 $out_msg =~ s/<\/xml>/<session_id>$session_id<\/session_id><\/xml>/;
282 if (defined $out_msg){
283 push(@out_msg_l, $out_msg);
284 }
286 }
288 return \@out_msg_l;
289 }
292 sub process_gosa_msg {
293 my ($msg, $msg_hash, $session_id) = @_ ;
294 my $out_msg;
295 my @out_msg_l = ('nohandler');
296 my $sql_events;
298 my $header = @{$msg_hash->{'header'}}[0];
299 my $target = @{$msg_hash->{'target'}}[0];
300 $header =~ s/gosa_//;
302 # check local installed events
303 if( exists $event_hash->{$header} ) {
304 # a event exists with the header as name
305 &main::daemon_log("$session_id INFO: found event '$header' at event-module '".$event_hash->{$header}."'", 5);
306 no strict 'refs';
307 @out_msg_l = &{$event_hash->{$header}."::$header"}( $msg, $msg_hash, $session_id );
309 # check client registered events
310 } else {
311 $sql_events = "SELECT * FROM $main::known_clients_tn WHERE ( (macaddress LIKE '$target') OR (hostname='$target') )";
312 my $res = $main::known_clients_db->select_dbentry( $sql_events );
313 my $l = keys(%$res);
315 # set error if no or more than 1 hits are found for sql query
316 if ( $l != 1) {
317 @out_msg_l = ('knownclienterror');
319 # found exact 1 hit in db
320 } else {
321 my $client_events = $res->{'1'}->{'events'};
323 # client is registered for this event, deliver this message to client
324 if ($client_events =~ /,$header,/) {
325 $msg =~ s/<header>gosa_/<header>/;
326 @out_msg_l = ( $msg );
328 # client is not registered for this event, set error
329 } else {
330 @out_msg_l = ('noeventerror');
331 }
332 }
333 }
335 # if delivery not possible raise error and return
336 if (not defined $out_msg_l[0]) {
337 @out_msg_l = ();
338 } elsif ($out_msg_l[0] eq 'nohandler') {
339 &main::daemon_log("$session_id ERROR: GosaPackages: no event handler or core function defined for '$header'", 1);
340 @out_msg_l = ();
341 } elsif ($out_msg_l[0] eq 'knownclienterror') {
342 &main::daemon_log("$session_id ERROR: no or more than 1 hits are found at known_clients_db with sql query: '$sql_events'", 1);
343 &main::daemon_log("$session_id WARNING: processing is aborted and message will not be forwarded");
344 @out_msg_l = ();
345 } elsif ($out_msg_l[0] eq 'noeventerror') {
346 &main::daemon_log("$session_id WARNING: client '$target' is not registered for event '$header', processing is aborted", 1);
347 @out_msg_l = ();
348 }
350 return @out_msg_l;
351 }
354 sub process_job_msg {
355 my ($msg, $msg_hash, $session_id)= @_ ;
356 my $out_msg;
357 my $error = 0;
359 my $header = @{$msg_hash->{'header'}}[0];
360 $header =~ s/job_//;
361 my $target = @{$msg_hash->{'target'}}[0];
363 # if no timestamp is specified, use 19700101000000
364 my $timestamp = "19700101000000";
365 if( exists $msg_hash->{'timestamp'} ) {
366 $timestamp = @{$msg_hash->{'timestamp'}}[0];
367 }
369 #if no macaddress is specified, raise error
370 my $macaddress;
371 if( exists $msg_hash->{'macaddress'} ) {
372 $macaddress = @{$msg_hash->{'macaddress'}}[0];
373 } elsif (@{$msg_hash->{'target'}}[0] =~ /^([0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2})$/i ) {
374 $macaddress = $1;
375 } else {
376 $error ++;
377 $out_msg = "<xml>".
378 "<header>answer</header>".
379 "<source>$server_address</source>".
380 "<target>GOSA</target>".
381 "<answer1>1</answer1>".
382 "<error_string>no mac address specified, neither in target-tag nor in macaddres-tag</error_string>".
383 "</xml>";
384 }
386 # if mac address is already known in ldap, set plain_name to 'cn'
387 my $plain_name;
388 my $ldap_handle = &main::get_ldap_handle($session_id);
389 if( not defined $ldap_handle ) {
390 &main::daemon_log("$session_id ERROR: cannot connect to ldap", 1);
391 $plain_name = "none";
393 # try to fetch a 'real name'
394 } else {
395 my $mesg = $ldap_handle->search(
396 base => $main::ldap_base,
397 scope => 'sub',
398 attrs => ['cn'],
399 filter => "(macAddress=$macaddress)");
400 if($mesg->code) {
401 &main::daemon_log($mesg->error, 1);
402 $plain_name = "none";
403 } else {
404 my $entry= $mesg->entry(0);
405 $plain_name = $entry->get_value("cn");
406 }
407 }
409 if( $error == 0 ) {
410 # add job to job queue
411 my $func_dic = {table=>$main::job_queue_tn,
412 primkey=>[],
413 timestamp=>$timestamp,
414 status=>'waiting',
415 result=>'none',
416 progress=>'none',
417 headertag=>$header,
418 targettag=>$target,
419 xmlmessage=>$msg,
420 macaddress=>$macaddress,
421 plainname=>$plain_name,
422 };
423 my $res = $main::job_db->add_dbentry($func_dic);
424 if (not $res == 0) {
425 &main::daemon_log("$session_id ERROR: GosaPackages: process_job_msg: $res", 1);
426 } else {
427 &main::daemon_log("$session_id INFO: GosaPackages: $header job successfully added to job queue", 5);
428 }
429 $out_msg = "<xml><header>answer</header><source>$server_address</source><target>GOSA</target><answer1>$res</answer1></xml>";
430 }
432 my @out_msg_l = ( $out_msg );
433 return @out_msg_l;
434 }
436 1;