Skip to content

Document ssh2_auth_pubkey() from pecl/ssh2 v1.4 #5010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cweiske wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document ssh2_auth_pubkey() from pecl/ssh2 v1.4 #5010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions reference/ssh2/functions/ssh2-auth-pubkey-file.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey-file">
<refnamediv>
<refname>ssh2_auth_pubkey_file</refname>
<refpurpose>Authenticate using a public key</refpurpose>
<refpurpose>Authenticate using a public key read from a file</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand Down Expand Up @@ -37,6 +37,7 @@
<term><parameter>username</parameter></term>
<listitem>
<simpara>
Name of the user to authenticate as on the remote server.
</simpara>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -103,7 +104,7 @@ if (ssh2_auth_pubkey_file($connection, 'username',
&reftitle.notes;
<note>
<simpara>
The underlying libssh library doesn't support partial auths very cleanly
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
Expand All @@ -114,6 +115,13 @@ if (ssh2_auth_pubkey_file($connection, 'username',
</note>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_auth_pubkey</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
147 changes: 147 additions & 0 deletions reference/ssh2/functions/ssh2-auth-pubkey.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey">
<refnamediv>
<refname>ssh2_auth_pubkey</refname>
<refpurpose>Authenticate using a public key in a variable</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ssh2_auth_pubkey</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>pubkey</parameter></methodparam>
<methodparam><type>string</type><parameter>privkey</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
</methodsynopsis>
<simpara>
Authenticate using a public key in a variable.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<simpara>
Name of the user to authenticate as on the remote server.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pubkey</parameter></term>
<listitem>
<simpara>
Public key in OpenSSH's format. It should look something like:
<literal>ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110</literal>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privkey</parameter></term>
<listitem>
<simpara>
Private OpenSSH key. It should begin with:
<literal>-----BEGIN RSA PRIVATE KEY-----</literal>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>passphrase</parameter></term>
<listitem>
<simpara>
If <parameter>privkey</parameter> is encrypted (which it should
be), the <parameter>passphrase</parameter> must be provided.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Authentication using a public key</title>
<programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa'));
$publicKey = file_get_contents('/home/username/.ssh/id_rsa.pub');
$privateKey = file_get_contents('/home/username/.ssh/id_rsa');

if (ssh2_auth_pubkey($connection, 'username',
$publicKey,
$privateKey, 'secret')) {
echo "Public Key Authentication Successful\n";
} else {
die('Public Key Authentication Failed');
}
?>
]]>
</programlisting>
</example>
</refsect1>

<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
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
<function>ssh2_auth_password</function> in order to complete
authentication.
</simpara>
</note>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_auth_pubkey_file</function></member>
</simplelist>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
1 change: 1 addition & 0 deletions reference/ssh2/functions/ssh2-connect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ if (!$connection) die('Connection failed');
<member><function>ssh2_fingerprint</function></member>
<member><function>ssh2_auth_none</function></member>
<member><function>ssh2_auth_password</function></member>
<member><function>ssh2_auth_pubkey</function></member>
<member><function>ssh2_auth_pubkey_file</function></member>
<member><function>ssh2_disconnect</function></member>
</simplelist>
Expand Down
1 change: 1 addition & 0 deletions reference/ssh2/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<function name='ssh2_auth_hostbased_file' from='PECL ssh2 &gt;= 0.9.0'/>
<function name='ssh2_auth_none' from='PECL ssh2 &gt;= 0.9.0'/>
<function name='ssh2_auth_password' from='PECL ssh2 &gt;= 0.9.0'/>
<function name='ssh2_auth_pubkey' from='PECL ssh2 &gt;= 1.4.0'/>
<function name='ssh2_auth_pubkey_file' from='PECL ssh2 &gt;= 0.9.0'/>
<function name='ssh2_connect' from='PECL ssh2 &gt;= 0.9.0'/>
<function name='ssh2_disconnect' from='PECL ssh2 &gt;= 1.0'/>
Expand Down