update documetation

ThreatResponse · Sep 3, 2016 · cb0b7db · cb0b7db
1 parent f25d592
commit cb0b7db
Show file tree

Hide file tree

Showing 8 changed files with 214 additions and 174 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,108 @@
+Margarita Shotgun
+=================
+
+Python Remote Memory Aquisition
+
+Documentation
+-------------
+
+Read the full documentation on `read the docs <https://margaritashotgun.readthedocs.io/en/latest/>`__.
+
+Quickstart
+**********
+
+For more information see the `user guide <https://margaritashotgun.readthedocs.io/en/latest/user_guide.html/>`__.
+
+Installation
+~~~~~~~~~~~~
+
+``pip install git+ssh://git@github.com/ThreatResponse/margaritashotgun.git@master``
+
+Or see `installing <https://margaritashotgun.readthedocs.io/en/latest/installing.html>`__.
+
+Capture A Single Machine
+************************
+
+A single machine can be captured using only the command line arguments for margaritashotgun.
+First specify the server and user with the ``-s`` and ``-u`` flags respectively.
+Next provide a path to an ssh key with ``-k`` (or use a password with the ``-p`` flag).
+Finally provide a lime kernel module with ``-m`` and specify an output file with ``-f``
+
+::
+
+   margaritashotgun -s 172.16.20.10 -u root -k root_access.pem -m lime-3.13.0-74-generic.ko -f 172.16.20.10-mem.lime
+
+Save Memory In S3
+*****************
+
+To save a file to s3 simply replace the ``-f`` or ``filename`` flags with ``-b`` or ``--bucket``.  Ensure that you have aws credentials configured prior to executing the following command.
+
+::
+
+   margaritashotgun -s 172.16.20.10 -u root -k root_access.pem -m lime-3.13.0-74-generic.ko -b memory_capture_bucket``
+
+Capture Multiple Machines
+*************************
+
+Run margaritashotgun with a configuration file like ``parallel_config.yml.example``
+
+.. code-block:: bah
+
+    aws:
+        bucket: memory_dump_example
+    hosts:
+        - addr:     52.36.191.XXX
+          port:     22
+          username: ec2-user
+          key:      access.pem
+          module:   lime-4.1.19-24.31.amzn1.x86_64.ko
+        - addr:     52.36.170.XXX
+          port:     22
+          username: ec2-user
+          key:      access.pem
+          module:   lime-4.1.19-24.31.amzn1.x86_64.ko
+        - addr:     52.36.210.XXX
+          port:     22
+          username: ubuntu
+          key:      dev.pem
+          module:   lime-3.13.0-74-generic.ko
+        - addr:     52.36.90.XXX
+          port:     22
+          username: ubuntu
+          key:      dev.pem
+          module:   lime-3.13.0-74-generic.ko
+    workers: 2
+
+Here parallelism is limited to 2 workers.
+
+Run the capture with:
+
+::
+
+   margaritashotgun -c your_custom_config.yml.
+
+License
+-------
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Joel Ferrier
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/docs/architecture.rst b/docs/architecture.rst
@@ -0,0 +1,6 @@
+
+Architecture
+============
+
+
+An Overview of margaritashotugn's architecture Coming Soon!
diff --git a/docs/development.rst b/docs/development.rst
@@ -1,6 +1,8 @@
 
-===========
 Development
 ===========
 
-TODO
+Tests
+-----
+
+The test suite is written with pytest and can be run with ``py.test --cov=margaritashotgun``
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,6 +12,7 @@ Python Remote Memory Aquisition
    installing
    user_guide
    reference_guide
+   architecture
    development
    about
 
diff --git a/docs/installing.rst b/docs/installing.rst
@@ -10,15 +10,21 @@ Currently only linux is a supported platform.  Running on OSX or Windows may be
 
 While margaritashotgun is written purely in python, some of the libraries used require additional system packages.
 
-Fedora / REHL Derivatives
--------------------------
+Fedora / REHL Distributions
+---------------------------
 
-TODO
+* python-devel (2.X or 3.X)
+* python-pip
+* libffi-devel
+* openssl-devel
 
-Debian Derivates
-----------------
+Debian Distributions
+--------------------
 
-TODO
+* python-dev (2.X or 3.X)
+* python-pip
+* libffi-dev
+* libssl-dev
 
 Install From PyPi
 *****************

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -1,5 +1,4 @@
 
-===========
 Quick Start
 ===========
 
@@ -8,19 +7,60 @@ First, :doc:`Install margaritashotgun <installing>`.
 Capture A Single Machine
 ************************
 
-TODO
+A single machine can be captured using only the command line arguments for margaritashotgun.
+First specify the server and user with the ``-s`` and ``-u`` flags respectively.
+Next provide a path to an ssh key with ``-k`` (or use a password with the ``-p`` flag).
+Finally provide a lime kernel module with ``-m`` and specify an output file with ``-f``
 
-Save Memory Locally
-*******************
+.. code-block:: bash
 
-TODO
+   margaritashotgun -s 172.16.20.10 -u root -k root_access.pem -m lime-3.13.0-74-generic.ko -f 172.16.20.10-mem.lime
 
 Save Memory In S3
 *****************
 
-TODO
+To save a file to s3 simply replace the ``-f`` or ``filename`` flags with ``-b`` or ``--bucket``.  Ensure that you have aws credentials configured prior to executing the following command.
+
+.. code-block:: bash
+
+   margaritashotgun -s 172.16.20.10 -u root -k root_access.pem -m lime-3.13.0-74-generic.ko -b memory_capture_bucket
 
 Capture Multiple Machines
 *************************
 
-TODO
+Run margaritashotgun with a configuration file like ``parallel_config.yml.example``
+
+.. code-block:: bah
+
+    aws:
+        bucket: memory_dump_example
+    hosts:
+        - addr:     52.36.191.XXX
+          port:     22
+          username: ec2-user
+          key:      access.pem
+          module:   lime-4.1.19-24.31.amzn1.x86_64.ko
+        - addr:     52.36.170.XXX
+          port:     22
+          username: ec2-user
+          key:      access.pem
+          module:   lime-4.1.19-24.31.amzn1.x86_64.ko
+        - addr:     52.36.210.XXX
+          port:     22
+          username: ubuntu
+          key:      dev.pem
+          module:   lime-3.13.0-74-generic.ko
+        - addr:     52.36.90.XXX
+          port:     22
+          username: ubuntu
+          key:      dev.pem
+          module:   lime-3.13.0-74-generic.ko
+    workers: 2
+
+Here parallelism is limited to 2 workers.
+
+Run the capture with:
+
+.. code-block:: bash
+
+   margaritashotgun -c your_custom_config.yml.