7f7ad2297d9f895919b781adfb000248974f69ce
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;
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, $arp_update, $ldap_uri, $ldap_base, $ldap_admin_dn, $ldap_admin_password);
38 my $hosts_database={};
39 my $ldap;
41 my %cfg_defaults =
42 (
43 "ArpHandler" => {
44 "enabled" => [\$arp_enabled, "true"],
45 "interface" => [\$arp_interface, "all"],
46 "update-entries" => [\$arp_update, "false"],
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 local_read_configfile {
63 my $cfg;
64 if( defined( $main::cfg_file) && ( (-s $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, undef);
84 &local_read_configfile();
85 # Don't start if some of the modules are missing
86 if(($arp_enabled eq 'true') && $start_service) {
87 if($lookup_vendor) {
88 eval("Net::MAC::Vendor::load_cache('file:///usr/lib/gosa-si/modules/oui.txt')");
89 if($@) {
90 &main::daemon_log("Loading OUI cache file failed! MAC Vendor lookup disabled", 1);
91 $lookup_vendor=0;
92 } else {
93 &main::daemon_log("Loading OUI cache file suceeded!", 6);
94 }
95 }
97 # When interface is not configured (or 'all'), start arpwatch on all possible interfaces
98 if ((!defined($arp_interface)) || $arp_interface eq 'all') {
99 foreach my $device(&get_interfaces) {
100 # TODO: Need a better workaround for IPv4-to-IPv6 bridges
101 if($device =~ m/^sit\d+$/) {
102 next;
103 }
105 # If device has a valid mac address
106 # TODO: Check if this should be the right way
107 if(not(&get_mac($device) eq "00:00:00:00:00:00")) {
108 &main::daemon_log("Starting ArpWatch on $device", 1);
109 POE::Session->create(
110 inline_states => {
111 _start => sub {
112 &start(@_,$device);
113 },
114 _stop => sub {
115 $_[KERNEL]->post( sprintf("arp_watch_$device") => 'shutdown' )
116 },
117 got_packet => \&got_packet,
118 },
119 );
120 }
121 }
122 } else {
123 foreach my $device(split(/[\s,]+/, $arp_interface)) {
124 &main::daemon_log("Starting ArpWatch on $device", 1);
125 POE::Session->create(
126 inline_states => {
127 _start => sub {
128 &start(@_,$device);
129 },
130 _stop => sub {
131 $_[KERNEL]->post( sprintf("arp_watch_$device") => 'shutdown' )
132 },
133 got_packet => \&got_packet,
134 },
135 );
136 }
137 }
138 } else {
139 &main::daemon_log("ArpHandler disabled. Not starting any capture processes");
140 }
141 return \@info;
142 }
144 sub process_incoming_msg {
145 return 1;
146 }
148 sub start {
149 my $device = (exists($_[ARG0])?$_[ARG0]:'eth0');
150 POE::Component::ArpWatch->spawn(
151 Alias => sprintf("arp_watch_$device"),
152 Device => $device,
153 Dispatch => 'got_packet',
154 Session => $_[SESSION],
155 );
157 $_[KERNEL]->post( sprintf("arp_watch_$device") => 'run' );
158 }
160 sub got_packet {
161 my ($kernel, $heap, $sender, $packet) = @_[KERNEL, HEAP, SENDER, ARG0];
163 if( $packet->{source_haddr} eq "00:00:00:00:00:00" ||
164 $packet->{source_haddr} eq "ff:ff:ff:ff:ff:ff" ||
165 $packet->{source_ipaddr} eq "0.0.0.0") {
166 return;
167 }
169 my $capture_device = sprintf "%s", $kernel->alias_list($sender) =~ /^arp_watch_(.*)$/;
171 my $ldap_handle = &main::get_ldap_handle();
172 if(!exists($hosts_database->{$packet->{source_haddr}})) {
173 my $dnsname= gethostbyaddr(inet_aton($packet->{source_ipaddr}), AF_INET) || $packet->{source_ipaddr};
174 my $ldap_result=&get_host_from_ldap($packet->{source_haddr});
175 if(exists($ldap_result->{dn}) and $arp_update eq "true") {
176 $hosts_database->{$packet->{source_haddr}}=$ldap_result;
177 $hosts_database->{$packet->{source_haddr}}->{dnsname}= $dnsname;
178 if(!exists($ldap_result->{ipHostNumber})) {
179 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber}=$packet->{source_ipaddr};
180 } else {
181 if(!($ldap_result->{ipHostNumber} eq $packet->{source_ipaddr})) {
182 &main::daemon_log(
183 "Current IP Address ".$packet->{source_ipaddr}.
184 " of host ".$hosts_database->{$packet->{source_haddr}}->{dnsname}.
185 " differs from LDAP (".$ldap_result->{ipHostNumber}.")", 4);
186 }
187 }
188 $hosts_database->{$packet->{source_haddr}}->{dnsname}=$dnsname;
189 &main::daemon_log("Host was found in LDAP as ".$ldap_result->{dn}, 8);
190 } else {
191 $hosts_database->{$packet->{source_haddr}}={
192 macAddress => $packet->{source_haddr},
193 ipHostNumber => $packet->{source_ipaddr},
194 dnsname => $dnsname,
195 cn => (($dnsname =~ /^(\d){1,3}\.(\d){1,3}\.(\d){1,3}\.(\d){1,3}/) ? $dnsname : sprintf "%s", $dnsname =~ /([^\.]+)\./),
196 macVendor => (($lookup_vendor) ? &get_vendor_for_mac($packet->{source_haddr}) : "Unknown Vendor"),
197 };
198 &main::daemon_log("A DEBUG: Host was not found in LDAP (".($hosts_database->{$packet->{source_haddr}}->{dnsname}).")",522);
199 &main::daemon_log(
200 "A INFO: New Host ".($hosts_database->{$packet->{source_haddr}}->{dnsname}).
201 ": ".$hosts_database->{$packet->{source_haddr}}->{ipHostNumber}.
202 "/".$hosts_database->{$packet->{source_haddr}}->{macAddress},5);
203 &add_ldap_entry(
204 $ldap_handle,
205 $ldap_base,
206 $hosts_database->{$packet->{source_haddr}}->{macAddress},
207 'new-system',
208 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber},
209 'interface',
210 $hosts_database->{$packet->{source_haddr}}->{macVendor});
211 }
212 $hosts_database->{$packet->{source_haddr}}->{device}= $capture_device;
213 } else {
214 if(($arp_update eq "true") and !($hosts_database->{$packet->{source_haddr}}->{ipHostNumber} eq $packet->{source_ipaddr})) {
215 &main::daemon_log(
216 "A INFO: IP Address change of MAC ".$packet->{source_haddr}.
217 ": ".$hosts_database->{$packet->{source_haddr}}->{ipHostNumber}.
218 "->".$packet->{source_ipaddr}, 5);
219 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber}= $packet->{source_ipaddr};
220 &change_ldap_entry(
221 $ldap_handle,
222 $ldap_base,
223 $hosts_database->{$packet->{source_haddr}}->{macAddress},
224 'ip-changed',
225 $hosts_database->{$packet->{source_haddr}}->{ipHostNumber},
226 );
228 }
229 &main::daemon_log("Host already in cache (".($hosts_database->{$packet->{source_haddr}}->{device})."->".($hosts_database->{$packet->{source_haddr}}->{dnsname}).")",8);
230 }
231 }
233 sub get_host_from_ldap {
234 my $mac=shift;
235 my $result={};
237 my $ldap_handle = &main::get_ldap_handle();
238 if(defined($ldap_handle)) {
239 my $ldap_result= &search_ldap_entry(
240 $ldap_handle,
241 $ldap_base,
242 "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))"
243 );
245 if(defined($ldap_result) && $ldap_result->count==1) {
246 if(exists($ldap_result->{entries}[0]) &&
247 exists($ldap_result->{entries}[0]->{asn}->{objectName}) &&
248 exists($ldap_result->{entries}[0]->{asn}->{attributes})) {
250 for my $attribute(@{$ldap_result->{entries}[0]->{asn}->{attributes}}) {
251 if($attribute->{type} eq 'cn') {
252 $result->{cn} = $attribute->{vals}[0];
253 }
254 if($attribute->{type} eq 'macAddress') {
255 $result->{macAddress} = $attribute->{vals}[0];
256 }
257 if($attribute->{type} eq 'dhcpHWAddress') {
258 $result->{dhcpHWAddress} = $attribute->{vals}[0];
259 }
260 if($attribute->{type} eq 'ipHostNumber') {
261 $result->{ipHostNumber} = $attribute->{vals}[0];
262 }
263 }
264 }
265 $result->{dn} = $ldap_result->{entries}[0]->{asn}->{objectName};
266 }
267 }
269 return $result;
270 }
273 #=== FUNCTION ================================================================
274 # NAME: get_mac
275 # PARAMETERS: interface name (i.e. eth0)
276 # RETURNS: (mac address)
277 # DESCRIPTION: Uses ioctl to get mac address directly from system.
278 #===============================================================================
279 sub get_mac {
280 my $ifreq= shift;
281 my $result;
282 if ($ifreq && length($ifreq) > 0) {
283 if($ifreq eq "all") {
284 $result = "00:00:00:00:00:00";
285 } else {
286 my $SIOCGIFHWADDR= 0x8927; # man 2 ioctl_list
288 socket SOCKET, PF_INET, SOCK_DGRAM, getprotobyname('ip')
289 or die "socket: $!";
291 if(ioctl SOCKET, $SIOCGIFHWADDR, $ifreq) {
292 my ($if, $mac)= unpack 'h36 H12', $ifreq;
294 if (length($mac) > 0) {
295 $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])$/;
296 $mac= sprintf("%s:%s:%s:%s:%s:%s", $1, $2, $3, $4, $5, $6);
297 $result = $mac;
298 }
299 }
300 }
301 }
302 return $result;
303 }
305 sub get_vendor_for_mac {
306 my $mac=shift;
307 my $result="Unknown Vendor";
309 if(defined($mac)) {
310 my $vendor= Net::MAC::Vendor::fetch_oui_from_cache(Net::MAC::Vendor::normalize_mac($mac));
311 if(length($vendor) > 0) {
312 $result= @{$vendor}[0];
313 }
314 &main::daemon_log("A INFO: Looking up Vendor for MAC ".$mac.": $result", 5);
315 }
317 return $result;
318 }
320 #=== FUNCTION ================================================================
321 # NAME: add_ldap_entry
322 # PURPOSE: adds an element to ldap-tree
323 # PARAMETERS:
324 # RETURNS: none
325 # DESCRIPTION: ????
326 # THROWS: no exceptions
327 # COMMENTS: none
328 # SEE ALSO: n/a/bin
329 #===============================================================================
330 sub add_ldap_entry {
331 my ($ldap_tree, $ldap_base, $mac, $gotoSysStatus, $ip, $interface, $desc) = @_;
332 if(defined($ldap_tree)) {
333 my $dn = "cn=".$hosts_database->{$mac}->{cn}.",ou=incoming,$ldap_base";
334 my $s_res = &search_ldap_entry($ldap_tree, $ldap_base, "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))");
335 my $c_res = (defined($s_res))?$s_res->count:0;
336 if($c_res == 1) {
337 &main::daemon_log("A WARNING: macAddress $mac already in LDAP", 3);
338 return;
339 } elsif($c_res > 0) {
340 &main::daemon_log("A ERROR: macAddress $mac exists $c_res times in LDAP", 1);
341 return;
342 }
344 # create LDAP entry
345 my $entry = Net::LDAP::Entry->new( $dn );
346 $entry->dn($dn);
347 $entry->add("objectClass" => "GOhard");
348 $entry->add("cn" => $hosts_database->{$mac}->{cn});
349 $entry->add("macAddress" => $mac);
350 if(defined $gotoSysStatus) {$entry->add("gotoSysStatus" => $gotoSysStatus)}
351 if(defined $ip) {$entry->add("ipHostNumber" => $ip) }
352 #if(defined $interface) { }
353 if(defined $desc) {$entry->add("description" => $desc) }
355 # submit entry to LDAP
356 my $result = $entry->update ($ldap_tree);
358 # for $result->code constants please look at Net::LDAP::Constant
359 if($result->code == 68) { # entry already exists
360 &main::daemon_log("A WARNING: $dn ".$result->error, 3);
361 } elsif($result->code == 0) { # everything went fine
362 &main::daemon_log("add entry $dn to ldap", 1);
363 } else { # if any other error occur
364 &main::daemon_log("A ERROR: $dn, ".$result->code.", ".$result->error, 1);
365 }
366 } else {
367 &main::daemon_log("A Not adding new Entry: LDAP disabled", 6);
368 }
369 return;
370 }
373 #=== FUNCTION ================================================================
374 # NAME: change_ldap_entry
375 # PURPOSE: ????
376 # PARAMETERS: ????
377 # RETURNS: ????
378 # DESCRIPTION: ????
379 # THROWS: no exceptions
380 # COMMENTS: none
381 # SEE ALSO: n/a
382 #===============================================================================
383 sub change_ldap_entry {
384 my ($ldap_tree, $ldap_base, $mac, $gotoSysStatus, $ip) = @_;
386 if(defined($ldap_tree)) {
387 # check if ldap_entry exists or not
388 my $s_res = &search_ldap_entry($ldap_tree, $ldap_base, "(|(macAddress=$mac)(dhcpHWAddress=ethernet $mac))");
389 my $c_res = (defined $s_res)?$s_res->count:0;
390 if($c_res == 0) {
391 &main::daemon_log("WARNING: macAddress $mac not in LDAP", 1);
392 return;
393 } elsif($c_res > 1) {
394 &main::daemon_log("ERROR: macAddress $mac exists $c_res times in LDAP", 1);
395 return;
396 }
398 my $s_res_entry = $s_res->pop_entry();
399 my $dn = $s_res_entry->dn();
400 my $replace = {
401 'gotoSysStatus' => $gotoSysStatus,
402 };
403 if (defined($ip)) {
404 $replace->{'ipHostNumber'} = $ip;
405 }
406 my $result = $ldap_tree->modify( $dn, replace => $replace );
408 # for $result->code constants please look at Net::LDAP::Constant
409 if($result->code == 32) { # entry doesnt exists
410 &add_ldap_entry($mac, $gotoSysStatus);
411 } elsif($result->code == 0) { # everything went fine
412 &main::daemon_log("entry $dn changed successful", 1);
413 } else { # if any other error occur
414 &main::daemon_log("ERROR: $dn, ".$result->code.", ".$result->error, 1);
415 }
416 } else {
417 &main::daemon_log("Not changing Entry: LDAP disabled", 6);
418 }
420 return;
421 }
423 #=== FUNCTION ================================================================
424 # NAME: search_ldap_entry
425 # PURPOSE: ????
426 # PARAMETERS: [Net::LDAP] $ldap_tree - object of an ldap-tree
427 # string $sub_tree - dn of the subtree the search is performed
428 # string $search_string - either a string or a Net::LDAP::Filter object
429 # RETURNS: [Net::LDAP::Search] $msg - result object of the performed search
430 # DESCRIPTION: ????
431 # THROWS: no exceptions
432 # COMMENTS: none
433 # SEE ALSO: n/a
434 #===============================================================================
435 sub search_ldap_entry {
436 my ($ldap_tree, $sub_tree, $search_string) = @_;
437 my $msg;
438 if(defined($ldap_tree)) {
439 $msg = $ldap_tree->search( # perform a search
440 base => $sub_tree,
441 filter => $search_string,
442 ) or &main::daemon_log("cannot perform search at ldap: $@", 1);
443 }
444 return $msg;
445 }
447 # vim:ts=4:shiftwidth:expandtab
448 1;