Documentation

SSH2
in package

SSH2

Pure-PHP implementation of SSHv2.

CHANNEL_AGENT_FORWARD


    public
    mixed
    CHANNEL_AGENT_FORWARD
    = 4

CHANNEL_EXEC


    public
    mixed
    CHANNEL_EXEC
    = 1

CHANNEL_KEEP_ALIVE


    public
    mixed
    CHANNEL_KEEP_ALIVE
    = 5

CHANNEL_SHELL


    public
    mixed
    CHANNEL_SHELL
    = 2

CHANNEL_SUBSYSTEM


    public
    mixed
    CHANNEL_SUBSYSTEM
    = 3

LOG_COMPLEX

Returns the message content


    public
    mixed
    LOG_COMPLEX
    = 2

LOG_MAX_SIZE

Make sure that the log never gets larger than this


    public
    mixed
    LOG_MAX_SIZE
    = 1048576

LOG_REALTIME

Outputs the content real-time


    public
    mixed
    LOG_REALTIME
    = 3

LOG_REALTIME_FILE

Dumps the content real-time to a file


    public
    mixed
    LOG_REALTIME_FILE
    = 4

LOG_SIMPLE

Returns the message numbers


    public
    mixed
    LOG_SIMPLE
    = 1

MASK_CONNECTED


    public
    mixed
    MASK_CONNECTED
    = 0x2

MASK_CONSTRUCTOR


    public
    mixed
    MASK_CONSTRUCTOR
    = 0x1

MASK_LOGIN


    public
    mixed
    MASK_LOGIN
    = 0x8

MASK_LOGIN_REQ


    public
    mixed
    MASK_LOGIN_REQ
    = 0x4

MASK_SHELL


    public
    mixed
    MASK_SHELL
    = 0x10

MASK_WINDOW_ADJUST


    public
    mixed
    MASK_WINDOW_ADJUST
    = 0x20

READ_NEXT

Returns whenever a data packet is received.


    public
    mixed
    READ_NEXT
    = 3

Some data packets may only contain a single character so it may be necessary to call read() multiple times when using this option

READ_REGEX

Returns when a string matching the regular expression $expect is found


    public
    mixed
    READ_REGEX
    = 2

READ_SIMPLE

Returns when a string matching $expect exactly is found


    public
    mixed
    READ_SIMPLE
    = 1

$agent

A System_SSH_Agent for use in the SSH2 Agent Forwarding scenario


    public
        System_SSH_Agent
    $agent

$auth

Authentication Credentials


    public
        array<string|int, mixed>
    $auth
     = array()

$bad_key_size_fix

Some versions of OpenSSH incorrectly calculate the key size


    public
        bool
    $bad_key_size_fix
     = false

$banner_message

Banner Message


    public
        string
    $banner_message
     = ''

Quoting from the RFC, "in some jurisdictions, sending a warning message before authentication may be relevant for getting legal protection."

$binary_packet_buffer

Binary Packet Buffer


    public
        string|false
    $binary_packet_buffer
     = false

$bitmap

Execution Bitmap


    public
        int
    $bitmap
     = 0

The bits that are set represent functions that have been called already. This is used to determine if a requisite function has been successfully executed. If not, an error should be thrown.

$channel_buffers

Channel Buffers


    public
        array<string|int, mixed>
    $channel_buffers
     = array()

If a client requests a packet from one channel but receives two packets from another those packets should be placed in a buffer

$channel_extended_data_type_codes

SSH_MSG_CHANNEL_EXTENDED_DATA's data_type_codes


    public
        array<string|int, mixed>
    $channel_extended_data_type_codes
     = array()

$channel_open_failure_reasons

SSH_MSG_CHANNEL_OPEN_FAILURE 'reason codes', defined in RFC4254


    public
        array<string|int, mixed>
    $channel_open_failure_reasons
     = array()

$channel_status

Channel Status


    public
        array<string|int, mixed>
    $channel_status
     = array()

Contains the type of the last sent message

$compression_algorithms_client_to_server

Compression Algorithms: Client to Server


    public
        array<string|int, mixed>|false
    $compression_algorithms_client_to_server
     = false

$compression_algorithms_server_to_client

Compression Algorithms: Server to Client


    public
        array<string|int, mixed>|false
    $compression_algorithms_server_to_client
     = false

$crypto_engine

Crypto Engine


    public
        int
    $crypto_engine
     = false

$curTimeout

Current Timeout


    public
        mixed
    $curTimeout

$decrypt

Server to Client Encryption Object


    public
        object
    $decrypt
     = false

$decrypt_block_size

Block Size for Client to Server Encryption


    public
        int
    $decrypt_block_size
     = 8

$disconnect_reasons

Disconnection Message 'reason codes' defined in RFC4253


    public
        array<string|int, mixed>
    $disconnect_reasons
     = array()

$encrypt

Client to Server Encryption Object


    public
        object
    $encrypt
     = false

$encrypt_block_size

Block Size for Server to Client Encryption


    public
        int
    $encrypt_block_size
     = 8

"Note that the length of the concatenation of 'packet_length', 'padding_length', 'payload', and 'random padding' MUST be a multiple of the cipher block size or 8, whichever is larger. This constraint MUST be enforced, even when using stream ciphers."

-- http://tools.ietf.org/html/rfc4253#section-6

$encryption_algorithms_client_to_server

Encryption Algorithms: Client to Server


    public
        array<string|int, mixed>|false
    $encryption_algorithms_client_to_server
     = false

$encryption_algorithms_server_to_client

Encryption Algorithms: Server to Client


    public
        array<string|int, mixed>|false
    $encryption_algorithms_server_to_client
     = false

$errors

Error information


    public
        string
    $errors
     = array()

$exchange_hash

Exchange hash


    public
        string
    $exchange_hash
     = false

The current exchange hash

$exit_status

Exit status returned from ssh if any


    public
        int
    $exit_status

$fsock

The Socket Object


    public
        object
    $fsock

$get_seq_no

Get Sequence Number


    public
        int
    $get_seq_no
     = 0

See 'Section 6.4. Data Integrity' of rfc4253 for more info.

$hmac_check

Server to Client HMAC Object


    public
        object
    $hmac_check
     = false

$hmac_create

Client to Server HMAC Object


    public
        object
    $hmac_create
     = false

$hmac_size

Size of server to client HMAC


    public
        int
    $hmac_size
     = false

We need to know how big the HMAC will be for the server to client direction so that we know how many bytes to read. For the client to server side, the HMAC object will make the HMAC as long as it needs to be. All we need to do is append it.

$host

Hostname


    public
        string
    $host

$identifier

The SSH identifier


    public
        string
    $identifier

$in_request_pty_exec

Flag set while exec() is running when using enablePTY()


    public
        bool
    $in_request_pty_exec
     = false

$in_subsystem

Flag set after startSubsystem() is called


    public
        bool
    $in_subsystem

$interactiveBuffer

Interactive Buffer


    public
        array<string|int, mixed>
    $interactiveBuffer
     = ''

$is_timeout

Did read() timeout or return normally?


    public
        bool
    $is_timeout
     = false

$kex_algorithm

Key Exchange Algorithm


    public
        string|false
    $kex_algorithm
     = false

$kex_algorithms

Key Exchange Algorithms


    public
        array<string|int, mixed>|false
    $kex_algorithms
     = false

$kex_dh_group_size_max

Maximum Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods


    public
        int
    $kex_dh_group_size_max
     = 4096

$kex_dh_group_size_min

Minimum Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods


    public
        int
    $kex_dh_group_size_min
     = 1536

$kex_dh_group_size_preferred

Preferred Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods


    public
        int
    $kex_dh_group_size_preferred
     = 2048

$keyboard_requests_responses

Keyboard Interactive Request / Responses


    public
        array<string|int, mixed>
    $keyboard_requests_responses
     = array()

$languages_client_to_server

Languages: Client to Server


    public
        array<string|int, mixed>|false
    $languages_client_to_server
     = false

$languages_server_to_client

Languages: Server to Client


    public
        array<string|int, mixed>|false
    $languages_server_to_client
     = false

$last_interactive_response

The Last Interactive Response


    public
        string
    $last_interactive_response
     = ''

$last_packet

Time of first network activity


    public
        int
    $last_packet

$log_boundary

Log Boundary


    public
        string
    $log_boundary
     = ':'

$log_long_width

Log Long Width


    public
        int
    $log_long_width
     = 65

$log_short_width

Log Short Width


    public
        int
    $log_short_width
     = 16

$log_size

Current log size


    public
        int
    $log_size

Should never exceed self::LOG_MAX_SIZE

$mac_algorithms_client_to_server

MAC Algorithms: Client to Server


    public
        array<string|int, mixed>|false
    $mac_algorithms_client_to_server
     = false

$mac_algorithms_server_to_client

MAC Algorithms: Server to Client


    public
        array<string|int, mixed>|false
    $mac_algorithms_server_to_client
     = false

$message_log

Message Log


    public
        array<string|int, mixed>
    $message_log
     = array()

$message_number_log

Message Number Log


    public
        array<string|int, mixed>
    $message_number_log
     = array()

$message_numbers

Message Numbers


    public
        array<string|int, mixed>
    $message_numbers
     = array()

$packet_size_client_to_server

Packet Size


    public
        array<string|int, mixed>
    $packet_size_client_to_server
     = array()

Maximum packet size indexed by channel

$port

Port Number


    public
        int
    $port

$preferred

Preferred Algorithms


    public
        array<string|int, mixed>
    $preferred
     = array()

$preferred_signature_format

Preferred Signature Format


    public
        string|false
    $preferred_signature_format
     = false

$quiet_mode

Flag to suppress stderr from output


    public
        mixed
    $quiet_mode
     = false

$realtime_log_file

Real-time log file pointer


    public
        resource
    $realtime_log_file

$realtime_log_size

Real-time log file size


    public
        int
    $realtime_log_size

$realtime_log_wrap

Real-time log file wrap boolean


    public
        mixed
    $realtime_log_wrap

$request_pty

Flag to request a PTY when using exec()


    public
        bool
    $request_pty
     = false

$retry_connect

Should we try to re-connect to re-establish keys?


    public
        bool
    $retry_connect
     = false

$send_id_string_first

Send the identification string first?


    public
        bool
    $send_id_string_first
     = true

$send_kex_first

Send the key exchange initiation packet first?


    public
        bool
    $send_kex_first
     = true

$send_seq_no

Send Sequence Number


    public
        int
    $send_seq_no
     = 0

See 'Section 6.4. Data Integrity' of rfc4253 for more info.

$server_channels

Server Channels


    public
        array<string|int, mixed>
    $server_channels
     = array()

Maps client channels to server channels

$server_host_key_algorithms

Server Host Key Algorithms


    public
        array<string|int, mixed>|false
    $server_host_key_algorithms
     = false

$server_identifier

Server Identifier


    public
        array<string|int, mixed>|false
    $server_identifier
     = false

$server_public_host_key

Server Public Host Key


    public
        string
    $server_public_host_key

$session_id

Session identifier


    public
        string
    $session_id
     = false

"The exchange hash H from the first key exchange is additionally used as the session identifier, which is a unique identifier for this connection."

-- http://tools.ietf.org/html/rfc4253#section-7.2

$signature

Server signature


    public
        string
    $signature
     = ''

Verified against $this->session_id

$signature_format

Server signature format


    public
        string
    $signature_format
     = ''

ssh-rsa or ssh-dss.

$signature_validated

Has the signature been validated?


    public
        bool
    $signature_validated
     = false

$stdErrorLog

Contents of stdError


    public
        string
    $stdErrorLog

$terminal_modes

Terminal Modes


    public
        array<string|int, mixed>
    $terminal_modes
     = array()

$timeout

Timeout


    public
        mixed
    $timeout

$window_resize

What we resize the window to


    public
        int
    $window_resize
     = 0x40000000

When PuTTY resizes the window it doesn't add an additional 0x7FFFFFFF bytes - it adds 0x40000000 bytes. Some SFTP clients (GoAnywhere) don't support adding 0x7FFFFFFF to the window size after the fact so we'll just do what PuTTY does

$window_size

The Window Size


    public
        int
    $window_size
     = 0x7fffffff

Bytes the other party can send before it must wait for the window to be adjusted (0x7FFFFFFF = 2GB)

$window_size_client_to_server

Window size, client to server


    public
        array<string|int, mixed>
    $window_size_client_to_server
     = array()

Window size indexed by channel

$window_size_server_to_client

Window size, server to client


    public
        array<string|int, mixed>
    $window_size_server_to_client
     = array()

Window size indexed by channel

$windowColumns

Number of columns for terminal window size


    public
        int
    $windowColumns
     = 80

$windowRows

Number of columns for terminal window size


    public
        int
    $windowRows
     = 24

__construct()

Default Constructor.


    public
                __construct(mixed $host[, int $port = 22 ][, int $timeout = 10 ]) : SSH2

$host can either be a string, representing the host, or a stream resource.

Parameters

$host : mixed
$port : int = 22
$timeout : int = 10

Return values

SSH2 —

__destruct()

Destructor.


    public
                __destruct() : mixed

Will be called, automatically, if you're supporting just PHP5. If you're supporting PHP4, you'll need to call disconnect().

Return values

mixed —

_append_log()

Logs data packets


    public
                _append_log(mixed $message_number, mixed $message) : mixed

Makes sure that only the last 1MB worth of packets will be logged

Parameters

$message_number : mixed
$message : mixed

Return values

mixed —

_array_intersect_first()

Returns the first value of the intersection of two arrays or false if the intersection is empty. The order is defined by the first parameter.


    public
                _array_intersect_first(array<string|int, mixed> $array1, array<string|int, mixed> $array2) : mixed

Parameters

$array1 : array<string|int, mixed>
$array2 : array<string|int, mixed>

Return values

mixed —

False if intersection is empty, else intersected value.

_bad_algorithm_candidate()

Tests whether or not proposed algorithm has a potential for issues


    public
                _bad_algorithm_candidate(string $algorithm) : bool

Parameters

$algorithm : string: Name of the encryption algorithm

Return values

bool —

_close_channel()

Closes and flushes a channel


    public
                _close_channel(int $client_channel[, bool $want_reply = false ]) : bool

\phpseclib\Net\SSH2 doesn't properly close most channels. For exec() channels are normally closed by the server and for SFTP channels are presumably closed when the client disconnects. This functions is intended for SCP more than anything.

Parameters

$client_channel : int
$want_reply : bool = false

Return values

bool —

_connect()

Connect to an SSHv2 server


    public
                _connect() : bool

Return values

bool —

_define_array()

Define Array


    public
                _define_array() : mixed

Takes any number of arrays whose indices are integers and whose values are strings and defines a bunch of named constants from it, using the value as the name of the constant and the index as the value of the constant. If any of the constants that would be defined already exists, none of the constants will be defined.

Return values

mixed —

_disconnect()

Disconnect


    public
                _disconnect(int $reason) : bool

Parameters

$reason : int

Return values

bool —

_encryption_algorithm_to_crypt_instance()

Maps an encryption algorithm name to an instance of a subclass of \phpseclib\Crypt\Base.


    public
                _encryption_algorithm_to_crypt_instance(string $algorithm) : mixed

Parameters

$algorithm : string: Name of the encryption algorithm

Return values

mixed —

Instance of \phpseclib\Crypt\Base or null for unknown

_encryption_algorithm_to_key_size()

Maps an encryption algorithm name to the number of key bytes.


    public
                _encryption_algorithm_to_key_size(string $algorithm) : int|null

Parameters

$algorithm : string: Name of the encryption algorithm

Return values

int|null —

Number of bytes as an integer or null for unknown

_filter()

Filter Binary Packets


    public
                _filter(mixed $payload, mixed $skip_channel_filter) : string

Because some binary packets need to be ignored...

Parameters

$payload : mixed
$skip_channel_filter : mixed

Return values

string —

_format_log()

Formats a log for printing


    public
                _format_log(array<string|int, mixed> $message_log, array<string|int, mixed> $message_number_log) : string

Parameters

$message_log : array<string|int, mixed>
$message_number_log : array<string|int, mixed>

Return values

string —

_format_log_helper()

Helper function for _format_log


    public
                _format_log_helper(array<string|int, mixed> $matches) : string

For use with preg_replace_callback()

Parameters

$matches : array<string|int, mixed>

Return values

string —

_generate_identifier()

Generates the SSH identifier


    public
                _generate_identifier() : string

You should overwrite this method in your own class if you want to use another identifier

Return values

string —

_get_binary_packet()

Gets Binary Packets


    public
                _get_binary_packet([mixed $skip_channel_filter = false ]) : string

See '6. Binary Packet Protocol' of rfc4253 for more info.

Parameters

$skip_channel_filter : mixed = false

Return values

string —

_get_channel_packet()

Gets channel data


    public
                _get_channel_packet( $client_channel[, mixed $skip_extended = false ]) : mixed

Returns the data as a string if it's available and false if not.

Parameters

$client_channel :
$skip_extended : mixed = false

Return values

mixed —

_get_interactive_channel()

Return the channel to be used with read() / write()


    public
                _get_interactive_channel() : int

Return values

int —

_get_open_channel()

Return an available open channel


    public
                _get_open_channel() : int

Return values

int —

_initShell()

Creates an interactive shell


    public
                _initShell() : bool

Return values

bool —

_key_exchange()

Key Exchange


    public
                _key_exchange([string $kexinit_payload_server = false ]) : mixed

Parameters

$kexinit_payload_server : string = false: optional

Return values

mixed —

_keyboard_interactive_login()


    public
                _keyboard_interactive_login(string $username, string $password) : bool

See RFC4256 for details. This is not a full-featured keyboard-interactive authenticator.

Parameters

$username : string
$password : string

Return values

bool —

_keyboard_interactive_process()

Handle the keyboard-interactive requests / responses.


    public
                _keyboard_interactive_process() : bool

Return values

bool —

_login()


    public
                _login(string $username) : bool

Parameters

$username : string

Return values

bool —

_on_channel_open()

Helper function for agent->_on_channel_open()


    public
                _on_channel_open() : mixed

Used when channels are created to inform agent of said channel opening. Must be called after channel open confirmation received

Return values

mixed —

_reconnect()

In situ reconnect method


    public
                _reconnect() : bool

Return values

bool —

_reset_connection()

Resets a connection for re-use


    public
                _reset_connection(int $reason) : mixed

Parameters

$reason : int

Return values

mixed —

_send_binary_packet()

Sends Binary Packets


    public
                _send_binary_packet(string $data[, string $logged = null ]) : bool

See '6. Binary Packet Protocol' of rfc4253 for more info.

Parameters

$data : string
$logged : string = null

Return values

bool —

_send_channel_packet()

Sends channel data


    public
                _send_channel_packet(int $client_channel, string $data) : bool

Spans multiple SSH_MSG_CHANNEL_DATAs if appropriate

Parameters

$client_channel : int
$data : string

Return values

bool —

_ssh_agent_login()


    public
                _ssh_agent_login(string $username, Agent $agent) : bool

Parameters

$username : string
$agent : Agent

Return values

bool —

_string_shift()

String Shift


    public
                _string_shift(string &$string[, int $index = 1 ]) : string

Inspired by array_shift

Parameters

$string : string
$index : int = 1

Return values

string —

_updateLogHistory()

Update packet types in log history


    public
                _updateLogHistory(string $old, string $new) : mixed

Parameters

$old : string
$new : string

Return values

mixed —

disablePTY()

Disable request-pty when using exec()


    public
                disablePTY() : mixed

Return values

mixed —

disableQuietMode()

Disable Quiet Mode


    public
                disableQuietMode() : mixed

Show stderr in output

Return values

mixed —

disconnect()

Disconnect


    public
                disconnect() : mixed

Return values

mixed —

enablePTY()

Enable request-pty when using exec()


    public
                enablePTY() : mixed

Return values

mixed —

enableQuietMode()

Enable Quiet Mode


    public
                enableQuietMode() : mixed

Suppress stderr from output

Return values

mixed —

exec()

Execute Command


    public
                exec(string $command[, callable $callback = null ]) : string

If $callback is set to false then \phpseclib\Net\SSH2::_get_channel_packet(self::CHANNEL_EXEC) will need to be called manually. In all likelihood, this is not a feature you want to be taking advantage of.

Parameters

$command : string
$callback : callable = null

Return values

string —

getAlgorithmsNegotiated()

Return list of negotiated algorithms


    public
                getAlgorithmsNegotiated() : array<string|int, mixed>

Uses the same format as https://www.php.net/ssh2-methods-negotiated

Return values

array<string|int, mixed> —

getBannerMessage()

Returns the banner message.


    public
                getBannerMessage() : string

Quoting from the RFC, "in some jurisdictions, sending a warning message before authentication may be relevant for getting legal protection."

Return values

string —

getCompressionAlgorithmsClient2Server()

Return a list of the compression algorithms the server supports, when receiving stuff from the client.


    public
                getCompressionAlgorithmsClient2Server() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getCompressionAlgorithmsServer2Client()

Return a list of the compression algorithms the server supports, when sending stuff to the client.


    public
                getCompressionAlgorithmsServer2Client() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getEncryptionAlgorithmsClient2Server()

Return a list of the (symmetric key) encryption algorithms the server supports, when receiving stuff from the client.


    public
                getEncryptionAlgorithmsClient2Server() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getEncryptionAlgorithmsServer2Client()

Return a list of the (symmetric key) encryption algorithms the server supports, when sending stuff to the client.


    public
                getEncryptionAlgorithmsServer2Client() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getErrors()

Returns all errors


    public
                getErrors() : array<string|int, string>

Return values

array<string|int, string> —

getExitStatus()

Returns the exit status of an SSH command or false.


    public
                getExitStatus() : false|int

Return values

false|int —

getKexAlgorithms()

Return a list of the key exchange algorithms the server supports.


    public
                getKexAlgorithms() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getLanguagesClient2Server()

Return a list of the languages the server supports, when receiving stuff from the client.


    public
                getLanguagesClient2Server() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getLanguagesServer2Client()

Return a list of the languages the server supports, when sending stuff to the client.


    public
                getLanguagesServer2Client() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getLastError()

Returns the last error


    public
                getLastError() : string

Return values

string —

getLog()

Returns a log of the packets that have been sent and received.


    public
                getLog() : array<string|int, mixed>|false|string

Returns a string if NET_SSH2_LOGGING == self::LOG_COMPLEX, an array if NET_SSH2_LOGGING == self::LOG_SIMPLE and false if !defined('NET_SSH2_LOGGING')

Return values

array<string|int, mixed>|false|string —

getMACAlgorithmsClient2Server()

Return a list of the MAC algorithms the server supports, when receiving stuff from the client.


    public
                getMACAlgorithmsClient2Server() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getMACAlgorithmsServer2Client()

Return a list of the MAC algorithms the server supports, when sending stuff to the client.


    public
                getMACAlgorithmsServer2Client() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getServerAlgorithms()

Returns a list of algorithms the server supports


    public
                getServerAlgorithms() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getServerHostKeyAlgorithms()

Return a list of the host key (public key) algorithms the server supports.


    public
                getServerHostKeyAlgorithms() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getServerIdentification()

Return the server identification.


    public
                getServerIdentification() : string

Return values

string —

getServerPublicHostKey()

Returns the server public host key.


    public
                getServerPublicHostKey() : mixed

Caching this the first time you connect to a server and checking the result on subsequent connections is recommended. Returns false if the server signature is not signed correctly with the public host key.

Return values

mixed —

getStdError()

Get the output from stdError


    public
                getStdError() : mixed

Return values

mixed —

getSupportedCompressionAlgorithms()

Returns a list of compression algorithms that phpseclib supports


    public
                getSupportedCompressionAlgorithms() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getSupportedEncryptionAlgorithms()

Returns a list of symmetric key algorithms that phpseclib supports


    public
                getSupportedEncryptionAlgorithms() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getSupportedHostKeyAlgorithms()

Returns a list of host key algorithms that phpseclib supports


    public
                getSupportedHostKeyAlgorithms() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getSupportedKEXAlgorithms()

Returns a list of KEX algorithms that phpseclib supports


    public
                getSupportedKEXAlgorithms() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getSupportedMACAlgorithms()

Returns a list of MAC algorithms that phpseclib supports


    public
                getSupportedMACAlgorithms() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getWindowColumns()

Returns the number of columns for the terminal window size.


    public
                getWindowColumns() : int

Return values

int —

getWindowRows()

Returns the number of rows for the terminal window size.


    public
                getWindowRows() : int

Return values

int —

isAuthenticated()

Have you successfully been logged in?


    public
                isAuthenticated() : bool

Return values

bool —

isConnected()

Is the connection still active?


    public
                isConnected() : bool

Return values

bool —

isPTYEnabled()

Returns whether request-pty is enabled or not


    public
                isPTYEnabled() : bool

Return values

bool —

isQuietModeEnabled()

Returns whether Quiet Mode is enabled or not


    public
                isQuietModeEnabled() : bool

Return values

bool —

isTimeout()

Is timeout?


    public
                isTimeout() : mixed

Did exec() or read() return because they timed out or because they encountered the end?

Return values

mixed —

login()


    public
                login(string $username) : bool

The $password parameter can be a plaintext password, a \phpseclib\Crypt\RSA object or an array

Parameters

$username : string

Return values

bool —

ping()

Pings a server connection, or tries to reconnect if the connection has gone down


    public
                ping() : bool

Inspired by http://php.net/manual/en/mysqli.ping.php

Return values

bool —

read()

Returns the output of an interactive shell


    public
                read([string $expect = '' ][, int $mode = self::READ_SIMPLE ]) : string|bool

Returns when there's a match for $expect, which can take the form of a string literal or, if $mode == self::READ_REGEX, a regular expression.

Parameters

$expect : string = ''
$mode : int = self::READ_SIMPLE

Return values

string|bool —

reset()

Closes a channel


    public
                reset() : mixed

If read() timed out you might want to just close the channel and have it auto-restart on the next read() call

Return values

mixed —

sendIdentificationStringFirst()

Send Identification String First


    public
                sendIdentificationStringFirst() : mixed

https://tools.ietf.org/html/rfc4253#section-4.2 says "when the connection has been established, both sides MUST send an identification string". It does not say which side sends it first. In theory it shouldn't matter but it is a fact of life that some SSH servers are simply buggy

Return values

mixed —

sendIdentificationStringLast()

Send Identification String Last


    public
                sendIdentificationStringLast() : mixed

Return values

mixed —

sendKEXINITFirst()

Send SSH_MSG_KEXINIT First


    public
                sendKEXINITFirst() : mixed

https://tools.ietf.org/html/rfc4253#section-7.1 says "key exchange begins by each sending sending the [SSH_MSG_KEXINIT] packet". It does not say which side sends it first. In theory it shouldn't matter but it is a fact of life that some SSH servers are simply buggy

Return values

mixed —

sendKEXINITLast()

Send SSH_MSG_KEXINIT Last


    public
                sendKEXINITLast() : mixed

Return values

mixed —

setCryptoEngine()

Set Crypto Engine Mode


    public
                setCryptoEngine(int $engine) : mixed

Possible $engine values: CRYPT_MODE_INTERNAL, CRYPT_MODE_MCRYPT

Parameters

$engine : int

Return values

mixed —

setPreferredAlgorithms()

Accepts an associative array with up to four parameters as described at <https://www.php.net/manual/en/function.ssh2-connect.php>


    public
                setPreferredAlgorithms(array<string|int, mixed> $methods) : mixed

Parameters

$methods : array<string|int, mixed>

Return values

mixed —

setTimeout()

Set Timeout


    public
                setTimeout(mixed $timeout) : mixed

$ssh->exec('ping 127.0.0.1'); on a Linux host will never return and will run indefinitely. setTimeout() makes it so it'll timeout. Setting $timeout to false or 0 will mean there is no timeout.

Parameters

$timeout : mixed

Return values

mixed —

setWindowColumns()

Sets the number of columns for the terminal window size.


    public
                setWindowColumns(int $value) : mixed

Parameters

$value : int

Return values

mixed —

setWindowRows()

Sets the number of rows for the terminal window size.


    public
                setWindowRows(int $value) : mixed

Parameters

$value : int

Return values

mixed —

setWindowSize()

Sets the number of columns and rows for the terminal window size.


    public
                setWindowSize([int $columns = 80 ][, int $rows = 24 ]) : mixed

Parameters

$columns : int = 80
$rows : int = 24

Return values

mixed —

startSubsystem()

Start a subsystem.


    public
                startSubsystem(string $subsystem) : bool

Right now only one subsystem at a time is supported. To support multiple subsystem's stopSubsystem() could accept a string that contained the name of the subsystem, but at that point, only one subsystem of each type could be opened. To support multiple subsystem's of the same name maybe it'd be best if startSubsystem() generated a new channel id and returns that and then that that was passed into stopSubsystem() but that'll be saved for a future date and implemented if there's sufficient demand for such a feature.

Parameters

$subsystem : string

Return values

bool —

stopSubsystem()

Stops a subsystem.


    public
                stopSubsystem() : bool

Return values

bool —

write()

Inputs a command into an interactive shell.


    public
                write(string $cmd) : bool

Parameters

$cmd : string

Return values

bool —