Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
Signed-off-by: Alessio Greggi <[email protected]>
  • Loading branch information
alegrey91 committed Apr 11, 2024
1 parent b4b73a9 commit 52723a4
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,8 @@ So, `main.doSomething` is the symbol of the function we want to trace using `har

Then, let's run `harpoon` to extract the syscalls from the function `main.doSomething`:

```sh
harpoon -fn main.doSomething ./binary
[+] start tracing
[+] stop tracing
```shell
sudo harpoon -fn main.doSomething ./binary
read
sigaltstack
gettid
Expand All @@ -46,8 +44,6 @@ These are the syscalls that have been executed by the traced function!

## Installation

`harpoon` uses the [**bcc**](https://github.com/iovisor/bcc/blob/master/) project under the hood to run **eBPF**. In order to make it works, you'll have to install the **bcc** *build dependencies*, since it compiles **eBPF** code at runtime. To do so, please refer to this [page](https://github.com/iovisor/bcc/blob/master/INSTALL.md) looking at your own distribution.

### Build

Once you have all the needed tools to run `harpoon`, you can build it locally with:
Expand All @@ -70,6 +66,11 @@ curl -s https://raw.githubusercontent.com/alegrey91/harpoon/main/install | sudo

In case you want to run the application locally, I've provided the [`.vscode/launch.json`](.vscode/launch.json) file to easily debug the application with `root` privileges in `vscode`. Just replace the parameters marked with `<>`.

## Talks

I had the pleasure of presenting `harpoon` at the following conferences:
* [**FOSDEM**](https://fosdem.org/2024/schedule/event/fosdem-2024-1884-how-we-almost-secured-our-projects-by-writing-more-tests/)

## References

I would like to point out that without the references mentioned below this project would never have come to life.
Expand Down

0 comments on commit 52723a4

Please sign in to comment.