PHP

SSH Tunnel Uncommon Options

Demonstrates the UncommonOptions property, which enables optional behavior for uncommon requirements. The default is an empty string; provide a comma-separated list of keywords to enable more than one option. Available keywords are listed in the reference documentation.

Background: This is a catch-all for narrow workarounds that do not warrant their own properties — forcing a specific signature algorithm, disabling the periodic keep-alive, removing weak MACs, bypassing a VPN on Android, and so on. Most applications never set it. When you do, it is usually to satisfy a particular server's quirk or a specific security requirement, and the exact keyword matters, so consult the documented list rather than guessing.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\SshTunnel;

// Demonstrates the SshTunnel.UncommonOptions property, which enables optional behavior for
// uncommon requirements.  The default is an empty string, appropriate for most applications.
// Provide a comma-separated list of keywords to enable more than one option.

$tunnel = new SshTunnel();

// For example, disable the periodic keep-alive ignore message and remove weak MAC algorithms
// from those offered.  Available keywords are listed in the reference documentation.
$tunnel->UncommonOptions = 'NoKeepAliveIgnoreMsg,no-weak-mac-algs';

$tunnel->DestHostname = 'db.internal.example.com';
$tunnel->DestPort = 5432;

$sshPort = 22;
try {
    $tunnel->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';

    $tunnel->AuthenticatePw('mySshLogin', $password);

    $listenPort = 1080;
    $tunnel->BeginAccepting($listenPort);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Tunnel established.\n";

$waitForThreadExit = true;
try {
    $tunnel->CloseTunnel($waitForThreadExit);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}