README.md and scriptedshell docs

Author: The5imon

README.md

@@ -1 +1,44 @@
-# SSH-MITM Plugins
+# SSH-MITM Plugins
+
+![SSH-MITM example](https://ssh-mitm.at/img/mitm-example.png)
+
+
+
+After working on features and functionality of the
+[ssh-mitm](http://ssh-mitm.at/)
+project it was decided that the features of the ssh-mitm version 0.4.0
+should be locked and any further additions to its feature-set should be
+made externally.
+This was done to keep the ssh-mitm project to its core functionality.
+The ssh-mitm plugins are advanced features that should enhance the capabilities of the ssh-mitm server.
+Here you will find detailed feature-oriented documentation of the creators
+additions to the ssh-mitm project.
+
+## Installation
+
+Installing the ssh-mitm server including these plugins is very simple:
+
+    $ pip install ssh-mitm-plugins
+    
+The current version of the ssh-mitm server will be installed and additional advanced features
+will be available through these plugins. The ssh-mitm server will operate normally as described
+by the [ssh-mitm project](#ssh-mitm).
+
+## Plugins
+
+Following advanced features will be made available through the modular runtime compilation of 
+the ssh-mitm server.
+
+#### SSH 
+* stealthshell - improving on the injectorshell, this ssh interface will
+make hijacking of a ssh session undetectable
+* scriptedshell - perfect for security audits and information gathering, this ssh interface executes
+a script on the remote machine and stores the output on the ssh-mitm server
+
+## SSH-MITM
+
+**For more information about the core functionality of the ssh-mitm server visit:**
+
+* Github        - https://github.com/ssh-mitm/ssh-mitm
+* Website       - http://ssh-mitm.at
+* Documentation - http://docs.ssh-mitm.at

docs/injectorshell.rst

@@ -11,7 +11,7 @@ mirrorshell there can be multiple injected shells per ssh session. All these she
 share their environment but are served answers individually.
 
 Using the ``--ssh-injector-enable-mirror`` option injected shells can print the input of the user to their screen.
-This differs from the mirrorshell which always displays every keystroke on both terminals. The injectorshell
+This differs from the mirrorshell which always displays output on the injected as well as the clients shell. The injectorshell
 tries its best to not leak any unwanted output to the users session so that they can operate normally.
 
 By default injector shell access is limited to the local maschine ``localhost`` but can be opened up to any

docs/scriptedshell.rst

@@ -4,4 +4,13 @@ scriptedshell
 When working through a security audit gathering information is one of the most important steps.
 
 The scriptedshell ssh interface is first and foremost an information gathering tool but due to its
-functionality it can also be used for different use cases.
+functionality it can also be used for different use cases. This plugin will execute a shell script
+when a new ssh session is opened by a client. The output of the script will be stored locally on the
+ssh-mitm machine under their respective session name.
+
+.. note::
+    Stored script output is taken from the server as-is with some ANSI control characters removed.
+
+The ``--ssh-script SCRIPT`` parameter declares the location of the script.
+
+The ``--ssh-out-dir DIR`` parameter indicates where the output of each session script execution should be stored.

docs/start.rst

@@ -1,4 +1,10 @@
 Start
 ======
 
-This is the documentation for ssh-mitm plugins.
+After working on features and functionality of the `ssh-mitm <http://ssh-mitm.at/>`_
+project it was decided that the features of the ssh-mitm version 0.4.0
+should be locked and any further additions to its feature-set should be made externally.
+This was done to keep the ssh-mitm project to its core functionality.
+The ssh-mitm plugins are advanced features that should enhance the capabilities of the
+ssh-mitm server.
+Here you will find detailed feature-oriented documentation of the creators additions to the ssh-mitm project.

docs/stealthshell.rst

@@ -17,8 +17,8 @@ work correctly.
 .. 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. It is recommended that the ``--ssh-injector-super-stealth``
+    unfinished injected strokes will be seen by the server). Only with the ``--ssh-injector-super-stealth`` option will the
+    discrepancy between the user and all injector shells not occur. It is recommended that the ``--ssh-injector-super-stealth``
     option is used in combination with the ``--ssh-injector-enable-mirror`` option to see more clearly when commands
     can be executed.