newsoft / dfir-orc

Forensics artefact collection tool for systems running Microsoft Windows

DFIR-ORC

Documentation

https://dfir-orc.github.io

Build

Requirements

• Visual Studio >=2017 with this configuration or alternatively use vstools
• Kitware's CMake >= 3.12 or Visual Studio 2017 integrated version
• LLVM's Clang Format >= 8.0.0 or Visual Studio 2019 integrated version

Build environment can be setup quickly using Microsoft's developer virtual machines. Import this .vsconfig from Visual Studio Installer.

Commands

Both 32-bit and 64-bit versions should be built for maximum compatiliby before deployment. See https://dfir-orc.github.io for more details about deployment and configuration.

git clone https://github.com/dfir-orc/dfir-orc.git
cd dfir-orc
mkdir build-x86 build-x64

cd build-x86
cmake -G "Visual Studio 16 2019" -A Win32 -T v141_xp -DORC_BUILD_VCPKG=ON ..
cmake --build . --config MinSizeRel -- -maxcpucount

cd ../build-x64
cmake -G "Visual Studio 16 2019" -A x64 -T v141_xp -DORC_BUILD_VCPKG=ON ..
cmake --build . --config MinSizeRel -- -maxcpucount

• The -T v141_xp option will allow compatibility with Windows XP SP2 and later, it can safely be removed if this is not required.

• The ORC_BUILD_VCPKG=ON option will build vcpkg packages in 'external/vcpkg' subdirectory.

Options

Using default options is recommended with the exception of ORC_BUILD_VCPKG which should be set to ON so dependencies will be built automatically using vcpkg.

CMake option	Default	Description
ORC_BUILD_VCPKG	OFF	Build vcpkg dependencies
ORC_BUILD_APACHE_ORC	OFF	Build Apache Orc module
ORC_BUILD_CHAKRACORE	OFF	Build with ChakraCore support
ORC_BUILD_FASTFIND	OFF	Build FastFind binary
ORC_BUILD_ORC	ON	Build Orc binary
ORC_BUILD_PARQUET	OFF	Build Parquet module (x64)
ORC_BUILD_SQL	OFF	Build SQL module [1]
ORC_BUILD_SSDEEP	OFF	Build with ssdeep support
ORC_USE_STATIC_CRT	ON	Use static runtime
ORC_VCPKG_ROOT	${ORC}/external/vcpkg	VCPKG root directory

[1] ORC_BUILD_SQL=ON requires SQL Server Native Client

Note: Some combinations may be irrelevant.

Build vcpkg dependencies manually

See top CMakeLists.txt for a complete list of the dependencies to install. Building mainstream vcpkg may not work as some packages have custom patches. The VERSION.txt contains the reference commit from official vcpkg repository.

cd external/vcpkg
bootstrap-vcpkg.bat
vcpkg --vcpkg-root . install fmt:x64-windows-static ...

Aknowledgments

DFIR-ORC is disclosing Microsoft source code with Microsoft's permission.