npcap-users-guide.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437
  1. <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Npcap Users' Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.2"><meta name="description" content="The Users' Guide covers the basics of installing and removing Npcap, interactions with WinPcap, frequently asked questions, and how to report bugs."><link rel="home" href="index.html" title="Npcap Reference Guide"><link rel="up" href="index.html" title="Npcap Reference Guide"><link rel="prev" href="index.html" title="Npcap Reference Guide"><link rel="next" href="npcap-devguide.html" title="Developing software with Npcap"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Npcap Users' Guide</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="npcap-devguide.html">Next</a></td></tr></table><hr></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="npcap-users-guide"></a>Npcap Users' Guide</h2></div><div><div class="abstract"><p class="title"><b>Abstract</b></p>
  2. <p>The Users' Guide covers the basics of installing and removing
  3. Npcap, interactions with WinPcap, frequently asked questions,
  4. and how to report bugs.</p>
  5. </div></div></div></div>
  6. <p>Because Npcap is a packet capture architecture, not merely a software
  7. library, some aspects of installation and configuration may fall to the end
  8. user. This Users' Guide covers the basics of installing, configuring, and
  9. removing Npcap, as well as how to report bugs.</p>
  10. <div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="npcap-installation"></a>Installation</h3></div></div></div>
  11. <p>
  12. Npcap is distributed as a signed executable installer, downloadable from
  13. <a class="ulink" href="https://npcap.com/#download" target="_top">Nmap.com</a>. Major
  14. versions are backwards-compatible, and users of the free non-commercial
  15. version are encouraged to upgrade regularly for security and stability
  16. fixes. Software distributors may have separate requirements for supported
  17. Npcap versions. Please refer to
  18. <a class="ulink" href="https://npcap.com/#license" target="_top">the Npcap License</a> for
  19. terms of use and redistribution.</p>
  20. <p>
  21. The Npcap installer and uninstaller are easy to use in
  22. <span class="quote">&#8220;<span class="quote">Graphical Mode</span>&#8221;</span> (direct run) and <span class="quote">&#8220;<span class="quote">Silent Mode</span>&#8221;</span> (run with
  23. <code class="option">/S</code> parameter, available only with <a class="ulink" href="https://npcap.com/oem/" target="_top">Npcap OEM</a>).
  24. </p>
  25. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-installation-options"></a>Installer options</h4></div></div></div>
  26. <p>
  27. The installer accepts several command-line options that correspond to the
  28. options presented in the graphical interface (GUI). The options can be
  29. set by command-line flags taking the form
  30. <code class="option">/<em class="replaceable"><code>name</code></em>=<em class="replaceable"><code>value</code></em></code>.
  31. </p>
  32. <p>The values for these options must be one of:
  33. </p>
  34. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="option">yes</code>: select the option</p></li><li class="listitem"><p><code class="option">no</code>: unselect the option</p></li><li class="listitem"><p><code class="option">enforced</code>: select the option and make it unchangable in the GUI</p></li><li class="listitem"><p><code class="option">disabled</code>: unselect the option and make it unchangable in the GUI</p></li></ul></div>
  35. <div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="npcap-installer-options-gui"></a>Graphical installer options</h5></div></div></div>
  36. <p>The following options are presented as checkboxes in the
  37. installer, but can be set or locked via command-line flags. Unless
  38. otherwise noted, the default for these options is <code class="option">no</code>.
  39. </p>
  40. <div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">/loopback_support</code></span></dt><dd><p>
  41. <span class="emphasis"><em>Legacy loopback support for Nmap 7.80 and older. Not needed for Wireshark.</em></span>
  42. Older versions of Npcap required a Microsoft KM-TEST loopback
  43. adapter to be installed in order to capture and inject loopback
  44. traffic. This is no longer needed, but some software won't be
  45. able to do loopback injection unless the adapter is installed.
  46. Use this option to install the legacy loopback adapter if
  47. needed.
  48. </p>
  49. <p>See <a class="xref" href="npcap-devguide.html#npcap-feature-loopback" title="For software that uses Npcap loopback feature">the section called &#8220;For software that uses Npcap loopback feature&#8221;</a> for more
  50. information.
  51. </p></dd><dt><span class="term"><code class="option">/admin_only</code></span></dt><dd><p>
  52. <span class="emphasis"><em>Restrict Npcap driver's access to Administrators
  53. only</em></span>. When this option is chosen, the devices
  54. created by the Npcap driver for capture and injection on each
  55. network adapter will be created with a restrictive ACL that
  56. only allows access to the device by the SYSTEM and built-in
  57. Administrators. Because this level of access requires UAC
  58. elevation, a helper binary, <code class="literal">NpcapHelper.exe</code>,
  59. is used to request elevation for each process that opens a
  60. capture handle.
  61. </p></dd><dt><span class="term"><code class="option">/dot11_support</code></span></dt><dd><p>
  62. <span class="emphasis"><em>Support raw 802.11 traffic (and monitor mode) for
  63. wireless adapters</em></span>. This option installs a second
  64. Lightweight Filter Driver that uses the Native WiFi API to
  65. capture raw 802.11 WiFi frames on devices that are put into
  66. network monitor mode. Captured frames are given a Radiotap
  67. header. Not all hardware or network drivers support the Native
  68. WiFi API.
  69. </p></dd><dt><span class="term"><code class="option">/winpcap_mode</code></span></dt><dd><p>
  70. <span class="emphasis"><em>Install Npcap in WinPcap API-compatible
  71. Mode</em></span>. The default for this option is
  72. <code class="option">yes</code> in Npcap 0.9985 and later. Npcap's DLLs
  73. have always been installed into a separate
  74. <code class="literal">Npcap</code> subdirectory of the system
  75. directory to avoid conflicting with existing WinPcap
  76. installations. This option also installs the DLLs to the
  77. system directory, replacing WinPcap. Any existing WinPcap
  78. installation will be removed.
  79. </p>
  80. <p>
  81. </p></dd><dt><span class="term"><code class="option">/prior_driver</code></span></dt><dd><p>
  82. <span class="emphasis"><em>Install older driver</em></span>. Microsoft continues to tighten their policy on what
  83. types of certificates and authorities may sign drivers. In cases where the current driver may
  84. not strictly meet these requirements, the <code class="option">/prior_driver</code> option may be used to
  85. install the last version of the driver that meets these requirements. In cases where no such
  86. driver exists, this option is ignored.
  87. </p>
  88. <p>
  89. </p></dd></dl></div>
  90. </div>
  91. <div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="npcap-installer-options-cli"></a>Command-line installation options</h5></div></div></div>
  92. <p>Some advanced or deprecated options are only available on the
  93. command-line. Options marked <code class="literal">(deprecated)</code> are
  94. subject to removal in future versions.</p>
  95. <div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">/S</code> (Silent install, Npcap OEM only)</span></dt><dd><p>
  96. Installs Npcap without showing any graphical windows or
  97. prompts. This option is case-sensitive. Silent install is available only for Npcap OEM.
  98. </p></dd><dt><span class="term"><code class="option">/disable_restore_point</code></span></dt><dd><p>
  99. The default for this option is <code class="option">yes</code>, so the
  100. installer will not set a system restore point. Windows may
  101. independently create a restore point because of the driver
  102. installation independent from this option. To ensure a
  103. restore point is made, specify
  104. <code class="option">/disable_restore_point=no</code>.
  105. </p></dd><dt><span class="term"><code class="option">/no_kill</code></span></dt><dd><p>
  106. Control termination of
  107. processes using Npcap during upgrades or WinPcap when
  108. <code class="option">/winpcap_mode=yes</code> is chosen. See
  109. <a class="xref" href="npcap-users-guide.html#npcap-installation-uninstall-options" title="Uninstaller options">the section called &#8220;Uninstaller options&#8221;</a>
  110. for more detailed discussion.
  111. </p></dd><dt><span class="term"><code class="option">/require_version</code></span></dt><dd><p>
  112. Uninstall and replace an existing Npcap installation even if it
  113. is newer than this version of the installer. By default, the
  114. Npcap installer will not remove and replace a version of Npcap
  115. that is newer than its own. In GUI mode, this hides the message
  116. box asking the user how to proceed.
  117. </p></dd><dt><span class="term"><code class="option">/require_features</code></span></dt><dd><p>
  118. Uninstall and replace an existing Npcap installation of any
  119. version if it does not provide the same features as the other
  120. command-line options specify. Features are the /winpcap_mode,
  121. /dot11_support, /loopback_support, and /admin_only options.
  122. </p></dd><dt><span class="term"><code class="option">/force</code></span></dt><dd><p>
  123. Uninstall and replace an existing Npcap installation regardless
  124. of version or whether the installation would be modified. By
  125. default, the Npcap installer will not remove and replace a
  126. Npcap installation of the same version unless the install
  127. options would be modified. In GUI mode, this hides the message
  128. box asking the user how to proceed.
  129. </p></dd><dt><span class="term"><code class="option">/D</code> (destination directory)</span></dt><dd><p>
  130. The destination directory for installation can be overridden by
  131. the <code class="option">/D</code> option, with a few restrictions. First, it will
  132. only affect where Npcap keeps its installation logs and helper utilities.
  133. The driver and DLLs will always be installed into the appropriate
  134. directories below <span class="command"><strong>%SYSTEMROOT%\System32\</strong></span>. Second, the
  135. <code class="option">/D</code> must be the last option in the command, and the path
  136. must not contain quotes. This option is case-sensitive. For example, to change the installation directory
  137. to <code class="filename">C:\Path With Spaces\</code>, the invocation would be:
  138. <span class="command"><strong>npcap-<em class="replaceable"><code>version</code></em>.exe /D=C:\Path With Spaces</strong></span>
  139. </p></dd><dt><span class="term"><code class="option">/npf_startup</code> (deprecated)</span></dt><dd><p>
  140. <span class="emphasis"><em>Automatically start the Npcap driver at boot
  141. time</em></span>. This option defaults to
  142. <code class="option">yes</code>, because Windows expects NDIS filter
  143. drivers to be available at boot time. If you choose to disable
  144. this, Windows may not start networking for up to 90 seconds
  145. after boot.
  146. </p></dd><dt><span class="term"><code class="option">/vlan_support</code> (deprecated, ignored)</span></dt><dd><p>
  147. <span class="emphasis"><em>Support 802.1Q VLAN tag when capturing and sending
  148. data (currently unsupported)</em></span>. This feature was
  149. disabled in 2016 to prevent a crash and has not been
  150. re-enabled.
  151. </p></dd></dl></div>
  152. </div>
  153. </div>
  154. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-installation-uninstall-options"></a>Uninstaller options</h4></div></div></div>
  155. <p>
  156. The uninstaller provided with Npcap also accepts some command-line options.
  157. </p>
  158. <div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">/S</code> (Silent uninstall)</span></dt><dd>
  159. <p>Uninstalls Npcap without showing any graphical windows or
  160. prompts. Silent uninstall is available in all editions of Npcap,
  161. not just Npcap OEM. If Npcap OEM installer in silent mode needs
  162. to uninstall an older Npcap installation, it passes the
  163. <code class="option">/S</code> option to the existing uninstaller. This option is case-sensitive.</p>
  164. </dd><dt><span class="term"><code class="option">/Q</code> (Quick uninstall)</span></dt><dd>
  165. <p>Skips the confirmation page and finish page in the uninstall
  166. wizard. This option does not have any meaning for silent
  167. uninstalls.</p>
  168. </dd><dt><span class="term"><code class="option">/no_kill</code>=<em class="replaceable"><code>yes|no</code></em> (do not kill processes)</span></dt><dd>
  169. <p>Controls how the uninstaller handles processes that are still using
  170. Npcap at the time of uninstall. The default value is
  171. <code class="literal">no</code>, which allows the uninstaller to terminate
  172. processes that would block Npcap from being uninstalled. If
  173. <code class="option">/no_kill=yes</code> is specified, then Npcap
  174. uninstaller will fail if there are still applications using Npcap
  175. driver or DLLs.</p>
  176. <p>In the default case, <code class="option">/no_kill=no</code>, the
  177. graphical uninstaller will give the user the choice to manually
  178. close the offending programs, have the uninstaller terminate
  179. them, or abort the uninstallation. In silent mode, Npcap
  180. uninstaller will immediately terminate any command-line processes
  181. that are using Npcap (like a Nmap process that is still
  182. scanning), and wait for at most 15 seconds to gracefully
  183. terminate any GUI processes that are using Npcap (like Wireshark
  184. UI that is still capturing). <span class="quote">&#8220;<span class="quote">Gracefully</span>&#8221;</span> means
  185. that if you are still capturing via Wireshark, Wireshark UI will
  186. prompt the user about whether to save the current capture before
  187. closing. The user will have 15 seconds to save his session.
  188. <span class="emphasis"><em>Note:</em></span> although Npcap uninstaller won't
  189. terminate Wireshark UI processes immediately, the live capture
  190. stops immediately. This is because Wireshark UI uses command-line
  191. processes named <code class="varname">dumpcap.exe</code> to capture, and
  192. that command-line process will be terminated immediately.</p>
  193. <p>If this option is provided on the
  194. <span class="emphasis"><em>installer</em></span> command line, it will be passed to
  195. the Npcap uninstaller when doing an upgrade or
  196. replacement.</p>
  197. </dd></dl></div>
  198. </div>
  199. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-installation-options-disabled"></a>Disabled and enforced options for GUI Mode</h4></div></div></div>
  200. <p>
  201. We may disable or enforce certain options in the installer GUI to make them unselectable. This
  202. usually means that those options can easily cause compatibility issues and are considered
  203. not suitable for most users, or we think we need to enforce some rules for the Npcap API. Advanced users can still change their states via command-line
  204. parameters, which is described in following sections.
  205. </p>
  206. <p>
  207. Fortunately, if a distributor wants to start the Npcap installer GUI and disable or enforce
  208. certain options for reasons like compatibility. It can also use the four value
  209. mechanism by setting the command-line parameters to <code class="option">disabled</code> or <code class="option">enforced</code>.
  210. For example, the following command will start an installer GUI with the
  211. <code class="option">loopback_support</code> option disabled and unselected:
  212. </p>
  213. <p>
  214. <span class="command"><strong>npcap-<em class="replaceable"><code>version</code></em>.exe /loopback_support=disabled</strong></span>
  215. </p>
  216. </div>
  217. </div>
  218. <div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="npcap-platforms"></a>Windows platforms supported</h3></div></div></div>
  219. <p>Npcap supports all Windows versions currently supported by Microsoft. Depending on Windows version, the
  220. driver may support a different NDIS version, which corresponds to a set of network stack
  221. features.</p>
  222. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  223. <p>On <span class="emphasis"><em>Windows 10</em></span>, <span class="emphasis"><em>Windows Server 2016</em></span>, and
  224. <span class="emphasis"><em>Windows Server 2019</em></span>, Npcap installs a NDIS 6.50
  225. driver.</p></li><li class="listitem">
  226. <p>On <span class="emphasis"><em>Windows 8.1</em></span>, <span class="emphasis"><em>Windows 8</em></span>,
  227. <span class="emphasis"><em>Windows Server 2012 R2</em></span>, and
  228. <span class="emphasis"><em>Windows Server 2012</em></span>,
  229. Npcap installs a NDIS 6.30 driver.</p></li><li class="listitem">
  230. <p>On <span class="emphasis"><em>Windows 7</em></span> and <span class="emphasis"><em>Windows Server 2008 R2</em></span>, Npcap
  231. installs a NDIS 6.20 driver.</p></li></ul></div>
  232. <p>Microsoft will end Extended support for Windows versions prior to Windows 10 on January 10, 2023. After
  233. that time, new Npcap releases <span class="emphasis"><em>may</em></span> omit support for these operating
  234. systems.</p>
  235. <p>Npcap can be installed on x86, x86-64, and ARM64. DLLs for the native architecture will be installed, as
  236. well as x86 DLLs for applications running in 32-bit emulation.</p>
  237. </div>
  238. <div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="npcap-feature-dot11-wireshark"></a>How to use Wireshark to capture raw 802.11 traffic in <span class="quote">&#8220;<span class="quote">Monitor Mode</span>&#8221;</span></h3></div></div></div>
  239. <p>
  240. The latest Wireshark has already integrated the support for Npcap's <span class="quote">&#8220;<span class="quote">Monitor Mode</span>&#8221;</span> capture.
  241. If you want to use Wireshark to capture raw 802.11 traffic in <span class="quote">&#8220;<span class="quote">Monitor Mode</span>&#8221;</span>, you need to
  242. switch on the monitor mode inside the Wireshark UI instead of using <a class="xref" href="npcap-devguide.html#npcap-feature-dot11-wlanhelper" title="WlanHelper">the section called &#8220;WlanHelper&#8221;</a>.
  243. This is because Wireshark only recognizes the monitor mode set by itself. So when you turn
  244. on monitor mode outside Wireshark (like in <code class="filename">WlanHelper</code>), Wireshark will not know the adapter
  245. has been in monitor mode, and will still try to capture in Ethernet mode, which will get no traffic.
  246. So after all, the correct steps are:
  247. </p>
  248. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Install latest version Wireshark and latest version Npcap with
  249. <code class="option">Support raw 802.11 traffic</code> option checked.</p></li><li class="listitem"><p>Launch Wireshark QT UI (GTK version is similar), go to <span class="quote">&#8220;<span class="quote">Capture options</span>&#8221;</span>.
  250. Then toggle the checkbox in the <span class="quote">&#8220;<span class="quote">Monitor Mode</span>&#8221;</span> column of your wireless adapter's row.
  251. Click the <span class="quote">&#8220;<span class="quote">Start</span>&#8221;</span> button. If you see a horizontal line instead of the checkbox,
  252. then it probably means that your adapter doesn't support monitor mode. You can use the
  253. <code class="filename">WlanHelper</code> tool to double-check this fact.</p></li><li class="listitem"><p>To decrypt <span class="emphasis"><em>encrypted 802.11 data</em></span>
  254. packets, you need to specify the decipher key in Wireshark, otherwise
  255. you will only see 802.11 data packets.</p></li><li class="listitem"><p>Stop the capture in Wireshark UI when you finishes capturing, the monitor mode
  256. will be turned off automatically by Npcap.</p></li></ul></div>
  257. </div>
  258. <div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="npcap-qa"></a>Q &amp; A</h3></div></div></div>
  259. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Network interruption while installing Npcap: Installing a filter driver may
  260. cause brief interruptions to network connectivity based on the specific changes needed
  261. to install the driver in the network stack. This known issue is documented as
  262. <a class="ulink" href="" target="_top">issue #53</a> on our tracker.</p>
  263. <p> A separate issue is a longer interruption in connectivity if the
  264. <code class="varname">npcap</code> service is not started, which used to be an installer option.
  265. As Microsoft states <a class="ulink" href="https://support.microsoft.com/en-us/kb/2019184" target="_top">here</a>,
  266. <span class="emphasis"><em>an optional NDIS light-weight filter (LWF) driver like Npcap could cause
  267. 90-second delay in network availability</em></span>. Some solutions you could try
  268. are: 1) wait for 90 seconds; 2) disable and re-enable the adapter icon in
  269. <span class="command"><strong>ncpa.cpl</strong></span>; 3) reboot. If the network is still unable to connect,
  270. please <a class="ulink" href="http://issues.npcap.org/new?title=Npcap+Bug+Report" target="_top">file a bug report</a>.
  271. </p></li><li class="listitem"><p>Installation fails with error code <code class="varname">0x8004a029</code>:
  272. The cause is that you have <span class="quote">&#8220;<span class="quote">reached the maximum number of network filter
  273. drivers</span>&#8221;</span>, see solution
  274. <a class="ulink" href="https://social.technet.microsoft.com/Forums/windows/en-US/4deb27fc-33ce-4fc0-a26f-3fec5b57733d/is-there-a-maximum-number-of-network-filter-drivers-in-windows-7?forum=w7itpronetworking" target="_top">here</a>.
  275. </p></li><li class="listitem"><p>Npcap Loopback Adapter is missing (legacy loopback support):
  276. The legacy Npcap Loopback Adapter is actually a wrapper of Microsoft Loopback Adapter.
  277. Such adapters won't show up in Wireshark if the <code class="varname">Basic Filtering Enging (BFE)</code>
  278. service was not running. To fix this issue, you should start this service at <code class="varname">services.msc</code>
  279. manually and restart the Npcap service by running <span class="command"><strong>net stop npcap</strong></span>
  280. and <span class="command"><strong>net start npcap</strong></span>. See details about this issue
  281. <a class="ulink" href="https://github.com/nmap/nmap/issues/802" target="_top">here</a>.
  282. </p></li><li class="listitem"><p>Npcap only captures TCP handshake and teardown, but not data packets.
  283. Some network adapters support offloading of tasks to free up CPU time for
  284. performance reasons. When this happens, Npcap may not receive all of the
  285. packets, or may receive them in a different form than is actually sent on the
  286. wire. To avoid this issue, you may disable TCP Chimney, IP Checksum
  287. Offloading, and Large Send Offloading in the network adapter properites on
  288. Windows. See details about this issue in
  289. <a class="ulink" href="https://github.com/nmap/nmap/issues/989" target="_top">issue
  290. #989</a> on our tracker.
  291. </p></li></ul></div>
  292. </div>
  293. <div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="npcap-issues"></a>Reporting Bugs</h3></div></div></div>
  294. <p>
  295. Please report any bugs or issues about Npcap on
  296. <a class="ulink" href="http://issues.npcap.org/new?title=Npcap+Bug+Report" target="_top">the Nmap Project's Issues tracker</a>.
  297. In your report, please provide your <span class="emphasis"><em>DiagReport</em></span> output, user
  298. software version (e.g. Nmap, Wireshark), steps to reproduce the problem, and other information
  299. you think necessary. If your issue occurs only on a particular OS version (e.g. Win10
  300. 1511, 1607), please mention it in the report.
  301. </p>
  302. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-issues-diagreport"></a>Diagnostic report</h4></div></div></div>
  303. <p>
  304. Npcap has provided a diagnostic utility called <code class="filename">DiagReport</code>.
  305. It provides a lot of information including OS metadata, Npcap related files,
  306. install options, registry values, services, etc. You can simply click the
  307. <code class="filename">C:\Program Files\Npcap\DiagReport.bat</code> file to run <code class="filename">DiagReport</code>.
  308. It will pop up a text report via Notepad (it's stored in: <code class="filename">C:\Program Files\Npcap\DiagReport.txt</code>).
  309. Please always submit it to us if you encounter any issues.
  310. </p>
  311. </div>
  312. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-issues-installation-log"></a>General installation log</h4></div></div></div>
  313. <p>
  314. Npcap keeps track of the installation in a log file:
  315. <code class="filename">C:\Program Files\Npcap\install.log</code>. Please submit it
  316. together in your report if you encounter issues during the installation
  317. (e.g. the installer halts).
  318. </p>
  319. </div>
  320. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-issues-driver-installation-log"></a>Driver installation log</h4></div></div></div>
  321. <p>
  322. Npcap keeps track of the driver installation (aka commands run by
  323. <code class="filename">NPFInstall.exe</code>) in a log file:
  324. <code class="filename">C:\Program Files\Npcap\NPFInstall.log</code>, please submit
  325. it together in your report if you encounter issues during the driver
  326. installation or problems with the <span class="quote">&#8220;<span class="quote">Npcap Loopback Adapter</span>&#8221;</span>.
  327. </p>
  328. <p>
  329. There's another system-provided driver installation log in:
  330. <code class="filename">C:\Windows\INF\setupapi.dev.log</code>.
  331. If you encounter errors during the driver/service installation, please copy
  332. the Npcap-related lines out and send them together in
  333. your report.
  334. </p>
  335. </div>
  336. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-issues-packet-log"></a>Dynamic link library (DLL) log</h4></div></div></div>
  337. <p>
  338. For problems with Npcap's regular operation, you may need to obtain a
  339. debug log from <code class="filename">Packet.dll</code>. To do this, you will
  340. need a debug build of Npcap. If you are a Npcap developer, you can build
  341. the <code class="filename">Packet.sln</code> project with the
  342. <code class="varname">_DEBUG_TO_FILE</code> macro defined. If you are an end user,
  343. you can contact the Npcap development team for the latest Npcap debug
  344. build. The debugging process will continue to append to the debug log
  345. (<code class="filename">C:\Program Files\Npcap\Packet.log</code>), so you may want
  346. to delete it after an amount of time, or save your output to another
  347. place before it gets too large.
  348. </p>
  349. </div>
  350. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-issues-driver-log"></a>Driver log</h4></div></div></div>
  351. <p>
  352. If there is an issue with the Npcap driver, you can open an
  353. <span class="emphasis"><em>Administrator</em></span> command prompt, enter <span class="command"><strong>sc query
  354. npcap</strong></span> to query the driver status and <span class="command"><strong>net start
  355. npcap</strong></span> to start the driver (replace
  356. <em class="replaceable"><code>npcap</code></em> with <em class="replaceable"><code>npf</code></em> if you
  357. installed Npcap in <span class="quote">&#8220;<span class="quote">WinPcap Compatible Mode</span>&#8221;</span>). The command
  358. output will inform you whether there's an error. If the driver is running
  359. well, but the issue still exists, then you may need to check the driver's
  360. log. Normal Npcap releases don't switch on the driver log function for
  361. performance. Contact the Npcap development team to obtain a driver-debug
  362. version of the Npcap installer. When you have got an appropriate
  363. driver-debug version Npcap, you need to use <a class="ulink" href="https://technet.microsoft.com/en-us/sysinternals/debugview.aspx" target="_top">DbgView</a>
  364. to read the Windows kernel log (which contains our driver log). You may
  365. need to turn on DbgView before installing Npcap, if the error occurs when
  366. the driver loads. When done, save the DbgView output to a file and submit
  367. it in your report.
  368. </p>
  369. </div>
  370. <div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="npcap-issues-bsod"></a>Blue screen of death (BSoD) dump</h4></div></div></div>
  371. <p>
  372. If you encountered BSoD when using Npcap, please attach the minidump
  373. file (in <code class="filename">C:\Windows\Minidump\</code>) to your report
  374. together with the Npcap version. We may ask you to provide the full
  375. dump (<code class="filename">C:\Windows\MEMORY.DMP</code>) for further troubleshooting.
  376. </p>
  377. </div>
  378. </div>
  379. </div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="npcap-devguide.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Npcap Reference Guide </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Developing software with Npcap</td></tr></table></div></body></html>