Add support for GDBus security action and flags
[framework/connectivity/connman.git] / gdbus / object.c
1 /*
2  *
3  *  D-Bus helper library
4  *
5  *  Copyright (C) 2004-2010  Marcel Holtmann <marcel@holtmann.org>
6  *
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21  *
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <stdio.h>
29 #include <string.h>
30
31 #include <glib.h>
32 #include <dbus/dbus.h>
33
34 #include "gdbus.h"
35
36 #define info(fmt...)
37 #define error(fmt...)
38 #define debug(fmt...)
39
40 struct generic_data {
41         unsigned int refcount;
42         GSList *interfaces;
43         char *introspect;
44 };
45
46 struct interface_data {
47         char *name;
48         const GDBusMethodTable *methods;
49         const GDBusSignalTable *signals;
50         const GDBusPropertyTable *properties;
51         void *user_data;
52         GDBusDestroyFunction destroy;
53 };
54
55 struct security_data {
56         GDBusPendingReply pending;
57         DBusMessage *message;
58         const GDBusMethodTable *method;
59         void *iface_user_data;
60 };
61
62 static void print_arguments(GString *gstr, const char *sig,
63                                                 const char *direction)
64 {
65         int i;
66
67         for (i = 0; sig[i]; i++) {
68                 char type[32];
69                 int struct_level, dict_level;
70                 unsigned int len;
71                 gboolean complete;
72
73                 complete = FALSE;
74                 struct_level = dict_level = 0;
75                 memset(type, 0, sizeof(type));
76
77                 /* Gather enough data to have a single complete type */
78                 for (len = 0; len < (sizeof(type) - 1) && sig[i]; len++, i++) {
79                         switch (sig[i]){
80                         case '(':
81                                 struct_level++;
82                                 break;
83                         case ')':
84                                 struct_level--;
85                                 if (struct_level <= 0 && dict_level <= 0)
86                                         complete = TRUE;
87                                 break;
88                         case '{':
89                                 dict_level++;
90                                 break;
91                         case '}':
92                                 dict_level--;
93                                 if (struct_level <= 0 && dict_level <= 0)
94                                         complete = TRUE;
95                                 break;
96                         case 'a':
97                                 break;
98                         default:
99                                 if (struct_level <= 0 && dict_level <= 0)
100                                         complete = TRUE;
101                                 break;
102                         }
103
104                         type[len] = sig[i];
105
106                         if (complete)
107                                 break;
108                 }
109
110
111                 if (direction)
112                         g_string_append_printf(gstr,
113                                         "\t\t\t<arg type=\"%s\" direction=\"%s\"/>\n",
114                                         type, direction);
115                 else
116                         g_string_append_printf(gstr,
117                                         "\t\t\t<arg type=\"%s\"/>\n",
118                                         type);
119         }
120 }
121
122 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
123 {
124         const GDBusMethodTable *method;
125         const GDBusSignalTable *signal;
126
127         for (method = iface->methods; method && method->name; method++) {
128                 if (!strlen(method->signature) && !strlen(method->reply))
129                         g_string_append_printf(gstr, "\t\t<method name=\"%s\"/>\n",
130                                                                 method->name);
131                 else {
132                         g_string_append_printf(gstr, "\t\t<method name=\"%s\">\n",
133                                                                 method->name);
134                         print_arguments(gstr, method->signature, "in");
135                         print_arguments(gstr, method->reply, "out");
136                         g_string_append_printf(gstr, "\t\t</method>\n");
137                 }
138         }
139
140         for (signal = iface->signals; signal && signal->name; signal++) {
141                 if (!strlen(signal->signature))
142                         g_string_append_printf(gstr, "\t\t<signal name=\"%s\"/>\n",
143                                                                 signal->name);
144                 else {
145                         g_string_append_printf(gstr, "\t\t<signal name=\"%s\">\n",
146                                                                 signal->name);
147                         print_arguments(gstr, signal->signature, NULL);
148                         g_string_append_printf(gstr, "\t\t</signal>\n");
149                 }
150         }
151 }
152
153 static void generate_introspection_xml(DBusConnection *conn,
154                                 struct generic_data *data, const char *path)
155 {
156         GSList *list;
157         GString *gstr;
158         char **children;
159         int i;
160
161         g_free(data->introspect);
162
163         gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
164
165         g_string_append_printf(gstr, "<node name=\"%s\">\n", path);
166
167         for (list = data->interfaces; list; list = list->next) {
168                 struct interface_data *iface = list->data;
169
170                 g_string_append_printf(gstr, "\t<interface name=\"%s\">\n",
171                                                                 iface->name);
172
173                 generate_interface_xml(gstr, iface);
174
175                 g_string_append_printf(gstr, "\t</interface>\n");
176         }
177
178         if (!dbus_connection_list_registered(conn, path, &children))
179                 goto done;
180
181         for (i = 0; children[i]; i++)
182                 g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n",
183                                                                 children[i]);
184
185         dbus_free_string_array(children);
186
187 done:
188         g_string_append_printf(gstr, "</node>\n");
189
190         data->introspect = g_string_free(gstr, FALSE);
191 }
192
193 static DBusMessage *introspect(DBusConnection *connection,
194                                 DBusMessage *message, void *user_data)
195 {
196         struct generic_data *data = user_data;
197         DBusMessage *reply;
198
199         if (!dbus_message_has_signature(message, DBUS_TYPE_INVALID_AS_STRING)) {
200                 error("Unexpected signature to introspect call");
201                 return NULL;
202         }
203
204         if (!data->introspect)
205                 generate_introspection_xml(connection, data,
206                                                 dbus_message_get_path(message));
207
208         reply = dbus_message_new_method_return(message);
209         if (!reply)
210                 return NULL;
211
212         dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
213                                         DBUS_TYPE_INVALID);
214
215         return reply;
216 }
217
218 static DBusHandlerResult process_message(DBusConnection *connection,
219                         DBusMessage *message, const GDBusMethodTable *method,
220                                                         void *iface_user_data)
221 {
222         DBusMessage *reply;
223
224         reply = method->function(connection, message, iface_user_data);
225
226         if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
227                 if (reply != NULL)
228                         dbus_message_unref(reply);
229                 return DBUS_HANDLER_RESULT_HANDLED;
230         }
231
232         if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
233                 if (reply == NULL)
234                         return DBUS_HANDLER_RESULT_HANDLED;
235         }
236
237         if (reply == NULL)
238                 return DBUS_HANDLER_RESULT_NEED_MEMORY;
239
240         dbus_connection_send(connection, reply, NULL);
241         dbus_message_unref(reply);
242
243         return DBUS_HANDLER_RESULT_HANDLED;
244 }
245
246 static GDBusPendingReply next_pending = 1;
247 static GSList *pending_security = NULL;
248
249 static const GDBusSecurityTable *security_table = NULL;
250
251 void g_dbus_pending_success(DBusConnection *connection,
252                                         GDBusPendingReply pending)
253 {
254         GSList *list;
255
256         for (list = pending_security; list; list = list->next) {
257                 struct security_data *secdata = list->data;
258                 DBusHandlerResult result;
259
260                 if (secdata->pending != pending)
261                         continue;
262
263                 pending_security = g_slist_remove(pending_security, secdata);
264
265                 result = process_message(connection, secdata->message,
266                                 secdata->method, secdata->iface_user_data);
267
268                 dbus_message_unref(secdata->message);
269                 g_free(secdata);
270                 return;
271         }
272 }
273
274 void g_dbus_pending_error_valist(DBusConnection *connection,
275                                 GDBusPendingReply pending, const char *name,
276                                         const char *format, va_list args)
277 {
278         GSList *list;
279
280         for (list = pending_security; list; list = list->next) {
281                 struct security_data *secdata = list->data;
282                 DBusMessage *reply;
283
284                 if (secdata->pending != pending)
285                         continue;
286
287                 pending_security = g_slist_remove(pending_security, secdata);
288
289                 reply = g_dbus_create_error_valist(secdata->message,
290                                                         name, format, args);
291                 if (reply != NULL) {
292                         dbus_connection_send(connection, reply, NULL);
293                         dbus_message_unref(reply);
294                 }
295
296                 dbus_message_unref(secdata->message);
297                 g_free(secdata);
298                 return;
299         }
300 }
301
302 void g_dbus_pending_error(DBusConnection *connection,
303                                 GDBusPendingReply pending,
304                                 const char *name, const char *format, ...)
305 {
306         va_list args;
307
308         va_start(args, format);
309
310         g_dbus_pending_error_valist(connection, pending, name, format, args);
311
312         va_end(args);
313 }
314
315 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
316                         const GDBusMethodTable *method, void *iface_user_data)
317 {
318         const GDBusSecurityTable *security;
319
320         for (security = security_table; security && security->privilege;
321                                                                 security++) {
322                 struct security_data *secdata;
323                 gboolean interaction;
324
325                 if (security->privilege != method->privilege)
326                         continue;
327
328                 secdata = g_new(struct security_data, 1);
329                 secdata->pending = next_pending++;
330                 secdata->message = dbus_message_ref(msg);
331                 secdata->method = method;
332                 secdata->iface_user_data = iface_user_data;
333
334                 pending_security = g_slist_prepend(pending_security, secdata);
335
336                 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
337                         interaction = TRUE;
338                 else
339                         interaction = FALSE;
340
341                 if (security->function)
342                         security->function(conn, security->action,
343                                                 interaction, secdata->pending);
344
345                 return TRUE;
346         }
347
348         return FALSE;
349 }
350
351 static void generic_unregister(DBusConnection *connection, void *user_data)
352 {
353         struct generic_data *data = user_data;
354
355         g_free(data->introspect);
356         g_free(data);
357 }
358
359 static struct interface_data *find_interface(GSList *interfaces,
360                                                 const char *name)
361 {
362         GSList *list;
363
364         if (!name)
365                 return NULL;
366
367         for (list = interfaces; list; list = list->next) {
368                 struct interface_data *iface = list->data;
369                 if (!strcmp(name, iface->name))
370                         return iface;
371         }
372
373         return NULL;
374 }
375
376 static DBusHandlerResult generic_message(DBusConnection *connection,
377                                         DBusMessage *message, void *user_data)
378 {
379         struct generic_data *data = user_data;
380         struct interface_data *iface;
381         const GDBusMethodTable *method;
382         const char *interface;
383
384         interface = dbus_message_get_interface(message);
385
386         iface = find_interface(data->interfaces, interface);
387         if (!iface)
388                 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
389
390         for (method = iface->methods; method &&
391                         method->name && method->function; method++) {
392                 if (dbus_message_is_method_call(message, iface->name,
393                                                         method->name) == FALSE)
394                         continue;
395
396                 if (dbus_message_has_signature(message,
397                                                 method->signature) == FALSE)
398                         continue;
399
400                 if (check_privilege(connection, message, method,
401                                                 iface->user_data) == TRUE)
402                         return DBUS_HANDLER_RESULT_HANDLED;
403
404                 return process_message(connection, message, method,
405                                                         iface->user_data);
406         }
407
408         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
409 }
410
411 static DBusObjectPathVTable generic_table = {
412         .unregister_function    = generic_unregister,
413         .message_function       = generic_message,
414 };
415
416 static void invalidate_parent_data(DBusConnection *conn, const char *child_path)
417 {
418         struct generic_data *data = NULL;
419         char *parent_path, *slash;
420
421         parent_path = g_strdup(child_path);
422         slash = strrchr(parent_path, '/');
423         if (!slash)
424                 goto done;
425
426         if (slash == parent_path && parent_path[1] != '\0')
427                 parent_path[1] = '\0';
428         else
429                 *slash = '\0';
430
431         if (!strlen(parent_path))
432                 goto done;
433
434         if (!dbus_connection_get_object_path_data(conn, parent_path,
435                                                         (void *) &data)) {
436                 invalidate_parent_data(conn, parent_path);
437                 goto done;
438         }
439
440         if (!data)
441                 goto done;
442
443         g_free(data->introspect);
444         data->introspect = NULL;
445
446 done:
447         g_free(parent_path);
448 }
449
450 static GDBusMethodTable introspect_methods[] = {
451         { "Introspect", "",     "s", introspect },
452         { }
453 };
454
455 static void add_interface(struct generic_data *data, const char *name,
456                                 const GDBusMethodTable *methods,
457                                 const GDBusSignalTable *signals,
458                                 const GDBusPropertyTable *properties,
459                                 void *user_data,
460                                 GDBusDestroyFunction destroy)
461 {
462         struct interface_data *iface;
463
464         iface = g_new0(struct interface_data, 1);
465         iface->name = g_strdup(name);
466         iface->methods = methods;
467         iface->signals = signals;
468         iface->properties = properties;
469         iface->user_data = user_data;
470         iface->destroy = destroy;
471
472         data->interfaces = g_slist_append(data->interfaces, iface);
473 }
474
475 static struct generic_data *object_path_ref(DBusConnection *connection,
476                                                         const char *path)
477 {
478         struct generic_data *data;
479
480         if (dbus_connection_get_object_path_data(connection, path,
481                                                 (void *) &data) == TRUE) {
482                 if (data != NULL) {
483                         data->refcount++;
484                         return data;
485                 }
486         }
487
488         data = g_new0(struct generic_data, 1);
489         data->refcount = 1;
490
491         data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
492
493         if (!dbus_connection_register_object_path(connection, path,
494                                                 &generic_table, data)) {
495                 g_free(data->introspect);
496                 g_free(data);
497                 return NULL;
498         }
499
500         invalidate_parent_data(connection, path);
501
502         add_interface(data, DBUS_INTERFACE_INTROSPECTABLE,
503                         introspect_methods, NULL, NULL, data, NULL);
504
505         return data;
506 }
507
508 static gboolean remove_interface(struct generic_data *data, const char *name)
509 {
510         struct interface_data *iface;
511
512         iface = find_interface(data->interfaces, name);
513         if (!iface)
514                 return FALSE;
515
516         data->interfaces = g_slist_remove(data->interfaces, iface);
517
518         if (iface->destroy)
519                 iface->destroy(iface->user_data);
520
521         g_free(iface->name);
522         g_free(iface);
523
524         return TRUE;
525 }
526
527 static void object_path_unref(DBusConnection *connection, const char *path)
528 {
529         struct generic_data *data = NULL;
530
531         if (dbus_connection_get_object_path_data(connection, path,
532                                                 (void *) &data) == FALSE)
533                 return;
534
535         if (data == NULL)
536                 return;
537
538         data->refcount--;
539
540         if (data->refcount > 0)
541                 return;
542
543         remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
544
545         invalidate_parent_data(connection, path);
546
547         dbus_connection_unregister_object_path(connection, path);
548 }
549
550 static gboolean check_signal(DBusConnection *conn, const char *path,
551                                 const char *interface, const char *name,
552                                 const char **args)
553 {
554         struct generic_data *data = NULL;
555         struct interface_data *iface;
556         const GDBusSignalTable *signal;
557
558         *args = NULL;
559         if (!dbus_connection_get_object_path_data(conn, path,
560                                         (void *) &data) || !data) {
561                 error("dbus_connection_emit_signal: path %s isn't registered",
562                                 path);
563                 return FALSE;
564         }
565
566         iface = find_interface(data->interfaces, interface);
567         if (!iface) {
568                 error("dbus_connection_emit_signal: %s does not implement %s",
569                                 path, interface);
570                 return FALSE;
571         }
572
573         for (signal = iface->signals; signal && signal->name; signal++) {
574                 if (!strcmp(signal->name, name)) {
575                         *args = signal->signature;
576                         break;
577                 }
578         }
579
580         if (!*args) {
581                 error("No signal named %s on interface %s", name, interface);
582                 return FALSE;
583         }
584
585         return TRUE;
586 }
587
588 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
589                                                 const char *path,
590                                                 const char *interface,
591                                                 const char *name,
592                                                 int first,
593                                                 va_list var_args)
594 {
595         DBusMessage *signal;
596         dbus_bool_t ret;
597         const char *signature, *args;
598
599         if (!check_signal(conn, path, interface, name, &args))
600                 return FALSE;
601
602         signal = dbus_message_new_signal(path, interface, name);
603         if (!signal) {
604                 error("Unable to allocate new %s.%s signal", interface,  name);
605                 return FALSE;
606         }
607
608         ret = dbus_message_append_args_valist(signal, first, var_args);
609         if (!ret)
610                 goto fail;
611
612         signature = dbus_message_get_signature(signal);
613         if (strcmp(args, signature) != 0) {
614                 error("%s.%s: expected signature'%s' but got '%s'",
615                                 interface, name, args, signature);
616                 ret = FALSE;
617                 goto fail;
618         }
619
620         ret = dbus_connection_send(conn, signal, NULL);
621
622 fail:
623         dbus_message_unref(signal);
624
625         return ret;
626 }
627
628 gboolean g_dbus_register_interface(DBusConnection *connection,
629                                         const char *path, const char *name,
630                                         const GDBusMethodTable *methods,
631                                         const GDBusSignalTable *signals,
632                                         const GDBusPropertyTable *properties,
633                                         void *user_data,
634                                         GDBusDestroyFunction destroy)
635 {
636         struct generic_data *data;
637
638         data = object_path_ref(connection, path);
639         if (data == NULL)
640                 return FALSE;
641
642         if (find_interface(data->interfaces, name)) {
643                 object_path_unref(connection, path);
644                 return FALSE;
645         }
646
647         add_interface(data, name, methods, signals,
648                         properties, user_data, destroy);
649
650         g_free(data->introspect);
651         data->introspect = NULL;
652
653         return TRUE;
654 }
655
656 gboolean g_dbus_unregister_interface(DBusConnection *connection,
657                                         const char *path, const char *name)
658 {
659         struct generic_data *data = NULL;
660
661         if (!path)
662                 return FALSE;
663
664         if (dbus_connection_get_object_path_data(connection, path,
665                                                 (void *) &data) == FALSE)
666                 return FALSE;
667
668         if (data == NULL)
669                 return FALSE;
670
671         if (remove_interface(data, name) == FALSE)
672                 return FALSE;
673
674         g_free(data->introspect);
675         data->introspect = NULL;
676
677         object_path_unref(connection, path);
678
679         return TRUE;
680 }
681
682 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
683 {
684         if (security_table != NULL)
685                 return FALSE;
686
687         security_table = security;
688
689         return TRUE;
690 }
691
692 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
693 {
694         security_table = NULL;
695
696         return TRUE;
697 }
698
699 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
700                                         const char *format, va_list args)
701 {
702         char str[1024];
703
704         vsnprintf(str, sizeof(str), format, args);
705
706         return dbus_message_new_error(message, name, str);
707 }
708
709 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
710                                                 const char *format, ...)
711 {
712         va_list args;
713         DBusMessage *reply;
714
715         va_start(args, format);
716
717         reply = g_dbus_create_error_valist(message, name, format, args);
718
719         va_end(args);
720
721         return reply;
722 }
723
724 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
725                                                 int type, va_list args)
726 {
727         DBusMessage *reply;
728
729         reply = dbus_message_new_method_return(message);
730         if (reply == NULL)
731                 return NULL;
732
733         if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
734                 dbus_message_unref(reply);
735                 return NULL;
736         }
737
738         return reply;
739 }
740
741 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
742 {
743         va_list args;
744         DBusMessage *reply;
745
746         va_start(args, type);
747
748         reply = g_dbus_create_reply_valist(message, type, args);
749
750         va_end(args);
751
752         return reply;
753 }
754
755 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
756 {
757         dbus_bool_t result;
758
759         if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
760                 dbus_message_set_no_reply(message, TRUE);
761
762         result = dbus_connection_send(connection, message, NULL);
763
764         dbus_message_unref(message);
765
766         return result;
767 }
768
769 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
770                                 DBusMessage *message, int type, va_list args)
771 {
772         DBusMessage *reply;
773
774         reply = dbus_message_new_method_return(message);
775         if (reply == NULL)
776                 return FALSE;
777
778         if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
779                 dbus_message_unref(reply);
780                 return FALSE;
781         }
782
783         return g_dbus_send_message(connection, reply);
784 }
785
786 gboolean g_dbus_send_reply(DBusConnection *connection,
787                                 DBusMessage *message, int type, ...)
788 {
789         va_list args;
790         gboolean result;
791
792         va_start(args, type);
793
794         result = g_dbus_send_reply_valist(connection, message, type, args);
795
796         va_end(args);
797
798         return result;
799 }
800
801 gboolean g_dbus_emit_signal(DBusConnection *connection,
802                                 const char *path, const char *interface,
803                                 const char *name, int type, ...)
804 {
805         va_list args;
806         gboolean result;
807
808         va_start(args, type);
809
810         result = emit_signal_valist(connection, path, interface,
811                                                         name, type, args);
812
813         va_end(args);
814
815         return result;
816 }
817
818 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
819                                 const char *path, const char *interface,
820                                 const char *name, int type, va_list args)
821 {
822         return emit_signal_valist(connection, path, interface,
823                                                         name, type, args);
824 }