Skip to content

Update SSH2 to En #1203

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

Merged
mmalferov merged 5 commits into from
Mar 9, 2026
Merged

Update SSH2 to En #1203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e61ef81
Create ssh2-auth-pubkey.xml
mmalferov Mar 9, 2026
18bd844
Update ssh2-auth-pubkey-file.xml to En
mmalferov Mar 9, 2026
d22d3de
Update ssh2-connect.xml to en
mmalferov Mar 9, 2026
90f180b
Update ssh2-auth-pubkey-file.xml Remove extra whitespace
mmalferov Mar 9, 2026
23c3b2e
Update ssh2-auth-pubkey.xml Remove extra whitespace
mmalferov Mar 9, 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
55 changes: 36 additions & 19 deletions reference/ssh2/functions/ssh2-auth-pubkey-file.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 12f0e72200ea9249d0fc2f118528bd24b24c44a6 Maintainer: rjhdby Status: ready -->
<!-- EN-Revision: 74ef2355c59e814d14f75a0792d22727be72f137 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey-file">
<refnamediv>
<refname>ssh2_auth_pubkey_file</refname>
<refpurpose>Аутентификация с открытым ключом</refpurpose>
<refpurpose>Аутентифицирует клиента путём считывания открытого ключа из файла</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -18,7 +18,7 @@
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
</methodsynopsis>
<simpara>
Аутентификация с открытым ключом, сохранённом в файле.
Функция аутентифицирует клиента по открытому ключу, который считывает из файла.
</simpara>
</refsect1>

Expand All @@ -29,23 +29,24 @@
<term><parameter>session</parameter></term>
<listitem>
<simpara>
Идентификатор соединения SSH, полученный из
<function>ssh2_connect</function>.
Идентификатор канала SSH-соединения, который вернула
функция <function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<simpara>
Имя пользователя, от лица которого требуется выполнить аутентификацию на удалённом сервере.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pubkeyfile</parameter></term>
<listitem>
<simpara>
Открытый ключ в формате OpenSSH. Должен выглядеть примерно так:
Открытый ключ в формате OpenSSH, строка наподобие:
</simpara>
<simpara>
ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
Expand All @@ -56,15 +57,17 @@
<term><parameter>privkeyfile</parameter></term>
<listitem>
<simpara>
Путь к файлу закрытого OpenSSH-ключа.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>passphrase</parameter></term>
<listitem>
<simpara>
Если <parameter>privkeyfile</parameter> зашифрован (как должен бы),
то необходимо предоставить <parameter>passphrase</parameter>.
Парольная фраза для расшифровки закрытого ключа <parameter>privkey</parameter>.
Парольную фразу передают в параметр <parameter>passphrase</parameter>,
только если выполняются требования безопасности и закрытый ключ хранится в зашифрованном виде.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -81,20 +84,24 @@
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Аутентификация с открытым ключом</title>
<title>Пример аутентификации по открытому ключу</title>
<programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa'));

if (ssh2_auth_pubkey_file($connection, 'username',
'/home/username/.ssh/id_rsa.pub',
'/home/username/.ssh/id_rsa', 'secret')) {
echo "Успешная аутентификация с открытым ключом\n";
$connection = ssh2_connect('shell.example.com', 22, array('hostkey' => 'ssh-rsa'));

if (ssh2_auth_pubkey_file(
$connection,
'username',
'/home/username/.ssh/id_rsa.pub',
'/home/username/.ssh/id_rsa',
'secret'
)) {
echo "Клиент прошёл аутентификацию по открытому ключу\n";
} else {
die('Неудачная аутентификация с открытым ключом');
die('Открытый ключ не подтвердил подлинность клиента');
}
?>
]]>
</programlisting>
</example>
Expand All @@ -104,13 +111,23 @@ if (ssh2_auth_pubkey_file($connection, 'username',
&reftitle.notes;
<note>
<simpara>
Основная библиотека libssh не поддерживает частичные аутентификации очень чисто.
То есть, если вам нужно предоставить как открытый ключ, так и пароль, он будет выглядеть так, как если бы эта функция потерпела неудачу. В данном конкретном случае неудачный вызов
может означать, что аутентификация не завершена. Вам нужно игнорировать это неудачное выполнение, продолжить работу и вызвать <function>ssh2_auth_password</function> для завершения аутентификации.
Библиотека libssh, на базе которой работает PHP-модуль SSH2, не поддерживает
частичное подтверждение подлинности на серверах с многофакторной аутентификацией,
при которой требуется проверка и открытого ключа, и пароля. Поэтому на шаге проверки
открытого ключа возврат значения &false; часто указывает не на ошибку, а только на незавершённость процесса аутентификации.
При многоступенчатой аутентификации ошибку игнорируют
и вызывают функцию <function>ssh2_auth_password</function>, чтобы завершить аутентификацию.
</simpara>
</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
152 changes: 152 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,152 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 74ef2355c59e814d14f75a0792d22727be72f137 Maintainer: malferov Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey">
<refnamediv>
<refname>ssh2_auth_pubkey</refname>
<refpurpose>Аутентифицирует клиента по открытому ключу в переменной</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>
Функция аутентифицирует клиента по открытому ключу, который содержит переменная.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
Идентификатор канала SSH-соединения, который вернула
функция <function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<simpara>
Имя пользователя, от лица которого требуется выполнить аутентификацию на удалённом сервере.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pubkey</parameter></term>
<listitem>
<simpara>
Открытый ключ в формате OpenSSH, строка наподобие:
<literal>ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110</literal>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privkey</parameter></term>
<listitem>
<simpara>
Закрытый OpenSSH-ключ, который начинается со строки:
<literal>-----BEGIN RSA PRIVATE KEY-----</literal>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>passphrase</parameter></term>
<listitem>
<simpara>
Парольная фраза для расшифровки закрытого ключа <parameter>privkey</parameter>.
Парольную фразу передают в параметр <parameter>passphrase</parameter>,
только если выполняются требования безопасности и закрытый ключ хранится в зашифрованном виде.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

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

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Пример аутентификации с открытым ключом</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 "Клиент прошёл аутентификацию по открытому ключу\n";
} else {
die('Открытый ключ не подтвердил подлинность клиента');
}
]]>
</programlisting>
</example>
</refsect1>

<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
Библиотека libssh, на базе которой работает PHP-модуль SSH2, не поддерживает
частичное подтверждение подлинности на серверах с многофакторной аутентификацией,
при которой требуется проверка и открытого ключа, и пароля. Поэтому на шаге проверки
открытого ключа возврат значения &false; часто указывает не на ошибку, а только на незавершённость процесса аутентификации.
При многоступенчатой аутентификации ошибку игнорируют
и вызывают функцию <function>ssh2_auth_password</function>, чтобы завершить аутентификацию.
</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
-->
Loading
Loading