Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

OLIVER / App-Netdisco-2.082002 / lib / App / Netdisco / Transport / SSH.pm 

            

              
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

              
package App::Netdisco::Transport::SSH;
use Dancer qw/:syntax :script/;
use App::Netdisco::Util::Device 'get_device';
use Module::Load ();
use Net::OpenSSH;
use Try::Tiny;
use base 'Dancer::Object::Singleton';
=head1 NAME
App::Netdisco::Transport::SSH
=head1 DESCRIPTION
Returns an object which has an active SSH connection which can be used
for some actions such as arpnip.
 my $cli = App::Netdisco::Transport::SSH->session_for( ... );
=cut
__PACKAGE__->attributes(qw/ sessions /);
sub init {
  my ( $class, $self ) = @_;
  $self->sessions( {} );
  return $self;
}
=head1 session_for( $ip )
Given an IP address, returns an object instance configured for and connected
to that device.
Returns C<undef> if the connection fails.
=cut
{
  package MySession;
  use Moo;
  has 'ssh'  => ( is => 'rw' );
  has 'auth' => ( is => 'rw' );
  has 'host' => ( is => 'rw' );
  has 'platform' => ( is => 'rw' );
  sub arpnip {
    my $self = shift;
    $self->platform->arpnip(@_, $self->host, $self->ssh, $self->auth);
  }
  sub macsuck {
    my $self = shift;
    $self->platform->macsuck(@_, $self->host, $self->ssh, $self->auth);
  }
}
sub session_for {
  my ($class, $ip) = @_;
  my $device = get_device($ip) or return undef;
  my $sessions = $class->instance->sessions or return undef;
  return $sessions->{$device->ip} if exists $sessions->{$device->ip};
  debug sprintf 'cli session cache warm: [%s]', $device->ip;
  my $auth = (setting('device_auth') || []);
  if (1 != scalar @$auth) {
    error sprintf " [%s] require only one matching auth stanza", $device->ip;
    return undef;
  }
  $auth = $auth->[0];
  if (!defined $auth->{platform}) {
    error sprintf " [%s] Perl SSH platform not specified, assuming Python", $device->ip;
    return undef;
  }
  my @master_opts = qw(-o BatchMode=no);
  push(@master_opts, @{$auth->{ssh_master_opts}})
    if $auth->{ssh_master_opts};
  $Net::OpenSSH::debug = $ENV{SSH_TRACE};
  my $ssh = Net::OpenSSH->new(
    $device->ip,
    user => $auth->{username},
    password => $auth->{password},
    timeout => 30,
    async => 0,
    default_stderr_file => '/dev/null',
    master_opts => \@master_opts
  );
  if ($ssh->error) {
    error sprintf " [%s] ssh connection error [%s]", $device->ip, $ssh->error;
    return undef;
  }
  elsif (! $ssh) {
    error sprintf " [%s] Net::OpenSSH instantiation error", $device->ip;
    return undef;
  }
  my $platform = "App::Netdisco::SSHCollector::Platform::" . $auth->{platform};
  my $happy = false;
  try {
    Module::Load::load $platform;
    $happy = true;
  } catch { error $_ };
  return unless $happy;
  my $sess = MySession->new(
    ssh  => $ssh,
    auth => $auth,
    host => $device->ip,
    platform => $platform->new(),
  );
  return ($sessions->{$device->ip} = $sess);
}
true;