Pure-PHP implementations of SFTP.
-
-
-
-
-
- $fsock
-
-
-
-
-
-
- The Socket Object
-
-
- public
- mixed
- $fsock
-
-
-
-
-
-
-
-
-
- $auth
-
-
-
-
-
-
- Authentication Credentials
-
-
- protected
- array<string|int, mixed>
- $auth
- = []
-
-
-
-
-
-
-
-
- $bitmap
-
-
-
-
-
-
- Execution Bitmap
-
-
- protected
- 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_status
-
-
-
-
-
-
- Channel Status
-
-
- protected
- array<string|int, mixed>
- $channel_status
- = []
-
- Contains the type of the last sent message
-
-
-
-
-
- -
- see
-
- -
- self::get_channel_packet()
-
-
-
-
-
-
-
-
-
- $curTimeout
-
-
-
-
-
-
- Current Timeout
-
-
- protected
- mixed
- $curTimeout
-
-
-
-
-
-
-
- -
- see
-
- -
- self::get_channel_packet()
-
-
-
-
-
-
-
-
-
-
-
- Preferred Signature Format
-
-
- protected
- string|false
- $preferred_signature_format
- = false
-
-
-
-
-
-
-
-
- $server_channels
-
-
-
-
-
-
- Server Channels
-
-
- protected
- array<string|int, mixed>
- $server_channels
- = []
-
- Maps client channels to server channels
-
-
-
-
-
- -
- see
-
- -
- self::get_channel_packet()
-
-
-
-
- -
- see
-
- -
- self::exec()
-
-
-
-
-
-
-
-
-
- $server_identifier
-
-
-
-
-
-
- Server Identifier
-
-
- protected
- string|false
- $server_identifier
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getServerIdentification()
-
-
-
-
-
-
-
-
-
- $sortOptions
-
-
-
-
-
-
- Sort Options
-
-
- protected
- array<string|int, mixed>
- $sortOptions
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::_comparator()
-
-
-
-
- -
- see
-
- -
- self::setListOrder()
-
-
-
-
-
-
-
-
-
- $timeout
-
-
-
-
-
-
- Timeout
-
-
- protected
- mixed
- $timeout
-
-
-
-
-
-
-
- -
- see
-
- -
- self::setTimeout()
-
-
-
-
-
-
-
-
-
- $window_size
-
-
-
-
-
-
- The Window Size
-
-
- protected
- int
- $window_size
- = 0x7fffffff
-
- Bytes the other party can send before it must wait for the window to be adjusted (0x7FFFFFFF = 2GB)
-
-
-
-
-
- -
- see
-
- -
- self::send_channel_packet()
-
-
-
-
- -
- see
-
- -
- self::exec()
-
-
-
-
-
-
-
-
-
- $window_size_server_to_client
-
-
-
-
-
-
- Window size, server to client
-
-
- protected
- array<string|int, mixed>
- $window_size_server_to_client
- = []
-
- Window size indexed by channel
-
-
-
-
-
- -
- see
-
- -
- self::send_channel_packet()
-
-
-
-
-
-
-
-
-
- $agent
-
-
-
-
-
-
- A System_SSH_Agent for use in the SSH2 Agent Forwarding scenario
-
-
- private
- Agent
- $agent
-
-
-
-
-
-
-
-
-
- $allow_arbitrary_length_packets
-
-
-
-
-
-
- Arbitrary Length Packets Flag
-
-
- private
- bool
- $allow_arbitrary_length_packets
- = false
-
- Determines whether or not packets of any length should be allowed,
-in cases where the server chooses the packet length (such as
-directory listings). By default, packets are only allowed to be
-256 * 1024 bytes (SFTP_MAX_MSG_LENGTH from OpenSSH's sftp-common.h)
-
-
-
-
-
- -
- see
-
- -
- self::enableArbitraryLengthPackets()
-
-
-
-
- -
- see
-
- -
- self::_get_sftp_packet()
-
-
-
-
-
-
-
-
-
- $attributes
-
-
-
-
-
-
-
-
- private
- static array<int, string>
- $attributes
-
-
-
-
-
-
-
-
-
- $auth_methods_to_continue
-
-
-
-
-
-
- The authentication methods that may productively continue authentication.
-
-
- private
- array<string|int, mixed>|null
- $auth_methods_to_continue
- = null
-
-
-
-
-
-
- -
- see
-
- -
- https://tools.ietf.org/html/rfc4252#section-5.1
-
-
-
-
-
-
-
-
-
- $bad_key_size_fix
-
-
-
-
-
-
- Some versions of OpenSSH incorrectly calculate the key size
-
-
- private
- bool
- $bad_key_size_fix
- = false
-
-
-
-
-
-
-
-
- $banner_message
-
-
-
-
-
-
- Banner Message
-
-
- private
- string
- $banner_message
- = ''
-
- Quoting from the RFC, "in some jurisdictions, sending a warning message before
-authentication may be relevant for getting legal protection."
-
-
-
-
-
- -
- see
-
- -
- self::_filter()
-
-
-
-
- -
- see
-
- -
- self::getBannerMessage()
-
-
-
-
-
-
-
-
-
- $binary_packet_buffer
-
-
-
-
-
-
- Binary Packet Buffer
-
-
- private
- string|false
- $binary_packet_buffer
- = false
-
-
-
-
-
-
-
-
- $canonicalize_paths
-
-
-
-
-
-
- Canonicalization Flag
-
-
- private
- bool
- $canonicalize_paths
- = true
-
- Determines whether or not paths should be canonicalized before being
-passed on to the remote server.
-
-
-
-
-
- -
- see
-
- -
- self::enablePathCanonicalization()
-
-
-
-
- -
- see
-
- -
- self::disablePathCanonicalization()
-
-
-
-
- -
- see
-
- -
- self::realpath()
-
-
-
-
-
-
-
-
-
- $channel_buffers
-
-
-
-
-
-
- Channel Buffers
-
-
- private
- array<string|int, mixed>
- $channel_buffers
- = []
-
- If a client requests a packet from one channel but receives two packets from another those packets should
-be placed in a buffer
-
-
-
-
-
- -
- see
-
- -
- self::get_channel_packet()
-
-
-
-
- -
- see
-
- -
- self::exec()
-
-
-
-
-
-
-
-
-
- $channel_close
-
-
-
-
-
-
- Was the last packet due to the channels being closed or not?
-
-
- private
- bool
- $channel_close
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::get()
-
-
-
-
- -
- see
-
- -
- self::get_sftp_packet()
-
-
-
-
-
-
-
-
-
- $channel_extended_data_type_codes
-
-
-
-
-
-
- SSH_MSG_CHANNEL_EXTENDED_DATA's data_type_codes
-
-
- private
- static array<string|int, mixed>
- $channel_extended_data_type_codes
- = []
-
-
-
-
-
-
- -
- link
-
- -
- http://tools.ietf.org/html/rfc4254#section-5.2
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- access
-
- -
-
-
-
-
-
-
-
-
-
- $channel_id_last_interactive
-
-
-
-
-
-
- The identifier of the interactive channel which was opened most recently
-
-
- private
- int
- $channel_id_last_interactive
- = 0
-
-
-
-
-
-
- -
- see
-
- -
- self::getInteractiveChannelId()
-
-
-
-
-
-
-
-
-
- $channel_open_failure_reasons
-
-
-
-
-
-
- SSH_MSG_CHANNEL_OPEN_FAILURE 'reason codes', defined in RFC4254
-
-
- private
- static array<string|int, mixed>
- $channel_open_failure_reasons
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- access
-
- -
-
-
-
-
-
-
-
-
-
- $channelCount
-
-
-
-
-
-
- How many channels are currently opened
-
-
- private
- int
- $channelCount
- = 0
-
-
-
-
-
-
-
-
- $compress
-
-
-
-
-
-
- Compression method
-
-
- private
- int
- $compress
- = self::NET_SSH2_COMPRESSION_NONE
-
-
-
-
-
-
-
-
- $compress_context
-
-
-
-
-
-
- Compression context
-
-
- private
- resource|false|null
- $compress_context
-
-
-
-
-
-
-
-
-
- $compression_algorithms_client_to_server
-
-
-
-
-
-
- Compression Algorithms: Client to Server
-
-
- private
- array<string|int, mixed>|false
- $compression_algorithms_client_to_server
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getCompressionAlgorithmsClient2Server()
-
-
-
-
-
-
-
-
-
- $compression_algorithms_server_to_client
-
-
-
-
-
-
- Compression Algorithms: Server to Client
-
-
- private
- array<string|int, mixed>|false
- $compression_algorithms_server_to_client
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getCompressionAlgorithmsServer2Client()
-
-
-
-
-
-
-
-
-
- $connections
-
-
-
-
-
-
- Connection storage to replicates ssh2 extension functionality:
-{@link http://php.net/manual/en/wrappers.ssh2.php#refsect1-wrappers.ssh2-examples}
-
-
- private
- static array<string, \phpseclib3\Net\SSH2|\WeakReference<\phpseclib3\Net\SSH2>>
- $connections
-
-
-
-
-
-
-
-
-
- $crypto_engine
-
-
-
-
-
-
- Crypto Engine
-
-
- private
- static int
- $crypto_engine
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::setCryptoEngine()
-
-
-
-
- -
- see
-
- -
- self::_key_exchange()
-
-
-
-
-
-
-
-
-
- $decompress
-
-
-
-
-
-
- Decompression method
-
-
- private
- int
- $decompress
- = self::NET_SSH2_COMPRESSION_NONE
-
-
-
-
-
-
-
-
- $decompress_context
-
-
-
-
-
-
- Decompression context
-
-
- private
- resource|object
- $decompress_context
-
-
-
-
-
-
-
-
-
- $decrypt
-
-
-
-
-
-
- Server to Client Encryption Object
-
-
- private
- SymmetricKey|false
- $decrypt
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::_get_binary_packet()
-
-
-
-
-
-
-
-
-
- $decrypt_block_size
-
-
-
-
-
-
- Block Size for Client to Server Encryption
-
-
- private
- int
- $decrypt_block_size
- = 8
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- see
-
- -
- self::_get_binary_packet()
-
-
-
-
-
-
-
-
-
- $decryptFixedPart
-
-
-
-
-
-
- Fixed Part of Nonce
-
-
- private
- string|null
- $decryptFixedPart
-
-
-
-
-
-
-
-
-
- $decryptInvocationCounter
-
-
-
-
-
-
- Decryption Invocation Counter
-
-
- private
- string|null
- $decryptInvocationCounter
-
-
-
-
-
-
-
-
-
- $decryptName
-
-
-
-
-
-
- Decryption Algorithm Name
-
-
- private
- string|null
- $decryptName
-
-
-
-
-
-
-
-
-
- $defaultVersion
-
-
-
-
-
-
- Default Server SFTP version
-
-
- private
- int
- $defaultVersion
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_initChannel()
-
-
-
-
-
-
-
-
-
- $disconnect_reasons
-
-
-
-
-
-
- Disconnection Message 'reason codes' defined in RFC4253
-
-
- private
- static array<string|int, mixed>
- $disconnect_reasons
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- access
-
- -
-
-
-
-
-
-
-
-
-
- $encrypt
-
-
-
-
-
-
- Client to Server Encryption Object
-
-
- private
- SymmetricKey|false
- $encrypt
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::_send_binary_packet()
-
-
-
-
-
-
-
-
-
- $encrypt_block_size
-
-
-
-
-
-
- Block Size for Server to Client Encryption
-
-
- private
- 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
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- see
-
- -
- self::_send_binary_packet()
-
-
-
-
-
-
-
-
-
- $encryptFixedPart
-
-
-
-
-
-
- Fixed Part of Nonce
-
-
- private
- string|null
- $encryptFixedPart
-
-
-
-
-
-
-
-
-
- $encryptInvocationCounter
-
-
-
-
-
-
- Encryption Invocation Counter
-
-
- private
- string|null
- $encryptInvocationCounter
-
-
-
-
-
-
-
-
-
- $encryption_algorithms_client_to_server
-
-
-
-
-
-
- Encryption Algorithms: Client to Server
-
-
- private
- array<string|int, mixed>|false
- $encryption_algorithms_client_to_server
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getEncryptionAlgorithmsClient2Server()
-
-
-
-
-
-
-
-
-
- $encryption_algorithms_server_to_client
-
-
-
-
-
-
- Encryption Algorithms: Server to Client
-
-
- private
- array<string|int, mixed>|false
- $encryption_algorithms_server_to_client
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getEncryptionAlgorithmsServer2Client()
-
-
-
-
-
-
-
-
-
- $encryptName
-
-
-
-
-
-
- Encryption Algorithm Name
-
-
- private
- string|null
- $encryptName
-
-
-
-
-
-
-
-
-
- $errorOnMultipleChannels
-
-
-
-
-
-
- Does the server support multiple channels? If not then error out
-when multiple channels are attempted to be opened
-
-
- private
- bool
- $errorOnMultipleChannels
-
-
-
-
-
-
-
-
-
- $errors
-
-
-
-
-
-
- Error information
-
-
- private
- array<string|int, mixed>
- $errors
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::getErrors()
-
-
-
-
- -
- see
-
- -
- self::getLastError()
-
-
-
-
-
-
-
-
-
- $exchange_hash
-
-
-
-
-
-
- Exchange hash
-
-
- private
- string
- $exchange_hash
- = false
-
- The current exchange hash
-
-
-
-
-
- -
- see
-
- -
- self::_key_exchange()
-
-
-
-
-
-
-
-
-
- $exit_status
-
-
-
-
-
-
- Exit status returned from ssh if any
-
-
- private
- int
- $exit_status
-
-
-
-
-
-
-
-
-
- $extensions
-
-
-
-
-
-
- Extensions supported by the server
-
-
- private
- array<string|int, mixed>
- $extensions
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::_initChannel()
-
-
-
-
-
-
-
-
-
-
-
- Terrapin Countermeasure
-
-
- private
- int
- $extra_packets
-
-
- "During initial KEX, terminate the connection if any unexpected or out-of-sequence packet is received"
--- https://github.com/openssh/openssh-portable/commit/1edb00c58f8a6875fad6a497aa2bacf37f9e6cd5
-
-
-
-
-
-
-
- $file_types
-
-
-
-
-
-
-
-
- private
- static array<int, string>
- $file_types
-
-
-
-
-
-
-
-
-
- $get_seq_no
-
-
-
-
-
-
- Get Sequence Number
-
-
- private
- int
- $get_seq_no
- = 0
-
- See 'Section 6.4. Data Integrity' of rfc4253 for more info.
-
-
-
-
-
- -
- see
-
- -
- self::_get_binary_packet()
-
-
-
-
-
-
-
-
-
- $hmac_check
-
-
-
-
-
-
- Server to Client HMAC Object
-
-
- private
- object
- $hmac_check
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::_get_binary_packet()
-
-
-
-
-
-
-
-
-
- $hmac_check_etm
-
-
-
-
-
-
- Server to Client ETM
-
-
- private
- int|false
- $hmac_check_etm
-
-
-
-
-
-
-
-
-
- $hmac_check_name
-
-
-
-
-
-
- Server to Client HMAC Name
-
-
- private
- string|false
- $hmac_check_name
-
-
-
-
-
-
-
-
-
- $hmac_create
-
-
-
-
-
-
- Client to Server HMAC Object
-
-
- private
- object
- $hmac_create
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::_send_binary_packet()
-
-
-
-
-
-
-
-
-
- $hmac_create_etm
-
-
-
-
-
-
- Client to Server ETM
-
-
- private
- int|false
- $hmac_create_etm
-
-
-
-
-
-
-
-
-
- $hmac_create_name
-
-
-
-
-
-
- Client to Server HMAC Name
-
-
- private
- string|false
- $hmac_create_name
-
-
-
-
-
-
-
-
-
- $hmac_size
-
-
-
-
-
-
- Size of server to client HMAC
-
-
- private
- 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.
-
-
-
-
-
- -
- see
-
- -
- self::_get_binary_packet()
-
-
-
-
-
-
-
-
-
- $host
-
-
-
-
-
-
- Hostname
-
-
- private
- string
- $host
-
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- see
-
- -
- self::_connect()
-
-
-
-
-
-
-
-
-
- $identifier
-
-
-
-
-
-
- The SSH identifier
-
-
- private
- string
- $identifier
-
-
-
-
-
-
-
-
-
- $interactiveBuffer
-
-
-
-
-
-
- Interactive Buffer
-
-
- private
- string
- $interactiveBuffer
- = ''
-
-
-
-
-
-
- -
- see
-
- -
- self::read()
-
-
-
-
-
-
-
-
-
- $is_timeout
-
-
-
-
-
-
- Did read() timeout or return normally?
-
-
- private
- bool
- $is_timeout
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::isTimeout()
-
-
-
-
-
-
-
-
-
- $keepAlive
-
-
-
-
-
-
- Keep Alive Interval
-
-
- private
- mixed
- $keepAlive
-
-
-
-
-
-
-
- -
- see
-
- -
- self::setKeepAlive()
-
-
-
-
-
-
-
-
-
- $kex_algorithm
-
-
-
-
-
-
- Key Exchange Algorithm
-
-
- private
- string|false
- $kex_algorithm
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getMethodsNegotiated()
-
-
-
-
-
-
-
-
-
- $kex_algorithms
-
-
-
-
-
-
- Key Exchange Algorithms
-
-
- private
- array<string|int, mixed>|false
- $kex_algorithms
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getKexAlgorithims()
-
-
-
-
-
-
-
-
-
- $kex_dh_group_size_max
-
-
-
-
-
-
- Maximum Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
-
-
- private
- int
- $kex_dh_group_size_max
- = 4096
-
-
-
-
-
-
- -
- see
-
- -
- self::_key_exchange()
-
-
-
-
-
-
-
-
-
- $kex_dh_group_size_min
-
-
-
-
-
-
- Minimum Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
-
-
- private
- int
- $kex_dh_group_size_min
- = 1536
-
-
-
-
-
-
- -
- see
-
- -
- self::_key_exchange()
-
-
-
-
-
-
-
-
-
- $kex_dh_group_size_preferred
-
-
-
-
-
-
- Preferred Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
-
-
- private
- int
- $kex_dh_group_size_preferred
- = 2048
-
-
-
-
-
-
- -
- see
-
- -
- self::_key_exchange()
-
-
-
-
-
-
-
-
-
- $keyboard_requests_responses
-
-
-
-
-
-
- Keyboard Interactive Request / Responses
-
-
- private
- array<string|int, mixed>
- $keyboard_requests_responses
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::_keyboard_interactive_process()
-
-
-
-
-
-
-
-
-
- $languages_client_to_server
-
-
-
-
-
-
- Languages: Client to Server
-
-
- private
- array<string|int, mixed>|false
- $languages_client_to_server
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getLanguagesClient2Server()
-
-
-
-
-
-
-
-
-
- $languages_server_to_client
-
-
-
-
-
-
- Languages: Server to Client
-
-
- private
- array<string|int, mixed>|false
- $languages_server_to_client
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getLanguagesServer2Client()
-
-
-
-
-
-
-
-
-
- $last_interactive_response
-
-
-
-
-
-
- The Last Interactive Response
-
-
- private
- string
- $last_interactive_response
- = ''
-
-
-
-
-
-
- -
- see
-
- -
- self::_keyboard_interactive_process()
-
-
-
-
-
-
-
-
-
- $last_packet
-
-
-
-
-
-
- Time of first network activity
-
-
- private
- float
- $last_packet
-
-
-
-
-
-
-
-
-
- $lengthDecrypt
-
-
-
-
-
-
- Server to Client Length Encryption Object
-
-
- private
- object
- $lengthDecrypt
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::_get_binary_packet()
-
-
-
-
-
-
-
-
-
- $lengthEncrypt
-
-
-
-
-
-
- Client to Server Length Encryption Object
-
-
- private
- object
- $lengthEncrypt
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::_send_binary_packet()
-
-
-
-
-
-
-
-
-
- $log_boundary
-
-
-
-
-
-
- Log Boundary
-
-
- private
- string
- $log_boundary
- = ':'
-
-
-
-
-
-
- -
- see
-
- -
- self::_format_log()
-
-
-
-
-
-
-
-
-
- $log_long_width
-
-
-
-
-
-
- Log Long Width
-
-
- private
- int
- $log_long_width
- = 65
-
-
-
-
-
-
- -
- see
-
- -
- self::_format_log()
-
-
-
-
-
-
-
-
-
- $log_short_width
-
-
-
-
-
-
- Log Short Width
-
-
- private
- int
- $log_short_width
- = 16
-
-
-
-
-
-
- -
- see
-
- -
- self::_format_log()
-
-
-
-
-
-
-
-
-
- $log_size
-
-
-
-
-
-
- Current log size
-
-
- private
- int
- $log_size
-
-
- Should never exceed self::LOG_MAX_SIZE
-
-
-
-
-
-
-
- $mac_algorithms_client_to_server
-
-
-
-
-
-
- MAC Algorithms: Client to Server
-
-
- private
- array<string|int, mixed>|false
- $mac_algorithms_client_to_server
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getMACAlgorithmsClient2Server()
-
-
-
-
-
-
-
-
-
- $mac_algorithms_server_to_client
-
-
-
-
-
-
- MAC Algorithms: Server to Client
-
-
- private
- array<string|int, mixed>|false
- $mac_algorithms_server_to_client
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getMACAlgorithmsServer2Client()
-
-
-
-
-
-
-
-
-
- $max_sftp_packet
-
-
-
-
-
-
- Max SFTP Packet Size
-
-
- private
- int
- $max_sftp_packet
-
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- see
-
- -
- self::get()
-
-
-
-
-
-
-
-
-
- $message_log
-
-
-
-
-
-
- Message Log
-
-
- private
- array<string|int, mixed>
- $message_log
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::getLog()
-
-
-
-
-
-
-
-
-
- $message_number_log
-
-
-
-
-
-
- Message Number Log
-
-
- private
- array<string|int, mixed>
- $message_number_log
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::getLog()
-
-
-
-
-
-
-
-
-
- $message_numbers
-
-
-
-
-
-
- Message Numbers
-
-
- private
- static array<string|int, mixed>
- $message_numbers
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- access
-
- -
-
-
-
-
-
-
-
-
-
- $open_flags
-
-
-
-
-
-
-
-
- private
- static array<int, string>
- $open_flags
-
-
-
-
-
-
-
-
-
- $open_flags5
-
-
-
-
-
-
-
-
- private
- static array<int, string>
- $open_flags5
-
-
-
-
-
-
-
-
-
- $packet_buffer
-
-
-
-
-
-
- Packet Buffer
-
-
- private
- string
- $packet_buffer
- = ''
-
-
-
-
-
-
- -
- see
-
- -
- self::_get_sftp_packet()
-
-
-
-
-
-
-
-
-
- $packet_log
-
-
-
-
-
-
- Packet Log
-
-
- private
- array<string|int, mixed>
- $packet_log
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::getLog()
-
-
-
-
-
-
-
-
-
- $packet_size_client_to_server
-
-
-
-
-
-
- Packet Size
-
-
- private
- array<string|int, mixed>
- $packet_size_client_to_server
- = []
-
- Maximum packet size indexed by channel
-
-
-
-
-
- -
- see
-
- -
- self::send_channel_packet()
-
-
-
-
-
-
-
-
-
- $packet_type
-
-
-
-
-
-
- The Packet Type
-
-
- private
- int
- $packet_type
- = -1
-
- The request ID exists in the off chance that a packet is sent out-of-order. Of course, this library doesn't support
-concurrent actions, so it's somewhat academic, here.
-
-
-
-
-
- -
- see
-
- -
- self::_get_sftp_packet()
-
-
-
-
-
-
-
-
-
- $packet_type_log
-
-
-
-
-
-
- Packet Type Log
-
-
- private
- array<string|int, mixed>
- $packet_type_log
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::getLog()
-
-
-
-
-
-
-
-
-
- $packet_types
-
-
-
-
-
-
- Packet Types
-
-
- private
- static array<string|int, mixed>
- $packet_types
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- access
-
- -
-
-
-
-
-
-
-
-
-
- $partial_init
-
-
-
-
-
-
- Has the SFTP channel been partially negotiated?
-
-
- private
- bool
- $partial_init
- = false
-
-
-
-
-
-
-
-
- $port
-
-
-
-
-
-
- Port Number
-
-
- private
- int
- $port
-
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- see
-
- -
- self::_connect()
-
-
-
-
-
-
-
-
-
- $preferred
-
-
-
-
-
-
- Preferred Algorithms
-
-
- private
- array<string|int, mixed>
- $preferred
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::setPreferredAlgorithms()
-
-
-
-
-
-
-
-
-
- $preferredVersion
-
-
-
-
-
-
- Preferred SFTP version
-
-
- private
- int
- $preferredVersion
- = 3
-
-
-
-
-
-
- -
- see
-
- -
- self::_initChannel()
-
-
-
-
-
-
-
-
-
- $preserveTime
-
-
-
-
-
-
- Preserve timestamps on file downloads / uploads
-
-
- private
- bool
- $preserveTime
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::get()
-
-
-
-
- -
- see
-
- -
- self::put()
-
-
-
-
-
-
-
-
-
- $pwd
-
-
-
-
-
-
- Current working directory
-
-
- private
- string|bool
- $pwd
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::realpath()
-
-
-
-
- -
- see
-
- -
- self::chdir()
-
-
-
-
-
-
-
-
-
- $quiet_mode
-
-
-
-
-
-
- Flag to suppress stderr from output
-
-
- private
- mixed
- $quiet_mode
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::enableQuietMode()
-
-
-
-
-
-
-
-
-
- $realtime_log_file
-
-
-
-
-
-
- Real-time log file pointer
-
-
- private
- mixed
- $realtime_log_file
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_append_log()
-
-
-
-
-
-
-
-
-
- $realtime_log_size
-
-
-
-
-
-
- Real-time log file size
-
-
- private
- int
- $realtime_log_size
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_append_log()
-
-
-
-
-
-
-
-
-
- $realtime_log_wrap
-
-
-
-
-
-
- Real-time log file wrap boolean
-
-
- private
- bool
- $realtime_log_wrap
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_append_log()
-
-
-
-
-
-
-
-
-
- $regenerate_compression_context
-
-
-
-
-
-
- Regenerate Compression Context
-
-
- private
- bool
- $regenerate_compression_context
- = false
-
-
-
-
-
-
-
-
- $regenerate_decompression_context
-
-
-
-
-
-
- Regenerate Decompression Context
-
-
- private
- bool
- $regenerate_decompression_context
- = false
-
-
-
-
-
-
-
-
- $request_pty
-
-
-
-
-
-
- Flag to request a PTY when using exec()
-
-
- private
- bool
- $request_pty
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::enablePTY()
-
-
-
-
-
-
-
-
-
- $requestBuffer
-
-
-
-
-
-
- Request Buffers
-
-
- private
- array<string|int, mixed>
- $requestBuffer
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::_get_sftp_packet()
-
-
-
-
-
-
-
-
-
- $retry_connect
-
-
-
-
-
-
- Should we try to re-connect to re-establish keys?
-
-
- private
- bool
- $retry_connect
- = false
-
-
-
-
-
-
-
-
- $send_id_string_first
-
-
-
-
-
-
- Send the identification string first?
-
-
- private
- bool
- $send_id_string_first
- = true
-
-
-
-
-
-
-
-
- $send_kex_first
-
-
-
-
-
-
- Send the key exchange initiation packet first?
-
-
- private
- bool
- $send_kex_first
- = true
-
-
-
-
-
-
-
-
- $send_seq_no
-
-
-
-
-
-
- Send Sequence Number
-
-
- private
- int
- $send_seq_no
- = 0
-
- See 'Section 6.4. Data Integrity' of rfc4253 for more info.
-
-
-
-
-
- -
- see
-
- -
- self::_send_binary_packet()
-
-
-
-
-
-
-
-
-
- $server_host_key_algorithms
-
-
-
-
-
-
- Server Host Key Algorithms
-
-
- private
- array<string|int, mixed>|false
- $server_host_key_algorithms
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getServerHostKeyAlgorithms()
-
-
-
-
-
-
-
-
-
- $server_public_host_key
-
-
-
-
-
-
- Server Public Host Key
-
-
- private
- string
- $server_public_host_key
-
-
-
-
-
-
-
- -
- see
-
- -
- self::getServerPublicHostKey()
-
-
-
-
-
-
-
-
-
- $session_id
-
-
-
-
-
-
- Session identifier
-
-
- private
- 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
-
-
-
-
-
- -
- see
-
- -
- self::_key_exchange()
-
-
-
-
-
-
-
-
-
- $sftp_errors
-
-
-
-
-
-
- Error information
-
-
- private
- array<string|int, mixed>
- $sftp_errors
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::getSFTPErrors()
-
-
-
-
- -
- see
-
- -
- self::getLastSFTPError()
-
-
-
-
-
-
-
-
-
- $signature
-
-
-
-
-
-
- Server signature
-
-
- private
- string
- $signature
- = ''
-
- Verified against $this->session_id
-
-
-
-
-
- -
- see
-
- -
- self::getServerPublicHostKey()
-
-
-
-
-
-
-
-
-
-
-
- Server signature format
-
-
- private
- string
- $signature_format
- = ''
-
-
-
-
-
-
- -
- see
-
- -
- self::getServerPublicHostKey()
-
-
-
-
-
-
-
-
-
- $signature_validated
-
-
-
-
-
-
- Has the signature been validated?
-
-
- private
- bool
- $signature_validated
- = false
-
-
-
-
-
-
- -
- see
-
- -
- self::getServerPublicHostKey()
-
-
-
-
-
-
-
-
-
- $smartMFA
-
-
-
-
-
-
- Smart multi-factor authentication flag
-
-
- private
- bool
- $smartMFA
- = true
-
-
-
-
-
-
-
-
- $stat_cache
-
-
-
-
-
-
- Stat Cache
-
-
- private
- array<string|int, mixed>
- $stat_cache
- = []
-
- Rather than always having to open a directory and close it immediately there after to see if a file is a directory
-we'll cache the results.
-
-
-
-
-
- -
- see
-
- -
- self::_update_stat_cache()
-
-
-
-
- -
- see
-
- -
- self::_remove_from_stat_cache()
-
-
-
-
- -
- see
-
- -
- self::_query_stat_cache()
-
-
-
-
-
-
-
-
-
- $status_codes
-
-
-
-
-
-
- Status Codes
-
-
- private
- static array<string|int, mixed>
- $status_codes
- = []
-
-
-
-
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- access
-
- -
-
-
-
-
-
-
-
-
-
- $stdErrorLog
-
-
-
-
-
-
- Contents of stdError
-
-
- private
- string
- $stdErrorLog
-
-
-
-
-
-
-
-
-
- $supported_private_key_algorithms
-
-
-
-
-
-
- Supported Private Key Algorithms
-
-
- private
- array<string|int, mixed>|false
- $supported_private_key_algorithms
- = false
-
- In theory this should be the same as the Server Host Key Algorithms but, in practice,
-some servers (eg. Azure) will support rsa-sha2-512 as a server host key algorithm but
-not a private key algorithm
-
-
-
-
-
- -
- see
-
- -
- self::privatekey_login()
-
-
-
-
-
-
-
-
-
- $term
-
-
-
-
-
-
- Terminal
-
-
- private
- string
- $term
- = 'vt100'
-
-
-
-
-
-
-
-
- $terminal_modes
-
-
-
-
-
-
- Terminal Modes
-
-
- private
- static array<string|int, mixed>
- $terminal_modes
- = []
-
-
-
-
-
-
- -
- link
-
- -
- http://tools.ietf.org/html/rfc4254#section-8
-
-
- -
- see
-
- -
- self::__construct()
-
-
-
-
- -
- access
-
- -
-
-
-
-
-
-
-
-
-
- $use_request_id
-
-
-
-
-
-
- The Request ID
-
-
- private
- bool
- $use_request_id
- = false
-
- The request ID exists in the off chance that a packet is sent out-of-order. Of course, this library doesn't support
-concurrent actions, so it's somewhat academic, here.
-
-
-
-
-
- -
- see
-
- -
- self::_send_sftp_packet()
-
-
-
-
-
-
-
-
-
- $use_stat_cache
-
-
-
-
-
-
- Stat Cache Flag
-
-
- private
- bool
- $use_stat_cache
- = true
-
-
-
-
-
-
- -
- see
-
- -
- self::disableStatCache()
-
-
-
-
- -
- see
-
- -
- self::enableStatCache()
-
-
-
-
-
-
-
-
-
- $version
-
-
-
-
-
-
- Server SFTP version
-
-
- private
- int
- $version
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_initChannel()
-
-
-
-
-
-
-
-
-
- $window_resize
-
-
-
-
-
-
- What we resize the window to
-
-
- private
- 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
-
-
-
-
-
- -
- see
-
- -
- self::_send_channel_packet()
-
-
-
-
- -
- see
-
- -
- self::exec()
-
-
-
-
-
-
-
-
-
- $window_size_client_to_server
-
-
-
-
-
-
- Window size, client to server
-
-
- private
- array<string|int, mixed>
- $window_size_client_to_server
- = []
-
- Window size indexed by channel
-
-
-
-
-
- -
- see
-
- -
- self::get_channel_packet()
-
-
-
-
-
-
-
-
-
- $windowColumns
-
-
-
-
-
-
- Number of columns for terminal window size
-
-
- private
- int
- $windowColumns
- = 80
-
-
-
-
-
-
- -
- see
-
- -
- self::getWindowColumns()
-
-
-
-
- -
- see
-
- -
- self::setWindowColumns()
-
-
-
-
- -
- see
-
- -
- self::setWindowSize()
-
-
-
-
-
-
-
-
-
- $windowRows
-
-
-
-
-
-
- Number of columns for terminal window size
-
-
- private
- int
- $windowRows
- = 24
-
-
-
-
-
-
- -
- see
-
- -
- self::getWindowRows()
-
-
-
-
- -
- see
-
- -
- self::setWindowRows()
-
-
-
-
- -
- see
-
- -
- self::setWindowSize()
-
-
-
-
-
-
-
-
-
-
-
-
-
- __construct()
-
-
-
-
- Default Constructor.
-
-
- public
- __construct(mixed $host[, int $port = 22 ][, int $timeout = 10 ]) : mixed
-
- Connects to an SFTP server
-$host can either be a string, representing the host, or a stream resource.
-
-
- Parameters
-
- -
- $host
- : mixed
-
- -
-
-
-
- -
- $port
- : int
- = 22
- -
-
-
-
- -
- $timeout
- : int
- = 10
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- __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
- —
-
-
-
-
-
-
- __toString()
-
-
-
-
- To String Magic Method
-
-
- public
- __toString() : string
-
-
-
-
-
-
- Return values
- string
- —
-
-
-
-
-
-
- chdir()
-
-
-
-
- Changes the current directory
-
-
- public
- chdir(string $dir) : bool
-
-
-
- Parameters
-
- -
- $dir
- : string
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- chgrp()
-
-
-
-
- Changes file or directory group
-
-
- public
- chgrp(string $filename, int|string $gid[, bool $recursive = false ]) : bool
-
- $gid should be an int for SFTPv3 and a string for SFTPv4+. Ideally the string
-would be of the form "user@dns_domain" but it does not need to be.
-$sftp->getSupportedVersions()['version'] will return the specific version
-that's being used.
-Returns true on success or false on error.
-
-
- Parameters
-
- -
- $filename
- : string
-
- -
-
-
-
- -
- $gid
- : int|string
-
- -
-
-
-
- -
- $recursive
- : bool
- = false
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- chmod()
-
-
-
-
- Set permissions on a file.
-
-
- public
- chmod(int $mode, string $filename[, bool $recursive = false ]) : mixed
-
- Returns the new file permissions on success or false on error.
-If $recursive is true than this just returns true or false.
-
-
- Parameters
-
- -
- $mode
- : int
-
- -
-
-
-
- -
- $filename
- : string
-
- -
-
-
-
- -
- $recursive
- : bool
- = false
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- chown()
-
-
-
-
- Changes file or directory owner
-
-
- public
- chown(string $filename, int|string $uid[, bool $recursive = false ]) : bool
-
- $uid should be an int for SFTPv3 and a string for SFTPv4+. Ideally the string
-would be of the form "user@dns_domain" but it does not need to be.
-$sftp->getSupportedVersions()['version'] will return the specific version
-that's being used.
-Returns true on success or false on error.
-
-
- Parameters
-
- -
- $filename
- : string
-
- -
-
-
-
- -
- $uid
- : int|string
-
- -
-
-
-
- -
- $recursive
- : bool
- = false
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- clearStatCache()
-
-
-
-
- Clear the stat cache
-
-
- public
- clearStatCache() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- delete()
-
-
-
-
- Deletes a file on the SFTP server.
-
-
- public
- delete(string $path[, bool $recursive = true ]) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
- -
- $recursive
- : bool
- = true
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- disableArbitraryLengthPackets()
-
-
-
-
- Disable arbitrary length packets
-
-
- public
- disableArbitraryLengthPackets() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- disableDatePreservation()
-
-
-
-
- Disable Date Preservation
-
-
- public
- disableDatePreservation() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- disablePathCanonicalization()
-
-
-
-
- Disable path canonicalization
-
-
- public
- disablePathCanonicalization() : mixed
-
- If this is enabled then $sftp->pwd() will not return the canonicalized absolute path
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- disablePTY()
-
-
-
-
- Disable request-pty when using exec()
-
-
- public
- disablePTY() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- disableQuietMode()
-
-
-
-
- Disable Quiet Mode
-
-
- public
- disableQuietMode() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- disableSmartMFA()
-
-
-
-
- Disables "smart" multi-factor authentication (MFA)
-
-
- public
- disableSmartMFA() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- disableStatCache()
-
-
-
-
- Disable the stat cache
-
-
- public
- disableStatCache() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- disconnect()
-
-
-
-
- Disconnect
-
-
- public
- disconnect() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- enableArbitraryLengthPackets()
-
-
-
-
- Enable arbitrary length packets
-
-
- public
- enableArbitraryLengthPackets() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- enableDatePreservation()
-
-
-
-
- Enable Date Preservation
-
-
- public
- enableDatePreservation() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- enablePathCanonicalization()
-
-
-
-
- Enable path canonicalization
-
-
- public
- enablePathCanonicalization() : 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
- —
-
-
-
-
-
-
- enableSmartMFA()
-
-
-
-
- Enables "smart" multi-factor authentication (MFA)
-
-
- public
- enableSmartMFA() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- enableStatCache()
-
-
-
-
- Enable the stat cache
-
-
- public
- enableStatCache() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- exec()
-
-
-
-
- Execute Command
-
-
- public
- exec(string $command[, callable $callback = null ]) : string|bool
-
- 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.
-
-
- Parameters
-
- -
- $command
- : string
-
- -
-
-
-
- -
- $callback
- : callable
- = null
- -
-
-
-
-
-
-
-
- -
- psalm-return
-
- -
-
-
($callback is callable ? bool : string|bool)
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
-
-
- Return values
- string|bool
- —
-
-
-
-
-
-
- file_exists()
-
-
-
-
- Checks whether a file or directory exists
-
-
- public
- file_exists(string $path) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- fileatime()
-
-
-
-
- Gets last access time of file
-
-
- public
- fileatime(string $path) : mixed
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- filegroup()
-
-
-
-
- Gets file group
-
-
- public
- filegroup(string $path) : mixed
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- filemtime()
-
-
-
-
- Gets file modification time
-
-
- public
- filemtime(string $path) : mixed
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- fileowner()
-
-
-
-
- Gets file owner
-
-
- public
- fileowner(string $path) : mixed
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- fileperms()
-
-
-
-
- Gets file permissions
-
-
- public
- fileperms(string $path) : mixed
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- filesize()
-
-
-
-
- Gets file size
-
-
- public
- filesize(string $path[, bool $recursive = false ]) : mixed
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
- -
- $recursive
- : bool
- = false
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- filetype()
-
-
-
-
- Gets file type
-
-
- public
- filetype(string $path) : string|false
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- string|false
- —
-
-
-
-
-
-
- forceMultipleChannels()
-
-
-
-
- Force multiple channels (even if phpseclib has decided to disable them)
-
-
- public
- forceMultipleChannels() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- get()
-
-
-
-
- Downloads a file from the SFTP server.
-
-
- public
- get(string $remote_file[, string|bool|resource|callable $local_file = false ], int $offset[, int $length = -1 ][, callable|null $progressCallback = null ]) : string|bool
-
- 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.
-
-
- Parameters
-
- -
- $remote_file
- : string
-
- -
-
-
-
- -
- $local_file
- : string|bool|resource|callable
- = false
- -
-
-
-
- -
- $offset
- : int
-
- -
-
-
-
- -
- $length
- : int
- = -1
- -
-
-
-
- -
- $progressCallback
- : callable|null
- = null
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- string|bool
- —
-
-
-
-
-
-
- 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>
- —
-
-
-
-
-
-
- getAuthMethodsToContinue()
-
-
-
-
- Return the list of authentication methods that may productively continue authentication.
-
-
- public
- getAuthMethodsToContinue() : array<string|int, mixed>|null
-
-
-
-
-
-
-
- -
- see
-
- -
- https://tools.ietf.org/html/rfc4252#section-5.1
-
-
-
-
-
-
- Return values
- array<string|int, mixed>|null
- —
-
-
-
-
-
-
- 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
- —
-
-
-
-
-
-
- getConnectionByResourceId()
-
-
-
-
- Return existing connection
-
-
- public
- static getConnectionByResourceId(string $id) : bool|SSH2
-
-
-
- Parameters
-
- -
- $id
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool|SSH2
- —
- will return false if no such connection
-
-
-
-
-
-
- getConnections()
-
-
-
-
- Return all excising connections
-
-
- public
- static getConnections() : array<string, SSH2>
-
-
-
-
-
-
- Return values
- array<string, SSH2>
- —
-
-
-
-
-
-
- getErrors()
-
-
-
-
- Returns all errors / debug messages on the SSH layer
-
-
- public
- getErrors() : array<string|int, string>
-
- If you are looking for messages from the SFTP layer, please see SFTP::getSFTPErrors()
-
-
-
-
-
- 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
- —
-
-
-
-
-
-
- getInteractiveChannelId()
-
-
-
-
- Returns a channel identifier, presently of the last interactive channel opened, regardless of current status.
-
-
- public
- getInteractiveChannelId() : int
-
- Returns 0 if no interactive channel has been opened.
-
-
-
-
-
-
- -
- see
-
- -
- self::isInteractiveChannelOpen()
-
-
-
-
-
-
- Return values
- int
- —
-
-
-
-
-
-
- getLastError()
-
-
-
-
- Returns the last error received on the SSH layer
-
-
- public
- getLastError() : string
-
- If you are looking for messages from the SFTP layer, please see SFTP::getLastSFTPError()
-
-
-
-
-
- Return values
- string
- —
-
-
-
-
-
-
- getLastSFTPError()
-
-
-
-
- Returns the last error on the SFTP layer
-
-
- public
- getLastSFTPError() : 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
- —
-
-
-
-
-
-
- getNegotiatedVersion()
-
-
-
-
- Get supported SFTP versions
-
-
- public
- getNegotiatedVersion() : int|false
-
-
-
-
-
-
- Return values
- int|false
- —
-
-
-
-
-
-
- getOpenChannelCount()
-
-
-
-
- How many channels are currently open?
-
-
- public
- getOpenChannelCount() : int
-
-
-
-
-
-
- Return values
- int
- —
-
-
-
-
-
-
- getResourceId()
-
-
-
-
- Get Resource ID
-
-
- public
- getResourceId() : string
-
- We use } because that symbols should not be in URL according to
-RFC.
-It will safe us from any conflicts, because otherwise regexp will
-match all alphanumeric domains.
-
-
-
-
-
- Return values
- string
- —
-
-
-
-
-
-
- getServerAlgorithms()
-
-
-
-
- Returns a list of algorithms the server supports
-
-
- public
- getServerAlgorithms() : array<string|int, mixed>
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- getServerIdentification()
-
-
-
-
- Return the server identification.
-
-
- public
- getServerIdentification() : string|false
-
-
-
-
-
-
- Return values
- string|false
- —
-
-
-
-
-
-
- getServerPublicHostKey()
-
-
-
-
- Returns the server public host key.
-
-
- public
- getServerPublicHostKey() : string|false
-
- 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.
-
-
-
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
on badly formatted keys
-
-
-
- -
- throws
-
- -
- NoSupportedAlgorithmsException
-
-
when the key isn't in a supported format
-
-
-
-
-
- Return values
- string|false
- —
-
-
-
-
-
-
- getSFTPErrors()
-
-
-
-
- Returns all errors on the SFTP layer
-
-
- public
- getSFTPErrors() : array<string|int, mixed>
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- getSFTPLog()
-
-
-
-
- Returns a log of the packets that have been sent and received.
-
-
- public
- getSFTPLog() : array<string|int, mixed>|string|false
-
- 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')
-
-
-
-
-
- Return values
- array<string|int, mixed>|string|false
- —
-
-
-
-
-
-
- getStdError()
-
-
-
-
- Get the output from stdError
-
-
- public
- getStdError() : mixed
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- getSupportedCompressionAlgorithms()
-
-
-
-
- Returns a list of compression algorithms that phpseclib supports
-
-
- public
- static getSupportedCompressionAlgorithms() : array<string|int, mixed>
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- getSupportedEncryptionAlgorithms()
-
-
-
-
- Returns a list of symmetric key algorithms that phpseclib supports
-
-
- public
- static getSupportedEncryptionAlgorithms() : array<string|int, mixed>
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- getSupportedHostKeyAlgorithms()
-
-
-
-
- Returns a list of host key algorithms that phpseclib supports
-
-
- public
- static getSupportedHostKeyAlgorithms() : array<string|int, mixed>
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- getSupportedKEXAlgorithms()
-
-
-
-
- Returns a list of KEX algorithms that phpseclib supports
-
-
- public
- static getSupportedKEXAlgorithms() : array<string|int, mixed>
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- getSupportedMACAlgorithms()
-
-
-
-
- Returns a list of MAC algorithms that phpseclib supports
-
-
- public
- static getSupportedMACAlgorithms() : array<string|int, mixed>
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- getSupportedVersions()
-
-
-
-
- Get supported SFTP versions
-
-
- public
- getSupportedVersions() : array<string|int, mixed>
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- getTimeout()
-
-
-
-
- Return the currently configured timeout
-
-
- public
- getTimeout() : int
-
-
-
-
-
-
- Return values
- int
- —
-
-
-
-
-
-
- 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
- —
-
-
-
-
-
-
- is_dir()
-
-
-
-
- Tells whether the filename is a directory
-
-
- public
- is_dir(string $path) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- is_file()
-
-
-
-
- Tells whether the filename is a regular file
-
-
- public
- is_file(string $path) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- is_link()
-
-
-
-
- Tells whether the filename is a symbolic link
-
-
- public
- is_link(string $path) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- is_readable()
-
-
-
-
- Tells whether a file exists and is readable
-
-
- public
- is_readable(string $path) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- is_writable()
-
-
-
-
- Tells whether the filename is writable
-
-
- public
- is_writable(string $path) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- is_writeable()
-
-
-
-
- Tells whether the filename is writeable
-
-
- public
- is_writeable(string $path) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- isAuthenticated()
-
-
-
-
- Have you successfully been logged in?
-
-
- public
- isAuthenticated() : bool
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- isConnected()
-
-
-
-
- Is the connection still active?
-
-
- public
- isConnected(int $level) : bool
-
- $level has 3x possible values:
-0 (default): phpseclib takes a passive approach to see if the connection is still active by calling feof()
-on the socket
-1: phpseclib takes an active approach to see if the connection is still active by sending an SSH_MSG_IGNORE
-packet that doesn't require a response
-2: phpseclib takes an active approach to see if the connection is still active by sending an SSH_MSG_CHANNEL_OPEN
-packet and imediately trying to close that channel. some routers, in particular, however, will only let you
-open one channel, so this approach could yield false positives
-
-
- Parameters
-
- -
- $level
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- isInteractiveChannelOpen()
-
-
-
-
- Is the given interactive channel active?
-
-
- public
- isInteractiveChannelOpen(int $channel) : bool
-
-
-
- Parameters
-
- -
- $channel
- : int
-
- -
-
Channel id returned by self::getInteractiveChannelId()
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- isPTYEnabled()
-
-
-
-
- Returns whether request-pty is enabled or not
-
-
- public
- isPTYEnabled() : bool
-
-
-
-
-
-
-
- -
- see
-
- -
- self::enablePTY()
-
-
-
-
- -
- see
-
- -
- self::disablePTY()
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- isPTYOpen()
-
-
-
-
- Is the exec pty active?
-
-
- public
- isPTYOpen() : bool
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- isQuietModeEnabled()
-
-
-
-
- Returns whether Quiet Mode is enabled or not
-
-
- public
- isQuietModeEnabled() : bool
-
-
-
-
-
-
-
- -
- see
-
- -
- self::enableQuietMode()
-
-
-
-
- -
- see
-
- -
- self::disableQuietMode()
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- isShellOpen()
-
-
-
-
- Is the interactive shell active?
-
-
- public
- isShellOpen() : 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()
-
-
-
-
- Login
-
-
- public
- login(string $username, string|PrivateKey|array<string|int, array<string|int, mixed>>|Agent|null ...$args) : bool
-
- The $password parameter can be a plaintext password, a \phpseclib3\Crypt\RSA|EC|DSA object, a \phpseclib3\System\SSH\Agent object or an array
-
-
- Parameters
-
- -
- $username
- : string
-
- -
-
-
-
- -
- $args
- : string|PrivateKey|array<string|int, array<string|int, mixed>>|Agent|null
-
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_login()
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- lstat()
-
-
-
-
- Returns general information about a file or symbolic link.
-
-
- public
- lstat(string $filename) : array<string|int, mixed>|false
-
- Returns an array on success and false otherwise.
-
-
- Parameters
-
- -
- $filename
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- array<string|int, mixed>|false
- —
-
-
-
-
-
-
- mkdir()
-
-
-
-
- Creates a directory.
-
-
- public
- mkdir(string $dir[, int $mode = -1 ][, bool $recursive = false ]) : bool
-
-
-
- Parameters
-
- -
- $dir
- : string
-
- -
-
-
-
- -
- $mode
- : int
- = -1
- -
-
-
-
- -
- $recursive
- : bool
- = false
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- nlist()
-
-
-
-
- Returns a list of files in the given directory
-
-
- public
- nlist([string $dir = '.' ][, bool $recursive = false ]) : array<string|int, mixed>|false
-
-
-
- Parameters
-
- -
- $dir
- : string
- = '.'
- -
-
-
-
- -
- $recursive
- : bool
- = false
- -
-
-
-
-
-
-
-
- Return values
- array<string|int, mixed>|false
- —
-
-
-
-
-
-
- openShell()
-
-
-
-
- Creates an interactive shell
-
-
- public
- openShell() : bool
-
- Returns bool(true) if the shell was opened.
-Returns bool(false) if the shell was already open.
-
-
-
-
-
-
- -
- see
-
- -
- self::isShellOpen()
-
-
-
-
- -
- see
-
- -
- self::read()
-
-
-
-
- -
- see
-
- -
- self::write()
-
-
-
-
- -
- throws
-
- -
- InsufficientSetupException
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
-
-
- 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
- —
-
-
-
-
-
-
- put()
-
-
-
-
- Uploads a file to the SFTP server.
-
-
- public
- put(string $remote_file, string|resource $data[, int $mode = self::SOURCE_STRING ][, int $start = -1 ][, int $local_start = -1 ][, callable|null $progressCallback = null ]) : bool
-
- 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.
-
-
- Parameters
-
- -
- $remote_file
- : string
-
- -
-
-
-
- -
- $data
- : string|resource
-
- -
-
-
-
- -
- $mode
- : int
- = self::SOURCE_STRING
- -
-
-
-
- -
- $start
- : int
- = -1
- -
-
-
-
- -
- $local_start
- : int
- = -1
- -
-
-
-
- -
- $progressCallback
- : callable|null
- = null
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
- -
- throws
-
- -
- BadFunctionCallException
-
-
if you're uploading via a callback and the callback function is invalid
-
-
-
- -
- throws
-
- -
- FileNotFoundException
-
-
if you're uploading via a file and the file doesn't exist
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- pwd()
-
-
-
-
- Returns the current directory name
-
-
- public
- pwd() : string|bool
-
-
-
-
-
-
- Return values
- string|bool
- —
-
-
-
-
-
-
- rawlist()
-
-
-
-
- Returns a detailed list of files in the given directory
-
-
- public
- rawlist([string $dir = '.' ][, bool $recursive = false ]) : array<string|int, mixed>|false
-
-
-
- Parameters
-
- -
- $dir
- : string
- = '.'
- -
-
-
-
- -
- $recursive
- : bool
- = false
- -
-
-
-
-
-
-
-
- Return values
- array<string|int, mixed>|false
- —
-
-
-
-
-
-
- read()
-
-
-
-
- Returns the output of an interactive shell
-
-
- public
- read([string $expect = '' ][, int $mode = self::READ_SIMPLE ][, int|null $channel = null ]) : string|bool|null
-
- 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.
-If not specifying a channel, an open interactive channel will be selected, or, if there are
-no open channels, an interactive shell will be created. If there are multiple open
-interactive channels, a legacy behavior will apply in which channel selection prioritizes
-an active subsystem, the exec pty, and, lastly, the shell. If using multiple interactive
-channels, callers are discouraged from relying on this legacy behavior and should specify
-the intended channel.
-
-
- Parameters
-
- -
- $expect
- : string
- = ''
- -
-
-
-
- -
- $mode
- : int
- = self::READ_SIMPLE
- -
-
One of the self::READ_* constants
-
-
-
- -
- $channel
- : int|null
- = null
- -
-
Channel id returned by self::getInteractiveChannelId()
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::write()
-
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
- -
- throws
-
- -
- InsufficientSetupException
-
-
on unexpected channel status, possibly due to closure
-
-
-
-
-
- Return values
- string|bool|null
- —
-
-
-
-
-
-
- readlink()
-
-
-
-
- Return the target of a symbolic link
-
-
- public
- readlink(string $link) : mixed
-
-
-
- Parameters
-
- -
- $link
- : string
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- realpath()
-
-
-
-
- Canonicalize the Server-Side Path Name
-
-
- public
- realpath(string $path) : mixed
-
- 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.
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::chdir()
-
-
-
-
- -
- see
-
- -
- self::disablePathCanonicalization()
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- rename()
-
-
-
-
- Renames a file or a directory on the SFTP server.
-
-
- public
- rename(string $oldname, string $newname) : bool
-
- If the file already exists this will return false
-
-
- Parameters
-
- -
- $oldname
- : string
-
- -
-
-
-
- -
- $newname
- : string
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- requestAgentForwarding()
-
-
-
-
- Request agent forwarding of remote server
-
-
- public
- requestAgentForwarding() : bool
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- reset()
-
-
-
-
- Closes a channel
-
-
- public
- reset([int|null $channel = null ]) : void
-
- If read() timed out you might want to just close the channel and have it auto-restart on the next read() call
-If not specifying a channel, an open interactive channel will be selected. If there are
-multiple open interactive channels, a legacy behavior will apply in which channel selection
-prioritizes an active subsystem, the exec pty, and, lastly, the shell. If using multiple
-interactive channels, callers are discouraged from relying on this legacy behavior and
-should specify the intended channel.
-
-
- Parameters
-
- -
- $channel
- : int|null
- = null
- -
-
Channel id returned by self::getInteractiveChannelId()
-
-
-
-
-
-
-
- Return values
- void
- —
-
-
-
-
-
-
- rmdir()
-
-
-
-
- Removes a directory.
-
-
- public
- rmdir(string $dir) : bool
-
-
-
- Parameters
-
- -
- $dir
- : string
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- 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
-
- 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
- —
-
-
-
-
-
-
- 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
-
- 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
- —
-
-
-
-
-
-
- setCryptoEngine()
-
-
-
-
- Set Crypto Engine Mode
-
-
- public
- static setCryptoEngine(int $engine) : mixed
-
- Possible $engine values:
-OpenSSL, mcrypt, Eval, PHP
-
-
- Parameters
-
- -
- $engine
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- setKeepAlive()
-
-
-
-
- Set Keep Alive
-
-
- public
- setKeepAlive(int $interval) : mixed
-
- Sends an SSH2_MSG_IGNORE message every x seconds, if x is a positive non-zero number.
-
-
- Parameters
-
- -
- $interval
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- setListOrder()
-
-
-
-
- Defines how nlist() and rawlist() will be sorted - if at all.
-
-
- public
- setListOrder(string ...$args) : mixed
-
- 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
-
-
- Parameters
-
- -
- $args
- : string
-
- -
-
-
-
-
-
-
-
- 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
- —
-
-
-
-
-
-
- setPreferredVersion()
-
-
-
-
- Set preferred version
-
-
- public
- setPreferredVersion(int $version) : mixed
-
- If you're preferred version isn't supported then the highest supported
-version of SFTP will be utilized. Set to null or false or int(0) to
-unset the preferred version
-
-
- Parameters
-
- -
- $version
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- setTerminal()
-
-
-
-
- Allows you to set the terminal
-
-
- public
- setTerminal(string $term) : mixed
-
-
-
- Parameters
-
- -
- $term
- : string
-
- -
-
-
-
-
-
-
-
- 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
-
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::stopSubsystem()
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- stat()
-
-
-
-
- Returns general information about a file.
-
-
- public
- stat(string $filename) : array<string|int, mixed>|false
-
- Returns an array on success and false otherwise.
-
-
- Parameters
-
- -
- $filename
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- array<string|int, mixed>|false
- —
-
-
-
-
-
-
- stopSubsystem()
-
-
-
-
- Stops a subsystem.
-
-
- public
- stopSubsystem() : bool
-
-
-
-
-
-
-
- -
- see
-
- -
- self::startSubsystem()
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- symlink()
-
-
-
-
- Create a symlink
-
-
- public
- symlink(string $target, string $link) : bool
-
- symlink() creates a symbolic link to the existing target with the specified name link.
-
-
- Parameters
-
- -
- $target
- : string
-
- -
-
-
-
- -
- $link
- : string
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- touch()
-
-
-
-
- Sets access and modification time of file.
-
-
- public
- touch(string $filename[, int $time = null ][, int $atime = null ]) : bool
-
- If the file does not exist, it will be created.
-
-
- Parameters
-
- -
- $filename
- : string
-
- -
-
-
-
- -
- $time
- : int
- = null
- -
-
-
-
- -
- $atime
- : int
- = null
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- truncate()
-
-
-
-
- Truncates a file to a given length
-
-
- public
- truncate(string $filename, int $new_size) : bool
-
-
-
- Parameters
-
- -
- $filename
- : string
-
- -
-
-
-
- -
- $new_size
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- write()
-
-
-
-
- Inputs a command into an interactive shell.
-
-
- public
- write(string $cmd[, int|null $channel = null ]) : void
-
- If not specifying a channel, an open interactive channel will be selected, or, if there are
-no open channels, an interactive shell will be created. If there are multiple open
-interactive channels, a legacy behavior will apply in which channel selection prioritizes
-an active subsystem, the exec pty, and, lastly, the shell. If using multiple interactive
-channels, callers are discouraged from relying on this legacy behavior and should specify
-the intended channel.
-
-
- Parameters
-
- -
- $cmd
- : string
-
- -
-
-
-
- -
- $channel
- : int|null
- = null
- -
-
Channel id returned by self::getInteractiveChannelId()
-
-
-
-
-
-
-
-
- -
- see
-
- -
- SSH2::read()
-
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
- -
- throws
-
- -
- InsufficientSetupException
-
-
on unexpected channel status, possibly due to closure
-
-
-
-
-
- Return values
- void
- —
-
-
-
-
-
-
- append_log_helper()
-
-
-
-
- Logs data packet helper
-
-
- protected
- append_log_helper(int $constant, string $message_number, string $message, array<string|int, mixed> &$message_number_log, array<string|int, mixed> &$message_log, int &$log_size, resource &$realtime_log_file, bool &$realtime_log_wrap, int &$realtime_log_size) : mixed
-
-
-
- Parameters
-
- -
- $constant
- : int
-
- -
-
-
-
- -
- $message_number
- : string
-
- -
-
-
-
- -
- $message
- : string
-
- -
-
-
-
- -
- $message_number_log
- : array<string|int, mixed>
-
- -
-
-
-
- -
- $message_log
- : array<string|int, mixed>
-
- -
-
-
-
- -
- $log_size
- : int
-
- -
-
-
-
- -
- $realtime_log_file
- : resource
-
- -
-
-
-
- -
- $realtime_log_wrap
- : bool
-
- -
-
-
-
- -
- $realtime_log_size
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- define_array()
-
-
-
-
- Define Array
-
-
- protected
- static define_array(array<string|int, mixed> ...$args) : 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.
-
-
- Parameters
-
- -
- $args
- : array<string|int, mixed>
-
- -
-
-
-
-
-
-
-
-
- -
- access
-
- -
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- disconnect_helper()
-
-
-
-
- Disconnect
-
-
- protected
- disconnect_helper(int $reason) : false
-
-
-
- Parameters
-
- -
- $reason
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- false
- —
-
-
-
-
-
-
-
-
- Formats a log for printing
-
-
- protected
- 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
- —
-
-
-
-
-
-
- get_channel_packet()
-
-
-
-
- Gets channel data
-
-
- protected
- get_channel_packet(int $client_channel[, bool $skip_extended = false ]) : mixed
-
- 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
-- if the channel status is CHANNEL_CLOSE and the response was CHANNEL_CLOSE
-
-bool(false) is returned if:
-
-- if the channel status is CHANNEL_REQUEST and the response was CHANNEL_FAILURE
-
-
-
- Parameters
-
- -
- $client_channel
- : int
-
- -
-
-
-
- -
- $skip_extended
- : bool
- = false
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- open_channel()
-
-
-
-
- Opens a channel
-
-
- protected
- open_channel(string $channel[, bool $skip_extended = false ]) : bool
-
-
-
- Parameters
-
- -
- $channel
- : string
-
- -
-
-
-
- -
- $skip_extended
- : bool
- = false
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- parseAttributes()
-
-
-
-
- Parse Attributes
-
-
- protected
- parseAttributes(string &$response) : array<string|int, mixed>
-
- See '7. File Attributes' of draft-ietf-secsh-filexfer-13 for more info.
-
-
- Parameters
-
- -
- $response
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- reset_connection()
-
-
-
-
- Resets a connection for re-use
-
-
- protected
- reset_connection(int $reason) : mixed
-
-
-
- Parameters
-
- -
- $reason
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- send_binary_packet()
-
-
-
-
- Sends Binary Packets
-
-
- protected
- send_binary_packet(string $data[, string $logged = null ]) : void
-
- See '6. Binary Packet Protocol' of rfc4253 for more info.
-
-
- Parameters
-
- -
- $data
- : string
-
- -
-
-
-
- -
- $logged
- : string
- = null
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_get_binary_packet()
-
-
-
-
-
-
- Return values
- void
- —
-
-
-
-
-
-
- send_channel_packet()
-
-
-
-
- Sends channel data
-
-
- protected
- send_channel_packet(int $client_channel, string $data) : void
-
- Spans multiple SSH_MSG_CHANNEL_DATAs if appropriate
-
-
- Parameters
-
- -
- $client_channel
- : int
-
- -
-
-
-
- -
- $data
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- void
- —
-
-
-
-
-
-
- sublogin()
-
-
-
-
- Login Helper
-
-
- protected
- sublogin(string $username, string|PrivateKey|array<string|int, array<string|int, mixed>>|Agent|null ...$args) : bool
-
-
-
- Parameters
-
- -
- $username
- : string
-
- -
-
-
-
- -
- $args
- : string|PrivateKey|array<string|int, array<string|int, mixed>>|Agent|null
-
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_login_helper()
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- append_log()
-
-
-
-
- Logs data packets
-
-
- private
- append_log(string $message_number, string $message) : mixed
-
- Makes sure that only the last 1MB worth of packets will be logged
-
-
- Parameters
-
- -
- $message_number
- : string
-
- -
-
-
-
- -
- $message
- : string
-
- -
-
-
-
-
-
-
-
- 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.
-
-
- private
- static 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()
-
-
-
-
-
-
- private
- static bad_algorithm_candidate(mixed $algorithm) : mixed
-
-
- Parameters
-
- -
- $algorithm
- : mixed
-
- -
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- close_channel()
-
-
-
-
- Closes and flushes a channel
-
-
- private
- close_channel(int $client_channel[, bool $want_reply = false ]) : void
-
- \phpseclib3\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
- void
- —
-
-
-
-
-
-
- close_channel_bitmap()
-
-
-
-
- Maintains execution state bitmap in response to channel closure
-
-
- private
- close_channel_bitmap(int $client_channel) : void
-
-
-
- Parameters
-
- -
- $client_channel
- : int
-
- -
-
The channel number to maintain closure status of
-
-
-
-
-
-
-
- Return values
- void
- —
-
-
-
-
-
-
- close_handle()
-
-
-
-
- Close handle
-
-
- private
- close_handle(string $handle) : bool
-
-
-
- Parameters
-
- -
- $handle
- : string
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- comparator()
-
-
-
-
- Compares two rawlist entries using parameters set by setListOrder()
-
-
- private
- comparator(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
-
- Intended for use with uasort()
-
-
- Parameters
-
- -
- $a
- : array<string|int, mixed>
-
- -
-
-
-
- -
- $b
- : array<string|int, mixed>
-
- -
-
-
-
-
-
-
-
- Return values
- int
- —
-
-
-
-
-
-
- connect()
-
-
-
-
- Connect to an SSHv2 server
-
-
- private
- connect() : mixed
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- delete_recursive()
-
-
-
-
- Recursively deletes directories on the SFTP server
-
-
- private
- delete_recursive(string $path, int &$i) : bool
-
- Minimizes directory lookups and SSH_FXP_STATUS requests for speed.
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
- -
- $i
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- encryption_algorithm_to_crypt_instance()
-
-
-
-
- Maps an encryption algorithm name to an instance of a subclass of
-\phpseclib3\Crypt\Common\SymmetricKey.
-
-
- private
- static encryption_algorithm_to_crypt_instance(string $algorithm) : SymmetricKey|null
-
-
-
- Parameters
-
- -
- $algorithm
- : string
-
- -
-
Name of the encryption algorithm
-
-
-
-
-
-
-
- Return values
- SymmetricKey|null
- —
-
-
-
-
-
-
- encryption_algorithm_to_key_size()
-
-
-
-
- Maps an encryption algorithm name to the number of key bytes.
-
-
- private
- 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
-
-
- private
- filter(string $payload, bool $skip_channel_filter) : string|bool
-
- Because some binary packets need to be ignored...
-
-
- Parameters
-
- -
- $payload
- : string
-
- -
-
-
-
- -
- $skip_channel_filter
- : bool
-
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_get_binary_packet()
-
-
-
-
-
-
- Return values
- string|bool
- —
-
-
-
-
-
-
- generate_identifier()
-
-
-
-
- Generates the SSH identifier
-
-
- private
- 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
-
-
- private
- get_binary_packet([bool $skip_channel_filter = false ]) : bool|string
-
- See '6. Binary Packet Protocol' of rfc4253 for more info.
-
-
- Parameters
-
- -
- $skip_channel_filter
- : bool
- = false
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_send_binary_packet()
-
-
-
-
-
-
- Return values
- bool|string
- —
-
-
-
-
-
-
- get_interactive_channel()
-
-
-
-
- Return the channel to be used with read(), write(), and reset(), if none were specified
-
-
- private
- get_interactive_channel() : int
-
-
-
-
-
-
-
- -
- deprecated
-
- -
-
-
for lack of transparency in intended channel target, to be potentially replaced
-with method which guarantees open-ness of all yielded channels and throws
-error for multiple open channels
-
-
-
- -
- see
-
- -
- self::read()
-
-
-
-
- -
- see
-
- -
- self::write()
-
-
-
-
-
-
- Return values
- int
- —
-
-
-
-
-
-
- get_lstat_cache_prop()
-
-
-
-
- Return an lstat properity
-
-
- private
- get_lstat_cache_prop(string $path, string $prop) : mixed
-
- Uses cache if appropriate.
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
- -
- $prop
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- get_open_channel()
-
-
-
-
- Return an available open channel
-
-
- private
- get_open_channel() : int
-
-
-
-
-
-
- Return values
- int
- —
-
-
-
-
-
-
- get_sftp_packet()
-
-
-
-
- Receives SFTP Packets
-
-
- private
- get_sftp_packet([mixed $request_id = null ]) : string
-
- 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.
-
-
- Parameters
-
- -
- $request_id
- : mixed
- = null
- -
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_send_sftp_packet()
-
-
-
-
-
-
- Return values
- string
- —
-
-
-
-
-
-
- get_stat_cache_prop()
-
-
-
-
- Return a stat properity
-
-
- private
- get_stat_cache_prop(string $path, string $prop) : mixed
-
- Uses cache if appropriate.
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
- -
- $prop
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- get_xstat_cache_prop()
-
-
-
-
- Return a stat or lstat properity
-
-
- private
- get_xstat_cache_prop(string $path, string $prop, string $type) : mixed
-
- Uses cache if appropriate.
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
- -
- $prop
- : string
-
- -
-
-
-
- -
- $type
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- init_sftp_connection()
-
-
-
-
- (Re)initializes the SFTP channel
-
-
- private
- init_sftp_connection() : bool
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- is_channel_status_data()
-
-
-
-
- Indicates the DATA status on the given channel
-
-
- private
- is_channel_status_data(int $channel) : bool
-
-
-
- Parameters
-
- -
- $channel
- : int
-
- -
-
The channel number to evaluate
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- key_exchange()
-
-
-
-
- Key Exchange
-
-
- private
- key_exchange([string|bool $kexinit_payload_server = false ]) : bool
-
-
-
- Parameters
-
- -
- $kexinit_payload_server
- : string|bool
- = false
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
- -
- throws
-
- -
- NoSupportedAlgorithmsException
-
-
when none of the algorithms phpseclib has loaded are compatible
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- keyboard_interactive_login()
-
-
-
-
- Login via keyboard-interactive authentication
-
-
- private
- keyboard_interactive_login(string $username, string|array<string|int, mixed> $password) : bool
-
- See RFC4256 for details. This is not a full-featured keyboard-interactive authenticator.
-
-
- Parameters
-
- -
- $username
- : string
-
- -
-
-
-
- -
- $password
- : string|array<string|int, mixed>
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- keyboard_interactive_process()
-
-
-
-
- Handle the keyboard-interactive requests / responses.
-
-
- private
- keyboard_interactive_process(string|array<string|int, mixed> ...$responses) : bool
-
-
-
- Parameters
-
- -
- $responses
- : string|array<string|int, mixed>
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- logError()
-
-
-
-
- Logs errors
-
-
- private
- logError(string $response[, int $status = -1 ]) : mixed
-
-
-
- Parameters
-
- -
- $response
- : string
-
- -
-
-
-
- -
- $status
- : int
- = -1
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- login_helper()
-
-
-
-
- Login Helper
-
-
- private
- login_helper(string $username[, mixed $password = null ]) : bool
-
-
-
- Parameters
-
- -
- $username
- : string
-
- -
-
-
-
- -
- $password
- : mixed
- = null
- -
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- mac_algorithm_to_hash_instance()
-
-
-
-
- Maps an encryption algorithm name to an instance of a subclass of
-\phpseclib3\Crypt\Hash.
-
-
- private
- static mac_algorithm_to_hash_instance(string $algorithm) : array{: \phpseclib3\Crypt\Hash, : int}|null
-
-
-
- Parameters
-
- -
- $algorithm
- : string
-
- -
-
Name of the encryption algorithm
-
-
-
-
-
-
-
- Return values
- array{: \phpseclib3\Crypt\Hash, : int}|null
- —
-
-
-
-
-
-
- mkdir_helper()
-
-
-
-
- Helper function for directory creation
-
-
- private
- mkdir_helper(string $dir, int $mode) : bool
-
-
-
- Parameters
-
- -
- $dir
- : string
-
- -
-
-
-
- -
- $mode
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- nlist_helper()
-
-
-
-
- Helper method for nlist
-
-
- private
- nlist_helper(string $dir, bool $recursive, string $relativeDir) : array<string|int, mixed>|false
-
-
-
- Parameters
-
- -
- $dir
- : string
-
- -
-
-
-
- -
- $recursive
- : bool
-
- -
-
-
-
- -
- $relativeDir
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- array<string|int, mixed>|false
- —
-
-
-
-
-
-
- on_channel_open()
-
-
-
-
- Helper function for agent->on_channel_open()
-
-
- private
- 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
- —
-
-
-
-
-
-
- parseLongname()
-
-
-
-
- Parse Longname
-
-
- private
- parseLongname(string $longname) : mixed
-
- 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
-SFTPv4 type constants.
-If the longname is in an unrecognized format bool(false) is returned.
-
-
- Parameters
-
- -
- $longname
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- parseMode()
-
-
-
-
- Attempt to identify the file type
-
-
- private
- parseMode(int $mode) : int
-
- Quoting the SFTP RFC, "Implementations MUST NOT send bits that are not defined" but they seem to anyway
-
-
- Parameters
-
- -
- $mode
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- int
- —
-
-
-
-
-
-
- parseTime()
-
-
-
-
- Parse Time
-
-
- private
- parseTime(string $key, int $flags, string &$response) : array<string|int, mixed>
-
- See '7.7. Times' of draft-ietf-secsh-filexfer-13 for more info.
-
-
- Parameters
-
- -
- $key
- : string
-
- -
-
-
-
- -
- $flags
- : int
-
- -
-
-
-
- -
- $response
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- array<string|int, mixed>
- —
-
-
-
-
-
-
- partial_init_sftp_connection()
-
-
-
-
- Partially initialize an SFTP connection
-
-
- private
- partial_init_sftp_connection() : bool
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- precheck()
-
-
-
-
- Check a few things before SFTP functions are called
-
-
- private
- precheck() : bool
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- privatekey_login()
-
-
-
-
- Login with an RSA private key
-
-
- private
- privatekey_login(string $username, PrivateKey $privatekey) : bool
-
-
-
- Parameters
-
- -
- $username
- : string
-
- -
-
-
-
- -
- $privatekey
- : PrivateKey
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- RuntimeException
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- query_stat_cache()
-
-
-
-
- Checks cache for path
-
-
- private
- query_stat_cache(string $path) : mixed
-
- Mainly used by file_exists
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- read_put_responses()
-
-
-
-
- Reads multiple successive SSH_FXP_WRITE responses
-
-
- private
- read_put_responses(int $i) : bool
-
- 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.
-
-
- Parameters
-
- -
- $i
- : int
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- read_remaining_bytes()
-
-
-
-
- Read Remaining Bytes
-
-
- private
- read_remaining_bytes(int $remaining_length) : string
-
-
-
- Parameters
-
- -
- $remaining_length
- : int
-
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::get_binary_packet()
-
-
-
-
-
-
- Return values
- string
- —
-
-
-
-
-
-
- readlist()
-
-
-
-
- Reads a list, be it detailed or not, of files in the given directory
-
-
- private
- readlist(string $dir[, bool $raw = true ]) : array<string|int, mixed>|false
-
-
-
- Parameters
-
- -
- $dir
- : string
-
- -
-
-
-
- -
- $raw
- : bool
- = true
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- array<string|int, mixed>|false
- —
-
-
-
-
-
-
- reconnect()
-
-
-
-
- In situ reconnect method
-
-
- private
- reconnect() : bool
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- recursiveFilesize()
-
-
-
-
- Recursively go through rawlist() output to get the total filesize
-
-
- private
- static recursiveFilesize(array<string|int, mixed> $files) : int
-
-
-
- Parameters
-
- -
- $files
- : array<string|int, mixed>
-
- -
-
-
-
-
-
-
- Return values
- int
- —
-
-
-
-
-
-
- remove_from_stat_cache()
-
-
-
-
- Remove files / directories from cache
-
-
- private
- remove_from_stat_cache(string $path) : bool
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- send_sftp_packet()
-
-
-
-
- Sends SFTP Packets
-
-
- private
- send_sftp_packet(int $type, string $data[, int $request_id = 1 ]) : void
-
- See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.
-
-
- Parameters
-
- -
- $type
- : int
-
- -
-
-
-
- -
- $data
- : string
-
- -
-
-
-
- -
- $request_id
- : int
- = 1
- -
-
-
-
-
-
-
-
-
- -
- see
-
- -
- self::_get_sftp_packet()
-
-
-
-
- -
- see
-
- -
- self::send_channel_packet()
-
-
-
-
-
-
- Return values
- void
- —
-
-
-
-
-
-
- setstat()
-
-
-
-
- Sets information about a file
-
-
- private
- setstat(string $filename, string $attr, bool $recursive) : bool
-
-
-
- Parameters
-
- -
- $filename
- : string
-
- -
-
-
-
- -
- $attr
- : string
-
- -
-
-
-
- -
- $recursive
- : bool
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- setstat_recursive()
-
-
-
-
- Recursively sets information on directories on the SFTP server
-
-
- private
- setstat_recursive(string $path, string $attr, int &$i) : bool
-
- Minimizes directory lookups and SSH_FXP_STATUS requests for speed.
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
- -
- $attr
- : string
-
- -
-
-
-
- -
- $i
- : int
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- ssh_agent_login()
-
-
-
-
- Login with an ssh-agent provided key
-
-
- private
- ssh_agent_login(string $username, Agent $agent) : bool
-
-
-
- Parameters
-
- -
- $username
- : string
-
- -
-
-
-
- -
- $agent
- : Agent
-
- -
-
-
-
-
-
-
-
- Return values
- bool
- —
-
-
-
-
-
-
- stat_helper()
-
-
-
-
- Returns general information about a file or symbolic link
-
-
- private
- stat_helper(string $filename, int $type) : array<string|int, mixed>|false
-
- Determines information without calling \phpseclib3\Net\SFTP::realpath().
-The second parameter can be either NET_SFTP_STAT or NET_SFTP_LSTAT.
-
-
- Parameters
-
- -
- $filename
- : string
-
- -
-
-
-
- -
- $type
- : int
-
- -
-
-
-
-
-
-
-
-
- -
- throws
-
- -
- UnexpectedValueException
-
-
on receipt of unexpected packets
-
-
-
-
-
- Return values
- array<string|int, mixed>|false
- —
-
-
-
-
-
-
- stream_select()
-
-
-
-
- stream_select wrapper
-
-
- private
- static stream_select(mixed &$read, mixed &$write, mixed &$except, mixed $seconds[, mixed $microseconds = null ]) : mixed
-
- Quoting https://stackoverflow.com/a/14262151/569976,
-"The general approach to EINTR is to simply handle the error and retry the operation again"
-This wrapper does that loop
-
-
- Parameters
-
- -
- $read
- : mixed
-
- -
-
-
- -
- $write
- : mixed
-
- -
-
-
- -
- $except
- : mixed
-
- -
-
-
- -
- $seconds
- : mixed
-
- -
-
-
- -
- $microseconds
- : mixed
- = null
- -
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- update_stat_cache()
-
-
-
-
- Save files / directories to cache
-
-
- private
- update_stat_cache(string $path, mixed $value) : mixed
-
-
-
- Parameters
-
- -
- $path
- : string
-
- -
-
-
-
- -
- $value
- : mixed
-
- -
-
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- updateLogHistory()
-
-
-
-
-
-
- private
- updateLogHistory(mixed $old, mixed $new) : mixed
-
-
- Parameters
-
- -
- $old
- : mixed
-
- -
-
-
- -
- $new
- : mixed
-
- -
-
-
-
-
-
-
- Return values
- mixed
- —
-
-
-
-
-
-
- 
- 