mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 07:02:08 +01:00
99 lines
2.5 KiB
XML
99 lines
2.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 12f0e72200ea9249d0fc2f118528bd24b24c44a6 Maintainer: takagi Status: ready -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-agent">
|
|
<refnamediv>
|
|
<refname>ssh2_auth_agent</refname>
|
|
<refpurpose>SSH の認証を、ssh agent を使って行う</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ssh2_auth_agent</methodname>
|
|
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>username</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
SSH の認証を、ssh agent を使って行います。
|
|
</simpara>
|
|
<note>
|
|
<simpara>
|
|
<function>ssh2_auth_agent</function> 関数が使えるのは、
|
|
ssh2 拡張モジュールのコンパイルに libssh >= 1.2.3 を使った場合だけです。
|
|
</simpara>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>session</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
SSH 接続リンク ID。
|
|
<function>ssh2_connect</function> を呼んで取得したもの。
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>username</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
リモートのユーザー名。
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
&return.success;
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>ssh agent による認証</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$connection = ssh2_connect('shell.example.com', 22);
|
|
|
|
if (ssh2_auth_agent($connection, 'username')) {
|
|
echo "Authentication Successful!\n";
|
|
} else {
|
|
die('Authentication Failed...');
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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
|
|
-->
|