logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

wpa_cli.8 (6646B)


  1. .\" This manpage has been automatically generated by docbook2man
  2. .\" from a DocBook document. This tool can be found at:
  3. .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
  4. .\" Please send any bug reports, improvements, comments, patches,
  5. .\" etc. to Steve Cheng <steve@ggi-project.org>.
  6. .TH "WPA_CLI" "8" "07 August 2019" "" ""
  7. .SH NAME
  8. wpa_cli \- WPA command line client
  9. .SH SYNOPSIS
  10. \fBwpa_cli\fR [ \fB-p \fIpath to ctrl sockets\fB\fR ] [ \fB-g \fIpath to global ctrl_interface socket\fB\fR ] [ \fB-i \fIifname\fB\fR ] [ \fB-hvB\fR ] [ \fB-a \fIaction file\fB\fR ] [ \fB-P \fIpid file\fB\fR ] [ \fB-G \fIping interval\fB\fR ] [ \fB\fIcommand ...\fB\fR ]
  11. .SH "OVERVIEW"
  12. .PP
  13. wpa_cli is a text-based frontend program for interacting
  14. with wpa_supplicant. It is used to query current status, change
  15. configuration, trigger events, and request interactive user
  16. input.
  17. .PP
  18. wpa_cli can show the current authentication status, selected
  19. security mode, dot11 and dot1x MIBs, etc. In addition, it can
  20. configure some variables like EAPOL state machine parameters and
  21. trigger events like reassociation and IEEE 802.1X
  22. logoff/logon. wpa_cli provides a user interface to request
  23. authentication information, like username and password, if these
  24. are not included in the configuration. This can be used to
  25. implement, e.g., one-time-passwords or generic token card
  26. authentication where the authentication is based on a
  27. challenge-response that uses an external device for generating the
  28. response.
  29. .PP
  30. The control interface of wpa_supplicant can be configured to
  31. allow non-root user access (ctrl_interface GROUP= parameter in the
  32. configuration file). This makes it possible to run wpa_cli with a
  33. normal user account.
  34. .PP
  35. wpa_cli supports two modes: interactive and command
  36. line. Both modes share the same command set and the main
  37. difference is in interactive mode providing access to unsolicited
  38. messages (event messages, username/password requests).
  39. .PP
  40. Interactive mode is started when wpa_cli is executed without
  41. including the command as a command line parameter. Commands are
  42. then entered on the wpa_cli prompt. In command line mode, the same
  43. commands are entered as command line arguments for wpa_cli.
  44. .SH "INTERACTIVE AUTHENTICATION PARAMETERS REQUEST"
  45. .PP
  46. When wpa_supplicant need authentication parameters, like
  47. username and password, which are not present in the configuration
  48. file, it sends a request message to all attached frontend programs,
  49. e.g., wpa_cli in interactive mode. wpa_cli shows these requests
  50. with "CTRL-REQ-<type>-<id>:<text>"
  51. prefix. <type> is IDENTITY, PASSWORD, or OTP
  52. (one-time-password). <id> is a unique identifier for the
  53. current network. <text> is description of the request. In
  54. case of OTP request, it includes the challenge from the
  55. authentication server.
  56. .PP
  57. The reply to these requests can be given with
  58. \fBidentity\fR, \fBpassword\fR, and
  59. \fBotp\fR commands. <id> needs to be copied from
  60. the matching request. \fBpassword\fR and
  61. \fBotp\fR commands can be used regardless of whether
  62. the request was for PASSWORD or OTP. The main difference between these
  63. two commands is that values given with \fBpassword\fR are
  64. remembered as long as wpa_supplicant is running whereas values given
  65. with \fBotp\fR are used only once and then forgotten,
  66. i.e., wpa_supplicant will ask frontend for a new value for every use.
  67. This can be used to implement one-time-password lists and generic token
  68. card -based authentication.
  69. .PP
  70. Example request for password and a matching reply:
  71. .sp
  72. .RS
  73. .nf
  74. CTRL-REQ-PASSWORD-1:Password needed for SSID foobar
  75. > password 1 mysecretpassword
  76. .fi
  77. .RE
  78. .PP
  79. Example request for generic token card challenge-response:
  80. .sp
  81. .RS
  82. .nf
  83. CTRL-REQ-OTP-2:Challenge 1235663 needed for SSID foobar
  84. > otp 2 9876
  85. .fi
  86. .RE
  87. .SH "COMMAND ARGUMENTS"
  88. .TP
  89. \fB-p path\fR
  90. Change the path where control sockets should
  91. be found.
  92. .TP
  93. \fB-g control socket path\fR
  94. Connect to the global control socket at the
  95. indicated path rather than an interface-specific control
  96. socket.
  97. .TP
  98. \fB-i ifname\fR
  99. Specify the interface that is being
  100. configured. By default, choose the first interface found with
  101. a control socket in the socket path.
  102. .TP
  103. \fB-h\fR
  104. Help. Show a usage message.
  105. .TP
  106. \fB-v\fR
  107. Show version information.
  108. .TP
  109. \fB-B\fR
  110. Run as a daemon in the background.
  111. .TP
  112. \fB-a file\fR
  113. Run in daemon mode executing the action file
  114. based on events from wpa_supplicant. The specified file will
  115. be executed with the first argument set to interface name and
  116. second to "CONNECTED" or "DISCONNECTED" depending on the event.
  117. This can be used to execute networking tools required to configure
  118. the interface.
  119. Additionally, three environmental variables are available to
  120. the file: WPA_CTRL_DIR, WPA_ID, and WPA_ID_STR. WPA_CTRL_DIR
  121. contains the absolute path to the ctrl_interface socket. WPA_ID
  122. contains the unique network_id identifier assigned to the active
  123. network, and WPA_ID_STR contains the content of the id_str option.
  124. .TP
  125. \fB-P file\fR
  126. Set the location of the PID
  127. file.
  128. .TP
  129. \fB-G ping interval\fR
  130. Set the interval (in seconds) at which
  131. wpa_cli pings the supplicant.
  132. .TP
  133. \fBcommand\fR
  134. Run a command. The available commands are
  135. listed in the next section.
  136. .SH "COMMANDS"
  137. .PP
  138. The following commands are available:
  139. .TP
  140. \fBstatus\fR
  141. get current WPA/EAPOL/EAP status
  142. .TP
  143. \fBmib\fR
  144. get MIB variables (dot1x, dot11)
  145. .TP
  146. \fBhelp\fR
  147. show this usage help
  148. .TP
  149. \fBinterface [ifname]\fR
  150. show interfaces/select interface
  151. .TP
  152. \fBlevel <debug level>\fR
  153. change debug level
  154. .TP
  155. \fBlicense\fR
  156. show full wpa_cli license
  157. .TP
  158. \fBlogoff\fR
  159. IEEE 802.1X EAPOL state machine logoff
  160. .TP
  161. \fBlogon\fR
  162. IEEE 802.1X EAPOL state machine logon
  163. .TP
  164. \fBset\fR
  165. set variables (shows list of variables when run without arguments)
  166. .TP
  167. \fBpmksa\fR
  168. show PMKSA cache
  169. .TP
  170. \fBreassociate\fR
  171. force reassociation
  172. .TP
  173. \fBreconfigure\fR
  174. force wpa_supplicant to re-read its configuration file
  175. .TP
  176. \fBpreauthenticate <BSSID>\fR
  177. force preauthentication
  178. .TP
  179. \fBidentity <network id> <identity>\fR
  180. configure identity for an SSID
  181. .TP
  182. \fBpassword <network id> <password>\fR
  183. configure password for an SSID
  184. .TP
  185. \fBpin <network id> <pin>\fR
  186. configure pin for an SSID
  187. .TP
  188. \fBotp <network id> <password>\fR
  189. configure one-time-password for an SSID
  190. .TP
  191. \fBbssid <network id> <BSSID>\fR
  192. set preferred BSSID for an SSID
  193. .TP
  194. \fBlist_networks\fR
  195. list configured networks
  196. .TP
  197. \fBterminate\fR
  198. terminate \fBwpa_supplicant\fR
  199. .TP
  200. \fBquit\fR
  201. exit wpa_cli
  202. .SH "SEE ALSO"
  203. .PP
  204. \fBwpa_supplicant\fR(8)
  205. .SH "LEGAL"
  206. .PP
  207. wpa_supplicant is copyright (c) 2003-2022,
  208. Jouni Malinen <j@w1.fi> and
  209. contributors.
  210. All Rights Reserved.
  211. .PP
  212. This program is licensed under the BSD license (the one with
  213. advertisement clause removed).