<!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: The libssh API</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><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">The libssh API</div> </div>
</div><!--header-->
<div class="contents">
<p>The libssh library is implementing the SSH protocols and some of its extensions.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__libssh__callbacks"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__callbacks.html">The libssh callbacks</a></td></tr>
<tr class="memdesc:group__libssh__callbacks"><td class="mdescLeft"> </td><td class="mdescRight">Callback which can be replaced in libssh. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__auth"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__auth.html">The SSH authentication functions.</a></td></tr>
<tr class="memdesc:group__libssh__auth"><td class="mdescLeft"> </td><td class="mdescRight">Functions to authenticate with a server. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__buffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__buffer.html">The SSH buffer functions.</a></td></tr>
<tr class="memdesc:group__libssh__buffer"><td class="mdescLeft"> </td><td class="mdescRight">Functions to handle SSH buffers. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__channel"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__channel.html">The SSH channel functions</a></td></tr>
<tr class="memdesc:group__libssh__channel"><td class="mdescLeft"> </td><td class="mdescRight">Functions that manage a SSH channel. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__error"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__error.html">The SSH error functions.</a></td></tr>
<tr class="memdesc:group__libssh__error"><td class="mdescLeft"> </td><td class="mdescRight">Functions for error handling. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__log"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html">The SSH logging functions.</a></td></tr>
<tr class="memdesc:group__libssh__log"><td class="mdescLeft"> </td><td class="mdescRight">Logging functions for debugging and problem resolving. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__messages"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__messages.html">The SSH message functions</a></td></tr>
<tr class="memdesc:group__libssh__messages"><td class="mdescLeft"> </td><td class="mdescRight">This file contains the Message parsing utilities for server programs using libssh. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__misc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__misc.html">The SSH helper functions.</a></td></tr>
<tr class="memdesc:group__libssh__misc"><td class="mdescLeft"> </td><td class="mdescRight">Different helper functions used in the SSH Library. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__pki"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__pki.html">The SSH Public Key Infrastructure</a></td></tr>
<tr class="memdesc:group__libssh__pki"><td class="mdescLeft"> </td><td class="mdescRight">Functions for the creation, importation and manipulation of public and private keys in the context of the SSH protocol. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__poll"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__poll.html">The SSH poll functions.</a></td></tr>
<tr class="memdesc:group__libssh__poll"><td class="mdescLeft"> </td><td class="mdescRight">Add a generic way to handle sockets asynchronously. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__scp"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__scp.html">The SSH scp functions</a></td></tr>
<tr class="memdesc:group__libssh__scp"><td class="mdescLeft"> </td><td class="mdescRight">SCP protocol over SSH functions. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__session"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__session.html">The SSH session functions.</a></td></tr>
<tr class="memdesc:group__libssh__session"><td class="mdescLeft"> </td><td class="mdescRight">Functions that manage a session. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__string"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__string.html">The SSH string functions</a></td></tr>
<tr class="memdesc:group__libssh__string"><td class="mdescLeft"> </td><td class="mdescRight">String manipulations used in libssh. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__threads"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__threads.html">The SSH threading functions.</a></td></tr>
<tr class="memdesc:group__libssh__threads"><td class="mdescLeft"> </td><td class="mdescRight">Threading with libssh. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga94a851d00248acde9cd7da084b491242"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh.html#ga94a851d00248acde9cd7da084b491242">ssh_finalize</a> (void)</td></tr>
<tr class="memdesc:ga94a851d00248acde9cd7da084b491242"><td class="mdescLeft"> </td><td class="mdescRight">Finalize and cleanup all libssh and cryptographic data structures. <a href="#ga94a851d00248acde9cd7da084b491242">More...</a><br/></td></tr>
<tr class="separator:ga94a851d00248acde9cd7da084b491242"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3ebf8d6920e563f3b032e3cd5277598e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh.html#ga3ebf8d6920e563f3b032e3cd5277598e">ssh_init</a> (void)</td></tr>
<tr class="memdesc:ga3ebf8d6920e563f3b032e3cd5277598e"><td class="mdescLeft"> </td><td class="mdescRight">Initialize global cryptographic data structures. <a href="#ga3ebf8d6920e563f3b032e3cd5277598e">More...</a><br/></td></tr>
<tr class="separator:ga3ebf8d6920e563f3b032e3cd5277598e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The libssh library is implementing the SSH protocols and some of its extensions. </p>
<p>This group of functions is mostly used to implment a SSH client. Some function are needed to implement a SSH server too. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga94a851d00248acde9cd7da084b491242"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_finalize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalize and cleanup all libssh and cryptographic data structures. </p>
<p>This function should only be called once, at the end of the program!</p>
<dl class="section return"><dt>Returns</dt><dd>0 on succes, -1 if an error occured.</dd>
<dd>
0 otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ga3ebf8d6920e563f3b032e3cd5277598e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize global cryptographic data structures. </p>
<p>This function should only be called once, at the beginning of the program, in the main thread. It may be omitted if your program is not multithreaded.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 if an error occured. </dd></dl>
<p>Referenced by <a class="el" href="group__libssh__auth.html#ga9c8517fd342dd68a94045b1e00e15a9d">privatekey_from_file()</a>, <a class="el" href="group__libssh__server.html#gaee5406f486d73aad765cab4c445f2f63">ssh_bind_listen()</a>, and <a class="el" href="group__libssh__session.html#ga032e07cbd8bc3f14cb2dd375db0b03d7">ssh_connect()</a>.</p>
</div>
</div>
</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>
