home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / ipspy140.zip / readme < prev   
Text File  |  1998-05-31  |  5KB  |  120 lines
  1. IpSpy Version 1.40                                        31.May.98
  2.  
  3. Short description:
  4.            IpSpy is a DLL which allows to monitor all the packets,
  5.            IP and ARP ones, incoming, outgoing and forwarding.
  6.            It also provides the ability to write raw packets to your net.
  7.             
  8. Requirements:
  9.            INET and IFNDIS.
  10.            Only tested with OS/2 Warp V3.0 and tcpip 3.0.
  11.  
  12. Start:
  13.            IpSpy_Init(ULONG *ulHandle, UCHAR *pchIF);
  14.              Opens a specific interface for monitoring.
  15.              ulHandle    -   address of the handle for the interface
  16.              pchIF       -   address of the interface name which is
  17.                              one of the following: lo, lan0, ppp0, sl0 ...
  18. Stop:
  19.            IpSpy_Exit(ULONG ulHandle);
  20.              Close the interface.
  21.              ulHandle    -   monitor handle obtained from IpSpy_Init
  22.  
  23. Read:
  24.            IpSpy_ReadRaw(ULONG ulHandle, VOID *data, USHORT *usLength, USHORT *usType, ULONG *ulTimeStamp, USHORT *usUnknown);
  25.              Reads raw packets from the interface.
  26.              ulHandle    -   monitor handle obtained from IpSpy_Init
  27.              data        -   address of the buffer to receive the bytes read
  28.              usLength    -   address of the length, in bytes, of the data area
  29.                              AFTER CALL: contains the length of the packet
  30.              ulTimeStamp -   address of the timestamp from the packet
  31.              usUnknown   -   unknown
  32.  
  33. Write:
  34.            IpSpy_WriteRaw(ULONG ulHandle, VOID *data, USHORT usLength, USHORT usType, ULONG ulTimeStamp, USHORT usUnknown);
  35.              Writes raw packets to the interface.
  36.              ulHandle    -   monitor handle obtained from IpSpy_Init
  37.              data        -   address of the buffer that contains the data to write
  38.              usLength    -   address of the number of bytes to write
  39.              ulTimeStamp -   address of the timestamp from the packet
  40.              usUnknown   -   unknown
  41.  
  42. Adapter's Receive Mode:
  43.            IpSpy_SetReceiveMode(USHORT usMode, UCHAR *pchIF, PVOID pvReserved);
  44.              Provides the ability to bring the adapter in promiscous mode.
  45.              usMode      -   bitmask of desired receive mode
  46.              pchIF       -   address of the interface name which is
  47.                              one of the following: lo, lan0, ppp0, sl0 ...
  48.              pvReserved  -   reserved
  49.  
  50.              Promiscuous mode is when the Network card accepts all
  51.              packets, not only the packets which match our
  52.              Address. It is useful for writing a network monitor,
  53.              but it is also a security problem. You have to remember
  54.              that all information on the net is not encrypted.
  55.  
  56.              Note:
  57.               Most Token Ring adapters do not support promiscuous mode.
  58.  
  59.              Before use this function for the first time, you must modify
  60.              your \IBMCOM\PROTOCOL.INI
  61.              You  must  add  the  following 3 lines at the end of the file:
  62.               [IPSPY_NIF]
  63.               drivername = IPSPY$
  64.               bindings = MYMAC
  65.              where MYMAC is the section name of the MAC adapter driver
  66.              you want to use.(only one adapter is supported)
  67.  
  68.              Also add following line at the end of your CONFIG.SYS:
  69.               DEVICE=[PATH]\IPSPY.OS2
  70.  
  71.              After you have made these changes, you must reboot your PC.
  72.  
  73. Filters:
  74.            iptest.c is an example of an icmp packet filter.
  75.  
  76.            iptracx.c writes packets to the file iptrace.dmp,
  77.            which can later be analysed by ipformat.exe.
  78.  
  79.            If you write your own filter, i am interested in it.
  80.  
  81. Docu:
  82.            No Docu's. This software packet is only for
  83.            programmers with a lot of tcp/ip experience, and
  84.            the examples should be enough explanation.
  85.  
  86.  
  87. Warning:
  88.            IpSpy slows the tcp/ip stack significantly
  89.            and SHOULD NOT be run for a stressful applications which
  90.            tend to fan through a lot of data.
  91.  
  92. Usage and distribution:
  93.            PROVIDED FILES CAN NOT BE USED FOR ANY COMMERCIAL
  94.            PURPOSES WITHOUT AUTHORIZATION.
  95.            PROVIDED FILES CAN BE FREELY DISTRIBUTED ON THE CONDITION
  96.            THAT NO FEE IS CHARGED AND THAT THE ORIGINAL 
  97.            CONTENTS IS PRESERVED (NO ADDITIONS OR OMISSIONS). 
  98.            SINCE THIS FILES ARE PROVIDED FREE OF CHARGE THERE
  99.            IS ABSOLUTELY NO WARRANTY OR CLAIM AS TO THEIR
  100.            QUALITY OR FITNESS FOR ANY PARTICULAR PURPOSE.
  101.  
  102.  Copyright (c) 1997 Edgar Buerkle, 100566.557@compuserve.com
  103.  
  104. History:
  105.  1.00   first release.
  106.  1.10   IpSpy_WriteRaw() implemented.
  107.  1.20   Bugfix: timestamp allways 0 and internal transmit buffer too small.
  108.         Thanks to Olaf Ernst for the bug report.
  109.  1.30   IpSpy_(Set/Query)ReceiveMode() implemented.
  110.  1.31   IpSpy_GetLastSocketError implemented.
  111.         PPP frames are softwareLoopback frames (in iptest.c) ?
  112.         Suppress Netbind.exe message: PRO0021.
  113.         The <Requirements:> statement was wrong in this readme file.
  114.           I tested IpSpy only with tcpip version 3.0.
  115.           IpSpy don't works with tcpip 2.00 without fixpacks.
  116.         Thanks to Romney White for the bug report.
  117.  1.32   Added SLIP and PPP support to iptest filter.
  118.         Added IpTracx
  119.  1.40   Added support for 32 bit stack 5.300(tcpip 4.1)
  120.