f0738a98b5191a6fb220f9eafb7866e08f41d942
[project/netifd.git] / proto-shell.c
1 #define _GNU_SOURCE
2
3 #include <string.h>
4 #include <stdlib.h>
5 #include <stdio.h>
6 #include <glob.h>
7 #include <unistd.h>
8 #include <fcntl.h>
9 #include <signal.h>
10
11 #include <arpa/inet.h>
12 #include <netinet/in.h>
13
14 #include <libubox/blobmsg_json.h>
15
16 #include "netifd.h"
17 #include "interface.h"
18 #include "interface-ip.h"
19 #include "proto.h"
20
21 static struct netifd_fd proto_fd;
22
23 enum proto_shell_sm {
24         S_IDLE,
25         S_SETUP,
26         S_SETUP_ABORT,
27         S_TEARDOWN,
28 };
29
30 struct proto_shell_handler {
31         struct list_head list;
32         struct proto_handler proto;
33         struct config_param_list config;
34         char *config_buf;
35         bool init_available;
36         char script_name[];
37 };
38
39 struct proto_shell_state {
40         struct interface_proto_state proto;
41         struct proto_shell_handler *handler;
42         struct blob_attr *config;
43
44         struct device_user l3_dev;
45
46         struct uloop_timeout teardown_timeout;
47
48         struct netifd_process script_task;
49         struct netifd_process proto_task;
50
51         enum proto_shell_sm sm;
52         bool proto_task_killed;
53
54         int last_error;
55 };
56
57 static int
58 proto_shell_handler(struct interface_proto_state *proto,
59                     enum interface_proto_cmd cmd, bool force)
60 {
61         struct proto_shell_state *state;
62         struct proto_shell_handler *handler;
63         struct netifd_process *proc;
64         static char error_buf[32];
65         const char *argv[7];
66         char *envp[2];
67         const char *action;
68         char *config;
69         int ret, i = 0, j = 0;
70
71         state = container_of(proto, struct proto_shell_state, proto);
72         handler = state->handler;
73         proc = &state->script_task;
74
75         if (cmd == PROTO_CMD_SETUP) {
76                 action = "setup";
77                 state->last_error = -1;
78         } else {
79                 if (state->sm == S_TEARDOWN)
80                         return 0;
81
82                 if (state->script_task.uloop.pending) {
83                         if (state->sm != S_SETUP_ABORT) {
84                                 uloop_timeout_set(&state->teardown_timeout, 1000);
85                                 kill(state->script_task.uloop.pid, SIGTERM);
86                                 if (state->proto_task.uloop.pending)
87                                         kill(state->proto_task.uloop.pid, SIGTERM);
88                                 state->sm = S_SETUP_ABORT;
89                         }
90                         return 0;
91                 }
92
93                 action = "teardown";
94                 state->sm = S_TEARDOWN;
95                 if (state->last_error >= 0) {
96                         snprintf(error_buf, sizeof(error_buf), "ERROR=%d", state->last_error);
97                         envp[j++] = error_buf;
98                 }
99                 uloop_timeout_set(&state->teardown_timeout, 5000);
100         }
101
102         config = blobmsg_format_json(state->config, true);
103         if (!config)
104                 return -1;
105
106         argv[i++] = handler->script_name;
107         argv[i++] = handler->proto.name;
108         argv[i++] = action;
109         argv[i++] = proto->iface->name;
110         argv[i++] = config;
111         if (proto->iface->main_dev.dev)
112                 argv[i++] = proto->iface->main_dev.dev->ifname;
113         argv[i] = NULL;
114         envp[j] = NULL;
115
116         ret = netifd_start_process(argv, envp, proc);
117         free(config);
118
119         return ret;
120 }
121
122 static void
123 proto_shell_task_finish(struct proto_shell_state *state,
124                         struct netifd_process *task)
125 {
126         switch (state->sm) {
127         case S_IDLE:
128                 if (task == &state->proto_task)
129                         state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
130                 /* fall through */
131         case S_SETUP:
132                 if (task == &state->proto_task)
133                         proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN,
134                                             false);
135                 break;
136
137         case S_SETUP_ABORT:
138                 if (state->script_task.uloop.pending ||
139                     state->proto_task.uloop.pending)
140                         break;
141
142                 uloop_timeout_cancel(&state->teardown_timeout);
143                 state->sm = S_IDLE;
144                 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
145                 break;
146
147         case S_TEARDOWN:
148                 if (state->script_task.uloop.pending)
149                         break;
150
151                 if (state->proto_task.uloop.pending) {
152                         if (!state->proto_task_killed)
153                                 kill(state->proto_task.uloop.pid, SIGTERM);
154                         break;
155                 }
156
157                 uloop_timeout_cancel(&state->teardown_timeout);
158                 state->sm = S_IDLE;
159                 state->proto.proto_event(&state->proto, IFPEV_DOWN);
160                 break;
161         }
162 }
163
164 static void
165 proto_shell_teardown_timeout_cb(struct uloop_timeout *timeout)
166 {
167         struct proto_shell_state *state;
168
169         state = container_of(timeout, struct proto_shell_state, teardown_timeout);
170
171         netifd_kill_process(&state->script_task);
172         netifd_kill_process(&state->proto_task);
173         proto_shell_task_finish(state, NULL);
174 }
175
176 static void
177 proto_shell_script_cb(struct netifd_process *p, int ret)
178 {
179         struct proto_shell_state *state;
180
181         state = container_of(p, struct proto_shell_state, script_task);
182         proto_shell_task_finish(state, p);
183 }
184
185 static void
186 proto_shell_task_cb(struct netifd_process *p, int ret)
187 {
188         struct proto_shell_state *state;
189
190         state = container_of(p, struct proto_shell_state, proto_task);
191
192         if (state->sm == S_IDLE || state->sm == S_SETUP)
193                 state->last_error = WEXITSTATUS(ret);
194
195         proto_shell_task_finish(state, p);
196 }
197
198 static void
199 proto_shell_free(struct interface_proto_state *proto)
200 {
201         struct proto_shell_state *state;
202
203         state = container_of(proto, struct proto_shell_state, proto);
204         free(state->config);
205         free(state);
206 }
207
208 static void
209 proto_shell_parse_route_list(struct interface *iface, struct blob_attr *attr,
210                              bool v6)
211 {
212         struct blob_attr *cur;
213         int rem;
214
215         blobmsg_for_each_attr(cur, attr, rem) {
216                 if (blobmsg_type(cur) != BLOBMSG_TYPE_TABLE) {
217                         DPRINTF("Ignore wrong route type: %d\n", blobmsg_type(cur));
218                         continue;
219                 }
220
221                 interface_ip_add_route(iface, cur, v6);
222         }
223 }
224
225 enum {
226         NOTIFY_ACTION,
227         NOTIFY_ERROR,
228         NOTIFY_COMMAND,
229         NOTIFY_ENV,
230         NOTIFY_SIGNAL,
231         NOTIFY_AVAILABLE,
232         NOTIFY_LINK_UP,
233         NOTIFY_IFNAME,
234         NOTIFY_ADDR_EXT,
235         NOTIFY_ROUTES,
236         NOTIFY_ROUTES6,
237         NOTIFY_DNS_SEARCH,
238         __NOTIFY_LAST
239 };
240
241 static const struct blobmsg_policy notify_attr[__NOTIFY_LAST] = {
242         [NOTIFY_ACTION] = { .name = "action", .type = BLOBMSG_TYPE_INT32 },
243         [NOTIFY_ERROR] = { .name = "error", .type = BLOBMSG_TYPE_ARRAY },
244         [NOTIFY_COMMAND] = { .name = "command", .type = BLOBMSG_TYPE_ARRAY },
245         [NOTIFY_ENV] = { .name = "env", .type = BLOBMSG_TYPE_ARRAY },
246         [NOTIFY_SIGNAL] = { .name = "signal", .type = BLOBMSG_TYPE_INT32 },
247         [NOTIFY_AVAILABLE] = { .name = "available", .type = BLOBMSG_TYPE_BOOL },
248         [NOTIFY_LINK_UP] = { .name = "link-up", .type = BLOBMSG_TYPE_BOOL },
249         [NOTIFY_IFNAME] = { .name = "ifname", .type = BLOBMSG_TYPE_STRING },
250         [NOTIFY_ADDR_EXT] = { .name = "address-external", .type = BLOBMSG_TYPE_BOOL },
251         [NOTIFY_ROUTES] = { .name = "routes", .type = BLOBMSG_TYPE_ARRAY },
252         [NOTIFY_ROUTES6] = { .name = "routes6", .type = BLOBMSG_TYPE_ARRAY },
253         [NOTIFY_DNS_SEARCH] = { .name = "dns_search", .type = BLOBMSG_TYPE_ARRAY },
254 };
255
256 static int
257 proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data, struct blob_attr **tb)
258 {
259         struct interface_ip_settings *ip;
260         struct interface *iface = state->proto.iface;
261         struct blob_attr *cur;
262         int dev_create = 1;
263         bool addr_ext = false;
264         bool up;
265
266         if (!tb[NOTIFY_LINK_UP])
267                 return UBUS_STATUS_INVALID_ARGUMENT;
268
269         up = blobmsg_get_bool(tb[NOTIFY_LINK_UP]);
270         if (!up) {
271                 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
272                 return 0;
273         }
274
275         if ((cur = tb[NOTIFY_ADDR_EXT]) != NULL) {
276                 addr_ext = blobmsg_get_bool(cur);
277                 if (addr_ext)
278                         dev_create = 2;
279         }
280
281         if (!tb[NOTIFY_IFNAME]) {
282                 if (!iface->main_dev.dev)
283                         return UBUS_STATUS_INVALID_ARGUMENT;
284         } else {
285                 if (state->l3_dev.dev)
286                         device_remove_user(&state->l3_dev);
287
288                 device_add_user(&state->l3_dev,
289                         device_get(blobmsg_data(tb[NOTIFY_IFNAME]), dev_create));
290                 iface->l3_dev = &state->l3_dev;
291                 device_claim(&state->l3_dev);
292         }
293
294         ip = &iface->proto_ip;
295         interface_update_start(iface);
296         proto_apply_ip_settings(iface, data, addr_ext);
297
298         if ((cur = tb[NOTIFY_ROUTES]) != NULL)
299                 proto_shell_parse_route_list(state->proto.iface, cur, false);
300
301         if ((cur = tb[NOTIFY_ROUTES6]) != NULL)
302                 proto_shell_parse_route_list(state->proto.iface, cur, true);
303
304         if ((cur = tb[NOTIFY_DNS_SEARCH]) != NULL)
305                 interface_add_dns_search_list(ip, cur);
306
307         interface_update_complete(state->proto.iface);
308
309         state->proto.proto_event(&state->proto, IFPEV_UP);
310
311         return 0;
312 }
313
314 static bool
315 fill_string_list(struct blob_attr *attr, char **argv, int max)
316 {
317         struct blob_attr *cur;
318         int argc = 0;
319         int rem;
320
321         if (!attr)
322                 goto out;
323
324         blobmsg_for_each_attr(cur, attr, rem) {
325                 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
326                         return false;
327
328                 if (!blobmsg_check_attr(cur, NULL))
329                         return false;
330
331                 argv[argc++] = blobmsg_data(cur);
332                 if (argc == max - 1)
333                         return false;
334         }
335
336 out:
337         argv[argc] = NULL;
338         return true;
339 }
340
341 static int
342 proto_shell_run_command(struct proto_shell_state *state, struct blob_attr **tb)
343 {
344         static char *argv[64];
345         static char *env[32];
346
347         if (!tb[NOTIFY_COMMAND])
348                 goto error;
349
350         if (!fill_string_list(tb[NOTIFY_COMMAND], argv, ARRAY_SIZE(argv)))
351                 goto error;
352
353         if (!fill_string_list(tb[NOTIFY_ENV], env, ARRAY_SIZE(env)))
354                 goto error;
355
356         netifd_start_process((const char **) argv, (char **) env, &state->proto_task);
357
358         return 0;
359
360 error:
361         return UBUS_STATUS_INVALID_ARGUMENT;
362 }
363
364 static int
365 proto_shell_kill_command(struct proto_shell_state *state, struct blob_attr **tb)
366 {
367         unsigned int signal = ~0;
368
369         if (tb[NOTIFY_SIGNAL])
370                 signal = blobmsg_get_u32(tb[NOTIFY_SIGNAL]);
371
372         if (signal > 31)
373                 signal = SIGTERM;
374
375         if (state->proto_task.uloop.pending) {
376                 state->proto_task_killed = true;
377                 kill(state->proto_task.uloop.pid, signal);
378         }
379
380         return 0;
381 }
382
383 static int
384 proto_shell_notify_error(struct proto_shell_state *state, struct blob_attr **tb)
385 {
386         struct blob_attr *cur;
387         char *data[16];
388         int n_data = 0;
389         int rem;
390
391         if (!tb[NOTIFY_ERROR])
392                 return UBUS_STATUS_INVALID_ARGUMENT;
393
394         blobmsg_for_each_attr(cur, tb[NOTIFY_ERROR], rem) {
395                 if (n_data + 1 == ARRAY_SIZE(data))
396                         goto error;
397
398                 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
399                         goto error;
400
401                 if (!blobmsg_check_attr(cur, NULL))
402                         goto error;
403
404                 data[n_data++] = blobmsg_data(cur);
405         }
406
407         if (!n_data)
408                 goto error;
409
410         interface_add_error(state->proto.iface, state->handler->proto.name,
411                         data[0], (const char **) &data[1], n_data - 1);
412
413         return 0;
414
415 error:
416         return UBUS_STATUS_INVALID_ARGUMENT;
417 }
418
419 static int
420 proto_shell_block_restart(struct proto_shell_state *state, struct blob_attr **tb)
421 {
422         state->proto.iface->autostart = false;
423         return 0;
424 }
425
426 static int
427 proto_shell_set_available(struct proto_shell_state *state, struct blob_attr **tb)
428 {
429         if (!tb[NOTIFY_AVAILABLE])
430                 return UBUS_STATUS_INVALID_ARGUMENT;
431
432         interface_set_available(state->proto.iface, blobmsg_get_bool(tb[NOTIFY_AVAILABLE]));
433         return 0;
434 }
435
436 static int
437 proto_shell_notify(struct interface_proto_state *proto, struct blob_attr *attr)
438 {
439         struct proto_shell_state *state;
440         struct blob_attr *tb[__NOTIFY_LAST];
441
442         state = container_of(proto, struct proto_shell_state, proto);
443
444         blobmsg_parse(notify_attr, __NOTIFY_LAST, tb, blob_data(attr), blob_len(attr));
445         if (!tb[NOTIFY_ACTION])
446                 return UBUS_STATUS_INVALID_ARGUMENT;
447
448         switch(blobmsg_get_u32(tb[NOTIFY_ACTION])) {
449         case 0:
450                 return proto_shell_update_link(state, attr, tb);
451         case 1:
452                 return proto_shell_run_command(state, tb);
453         case 2:
454                 return proto_shell_kill_command(state, tb);
455         case 3:
456                 return proto_shell_notify_error(state, tb);
457         case 4:
458                 return proto_shell_block_restart(state, tb);
459         case 5:
460                 return proto_shell_set_available(state, tb);
461         default:
462                 return UBUS_STATUS_INVALID_ARGUMENT;
463         }
464 }
465
466 static struct interface_proto_state *
467 proto_shell_attach(const struct proto_handler *h, struct interface *iface,
468                    struct blob_attr *attr)
469 {
470         struct proto_shell_state *state;
471
472         state = calloc(1, sizeof(*state));
473         state->config = malloc(blob_pad_len(attr));
474         if (!state->config)
475                 goto error;
476
477         memcpy(state->config, attr, blob_pad_len(attr));
478         state->proto.free = proto_shell_free;
479         state->proto.notify = proto_shell_notify;
480         state->proto.cb = proto_shell_handler;
481         state->teardown_timeout.cb = proto_shell_teardown_timeout_cb;
482         state->script_task.cb = proto_shell_script_cb;
483         state->script_task.dir_fd = proto_fd.fd;
484         state->script_task.log_prefix = iface->name;
485         state->proto_task.cb = proto_shell_task_cb;
486         state->proto_task.dir_fd = proto_fd.fd;
487         state->proto_task.log_prefix = iface->name;
488         state->handler = container_of(h, struct proto_shell_handler, proto);
489
490         return &state->proto;
491
492 error:
493         free(state);
494         return NULL;
495 }
496
497 static json_object *
498 check_type(json_object *obj, json_type type)
499 {
500         if (!obj)
501                 return NULL;
502
503         if (json_object_get_type(obj) != type)
504                 return NULL;
505
506         return obj;
507 }
508
509 static inline json_object *
510 get_field(json_object *obj, const char *name, json_type type)
511 {
512         return check_type(json_object_object_get(obj, name), type);
513 }
514
515 static char *
516 proto_shell_parse_config(struct config_param_list *config, json_object *obj)
517 {
518         struct blobmsg_policy *attrs;
519         char *str_buf, *str_cur;
520         int str_len = 0;
521         int i;
522
523         config->n_params = json_object_array_length(obj);
524         attrs = calloc(1, sizeof(*attrs) * config->n_params);
525         if (!attrs)
526                 return NULL;
527
528         config->params = attrs;
529         for (i = 0; i < config->n_params; i++) {
530                 json_object *cur, *name, *type;
531
532                 cur = check_type(json_object_array_get_idx(obj, i), json_type_array);
533                 if (!cur)
534                         goto error;
535
536                 name = check_type(json_object_array_get_idx(cur, 0), json_type_string);
537                 if (!name)
538                         goto error;
539
540                 type = check_type(json_object_array_get_idx(cur, 1), json_type_int);
541                 if (!type)
542                         goto error;
543
544                 attrs[i].name = json_object_get_string(name);
545                 attrs[i].type = json_object_get_int(type);
546                 if (attrs[i].type > BLOBMSG_TYPE_LAST)
547                         goto error;
548
549                 str_len += strlen(attrs[i].name) + 1;
550         }
551
552         str_buf = malloc(str_len);
553         if (!str_buf)
554                 goto error;
555
556         str_cur = str_buf;
557         for (i = 0; i < config->n_params; i++) {
558                 const char *name = attrs[i].name;
559
560                 attrs[i].name = str_cur;
561                 str_cur += sprintf(str_cur, "%s", name) + 1;
562         }
563
564         return str_buf;
565
566 error:
567         free(attrs);
568         config->n_params = 0;
569         return NULL;
570 }
571
572 static void
573 proto_shell_add_handler(const char *script, json_object *obj)
574 {
575         struct proto_shell_handler *handler;
576         struct proto_handler *proto;
577         json_object *config, *tmp;
578         const char *name;
579         char *str;
580
581         if (!check_type(obj, json_type_object))
582                 return;
583
584         tmp = get_field(obj, "name", json_type_string);
585         if (!tmp)
586                 return;
587
588         name = json_object_get_string(tmp);
589
590         handler = calloc(1, sizeof(*handler) +
591                          strlen(script) + 1 +
592                          strlen(name) + 1);
593         if (!handler)
594                 return;
595
596         strcpy(handler->script_name, script);
597
598         str = handler->script_name + strlen(handler->script_name) + 1;
599         strcpy(str, name);
600
601         proto = &handler->proto;
602         proto->name = str;
603         proto->config_params = &handler->config;
604         proto->attach = proto_shell_attach;
605
606         tmp = get_field(obj, "no-device", json_type_boolean);
607         if (tmp && json_object_get_boolean(tmp))
608                 handler->proto.flags |= PROTO_FLAG_NODEV;
609
610         tmp = get_field(obj, "available", json_type_boolean);
611         if (tmp && json_object_get_boolean(tmp))
612                 handler->proto.flags |= PROTO_FLAG_INIT_AVAILABLE;
613
614         config = get_field(obj, "config", json_type_array);
615         if (config)
616                 handler->config_buf = proto_shell_parse_config(&handler->config, config);
617
618         DPRINTF("Add handler for script %s: %s\n", script, proto->name);
619         add_proto_handler(proto);
620 }
621
622 static void proto_shell_add_script(const char *name)
623 {
624         struct json_tokener *tok = NULL;
625         json_object *obj;
626         static char buf[512];
627         char *start, *cmd;
628         FILE *f;
629         int len;
630
631 #define DUMP_SUFFIX     " '' dump"
632
633         cmd = alloca(strlen(name) + 1 + sizeof(DUMP_SUFFIX));
634         sprintf(cmd, "%s" DUMP_SUFFIX, name);
635
636         f = popen(cmd, "r");
637         if (!f)
638                 return;
639
640         do {
641                 start = fgets(buf, sizeof(buf), f);
642                 if (!start)
643                         continue;
644
645                 len = strlen(start);
646
647                 if (!tok)
648                         tok = json_tokener_new();
649
650                 obj = json_tokener_parse_ex(tok, start, len);
651                 if (!is_error(obj)) {
652                         proto_shell_add_handler(name, obj);
653                         json_object_put(obj);
654                         json_tokener_free(tok);
655                         tok = NULL;
656                 } else if (start[len - 1] == '\n') {
657                         json_tokener_free(tok);
658                         tok = NULL;
659                 }
660         } while (!feof(f) && !ferror(f));
661
662         if (tok)
663                 json_tokener_free(tok);
664
665         pclose(f);
666 }
667
668 static void __init proto_shell_init(void)
669 {
670         glob_t g;
671         int main_fd;
672         int i;
673
674         main_fd = open(".", O_RDONLY | O_DIRECTORY);
675         if (main_fd < 0)
676                 return;
677
678         if (chdir(main_path)) {
679                 perror("chdir(main path)");
680                 goto close_cur;
681         }
682
683         if (chdir("./proto"))
684                 goto close_cur;
685
686         proto_fd.fd = open(".", O_RDONLY | O_DIRECTORY);
687         if (proto_fd.fd < 0)
688                 goto close_cur;
689
690         netifd_fd_add(&proto_fd);
691         glob("./*.sh", 0, NULL, &g);
692         for (i = 0; i < g.gl_pathc; i++)
693                 proto_shell_add_script(g.gl_pathv[i]);
694
695 close_cur:
696         fchdir(main_fd);
697         close(main_fd);
698 }