<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ssh2.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.ssh2-publickey-list.php',
    1 => 'ssh2_publickey_list',
    2 => '現在認証済みの公開鍵の一覧を表示する',
  ),
  'up' => 
  array (
    0 => 'ref.ssh2.php',
    1 => 'SSH2 関数',
  ),
  'prev' => 
  array (
    0 => 'function.ssh2-publickey-init.php',
    1 => 'ssh2_publickey_init',
  ),
  'next' => 
  array (
    0 => 'function.ssh2-publickey-remove.php',
    1 => 'ssh2_publickey_remove',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ssh2/functions/ssh2-publickey-list.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ssh2-publickey-list" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ssh2_publickey_list</h1>
  <p class="verinfo">(PECL ssh2 &gt;= 0.10)</p><p class="refpurpose"><span class="refname">ssh2_publickey_list</span> &mdash; <span class="dc-title">
   現在認証済みの公開鍵の一覧を表示する
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ssh2-publickey-list-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ssh2_publickey_list</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$pkey</code></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="simpara">
   現在認証済みの公開鍵の一覧を表示します。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ssh2-publickey-list-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">pkey</code></dt>
    <dd>
     <span class="simpara">
      公開鍵サブシステムのリソース。
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ssh2-publickey-list-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   鍵を、数値添字の配列で返します。
   個々の要素は連想配列となっており、その内容は
   name、blob、および attrs です。
  </p>
  <table class="doctable table">
   <caption><strong>公開鍵の要素</strong></caption>
   
    <thead>
     <tr>
      <th>配列のキー</th>
      <th>意味</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>name</td>
      <td>
       この公開鍵で使用しているアルゴリズムの名前。例:
       <code class="literal">ssh-dss</code> あるいは <code class="literal">ssh-rsa</code>。
      </td>
     </tr>

     <tr>
      <td>blob</td>
      <td>生のバイナリデータとしての blob 形式の公開鍵。</td>
     </tr>

     <tr>
      <td>attrs</td>
      <td>
       この公開鍵に割り当てる属性。
       もっとも一般的な属性であり、バージョン 1 の公開鍵サーバーが唯一サポートしている属性は
       <code class="literal">comment</code> です。これは任意の書式の文字列です。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.ssh2-publickey-list-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 認証済みの鍵の一覧を <span class="function"><strong>ssh2_publickey_list()</strong></span> で表示する</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$ssh2 </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'shell.example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ssh2_auth_password</span><span style="color: #007700">(</span><span style="color: #0000BB">$ssh2</span><span style="color: #007700">, </span><span style="color: #DD0000">'jdoe'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$pkey </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_publickey_init</span><span style="color: #007700">(</span><span style="color: #0000BB">$ssh2</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$list </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_publickey_list</span><span style="color: #007700">(</span><span style="color: #0000BB">$pkey</span><span style="color: #007700">);<br /><br />foreach(</span><span style="color: #0000BB">$list </span><span style="color: #007700">as </span><span style="color: #0000BB">$key</span><span style="color: #007700">) {<br />  echo </span><span style="color: #DD0000">"Key: </span><span style="color: #007700">{</span><span style="color: #0000BB">$key</span><span style="color: #007700">[</span><span style="color: #DD0000">'name'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />  echo </span><span style="color: #DD0000">"Blob: " </span><span style="color: #007700">. </span><span style="color: #0000BB">chunk_split</span><span style="color: #007700">(</span><span style="color: #0000BB">base64_encode</span><span style="color: #007700">(</span><span style="color: #0000BB">$key</span><span style="color: #007700">[</span><span style="color: #DD0000">'blob'</span><span style="color: #007700">]), </span><span style="color: #0000BB">40</span><span style="color: #007700">, </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />  echo </span><span style="color: #DD0000">"Comment: </span><span style="color: #007700">{</span><span style="color: #0000BB">$key</span><span style="color: #007700">[</span><span style="color: #DD0000">'attrs'</span><span style="color: #007700">][</span><span style="color: #DD0000">'comment'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>上の例の出力は以下となります。</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Key: ssh-rsa
Blob: AAAAB3NzaC1yc2EAAAABIwAAAIEA5HVt6VqSGd5P
TrLRdjNONxXH1tVFGn0Bd26BF0aCP9qyJRlvdJ3j
4WBeX4ZmrveGrjMgkseSYc4xZ26sDHwfL351xjza
Lpipu\BGRrw17mWVBhuCExo476ri5tQFzbTc54VE
HYckxQ16CjSTibI5X69GmnYC9PNqEYq/1TP+HF10
Comment: John&#039;s Key

Key: ssh-rsa
Blob: AAAAB3NzaHVt6VqSGd5C1yc2EAAAABIwA232dnJA
AIEA5HVt6VqSGd5PTrLRdjNONxX/1TP+HF1HVt6V
qSGd50H1tVFGn0BB3NzaC1yc2EAd26BF0aCP9qyJ
RlvdJ3j4WBeX4ZmrveGrjMgkseSYc4xZ26HVt6Vq
SGd5sDHwfL351xjzaLpipu\BGB3NzaC1yc2EA/1T
Comment: Alice&#039;s Key</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-function.ssh2-publickey-list-notes">
  <h3 class="title">注意</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: <span class="simpara">
この公開鍵サブシステムは、クライアントが認証 <em>済</em> の
公開鍵をサーバー上で管理するために使用されます。
公開鍵認証によりリモートシステムで認証を行うには、かわりに
<span class="function"><a href="function.ssh2-auth-pubkey-file.php" class="function">ssh2_auth_pubkey_file()</a></span> 関数を使用してください。</span></p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ssh2-publickey-list-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.ssh2-publickey-init.php" class="function" rel="rdfs-seeAlso">ssh2_publickey_init()</a> - 公開鍵サブシステムを初期化する</span></li>
   <li><span class="function"><a href="function.ssh2-publickey-add.php" class="function" rel="rdfs-seeAlso">ssh2_publickey_add()</a> - 認証済み公開鍵を追加する</span></li>
   <li><span class="function"><a href="function.ssh2-publickey-remove.php" class="function" rel="rdfs-seeAlso">ssh2_publickey_remove()</a> - 認証済み公開鍵を取り除く</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>