1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* config-parser.c XML-library-agnostic configuration file parser
4 * Copyright (C) 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 1.2
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include "config-parser.h"
27 #include <dbus/dbus-list.h>
28 #include <dbus/dbus-internals.h>
52 /* we ignore policies for unknown groups/users */
66 unsigned int had_content : 1;
72 unsigned int ignore_missing : 1;
78 unsigned long gid_or_uid;
92 * Parser for bus configuration file.
94 struct BusConfigParser
96 int refcount; /**< Reference count */
98 DBusString basedir; /**< Directory we resolve paths relative to */
100 DBusList *stack; /**< stack of Element */
102 char *user; /**< user to run as */
104 char *bus_type; /**< Message bus type */
106 DBusList *listen_on; /**< List of addresses to listen to */
108 DBusList *mechanisms; /**< Auth mechanisms */
110 DBusList *service_dirs; /**< Directories to look for services in */
112 BusPolicy *policy; /**< Security policy */
114 BusLimits limits; /**< Limits */
116 char *pidfile; /**< PID file */
118 unsigned int fork : 1; /**< TRUE to fork into daemon mode */
120 unsigned int is_toplevel : 1; /**< FALSE if we are a sub-config-file inside another one */
124 element_type_to_name (ElementType type)
130 case ELEMENT_BUSCONFIG:
132 case ELEMENT_INCLUDE:
150 case ELEMENT_PIDFILE:
152 case ELEMENT_SERVICEDIR:
154 case ELEMENT_INCLUDEDIR:
160 _dbus_assert_not_reached ("bad element type");
166 push_element (BusConfigParser *parser,
171 _dbus_assert (type != ELEMENT_NONE);
173 e = dbus_new0 (Element, 1);
177 if (!_dbus_list_append (&parser->stack, e))
189 element_free (Element *e)
191 if (e->type == ELEMENT_LIMIT)
192 dbus_free (e->d.limit.name);
198 pop_element (BusConfigParser *parser)
202 e = _dbus_list_pop_last (&parser->stack);
208 peek_element (BusConfigParser *parser)
212 e = _dbus_list_get_last (&parser->stack);
218 top_element_type (BusConfigParser *parser)
222 e = _dbus_list_get_last (&parser->stack);
231 merge_included (BusConfigParser *parser,
232 BusConfigParser *included,
237 if (!bus_policy_merge (parser->policy,
244 if (included->user != NULL)
246 dbus_free (parser->user);
247 parser->user = included->user;
248 included->user = NULL;
251 if (included->bus_type != NULL)
253 dbus_free (parser->bus_type);
254 parser->bus_type = included->bus_type;
255 included->bus_type = NULL;
261 if (included->pidfile != NULL)
263 dbus_free (parser->pidfile);
264 parser->pidfile = included->pidfile;
265 included->pidfile = NULL;
268 while ((link = _dbus_list_pop_first_link (&included->listen_on)))
269 _dbus_list_append_link (&parser->listen_on, link);
271 while ((link = _dbus_list_pop_first_link (&included->mechanisms)))
272 _dbus_list_append_link (&parser->mechanisms, link);
274 while ((link = _dbus_list_pop_first_link (&included->service_dirs)))
275 _dbus_list_append_link (&parser->service_dirs, link);
281 bus_config_parser_new (const DBusString *basedir,
282 dbus_bool_t is_toplevel)
284 BusConfigParser *parser;
286 parser = dbus_new0 (BusConfigParser, 1);
290 parser->is_toplevel = !!is_toplevel;
292 if (!_dbus_string_init (&parser->basedir))
298 if (((parser->policy = bus_policy_new ()) == NULL) ||
299 !_dbus_string_copy (basedir, 0, &parser->basedir, 0))
302 bus_policy_unref (parser->policy);
304 _dbus_string_free (&parser->basedir);
309 /* Make up some numbers! woot! */
310 parser->limits.max_incoming_bytes = _DBUS_ONE_MEGABYTE * 63;
311 parser->limits.max_outgoing_bytes = _DBUS_ONE_MEGABYTE * 63;
312 parser->limits.max_message_size = _DBUS_ONE_MEGABYTE * 32;
314 /* Making this long means the user has to wait longer for an error
315 * message if something screws up, but making it too short means
316 * they might see a false failure.
318 parser->limits.activation_timeout = 25000; /* 25 seconds */
320 /* Making this long risks making a DOS attack easier, but too short
321 * and legitimate auth will fail. If interactive auth (ask user for
322 * password) is allowed, then potentially it has to be quite long.
324 parser->limits.auth_timeout = 30000; /* 30 seconds */
326 parser->limits.max_incomplete_connections = 32;
327 parser->limits.max_connections_per_user = 128;
329 /* Note that max_completed_connections / max_connections_per_user
330 * is the number of users that would have to work together to
331 * DOS all the other users.
333 parser->limits.max_completed_connections = 1024;
335 parser->limits.max_pending_activations = 256;
336 parser->limits.max_services_per_connection = 256;
338 parser->limits.max_match_rules_per_connection = 128;
340 parser->limits.reply_timeout = 5 * 60 * 1000; /* 5 minutes */
341 parser->limits.max_replies_per_connection = 32;
343 parser->refcount = 1;
349 bus_config_parser_ref (BusConfigParser *parser)
351 _dbus_assert (parser->refcount > 0);
353 parser->refcount += 1;
357 bus_config_parser_unref (BusConfigParser *parser)
359 _dbus_assert (parser->refcount > 0);
361 parser->refcount -= 1;
363 if (parser->refcount == 0)
365 while (parser->stack != NULL)
366 pop_element (parser);
368 dbus_free (parser->user);
369 dbus_free (parser->bus_type);
370 dbus_free (parser->pidfile);
372 _dbus_list_foreach (&parser->listen_on,
373 (DBusForeachFunction) dbus_free,
376 _dbus_list_clear (&parser->listen_on);
378 _dbus_list_foreach (&parser->service_dirs,
379 (DBusForeachFunction) dbus_free,
382 _dbus_list_clear (&parser->service_dirs);
384 _dbus_list_foreach (&parser->mechanisms,
385 (DBusForeachFunction) dbus_free,
388 _dbus_list_clear (&parser->mechanisms);
390 _dbus_string_free (&parser->basedir);
393 bus_policy_unref (parser->policy);
400 bus_config_parser_check_doctype (BusConfigParser *parser,
404 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
406 if (strcmp (doctype, "busconfig") != 0)
408 dbus_set_error (error,
410 "Configuration file has the wrong document type %s",
425 locate_attributes (BusConfigParser *parser,
426 const char *element_name,
427 const char **attribute_names,
428 const char **attribute_values,
430 const char *first_attribute_name,
431 const char **first_attribute_retloc,
439 LocateAttr attrs[MAX_ATTRS];
443 _dbus_assert (first_attribute_name != NULL);
444 _dbus_assert (first_attribute_retloc != NULL);
449 attrs[0].name = first_attribute_name;
450 attrs[0].retloc = first_attribute_retloc;
451 *first_attribute_retloc = NULL;
453 va_start (args, first_attribute_retloc);
455 name = va_arg (args, const char*);
456 retloc = va_arg (args, const char**);
460 _dbus_assert (retloc != NULL);
461 _dbus_assert (n_attrs < MAX_ATTRS);
463 attrs[n_attrs].name = name;
464 attrs[n_attrs].retloc = retloc;
468 name = va_arg (args, const char*);
469 retloc = va_arg (args, const char**);
478 while (attribute_names[i])
487 if (strcmp (attrs[j].name, attribute_names[i]) == 0)
489 retloc = attrs[j].retloc;
493 dbus_set_error (error, DBUS_ERROR_FAILED,
494 "Attribute \"%s\" repeated twice on the same <%s> element",
495 attrs[j].name, element_name);
500 *retloc = attribute_values[i];
509 dbus_set_error (error, DBUS_ERROR_FAILED,
510 "Attribute \"%s\" is invalid on <%s> element in this context",
511 attribute_names[i], element_name);
524 check_no_attributes (BusConfigParser *parser,
525 const char *element_name,
526 const char **attribute_names,
527 const char **attribute_values,
530 if (attribute_names[0] != NULL)
532 dbus_set_error (error, DBUS_ERROR_FAILED,
533 "Attribute \"%s\" is invalid on <%s> element in this context",
534 attribute_names[0], element_name);
542 start_busconfig_child (BusConfigParser *parser,
543 const char *element_name,
544 const char **attribute_names,
545 const char **attribute_values,
548 if (strcmp (element_name, "user") == 0)
550 if (!check_no_attributes (parser, "user", attribute_names, attribute_values, error))
553 if (push_element (parser, ELEMENT_USER) == NULL)
561 else if (strcmp (element_name, "type") == 0)
563 if (!check_no_attributes (parser, "type", attribute_names, attribute_values, error))
566 if (push_element (parser, ELEMENT_TYPE) == NULL)
574 else if (strcmp (element_name, "fork") == 0)
576 if (!check_no_attributes (parser, "fork", attribute_names, attribute_values, error))
579 if (push_element (parser, ELEMENT_FORK) == NULL)
589 else if (strcmp (element_name, "pidfile") == 0)
591 if (!check_no_attributes (parser, "pidfile", attribute_names, attribute_values, error))
594 if (push_element (parser, ELEMENT_PIDFILE) == NULL)
602 else if (strcmp (element_name, "listen") == 0)
604 if (!check_no_attributes (parser, "listen", attribute_names, attribute_values, error))
607 if (push_element (parser, ELEMENT_LISTEN) == NULL)
615 else if (strcmp (element_name, "auth") == 0)
617 if (!check_no_attributes (parser, "auth", attribute_names, attribute_values, error))
620 if (push_element (parser, ELEMENT_AUTH) == NULL)
628 else if (strcmp (element_name, "includedir") == 0)
630 if (!check_no_attributes (parser, "includedir", attribute_names, attribute_values, error))
633 if (push_element (parser, ELEMENT_INCLUDEDIR) == NULL)
641 else if (strcmp (element_name, "servicedir") == 0)
643 if (!check_no_attributes (parser, "servicedir", attribute_names, attribute_values, error))
646 if (push_element (parser, ELEMENT_SERVICEDIR) == NULL)
654 else if (strcmp (element_name, "include") == 0)
657 const char *ignore_missing;
659 if ((e = push_element (parser, ELEMENT_INCLUDE)) == NULL)
665 e->d.include.ignore_missing = FALSE;
667 if (!locate_attributes (parser, "include",
671 "ignore_missing", &ignore_missing,
675 if (ignore_missing != NULL)
677 if (strcmp (ignore_missing, "yes") == 0)
678 e->d.include.ignore_missing = TRUE;
679 else if (strcmp (ignore_missing, "no") == 0)
680 e->d.include.ignore_missing = FALSE;
683 dbus_set_error (error, DBUS_ERROR_FAILED,
684 "ignore_missing attribute must have value \"yes\" or \"no\"");
691 else if (strcmp (element_name, "policy") == 0)
698 if ((e = push_element (parser, ELEMENT_POLICY)) == NULL)
704 e->d.policy.type = POLICY_IGNORED;
706 if (!locate_attributes (parser, "policy",
716 if (((context && user) ||
717 (context && group)) ||
719 !(context || user || group))
721 dbus_set_error (error, DBUS_ERROR_FAILED,
722 "<policy> element must have exactly one of (context|user|group) attributes");
728 if (strcmp (context, "default") == 0)
730 e->d.policy.type = POLICY_DEFAULT;
732 else if (strcmp (context, "mandatory") == 0)
734 e->d.policy.type = POLICY_MANDATORY;
738 dbus_set_error (error, DBUS_ERROR_FAILED,
739 "context attribute on <policy> must have the value \"default\" or \"mandatory\", not \"%s\"",
744 else if (user != NULL)
747 _dbus_string_init_const (&username, user);
749 if (_dbus_get_user_id (&username,
750 &e->d.policy.gid_or_uid))
751 e->d.policy.type = POLICY_USER;
753 _dbus_warn ("Unknown username \"%s\" in message bus configuration file\n",
756 else if (group != NULL)
758 DBusString group_name;
759 _dbus_string_init_const (&group_name, group);
761 if (_dbus_get_group_id (&group_name,
762 &e->d.policy.gid_or_uid))
763 e->d.policy.type = POLICY_GROUP;
765 _dbus_warn ("Unknown group \"%s\" in message bus configuration file\n",
770 _dbus_assert_not_reached ("all <policy> attributes null and we didn't set error");
775 else if (strcmp (element_name, "limit") == 0)
780 if ((e = push_element (parser, ELEMENT_LIMIT)) == NULL)
786 if (!locate_attributes (parser, "limit",
796 dbus_set_error (error, DBUS_ERROR_FAILED,
797 "<limit> element must have a \"name\" attribute");
801 e->d.limit.name = _dbus_strdup (name);
802 if (e->d.limit.name == NULL)
812 dbus_set_error (error, DBUS_ERROR_FAILED,
813 "Element <%s> not allowed inside <%s> in configuration file",
814 element_name, "busconfig");
820 append_rule_from_element (BusConfigParser *parser,
821 const char *element_name,
822 const char **attribute_names,
823 const char **attribute_values,
827 const char *send_interface;
828 const char *send_member;
829 const char *send_error;
830 const char *send_destination;
831 const char *send_path;
832 const char *send_type;
833 const char *receive_interface;
834 const char *receive_member;
835 const char *receive_error;
836 const char *receive_sender;
837 const char *receive_path;
838 const char *receive_type;
839 const char *eavesdrop;
845 if (!locate_attributes (parser, element_name,
849 "send_interface", &send_interface,
850 "send_member", &send_member,
851 "send_error", &send_error,
852 "send_destination", &send_destination,
853 "send_path", &send_path,
854 "send_type", &send_type,
855 "receive_interface", &receive_interface,
856 "receive_member", &receive_member,
857 "receive_error", &receive_error,
858 "receive_sender", &receive_sender,
859 "receive_path", &receive_path,
860 "receive_type", &receive_type,
861 "eavesdrop", &eavesdrop,
868 if (!(send_interface || send_member || send_error || send_destination ||
869 send_type || send_path ||
870 receive_interface || receive_member || receive_error || receive_sender ||
871 receive_type || receive_path || eavesdrop ||
872 own || user || group))
874 dbus_set_error (error, DBUS_ERROR_FAILED,
875 "Element <%s> must have one or more attributes",
880 if ((send_member && (send_interface == NULL && send_path == NULL)) ||
881 (receive_member && (receive_interface == NULL && receive_path == NULL)))
883 dbus_set_error (error, DBUS_ERROR_FAILED,
884 "On element <%s>, if you specify a member you must specify an interface or a path. Keep in mind that not all messages have an interface field.",
889 /* Allowed combinations of elements are:
891 * base, must be all send or all receive:
897 * base send_ can combine with send_destination, send_path, send_type
898 * base receive_ with receive_sender, receive_path, receive_type, eavesdrop
900 * user, group, own must occur alone
902 * Pretty sure the below stuff is broken, FIXME think about it more.
905 if (((send_interface && send_error) ||
906 (send_interface && receive_interface) ||
907 (send_interface && receive_member) ||
908 (send_interface && receive_error) ||
909 (send_interface && receive_sender) ||
910 (send_interface && eavesdrop) ||
911 (send_interface && own) ||
912 (send_interface && user) ||
913 (send_interface && group)) ||
915 ((send_member && send_error) ||
916 (send_member && receive_interface) ||
917 (send_member && receive_member) ||
918 (send_member && receive_error) ||
919 (send_member && receive_sender) ||
920 (send_member && eavesdrop) ||
921 (send_member && own) ||
922 (send_member && user) ||
923 (send_member && group)) ||
925 ((send_error && receive_interface) ||
926 (send_error && receive_member) ||
927 (send_error && receive_error) ||
928 (send_error && receive_sender) ||
929 (send_error && eavesdrop) ||
930 (send_error && own) ||
931 (send_error && user) ||
932 (send_error && group)) ||
934 ((send_destination && receive_interface) ||
935 (send_destination && receive_member) ||
936 (send_destination && receive_error) ||
937 (send_destination && receive_sender) ||
938 (send_destination && eavesdrop) ||
939 (send_destination && own) ||
940 (send_destination && user) ||
941 (send_destination && group)) ||
943 ((send_type && receive_interface) ||
944 (send_type && receive_member) ||
945 (send_type && receive_error) ||
946 (send_type && receive_sender) ||
947 (send_type && eavesdrop) ||
948 (send_type && own) ||
949 (send_type && user) ||
950 (send_type && group)) ||
952 ((send_path && receive_interface) ||
953 (send_path && receive_member) ||
954 (send_path && receive_error) ||
955 (send_path && receive_sender) ||
956 (send_path && eavesdrop) ||
957 (send_path && own) ||
958 (send_path && user) ||
959 (send_path && group)) ||
961 ((receive_interface && receive_error) ||
962 (receive_interface && own) ||
963 (receive_interface && user) ||
964 (receive_interface && group)) ||
966 ((receive_member && receive_error) ||
967 (receive_member && own) ||
968 (receive_member && user) ||
969 (receive_member && group)) ||
971 ((receive_error && own) ||
972 (receive_error && user) ||
973 (receive_error && group)) ||
975 ((eavesdrop && own) ||
976 (eavesdrop && user) ||
977 (eavesdrop && group)) ||
984 dbus_set_error (error, DBUS_ERROR_FAILED,
985 "Invalid combination of attributes on element <%s>",
992 /* In BusPolicyRule, NULL represents wildcard.
993 * In the config file, '*' represents it.
995 #define IS_WILDCARD(str) ((str) && ((str)[0]) == '*' && ((str)[1]) == '\0')
997 if (send_interface || send_member || send_error || send_destination ||
998 send_path || send_type)
1002 if (IS_WILDCARD (send_interface))
1003 send_interface = NULL;
1004 if (IS_WILDCARD (send_member))
1006 if (IS_WILDCARD (send_error))
1008 if (IS_WILDCARD (send_destination))
1009 send_destination = NULL;
1010 if (IS_WILDCARD (send_path))
1012 if (IS_WILDCARD (send_type))
1015 message_type = DBUS_MESSAGE_TYPE_INVALID;
1016 if (send_type != NULL)
1018 message_type = dbus_message_type_from_string (send_type);
1019 if (message_type == DBUS_MESSAGE_TYPE_INVALID)
1021 dbus_set_error (error, DBUS_ERROR_FAILED,
1022 "Bad message type \"%s\"",
1028 rule = bus_policy_rule_new (BUS_POLICY_RULE_SEND, allow);
1032 rule->d.send.message_type = message_type;
1033 rule->d.send.path = _dbus_strdup (send_path);
1034 rule->d.send.interface = _dbus_strdup (send_interface);
1035 rule->d.send.member = _dbus_strdup (send_member);
1036 rule->d.send.error = _dbus_strdup (send_error);
1037 rule->d.send.destination = _dbus_strdup (send_destination);
1038 if (send_path && rule->d.send.path == NULL)
1040 if (send_interface && rule->d.send.interface == NULL)
1042 if (send_member && rule->d.send.member == NULL)
1044 if (send_error && rule->d.send.error == NULL)
1046 if (send_destination && rule->d.send.destination == NULL)
1049 else if (receive_interface || receive_member || receive_error || receive_sender ||
1050 receive_path || receive_type || eavesdrop)
1054 if (IS_WILDCARD (receive_interface))
1055 receive_interface = NULL;
1056 if (IS_WILDCARD (receive_member))
1057 receive_member = NULL;
1058 if (IS_WILDCARD (receive_error))
1059 receive_error = NULL;
1060 if (IS_WILDCARD (receive_sender))
1061 receive_sender = NULL;
1062 if (IS_WILDCARD (receive_path))
1063 receive_path = NULL;
1064 if (IS_WILDCARD (receive_type))
1065 receive_type = NULL;
1067 message_type = DBUS_MESSAGE_TYPE_INVALID;
1068 if (receive_type != NULL)
1070 message_type = dbus_message_type_from_string (receive_type);
1071 if (message_type == DBUS_MESSAGE_TYPE_INVALID)
1073 dbus_set_error (error, DBUS_ERROR_FAILED,
1074 "Bad message type \"%s\"",
1082 !(strcmp (eavesdrop, "true") == 0 ||
1083 strcmp (eavesdrop, "false") == 0))
1085 dbus_set_error (error, DBUS_ERROR_FAILED,
1086 "Bad value \"%s\" for eavesdrop attribute, must be true or false",
1091 rule = bus_policy_rule_new (BUS_POLICY_RULE_RECEIVE, allow);
1096 rule->d.receive.eavesdrop = (strcmp (eavesdrop, "true") == 0);
1098 rule->d.receive.message_type = message_type;
1099 rule->d.receive.path = _dbus_strdup (receive_path);
1100 rule->d.receive.interface = _dbus_strdup (receive_interface);
1101 rule->d.receive.member = _dbus_strdup (receive_member);
1102 rule->d.receive.error = _dbus_strdup (receive_error);
1103 rule->d.receive.origin = _dbus_strdup (receive_sender);
1104 if (receive_path && rule->d.receive.path == NULL)
1106 if (receive_interface && rule->d.receive.interface == NULL)
1108 if (receive_member && rule->d.receive.member == NULL)
1110 if (receive_error && rule->d.receive.error == NULL)
1112 if (receive_sender && rule->d.receive.origin == NULL)
1117 rule = bus_policy_rule_new (BUS_POLICY_RULE_OWN, allow);
1121 if (IS_WILDCARD (own))
1124 rule->d.own.service_name = _dbus_strdup (own);
1125 if (own && rule->d.own.service_name == NULL)
1130 if (IS_WILDCARD (user))
1132 rule = bus_policy_rule_new (BUS_POLICY_RULE_USER, allow);
1136 rule->d.user.uid = DBUS_UID_UNSET;
1140 DBusString username;
1143 _dbus_string_init_const (&username, user);
1145 if (_dbus_get_user_id (&username, &uid))
1147 rule = bus_policy_rule_new (BUS_POLICY_RULE_USER, allow);
1151 rule->d.user.uid = uid;
1155 _dbus_warn ("Unknown username \"%s\" on element <%s>\n",
1156 user, element_name);
1162 if (IS_WILDCARD (group))
1164 rule = bus_policy_rule_new (BUS_POLICY_RULE_GROUP, allow);
1168 rule->d.group.gid = DBUS_GID_UNSET;
1172 DBusString groupname;
1175 _dbus_string_init_const (&groupname, group);
1177 if (_dbus_get_user_id (&groupname, &gid))
1179 rule = bus_policy_rule_new (BUS_POLICY_RULE_GROUP, allow);
1183 rule->d.group.gid = gid;
1187 _dbus_warn ("Unknown group \"%s\" on element <%s>\n",
1188 group, element_name);
1193 _dbus_assert_not_reached ("Did not handle some combination of attributes on <allow> or <deny>");
1199 pe = peek_element (parser);
1200 _dbus_assert (pe != NULL);
1201 _dbus_assert (pe->type == ELEMENT_POLICY);
1203 switch (pe->d.policy.type)
1205 case POLICY_IGNORED:
1206 /* drop the rule on the floor */
1209 case POLICY_DEFAULT:
1210 if (!bus_policy_append_default_rule (parser->policy, rule))
1213 case POLICY_MANDATORY:
1214 if (!bus_policy_append_mandatory_rule (parser->policy, rule))
1218 if (!BUS_POLICY_RULE_IS_PER_CLIENT (rule))
1220 dbus_set_error (error, DBUS_ERROR_FAILED,
1221 "<%s> rule cannot be per-user because it has bus-global semantics",
1226 if (!bus_policy_append_user_rule (parser->policy, pe->d.policy.gid_or_uid,
1231 if (!BUS_POLICY_RULE_IS_PER_CLIENT (rule))
1233 dbus_set_error (error, DBUS_ERROR_FAILED,
1234 "<%s> rule cannot be per-group because it has bus-global semantics",
1239 if (!bus_policy_append_group_rule (parser->policy, pe->d.policy.gid_or_uid,
1245 bus_policy_rule_unref (rule);
1252 BUS_SET_OOM (error);
1255 bus_policy_rule_unref (rule);
1260 start_policy_child (BusConfigParser *parser,
1261 const char *element_name,
1262 const char **attribute_names,
1263 const char **attribute_values,
1266 if (strcmp (element_name, "allow") == 0)
1268 if (!append_rule_from_element (parser, element_name,
1269 attribute_names, attribute_values,
1273 if (push_element (parser, ELEMENT_ALLOW) == NULL)
1275 BUS_SET_OOM (error);
1281 else if (strcmp (element_name, "deny") == 0)
1283 if (!append_rule_from_element (parser, element_name,
1284 attribute_names, attribute_values,
1288 if (push_element (parser, ELEMENT_DENY) == NULL)
1290 BUS_SET_OOM (error);
1298 dbus_set_error (error, DBUS_ERROR_FAILED,
1299 "Element <%s> not allowed inside <%s> in configuration file",
1300 element_name, "policy");
1306 bus_config_parser_start_element (BusConfigParser *parser,
1307 const char *element_name,
1308 const char **attribute_names,
1309 const char **attribute_values,
1314 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1316 /* printf ("START: %s\n", element_name); */
1318 t = top_element_type (parser);
1320 if (t == ELEMENT_NONE)
1322 if (strcmp (element_name, "busconfig") == 0)
1324 if (!check_no_attributes (parser, "busconfig", attribute_names, attribute_values, error))
1327 if (push_element (parser, ELEMENT_BUSCONFIG) == NULL)
1329 BUS_SET_OOM (error);
1337 dbus_set_error (error, DBUS_ERROR_FAILED,
1338 "Unknown element <%s> at root of configuration file",
1343 else if (t == ELEMENT_BUSCONFIG)
1345 return start_busconfig_child (parser, element_name,
1346 attribute_names, attribute_values,
1349 else if (t == ELEMENT_POLICY)
1351 return start_policy_child (parser, element_name,
1352 attribute_names, attribute_values,
1357 dbus_set_error (error, DBUS_ERROR_FAILED,
1358 "Element <%s> is not allowed in this context",
1365 set_limit (BusConfigParser *parser,
1370 dbus_bool_t must_be_positive;
1371 dbus_bool_t must_be_int;
1373 must_be_int = FALSE;
1374 must_be_positive = FALSE;
1376 if (strcmp (name, "max_incoming_bytes") == 0)
1378 must_be_positive = TRUE;
1379 parser->limits.max_incoming_bytes = value;
1381 else if (strcmp (name, "max_outgoing_bytes") == 0)
1383 must_be_positive = TRUE;
1384 parser->limits.max_outgoing_bytes = value;
1386 else if (strcmp (name, "max_message_size") == 0)
1388 must_be_positive = TRUE;
1389 parser->limits.max_message_size = value;
1391 else if (strcmp (name, "activation_timeout") == 0)
1393 must_be_positive = TRUE;
1395 parser->limits.activation_timeout = value;
1397 else if (strcmp (name, "auth_timeout") == 0)
1399 must_be_positive = TRUE;
1401 parser->limits.auth_timeout = value;
1403 else if (strcmp (name, "reply_timeout") == 0)
1405 must_be_positive = TRUE;
1407 parser->limits.reply_timeout = value;
1409 else if (strcmp (name, "max_completed_connections") == 0)
1411 must_be_positive = TRUE;
1413 parser->limits.max_completed_connections = value;
1415 else if (strcmp (name, "max_incomplete_connections") == 0)
1417 must_be_positive = TRUE;
1419 parser->limits.max_incomplete_connections = value;
1421 else if (strcmp (name, "max_connections_per_user") == 0)
1423 must_be_positive = TRUE;
1425 parser->limits.max_connections_per_user = value;
1427 else if (strcmp (name, "max_pending_activations") == 0)
1429 must_be_positive = TRUE;
1431 parser->limits.max_pending_activations = value;
1433 else if (strcmp (name, "max_services_per_connection") == 0)
1435 must_be_positive = TRUE;
1437 parser->limits.max_services_per_connection = value;
1439 else if (strcmp (name, "max_replies_per_connection") == 0)
1441 must_be_positive = TRUE;
1443 parser->limits.max_replies_per_connection = value;
1447 dbus_set_error (error, DBUS_ERROR_FAILED,
1448 "There is no limit called \"%s\"\n",
1453 if (must_be_positive && value < 0)
1455 dbus_set_error (error, DBUS_ERROR_FAILED,
1456 "<limit name=\"%s\"> must be a positive number\n",
1462 (value < _DBUS_INT_MIN || value > _DBUS_INT_MAX))
1464 dbus_set_error (error, DBUS_ERROR_FAILED,
1465 "<limit name=\"%s\"> value is too large\n",
1474 bus_config_parser_end_element (BusConfigParser *parser,
1475 const char *element_name,
1482 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1484 /* printf ("END: %s\n", element_name); */
1486 t = top_element_type (parser);
1488 if (t == ELEMENT_NONE)
1490 /* should probably be an assertion failure but
1491 * being paranoid about XML parsers
1493 dbus_set_error (error, DBUS_ERROR_FAILED,
1494 "XML parser ended element with no element on the stack");
1498 n = element_type_to_name (t);
1499 _dbus_assert (n != NULL);
1500 if (strcmp (n, element_name) != 0)
1502 /* should probably be an assertion failure but
1503 * being paranoid about XML parsers
1505 dbus_set_error (error, DBUS_ERROR_FAILED,
1506 "XML element <%s> ended but topmost element on the stack was <%s>",
1511 e = peek_element (parser);
1512 _dbus_assert (e != NULL);
1517 _dbus_assert_not_reached ("element in stack has no type");
1520 case ELEMENT_INCLUDE:
1523 case ELEMENT_LISTEN:
1524 case ELEMENT_PIDFILE:
1526 case ELEMENT_SERVICEDIR:
1527 case ELEMENT_INCLUDEDIR:
1529 if (!e->had_content)
1531 dbus_set_error (error, DBUS_ERROR_FAILED,
1532 "XML element <%s> was expected to have content inside it",
1533 element_type_to_name (e->type));
1537 if (e->type == ELEMENT_LIMIT)
1539 if (!set_limit (parser, e->d.limit.name, e->d.limit.value,
1545 case ELEMENT_BUSCONFIG:
1546 case ELEMENT_POLICY:
1553 pop_element (parser);
1559 all_whitespace (const DBusString *str)
1563 _dbus_string_skip_white (str, 0, &i);
1565 return i == _dbus_string_get_length (str);
1569 make_full_path (const DBusString *basedir,
1570 const DBusString *filename,
1571 DBusString *full_path)
1573 if (_dbus_path_is_absolute (filename))
1575 return _dbus_string_copy (filename, 0, full_path, 0);
1579 if (!_dbus_string_copy (basedir, 0, full_path, 0))
1582 if (!_dbus_concat_dir_and_file (full_path, filename))
1590 include_file (BusConfigParser *parser,
1591 const DBusString *filename,
1592 dbus_bool_t ignore_missing,
1595 /* FIXME good test case for this would load each config file in the
1596 * test suite both alone, and as an include, and check
1597 * that the result is the same
1599 BusConfigParser *included;
1600 DBusError tmp_error;
1602 dbus_error_init (&tmp_error);
1603 included = bus_config_load (filename, FALSE, &tmp_error);
1604 if (included == NULL)
1606 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1608 if (dbus_error_has_name (&tmp_error, DBUS_ERROR_FILE_NOT_FOUND) &&
1611 dbus_error_free (&tmp_error);
1616 dbus_move_error (&tmp_error, error);
1622 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1624 if (!merge_included (parser, included, error))
1626 bus_config_parser_unref (included);
1630 bus_config_parser_unref (included);
1636 include_dir (BusConfigParser *parser,
1637 const DBusString *dirname,
1640 DBusString filename;
1642 DBusError tmp_error;
1645 if (!_dbus_string_init (&filename))
1647 BUS_SET_OOM (error);
1653 dir = _dbus_directory_open (dirname, error);
1658 dbus_error_init (&tmp_error);
1659 while (_dbus_directory_get_next_file (dir, &filename, &tmp_error))
1661 DBusString full_path;
1663 if (!_dbus_string_init (&full_path))
1665 BUS_SET_OOM (error);
1669 if (!_dbus_string_copy (dirname, 0, &full_path, 0))
1671 BUS_SET_OOM (error);
1672 _dbus_string_free (&full_path);
1676 if (!_dbus_concat_dir_and_file (&full_path, &filename))
1678 BUS_SET_OOM (error);
1679 _dbus_string_free (&full_path);
1683 if (_dbus_string_ends_with_c_str (&full_path, ".conf"))
1685 if (!include_file (parser, &full_path, TRUE, error))
1687 _dbus_string_free (&full_path);
1692 _dbus_string_free (&full_path);
1695 if (dbus_error_is_set (&tmp_error))
1697 dbus_move_error (&tmp_error, error);
1704 _dbus_string_free (&filename);
1707 _dbus_directory_close (dir);
1713 bus_config_parser_content (BusConfigParser *parser,
1714 const DBusString *content,
1719 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1725 _dbus_string_get_const_data (content, &c_str);
1727 printf ("CONTENT %d bytes: %s\n", _dbus_string_get_length (content), c_str);
1731 e = peek_element (parser);
1734 dbus_set_error (error, DBUS_ERROR_FAILED,
1735 "Text content outside of any XML element in configuration file");
1738 else if (e->had_content)
1740 _dbus_assert_not_reached ("Element had multiple content blocks");
1744 switch (top_element_type (parser))
1747 _dbus_assert_not_reached ("element at top of stack has no type");
1750 case ELEMENT_BUSCONFIG:
1751 case ELEMENT_POLICY:
1755 if (all_whitespace (content))
1759 dbus_set_error (error, DBUS_ERROR_FAILED,
1760 "No text content expected inside XML element %s in configuration file",
1761 element_type_to_name (top_element_type (parser)));
1765 case ELEMENT_PIDFILE:
1769 e->had_content = TRUE;
1771 if (!_dbus_string_copy_data (content, &s))
1774 dbus_free (parser->pidfile);
1775 parser->pidfile = s;
1779 case ELEMENT_INCLUDE:
1781 DBusString full_path;
1783 e->had_content = TRUE;
1785 if (!_dbus_string_init (&full_path))
1788 if (!make_full_path (&parser->basedir, content, &full_path))
1790 _dbus_string_free (&full_path);
1794 if (!include_file (parser, &full_path,
1795 e->d.include.ignore_missing, error))
1797 _dbus_string_free (&full_path);
1801 _dbus_string_free (&full_path);
1805 case ELEMENT_INCLUDEDIR:
1807 DBusString full_path;
1809 e->had_content = TRUE;
1811 if (!_dbus_string_init (&full_path))
1814 if (!make_full_path (&parser->basedir, content, &full_path))
1816 _dbus_string_free (&full_path);
1820 if (!include_dir (parser, &full_path, error))
1822 _dbus_string_free (&full_path);
1826 _dbus_string_free (&full_path);
1834 e->had_content = TRUE;
1836 if (!_dbus_string_copy_data (content, &s))
1839 dbus_free (parser->user);
1848 e->had_content = TRUE;
1850 if (!_dbus_string_copy_data (content, &s))
1853 dbus_free (parser->bus_type);
1854 parser->bus_type = s;
1858 case ELEMENT_LISTEN:
1862 e->had_content = TRUE;
1864 if (!_dbus_string_copy_data (content, &s))
1867 if (!_dbus_list_append (&parser->listen_on,
1880 e->had_content = TRUE;
1882 if (!_dbus_string_copy_data (content, &s))
1885 if (!_dbus_list_append (&parser->mechanisms,
1894 case ELEMENT_SERVICEDIR:
1897 DBusString full_path;
1899 e->had_content = TRUE;
1901 if (!_dbus_string_init (&full_path))
1904 if (!make_full_path (&parser->basedir, content, &full_path))
1906 _dbus_string_free (&full_path);
1910 if (!_dbus_string_copy_data (&full_path, &s))
1912 _dbus_string_free (&full_path);
1916 if (!_dbus_list_append (&parser->service_dirs, s))
1918 _dbus_string_free (&full_path);
1923 _dbus_string_free (&full_path);
1931 e->had_content = TRUE;
1934 if (!_dbus_string_parse_int (content, 0, &val, NULL))
1936 dbus_set_error (error, DBUS_ERROR_FAILED,
1937 "<limit name=\"%s\"> element has invalid value (could not parse as integer)",
1942 e->d.limit.value = val;
1944 _dbus_verbose ("Loaded value %ld for limit %s\n",
1951 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1955 BUS_SET_OOM (error);
1960 bus_config_parser_finished (BusConfigParser *parser,
1963 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1965 if (parser->stack != NULL)
1967 dbus_set_error (error, DBUS_ERROR_FAILED,
1968 "Element <%s> was not closed in configuration file",
1969 element_type_to_name (top_element_type (parser)));
1974 if (parser->is_toplevel && parser->listen_on == NULL)
1976 dbus_set_error (error, DBUS_ERROR_FAILED,
1977 "Configuration file needs one or more <listen> elements giving addresses");
1985 bus_config_parser_get_user (BusConfigParser *parser)
1987 return parser->user;
1991 bus_config_parser_get_type (BusConfigParser *parser)
1993 return parser->bus_type;
1997 bus_config_parser_get_addresses (BusConfigParser *parser)
1999 return &parser->listen_on;
2003 bus_config_parser_get_mechanisms (BusConfigParser *parser)
2005 return &parser->mechanisms;
2009 bus_config_parser_get_service_dirs (BusConfigParser *parser)
2011 return &parser->service_dirs;
2015 bus_config_parser_get_fork (BusConfigParser *parser)
2017 return parser->fork;
2021 bus_config_parser_get_pidfile (BusConfigParser *parser)
2023 return parser->pidfile;
2027 bus_config_parser_steal_policy (BusConfigParser *parser)
2031 _dbus_assert (parser->policy != NULL); /* can only steal the policy 1 time */
2033 policy = parser->policy;
2035 parser->policy = NULL;
2040 /* Overwrite any limits that were set in the configuration file */
2042 bus_config_parser_get_limits (BusConfigParser *parser,
2045 *limits = parser->limits;
2048 #ifdef DBUS_BUILD_TESTS
2059 do_load (const DBusString *full_path,
2061 dbus_bool_t oom_possible)
2063 BusConfigParser *parser;
2066 dbus_error_init (&error);
2068 parser = bus_config_load (full_path, TRUE, &error);
2071 _DBUS_ASSERT_ERROR_IS_SET (&error);
2074 dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY))
2076 _dbus_verbose ("Failed to load valid file due to OOM\n");
2077 dbus_error_free (&error);
2080 else if (validity == VALID)
2082 _dbus_warn ("Failed to load valid file but still had memory: %s\n",
2085 dbus_error_free (&error);
2090 dbus_error_free (&error);
2096 _DBUS_ASSERT_ERROR_IS_CLEAR (&error);
2098 bus_config_parser_unref (parser);
2100 if (validity == INVALID)
2102 _dbus_warn ("Accepted invalid file\n");
2112 const DBusString *full_path;
2117 check_loader_oom_func (void *data)
2119 LoaderOomData *d = data;
2121 return do_load (d->full_path, d->validity, TRUE);
2125 process_test_subdir (const DBusString *test_base_dir,
2129 DBusString test_directory;
2130 DBusString filename;
2138 if (!_dbus_string_init (&test_directory))
2139 _dbus_assert_not_reached ("didn't allocate test_directory\n");
2141 _dbus_string_init_const (&filename, subdir);
2143 if (!_dbus_string_copy (test_base_dir, 0,
2144 &test_directory, 0))
2145 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
2147 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
2148 _dbus_assert_not_reached ("couldn't allocate full path");
2150 _dbus_string_free (&filename);
2151 if (!_dbus_string_init (&filename))
2152 _dbus_assert_not_reached ("didn't allocate filename string\n");
2154 dbus_error_init (&error);
2155 dir = _dbus_directory_open (&test_directory, &error);
2158 _dbus_warn ("Could not open %s: %s\n",
2159 _dbus_string_get_const_data (&test_directory),
2161 dbus_error_free (&error);
2165 printf ("Testing:\n");
2168 while (_dbus_directory_get_next_file (dir, &filename, &error))
2170 DBusString full_path;
2173 if (!_dbus_string_init (&full_path))
2174 _dbus_assert_not_reached ("couldn't init string");
2176 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
2177 _dbus_assert_not_reached ("couldn't copy dir to full_path");
2179 if (!_dbus_concat_dir_and_file (&full_path, &filename))
2180 _dbus_assert_not_reached ("couldn't concat file to dir");
2182 if (!_dbus_string_ends_with_c_str (&full_path, ".conf"))
2184 _dbus_verbose ("Skipping non-.conf file %s\n",
2185 _dbus_string_get_const_data (&filename));
2186 _dbus_string_free (&full_path);
2190 printf (" %s\n", _dbus_string_get_const_data (&filename));
2192 _dbus_verbose (" expecting %s\n",
2193 validity == VALID ? "valid" :
2194 (validity == INVALID ? "invalid" :
2195 (validity == UNKNOWN ? "unknown" : "???")));
2197 d.full_path = &full_path;
2198 d.validity = validity;
2199 if (!_dbus_test_oom_handling ("config-loader", check_loader_oom_func, &d))
2200 _dbus_assert_not_reached ("test failed");
2202 _dbus_string_free (&full_path);
2205 if (dbus_error_is_set (&error))
2207 _dbus_warn ("Could not get next file in %s: %s\n",
2208 _dbus_string_get_const_data (&test_directory),
2210 dbus_error_free (&error);
2219 _dbus_directory_close (dir);
2220 _dbus_string_free (&test_directory);
2221 _dbus_string_free (&filename);
2227 bus_config_parser_test (const DBusString *test_data_dir)
2229 if (test_data_dir == NULL ||
2230 _dbus_string_get_length (test_data_dir) == 0)
2232 printf ("No test data\n");
2236 if (!process_test_subdir (test_data_dir, "valid-config-files", VALID))
2242 #endif /* DBUS_BUILD_TESTS */