2 * WPA Supplicant / dbus-based control interface
3 * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
10 #include <dbus/dbus.h>
14 #include "dbus_dict_helpers.h"
18 * Start a dict in a dbus message. Should be paired with a call to
19 * wpa_dbus_dict_close_write().
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
26 dbus_bool_t wpa_dbus_dict_open_write(DBusMessageIter *iter,
27 DBusMessageIter *iter_dict)
31 if (!iter || !iter_dict)
34 result = dbus_message_iter_open_container(
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,
47 * End a dict element in a dbus message. Should be paired with
48 * a call to wpa_dbus_dict_open_write().
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
57 dbus_bool_t wpa_dbus_dict_close_write(DBusMessageIter *iter,
58 DBusMessageIter *iter_dict)
60 if (!iter || !iter_dict)
63 return dbus_message_iter_close_container(iter, iter_dict);
67 const char * wpa_dbus_type_as_string(const int type)
71 return DBUS_TYPE_BYTE_AS_STRING;
72 case DBUS_TYPE_BOOLEAN:
73 return DBUS_TYPE_BOOLEAN_AS_STRING;
75 return DBUS_TYPE_INT16_AS_STRING;
76 case DBUS_TYPE_UINT16:
77 return DBUS_TYPE_UINT16_AS_STRING;
79 return DBUS_TYPE_INT32_AS_STRING;
80 case DBUS_TYPE_UINT32:
81 return DBUS_TYPE_UINT32_AS_STRING;
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;
93 return DBUS_TYPE_ARRAY_AS_STRING;
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)
104 if (!dbus_message_iter_open_container(iter_dict,
105 DBUS_TYPE_DICT_ENTRY, NULL,
109 return dbus_message_iter_append_basic(iter_dict_entry, DBUS_TYPE_STRING,
114 static dbus_bool_t _wpa_dbus_add_dict_entry_end(
115 DBusMessageIter *iter_dict, DBusMessageIter *iter_dict_entry,
116 DBusMessageIter *iter_dict_val)
118 if (!dbus_message_iter_close_container(iter_dict_entry, iter_dict_val))
121 return dbus_message_iter_close_container(iter_dict, iter_dict_entry);
125 static dbus_bool_t _wpa_dbus_add_dict_entry_basic(DBusMessageIter *iter_dict,
127 const int value_type,
130 DBusMessageIter iter_dict_entry, iter_dict_val;
131 const char *type_as_string = NULL;
136 type_as_string = wpa_dbus_type_as_string(value_type);
140 if (!_wpa_dbus_add_dict_entry_start(iter_dict, &iter_dict_entry,
142 !dbus_message_iter_open_container(&iter_dict_entry,
144 type_as_string, &iter_dict_val) ||
145 !dbus_message_iter_append_basic(&iter_dict_val, value_type, value))
148 return _wpa_dbus_add_dict_entry_end(iter_dict, &iter_dict_entry,
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)
157 DBusMessageIter iter_dict_entry, iter_dict_val, iter_array;
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,
164 DBUS_TYPE_ARRAY_AS_STRING
165 DBUS_TYPE_BYTE_AS_STRING,
167 !dbus_message_iter_open_container(&iter_dict_val, DBUS_TYPE_ARRAY,
168 DBUS_TYPE_BYTE_AS_STRING,
172 for (i = 0; i < value_len; i++) {
173 if (!dbus_message_iter_append_basic(&iter_array,
179 if (!dbus_message_iter_close_container(&iter_dict_val, &iter_array))
182 return _wpa_dbus_add_dict_entry_end(iter_dict, &iter_dict_entry,
188 * Add a string entry to the dict.
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
197 dbus_bool_t wpa_dbus_dict_append_string(DBusMessageIter *iter_dict,
198 const char *key, const char *value)
202 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_STRING,
208 * Add a byte entry to the dict.
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 byte value
214 * @return TRUE on success, FALSE on failure
217 dbus_bool_t wpa_dbus_dict_append_byte(DBusMessageIter *iter_dict,
218 const char *key, const char value)
220 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_BYTE,
226 * Add a boolean entry to the dict.
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 boolean value
232 * @return TRUE on success, FALSE on failure
235 dbus_bool_t wpa_dbus_dict_append_bool(DBusMessageIter *iter_dict,
236 const char *key, const dbus_bool_t value)
238 return _wpa_dbus_add_dict_entry_basic(iter_dict, key,
239 DBUS_TYPE_BOOLEAN, &value);
244 * Add a 16-bit signed integer entry to the dict.
246 * @param iter_dict A valid DBusMessageIter returned from
247 * wpa_dbus_dict_open_write()
248 * @param key The key of the dict item
249 * @param value The 16-bit signed integer value
250 * @return TRUE on success, FALSE on failure
253 dbus_bool_t wpa_dbus_dict_append_int16(DBusMessageIter *iter_dict,
255 const dbus_int16_t value)
257 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_INT16,
263 * Add a 16-bit unsigned integer entry to the dict.
265 * @param iter_dict A valid DBusMessageIter returned from
266 * wpa_dbus_dict_open_write()
267 * @param key The key of the dict item
268 * @param value The 16-bit unsigned integer value
269 * @return TRUE on success, FALSE on failure
272 dbus_bool_t wpa_dbus_dict_append_uint16(DBusMessageIter *iter_dict,
274 const dbus_uint16_t value)
276 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_UINT16,
282 * Add a 32-bit signed integer to the dict.
284 * @param iter_dict A valid DBusMessageIter returned from
285 * wpa_dbus_dict_open_write()
286 * @param key The key of the dict item
287 * @param value The 32-bit signed integer value
288 * @return TRUE on success, FALSE on failure
291 dbus_bool_t wpa_dbus_dict_append_int32(DBusMessageIter *iter_dict,
293 const dbus_int32_t value)
295 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_INT32,
301 * Add a 32-bit unsigned integer entry to the dict.
303 * @param iter_dict A valid DBusMessageIter returned from
304 * wpa_dbus_dict_open_write()
305 * @param key The key of the dict item
306 * @param value The 32-bit unsigned integer value
307 * @return TRUE on success, FALSE on failure
310 dbus_bool_t wpa_dbus_dict_append_uint32(DBusMessageIter *iter_dict,
312 const dbus_uint32_t value)
314 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_UINT32,
320 * Add a 64-bit integer entry to the dict.
322 * @param iter_dict A valid DBusMessageIter returned from
323 * wpa_dbus_dict_open_write()
324 * @param key The key of the dict item
325 * @param value The 64-bit integer value
326 * @return TRUE on success, FALSE on failure
329 dbus_bool_t wpa_dbus_dict_append_int64(DBusMessageIter *iter_dict,
331 const dbus_int64_t value)
333 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_INT64,
339 * Add a 64-bit unsigned integer entry to the dict.
341 * @param iter_dict A valid DBusMessageIter returned from
342 * wpa_dbus_dict_open_write()
343 * @param key The key of the dict item
344 * @param value The 64-bit unsigned integer value
345 * @return TRUE on success, FALSE on failure
348 dbus_bool_t wpa_dbus_dict_append_uint64(DBusMessageIter *iter_dict,
350 const dbus_uint64_t value)
352 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_UINT64,
358 * Add a double-precision floating point entry to the dict.
360 * @param iter_dict A valid DBusMessageIter returned from
361 * wpa_dbus_dict_open_write()
362 * @param key The key of the dict item
363 * @param value The double-precision floating point value
364 * @return TRUE on success, FALSE on failure
367 dbus_bool_t wpa_dbus_dict_append_double(DBusMessageIter *iter_dict,
368 const char *key, const double value)
370 return _wpa_dbus_add_dict_entry_basic(iter_dict, key, DBUS_TYPE_DOUBLE,
376 * Add a DBus object path entry to the dict.
378 * @param iter_dict A valid DBusMessageIter returned from
379 * wpa_dbus_dict_open_write()
380 * @param key The key of the dict item
381 * @param value The DBus object path value
382 * @return TRUE on success, FALSE on failure
385 dbus_bool_t wpa_dbus_dict_append_object_path(DBusMessageIter *iter_dict,
391 return _wpa_dbus_add_dict_entry_basic(iter_dict, key,
392 DBUS_TYPE_OBJECT_PATH, &value);
397 * Add a byte array entry to the dict.
399 * @param iter_dict A valid DBusMessageIter returned from
400 * wpa_dbus_dict_open_write()
401 * @param key The key of the dict item
402 * @param value The byte array
403 * @param value_len The length of the byte array, in bytes
404 * @return TRUE on success, FALSE on failure
407 dbus_bool_t wpa_dbus_dict_append_byte_array(DBusMessageIter *iter_dict,
410 const dbus_uint32_t value_len)
412 if (!key || (!value && value_len != 0))
414 return _wpa_dbus_add_dict_entry_byte_array(iter_dict, key, value,
420 * Begin an array entry in the dict
422 * @param iter_dict A valid DBusMessageIter returned from
423 * wpa_dbus_dict_open_write()
424 * @param key The key of the dict item
425 * @param type The type of the contained data
426 * @param iter_dict_entry A private DBusMessageIter provided by the caller to
427 * be passed to wpa_dbus_dict_end_string_array()
428 * @param iter_dict_val A private DBusMessageIter provided by the caller to
429 * be passed to wpa_dbus_dict_end_string_array()
430 * @param iter_array On return, the DBusMessageIter to be passed to
431 * wpa_dbus_dict_string_array_add_element()
432 * @return TRUE on success, FALSE on failure
435 dbus_bool_t wpa_dbus_dict_begin_array(DBusMessageIter *iter_dict,
436 const char *key, const char *type,
437 DBusMessageIter *iter_dict_entry,
438 DBusMessageIter *iter_dict_val,
439 DBusMessageIter *iter_array)
444 err = os_snprintf(array_type, sizeof(array_type),
445 DBUS_TYPE_ARRAY_AS_STRING "%s",
447 if (os_snprintf_error(sizeof(array_type), err))
450 if (!iter_dict || !iter_dict_entry || !iter_dict_val || !iter_array ||
451 !_wpa_dbus_add_dict_entry_start(iter_dict, iter_dict_entry,
452 key, DBUS_TYPE_ARRAY) ||
453 !dbus_message_iter_open_container(iter_dict_entry,
459 return dbus_message_iter_open_container(iter_dict_val, DBUS_TYPE_ARRAY,
464 dbus_bool_t wpa_dbus_dict_begin_string_array(DBusMessageIter *iter_dict,
466 DBusMessageIter *iter_dict_entry,
467 DBusMessageIter *iter_dict_val,
468 DBusMessageIter *iter_array)
470 return wpa_dbus_dict_begin_array(
472 DBUS_TYPE_STRING_AS_STRING,
473 iter_dict_entry, iter_dict_val, iter_array);
478 * Add a single string element to a string array dict entry
480 * @param iter_array A valid DBusMessageIter returned from
481 * wpa_dbus_dict_begin_string_array()'s
482 * iter_array parameter
483 * @param elem The string element to be added to the dict entry's string array
484 * @return TRUE on success, FALSE on failure
487 dbus_bool_t wpa_dbus_dict_string_array_add_element(DBusMessageIter *iter_array,
490 if (!iter_array || !elem)
493 return dbus_message_iter_append_basic(iter_array, DBUS_TYPE_STRING,
499 * Add a single byte array element to a string array dict entry
501 * @param iter_array A valid DBusMessageIter returned from
502 * wpa_dbus_dict_begin_array()'s iter_array
503 * parameter -- note that wpa_dbus_dict_begin_array()
504 * must have been called with "ay" as the type
505 * @param value The data to be added to the dict entry's array
506 * @param value_len The length of the data
507 * @return TRUE on success, FALSE on failure
510 dbus_bool_t wpa_dbus_dict_bin_array_add_element(DBusMessageIter *iter_array,
514 DBusMessageIter iter_bytes;
517 if (!iter_array || !value ||
518 !dbus_message_iter_open_container(iter_array, DBUS_TYPE_ARRAY,
519 DBUS_TYPE_BYTE_AS_STRING,
523 for (i = 0; i < value_len; i++) {
524 if (!dbus_message_iter_append_basic(&iter_bytes,
530 return dbus_message_iter_close_container(iter_array, &iter_bytes);
535 * End an array dict entry
537 * @param iter_dict A valid DBusMessageIter returned from
538 * wpa_dbus_dict_open_write()
539 * @param iter_dict_entry A private DBusMessageIter returned from
540 * wpa_dbus_dict_begin_string_array() or
541 * wpa_dbus_dict_begin_array()
542 * @param iter_dict_val A private DBusMessageIter returned from
543 * wpa_dbus_dict_begin_string_array() or
544 * wpa_dbus_dict_begin_array()
545 * @param iter_array A DBusMessageIter returned from
546 * wpa_dbus_dict_begin_string_array() or
547 * wpa_dbus_dict_begin_array()
548 * @return TRUE on success, FALSE on failure
551 dbus_bool_t wpa_dbus_dict_end_array(DBusMessageIter *iter_dict,
552 DBusMessageIter *iter_dict_entry,
553 DBusMessageIter *iter_dict_val,
554 DBusMessageIter *iter_array)
556 if (!iter_dict || !iter_dict_entry || !iter_dict_val || !iter_array ||
557 !dbus_message_iter_close_container(iter_dict_val, iter_array))
560 return _wpa_dbus_add_dict_entry_end(iter_dict, iter_dict_entry,
566 * Convenience function to add an entire string array to the dict.
568 * @param iter_dict A valid DBusMessageIter returned from
569 * wpa_dbus_dict_open_write()
570 * @param key The key of the dict item
571 * @param items The array of strings
572 * @param num_items The number of strings in the array
573 * @return TRUE on success, FALSE on failure
576 dbus_bool_t wpa_dbus_dict_append_string_array(DBusMessageIter *iter_dict,
579 const dbus_uint32_t num_items)
581 DBusMessageIter iter_dict_entry, iter_dict_val, iter_array;
584 if (!key || (!items && num_items != 0) ||
585 !wpa_dbus_dict_begin_string_array(iter_dict, key,
586 &iter_dict_entry, &iter_dict_val,
590 for (i = 0; i < num_items; i++) {
591 if (!wpa_dbus_dict_string_array_add_element(&iter_array,
596 return wpa_dbus_dict_end_string_array(iter_dict, &iter_dict_entry,
597 &iter_dict_val, &iter_array);
602 * Convenience function to add an wpabuf binary array to the dict.
604 * @param iter_dict A valid DBusMessageIter returned from
605 * wpa_dbus_dict_open_write()
606 * @param key The key of the dict item
607 * @param items The array of wpabuf structures
608 * @param num_items The number of strings in the array
609 * @return TRUE on success, FALSE on failure
612 dbus_bool_t wpa_dbus_dict_append_wpabuf_array(DBusMessageIter *iter_dict,
614 const struct wpabuf **items,
615 const dbus_uint32_t num_items)
617 DBusMessageIter iter_dict_entry, iter_dict_val, iter_array;
621 (!items && num_items != 0) ||
622 !wpa_dbus_dict_begin_array(iter_dict, key,
623 DBUS_TYPE_ARRAY_AS_STRING
624 DBUS_TYPE_BYTE_AS_STRING,
625 &iter_dict_entry, &iter_dict_val,
629 for (i = 0; i < num_items; i++) {
630 if (!wpa_dbus_dict_bin_array_add_element(&iter_array,
631 wpabuf_head(items[i]),
632 wpabuf_len(items[i])))
636 return wpa_dbus_dict_end_array(iter_dict, &iter_dict_entry,
637 &iter_dict_val, &iter_array);
641 /*****************************************************/
642 /* Stuff for reading dicts */
643 /*****************************************************/
646 * Start reading from a dbus dict.
648 * @param iter A valid DBusMessageIter pointing to the start of the dict
649 * @param iter_dict (out) A DBusMessageIter to be passed to
650 * wpa_dbus_dict_read_next_entry()
651 * @error on failure a descriptive error
652 * @return TRUE on success, FALSE on failure
655 dbus_bool_t wpa_dbus_dict_open_read(DBusMessageIter *iter,
656 DBusMessageIter *iter_dict,
661 wpa_printf(MSG_MSGDUMP, "%s: start reading a dict entry", __func__);
662 if (!iter || !iter_dict) {
663 dbus_set_error_const(error, DBUS_ERROR_FAILED,
664 "[internal] missing message iterators");
668 type = dbus_message_iter_get_arg_type(iter);
669 if (type != DBUS_TYPE_ARRAY ||
670 dbus_message_iter_get_element_type(iter) != DBUS_TYPE_DICT_ENTRY) {
671 wpa_printf(MSG_DEBUG,
672 "%s: unexpected message argument types (arg=%c element=%c)",
674 type != DBUS_TYPE_ARRAY ? '?' :
675 dbus_message_iter_get_element_type(iter));
676 dbus_set_error_const(error, DBUS_ERROR_INVALID_ARGS,
677 "unexpected message argument types");
681 dbus_message_iter_recurse(iter, iter_dict);
686 #define BYTE_ARRAY_CHUNK_SIZE 34
687 #define BYTE_ARRAY_ITEM_SIZE (sizeof(char))
689 static dbus_bool_t _wpa_dbus_dict_entry_get_byte_array(
690 DBusMessageIter *iter, struct wpa_dbus_dict_entry *entry)
692 dbus_uint32_t count = 0;
693 dbus_bool_t success = FALSE;
694 char *buffer, *nbuffer;
696 entry->bytearray_value = NULL;
697 entry->array_type = DBUS_TYPE_BYTE;
699 buffer = os_calloc(BYTE_ARRAY_CHUNK_SIZE, BYTE_ARRAY_ITEM_SIZE);
703 entry->bytearray_value = buffer;
704 entry->array_len = 0;
705 while (dbus_message_iter_get_arg_type(iter) == DBUS_TYPE_BYTE) {
708 if ((count % BYTE_ARRAY_CHUNK_SIZE) == 0 && count != 0) {
709 nbuffer = os_realloc_array(
710 buffer, count + BYTE_ARRAY_CHUNK_SIZE,
711 BYTE_ARRAY_ITEM_SIZE);
712 if (nbuffer == NULL) {
714 wpa_printf(MSG_ERROR, "dbus: _wpa_dbus_dict_"
715 "entry_get_byte_array out of "
716 "memory trying to retrieve the "
722 entry->bytearray_value = buffer;
724 dbus_message_iter_get_basic(iter, &byte);
725 entry->bytearray_value[count] = byte;
726 entry->array_len = ++count;
727 dbus_message_iter_next(iter);
729 wpa_hexdump_key(MSG_MSGDUMP, "dbus: byte array contents",
730 entry->bytearray_value, entry->array_len);
732 /* Zero-length arrays are valid. */
733 if (entry->array_len == 0) {
734 os_free(entry->bytearray_value);
735 entry->bytearray_value = NULL;
745 #define STR_ARRAY_CHUNK_SIZE 8
746 #define STR_ARRAY_ITEM_SIZE (sizeof(char *))
748 static dbus_bool_t _wpa_dbus_dict_entry_get_string_array(
749 DBusMessageIter *iter, int array_type,
750 struct wpa_dbus_dict_entry *entry)
752 dbus_uint32_t count = 0;
753 dbus_bool_t success = FALSE;
754 char **buffer, **nbuffer;
756 entry->strarray_value = NULL;
757 entry->array_type = DBUS_TYPE_STRING;
759 buffer = os_calloc(STR_ARRAY_CHUNK_SIZE, STR_ARRAY_ITEM_SIZE);
763 entry->strarray_value = buffer;
764 entry->array_len = 0;
765 while (dbus_message_iter_get_arg_type(iter) == DBUS_TYPE_STRING) {
769 if ((count % STR_ARRAY_CHUNK_SIZE) == 0 && count != 0) {
770 nbuffer = os_realloc_array(
771 buffer, count + STR_ARRAY_CHUNK_SIZE,
772 STR_ARRAY_ITEM_SIZE);
773 if (nbuffer == NULL) {
775 wpa_printf(MSG_ERROR, "dbus: _wpa_dbus_dict_"
776 "entry_get_string_array out of "
777 "memory trying to retrieve the "
783 entry->strarray_value = buffer;
785 dbus_message_iter_get_basic(iter, &value);
786 wpa_printf(MSG_MSGDUMP, "%s: string_array value: %s",
787 __func__, wpa_debug_show_keys ? value : "[omitted]");
788 str = os_strdup(value);
790 wpa_printf(MSG_ERROR, "dbus: _wpa_dbus_dict_entry_get_"
791 "string_array out of memory trying to "
792 "duplicate the string array");
795 entry->strarray_value[count] = str;
796 entry->array_len = ++count;
797 dbus_message_iter_next(iter);
799 wpa_printf(MSG_MSGDUMP, "%s: string_array length %u",
800 __func__, entry->array_len);
802 /* Zero-length arrays are valid. */
803 if (entry->array_len == 0) {
804 os_free(entry->strarray_value);
805 entry->strarray_value = NULL;
815 #define BIN_ARRAY_CHUNK_SIZE 10
816 #define BIN_ARRAY_ITEM_SIZE (sizeof(struct wpabuf *))
818 static dbus_bool_t _wpa_dbus_dict_entry_get_binarray(
819 DBusMessageIter *iter, struct wpa_dbus_dict_entry *entry)
821 struct wpa_dbus_dict_entry tmpentry;
825 entry->array_type = WPAS_DBUS_TYPE_BINARRAY;
826 entry->array_len = 0;
827 entry->binarray_value = NULL;
829 type = dbus_message_iter_get_arg_type(iter);
830 wpa_printf(MSG_MSGDUMP, "%s: parsing binarray type %c", __func__, type);
831 if (type == DBUS_TYPE_INVALID) {
832 /* Likely an empty array of arrays */
835 if (type != DBUS_TYPE_ARRAY) {
836 wpa_printf(MSG_DEBUG, "%s: not an array type: %c",
841 type = dbus_message_iter_get_element_type(iter);
842 if (type != DBUS_TYPE_BYTE) {
843 wpa_printf(MSG_DEBUG, "%s: unexpected element type %c",
848 while (dbus_message_iter_get_arg_type(iter) == DBUS_TYPE_ARRAY) {
849 DBusMessageIter iter_array;
851 if (entry->array_len == buflen) {
852 struct wpabuf **newbuf;
854 buflen += BIN_ARRAY_CHUNK_SIZE;
856 newbuf = os_realloc_array(entry->binarray_value,
857 buflen, BIN_ARRAY_ITEM_SIZE);
860 entry->binarray_value = newbuf;
863 dbus_message_iter_recurse(iter, &iter_array);
864 os_memset(&tmpentry, 0, sizeof(tmpentry));
865 tmpentry.type = DBUS_TYPE_ARRAY;
866 if (_wpa_dbus_dict_entry_get_byte_array(&iter_array, &tmpentry)
870 entry->binarray_value[entry->array_len] =
871 wpabuf_alloc_ext_data((u8 *) tmpentry.bytearray_value,
873 if (entry->binarray_value[entry->array_len] == NULL) {
874 wpa_dbus_dict_entry_clear(&tmpentry);
878 dbus_message_iter_next(iter);
880 wpa_printf(MSG_MSGDUMP, "%s: binarray length %u",
881 __func__, entry->array_len);
886 for (i = 0; i < (int) entry->array_len; i++)
887 wpabuf_free(entry->binarray_value[i]);
888 os_free(entry->binarray_value);
889 entry->array_len = 0;
890 entry->binarray_value = NULL;
895 static dbus_bool_t _wpa_dbus_dict_entry_get_array(
896 DBusMessageIter *iter_dict_val, struct wpa_dbus_dict_entry *entry)
898 int array_type = dbus_message_iter_get_element_type(iter_dict_val);
899 dbus_bool_t success = FALSE;
900 DBusMessageIter iter_array;
902 wpa_printf(MSG_MSGDUMP, "%s: array_type %c", __func__, array_type);
904 dbus_message_iter_recurse(iter_dict_val, &iter_array);
906 switch (array_type) {
908 success = _wpa_dbus_dict_entry_get_byte_array(&iter_array,
911 case DBUS_TYPE_STRING:
912 success = _wpa_dbus_dict_entry_get_string_array(&iter_array,
916 case DBUS_TYPE_ARRAY:
917 success = _wpa_dbus_dict_entry_get_binarray(&iter_array, entry);
920 wpa_printf(MSG_MSGDUMP, "%s: unsupported array type %c",
921 __func__, array_type);
929 static dbus_bool_t _wpa_dbus_dict_fill_value_from_variant(
930 struct wpa_dbus_dict_entry *entry, DBusMessageIter *iter)
934 switch (entry->type) {
935 case DBUS_TYPE_OBJECT_PATH:
936 dbus_message_iter_get_basic(iter, &v);
937 wpa_printf(MSG_MSGDUMP, "%s: object path value: %s",
939 entry->str_value = os_strdup(v);
940 if (entry->str_value == NULL)
943 case DBUS_TYPE_STRING:
944 dbus_message_iter_get_basic(iter, &v);
945 wpa_printf(MSG_MSGDUMP, "%s: string value: %s",
946 __func__, wpa_debug_show_keys ? v : "[omitted]");
947 entry->str_value = os_strdup(v);
948 if (entry->str_value == NULL)
951 case DBUS_TYPE_BOOLEAN:
952 dbus_message_iter_get_basic(iter, &entry->bool_value);
953 wpa_printf(MSG_MSGDUMP, "%s: boolean value: %d",
954 __func__, entry->bool_value);
957 dbus_message_iter_get_basic(iter, &entry->byte_value);
958 wpa_printf(MSG_MSGDUMP, "%s: byte value: %d",
959 __func__, entry->byte_value);
961 case DBUS_TYPE_INT16:
962 dbus_message_iter_get_basic(iter, &entry->int16_value);
963 wpa_printf(MSG_MSGDUMP, "%s: int16 value: %d",
964 __func__, entry->int16_value);
966 case DBUS_TYPE_UINT16:
967 dbus_message_iter_get_basic(iter, &entry->uint16_value);
968 wpa_printf(MSG_MSGDUMP, "%s: uint16 value: %d",
969 __func__, entry->uint16_value);
971 case DBUS_TYPE_INT32:
972 dbus_message_iter_get_basic(iter, &entry->int32_value);
973 wpa_printf(MSG_MSGDUMP, "%s: int32 value: %d",
974 __func__, entry->int32_value);
976 case DBUS_TYPE_UINT32:
977 dbus_message_iter_get_basic(iter, &entry->uint32_value);
978 wpa_printf(MSG_MSGDUMP, "%s: uint32 value: %d",
979 __func__, entry->uint32_value);
981 case DBUS_TYPE_INT64:
982 dbus_message_iter_get_basic(iter, &entry->int64_value);
983 wpa_printf(MSG_MSGDUMP, "%s: int64 value: %lld",
984 __func__, (long long int) entry->int64_value);
986 case DBUS_TYPE_UINT64:
987 dbus_message_iter_get_basic(iter, &entry->uint64_value);
988 wpa_printf(MSG_MSGDUMP, "%s: uint64 value: %llu",
990 (unsigned long long int) entry->uint64_value);
992 case DBUS_TYPE_DOUBLE:
993 dbus_message_iter_get_basic(iter, &entry->double_value);
994 wpa_printf(MSG_MSGDUMP, "%s: double value: %f",
995 __func__, entry->double_value);
997 case DBUS_TYPE_ARRAY:
998 return _wpa_dbus_dict_entry_get_array(iter, entry);
1000 wpa_printf(MSG_MSGDUMP, "%s: unsupported type %c",
1001 __func__, entry->type);
1010 * Read the current key/value entry from the dict. Entries are dynamically
1011 * allocated when needed and must be freed after use with the
1012 * wpa_dbus_dict_entry_clear() function.
1014 * The returned entry object will be filled with the type and value of the next
1015 * entry in the dict, or the type will be DBUS_TYPE_INVALID if an error
1018 * @param iter_dict A valid DBusMessageIter returned from
1019 * wpa_dbus_dict_open_read()
1020 * @param entry A valid dict entry object into which the dict key and value
1022 * @return TRUE on success, FALSE on failure
1025 dbus_bool_t wpa_dbus_dict_get_entry(DBusMessageIter *iter_dict,
1026 struct wpa_dbus_dict_entry * entry)
1028 DBusMessageIter iter_dict_entry, iter_dict_val;
1032 if (!iter_dict || !entry ||
1033 dbus_message_iter_get_arg_type(iter_dict) != DBUS_TYPE_DICT_ENTRY) {
1034 wpa_printf(MSG_DEBUG, "%s: not a dict entry", __func__);
1038 dbus_message_iter_recurse(iter_dict, &iter_dict_entry);
1039 dbus_message_iter_get_basic(&iter_dict_entry, &key);
1040 wpa_printf(MSG_MSGDUMP, "%s: dict entry key: %s", __func__, key);
1043 if (!dbus_message_iter_next(&iter_dict_entry)) {
1044 wpa_printf(MSG_DEBUG, "%s: no variant in dict entry", __func__);
1047 type = dbus_message_iter_get_arg_type(&iter_dict_entry);
1048 if (type != DBUS_TYPE_VARIANT) {
1049 wpa_printf(MSG_DEBUG,
1050 "%s: unexpected dict entry variant type: %c",
1055 dbus_message_iter_recurse(&iter_dict_entry, &iter_dict_val);
1056 entry->type = dbus_message_iter_get_arg_type(&iter_dict_val);
1057 wpa_printf(MSG_MSGDUMP, "%s: dict entry variant content type: %c",
1058 __func__, entry->type);
1059 entry->array_type = DBUS_TYPE_INVALID;
1060 if (!_wpa_dbus_dict_fill_value_from_variant(entry, &iter_dict_val)) {
1061 wpa_printf(MSG_DEBUG,
1062 "%s: failed to fetch dict values from variant",
1067 dbus_message_iter_next(iter_dict);
1072 wpa_dbus_dict_entry_clear(entry);
1073 entry->type = DBUS_TYPE_INVALID;
1074 entry->array_type = DBUS_TYPE_INVALID;
1082 * Return whether or not there are additional dictionary entries.
1084 * @param iter_dict A valid DBusMessageIter returned from
1085 * wpa_dbus_dict_open_read()
1086 * @return TRUE if more dict entries exists, FALSE if no more dict entries
1089 dbus_bool_t wpa_dbus_dict_has_dict_entry(DBusMessageIter *iter_dict)
1093 return dbus_message_iter_get_arg_type(iter_dict) ==
1094 DBUS_TYPE_DICT_ENTRY;
1099 * Free any memory used by the entry object.
1101 * @param entry The entry object
1103 void wpa_dbus_dict_entry_clear(struct wpa_dbus_dict_entry *entry)
1109 switch (entry->type) {
1110 case DBUS_TYPE_OBJECT_PATH:
1111 case DBUS_TYPE_STRING:
1112 os_free(entry->str_value);
1114 case DBUS_TYPE_ARRAY:
1115 switch (entry->array_type) {
1116 case DBUS_TYPE_BYTE:
1117 os_free(entry->bytearray_value);
1119 case DBUS_TYPE_STRING:
1120 for (i = 0; i < entry->array_len; i++)
1121 os_free(entry->strarray_value[i]);
1122 os_free(entry->strarray_value);
1124 case WPAS_DBUS_TYPE_BINARRAY:
1125 for (i = 0; i < entry->array_len; i++)
1126 wpabuf_free(entry->binarray_value[i]);
1127 os_free(entry->binarray_value);
1133 os_memset(entry, 0, sizeof(struct wpa_dbus_dict_entry));