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
|
#
# (c) Jan Gehring <jan.gehring@gmail.com>
#
package Rex::Interface::Connection::SSH;
use v5.12.5;
use warnings;
our $VERSION = '1.14.1'; # VERSION
BEGIN {
use Rex::Require;
Net::SSH2->require;
}
use Carp;
use Rex::Helper::IP;
use Rex::Interface::Connection::Base;
use base qw(Rex::Interface::Connection::Base);
sub new {
my $that = shift;
my $proto = ref($that) || $that;
my $self = $that->SUPER::new(@_);
bless( $self, $proto );
return $self;
}
sub connect {
my ( $self, %option ) = @_;
my (
$user, $pass, $private_key, $public_key, $server,
$port, $timeout, $auth_type, $is_sudo
);
$user = $option{user};
$pass = $option{password};
$server = $option{server};
$port = $option{port};
$timeout = $option{timeout};
$public_key = $option{public_key};
$private_key = $option{private_key};
$auth_type = $option{auth_type};
$is_sudo = $option{sudo};
$self->{server} = $server;
$self->{is_sudo} = $is_sudo;
$self->{__auth_info__} = \%option;
Rex::Logger::debug("Using Net::SSH2 for connection");
Rex::Logger::debug( "Using user: " . $user );
Rex::Logger::debug( Rex::Logger::masq( "Using password: %s", $pass ) )
if defined $pass;
$self->{ssh} = Net::SSH2->new;
my $fail_connect = 0;
CON_SSH:
$port ||= Rex::Config->get_port( server => $server ) || 22;
$timeout ||= Rex::Config->get_timeout( server => $server ) || 3;
$self->{ssh}->timeout( $timeout * 1000 );
$server =
Rex::Config->get_ssh_config_hostname( server => $server ) || $server;
( $server, $port ) = Rex::Helper::IP::get_server_and_port( $server, $port );
Rex::Logger::debug( "Connecting to $server:$port (" . $user . ")" );
unless ( $self->{ssh}->connect( $server, $port ) ) {
++$fail_connect;
sleep 1;
goto CON_SSH
if (
$fail_connect < Rex::Config->get_max_connect_fails( server => $server ) )
; # try connecting 3 times
Rex::Logger::info( "Can't connect to $server", "warn" );
$self->{connected} = 0;
return;
}
Rex::Logger::debug( "Current Error-Code: " . $self->{ssh}->error() );
Rex::Logger::debug("Connected to $server, trying to authenticate.");
$self->{connected} = 1;
if ( $auth_type && $auth_type eq "pass" ) {
Rex::Logger::debug("Using password authentication.");
$self->{auth_ret} = $self->{ssh}->auth_password( $user, $pass );
if ( !$self->{auth_ret} ) {
# try guessing
$self->{auth_ret} = $self->{ssh}->auth(
'username' => $user,
'password' => $pass
);
}
}
elsif ( $auth_type && $auth_type eq "key" ) {
Rex::Logger::debug("Using key authentication.");
croak "No public_key file defined." if !$public_key;
croak "No private_key file defined." if !$private_key;
$self->{auth_ret} =
$self->{ssh}->auth_publickey( $user, $public_key, $private_key, $pass );
}
else {
Rex::Logger::debug("Trying to guess the authentication method.");
$self->{auth_ret} = $self->{ssh}->auth(
'username' => $user,
'password' => $pass,
'publickey' => $public_key || "",
'privatekey' => $private_key || ""
);
}
$self->{sftp} = $self->{ssh}->sftp;
}
sub reconnect {
my ($self) = @_;
Rex::Logger::debug("Reconnecting SSH");
$self->connect( %{ $self->{__auth_info__} } );
}
sub disconnect {
my ($self) = @_;
$self->get_connection_object->disconnect;
}
sub error {
my ($self) = @_;
return $self->get_connection_object->error;
}
sub get_connection_object {
my ($self) = @_;
return $self->{ssh};
}
sub get_fs_connection_object {
my ($self) = @_;
if ( !defined $self->{sftp} ) {
Rex::Logger::info(
"It seems that you haven't installed or configured sftp on your server.",
"warn"
);
Rex::Logger::info(
"Rex needs sftp for file operations, so please install one.", "warn" );
die("No SFTP server found on remote host.");
}
return $self->{sftp};
}
sub is_connected {
my ($self) = @_;
return $self->{connected};
}
sub is_authenticated {
my ($self) = @_;
return $self->{auth_ret};
}
sub get_connection_type {
my ($self) = @_;
my $type = "SSH";
if ( $self->{is_sudo} && $self->{is_sudo} == 1 ) {
return "Sudo";
}
if ( Rex::is_ssh() && !Rex::is_sudo() ) {
$type = "SSH";
}
elsif ( Rex::is_sudo() ) {
$type = "Sudo";
}
return $type;
}
1;
|
