Class WinPcap

Love The Way You Lie 2022-08-24 00:52 146阅读 0赞

<table> 
 <tbody> 
 <tr> 
 <td colspan="2" style="background-color: rgb(238, 238, 255); "><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html" rel="nofollow">http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html</a> 
 <table> 
 <tbody> 
 <tr> 
 <td style="background-color: rgb(238, 238, 255); "><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/overview-summary.html" rel="nofollow">Overview</a>&nbsp;</td> 
 <td style="background-color: rgb(238, 238, 255); "><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/package-summary.html" rel="nofollow">Package</a>&nbsp;</td> 
 <td style="background-color: rgb(0, 0, 139); ">&nbsp;Class&nbsp;</td> 
 <td style="background-color: rgb(238, 238, 255); "><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/package-tree.html" rel="nofollow">Tree</a>&nbsp;</td> 
 <td style="background-color: rgb(238, 238, 255); "><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/deprecated-list.html" rel="nofollow">Deprecated</a>&nbsp;</td> 
 <td style="background-color: rgb(238, 238, 255); "><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/index-all.html" rel="nofollow">Index</a>&nbsp;</td> 
 <td style="background-color: rgb(238, 238, 255); "><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/help-doc.html" rel="nofollow">Help</a>&nbsp;</td> 
 </tr> 
 </tbody> 
 </table></td> 
 <td align="right"></td> 
 </tr> 
 <tr> 
 <td style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255); ">&nbsp;PREV CLASS&nbsp; &nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcapRmtAuth.html" title="class in org.jnetpcap.winpcap" rel="nofollow">NEXT CLASS</a></td> 
 <td style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255); "><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/index.html?org/jnetpcap/winpcap/WinPcap.html" rel="nofollow">FRAMES</a>&nbsp;&nbsp; &nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html" rel="nofollow">NO FRAMES</a>&nbsp;&nbsp; &nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/allclasses-noframe.html" rel="nofollow">All Classes</a></td> 
 </tr> 
 <tr> 
 <td style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255); ">SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#field_summary" rel="nofollow">FIELD</a>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#method_summary" rel="nofollow">METHOD</a></td> 
 <td style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255); ">DETAIL:&nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#field_detail" rel="nofollow">FIELD</a>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#method_detail" rel="nofollow">METHOD</a></td> 
 </tr> 
 </tbody> 
</table>

--------------------

## org.jnetpcap.winpcap   Class WinPcap ##

java.lang.Object
      org.jnetpcap.Pcap
          org.jnetpcap.winpcap.WinPcap

--------------------

public class WinPcap
        
         extends 
         Pcap

Class peered with native `pcap_t` structure providing WinPcap specific extensions to libpcap library. To access WinPcap extensions, you must use WinPcap class and its methods. `WinPcap` class extends Pcap class so you have all of the typeical `Pcap` class functionality. WinPcap provides many additional methods which are only available on platforms what support WinPcap. First you must use static `WinPcap.isSupported()` method call which will return a boolean that will indicate if WinPcap extensions are supported on this particular platform. If you try and use any method in this class when WinPcap extensions are not supported, another words `WinPcap.isSupported()` returned false, every method in this calls will throw unchecked `PcapExtensionNotAvailableException`. Of course,`isSupported` call itself never throws an exception. So its safe to use on any platform.

// Before using any WinPcap code
     if (WinPcap.isSupported() == false) {
            return; // Can't use WinPcap extensions
     }

# Using WinPcap class #

For the most part, you use `WinPcap` the same way you would use `Pcap` class. `WinPcap` class provides many different static methods, and the same main three methods that `Pcap` does to open a capture session, plus one extra. They are:

*  openLive - opens a live capture from network interface
 *  openOffline - opens a capture file
 *  openDead - opens a dummy capture for filter compiling
 *  open - special open command that uses the *source string* syntax to accomplish the same tasks as the three openXXX methods before it.

There are also several addition methods:

*  findAllDevsEx - extended version of `Pcap.findAllDevs` which allows you to not only find network interfaces, but also PCAP files. This can be done locally or remotely.
 *  liveDump - which can dump captured packets to a savefile automatically at the kernel level.
 *  sendQueueTransmit - and related method, which allow raw packets to be sent in bulk, efficiently.
 *  setMinToCopy, setMode and setBuf - allow tweaking of kernel buffers and enable/disable statistical captures
 *  offlineFilter - ability to apply the BPF filter on your own packets without a capture
 *  setSampling - changes the mode of the capture where only samples of a capture are retruend. packets
 *  statEx - extended statistics that include counters on RPCAP remote connection

# Using WinPcap.findAllDevsEx #

The new method uses *source string* and WinPcapRmtAuth object and allows remote lookups of interfraces and files. A local lookup:

String source = "rpcap://";
 List<PcapIf> alldevs = new ArrayList<PcapIf>();
 
 int r = WinPcap.findAllDevsEx(source, auth, alldevs, errbuf);
 if (r != Pcap.OK) {
 fail(errbuf.toString());
 return;
 }
 
 System.out.println("device list is " + alldevs);

Now we have a list of PcapIf objects. You can use `PcapIf.getName()` which contains already properly formatted name to be passed to `WinPcap.open` call.

# Using WinPcap.open method #

Once you have a reference to a WinPcap object, you can then call any of its dynamic methods. Here is a straight forward example how to open a capture session and then close it:

WinPcap pcap = WinPcap.openLive(device, snaplen, flags, timeout, errbuf);
     // Do something
     pcap.close();

This is identical to `Pcap.openLive` method with the exception that `WinPcap` object is returned. WinPcap extends Pcap. Here is the same example this time using WinPcap's *source string* code and a bogus device name (you will need to substitute your own actual device name):

String source = "rpcap:Device//NPF_{BC81C4FC-242F-4F1C-9DAD-EA9523CC992D}";
      int snaplen = 64 * 1024;
      int flags = Pcap.MODE_NON_PROMISCUOUS;
      int timeout = 1000;
      WinPcapRmtAuth auth = null;
      StringBuilder errbuf = new StringBuilder();
     
      WinPcap pcap = WinPcap.open(source, snaplen, flags, timeout, auth, errbuf);
      if (pcap == null) {
            System.err.println(errbuf.toString());
            return;
      }
      pcap.close(); }

We use `open` method which takes a `WinPcapRmtAuth` object. We could set username and password in it, but we chose the 'NULL' authentication method. The remote server has to be configured with a '-n' command line argument to access 'NULL' authentication.

**Author:**

Mark Bednarczyk, Sly Technologies, Inc.

**See Also:**

[`Pcap`][Pcap]

--------------------

<table> 
 <tbody> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(204, 204, 255); background-position: initial initial; "> 
 <th align="left" colspan="2">Field Summary</th> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#MODE_CAPT" rel="nofollow">MODE_CAPT</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;default capture mode</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#MODE_MONITOR" rel="nofollow">MODE_MONITOR</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;monitor mode</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#MODE_STAT" rel="nofollow">MODE_STAT</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;statistical mode</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#OPENFLAG_DATATX_UDP" rel="nofollow">OPENFLAG_DATATX_UDP</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defines if the data trasfer (in case of a remote capture) has to be done with UDP protocol and can only be used with&nbsp;<code>WinPcap.open</code>.</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#OPENFLAG_MAX_RESPONSIVENESS" rel="nofollow">OPENFLAG_MAX_RESPONSIVENESS</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This flag configures the adapter for maximum responsiveness and can only be used with&nbsp;<code>WinPcap.open</code>.</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#OPENFLAG_NOCAPTURE_LOCAL" rel="nofollow">OPENFLAG_NOCAPTURE_LOCAL</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defines if the local adapter will capture its own generated traffic and can only be used with&nbsp;<code>WinPcap.open</code>.</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#OPENFLAG_NOCAPTURE_RPCAP" rel="nofollow">OPENFLAG_NOCAPTURE_RPCAP</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defines if the remote probe will capture its own generated traffic and can only be used with&nbsp;<code>WinPcap.open</code>.</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#SRC_FILE" rel="nofollow">SRC_FILE</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to create a&nbsp;source string&nbsp;using method&nbsp;<code>createSrcStr</code>, which will be used to open a local capture file.</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#SRC_IFLOCAL" rel="nofollow">SRC_IFLOCAL</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to create a&nbsp;source string&nbsp;using method&nbsp;<code>createSrcStr</code>, which will be used to open a local network interface.</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#SRC_IFREMOTE" rel="nofollow">SRC_IFREMOTE</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to create a&nbsp;source string&nbsp;using method&nbsp;<code>createSrcStr</code>,which will be used to open a remote connection (could be file, or network interface on remote system).</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#TRANSMIT_SYNCH_ASAP" rel="nofollow">TRANSMIT_SYNCH_ASAP</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag used with&nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#sendQueueTransmit%28org.jnetpcap.winpcap.WinPcapSendQueue,%20int%29" rel="nofollow"><code>sendQueueTransmit(WinPcapSendQueue, int)</code></a>, to tell kernel to send packets as fast as possible, without synchronizing with packet timestamps found in headers.</td> 
 </tr> 
 <tr style="background-image: initial; background-repeat: initial; background-attachment: initial; -webkit-background-clip: initial; -webkit-background-origin: initial; background-color: rgb(255, 255, 255); background-position: initial initial; "> 
 <td align="right"><code>static&nbsp;int</code></td> 
 <td><code><a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#TRANSMIT_SYNCH_USE_TIMESTAMP" rel="nofollow">TRANSMIT_SYNCH_USE_TIMESTAMP</a></code>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag used with&nbsp;<a href="http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/winpcap/WinPcap.html#sendQueueTransmit%28org.jnetpcap.winpcap.WinPcapSendQueue,%20int%29" rel="nofollow"><code>sendQueueTransmit(WinPcapSendQueue, int)</code></a>, to tell kernel to send packets at the rate that is determined by the timestamp with in the sendqueue.</td> 
 </tr> 
 </tbody> 
</table>

[Pcap]: http://jnetstream.com/docs/javadoc/jnetpcap-1.1-javadoc/org/jnetpcap/Pcap.html