feat: VPN toggle

[PixelKhaos]

Fairly straightforward, optional toggle for using wireguard, netbird, tailscale VPN, using [provider] [up|down] on toggles and ip link show to list whether connections are available or not whenever a network change occurs.
Including toasts for connecting/disconnecting, and whenever shell starts.

pkexec is used for the auth for wireguard, I did setup a polkit rule for a session, otherwise asked for password on every toggle.
No getting around wg-quick being root

polkit.addRule(function(action, subject) {
    if (action.id == "org.freedesktop.policykit.exec" &&
        subject.isInGroup("wheel")) {
        var command = action.lookup("command_line");
        if (command && (command.indexOf("wg-quick") >= 0)) {
            return polkit.Result.YES;
        }
    }
});

Edit: polkit rule adjusted to Result.YES

Updated for providers to be user configured, shortform allowed to use defaults.

A simple setup of using any predefined one, like warp can be;

"vpn": {
   "enabled": true,
   "provider": ["warp"]
}

or as custom as;

        "vpn": {
            "enabled": true,
            "provider": [
                {
                    "name": "wireguard",
                    "interface": "torguard",
                    "displayName": "Wireguard (Torguard)",
                    "connectCmd": ["pkexec", "wg-quick", "up", "torguard"],
                    "disconnectCmd": ["pkexec", "wg-quick", "down", "torguard"]
                }
            ]
        }

[Cleboost]

Do you think you can add support for netbird? It's mesh VPN like tailscale with netbird up & netbird down?

[PixelKhaos]

Do you think you can add support for netbird? It's mesh VPN like tailscale with netbird up & netbird down?

I'll take a look at it, shouldn't be much harder than making a provider/tunnel variable for the actual command, since the rest of this just checks for changes in the network and if any active connections match the named tunnel defined in config or not

Edit: a little bit more involved actually it seems, but still doable :)

[PixelKhaos]

@Cleboost Added now, works great, I like how it didn't need sudo or pkexec so I made just wireguard use that explicitly, so super smooth experience to toggle it for netbird :)

[Cleboost]

It's perfect thanks :)

[AlmiWasFound]

@PixelKhaos not sure if it's relatable but is it possible to add 1.1.1.1/warp in there as well? i believe there's quite a similar module in end4's configs, but please let me know :P

[AlmiWasFound]

It's kinda the same, with warp-cli connect and warp-cli disconnect so yeah.

[AlmiWasFound]

works great, but for wireguard you have to add in a polkit rule and it has to return as YES, not AUTH_SELF_KEEP. other than that, everything works fine!

[PixelKhaos]

works great, but for wireguard you have to add in a polkit rule and it has to return as YES, not AUTH_SELF_KEEP. other than that, everything works fine!

@AlmiWasFound Oh yeah, changed that now, not sure why but seems there was some change so I too encountered it not allowing to run it.

I have also modified this whole bit to include a mapping of some default providers, and reworked to easily just define in the shell.json as an object. Less hardcoded.

A simple setup of using any predefined one, like warp can be;

"vpn": {
   "enabled": true,
   "provider": ["warp"]
}

or as custom as;

        "vpn": {
            "enabled": true,
            "provider": [
                {
                    "name": "wireguard",
                    "interface": "torguard",
                    "displayName": "Wireguard (Torguard)",
                    "connectCmd": ["pkexec", "wg-quick", "up", "torguard"],
                    "disconnectCmd": ["pkexec", "wg-quick", "down", "torguard"]
                }
            ]
        }

It will default for most things here, but lets you override things if there would ever be any need for it, or of course, just add whatever other provider you want to use or aliases, etc.

[AlmiWasFound]

Awesome! Everything works as expected! Tysm for the help, really appreciate it :D

[AlmiWasFound]

comments dont work in .json files as far as i know, which causes the shell to not process/parse the code/vars in the shell.json file. correct me if im wrong though. everything else works fine

[PixelKhaos]

comments dont work in .json files as far as i know, which causes the shell to not process/parse the code/vars in the shell.json file. correct me if im wrong though. everything else works fine

Was thinking people would remove the comments, since it's not jsonc, but better to remove it alltogether probably yeah.

[AlmiWasFound]

yeah, prob. you have to somehow add them in at the FAQ

[soramanew]

Thanks for the PR! Just a few issues with style, I don't use a VPN personally so I didn't test this, but I trust that it works.

[PixelKhaos]

Thanks for the PR! Just a few issues with style, I don't use a VPN personally so I didn't test this, but I trust that it works.

Oh yeah, understandable, in general it's all working with defaults, it's pretty straightforward check of whether configured interfaces are active or not, testing against defaults, but don't depend on any complex setups. all of these were free for me to test other than wireguard which I use myself and is the more particular one to setup.

And appreciate the feedback, pretty new to QML so there's some things I have to unlearn and get used to convention wise :)
also didnt realize qml linting was defaulting to version 1.0 for some reason so had to fix that haha

[Cleboost]

All work fine for me :)
I think you forgot to update the readme with new config

[Cleboost]

Suggested change

	{
	"name": "wireguard",
	"interface": "your-connection-name",
	"displayName": "Wireguard (Your VPN)"
	}
	{
	"name": "wireguard",
	"interface": "your-connection-name",
	"displayName": "Wireguard (Your VPN)",
	"connectCmd": ["pkexec", "wg-quick", "up", "torguard"],
	"disconnectCmd": ["pkexec", "wg-quick", "down", "torguard"]
	}

[PixelKhaos]

Well, those two extra lines are super optional, just as a way to specify outside of any of the other patterns of up/down|connect/disconnect. I would assume it almost never be used, but wanted it supported just in case.