ssh2-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d6352b08091d6b6c3795fd95cbfe282046ef7681 Maintainer: shimooka Status: ready -->
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-connect">
 <refnamediv>
  <refname>ssh2_connect</refname>
  <refpurpose>SSH サーバーに接続する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>resource</type><type>false</type></type><methodname>ssh2_connect</methodname>
   <methodparam><type>string</type><parameter>host</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>22</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>methods</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter></methodparam>
  </methodsynopsis>
  <para>
   リモートの SSH サーバーとの接続を確立します。
  </para>
  <para>
   一度接続すると、クライアントは <function>ssh2_fingerprint</function>
   を使用してサーバーのホスト鍵を検証し、
   パスワードもしくは公開鍵を使用して認証します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>host</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>methods</parameter></term>
     <listitem>
      <para>
       <parameter>methods</parameter>
       は以下に示された4つのパラメータを持つ連想配列です。
      </para>
      <para>
       <table>
        <title><parameter>methods</parameter>
        は以下のパラメータのいくつかあるいは全てを含む連想配列</title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>インデックス</entry>
           <entry>意味</entry>
           <entry>サポートする値*</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>kex</entry>
           <entry>
            通知する鍵交換メソッドのリスト。優先する順にカンマ区切りにする。
           </entry>
           <entry>
            <literal>diffie-hellman-group1-sha1</literal>、
            <literal>diffie-hellman-group14-sha1</literal> および
            <literal>diffie-hellman-group-exchange-sha1</literal>
           </entry>
          </row>
          <row>
           <entry>hostkey</entry>
           <entry>
            通知するホスト鍵メソッドのリスト。優先する順にカンマ区切りにする。
           </entry>
           <entry>
            <literal>ssh-rsa</literal> および
            <literal>ssh-dss</literal>
           </entry>
          </row>
          <row>
           <entry>client_to_server</entry>
           <entry>
            クライアントからサーバーに送信されるメッセージのために優先する暗号化、
            圧縮、メッセージ認証コード (MAC) メソッドを含む連想配列。
           </entry>
           <entry/>
          </row>
          <row>
           <entry>server_to_client</entry>
           <entry>
            サーバーからクライアントに送信されるメッセージのために優先する暗号化、
            圧縮、メッセージ認証コード (MAC) メソッドを含む連想配列。
           </entry>
           <entry/>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
      <para>
       * - サポートする値は、
       構成するライブラリがサポートしているメソッドに依存します。
       追加情報については <link xlink:href="&url.libssh2;">libssh2</link>
       ドキュメントを参照ください。
      </para>
      <para>
       <table>
        <title>
         <parameter>client_to_server</parameter> と
         <parameter>server_to_client</parameter>
         は以下のパラメータのいくつかあるいは全てを含む連想配列
        </title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>インデックス</entry>
           <entry>意味</entry>
           <entry>サポートする値*</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>crypt</entry>
           <entry>通知する暗号化メソッドのリスト。
           優先する順にカンマ区切りにする。</entry>
           <entry>
            <literal>rijndael-cbc@lysator.liu.se</literal>、
            <literal>aes256-cbc</literal>、
            <literal>aes192-cbc</literal>、
            <literal>aes128-cbc</literal>、
            <literal>3des-cbc</literal>、
            <literal>blowfish-cbc</literal>、
            <literal>cast128-cbc</literal>、
            <literal>arcfour</literal> および
            <literal>none**</literal>
           </entry>
          </row>
          <row>
           <entry>comp</entry>
           <entry>通知する圧縮メソッドのリスト。
           優先する順にカンマ区切りにする。</entry>
           <entry>
            <literal>zlib</literal> および
            <literal>none</literal>
           </entry>
          </row>
          <row>
           <entry>mac</entry>
           <entry>通知する MAC メソッドのリスト。
           優先する順にカンマ区切りにする。</entry>
           <entry>
            <literal>hmac-sha1</literal>、
            <literal>hmac-sha1-96</literal>、
            <literal>hmac-ripemd160</literal>、
            <literal>hmac-ripemd160@openssh.com</literal> および
            <literal>none**</literal>
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
      <para>
       <note>
        <title>暗号化、MAC メソッドの "<literal>none</literal>"</title>
        <para>
         セキュリティ上の問題で、<literal>none</literal> は
         ビルド時に適切な ./configure
         オプションを使用して明示的に有効にしない限り、構成している
         <link xlink:href="&url.libssh2;">libssh2</link> によって無効にされます。
         詳細は構成するライブラリのドキュメントを参照ください。
        </para>
       </note>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callbacks</parameter></term>
     <listitem>
      <para>
       <parameter>callbacks</parameter>
       は以下のパラメータのいくつかあるいは全てを含む連想配列
       <table>
        <title>
         コールバックパラメータ
        </title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>インデックス</entry>
           <entry>意味</entry>
           <entry>プロトタイプ</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>ignore</entry>
           <entry>
            <constant>SSH2_MSG_IGNORE</constant>
            パケットを受信したときにコールする関数名
           </entry>
           <entry>void ignore_cb($message)</entry>
          </row>
          <row>
           <entry>debug</entry>
           <entry>
            <constant>SSH2_MSG_DEBUG</constant>
            パケットを受信したときにコールする関数名
           </entry>
           <entry>void debug_cb($message, $language, $always_display)</entry>
          </row>
          <row>
           <entry>macerror</entry>
           <entry>
            パケットを受信したがメッセージ認証コードに失敗した場合にコールされる関数名。
            もしコールバックが &true; を返す場合、不整合は無視されます。
            そうでない場合、接続は終了します。
           </entry>
           <entry>bool macerror_cb($packet)</entry>
          </row>
          <row>
           <entry>disconnect</entry>
           <entry>
            <constant>SSH2_MSG_DISCONNECT</constant>
            パケットを受信したときにコールする関数名
           </entry>
           <entry>void disconnect_cb($reason, $message, $language)</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合にリソース、エラー時に &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ssh2_connect</function> の例</title>
    <para>
     パケット送信時に 3des-cbc 、
     パケット受信時に任意の強度の aes cipher、
     両方向で無圧縮、
     Group1 での鍵交換という設定で強制的に接続をオープンします。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
/* もしサーバーが接続を終了した場合、ユーザーに通知する */
function my_ssh_disconnect($reason, $message, $language) {
  printf("Server disconnected with reason code [%d] and message: %s\n",
         $reason, $message);
}

$methods = array(
  'kex' => 'diffie-hellman-group1-sha1',
  'client_to_server' => array(
    'crypt' => '3des-cbc',
    'comp' => 'none'),
  'server_to_client' => array(
    'crypt' => 'aes256-cbc,aes192-cbc,aes128-cbc',
    'comp' => 'none'));

$callbacks = array('disconnect' => 'my_ssh_disconnect');

$connection = ssh2_connect('shell.example.com', 22, $methods, $callbacks);
if (!$connection) die('Connection failed');
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <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_file</function></member>
    <member><function>ssh2_disconnect</function></member>
   </simplelist>
  </para>
 </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
-->