https://github.com/ThreatResponse/margaritashotgun

Remote Memory Acquisition Tool
https://github.com/ThreatResponse/margaritashotgun

Last synced: about 2 months ago
JSON representation

Remote Memory Acquisition Tool

• Host: GitHub
• URL: https://github.com/ThreatResponse/margaritashotgun
• Owner: ThreatResponse
• License: mit
• Created: 2016-08-09T17:39:44.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-09-22T15:58:11.000Z (over 4 years ago)
• Last Synced: 2024-11-09T10:15:58.260Z (2 months ago)
• Language: Python
• Homepage: https://www.threatresponse.cloud
• Size: 191 KB
• Stars: 241
• Watchers: 17
• Forks: 50
• Open Issues: 13
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

• Python-Security-Tool-Database - Margarita Shotgun - First, how great is that name?! Second, this is the best Python based live memory acquisition tool. Done and dusted. It's a bit old, but still kicking. (Synopsis / Table of Contents)

README

        
.. image:: https://travis-ci.org/ThreatResponse/margaritashotgun.svg?branch=master

    :target: https://travis-ci.org/ThreatResponse/margaritashotgun

Margarita Shotgun

=================

Python Remote Memory Aquisition

Documentation

-------------

Read the full documentation on `read the docs `__.

Quickstart

**********

For more information see the `user guide `__.

Installation

~~~~~~~~~~~~

``pip install margaritashotgun``

Margarita Shotgun is supported on common linux distributions, for other operating systems use the `python docker container `__ and follow our `installation guide `__.

See `installing `__ for a list of required system packages.

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 ``--server`` and ``--username`` flags.

Next provide a path to an ssh key with ``--key`` (or use a password with the ``--password`` flag).

Finally provide a lime kernel module with ``--module`` and specify an output file with ``--filename``

::

   margaritashotgun --server 172.16.20.10 --username root --key root_access.pem --module lime-3.13.0-74-generic.ko --filename 172.16.20.10-mem.lime

Save Memory In S3

*****************

To save a file to s3 replace the ``filename`` flag with ``--bucket``.  Ensure that you have aws credentials configured prior to executing the following command.

::

   margaritashotgun --server 172.16.20.10 --username root --key root_access.pem --module lime-3.13.0-74-generic.ko --bucket memory_capture_bucket``

Capture Multiple Machines

*************************

Run margaritashotgun with a configuration file like ``parallel_config.yml.example``

.. code-block:: bash

    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 --config 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.