phpseclib\Net\SCP Class Reference

Collaboration diagram for phpseclib\Net\SCP:

Public Member Functions
	__construct ($ssh)
	Default Constructor. More...
	put ($remote_file, $data, $mode=self::SOURCE_STRING, $callback=null)
	Uploads a file to the SCP server. More...
	get ($remote_file, $local_file=false)
	Downloads a file from the SCP server. More...
	_send ($data)
	Sends a packet to an SSH server. More...
	_receive ()
	Receives a packet from an SSH server. More...
	_close ()
	Closes the connection to an SSH server. More...

Data Fields
const	SOURCE_LOCAL_FILE = 1
	#+ public More...
const	SOURCE_STRING = 2
	Reads data from a string. More...
const	MODE_SSH1 = 1
	#- More...
const	MODE_SSH2 = 2
	SSH2 is being used. More...
	$ssh
	$packet_size
	$mode

Detailed Description

Definition at line 45 of file SCP.php.

Constructor & Destructor Documentation

__construct()

phpseclib\Net\SCP::__construct

(

$ssh

)

Default Constructor.

Connects to an SSH server

Parameters

string	$host
int	$port
int	$timeout

Returns

public

Definition at line 111 of file SCP.php.

References phpseclib\Net\SCP\$ssh.

    {
        if ($ssh instanceof SSH2) {
            $this->mode = self::MODE_SSH2;
        } elseif ($ssh instanceof SSH1) {
            $this->packet_size = 50000;
            $this->mode = self::MODE_SSH1;
        } else {
            return;
        }

        $this->ssh = $ssh;
    }

Member Function Documentation

_close()

phpseclib\Net\SCP::_close

(

)

Closes the connection to an SSH server.

private

Definition at line 329 of file SCP.php.

References phpseclib\Net\SSH2\CHANNEL_EXEC.

Referenced by phpseclib\Net\SCP\get(), and phpseclib\Net\SCP\put().

    {
        switch ($this->mode) {
            case self::MODE_SSH2:
                $this->ssh->_close_channel(SSH2::CHANNEL_EXEC, true);
                break;
            case self::MODE_SSH1:
                $this->ssh->disconnect();
        }
    }

Here is the caller graph for this function:

_receive()

phpseclib\Net\SCP::_receive

(

)

Receives a packet from an SSH server.

Returns

string private

Definition at line 294 of file SCP.php.

References $response, phpseclib\Net\SSH2\CHANNEL_EXEC, phpseclib\Net\SSH1\RESPONSE_DATA, and phpseclib\Net\SSH1\RESPONSE_TYPE.

Referenced by phpseclib\Net\SCP\get(), and phpseclib\Net\SCP\put().

    {
        switch ($this->mode) {
            case self::MODE_SSH2:
                return $this->ssh->_get_channel_packet(SSH2::CHANNEL_EXEC, true);
            case self::MODE_SSH1:
                if (!$this->ssh->bitmap) {
                    return false;
                }
                while (true) {
                    $response = $this->ssh->_get_binary_packet();
                    switch ($response[SSH1::RESPONSE_TYPE]) {
                        case NET_SSH1_SMSG_STDOUT_DATA:
                            extract(unpack('Nlength', $response[SSH1::RESPONSE_DATA]));
                            return $this->ssh->_string_shift($response[SSH1::RESPONSE_DATA], $length);
                        case NET_SSH1_SMSG_STDERR_DATA:
                            break;
                        case NET_SSH1_SMSG_EXITSTATUS:
                            $this->ssh->_send_binary_packet(chr(NET_SSH1_CMSG_EXIT_CONFIRMATION));
                            fclose($this->ssh->fsock);
                            $this->ssh->bitmap = 0;
                            return false;
                        default:
                            user_error('Unknown packet received', E_USER_NOTICE);
                            return false;
                    }
                }
        }
    }

Here is the caller graph for this function:

_send()

phpseclib\Net\SCP::_send

(

$data

)

Sends a packet to an SSH server.

Parameters

string

$data

private

Definition at line 276 of file SCP.php.

References $data, and phpseclib\Net\SSH2\CHANNEL_EXEC.

Referenced by phpseclib\Net\SCP\get(), and phpseclib\Net\SCP\put().

    {
        switch ($this->mode) {
            case self::MODE_SSH2:
                $this->ssh->_send_channel_packet(SSH2::CHANNEL_EXEC, $data);
                break;
            case self::MODE_SSH1:
                $data = pack('CNa*', NET_SSH1_CMSG_STDIN_DATA, strlen($data), $data);
                $this->ssh->_send_binary_packet($data);
        }
    }

Here is the caller graph for this function:

get()

phpseclib\Net\SCP::get	(		$remote_file,
			$local_file = false
	)

Downloads a file from the SCP server.

Returns a string containing the contents of $remote_file if $local_file is left undefined or a boolean false if the operation was unsuccessful. If $local_file is defined, returns true or false depending on the success of the operation

Parameters

string	$remote_file
string	$local_file

Returns

mixed public

Definition at line 220 of file SCP.php.

References $data, $info, $size, phpseclib\Net\SCP\_close(), phpseclib\Net\SCP\_receive(), and phpseclib\Net\SCP\_send().

    {
        if (!isset($this->ssh)) {
            return false;
        }

        if (!$this->ssh->exec('scp -f ' . escapeshellarg($remote_file), false)) { // -f = from
            return false;
        }

        $this->_send("\0");

        if (!preg_match('#(?<perms>[^ ]+) (?<size>\d+) (?<name>.+)#', rtrim($this->_receive()), $info)) {
            return false;
        }

        $this->_send("\0");

        $size = 0;

        if ($local_file !== false) {
            $fp = @fopen($local_file, 'wb');
            if (!$fp) {
                return false;
            }
        }

        $content = '';
        while ($size < $info['size']) {
            $data = $this->_receive();
            // SCP usually seems to split stuff out into 16k chunks
            $size+= strlen($data);

            if ($local_file === false) {
                $content.= $data;
            } else {
                fputs($fp, $data);
            }
        }

        $this->_close();

        if ($local_file !== false) {
            fclose($fp);
            return true;
        }

        return $content;
    }

Here is the call graph for this function:

put()

phpseclib\Net\SCP::put	(		$remote_file,
			$data,
			$mode = self::SOURCE_STRING,
			$callback = null
	)

Uploads a file to the SCP server.

By default, ::put() does not read from the local filesystem. $data is dumped directly into $remote_file. So, for example, if you set $data to 'filename.ext' and then do get(), you will get a file, twelve bytes long, containing 'filename.ext' as its contents.

Setting $mode to self::SOURCE_LOCAL_FILE will change the above behavior. With self::SOURCE_LOCAL_FILE, $remote_file will contain as many bytes as filename.ext does on your local filesystem. If your filename.ext is 1MB then that is how large $remote_file will be, as well.

Currently, only binary mode is supported. As such, if the line endings need to be adjusted, you will need to take care of that, yourself.

Parameters

string	$remote_file
string	$data
int	$mode
callable	$callback

Returns

bool public

Definition at line 146 of file SCP.php.

References $data, $size, phpseclib\Net\SCP\_close(), phpseclib\Net\SCP\_receive(), phpseclib\Net\SCP\_send(), and phpseclib\Net\SSH2\CHANNEL_EXEC.

    {
        if (!isset($this->ssh)) {
            return false;
        }

        if (!$this->ssh->exec('scp -t ' . escapeshellarg($remote_file), false)) { // -t = to
            return false;
        }

        $temp = $this->_receive();
        if ($temp !== chr(0)) {
            return false;
        }

        if ($this->mode == self::MODE_SSH2) {
            $this->packet_size = $this->ssh->packet_size_client_to_server[SSH2::CHANNEL_EXEC] - 4;
        }

        $remote_file = basename($remote_file);

        if ($mode == self::SOURCE_STRING) {
            $size = strlen($data);
        } else {
            if (!is_file($data)) {
                user_error("$data is not a valid file", E_USER_NOTICE);
                return false;
            }

            $fp = @fopen($data, 'rb');
            if (!$fp) {
                return false;
            }
            $size = filesize($data);
        }

        $this->_send('C0644 ' . $size . ' ' . $remote_file . "\n");

        $temp = $this->_receive();
        if ($temp !== chr(0)) {
            return false;
        }

        $sent = 0;
        while ($sent < $size) {
            $temp = $mode & self::SOURCE_STRING ? substr($data, $sent, $this->packet_size) : fread($fp, $this->packet_size);
            $this->_send($temp);
            $sent+= strlen($temp);

            if (is_callable($callback)) {
                call_user_func($callback, $sent);
            }
        }
        $this->_close();

        if ($mode != self::SOURCE_STRING) {
            fclose($fp);
        }

        return true;
    }

Here is the call graph for this function:

Field Documentation

$mode

phpseclib\Net\SCP::$mode

Definition at line 98 of file SCP.php.

$packet_size

phpseclib\Net\SCP::$packet_size

Definition at line 90 of file SCP.php.

$ssh

phpseclib\Net\SCP::$ssh

Definition at line 82 of file SCP.php.

Referenced by phpseclib\Net\SCP\__construct().

MODE_SSH1

const phpseclib\Net\SCP::MODE_SSH1 = 1

#-

#+ private

See also

::_send()

::_receive() SSH1 is being used.

Definition at line 69 of file SCP.php.

MODE_SSH2

const phpseclib\Net\SCP::MODE_SSH2 = 2

SSH2 is being used.

Definition at line 73 of file SCP.php.

SOURCE_LOCAL_FILE

const phpseclib\Net\SCP::SOURCE_LOCAL_FILE = 1

#+ public

See also

::put() Reads data from a local file.

Definition at line 54 of file SCP.php.

SOURCE_STRING

const phpseclib\Net\SCP::SOURCE_STRING = 2

Reads data from a string.

Definition at line 58 of file SCP.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpseclib/phpseclib/phpseclib/Net/SCP.php