xref: /freebsd/contrib/wpa/wpa_supplicant/dbus/dbus_new.h (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
1 /*
2  * WPA Supplicant / dbus-based control interface
3  * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
4  * Copyright (c) 2009-2010, Witold Sowa <witold.sowa@gmail.com>
5  *
6  * This software may be distributed under the terms of the BSD license.
7  * See README for more details.
8  */
9 
10 #ifndef CTRL_IFACE_DBUS_NEW_H
11 #define CTRL_IFACE_DBUS_NEW_H
12 
13 #include "common/defs.h"
14 #include "p2p/p2p.h"
15 
16 struct wpa_global;
17 struct wpa_supplicant;
18 struct wpa_ssid;
19 struct wps_event_m2d;
20 struct wps_event_fail;
21 struct wps_credential;
22 
23 enum wpas_dbus_prop {
24 	WPAS_DBUS_PROP_AP_SCAN,
25 	WPAS_DBUS_PROP_SCANNING,
26 	WPAS_DBUS_PROP_STATE,
27 	WPAS_DBUS_PROP_CURRENT_BSS,
28 	WPAS_DBUS_PROP_CURRENT_NETWORK,
29 	WPAS_DBUS_PROP_CURRENT_AUTH_MODE,
30 	WPAS_DBUS_PROP_BSSS,
31 	WPAS_DBUS_PROP_DISCONNECT_REASON,
32 };
33 
34 enum wpas_dbus_bss_prop {
35 	WPAS_DBUS_BSS_PROP_SIGNAL,
36 	WPAS_DBUS_BSS_PROP_FREQ,
37 	WPAS_DBUS_BSS_PROP_MODE,
38 	WPAS_DBUS_BSS_PROP_PRIVACY,
39 	WPAS_DBUS_BSS_PROP_RATES,
40 	WPAS_DBUS_BSS_PROP_WPA,
41 	WPAS_DBUS_BSS_PROP_RSN,
42 	WPAS_DBUS_BSS_PROP_WPS,
43 	WPAS_DBUS_BSS_PROP_IES,
44 	WPAS_DBUS_BSS_PROP_AGE,
45 };
46 
47 #define WPAS_DBUS_OBJECT_PATH_MAX 150
48 
49 #define WPAS_DBUS_NEW_SERVICE		"fi.w1.wpa_supplicant1"
50 #define WPAS_DBUS_NEW_PATH		"/fi/w1/wpa_supplicant1"
51 #define WPAS_DBUS_NEW_INTERFACE		"fi.w1.wpa_supplicant1"
52 
53 #define WPAS_DBUS_NEW_PATH_INTERFACES	WPAS_DBUS_NEW_PATH "/Interfaces"
54 #define WPAS_DBUS_NEW_IFACE_INTERFACE	WPAS_DBUS_NEW_INTERFACE ".Interface"
55 #define WPAS_DBUS_NEW_IFACE_WPS WPAS_DBUS_NEW_IFACE_INTERFACE ".WPS"
56 
57 #define WPAS_DBUS_NEW_NETWORKS_PART "Networks"
58 #define WPAS_DBUS_NEW_IFACE_NETWORK WPAS_DBUS_NEW_INTERFACE ".Network"
59 
60 #define WPAS_DBUS_NEW_BSSIDS_PART "BSSs"
61 #define WPAS_DBUS_NEW_IFACE_BSS	WPAS_DBUS_NEW_INTERFACE ".BSS"
62 
63 #define WPAS_DBUS_NEW_IFACE_P2PDEVICE	\
64 		WPAS_DBUS_NEW_IFACE_INTERFACE ".P2PDevice"
65 
66 /*
67  * Groups correspond to P2P groups where this device is a GO (owner)
68  */
69 #define WPAS_DBUS_NEW_P2P_GROUPS_PART	"Groups"
70 #define	WPAS_DBUS_NEW_IFACE_P2P_GROUP WPAS_DBUS_NEW_INTERFACE ".Group"
71 
72 /*
73  * Different dbus object for persistent groups so they do not get confused
74  * with regular (configured) network objects.
75  */
76 #define WPAS_DBUS_NEW_PERSISTENT_GROUPS_PART "PersistentGroups"
77 #define WPAS_DBUS_NEW_IFACE_PERSISTENT_GROUP \
78 	WPAS_DBUS_NEW_INTERFACE ".PersistentGroup"
79 
80 #define WPAS_DBUS_NEW_P2P_PEERS_PART	"Peers"
81 #define	WPAS_DBUS_NEW_IFACE_P2P_PEER WPAS_DBUS_NEW_INTERFACE ".Peer"
82 
83 /* Top-level Errors */
84 #define WPAS_DBUS_ERROR_UNKNOWN_ERROR \
85 	WPAS_DBUS_NEW_INTERFACE ".UnknownError"
86 #define WPAS_DBUS_ERROR_INVALID_ARGS \
87 	WPAS_DBUS_NEW_INTERFACE ".InvalidArgs"
88 
89 #define WPAS_DBUS_ERROR_IFACE_EXISTS \
90 	WPAS_DBUS_NEW_INTERFACE ".InterfaceExists"
91 #define WPAS_DBUS_ERROR_IFACE_DISABLED            \
92 	WPAS_DBUS_NEW_INTERFACE ".InterfaceDisabled"
93 #define WPAS_DBUS_ERROR_IFACE_UNKNOWN \
94 	WPAS_DBUS_NEW_INTERFACE ".InterfaceUnknown"
95 
96 #define WPAS_DBUS_ERROR_NOT_CONNECTED \
97 	WPAS_DBUS_NEW_INTERFACE ".NotConnected"
98 #define WPAS_DBUS_ERROR_NETWORK_UNKNOWN \
99 	WPAS_DBUS_NEW_INTERFACE ".NetworkUnknown"
100 
101 #define WPAS_DBUS_ERROR_CONNECT_CHANNEL_UNAVAILABLE \
102 	WPAS_DBUS_NEW_INTERFACE ".ConnectChannelUnavailable"
103 #define WPAS_DBUS_ERROR_CONNECT_CHANNEL_UNSUPPORTED \
104 	WPAS_DBUS_NEW_INTERFACE ".ConnectChannelUnsupported"
105 #define WPAS_DBUS_ERROR_CONNECT_UNSPECIFIED_ERROR \
106 	WPAS_DBUS_NEW_INTERFACE ".ConnectUnspecifiedError"
107 
108 #define WPAS_DBUS_ERROR_BLOB_EXISTS \
109 	WPAS_DBUS_NEW_INTERFACE ".BlobExists"
110 #define WPAS_DBUS_ERROR_BLOB_UNKNOWN \
111 	WPAS_DBUS_NEW_INTERFACE ".BlobUnknown"
112 
113 #define WPAS_DBUS_ERROR_SUBSCRIPTION_IN_USE \
114 	WPAS_DBUS_NEW_INTERFACE ".SubscriptionInUse"
115 #define WPAS_DBUS_ERROR_NO_SUBSCRIPTION \
116 	WPAS_DBUS_NEW_INTERFACE ".NoSubscription"
117 #define WPAS_DBUS_ERROR_SUBSCRIPTION_EPERM \
118 	WPAS_DBUS_NEW_INTERFACE ".SubscriptionNotYou"
119 
120 /* Interface-level errors */
121 #define WPAS_DBUS_ERROR_IFACE_SCAN_ERROR \
122 	WPAS_DBUS_NEW_IFACE_INTERFACE ".ScanError"
123 
124 void wpas_dbus_subscribe_noc(struct wpas_dbus_priv *priv);
125 void wpas_dbus_unsubscribe_noc(struct wpas_dbus_priv *priv);
126 
127 
128 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
129 
130 int wpas_dbus_ctrl_iface_init(struct wpas_dbus_priv *priv);
131 void wpas_dbus_ctrl_iface_deinit(struct wpas_dbus_priv *iface);
132 
133 int wpas_dbus_register_interface(struct wpa_supplicant *wpa_s);
134 int wpas_dbus_unregister_interface(struct wpa_supplicant *wpa_s);
135 void wpas_dbus_signal_prop_changed(struct wpa_supplicant *wpa_s,
136 				   enum wpas_dbus_prop property);
137 void wpas_dbus_bss_signal_prop_changed(struct wpa_supplicant *wpa_s,
138 				       enum wpas_dbus_bss_prop property,
139 				       unsigned int id);
140 void wpas_dbus_signal_network_enabled_changed(struct wpa_supplicant *wpa_s,
141 					      struct wpa_ssid *ssid);
142 void wpas_dbus_signal_network_selected(struct wpa_supplicant *wpa_s, int id);
143 void wpas_dbus_signal_network_request(struct wpa_supplicant *wpa_s,
144 				      struct wpa_ssid *ssid,
145 				      enum wpa_ctrl_req_type rtype,
146 				      const char *default_text);
147 void wpas_dbus_signal_scan_done(struct wpa_supplicant *wpa_s, int success);
148 void wpas_dbus_signal_wps_cred(struct wpa_supplicant *wpa_s,
149 			       const struct wps_credential *cred);
150 void wpas_dbus_signal_wps_event_m2d(struct wpa_supplicant *wpa_s,
151 				    struct wps_event_m2d *m2d);
152 void wpas_dbus_signal_wps_event_fail(struct wpa_supplicant *wpa_s,
153 				     struct wps_event_fail *fail);
154 void wpas_dbus_signal_wps_event_success(struct wpa_supplicant *wpa_s);
155 int wpas_dbus_register_network(struct wpa_supplicant *wpa_s,
156 			       struct wpa_ssid *ssid);
157 int wpas_dbus_unregister_network(struct wpa_supplicant *wpa_s, int nid);
158 int wpas_dbus_unregister_bss(struct wpa_supplicant *wpa_s,
159 			     u8 bssid[ETH_ALEN], unsigned int id);
160 int wpas_dbus_register_bss(struct wpa_supplicant *wpa_s,
161 			   u8 bssid[ETH_ALEN], unsigned int id);
162 void wpas_dbus_signal_blob_added(struct wpa_supplicant *wpa_s,
163 				 const char *name);
164 void wpas_dbus_signal_blob_removed(struct wpa_supplicant *wpa_s,
165 				   const char *name);
166 void wpas_dbus_signal_debug_level_changed(struct wpa_global *global);
167 void wpas_dbus_signal_debug_timestamp_changed(struct wpa_global *global);
168 void wpas_dbus_signal_debug_show_keys_changed(struct wpa_global *global);
169 
170 int wpas_dbus_register_peer(struct wpa_supplicant *wpa_s, const u8 *dev_addr);
171 void wpas_dbus_signal_peer_device_found(struct wpa_supplicant *wpa_s,
172 					   const u8 *dev_addr);
173 int wpas_dbus_unregister_peer(struct wpa_supplicant *wpa_s,
174 				  const u8 *dev_addr);
175 void wpas_dbus_signal_peer_device_lost(struct wpa_supplicant *wpa_s,
176 					   const u8 *dev_addr);
177 void wpas_dbus_signal_peer_groups_changed(struct wpa_supplicant *wpa_s,
178 					  const u8 *dev_addr);
179 void wpas_dbus_signal_p2p_group_removed(struct wpa_supplicant *wpa_s,
180 					const char *role);
181 void wpas_dbus_signal_p2p_provision_discovery(struct wpa_supplicant *wpa_s,
182 					      const u8 *dev_addr, int request,
183 					      enum p2p_prov_disc_status status,
184 					      u16 config_methods,
185 					      unsigned int generated_pin);
186 void wpas_dbus_signal_p2p_go_neg_req(struct wpa_supplicant *wpa_s,
187 				     const u8 *src, u16 dev_passwd_id);
188 void wpas_dbus_signal_p2p_group_started(struct wpa_supplicant *wpa_s,
189 					const struct wpa_ssid *ssid,
190 					int client, int network_id);
191 void wpas_dbus_register_p2p_group(struct wpa_supplicant *wpa_s,
192 				  struct wpa_ssid *ssid);
193 void wpas_dbus_signal_p2p_go_neg_resp(struct wpa_supplicant *wpa_s,
194 				      struct p2p_go_neg_results *res);
195 void wpas_dbus_unregister_p2p_group(struct wpa_supplicant *wpa_s,
196 				    const struct wpa_ssid *ssid);
197 int wpas_dbus_register_persistent_group(struct wpa_supplicant *wpa_s,
198 					struct wpa_ssid *ssid);
199 int wpas_dbus_unregister_persistent_group(struct wpa_supplicant *wpa_s,
200 					  int nid);
201 void wpas_dbus_signal_p2p_invitation_result(struct wpa_supplicant *wpa_s,
202 					    int status, const u8 *bssid);
203 void wpas_dbus_signal_p2p_peer_disconnected(struct wpa_supplicant *wpa_s,
204 					    const u8 *member);
205 void wpas_dbus_signal_p2p_sd_request(struct wpa_supplicant *wpa_s,
206 				     int freq, const u8 *sa, u8 dialog_token,
207 				     u16 update_indic, const u8 *tlvs,
208 				     size_t tlvs_len);
209 void wpas_dbus_signal_p2p_sd_response(struct wpa_supplicant *wpa_s,
210 				      const u8 *sa, u16 update_indic,
211 				      const u8 *tlvs, size_t tlvs_len);
212 void wpas_dbus_signal_p2p_peer_joined(struct wpa_supplicant *wpa_s,
213 				const u8 *member);
214 void wpas_dbus_signal_p2p_wps_failed(struct wpa_supplicant *wpa_s,
215 				     struct wps_event_fail *fail);
216 void wpas_dbus_signal_certification(struct wpa_supplicant *wpa_s,
217 				    int depth, const char *subject,
218 				    const char *altsubject[],
219 				    int num_altsubject,
220 				    const char *cert_hash,
221 				    const struct wpabuf *cert);
222 void wpas_dbus_signal_preq(struct wpa_supplicant *wpa_s,
223 			   const u8 *addr, const u8 *dst, const u8 *bssid,
224 			   const u8 *ie, size_t ie_len, u32 ssi_signal);
225 void wpas_dbus_signal_eap_status(struct wpa_supplicant *wpa_s,
226 				 const char *status, const char *parameter);
227 void wpas_dbus_signal_sta_authorized(struct wpa_supplicant *wpa_s,
228 				     const u8 *sta);
229 void wpas_dbus_signal_sta_deauthorized(struct wpa_supplicant *wpa_s,
230 				       const u8 *sta);
231 
232 #else /* CONFIG_CTRL_IFACE_DBUS_NEW */
233 
234 static inline int wpas_dbus_register_interface(struct wpa_supplicant *wpa_s)
235 {
236 	return 0;
237 }
238 
239 static inline int wpas_dbus_unregister_interface(struct wpa_supplicant *wpa_s)
240 {
241 	return 0;
242 }
243 
244 #define wpas_dbus_signal_state_changed(w, n, o) do { } while (0)
245 
246 static inline void wpas_dbus_signal_prop_changed(struct wpa_supplicant *wpa_s,
247 						 enum wpas_dbus_prop property)
248 {
249 }
250 
251 static inline void wpas_dbus_bss_signal_prop_changed(
252 	struct wpa_supplicant *wpa_s, enum wpas_dbus_bss_prop property,
253 	unsigned int id)
254 {
255 }
256 
257 static inline void wpas_dbus_signal_network_enabled_changed(
258 	struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid)
259 {
260 }
261 
262 static inline void wpas_dbus_signal_network_selected(
263 	struct wpa_supplicant *wpa_s, int id)
264 {
265 }
266 
267 static inline void wpas_dbus_signal_network_request(
268 	struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
269 	enum wpa_ctrl_req_type rtype, const char *default_txt)
270 {
271 }
272 
273 static inline void wpas_dbus_signal_scan_done(struct wpa_supplicant *wpa_s,
274 					      int success)
275 {
276 }
277 
278 static inline void wpas_dbus_signal_wps_cred(struct wpa_supplicant *wpa_s,
279 					     const struct wps_credential *cred)
280 {
281 }
282 
283 static inline void wpas_dbus_signal_wps_event_m2d(struct wpa_supplicant *wpa_s,
284 						  struct wps_event_m2d *m2d)
285 {
286 }
287 
288 static inline void wpas_dbus_signal_wps_event_fail(
289 	struct wpa_supplicant *wpa_s, struct wps_event_fail *fail)
290 {
291 }
292 
293 static inline void wpas_dbus_signal_wps_event_success(
294 	struct wpa_supplicant *wpa_s)
295 {
296 }
297 
298 static inline int wpas_dbus_register_network(struct wpa_supplicant *wpa_s,
299 					     struct wpa_ssid *ssid)
300 {
301 	return 0;
302 }
303 
304 static inline int wpas_dbus_unregister_network(struct wpa_supplicant *wpa_s,
305 					       int nid)
306 {
307 	return 0;
308 }
309 
310 static inline int wpas_dbus_unregister_bss(struct wpa_supplicant *wpa_s,
311 					   u8 bssid[ETH_ALEN], unsigned int id)
312 {
313 	return 0;
314 }
315 
316 static inline int wpas_dbus_register_bss(struct wpa_supplicant *wpa_s,
317 					 u8 bssid[ETH_ALEN], unsigned int id)
318 {
319 	return 0;
320 }
321 
322 static inline void wpas_dbus_signal_blob_added(struct wpa_supplicant *wpa_s,
323 					       const char *name)
324 {
325 }
326 
327 static inline void wpas_dbus_signal_blob_removed(struct wpa_supplicant *wpa_s,
328 						 const char *name)
329 {
330 }
331 
332 static inline void wpas_dbus_signal_debug_level_changed(
333 	struct wpa_global *global)
334 {
335 }
336 
337 static inline void wpas_dbus_signal_debug_timestamp_changed(
338 	struct wpa_global *global)
339 {
340 }
341 
342 static inline void wpas_dbus_signal_debug_show_keys_changed(
343 	struct wpa_global *global)
344 {
345 }
346 
347 static inline int wpas_dbus_register_peer(struct wpa_supplicant *wpa_s,
348 					  const u8 *dev_addr)
349 {
350 	return 0;
351 }
352 
353 static inline int wpas_dbus_unregister_peer(struct wpa_supplicant *wpa_s,
354 					    const u8 *dev_addr)
355 {
356 	return 0;
357 }
358 
359 static inline void
360 wpas_dbus_signal_peer_groups_changed(struct wpa_supplicant *wpa_s,
361 				     const u8 *dev_addr)
362 {
363 }
364 
365 static inline void
366 wpas_dbus_signal_p2p_group_removed(struct wpa_supplicant *wpa_s,
367 				   const char *role)
368 {
369 }
370 
371 static inline void
372 wpas_dbus_signal_p2p_provision_discovery(struct wpa_supplicant *wpa_s,
373 					 const u8 *dev_addr, int request,
374 					 enum p2p_prov_disc_status status,
375 					 u16 config_methods,
376 					 unsigned int generated_pin)
377 {
378 }
379 
380 static inline void wpas_dbus_signal_p2p_go_neg_req(
381 				struct wpa_supplicant *wpa_s,
382 				const u8 *src,
383 				u16 dev_passwd_id)
384 {
385 }
386 
387 static inline void
388 wpas_dbus_signal_p2p_group_started(struct wpa_supplicant *wpa_s,
389 				   const struct wpa_ssid *ssid,
390 				   int client, int network_id)
391 {
392 }
393 
394 static inline void
395 wpas_dbus_register_p2p_group(struct wpa_supplicant *wpa_s,
396 			     struct wpa_ssid *ssid)
397 {
398 }
399 
400 static inline int wpas_dbus_register_persistent_group(
401 	struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid)
402 {
403 	return 0;
404 }
405 
406 static inline int wpas_dbus_unregister_persistent_group(
407 	struct wpa_supplicant *wpa_s, int nid)
408 {
409 	return 0;
410 }
411 
412 static inline void
413 wpas_dbus_signal_p2p_go_neg_resp(struct wpa_supplicant *wpa_s,
414 				 struct p2p_go_neg_results *res)
415 {
416 }
417 
418 static inline void
419 wpas_dbus_unregister_p2p_group(struct wpa_supplicant *wpa_s,
420 			       const struct wpa_ssid *ssid)
421 {
422 }
423 
424 static inline void wpas_dbus_signal_p2p_invitation_result(
425 				struct wpa_supplicant *wpa_s, int status,
426 				const u8 *bssid)
427 {
428 }
429 
430 static inline void
431 wpas_dbus_register_p2p_groupmember(struct wpa_supplicant *wpa_s,
432 				   const u8 *p2p_if_addr)
433 {
434 }
435 
436 static inline void
437 wpas_dbus_signal_p2p_sd_request(struct wpa_supplicant *wpa_s, int freq,
438 				const u8 *sa, u8 dialog_token, u16 update_indic,
439 				const u8 *tlvs, size_t tlvs_len)
440 {
441 }
442 
443 static inline void
444 wpas_dbus_signal_p2p_sd_response(struct wpa_supplicant *wpa_s,
445 				 const u8 *sa, u16 update_indic,
446 				 const u8 *tlvs, size_t tlvs_len)
447 {
448 }
449 
450 static inline void
451 wpas_dbus_unregister_p2p_groupmember(struct wpa_supplicant *wpa_s,
452 				     const u8 *p2p_if_addr)
453 {
454 }
455 
456 static inline void
457 wpas_dbus_signal_p2p_peer_joined(struct wpa_supplicant *wpa_s,
458 				 const u8 *member)
459 {
460 }
461 
462 static inline void
463 wpas_dbus_signal_peer_device_found(struct wpa_supplicant *wpa_s,
464 				   const u8 *dev_addr)
465 {
466 }
467 
468 static inline void
469 wpas_dbus_signal_peer_device_lost(struct wpa_supplicant *wpa_s,
470 				  const u8 *dev_addr)
471 {
472 }
473 
474 static inline void
475 wpas_dbus_signal_p2p_peer_disconnected(struct wpa_supplicant *wpa_s,
476 				       const u8 *member)
477 {
478 }
479 
480 static inline void
481 wpas_dbus_signal_p2p_wps_failed(struct wpa_supplicant *wpa_s,
482 				struct wps_event_fail *fail)
483 {
484 }
485 
486 static inline void wpas_dbus_signal_certification(struct wpa_supplicant *wpa_s,
487 						  int depth,
488 						  const char *subject,
489 						  const char *altsubject[],
490 						  int num_altsubject,
491 						  const char *cert_hash,
492 						  const struct wpabuf *cert)
493 {
494 }
495 
496 static inline void wpas_dbus_signal_preq(struct wpa_supplicant *wpa_s,
497 					 const u8 *addr, const u8 *dst,
498 					 const u8 *bssid,
499 					 const u8 *ie, size_t ie_len,
500 					 u32 ssi_signal)
501 {
502 }
503 
504 static inline void wpas_dbus_signal_eap_status(struct wpa_supplicant *wpa_s,
505 					       const char *status,
506 					       const char *parameter)
507 {
508 }
509 
510 static inline
511 void wpas_dbus_signal_sta_authorized(struct wpa_supplicant *wpa_s,
512 				     const u8 *sta)
513 {
514 }
515 
516 static inline
517 void wpas_dbus_signal_sta_deauthorized(struct wpa_supplicant *wpa_s,
518 				       const u8 *sta)
519 {
520 }
521 
522 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
523 
524 #endif /* CTRL_IFACE_DBUS_H_NEW */
525