SFTP

Default Constructor.

Connects to an SFTP server

Set Crypto Engine Mode

Possible $engine values: OpenSSL, mcrypt, Eval, PHP

Send Identification String First

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

Send Identification String Last

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

Send SSH_MSG_KEXINIT First

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

Send SSH_MSG_KEXINIT Last

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

Login

Login Helper

Set Timeout

$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.

Set Keep Alive

Sends an SSH2_MSG_IGNORE message every x seconds, if x is a positive non-zero number.

Get the output from stdError

Execute Command

If $callback is set to false then \phpseclib3\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.

Request agent forwarding of remote server

Returns the output of an interactive shell

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.

Inputs a command into an interactive shell.

Start a subsystem.

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.

Stops a subsystem.

Closes a channel

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

Is timeout?

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

Disconnect

Destructor.

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

Is the connection still active?

Have you successfully been logged in?

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

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

Resets a connection for re-use

Enable Quiet Mode

Suppress stderr from output

Disable Quiet Mode

Show stderr in output

Returns whether Quiet Mode is enabled or not

Enable request-pty when using exec()

Disable request-pty when using exec()

Returns whether request-pty is enabled or not

Gets channel data

Returns the data as a string. bool(true) is returned if:

• the server closes the channel
• if the connection times out
• if the channel status is CHANNEL_OPEN and the response was CHANNEL_OPEN_CONFIRMATION
• if the channel status is CHANNEL_REQUEST and the response was CHANNEL_SUCCESS

bool(false) is returned if:

• if the channel status is CHANNEL_REQUEST and the response was CHANNEL_FAILURE

Sends Binary Packets

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

Sends channel data

Spans multiple SSH_MSG_CHANNEL_DATAs if appropriate

Disconnect

Define Array

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.

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

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')

Formats a log for printing

Returns all errors

Returns the last error

Return the server identification.

Returns a list of algorithms the server supports

Returns a list of KEX algorithms that phpseclib supports

Returns a list of host key algorithms that phpseclib supports

Returns a list of symmetric key algorithms that phpseclib supports

Returns a list of MAC algorithms that phpseclib supports

Returns a list of compression algorithms that phpseclib supports

Return list of negotiated algorithms

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

Allows you to set the terminal

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

Returns the banner message.

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

Returns the server public host key.

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.

Returns the exit status of an SSH command or false.

Returns the number of columns for the terminal window size.

Returns the number of rows for the terminal window size.

Sets the number of columns for the terminal window size.

Sets the number of rows for the terminal window size.

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

To String Magic Method

Get Resource ID

We use } because that symbols should not be in URL according to {@link http://tools.ietf.org/html/rfc3986#section-2 RFC}. It will safe us from any conflicts, because otherwise regexp will match all alphanumeric domains.

Return existing connection

Return all excising connections

Return the list of authentication methods that may productively continue authentication.

Disable the stat cache

Enable the stat cache

Clear the stat cache

Enable path canonicalization

Enable path canonicalization

Returns the current directory name

Canonicalize the Server-Side Path Name

SFTP doesn't provide a mechanism by which the current working directory can be changed, so we'll emulate it. Returns the absolute (canonicalized) path.

If canonicalize_paths has been disabled using disablePathCanonicalization(), $path is returned as-is.

Changes the current directory

Returns a list of files in the given directory

Returns a detailed list of files in the given directory

Defines how nlist() and rawlist() will be sorted - if at all.

If sorting is enabled directories and files will be sorted independently with directories appearing before files in the resultant array that is returned.

Any parameter returned by stat is a valid sort parameter for this function. Filename comparisons are case insensitive.

Examples:

$sftp->setListOrder('filename', SORT_ASC); $sftp->setListOrder('size', SORT_DESC, 'filename', SORT_ASC); $sftp->setListOrder(true); Separates directories from files but doesn't do any sorting beyond that $sftp->setListOrder(); Don't do any sort of sorting

Returns general information about a file.

Returns an array on success and false otherwise.

Returns general information about a file or symbolic link.

Returns an array on success and false otherwise.

Truncates a file to a given length

Sets access and modification time of file.

If the file does not exist, it will be created.

Changes file or directory owner

Returns true on success or false on error.

Changes file or directory group

Returns true on success or false on error.

Set permissions on a file.

Returns the new file permissions on success or false on error. If $recursive is true than this just returns true or false.

Return the target of a symbolic link

Create a symlink

symlink() creates a symbolic link to the existing target with the specified name link.

Creates a directory.

Removes a directory.

Uploads a file to the SFTP server.

By default, \phpseclib3\Net\SFTP::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 \phpseclib3\Net\SFTP::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.

Setting $mode to self::SOURCE_CALLBACK will use $data as callback function, which gets only one parameter -- number of bytes to return, and returns a string if there is some data or null if there is no more data

If $data is a resource then it'll be used as a resource instead.

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.

$mode can take an additional two parameters - self::RESUME and self::RESUME_START. These are bitwise AND'd with $mode. So if you want to resume upload of a 300mb file on the local file system you'd set $mode to the following:

self::SOURCE_LOCAL_FILE | self::RESUME

If you wanted to simply append the full contents of a local file to the full contents of a remote file you'd replace self::RESUME with self::RESUME_START.

If $mode & (self::RESUME | self::RESUME_START) then self::RESUME_START will be assumed.

$start and $local_start give you more fine grained control over this process and take precident over self::RESUME when they're non-negative. ie. $start could let you write at the end of a file (like self::RESUME) or in the middle of one. $local_start could let you start your reading from the end of a file (like self::RESUME_START) or in the middle of one.

Setting $local_start to > 0 or $mode | self::RESUME_START doesn't do anything unless $mode | self::SOURCE_LOCAL_FILE.

{@internal ASCII mode for SFTPv4/5/6 can be supported by adding a new function - \phpseclib3\Net\SFTP::setMode().}

Downloads a file from the SFTP 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.

$offset and $length can be used to download files in chunks.

Deletes a file on the SFTP server.

Checks whether a file or directory exists

Tells whether the filename is a directory

Tells whether the filename is a regular file

Tells whether the filename is a symbolic link

Tells whether a file exists and is readable

Tells whether the filename is writable

Tells whether the filename is writeable

Alias of is_writable

Gets last access time of file

Gets file modification time

Gets file permissions

Gets file owner

Gets file group

Gets file size

Gets file type

Renames a file or a directory on the SFTP server

Parse Attributes

See '7. File Attributes' of draft-ietf-secsh-filexfer-13 for more info.

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

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

Returns all errors

Returns the last error

Get supported SFTP versions

Enable Date Preservation

Disable Date Preservation