1 /*
2 * WPA Supplicant / dbus-based control interface
3 * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9 #include "includes.h"
10 #include <dbus/dbus.h>
11
12 #include "common.h"
13 #include "wpabuf.h"
14 #include "dbus_dict_helpers.h"
15
16
17 /**
18 * Start a dict in a dbus message. Should be paired with a call to
19 * wpa_dbus_dict_close_write().
20 *
21 * @param iter A valid dbus message iterator
22 * @param iter_dict (out) A dict iterator to pass to further dict functions
23 * @return TRUE on success, FALSE on failure
24 *
25 */
wpa_dbus_dict_open_write(DBusMessageIter * iter,DBusMessageIter * iter_dict)26 dbus_bool_t wpa_dbus_dict_open_write(DBusMessageIter *iter,
27 DBusMessageIter *iter_dict)
28 {
29 dbus_bool_t result;
30
31 if (!iter || !iter_dict)
32 return FALSE;
33
34 result = dbus_message_iter_open_container(
35 iter,
36 DBUS_TYPE_ARRAY,
37 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
38 DBUS_TYPE_STRING_AS_STRING
39 DBUS_TYPE_VARIANT_AS_STRING
40 DBUS_DICT_ENTRY_END_CHAR_AS_STRING,
41 iter_dict);
42 return result;
43 }
44
45
46 /**
47 * End a dict element in a dbus message. Should be paired with
48 * a call to wpa_dbus_dict_open_write().
49 *
50 * @param iter valid dbus message iterator, same as passed to
51 * wpa_dbus_dict_open_write()
52 * @param iter_dict a dbus dict iterator returned from
53 * wpa_dbus_dict_open_write()
54 * @return TRUE on success, FALSE on failure
55 *
56 */
wpa_dbus_dict_close_write(DBusMessageIter * iter,DBusMessageIter * iter_dict)57 dbus_bool_t wpa_dbus_dict_close_write(DBusMessageIter *iter,
58 DBusMessageIter *iter_dict)
59 {
60 if (!iter || !iter_dict)
61 return FALSE;
62
63 return dbus_message_iter_close_container(iter, iter_dict);
64 }
65
66
wpa_dbus_type_as_string(const int type)67 const char * wpa_dbus_type_as_string(const int type)
68 {
69 switch (type) {
70 case DBUS_TYPE_BYTE:
71 return DBUS_TYPE_BYTE_AS_STRING;
72 case DBUS_TYPE_BOOLEAN:
73 return DBUS_TYPE_BOOLEAN_AS_STRING;
74 case DBUS_TYPE_INT16:
75 return DBUS_TYPE_INT16_AS_STRING;
76 case DBUS_TYPE_UINT16:
77 return DBUS_TYPE_UINT16_AS_STRING;
78 case DBUS_TYPE_INT32:
79 return DBUS_TYPE_INT32_AS_STRING;
80 case DBUS_TYPE_UINT32:
81 return DBUS_TYPE_UINT32_AS_STRING;
82 case DBUS_TYPE_INT64:
83 return DBUS_TYPE_INT64_AS_STRING;
84 case DBUS_TYPE_UINT64:
85 return DBUS_TYPE_UINT64_AS_STRING;
86 case DBUS_TYPE_DOUBLE:
87 return DBUS_TYPE_DOUBLE_AS_STRING;
88 case DBUS_TYPE_STRING:
89 return DBUS_TYPE_STRING_AS_STRING;
90 case DBUS_TYPE_OBJECT_PATH:
91 return DBUS_TYPE_OBJECT_PATH_AS_STRING;
92 case DBUS_TYPE_ARRAY:
93 return DBUS_TYPE_ARRAY_AS_STRING;
94 default:
95 return NULL;
96 }
97 }
98
99
_wpa_dbus_add_dict_entry_start(DBusMessageIter * iter_dict,DBusMessageIter * iter_dict_entry,const char * key,const int value_type)100 static dbus_bool_t _wpa_dbus_add_dict_entry_start(
101 DBusMessageIter *iter_dict, DBusMessageIter *iter_dict_entry,
102 const char *key, const int value_type)
103 {
104 if (!dbus_message_iter_open_container(iter_dict,
105 DBUS_TYPE_DICT_ENTRY, NULL,
106 iter_dict_entry))
107 return FALSE;
108
109 return dbus_message_iter_append_basic(iter_dict_entry, DBUS_TYPE_STRING,
110 &key);
111 }
112
113
_wpa_dbus_add_dict_entry_end(DBusMessageIter * iter_dict,DBusMessageIter * iter_dict_entry,DBusMessageIter * iter_dict_val)114 static dbus_bool_t _wpa_dbus_add_dict_entry_end(
115 DBusMessageIter *iter_dict, DBusMessageIter *iter_dict_entry,
116 DBusMessageIter *iter_dict_val)
117 {
118 if (!dbus_message_iter_close_container(iter_dict_entry, iter_dict_val))
119 return FALSE;
120
121 return dbus_message_iter_close_container(iter_dict, iter_dict_entry);
122 }
123
124
_wpa_dbus_add_dict_entry_basic(DBusMessageIter * iter_dict,const char * key,const int value_type,const void * value)125 static dbus_bool_t _wpa_dbus_add_dict_entry_basic(DBusMessageIter *iter_dict,
126 const char *key,
127 const int value_type,
128 const void *value)
129 {
130 DBusMessageIter iter_dict_entry, iter_dict_val;
131 const char *type_as_string = NULL;
132
133 if (key == NULL)
134 return FALSE;
135
136 type_as_string = wpa_dbus_type_as_string(value_type);
137 if (!type_as_string)
138 return FALSE;
139
140 if (!_wpa_dbus_add_dict_entry_start(iter_dict, &iter_dict_entry,
141 key, value_type) ||
142 !dbus_message_iter_open_container(&iter_dict_entry,
143 DBUS_TYPE_VARIANT,
144 type_as_string, &iter_dict_val) ||
145 !dbus_message_iter_append_basic(&iter_dict_val, value_type, value))
146 return FALSE;
147
148 return _wpa_dbus_add_dict_entry_end(iter_dict, &iter_dict_entry,
149 &iter_dict_val);
150 }
151
152
_wpa_dbus_add_dict_entry_byte_array(DBusMessageIter * iter_dict,const char * key,const char * value,const dbus_uint32_t value_len)153 static dbus_bool_t _wpa_dbus_add_dict_entry_byte_array(
154 DBusMessageIter *iter_dict, const char *key,
155 const char *value, const dbus_uint32_t value_len)
156 {
157 DBusMessageIter iter_dict_entry, iter_dict_val, iter_array;
158 dbus_uint32_t i;
159
160 if (!_wpa_dbus_add_dict_entry_start(iter_dict, &iter_dict_entry,
161 key, DBUS_TYPE_ARRAY) ||
162 !dbus_message_iter_open_container(&iter_dict_entry,
163 DBUS_TYPE_VARIANT,
164 DBUS_TYPE_ARRAY_AS_STRING
165 DBUS_TYPE_BYTE_AS_STRING,
166 &iter_dict_val) ||
167 !dbus_message_iter_open_container(&iter_dict_val, DBUS_TYPE_ARRAY,
168 DBUS_TYPE_BYTE_AS_STRING,
169 &iter_array))
170 return FALSE;
171
172 for (i = 0; i < value_len; i++) {
173 if (!dbus_message_iter_append_basic(&iter_array,
174 DBUS_TYPE_BYTE,
175 &(value[i])))
176 return FALSE;
177 }
178
179 if (!dbus_message_iter_close_container(&iter_dict_val, &iter_array))
180 return FALSE;
181
182 return _wpa_dbus_add_dict_entry_end(iter_dict, &iter_dict_entry,
183 &iter_dict_val);
184 }
185
186
187 /**
188 * Add a string entry to the dict.
189 *
190 * @param iter_dict A valid DBusMessageIter returned from
191 * wpa_dbus_dict_open_write()
192 * @param key The key of the dict item
193 * @param value The string value
194 * @return TRUE on success, FALSE on failure
195 *
196 */
wpa_dbus_dict_append_string(DBusMessageIter * iter_dict,const char * key,const char * value)197 dbus_bool_t wpa_dbus_dict_append_string(DBusMessageIter *iter_dict,
198 const char *key, const char *value)
199 {
200 if (!value)
201 return FALSE;
202 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_STRING,
203 &value);
204 }
205
206
207 /**
208 * Add a boolean entry to the dict.
209 *
210 * @param iter_dict A valid DBusMessageIter returned from
211 * wpa_dbus_dict_open_write()
212 * @param key The key of the dict item
213 * @param value The boolean value
214 * @return TRUE on success, FALSE on failure
215 *
216 */
wpa_dbus_dict_append_bool(DBusMessageIter * iter_dict,const char * key,const dbus_bool_t value)217 dbus_bool_t wpa_dbus_dict_append_bool(DBusMessageIter *iter_dict,
218 const char *key, const dbus_bool_t value)
219 {
220 return _wpa_dbus_add_dict_entry_basic(iter_dict, key,
221 DBUS_TYPE_BOOLEAN, &value);
222 }
223
224
225 /**
226 * Add a 16-bit signed integer entry to the dict.
227 *
228 * @param iter_dict A valid DBusMessageIter returned from
229 * wpa_dbus_dict_open_write()
230 * @param key The key of the dict item
231 * @param value The 16-bit signed integer value
232 * @return TRUE on success, FALSE on failure
233 *
234 */
wpa_dbus_dict_append_int16(DBusMessageIter * iter_dict,const char * key,const dbus_int16_t value)235 dbus_bool_t wpa_dbus_dict_append_int16(DBusMessageIter *iter_dict,
236 const char *key,
237 const dbus_int16_t value)
238 {
239 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_INT16,
240 &value);
241 }
242
243
244 /**
245 * Add a 16-bit unsigned integer entry to the dict.
246 *
247 * @param iter_dict A valid DBusMessageIter returned from
248 * wpa_dbus_dict_open_write()
249 * @param key The key of the dict item
250 * @param value The 16-bit unsigned integer value
251 * @return TRUE on success, FALSE on failure
252 *
253 */
wpa_dbus_dict_append_uint16(DBusMessageIter * iter_dict,const char * key,const dbus_uint16_t value)254 dbus_bool_t wpa_dbus_dict_append_uint16(DBusMessageIter *iter_dict,
255 const char *key,
256 const dbus_uint16_t value)
257 {
258 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_UINT16,
259 &value);
260 }
261
262
263 /**
264 * Add a 32-bit signed integer to the dict.
265 *
266 * @param iter_dict A valid DBusMessageIter returned from
267 * wpa_dbus_dict_open_write()
268 * @param key The key of the dict item
269 * @param value The 32-bit signed integer value
270 * @return TRUE on success, FALSE on failure
271 *
272 */
wpa_dbus_dict_append_int32(DBusMessageIter * iter_dict,const char * key,const dbus_int32_t value)273 dbus_bool_t wpa_dbus_dict_append_int32(DBusMessageIter *iter_dict,
274 const char *key,
275 const dbus_int32_t value)
276 {
277 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_INT32,
278 &value);
279 }
280
281
282 /**
283 * Add a 32-bit unsigned integer entry to the dict.
284 *
285 * @param iter_dict A valid DBusMessageIter returned from
286 * wpa_dbus_dict_open_write()
287 * @param key The key of the dict item
288 * @param value The 32-bit unsigned integer value
289 * @return TRUE on success, FALSE on failure
290 *
291 */
wpa_dbus_dict_append_uint32(DBusMessageIter * iter_dict,const char * key,const dbus_uint32_t value)292 dbus_bool_t wpa_dbus_dict_append_uint32(DBusMessageIter *iter_dict,
293 const char *key,
294 const dbus_uint32_t value)
295 {
296 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_UINT32,
297 &value);
298 }
299
300
301 /**
302 * Add a 64-bit unsigned integer entry to the dict.
303 *
304 * @param iter_dict A valid DBusMessageIter returned from
305 * wpa_dbus_dict_open_write()
306 * @param key The key of the dict item
307 * @param value The 64-bit unsigned integer value
308 * @return TRUE on success, FALSE on failure
309 *
310 */
wpa_dbus_dict_append_uint64(DBusMessageIter * iter_dict,const char * key,const dbus_uint64_t value)311 dbus_bool_t wpa_dbus_dict_append_uint64(DBusMessageIter *iter_dict,
312 const char *key,
313 const dbus_uint64_t value)
314 {
315 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_UINT64,
316 &value);
317 }
318
319
320 /**
321 * Add a DBus object path entry to the dict.
322 *
323 * @param iter_dict A valid DBusMessageIter returned from
324 * wpa_dbus_dict_open_write()
325 * @param key The key of the dict item
326 * @param value The DBus object path value
327 * @return TRUE on success, FALSE on failure
328 *
329 */
wpa_dbus_dict_append_object_path(DBusMessageIter * iter_dict,const char * key,const char * value)330 dbus_bool_t wpa_dbus_dict_append_object_path(DBusMessageIter *iter_dict,
331 const char *key,
332 const char *value)
333 {
334 if (!value)
335 return FALSE;
336 return _wpa_dbus_add_dict_entry_basic(iter_dict, key,
337 DBUS_TYPE_OBJECT_PATH, &value);
338 }
339
340
341 /**
342 * Add a byte array entry to the dict.
343 *
344 * @param iter_dict A valid DBusMessageIter returned from
345 * wpa_dbus_dict_open_write()
346 * @param key The key of the dict item
347 * @param value The byte array
348 * @param value_len The length of the byte array, in bytes
349 * @return TRUE on success, FALSE on failure
350 *
351 */
wpa_dbus_dict_append_byte_array(DBusMessageIter * iter_dict,const char * key,const char * value,const dbus_uint32_t value_len)352 dbus_bool_t wpa_dbus_dict_append_byte_array(DBusMessageIter *iter_dict,
353 const char *key,
354 const char *value,
355 const dbus_uint32_t value_len)
356 {
357 if (!key || (!value && value_len != 0))
358 return FALSE;
359 return _wpa_dbus_add_dict_entry_byte_array(iter_dict, key, value,
360 value_len);
361 }
362
363
364 /**
365 * Begin an array entry in the dict
366 *
367 * @param iter_dict A valid DBusMessageIter returned from
368 * wpa_dbus_dict_open_write()
369 * @param key The key of the dict item
370 * @param type The type of the contained data
371 * @param iter_dict_entry A private DBusMessageIter provided by the caller to
372 * be passed to wpa_dbus_dict_end_string_array()
373 * @param iter_dict_val A private DBusMessageIter provided by the caller to
374 * be passed to wpa_dbus_dict_end_string_array()
375 * @param iter_array On return, the DBusMessageIter to be passed to
376 * wpa_dbus_dict_string_array_add_element()
377 * @return TRUE on success, FALSE on failure
378 *
379 */
wpa_dbus_dict_begin_array(DBusMessageIter * iter_dict,const char * key,const char * type,DBusMessageIter * iter_dict_entry,DBusMessageIter * iter_dict_val,DBusMessageIter * iter_array)380 dbus_bool_t wpa_dbus_dict_begin_array(DBusMessageIter *iter_dict,
381 const char *key, const char *type,
382 DBusMessageIter *iter_dict_entry,
383 DBusMessageIter *iter_dict_val,
384 DBusMessageIter *iter_array)
385 {
386 char array_type[10];
387 int err;
388
389 err = os_snprintf(array_type, sizeof(array_type),
390 DBUS_TYPE_ARRAY_AS_STRING "%s",
391 type);
392 if (os_snprintf_error(sizeof(array_type), err))
393 return FALSE;
394
395 if (!iter_dict || !iter_dict_entry || !iter_dict_val || !iter_array ||
396 !_wpa_dbus_add_dict_entry_start(iter_dict, iter_dict_entry,
397 key, DBUS_TYPE_ARRAY) ||
398 !dbus_message_iter_open_container(iter_dict_entry,
399 DBUS_TYPE_VARIANT,
400 array_type,
401 iter_dict_val))
402 return FALSE;
403
404 return dbus_message_iter_open_container(iter_dict_val, DBUS_TYPE_ARRAY,
405 type, iter_array);
406 }
407
408
wpa_dbus_dict_begin_string_array(DBusMessageIter * iter_dict,const char * key,DBusMessageIter * iter_dict_entry,DBusMessageIter * iter_dict_val,DBusMessageIter * iter_array)409 dbus_bool_t wpa_dbus_dict_begin_string_array(DBusMessageIter *iter_dict,
410 const char *key,
411 DBusMessageIter *iter_dict_entry,
412 DBusMessageIter *iter_dict_val,
413 DBusMessageIter *iter_array)
414 {
415 return wpa_dbus_dict_begin_array(
416 iter_dict, key,
417 DBUS_TYPE_STRING_AS_STRING,
418 iter_dict_entry, iter_dict_val, iter_array);
419 }
420
421
422 /**
423 * Add a single string element to a string array dict entry
424 *
425 * @param iter_array A valid DBusMessageIter returned from
426 * wpa_dbus_dict_begin_string_array()'s
427 * iter_array parameter
428 * @param elem The string element to be added to the dict entry's string array
429 * @return TRUE on success, FALSE on failure
430 *
431 */
wpa_dbus_dict_string_array_add_element(DBusMessageIter * iter_array,const char * elem)432 dbus_bool_t wpa_dbus_dict_string_array_add_element(DBusMessageIter *iter_array,
433 const char *elem)
434 {
435 if (!iter_array || !elem)
436 return FALSE;
437
438 return dbus_message_iter_append_basic(iter_array, DBUS_TYPE_STRING,
439 &elem);
440 }
441
442
443 /**
444 * Add a single byte array element to a string array dict entry
445 *
446 * @param iter_array A valid DBusMessageIter returned from
447 * wpa_dbus_dict_begin_array()'s iter_array
448 * parameter -- note that wpa_dbus_dict_begin_array()
449 * must have been called with "ay" as the type
450 * @param value The data to be added to the dict entry's array
451 * @param value_len The length of the data
452 * @return TRUE on success, FALSE on failure
453 *
454 */
wpa_dbus_dict_bin_array_add_element(DBusMessageIter * iter_array,const u8 * value,size_t value_len)455 dbus_bool_t wpa_dbus_dict_bin_array_add_element(DBusMessageIter *iter_array,
456 const u8 *value,
457 size_t value_len)
458 {
459 DBusMessageIter iter_bytes;
460 size_t i;
461
462 if (!iter_array || !value ||
463 !dbus_message_iter_open_container(iter_array, DBUS_TYPE_ARRAY,
464 DBUS_TYPE_BYTE_AS_STRING,
465 &iter_bytes))
466 return FALSE;
467
468 for (i = 0; i < value_len; i++) {
469 if (!dbus_message_iter_append_basic(&iter_bytes,
470 DBUS_TYPE_BYTE,
471 &(value[i])))
472 return FALSE;
473 }
474
475 return dbus_message_iter_close_container(iter_array, &iter_bytes);
476 }
477
478
479 /**
480 * End an array dict entry
481 *
482 * @param iter_dict A valid DBusMessageIter returned from
483 * wpa_dbus_dict_open_write()
484 * @param iter_dict_entry A private DBusMessageIter returned from
485 * wpa_dbus_dict_begin_string_array() or
486 * wpa_dbus_dict_begin_array()
487 * @param iter_dict_val A private DBusMessageIter returned from
488 * wpa_dbus_dict_begin_string_array() or
489 * wpa_dbus_dict_begin_array()
490 * @param iter_array A DBusMessageIter returned from
491 * wpa_dbus_dict_begin_string_array() or
492 * wpa_dbus_dict_begin_array()
493 * @return TRUE on success, FALSE on failure
494 *
495 */
wpa_dbus_dict_end_array(DBusMessageIter * iter_dict,DBusMessageIter * iter_dict_entry,DBusMessageIter * iter_dict_val,DBusMessageIter * iter_array)496 dbus_bool_t wpa_dbus_dict_end_array(DBusMessageIter *iter_dict,
497 DBusMessageIter *iter_dict_entry,
498 DBusMessageIter *iter_dict_val,
499 DBusMessageIter *iter_array)
500 {
501 if (!iter_dict || !iter_dict_entry || !iter_dict_val || !iter_array ||
502 !dbus_message_iter_close_container(iter_dict_val, iter_array))
503 return FALSE;
504
505 return _wpa_dbus_add_dict_entry_end(iter_dict, iter_dict_entry,
506 iter_dict_val);
507 }
508
509
510 /**
511 * Convenience function to add an entire string array to the dict.
512 *
513 * @param iter_dict A valid DBusMessageIter returned from
514 * wpa_dbus_dict_open_write()
515 * @param key The key of the dict item
516 * @param items The array of strings
517 * @param num_items The number of strings in the array
518 * @return TRUE on success, FALSE on failure
519 *
520 */
wpa_dbus_dict_append_string_array(DBusMessageIter * iter_dict,const char * key,const char ** items,const dbus_uint32_t num_items)521 dbus_bool_t wpa_dbus_dict_append_string_array(DBusMessageIter *iter_dict,
522 const char *key,
523 const char **items,
524 const dbus_uint32_t num_items)
525 {
526 DBusMessageIter iter_dict_entry, iter_dict_val, iter_array;
527 dbus_uint32_t i;
528
529 if (!key || (!items && num_items != 0) ||
530 !wpa_dbus_dict_begin_string_array(iter_dict, key,
531 &iter_dict_entry, &iter_dict_val,
532 &iter_array))
533 return FALSE;
534
535 for (i = 0; i < num_items; i++) {
536 if (!wpa_dbus_dict_string_array_add_element(&iter_array,
537 items[i]))
538 return FALSE;
539 }
540
541 return wpa_dbus_dict_end_string_array(iter_dict, &iter_dict_entry,
542 &iter_dict_val, &iter_array);
543 }
544
545
546 /**
547 * Convenience function to add an wpabuf binary array to the dict.
548 *
549 * @param iter_dict A valid DBusMessageIter returned from
550 * wpa_dbus_dict_open_write()
551 * @param key The key of the dict item
552 * @param items The array of wpabuf structures
553 * @param num_items The number of strings in the array
554 * @return TRUE on success, FALSE on failure
555 *
556 */
wpa_dbus_dict_append_wpabuf_array(DBusMessageIter * iter_dict,const char * key,const struct wpabuf ** items,const dbus_uint32_t num_items)557 dbus_bool_t wpa_dbus_dict_append_wpabuf_array(DBusMessageIter *iter_dict,
558 const char *key,
559 const struct wpabuf **items,
560 const dbus_uint32_t num_items)
561 {
562 DBusMessageIter iter_dict_entry, iter_dict_val, iter_array;
563 dbus_uint32_t i;
564
565 if (!key ||
566 (!items && num_items != 0) ||
567 !wpa_dbus_dict_begin_array(iter_dict, key,
568 DBUS_TYPE_ARRAY_AS_STRING
569 DBUS_TYPE_BYTE_AS_STRING,
570 &iter_dict_entry, &iter_dict_val,
571 &iter_array))
572 return FALSE;
573
574 for (i = 0; i < num_items; i++) {
575 if (!wpa_dbus_dict_bin_array_add_element(&iter_array,
576 wpabuf_head(items[i]),
577 wpabuf_len(items[i])))
578 return FALSE;
579 }
580
581 return wpa_dbus_dict_end_array(iter_dict, &iter_dict_entry,
582 &iter_dict_val, &iter_array);
583 }
584
585
586 /*****************************************************/
587 /* Stuff for reading dicts */
588 /*****************************************************/
589
590 /**
591 * Start reading from a dbus dict.
592 *
593 * @param iter A valid DBusMessageIter pointing to the start of the dict
594 * @param iter_dict (out) A DBusMessageIter to be passed to
595 * wpa_dbus_dict_read_next_entry()
596 * @error on failure a descriptive error
597 * @return TRUE on success, FALSE on failure
598 *
599 */
wpa_dbus_dict_open_read(DBusMessageIter * iter,DBusMessageIter * iter_dict,DBusError * error)600 dbus_bool_t wpa_dbus_dict_open_read(DBusMessageIter *iter,
601 DBusMessageIter *iter_dict,
602 DBusError *error)
603 {
604 int type;
605
606 wpa_printf(MSG_MSGDUMP, "%s: start reading a dict entry", __func__);
607 if (!iter || !iter_dict) {
608 dbus_set_error_const(error, DBUS_ERROR_FAILED,
609 "[internal] missing message iterators");
610 return FALSE;
611 }
612
613 type = dbus_message_iter_get_arg_type(iter);
614 if (type != DBUS_TYPE_ARRAY ||
615 dbus_message_iter_get_element_type(iter) != DBUS_TYPE_DICT_ENTRY) {
616 wpa_printf(MSG_DEBUG,
617 "%s: unexpected message argument types (arg=%c element=%c)",
618 __func__, type,
619 type != DBUS_TYPE_ARRAY ? '?' :
620 dbus_message_iter_get_element_type(iter));
621 dbus_set_error_const(error, DBUS_ERROR_INVALID_ARGS,
622 "unexpected message argument types");
623 return FALSE;
624 }
625
626 dbus_message_iter_recurse(iter, iter_dict);
627 return TRUE;
628 }
629
630
631 #define BYTE_ARRAY_CHUNK_SIZE 34
632 #define BYTE_ARRAY_ITEM_SIZE (sizeof(char))
633
_wpa_dbus_dict_entry_get_byte_array(DBusMessageIter * iter,struct wpa_dbus_dict_entry * entry)634 static dbus_bool_t _wpa_dbus_dict_entry_get_byte_array(
635 DBusMessageIter *iter, struct wpa_dbus_dict_entry *entry)
636 {
637 dbus_uint32_t count = 0;
638 dbus_bool_t success = FALSE;
639 char *buffer, *nbuffer;
640
641 entry->bytearray_value = NULL;
642 entry->array_type = DBUS_TYPE_BYTE;
643
644 buffer = os_calloc(BYTE_ARRAY_CHUNK_SIZE, BYTE_ARRAY_ITEM_SIZE);
645 if (!buffer)
646 return FALSE;
647
648 entry->array_len = 0;
649 while (dbus_message_iter_get_arg_type(iter) == DBUS_TYPE_BYTE) {
650 char byte;
651
652 if ((count % BYTE_ARRAY_CHUNK_SIZE) == 0 && count != 0) {
653 nbuffer = os_realloc_array(
654 buffer, count + BYTE_ARRAY_CHUNK_SIZE,
655 BYTE_ARRAY_ITEM_SIZE);
656 if (nbuffer == NULL) {
657 os_free(buffer);
658 wpa_printf(MSG_ERROR,
659 "dbus: %s out of memory trying to retrieve the string array",
660 __func__);
661 goto done;
662 }
663 buffer = nbuffer;
664 }
665
666 dbus_message_iter_get_basic(iter, &byte);
667 buffer[count] = byte;
668 entry->array_len = ++count;
669 dbus_message_iter_next(iter);
670 }
671 entry->bytearray_value = buffer;
672 wpa_hexdump_key(MSG_MSGDUMP, "dbus: byte array contents",
673 entry->bytearray_value, entry->array_len);
674
675 /* Zero-length arrays are valid. */
676 if (entry->array_len == 0) {
677 os_free(entry->bytearray_value);
678 entry->bytearray_value = NULL;
679 }
680
681 success = TRUE;
682
683 done:
684 return success;
685 }
686
687
688 #define STR_ARRAY_CHUNK_SIZE 8
689 #define STR_ARRAY_ITEM_SIZE (sizeof(char *))
690
_wpa_dbus_dict_entry_get_string_array(DBusMessageIter * iter,int array_type,struct wpa_dbus_dict_entry * entry)691 static dbus_bool_t _wpa_dbus_dict_entry_get_string_array(
692 DBusMessageIter *iter, int array_type,
693 struct wpa_dbus_dict_entry *entry)
694 {
695 dbus_uint32_t count = 0;
696 char **buffer, **nbuffer;
697
698 entry->strarray_value = NULL;
699 entry->array_len = 0;
700 entry->array_type = DBUS_TYPE_STRING;
701
702 buffer = os_calloc(STR_ARRAY_CHUNK_SIZE, STR_ARRAY_ITEM_SIZE);
703 if (buffer == NULL)
704 return FALSE;
705
706 while (dbus_message_iter_get_arg_type(iter) == DBUS_TYPE_STRING) {
707 const char *value;
708 char *str;
709
710 if ((count % STR_ARRAY_CHUNK_SIZE) == 0 && count != 0) {
711 nbuffer = os_realloc_array(
712 buffer, count + STR_ARRAY_CHUNK_SIZE,
713 STR_ARRAY_ITEM_SIZE);
714 if (nbuffer == NULL) {
715 wpa_printf(MSG_ERROR,
716 "dbus: %s out of memory trying to retrieve the string array",
717 __func__);
718 goto fail;
719 }
720 buffer = nbuffer;
721 }
722
723 dbus_message_iter_get_basic(iter, &value);
724 wpa_printf(MSG_MSGDUMP, "%s: string_array value: %s",
725 __func__, wpa_debug_show_keys ? value : "[omitted]");
726 str = os_strdup(value);
727 if (str == NULL) {
728 wpa_printf(MSG_ERROR,
729 "dbus: %s out of memory trying to duplicate the string array",
730 __func__);
731 goto fail;
732 }
733 buffer[count++] = str;
734 dbus_message_iter_next(iter);
735 }
736 entry->strarray_value = buffer;
737 entry->array_len = count;
738 wpa_printf(MSG_MSGDUMP, "%s: string_array length %u",
739 __func__, entry->array_len);
740
741 /* Zero-length arrays are valid. */
742 if (entry->array_len == 0) {
743 os_free(entry->strarray_value);
744 entry->strarray_value = NULL;
745 }
746
747 return TRUE;
748
749 fail:
750 while (count > 0) {
751 count--;
752 os_free(buffer[count]);
753 }
754 os_free(buffer);
755 return FALSE;
756 }
757
758
759 #define BIN_ARRAY_CHUNK_SIZE 10
760 #define BIN_ARRAY_ITEM_SIZE (sizeof(struct wpabuf *))
761
_wpa_dbus_dict_entry_get_binarray(DBusMessageIter * iter,struct wpa_dbus_dict_entry * entry)762 static dbus_bool_t _wpa_dbus_dict_entry_get_binarray(
763 DBusMessageIter *iter, struct wpa_dbus_dict_entry *entry)
764 {
765 struct wpa_dbus_dict_entry tmpentry;
766 size_t buflen = 0;
767 int i, type;
768
769 entry->array_type = WPAS_DBUS_TYPE_BINARRAY;
770 entry->array_len = 0;
771 entry->binarray_value = NULL;
772
773 type = dbus_message_iter_get_arg_type(iter);
774 wpa_printf(MSG_MSGDUMP, "%s: parsing binarray type %c", __func__, type);
775 if (type == DBUS_TYPE_INVALID) {
776 /* Likely an empty array of arrays */
777 return TRUE;
778 }
779 if (type != DBUS_TYPE_ARRAY) {
780 wpa_printf(MSG_DEBUG, "%s: not an array type: %c",
781 __func__, type);
782 return FALSE;
783 }
784
785 type = dbus_message_iter_get_element_type(iter);
786 if (type != DBUS_TYPE_BYTE) {
787 wpa_printf(MSG_DEBUG, "%s: unexpected element type %c",
788 __func__, type);
789 return FALSE;
790 }
791
792 while (dbus_message_iter_get_arg_type(iter) == DBUS_TYPE_ARRAY) {
793 DBusMessageIter iter_array;
794
795 if (entry->array_len == buflen) {
796 struct wpabuf **newbuf;
797
798 buflen += BIN_ARRAY_CHUNK_SIZE;
799
800 newbuf = os_realloc_array(entry->binarray_value,
801 buflen, BIN_ARRAY_ITEM_SIZE);
802 if (!newbuf)
803 goto cleanup;
804 entry->binarray_value = newbuf;
805 }
806
807 dbus_message_iter_recurse(iter, &iter_array);
808 os_memset(&tmpentry, 0, sizeof(tmpentry));
809 tmpentry.type = DBUS_TYPE_ARRAY;
810 if (_wpa_dbus_dict_entry_get_byte_array(&iter_array, &tmpentry)
811 == FALSE)
812 goto cleanup;
813
814 entry->binarray_value[entry->array_len] =
815 wpabuf_alloc_ext_data((u8 *) tmpentry.bytearray_value,
816 tmpentry.array_len);
817 if (entry->binarray_value[entry->array_len] == NULL) {
818 wpa_dbus_dict_entry_clear(&tmpentry);
819 goto cleanup;
820 }
821 entry->array_len++;
822 dbus_message_iter_next(iter);
823 }
824 wpa_printf(MSG_MSGDUMP, "%s: binarray length %u",
825 __func__, entry->array_len);
826
827 return TRUE;
828
829 cleanup:
830 for (i = 0; i < (int) entry->array_len; i++)
831 wpabuf_free(entry->binarray_value[i]);
832 os_free(entry->binarray_value);
833 entry->array_len = 0;
834 entry->binarray_value = NULL;
835 return FALSE;
836 }
837
838
_wpa_dbus_dict_entry_get_array(DBusMessageIter * iter_dict_val,struct wpa_dbus_dict_entry * entry)839 static dbus_bool_t _wpa_dbus_dict_entry_get_array(
840 DBusMessageIter *iter_dict_val, struct wpa_dbus_dict_entry *entry)
841 {
842 int array_type = dbus_message_iter_get_element_type(iter_dict_val);
843 dbus_bool_t success = FALSE;
844 DBusMessageIter iter_array;
845
846 wpa_printf(MSG_MSGDUMP, "%s: array_type %c", __func__, array_type);
847
848 dbus_message_iter_recurse(iter_dict_val, &iter_array);
849
850 switch (array_type) {
851 case DBUS_TYPE_BYTE:
852 success = _wpa_dbus_dict_entry_get_byte_array(&iter_array,
853 entry);
854 break;
855 case DBUS_TYPE_STRING:
856 success = _wpa_dbus_dict_entry_get_string_array(&iter_array,
857 array_type,
858 entry);
859 break;
860 case DBUS_TYPE_ARRAY:
861 success = _wpa_dbus_dict_entry_get_binarray(&iter_array, entry);
862 break;
863 default:
864 wpa_printf(MSG_MSGDUMP, "%s: unsupported array type %c",
865 __func__, array_type);
866 break;
867 }
868
869 return success;
870 }
871
872
_wpa_dbus_dict_fill_value_from_variant(struct wpa_dbus_dict_entry * entry,DBusMessageIter * iter)873 static dbus_bool_t _wpa_dbus_dict_fill_value_from_variant(
874 struct wpa_dbus_dict_entry *entry, DBusMessageIter *iter)
875 {
876 const char *v;
877
878 switch (entry->type) {
879 case DBUS_TYPE_OBJECT_PATH:
880 dbus_message_iter_get_basic(iter, &v);
881 wpa_printf(MSG_MSGDUMP, "%s: object path value: %s",
882 __func__, v);
883 entry->str_value = os_strdup(v);
884 if (entry->str_value == NULL)
885 return FALSE;
886 break;
887 case DBUS_TYPE_STRING:
888 dbus_message_iter_get_basic(iter, &v);
889 wpa_printf(MSG_MSGDUMP, "%s: string value: %s",
890 __func__, wpa_debug_show_keys ? v : "[omitted]");
891 entry->str_value = os_strdup(v);
892 if (entry->str_value == NULL)
893 return FALSE;
894 break;
895 case DBUS_TYPE_BOOLEAN:
896 dbus_message_iter_get_basic(iter, &entry->bool_value);
897 wpa_printf(MSG_MSGDUMP, "%s: boolean value: %d",
898 __func__, entry->bool_value);
899 break;
900 case DBUS_TYPE_BYTE:
901 dbus_message_iter_get_basic(iter, &entry->byte_value);
902 wpa_printf(MSG_MSGDUMP, "%s: byte value: %d",
903 __func__, entry->byte_value);
904 break;
905 case DBUS_TYPE_INT16:
906 dbus_message_iter_get_basic(iter, &entry->int16_value);
907 wpa_printf(MSG_MSGDUMP, "%s: int16 value: %d",
908 __func__, entry->int16_value);
909 break;
910 case DBUS_TYPE_UINT16:
911 dbus_message_iter_get_basic(iter, &entry->uint16_value);
912 wpa_printf(MSG_MSGDUMP, "%s: uint16 value: %d",
913 __func__, entry->uint16_value);
914 break;
915 case DBUS_TYPE_INT32:
916 dbus_message_iter_get_basic(iter, &entry->int32_value);
917 wpa_printf(MSG_MSGDUMP, "%s: int32 value: %d",
918 __func__, entry->int32_value);
919 break;
920 case DBUS_TYPE_UINT32:
921 dbus_message_iter_get_basic(iter, &entry->uint32_value);
922 wpa_printf(MSG_MSGDUMP, "%s: uint32 value: %d",
923 __func__, entry->uint32_value);
924 break;
925 case DBUS_TYPE_INT64:
926 dbus_message_iter_get_basic(iter, &entry->int64_value);
927 wpa_printf(MSG_MSGDUMP, "%s: int64 value: %lld",
928 __func__, (long long int) entry->int64_value);
929 break;
930 case DBUS_TYPE_UINT64:
931 dbus_message_iter_get_basic(iter, &entry->uint64_value);
932 wpa_printf(MSG_MSGDUMP, "%s: uint64 value: %llu",
933 __func__,
934 (unsigned long long int) entry->uint64_value);
935 break;
936 case DBUS_TYPE_DOUBLE:
937 dbus_message_iter_get_basic(iter, &entry->double_value);
938 wpa_printf(MSG_MSGDUMP, "%s: double value: %f",
939 __func__, entry->double_value);
940 break;
941 case DBUS_TYPE_ARRAY:
942 return _wpa_dbus_dict_entry_get_array(iter, entry);
943 default:
944 wpa_printf(MSG_MSGDUMP, "%s: unsupported type %c",
945 __func__, entry->type);
946 return FALSE;
947 }
948
949 return TRUE;
950 }
951
952
953 /**
954 * Read the current key/value entry from the dict. Entries are dynamically
955 * allocated when needed and must be freed after use with the
956 * wpa_dbus_dict_entry_clear() function.
957 *
958 * The returned entry object will be filled with the type and value of the next
959 * entry in the dict, or the type will be DBUS_TYPE_INVALID if an error
960 * occurred.
961 *
962 * @param iter_dict A valid DBusMessageIter returned from
963 * wpa_dbus_dict_open_read()
964 * @param entry A valid dict entry object into which the dict key and value
965 * will be placed
966 * @return TRUE on success, FALSE on failure
967 *
968 */
wpa_dbus_dict_get_entry(DBusMessageIter * iter_dict,struct wpa_dbus_dict_entry * entry)969 dbus_bool_t wpa_dbus_dict_get_entry(DBusMessageIter *iter_dict,
970 struct wpa_dbus_dict_entry * entry)
971 {
972 DBusMessageIter iter_dict_entry, iter_dict_val;
973 int type;
974 const char *key;
975
976 if (!iter_dict || !entry ||
977 dbus_message_iter_get_arg_type(iter_dict) != DBUS_TYPE_DICT_ENTRY) {
978 wpa_printf(MSG_DEBUG, "%s: not a dict entry", __func__);
979 goto error;
980 }
981
982 dbus_message_iter_recurse(iter_dict, &iter_dict_entry);
983 dbus_message_iter_get_basic(&iter_dict_entry, &key);
984 wpa_printf(MSG_MSGDUMP, "%s: dict entry key: %s", __func__, key);
985 entry->key = key;
986
987 if (!dbus_message_iter_next(&iter_dict_entry)) {
988 wpa_printf(MSG_DEBUG, "%s: no variant in dict entry", __func__);
989 goto error;
990 }
991 type = dbus_message_iter_get_arg_type(&iter_dict_entry);
992 if (type != DBUS_TYPE_VARIANT) {
993 wpa_printf(MSG_DEBUG,
994 "%s: unexpected dict entry variant type: %c",
995 __func__, type);
996 goto error;
997 }
998
999 dbus_message_iter_recurse(&iter_dict_entry, &iter_dict_val);
1000 entry->type = dbus_message_iter_get_arg_type(&iter_dict_val);
1001 wpa_printf(MSG_MSGDUMP, "%s: dict entry variant content type: %c",
1002 __func__, entry->type);
1003 entry->array_type = DBUS_TYPE_INVALID;
1004 if (!_wpa_dbus_dict_fill_value_from_variant(entry, &iter_dict_val)) {
1005 wpa_printf(MSG_DEBUG,
1006 "%s: failed to fetch dict values from variant",
1007 __func__);
1008 goto error;
1009 }
1010
1011 dbus_message_iter_next(iter_dict);
1012 return TRUE;
1013
1014 error:
1015 if (entry) {
1016 wpa_dbus_dict_entry_clear(entry);
1017 entry->type = DBUS_TYPE_INVALID;
1018 entry->array_type = DBUS_TYPE_INVALID;
1019 }
1020
1021 return FALSE;
1022 }
1023
1024
1025 /**
1026 * Return whether or not there are additional dictionary entries.
1027 *
1028 * @param iter_dict A valid DBusMessageIter returned from
1029 * wpa_dbus_dict_open_read()
1030 * @return TRUE if more dict entries exists, FALSE if no more dict entries
1031 * exist
1032 */
wpa_dbus_dict_has_dict_entry(DBusMessageIter * iter_dict)1033 dbus_bool_t wpa_dbus_dict_has_dict_entry(DBusMessageIter *iter_dict)
1034 {
1035 if (!iter_dict)
1036 return FALSE;
1037 return dbus_message_iter_get_arg_type(iter_dict) ==
1038 DBUS_TYPE_DICT_ENTRY;
1039 }
1040
1041
1042 /**
1043 * Free any memory used by the entry object.
1044 *
1045 * @param entry The entry object
1046 */
wpa_dbus_dict_entry_clear(struct wpa_dbus_dict_entry * entry)1047 void wpa_dbus_dict_entry_clear(struct wpa_dbus_dict_entry *entry)
1048 {
1049 unsigned int i;
1050
1051 if (!entry)
1052 return;
1053 switch (entry->type) {
1054 case DBUS_TYPE_OBJECT_PATH:
1055 case DBUS_TYPE_STRING:
1056 os_free(entry->str_value);
1057 break;
1058 case DBUS_TYPE_ARRAY:
1059 switch (entry->array_type) {
1060 case DBUS_TYPE_BYTE:
1061 os_free(entry->bytearray_value);
1062 break;
1063 case DBUS_TYPE_STRING:
1064 if (!entry->strarray_value)
1065 break;
1066 for (i = 0; i < entry->array_len; i++)
1067 os_free(entry->strarray_value[i]);
1068 os_free(entry->strarray_value);
1069 break;
1070 case WPAS_DBUS_TYPE_BINARRAY:
1071 for (i = 0; i < entry->array_len; i++)
1072 wpabuf_free(entry->binarray_value[i]);
1073 os_free(entry->binarray_value);
1074 break;
1075 }
1076 break;
1077 }
1078
1079 os_memset(entry, 0, sizeof(struct wpa_dbus_dict_entry));
1080 }
1081