<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Initialize Publickey subsystem</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-publickey-add.html">ssh2_publickey_add</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-publickey-list.html">ssh2_publickey_list</a></div>
<div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ssh2-publickey-init" class="refentry">
<div class="refnamediv">
<h1 class="refname">ssh2_publickey_init</h1>
<p class="verinfo">(PECL ssh2 >= 0.10)</p><p class="refpurpose"><span class="refname">ssh2_publickey_init</span> — <span class="dc-title">
Initialize Publickey subsystem
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ssh2-publickey-init-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>ssh2_publickey_init</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$session</code></span>
)</div>
<p class="para rdfs-comment">
Request the Publickey subsystem from an already connected SSH2 server.
</p>
<p class="para">
The publickey subsystem allows an already connected and authenticated
client to manage the list of authorized public keys stored on the
target server in an implementation agnostic manner.
If the remote server does not support the publickey subsystem,
the <span class="function"><strong>ssh2_publickey_init()</strong></span> function will return <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ssh2-publickey-init-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">session</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ssh2-publickey-init-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an <em>SSH2 Publickey Subsystem</em> resource for use
with all other ssh2_publickey_*() methods or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.ssh2-publickey-init-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">The public key subsystem
is used for managing public keys on a server to which the client is
<em class="emphasis">already</em> authenticated. To authenticate to a remote system
using public key authentication, use the
<span class="function"><a href="function.ssh2-auth-pubkey-file.html" class="function">ssh2_auth_pubkey_file()</a></span> function instead.</span></p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.ssh2-publickey-init-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ssh2-publickey-add.html" class="function" rel="rdfs-seeAlso">ssh2_publickey_add()</a> - Add an authorized publickey</span></li>
<li class="member"> <span class="function"><a href="function.ssh2-publickey-remove.html" class="function" rel="rdfs-seeAlso">ssh2_publickey_remove()</a> - Remove an authorized publickey</span></li>
<li class="member"> <span class="function"><a href="function.ssh2-publickey-list.html" class="function" rel="rdfs-seeAlso">ssh2_publickey_list()</a> - List currently authorized publickeys</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-publickey-add.html">ssh2_publickey_add</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-publickey-list.html">ssh2_publickey_list</a></div>
<div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
