nixpkgs/nixos/modules/programs/wireshark.nix
jan 5deeee393a nixos/wireshark: usbmon permissions
Add an usbmon.enable option (default false) for setting permissions for
capturing USB traffic.
Add a dumpcap.enable option (default true) for setting permissions for
capturing network traffic.
fixes #375657
2025-03-07 19:34:27 +01:00

66 lines
1.9 KiB
Nix

{
config,
lib,
pkgs,
...
}:
let
cfg = config.programs.wireshark;
wireshark = cfg.package;
in
{
options = {
programs.wireshark = {
enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Whether to add Wireshark to the global environment and create a 'wireshark'
group. To configure what users can capture, set the `dumpcap.enable` and
`usbmon.enable` options. By default, users in the 'wireshark' group are
allowed to capture network traffic but not USB traffic.
'';
};
package = lib.mkPackageOption pkgs "wireshark-cli" {
example = "wireshark";
};
dumpcap.enable = lib.mkOption {
type = lib.types.bool;
default = true;
description = ''
Whether to allow users in the 'wireshark' group to capture network traffic. This
configures a setcap wrapper for 'dumpcap' for users in the 'wireshark' group.
'';
};
usbmon.enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Whether to allow users in the 'wireshark' group to capture USB traffic. This adds
udev rules to give users in the 'wireshark' group read permissions to all devices
in the usbmon subsystem.
'';
};
};
};
config = lib.mkIf cfg.enable {
environment.systemPackages = [ wireshark ];
users.groups.wireshark = { };
security.wrappers.dumpcap = lib.mkIf cfg.dumpcap.enable {
source = "${wireshark}/bin/dumpcap";
capabilities = "cap_net_raw,cap_net_admin+eip";
owner = "root";
group = "wireshark";
permissions = "u+rx,g+x";
};
services.udev.packages = lib.mkIf cfg.usbmon.enable [
(pkgs.writeTextDir "etc/udev/rules.d/85-wireshark-usbmon.rules" ''
SUBSYSTEM=="usbmon", MODE="0640", GROUP="wireshark"
'')
];
};
}