<!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 SSH Public Key Infrastructure</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">The SSH Public Key Infrastructure<div class="ingroups"><a class="el" href="group__libssh.html">The libssh API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Functions for the creation, importation and manipulation of public and private keys in the context of the SSH protocol.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga9ee6aacb86cb7f4e8f3b5ec582040d3a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__pki.html#ga9ee6aacb86cb7f4e8f3b5ec582040d3a">ssh_key_clean</a> (ssh_key key)</td></tr>
<tr class="memdesc:ga9ee6aacb86cb7f4e8f3b5ec582040d3a"><td class="mdescLeft"> </td><td class="mdescRight">clean up the key and deallocate all existing keys <a href="#ga9ee6aacb86cb7f4e8f3b5ec582040d3a">More...</a><br/></td></tr>
<tr class="separator:ga9ee6aacb86cb7f4e8f3b5ec582040d3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga08808beb83a42ccd6f1c710ddeb1b4c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__pki.html#ga08808beb83a42ccd6f1c710ddeb1b4c2">ssh_key_free</a> (ssh_key key)</td></tr>
<tr class="memdesc:ga08808beb83a42ccd6f1c710ddeb1b4c2"><td class="mdescLeft"> </td><td class="mdescRight">deallocate a SSH key <a href="#ga08808beb83a42ccd6f1c710ddeb1b4c2">More...</a><br/></td></tr>
<tr class="separator:ga08808beb83a42ccd6f1c710ddeb1b4c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga006a01fce17d24d5e83d946c78b0e252"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__pki.html#ga006a01fce17d24d5e83d946c78b0e252">ssh_key_import_private</a> (ssh_key key, ssh_session session, const char *filename, const char *passphrase)</td></tr>
<tr class="memdesc:ga006a01fce17d24d5e83d946c78b0e252"><td class="mdescLeft"> </td><td class="mdescRight">import a key from a file <a href="#ga006a01fce17d24d5e83d946c78b0e252">More...</a><br/></td></tr>
<tr class="separator:ga006a01fce17d24d5e83d946c78b0e252"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabfebce03474a4d014aa779d5dbf057b0"><td class="memItemLeft" align="right" valign="top">ssh_key </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__pki.html#gabfebce03474a4d014aa779d5dbf057b0">ssh_key_new</a> (void)</td></tr>
<tr class="memdesc:gabfebce03474a4d014aa779d5dbf057b0"><td class="mdescLeft"> </td><td class="mdescRight">creates a new empty SSH key <a href="#gabfebce03474a4d014aa779d5dbf057b0">More...</a><br/></td></tr>
<tr class="separator:gabfebce03474a4d014aa779d5dbf057b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga36d3ebe83652057772d028fa84d87fc2"><td class="memItemLeft" align="right" valign="top">enum ssh_keytypes_e </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__pki.html#ga36d3ebe83652057772d028fa84d87fc2">ssh_key_type</a> (ssh_key key)</td></tr>
<tr class="memdesc:ga36d3ebe83652057772d028fa84d87fc2"><td class="mdescLeft"> </td><td class="mdescRight">returns the type of a ssh key <a href="#ga36d3ebe83652057772d028fa84d87fc2">More...</a><br/></td></tr>
<tr class="separator:ga36d3ebe83652057772d028fa84d87fc2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions for the creation, importation and manipulation of public and private keys in the context of the SSH protocol. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga9ee6aacb86cb7f4e8f3b5ec582040d3a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssh_key_clean </td>
<td>(</td>
<td class="paramtype">ssh_key </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>clean up the key and deallocate all existing keys </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>ssh_key to clean </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="group__libssh__pki.html#ga08808beb83a42ccd6f1c710ddeb1b4c2">ssh_key_free()</a>, and <a class="el" href="group__libssh__pki.html#ga006a01fce17d24d5e83d946c78b0e252">ssh_key_import_private()</a>.</p>
</div>
</div>
<a class="anchor" id="ga08808beb83a42ccd6f1c710ddeb1b4c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssh_key_free </td>
<td>(</td>
<td class="paramtype">ssh_key </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>deallocate a SSH key </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>ssh_key handle to free </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="group__libssh__pki.html#ga9ee6aacb86cb7f4e8f3b5ec582040d3a">ssh_key_clean()</a>.</p>
</div>
</div>
<a class="anchor" id="ga006a01fce17d24d5e83d946c78b0e252"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_key_import_private </td>
<td>(</td>
<td class="paramtype">ssh_key </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ssh_session </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>passphrase</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>import a key from a file </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">key</td><td>the ssh_key to update </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>The SSH Session to use. If a key decryption callback is set, it will be used to ask for the passphrase. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>The filename of the the private key. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">passphrase</td><td>The passphrase to decrypt the private key. Set to null if none is needed or it is unknown. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_OK on success, SSH_ERROR otherwise. </dd></dl>
<p>References <a class="el" href="group__libssh__auth.html#ga9c8517fd342dd68a94045b1e00e15a9d">privatekey_from_file()</a>, and <a class="el" href="group__libssh__pki.html#ga9ee6aacb86cb7f4e8f3b5ec582040d3a">ssh_key_clean()</a>.</p>
</div>
</div>
<a class="anchor" id="gabfebce03474a4d014aa779d5dbf057b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_key ssh_key_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>creates a new empty SSH key </p>
<dl class="section return"><dt>Returns</dt><dd>an empty ssh_key handle, or NULL on error. </dd></dl>
</div>
</div>
<a class="anchor" id="ga36d3ebe83652057772d028fa84d87fc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum ssh_keytypes_e ssh_key_type </td>
<td>(</td>
<td class="paramtype">ssh_key </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the type of a ssh key </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>the ssh_key handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>one of SSH_KEYTYPE_RSA,SSH_KEYTYPE_DSS,SSH_KEYTYPE_RSA1 </dd>
<dd>
SSH_KEYTYPE_UNKNOWN if the type is unknown </dd></dl>
</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>
