<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>libssh: ssh::Session Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libssh
 <span id="projectnumber">0.5.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ssh</b></li><li class="navelem"><a class="el" href="classssh_1_1Session.html">Session</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">ssh::Session Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">ssh::Session</a> class contains the state of a SSH connection.
<a href="classssh_1_1Session.html#details">More...</a></p>
<p><code>#include <<a class="el" href="libsshpp_8hpp_source.html">include/libssh/libsshpp.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6cd5318d71a3850a87b87bdfd89a5983"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classssh_1_1Channel.html">Channel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a6cd5318d71a3850a87b87bdfd89a5983">acceptForward</a> (int timeout_ms)</td></tr>
<tr class="memdesc:a6cd5318d71a3850a87b87bdfd89a5983"><td class="mdescLeft"> </td><td class="mdescRight">accept an incoming forward connection <a href="#a6cd5318d71a3850a87b87bdfd89a5983">More...</a><br/></td></tr>
<tr class="separator:a6cd5318d71a3850a87b87bdfd89a5983"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a88d7dd524e81cb9152a87cb6fefc40"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a2a88d7dd524e81cb9152a87cb6fefc40">connect</a> ()</td></tr>
<tr class="memdesc:a2a88d7dd524e81cb9152a87cb6fefc40"><td class="mdescLeft"> </td><td class="mdescRight">connects to the remote host <a href="#a2a88d7dd524e81cb9152a87cb6fefc40">More...</a><br/></td></tr>
<tr class="separator:a2a88d7dd524e81cb9152a87cb6fefc40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa6972fe2757370a0cf2b90576eb6edc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#aaa6972fe2757370a0cf2b90576eb6edc">disconnect</a> ()</td></tr>
<tr class="memdesc:aaa6972fe2757370a0cf2b90576eb6edc"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects from the SSH server and closes connection. <a href="#aaa6972fe2757370a0cf2b90576eb6edc">More...</a><br/></td></tr>
<tr class="separator:aaa6972fe2757370a0cf2b90576eb6edc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08d70b5cdb5bd1a2a8f5f9ebbdf67b3b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a08d70b5cdb5bd1a2a8f5f9ebbdf67b3b">getAuthList</a> ()</td></tr>
<tr class="memdesc:a08d70b5cdb5bd1a2a8f5f9ebbdf67b3b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the available authentication methods from the server. <a href="#a08d70b5cdb5bd1a2a8f5f9ebbdf67b3b">More...</a><br/></td></tr>
<tr class="separator:a08d70b5cdb5bd1a2a8f5f9ebbdf67b3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e0c0bcc2cc0d129e049b5b51bf1cbe8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a4e0c0bcc2cc0d129e049b5b51bf1cbe8">getDisconnectMessage</a> ()</td></tr>
<tr class="memdesc:a4e0c0bcc2cc0d129e049b5b51bf1cbe8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the disconnect message from the server, if any. <a href="#a4e0c0bcc2cc0d129e049b5b51bf1cbe8">More...</a><br/></td></tr>
<tr class="separator:a4e0c0bcc2cc0d129e049b5b51bf1cbe8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9969ed8dcaccef321ac519271758b406"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a9969ed8dcaccef321ac519271758b406">getIssueBanner</a> ()</td></tr>
<tr class="memdesc:a9969ed8dcaccef321ac519271758b406"><td class="mdescLeft"> </td><td class="mdescRight">gets the Issue banner from the ssh server <a href="#a9969ed8dcaccef321ac519271758b406">More...</a><br/></td></tr>
<tr class="separator:a9969ed8dcaccef321ac519271758b406"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e0af590062a73a0927bb513bc19dd8e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a9e0af590062a73a0927bb513bc19dd8e">getOpensshVersion</a> ()</td></tr>
<tr class="memdesc:a9e0af590062a73a0927bb513bc19dd8e"><td class="mdescLeft"> </td><td class="mdescRight">returns the OpenSSH version (server) if possible <a href="#a9e0af590062a73a0927bb513bc19dd8e">More...</a><br/></td></tr>
<tr class="separator:a9e0af590062a73a0927bb513bc19dd8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30c021f6138124d785f151583e5656bd"><td class="memItemLeft" align="right" valign="top">socket_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a30c021f6138124d785f151583e5656bd">getSocket</a> ()</td></tr>
<tr class="memdesc:a30c021f6138124d785f151583e5656bd"><td class="mdescLeft"> </td><td class="mdescRight">returns the file descriptor used for the communication <a href="#a30c021f6138124d785f151583e5656bd">More...</a><br/></td></tr>
<tr class="separator:a30c021f6138124d785f151583e5656bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d7b4df57ed97f2592893b0493336b88"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a5d7b4df57ed97f2592893b0493336b88">getVersion</a> ()</td></tr>
<tr class="memdesc:a5d7b4df57ed97f2592893b0493336b88"><td class="mdescLeft"> </td><td class="mdescRight">returns the version of the SSH protocol being used <a href="#a5d7b4df57ed97f2592893b0493336b88">More...</a><br/></td></tr>
<tr class="separator:a5d7b4df57ed97f2592893b0493336b88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b7055cb236685a9c18cb79c5492b40f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a0b7055cb236685a9c18cb79c5492b40f">isServerKnown</a> ()</td></tr>
<tr class="memdesc:a0b7055cb236685a9c18cb79c5492b40f"><td class="mdescLeft"> </td><td class="mdescRight">verifies that the server is known <a href="#a0b7055cb236685a9c18cb79c5492b40f">More...</a><br/></td></tr>
<tr class="separator:a0b7055cb236685a9c18cb79c5492b40f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05cbc79d7b3ef14499fe258f56031957"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a05cbc79d7b3ef14499fe258f56031957">optionsCopy</a> (const <a class="el" href="classssh_1_1Session.html">Session</a> &source)</td></tr>
<tr class="memdesc:a05cbc79d7b3ef14499fe258f56031957"><td class="mdescLeft"> </td><td class="mdescRight">copies options from a session to another <a href="#a05cbc79d7b3ef14499fe258f56031957">More...</a><br/></td></tr>
<tr class="separator:a05cbc79d7b3ef14499fe258f56031957"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0fe8a68c45f9f150bb306ae840f68f0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a0fe8a68c45f9f150bb306ae840f68f0f">optionsParseConfig</a> (const char *file)</td></tr>
<tr class="memdesc:a0fe8a68c45f9f150bb306ae840f68f0f"><td class="mdescLeft"> </td><td class="mdescRight">parses a configuration file for options <a href="#a0fe8a68c45f9f150bb306ae840f68f0f">More...</a><br/></td></tr>
<tr class="separator:a0fe8a68c45f9f150bb306ae840f68f0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad19ae4a0927094c12f383907cbf40ccc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#ad19ae4a0927094c12f383907cbf40ccc">setOption</a> (enum ssh_options_e type, const char *option)</td></tr>
<tr class="memdesc:ad19ae4a0927094c12f383907cbf40ccc"><td class="mdescLeft"> </td><td class="mdescRight">sets an SSH session options <a href="#ad19ae4a0927094c12f383907cbf40ccc">More...</a><br/></td></tr>
<tr class="separator:ad19ae4a0927094c12f383907cbf40ccc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6dc221d1212370608516c89115f6470"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#ad6dc221d1212370608516c89115f6470">setOption</a> (enum ssh_options_e type, long int option)</td></tr>
<tr class="memdesc:ad6dc221d1212370608516c89115f6470"><td class="mdescLeft"> </td><td class="mdescRight">sets an SSH session options <a href="#ad6dc221d1212370608516c89115f6470">More...</a><br/></td></tr>
<tr class="separator:ad6dc221d1212370608516c89115f6470"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bd14b987212698c146ed05f25454046"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a1bd14b987212698c146ed05f25454046">setOption</a> (enum ssh_options_e type, void *option)</td></tr>
<tr class="memdesc:a1bd14b987212698c146ed05f25454046"><td class="mdescLeft"> </td><td class="mdescRight">sets an SSH session options <a href="#a1bd14b987212698c146ed05f25454046">More...</a><br/></td></tr>
<tr class="separator:a1bd14b987212698c146ed05f25454046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15b2a58607cc42628e17c94c8f7eb793"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a15b2a58607cc42628e17c94c8f7eb793">silentDisconnect</a> ()</td></tr>
<tr class="memdesc:a15b2a58607cc42628e17c94c8f7eb793"><td class="mdescLeft"> </td><td class="mdescRight">silently disconnect from remote host <a href="#a15b2a58607cc42628e17c94c8f7eb793">More...</a><br/></td></tr>
<tr class="separator:a15b2a58607cc42628e17c94c8f7eb793"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a4d5abc13091ef27542aaa0a1caf6b4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a5a4d5abc13091ef27542aaa0a1caf6b4">userauthAutopubkey</a> (void)</td></tr>
<tr class="memdesc:a5a4d5abc13091ef27542aaa0a1caf6b4"><td class="mdescLeft"> </td><td class="mdescRight">Authenticates automatically using public key. <a href="#a5a4d5abc13091ef27542aaa0a1caf6b4">More...</a><br/></td></tr>
<tr class="separator:a5a4d5abc13091ef27542aaa0a1caf6b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a988398835fc131b0eb5a83a4adaec532"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a988398835fc131b0eb5a83a4adaec532">userauthNone</a> ()</td></tr>
<tr class="memdesc:a988398835fc131b0eb5a83a4adaec532"><td class="mdescLeft"> </td><td class="mdescRight">Authenticates using the "none" method. <a href="#a988398835fc131b0eb5a83a4adaec532">More...</a><br/></td></tr>
<tr class="separator:a988398835fc131b0eb5a83a4adaec532"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ac19de04c5c6c396ce8d042052be4ca"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a8ac19de04c5c6c396ce8d042052be4ca">userauthOfferPubkey</a> (int type, ssh_string pubkey)</td></tr>
<tr class="memdesc:a8ac19de04c5c6c396ce8d042052be4ca"><td class="mdescLeft"> </td><td class="mdescRight">Try to authenticate using the publickey method. <a href="#a8ac19de04c5c6c396ce8d042052be4ca">More...</a><br/></td></tr>
<tr class="separator:a8ac19de04c5c6c396ce8d042052be4ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2d10826877bec6598961614eb62f0f7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#ac2d10826877bec6598961614eb62f0f7">userauthPassword</a> (const char *password)</td></tr>
<tr class="memdesc:ac2d10826877bec6598961614eb62f0f7"><td class="mdescLeft"> </td><td class="mdescRight">Authenticates using the password method. <a href="#ac2d10826877bec6598961614eb62f0f7">More...</a><br/></td></tr>
<tr class="separator:ac2d10826877bec6598961614eb62f0f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8356cb653749ecb816a3f1aefa37e687"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#a8356cb653749ecb816a3f1aefa37e687">userauthPubkey</a> (ssh_string pubkey, ssh_private_key privkey)</td></tr>
<tr class="memdesc:a8356cb653749ecb816a3f1aefa37e687"><td class="mdescLeft"> </td><td class="mdescRight">Authenticates using the publickey method. <a href="#a8356cb653749ecb816a3f1aefa37e687">More...</a><br/></td></tr>
<tr class="separator:a8356cb653749ecb816a3f1aefa37e687"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae55f054025dcbe4ceeaec87c9ca064c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Session.html#ae55f054025dcbe4ceeaec87c9ca064c7">writeKnownhost</a> ()</td></tr>
<tr class="memdesc:ae55f054025dcbe4ceeaec87c9ca064c7"><td class="mdescLeft"> </td><td class="mdescRight">Writes the known host file with current host key. <a href="#ae55f054025dcbe4ceeaec87c9ca064c7">More...</a><br/></td></tr>
<tr class="separator:ae55f054025dcbe4ceeaec87c9ca064c7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">ssh::Session</a> class contains the state of a SSH connection. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6cd5318d71a3850a87b87bdfd89a5983"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classssh_1_1Channel.html">Channel</a> * ssh::Session::acceptForward </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeout_ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>accept an incoming forward connection </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timeout_ms</td><td>timeout for waiting, in ms </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>new <a class="el" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a> pointer on the forward connection </dd>
<dd>
NULL in case of error </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>you have to delete this pointer after use </dd></dl>
<dl class="section see"><dt>See Also</dt><dd>ssh_channel_forward_accept </dd>
<dd>
Session::listenForward </dd></dl>
<p>References <a class="el" href="group__libssh__channel.html#ga205d5ea76fb140075ebb1c20b8f193d3">ssh_forward_accept()</a>.</p>
</div>
</div>
<a class="anchor" id="a2a88d7dd524e81cb9152a87cb6fefc40"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Session::connect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>connects to the remote host </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga032e07cbd8bc3f14cb2dd375db0b03d7" title="Connect to the ssh server.">ssh_connect</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga032e07cbd8bc3f14cb2dd375db0b03d7">ssh_connect()</a>.</p>
</div>
</div>
<a class="anchor" id="aaa6972fe2757370a0cf2b90576eb6edc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Session::disconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnects from the SSH server and closes connection. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga0f048a4c0dbe02cfb7e9c5b6d0db0f27" title="Disconnect from a session (client or server).">ssh_disconnect</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga0f048a4c0dbe02cfb7e9c5b6d0db0f27">ssh_disconnect()</a>.</p>
</div>
</div>
<a class="anchor" id="a08d70b5cdb5bd1a2a8f5f9ebbdf67b3b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::getAuthList </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the available authentication methods from the server. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Bitfield of available methods. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__auth.html#ga35d44897a44b4bb3b7c01108c1812a37" title="retrieves available authentication methods for this session">ssh_userauth_list</a> </dd></dl>
<p>References <a class="el" href="group__libssh__auth.html#ga35d44897a44b4bb3b7c01108c1812a37">ssh_userauth_list()</a>.</p>
</div>
</div>
<a class="anchor" id="a4e0c0bcc2cc0d129e049b5b51bf1cbe8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* ssh::Session::getDisconnectMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the disconnect message from the server, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>pointer to the message, or NULL. Do not attempt to free the pointer. </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#gad19e368e35d48e02ba95970a7d1e87f5">ssh_get_disconnect_message()</a>.</p>
</div>
</div>
<a class="anchor" id="a9969ed8dcaccef321ac519271758b406"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ssh::Session::getIssueBanner </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>gets the Issue banner from the ssh server </p>
<dl class="section return"><dt>Returns</dt><dd>the issue banner. This is generally a MOTD from server </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga89864d4d5cc6d3d6ef1c39652f2a688f" title="Get the issue banner from the server.">ssh_get_issue_banner</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga89864d4d5cc6d3d6ef1c39652f2a688f">ssh_get_issue_banner()</a>.</p>
</div>
</div>
<a class="anchor" id="a9e0af590062a73a0927bb513bc19dd8e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::getOpensshVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the OpenSSH version (server) if possible </p>
<dl class="section return"><dt>Returns</dt><dd>openssh version code </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#gac55d2895467a1e898ee75b4710d836a5" title="Get the version of the OpenSSH server, if it is not an OpenSSH server then 0 will be returned...">ssh_get_openssh_version</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#gac55d2895467a1e898ee75b4710d836a5">ssh_get_openssh_version()</a>.</p>
</div>
</div>
<a class="anchor" id="a30c021f6138124d785f151583e5656bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">socket_t ssh::Session::getSocket </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the file descriptor used for the communication </p>
<dl class="section return"><dt>Returns</dt><dd>the file descriptor </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>if a proxycommand is used, this function will only return one of the two file descriptors being used </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#gafe509fcea47714b5cd277d1e35e83276" title="Get the fd of a connection.">ssh_get_fd</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#gafe509fcea47714b5cd277d1e35e83276">ssh_get_fd()</a>.</p>
</div>
</div>
<a class="anchor" id="a5d7b4df57ed97f2592893b0493336b88"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::getVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the version of the SSH protocol being used </p>
<dl class="section return"><dt>Returns</dt><dd>the SSH protocol version </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga8467735e4735165336f68ee82e24de0e" title="Get the protocol version of the session.">ssh_get_version</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga8467735e4735165336f68ee82e24de0e">ssh_get_version()</a>.</p>
</div>
</div>
<a class="anchor" id="a0b7055cb236685a9c18cb79c5492b40f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::isServerKnown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>verifies that the server is known </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Integer value depending on the knowledge of the server key </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga6f37e3d7bb6b938b44d6a34a76fdfa0b" title="Check if the server is known.">ssh_is_server_known</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga6f37e3d7bb6b938b44d6a34a76fdfa0b">ssh_is_server_known()</a>.</p>
</div>
</div>
<a class="anchor" id="a05cbc79d7b3ef14499fe258f56031957"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Session::optionsCopy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classssh_1_1Session.html">Session</a> & </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>copies options from a session to another </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#gaead8cef1f39e785139bc510852ce1dff" title="Duplicate the options of a session structure.">ssh_options_copy</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#gaead8cef1f39e785139bc510852ce1dff">ssh_options_copy()</a>.</p>
</div>
</div>
<a class="anchor" id="a0fe8a68c45f9f150bb306ae840f68f0f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Session::optionsParseConfig </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>parses a configuration file for options </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>configuration file name </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga82371e723260c7572ea061edecc2e9f1" title="Parse the ssh config file.">ssh_options_parse_config</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga82371e723260c7572ea061edecc2e9f1">ssh_options_parse_config()</a>.</p>
</div>
</div>
<a class="anchor" id="ad19ae4a0927094c12f383907cbf40ccc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Session::setOption </td>
<td>(</td>
<td class="paramtype">enum ssh_options_e </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>option</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>sets an SSH session options </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Type of option </td></tr>
<tr><td class="paramname">option</td><td>cstring containing the value of option </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d" title="This function can set all possible ssh options.">ssh_options_set</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d">ssh_options_set()</a>.</p>
</div>
</div>
<a class="anchor" id="ad6dc221d1212370608516c89115f6470"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Session::setOption </td>
<td>(</td>
<td class="paramtype">enum ssh_options_e </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long int </td>
<td class="paramname"><em>option</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>sets an SSH session options </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Type of option </td></tr>
<tr><td class="paramname">option</td><td>long integer containing the value of option </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d" title="This function can set all possible ssh options.">ssh_options_set</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d">ssh_options_set()</a>.</p>
</div>
</div>
<a class="anchor" id="a1bd14b987212698c146ed05f25454046"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Session::setOption </td>
<td>(</td>
<td class="paramtype">enum ssh_options_e </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>option</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>sets an SSH session options </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Type of option </td></tr>
<tr><td class="paramname">option</td><td>void pointer containing the value of option </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d" title="This function can set all possible ssh options.">ssh_options_set</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d">ssh_options_set()</a>.</p>
</div>
</div>
<a class="anchor" id="a15b2a58607cc42628e17c94c8f7eb793"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Session::silentDisconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>silently disconnect from remote host </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#gae1bd16255ba373325adf76307d0c8c42" title="Disconnect impolitely from a remote host by closing the socket.">ssh_silent_disconnect</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#gae1bd16255ba373325adf76307d0c8c42">ssh_silent_disconnect()</a>.</p>
</div>
</div>
<a class="anchor" id="a5a4d5abc13091ef27542aaa0a1caf6b4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::userauthAutopubkey </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Authenticates automatically using public key. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_AUTH_SUCCESS, SSH_AUTH_PARTIAL, SSH_AUTH_DENIED </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__auth.html#gad07655f2c742ce68271422197cf2acda" title="Tries to automatically authenticate with public key and "none".">ssh_userauth_autopubkey</a> </dd></dl>
<p>References <a class="el" href="group__libssh__auth.html#gad07655f2c742ce68271422197cf2acda">ssh_userauth_autopubkey()</a>.</p>
</div>
</div>
<a class="anchor" id="a988398835fc131b0eb5a83a4adaec532"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::userauthNone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Authenticates using the "none" method. </p>
<p>Prefer using autopubkey if possible. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_AUTH_SUCCESS, SSH_AUTH_PARTIAL, SSH_AUTH_DENIED </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__auth.html#ga58e7c265236edbc97a2f117d3f23b4dd" title="Try to authenticate through the "none" method.">ssh_userauth_none</a> </dd>
<dd>
Session::userauthAutoPubkey </dd></dl>
<p>References <a class="el" href="group__libssh__auth.html#ga58e7c265236edbc97a2f117d3f23b4dd">ssh_userauth_none()</a>.</p>
</div>
</div>
<a class="anchor" id="a8ac19de04c5c6c396ce8d042052be4ca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::userauthOfferPubkey </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ssh_string </td>
<td class="paramname"><em>pubkey</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Try to authenticate using the publickey method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>public key type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pubkey</td><td>public key to use for authentication </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_AUTH_SUCCESS if the pubkey is accepted, </dd>
<dd>
SSH_AUTH_DENIED if the pubkey is denied </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__auth.html#ga78b485bf5c4e68ddfbc25f17de8b6521" title="Try to authenticate through public key.">ssh_userauth_offer_pubkey</a> </dd></dl>
<p>References <a class="el" href="group__libssh__auth.html#ga78b485bf5c4e68ddfbc25f17de8b6521">ssh_userauth_offer_pubkey()</a>.</p>
</div>
</div>
<a class="anchor" id="ac2d10826877bec6598961614eb62f0f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::userauthPassword </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Authenticates using the password method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>password to use for authentication </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_AUTH_SUCCESS, SSH_AUTH_PARTIAL, SSH_AUTH_DENIED </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__auth.html#ga50c0c150f8c4703e7ee49b3e3e3ca215" title="Try to authenticate by password.">ssh_userauth_password</a> </dd></dl>
<p>References <a class="el" href="group__libssh__auth.html#ga50c0c150f8c4703e7ee49b3e3e3ca215">ssh_userauth_password()</a>.</p>
</div>
</div>
<a class="anchor" id="a8356cb653749ecb816a3f1aefa37e687"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::userauthPubkey </td>
<td>(</td>
<td class="paramtype">ssh_string </td>
<td class="paramname"><em>pubkey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ssh_private_key </td>
<td class="paramname"><em>privkey</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Authenticates using the publickey method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pubkey</td><td>public key to use for authentication </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">privkey</td><td>private key to use for authentication </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_AUTH_SUCCESS, SSH_AUTH_PARTIAL, SSH_AUTH_DENIED </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__auth.html#ga18f0c63c75b9af6c28c032e93628a7c5" title="Try to authenticate through public key.">ssh_userauth_pubkey</a> </dd></dl>
<p>References <a class="el" href="group__libssh__auth.html#ga18f0c63c75b9af6c28c032e93628a7c5">ssh_userauth_pubkey()</a>.</p>
</div>
</div>
<a class="anchor" id="ae55f054025dcbe4ceeaec87c9ca064c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Session::writeKnownhost </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the known host file with current host key. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__session.html#gaf61a9cfdc40c76ffce9f9a8543755d36" title="Write the current server as known in the known hosts file.">ssh_write_knownhost</a> </dd></dl>
<p>References <a class="el" href="group__libssh__session.html#gaf61a9cfdc40c76ffce9f9a8543755d36">ssh_write_knownhost()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/libssh/<a class="el" href="libsshpp_8hpp_source.html">libsshpp.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
