kaff4 - Kotlin AFF4[-L]

The kaff4 project is a kotlin implementation of the AFF4 file format.

This library is built to run in any JVM-based environment.

Warranty

This software has no warranty, it might eat your lunch for all we know. Use at your own risk and cross-validate with other tools. We are not responsible for any usages or outcomes from using this software.

What works today

• Reading
  • Physical Images
  • Logical Images
    • Querying files/directories is not "first party" but can be easily implemented by querying
• Writing via Aff4ContainerBuilder
  • Physical Images
• Hashing
  • MD5, Sha1, Sha256, and Sha512 types are supported
  • Blake2b is not supported (see #77)
• Compression
  • lz4, snappy, deflate, "none"
• Striped (segmented) images

License - MIT

See LICENSE in the root of this project.

For individual projects, see ./gradlew :path:to:project:licenseReport

Using the kaff4-cli CLI

The kaff4-cli CLI provides several commands for working with AFF4 containers.

Prerequisites

• Working Java 17 JDK (e.g. Eclipse Temurin 17)
• Downloaded distribution zip/tar (e.g. kaff4-cli-0.0.0-SNAPSHOT.zip), unpacked

Example usage

# Change directory into the unpacked distribution
$ cd ./path/to/kaff4-cli-0.0.0-SNAPSHOT && ls -l
total 0
drwxrwxrwx 1 kevin kevin 4096 Apr  7 09:57 bin
drwxrwxrwx 1 kevin kevin 4096 Apr  7 09:57 lib

# Change to the bin directory
$ cd bin 

# Run the CLI help
$ ./kaff4-cli --help
Usage: kaff4-cli options_list
Subcommands:
    verify - Verify an image
    dump-stream - Dump an image stream

Options:
    --help, -h -> Usage info

# Individual commands have their own help description
$ ./kaff4-cli verify --help
Usage: kaff4-cli verify options_list
Arguments:
    input_file -> Input image to verify { Value is a path to a file }
Options:
    --thread_count, -n [8] -> Number of threads to use for verification { Int }
    --help, -h -> Usage info

Examples

The best way to understand capabilities is to play with kaff4-cli and look at the implementations of commands.

Attributions

• IntervalTree - MIT
  • Mason M Lai
  • Kevin Brightwell

For individual projects, see ./gradlew :path:to:project:licenseReport

Development Dependencies

• Java 17 JVM: brew install --cask temurin-17

Releasing

# Clean the repo first to not have any old artifacts
./gradlew clean

# Verify the repo is in good shape
./gradlew check

# Tag a version
git tag v0.0.0

# Publish a new build - BE MINDFUL OF SHELL HISTORY PRESERVING ENVIRONMENT VARIABLES
ORG_GRADLE_PROJECT_signingKey=${SIGNING_KEY} \                                                                                                                   [14:52:36]
ORG_GRADLE_PROJECT_signingPassword=${SIGNING_PASSWORD} \
OSSRH_USERNAME=${OSSRH_USERNAME} \
OSSRH_PASSWORD=${OSSRH_PASSWORD} \
RELEASE=1 \
./gradlew build publishToSonatype closeAndReleaseSonatypeStagingRepository

# Push tags to github
git push --tags

# Create a new release: https://github.com/Nava2/kaff4/releases