PHP

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 PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\SFtp;
use Chilkat2\SecureString;
use Chilkat2\SshKey;

// 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.

$sftp = new SFtp();

// Step 1: Connect the SSH transport.  Port 22 is the usual port.
$port = 22;
try {
    $sftp->Connect('sftp.example.com', $port);

    // 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.
    $password = 'mySshPassword';

    // Load the SSH private key.  LoadText reads the file's text, which is then imported.
    $privKey = new SshKey();
    $keyText = $privKey->LoadText('qa_data/id_rsa');

    $privKey->FromOpenSshPrivateKey($keyText);

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

    $sftp->AuthenticateSecPwPk($secureLogin, $securePassword, $privKey);

    // Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
    // file or directory operations.
    $sftp->InitializeSftp();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Authenticated.\n";

$sftp->Disconnect();