docs: added chapter "Network startup activity" to the Developer Guide

bareos · Jul 1, 2019 · 4417cd3 · 4417cd3
1 parent b811c29
commit 4417cd3
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 1 deletion.
diff --git a/docs/manuals/source/DeveloperGuide/netprotocol.rst b/docs/manuals/source/DeveloperGuide/netprotocol.rst
@@ -198,3 +198,50 @@ The client will perform the following:
 
 Thus the client will send multiple packets and signal to the server when
 all the packets have been sent by sending a zero length record.
+
+Network startup activity
+------------------------
+
+The following diagram shows the activity on a Bareos TCP server (i.e. a |dir| or a |sd|) when a TCP client initiates a network connection. The connection protocol has two possible handshake modes. Cleartext first or TLS first. Depending on the configuration, the Bareos version and the type of client (i.e. |fd| or |bconsole|) the handshake mode will be chosen. See chapter :ref:`section-TlsTechnicalDocumentation` for detailed information. 
+
+.. uml::
+  :caption: Network startup activity (Bareos TCP-Server)
+
+  start
+
+  :accept TCP socket;
+
+  if (evaluation of cleartext hello \nis successfus) then (yes)
+    if (is cleartext hello ?) then (yes)
+      if (is R_CLIENT ?) then (yes)
+        if (TLS required) then (yes)
+          :Close connection;
+          stop
+        else (no)
+          :Do cleartext \nhandshake;
+        endif
+      elseif (is R_CONSOLE AND \nconsole version < 18.2 ?) then (yes)
+          :Do cleartext \nhandshake;
+      elseif (TLS not configured) then (yes)
+        :Do cleartext \nhandshake;
+      else
+        :Close connection;
+        stop
+      endif
+      :Do cleartext handshake;
+    else (no)
+      :Do TLS handshake \nas a server;
+      if (TLS handshake successful ?) then (no)
+        :Close connection;
+        stop
+      else (yes)
+      endif
+    endif
+  else (no)
+    :Close connection;
+    stop
+  endif
+
+  :Handle client message;
+  end
+
diff --git a/docs/manuals/source/DeveloperGuide/tls-techdoc.rst b/docs/manuals/source/DeveloperGuide/tls-techdoc.rst
@@ -1,3 +1,5 @@
+.. _section-TlsTechnicalDocumentation:
+
 TLS
 ===
 

diff --git a/docs/manuals/source/TasksAndConcepts/NetworkSetup.rst b/docs/manuals/source/TasksAndConcepts/NetworkSetup.rst
@@ -552,4 +552,3 @@ Tray-Monitor
   arrow(Tray, down, FD, 10)
   arrow(Tray, down, SD, 11)
 
-