path: root/lib/ssh/doc/src/introduction.xml

<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">

<chapter>
  <header>
    <copyright>
      <year>2012</year>
      <year>2013</year>
      <holder>Ericsson AB, All Rights Reserved</holder>
    </copyright>
    <legalnotice>
  The contents of this file are subject to the Erlang Public License,
  Version 1.1, (the "License"); you may not use this file except in
  compliance with the License. You should have received a copy of the
  Erlang Public License along with this software. If not, it can be
  retrieved online at http://www.erlang.org/.

  Software distributed under the License is distributed on an "AS IS"
  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  the License for the specific language governing rights and limitations
  under the License.

  The Initial Developer of the Original Code is Ericsson AB.
    </legalnotice>

    <title>Introduction</title>
    <prepared>OTP team</prepared>
    <file>introduction.xml</file>
  </header>

  <section>
    <title>Purpose</title>

    <p>Secure Shell (SSH) is a protocol for secure remote login and
    other secure network services over an insecure network. SSH
    provides a single, full-duplex, byte-oriented connection between
    client and server. The protocol also provides privacy, integrity,
    server authentication and man-in-the-middle protection.</p>

    <p>The Erlang SSH application is an implementation of the SSH
    protocol in Erlang which offers API functions to write customized
    SSH clients and servers as well as making the Erlang shell
    available via SSH. Also included in the SSH application are an
    SFTP (SSH File Transfer Protocol) client <seealso
    marker="ssh_sftp">ssh_sftp</seealso> and server <seealso
    marker="ssh_sftp">ssh_sftpd</seealso>.</p>
  </section>

  <section>
    <title>Prerequisites</title>
    <p>It is assumed that the reader is familiar with the concepts of <seealso marker="doc/design_principals:des_princ">OTP</seealso>
    and has a basic understanding of <url href="http://en.wikipedia.org/wiki/Public-key_cryptography">public keys</url>.</p>
  </section>

</chapter>