Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

a ruby toolkit for working with FTK output

branch: master

Fetching latest commit…


Cannot retrieve the latest commit at this time

Octocat-spinner-32 jetty @ d6430ae
Octocat-spinner-32 lib
Octocat-spinner-32 logs
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .gitmodules
Octocat-spinner-32 .rvmrc
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Gemfile.lock
Octocat-spinner-32 LICENSE.txt
Octocat-spinner-32 README
Octocat-spinner-32 Rakefile
Octocat-spinner-32 Readme.textile
Octocat-spinner-32 ruby_ftk.gemspec

Ruby FTK Toolkit

This is a ruby library for manipulating the output of Forensic Toolkit ( It was built for a project called Hypatia ( but can be used elsewhere. It makes certain assumptions about how FTK outputs data, which will be documented here soon.

The XML output that FTK creates is an XML-FO document that isn’t easy to read or understand. This library can do that for you. To turn an FTK report into something that’s easier to work with, follow this example:

		require 'ruby_ftk_toolkit'
      	report = File.join(File.dirname(__FILE__), "/spec/fixtures/Gould_FTK_Report.xml")
		ftk_processor = => report)
		# You can get collection level data 
		ftk_processor.collection_title # => "Stephen Jay Gould papers"
		ftk_processor.call_number 	# => "M1437"
		ftk_processor.series # => "Series 6: Born Digital Materials"
		ftk_processor.file_count # => "56"
		# And you can get file level data in the form of FtkFile objects
		ftk_processor.files.each do |ftk_file|
			puts ftk_file[1].filename
			puts ftk_file[1].id
			puts ftk_file[1].md5

You might want to create BagIt packages for each file from your FTK output:

# Assemble FTK output into objects for Hypatia. my_fedora_config = "/path/to/fedora.yml" my_bag_dir = "/path/to/where/my/bags/should/be/created" ftk_report = "/path/to/FTK_Report.xml" file_dir = "/path/to/exported/ftk/file/directory" hfo = => my_fedora_config, :bag_destination => my_bag_dir) hfo.process(ftk_report, file_dir)
Something went wrong with that request. Please try again.