PHP

SSH Authenticate with a SecureString Password and Private Key

Demonstrates the Chilkat Ssh.AuthenticateSecPwPk method, which performs the same combined password/private-key authentication as AuthenticatePwPk but receives the username and password as SecureString objects. 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 multi-factor SSH 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\SecureString;
use Chilkat2\Ssh;
use Chilkat2\SshKey;

// Demonstrates the Ssh.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.

$ssh = new Ssh();

// Connect to the SSH server.  Port 22 is the usual SSH port.
$sshPort = 22;
try {
    $ssh->Connect('ssh.example.com', $sshPort);

    // 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();
    $keyStr = $privKey->LoadText('qa_data/id_rsa');

    $privKey->FromOpenSshPrivateKey($keyStr);

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

    $ssh->AuthenticateSecPwPk($secureLogin, $securePassword, $privKey);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Authenticated.\n";

$ssh->Disconnect();