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

void __construct(string $host, array $auth, Filesystem $files)

Create a new gateway implementation.
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.
Crypt_RSA|System_SSH_Agent|string getAuthForLogin()

Get the authentication object for login.
bool hasRsaKey()

Determine if an RSA key is configured.
Crypt_RSA loadRsaKey(array $auth)

Load the RSA key instance.
string readRsaKey(array $auth)

Read the contents of the RSA key.
Crypt_RSA getKey(array $auth)

Create a new RSA key instance.
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.

Details

void __construct(string $host, array $auth, Filesystem $files)

Create a new gateway implementation.

Parameters

string $host
array $auth
Filesystem $files

Return Value

void

protected void setHostAndPort(string $host)

Set the host and port from a full host string.

Parameters

string $host

Return Value

void

void connect(string $username)

Connect to the SSH server.

Parameters

string $username

Return Value

void

bool connected()

Determine if the gateway is connected.

Return Value

bool

void run(string $command)

Run a command against the server (non-blocking).

Parameters

string $command

Return Value

void

void get(string $remote, string $local)

Download the contents of a remote file.

Parameters

string $remote
string $local

Return Value

void

string getString(string $remote)

Get the contents of a remote file.

Parameters

string $remote

Return Value

string

void put(string $local, string $remote)

Upload a local file to the server.

Parameters

string $local
string $remote

Return Value

void

void putString(string $remote, string $contents)

Upload a string to to the given file on the server.

Parameters

string $remote
string $contents

Return Value

void

string|null nextLine()

Get the next line of output from the server.

Return Value

string|null

protected Crypt_RSA|System_SSH_Agent|string getAuthForLogin()

Get the authentication object for login.

Return Value

Crypt_RSA|System_SSH_Agent|string

Exceptions

InvalidArgumentException

protected bool hasRsaKey()

Determine if an RSA key is configured.

Return Value

bool

protected Crypt_RSA loadRsaKey(array $auth)

Load the RSA key instance.

Parameters

array $auth

Return Value

Crypt_RSA

protected string readRsaKey(array $auth)

Read the contents of the RSA key.

Parameters

array $auth

Return Value

string

protected Crypt_RSA getKey(array $auth)

Create a new RSA key instance.

Parameters

array $auth

Return Value

Crypt_RSA

protected bool useAgent()

Determine if the SSH Agent should provide an RSA key.

Return Value

bool

System_SSH_Agent getAgent()

Get a new SSH Agent instance.

Return Value

System_SSH_Agent

Crypt_RSA getNewKey()

Get a new RSA key instance.

Return Value

Crypt_RSA

int|bool status()

Get the exit status of the last command.

Return Value

int|bool

string getHost()

Get the host used by the gateway.

Return Value

string

int getPort()

Get the port used by the gateway.

Return Value

int

Net_SFTP getConnection()

Get the underlying Net_SFTP connection.

Return Value

Net_SFTP

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Remote/SecLibGateway.html