Skip to content

Commit

Permalink
Include tool descriptions + behind the scenes tools to README (#75)
Browse files Browse the repository at this point in the history
* Update README with more of our tools

* more tweaks

* more tweaks

* tweaks pt 2

* tweak 3

* move LCF, Plaso as Turbinia deps

* small plaso tweak
  • Loading branch information
wajihyassine authored Oct 27, 2023
1 parent dfc1feb commit 150c490
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,16 @@ Digital Forensics tools to Kubernetes clusters using Helm.

Currently, OSDFIR Infrastructure supports the deployment and integration of the following tools:

* [Timesketch](https://github.com/google/timesketch)
* [Turbinia](https://github.com/google/turbinia)
* [dfTimewolf](https://github.com/log2timeline/dftimewolf)
* [Turbinia](https://github.com/google/turbinia) for automating processing of forensic evidence at scale helping find prevelant badness and includes built-in integrations to many tools such as:
* [Plaso](https://github.com/log2timeline/plaso) (and related projects such as dfVFS, libyal) for extracting data from a variety of sources into a correlated super timeline
* [Container Explorer](https://github.com/google/container-explorer) for container level processing
* [Docker Explorer](https://github.com/google/docker-explorer) for docker container level processing
* [Fraken](https://github.com/google/turbinia/tree/master/tools/fraken) for multi-threaded yara scanning
* [Libcloudforensics](https://github.com/google/cloud-forensics-utils/) for mounting evidence from cloud platforms
* [Timesketch](https://github.com/google/timesketch) for collaborative forensic timeline analysis with built-in analyzers to help identitify patterns in data and supports Plaso, JSONL, or CSV file imports
* [dfTimewolf](https://github.com/log2timeline/dftimewolf) for orchestrating forensic collection, processing and data export, helping pass data between tools

These tools can be used independently as well by following the documentation on the tool's repository or by installing a tool specific Helm chart which includes any built-in integrations.

## Installing the Charts

Expand All @@ -22,5 +29,5 @@ The command deploys OSDFIR Infrastructure on the Kubernetes cluster in the defau
For more information on how to install and configure OSDFIR Infrastructure or individual tools, please refer to the links below.

* [OSDFIR Infrastructure Install Guide](charts/osdfir-infrastructure/README.md)
* [Timesketch Install Guide](charts/timesketch/README.md)
* [Turbinia Install Guide](charts/turbinia/README.md)
* [Timesketch Install Guide](charts/timesketch/README.md)

0 comments on commit 150c490

Please sign in to comment.