ebpf-web-fingerprint

KO | EN

gitlite — search

#hacktoberfest #typescript #golang #android #machine-learning #macos #java #awesome #cli #kubernetes #awesome-list #vue #security #open-source

ebpf-web-fingerprint

(★ 104)

a golang library and webserver for fast TCP & TLS fingerprinting, powered by eBPF

File Explorer

Download Latest Version (.zip)

- - main.go
- - run-in-prod.md
- bpf_endian.h
- bpf_helper_defs.h
- bpf_helpers.h
- LICENSE.BSD-2-Clause
- net_headers.h
- update.sh
- - routes.go
  - run.go
- - tcpinfo.go
  - tcpinfo_test.go
- - bpfprobe.go
  - endianness.go
  - key.go
  - lookup.go
  - parse_tcp.go
  - xdp.c
  - xdp_bpfeb.go
  - xdp_bpfeb.o
  - xdp_bpfel.go
  - xdp_bpfel.o
- - handshake.go
- - lookup.go
  - tcpconn.go
  - wrappers.go
- check_kernel_features.sh
- netns_setup.sh
- netns_teardown.sh
- read_ktrace_logs.sh
- .gitignore
- client.go
.gitignore
go.mod
go.sum
LICENSE
Makefile
notes-httpgo.md
README.md
roadmap.md
san.cnf

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# eBPF web fingerprint

A golang webserver and library for fast TCP & TLS fingerprinting, powered by eBPF.  
See [this article](https://halb.it/posts/ebpf-fingerprinting-1/)
for a high-level introduction on the topic.

This project is available in two modes:

- [Standalone Demo Web Server](#run-the-demo-webserver)

A simple webserver that echoes back detailed information about a
visitor's TCP and TLS handshakes.
It can be used to experiment with fingerprintig detection and evasion techniques,
or as a reference for how to use the fingerprint library.

- [Golang fingerprint library](#using-the-fingerprint-library)

A reusable library that can be embedded into existing Golang webservers or
reverse proxies.
It exposes low-level metadata about incoming client connections, enabling advanced fingerprinting and bot detection strategies.

## Run the Demo Webserver

To build and run the Webserver in a dedicated network namespace:
```bash
# create a dedicated network namespace
make testns_setup
# compile and run the test server in the dedicated namespace
make testns_run
```

the server will be accessible at both:
- `http://10.200.1.2:8080/test/id` (ipv4)
- `http://[fd00:a1b:200::2]:8080/test/id` (ipv6)

Note that the build process currently requires `go`, `Make`, `Clang` and `LLVM` to be installed on your system. 
On ubuntu/debian, you can install all the dependencies with:
```bash
sudo apt install clang-18 llvm-18
```
On other linux distributions you can ask your favourite LLM for help with the installation.

## Run the demo server in TLS mode

first, you must generate a valid self-signed certificate for the ip `10.200.1.2`:

```
openssl req -x509 -nodes -days 730 -newkey rsa:2048 -keyout key.pem -out cert.pem -config san.cnf
```

Then, run the demo server with tls enabled:

```bash
TLS=true make testns_run
```

the server will be accessible at 
```
curl https://10.200.1.2:8080/test/id --insecure
curl https://[fd00:a1b:200::2]:8080/test/id --insecure
```

to use a specific TLS version:

```
curl https://10.200.1.2:8080/test/id --insecure --tlsv1.1 --tls-max 1.1
```

This project includes some test proxies as submodules in the `test/` folder.
They are useful to test the behaviour of the system under TLS and TCP fragmentation.

to use a specific TLS version and a test proxy, first launch the proxy. then
run:
```
curl https://10.200.1.2:8080/test/id --insecure --tlsv1.1 --tls-max 1.1 --proxy localhost:4433
```

## Other demo server configurations

The demo server receives configuration via environment variables.

For example, this is how you run the demo server with TLS enabled, listening on port 443.
```bash
TLS=true DST_PORT=443 make testns_run
```

This is the complete list of environment variables you can use, and their defaults:

| Variable    | Default      | Description                                                                                                                                    |
| ----------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `IFACE`     | `veth-ns`    | Network interface the server will listen on. Must exist and have the configured `DST_IP` assigned.                                             |
| `DST_IP`    | `10.200.1.2` | IP address on the selected network interface that the server will listen on.                                                                   |
| `DST_PORT`  | `8080`       | TCP port the server will listen on. When `CERTMAGIC=true`, this **cannot** be `80`.                                                            |
| `TLS`       | `false`      | Enable TLS mode and TLS fingerprinting. Options: `"true"` or `"false"`                                                                         |
| `CERTMAGIC` | `false`      | Enable automatic TLS certificate management via Certmagic. Options: `"true"` or `"false"`. When enabled, `TLS_CERT` and `TLS_KEY` are ignored. |
| `CERTMAGIC_PATH` | `./acme`      | Filesystem path where Certmagic stores certificates, account information, and metadata. Must be writable by the server. |
| `CERTMAGIC_DOMAINS` | `example.com,www.example.com`      | Comma-separated list of domain names for which Certmagic will automatically obtain and manage TLS certificates.|
| `TLS_CERT`  | `cert.pem`   | Path to TLS certificate file. Used only when `TLS="true"` and `CERTMAGIC="false"`.                                                             |
| `TLS_KEY`   | `key.pem`    | Path to TLS private key file. Used only when `TLS="true"` and `CERTMAGIC="false"`.                                                             |

## Using the fingerprint library

If you are interested in ways to add ebpf-based fingerprint capabilities to a web server, 
it is extremely unlikely that you want a high-level and opinionated API that starts a 
webserver for you.

This is why the library does not provide any high level function like:
```
startFingerprintWebServer(":80", handlers)
```

Instead, the fingerprint library provides functionalities to tap into an existing 
golang webserver, enhancing what you already have with TCP and (optionally) TLS handshake data.

Considering the limited size of this project and its simplicity, it might be a good idea to 
vendor it or even better to re-implement it from scratch in your project. The MIT license 
of this code allows it.

A good starting point for using the library is therefore to start the demoserver, and to 
experiment with it. See the [demoserver](#run-the-demo-webserver) section.
Then, you can read the code to familiarize with the high-level concepts.

## Goals

Note that the main goal of this project is to make 
raw handshake data easily accessible from a regular golang webserver,
with as little overhead as possible.

The implementation of specific fingerprint standards or techniques is out of 
scope. The end user should be left with the freedom to implement the system
they want, based on their project requirements.

ebpf-web-fingerprint

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

ebpf-web-fingerprint

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README