File: hp-search-mac.pl

package info (click to toggle)
hp-search-mac 0.1.4
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 88 kB
  • ctags: 16
  • sloc: perl: 267; makefile: 22
file content (527 lines) | stat: -rwxr-xr-x 15,395 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
#!/usr/bin/perl
# Program:	hp-search-mac
# Version:      0.1.3
# Summary:
#	This program takes a mac address (and some switches to query)
#	and output the physical port address that it belongs to in best
#	match order.
#
# Copyright:
#
#   Copyright (C) 2002-2008 Ola Lundqvist <ola@inguza.com>
#
#  This program is free software; you can redistribute it and/or modify it
#  under the terms of the GNU General Public License as published by the
#  Free Software  Foundation; either version 2, or (at your option) any
#  later version.
#
#  This program is distributed in the hope that it will be useful, but WITHOUT
#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
#  for more details.
#
# You should have received a copy of the GNU General Public License with
# the source package as the file COPYING.  If not, write to the Free
# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
# Notes:
#    Needs the the perl modules: libnet-snmp-perl and opalmod
#    to work properly.
#

###############################################################################
########################## Uses ###############################################
###############################################################################

use OpaL::action qw(pdebug setDebugLevel);
use strict;
use vars qw(%switchMacAddresses
	    %switchMacCount
	    %switches
	    $snmplookedup);
use Net::SNMP;

###############################################################################
########################## Defaults ###########################################
###############################################################################

my $macToPortOid = "17.4.3.1.2";
my $ifDescr = "2.2.1.2";
my $base = ".1.3.6.1.2.1";
%switchMacAddresses = ();
%switchMacCount = ();
$snmplookedup = 0;
my $etcconfigfile = "/etc/hp-search-mac.conf";
my $userconfigfile = "$ENV{HOME}/.hp-search-mac.conf";
%switches = ();

###############################################################################
######################### Configuration #######################################
###############################################################################

if (-e $etcconfigfile) {
  my $t = do $etcconfigfile;
  unless ($t) {
    pdebug(4, "Loading config file $etcconfigfile:\n\t$!\n\t$@");
  }
}

if (-e $userconfigfile) {
  my $t = do $userconfigfile;
  unless ($t) {
    pdebug(4, "Loading config file $userconfigfile:\n\t$!\n\t$@");
  }
}

###############################################################################
########################### HELP ##############################################
###############################################################################

my $help = "
hp-search-mac [options] mac [ [options] mac ] [...]

options:
  --dl n
		Set debug level to n.
  --help
		Print this help.
  --hostname host[=>community] | -h host[=>community]
		Set a switch name to search. You can also set this in
		$etcconfigfile or $userconfigfile
		The hash to set is \%switches.

Mac:
  You can use some different formats:
	ff:ff:ff:ff:ff:ff (hex)
	ff-ff-ff-ff-ff-ff (hex)

        0.123.0.12.0.12.0 (dec)

\%switches:
	This is a normal perl hash of the form
	\%switches = (\"host\" => \"community\", ...);

";

###############################################################################
########################## Arguments ##########################################
###############################################################################

while ($_ = shift @ARGV) {
    my $h = "[0-9a-fA-F]";
    my $dh = "$h$h?";
    my $d = "[0-9]";
    my $dd = "$d$d?$d?";
    if (/^--/) {
	if (/^--help$/) {
	    print($help);
	    exit;
	}
	elsif (/^--dl$/) {
	    setDebugLevel(shift @ARGV);
	}
	elsif (/^--hostname$/) {
		my @split = split /=>/, shift @ARGV;
		my $host = $split[0];
		my $port = $split[1];
		$port = "public" if ("" eq $port);
		$switches{$host} = $port;
	}
    }
    elsif (/^-/) {
	s/^\-//;
        my $t = $_;
        foreach (split //, $t) {
	    if (/h/) {
		my @split = split /=>/, shift @ARGV;
		my $host = $split[0];
		my $port = $split[1];
		$port = "public" if ("" eq $port);
		$switches{$host} = $port;
	    }
	    else {
		pdebug(2, "Unknown argument $_.");
	    }
	}
    }
    elsif (/^$dh:$dh:$dh:$dh:$dh:$dh/) {
	print ("MAC (hex): $_");
	$_ = hexToDec($_);
	s/:/./g;
	print(" (dec): $_\n");
	&searchFor($_);
    }
    elsif (/^$dh-$dh-$dh-$dh-$dh-$dh/) {
	print ("MAC (hex): $_");
	$_ = hexToDec($_);
	s/-/./g;
	print(" (dec): $_\n");
	&searchFor($_);
    }
    elsif (/^$dd.$dd.$dd.$dd.$dd.$dd/) {
	print ("MAC (dec): $_\n");
	&searchFor($_);
    }
    else {
	pdebug(2, "Unknown argument '$_'.");
    }
}

###############################################################################
# Name:		searchPrepare
# Uses:		%switchMacAddresses, %switchMacCount, $snmplookedup
# Needs:	%switches
# Description:	Fetch data from the switches using SNMP.
# Changes:
#	2002-02-26	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub searchPrepare() {
    if (%switches == ()) {
	pdebug(2, "No switches to search. Set it using the --hostname option\n".
	       "or the %switches hash in one of the configuration files.");
    }
    if (! $snmplookedup) {
	%switchMacAddresses = lookupMacOnServers(%switches);
	%switchMacCount = lookupCountOfMac(%switchMacAddresses);
	$snmplookedup = 1;
    }
}

###############################################################################
# Name:		searchFor
# Arguments:	A mac address in decimal form.
# Changes:
#	2002-02-26	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub searchFor($) {
    my ($decMac) = @_;
    &searchPrepare();
    my %matchCount = switchCountForMatching($decMac, %switches);
    my @orderedList = keysForHashSortedByValues(%matchCount);
    print("Search in count order (lowest count => best match):\n");
    foreach my $switch (@orderedList) {
	print("Switch: $switch, ");
	my $port = $switchMacAddresses{$switch}{$decMac};
	my $sport = hpPortNameForDecMac($port, $switch, $switches{$switch});
	print("port: $sport ($port), ");
	print("count: ".$switchMacCount{$switch}{$port});
	print("\n");
    }
}

###############################################################################
# Name:		keysForHashSortedByValues
# Arguments:	a hash
# Returns:	A list of the keys sorted by the value.
# Changes:
#	2002-02-26	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub keysForHashSortedByValues(%) {
    my (%hash) = @_;
    return sort { $hash{$a} <=> $hash{$b} } keys(%hash);
}

###############################################################################
# Name:		switchCountForMatching
# Arguments:	mac address in decimal form
#		switch hash (host => community)
# Returns:	hash with counts of the number of macs for each port matching
#		a specific mac address.
#		switch => count (mr of mac:s found)
# Changes:
#	2002-02-26	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub switchCountForMatching($%) {
    my ($decMac, %switches) = @_;
    my %ret = ();
    foreach my $switch (keys %switches) {
	my $port = ${$switchMacAddresses{$switch}}{$decMac};
	$ret{$switch} =
	    $switchMacCount{$switch}{$port} if (defined $port);
    }
    return %ret;
}

###############################################################################
# Name:		lookupMacOnServers
# Arguments:	switch hash (host => community)
# Returns:	hash with mac to port mapping for each switch
#		switch => mac => port
# Changes:
#	2002-02-26	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub lookupMacOnServers(%) {
    my %switches = @_;
    my %ret = ();
    foreach my $switch (keys %switches) {
	my %temp = hpSnmpToDecMac("$base.$macToPortOid",
				  getTable("$base.$macToPortOid",
					   $switch,
					   $switches{$switch}));
	$ret{$switch} = { %temp }; #{ %temp };
    }
    return %ret;
}

###############################################################################
# Name:		lookupCountOfMac
# Arguments:	switch hash (host => community)
# Returns:	hash with port to count mapping for each switch.
#		switch => port => count
# Changes:
#	2002-02-26	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub lookupCountOfMac(%) {
    my (%switchMacAddresses) = @_;
    my %ret = ();
    foreach my $switch (keys %switchMacAddresses) {
	my %temp = countsOfHashValues(%{$switchMacAddresses{$switch}});
	$ret{$switch} = { %temp };
    }
    return %ret;
}

###############################################################################
# Name:		hpSnmpToDecMac
# Arguments:	A base OID to strip.
#		A hash with the OID from the HP SNMP result as keys.
# Returns:	The same hash but with the OIDs converted (tripped the
#		prepended base) to decimal MAC addresses.
# Changes:
#	2002-02-25	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub hpSnmpToDecMac($%) {
    my ($base, %hash) = @_;
    my %ret = ();
    foreach my $key (keys %hash) {
	my $newkey = $key;
	$newkey =~ s/^$base\.//;
	$ret{$newkey} = $hash{$key};
    }
    return %ret;
}

###############################################################################
# Name:		hpPortNameForDecMac
# Arguments:	port (logical switch port)
#		switch to connect to
#		community to use on that switch
# Returns:	The "physical" name of that logical switch port
#		(ie. description).
# Changes:
#	2002-02-26	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub hpPortNameForDecMac($$$) {
    my ($port, $server, $community) = @_;
    my $ret = get("$base.$ifDescr.$port", $server, $community);
    $ret = $port if ("" eq $ret);
    return $ret;
}

###############################################################################
# Name:		countsOfHashValues
# Argument:	A hash.
# Returns:	A hash with the values of the argument hash as keys
#		and for each time that key is used it values is incresed by
#		one.
# Changes:
#	2002-02-25	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub countsOfHashValues(%) {
    my (%hash) = @_;
    my %ret = ();
    foreach my $key (keys %hash) {
	$ret{$hash{$key}}++;
    }
    return %ret;
}

###############################################################################
# Name:		getSession
# Arguments:	server (switch) and optionally (defult public) community.
# Returns:	A session object that can be used to query the SNMP database.
# Changes:
#	2002-02-25	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
#	2002-09-12	Ola Lundqvist <ola@inguza.com>
#		Now is a bit more verbose when the connection fails.
###############################################################################
sub getSession($;$) {
    my ($server, $community) = @_;
    $community = "public" if ("" eq $community);
    return Net::SNMP->session(-hostname => $server,
			      -community => $community);
}

###############################################################################
# Name:		get
# Arguments:	oid to get value of
#		server to query
#		community (optionally) to use.
# Returns:	the value of that oid, undefined if not found.
# Changes:
#	2002-02-25	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub get($$;$) {
    my ($oid, $server, $community) = @_;
    my ($session, $error) = getSession($server, $community);
    if (!defined($session)) {
	pdebug(2, sprintf("Get session %s", $error));
    }
    my $response = $session->get_request($oid);
    $session->close();	
    if (!defined($response)) {
	return undef;
    }
    return $response->{$oid};
}

###############################################################################
# Name:		getTable
# Arguments:	oid to get all values of
#		server to query
#		community (optionally) to use.
# Returns:	the hash table of that oid, undefined if not found.
#		oid => value
# Changes:
#	2002-02-25	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
#	2002-09-12	Ola Lundqvist <ola@inguza.com>
#		Now is a bit more verbose when the connection fails.
###############################################################################
sub getTable($$;$) {
    my ($baseoid, $server, $community) = @_;
    my ($session, $error) = getSession($server, $community);
    if (!defined($session)) {
	pdebug(2, $error);
    }
    my $ref = $session->get_table($baseoid);
    $session->close();
    if (! defined $ref) {
	pdebug(3,
	       "Can not get table from $server, probably authentication ".
	       "or connection failure.");
	return undef;
    }
    return %$ref;
}

###############################################################################
# Name:		hexToDec
# Argument:	A string.
# Returns:	A string with all things that can be treated as numbers
#		converted to decimal form.
# Example:	00 is converted o 0
#		!banjo is converted to !202njo
# Changes:
#	2002-02-25	Ola Lundqvist <ola@inguza.com>
#		Wrote it.
###############################################################################
sub hexToDec($) {
    my ($arg) = @_;
    my $ret = "";
    my $val;
    undef $val;
    foreach my $tmp (split //, $arg) {
	if ($tmp =~ /[0-9a-fA-F]/) {
	    if ($tmp eq "a" || $tmp eq "A") {
		$tmp = 10;
	    }
	    if ($tmp eq "b" || $tmp eq "B") {
		$tmp = 11;
	    }
	    if ($tmp eq "c" || $tmp eq "C") {
		$tmp = 12;
	    }
	    if ($tmp eq "d" || $tmp eq "D") {
		$tmp = 13;
	    }
	    if ($tmp eq "e" || $tmp eq "E") {
		$tmp = 14;
	    }
	    if ($tmp eq "f" || $tmp eq "F") {
		$tmp = 15;
	    }
	    if (defined $val) {
		$val = $val * 16 + $tmp;
	    }
	    else {
		$val = $tmp;
	    }
	}
	else {
	    $ret .= "$val$tmp";
	    undef $val;
	}
    }
    $ret .= $val;
    return $ret;
}

__END__

=head1 NAME

hp-search-mac  -- HP switch search tool.

=head1 DESCRIPTION

 HP-search-MAC is an util that can query HP switches for their
 connection table. It then allow you to search for a MAC address and tell you
 where it is physically connected (best match first).
 .
 The functionality is similar to traceroute but on Ethernet level and only
 for HP switches.

=head1 USAGE

hp-search-mac [options] [MAC] [...]

=head1 OPTIONS

hp-search-mac [options] mac [ [options] mac ] [...]

options:
  --dl n
		Set debug level to n.
  --help
		Print this help.
  --hostname host[=>community] | -h host[=>community]
		Set a switch name to search. You can also set this in
                /etc/hp-search-mac.conf or ~/.hp-search-mac.conf.
		The hash to set is \%switches.

Mac:
  You can use some different formats:
	ff:ff:ff:ff:ff:ff (hex)
	ff-ff-ff-ff-ff-ff (hex)

        0.123.0.12.0.12.0 (dec)

CONFIGURATION:

\%switches:
	This is a normal perl hash of the form
	\%switches = (\"host\" => \"community\", ...);

=head1 AUTHOR

Ola Lundqvist <ola@inguza.com>

=head1 SEE ALSO

snmp-walk(1)
snmp-get(1)

=cut