Perl

SFTP Authenticate with a SecureString Password and Private Key

Demonstrates the Chilkat SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login and password objects together with a private key. The third argument is the SshKey private key.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

Background: This is the SecureString form of two-factor SFTP authentication: the password is held encrypted in memory and combined with a private key for servers that require both. It is the most protective option when a deployment mandates two-factor SSH and you also want to minimize plaintext credential exposure in the process.

Chilkat Perl Downloads

Download Chilkat for Perl

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# Demonstrates the SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login
# and password objects together with a private key.  The 1st argument is the username, the 2nd
# is the password, and the 3rd is an SshKey private key.

my $sftp = Chilkat2::SFtp->new;

# Step 1: Connect the SSH transport.  Port 22 is the usual port.
my $port = 22;
my $success = $sftp->Connect('sftp.example.com', $port);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Normally you would not hard-code the password in source.  You should instead obtain it
# from an interactive prompt, environment variable, or a secrets vault.
my $password = 'mySshPassword';

# Load the SSH private key.  LoadText reads the file's text, which is then imported.
my $privKey = Chilkat2::SshKey->new;
my $keyText = $privKey->LoadText('qa_data/id_rsa');
if (!$privKey->LastMethodSuccess) {
    print $privKey->LastErrorText, "\n";
    exit;
}

$success = $privKey->FromOpenSshPrivateKey($keyText);
if (!$success) {
    print $privKey->LastErrorText, "\n";
    exit;
}

# Place the login and password into SecureString objects.
my $secureLogin = Chilkat2::SecureString->new;
$secureLogin->Append('mySshLogin');
my $securePassword = Chilkat2::SecureString->new;
$securePassword->Append($password);

$success = $sftp->AuthenticateSecPwPk($secureLogin, $securePassword, $privKey);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
# file or directory operations.
$success = $sftp->InitializeSftp();
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

print "Authenticated.\n";

$sftp->Disconnect();