From 09df26f453b88aafaddf53c08c740d32e1342336 Mon Sep 17 00:00:00 2001
From: Niko Tyni <ntyni@iki.fi>
Date: Wed, 16 Feb 2005 20:18:48 +0000
Subject: * announce smokeping version at startup * add matcher list to
 smokeping_config * make matcher names start with a capital letter * make
 probe names start with a capital letter * small doc updates * one more
 pod2html makefile fix

---
 lib/Smokeping/probes/TelnetIOSPing.pm | 283 ++++++++++++++++++++++++++++++++++
 1 file changed, 283 insertions(+)
 create mode 100644 lib/Smokeping/probes/TelnetIOSPing.pm

(limited to 'lib/Smokeping/probes/TelnetIOSPing.pm')

diff --git a/lib/Smokeping/probes/TelnetIOSPing.pm b/lib/Smokeping/probes/TelnetIOSPing.pm
new file mode 100644
index 0000000..5f68877
--- /dev/null
+++ b/lib/Smokeping/probes/TelnetIOSPing.pm
@@ -0,0 +1,283 @@
+package Smokeping::probes::TelnetIOSPing;
+
+=head1 301 Moved Permanently
+
+This is a Smokeping probe module. Please use the command 
+
+C<smokeping -man Smokeping::probes::TelnetIOSPing>
+
+to view the documentation or the command
+
+C<smokeping -makepod Smokeping::probes::TelnetIOSPing>
+
+to generate the POD document.
+
+=cut
+
+use strict;
+
+use base qw(Smokeping::probes::basefork);
+use Net::Telnet ();
+use Carp;
+
+my $e = "=";
+sub pod_hash {
+	return {
+		name => <<DOC,
+Smokeping::probes::TelnetIOSPing - Cisco IOS Probe for SmokePing
+DOC
+		description => <<DOC,
+Integrates Cisco IOS as a probe into smokeping.  Uses the telnet protocol 
+to run a ping from an IOS device (source) to another device (host).
+This probe basically uses the "extended ping" of the Cisco IOS.  You have
+the option to specify which interface the ping is sourced from as well.
+DOC
+		notes => <<DOC,
+${e}head2 IOS configuration
+
+The IOS device should have a username/password configured, as well as
+the ability to connect to the VTY(s).
+eg:
+
+    !
+    username smokeping privilege 5 password 0 SmokepingPassword
+    !
+    line vty 0 4
+     login local
+     transport input telnet
+    !
+
+Some IOS devices have a maximum of 5 VTYs available, so be careful not
+to hit a limit with the 'forks' variable.
+
+${e}head2 Requirements
+
+This module requires the Net::Telnet module for perl.  This is usually
+included on most newer OSs which include perl.
+
+${e}head2 Debugging
+
+There is some VERY rudimentary debugging code built into this module (it's
+based on the debugging code written into Net::Telnet).  It will log
+information into three files "TIPreturn", "TIPoutlog", and "TIPdump".
+These files will be written out into your current working directory (CWD).
+You can change the names of these files to something with more meaning to
+you.
+
+${e}head2 Password authentication
+
+You should be advised that the authentication method of telnet uses
+clear text transmissions...meaning that without proper network security
+measures someone could sniff your username and password off the network.
+I may attempt to incorporate SSH in a future version of this module, but
+it is very doubtful.  Right now SSH adds a LOT of processing overhead to
+a router, and isn't incredibly easy to implement in perl.
+
+Having said this, don't be too scared of telnet.  Remember, the
+original IOSPing module used RSH, which is even more scary to use from
+a security perspective.
+
+${e}head2 Ping packet size
+
+The FPing manpage has the following to say on the topic of ping packet
+size:
+
+Number of bytes of ping data to send.  The minimum size (normally 12)
+allows room for the data that fping needs to do its work (sequence
+number, timestamp).  The reported received data size includes the IP
+header (normally 20 bytes) and ICMP header (8 bytes), so the minimum
+total size is 40 bytes.  Default is 56, as in ping. Maximum is the
+theoretical maximum IP datagram size (64K), though most systems limit
+this to a smaller, system-dependent number.
+DOC
+		authors => <<'DOC',
+John A Jackson <geonjay@infoave.net>
+
+based HEAVILY on Smokeping::probes::IOSPing by
+
+Paul J Murphy <paul@murph.org>
+
+based on Smokeping::probes::FPing by
+
+Tobias Oetiker <tobi@oetiker.ch>
+DOC
+	}
+}
+
+sub new($$$)
+{
+    my $proto = shift;
+    my $class = ref($proto) || $proto;
+    my $self = $class->SUPER::new(@_);
+
+    # no need for this if we run as a cgi
+    unless ( $ENV{SERVER_SOFTWARE} ) {
+	$self->{pingfactor} = 1000; # Gives us a good-guess default
+	print "### assuming you are using an IOS reporting in miliseconds\n";
+    };
+
+    return $self;
+}
+
+sub ProbeDesc($){
+    my $self = shift;
+    my $bytes = $self->{properties}{packetsize};
+    return "InfoAve Cisco IOS - ICMP Echo Pings ($bytes Bytes)";
+}
+
+sub pingone ($$){
+    my $self = shift;
+    my $target = shift;
+    my $source = $target->{vars}{source};
+    my $dest = $target->{vars}{host};
+    my $psource = $target->{vars}{psource} || "";
+    my $port = 23;
+    my @output = ();
+    my $login = $target->{vars}{iosuser};
+    my $pssword = $target->{vars}{iospass};
+    my $bytes = $self->{properties}{packetsize};
+    my $pings = $self->pings($target);
+
+    # do NOT call superclass ... the ping method MUST be overwriten
+    my %upd;
+    my @args = ();
+
+
+     my $telnet = new Net::Telnet;
+#               These are for debugging
+#               $telnet->errmode("TIPreturn");
+#               $telnet->input_log("TIPinlog");
+#               $telnet->dump_log("TIPdumplog");
+
+#Open the Connection to the router
+#     open(OUTF,">outfile.IA") || die "Can't open OUTF: $!";
+#     print OUTF "target => $dest\nsource => $source\nuser => $login\n";
+     my $ok = $telnet->open(Host => $source,
+                   Port => $port);
+#    print OUTF "Connection is a $ok\n";
+
+    #Authenticate
+     $telnet->waitfor('/(ogin|name|word):.*$/');
+     $telnet->print("$login");
+     $telnet->waitfor('/word:.*$/');
+     $telnet->print("$pssword");
+    #Do the work
+     $telnet->waitfor('/[\@\w\-\.]+[>#][ ]*$/');
+     $telnet->print("terminal length 0");
+     $telnet->waitfor('/[\@\w\-\.]+[>#][ ]*$/');
+     $telnet->print("ping");
+     $telnet->waitfor('/Protocol \[ip\]: $/');
+     $telnet->print("");
+     $telnet->waitfor('/Target IP address: $/');
+     $telnet->print("$dest");
+     $telnet->waitfor('/Repeat count \[5\]: $/');
+     $telnet->print($pings);
+     $telnet->waitfor('/Datagram size \[100\]: $/');
+     $telnet->print("$bytes");
+     $telnet->waitfor('/Timeout in seconds \[2\]: $/');
+     $telnet->print("");
+     $telnet->waitfor('/Extended commands \[n\]: $/');
+     $telnet->print("y");
+     $telnet->waitfor('/Source address or interface: $/');
+     $telnet->print("$psource");
+     $telnet->waitfor('/Type of service \[0\]: $/');
+     $telnet->print("");
+     $telnet->waitfor('/Set DF bit in IP header\? \[no\]: $/');
+     $telnet->print("");
+     $telnet->waitfor('/Validate reply data\? \[no\]: $/');
+     $telnet->print("");
+     $telnet->waitfor('/Data pattern \[0xABCD\]: $/');
+     $telnet->print("");
+     $telnet->waitfor('/Loose, Strict, Record, Timestamp, Verbose\[none\]: $/');
+     $telnet->print("v");
+     $telnet->waitfor('/Loose, Strict, Record, Timestamp, Verbose\[V\]: $/');
+     $telnet->print("");
+     $telnet->waitfor('/Sweep range of sizes.+$/');
+
+     $telnet->prompt('/[\@\w\-\.]+[>#][ ]*$/');
+     @output = $telnet->cmd("n");
+     
+     #$telnet->waitfor('/[\@\w\-\.]+[>#][ ]*$/');
+     $telnet->print("quit");
+     $telnet->close;
+#     print OUTF "closed Telnet connection\n";
+
+    my @times = ();
+    while (@output) {
+	my $outputline = shift @output;
+	chomp($outputline);
+#	print OUTF "$outputline\n";
+	$outputline =~ /^Reply to request \d+ \((\d+) ms\)/ && push(@times,$1);
+	#print OUTF "$outputline => $1\n";
+    }
+    @times = map {sprintf "%.10e", $_ / $self->{pingfactor}} sort {$a <=> $b} @times;
+#    close(OUTF);
+    return @times;
+}
+
+sub probevars {
+	my $class = shift;
+	return $class->_makevars($class->SUPER::probevars, {
+		packetsize => {
+			_doc => <<DOC,
+The (optional) packetsize option lets you configure the packetsize for
+the pings sent.
+DOC
+			_default => 56,
+			_re => '\d+',
+			_sub => sub {
+				my $val = shift;
+				return "ERROR: packetsize must be between 12 and 64000"
+					unless $val >= 12 and $val <= 64000;
+				return undef;
+			},
+		},
+	});
+}
+
+sub targetvars {
+	my $class = shift;
+	return $class->_makevars($class->SUPER::targetvars, {
+		_mandatory => [ 'iosuser', 'iospass', 'source' ],
+		source => {
+			_doc => <<DOC,
+The source option specifies the IOS device to which we telnet.  This
+is an IP address of an IOS Device that you/your server:
+	1)  Have the ability to telnet to
+	2)  Have a valid username and password for
+DOC
+			_example => "192.168.2.1",
+		},
+		psource => {
+			_doc => <<DOC,
+The (optional) psource option specifies an alternate IP address or
+Interface from which you wish to source your pings from.  Routers
+can have many many IP addresses, and interfaces.  When you ping from a
+router you have the ability to choose which interface and/or which IP
+address the ping is sourced from.  Specifying an IP/interface does not 
+necessarily specify the interface from which the ping will leave, but
+will specify which address the packet(s) appear to come from.  If this
+option is left out the IOS Device will source the packet automatically
+based on routing and/or metrics.  If this doesn't make sense to you
+then just leave it out.
+DOC
+			_example => "192.168.2.129",
+		},
+		iosuser => {
+			_doc => <<DOC,
+The iosuser option allows you to specify a username that has ping
+capability on the IOS Device.
+DOC
+			_example => 'user',
+		},
+		iospass => {
+			_doc => <<DOC,
+The iospass option allows you to specify the password for the username
+specified with the option iosuser.
+DOC
+			_example => 'password',
+		},
+	});
+}
+
+1;
-- 
cgit v1.2.3-24-g4f1b