Skip to content

Add missing ssh2_auth_pubkey_file translation and fix EN-Revision hash #474

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
lacatoire wants to merge 2 commits into
base: master
Choose a base branch
from
+150 −0
Open

Add missing ssh2_auth_pubkey_file translation and fix EN-Revision hash #474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e35922
Add missing ssh2_auth_pubkey_file translation and fix EN-Revision hash
lacatoire Apr 4, 2026
7c54ca4
Merge branch 'php:master' into fix/missing-files-and-hash
lacatoire Apr 4, 2026
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
1 change: 1 addition & 0 deletions appendices/reserved.constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: dcd5448282973a659f62e4240fb6e50aae0eb78b Maintainer: lacatoire Status: ready -->
<!-- $Revision$ -->

<!--
Expand Down
149 changes: 149 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,149 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 74ef2355c59e814d14f75a0792d22727be72f137 Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey">
<refnamediv>
<refname>ssh2_auth_pubkey</refname>
<refpurpose>Identificación utilizando una clave pública en una 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>
Identificación utilizando una clave pública en una variable.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
Un identificador de conexión SSH, obtenido desde la función
<function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<simpara>
Nombre del usuario para autenticarse en el servidor remoto.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pubkey</parameter></term>
<listitem>
<simpara>
Clave pública en formato OpenSSH. Debe parecerse a esto:
<literal>ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110</literal>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privkey</parameter></term>
<listitem>
<simpara>
Clave privada OpenSSH. Debe comenzar con:
<literal>-----BEGIN RSA PRIVATE KEY-----</literal>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>passphrase</parameter></term>
<listitem>
<simpara>
Si <parameter>privkey</parameter> está cifrado (y debe estarlo),
la frase de paso debe ser proporcionada.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

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

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Identificación utilizando una clave pública</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>
La biblioteca libssh subyacente no soporta muy limpiamente las
autenticaciones parciales. Es decir, que si debe proporcionar a la
vez una clave pública y una contraseña, entonces parecerá como si
la función estuviera en error. En este caso particular, un error en esta
llamada puede simplemente significar que la autenticación no está aún terminada.
Debe ignorar este error y continuar con la llamada
<function>ssh2_auth_password</function> para terminar la autenticación.
</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
-->