<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Return list of negotiated methods</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-fingerprint.html">ssh2_fingerprint</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-publickey-add.html">ssh2_publickey_add</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-methods-negotiated" class="refentry">
<div class="refnamediv">
<h1 class="refname">ssh2_methods_negotiated</h1>
<p class="verinfo">(PECL ssh2 >= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_methods_negotiated</span> — <span class="dc-title">Return list of negotiated methods</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ssh2-methods-negotiated-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>ssh2_methods_negotiated</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$session</code></span>
)</div>
<p class="para rdfs-comment">
Returns list of negotiated methods.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ssh2-methods-negotiated-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">session</code></dt>
<dd>
<p class="para">
An SSH connection link identifier, obtained from a call to
<span class="function"><a href="function.ssh2-connect.html" class="function">ssh2_connect()</a></span>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ssh2-methods-negotiated-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ssh2-methods-negotiated-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5752">
<p><strong>Example #1 Determining what methods were negotiated</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$connection </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">$methods </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_methods_negotiated</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Encryption keys were negotiated using: </span><span style="color: #007700">{</span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'kex'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"Server identified using an </span><span style="color: #007700">{</span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'hostkey'</span><span style="color: #007700">]}</span><span style="color: #DD0000"> with "</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"fingerprint: " </span><span style="color: #007700">. </span><span style="color: #0000BB">ssh2_fingerprint</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br />echo </span><span style="color: #DD0000">"Client to Server packets will use methods:\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\tCrypt: </span><span style="color: #007700">{</span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'client_to_server'</span><span style="color: #007700">][</span><span style="color: #DD0000">'crypt'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\tComp: </span><span style="color: #007700">{</span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'client_to_server'</span><span style="color: #007700">][</span><span style="color: #DD0000">'comp'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\tMAC: </span><span style="color: #007700">{</span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'client_to_server'</span><span style="color: #007700">][</span><span style="color: #DD0000">'mac'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br />echo </span><span style="color: #DD0000">"Server to Client packets will use methods:\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\tCrypt: </span><span style="color: #007700">{</span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'server_to_client'</span><span style="color: #007700">][</span><span style="color: #DD0000">'crypt'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\tComp: </span><span style="color: #007700">{</span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'server_to_client'</span><span style="color: #007700">][</span><span style="color: #DD0000">'comp'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\tMAC: </span><span style="color: #007700">{</span><span style="color: #0000BB">$methods</span><span style="color: #007700">[</span><span style="color: #DD0000">'server_to_client'</span><span style="color: #007700">][</span><span style="color: #DD0000">'mac'</span><span style="color: #007700">]}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ssh2-methods-negotiated-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.ssh2-connect.html" class="function" rel="rdfs-seeAlso">ssh2_connect()</a> - Connect to an SSH server</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-fingerprint.html">ssh2_fingerprint</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-publickey-add.html">ssh2_publickey_add</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>
