Packet32.h
上传用户:gzdtt123
上传日期:2022-01-26
资源大小:88k
文件大小:21k
- /*
- * Copyright (c) 1999 - 2003
- * NetGroup, Politecnico di Torino (Italy)
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * 3. Neither the name of the Politecnico di Torino nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
- /** @ingroup packetapi
- * @{
- */
- /** @defgroup packet32h Packet.dll definitions and data structures
- * Packet32.h contains the data structures and the definitions used by packet.dll.
- * The file is used both by the Win9x and the WinNTx versions of packet.dll, and can be included
- * by the applications that use the functions of this library
- * @{
- */
- #ifndef __PACKET32
- #define __PACKET32
- #include <winsock2.h>
- #include "devioctl.h"
- #ifdef HAVE_DAG_API
- #include <dagc.h>
- #endif /* HAVE_DAG_API */
- // Working modes
- #define PACKET_MODE_CAPT 0x0 ///< Capture mode
- #define PACKET_MODE_STAT 0x1 ///< Statistical mode
- #define PACKET_MODE_MON 0x2 ///< Monitoring mode
- #define PACKET_MODE_DUMP 0x10 ///< Dump mode
- #define PACKET_MODE_STAT_DUMP MODE_DUMP | MODE_STAT ///< Statistical dump Mode
- // ioctls
- #define FILE_DEVICE_PROTOCOL 0x8000
- #define IOCTL_PROTOCOL_STATISTICS CTL_CODE(FILE_DEVICE_PROTOCOL, 2 , METHOD_BUFFERED, FILE_ANY_ACCESS)
- #define IOCTL_PROTOCOL_RESET CTL_CODE(FILE_DEVICE_PROTOCOL, 3 , METHOD_BUFFERED, FILE_ANY_ACCESS)
- #define IOCTL_PROTOCOL_READ CTL_CODE(FILE_DEVICE_PROTOCOL, 4 , METHOD_BUFFERED, FILE_ANY_ACCESS)
- #define IOCTL_PROTOCOL_WRITE CTL_CODE(FILE_DEVICE_PROTOCOL, 5 , METHOD_BUFFERED, FILE_ANY_ACCESS)
- #define IOCTL_PROTOCOL_MACNAME CTL_CODE(FILE_DEVICE_PROTOCOL, 6 , METHOD_BUFFERED, FILE_ANY_ACCESS)
- #define IOCTL_OPEN CTL_CODE(FILE_DEVICE_PROTOCOL, 7 , METHOD_BUFFERED, FILE_ANY_ACCESS)
- #define IOCTL_CLOSE CTL_CODE(FILE_DEVICE_PROTOCOL, 8 , METHOD_BUFFERED, FILE_ANY_ACCESS)
- #define pBIOCSETBUFFERSIZE 9592 ///< IOCTL code: set kernel buffer size.
- #define pBIOCSETF 9030 ///< IOCTL code: set packet filtering program.
- #define pBIOCGSTATS 9031 ///< IOCTL code: get the capture stats.
- #define pBIOCSRTIMEOUT 7416 ///< IOCTL code: set the read timeout.
- #define pBIOCSMODE 7412 ///< IOCTL code: set working mode.
- #define pBIOCSWRITEREP 7413 ///< IOCTL code: set number of physical repetions of every packet written by the app.
- #define pBIOCSMINTOCOPY 7414 ///< IOCTL code: set minimum amount of data in the kernel buffer that unlocks a read call.
- #define pBIOCSETOID 2147483648 ///< IOCTL code: set an OID value.
- #define pBIOCQUERYOID 2147483652 ///< IOCTL code: get an OID value.
- #define pATTACHPROCESS 7117 ///< IOCTL code: attach a process to the driver. Used in Win9x only.
- #define pDETACHPROCESS 7118 ///< IOCTL code: detach a process from the driver. Used in Win9x only.
- #define pBIOCSETDUMPFILENAME 9029 ///< IOCTL code: set the name of a the file used by kernel dump mode.
- #define pBIOCEVNAME 7415 ///< IOCTL code: get the name of the event that the driver signals when some data is present in the buffer.
- #define pBIOCSENDPACKETSNOSYNC 9032 ///< IOCTL code: Send a buffer containing multiple packets to the network, ignoring the timestamps associated with the packets.
- #define pBIOCSENDPACKETSSYNC 9033 ///< IOCTL code: Send a buffer containing multiple packets to the network, respecting the timestamps associated with the packets.
- #define pBIOCSETDUMPLIMITS 9034 ///< IOCTL code: Set the dump file limits. See the PacketSetDumpLimits() function.
- #define pBIOCISDUMPENDED 7411 ///< IOCTL code: Get the status of the kernel dump process. See the PacketIsDumpEnded() function.
- #define pBIOCSTIMEZONE 7471 ///< IOCTL code: set time zone. Used in Win9x only.
- /// Alignment macro. Defines the alignment size.
- #define Packet_ALIGNMENT sizeof(int)
- /// Alignment macro. Rounds up to the next even multiple of Packet_ALIGNMENT.
- #define Packet_WORDALIGN(x) (((x)+(Packet_ALIGNMENT-1))&~(Packet_ALIGNMENT-1))
- #define NdisMediumNull -1 // Custom linktype: NDIS doesn't provide an equivalent
- #define NdisMediumCHDLC -2 // Custom linktype: NDIS doesn't provide an equivalent
- #define NdisMediumPPPSerial -3 // Custom linktype: NDIS doesn't provide an equivalent
- /*!
- brief Network type structure.
- This structure is used by the PacketGetNetType() function to return information on the current adapter's type and speed.
- */
- typedef struct NetType
- {
- UINT LinkType; ///< The MAC of the current network adapter (see function PacketGetNetType() for more information)
- ULONGLONG LinkSpeed; ///< The speed of the network in bits per second
- }NetType;
- //some definitions stolen from libpcap
- #ifndef BPF_MAJOR_VERSION
- /*!
- brief A BPF pseudo-assembly program.
- The program will be injected in the kernel by the PacketSetBPF() function and applied to every incoming packet.
- */
- struct bpf_program
- {
- UINT bf_len; ///< Indicates the number of instructions of the program, i.e. the number of struct bpf_insn that will follow.
- struct bpf_insn *bf_insns; ///< A pointer to the first instruction of the program.
- };
- /*!
- brief A single BPF pseudo-instruction.
- bpf_insn contains a single instruction for the BPF register-machine. It is used to send a filter program to the driver.
- */
- struct bpf_insn
- {
- USHORT code; ///< Instruction type and addressing mode.
- UCHAR jt; ///< Jump if true
- UCHAR jf; ///< Jump if false
- int k; ///< Generic field used for various purposes.
- };
- /*!
- brief Structure that contains a couple of statistics values on the current capture.
- It is used by packet.dll to return statistics about a capture session.
- */
- struct bpf_stat
- {
- UINT bs_recv; ///< Number of packets that the driver received from the network adapter
- ///< from the beginning of the current capture. This value includes the packets
- ///< lost by the driver.
- UINT bs_drop; ///< number of packets that the driver lost from the beginning of a capture.
- ///< Basically, a packet is lost when the the buffer of the driver is full.
- ///< In this situation the packet cannot be stored and the driver rejects it.
- UINT ps_ifdrop; ///< drops by interface. XXX not yet supported
- UINT bs_capt; ///< number of packets that pass the filter, find place in the kernel buffer and
- ///< thus reach the application.
- };
- /*!
- brief Packet header.
- This structure defines the header associated with every packet delivered to the application.
- */
- struct bpf_hdr
- {
- struct timeval bh_tstamp; ///< The timestamp associated with the captured packet.
- ///< It is stored in a TimeVal structure.
- UINT bh_caplen; ///< Length of captured portion. The captured portion <b>can be different</b>
- ///< from the original packet, because it is possible (with a proper filter)
- ///< to instruct the driver to capture only a portion of the packets.
- UINT bh_datalen; ///< Original length of packet
- USHORT bh_hdrlen; ///< Length of bpf header (this struct plus alignment padding). In some cases,
- ///< a padding could be added between the end of this structure and the packet
- ///< data for performance reasons. This filed can be used to retrieve the actual data
- ///< of the packet.
- };
- /*!
- brief Dump packet header.
- This structure defines the header associated with the packets in a buffer to be used with PacketSendPackets().
- It is simpler than the bpf_hdr, because it corresponds to the header associated by WinPcap and libpcap to a
- packet in a dump file. This makes straightforward sending WinPcap dump files to the network.
- */
- struct dump_bpf_hdr{
- struct timeval ts; ///< Time stamp of the packet
- UINT caplen; ///< Length of captured portion. The captured portion can smaller than the
- ///< the original packet, because it is possible (with a proper filter) to
- ///< instruct the driver to capture only a portion of the packets.
- UINT len; ///< Length of the original packet (off wire).
- };
- #endif
- #define DOSNAMEPREFIX TEXT("Packet_") ///< Prefix added to the adapters device names to create the WinPcap devices
- #define MAX_LINK_NAME_LENGTH 64 //< Maximum length of the devices symbolic links
- #define NMAX_PACKET 65535
- /*!
- brief Addresses of a network adapter.
- This structure is used by the PacketGetNetInfoEx() function to return the IP addresses associated with
- an adapter.
- */
- typedef struct npf_if_addr {
- struct sockaddr_storage IPAddress; ///< IP address.
- struct sockaddr_storage SubnetMask; ///< Netmask for that address.
- struct sockaddr_storage Broadcast; ///< Broadcast address.
- }npf_if_addr;
- #define ADAPTER_NAME_LENGTH 256 + 12 ///< Maximum length for the name of an adapter. The value is the same used by the IP Helper API.
- #define ADAPTER_DESC_LENGTH 128 ///< Maximum length for the description of an adapter. The value is the same used by the IP Helper API.
- #define MAX_MAC_ADDR_LENGTH 8 ///< Maximum length for the link layer address of an adapter. The value is the same used by the IP Helper API.
- #define MAX_NETWORK_ADDRESSES 16 ///< Maximum length for the link layer address of an adapter. The value is the same used by the IP Helper API.
- typedef struct WAN_ADAPTER_INT WAN_ADAPTER; ///< Describes an opened wan (dialup, VPN...) network adapter using the NetMon API
- typedef WAN_ADAPTER *PWAN_ADAPTER; ///< Describes an opened wan (dialup, VPN...) network adapter using the NetMon API
- #define INFO_FLAG_NDIS_ADAPTER 0 ///< Flag for ADAPTER_INFO: this is a traditional ndis adapter
- #define INFO_FLAG_NDISWAN_ADAPTER 1 ///< Flag for ADAPTER_INFO: this is a NdisWan adapter
- #define INFO_FLAG_DAG_CARD 2 ///< Flag for ADAPTER_INFO: this is a DAG card
- #define INFO_FLAG_DAG_FILE 6 ///< Flag for ADAPTER_INFO: this is a DAG file
- #define INFO_FLAG_DONT_EXPORT 8 ///< Flag for ADAPTER_INFO: when this flag is set, the adapter will not be listed or openend by winpcap. This allows to prevent exporting broken network adapters, like for example FireWire ones.
- /*!
- brief Contains comprehensive information about a network adapter.
- This structure is filled with all the accessory information that the user can need about an adapter installed
- on his system.
- */
- typedef struct _ADAPTER_INFO
- {
- struct _ADAPTER_INFO *Next; ///< Pointer to the next adapter in the list.
- CHAR Name[ADAPTER_NAME_LENGTH + 1]; ///< Name of the device representing the adapter.
- CHAR Description[ADAPTER_DESC_LENGTH + 1]; ///< Human understandable description of the adapter
- UINT MacAddressLen; ///< Length of the link layer address.
- UCHAR MacAddress[MAX_MAC_ADDR_LENGTH]; ///< Link layer address.
- NetType LinkLayer; ///< Physical characteristics of this adapter. This NetType structure contains the link type and the speed of the adapter.
- INT NNetworkAddresses; ///< Number of network layer addresses of this adapter.
- npf_if_addr *NetworkAddresses; ///< Pointer to an array of npf_if_addr, each of which specifies a network address of this adapter.
- UINT Flags; ///< Adapter's flags. Tell if this adapter must be treated in a different way, using the Netmon API or the dagc API.
- }
- ADAPTER_INFO, *PADAPTER_INFO;
- /*!
- brief Describes an opened network adapter.
- This structure is the most important for the functioning of packet.dll, but the great part of its fields
- should be ignored by the user, since the library offers functions that avoid to cope with low-level parameters
- */
- typedef struct _ADAPTER {
- HANDLE hFile; ///< internal Handle to an open instance of the NPF driver.
- CHAR SymbolicLink[MAX_LINK_NAME_LENGTH]; ///< internal A string containing the name of the network adapter currently opened.
- int NumWrites; ///< internal Number of times a packets written on this adapter will be repeated
- ///< on the wire.
- HANDLE ReadEvent; ///< A notification event associated with the read calls on the adapter.
- ///< It can be passed to standard Win32 functions (like WaitForSingleObject
- ///< or WaitForMultipleObjects) to wait until the driver's buffer contains some
- ///< data. It is particularly useful in GUI applications that need to wait
- ///< concurrently on several events. In Windows NT/2000 the PacketSetMinToCopy()
- ///< function can be used to define the minimum amount of data in the kernel buffer
- ///< that will cause the event to be signalled.
-
- UINT ReadTimeOut; ///< internal The amount of time after which a read on the driver will be released and
- ///< ReadEvent will be signaled, also if no packets were captured
- CHAR Name[ADAPTER_NAME_LENGTH];
- PWAN_ADAPTER pWanAdapter;
- UINT Flags; ///< Adapter's flags. Tell if this adapter must be treated in a different way, using the Netmon API or the dagc API.
- #ifdef HAVE_DAG_API
- dagc_t *pDagCard; ///< Pointer to the dagc API adapter descriptor for this adapter
- PCHAR DagBuffer; ///< Pointer to the buffer with the packets that is received from the DAG card
- struct timeval DagReadTimeout; ///< Read timeout. The dagc API requires a timeval structure
- unsigned DagFcsLen; ///< Length of the frame check sequence attached to any packet by the card. Obtained from the registry
- DWORD DagFastProcess; ///< True if the user requests fast capture processing on this card. Higher level applications can use this value to provide a faster but possibly unprecise capture (for example, libpcap doesn't convert the timestamps).
- #endif // HAVE_DAG_API
- } ADAPTER, *LPADAPTER;
- /*!
- brief Structure that contains a group of packets coming from the driver.
- This structure defines the header associated with every packet delivered to the application.
- */
- typedef struct _PACKET {
- HANDLE hEvent; ///< deprecated Still present for compatibility with old applications.
- OVERLAPPED OverLapped; ///< deprecated Still present for compatibility with old applications.
- PVOID Buffer; ///< Buffer with containing the packets. See the PacketReceivePacket() for
- ///< details about the organization of the data in this buffer
- UINT Length; ///< Length of the buffer
- DWORD ulBytesReceived; ///< Number of valid bytes present in the buffer, i.e. amount of data
- ///< received by the last call to PacketReceivePacket()
- BOOLEAN bIoComplete; ///< deprecated Still present for compatibility with old applications.
- } PACKET, *LPPACKET;
- /*!
- brief Structure containing an OID request.
- It is used by the PacketRequest() function to send an OID to the interface card driver.
- It can be used, for example, to retrieve the status of the error counters on the adapter, its MAC address,
- the list of the multicast groups defined on it, and so on.
- */
- struct _PACKET_OID_DATA {
- ULONG Oid; ///< OID code. See the Microsoft DDK documentation or the file ntddndis.h
- ///< for a complete list of valid codes.
- ULONG Length; ///< Length of the data field
- UCHAR Data[1]; ///< variable-lenght field that contains the information passed to or received
- ///< from the adapter.
- };
- typedef struct _PACKET_OID_DATA PACKET_OID_DATA, *PPACKET_OID_DATA;
- #if _DBG
- #define ODS(_x) OutputDebugString(TEXT(_x))
- #define ODSEx(_x, _y)
- #else
- #ifdef _DEBUG_TO_FILE
- /*!
- brief Macro to print a debug string. The behavior differs depending on the debug level
- */
- #define ODS(_x) {
- FILE *f;
- f = fopen("winpcap_debug.txt", "a");
- fprintf(f, "%s", _x);
- fclose(f);
- }
- /*!
- brief Macro to print debug data with the printf convention. The behavior differs depending on
- the debug level
- */
- #define ODSEx(_x, _y) {
- FILE *f;
- f = fopen("winpcap_debug.txt", "a");
- fprintf(f, _x, _y);
- fclose(f);
- }
- LONG PacketDumpRegistryKey(PCHAR KeyName, PCHAR FileName);
- #else
- #define ODS(_x)
- #define ODSEx(_x, _y)
- #endif
- #endif
- /* We load dinamically the dag library in order link it only when it's present on the system */
- #ifdef HAVE_DAG_API
- typedef dagc_t* (*dagc_open_handler)(const char *source, unsigned flags, char *ebuf); ///< prototype used to dynamically load the dag dll
- typedef void (*dagc_close_handler)(dagc_t *dagcfd); ///< prototype used to dynamically load the dag dll
- typedef int (*dagc_getlinktype_handler)(dagc_t *dagcfd); ///< prototype used to dynamically load the dag dll
- typedef int (*dagc_getlinkspeed_handler)(dagc_t *dagcfd); ///< prototype used to dynamically load the dag dll
- typedef int (*dagc_setsnaplen_handler)(dagc_t *dagcfd, unsigned snaplen); ///< prototype used to dynamically load the dag dll
- typedef unsigned (*dagc_getfcslen_handler)(dagc_t *dagcfd); ///< prototype used to dynamically load the dag dll
- typedef int (*dagc_receive_handler)(dagc_t *dagcfd, u_char **buffer, u_int *bufsize); ///< prototype used to dynamically load the dag dll
- typedef int (*dagc_stats_handler)(dagc_t *dagcfd, dagc_stats_t *ps); ///< prototype used to dynamically load the dag dll
- typedef int (*dagc_wait_handler)(dagc_t *dagcfd, struct timeval *timeout); ///< prototype used to dynamically load the dag dll
- typedef int (*dagc_finddevs_handler)(dagc_if_t **alldevsp, char *ebuf); ///< prototype used to dynamically load the dag dll
- typedef int (*dagc_freedevs_handler)(dagc_if_t *alldevsp); ///< prototype used to dynamically load the dag dll
- #endif // HAVE_DAG_API
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**
- * @}
- */
- // The following is used to check the adapter name in PacketOpenAdapterNPF and prevent
- // opening of firewire adapters
- #define FIREWIRE_SUBSTR L"1394"
- void PacketPopulateAdaptersInfoList();
- PWCHAR SChar2WChar(PCHAR string);
- PCHAR WChar2SChar(PWCHAR string);
- BOOL PacketGetFileVersion(LPTSTR FileName, PCHAR VersionBuff, UINT VersionBuffLen);
- PADAPTER_INFO PacketFindAdInfo(PCHAR AdapterName);
- BOOLEAN PacketUpdateAdInfo(PCHAR AdapterName);
- BOOLEAN IsFireWire(TCHAR *AdapterDesc);
- //---------------------------------------------------------------------------
- // EXPORTED FUNCTIONS
- //---------------------------------------------------------------------------
- PCHAR PacketGetVersion();
- PCHAR PacketGetDriverVersion();
- BOOLEAN PacketSetMinToCopy(LPADAPTER AdapterObject,int nbytes);
- BOOLEAN PacketSetNumWrites(LPADAPTER AdapterObject,int nwrites);
- BOOLEAN PacketSetMode(LPADAPTER AdapterObject,int mode);
- BOOLEAN PacketSetReadTimeout(LPADAPTER AdapterObject,int timeout);
- BOOLEAN PacketSetBpf(LPADAPTER AdapterObject,struct bpf_program *fp);
- INT PacketSetSnapLen(LPADAPTER AdapterObject,int snaplen);
- BOOLEAN PacketGetStats(LPADAPTER AdapterObject,struct bpf_stat *s);
- BOOLEAN PacketGetStatsEx(LPADAPTER AdapterObject,struct bpf_stat *s);
- BOOLEAN PacketSetBuff(LPADAPTER AdapterObject,int dim);
- BOOLEAN PacketGetNetType (LPADAPTER AdapterObject,NetType *type);
- LPADAPTER PacketOpenAdapter(PCHAR AdapterName);
- BOOLEAN PacketSendPacket(LPADAPTER AdapterObject,LPPACKET pPacket,BOOLEAN Sync);
- INT PacketSendPackets(LPADAPTER AdapterObject,PVOID PacketBuff,ULONG Size, BOOLEAN Sync);
- LPPACKET PacketAllocatePacket(void);
- VOID PacketInitPacket(LPPACKET lpPacket,PVOID Buffer,UINT Length);
- VOID PacketFreePacket(LPPACKET lpPacket);
- BOOLEAN PacketReceivePacket(LPADAPTER AdapterObject,LPPACKET lpPacket,BOOLEAN Sync);
- BOOLEAN PacketSetHwFilter(LPADAPTER AdapterObject,ULONG Filter);
- BOOLEAN PacketGetAdapterNames(PTSTR pStr,PULONG BufferSize);
- BOOLEAN PacketGetNetInfoEx(PCHAR AdapterName, npf_if_addr* buffer, PLONG NEntries);
- BOOLEAN PacketRequest(LPADAPTER AdapterObject,BOOLEAN Set,PPACKET_OID_DATA OidData);
- HANDLE PacketGetReadEvent(LPADAPTER AdapterObject);
- BOOLEAN PacketSetDumpName(LPADAPTER AdapterObject, void *name, int len);
- BOOLEAN PacketSetDumpLimits(LPADAPTER AdapterObject, UINT maxfilesize, UINT maxnpacks);
- BOOLEAN PacketIsDumpEnded(LPADAPTER AdapterObject, BOOLEAN sync);
- BOOL PacketStopDriver();
- VOID PacketCloseAdapter(LPADAPTER lpAdapter);
- #ifdef __cplusplus
- }
- #endif
- #endif //__PACKET32