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.Dd August 30, 2007 32.Dt NDIS_EVENTS 8 33.Os 34.Sh NAME 35.Nm ndis_events 36.Nd relay events from 37.Xr ndis 4 38drivers to 39.Xr wpa_supplicant 8 40.Sh SYNOPSIS 41.Nm 42.Op Fl a 43.Op Fl d 44.Op Fl v 45.Sh DESCRIPTION 46The 47.Nm 48utility listens for events generated by an 49.Xr ndis 4 50wireless network driver and relays them to 51.Xr wpa_supplicant 8 52for possible processing. 53The three event types that can occur 54are media connect and disconnect events, such as when a wireless 55interface joins or leaves a network, and media-specific events. 56In particular, 57.Xr ndis 4 58drivers that support WPA2 will generate media-specific events 59containing PMKID candidate information which 60.Xr wpa_supplicant 8 61needs in order to properly associate with WPA2-capable access points. 62.Pp 63The 64.Nm 65daemon works by listening for interface information events via 66a routing socket. 67When it detects an event that was generated by an 68.Xr ndis 4 69interface, it transmits it via UDP packet on the loopback interface, 70where 71.Xr wpa_supplicant 8 72is presumably listening. 73The standard 74.Xr wpa_supplicant 8 75distribution includes its own version of this utility for use with 76.Tn Windows\[rg] . 77The 78.Fx 79version performs the same functions as the 80.Tn Windows\[rg] 81one, except that it uses an 82.Xr ioctl 2 83and routing socket interface instead of WMI. 84.Pp 85Note that a single instance of 86.Nm 87is sufficient to scan for events for any number of 88.Xr ndis 4 89interfaces in a system. 90.Sh OPTIONS 91The 92.Nm 93daemon supports the following options: 94.Bl -tag -width indent 95.It Fl a 96Process all events. 97By default, 98.Nm 99will only process and forward media-specific events, which contain 100PMKID candidate information, and not bother forwarding connect and 101disconnect events, since 102.Xr wpa_supplicant 8 103normally can determine the current link state on its own. 104In some 105cases, the additional connect and disconnect events only confuse it 106and make the association and authentication process take longer. 107.It Fl d 108Run in debug mode. 109This causes 110.Nm 111to run in the foreground and generate any output to the standard 112error instead of using the 113.Xr syslog 3 114facility. 115.It Fl v 116Run in verbose mode. 117This causes 118.Nm 119to emit notifications when it receives events. 120.El 121.Sh SEE ALSO 122.Xr ndis 4 , 123.Xr wpa_supplicant 8 124.Sh HISTORY 125The 126.Nm 127utility first appeared in 128.Fx 6.0 . 129.Sh AUTHORS 130The 131.Nm 132utility was written by 133.An Bill Paul Aq Mt wpaul@windriver.com . 134