gosa-si/modules/ArpHandler.pm

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