<!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 Tutorial</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 class="current"><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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="index.html">index</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">The Tutorial </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="introduction"></a>
Introduction</h1>
<p>libssh is a C library that enables you to write a program that uses the SSH protocol. With it, you can remotely execute programs, transfer files, or use a secure and transparent tunnel for your remote programs. The SSH protocol is encrypted, ensures data integrity, and provides strong means of authenticating both the server of the client. The library hides a lot of technical details from the SSH protocol, but this does not mean that you should not try to know about and understand these details.</p>
<p>libssh is a Free Software / Open Source project. The libssh library is distributed under LGPL license. The libssh project has nothing to do with "libssh2", which is a completly different and independant project.</p>
<p>libssh can run on top of either libgcrypt (<a href="http://directory.fsf.org/project/libgcrypt/">http://directory.fsf.org/project/libgcrypt/</a>) or libcrypto (<a href="http://www.openssl.org/docs/crypto/crypto.html">http://www.openssl.org/docs/crypto/crypto.html</a>), two general-purpose cryptographic libraries.</p>
<p>This tutorial concentrates for its main part on the "client" side of libssh. To learn how to accept incoming SSH connexions (how to write a SSH server), you'll have to jump to the end of this document.</p>
<p>This tutorial describes libssh version 0.5.0. This version is a little different from the 0.4.X series. However, the examples should work with little changes on versions like 0.4.2 and later.</p>
<p>Table of contents:</p>
<p><a class="el" href="libssh_tutor_guided_tour.html">Chapter 1: A typical SSH session</a></p>
<p><a class="el" href="libssh_tutor_authentication.html">Chapter 2: A deeper insight on authentication</a></p>
<p><a class="el" href="libssh_tutor_shell.html">Chapter 3: Opening a remote shell</a></p>
<p><a class="el" href="libssh_tutor_command.html">Chapter 4: Passing a remote command</a></p>
<p><a class="el" href="libssh_tutor_sftp.html">Chapter 5: The SFTP subsystem</a></p>
<p><a class="el" href="libssh_tutor_scp.html">Chapter 6: The SCP subsystem</a></p>
<p><a class="el" href="libssh_tutor_forwarding.html">Chapter 7: Forwarding connections (tunnel)</a></p>
<p><a class="el" href="libssh_tutor_threads.html">Chapter 8: Threads with libssh</a></p>
<p><a class="el" href="libssh_tutor_todo.html">To be done</a> </p>
</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>
