#
# (c) Jan Gehring <jan.gehring@gmail.com>
#
# vim: set ts=2 sw=2 tw=0:
# vim: set expandtab:
package Rex::Interface::Connection::OpenSSH;
use strict;
use warnings;
use Rex::Interface::Connection::Base;
use Net::OpenSSH;
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
);
Rex::Logger::debug("Using Net::OpenSSH for connection");
$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->{is_sudo} = $is_sudo;
$self->{__auth_info__} = \%option;
Rex::Logger::debug( "Using user: " . $user );
Rex::Logger::debug(
"Using password: " . ( $pass ? "***********" : "<no password>" ) );
$self->{server} = $server;
my $fail_connect = 0;
$port ||= Rex::Config->get_port( server => $server ) || 22;
$timeout ||= Rex::Config->get_timeout( server => $server ) || 3;
$server =
Rex::Config->get_ssh_config_hostname( server => $server ) || $server;
if ( $server =~ m/^(.*?):(\d+)$/ ) {
$server = $1;
$port = $2;
}
Rex::Logger::info( "Connecting to $server:$port (" . $user . ")" );
my %ssh_opts = Rex::Config->get_openssh_opt();
my @ssh_opts_line;
for my $key ( keys %ssh_opts ) {
push @ssh_opts_line, "-o" => $key . "=" . $ssh_opts{$key};
}
my @connection_props = ( $server, user => $user, port => $port );
push @connection_props, master_opts => \@ssh_opts_line if @ssh_opts_line;
push @connection_props, default_ssh_opts => \@ssh_opts_line if @ssh_opts_line;
if ( $auth_type && $auth_type eq "pass" ) {
Rex::Logger::debug("OpenSSH: pass_auth: $server:$port - $user - ******");
push @connection_props, password => $pass;
}
elsif ( $auth_type && $auth_type eq "krb5" ) {
Rex::Logger::debug("OpenSSH: krb5_auth: $server:$port - $user");
# do nothing here
}
else { # for key auth, and others
Rex::Logger::debug(
"OpenSSH: key_auth or not defined: $server:$port - $user");
push @connection_props, key_path => $private_key;
if ($pass) {
push @connection_props, passphrase => $pass;
}
}
$self->{ssh} = Net::OpenSSH->new(@connection_props);
if ( $self->{ssh} && $self->{ssh}->error ) {
Rex::Logger::info(
"Can't connect to $server (" . $self->{ssh}->error() . ")", "warn" );
$self->{connected} = 0;
return;
}
if ( !$self->{ssh} ) {
Rex::Logger::info( "Can't connect to $server", "warn" );
$self->{connected} = 0;
return;
}
Rex::Logger::debug( "Current Error-Code: " . $self->{ssh}->error() );
Rex::Logger::info("Connected and authenticated to $server.");
$self->{connected} = 1;
$self->{auth_ret} = 1;
$self->{sftp} = $self->{ssh}->sftp;
}
sub reconnect {
my ($self) = @_;
Rex::Logger::debug("Reconnecting SSH");
$self->connect( %{ $self->{__auth_info__} } );
}
sub disconnect {
my ($self) = @_;
undef $self->{ssh};
return 1;
}
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) = @_;
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 = "OpenSSH";
if ( $self->{is_sudo} && $self->{is_sudo} == 1 ) {
return "Sudo";
}
if ( Rex::is_ssh() && !Rex::is_sudo() ) {
$type = "OpenSSH";
}
elsif ( Rex::is_sudo() ) {
$type = "Sudo";
}
return $type;
}
1;