<!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>Authenticate using a public key</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-auth-password.html">ssh2_auth_password</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-connect.html">ssh2_connect</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-auth-pubkey-file" class="refentry">
<div class="refnamediv">
<h1 class="refname">ssh2_auth_pubkey_file</h1>
<p class="verinfo">(PECL ssh2 >= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_auth_pubkey_file</span> — <span class="dc-title">Authenticate using a public key</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ssh2-auth-pubkey-file-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ssh2_auth_pubkey_file</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$session</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$username</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$pubkeyfile</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$privkeyfile</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$passphrase</code></span>
] )</div>
<p class="para rdfs-comment">
Authenticate using a public key read from a file.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ssh2-auth-pubkey-file-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">session</code></dt>
<dd>
<p class="para">
An SSH connection link identifier, obtained from a call to
<span class="function"><a href="function.ssh2-connect.html" class="function">ssh2_connect()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">username</code></dt>
<dd>
<p class="para">
</p>
</dd>
<dt>
<code class="parameter">pubkeyfile</code></dt>
<dd>
<p class="para">
The public key file needs to be in OpenSSH's format. It should look something like:
</p>
<p class="para">
ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
</p>
</dd>
<dt>
<code class="parameter">privkeyfile</code></dt>
<dd>
<p class="para">
</p>
</dd>
<dt>
<code class="parameter">passphrase</code></dt>
<dd>
<p class="para">
If <code class="parameter">privkeyfile</code> is encrypted (which it should
be), the <code class="parameter">passphrase</code> must be provided.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ssh2-auth-pubkey-file-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ssh2-auth-pubkey-file-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5747">
<p><strong>Example #1 Authentication using a public key</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$connection </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'shell.example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'hostkey'</span><span style="color: #007700">=></span><span style="color: #DD0000">'ssh-rsa'</span><span style="color: #007700">));<br /><br />if (</span><span style="color: #0000BB">ssh2_auth_pubkey_file</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'/home/username/.ssh/id_rsa.pub'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'/home/username/.ssh/id_rsa'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret'</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Public Key Authentication Successful\n"</span><span style="color: #007700">;<br />} else {<br /> die(</span><span style="color: #DD0000">'Public Key Authentication Failed'</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.ssh2-auth-pubkey-file-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
The underlying libssh library doesn't support partial auths very cleanly
That is, if you need to supply both a public key and a password it will
appear as if this function has failed. In this particular case a failure
from this call may just mean that auth hasn't been completed yet. You
would need to ignore this failure and continue on and call
<span class="function"><a href="function.ssh2-auth-password.html" class="function">ssh2_auth_password()</a></span> in order to complete
authentication.
</p>
</p></blockquote>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-auth-password.html">ssh2_auth_password</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-connect.html">ssh2_connect</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>
