SFTP

Default Constructor.

Connects to an SFTP server

Set Crypto Engine Mode

Possible $engine values: CRYPT_MODE_INTERNAL, CRYPT_MODE_MCRYPT

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

Connect to an SSHv2 server

Generates the SSH identifier

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

Key Exchange

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

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

Tests whether or not proposed algorithm has a potential for issues

Login

Login Helper

Login Helper

Login via keyboard-interactive authentication

See {@link http://tools.ietf.org/html/rfc4256 RFC4256} for details. This is not a full-featured keyboard-interactive authenticator.

Handle the keyboard-interactive requests / responses.

Login with an ssh-agent provided key

Login with an RSA private key

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

Creates an interactive shell

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

Return an available open channel

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

In situ reconnect method

Resets a connection for re-use

Gets Binary Packets

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

Filter Binary Packets

Because some binary packets need to be ignored...

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 if it's available and false if not.

Sends Binary Packets

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

Logs data packets

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

Sends channel data

Spans multiple SSH_MSG_CHANNEL_DATAs if appropriate

Closes and flushes a channel

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

Disconnect

String Shift

Inspired by array_shift

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

Helper function for _format_log

For use with preg_replace_callback()

Helper function for agent->_on_channel_open()

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

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.

Returns all errors

Returns the last error

Return the server identification.

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

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

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

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

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

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

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

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

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

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

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

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.

Update packet types in log history

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

(Re)initializes the SFTP channel

Disable the stat cache

Enable the stat cache

Clear the stat cache

Enable path canonicalization

Enable path canonicalization

Returns the current directory name

Logs errors

Returns canonicalized absolute pathname

realpath() expands all symbolic links and resolves references to '/./', '/../' and extra '/' characters in the input path and returns the canonicalized absolute pathname.

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

Helper method for nlist

Returns a detailed list of files in the given directory

Reads a list, be it detailed or not, of files in the given directory

Compares two rawlist entries using parameters set by setListOrder()

Intended for use with uasort()

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 the file size, in bytes, or false, on failure

Files larger than 4GB will show up as being exactly 4GB.

Save files / directories to cache

Remove files / directories from cache

Checks cache for path

Mainly used by file_exists

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.

Returns general information about a file or symbolic link

Determines information without calling \phpseclib\Net\SFTP::realpath(). The second parameter can be either NET_SFTP_STAT or NET_SFTP_LSTAT.

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.

Sets information about a file

Recursively sets information on directories on the SFTP server

Minimizes directory lookups and SSH_FXP_STATUS requests for speed.

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.

Helper function for directory creation

Removes a directory.

Uploads a file to the SFTP server.

By default, \phpseclib\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 \phpseclib\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.

Reads multiple successive SSH_FXP_WRITE responses

Sending an SSH_FXP_WRITE packet and immediately reading its response isn't as efficient as blindly sending out $i SSH_FXP_WRITEs, in succession, and then reading $i responses.

Close handle

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.

Recursively deletes directories on the SFTP server

Minimizes directory lookups and SSH_FXP_STATUS requests for speed.

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

Return a stat properity

Uses cache if appropriate.

Return an lstat properity

Uses cache if appropriate.

Return a stat or lstat properity

Uses cache if appropriate.

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.

Attempt to identify the file type

Quoting the SFTP RFC, "Implementations MUST NOT send bits that are not defined" but they seem to anyway

Parse Longname

SFTPv3 doesn't provide any easy way of identifying a file type. You could try to open a file as a directory and see if an error is returned or you could try to parse the SFTPv3-specific longname field of the SSH_FXP_NAME packet. That's what this function does. The result is returned using the {@link http://tools.ietf.org/html/draft-ietf-secsh-filexfer-04#section-5.2 SFTPv4 type constants}.

If the longname is in an unrecognized format bool(false) is returned.

Sends SFTP Packets

See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.

Receives SFTP Packets

See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.

Incidentally, the number of SSH_MSG_CHANNEL_DATA messages has no bearing on the number of SFTP packets present. There can be one SSH_MSG_CHANNEL_DATA messages containing two SFTP packets or there can be two SSH_MSG_CHANNEL_DATA messages containing one SFTP packet.

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

Returns a string if NET_SFTP_LOGGING == NET_SFTP_LOG_COMPLEX, an array if NET_SFTP_LOGGING == NET_SFTP_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