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 if (write(fd
, blobmsg_data(tb
[RPC_F_DATA
]), blobmsg_data_len(tb
[RPC_F_DATA
])) < 0)
218 return rpc_errno_status();
221 return rpc_errno_status();
230 rpc_file_list(struct ubus_context
*ctx
, struct ubus_object
*obj
,
231 struct ubus_request_data
*req
, const char *method
,
232 struct blob_attr
*msg
)
240 if (!rpc_check_path(msg
, &path
, &s
))
241 return rpc_errno_status();
243 if ((fd
= opendir(path
)) == NULL
)
244 return rpc_errno_status();
246 blob_buf_init(&buf
, 0);
247 c
= blobmsg_open_array(&buf
, "entries");
249 while ((e
= readdir(fd
)) != NULL
)
251 if (!strcmp(e
->d_name
, ".") || !strcmp(e
->d_name
, ".."))
254 d
= blobmsg_open_table(&buf
, NULL
);
255 blobmsg_add_string(&buf
, "name", e
->d_name
);
256 blobmsg_add_string(&buf
, "type", d_types
[e
->d_type
]);
257 blobmsg_close_table(&buf
, d
);
260 blobmsg_close_array(&buf
, c
);
261 ubus_send_reply(ctx
, req
, buf
.head
);
267 rpc_file_stat(struct ubus_context
*ctx
, struct ubus_object
*obj
,
268 struct ubus_request_data
*req
, const char *method
,
269 struct blob_attr
*msg
)
275 if (!rpc_check_path(msg
, &path
, &s
))
276 return rpc_errno_status();
278 blob_buf_init(&buf
, 0);
280 type
= S_ISREG(s
.st_mode
) ? DT_REG
:
281 S_ISDIR(s
.st_mode
) ? DT_DIR
:
282 S_ISCHR(s
.st_mode
) ? DT_CHR
:
283 S_ISBLK(s
.st_mode
) ? DT_BLK
:
284 S_ISFIFO(s
.st_mode
) ? DT_FIFO
:
285 S_ISLNK(s
.st_mode
) ? DT_LNK
:
286 S_ISSOCK(s
.st_mode
) ? DT_SOCK
:
289 blobmsg_add_string(&buf
, "path", path
);
290 blobmsg_add_string(&buf
, "type", d_types
[type
]);
291 blobmsg_add_u32(&buf
, "size", s
.st_size
);
292 blobmsg_add_u32(&buf
, "mode", s
.st_mode
);
293 blobmsg_add_u32(&buf
, "atime", s
.st_atime
);
294 blobmsg_add_u32(&buf
, "mtime", s
.st_mtime
);
295 blobmsg_add_u32(&buf
, "ctime", s
.st_ctime
);
296 blobmsg_add_u32(&buf
, "inode", s
.st_ino
);
297 blobmsg_add_u32(&buf
, "uid", s
.st_uid
);
298 blobmsg_add_u32(&buf
, "gid", s
.st_gid
);
300 ubus_send_reply(ctx
, req
, buf
.head
);
306 rpc_file_exec_lookup(const char *cmd
)
309 int plen
= 0, clen
= strlen(cmd
) + 1;
311 static char path
[PATH_MAX
];
313 if (!stat(cmd
, &s
) && S_ISREG(s
.st_mode
))
316 search
= getenv("PATH");
319 search
= "/bin:/usr/bin:/sbin:/usr/sbin";
325 if (*p
!= ':' && *p
!= '\0')
330 if ((plen
+ clen
) >= sizeof(path
))
333 strncpy(path
, search
, plen
);
334 sprintf(path
+ plen
, "/%s", cmd
);
336 if (!stat(path
, &s
) && S_ISREG(s
.st_mode
))
348 rpc_ustream_to_blobmsg(struct ustream
*s
, const char *name
)
353 if ((len
= ustream_pending_data(s
, false)) > 0)
355 wbuf
= blobmsg_alloc_string_buffer(&buf
, name
, len
+ 1);
360 ustream_for_each_read_buffer(s
, rbuf
, len
)
362 memcpy(wbuf
, rbuf
, len
);
367 blobmsg_add_string_buffer(&buf
);
372 rpc_file_exec_reply(struct rpc_file_exec_context
*c
, int rv
)
374 uloop_timeout_cancel(&c
->timeout
);
375 uloop_process_delete(&c
->process
);
377 if (rv
== UBUS_STATUS_OK
)
379 blob_buf_init(&buf
, 0);
381 blobmsg_add_u32(&buf
, "code", WEXITSTATUS(c
->stat
));
383 rpc_ustream_to_blobmsg(&c
->opipe
.stream
, "stdout");
384 rpc_ustream_to_blobmsg(&c
->epipe
.stream
, "stderr");
386 ubus_send_reply(c
->context
, &c
->request
, buf
.head
);
389 ubus_complete_deferred_request(c
->context
, &c
->request
, rv
);
391 ustream_free(&c
->opipe
.stream
);
392 ustream_free(&c
->epipe
.stream
);
394 close(c
->opipe
.fd
.fd
);
395 close(c
->epipe
.fd
.fd
);
401 rpc_file_exec_timeout_cb(struct uloop_timeout
*t
)
403 struct rpc_file_exec_context
*c
=
404 container_of(t
, struct rpc_file_exec_context
, timeout
);
406 kill(c
->process
.pid
, SIGKILL
);
407 rpc_file_exec_reply(c
, UBUS_STATUS_TIMEOUT
);
411 rpc_file_exec_process_cb(struct uloop_process
*p
, int stat
)
413 struct rpc_file_exec_context
*c
=
414 container_of(p
, struct rpc_file_exec_context
, process
);
418 ustream_poll(&c
->opipe
.stream
);
419 ustream_poll(&c
->epipe
.stream
);
423 rpc_file_exec_opipe_read_cb(struct ustream
*s
, int bytes
)
425 struct rpc_file_exec_context
*c
=
426 container_of(s
, struct rpc_file_exec_context
, opipe
.stream
);
428 if (ustream_read_buf_full(s
))
429 rpc_file_exec_reply(c
, UBUS_STATUS_NOT_SUPPORTED
);
433 rpc_file_exec_epipe_read_cb(struct ustream
*s
, int bytes
)
435 struct rpc_file_exec_context
*c
=
436 container_of(s
, struct rpc_file_exec_context
, epipe
.stream
);
438 if (ustream_read_buf_full(s
))
439 rpc_file_exec_reply(c
, UBUS_STATUS_NOT_SUPPORTED
);
443 rpc_file_exec_opipe_state_cb(struct ustream
*s
)
445 struct rpc_file_exec_context
*c
=
446 container_of(s
, struct rpc_file_exec_context
, opipe
.stream
);
448 if (c
->opipe
.stream
.eof
&& c
->epipe
.stream
.eof
)
449 rpc_file_exec_reply(c
, UBUS_STATUS_OK
);
453 rpc_file_exec_epipe_state_cb(struct ustream
*s
)
455 struct rpc_file_exec_context
*c
=
456 container_of(s
, struct rpc_file_exec_context
, epipe
.stream
);
458 if (c
->opipe
.stream
.eof
&& c
->epipe
.stream
.eof
)
459 rpc_file_exec_reply(c
, UBUS_STATUS_OK
);
463 rpc_file_exec_run(const char *cmd
,
464 const struct blob_attr
*arg
, const struct blob_attr
*env
,
465 struct ubus_context
*ctx
, struct ubus_request_data
*req
)
473 struct blob_attr
*cur
;
478 struct rpc_file_exec_context
*c
;
480 cmd
= rpc_file_exec_lookup(cmd
);
483 return UBUS_STATUS_NOT_FOUND
;
485 c
= malloc(sizeof(*c
));
488 return UBUS_STATUS_UNKNOWN_ERROR
;
490 if (pipe(opipe
) || pipe(epipe
))
491 return rpc_errno_status();
493 switch ((pid
= fork()))
496 return rpc_errno_status();
511 args
= malloc(sizeof(char *) * arglen
);
514 return UBUS_STATUS_UNKNOWN_ERROR
;
516 args
[0] = (char *)cmd
;
521 blobmsg_for_each_attr(cur
, arg
, rem
)
523 if (blobmsg_type(cur
) != BLOBMSG_TYPE_STRING
)
528 if (!(args
= realloc(args
, sizeof(char *) * arglen
)))
529 return UBUS_STATUS_UNKNOWN_ERROR
;
531 args
[arglen
-2] = blobmsg_data(cur
);
532 args
[arglen
-1] = NULL
;
538 blobmsg_for_each_attr(cur
, env
, rem
)
540 if (blobmsg_type(cur
) != BLOBMSG_TYPE_STRING
)
543 setenv(blobmsg_name(cur
), blobmsg_data(cur
), 1);
547 if (execv(cmd
, args
))
548 return rpc_errno_status();
551 memset(c
, 0, sizeof(*c
));
553 ustream_declare(c
->opipe
, opipe
[0], exec_opipe
);
554 ustream_declare(c
->epipe
, epipe
[0], exec_epipe
);
556 c
->process
.pid
= pid
;
557 c
->process
.cb
= rpc_file_exec_process_cb
;
558 uloop_process_add(&c
->process
);
560 c
->timeout
.cb
= rpc_file_exec_timeout_cb
;
561 uloop_timeout_set(&c
->timeout
, RPC_FILE_MAX_RUNTIME
);
567 ubus_defer_request(ctx
, req
, &c
->request
);
570 return UBUS_STATUS_OK
;
574 rpc_file_exec(struct ubus_context
*ctx
, struct ubus_object
*obj
,
575 struct ubus_request_data
*req
, const char *method
,
576 struct blob_attr
*msg
)
578 struct blob_attr
*tb
[__RPC_E_MAX
];
580 blobmsg_parse(rpc_exec_policy
, __RPC_E_MAX
, tb
,
581 blob_data(msg
), blob_len(msg
));
584 return UBUS_STATUS_INVALID_ARGUMENT
;
586 return rpc_file_exec_run(blobmsg_data(tb
[RPC_E_CMD
]),
587 tb
[RPC_E_PARM
], tb
[RPC_E_ENV
], ctx
, req
);
592 rpc_file_api_init(const struct rpc_daemon_ops
*o
, struct ubus_context
*ctx
)
594 static const struct ubus_method file_methods
[] = {
595 UBUS_METHOD("read", rpc_file_read
, rpc_file_policy
),
596 UBUS_METHOD("write", rpc_file_write
, rpc_file_policy
),
597 UBUS_METHOD("list", rpc_file_list
, rpc_file_policy
),
598 UBUS_METHOD("stat", rpc_file_stat
, rpc_file_policy
),
599 UBUS_METHOD("exec", rpc_file_exec
, rpc_exec_policy
),
602 static struct ubus_object_type file_type
=
603 UBUS_OBJECT_TYPE("luci-rpc-file", file_methods
);
605 static struct ubus_object obj
= {
608 .methods
= file_methods
,
609 .n_methods
= ARRAY_SIZE(file_methods
),
612 return ubus_add_object(ctx
, &obj
);
615 struct rpc_plugin rpc_plugin
= {
616 .init
= rpc_file_api_init