Skip to content

Latest commit

 

History

History
57 lines (33 loc) · 2.11 KB

commands.md

File metadata and controls

57 lines (33 loc) · 2.11 KB
Raw

Commands

Harpoon has several commands that you can use.

The common way of using harpoon is to execute the available commands as follow:

  • harpoon analyze to infer symbols to be traced from the project root directory. This will create the harpoon-report.yml file.

  • harpoon hunt by passing the harpoon-report.yml file to trace the functions and get their system calls. This will generate the ./harpoon/ directory with the metadata that contain the system calls traced.

  • harpoon build to read the metadata files and provide the seccomp profile.

Analyze

The analyze command is used to analyze the project's folder and get the list of function symbols you want to trace.

Additionally it automatically build the test binary and place them into the harpoon/ directory.

The result of this command is the harpoon-report.yml file with the list of test binaries followed by their function symbols that are currently tested.

Run it on your project folder:

sudo harpoon analyze --exclude .git/

Build

The build command collects the metadata files (created by the hunt command under the harpoon/ directory) and use them to create a seccomp profile based on their content.

sudo harpoon build -D ./harpoon/

Capture

The capture command is the "core" of harpoon. This traces the function symbols passed as argument for the give binary.

sudo harpoon capture -f github.com/user/repo/pkg/pkgname.functionName .harpoon/packagebin.test

The result, is a list of system call executed by the function during the run of the binary.

Hunt

The hunt command is similar to capture, but used to capture a list of functions from different test binary.

The command needs a file as input paramenter that is the result of the analyze command.

This will loop over the entries of the file, capturing the system calls of each entry.

harpoon hunt --file harpoon-report.yml -S

This will create the directory harpoon/ with the list of system calls traced from the execution of the different test binaries present in the harpoon-report.yml file.