SSHSession.md

SSHSession

• class SSHSession (ssh\SSHSession)
• package ssh
• source ssh/SSHSession.php

Description

Class SSHSession

---

Properties

• ->clientVersion : string
• ->host : string
• ->port : int
• ->timeout : int

---

Methods

• ->__construct()
• ->setConfig()
• ->getConfig()
• ->connect()
• ->disconnect()
• ->setUserInfo() - param is:
• ->getUserInfo()
• ->setPassword()
• ->setDaemonThread()
• ->sendIgnore()
• ->sendKeepAliveMsg()
• ->rekey()
• ->exec() - Open exec channel.
• ->sftp() - Open SFTP channel.

---

Methods

__construct()

__construct(): void

---

setConfig()

setConfig(string $key, string $value): void

---

getConfig()

getConfig(string $key): string

---

connect()

connect(int $timeout): void

---

disconnect()

disconnect(): void

---

setUserInfo()

setUserInfo([ array $userInfoHandlers): void

param is: [ getPassphrase => callable(): string, getPassword => callable(): string, promptPassword => callable(string $msg): bool promptPassphrase => callable(string $msg): bool promptYesNo => callable(string $msg): bool showMessage => callable(string $msg): void ]

---

getUserInfo()

getUserInfo(): array|null

---

setPassword()

setPassword(string $password): void

---

setDaemonThread()

setDaemonThread(bool $enable): void

---

sendIgnore()

sendIgnore(): void

---

sendKeepAliveMsg()

sendKeepAliveMsg(): void

---

rekey()

rekey(): void

---

exec()

exec(): ssh\SSHExecChannel

Open exec channel.

---

sftp()

sftp(): ssh\SSHSftpChannel

Open SFTP channel.