usr.sbin/802_11/ndis_events/ndis_events.8

   1 .\" Copyright (c) 2005
   2 .\"     Bill Paul <wpaul@windriver.com> All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD: src/usr.sbin/wpa/ndis_events/ndis_events.8,v 1.7 2007/09/07 22:19:29 brueffer Exp $
  32 .\"
  33 .Dd August 30, 2007
  34 .Dt NDIS_EVENTS 8
  35 .Os
  36 .Sh NAME
  37 .Nm ndis_events
  38 .Nd relay events from
  39 .Xr ndis 4
  40 drivers to
  41 .Xr wpa_supplicant 8
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl a
  45 .Op Fl d
  46 .Op Fl v
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility listens for events generated by an
  51 .Xr ndis 4
  52 wireless network driver and relays them to
  53 .Xr wpa_supplicant 8
  54 for possible processing.
  55 The three event types that can occur
  56 are media connect and disconnect events, such as when a wireless
  57 interface joins or leaves a network, and media-specific events.
  58 In particular,
  59 .Xr ndis 4
  60 drivers that support WPA2 will generate media-specific events
  61 containing PMKID candidate information which
  62 .Xr wpa_supplicant 8
  63 needs in order to properly associate with WPA2-capable access points.
  64 .Pp
  65 The
  66 .Nm
  67 daemon works by listening for interface information events via
  68 a routing socket.
  69 When it detects an event that was generated by an
  70 .Xr ndis 4
  71 interface, it transmits it via UDP packet on the loopback interface,
  72 where
  73 .Xr wpa_supplicant 8
  74 is presumably listening.
  75 The standard
  76 .Xr wpa_supplicant 8
  77 distribution includes its own version of this utility for use with
  78 .Tn Windows\[rg] .
  79 The
  80 .Dx
  81 version performs the same functions as the
  82 .Tn Windows\[rg]
  83 one, except that it uses an
  84 .Fn ioctl
  85 and routing socket interface instead of WMI.
  86 .Pp
  87 Note that a single instance of
  88 .Nm
  89 is sufficient to scan for events for any number of
  90 .Xr ndis 4
  91 interfaces in a system.
  92 .Sh OPTIONS
  93 The
  94 .Nm
  95 daemon supports the following options:
  96 .Bl -tag -width indent
  97 .It Fl a
  98 Process all events.
  99 By default,
 100 .Nm
 101 will only process and forward media-specific events, which contain
 102 PMKID candidate information, and not bother forwarding connect and
 103 disconnect events, since
 104 .Xr wpa_supplicant 8
 105 normally can determine the current link state on its own.
 106 In some
 107 cases, the additional connect and disconnect events only confuse it
 108 and make the association and authentication process take longer.
 109 .It Fl d
 110 Run in debug mode.
 111 This causes
 112 .Nm
 113 to run in the foreground and generate any output to the standard
 114 error instead of using the
 115 .Xr syslog 3
 116 facility.
 117 .It Fl v
 118 Run in verbose mode.
 119 This causes
 120 .Nm
 121 to emit notifications when it receives events.
 122 .El
 123 .Sh SEE ALSO
 124 .Xr ndis 4 ,
 125 .Xr wpa_supplicant 8
 126 .Sh HISTORY
 127 The
 128 .Nm
 129 utility first appeared in
 130 .Fx 6.0 .
 131 .Sh AUTHORS
 132 The
 133 .Nm
 134 utility was written by
 135 .An Bill Paul Aq Mt wpaul@windriver.com .