mainwp/mainwp.dev
1
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/mainwp/mainwp.dev.git synced 2026-07-16 14:53:06 +08:00
Code Issues Projects Packages Activity Actions
mainwp.dev/source-code/child/classes/phpseclib3-System-SSH-Agent.html
Dennis Dornon 5169eec27d Adding Pronamic WordPress Documentor for Hooks
2025-03-17 19:02:54 -04:00

1422 lines
68 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>MainWP Child Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">MainWP Child Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/mainwp.html" class="">MainWP</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/mainwp-child.html" class="">Child</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/paragonie.html" class="">ParagonIE</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/paragonie-constanttime.html" class="">ConstantTime</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/phpseclib3.html" class="">phpseclib3</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/phpseclib3-common.html" class="">Common</a>
</li>
<li>
<a href="namespaces/phpseclib3-crypt.html" class="">Crypt</a>
</li>
<li>
<a href="namespaces/phpseclib3-exception.html" class="">Exception</a>
</li>
<li>
<a href="namespaces/phpseclib3-file.html" class="">File</a>
</li>
<li>
<a href="namespaces/phpseclib3-math.html" class="">Math</a>
</li>
<li>
<a href="namespaces/phpseclib3-net.html" class="">Net</a>
</li>
<li>
<a href="namespaces/phpseclib3-system.html" class="">System</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/MainWP.html" class="">MainWP</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/MainWP-Child.html" class="">Child</a>
</li>
<li>
<a href="packages/MainWP-ChildCreditsPlugin.html" class="">ChildCreditsPlugin</a>
</li>
<li>
<a href="packages/MainWP-Dashboard.html" class="">Dashboard</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/MainWPChild.html" class="">MainWPChild</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/ParagonIE.html" class="">ParagonIE</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/ParagonIE-ConstantTime.html" class="">ConstantTime</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -reports">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3.html">phpseclib3</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3-system.html">System</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3-system-ssh.html">SSH</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Agent
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP.html">MainWP</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP-Child.html">Child</a></li>
</ul>
</div>
<span class="phpdocumentor-element__extends">
uses
<a href="classes/phpseclib3-System-SSH-Common-Traits-ReadBytes.html"><abbr title="\phpseclib3\System\SSH\Common\Traits\ReadBytes">ReadBytes</abbr></a> </span>
</h2>
<div class="phpdocumentor-label-line">
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.49" class="phpdocumentor-element-found-in__source" data-line="49" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Pure-PHP ssh-agent client identity factory</p>
<section class="phpdocumentor-description"><p>requestIdentities() method pumps out \phpseclib3\System\SSH\Agent\Identity objects</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/phpseclib3-System-SSH-Agent.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Jim Wigginton <a href="mailto:terrafrost@php.net">terrafrost@php.net</a></p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/phpseclib3-System-SSH-Agent.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-constants">
Constants
<a href="classes/phpseclib3-System-SSH-Agent.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_ACTIVE">FORWARD_ACTIVE</a>
<span>
&nbsp;= 2 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_NONE">FORWARD_NONE</a>
<span>
&nbsp;= 0 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_REQUEST">FORWARD_REQUEST</a>
<span>
&nbsp;= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_FAILURE">SSH_AGENT_FAILURE</a>
<span>
&nbsp;= 5 </span>
</dt>
<dd>Unused</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_IDENTITIES_ANSWER">SSH_AGENT_IDENTITIES_ANSWER</a>
<span>
&nbsp;= 12 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_SIGN_RESPONSE">SSH_AGENT_SIGN_RESPONSE</a>
<span>
&nbsp;= 14 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENTC_REQUEST_IDENTITIES">SSH_AGENTC_REQUEST_IDENTITIES</a>
<span>
&nbsp;= 11 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENTC_SIGN_REQUEST">SSH_AGENTC_SIGN_REQUEST</a>
<span>
&nbsp;= 13 </span>
</dt>
</dl>
<h4 id="toc-properties">
Properties
<a href="classes/phpseclib3-System-SSH-Agent.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#property_expected_bytes">$expected_bytes</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Tracking the number of bytes we are expecting
to arrive for the agent socket on the SSH data
channel</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#property_forward_status">$forward_status</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Agent forwarding status</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#property_fsock">$fsock</a>
<span>
&nbsp;: resource </span>
</dt>
<dd>Socket Resource</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#property_socket_buffer">$socket_buffer</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Buffer for accumulating forwarded authentication
agent data arriving on SSH data channel destined
for agent unix socket</dd>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/phpseclib3-System-SSH-Agent.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#method___construct">__construct()</a>
<span>
&nbsp;: <a href="classes/phpseclib3-System-SSH-Agent.html"><abbr title="\phpseclib3\System\SSH\Agent">Agent</abbr></a> </span>
</dt>
<dd>Default Constructor</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#method_forwardData">forwardData()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Forward data to SSH Agent and return data reply</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-System-SSH-Common-Traits-ReadBytes.html#method_readBytes">readBytes()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Read data</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#method_registerChannelOpen">registerChannelOpen()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>On successful channel open</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#method_requestIdentities">requestIdentities()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Request Identities</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#method_startSSHForwarding">startSSHForwarding()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Signal that agent forwarding should
be requested when a channel is opened</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a class="" href="classes/phpseclib3-System-SSH-Agent.html#method_request_forwarding">request_forwarding()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Request agent forwarding of remote server</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/phpseclib3-System-SSH-Agent.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_FORWARD_ACTIVE">
FORWARD_ACTIVE
<a href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_ACTIVE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">FORWARD_ACTIVE</span>
= <span class="phpdocumentor-signature__default-value">2</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_FORWARD_NONE">
FORWARD_NONE
<a href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_NONE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.67" class="phpdocumentor-element-found-in__source" data-line="67" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">FORWARD_NONE</span>
= <span class="phpdocumentor-signature__default-value">0</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_FORWARD_REQUEST">
FORWARD_REQUEST
<a href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_REQUEST" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.69" class="phpdocumentor-element-found-in__source" data-line="69" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">FORWARD_REQUEST</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_SSH_AGENT_FAILURE">
SSH_AGENT_FAILURE
<a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_FAILURE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.76" class="phpdocumentor-element-found-in__source" data-line="76" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Unused</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">SSH_AGENT_FAILURE</span>
= <span class="phpdocumentor-signature__default-value">5</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_SSH_AGENT_IDENTITIES_ANSWER">
SSH_AGENT_IDENTITIES_ANSWER
<a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_IDENTITIES_ANSWER" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.58" class="phpdocumentor-element-found-in__source" data-line="58" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">SSH_AGENT_IDENTITIES_ANSWER</span>
= <span class="phpdocumentor-signature__default-value">12</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_SSH_AGENT_SIGN_RESPONSE">
SSH_AGENT_SIGN_RESPONSE
<a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_SIGN_RESPONSE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.62" class="phpdocumentor-element-found-in__source" data-line="62" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">SSH_AGENT_SIGN_RESPONSE</span>
= <span class="phpdocumentor-signature__default-value">14</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_SSH_AGENTC_REQUEST_IDENTITIES">
SSH_AGENTC_REQUEST_IDENTITIES
<a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENTC_REQUEST_IDENTITIES" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.56" class="phpdocumentor-element-found-in__source" data-line="56" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">SSH_AGENTC_REQUEST_IDENTITIES</span>
= <span class="phpdocumentor-signature__default-value">11</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_SSH_AGENTC_SIGN_REQUEST">
SSH_AGENTC_SIGN_REQUEST
<a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENTC_SIGN_REQUEST" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.60" class="phpdocumentor-element-found-in__source" data-line="60" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">SSH_AGENTC_SIGN_REQUEST</span>
= <span class="phpdocumentor-signature__default-value">13</span>
</code>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/phpseclib3-System-SSH-Agent.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_expected_bytes">
$expected_bytes
<a href="classes/phpseclib3-System-SSH-Agent.html#property_expected_bytes" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.108" class="phpdocumentor-element-found-in__source" data-line="108" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Tracking the number of bytes we are expecting
to arrive for the agent socket on the SSH data
channel</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$expected_bytes</span>
= <span class="phpdocumentor-signature__default-value">0</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_forward_status">
$forward_status
<a href="classes/phpseclib3-System-SSH-Agent.html#property_forward_status" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.90" class="phpdocumentor-element-found-in__source" data-line="90" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Agent forwarding status</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$forward_status</span>
= <span class="phpdocumentor-signature__default-value">self::FORWARD_NONE</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_fsock">
$fsock
<a href="classes/phpseclib3-System-SSH-Agent.html#property_fsock" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.83" class="phpdocumentor-element-found-in__source" data-line="83" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Socket Resource</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">resource</span>
<span class="phpdocumentor-signature__name">$fsock</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_socket_buffer">
$socket_buffer
<a href="classes/phpseclib3-System-SSH-Agent.html#property_socket_buffer" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">99</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.99" class="phpdocumentor-element-found-in__source" data-line="99" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Buffer for accumulating forwarded authentication
agent data arriving on SSH data channel destined
for agent unix socket</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$socket_buffer</span>
= <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/phpseclib3-System-SSH-Agent.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/phpseclib3-System-SSH-Agent.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">117</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.117" class="phpdocumentor-element-found-in__source" data-line="117" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Default Constructor</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$address</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/phpseclib3-System-SSH-Agent.html"><abbr title="\phpseclib3\System\SSH\Agent">Agent</abbr></a></span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$address</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/phpseclib3-System-SSH-Agent.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/phpseclib3-Exception-BadConfigurationException.html"><abbr title="\phpseclib3\Exception\BadConfigurationException">BadConfigurationException</abbr></a></span>
<section class="phpdocumentor-description"><p>if SSH_AUTH_SOCK cannot be found</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>on connection errors</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/phpseclib3-System-SSH-Agent.html"><abbr title="\phpseclib3\System\SSH\Agent">Agent</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_forwardData">
forwardData()
<a href="classes/phpseclib3-System-SSH-Agent.html#method_forwardData" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">257</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.257" class="phpdocumentor-element-found-in__source" data-line="257" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Forward data to SSH Agent and return data reply</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">forwardData</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/phpseclib3-System-SSH-Agent.html#method_forwardData#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>on connection errors</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>Data from SSH Agent</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_readBytes">
readBytes()
<a href="classes/phpseclib3-System-SSH-Common-Traits-ReadBytes.html#method_readBytes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Common/Traits/ReadBytes.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-common-traits-readbytes.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Common/Traits/ReadBytes.php">ReadBytes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.29" class="phpdocumentor-element-found-in__source" data-line="29" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Common/Traits/ReadBytes.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Read data</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">readBytes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$length</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$length</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/phpseclib3-System-SSH-Common-Traits-ReadBytes.html#method_readBytes#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>on connection errors</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_registerChannelOpen">
registerChannelOpen()
<a href="classes/phpseclib3-System-SSH-Agent.html#method_registerChannelOpen" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">243</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.243" class="phpdocumentor-element-found-in__source" data-line="243" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">On successful channel open</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">registerChannelOpen</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Net-SSH2.html"><abbr title="\phpseclib3\Net\SSH2">SSH2</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$ssh</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>This method is called upon successful channel
open to give the SSH Agent an opportunity
to take further action. i.e. request agent forwarding</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$ssh</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Net-SSH2.html"><abbr title="\phpseclib3\Net\SSH2">SSH2</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_requestIdentities">
requestIdentities()
<a href="classes/phpseclib3-System-SSH-Agent.html#method_requestIdentities" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">158</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.158" class="phpdocumentor-element-found-in__source" data-line="158" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Request Identities</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">requestIdentities</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>See &quot;2.5.2 Requesting a list of protocol 2 keys&quot;
Returns an array containing zero or more \phpseclib3\System\SSH\Agent\Identity objects</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/phpseclib3-System-SSH-Agent.html#method_requestIdentities#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>on receipt of unexpected packets</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_startSSHForwarding">
startSSHForwarding()
<a href="classes/phpseclib3-System-SSH-Agent.html#method_startSSHForwarding" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">210</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.210" class="phpdocumentor-element-found-in__source" data-line="210" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Signal that agent forwarding should
be requested when a channel is opened</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">startSSHForwarding</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
</div>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_request_forwarding">
request_forwarding()
<a href="classes/phpseclib3-System-SSH-Agent.html#method_request_forwarding" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-system-ssh-agent.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php">Agent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">223</span>
<a href="classes/phpseclib3-System-SSH-Agent.html#source-view.223" class="phpdocumentor-element-found-in__source" data-line="223" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Request agent forwarding of remote server</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">request_forwarding</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Net-SSH2.html"><abbr title="\phpseclib3\Net\SSH2">SSH2</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$ssh</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$ssh</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/phpseclib3-Net-SSH2.html"><abbr title="\phpseclib3\Net\SSH2">SSH2</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/System/SSH/Agent.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/phpseclib3-System-SSH-Agent.html#toc-constants">Constants</a></li>
<li><a href="classes/phpseclib3-System-SSH-Agent.html#toc-properties">Properties</a></li>
<li><a href="classes/phpseclib3-System-SSH-Agent.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Constants</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_ACTIVE">FORWARD_ACTIVE</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_NONE">FORWARD_NONE</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#constant_FORWARD_REQUEST">FORWARD_REQUEST</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_FAILURE">SSH_AGENT_FAILURE</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_IDENTITIES_ANSWER">SSH_AGENT_IDENTITIES_ANSWER</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENT_SIGN_RESPONSE">SSH_AGENT_SIGN_RESPONSE</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENTC_REQUEST_IDENTITIES">SSH_AGENTC_REQUEST_IDENTITIES</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#constant_SSH_AGENTC_SIGN_REQUEST">SSH_AGENTC_SIGN_REQUEST</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#property_expected_bytes">$expected_bytes</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#property_forward_status">$forward_status</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#property_fsock">$fsock</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#property_socket_buffer">$socket_buffer</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#method___construct">__construct()</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#method_forwardData">forwardData()</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Common-Traits-ReadBytes.html#method_readBytes">readBytes()</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#method_registerChannelOpen">registerChannelOpen()</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#method_requestIdentities">requestIdentities()</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#method_startSSHForwarding">startSSHForwarding()</a></li>
<li class=""><a href="classes/phpseclib3-System-SSH-Agent.html#method_request_forwarding">request_forwarding()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/phpseclib3-System-SSH-Agent.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink