Doc structure

Author: The5imon

docs/conf.py

@@ -27,7 +27,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['recommonmark', 'sphinx_rtd_theme']
+extensions = ['recommonmark', 'sphinx_rtd_theme', 'sphinx.ext.autosectionlabel']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/index.rst

@@ -6,11 +6,12 @@
  SSH-MITM Plugins Documentation
 ============================================
 
+Home
+======
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
    start
-   injectorshell
-   stealthshell
-   scriptedshell
+   ssh-interfaces
+

docs/injectorshell.rst

@@ -3,13 +3,13 @@ Injectorshell
 
 
 
-.. info::
-It should also be noted that shell environment can be affected by any injector shell and is not accounted for when
-considering stealth. This means environment variables or the working directory for example can be changed by any
-injector shell and will alert the original shells owner of faulty operation.
+.. note::
+    It should also be noted that shell environment can be affected by any injector shell and is not accounted for when
+    considering stealth. This means environment variables or the working directory for example can be changed by any
+    injector shell and will alert the original shells owner of faulty operation.
 
 .. important::
-It is also important to mention that when multiple injector shells are inserting commands into the same hijacked ssh
-session at the same time discrepancies are not accounted for. Keystrokes are collectively merged at the server and the
-responses are served accordingly. This is also true for the clients interactive ssh session. A advanced edition of the
-injectorshell fixes both these problems.
+    It is also important to mention that when multiple injector shells are inserting commands into the same hijacked ssh
+    session at the same time discrepancies are not accounted for. Keystrokes are collectively merged at the server and the
+    responses are served accordingly. This is also true for the clients interactive ssh session. A advanced edition of the
+    injectorshell fixes both these problems.

docs/ssh-interfaces.rst

@@ -0,0 +1,9 @@
+SSH Interfaces
+============================================
+
+.. toctree::
+   :maxdepth: 2
+
+   injectorshell
+   stealthshell
+   scriptedshell

docs/start.rst

@@ -1,3 +1,4 @@
 Start
-=================
+======
 
+This is the documentation for ssh-mitm plugins.

docs/stealthshell.rst

@@ -1,23 +1,23 @@
 Stealthshell
 =================
 
-As an upgrade to the `injectorshell`_ (implementation in `ssh-mitm <http://ssh-mitm.at/>`_ done by me) the stealthshell
+As an upgrade to the :ref:`injectorshell` (implementation in `ssh-mitm <http://ssh-mitm.at/>`_ done by me) the stealthshell
 provides a way to workaround the problem of interfering with the clients interactive session.
 It only executes injected commands when the shell of the user wont be affected. As long as the interactive shell of the
 client is not typing or executing a command input from the injector shells is halted and put in a waiting queue.
 
 Using the ``--ssh-injector-super-stealth`` option the injector shells will only send whole commands instead of
 every keystroke. This further eliminates unwanted behavior. Unfinished commands from the injector shells are not seen
 by the server and the user of the interactive shell will never be surprised by input they never typed. This, however,
-will limit the terminal functionality of the injector shell. Because the server only responds to the whole command
+will limit the terminal functionality of the injector shell. Because the server only responds to the whole command,
 terminal features like command auto-completion when pressing tab or command history with the up and down keys will not
 work correctly.
 
 
-.. info::
-Environment considerations of the `injectorshell`_ are still uphold by the stealthshell. Discrepancy problems
-described by the `injectorshell`_ are solved by this newer edition (client cannot be interrupted by injected keystrokes BUT
-unfinished injected strokes will be seen by the server). Only with the ``--ssh-injector-super-stealth`` option the
-discrepancy between the user and all injector shells can be eliminated.
+.. note::
+    Environment considerations of the :ref:`injectorshell` are still uphold by the stealthshell. Discrepancy problems
+    described by the :ref:`injectorshell` are solved by this newer edition (client cannot be interrupted by injected keystrokes BUT
+    unfinished injected strokes will be seen by the server). Only with the ``--ssh-injector-super-stealth`` option the
+    discrepancy between the user and all injector shells will not occur.