doc/README.packaging

   1 The following guidelines should be followed by anyone distributing a software
   2 package containing Wireshark:
   3
   4 1. URLs.
   5
   6 1.1. Wireshark web site.
   7
   8 The Wireshark web site URL is https://www.wireshark.org/ .
   9
  10 1.2. Wireshark releases.
  11
  12 The canonical location for every Wireshark source release is
  13
  14     https://www.wireshark.org/download/src/all-versions/, e.g.
  15
  16     https://www.wireshark.org/download/src/all-versions/wireshark-2.6.5.tar.xz
  17
  18 If your packaging system downloads a copy of the Wireshark sources, use
  19 this location. Don't use https://www.wireshark.org/download/src.
  20
  21 1.3. Artwork.
  22
  23 Logo and icon artwork can be found in the "image" directory in the
  24 distribution. This is available online at
  25
  26     https://code.wireshark.org/review/gitweb?p=wireshark.git;a=tree;f=image;hb=HEAD
  27
  28 2. Licensing.
  29
  30 Wireshark is released under the GNU General Public License version 2 or
  31 newer.  Make sure your package complies with this license.
  32
  33 3. Privileges.
  34
  35 All function calls that require elevated privileges are in dumpcap.
  36
  37 WIRESHARK CONTAINS OVER TWO MILLION LINES OF SOURCE CODE. DO NOT RUN
  38 THEM AS ROOT.
  39
  40 Warnings are displayed when Wireshark and TShark are run as root.
  41
  42 There are several configure-time options on non-Windows systems that
  43 affect the privileges a normal user needs to capture traffic and list
  44 interfaces:
  45
  46     -DDUMPCAP_INSTALL_OPTION=capabilities
  47        Install dumpcap with cap_net_admin and cap_net_raw capabilities.
  48        Linux only.
  49
  50     -DDUMPCAP_INSTALL_OPTION=suid
  51        Install dumpcap setuid root.
  52
  53 These are necessary for non-root users to be able to capture on most
  54 systems, e.g. on Linux or FreeBSD if the user doesn't have permissions
  55 to access /dev/bpf*. Setcap installation is preferred over setuid on
  56 Linux. If "-DDUMPCAP_INSTALL_OPTION=capabilities" is used it will
  57 override any setuid settings.
  58
  59 The "-DENABLE_CAP" option is only useful when dumpcap is installed
  60 setuid. If it is enabled dumpcap will try to drop any setuid privileges
  61 it may have while retaining the CAP_NET_ADMIN and CAP_NET_RAW
  62 capabilities. It is enabled by default, if the Linux capabilities
  63 library (on which it depends) is found.
  64
  65 Note that enabling setcap or setuid installation allows packet capture
  66 for ALL users on your system. If this is not desired, you can restrict
  67 dumpcap execution to a specific group or user. The following two examples
  68 show how to restrict access using setcap and setuid respectively:
  69
  70 # groupadd -g packetcapture
  71 # chmod 750 /usr/bin/dumpcap
  72 # chgrp packetcapture /usr/bin/dumpcap
  73 # setcap cap_net_raw,cap_net_admin+ep /usr/bin/dumpcap
  74
  75 # groupadd -g packetcapture
  76 # chgrp packetcapture /usr/bin/dumpcap
  77 # chmod 4750 /usr/bin/dumpcap
  78
  79 4. Customization.
  80
  81 Custom version information can be added by creating a file called
  82 "version.conf" and running "make-version.pl -p". See make-version.pl for
  83 details. If your package contains significant changes we recommend that
  84 you use this to differentiate it from official Wireshark releases.
  85
  86 4.1. Source-level version detection.
  87
  88 The Git version corresponding to each release is in version.h. It's
  89 defined as a string. If you need a numeric definition, let us know.
  90
  91 5. Trademarks.
  92
  93 Wireshark and the "fin" logo are registered trademarks of the Wireshark
  94 Foundation.
  95
  96 6. Spelling.
  97
  98 Wireshark is spelled with a capital "W", and with everything else lower
  99 case. E.g., "WireShark" is incorrect.
 100
 101
 102 If you have a question not addressed here, send it to
 103 wireshark-dev@wireshark.org.