1 package ArpHandler;
3 use Exporter;
4 @ISA = ("Exporter");
6 use strict;
7 use warnings;
8 use GOSA::GosaSupportDaemon;
9 use POSIX;
10 use Fcntl;
11 use Net::LDAP;
12 use Net::LDAP::LDIF;
13 use Net::LDAP::Entry;
14 use Net::DNS;
15 use Switch;
16 use Data::Dumper;
17 use Socket;
18 use utf8;
20 # Don't start if some of the modules are missing
21 my $start_service=1;
22 my $lookup_vendor=1;
23 BEGIN{
24 unless(eval('use Socket qw(PF_INET SOCK_DGRAM inet_ntoa sockaddr_in)')) {
25 $start_service=0;
26 }
27 unless(eval('use POE qw(Component::Pcap Component::ArpWatch)')) {
28 $start_service=0;
29 }
30 unless(eval('use Net::MAC::Vendor')) {
31 $lookup_vendor=0;
32 }
33 }
35 END{}
37 my ($timeout, $mailto, $mailfrom, $user, $group);
38 my ($arp_enabled, $arp_interface, $ldap_uri, $ldap_base, $ldap_admin_dn, $ldap_admin_password);
39 my $hosts_database={};
40 my $ldap;
42 my %cfg_defaults =
43 (
44 "ArpHandler" => {
45 "enabled" => [\$arp_enabled, "true"],
46 "interface" => [\$arp_interface, "all"],
47 },
48 "server" => {
49 "ldap-uri" => [\$ldap_uri, ""],
50 "ldap-base" => [\$ldap_base, ""],
51 "ldap-admin-dn" => [\$ldap_admin_dn, ""],
52 "ldap-admin-password" => [\$ldap_admin_password, ""],
53 },
54 );
56 #=== FUNCTION ================================================================
57 # NAME: read_configfile
58 # PARAMETERS: cfg_file - string -
59 # RETURNS: nothing
60 # DESCRIPTION: read cfg_file and set variables
61 #===============================================================================
62 sub read_configfile {
63 my $cfg;
64 if( defined( $main::cfg_file) && ( length($main::cfg_file) > 0 )) {
65 if( -r $main::cfg_file ) {
66 $cfg = Config::IniFiles->new( -file => $main::cfg_file );
67 } else {
68 print STDERR "Couldn't read config file!";
69 }
70 } else {
71 $cfg = Config::IniFiles->new() ;
72 }
73 foreach my $section (keys %cfg_defaults) {
74 foreach my $param (keys %{$cfg_defaults{ $section }}) {
75 my $pinfo = $cfg_defaults{ $section }{ $param };
76 ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] );
77 }
78 }
79 }
81 sub get_module_info {
82 my @info = (undef,
83 undef,
84 );
86 &read_configfile();
87 # Don't start if some of the modules are missing
88 if(($arp_enabled eq 'true') && $start_service) {
89 if($lookup_vendor) {
90 eval("Net::MAC::Vendor::load_cache('file:///usr/lib/gosa-si/modules/oui.txt')");
91 if($@) {
92 &main::daemon_log("Loading OUI cache file failed! MAC Vendor lookup disabled", 1);
93 $lookup_vendor=0;
94 } else {
95 &main::daemon_log("Loading OUI cache file suceeded!", 6);
96 }
97 }
98 if(defined($ldap_uri) && length($ldap_uri)>0) {
99 &main::refresh_ldap_handle();
100 if (!$main::ldap_handle) {
101 &main::daemon_log("Could not connect to LDAP Server at $ldap_uri!\n$@", 1);
102 }
103 } else {
104 $main::ldap_handle= undef;
105 }
107 # When interface is not configured (or 'all'), start arpwatch on all possible interfaces
108 if ((!defined($arp_interface)) || $arp_interface eq 'all') {
109 foreach my $device(&get_interfaces) {
110 # TODO: Need a better workaround for IPv4-to-IPv6 bridges
111 if($device =~ m/^sit\d+$/) {
112 next;
113 }
115 # If device has a valid mac address
116 # TODO: Check if this should be the right way
117 if(not(&get_mac($device) eq "00:00:00:00:00:00")) {
118 &main::daemon_log("Starting ArpWatch on $device", 1);
119 POE::Session->create(
120 inline_states => {
121 _start => sub {
122 &start(@_,$device);
123 },
124 _stop => sub {
125 $_[KERNEL]->post( sprintf("arp_watch_$device") => 'shutdown' )
126 },
127 got_packet => \&got_packet,
128 },
129 );
130 }
131 }
132 } else {
133 foreach my $device(split(/[\s,]+/, $arp_interface)) {
134 &main::daemon_log("Starting ArpWatch on $device", 1);
135 POE::Session->create(
136 inline_states => {
137 _start => sub {
138 &start(@_,$device);
139 },
140 _stop => sub {
141 $_[KERNEL]->post( sprintf("arp_watch_$device") => 'shutdown' )
142 },
143 got_packet => \&got_packet,
144 },
145 );
146 }
147 }
148 } else {
149 &main::daemon_log("ArpHandler disabled. Not starting any capture processes");
150 }
151 return \@info;
152 }
154 sub process_incoming_msg {
155 return 1;
156 }
158 sub start {
159 my $device = (exists($_[ARG0])?$_[ARG0]:'eth0');
160 POE::Component::ArpWatch->spawn(
161 Alias => sprintf("arp_watch_$device"),
162 Device => $device,
163 Dispatch => 'got_packet',
164 Session => $_[SESSION],
165 );
167 $_[KERNEL]->post( sprintf("arp_watch_$device") => 'run' );
168 }
170 sub got_packet {
171 my ($kernel, $heap, $sender, $packet) = @_[KERNEL, HEAP, SENDER, ARG0];
173 if( $packet->{source_haddr} eq "00:00:00:00:00:00" ||
174 $packet->{source_haddr} eq "ff:ff:ff:ff:ff:ff" ||
175 $packet->{source_ipaddr} eq "0.0.0.0") {
176 return;
177 }
179 my $capture_device = sprintf "%s", $kernel->alias_list($sender) =~ /^arp_watch_(.*)$/;
181 if(!exists($hosts_database->{$packet->{source_haddr}})) {
182 my $dnsname= gethostbyaddr(inet_aton($packet->{source_ipaddr}), AF_INET) || $packet->{source_ipaddr};
183 my $ldap_result=&get_host_from_ldap($packet->{source_haddr});
184 if(exists($ldap_result->{dn})) {
185 $hosts_database->{$packet->{source_haddr}}=$ldap_result;
186 $hosts_database->{$packet->{source_haddr}}->{dnsname}= $dnsname;
187 if(!exists($ldap_result->{ipHostNumber})) {
188 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber}=$packet->{source_ipaddr};
189 } else {
190 if(!($ldap_result->{ipHostNumber} eq $packet->{source_ipaddr})) {
191 &main::daemon_log(
192 "Current IP Address ".$packet->{source_ipaddr}.
193 " of host ".$hosts_database->{$packet->{source_haddr}}->{dnsname}.
194 " differs from LDAP (".$ldap_result->{ipHostNumber}.")", 4);
195 }
196 }
197 $hosts_database->{$packet->{source_haddr}}->{dnsname}=$dnsname;
198 &main::daemon_log("Host was found in LDAP as ".$ldap_result->{dn}, 8);
199 } else {
200 $hosts_database->{$packet->{source_haddr}}={
201 macAddress => $packet->{source_haddr},
202 ipHostNumber => $packet->{source_ipaddr},
203 dnsname => $dnsname,
204 cn => (($dnsname =~ /^(\d){1,3}\.(\d){1,3}\.(\d){1,3}\.(\d){1,3}/) ? $dnsname : sprintf "%s", $dnsname =~ /([^\.]+)\./),
205 macVendor => (($lookup_vendor) ? &get_vendor_for_mac($packet->{source_haddr}) : "Unknown Vendor"),
206 };
207 &main::daemon_log("Host was not found in LDAP (".($hosts_database->{$packet->{source_haddr}}->{dnsname}).")",6);
208 &main::daemon_log(
209 "New Host ".($hosts_database->{$packet->{source_haddr}}->{dnsname}).
210 ": ".$hosts_database->{$packet->{source_haddr}}->{ipHostNumber}.
211 "/".$hosts_database->{$packet->{source_haddr}}->{macAddress},4);
212 &add_ldap_entry(
213 $main::ldap_handle,
214 $ldap_base,
215 $hosts_database->{$packet->{source_haddr}}->{macAddress},
216 'new-system',
217 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber},
218 'interface',
219 $hosts_database->{$packet->{source_haddr}}->{macVendor});
220 }
221 $hosts_database->{$packet->{source_haddr}}->{device}= $capture_device;
222 } else {
223 if(!($hosts_database->{$packet->{source_haddr}}->{ipHostNumber} eq $packet->{source_ipaddr})) {
224 &main::daemon_log(
225 "IP Address change of MAC ".$packet->{source_haddr}.
226 ": ".$hosts_database->{$packet->{source_haddr}}->{ipHostNumber}.
227 "->".$packet->{source_ipaddr}, 4);
228 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber}= $packet->{source_ipaddr};
229 &change_ldap_entry(
230 $main::ldap_handle,
231 $ldap_base,
232 $hosts_database->{$packet->{source_haddr}}->{macAddress},
233 'ip-changed',
234 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber},
235 );
237 }
238 &main::daemon_log("Host already in cache (".($hosts_database->{$packet->{source_haddr}}->{device})."->".($hosts_database->{$packet->{source_haddr}}->{dnsname}).")",8);
239 }
240 }
242 sub get_host_from_ldap {
243 my $mac=shift;
244 my $result={};
246 if(defined($main::ldap_handle)) {
247 my $ldap_result= &search_ldap_entry(
248 $main::ldap_handle,
249 $ldap_base,
250 "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))"
251 );
253 if(defined($ldap_result) && $ldap_result->count==1) {
254 if(exists($ldap_result->{entries}[0]) &&
255 exists($ldap_result->{entries}[0]->{asn}->{objectName}) &&
256 exists($ldap_result->{entries}[0]->{asn}->{attributes})) {
258 for my $attribute(@{$ldap_result->{entries}[0]->{asn}->{attributes}}) {
259 if($attribute->{type} eq 'cn') {
260 $result->{cn} = $attribute->{vals}[0];
261 }
262 if($attribute->{type} eq 'macAddress') {
263 $result->{macAddress} = $attribute->{vals}[0];
264 }
265 if($attribute->{type} eq 'dhcpHWAddress') {
266 $result->{dhcpHWAddress} = $attribute->{vals}[0];
267 }
268 if($attribute->{type} eq 'ipHostNumber') {
269 $result->{ipHostNumber} = $attribute->{vals}[0];
270 }
271 }
272 }
273 $result->{dn} = $ldap_result->{entries}[0]->{asn}->{objectName};
274 }
275 }
277 return $result;
278 }
280 #=== FUNCTION ================================================================
281 # NAME: get_interfaces
282 # PARAMETERS: none
283 # RETURNS: (list of interfaces)
284 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
285 #===============================================================================
286 sub get_interfaces {
287 my @result;
288 my $PROC_NET_DEV= ('/proc/net/dev');
290 open(PROC_NET_DEV, "<$PROC_NET_DEV")
291 or die "Could not open $PROC_NET_DEV";
293 my @ifs = <PROC_NET_DEV>;
295 close(PROC_NET_DEV);
297 # Eat first two line
298 shift @ifs;
299 shift @ifs;
301 chomp @ifs;
302 foreach my $line(@ifs) {
303 my $if= (split /:/, $line)[0];
304 $if =~ s/^\s+//;
305 push @result, $if;
306 }
308 return @result;
309 }
311 #=== FUNCTION ================================================================
312 # NAME: get_mac
313 # PARAMETERS: interface name (i.e. eth0)
314 # RETURNS: (mac address)
315 # DESCRIPTION: Uses ioctl to get mac address directly from system.
316 #===============================================================================
317 sub get_mac {
318 my $ifreq= shift;
319 my $result;
320 if ($ifreq && length($ifreq) > 0) {
321 if($ifreq eq "all") {
322 $result = "00:00:00:00:00:00";
323 } else {
324 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
326 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
327 or die "socket: $!";
329 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
330 my ($if, $mac)= unpack 'h36 H12', $ifreq;
332 if (length($mac) > 0) {
333 $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])$/;
334 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
335 $result = $mac;
336 }
337 }
338 }
339 }
340 return $result;
341 }
343 sub get_vendor_for_mac {
344 my $mac=shift;
345 my $result="Unknown Vendor";
347 if(defined($mac)) {
348 my $vendor= Net::MAC::Vendor::fetch_oui_from_cache(Net::MAC::Vendor::normalize_mac($mac));
349 if(length($vendor) > 0) {
350 $result= @{$vendor}[0];
351 }
352 &main::daemon_log("Looking up Vendor for MAC ".$mac.": $result", 4);
353 }
355 return $result;
356 }
358 #=== FUNCTION ================================================================
359 # NAME: add_ldap_entry
360 # PURPOSE: adds an element to ldap-tree
361 # PARAMETERS:
362 # RETURNS: none
363 # DESCRIPTION: ????
364 # THROWS: no exceptions
365 # COMMENTS: none
366 # SEE ALSO: n/a/bin
367 #===============================================================================
368 sub add_ldap_entry {
369 my ($ldap_tree, $ldap_base, $mac, $gotoSysStatus, $ip, $interface, $desc) = @_;
370 if(defined($ldap_tree)) {
371 my $dn = "cn=".$hosts_database->{$mac}->{cn}.",ou=incoming,$ldap_base";
372 my $s_res = &search_ldap_entry($ldap_tree, $ldap_base, "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))");
373 my $c_res = (defined($s_res))?$s_res->count:0;
374 if($c_res == 1) {
375 &main::daemon_log("WARNING: macAddress $mac already in LDAP", 1);
376 return;
377 } elsif($c_res > 0) {
378 &main::daemon_log("ERROR: macAddress $mac exists $c_res times in LDAP", 1);
379 return;
380 }
382 # create LDAP entry
383 my $entry = Net::LDAP::Entry->new( $dn );
384 $entry->dn($dn);
385 $entry->add("objectClass" => "goHard");
386 $entry->add("cn" => $hosts_database->{$mac}->{cn});
387 $entry->add("macAddress" => $mac);
388 if(defined $gotoSysStatus) {$entry->add("gotoSysStatus" => $gotoSysStatus)}
389 if(defined $ip) {$entry->add("ipHostNumber" => $ip) }
390 #if(defined $interface) { }
391 if(defined $desc) {$entry->add("description" => $desc) }
393 # submit entry to LDAP
394 my $result = $entry->update ($ldap_tree);
396 # for $result->code constants please look at Net::LDAP::Constant
397 if($result->code == 68) { # entry already exists
398 &main::daemon_log("WARNING: $dn ".$result->error, 3);
399 } elsif($result->code == 0) { # everything went fine
400 &main::daemon_log("add entry $dn to ldap", 1);
401 } else { # if any other error occur
402 &main::daemon_log("ERROR: $dn, ".$result->code.", ".$result->error, 1);
403 }
404 } else {
405 &main::daemon_log("Not adding new Entry: LDAP disabled", 6);
406 }
407 return;
408 }
411 #=== FUNCTION ================================================================
412 # NAME: change_ldap_entry
413 # PURPOSE: ????
414 # PARAMETERS: ????
415 # RETURNS: ????
416 # DESCRIPTION: ????
417 # THROWS: no exceptions
418 # COMMENTS: none
419 # SEE ALSO: n/a
420 #===============================================================================
421 sub change_ldap_entry {
422 my ($ldap_tree, $ldap_base, $mac, $gotoSysStatus, $ip) = @_;
424 if(defined($ldap_tree)) {
425 # check if ldap_entry exists or not
426 my $s_res = &search_ldap_entry($ldap_tree, $ldap_base, "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))");
427 my $c_res = (defined $s_res)?$s_res->count:0;
428 if($c_res == 0) {
429 &main::daemon_log("WARNING: macAddress $mac not in LDAP", 1);
430 return;
431 } elsif($c_res > 1) {
432 &main::daemon_log("ERROR: macAddress $mac exists $c_res times in LDAP", 1);
433 return;
434 }
436 my $s_res_entry = $s_res->pop_entry();
437 my $dn = $s_res_entry->dn();
438 my $replace = {
439 'gotoSysStatus' => $gotoSysStatus,
440 };
441 if (defined($ip)) {
442 $replace->{'ipHostNumber'} = $ip;
443 }
444 my $result = $main::ldap_handle->modify( $dn, replace => $replace );
446 # for $result->code constants please look at Net::LDAP::Constant
447 if($result->code == 32) { # entry doesnt exists
448 &add_ldap_entry($mac, $gotoSysStatus);
449 } elsif($result->code == 0) { # everything went fine
450 &main::daemon_log("entry $dn changed successful", 1);
451 } else { # if any other error occur
452 &main::daemon_log("ERROR: $dn, ".$result->code.", ".$result->error, 1);
453 }
454 } else {
455 &main::daemon_log("Not changing Entry: LDAP disabled", 6);
456 }
458 return;
459 }
461 #=== FUNCTION ================================================================
462 # NAME: search_ldap_entry
463 # PURPOSE: ????
464 # PARAMETERS: [Net::LDAP] $ldap_tree - object of an ldap-tree
465 # string $sub_tree - dn of the subtree the search is performed
466 # string $search_string - either a string or a Net::LDAP::Filter object
467 # RETURNS: [Net::LDAP::Search] $msg - result object of the performed search
468 # DESCRIPTION: ????
469 # THROWS: no exceptions
470 # COMMENTS: none
471 # SEE ALSO: n/a
472 #===============================================================================
473 sub search_ldap_entry {
474 my ($ldap_tree, $sub_tree, $search_string) = @_;
475 my $msg;
476 if(defined($ldap_tree)) {
477 $msg = $ldap_tree->search( # perform a search
478 base => $sub_tree,
479 filter => $search_string,
480 ) or &main::daemon_log("cannot perform search at ldap: $@", 1);
481 }
482 return $msg;
483 }
485 1;