Skip to main content

Service to manage disk image mounts.

Project description

https://github.com/mitre/thumbtack/actions/workflows/thumbtack_workflow.yml/badge.svg?branch=master

thumbtack

Thumbtack is a web front-end providing a REST-ful API to mount and unmount forensic disk images, built on top of the imagemounter library.

Documentation is available in the docs/ directory or online at https://thumbtack.readthedocs.io/en/latest.

Quick Start

$ sudo pip install thumbtack
$ sudo imount --check # List install status of tools used by imagemounter
The following commands are used by imagemounter internally. Without most commands, imagemounter works perfectly fine, but may lack some detection or mounting capabilities.
-- Mounting base disk images (at least one required, first three recommended) --
MISSING   xmount              needed for several types of disk images, part of the xmount package
MISSING   ewfmount            needed for EWF images (partially covered by xmount), part of the ewf-tools package
MISSING   affuse              needed for AFF images (partially covered by xmount), part of the afflib-tools package
MISSING   vmware-mount        needed for VMWare disks
MISSING   mountavfs           needed for compressed disk images, part of the avfs package
MISSING   qemu-nbd            needed for Qcow2 images, part of the qemu-utils package
...

Install additional tools needed to mount your images. More information can be found in the imagemounter installation docs https://imagemounter.readthedocs.io/en/latest/installation.html.

# Install tools
$ sudo apt-get install xmount ewf-tools afflib-tools sleuthkit
$ cd path/to/disk/image/files
$ sudo thumbtack
  * Serving Flask app "thumbtack" (lazy loading)
  * Environment: production
    WARNING: This is a development server. Do not use it in a production deployment.
    Use a production WSGI server instead.
  * Debug mode: off
  * Running on http://127.0.0.1:8208/ (Press CTRL+C to quit)

Then go to http://127.0.0.1:8208 and start mounting and unmounting images!

Find a full tutorial in docs/tutorial.rst.

Quick Reference

$ sudo thumbtack --help
Usage: thumbtack [OPTIONS]

Options:
  -d, --debug                   Run the Thumbtack server in debug mode
  -h, --host TEXT               Host to run Thumbtack server on  [default: 127.0.0.1]
  -p, --port TEXT               Port to run Thumbtack server on  [default: 8208]
  -m, --mount-dir TEXT          Directory to mount disk images  [Default: /mnt/thumbtack]
  -i, --image-dir TEXT          Directory of disk images for Thumbtack server to monitor  [Default: $CWD]
  --db TEXT                     SQLite database to store mount state
  -b, --base-url TEXT           Base URL where Thumbtack is hosted on the server  [default: /]
  --path-contains TEXT          Only select files containing specified string in the path
  -s, --skip-subdirectory TEXT  Subdirectory to ignore when monitoring files
  -r, --remove-directories      Unmount all mountpoints and remove all empty directories in the thumbtack mount directory
  --help                        Show this message and exit.

LICENSE

Thumbtack is licensed under the Apache License, Version 2.0. See the LICENSE file for more information.

RELEASE STATEMENT

Approved for Public Release; Distribution Unlimited. Public Release Case Number 19-0358.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

thumbtack-0.5.4.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

thumbtack-0.5.4-py2.py3-none-any.whl (24.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file thumbtack-0.5.4.tar.gz.

File metadata

  • Download URL: thumbtack-0.5.4.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for thumbtack-0.5.4.tar.gz
Algorithm Hash digest
SHA256 48e90272263b812b2576a9f235b19d0a4f415f353dbf125d555c679c63dcd8bc
MD5 d3bd458b29a80738540209b3753e92da
BLAKE2b-256 97503f8505e85b3e9f4d3f9cd709a3fabf031e0aa51fdacce4c2eb0494d7cf79

See more details on using hashes here.

File details

Details for the file thumbtack-0.5.4-py2.py3-none-any.whl.

File metadata

  • Download URL: thumbtack-0.5.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 24.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for thumbtack-0.5.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3b4d07ea63736dce3c3e52fa7cf632a263fb680a20e911efee728db0f9fefaba
MD5 96670584020129977c3e0167662fcd52
BLAKE2b-256 3d23e89448f946411de0a1391f3fadb3697d4e11823a1f3ce89b428052d8f2f7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page