README-P2P 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844
  1. wpa_supplicant and Wi-Fi P2P
  2. ============================
  3. This document describes how the Wi-Fi P2P implementation in
  4. wpa_supplicant can be configured and how an external component on the
  5. client (e.g., management GUI) is used to enable WPS enrollment and
  6. registrar registration.
  7. Introduction to Wi-Fi P2P
  8. -------------------------
  9. TODO
  10. More information about Wi-Fi P2P is available from Wi-Fi Alliance:
  11. http://www.wi-fi.org/Wi-Fi_Direct.php
  12. wpa_supplicant implementation
  13. -----------------------------
  14. TODO
  15. wpa_supplicant configuration
  16. ----------------------------
  17. Wi-Fi P2P is an optional component that needs to be enabled in the
  18. wpa_supplicant build configuration (.config). Here is an example
  19. configuration that includes Wi-Fi P2P support and Linux nl80211
  20. -based driver interface:
  21. CONFIG_DRIVER_NL80211=y
  22. CONFIG_CTRL_IFACE=y
  23. CONFIG_P2P=y
  24. CONFIG_AP=y
  25. CONFIG_WPS=y
  26. In run-time configuration file (wpa_supplicant.conf), some parameters
  27. for P2P may be set. In order to make the devices easier to recognize,
  28. device_name and device_type should be specified. For example,
  29. something like this should be included:
  30. ctrl_interface=/var/run/wpa_supplicant
  31. device_name=My P2P Device
  32. device_type=1-0050F204-1
  33. wpa_cli
  34. -------
  35. Actual Wi-Fi P2P operations are requested during runtime. These can be
  36. done for example using wpa_cli (which is described below) or a GUI
  37. like wpa_gui-qt4.
  38. wpa_cli starts in interactive mode if no command string is included on
  39. the command line. By default, it will select the first network interface
  40. that it can find (and that wpa_supplicant controls). If more than one
  41. interface is in use, it may be necessary to select one of the explicitly
  42. by adding -i argument on the command line (e.g., 'wpa_cli -i wlan1').
  43. Most of the P2P operations are done on the main interface (e.g., the
  44. interface that is automatically added when the driver is loaded, e.g.,
  45. wlan0). When using a separate virtual interface for group operations
  46. (e.g., wlan1), the control interface for that group interface may need
  47. to be used for some operations (mainly WPS activation in GO). This may
  48. change in the future so that all the needed operations could be done
  49. over the main control interface.
  50. Device Discovery
  51. p2p_find [timeout in seconds] [type=<social|progressive>] \
  52. [dev_id=<addr>] [dev_type=<device type>] \
  53. [delay=<search delay in ms>] [seek=<service name>] [freq=<MHz>]
  54. The default behavior is to run a single full scan in the beginning and
  55. then scan only social channels. type=social will scan only social
  56. channels, i.e., it skips the initial full scan. type=progressive is
  57. like the default behavior, but it will scan through all the channels
  58. progressively one channel at the time in the Search state rounds. This
  59. will help in finding new groups or groups missed during the initial
  60. full scan. When the type parameter is not included (i.e., full scan), the
  61. optional freq parameter can be used to override the first scan to use only
  62. the specified channel after which only social channels are scanned.
  63. The optional dev_id option can be used to specify a single P2P peer to
  64. search for. The optional delay parameter can be used to request an extra
  65. delay to be used between search iterations (e.g., to free up radio
  66. resources for concurrent operations).
  67. The optional dev_type option can be used to specify a single device type
  68. (primary or secondary) to search for, e.g.,
  69. "p2p_find dev_type=1-0050F204-1".
  70. With one or more seek arguments, the command sends Probe Request frames
  71. for a P2PS service. For example,
  72. p2p_find 5 dev_id=11:22:33:44:55:66 seek=alt.example.chat seek=alt.example.video
  73. Parameters description:
  74. Timeout - Optional ASCII base-10-encoded u16. If missing, request will not
  75. time out and must be canceled manually
  76. dev_id - Optional to request responses from a single known remote device
  77. Service Name - Mandatory UTF-8 string for ASP seeks
  78. Service name must match the remote service being advertised exactly
  79. (no prefix matching).
  80. Service name may be empty, in which case all ASP services will be
  81. returned, and may be filtered with p2p_serv_disc_req settings, and
  82. p2p_serv_asp_resp results.
  83. Multiple service names may be requested, but if it exceeds internal
  84. limit, it will automatically revert to requesting all ASP services.
  85. p2p_listen [timeout in seconds]
  86. Start Listen-only state (become discoverable without searching for
  87. other devices). Optional parameter can be used to specify the duration
  88. for the Listen operation in seconds. This command may not be of that
  89. much use during normal operations and is mainly designed for
  90. testing. It can also be used to keep the device discoverable without
  91. having to maintain a group.
  92. p2p_stop_find
  93. Stop ongoing P2P device discovery or other operation (connect, listen
  94. mode).
  95. p2p_flush
  96. Flush P2P peer table and state.
  97. Group Formation
  98. p2p_prov_disc <peer device address> <display|keypad|pbc> [join|auto]
  99. Send P2P provision discovery request to the specified peer. The
  100. parameters for this command are the P2P device address of the peer and
  101. the desired configuration method. For example, "p2p_prov_disc
  102. 02:01:02:03:04:05 display" would request the peer to display a PIN for
  103. us and "p2p_prov_disc 02:01:02:03:04:05 keypad" would request the peer
  104. to enter a PIN that we display.
  105. The optional "join" parameter can be used to indicate that this command
  106. is requesting an already running GO to prepare for a new client. This is
  107. mainly used with "display" to request it to display a PIN. The "auto"
  108. parameter can be used to request wpa_supplicant to automatically figure
  109. out whether the peer device is operating as a GO and if so, use
  110. join-a-group style PD instead of GO Negotiation style PD.
  111. p2p_connect <peer device address> <pbc|pin|PIN#|p2ps> [display|keypad|p2ps]
  112. [persistent|persistent=<network id>] [join|auth]
  113. [go_intent=<0..15>] [freq=<in MHz>] [ht40] [vht] [provdisc] [auto]
  114. Start P2P group formation with a discovered P2P peer. This includes
  115. optional group owner negotiation, group interface setup, provisioning,
  116. and establishing data connection.
  117. The <pbc|pin|PIN#> parameter specifies the WPS provisioning
  118. method. "pbc" string starts pushbutton method, "pin" string start PIN
  119. method using an automatically generated PIN (which will be returned as
  120. the command return code), PIN# means that a pre-selected PIN can be
  121. used (e.g., 12345670). [display|keypad] is used with PIN method
  122. to specify which PIN is used (display=dynamically generated random PIN
  123. from local display, keypad=PIN entered from peer display). "persistent"
  124. parameter can be used to request a persistent group to be formed. The
  125. "persistent=<network id>" alternative can be used to pre-populate
  126. SSID/passphrase configuration based on a previously used persistent
  127. group where this device was the GO. The previously used parameters will
  128. then be used if the local end becomes the GO in GO Negotiation (which
  129. can be forced with go_intent=15).
  130. "join" indicates that this is a command to join an existing group as a
  131. client. It skips the GO Negotiation part. This will send a Provision
  132. Discovery Request message to the target GO before associating for WPS
  133. provisioning.
  134. "auth" indicates that the WPS parameters are authorized for the peer
  135. device without actually starting GO Negotiation (i.e., the peer is
  136. expected to initiate GO Negotiation). This is mainly for testing
  137. purposes.
  138. "go_intent" can be used to override the default GO Intent for this GO
  139. Negotiation.
  140. "freq" can be used to set a forced operating channel (e.g., freq=2412
  141. to select 2.4 GHz channel 1).
  142. "provdisc" can be used to request a Provision Discovery exchange to be
  143. used prior to starting GO Negotiation as a workaround with some deployed
  144. P2P implementations that require this to allow the user to accept the
  145. connection.
  146. "auto" can be used to request wpa_supplicant to automatically figure
  147. out whether the peer device is operating as a GO and if so, use
  148. join-a-group operation rather than GO Negotiation.
  149. P2PS attribute changes to p2p_connect command:
  150. P2PS supports two WPS provisioning methods namely PIN method and P2PS default.
  151. The remaining paramters hold same role as in legacy P2P. In case of P2PS default
  152. config method "p2ps" keyword is added in p2p_connect command.
  153. For example:
  154. p2p_connect 02:0a:f5:85:11:00 12345670 p2ps persistent join
  155. (WPS Method = P2PS default)
  156. p2p_connect 02:0a:f5:85:11:00 45629034 keypad persistent
  157. (WPS Method = PIN)
  158. p2p_asp_provision <peer MAC address> <adv_id=peer adv id>
  159. <adv_mac=peer MAC address> [role=2|4|1] <session=session id>
  160. <session_mac=initiator mac address>
  161. [info='service info'] <method=Default|keypad|Display>
  162. This command starts provision discovery with the P2PS enabled peer device.
  163. For example,
  164. p2p_asp_provision 00:11:22:33:44:55 adv_id=4d6fc7 adv_mac=00:55:44:33:22:11 role=1 session=12ab34 session_mac=00:11:22:33:44:55 info='name=john' method=1000
  165. Parameter description:
  166. MAC address - Mandatory
  167. adv_id - Mandatory remote Advertising ID of service connection is being
  168. established for
  169. adv_mac - Mandatory MAC address that owns/registered the service
  170. role - Optional
  171. 2 (group client only) or 4 (group owner only)
  172. if not present (or 1) role is negotiated by the two peers.
  173. session - Mandatory Session ID of the first session to be established
  174. session_mac - Mandatory MAC address that owns/initiated the session
  175. method - Optional method to request for provisioning (1000 - P2PS Default,
  176. 100 - Keypad(PIN), 8 - Display(PIN))
  177. info - Optional UTF-8 string. Hint for service to indicate possible usage
  178. parameters - Escape single quote & backslash:
  179. with a backslash 0x27 == ' == \', and 0x5c == \ == \\
  180. p2p_asp_provision_resp <peer mac address> <adv_id= local adv id>
  181. <adv_mac=local MAC address> <role=1|2|4> <status=0>
  182. <session=session id> <session_mac=peer MAC address>
  183. This command sends a provision discovery response from responder side.
  184. For example,
  185. p2p_asp_provision_resp 00:55:44:33:22:11 adv_id=4d6fc7 adv_mac=00:55:44:33:22:11 role=1 status=0 session=12ab34 session_mac=00:11:22:33:44:55
  186. Parameters definition:
  187. MAC address - Mandatory
  188. adv_id - Mandatory local Advertising ID of service connection is being
  189. established for
  190. adv_mac - Mandatory MAC address that owns/registered the service
  191. role - Optional 2 (group client only) or 4 (group owner only)
  192. if not present (or 1) role is negotiated by the two peers.
  193. status - Mandatory Acceptance/Rejection code of Provisioning
  194. session - Mandatory Session ID of the first session to be established
  195. session_mac - Mandatory MAC address that owns/initiated the session
  196. p2p_group_add [persistent|persistent=<network id>] [freq=<freq in MHz>]
  197. [ht40] [vht]
  198. Set up a P2P group owner manually (i.e., without group owner
  199. negotiation with a specific peer). This is also known as autonomous
  200. GO. Optional persistent=<network id> can be used to specify restart of
  201. a persistent group. Optional freq=<freq in MHz> can be used to force
  202. the GO to be started on a specific frequency. Special freq=2 or freq=5
  203. options can be used to request the best 2.4 GHz or 5 GHz band channel
  204. to be selected automatically.
  205. p2p_reject <peer device address>
  206. Reject connection attempt from a peer (specified with a device
  207. address). This is a mechanism to reject a pending GO Negotiation with
  208. a peer and request to automatically block any further connection or
  209. discovery of the peer.
  210. p2p_group_remove <group interface>
  211. Terminate a P2P group. If a new virtual network interface was used for
  212. the group, it will also be removed. The network interface name of the
  213. group interface is used as a parameter for this command.
  214. p2p_cancel
  215. Cancel an ongoing P2P group formation and joining-a-group related
  216. operation. This operations unauthorizes the specific peer device (if any
  217. had been authorized to start group formation), stops P2P find (if in
  218. progress), stops pending operations for join-a-group, and removes the
  219. P2P group interface (if one was used) that is in the WPS provisioning
  220. step. If the WPS provisioning step has been completed, the group is not
  221. terminated.
  222. p2p_remove_client <peer's P2P Device Address|iface=<interface address>>
  223. This command can be used to remove the specified client from all groups
  224. (operating and persistent) from the local GO. Note that the peer device
  225. can rejoin the group if it is in possession of a valid key. See p2p_set
  226. per_sta_psk command below for more details on how the peer can be
  227. removed securely.
  228. Service Discovery
  229. p2p_service_add asp <auto accept> <adv id> <status 0/1> <Config Methods>
  230. <Service name> [Service Information] [Response Info]
  231. This command can be used to search for a P2PS service which includes
  232. Play, Send, Display, and Print service. The parameters for this command
  233. are "asp" to identify the command as P2PS one, auto accept value,
  234. advertisement id which uniquely identifies the service requests, state
  235. of the service whether the service is available or not, config methods
  236. which can be either P2PS method or PIN method, service name followed by
  237. two optional parameters service information, and response info.
  238. For example,
  239. p2p_service_add asp 1 4d6fc7 0 1108 alt.example.chat svc_info='name=john' rsp_info='enter PIN 1234'
  240. Parameters definition:
  241. asp - Mandatory for ASP service registration
  242. auto accept - Mandatory ASCII hex-encoded boolean (0 == no auto-accept,
  243. 1 == auto-accept ANY role, 2 == auto-accept CLIENT role,
  244. 4 == auto-accept GO role)
  245. Advertisement ID - Mandatory non-zero ASCII hex-encoded u32
  246. (Must be unique/not yet exist in svc db)
  247. State - Mandatory ASCII hex-encoded u8 (0 -- Svc not available,
  248. 1 -- Svc available, 2-0xff Application defined)
  249. Config Methods - Mandatory ASCII hex-encoded u16 (bitmask of WSC config
  250. methods)
  251. Service Name - Mandatory UTF-8 string
  252. Service Information - Optional UTF-8 string
  253. Escape single quote & backslash with a backslash:
  254. 0x27 == ' == \', and 0x5c == \ == \\
  255. Session response information - Optional (used only if auto accept is TRUE)
  256. UTF-8 string
  257. Escape single quote & backslash with a backslash:
  258. 0x27 == ' == \', and 0x5c == \ == \\
  259. p2p_service_rep asp <auto accept> <adv id> <status 0/1> <Config Methods>
  260. <Service name> [Service Information] [Response Info]
  261. This command can be used to replace the existing service request
  262. attributes from the initiator side. The replacement is only allowed if
  263. the advertisement id issued in the command matches with any one entry in
  264. the list of existing SD queries. If advertisement id doesn't match the
  265. command returns a failure.
  266. For example,
  267. p2p_service_rep asp 1 4d6fc7 1 1108 alt.example.chat svc_info='name=john' rsp_info='enter PIN 1234'
  268. Parameters definition:
  269. asp - Mandatory for ASP service registration
  270. auto accept - Mandatory ASCII hex-encoded boolean (1 == true, 0 == false)
  271. Advertisement ID - Mandatory non-zero ASCII hex-encoded u32
  272. (Must already exist in svc db)
  273. State - Mandatory ASCII hex-encoded u8 (can be used to indicate svc
  274. available or not available for instance)
  275. Config Methods - Mandatory ASCII hex-encoded u16 (bitmask of WSC config
  276. methods)
  277. Service Name - Mandatory UTF-8 string (Must match existing string in svc db)
  278. Service Information - Optional UTF-8 string
  279. Escape single quote & backslash with a backslash:
  280. 0x27 == ' == \', and 0x5c == \ == \\
  281. Session response information - Optional (used only if auto accept is TRUE)
  282. UTF-8 string
  283. Escape single quote & backslash with a backslash:
  284. 0x27 == ' == \', and 0x5c == \ == \\
  285. p2p_serv_disc_req
  286. Schedule a P2P service discovery request. The parameters for this
  287. command are the device address of the peer device (or 00:00:00:00:00:00
  288. for wildcard query that is sent to every discovered P2P peer that
  289. supports service discovery) and P2P Service Query TLV(s) as hexdump. For
  290. example,
  291. p2p_serv_disc_req 00:00:00:00:00:00 02000001
  292. schedules a request for listing all available services of all service
  293. discovery protocols and requests this to be sent to all discovered
  294. peers (note: this can result in long response frames). The pending
  295. requests are sent during device discovery (see p2p_find).
  296. There can be multiple pending peer device specific queries (each will be
  297. sent in sequence whenever the peer is found).
  298. This command returns an identifier for the pending query (e.g.,
  299. "1f77628") that can be used to cancel the request. Directed requests
  300. will be automatically removed when the specified peer has replied to
  301. it.
  302. Service Query TLV has following format:
  303. Length (2 octets, little endian) - length of following data
  304. Service Protocol Type (1 octet) - see the table below
  305. Service Transaction ID (1 octet) - nonzero identifier for the TLV
  306. Query Data (Length - 2 octets of data) - service protocol specific data
  307. Service Protocol Types:
  308. 0 = All service protocols
  309. 1 = Bonjour
  310. 2 = UPnP
  311. 3 = WS-Discovery
  312. 4 = Wi-Fi Display
  313. For UPnP, an alternative command format can be used to specify a
  314. single query TLV (i.e., a service discovery for a specific UPnP
  315. service):
  316. p2p_serv_disc_req 00:00:00:00:00:00 upnp <version hex> <ST: from M-SEARCH>
  317. For example:
  318. p2p_serv_disc_req 00:00:00:00:00:00 upnp 10 urn:schemas-upnp-org:device:InternetGatewayDevice:1
  319. Additional examples for queries:
  320. # list of all Bonjour services
  321. p2p_serv_disc_req 00:00:00:00:00:00 02000101
  322. # list of all UPnP services
  323. p2p_serv_disc_req 00:00:00:00:00:00 02000201
  324. # list of all WS-Discovery services
  325. p2p_serv_disc_req 00:00:00:00:00:00 02000301
  326. # list of all Bonjour and UPnP services
  327. p2p_serv_disc_req 00:00:00:00:00:00 0200010102000202
  328. # Apple File Sharing over TCP
  329. p2p_serv_disc_req 00:00:00:00:00:00 130001010b5f6166706f766572746370c00c000c01
  330. # Bonjour SSTH (supported service type hash)
  331. p2p_serv_disc_req 00:00:00:00:00:00 05000101000000
  332. # UPnP examples
  333. p2p_serv_disc_req 00:00:00:00:00:00 upnp 10 ssdp:all
  334. p2p_serv_disc_req 00:00:00:00:00:00 upnp 10 upnp:rootdevice
  335. p2p_serv_disc_req 00:00:00:00:00:00 upnp 10 urn:schemas-upnp-org:service:ContentDirectory:2
  336. p2p_serv_disc_req 00:00:00:00:00:00 upnp 10 uuid:6859dede-8574-59ab-9332-123456789012
  337. p2p_serv_disc_req 00:00:00:00:00:00 upnp 10 urn:schemas-upnp-org:device:InternetGatewayDevice:1
  338. # Wi-Fi Display examples
  339. # format: wifi-display <list of roles> <list of subelements>
  340. p2p_serv_disc_req 00:00:00:00:00:00 wifi-display [source] 2,3,4,5
  341. p2p_serv_disc_req 02:01:02:03:04:05 wifi-display [pri-sink] 3
  342. p2p_serv_disc_req 00:00:00:00:00:00 wifi-display [sec-source] 2
  343. p2p_serv_disc_req 00:00:00:00:00:00 wifi-display [source+sink] 2,3,4,5
  344. p2p_serv_disc_req 00:00:00:00:00:00 wifi-display [source][pri-sink] 2,3,4,5
  345. p2p_serv_disc_req <Unicast|Broadcast mac address> asp <Transaction ID>
  346. <Service Name> [Service Information]
  347. The command can be used for service discovery for P2PS enabled devices.
  348. For example: p2p_serv_disc_req 00:00:00:00:00:00 asp a1 alt.example 'john'
  349. Parameters definition:
  350. MAC address - Mandatory Existing
  351. asp - Mandatory for ASP queries
  352. Transaction ID - Mandatory non-zero ASCII hex-encoded u8 for GAS
  353. Service Name Prefix - Mandatory UTF-8 string.
  354. Will match from beginning of remote Service Name
  355. Service Information Substring - Optional UTF-8 string
  356. If Service Information Substring is not included, all services matching
  357. Service Name Prefix will be returned.
  358. If Service Information Substring is included, both the Substring and the
  359. Service Name Prefix must match for service to be returned.
  360. If remote service has no Service Information, all Substring searches
  361. will fail.
  362. p2p_serv_disc_cancel_req <query identifier>
  363. Cancel a pending P2P service discovery request. This command takes a
  364. single parameter: identifier for the pending query (the value returned
  365. by p2p_serv_disc_req, e.g., "p2p_serv_disc_cancel_req 1f77628".
  366. p2p_serv_disc_resp
  367. Reply to a service discovery query. This command takes following
  368. parameters: frequency in MHz, destination address, dialog token,
  369. response TLV(s). The first three parameters are copied from the
  370. request event. For example, "p2p_serv_disc_resp 2437 02:40:61:c2:f3:b7
  371. 1 0300000101". This command is used only if external program is used
  372. to process the request (see p2p_serv_disc_external).
  373. p2p_service_update
  374. Indicate that local services have changed. This is used to increment
  375. the P2P service indicator value so that peers know when previously
  376. cached information may have changed. This is only needed when external
  377. service discovery processing is enabled since the commands to
  378. pre-configure services for internal processing will increment the
  379. indicator automatically.
  380. p2p_serv_disc_external <0|1>
  381. Configure external processing of P2P service requests: 0 (default) =
  382. no external processing of requests (i.e., internal code will process
  383. each request based on pre-configured services), 1 = external
  384. processing of requests (external program is responsible for replying
  385. to service discovery requests with p2p_serv_disc_resp). Please note
  386. that there is quite strict limit on how quickly the response needs to
  387. be transmitted, so use of the internal processing is strongly
  388. recommended.
  389. p2p_service_add bonjour <query hexdump> <RDATA hexdump>
  390. Add a local Bonjour service for internal SD query processing.
  391. Examples:
  392. # AFP Over TCP (PTR)
  393. p2p_service_add bonjour 0b5f6166706f766572746370c00c000c01 074578616d706c65c027
  394. # AFP Over TCP (TXT) (RDATA=null)
  395. p2p_service_add bonjour 076578616d706c650b5f6166706f766572746370c00c001001 00
  396. # IP Printing over TCP (PTR) (RDATA=MyPrinter._ipp._tcp.local.)
  397. p2p_service_add bonjour 045f697070c00c000c01 094d795072696e746572c027
  398. # IP Printing over TCP (TXT) (RDATA=txtvers=1,pdl=application/postscript)
  399. p2p_service_add bonjour 096d797072696e746572045f697070c00c001001 09747874766572733d311a70646c3d6170706c69636174696f6e2f706f7374736372797074
  400. # Supported Service Type Hash (SSTH)
  401. p2p_service_add bonjour 000000 <32-byte bitfield as hexdump>
  402. (note: see P2P spec Annex E.4 for information on how to construct the bitfield)
  403. p2p_service_del bonjour <query hexdump>
  404. Remove a local Bonjour service from internal SD query processing.
  405. p2p_service_add upnp <version hex> <service>
  406. Add a local UPnP service for internal SD query processing.
  407. Examples:
  408. p2p_service_add upnp 10 uuid:6859dede-8574-59ab-9332-123456789012::upnp:rootdevice
  409. p2p_service_add upnp 10 uuid:5566d33e-9774-09ab-4822-333456785632::upnp:rootdevice
  410. p2p_service_add upnp 10 uuid:1122de4e-8574-59ab-9322-333456789044::urn:schemas-upnp-org:service:ContentDirectory:2
  411. p2p_service_add upnp 10 uuid:5566d33e-9774-09ab-4822-333456785632::urn:schemas-upnp-org:service:ContentDirectory:2
  412. p2p_service_add upnp 10 uuid:6859dede-8574-59ab-9332-123456789012::urn:schemas-upnp-org:device:InternetGatewayDevice:1
  413. p2p_service_del upnp <version hex> <service>
  414. Remove a local UPnP service from internal SD query processing.
  415. p2p_service_del asp <adv id>
  416. Removes the local asp service from internal SD query list.
  417. For example: p2p_service_del asp 4d6fc7
  418. p2p_service_flush
  419. Remove all local services from internal SD query processing.
  420. Invitation
  421. p2p_invite [persistent=<network id>|group=<group ifname>] [peer=address]
  422. [go_dev_addr=address] [freq=<freq in MHz>] [ht40] [vht]
  423. [pref=<MHz>]
  424. Invite a peer to join a group (e.g., group=wlan1) or to reinvoke a
  425. persistent group (e.g., persistent=4). If the peer device is the GO of
  426. the persistent group, the peer parameter is not needed. Otherwise it is
  427. used to specify which device to invite. go_dev_addr parameter can be
  428. used to override the GO device address for Invitation Request should
  429. it be not known for some reason (this should not be needed in most
  430. cases). When reinvoking a persistent group, the GO device can specify
  431. the frequency for the group with the freq parameter. When reinvoking a
  432. persistent group, the P2P client device can use freq parameter to force
  433. a specific operating channel (or invitation failure if GO rejects that)
  434. or pref parameter to request a specific channel (while allowing GO to
  435. select to use another channel, if needed).
  436. Group Operations
  437. (These are used on the group interface.)
  438. wps_pin <any|address> <PIN>
  439. Start WPS PIN method. This allows a single WPS Enrollee to connect to
  440. the AP/GO. This is used on the GO when a P2P client joins an existing
  441. group. The second parameter is the address of the Enrollee or a string
  442. "any" to allow any station to use the entered PIN (which will restrict
  443. the PIN for one-time-use). PIN is the Enrollee PIN read either from a
  444. label or display on the P2P Client/WPS Enrollee.
  445. wps_pbc
  446. Start WPS PBC method (i.e., push the button). This allows a single WPS
  447. Enrollee to connect to the AP/GO. This is used on the GO when a P2P
  448. client joins an existing group.
  449. p2p_get_passphrase
  450. Get the passphrase for a group (only available when acting as a GO).
  451. p2p_presence_req [<duration> <interval>] [<duration> <interval>]
  452. Send a P2P Presence Request to the GO (this is only available when
  453. acting as a P2P client). If no duration/interval pairs are given, the
  454. request indicates that this client has no special needs for GO
  455. presence. The first parameter pair gives the preferred duration and
  456. interval values in microseconds. If the second pair is included, that
  457. indicates which value would be acceptable. This command returns OK
  458. immediately and the response from the GO is indicated in a
  459. P2P-PRESENCE-RESPONSE event message.
  460. Parameters
  461. p2p_ext_listen [<period> <interval>]
  462. Configure Extended Listen Timing. If the parameters are omitted, this
  463. feature is disabled. If the parameters are included, Listen State will
  464. be entered every interval msec for at least period msec. Both values
  465. have acceptable range of 1-65535 (with interval obviously having to be
  466. larger than or equal to duration). If the P2P module is not idle at
  467. the time the Extended Listen Timing timeout occurs, the Listen State
  468. operation will be skipped.
  469. The configured values will also be advertised to other P2P Devices. The
  470. received values are available in the p2p_peer command output:
  471. ext_listen_period=100 ext_listen_interval=5000
  472. p2p_set <field> <value>
  473. Change dynamic P2P parameters
  474. p2p_set discoverability <0/1>
  475. Disable/enable advertisement of client discoverability. This is
  476. enabled by default and this parameter is mainly used to allow testing
  477. of device discoverability.
  478. p2p_set managed <0/1>
  479. Disable/enable managed P2P Device operations. This is disabled by
  480. default.
  481. p2p_set listen_channel <1/6/11>
  482. Set P2P Listen channel. This is mainly meant for testing purposes and
  483. changing the Listen channel during normal operations can result in
  484. protocol failures.
  485. p2p_set ssid_postfix <postfix>
  486. Set postfix string to be added to the automatically generated P2P SSID
  487. (DIRECT-<two random characters>). For example, postfix of "-testing"
  488. could result in the SSID becoming DIRECT-ab-testing.
  489. p2p_set per_sta_psk <0/1>
  490. Disabled(default)/enables use of per-client PSK in the P2P groups. This
  491. can be used to request GO to assign a unique PSK for each client during
  492. WPS provisioning. When enabled, this allow clients to be removed from
  493. the group securily with p2p_remove_client command since that client's
  494. PSK is removed at the same time to prevent it from connecting back using
  495. the old PSK. When per-client PSK is not used, the client can still be
  496. disconnected, but it will be able to re-join the group since the PSK it
  497. learned previously is still valid. It should be noted that the default
  498. passphrase on the GO that is normally used to allow legacy stations to
  499. connect through manual configuration does not change here, so if that is
  500. shared, devices with knowledge of that passphrase can still connect.
  501. set <field> <value>
  502. Set global configuration parameters which may also affect P2P
  503. operations. The format on these parameters is same as is used in
  504. wpa_supplicant.conf. Only the parameters listen here should be
  505. changed. Modifying other parameters may result in incorrect behavior
  506. since not all existing users of the parameters are updated.
  507. set uuid <UUID>
  508. Set WPS UUID (by default, this is generated based on the MAC address).
  509. set device_name <device name>
  510. Set WPS Device Name (also included in some P2P messages).
  511. set manufacturer <manufacturer>
  512. Set WPS Manufacturer.
  513. set model_name <model name>
  514. Set WPS Model Name.
  515. set model_number <model number>
  516. Set WPS Model Number.
  517. set serial_number <serial number>
  518. Set WPS Serial Number.
  519. set device_type <device type>
  520. Set WPS Device Type.
  521. set os_version <OS version>
  522. Set WPS OS Version.
  523. set config_methods <config methods>
  524. Set WPS Configuration Methods.
  525. set sec_device_type <device type>
  526. Add a new Secondary Device Type.
  527. set p2p_go_intent <GO intent>
  528. Set the default P2P GO Intent. Note: This value can be overridden in
  529. p2p_connect command and as such, there should be no need to change the
  530. default value here during normal operations.
  531. set p2p_ssid_postfix <P2P SSID postfix>
  532. Set P2P SSID postfix.
  533. set persistent_reconnect <0/1>
  534. Disable/enabled persistent reconnect for reinvocation of persistent
  535. groups. If enabled, invitations to reinvoke a persistent group will be
  536. accepted without separate authorization (e.g., user interaction).
  537. set country <two character country code>
  538. Set country code (this is included in some P2P messages).
  539. set p2p_search_delay <delay>
  540. Set p2p_search_delay which adds extra delay in milliseconds between
  541. concurrent search iterations to make p2p_find friendlier to concurrent
  542. operations by avoiding it from taking 100% of radio resources. The
  543. default value is 500 ms.
  544. Status
  545. p2p_peers [discovered]
  546. List P2P Device Addresses of all the P2P peers we know. The optional
  547. "discovered" parameter filters out the peers that we have not fully
  548. discovered, i.e., which we have only seen in a received Probe Request
  549. frame.
  550. p2p_peer <P2P Device Address>
  551. Fetch information about a known P2P peer.
  552. Group Status
  553. (These are used on the group interface.)
  554. status
  555. Show status information (connection state, role, use encryption
  556. parameters, IP address, etc.).
  557. sta
  558. Show information about an associated station (when acting in AP/GO role).
  559. all_sta
  560. Lists the currently associated stations.
  561. Configuration data
  562. list_networks
  563. Lists the configured networks, including stored information for
  564. persistent groups. The identifier in this list is used with
  565. p2p_group_add and p2p_invite to indicate which persistent group is to
  566. be reinvoked.
  567. remove_network <network id>
  568. Remove a network entry from configuration.
  569. P2PS Events/Responses:
  570. P2PS-PROV-START: This events gets triggered when provisioning is issued for
  571. either seeker or advertiser.
  572. For example,
  573. P2PS-PROV-START 00:55:44:33:22:11 adv_id=111 adv_mac=00:55:44:33:22:11 conncap=1 session=1234567 session_mac=00:11:22:33:44:55 info='xxxx'
  574. Parameters definition:
  575. MAC address - always
  576. adv_id - always ASCII hex-encoded u32
  577. adv_mac - always MAC address that owns/registered the service
  578. conncap - always mask of 0x01 (new), 0x02 (group client), 0x04 (group owner)
  579. bits
  580. session - always Session ID of the first session to be established
  581. session_mac - always MAC address that owns/initiated the session
  582. info - if available, UTF-8 string
  583. Escaped single quote & backslash with a backslash:
  584. \' == 0x27 == ', and \\ == 0x5c == \
  585. P2PS-PROV-DONE: When provisioning is completed then this event gets triggered.
  586. For example,
  587. P2PS-PROV-DONE 00:11:22:33:44:55 status=0 adv_id=111 adv_mac=00:55:44:33:22:11 conncap=1 session=1234567 session_mac=00:11:22:33:44:55 [dev_passwd_id=8 | go=p2p-wlan0-0 | join=11:22:33:44:55:66 | persist=0]
  588. Parameters definition:
  589. MAC address - always main device address of peer. May be different from MAC
  590. ultimately connected to.
  591. status - always ascii hex-encoded u8 (0 == success, 12 == deferred success)
  592. adv_id - always ascii hex-encoded u32
  593. adv_mac - always MAC address that owns/registered the service
  594. conncap - always One of: 1 (new), 2 (group client), 4 (group owner) bits
  595. session - always Session ID of the first session to be established
  596. session_mac - always MAC address that owns/initiated the session
  597. dev_passwd_id - only if conncap value == 1 (New GO negotiation)
  598. 8 - "p2ps" password must be passed in p2p_connect command
  599. 1 - "display" password must be passed in p2p_connect command
  600. 5 - "keypad" password must be passed in p2p_connect command
  601. join only - if conncap value == 2 (Client Only). Display password and "join"
  602. must be passed in p2p_connect and address must be the MAC specified
  603. go only - if conncap value == 4 (GO Only). Interface name must be set with a
  604. password
  605. persist - only if previous persistent group existed between peers and shall
  606. be re-used. Group is restarted by sending "p2p_group_add persistent=0"
  607. where value is taken from P2P-PROV-DONE
  608. Extended Events/Response
  609. P2P-DEVICE-FOUND 00:11:22:33:44:55 p2p_dev_addr=00:11:22:33:44:55 pri_dev_type=0-00000000-0 name='' config_methods=0x108 dev_capab=0x21 group_capab=0x0 adv_id=111 asp_svc=alt.example.chat
  610. Parameters definition:
  611. adv_id - if ASP ASCII hex-encoded u32. If it is reporting the
  612. "wildcard service", this value will be 0
  613. asp_svc - if ASP this is the service string. If it is reporting the
  614. "wildcard service", this value will be org.wi-fi.wfds
  615. wpa_cli action script
  616. ---------------------
  617. See examples/p2p-action.sh
  618. TODO: describe DHCP/DNS setup
  619. TODO: cross-connection