<!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: include/libssh/legacy.h Source File</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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b9682cd10a3f48e47321de8901f87a77.html">libssh</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">legacy.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * This file is part of the SSH Library</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2010 by Aris Adamantiadis</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * The SSH Library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License as published by</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the Free Software Foundation; either version 2.1 of the License, or (at your</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The SSH Library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * along with the SSH Library; see the file COPYING. If not, write to</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * MA 02111-1307, USA.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/* Since libssh.h includes legacy.h, it's important that libssh.h is included</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * first. we don't define LEGACY_H now because we want it to be defined when</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * included from libssh.h</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * All function calls declared in this header are deprecated and meant to be</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * removed in future.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "libssh/libssh.h"</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifndef LEGACY_H_</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span><span class="preprocessor">#define LEGACY_H_</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span>LIBSSH_API <span class="keywordtype">void</span> buffer_free(ssh_buffer buffer);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> LIBSSH_API <span class="keywordtype">void</span> *buffer_get(ssh_buffer buffer);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> LIBSSH_API uint32_t buffer_get_len(ssh_buffer buffer);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> LIBSSH_API ssh_buffer buffer_new(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> LIBSSH_API ssh_channel channel_accept_x11(ssh_channel channel, <span class="keywordtype">int</span> timeout_ms);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> LIBSSH_API <span class="keywordtype">int</span> channel_change_pty_size(ssh_channel channel,<span class="keywordtype">int</span> cols,<span class="keywordtype">int</span> rows);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> LIBSSH_API ssh_channel channel_forward_accept(ssh_session session, <span class="keywordtype">int</span> timeout_ms);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> LIBSSH_API <span class="keywordtype">int</span> channel_close(ssh_channel channel);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> LIBSSH_API <span class="keywordtype">int</span> channel_forward_cancel(ssh_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *address, <span class="keywordtype">int</span> port);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> LIBSSH_API <span class="keywordtype">int</span> channel_forward_listen(ssh_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *address, <span class="keywordtype">int</span> port, <span class="keywordtype">int</span> *bound_port);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> LIBSSH_API <span class="keywordtype">void</span> channel_free(ssh_channel channel);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> LIBSSH_API <span class="keywordtype">int</span> channel_get_exit_status(ssh_channel channel);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> LIBSSH_API ssh_session channel_get_session(ssh_channel channel);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> LIBSSH_API <span class="keywordtype">int</span> channel_is_closed(ssh_channel channel);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> LIBSSH_API <span class="keywordtype">int</span> channel_is_eof(ssh_channel channel);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> LIBSSH_API <span class="keywordtype">int</span> channel_is_open(ssh_channel channel);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> LIBSSH_API ssh_channel channel_new(ssh_session session);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> LIBSSH_API <span class="keywordtype">int</span> channel_open_forward(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">char</span> *remotehost,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">int</span> remoteport, <span class="keyword">const</span> <span class="keywordtype">char</span> *sourcehost, <span class="keywordtype">int</span> localport);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> LIBSSH_API <span class="keywordtype">int</span> channel_open_session(ssh_channel channel);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> LIBSSH_API <span class="keywordtype">int</span> channel_poll(ssh_channel channel, <span class="keywordtype">int</span> is_stderr);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> LIBSSH_API <span class="keywordtype">int</span> channel_read(ssh_channel channel, <span class="keywordtype">void</span> *dest, uint32_t count, <span class="keywordtype">int</span> is_stderr);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__channel.html#gab391f5c978cb1bc8df3ebd061f38e8c5" title="Read data from a channel into a buffer.">channel_read_buffer</a>(ssh_channel channel, ssh_buffer buffer, uint32_t count,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">int</span> is_stderr);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> LIBSSH_API <span class="keywordtype">int</span> channel_read_nonblocking(ssh_channel channel, <span class="keywordtype">void</span> *dest, uint32_t count,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">int</span> is_stderr);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_env(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_exec(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_pty(ssh_channel channel);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_pty_size(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">char</span> *term,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">int</span> cols, <span class="keywordtype">int</span> rows);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_shell(ssh_channel channel);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_send_signal(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">char</span> *signum);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_sftp(ssh_channel channel);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_subsystem(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">char</span> *subsystem);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> LIBSSH_API <span class="keywordtype">int</span> channel_request_x11(ssh_channel channel, <span class="keywordtype">int</span> single_connection, <span class="keyword">const</span> <span class="keywordtype">char</span> *protocol,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *cookie, <span class="keywordtype">int</span> screen_number);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> LIBSSH_API <span class="keywordtype">int</span> channel_send_eof(ssh_channel channel);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> LIBSSH_API <span class="keywordtype">int</span> channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans, <span class="keyword">struct</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  timeval * timeout);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> LIBSSH_API <span class="keywordtype">void</span> channel_set_blocking(ssh_channel channel, <span class="keywordtype">int</span> blocking);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> LIBSSH_API <span class="keywordtype">int</span> channel_write(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, uint32_t len);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> LIBSSH_API <span class="keywordtype">void</span> <a class="code" href="group__libssh__auth.html#ga083af6f8d42a71fab6185137bf155de2" title="Deallocate a private key object.">privatekey_free</a>(ssh_private_key prv);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> LIBSSH_API ssh_private_key <a class="code" href="group__libssh__auth.html#ga9c8517fd342dd68a94045b1e00e15a9d" title="Reads a SSH private key from a file.">privatekey_from_file</a>(ssh_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *filename,</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">int</span> type, <span class="keyword">const</span> <span class="keywordtype">char</span> *passphrase);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> LIBSSH_API <span class="keywordtype">void</span> publickey_free(ssh_public_key key);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__auth.html#ga21dbd716d13837aa8c70cb3603977606" title="Write a public key to a file.">ssh_publickey_to_file</a>(ssh_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *file,</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  ssh_string pubkey, <span class="keywordtype">int</span> type);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> LIBSSH_API ssh_string <a class="code" href="group__libssh__auth.html#ga40c8ac05358aa941496fd1243ac9ee00" title="Retrieve a public key from a file.">publickey_from_file</a>(ssh_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *filename,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">int</span> *type);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> LIBSSH_API ssh_public_key <a class="code" href="group__libssh__auth.html#gae11c083974e8bfb0ebeb7c6fb9a06baf" title="Make a public_key object out of a private_key object.">publickey_from_privatekey</a>(ssh_private_key prv);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> LIBSSH_API ssh_string <a class="code" href="group__libssh__auth.html#ga1bd48caa6d4fc91a0cbedd04ba56f901" title="Convert a public_key object into a a SSH string.">publickey_to_string</a>(ssh_public_key key);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> LIBSSH_API ssh_message ssh_message_retrieve(ssh_session session, uint32_t packettype);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> LIBSSH_API <span class="keywordtype">void</span> string_burn(ssh_string str);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> LIBSSH_API ssh_string string_copy(ssh_string str);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> LIBSSH_API <span class="keywordtype">void</span> *string_data(ssh_string str);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> LIBSSH_API <span class="keywordtype">int</span> string_fill(ssh_string str, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> LIBSSH_API <span class="keywordtype">void</span> string_free(ssh_string str);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> LIBSSH_API ssh_string string_from_char(<span class="keyword">const</span> <span class="keywordtype">char</span> *what);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> LIBSSH_API <span class="keywordtype">size_t</span> string_len(ssh_string str);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> LIBSSH_API ssh_string string_new(<span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> LIBSSH_API <span class="keywordtype">char</span> *string_to_char(ssh_string str);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif </span><span class="comment">/* LEGACY_H_ */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></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>
