Turbinia

Unit tests e2e tests

Summary

Turbinia is an open-source framework for deploying, managing, and running distributed forensic workloads. It is intended to automate running of common forensic processing tools (i.e. Plaso, TSK, strings, etc) to help with processing evidence in the Cloud, scaling the processing of large amounts of evidence, and decreasing response time by parallelizing processing where possible.

How it works

Turbinia is composed of different components for the client, server and the workers. These components can be run in the Cloud, on local machines, or as a hybrid of both. The Turbinia client makes requests to process evidence to the Turbinia server. The Turbinia server creates logical jobs from these incoming user requests, which creates and schedules forensic processing tasks to be run by the workers. The evidence to be processed will be split up by the jobs when possible, and many tasks can be created in order to process the evidence in parallel. One or more workers run continuously to process tasks from the server. Any new evidence created or discovered by the tasks will be fed back into Turbinia for further processing.

Communication from the client to the server is currently done with either Google Cloud PubSub or Kombu messaging. The worker implementation can use either PSQ (a Google Cloud PubSub Task Queue) or Celery for task scheduling.

The main documentation for Turbinia can be found here. You can also find out more about the architecture and how it works here.

Status

Turbinia is currently in Alpha release.

Installation

There is an installation guide here.

Usage

The basic steps to get things running after the initial installation and configuration are:

Start Turbinia server component with turbiniactl server command
Start Turbinia API server component with turbiniactl api_server command if using Celery
Start one or more Turbinia workers with turbiniactl celeryworker if using Celery, or turbiniactl psqworker if using PSQ
Install turbinia-client via pip install turbinia-client
Send evidence to be processed from the turbinia client with turbinia-client submit ${evidencetype}
Check status of running tasks with turbinia-client status

turbinia-client can be used to interact with Turbinia through the API server component, and here is the basic usage:

$ turbinia-client -h
Usage: turbinia-client [OPTIONS] COMMAND [ARGS]...

  Turbinia API command-line tool (turbinia-client).

                          ***    ***
                           *          *
                      ***             ******
                     *                      *
                     **      *   *  **     ,*
                       *******  * ********
                              *  * *
                              *  * *
                              %%%%%%
                              %%%%%%
                     %%%%%%%%%%%%%%%       %%%%%%
               %%%%%%%%%%%%%%%%%%%%%      %%%%%%%
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%  ** *******
  %%                                                   %%  ***************
  %%                                (%%%%%%%%%%%%%%%%%%%  *****  **
    %%%%%        %%%%%%%%%%%%%%%
    %%%%%%%%%%                     %%          **             ***
       %%%                         %%  %%             %%%           %%%%,
       %%%      %%%   %%%   %%%%%  %%%   %%%   %%  %%%   %%%  %%%       (%%
       %%%      %%%   %%%  %%%     %%     %%/  %%  %%%   %%%  %%%  %%%%%%%%
       %%%      %%%   %%%  %%%     %%%   %%%   %%  %%%   %%%  %%% %%%   %%%
       %%%        %%%%%    %%%       %%%%%     %%  %%%    %%  %%%   %%%%%

  This command-line tool interacts with Turbinia's API server.

  You can specify the API server location in ~/.turbinia_api_config.json

Options:
  -c, --config_instance TEXT  A Turbinia instance configuration name.
                              [default: (dynamic)]
  -p, --config_path TEXT      Path to the .turbinia_api_config.json file..
                              [default: (dynamic)]
  -h, --help                  Show this message and exit.

Commands:
  config    Get Turbinia configuration.
  evidence  Get or upload Turbinia evidence.
  jobs      Get a list of enabled Turbinia jobs.
  result    Get Turbinia request or task results.
  status    Get Turbinia request or task status.
  submit    Submit new requests to the Turbinia API server.

Check out the turbinia-client documentation page for a detailed user guide.

You can also interact with Turbinia directly from Python by using the API library. We provide some examples here

Metadata

Release files for turbinia 20240614.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for turbinia 20240614.2
File	Size	Uploaded
turbinia-20240614.2.tar.gz	309.7 kB	Jun 18, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for turbinia 20240614.2
File	Interpreter	ABI	Platform	Reset
turbinia-20240614.2-py3-none-any.whl 493.7 kB Jun 18, 2024	Python 3	none	any	Details

Total release size: 803.4 kB

Release files / turbinia-20240614.2.tar.gz

Download URL	turbinia-20240614.2.tar.gz
Size	309.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`15603e798d9fb5d42023dae8bad05580b429a52f6479b28622d8a848da270364`
BLAKE2b-256 checksum How to use checksums	`fa5f1648ccc032b9269e72bc87ed1c7a764b775ee65b7eecbe5b7eedfc300592`
Upload date	Jun 18, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.0 CPython/3.12.4`

Release files / turbinia-20240614.2-py3-none-any.whl

Download URL	turbinia-20240614.2-py3-none-any.whl
Size	493.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`35554cf105c2b5193259953f2c9d72ef8904c13c9db5367884668cf1df895b5a`
BLAKE2b-256 checksum How to use checksums	`e5c3996184bbfb5cb73ebd0a35bce65b782fe637a4baacbdfffd818e71d5347f`
Upload date	Jun 18, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.0 CPython/3.12.4`