Collaboration diagram for phpseclib\System\SSH\Agent:

Public Member Functions
	__construct ()
	Default Constructor. More...

	requestIdentities ()
	Request Identities. More...

	startSSHForwarding ($ssh)
	Signal that agent forwarding should be requested when a channel is opened. More...

	_request_forwarding ($ssh)
	Request agent forwarding of remote server. More...

	_on_channel_open ($ssh)
	On successful channel open. More...

	_forward_data ($data)
	Forward data to SSH Agent and return data reply. More...

Data Fields
const	SSH_AGENTC_REQUEST_IDENTITIES = 11
	#+ Message numbers More...

const	SSH_AGENT_IDENTITIES_ANSWER = 12

const	SSH_AGENTC_SIGN_REQUEST = 13

const	SSH_AGENT_SIGN_RESPONSE = 14

const	FORWARD_NONE = 0
	#- More...

const	FORWARD_REQUEST = 1

const	FORWARD_ACTIVE = 2

const	SSH_AGENT_FAILURE = 5
	#- More...

	$fsock

	$forward_status = self::FORWARD_NONE
	Agent forwarding status. More...

	$socket_buffer = ''
	Buffer for accumulating forwarded authentication agent data arriving on SSH data channel destined for agent unix socket. More...

	$expected_bytes = 0
	Tracking the number of bytes we are expecting to arrive for the agent socket on the SSH data channel. More...

Detailed Description

Definition at line 48 of file Agent.php.

Constructor & Destructor Documentation

◆ __construct()

phpseclib\System\SSH\Agent::__construct ( )

Default Constructor.

Returns: \phpseclib\System\SSH\Agent @access public

Definition at line 120 of file Agent.php.

    {
        switch (true) {
            case isset($_SERVER['SSH_AUTH_SOCK']):
                $address = $_SERVER['SSH_AUTH_SOCK'];
                break;
            case isset($_ENV['SSH_AUTH_SOCK']):
                $address = $_ENV['SSH_AUTH_SOCK'];
                break;
            default:
                user_error('SSH_AUTH_SOCK not found');
                return false;
        }
 
        $this->fsock = fsockopen('unix://' . $address, 0, $errno, $errstr);
        if (!$this->fsock) {
            user_error("Unable to connect to ssh-agent (Error $errno: $errstr)");
        }
    }

References $_SERVER.

Member Function Documentation

◆ _forward_data()

phpseclib\System\SSH\Agent::_forward_data ( $data )

Forward data to SSH Agent and return data reply.

Parameters

string $data

Returns: data from SSH Agent @access private

Definition at line 278 of file Agent.php.

    {
        if ($this->expected_bytes > 0) {
            $this->socket_buffer.= $data;
            $this->expected_bytes -= strlen($data);
        } else {
            $agent_data_bytes = current(unpack('N', $data));
            $current_data_bytes = strlen($data);
            $this->socket_buffer = $data;
            if ($current_data_bytes != $agent_data_bytes + 4) {
                $this->expected_bytes = ($agent_data_bytes + 4) - $current_data_bytes;
                return false;
            }
        }
 
        if (strlen($this->socket_buffer) != fwrite($this->fsock, $this->socket_buffer)) {
            user_error('Connection closed attempting to forward data to SSH agent');
        }
 
        $this->socket_buffer = '';
        $this->expected_bytes = 0;
 
        $agent_reply_bytes = current(unpack('N', fread($this->fsock, 4)));
 
        $agent_reply_data = fread($this->fsock, $agent_reply_bytes);
        $agent_reply_data = current(unpack('a*', $agent_reply_data));
 
        return pack('Na*', $agent_reply_bytes, $agent_reply_data);
    }

References $data.

◆ _on_channel_open()

phpseclib\System\SSH\Agent::_on_channel_open ( $ssh )

On successful channel open.

This method is called upon successful channel open to give the SSH Agent an opportunity to take further action. i.e. request agent forwarding

Parameters

Net_SSH2 $ssh @access private

Definition at line 264 of file Agent.php.

    {
        if ($this->forward_status == self::FORWARD_REQUEST) {
            $this->_request_forwarding($ssh);
        }
    }

References phpseclib\System\SSH\Agent\_request_forwarding().

Here is the call graph for this function:

◆ _request_forwarding()

phpseclib\System\SSH\Agent::_request_forwarding ( $ssh )

Request agent forwarding of remote server.

Parameters

Net_SSH2 $ssh

Returns: bool @access private

Definition at line 221 of file Agent.php.

    {
        $request_channel = $ssh->_get_open_channel();
        if ($request_channel === false) {
            return false;
        }
 
        $packet = pack(
            'CNNa*C',
            NET_SSH2_MSG_CHANNEL_REQUEST,
            $ssh->server_channels[$request_channel],
            strlen('auth-agent-req@openssh.com'),
            'auth-agent-req@openssh.com',
            1
        );
 
        $ssh->channel_status[$request_channel] = NET_SSH2_MSG_CHANNEL_REQUEST;
 
        if (!$ssh->_send_binary_packet($packet)) {
            return false;
        }
 
        $response = $ssh->_get_channel_packet($request_channel);
        if ($response === false) {
            return false;
        }
 
        $ssh->channel_status[$request_channel] = NET_SSH2_MSG_CHANNEL_OPEN;
        $this->forward_status = self::FORWARD_ACTIVE;
 
        return true;
    }

References $response, and phpseclib\System\SSH\Agent\FORWARD_ACTIVE.

Referenced by phpseclib\System\SSH\Agent\_on_channel_open().

Here is the caller graph for this function:

◆ requestIdentities()

phpseclib\System\SSH\Agent::requestIdentities ( )

Request Identities.

See "2.5.2 Requesting a list of protocol 2 keys" Returns an array containing zero or more \phpseclib\System\SSH\Agent\Identity objects

Returns: array @access public

Definition at line 149 of file Agent.php.

    {
        if (!$this->fsock) {
            return array();
        }
 
        $packet = pack('NC', 1, self::SSH_AGENTC_REQUEST_IDENTITIES);
        if (strlen($packet) != fputs($this->fsock, $packet)) {
            user_error('Connection closed while requesting identities');
        }
 
        $length = current(unpack('N', fread($this->fsock, 4)));
        $type = ord(fread($this->fsock, 1));
        if ($type != self::SSH_AGENT_IDENTITIES_ANSWER) {
            user_error('Unable to request identities');
        }
 
        $identities = array();
        $keyCount = current(unpack('N', fread($this->fsock, 4)));
        for ($i = 0; $i < $keyCount; $i++) {
            $length = current(unpack('N', fread($this->fsock, 4)));
            $key_blob = fread($this->fsock, $length);
            $length = current(unpack('N', fread($this->fsock, 4)));
            if ($length) {
                $key_comment = fread($this->fsock, $length);
            }
            $length = current(unpack('N', substr($key_blob, 0, 4)));
            $key_type = substr($key_blob, 4, $length);
            switch ($key_type) {
                case 'ssh-rsa':
                    $key = new RSA();
                    $key->loadKey('ssh-rsa ' . base64_encode($key_blob) . ' ' . $key_comment);
                    break;
                case 'ssh-dss':
                    // not currently supported
                    break;
            }
            // resources are passed by reference by default
            if (isset($key)) {
                $identity = new Identity($this->fsock);
                $identity->setPublicKey($key);
                $identity->setPublicKeyBlob($key_blob);
                $identities[] = $identity;
                unset($key);
            }
        }
 
        return $identities;
    }

References $i, $key, and $type.

◆ startSSHForwarding()

phpseclib\System\SSH\Agent::startSSHForwarding ( $ssh )

Signal that agent forwarding should be requested when a channel is opened.

Parameters

Net_SSH2 $ssh

Returns: bool @access public

Definition at line 207 of file Agent.php.

    {
        if ($this->forward_status == self::FORWARD_NONE) {
            $this->forward_status = self::FORWARD_REQUEST;
        }
    }

References phpseclib\System\SSH\Agent\FORWARD_REQUEST.

Field Documentation

◆ $expected_bytes

phpseclib\System\SSH\Agent::$expected_bytes = 0

Tracking the number of bytes we are expecting to arrive for the agent socket on the SSH data channel.

Definition at line 112 of file Agent.php.

◆ $forward_status

phpseclib\System\SSH\Agent::$forward_status = self::FORWARD_NONE

Agent forwarding status.

@access private

Definition at line 96 of file Agent.php.

◆ $fsock

phpseclib\System\SSH\Agent::$fsock

Definition at line 89 of file Agent.php.

◆ $socket_buffer

phpseclib\System\SSH\Agent::$socket_buffer = ''

Buffer for accumulating forwarded authentication agent data arriving on SSH data channel destined for agent unix socket.

@access private

Definition at line 105 of file Agent.php.

◆ FORWARD_ACTIVE

const phpseclib\System\SSH\Agent::FORWARD_ACTIVE = 2

Definition at line 75 of file Agent.php.

Referenced by phpseclib\System\SSH\Agent\_request_forwarding().

◆ FORWARD_NONE

const phpseclib\System\SSH\Agent::FORWARD_NONE = 0

#-

+ Agent forwarding status

@access private

Definition at line 71 of file Agent.php.

◆ FORWARD_REQUEST

const phpseclib\System\SSH\Agent::FORWARD_REQUEST = 1

Definition at line 73 of file Agent.php.

Referenced by phpseclib\System\SSH\Agent\startSSHForwarding().

◆ SSH_AGENT_FAILURE

const phpseclib\System\SSH\Agent::SSH_AGENT_FAILURE = 5

#-

Unused

Definition at line 81 of file Agent.php.

◆ SSH_AGENT_IDENTITIES_ANSWER

const phpseclib\System\SSH\Agent::SSH_AGENT_IDENTITIES_ANSWER = 12

Definition at line 58 of file Agent.php.

◆ SSH_AGENT_SIGN_RESPONSE

const phpseclib\System\SSH\Agent::SSH_AGENT_SIGN_RESPONSE = 14

Definition at line 62 of file Agent.php.

Referenced by phpseclib\System\SSH\Agent\Identity\sign().

◆ SSH_AGENTC_REQUEST_IDENTITIES

const phpseclib\System\SSH\Agent::SSH_AGENTC_REQUEST_IDENTITIES = 11

#+ Message numbers

@access private

Definition at line 56 of file Agent.php.

◆ SSH_AGENTC_SIGN_REQUEST

const phpseclib\System\SSH\Agent::SSH_AGENTC_SIGN_REQUEST = 13

Definition at line 60 of file Agent.php.

Referenced by phpseclib\System\SSH\Agent\Identity\sign().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _forward_data()

◆ _on_channel_open()

◆ _request_forwarding()

◆ requestIdentities()

◆ startSSHForwarding()

Field Documentation

◆ $expected_bytes

◆ $forward_status

◆ $fsock

◆ $socket_buffer

◆ FORWARD_ACTIVE

◆ FORWARD_NONE

◆ FORWARD_REQUEST

◆ SSH_AGENT_FAILURE

◆ SSH_AGENT_IDENTITIES_ANSWER

◆ SSH_AGENT_SIGN_RESPONSE

◆ SSH_AGENTC_REQUEST_IDENTITIES

◆ SSH_AGENTC_SIGN_REQUEST