2 * rpcd - UBUS RPC server
4 * Copyright (C) 2013-2014 Jo-Philipp Wich <jow@openwrt.org>
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 #include <libubox/blobmsg.h>
23 #include <libubox/blobmsg_json.h>
26 #include <rpcd/exec.h>
27 #include <rpcd/session.h>
29 static struct blob_buf buf;
30 static struct uci_context *cursor;
31 static struct uloop_timeout apply_timer;
32 static struct ubus_context *apply_ctx;
34 char apply_sid[RPC_SID_LEN + 1];
46 static const struct blobmsg_policy rpc_uci_get_policy[__RPC_G_MAX] = {
47 [RPC_G_CONFIG] = { .name = "config", .type = BLOBMSG_TYPE_STRING },
48 [RPC_G_SECTION] = { .name = "section", .type = BLOBMSG_TYPE_STRING },
49 [RPC_G_OPTION] = { .name = "option", .type = BLOBMSG_TYPE_STRING },
50 [RPC_G_TYPE] = { .name = "type", .type = BLOBMSG_TYPE_STRING },
51 [RPC_G_MATCH] = { .name = "match", .type = BLOBMSG_TYPE_TABLE },
52 [RPC_G_SESSION] = { .name = "ubus_rpc_session",
53 .type = BLOBMSG_TYPE_STRING },
65 static const struct blobmsg_policy rpc_uci_add_policy[__RPC_A_MAX] = {
66 [RPC_A_CONFIG] = { .name = "config", .type = BLOBMSG_TYPE_STRING },
67 [RPC_A_TYPE] = { .name = "type", .type = BLOBMSG_TYPE_STRING },
68 [RPC_A_NAME] = { .name = "name", .type = BLOBMSG_TYPE_STRING },
69 [RPC_A_VALUES] = { .name = "values", .type = BLOBMSG_TYPE_TABLE },
70 [RPC_A_SESSION] = { .name = "ubus_rpc_session",
71 .type = BLOBMSG_TYPE_STRING },
84 static const struct blobmsg_policy rpc_uci_set_policy[__RPC_S_MAX] = {
85 [RPC_S_CONFIG] = { .name = "config", .type = BLOBMSG_TYPE_STRING },
86 [RPC_S_SECTION] = { .name = "section", .type = BLOBMSG_TYPE_STRING },
87 [RPC_S_TYPE] = { .name = "type", .type = BLOBMSG_TYPE_STRING },
88 [RPC_S_MATCH] = { .name = "match", .type = BLOBMSG_TYPE_TABLE },
89 [RPC_S_VALUES] = { .name = "values", .type = BLOBMSG_TYPE_TABLE },
90 [RPC_S_SESSION] = { .name = "ubus_rpc_session",
91 .type = BLOBMSG_TYPE_STRING },
105 static const struct blobmsg_policy rpc_uci_delete_policy[__RPC_D_MAX] = {
106 [RPC_D_CONFIG] = { .name = "config", .type = BLOBMSG_TYPE_STRING },
107 [RPC_D_SECTION] = { .name = "section", .type = BLOBMSG_TYPE_STRING },
108 [RPC_D_TYPE] = { .name = "type", .type = BLOBMSG_TYPE_STRING },
109 [RPC_D_MATCH] = { .name = "match", .type = BLOBMSG_TYPE_TABLE },
110 [RPC_D_OPTION] = { .name = "option", .type = BLOBMSG_TYPE_STRING },
111 [RPC_D_OPTIONS] = { .name = "options", .type = BLOBMSG_TYPE_ARRAY },
112 [RPC_D_SESSION] = { .name = "ubus_rpc_session",
113 .type = BLOBMSG_TYPE_STRING },
125 static const struct blobmsg_policy rpc_uci_rename_policy[__RPC_R_MAX] = {
126 [RPC_R_CONFIG] = { .name = "config", .type = BLOBMSG_TYPE_STRING },
127 [RPC_R_SECTION] = { .name = "section", .type = BLOBMSG_TYPE_STRING },
128 [RPC_R_OPTION] = { .name = "option", .type = BLOBMSG_TYPE_STRING },
129 [RPC_R_NAME] = { .name = "name", .type = BLOBMSG_TYPE_STRING },
130 [RPC_R_SESSION] = { .name = "ubus_rpc_session",
131 .type = BLOBMSG_TYPE_STRING },
141 static const struct blobmsg_policy rpc_uci_order_policy[__RPC_O_MAX] = {
142 [RPC_O_CONFIG] = { .name = "config", .type = BLOBMSG_TYPE_STRING },
143 [RPC_O_SECTIONS] = { .name = "sections", .type = BLOBMSG_TYPE_ARRAY },
144 [RPC_O_SESSION] = { .name = "ubus_rpc_session",
145 .type = BLOBMSG_TYPE_STRING },
154 static const struct blobmsg_policy rpc_uci_config_policy[__RPC_C_MAX] = {
155 [RPC_C_CONFIG] = { .name = "config", .type = BLOBMSG_TYPE_STRING },
156 [RPC_C_SESSION] = { .name = "ubus_rpc_session",
157 .type = BLOBMSG_TYPE_STRING },
167 static const struct blobmsg_policy rpc_uci_apply_policy[__RPC_T_MAX] = {
168 [RPC_T_ROLLBACK] = { .name = "rollback", .type = BLOBMSG_TYPE_BOOL },
169 [RPC_T_TIMEOUT] = { .name = "timeout", .type = BLOBMSG_TYPE_INT32 },
170 [RPC_T_SESSION] = { .name = "ubus_rpc_session",
171 .type = BLOBMSG_TYPE_STRING },
179 static const struct blobmsg_policy rpc_uci_rollback_policy[__RPC_B_MAX] = {
180 [RPC_B_SESSION] = { .name = "ubus_rpc_session",
181 .type = BLOBMSG_TYPE_STRING },
185 * Validate a uci name
188 rpc_uci_verify_str(const char *name, bool extended, bool type)
196 if (extended && *name != '@')
199 for (c = name + extended; *c; c++)
200 if (!isalnum(*c) && *c != '_' && ((!type && !extended) || *c != '-'))
209 return (e > c && *e == ']' && *(e+1) == 0);
216 * Check that string is a valid, shell compatible uci name
218 static bool rpc_uci_verify_name(const char *name) {
219 return rpc_uci_verify_str(name, false, false);
223 * Check that string is a valid section type name
225 static bool rpc_uci_verify_type(const char *type) {
226 return rpc_uci_verify_str(type, false, true);
230 * Check that the string is a valid section id, optionally in extended
233 static bool rpc_uci_verify_section(const char *section) {
234 return rpc_uci_verify_str(section, true, false);
239 * Turn uci error state into ubus return code
247 return UBUS_STATUS_OK;
250 return UBUS_STATUS_INVALID_ARGUMENT;
252 case UCI_ERR_NOTFOUND:
253 return UBUS_STATUS_NOT_FOUND;
256 return UBUS_STATUS_UNKNOWN_ERROR;
261 * Clear all save directories from the uci cursor and append the given path
262 * as new save directory.
265 rpc_uci_replace_savedir(const char *path)
267 struct uci_element *e, *tmp;
269 uci_foreach_element_safe(&cursor->delta_path, tmp, e) {
276 cursor->delta_path.prev = &cursor->delta_path;
277 cursor->delta_path.next = &cursor->delta_path;
280 uci_set_savedir(cursor, path);
284 * Setup per-session delta save directory. If the passed "sid" blob attribute
285 * pointer is NULL then the precedure was not invoked through the ubus-rpc so
286 * we do not perform session isolation and use the default save directory.
289 rpc_uci_set_savedir(struct blob_attr *sid)
295 rpc_uci_replace_savedir("/tmp/.uci");
299 snprintf(path, sizeof(path) - 1,
300 RPC_UCI_SAVEDIR_PREFIX "%s", blobmsg_get_string(sid));
302 rpc_uci_replace_savedir(path);
306 * Test read access to given config. If the passed "sid" blob attribute pointer
307 * is NULL then the precedure was not invoked through the ubus-rpc so we do not
308 * perform access control and always assume true.
311 rpc_uci_read_access(struct blob_attr *sid, struct blob_attr *config)
313 rpc_uci_set_savedir(sid);
318 return rpc_session_access(blobmsg_data(sid), "uci",
319 blobmsg_data(config), "read");
323 * Test write access to given config. If the passed "sid" blob attribute pointer
324 * is NULL then the precedure was not invoked through the ubus-rpc so we do not
325 * perform access control and always assume true.
328 rpc_uci_write_access(struct blob_attr *sid, struct blob_attr *config)
330 rpc_uci_set_savedir(sid);
335 return rpc_session_access(blobmsg_data(sid), "uci",
336 blobmsg_data(config), "write");
340 * Format applicable blob value as string and place a pointer to the string
341 * buffer in "p". Uses a static string buffer.
344 rpc_uci_format_blob(struct blob_attr *v, const char **p)
350 switch (blobmsg_type(v))
352 case BLOBMSG_TYPE_STRING:
353 *p = blobmsg_data(v);
356 case BLOBMSG_TYPE_INT64:
357 snprintf(buf, sizeof(buf), "%"PRIu64, blobmsg_get_u64(v));
361 case BLOBMSG_TYPE_INT32:
362 snprintf(buf, sizeof(buf), "%u", blobmsg_get_u32(v));
366 case BLOBMSG_TYPE_INT16:
367 snprintf(buf, sizeof(buf), "%u", blobmsg_get_u16(v));
371 case BLOBMSG_TYPE_INT8:
372 snprintf(buf, sizeof(buf), "%u", !!blobmsg_get_u8(v));
384 * Lookup the given uci_ptr and enable extended lookup format if the .section
385 * value of the uci_ptr looks like extended syntax. Uses an internal copy
386 * of the given uci_ptr to perform the lookup as failing extended section
387 * lookup operations in libuci will zero our the uci_ptr struct.
388 * Copies the internal uci_ptr back to given the uci_ptr on success.
391 rpc_uci_lookup(struct uci_ptr *ptr)
394 struct uci_ptr lookup = *ptr;
396 if (!lookup.s && lookup.section && *lookup.section == '@')
397 lookup.flags |= UCI_LOOKUP_EXTENDED;
399 rv = uci_lookup_ptr(cursor, &lookup, NULL, true);
408 * Checks whether the given uci_option object matches the given string value.
409 * 1) If the uci_option is of type list, check whether any of the list elements
410 * equals to the given string
411 * 2) If the uci_option is of type string, parse it into space separated tokens
412 * and check if any of the tokens equals to the given string.
413 * Returns true if a list element or token matched the given string.
416 rpc_uci_match_option(struct uci_option *o, const char *cmp)
418 struct uci_element *e;
421 if (o->type == UCI_TYPE_LIST)
423 uci_foreach_element(&o->v.list, e)
424 if (e->name && !strcmp(e->name, cmp))
433 s = strdup(o->v.string);
438 for (p = strtok(s, " \t"); p; p = strtok(NULL, " \t"))
452 * Checks whether the given uci_section matches the type and value blob attrs.
453 * 1) Returns false if "type" is given and the section type does not match
454 * the value specified in the "type" string blob attribute, else continue.
455 * 2) Tests whether any key in the "matches" table blob attribute exists in
456 * the given uci_section and whether each value is contained in the
457 * corresponding uci option value (see rpc_uci_match_option()).
458 * 3) A missing or empty "matches" table blob attribute is always considered
460 * Returns true if "type" matches or is NULL and "matches" matches or is NULL.
463 rpc_uci_match_section(struct uci_section *s,
464 struct blob_attr *type, struct blob_attr *matches)
466 struct uci_element *e;
467 struct blob_attr *cur;
473 if (type && strcmp(s->type, blobmsg_data(type)))
479 blobmsg_for_each_attr(cur, matches, rem)
481 if (!rpc_uci_format_blob(cur, &cmp))
484 uci_foreach_element(&s->options, e)
486 if (strcmp(e->name, blobmsg_name(cur)))
489 if (!rpc_uci_match_option(uci_to_option(e), cmp))
498 return (empty || match);
502 * Dump the given uci_option value into the global blobmsg buffer and use
503 * given "name" as key.
504 * 1) If the uci_option is of type list, put a table into the blob buffer and
505 * add each list item as string to it.
506 * 2) If the uci_option is of type string, put its value directly into the blob
510 rpc_uci_dump_option(struct uci_option *o, const char *name)
513 struct uci_element *e;
517 case UCI_TYPE_STRING:
518 blobmsg_add_string(&buf, name, o->v.string);
522 c = blobmsg_open_array(&buf, name);
524 uci_foreach_element(&o->v.list, e)
525 blobmsg_add_string(&buf, NULL, e->name);
527 blobmsg_close_array(&buf, c);
536 * Dump the given uci_section object into the global blobmsg buffer and use
537 * given "name" as key.
538 * Puts a table into the blob buffer and puts each section option member value
539 * as value into the table using the option name as key.
540 * Adds three special keys ".anonymous", ".type" and ".name" which specify the
541 * corresponding section properties.
544 rpc_uci_dump_section(struct uci_section *s, const char *name, int index)
547 struct uci_option *o;
548 struct uci_element *e;
550 c = blobmsg_open_table(&buf, name);
552 blobmsg_add_u8(&buf, ".anonymous", s->anonymous);
553 blobmsg_add_string(&buf, ".type", s->type);
554 blobmsg_add_string(&buf, ".name", s->e.name);
557 blobmsg_add_u32(&buf, ".index", index);
559 uci_foreach_element(&s->options, e)
561 o = uci_to_option(e);
562 rpc_uci_dump_option(o, o->e.name);
565 blobmsg_close_table(&buf, c);
569 * Dump the given uci_package object into the global blobmsg buffer and use
570 * given "name" as key.
571 * Puts a table into the blob buffer and puts each package section member as
572 * value into the table using the section name as key.
573 * Only dumps sections matching the given "type" and "matches", see explaination
574 * of rpc_uci_match_section() for details.
577 rpc_uci_dump_package(struct uci_package *p, const char *name,
578 struct blob_attr *type, struct blob_attr *matches)
581 struct uci_element *e;
584 c = blobmsg_open_table(&buf, name);
586 uci_foreach_element(&p->sections, e)
590 if (!rpc_uci_match_section(uci_to_section(e), type, matches))
593 rpc_uci_dump_section(uci_to_section(e), e->name, i);
596 blobmsg_close_table(&buf, c);
601 rpc_uci_getcommon(struct ubus_context *ctx, struct ubus_request_data *req,
602 struct blob_attr *msg, bool use_state)
604 struct blob_attr *tb[__RPC_G_MAX];
605 struct uci_package *p = NULL;
606 struct uci_ptr ptr = { 0 };
608 blobmsg_parse(rpc_uci_get_policy, __RPC_G_MAX, tb,
609 blob_data(msg), blob_len(msg));
611 if (!tb[RPC_G_CONFIG])
612 return UBUS_STATUS_INVALID_ARGUMENT;
614 if (!rpc_uci_read_access(tb[RPC_G_SESSION], tb[RPC_G_CONFIG]))
615 return UBUS_STATUS_PERMISSION_DENIED;
617 ptr.package = blobmsg_data(tb[RPC_G_CONFIG]);
620 uci_set_savedir(cursor, "/var/state");
622 if (uci_load(cursor, ptr.package, &p))
623 return rpc_uci_status();
625 if (tb[RPC_G_SECTION])
627 ptr.section = blobmsg_data(tb[RPC_G_SECTION]);
629 if (tb[RPC_G_OPTION])
630 ptr.option = blobmsg_data(tb[RPC_G_OPTION]);
633 if (rpc_uci_lookup(&ptr) || !(ptr.flags & UCI_LOOKUP_COMPLETE))
636 blob_buf_init(&buf, 0);
638 switch (ptr.last->type)
640 case UCI_TYPE_PACKAGE:
641 rpc_uci_dump_package(ptr.p, "values", tb[RPC_G_TYPE], tb[RPC_G_MATCH]);
644 case UCI_TYPE_SECTION:
645 rpc_uci_dump_section(ptr.s, "values", -1);
648 case UCI_TYPE_OPTION:
649 rpc_uci_dump_option(ptr.o, "value");
656 ubus_send_reply(ctx, req, buf.head);
659 uci_unload(cursor, p);
661 return rpc_uci_status();
665 rpc_uci_get(struct ubus_context *ctx, struct ubus_object *obj,
666 struct ubus_request_data *req, const char *method,
667 struct blob_attr *msg)
669 return rpc_uci_getcommon(ctx, req, msg, false);
673 rpc_uci_state(struct ubus_context *ctx, struct ubus_object *obj,
674 struct ubus_request_data *req, const char *method,
675 struct blob_attr *msg)
677 return rpc_uci_getcommon(ctx, req, msg, true);
681 rpc_uci_add(struct ubus_context *ctx, struct ubus_object *obj,
682 struct ubus_request_data *req, const char *method,
683 struct blob_attr *msg)
685 struct blob_attr *tb[__RPC_A_MAX];
686 struct blob_attr *cur, *elem;
687 struct uci_package *p = NULL;
688 struct uci_section *s;
689 struct uci_ptr ptr = { 0 };
690 int rem, rem2, err = 0;
692 blobmsg_parse(rpc_uci_add_policy, __RPC_A_MAX, tb,
693 blob_data(msg), blob_len(msg));
695 if (!tb[RPC_A_CONFIG] || !tb[RPC_A_TYPE])
696 return UBUS_STATUS_INVALID_ARGUMENT;
698 if (!rpc_uci_write_access(tb[RPC_A_SESSION], tb[RPC_A_CONFIG]))
699 return UBUS_STATUS_PERMISSION_DENIED;
701 if (!rpc_uci_verify_type(blobmsg_data(tb[RPC_A_TYPE])))
702 return UBUS_STATUS_INVALID_ARGUMENT;
704 if (tb[RPC_A_NAME] &&
705 !rpc_uci_verify_name(blobmsg_data(tb[RPC_A_NAME])))
706 return UBUS_STATUS_INVALID_ARGUMENT;
708 ptr.package = blobmsg_data(tb[RPC_A_CONFIG]);
710 if (uci_load(cursor, ptr.package, &p))
711 return rpc_uci_status();
713 /* add named section */
716 ptr.section = blobmsg_data(tb[RPC_A_NAME]);
717 ptr.value = blobmsg_data(tb[RPC_A_TYPE]);
720 if (rpc_uci_lookup(&ptr) || uci_set(cursor, &ptr))
724 /* add anon section */
727 if (uci_add_section(cursor, p, blobmsg_data(tb[RPC_A_TYPE]), &s) || !s)
730 ptr.section = s->e.name;
733 if (tb[RPC_A_VALUES])
735 blobmsg_for_each_attr(cur, tb[RPC_A_VALUES], rem)
738 ptr.option = blobmsg_name(cur);
740 if (!rpc_uci_verify_name(ptr.option))
743 err = UBUS_STATUS_INVALID_ARGUMENT;
748 if (rpc_uci_lookup(&ptr) || !ptr.s)
751 err = UBUS_STATUS_NOT_FOUND;
756 switch (blobmsg_type(cur))
758 case BLOBMSG_TYPE_ARRAY:
759 blobmsg_for_each_attr(elem, cur, rem2)
761 if (!rpc_uci_format_blob(elem, &ptr.value))
764 err = UBUS_STATUS_INVALID_ARGUMENT;
769 uci_add_list(cursor, &ptr);
775 if (!rpc_uci_format_blob(cur, &ptr.value))
778 err = UBUS_STATUS_INVALID_ARGUMENT;
782 uci_set(cursor, &ptr);
794 blob_buf_init(&buf, 0);
795 blobmsg_add_string(&buf, "section", ptr.section);
796 ubus_send_reply(ctx, req, buf.head);
800 uci_unload(cursor, p);
802 return err ? err : rpc_uci_status();
806 * Turn value from a blob attribute into uci set operation
807 * 1) if the blob is of type array, delete existing option (if any) and
808 * emit uci add_list operations for each element
809 * 2) if the blob is not an array but an option of type list exists,
810 * delete existing list and emit uci set operation for the blob value
811 * 3) in all other cases only emit a set operation if there is no existing
812 * option of if the existing options value differs from the blob value
815 rpc_uci_merge_set(struct blob_attr *opt, struct uci_ptr *ptr)
817 struct blob_attr *cur;
821 ptr->option = blobmsg_name(opt);
824 if (!rpc_uci_verify_name(ptr->option))
825 return UBUS_STATUS_INVALID_ARGUMENT;
827 if (rpc_uci_lookup(ptr) || !ptr->s)
828 return UBUS_STATUS_NOT_FOUND;
830 if (blobmsg_type(opt) == BLOBMSG_TYPE_ARRAY)
833 uci_delete(cursor, ptr);
835 rv = UBUS_STATUS_INVALID_ARGUMENT;
837 blobmsg_for_each_attr(cur, opt, rem)
839 if (!rpc_uci_format_blob(cur, &ptr->value))
842 uci_add_list(cursor, ptr);
848 else if (ptr->o && ptr->o->type == UCI_TYPE_LIST)
850 uci_delete(cursor, ptr);
852 if (!rpc_uci_format_blob(opt, &ptr->value))
853 return UBUS_STATUS_INVALID_ARGUMENT;
855 uci_set(cursor, ptr);
859 if (!rpc_uci_format_blob(opt, &ptr->value))
860 return UBUS_STATUS_INVALID_ARGUMENT;
862 if (!ptr->o || !ptr->o->v.string || strcmp(ptr->o->v.string, ptr->value))
863 uci_set(cursor, ptr);
870 rpc_uci_set(struct ubus_context *ctx, struct ubus_object *obj,
871 struct ubus_request_data *req, const char *method,
872 struct blob_attr *msg)
874 struct blob_attr *tb[__RPC_S_MAX];
875 struct blob_attr *cur;
876 struct uci_package *p = NULL;
877 struct uci_element *e;
878 struct uci_ptr ptr = { 0 };
879 int rem, rv, err = 0;
881 blobmsg_parse(rpc_uci_set_policy, __RPC_S_MAX, tb,
882 blob_data(msg), blob_len(msg));
884 if (!tb[RPC_S_CONFIG] || !tb[RPC_S_VALUES] ||
885 (!tb[RPC_S_SECTION] && !tb[RPC_S_TYPE] && !tb[RPC_S_MATCH]))
886 return UBUS_STATUS_INVALID_ARGUMENT;
888 if (!rpc_uci_write_access(tb[RPC_S_SESSION], tb[RPC_S_CONFIG]))
889 return UBUS_STATUS_PERMISSION_DENIED;
891 if (tb[RPC_S_SECTION] &&
892 !rpc_uci_verify_section(blobmsg_data(tb[RPC_S_SECTION])))
893 return UBUS_STATUS_INVALID_ARGUMENT;
895 ptr.package = blobmsg_data(tb[RPC_S_CONFIG]);
897 if (uci_load(cursor, ptr.package, &p))
898 return rpc_uci_status();
900 if (tb[RPC_S_SECTION])
902 ptr.section = blobmsg_data(tb[RPC_S_SECTION]);
903 blobmsg_for_each_attr(cur, tb[RPC_S_VALUES], rem)
905 rv = rpc_uci_merge_set(cur, &ptr);
913 uci_foreach_element(&p->sections, e)
915 if (!rpc_uci_match_section(uci_to_section(e),
916 tb[RPC_S_TYPE], tb[RPC_S_MATCH]))
920 ptr.section = e->name;
922 blobmsg_for_each_attr(cur, tb[RPC_S_VALUES], rem)
924 rv = rpc_uci_merge_set(cur, &ptr);
933 err = UBUS_STATUS_NOT_FOUND;
938 uci_unload(cursor, p);
940 return err ? err : rpc_uci_status();
944 * Delete option or section from uci specified by given blob attribute pointer
945 * 1) if the blob is of type array, delete any option named after each element
946 * 2) if the blob is of type string, delete the option named after its value
947 * 3) if the blob is NULL, delete entire section
950 rpc_uci_merge_delete(struct blob_attr *opt, struct uci_ptr *ptr)
952 struct blob_attr *cur;
955 if (rpc_uci_lookup(ptr) || !ptr->s)
963 uci_delete(cursor, ptr);
965 else if (blobmsg_type(opt) == BLOBMSG_TYPE_ARRAY)
967 blobmsg_for_each_attr(cur, opt, rem)
969 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
973 ptr->option = blobmsg_data(cur);
975 if (rpc_uci_lookup(ptr) || !ptr->o)
978 uci_delete(cursor, ptr);
981 else if (blobmsg_type(opt) == BLOBMSG_TYPE_STRING)
984 ptr->option = blobmsg_data(opt);
986 if (rpc_uci_lookup(ptr) || !ptr->o)
989 uci_delete(cursor, ptr);
994 rpc_uci_delete(struct ubus_context *ctx, struct ubus_object *obj,
995 struct ubus_request_data *req, const char *method,
996 struct blob_attr *msg)
998 struct blob_attr *tb[__RPC_D_MAX];
999 struct uci_package *p = NULL;
1000 struct uci_element *e, *tmp;
1001 struct uci_ptr ptr = { 0 };
1003 blobmsg_parse(rpc_uci_delete_policy, __RPC_D_MAX, tb,
1004 blob_data(msg), blob_len(msg));
1006 if (!tb[RPC_D_CONFIG] ||
1007 (!tb[RPC_D_SECTION] && !tb[RPC_D_TYPE] && !tb[RPC_D_MATCH]))
1008 return UBUS_STATUS_INVALID_ARGUMENT;
1010 if (!rpc_uci_write_access(tb[RPC_D_SESSION], tb[RPC_D_CONFIG]))
1011 return UBUS_STATUS_PERMISSION_DENIED;
1013 ptr.package = blobmsg_data(tb[RPC_D_CONFIG]);
1015 if (uci_load(cursor, ptr.package, &p))
1016 return rpc_uci_status();
1018 if (tb[RPC_D_SECTION])
1020 ptr.section = blobmsg_data(tb[RPC_D_SECTION]);
1022 if (tb[RPC_D_OPTIONS])
1023 rpc_uci_merge_delete(tb[RPC_D_OPTIONS], &ptr);
1025 rpc_uci_merge_delete(tb[RPC_D_OPTION], &ptr);
1029 uci_foreach_element_safe(&p->sections, tmp, e)
1031 if (!rpc_uci_match_section(uci_to_section(e),
1032 tb[RPC_D_TYPE], tb[RPC_D_MATCH]))
1036 ptr.section = e->name;
1038 if (tb[RPC_D_OPTIONS])
1039 rpc_uci_merge_delete(tb[RPC_D_OPTIONS], &ptr);
1041 rpc_uci_merge_delete(tb[RPC_D_OPTION], &ptr);
1045 uci_save(cursor, p);
1046 uci_unload(cursor, p);
1048 return rpc_uci_status();
1052 rpc_uci_rename(struct ubus_context *ctx, struct ubus_object *obj,
1053 struct ubus_request_data *req, const char *method,
1054 struct blob_attr *msg)
1056 struct blob_attr *tb[__RPC_R_MAX];
1057 struct uci_package *p = NULL;
1058 struct uci_ptr ptr = { 0 };
1060 blobmsg_parse(rpc_uci_rename_policy, __RPC_R_MAX, tb,
1061 blob_data(msg), blob_len(msg));
1063 if (!tb[RPC_R_CONFIG] || !tb[RPC_R_SECTION] || !tb[RPC_R_NAME])
1064 return UBUS_STATUS_INVALID_ARGUMENT;
1066 if (!rpc_uci_write_access(tb[RPC_R_SESSION], tb[RPC_R_CONFIG]))
1067 return UBUS_STATUS_PERMISSION_DENIED;
1069 ptr.package = blobmsg_data(tb[RPC_R_CONFIG]);
1070 ptr.section = blobmsg_data(tb[RPC_R_SECTION]);
1071 ptr.value = blobmsg_data(tb[RPC_R_NAME]);
1073 if (!rpc_uci_verify_name(ptr.value))
1074 return UBUS_STATUS_INVALID_ARGUMENT;
1076 if (tb[RPC_R_OPTION])
1077 ptr.option = blobmsg_data(tb[RPC_R_OPTION]);
1079 if (uci_load(cursor, ptr.package, &p))
1080 return rpc_uci_status();
1082 if (uci_lookup_ptr(cursor, &ptr, NULL, true))
1085 if ((ptr.option && !ptr.o) || !ptr.s)
1087 cursor->err = UCI_ERR_NOTFOUND;
1091 if (uci_rename(cursor, &ptr))
1094 uci_save(cursor, p);
1097 uci_unload(cursor, p);
1099 return rpc_uci_status();
1103 rpc_uci_order(struct ubus_context *ctx, struct ubus_object *obj,
1104 struct ubus_request_data *req, const char *method,
1105 struct blob_attr *msg)
1107 struct blob_attr *tb[__RPC_O_MAX];
1108 struct blob_attr *cur;
1109 struct uci_package *p = NULL;
1110 struct uci_ptr ptr = { 0 };
1113 blobmsg_parse(rpc_uci_order_policy, __RPC_O_MAX, tb,
1114 blob_data(msg), blob_len(msg));
1116 if (!tb[RPC_O_CONFIG] || !tb[RPC_O_SECTIONS])
1117 return UBUS_STATUS_INVALID_ARGUMENT;
1119 if (!rpc_uci_write_access(tb[RPC_O_SESSION], tb[RPC_O_CONFIG]))
1120 return UBUS_STATUS_PERMISSION_DENIED;
1122 ptr.package = blobmsg_data(tb[RPC_O_CONFIG]);
1124 if (uci_load(cursor, ptr.package, &p))
1125 return rpc_uci_status();
1127 blobmsg_for_each_attr(cur, tb[RPC_O_SECTIONS], rem)
1129 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
1133 ptr.section = blobmsg_data(cur);
1135 if (uci_lookup_ptr(cursor, &ptr, NULL, true) || !ptr.s)
1138 uci_reorder_section(cursor, ptr.s, i++);
1141 uci_save(cursor, p);
1142 uci_unload(cursor, p);
1144 return rpc_uci_status();
1148 rpc_uci_dump_change(struct uci_delta *d)
1151 const char *types[] = {
1152 [UCI_CMD_REORDER] = "order",
1153 [UCI_CMD_REMOVE] = "remove",
1154 [UCI_CMD_RENAME] = "rename",
1155 [UCI_CMD_ADD] = "add",
1156 [UCI_CMD_LIST_ADD] = "list-add",
1157 [UCI_CMD_LIST_DEL] = "list-del",
1158 [UCI_CMD_CHANGE] = "set",
1164 c = blobmsg_open_array(&buf, NULL);
1166 blobmsg_add_string(&buf, NULL, types[d->cmd]);
1167 blobmsg_add_string(&buf, NULL, d->section);
1170 blobmsg_add_string(&buf, NULL, d->e.name);
1174 if (d->cmd == UCI_CMD_REORDER)
1175 blobmsg_add_u32(&buf, NULL, strtoul(d->value, NULL, 10));
1177 blobmsg_add_string(&buf, NULL, d->value);
1180 blobmsg_close_array(&buf, c);
1184 rpc_uci_changes(struct ubus_context *ctx, struct ubus_object *obj,
1185 struct ubus_request_data *req, const char *method,
1186 struct blob_attr *msg)
1188 struct blob_attr *tb[__RPC_C_MAX];
1189 struct uci_package *p = NULL;
1190 struct uci_element *e;
1195 blobmsg_parse(rpc_uci_config_policy, __RPC_C_MAX, tb,
1196 blob_data(msg), blob_len(msg));
1198 if (tb[RPC_C_CONFIG])
1200 if (!rpc_uci_read_access(tb[RPC_C_SESSION], tb[RPC_C_CONFIG]))
1201 return UBUS_STATUS_PERMISSION_DENIED;
1203 if (uci_load(cursor, blobmsg_data(tb[RPC_C_CONFIG]), &p))
1204 return rpc_uci_status();
1206 blob_buf_init(&buf, 0);
1207 c = blobmsg_open_array(&buf, "changes");
1209 uci_foreach_element(&p->saved_delta, e)
1210 rpc_uci_dump_change(uci_to_delta(e));
1212 blobmsg_close_array(&buf, c);
1214 uci_unload(cursor, p);
1216 ubus_send_reply(ctx, req, buf.head);
1218 return rpc_uci_status();
1221 rpc_uci_set_savedir(tb[RPC_C_SESSION]);
1223 if (uci_list_configs(cursor, &configs))
1224 return rpc_uci_status();
1226 blob_buf_init(&buf, 0);
1228 c = blobmsg_open_table(&buf, "changes");
1230 for (i = 0; configs[i]; i++)
1232 if (tb[RPC_C_SESSION] &&
1233 !rpc_session_access(blobmsg_data(tb[RPC_C_SESSION]), "uci",
1234 configs[i], "read"))
1237 if (uci_load(cursor, configs[i], &p))
1240 if (!uci_list_empty(&p->saved_delta))
1242 d = blobmsg_open_array(&buf, configs[i]);
1244 uci_foreach_element(&p->saved_delta, e)
1245 rpc_uci_dump_change(uci_to_delta(e));
1247 blobmsg_close_array(&buf, d);
1250 uci_unload(cursor, p);
1253 blobmsg_close_table(&buf, c);
1255 ubus_send_reply(ctx, req, buf.head);
1261 rpc_uci_trigger_event(struct ubus_context *ctx, const char *config)
1263 char *pkg = strdup(config);
1264 static struct blob_buf b;
1267 if (!ubus_lookup_id(ctx, "service", &id)) {
1270 blob_buf_init(&b, 0);
1271 blobmsg_add_string(&b, "type", "config.change");
1272 c = blobmsg_open_table(&b, "data");
1273 blobmsg_add_string(&b, "package", pkg);
1274 blobmsg_close_table(&b, c);
1275 ubus_invoke(ctx, id, "event", b.head, NULL, 0, 1000);
1281 rpc_uci_revert_commit(struct ubus_context *ctx, struct blob_attr *msg, bool commit)
1283 struct blob_attr *tb[__RPC_C_MAX];
1284 struct uci_package *p = NULL;
1285 struct uci_ptr ptr = { 0 };
1288 return UBUS_STATUS_PERMISSION_DENIED;
1290 blobmsg_parse(rpc_uci_config_policy, __RPC_C_MAX, tb,
1291 blob_data(msg), blob_len(msg));
1293 if (!tb[RPC_C_CONFIG])
1294 return UBUS_STATUS_INVALID_ARGUMENT;
1296 if (!rpc_uci_write_access(tb[RPC_C_SESSION], tb[RPC_C_CONFIG]))
1297 return UBUS_STATUS_PERMISSION_DENIED;
1299 ptr.package = blobmsg_data(tb[RPC_C_CONFIG]);
1303 if (!uci_load(cursor, ptr.package, &p))
1305 uci_commit(cursor, &p, false);
1306 uci_unload(cursor, p);
1307 rpc_uci_trigger_event(ctx, blobmsg_get_string(tb[RPC_C_CONFIG]));
1312 if (!uci_lookup_ptr(cursor, &ptr, NULL, true) && ptr.p)
1314 uci_revert(cursor, &ptr);
1315 uci_unload(cursor, ptr.p);
1319 return rpc_uci_status();
1323 rpc_uci_revert(struct ubus_context *ctx, struct ubus_object *obj,
1324 struct ubus_request_data *req, const char *method,
1325 struct blob_attr *msg)
1327 return rpc_uci_revert_commit(ctx, msg, false);
1331 rpc_uci_commit(struct ubus_context *ctx, struct ubus_object *obj,
1332 struct ubus_request_data *req, const char *method,
1333 struct blob_attr *msg)
1335 return rpc_uci_revert_commit(ctx, msg, true);
1339 rpc_uci_configs(struct ubus_context *ctx, struct ubus_object *obj,
1340 struct ubus_request_data *req, const char *method,
1341 struct blob_attr *msg)
1347 if (uci_list_configs(cursor, &configs))
1350 blob_buf_init(&buf, 0);
1352 c = blobmsg_open_array(&buf, "configs");
1354 for (i = 0; configs[i]; i++)
1355 blobmsg_add_string(&buf, NULL, configs[i]);
1357 blobmsg_close_array(&buf, c);
1359 ubus_send_reply(ctx, req, buf.head);
1362 return rpc_uci_status();
1367 * Remove given delta save directory (if any).
1370 rpc_uci_purge_dir(const char *path)
1375 char file[PATH_MAX];
1377 if (stat(path, &s) || !S_ISDIR(s.st_mode))
1380 if ((d = opendir(path)) != NULL)
1382 while ((e = readdir(d)) != NULL)
1384 snprintf(file, sizeof(file) - 1, "%s/%s", path, e->d_name);
1386 if (stat(file, &s) || !S_ISREG(s.st_mode))
1399 rpc_uci_apply_config(struct ubus_context *ctx, char *config)
1401 struct uci_package *p = NULL;
1403 if (!uci_load(cursor, config, &p)) {
1404 uci_commit(cursor, &p, false);
1405 uci_unload(cursor, p);
1407 rpc_uci_trigger_event(ctx, config);
1413 rpc_uci_copy_file(const char *src, const char *target, const char *file)
1418 snprintf(tmp, sizeof(tmp), "%s%s", src, file);
1419 in = fopen(tmp, "rb");
1420 snprintf(tmp, sizeof(tmp), "%s%s", target, file);
1421 out = fopen(tmp, "wb+");
1424 int len = fread(tmp, 1, sizeof(tmp), in);
1427 fwrite(tmp, 1, len, out);
1436 rpc_uci_apply_access(const char *sid, glob_t *gl)
1441 if (gl->gl_pathc < 3)
1442 return UBUS_STATUS_NO_DATA;
1444 for (i = 0; i < gl->gl_pathc; i++) {
1445 char *config = basename(gl->gl_pathv[i]);
1449 if (stat(gl->gl_pathv[i], &s) || !s.st_size)
1451 if (!rpc_session_access(sid, "uci", config, "write"))
1452 return UBUS_STATUS_PERMISSION_DENIED;
1457 return UBUS_STATUS_NO_DATA;
1463 rpc_uci_do_rollback(struct ubus_context *ctx, glob_t *gl)
1468 /* Test apply permission to see if the initiator session still exists.
1469 * If it does, restore the delta files as well, else just restore the
1470 * main configuration files. */
1472 ? rpc_uci_apply_access(apply_sid, gl) : UBUS_STATUS_NOT_FOUND;
1475 snprintf(tmp, sizeof(tmp), RPC_UCI_SAVEDIR_PREFIX "%s/", apply_sid);
1479 /* avoid merging unrelated uci changes when restoring old configs */
1480 rpc_uci_replace_savedir("/dev/null");
1482 for (i = 0; i < gl->gl_pathc; i++) {
1483 char *config = basename(gl->gl_pathv[i]);
1488 rpc_uci_copy_file(RPC_SNAPSHOT_FILES, RPC_UCI_DIR, config);
1489 rpc_uci_apply_config(ctx, config);
1494 rpc_uci_copy_file(RPC_SNAPSHOT_DELTA, tmp, config);
1497 rpc_uci_purge_dir(RPC_SNAPSHOT_FILES);
1498 rpc_uci_purge_dir(RPC_SNAPSHOT_DELTA);
1500 uloop_timeout_cancel(&apply_timer);
1501 memset(apply_sid, 0, sizeof(apply_sid));
1506 rpc_uci_apply_timeout(struct uloop_timeout *t)
1511 snprintf(tmp, sizeof(tmp), "%s/*", RPC_SNAPSHOT_FILES);
1512 if (glob(tmp, GLOB_PERIOD, NULL, &gl) < 0)
1515 rpc_uci_do_rollback(apply_ctx, &gl);
1521 rpc_uci_apply(struct ubus_context *ctx, struct ubus_object *obj,
1522 struct ubus_request_data *req, const char *method,
1523 struct blob_attr *msg)
1525 struct blob_attr *tb[__RPC_T_MAX];
1526 int timeout = RPC_APPLY_TIMEOUT;
1528 bool rollback = false;
1533 blobmsg_parse(rpc_uci_apply_policy, __RPC_T_MAX, tb,
1534 blob_data(msg), blob_len(msg));
1536 if (tb[RPC_T_ROLLBACK])
1537 rollback = blobmsg_get_bool(tb[RPC_T_ROLLBACK]);
1539 if (apply_sid[0] && rollback)
1540 return UBUS_STATUS_PERMISSION_DENIED;
1542 if (!tb[RPC_T_SESSION])
1543 return UBUS_STATUS_INVALID_ARGUMENT;
1545 sid = blobmsg_data(tb[RPC_T_SESSION]);
1547 if (tb[RPC_T_TIMEOUT])
1548 timeout = blobmsg_get_u32(tb[RPC_T_TIMEOUT]);
1550 rpc_uci_purge_dir(RPC_SNAPSHOT_FILES);
1551 rpc_uci_purge_dir(RPC_SNAPSHOT_DELTA);
1553 if (!apply_sid[0]) {
1554 rpc_uci_set_savedir(tb[RPC_T_SESSION]);
1556 mkdir(RPC_SNAPSHOT_FILES, 0700);
1557 mkdir(RPC_SNAPSHOT_DELTA, 0700);
1559 snprintf(tmp, sizeof(tmp), RPC_UCI_SAVEDIR_PREFIX "%s/*", sid);
1560 if (glob(tmp, GLOB_PERIOD, NULL, &gl) < 0)
1561 return UBUS_STATUS_NOT_FOUND;
1563 snprintf(tmp, sizeof(tmp), RPC_UCI_SAVEDIR_PREFIX "%s/", sid);
1565 ret = rpc_uci_apply_access(sid, &gl);
1571 /* copy SID early because rpc_uci_apply_config() will clobber buf */
1573 strncpy(apply_sid, sid, RPC_SID_LEN);
1575 for (i = 0; i < gl.gl_pathc; i++) {
1576 char *config = basename(gl.gl_pathv[i]);
1582 if (stat(gl.gl_pathv[i], &s) || !s.st_size)
1585 rpc_uci_copy_file(RPC_UCI_DIR, RPC_SNAPSHOT_FILES, config);
1586 rpc_uci_copy_file(tmp, RPC_SNAPSHOT_DELTA, config);
1587 rpc_uci_apply_config(ctx, config);
1593 apply_timer.cb = rpc_uci_apply_timeout;
1594 uloop_timeout_set(&apply_timer, timeout * 1000);
1603 rpc_uci_confirm(struct ubus_context *ctx, struct ubus_object *obj,
1604 struct ubus_request_data *req, const char *method,
1605 struct blob_attr *msg)
1607 struct blob_attr *tb[__RPC_B_MAX];
1610 blobmsg_parse(rpc_uci_rollback_policy, __RPC_B_MAX, tb,
1611 blob_data(msg), blob_len(msg));
1613 if (!tb[RPC_B_SESSION])
1614 return UBUS_STATUS_INVALID_ARGUMENT;
1616 sid = blobmsg_data(tb[RPC_B_SESSION]);
1619 return UBUS_STATUS_NO_DATA;
1621 if (strcmp(apply_sid, sid))
1622 return UBUS_STATUS_PERMISSION_DENIED;
1624 rpc_uci_purge_dir(RPC_SNAPSHOT_FILES);
1625 rpc_uci_purge_dir(RPC_SNAPSHOT_DELTA);
1627 uloop_timeout_cancel(&apply_timer);
1628 memset(apply_sid, 0, sizeof(apply_sid));
1635 rpc_uci_rollback(struct ubus_context *ctx, struct ubus_object *obj,
1636 struct ubus_request_data *req, const char *method,
1637 struct blob_attr *msg)
1639 struct blob_attr *tb[__RPC_B_MAX];
1644 blobmsg_parse(rpc_uci_rollback_policy, __RPC_B_MAX, tb,
1645 blob_data(msg), blob_len(msg));
1648 return UBUS_STATUS_NO_DATA;
1650 if (!tb[RPC_B_SESSION])
1651 return UBUS_STATUS_INVALID_ARGUMENT;
1653 sid = blobmsg_data(tb[RPC_B_SESSION]);
1655 if (strcmp(apply_sid, sid))
1656 return UBUS_STATUS_PERMISSION_DENIED;
1658 snprintf(tmp, sizeof(tmp), "%s/*", RPC_SNAPSHOT_FILES);
1659 if (glob(tmp, GLOB_PERIOD, NULL, &gl) < 0)
1660 return UBUS_STATUS_NOT_FOUND;
1662 rpc_uci_do_rollback(ctx, &gl);
1670 rpc_uci_reload(struct ubus_context *ctx, struct ubus_object *obj,
1671 struct ubus_request_data *req, const char *method,
1672 struct blob_attr *msg)
1674 char * const cmd[2] = { "/sbin/reload_config", NULL };
1677 /* wait for the RPC call to complete */
1679 return execv(cmd[0], cmd);
1686 * Session destroy callback to purge associated delta directory.
1689 rpc_uci_purge_savedir_cb(struct rpc_session *ses, void *priv)
1691 char path[PATH_MAX];
1693 snprintf(path, sizeof(path) - 1, RPC_UCI_SAVEDIR_PREFIX "%s", ses->id);
1694 rpc_uci_purge_dir(path);
1698 * Removes all delta directories which match the RPC_UCI_SAVEDIR_PREFIX.
1699 * This is used to clean up garbage when starting rpcd.
1701 void rpc_uci_purge_savedirs(void)
1706 if (!glob(RPC_UCI_SAVEDIR_PREFIX "*", 0, NULL, &gl))
1708 for (i = 0; i < gl.gl_pathc; i++)
1709 rpc_uci_purge_dir(gl.gl_pathv[i]);
1715 int rpc_uci_api_init(struct ubus_context *ctx)
1717 static const struct ubus_method uci_methods[] = {
1718 { .name = "configs", .handler = rpc_uci_configs },
1719 UBUS_METHOD("get", rpc_uci_get, rpc_uci_get_policy),
1720 UBUS_METHOD("state", rpc_uci_state, rpc_uci_get_policy),
1721 UBUS_METHOD("add", rpc_uci_add, rpc_uci_add_policy),
1722 UBUS_METHOD("set", rpc_uci_set, rpc_uci_set_policy),
1723 UBUS_METHOD("delete", rpc_uci_delete, rpc_uci_delete_policy),
1724 UBUS_METHOD("rename", rpc_uci_rename, rpc_uci_rename_policy),
1725 UBUS_METHOD("order", rpc_uci_order, rpc_uci_order_policy),
1726 UBUS_METHOD("changes", rpc_uci_changes, rpc_uci_config_policy),
1727 UBUS_METHOD("revert", rpc_uci_revert, rpc_uci_config_policy),
1728 UBUS_METHOD("commit", rpc_uci_commit, rpc_uci_config_policy),
1729 UBUS_METHOD("apply", rpc_uci_apply, rpc_uci_apply_policy),
1730 UBUS_METHOD("confirm", rpc_uci_confirm, rpc_uci_rollback_policy),
1731 UBUS_METHOD("rollback", rpc_uci_rollback, rpc_uci_rollback_policy),
1732 UBUS_METHOD_NOARG("reload_config", rpc_uci_reload),
1735 static struct ubus_object_type uci_type =
1736 UBUS_OBJECT_TYPE("luci-rpc-uci", uci_methods);
1738 static struct ubus_object obj = {
1741 .methods = uci_methods,
1742 .n_methods = ARRAY_SIZE(uci_methods),
1745 static struct rpc_session_cb cb = {
1746 .cb = rpc_uci_purge_savedir_cb
1749 cursor = uci_alloc_context();
1752 return UBUS_STATUS_UNKNOWN_ERROR;
1754 rpc_session_destroy_cb(&cb);
1756 return ubus_add_object(ctx, &obj);