PHP

Set an Environment Variable on an SSH Channel

Demonstrates the Chilkat Ssh.SendReqSetEnv method, which asks the server to set an environment variable for a session channel. The arguments are the channel number, the variable name, and its value. Send these requests before the exec, shell, or subsystem request.

Background: This is the clean way to pass configuration to a remote command without embedding it in the command line. Be aware that many SSH servers restrict which variables clients may set (OpenSSH's AcceptEnv), so a request can be silently ignored or rejected — do not rely on it without verifying the server's policy.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Ssh;

// Demonstrates the Ssh.SendReqSetEnv method, which asks the server to set an environment
// variable for a session channel.  The 1st argument is the channel number, the 2nd is the
// variable name, and the 3rd is its value.  Send it before the exec, shell, or subsystem
// request.

$ssh = new Ssh();

$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';

    $ssh->AuthenticatePw('mySshLogin', $password);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Open a session channel.  A negative return value indicates failure.
$channelNum = $ssh->OpenSessionChannel();
if ($channelNum < 0) {
    echo $ssh->LastErrorText, "\n";
    exit;
}

// Set environment variables for the channel.  Multiple variables may be requested.
try {
    $ssh->SendReqSetEnv($channelNum, 'LANG', 'en_US.UTF-8');

    $ssh->SendReqSetEnv($channelNum, 'MY_APP_MODE', 'production');

    // Now run the command, which sees the requested environment.
    $ssh->SendReqExec($channelNum, 'echo $MY_APP_MODE');

    // IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
    // it, this call waits forever if the server never sends channel close.
    $ssh->ReadTimeoutMs = 15000;

    $ssh->ChannelReceiveToClose($channelNum);

    $output = $ssh->GetReceivedText($channelNum, 'utf-8');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo $output, "\n";

$ssh->Disconnect();