libssh  0.5.2
libssh Documentation

This is the online reference for developing with the libssh library. It documents the libssh C API and the C++ wrapper.

Linking

We created a small howto how to link libssh against your application, read The Linking HowTo.

Tutorial

You should start by reading The Tutorial, then reading the documentation of the interesting functions as you go.

Features

The libssh library provides:

Copyright Policy

The developers of libssh have a policy of asking for contributions to be made under the personal copyright of the contributor, instead of a corporate copyright.

There are some reasons for the establishment of this policy:

Internet standard

Secure Shell (SSH)

The following RFC documents described SSH-2 protcol as an Internet standard.

It was later modified and expanded by the following RFCs.

Interesting cryptography documents:

Secure Shell File Transfer Protocol (SFTP)

The protocol is not an Internet standard but it is still widely implemented. OpenSSH and most other implementation implement Version 3 of the protocol. We do the same in libssh.

Secure Shell Extensions

The OpenSSH project has defined some extensions to the protocol. We support some of them like the statvfs calls in SFTP or the ssh-agent.