From 6cedde4ae59a6e8505d7fc8ac22111a7a8b15e4c Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Wed, 22 Apr 2015 16:17:50 +0200
Subject: ssh: Move code example to Users Guide

---
 lib/ssh/doc/src/ssh_sftp.xml  | 65 +++--------------------------------------
 lib/ssh/doc/src/using_ssh.xml | 67 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 71 insertions(+), 61 deletions(-)

(limited to 'lib/ssh/doc/src')

diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index d52613c6bc..4ed5a38de4 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -300,20 +300,9 @@
 	<seealso marker="stdlib:erl_tar#init-3">erl_tar:init/3</seealso> function.
 	</p>
 
-	<p>Example of writing and then reading a tar file follows:</p>
-        <code type="erlang">
-          {ok,HandleWrite} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [write]),
-          ok = erl_tar:add(HandleWrite, .... ),
-          ok = erl_tar:add(HandleWrite, .... ),
-              ...
-          ok = erl_tar:add(HandleWrite, .... ),
-          ok = erl_tar:close(HandleWrite),
-
-          %% And for reading
-          {ok,HandleRead} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [read]),
-          {ok,NameValueList} = erl_tar:extract(HandleRead,[memory]),
-          ok = erl_tar:close(HandleRead),
-        </code>
+	<p> For code exampel see Section
+	<seealso marker="using_ssh">SFTP Client with TAR Compression and Encryption</seealso> in
+	the ssh Users Guide. </p>
 
 	<p>The <c>crypto</c> mode option is applied to the generated stream of bytes prior to sending
 	them to the SFTP server. This is intended for encryption but can be used for other
@@ -332,53 +321,7 @@
 	<c>ChunkSize</c>s can be changed in the return from the <c>EncryptFun</c> or
 	<c>DecryptFun</c>. The value can be changed between <c>pos_integer()</c> and <c>undefined</c>.
 	</p>
-	<p>The previous write and read example can be extended with encryption and decryption as follows:</p>
-        <code type="erlang">
-          %% First three parameters depending on which crypto type we select:
-          Key = &lt;&lt;"This is a 256 bit key. abcdefghi">>,
-          Ivec0 = crypto:rand_bytes(16),
-          DataSize = 1024,  % DataSize rem 16 = 0 for aes_cbc
-
-          %% Initialization of the CryptoState, in this case it is the Ivector.
-          InitFun = fun() -> {ok, Ivec0, DataSize} end,
-
-          %% How to encrypt:
-          EncryptFun = 
-              fun(PlainBin,Ivec) -> 
-                   EncryptedBin = crypto:block_encrypt(aes_cbc256, Key, Ivec, PlainBin),
-                   {ok, EncryptedBin, crypto:next_iv(aes_cbc,EncryptedBin)}
-              end,
-
-          %% What to do with the very last block:
-          CloseFun = 
-              fun(PlainBin, Ivec) ->
-                    EncryptedBin = crypto:block_encrypt(aes_cbc256, Key, Ivec, 
-                                                     pad(16,PlainBin) %% Last chunk
-                                                     ),
-                    {ok, EncryptedBin} 
-            end,
-
-          Cw = {InitFun,EncryptFun,CloseFun},
-          {ok,HandleWrite} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [write,{crypto,Cw}]),
-          ok = erl_tar:add(HandleWrite, .... ),
-          ok = erl_tar:add(HandleWrite, .... ),
-              ...
-          ok = erl_tar:add(HandleWrite, .... ),
-          ok = erl_tar:close(HandleWrite),
-
-          %% And for decryption (in this crypto example we could use the same InitFun
-          %% as for encryption):
-          DecryptFun = 
-              fun(EncryptedBin,Ivec) ->
-                   PlainBin = crypto:block_decrypt(aes_cbc256, Key, Ivec, EncryptedBin),
-                   {ok, PlainBin, crypto:next_iv(aes_cbc,EncryptedBin)}
-              end,
-
-          Cr = {InitFun,DecryptFun},
-          {ok,HandleRead} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [read,{crypto,Cw}]),
-          {ok,NameValueList} = erl_tar:extract(HandleRead,[memory]),
-          ok = erl_tar:close(HandleRead),
-        </code>
+
       </desc>
     </func>
 
diff --git a/lib/ssh/doc/src/using_ssh.xml b/lib/ssh/doc/src/using_ssh.xml
index 64477cb493..9da839d072 100644
--- a/lib/ssh/doc/src/using_ssh.xml
+++ b/lib/ssh/doc/src/using_ssh.xml
@@ -228,6 +228,73 @@
     </code>
   </section>
 
+  <section>
+    <title>SFTP Client with TAR Compression and Encryption</title>
+
+    <p>Example of writing and then reading a tar file follows:</p>
+    <code type="erlang">
+      {ok,HandleWrite} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [write]),
+      ok = erl_tar:add(HandleWrite, .... ),
+      ok = erl_tar:add(HandleWrite, .... ),
+      ...
+      ok = erl_tar:add(HandleWrite, .... ),
+      ok = erl_tar:close(HandleWrite),
+
+      %% And for reading
+      {ok,HandleRead} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [read]),
+      {ok,NameValueList} = erl_tar:extract(HandleRead,[memory]),
+      ok = erl_tar:close(HandleRead),
+    </code>
+
+    <p>The previous write and read example can be extended with encryption and decryption as follows:</p>
+    <code type="erlang">
+      %% First three parameters depending on which crypto type we select:
+      Key = &lt;&lt;"This is a 256 bit key. abcdefghi">>,
+      Ivec0 = crypto:rand_bytes(16),
+      DataSize = 1024,  % DataSize rem 16 = 0 for aes_cbc
+
+      %% Initialization of the CryptoState, in this case it is the Ivector.
+      InitFun = fun() -> {ok, Ivec0, DataSize} end,
+
+      %% How to encrypt:
+      EncryptFun =
+      fun(PlainBin,Ivec) ->
+      EncryptedBin = crypto:block_encrypt(aes_cbc256, Key, Ivec, PlainBin),
+      {ok, EncryptedBin, crypto:next_iv(aes_cbc,EncryptedBin)}
+      end,
+
+      %% What to do with the very last block:
+      CloseFun =
+      fun(PlainBin, Ivec) ->
+      EncryptedBin = crypto:block_encrypt(aes_cbc256, Key, Ivec,
+      pad(16,PlainBin) %% Last chunk
+      ),
+      {ok, EncryptedBin}
+      end,
+
+      Cw = {InitFun,EncryptFun,CloseFun},
+      {ok,HandleWrite} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [write,{crypto,Cw}]),
+      ok = erl_tar:add(HandleWrite, .... ),
+      ok = erl_tar:add(HandleWrite, .... ),
+      ...
+      ok = erl_tar:add(HandleWrite, .... ),
+      ok = erl_tar:close(HandleWrite),
+
+      %% And for decryption (in this crypto example we could use the same InitFun
+      %% as for encryption):
+      DecryptFun =
+      fun(EncryptedBin,Ivec) ->
+      PlainBin = crypto:block_decrypt(aes_cbc256, Key, Ivec, EncryptedBin),
+      {ok, PlainBin, crypto:next_iv(aes_cbc,EncryptedBin)}
+      end,
+
+      Cr = {InitFun,DecryptFun},
+      {ok,HandleRead} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [read,{crypto,Cw}]),
+      {ok,NameValueList} = erl_tar:extract(HandleRead,[memory]),
+      ok = erl_tar:close(HandleRead),
+    </code>
+  </section>
+
   <section>
     <title>Creating a Subsystem</title>
 
-- 
cgit v1.2.3