📄 function.ssh2-publickey-list.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>List currently authorized publickeys</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-publickey-init.html">ssh2_publickey_init</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ssh2-publickey-remove.html">ssh2_publickey_remove</a></div> <div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.ssh2-publickey-list" class="refentry"> <div class="refnamediv"> <h1 class="refname">ssh2_publickey_list</h1> <p class="verinfo">(PECL ssh2:0.10)</p><p class="refpurpose"><span class="refname">ssh2_publickey_list</span> — <span class="dc-title"> List currently authorized publickeys </span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><b>ssh2_publickey_list</b></b></span> ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$pkey</tt></span> )</div> <p class="para rdfs-comment"> List currently authorized publickeys. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">pkey</tt></i></span> <dd> <p class="para"> Publickey Subsystem resource </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a numerically indexed array of keys, each of which is an associative array containing: name, blob, and attrs elements. </p> <p class="para"> <table border="5"> <caption><b>Publickey elements</b></caption> <colgroup> <thead valign="middle"> <tr valign="middle"> <th colspan="1">Array Key</th> <th colspan="1">Meaning</th> </tr> </thead> <tbody valign="middle" class="tbody"> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">name</td> <td colspan="1" rowspan="1" align="left">Name of algorithm used by this publickey, for example: <i>ssh-dss</i> or <i>ssh-rsa</i>.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">blob</td> <td colspan="1" rowspan="1" align="left">Publickey blob as raw binary data.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">attrs</td> <td colspan="1" rowspan="1" align="left">Attributes assigned to this publickey. The most common attribute, and the only one supported by publickey version 1 servers, is <i>comment</i>, which may be any freeform string.</td> </tr> </tbody> </colgroup> </table> </p> </div> <div class="refsect1 examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 Listing authorized keys with <b>ssh2_publickey_list()</b></b></p> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?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: {$key['name']}\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: {$key['attrs']['comment']}\n\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span></span></code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents"><pre><div class="cdata"><pre>Key: ssh-rsaBlob: AAAAB3NzaC1yc2EAAAABIwAAAIEA5HVt6VqSGd5PTrLRdjNONxXH1tVFGn0Bd26BF0aCP9qyJRlvdJ3j4WBeX4ZmrveGrjMgkseSYc4xZ26sDHwfL351xjzaLpipu\BGRrw17mWVBhuCExo476ri5tQFzbTc54VEHYckxQ16CjSTibI5X69GmnYC9PNqEYq/1TP+HF10Comment: John's KeyKey: ssh-rsaBlob: AAAAB3NzaHVt6VqSGd5C1yc2EAAAABIwA232dnJAAIEA5HVt6VqSGd5PTrLRdjNONxX/1TP+HF1HVt6VqSGd50H1tVFGn0BB3NzaC1yc2EAd26BF0aCP9qyJRlvdJ3j4WBeX4ZmrveGrjMgkseSYc4xZ26HVt6VqSGd5sDHwfL351xjzaLpipu\BGB3NzaC1yc2EA/1TComment: Alice's Key</pre></div> </pre></div> </div> </p> </div> <div class="refsect1 notes"> <h3 class="title">Notes</h3> <blockquote><p><b class="note">Note</b>: <span class="simpara">The public key subsystemis used for managing public keys on a server to which the client is<em class="emphasis">already</em> authenticated. To authenticate to a remote systemusing public key authentication, use the<a href="function.ssh2-auth-pubkey-file.html" class="function">ssh2_auth_pubkey_file()</a> function instead.</span></p></blockquote> </div> <div class="refsect1 seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="function.ssh2-publickey-init.html" class="function" rel="rdfs-seeAlso">ssh2_publickey_init()</a></li> <li class="member"><a href="function.ssh2-publickey-add.html" class="function" rel="rdfs-seeAlso">ssh2_publickey_add()</a></li> <li class="member"><a href="function.ssh2-publickey-remove.html" class="function" rel="rdfs-seeAlso">ssh2_publickey_remove()</a></li> </ul> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-publickey-init.html">ssh2_publickey_init</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ssh2-publickey-remove.html">ssh2_publickey_remove</a></div> <div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -