From c6d03c10d7cd9a4d2d56a6acd471ba623b5a73a4 Mon Sep 17 00:00:00 2001 From: Niclas Eklund Date: Fri, 10 Jun 2011 13:35:47 +0200 Subject: ssh: Added User's Guide framework and minor enhancements --- lib/ssh/doc/src/Makefile | 15 ++++-- lib/ssh/doc/src/SSH_protocols.png | Bin 0 -> 15381 bytes lib/ssh/doc/src/book.xml | 3 ++ lib/ssh/doc/src/make.dep | 19 ++++++++ lib/ssh/doc/src/part.xml | 35 ++++++++++++++ lib/ssh/doc/src/ssh.xml | 2 +- lib/ssh/doc/src/ssh_ug.xml | 95 ++++++++++++++++++++++++++++++++++++++ 7 files changed, 164 insertions(+), 5 deletions(-) create mode 100644 lib/ssh/doc/src/SSH_protocols.png create mode 100644 lib/ssh/doc/src/make.dep create mode 100644 lib/ssh/doc/src/part.xml create mode 100644 lib/ssh/doc/src/ssh_ug.xml (limited to 'lib/ssh/doc/src') diff --git a/lib/ssh/doc/src/Makefile b/lib/ssh/doc/src/Makefile index da99c4ea0f..bf65a2a60c 100644 --- a/lib/ssh/doc/src/Makefile +++ b/lib/ssh/doc/src/Makefile @@ -44,14 +44,18 @@ XML_REF3_FILES = \ ssh_sftp.xml \ ssh_sftpd.xml \ -XML_PART_FILES = part_notes.xml -XML_CHAPTER_FILES = notes.xml +XML_PART_FILES = part_notes.xml \ + part.xml +XML_CHAPTER_FILES = notes.xml \ + ssh_ug.xml BOOK_FILES = book.xml XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ $(XML_PART_FILES) $(XML_CHAPTER_FILES) +IMAGE_FILES = SSH_protocols.png + # ---------------------------------------------------- HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ @@ -80,16 +84,19 @@ DVIPS_FLAGS += # ---------------------------------------------------- # Targets # ---------------------------------------------------- -$(HTMLDIR)/%.gif: %.gif +$(HTMLDIR)/%.png: %.png $(INSTALL_DATA) $< $@ docs: pdf html man $(TOP_PDF_FILE): $(XML_FILES) +images: $(IMAGE_FILES:%=$(HTMLDIR)/%) + pdf: $(TOP_PDF_FILE) -html: $(HTML_REF_MAN_FILE) +html: images $(HTML_REF_MAN_FILE) + clean clean_docs: rm -rf $(HTMLDIR)/* diff --git a/lib/ssh/doc/src/SSH_protocols.png b/lib/ssh/doc/src/SSH_protocols.png new file mode 100644 index 0000000000..145c96c4cd Binary files /dev/null and b/lib/ssh/doc/src/SSH_protocols.png differ diff --git a/lib/ssh/doc/src/book.xml b/lib/ssh/doc/src/book.xml index fcec1d6f70..d33d9faf15 100644 --- a/lib/ssh/doc/src/book.xml +++ b/lib/ssh/doc/src/book.xml @@ -34,6 +34,9 @@ + + + diff --git a/lib/ssh/doc/src/make.dep b/lib/ssh/doc/src/make.dep new file mode 100644 index 0000000000..9be373481a --- /dev/null +++ b/lib/ssh/doc/src/make.dep @@ -0,0 +1,19 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: book.tex ref_man.tex ssh_ug.tex ssh.tex ssh_channel.tex \ + ssh_connection.tex ssh_sftp.tex ssh_sftpd.tex + +# ---------------------------------------------------- +# Source inlined when transforming from source to LaTeX +# ---------------------------------------------------- + +book.tex: ref_man.xml diff --git a/lib/ssh/doc/src/part.xml b/lib/ssh/doc/src/part.xml new file mode 100644 index 0000000000..cca30182a1 --- /dev/null +++ b/lib/ssh/doc/src/part.xml @@ -0,0 +1,35 @@ + + + + +
+ + 2011 + Ericsson AB. All Rights Reserved. + + + 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. + + + + SSH User's Guide + + + + +
+ +

The SSH application is an Erlang implementation of the + SSH protocol.

+ + + diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 04b7a2ae56..9f8efebbf5 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -217,7 +217,7 @@ daemon(Port) -> daemon(Port, Options) -> - daemon(HostAddress, Port, Options) -> ssh_daemon_ref() + daemon(HostAddress, Port, Options) -> {ok, ssh_daemon_ref()} | {error, atom()} Starts a server listening for SSH connections on the given port. diff --git a/lib/ssh/doc/src/ssh_ug.xml b/lib/ssh/doc/src/ssh_ug.xml new file mode 100644 index 0000000000..0b040a59fd --- /dev/null +++ b/lib/ssh/doc/src/ssh_ug.xml @@ -0,0 +1,95 @@ + + + + +
+ + 2011 + Ericsson AB. All Rights Reserved. + + + The program may be used and/or copied only with the written permission from + Ericsson AB, or in accordance with the terms and conditions stipulated in + the agreement/contract under which the program has been supplied. + + SSH + OTP + + + A + ssh_ug.xml +
+ +
+ Introduction +

The Secure Shell (SSH) is a transport protocol. For more detailed information, + see the following RFCs: +

+ + RFC 4250 - + Protocol Assigned Numbers. + RFC 4251 - + Protocol Architecture. + RFC 4252 - + Authentication Protocol. + RFC 4253 - + Transport Layer Protocol. + RFC 4254 - + Connection Protocol. + RFC 4255 - + Key Fingerprints. + RFC 4344 - + Transport Layer Encryption Modes. + RFC 4716 - + Public Key File Format. + + +

The SSH application is an implementation of the SSH protocol + in Erlang. Conceptually it can be partitioned into four layers:

+ + + SSH Protocol Dependencies + + +
+ +
+ Overview +

The SSH application supports:

+ + + Subsystem - user-named services such as ssh_sftp. + The user can also add other subsystems (e.g. NETCONF). + Shell - interactive shell. + Exec - one-time remote execution (i.e. SCP). See ssh_connection:exec/4 + + + +
+ +
+ Configuration and Start + +

Before the SSH application can be used, there are two things that must be fulfilled:

+ + The Crypto application is started before SSH is. + The Public_key application is loaded when + running an embedded system. + + +
+ Server Side + +

When SSH is supposed to run as server, the function ssh:daemon/[1, 2, 3] needs to + be used to start the daemon.

+ +
+
+ Client Side + +

The client.

+ +
+
+ + -- cgit v1.2.3