.\" This manpage has been automatically generated by docbook2man .\" from a DocBook document.  This tool can be found at:.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>..TH "WPA_CLI" "8" "06 May 2006" "" "".SH NAMEwpa_cli \- WPA command line client.SH SYNOPSIS\fBwpa_cli\fR [ \fB-p \fIpath to ctrl sockets\fB\fR ] [ \fB-i \fIifname\fB\fR ] [ \fB-hvB\fR ] [ \fB-a \fIaction file\fB\fR ] [ \fB-P \fIpid file\fB\fR ] [ \fB\fIcommand ...\fB\fR ].SH "OVERVIEW".PPwpa_cli is a text-based frontend program for interactingwith wpa_supplicant. It is used to query current status, changeconfiguration, trigger events, and request interactive userinput..PPwpa_cli can show the current authentication status, selectedsecurity mode, dot11 and dot1x MIBs, etc. In addition, it canconfigure some variables like EAPOL state machine parameters andtrigger events like reassociation and IEEE 802.1Xlogoff/logon. wpa_cli provides a user interface to requestauthentication information, like username and password, if theseare not included in the configuration. This can be used toimplement, e.g., one-time-passwords or generic token cardauthentication where the authentication is based on achallenge-response that uses an external device for generating theresponse..PPThe control interface of wpa_supplicant can be configured toallow non-root user access (ctrl_interface_group in theconfiguration file). This makes it possible to run wpa_cli with anormal user account..PPwpa_cli supports two modes: interactive and commandline. Both modes share the same command set and the maindifference is in interactive mode providing access to unsolicitedmessages (event messages, username/password requests)..PPInteractive mode is started when wpa_cli is executed withoutincluding the command as a command line parameter. Commands arethen entered on the wpa_cli prompt. In command line mode, the samecommands are entered as command line arguments for wpa_cli..SH "INTERACTIVE AUTHENTICATION PARAMETERS REQUEST".PPWhen wpa_supplicant need authentication parameters, likeusername and password, which are not present in the configurationfile, it sends a request message to all attached frontend programs,e.g., wpa_cli in interactive mode. wpa_cli shows these requestswith "CTRL-REQ-<type>-<id>:<text>"prefix. <type> is IDENTITY, PASSWORD, or OTP(one-time-password). <id> is a unique identifier for thecurrent network. <text> is description of the request. Incase of OTP request, it includes the challenge from theauthentication server..PPThe reply to these requests can be given with 'identity','password', and 'otp' commands. <id> needs to be copied from thethe matching request. 'password' and 'otp' commands can be usedregardless of whether the request was for PASSWORD or OTP. Themain difference between these two commands is that values givenwith 'password' are remembered as long as wpa_supplicant isrunning whereas values given with 'otp' are used only once andthen forgotten, i.e., wpa_supplicant will ask frontend for a newvalue for every use. This can be used to implementone-time-password lists and generic token card -basedauthentication..PPExample request for password and a matching reply:.sp.RS.nfCTRL-REQ-PASSWORD-1:Password needed for SSID foobar> password 1 mysecretpassword.fi.RE.PPExample request for generic token card challenge-response:.sp.RS.nfCTRL-REQ-OTP-2:Challenge 1235663 needed for SSID foobar> otp 2 9876.fi.RE.SH "COMMAND ARGUMENTS".TP\fB-p path\fRChange the path where control sockets shouldbe found..TP\fB-i ifname\fRSpecify the interface that is beingconfigured.  By default, choose the first interface found witha control socket in the socket path..TP\fB-h\fRHelp.  Show a usage message..TP\fB-v\fRShow version information..TP\fB-B\fRRun as a daemon in the background..TP\fB-a file\fRRun in daemon mode executing the action filebased on events from wpa_supplicant.  The specified file willbe executed with the first argument set to interface name andsecond to "CONNECT" or "DISCONNECT" depending on the event.This can be used .TP\fB-P file\fRSet the location of the PIDfile..TP\fBcommand\fRRun a command.  The available commands arelisted in the next section..SH "COMMANDS".PPThe following commands are available:.TP\fBstatus\fRget current WPA/EAPOL/EAP status.TP\fBmib\fRget MIB variables (dot1x, dot11).TP\fBhelp\fRshow this usage help.TP\fBinterface [ifname]\fRshow interfaces/select interface.TP\fBlevel <debug level>\fRchange debug level.TP\fBlicense\fRshow full wpa_cli license.TP\fBlogoff\fRIEEE 802.1X EAPOL state machine logoff.TP\fBlogon\fRIEEE 802.1X EAPOL state machine logon.TP\fBset\fRset variables (shows list of variables when run without arguments).TP\fBpmksa\fRshow PMKSA cache.TP\fBreassociate\fRforce reassociation.TP\fBreconfigure\fRforce wpa_supplicant to re-read its configuration file.TP\fBpreauthenticate <BSSID>\fRforce preauthentication.TP\fBidentity <network id> <identity>\fRconfigure identity for an SSID.TP\fBpassword <network id> <password>\fRconfigure password for an SSID.TP\fBpin <network id> <pin>\fRconfigure pin for an SSID.TP\fBotp <network id> <password>\fRconfigure one-time-password for an SSID.TP\fBbssid *lt;network id> <BSSID>\fRset preferred BSSID for an SSID.TP\fBlist_networks\fRlist configured networks.TP\fBterminate\fRterminate \fBwpa_supplicant\fR.TP\fBquit\fRexit wpa_cli.SH "SEE ALSO".PP\fBwpa_supplicant\fR(8).SH "LEGAL".PPwpa_supplicant is copyright (c) 2003-2005,Jouni Malinen <jkmaline@cc.hut.fi> andcontributors.All Rights Reserved..PPThis program is dual-licensed under both the GPL version 2and BSD license. Either license may be used at your option.