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 utf8;
19 # Don't start if some of the modules are missing
20 my $start_service=1;
21 my $lookup_vendor=1;
22 BEGIN{
23 unless(eval('use Socket qw(PF_INET SOCK_DGRAM inet_ntoa sockaddr_in)')) {
24 $start_service=0;
25 }
26 unless(eval('use POE qw(Component::Pcap Component::ArpWatch)')) {
27 $start_service=0;
28 }
29 unless(eval('use Net::MAC::Vendor')) {
30 $lookup_vendor=0;
31 }
32 }
34 END{}
36 my ($timeout, $mailto, $mailfrom, $user, $group);
37 my ($arp_enabled, $arp_interface, $ldap_uri, $ldap_base, $ldap_admin_dn, $ldap_admin_password);
38 my $hosts_database={};
39 my $resolver=Net::DNS::Resolver->new;
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 $dnsresult= $resolver->search($packet->{source_ipaddr});
183 my $dnsname= (defined($dnsresult))?$dnsresult->{answer}[0]->{ptrdname}:$packet->{source_ipaddr};
184 my $ldap_result=&get_host_from_ldap($packet->{source_haddr});
185 if(exists($ldap_result->{dn})) {
186 $hosts_database->{$packet->{source_haddr}}=$ldap_result;
187 $hosts_database->{$packet->{source_haddr}}->{dnsname}= $dnsname;
188 if(!exists($ldap_result->{ipHostNumber})) {
189 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber}=$packet->{source_ipaddr};
190 } else {
191 if(!($ldap_result->{ipHostNumber} eq $packet->{source_ipaddr})) {
192 &main::daemon_log(
193 "Current IP Address ".$packet->{source_ipaddr}.
194 " of host ".$hosts_database->{$packet->{source_haddr}}->{dnsname}.
195 " differs from LDAP (".$ldap_result->{ipHostNumber}.")", 4);
196 }
197 }
198 $hosts_database->{$packet->{source_haddr}}->{dnsname}=$dnsname;
199 &main::daemon_log("Host was found in LDAP as ".$ldap_result->{dn}, 8);
200 } else {
201 $hosts_database->{$packet->{source_haddr}}={
202 macAddress => $packet->{source_haddr},
203 ipHostNumber => $packet->{source_ipaddr},
204 dnsname => $dnsname,
205 cn => (($dnsname =~ /^(\d){1,3}\.(\d){1,3}\.(\d){1,3}\.(\d){1,3}/) ? $dnsname : sprintf "%s", $dnsname =~ /([^\.]+)\./),
206 macVendor => (($lookup_vendor) ? &get_vendor_for_mac($packet->{source_haddr}) : "Unknown Vendor"),
207 };
208 &main::daemon_log("Host was not found in LDAP (".($hosts_database->{$packet->{source_haddr}}->{dnsname}).")",6);
209 &main::daemon_log(
210 "New Host ".($hosts_database->{$packet->{source_haddr}}->{dnsname}).
211 ": ".$hosts_database->{$packet->{source_haddr}}->{ipHostNumber}.
212 "/".$hosts_database->{$packet->{source_haddr}}->{macAddress},4);
213 &add_ldap_entry(
214 $main::ldap_handle,
215 $ldap_base,
216 $hosts_database->{$packet->{source_haddr}}->{macAddress},
217 'new-system',
218 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber},
219 'interface',
220 $hosts_database->{$packet->{source_haddr}}->{macVendor});
221 }
222 $hosts_database->{$packet->{source_haddr}}->{device}= $capture_device;
223 } else {
224 if(!($hosts_database->{$packet->{source_haddr}}->{ipHostNumber} eq $packet->{source_ipaddr})) {
225 &main::daemon_log(
226 "IP Address change of MAC ".$packet->{source_haddr}.
227 ": ".$hosts_database->{$packet->{source_haddr}}->{ipHostNumber}.
228 "->".$packet->{source_ipaddr}, 4);
229 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber}= $packet->{source_ipaddr};
230 &change_ldap_entry(
231 $main::ldap_handle,
232 $ldap_base,
233 $hosts_database->{$packet->{source_haddr}}->{macAddress},
234 'ip-changed',
235 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber},
236 );
238 }
239 &main::daemon_log("Host already in cache (".($hosts_database->{$packet->{source_haddr}}->{device})."->".($hosts_database->{$packet->{source_haddr}}->{dnsname}).")",8);
240 }
241 }
243 sub get_host_from_ldap {
244 my $mac=shift;
245 my $result={};
247 if(defined($main::ldap_handle)) {
248 my $ldap_result= &search_ldap_entry(
249 $main::ldap_handle,
250 $ldap_base,
251 "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))"
252 );
254 if(defined($ldap_result) && $ldap_result->count==1) {
255 if(exists($ldap_result->{entries}[0]) &&
256 exists($ldap_result->{entries}[0]->{asn}->{objectName}) &&
257 exists($ldap_result->{entries}[0]->{asn}->{attributes})) {
259 for my $attribute(@{$ldap_result->{entries}[0]->{asn}->{attributes}}) {
260 if($attribute->{type} eq 'cn') {
261 $result->{cn} = $attribute->{vals}[0];
262 }
263 if($attribute->{type} eq 'macAddress') {
264 $result->{macAddress} = $attribute->{vals}[0];
265 }
266 if($attribute->{type} eq 'dhcpHWAddress') {
267 $result->{dhcpHWAddress} = $attribute->{vals}[0];
268 }
269 if($attribute->{type} eq 'ipHostNumber') {
270 $result->{ipHostNumber} = $attribute->{vals}[0];
271 }
272 }
273 }
274 $result->{dn} = $ldap_result->{entries}[0]->{asn}->{objectName};
275 }
276 }
278 return $result;
279 }
281 #=== FUNCTION ================================================================
282 # NAME: get_interfaces
283 # PARAMETERS: none
284 # RETURNS: (list of interfaces)
285 # DESCRIPTION: Uses proc fs (/proc/net/dev) to get list of interfaces.
286 #===============================================================================
287 sub get_interfaces {
288 my @result;
289 my $PROC_NET_DEV= ('/proc/net/dev');
291 open(PROC_NET_DEV, "<$PROC_NET_DEV")
292 or die "Could not open $PROC_NET_DEV";
294 my @ifs = <PROC_NET_DEV>;
296 close(PROC_NET_DEV);
298 # Eat first two line
299 shift @ifs;
300 shift @ifs;
302 chomp @ifs;
303 foreach my $line(@ifs) {
304 my $if= (split /:/, $line)[0];
305 $if =~ s/^\s+//;
306 push @result, $if;
307 }
309 return @result;
310 }
312 #=== FUNCTION ================================================================
313 # NAME: get_mac
314 # PARAMETERS: interface name (i.e. eth0)
315 # RETURNS: (mac address)
316 # DESCRIPTION: Uses ioctl to get mac address directly from system.
317 #===============================================================================
318 sub get_mac {
319 my $ifreq= shift;
320 my $result;
321 if ($ifreq && length($ifreq) > 0) {
322 if($ifreq eq "all") {
323 $result = "00:00:00:00:00:00";
324 } else {
325 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
327 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
328 or die "socket: $!";
330 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
331 my ($if, $mac)= unpack 'h36 H12', $ifreq;
333 if (length($mac) > 0) {
334 $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])$/;
335 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
336 $result = $mac;
337 }
338 }
339 }
340 }
341 return $result;
342 }
344 sub get_vendor_for_mac {
345 my $mac=shift;
346 my $result="Unknown Vendor";
348 if(defined($mac)) {
349 my $vendor= Net::MAC::Vendor::fetch_oui_from_cache(Net::MAC::Vendor::normalize_mac($mac));
350 if(length($vendor) > 0) {
351 $result= @{$vendor}[0];
352 }
353 &main::daemon_log("Looking up Vendor for MAC ".$mac.": $result", 4);
354 }
356 return $result;
357 }
359 #=== FUNCTION ================================================================
360 # NAME: add_ldap_entry
361 # PURPOSE: adds an element to ldap-tree
362 # PARAMETERS:
363 # RETURNS: none
364 # DESCRIPTION: ????
365 # THROWS: no exceptions
366 # COMMENTS: none
367 # SEE ALSO: n/a/bin
368 #===============================================================================
369 sub add_ldap_entry {
370 my ($ldap_tree, $ldap_base, $mac, $gotoSysStatus, $ip, $interface, $desc) = @_;
371 if(defined($ldap_tree)) {
372 my $dn = "cn=".$hosts_database->{$mac}->{cn}.",ou=incoming,$ldap_base";
373 my $s_res = &search_ldap_entry($ldap_tree, $ldap_base, "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))");
374 my $c_res = (defined($s_res))?$s_res->count:0;
375 if($c_res == 1) {
376 &main::daemon_log("WARNING: macAddress $mac already in LDAP", 1);
377 return;
378 } elsif($c_res > 0) {
379 &main::daemon_log("ERROR: macAddress $mac exists $c_res times in LDAP", 1);
380 return;
381 }
383 # create LDAP entry
384 my $entry = Net::LDAP::Entry->new( $dn );
385 $entry->dn($dn);
386 $entry->add("objectClass" => "goHard");
387 $entry->add("cn" => $hosts_database->{$mac}->{cn});
388 $entry->add("macAddress" => $mac);
389 if(defined $gotoSysStatus) {$entry->add("gotoSysStatus" => $gotoSysStatus)}
390 if(defined $ip) {$entry->add("ipHostNumber" => $ip) }
391 #if(defined $interface) { }
392 if(defined $desc) {$entry->add("description" => $desc) }
394 # submit entry to LDAP
395 my $result = $entry->update ($ldap_tree);
397 # for $result->code constants please look at Net::LDAP::Constant
398 if($result->code == 68) { # entry already exists
399 &main::daemon_log("WARNING: $dn ".$result->error, 3);
400 } elsif($result->code == 0) { # everything went fine
401 &main::daemon_log("add entry $dn to ldap", 1);
402 } else { # if any other error occur
403 &main::daemon_log("ERROR: $dn, ".$result->code.", ".$result->error, 1);
404 }
405 } else {
406 &main::daemon_log("Not adding new Entry: LDAP disabled", 6);
407 }
408 return;
409 }
412 #=== FUNCTION ================================================================
413 # NAME: change_ldap_entry
414 # PURPOSE: ????
415 # PARAMETERS: ????
416 # RETURNS: ????
417 # DESCRIPTION: ????
418 # THROWS: no exceptions
419 # COMMENTS: none
420 # SEE ALSO: n/a
421 #===============================================================================
422 sub change_ldap_entry {
423 my ($ldap_tree, $ldap_base, $mac, $gotoSysStatus, $ip) = @_;
425 if(defined($ldap_tree)) {
426 # check if ldap_entry exists or not
427 my $s_res = &search_ldap_entry($ldap_tree, $ldap_base, "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))");
428 my $c_res = (defined $s_res)?$s_res->count:0;
429 if($c_res == 0) {
430 &main::daemon_log("WARNING: macAddress $mac not in LDAP", 1);
431 return;
432 } elsif($c_res > 1) {
433 &main::daemon_log("ERROR: macAddress $mac exists $c_res times in LDAP", 1);
434 return;
435 }
437 my $s_res_entry = $s_res->pop_entry();
438 my $dn = $s_res_entry->dn();
439 my $replace = {
440 'gotoSysStatus' => $gotoSysStatus,
441 };
442 if (defined($ip)) {
443 $replace->{'ipHostNumber'} = $ip;
444 }
445 my $result = $main::ldap_handle->modify( $dn, replace => $replace );
447 # for $result->code constants please look at Net::LDAP::Constant
448 if($result->code == 32) { # entry doesnt exists
449 &add_ldap_entry($mac, $gotoSysStatus);
450 } elsif($result->code == 0) { # everything went fine
451 &main::daemon_log("entry $dn changed successful", 1);
452 } else { # if any other error occur
453 &main::daemon_log("ERROR: $dn, ".$result->code.", ".$result->error, 1);
454 }
455 } else {
456 &main::daemon_log("Not changing Entry: LDAP disabled", 6);
457 }
459 return;
460 }
462 #=== FUNCTION ================================================================
463 # NAME: search_ldap_entry
464 # PURPOSE: ????
465 # PARAMETERS: [Net::LDAP] $ldap_tree - object of an ldap-tree
466 # string $sub_tree - dn of the subtree the search is performed
467 # string $search_string - either a string or a Net::LDAP::Filter object
468 # RETURNS: [Net::LDAP::Search] $msg - result object of the performed search
469 # DESCRIPTION: ????
470 # THROWS: no exceptions
471 # COMMENTS: none
472 # SEE ALSO: n/a
473 #===============================================================================
474 sub search_ldap_entry {
475 my ($ldap_tree, $sub_tree, $search_string) = @_;
476 my $msg;
477 if(defined($ldap_tree)) {
478 $msg = $ldap_tree->search( # perform a search
479 base => $sub_tree,
480 filter => $search_string,
481 ) or &main::daemon_log("cannot perform search at ldap: $@", 1);
482 }
483 return $msg;
484 }
486 1;