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