packaging/debian/README.Debian

   1
   2 I. Capturing packets with Wireshark/Tshark
   3
   4    There are two ways of installing Wireshark/Tshark on Debian; the
   5    installation process may offer a choice between these two ways,
   6    asking "Should non-superuser be able to capture packets?"
   7
   8    I./a. Installing dumpcap without allowing non-root users to capture packets
   9
  10       Only root user will be able to capture packets. It is advised to capture
  11       packets with the bundled dumpcap program as root and then run
  12       Wireshark/Tshark as an ordinary user to analyze the captured logs. [2]
  13
  14       This is the default on Debian systems; it is selected by answering
  15       "<No>" to the question mentioned above.
  16
  17    I./b. Installing dumpcap and allowing non-root users to capture packets
  18
  19       Members of the wireshark group will be able to capture packets on network
  20       interfaces. This is the preferred way of installation if Wireshark/Tshark
  21       will be used for capturing and displaying packets at the same time, since
  22       that way only the dumpcap process has to be run with elevated privileges
  23       thanks to the privilege separation[1].
  24
  25       This is selected by answering "<Yes>" to the question mentioned
  26       above.
  27
  28       Note that no user will be added to group wireshark automatically;
  29       a system administrator has to add them manually, using the usermod
  30       command:
  31
  32          sudo usermod -a -G wireshark {username}
  33
  34       or, if you're using a desktop environment that includes a tool for
  35       managing users, such as the "Users and Groups" tool in GNOME (found
  36       in the gnome-system-tools package), using that tool.  After a user
  37       is added to the wireshark group, she/he may need to log in again to
  38       make her/his new group membership take effect and be able to capture
  39       packets.
  40
  41       The additional privileges are provided using the Linux Capabilities
  42       system where it is available and resorting to setting the set-user-id
  43       bit of the dumpcap binary as a fall-back, where the Linux Capabilities
  44       system is not present (Debian GNU/kFreeBSD, Debian GNU/Hurd).
  45
  46       Linux kernels provided by Debian support Linux Capabilities, but custom
  47       built kernels may lack this support. If the support for Linux
  48       Capabilities is not present at the time of installing wireshark-common
  49       package, the installer will fall back to set the set-user-id bit to
  50       allow non-root users to capture packets.
  51
  52       If installation succeeds with using Linux Capabilities, non-root users
  53       will not be able to capture packets while running kernels not supporting
  54       Linux Capabilities.
  55
  56       Note that capturing USB packets is not enabled for non-root users by using
  57       Linux Capabilities. You have to capture the packets using the method
  58       described in I./a., setting the set-user-id permanently using
  59       dpkg-statoverride or running dumpcap as root.
  60
  61       The installation method can be changed any time by running:
  62
  63          sudo dpkg-reconfigure wireshark-common
  64
  65       The question mentioned above will be asked; answer "<Yes>" to it.
  66
  67
  68 II. Installing SNMP MIBs
  69
  70     SNMP [4] OIDs can be decoded using MIBs provided by other packages.
  71     wireshark-common suggests snmp-mibs-downloader which package can be used to
  72     download a set of common MIBs Wireshark/Tshark tries to load at startup.
  73
  74     At the time of writing, MIBs are distributed under DFSG incompatible terms
  75     [5] thus snmp-mibs-downloader has to be in the non-free archive area.
  76     To keep wireshark in the main area [7], wireshark-common does not depend on
  77     or recommend snmp-mibs-downloader and as a result snmp-mibs-downloader is
  78     not installed automatically with wireshark.
  79
  80     To make Wireshark/Tshark able to decode OIDs, please install
  81     snmp-mibs-downloader manually.
  82
  83     To help Wireshark/Tshark to decode OIDs without having to install packages
  84     manually, please support the initiative of requesting additional rights
  85     from RFC authors [5].
  86
  87
  88    [1] https://gitlab.com/wireshark/wireshark/-/wikis/Development/PrivilegeSeparation
  89    [2] https://gitlab.com/wireshark/wireshark/-/wikis/CaptureSetup/CapturePrivileges
  90    [3] https://blog.wireshark.org/2010/02/running-wireshark-as-you
  91    [4] https://gitlab.com/wireshark/wireshark/-/wikis/SNMP
  92    [5] https://wiki.debian.org/NonFreeIETFDocuments
  93    [6] https://www.debian.org/doc/debian-policy/ch-archive.html#s-non-free
  94    [7] https://www.debian.org/doc/debian-policy/ch-archive.html#s-main