Skip to content

Latest commit

 

History

History
164 lines (105 loc) · 4.29 KB

build.md

File metadata and controls

164 lines (105 loc) · 4.29 KB
Raw

Building Traceeshark from source

The general flow of building Traceeshark is as follows:

  1. Clone Traceeshark

  2. Clone Wireshark under the Traceeshark directory

  3. Set up the build environment

  4. Checkout the desired Wireshark version to build Traceeshark against

  5. Configure Wireshark normally and install Wireshark's headers

  6. Build Traceeshark

  7. Optional: create a distribution archive

  8. Repeat from step 4 to build against another version of Wireshark

1. Clone Traceeshark

⚠️ On Windows, before cloning Traceeshark, make sure to run the following command: git config --global core.autocrlf false. Without this, git will insert carriage returns into the files and will break an important shell script!

git clone https://github.com/aquasecurity/traceeshark
cd traceeshark

2. Clone Wireshark

Clone the Wireshark source into the Traceeshark directory (Makefile and build scripts depend on this location):

git clone https://github.com/wireshark/wireshark

3. Setting up the build environment

Follow Wireshark's instructions for setting up the build environment:

  • Linux & Mac

  • Windows - follow sections 2.2.2 and 2.2.3. Ignore the instructions about setting up environmet variables, instead edit scripts\setup_env.bat with the appropriate paths to the Wireshark repository, the Qt installation and the Visual Studio installation. Run this script in any new shell you use to build Traceeshark/Wireshark.

Additionally, make sure you have ninja and rsync installed. On Ubuntu:

sudo apt install rsync ninja-build

4. Checkout the desired Wireshark version

Release versions of Wireshark have tags in the form wireshark-x.y.z. Checkout the desired tag, for example:

cd wireshark
git checkout wireshark-4.2.6
cd ..

ℹ️ Note that source code compatibility of Traceeshark is not guaranteed, not all versions of Wireshark are supported. Incompatible versions will result in compilation errors.

5. Configure Wireshark and install headers

Configure Wireshark normally so the headers are generated install them.

On Linux and Mac:

mkdir wireshark/build
pushd wireshark/build
cmake ..
sudo make install-headers
popd

On Windows (requires an elevated command prompt):

mkdir build
pushd build
cmake -G "Visual Studio 17 2022" -A x64 ..\wireshark
msbuild install-headers.vcxproj
popd

ℹ️ If Visual Studio 17 2022 is not a valid toolchain on your system, you can list the available options using cmake -G

Keep in mind that this stage needs to be repeated for every Wireshark version you want to build Traceeshark against.

6. Build Traceeshark

Building Traceeshark is managed using a Makefile on Linux and Mac and build scripts on Windows.

Before building for the first time, Wireshark needs to be configured again, this time for Traceeshark.

On Linux and Mac:

make cmake

On Windows:

scripts\cmake.bat

Next, build Wireshark together with the Traceeshark plugins.

On Linux and Mac:

make

On Windows:

scripts\build.bat

There are a few extra targets and scripts that are useful for development.

On Linux and Mac:

# Install plugins and other Traceeshark
# files into their destinations.
make install

# Run Wireshark from the build directory.
# Runs the install target automatically.
make run

# Same as run target, but with debug output enabled
make debug

On Windows:

rem Install plugins and other Traceeshark files into their destinations.
scripts\install.bat

7. Create a distribution archive

A distribution archive with an installation script can be created for anyone with the same OS and architecture. Note that a distribution targets the specific Wireshark version that was used while building. To build for a different version, go back to step 4.

On Linux and Mac:

make dist

On Windows:

scripts\dist.bat

The archive will be written to the dist directory.