Skip to main content

Build Status codecov Codacy Badge Documentation Status

Woodblock – Easy File Carving Test Data Generation

The goal of Woodblock is to make it as easy as possible to generate file carving test data sets such as the ones created by the DFRWS in their 2006 and 2007 challenges or by the ones created by NIST.

Basic Features

  • Simple configuration files based image creation for most use cases.
  • Easy to use Python API for more complex requirements.
  • Ground truth file in JSON format.

Documentation

Our documentation is hosted on Read the Docs.

Concepts

Woodblock borrows most concepts from the DFRWS 2006 and 2007 challenges. As stated there, a scenario reflects a “specific situation that might occur in a real file system”. A scenario consists of files which are split into fragments. Scenarios on the other hand can be put into an image which can then used as input for the carving tool you would like to test.

The following example should clarify these concepts. Consider for example the two files A and B.

two files

These files can be split into fragments. In the example, we split file A into two fragments, A.1 and A.2. File B has not been fragmented.

two files fragmented

If we arrange the fragments of our files, we have a scenario:

example scenario

A scenario can be added to an image, which in turn can be written to disk. Or you can add another scenario to the image as shown below.

example image with two scenarios

Using Woodblock, you could create the images shown above using a simple configuration file:

[general]
block size = 512
seed = 123
corpus = testfiles

[scenario 1]
frags file1 = 2
frags file2 = 1
layout = 1.1, 2.1, 1.2

[scenario 2]
frags file1 = 3
layout = 1.2, 1.1, Z, 1.3

All files possibly added to a scenario have to be stored in a directory. This directory serves as the test file corpus and has to be distributed along with Woodstock configuration files or scripts using the Woodstock API.

Metadata

Release files for woodblock 0.1.7

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

Source distribution (sdist)

Source distribution for woodblock 0.1.7
File Size Uploaded
woodblock-0.1.7.tar.gz 12.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for woodblock 0.1.7
File Interpreter ABI Platform
woodblock-0.1.7-py3-none-any.whl Python 3 none any Details

Total release size: 29.5 kB

Release files / woodblock-0.1.7.tar.gz

Download URL woodblock-0.1.7.tar.gz
Size 12.7 kB
Tags Source
SHA-256 checksum
How to use checksums
c0347ece920b7009d94551983a01f42db02920ca8d7b0ff36d24a337e2c937f7
BLAKE2b-256 checksum
How to use checksums
c8f8e51c3ed6e9707e919e41236a3b3cf76b7f47abdd18b9b68e55301d2a7b66
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

Release files / woodblock-0.1.7-py3-none-any.whl

Download URL woodblock-0.1.7-py3-none-any.whl
Size 16.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2465fb5cf18333a863512dee0d2f437865ee1225eca73e63a67914c35ef1b5d6
BLAKE2b-256 checksum
How to use checksums
0472f20c62c80b5fcad190d61b034018e856bb156d97a0f556f64adf469b08b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

Release history Release notifications | RSS feed

This release

0.1.7 This release

2 release files

0.1.6

2 release files

0.1.5

3 release files

0.1.4

3 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

3 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page