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.
29 #include <libubox/blobmsg.h>
30 #include <libubox/ustream.h>
32 #include <rpcd/plugin.h>
34 /* limit of sys & proc files */
35 #define RPC_FILE_MIN_SIZE (128)
37 /* limit of regular files and command output data */
38 #define RPC_FILE_MAX_SIZE (4096 * 64)
39 #define RPC_FILE_MAX_RUNTIME (3 * 1000)
41 #define ustream_for_each_read_buffer(stream, ptr, len) \
42 for (ptr = ustream_get_read_buf(stream, &len); \
43 ptr != NULL && len > 0; \
44 ustream_consume(stream, len), ptr = ustream_get_read_buf(stream, &len))
46 #define ustream_declare(us, fd, name) \
47 us.stream.string_data = true; \
48 us.stream.r.buffer_len = 4096; \
49 us.stream.r.max_buffers = RPC_FILE_MAX_SIZE / 4096; \
50 us.stream.notify_read = rpc_file_##name##_read_cb; \
51 us.stream.notify_state = rpc_file_##name##_state_cb; \
52 ustream_fd_init(&us, fd);
54 struct rpc_file_exec_context {
55 struct ubus_context *context;
56 struct ubus_request_data request;
57 struct uloop_timeout timeout;
58 struct uloop_process process;
59 struct ustream_fd opipe;
60 struct ustream_fd epipe;
69 static struct blob_buf buf;
77 static const struct blobmsg_policy rpc_file_policy[__RPC_F_MAX] = {
78 [RPC_F_PATH] = { .name = "path", .type = BLOBMSG_TYPE_STRING },
79 [RPC_F_DATA] = { .name = "data", .type = BLOBMSG_TYPE_STRING },
89 static const struct blobmsg_policy rpc_exec_policy[__RPC_E_MAX] = {
90 [RPC_E_CMD] = { .name = "command", .type = BLOBMSG_TYPE_STRING },
91 [RPC_E_PARM] = { .name = "params", .type = BLOBMSG_TYPE_ARRAY },
92 [RPC_E_ENV] = { .name = "env", .type = BLOBMSG_TYPE_TABLE },
95 static const char *d_types[] = {
98 [DT_DIR] = "directory",
100 [DT_LNK] = "symlink",
102 [DT_SOCK] = "socket",
103 [DT_UNKNOWN] = "unknown",
108 rpc_errno_status(void)
113 return UBUS_STATUS_PERMISSION_DENIED;
116 return UBUS_STATUS_INVALID_ARGUMENT;
119 return UBUS_STATUS_NOT_FOUND;
122 return UBUS_STATUS_INVALID_ARGUMENT;
125 return UBUS_STATUS_UNKNOWN_ERROR;
129 static struct blob_attr **
130 rpc_check_path(struct blob_attr *msg, char **path, struct stat *s)
132 static struct blob_attr *tb[__RPC_F_MAX];
134 blobmsg_parse(rpc_file_policy, __RPC_F_MAX, tb, blob_data(msg), blob_len(msg));
142 *path = blobmsg_data(tb[RPC_F_PATH]);
151 rpc_file_read(struct ubus_context *ctx, struct ubus_object *obj,
152 struct ubus_request_data *req, const char *method,
153 struct blob_attr *msg)
160 if (!rpc_check_path(msg, &path, &s))
161 return rpc_errno_status();
163 if (s.st_size >= RPC_FILE_MAX_SIZE)
164 return UBUS_STATUS_NOT_SUPPORTED;
166 if ((fd = open(path, O_RDONLY)) < 0)
167 return rpc_errno_status();
169 /* some sysfs files do not report a length */
171 s.st_size = RPC_FILE_MIN_SIZE;
173 blob_buf_init(&buf, 0);
175 wbuf = blobmsg_alloc_string_buffer(&buf, "data", s.st_size + 1);
179 rv = UBUS_STATUS_UNKNOWN_ERROR;
183 if ((len = read(fd, wbuf, s.st_size)) <= 0)
185 rv = UBUS_STATUS_NO_DATA;
190 blobmsg_add_string_buffer(&buf);
192 ubus_send_reply(ctx, req, buf.head);
201 rpc_file_write(struct ubus_context *ctx, struct ubus_object *obj,
202 struct ubus_request_data *req, const char *method,
203 struct blob_attr *msg)
206 struct blob_attr *tb[__RPC_F_MAX];
208 blobmsg_parse(rpc_file_policy, __RPC_F_MAX, tb,
209 blob_data(msg), blob_len(msg));
211 if (!tb[RPC_F_PATH] || !tb[RPC_F_DATA])
212 return UBUS_STATUS_INVALID_ARGUMENT;
214 if ((fd = open(blobmsg_data(tb[RPC_F_PATH]), O_CREAT | O_TRUNC | O_WRONLY)) < 0)
215 return rpc_errno_status();
217 write(fd, blobmsg_data(tb[RPC_F_DATA]), blobmsg_data_len(tb[RPC_F_DATA]));
224 rpc_file_list(struct ubus_context *ctx, struct ubus_object *obj,
225 struct ubus_request_data *req, const char *method,
226 struct blob_attr *msg)
234 if (!rpc_check_path(msg, &path, &s))
235 return rpc_errno_status();
237 if ((fd = opendir(path)) == NULL)
238 return rpc_errno_status();
240 blob_buf_init(&buf, 0);
241 c = blobmsg_open_array(&buf, "entries");
243 while ((e = readdir(fd)) != NULL)
245 if (!strcmp(e->d_name, ".") || !strcmp(e->d_name, ".."))
248 d = blobmsg_open_table(&buf, NULL);
249 blobmsg_add_string(&buf, "name", e->d_name);
250 blobmsg_add_string(&buf, "type", d_types[e->d_type]);
251 blobmsg_close_table(&buf, d);
254 blobmsg_close_array(&buf, c);
255 ubus_send_reply(ctx, req, buf.head);
261 rpc_file_stat(struct ubus_context *ctx, struct ubus_object *obj,
262 struct ubus_request_data *req, const char *method,
263 struct blob_attr *msg)
269 if (!rpc_check_path(msg, &path, &s))
270 return rpc_errno_status();
272 blob_buf_init(&buf, 0);
274 type = S_ISREG(s.st_mode) ? DT_REG :
275 S_ISDIR(s.st_mode) ? DT_DIR :
276 S_ISCHR(s.st_mode) ? DT_CHR :
277 S_ISBLK(s.st_mode) ? DT_BLK :
278 S_ISFIFO(s.st_mode) ? DT_FIFO :
279 S_ISLNK(s.st_mode) ? DT_LNK :
280 S_ISSOCK(s.st_mode) ? DT_SOCK :
283 blobmsg_add_string(&buf, "path", path);
284 blobmsg_add_string(&buf, "type", d_types[type]);
285 blobmsg_add_u32(&buf, "size", s.st_size);
286 blobmsg_add_u32(&buf, "mode", s.st_mode);
287 blobmsg_add_u32(&buf, "atime", s.st_atime);
288 blobmsg_add_u32(&buf, "mtime", s.st_mtime);
289 blobmsg_add_u32(&buf, "ctime", s.st_ctime);
290 blobmsg_add_u32(&buf, "inode", s.st_ino);
291 blobmsg_add_u32(&buf, "uid", s.st_uid);
292 blobmsg_add_u32(&buf, "gid", s.st_gid);
294 ubus_send_reply(ctx, req, buf.head);
300 rpc_file_exec_lookup(const char *cmd)
303 int plen = 0, clen = strlen(cmd) + 1;
305 static char path[PATH_MAX];
307 if (!stat(cmd, &s) && S_ISREG(s.st_mode))
310 search = getenv("PATH");
313 search = "/bin:/usr/bin:/sbin:/usr/sbin";
319 if (*p != ':' && *p != '\0')
324 if ((plen + clen) >= sizeof(path))
327 strncpy(path, search, plen);
328 sprintf(path + plen, "/%s", cmd);
330 if (!stat(path, &s) && S_ISREG(s.st_mode))
342 rpc_ustream_to_blobmsg(struct ustream *s, const char *name)
347 if ((len = ustream_pending_data(s, false)) > 0)
349 wbuf = blobmsg_alloc_string_buffer(&buf, name, len + 1);
354 ustream_for_each_read_buffer(s, rbuf, len)
356 memcpy(wbuf, rbuf, len);
361 blobmsg_add_string_buffer(&buf);
366 rpc_file_exec_reply(struct rpc_file_exec_context *c, int rv)
368 uloop_timeout_cancel(&c->timeout);
369 uloop_process_delete(&c->process);
371 if (rv == UBUS_STATUS_OK)
373 blob_buf_init(&buf, 0);
375 blobmsg_add_u32(&buf, "code", WEXITSTATUS(c->stat));
377 rpc_ustream_to_blobmsg(&c->opipe.stream, "stdout");
378 rpc_ustream_to_blobmsg(&c->epipe.stream, "stderr");
380 ubus_send_reply(c->context, &c->request, buf.head);
383 ubus_complete_deferred_request(c->context, &c->request, rv);
385 ustream_free(&c->opipe.stream);
386 ustream_free(&c->epipe.stream);
388 close(c->opipe.fd.fd);
389 close(c->epipe.fd.fd);
395 rpc_file_exec_timeout_cb(struct uloop_timeout *t)
397 struct rpc_file_exec_context *c =
398 container_of(t, struct rpc_file_exec_context, timeout);
400 kill(c->process.pid, SIGKILL);
401 rpc_file_exec_reply(c, UBUS_STATUS_TIMEOUT);
405 rpc_file_exec_process_cb(struct uloop_process *p, int stat)
407 struct rpc_file_exec_context *c =
408 container_of(p, struct rpc_file_exec_context, process);
412 ustream_poll(&c->opipe.stream);
413 ustream_poll(&c->epipe.stream);
417 rpc_file_exec_opipe_read_cb(struct ustream *s, int bytes)
419 struct rpc_file_exec_context *c =
420 container_of(s, struct rpc_file_exec_context, opipe.stream);
422 if (ustream_read_buf_full(s))
423 rpc_file_exec_reply(c, UBUS_STATUS_NOT_SUPPORTED);
427 rpc_file_exec_epipe_read_cb(struct ustream *s, int bytes)
429 struct rpc_file_exec_context *c =
430 container_of(s, struct rpc_file_exec_context, epipe.stream);
432 if (ustream_read_buf_full(s))
433 rpc_file_exec_reply(c, UBUS_STATUS_NOT_SUPPORTED);
437 rpc_file_exec_opipe_state_cb(struct ustream *s)
439 struct rpc_file_exec_context *c =
440 container_of(s, struct rpc_file_exec_context, opipe.stream);
442 if (c->opipe.stream.eof && c->epipe.stream.eof)
443 rpc_file_exec_reply(c, UBUS_STATUS_OK);
447 rpc_file_exec_epipe_state_cb(struct ustream *s)
449 struct rpc_file_exec_context *c =
450 container_of(s, struct rpc_file_exec_context, epipe.stream);
452 if (c->opipe.stream.eof && c->epipe.stream.eof)
453 rpc_file_exec_reply(c, UBUS_STATUS_OK);
457 rpc_file_exec_run(const char *cmd,
458 const struct blob_attr *arg, const struct blob_attr *env,
459 struct ubus_context *ctx, struct ubus_request_data *req)
467 struct blob_attr *cur;
472 struct rpc_file_exec_context *c;
474 cmd = rpc_file_exec_lookup(cmd);
477 return UBUS_STATUS_NOT_FOUND;
479 c = malloc(sizeof(*c));
482 return UBUS_STATUS_UNKNOWN_ERROR;
484 if (pipe(opipe) || pipe(epipe))
485 return rpc_errno_status();
487 switch ((pid = fork()))
490 return rpc_errno_status();
505 args = malloc(sizeof(char *) * arglen);
508 return UBUS_STATUS_UNKNOWN_ERROR;
510 args[0] = (char *)cmd;
515 blobmsg_for_each_attr(cur, arg, rem)
517 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
522 if (!(args = realloc(args, sizeof(char *) * arglen)))
523 return UBUS_STATUS_UNKNOWN_ERROR;
525 args[arglen-2] = blobmsg_data(cur);
526 args[arglen-1] = NULL;
532 blobmsg_for_each_attr(cur, env, rem)
534 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
537 setenv(blobmsg_name(cur), blobmsg_data(cur), 1);
541 if (execv(cmd, args))
542 return rpc_errno_status();
545 memset(c, 0, sizeof(*c));
547 ustream_declare(c->opipe, opipe[0], exec_opipe);
548 ustream_declare(c->epipe, epipe[0], exec_epipe);
550 c->process.pid = pid;
551 c->process.cb = rpc_file_exec_process_cb;
552 uloop_process_add(&c->process);
554 c->timeout.cb = rpc_file_exec_timeout_cb;
555 uloop_timeout_set(&c->timeout, RPC_FILE_MAX_RUNTIME);
561 ubus_defer_request(ctx, req, &c->request);
564 return UBUS_STATUS_OK;
568 rpc_file_exec(struct ubus_context *ctx, struct ubus_object *obj,
569 struct ubus_request_data *req, const char *method,
570 struct blob_attr *msg)
572 struct blob_attr *tb[__RPC_E_MAX];
574 blobmsg_parse(rpc_exec_policy, __RPC_E_MAX, tb,
575 blob_data(msg), blob_len(msg));
578 return UBUS_STATUS_INVALID_ARGUMENT;
580 return rpc_file_exec_run(blobmsg_data(tb[RPC_E_CMD]),
581 tb[RPC_E_PARM], tb[RPC_E_ENV], ctx, req);
586 rpc_file_api_init(const struct rpc_daemon_ops *o, struct ubus_context *ctx)
588 static const struct ubus_method file_methods[] = {
589 UBUS_METHOD("read", rpc_file_read, rpc_file_policy),
590 UBUS_METHOD("write", rpc_file_write, rpc_file_policy),
591 UBUS_METHOD("list", rpc_file_list, rpc_file_policy),
592 UBUS_METHOD("stat", rpc_file_stat, rpc_file_policy),
593 UBUS_METHOD("exec", rpc_file_exec, rpc_exec_policy),
596 static struct ubus_object_type file_type =
597 UBUS_OBJECT_TYPE("luci-rpc-file", file_methods);
599 static struct ubus_object obj = {
602 .methods = file_methods,
603 .n_methods = ARRAY_SIZE(file_methods),
606 return ubus_add_object(ctx, &obj);
609 const struct rpc_plugin rpc_plugin = {
610 .init = rpc_file_api_init