gosa-si/modules/ArpHandler.pm

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