mitmproxy / mitmproxy/mitmproxy

Support custom wireguard options

Open
#6,639 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

kind/feature
Dominant language
Python
Stars
45.1k
Forks
4.7k
Avg merge
21h 12m
Merged PRs (30d)
16

Description

Problem Description

I wish to use custom WG configuration, instead of hard-coded values in the python, I read https://github.com/mitmproxy/mitmproxy/pull/5562#pullrequestreview-1099934509 and I understand the desire to not have lots of code to parse existing configs.

Proposal

Add additional options to the wireguard.conf file. The pub/priv keys are already stored here, and other variables could also be stored here too, such is IPs, listen ports for both instance/peer/dns and in particular, endpoint.

The file could easily be populated by default with the static config already there, which would provide customisation at no expense to those who do not wish to manually enter anything.

Alternatives

There is not really one that requires less effort, but the alternative would be to allow the use of standard wireguard config formats.

Additional context

In my case I have an LTE router at another location and I want to connect mitmproxy via my existing wireguard setup, which uses a FQDN as a means of conveying the current IP, due to having a dynamic one so that I can proxy the webUIs available there over the tunnel.

It would also be nice one day to reintroduce the multi-peer support so one instance of MITM can serve multiple remote locations or devices without having to share a common WG tunnel.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the wireguard.conf proposal and the referenced pull request review at #5562. Determine how custom IPs, listen ports, DNS settings, endpoints, and existing keys should be represented, and define what configuration behavior and compatibility should count as done.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.