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
;
76 static const struct blobmsg_policy rpc_file_r_policy
[__RPC_F_R_MAX
] = {
77 [RPC_F_R_PATH
] = { .name
= "path", .type
= BLOBMSG_TYPE_STRING
},
86 static const struct blobmsg_policy rpc_file_rw_policy
[__RPC_F_RW_MAX
] = {
87 [RPC_F_RW_PATH
] = { .name
= "path", .type
= BLOBMSG_TYPE_STRING
},
88 [RPC_F_RW_DATA
] = { .name
= "data", .type
= BLOBMSG_TYPE_STRING
},
98 static const struct blobmsg_policy rpc_exec_policy
[__RPC_E_MAX
] = {
99 [RPC_E_CMD
] = { .name
= "command", .type
= BLOBMSG_TYPE_STRING
},
100 [RPC_E_PARM
] = { .name
= "params", .type
= BLOBMSG_TYPE_ARRAY
},
101 [RPC_E_ENV
] = { .name
= "env", .type
= BLOBMSG_TYPE_TABLE
},
104 static const char *d_types
[] = {
107 [DT_DIR
] = "directory",
109 [DT_LNK
] = "symlink",
111 [DT_SOCK
] = "socket",
112 [DT_UNKNOWN
] = "unknown",
117 rpc_errno_status(void)
122 return UBUS_STATUS_PERMISSION_DENIED
;
125 return UBUS_STATUS_INVALID_ARGUMENT
;
128 return UBUS_STATUS_NOT_FOUND
;
131 return UBUS_STATUS_INVALID_ARGUMENT
;
134 return UBUS_STATUS_UNKNOWN_ERROR
;
138 static struct blob_attr
**
139 rpc_check_path(struct blob_attr
*msg
, char **path
, struct stat
*s
)
141 static struct blob_attr
*tb
[__RPC_F_R_MAX
];
143 blobmsg_parse(rpc_file_r_policy
, __RPC_F_R_MAX
, tb
, blob_data(msg
), blob_len(msg
));
145 if (!tb
[RPC_F_R_PATH
])
151 *path
= blobmsg_data(tb
[RPC_F_R_PATH
]);
160 rpc_file_read(struct ubus_context
*ctx
, struct ubus_object
*obj
,
161 struct ubus_request_data
*req
, const char *method
,
162 struct blob_attr
*msg
)
169 if (!rpc_check_path(msg
, &path
, &s
))
170 return rpc_errno_status();
172 if (s
.st_size
>= RPC_FILE_MAX_SIZE
)
173 return UBUS_STATUS_NOT_SUPPORTED
;
175 if ((fd
= open(path
, O_RDONLY
)) < 0)
176 return rpc_errno_status();
178 /* some sysfs files do not report a length */
180 s
.st_size
= RPC_FILE_MIN_SIZE
;
182 blob_buf_init(&buf
, 0);
184 wbuf
= blobmsg_alloc_string_buffer(&buf
, "data", s
.st_size
+ 1);
188 rv
= UBUS_STATUS_UNKNOWN_ERROR
;
192 if ((len
= read(fd
, wbuf
, s
.st_size
)) <= 0)
194 rv
= UBUS_STATUS_NO_DATA
;
199 blobmsg_add_string_buffer(&buf
);
201 ubus_send_reply(ctx
, req
, buf
.head
);
210 rpc_file_write(struct ubus_context
*ctx
, struct ubus_object
*obj
,
211 struct ubus_request_data
*req
, const char *method
,
212 struct blob_attr
*msg
)
215 struct blob_attr
*tb
[__RPC_F_RW_MAX
];
217 blobmsg_parse(rpc_file_rw_policy
, __RPC_F_RW_MAX
, tb
,
218 blob_data(msg
), blob_len(msg
));
220 if (!tb
[RPC_F_RW_PATH
] || !tb
[RPC_F_RW_DATA
])
221 return UBUS_STATUS_INVALID_ARGUMENT
;
223 if ((fd
= open(blobmsg_data(tb
[RPC_F_RW_PATH
]), O_CREAT
| O_TRUNC
| O_WRONLY
)) < 0)
224 return rpc_errno_status();
226 if (write(fd
, blobmsg_data(tb
[RPC_F_RW_DATA
]), blobmsg_data_len(tb
[RPC_F_RW_DATA
])) < 0)
227 return rpc_errno_status();
230 return rpc_errno_status();
239 rpc_file_list(struct ubus_context
*ctx
, struct ubus_object
*obj
,
240 struct ubus_request_data
*req
, const char *method
,
241 struct blob_attr
*msg
)
249 if (!rpc_check_path(msg
, &path
, &s
))
250 return rpc_errno_status();
252 if ((fd
= opendir(path
)) == NULL
)
253 return rpc_errno_status();
255 blob_buf_init(&buf
, 0);
256 c
= blobmsg_open_array(&buf
, "entries");
258 while ((e
= readdir(fd
)) != NULL
)
260 if (!strcmp(e
->d_name
, ".") || !strcmp(e
->d_name
, ".."))
263 d
= blobmsg_open_table(&buf
, NULL
);
264 blobmsg_add_string(&buf
, "name", e
->d_name
);
265 blobmsg_add_string(&buf
, "type", d_types
[e
->d_type
]);
266 blobmsg_close_table(&buf
, d
);
269 blobmsg_close_array(&buf
, c
);
270 ubus_send_reply(ctx
, req
, buf
.head
);
276 rpc_file_stat(struct ubus_context
*ctx
, struct ubus_object
*obj
,
277 struct ubus_request_data
*req
, const char *method
,
278 struct blob_attr
*msg
)
284 if (!rpc_check_path(msg
, &path
, &s
))
285 return rpc_errno_status();
287 blob_buf_init(&buf
, 0);
289 type
= S_ISREG(s
.st_mode
) ? DT_REG
:
290 S_ISDIR(s
.st_mode
) ? DT_DIR
:
291 S_ISCHR(s
.st_mode
) ? DT_CHR
:
292 S_ISBLK(s
.st_mode
) ? DT_BLK
:
293 S_ISFIFO(s
.st_mode
) ? DT_FIFO
:
294 S_ISLNK(s
.st_mode
) ? DT_LNK
:
295 S_ISSOCK(s
.st_mode
) ? DT_SOCK
:
298 blobmsg_add_string(&buf
, "path", path
);
299 blobmsg_add_string(&buf
, "type", d_types
[type
]);
300 blobmsg_add_u32(&buf
, "size", s
.st_size
);
301 blobmsg_add_u32(&buf
, "mode", s
.st_mode
);
302 blobmsg_add_u32(&buf
, "atime", s
.st_atime
);
303 blobmsg_add_u32(&buf
, "mtime", s
.st_mtime
);
304 blobmsg_add_u32(&buf
, "ctime", s
.st_ctime
);
305 blobmsg_add_u32(&buf
, "inode", s
.st_ino
);
306 blobmsg_add_u32(&buf
, "uid", s
.st_uid
);
307 blobmsg_add_u32(&buf
, "gid", s
.st_gid
);
309 ubus_send_reply(ctx
, req
, buf
.head
);
315 rpc_file_exec_lookup(const char *cmd
)
318 int plen
= 0, clen
= strlen(cmd
) + 1;
320 static char path
[PATH_MAX
];
322 if (!stat(cmd
, &s
) && S_ISREG(s
.st_mode
))
325 search
= getenv("PATH");
328 search
= "/bin:/usr/bin:/sbin:/usr/sbin";
334 if (*p
!= ':' && *p
!= '\0')
339 if ((plen
+ clen
) >= sizeof(path
))
342 strncpy(path
, search
, plen
);
343 sprintf(path
+ plen
, "/%s", cmd
);
345 if (!stat(path
, &s
) && S_ISREG(s
.st_mode
))
357 rpc_ustream_to_blobmsg(struct ustream
*s
, const char *name
)
362 if ((len
= ustream_pending_data(s
, false)) > 0)
364 wbuf
= blobmsg_alloc_string_buffer(&buf
, name
, len
+ 1);
369 ustream_for_each_read_buffer(s
, rbuf
, len
)
371 memcpy(wbuf
, rbuf
, len
);
376 blobmsg_add_string_buffer(&buf
);
381 rpc_file_exec_reply(struct rpc_file_exec_context
*c
, int rv
)
383 uloop_timeout_cancel(&c
->timeout
);
384 uloop_process_delete(&c
->process
);
386 if (rv
== UBUS_STATUS_OK
)
388 blob_buf_init(&buf
, 0);
390 blobmsg_add_u32(&buf
, "code", WEXITSTATUS(c
->stat
));
392 rpc_ustream_to_blobmsg(&c
->opipe
.stream
, "stdout");
393 rpc_ustream_to_blobmsg(&c
->epipe
.stream
, "stderr");
395 ubus_send_reply(c
->context
, &c
->request
, buf
.head
);
398 ubus_complete_deferred_request(c
->context
, &c
->request
, rv
);
400 ustream_free(&c
->opipe
.stream
);
401 ustream_free(&c
->epipe
.stream
);
403 close(c
->opipe
.fd
.fd
);
404 close(c
->epipe
.fd
.fd
);
410 rpc_file_exec_timeout_cb(struct uloop_timeout
*t
)
412 struct rpc_file_exec_context
*c
=
413 container_of(t
, struct rpc_file_exec_context
, timeout
);
415 kill(c
->process
.pid
, SIGKILL
);
416 rpc_file_exec_reply(c
, UBUS_STATUS_TIMEOUT
);
420 rpc_file_exec_process_cb(struct uloop_process
*p
, int stat
)
422 struct rpc_file_exec_context
*c
=
423 container_of(p
, struct rpc_file_exec_context
, process
);
427 ustream_poll(&c
->opipe
.stream
);
428 ustream_poll(&c
->epipe
.stream
);
432 rpc_file_exec_opipe_read_cb(struct ustream
*s
, int bytes
)
434 struct rpc_file_exec_context
*c
=
435 container_of(s
, struct rpc_file_exec_context
, opipe
.stream
);
437 if (ustream_read_buf_full(s
))
438 rpc_file_exec_reply(c
, UBUS_STATUS_NOT_SUPPORTED
);
442 rpc_file_exec_epipe_read_cb(struct ustream
*s
, int bytes
)
444 struct rpc_file_exec_context
*c
=
445 container_of(s
, struct rpc_file_exec_context
, epipe
.stream
);
447 if (ustream_read_buf_full(s
))
448 rpc_file_exec_reply(c
, UBUS_STATUS_NOT_SUPPORTED
);
452 rpc_file_exec_opipe_state_cb(struct ustream
*s
)
454 struct rpc_file_exec_context
*c
=
455 container_of(s
, struct rpc_file_exec_context
, opipe
.stream
);
457 if (c
->opipe
.stream
.eof
&& c
->epipe
.stream
.eof
)
458 rpc_file_exec_reply(c
, UBUS_STATUS_OK
);
462 rpc_file_exec_epipe_state_cb(struct ustream
*s
)
464 struct rpc_file_exec_context
*c
=
465 container_of(s
, struct rpc_file_exec_context
, epipe
.stream
);
467 if (c
->opipe
.stream
.eof
&& c
->epipe
.stream
.eof
)
468 rpc_file_exec_reply(c
, UBUS_STATUS_OK
);
472 rpc_file_exec_run(const char *cmd
,
473 const struct blob_attr
*arg
, const struct blob_attr
*env
,
474 struct ubus_context
*ctx
, struct ubus_request_data
*req
)
482 struct blob_attr
*cur
;
487 struct rpc_file_exec_context
*c
;
489 cmd
= rpc_file_exec_lookup(cmd
);
492 return UBUS_STATUS_NOT_FOUND
;
494 c
= malloc(sizeof(*c
));
497 return UBUS_STATUS_UNKNOWN_ERROR
;
499 if (pipe(opipe
) || pipe(epipe
))
500 return rpc_errno_status();
502 switch ((pid
= fork()))
505 return rpc_errno_status();
520 args
= malloc(sizeof(char *) * arglen
);
523 return UBUS_STATUS_UNKNOWN_ERROR
;
525 args
[0] = (char *)cmd
;
530 blobmsg_for_each_attr(cur
, arg
, rem
)
532 if (blobmsg_type(cur
) != BLOBMSG_TYPE_STRING
)
537 if (!(args
= realloc(args
, sizeof(char *) * arglen
)))
538 return UBUS_STATUS_UNKNOWN_ERROR
;
540 args
[arglen
-2] = blobmsg_data(cur
);
541 args
[arglen
-1] = NULL
;
547 blobmsg_for_each_attr(cur
, env
, rem
)
549 if (blobmsg_type(cur
) != BLOBMSG_TYPE_STRING
)
552 setenv(blobmsg_name(cur
), blobmsg_data(cur
), 1);
556 if (execv(cmd
, args
))
557 return rpc_errno_status();
560 memset(c
, 0, sizeof(*c
));
562 ustream_declare(c
->opipe
, opipe
[0], exec_opipe
);
563 ustream_declare(c
->epipe
, epipe
[0], exec_epipe
);
565 c
->process
.pid
= pid
;
566 c
->process
.cb
= rpc_file_exec_process_cb
;
567 uloop_process_add(&c
->process
);
569 c
->timeout
.cb
= rpc_file_exec_timeout_cb
;
570 uloop_timeout_set(&c
->timeout
, RPC_FILE_MAX_RUNTIME
);
576 ubus_defer_request(ctx
, req
, &c
->request
);
579 return UBUS_STATUS_OK
;
583 rpc_file_exec(struct ubus_context
*ctx
, struct ubus_object
*obj
,
584 struct ubus_request_data
*req
, const char *method
,
585 struct blob_attr
*msg
)
587 struct blob_attr
*tb
[__RPC_E_MAX
];
589 blobmsg_parse(rpc_exec_policy
, __RPC_E_MAX
, tb
,
590 blob_data(msg
), blob_len(msg
));
593 return UBUS_STATUS_INVALID_ARGUMENT
;
595 return rpc_file_exec_run(blobmsg_data(tb
[RPC_E_CMD
]),
596 tb
[RPC_E_PARM
], tb
[RPC_E_ENV
], ctx
, req
);
601 rpc_file_api_init(const struct rpc_daemon_ops
*o
, struct ubus_context
*ctx
)
603 static const struct ubus_method file_methods
[] = {
604 UBUS_METHOD("read", rpc_file_read
, rpc_file_r_policy
),
605 UBUS_METHOD("write", rpc_file_write
, rpc_file_rw_policy
),
606 UBUS_METHOD("list", rpc_file_list
, rpc_file_r_policy
),
607 UBUS_METHOD("stat", rpc_file_stat
, rpc_file_r_policy
),
608 UBUS_METHOD("exec", rpc_file_exec
, rpc_exec_policy
),
611 static struct ubus_object_type file_type
=
612 UBUS_OBJECT_TYPE("luci-rpc-file", file_methods
);
614 static struct ubus_object obj
= {
617 .methods
= file_methods
,
618 .n_methods
= ARRAY_SIZE(file_methods
),
621 return ubus_add_object(ctx
, &obj
);
624 struct rpc_plugin rpc_plugin
= {
625 .init
= rpc_file_api_init