SecLibGateway
class SecLibGateway implements GatewayInterface (View source)
Properties
| protected string | $host | The host name of the server. |
|
| protected int | $port | The SSH port on the server. |
|
| protected array | $auth | The authentication credential set. |
|
| protected Filesystem | $files | The filesystem instance. |
|
| protected Net_SFTP | $connection | The SecLib connection instance. |
Methods
Set the host and port from a full host string.
Connect to the SSH server.
Determine if the gateway is connected.
Run a command against the server (non-blocking).
Download the contents of a remote file.
Get the contents of a remote file.
Upload a local file to the server.
Upload a string to to the given file on the server.
Get the next line of output from the server.
Get the authentication object for login.
Determine if an RSA key is configured.
Load the RSA key instance.
Read the contents of the RSA key.
Create a new RSA key instance.
Determine if the SSH Agent should provide an RSA key.
Get a new SSH Agent instance.
Get a new RSA key instance.
Get the exit status of the last command.
Get the host used by the gateway.
Get the port used by the gateway.
Get the underlying Net_SFTP connection.
Details
void
__construct(string $host, array $auth, Filesystem $files)
Create a new gateway implementation.
protected void
setHostAndPort(string $host)
Set the host and port from a full host string.
void
connect(string $username)
Connect to the SSH server.
bool
connected()
Determine if the gateway is connected.
void
run(string $command)
Run a command against the server (non-blocking).
void
get(string $remote, string $local)
Download the contents of a remote file.
string
getString(string $remote)
Get the contents of a remote file.
void
put(string $local, string $remote)
Upload a local file to the server.
void
putString(string $remote, string $contents)
Upload a string to to the given file on the server.
string|null
nextLine()
Get the next line of output from the server.
protected Crypt_RSA|System_SSH_Agent|string
getAuthForLogin()
Get the authentication object for login.
protected bool
hasRsaKey()
Determine if an RSA key is configured.
protected Crypt_RSA
loadRsaKey(array $auth)
Load the RSA key instance.
protected string
readRsaKey(array $auth)
Read the contents of the RSA key.
protected Crypt_RSA
getKey(array $auth)
Create a new RSA key instance.
protected bool
useAgent()
Determine if the SSH Agent should provide an RSA key.
System_SSH_Agent
getAgent()
Get a new SSH Agent instance.
Crypt_RSA
getNewKey()
Get a new RSA key instance.
int|bool
status()
Get the exit status of the last command.
string
getHost()
Get the host used by the gateway.
int
getPort()
Get the port used by the gateway.
Net_SFTP
getConnection()
Get the underlying Net_SFTP connection.