db95429b4a0a43ef13aaacf890c726c93e0ed79c
[lttng-tools.git] / src / common / runas.c
1 /*
2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 *
6 * SPDX-License-Identifier: GPL-2.0-only
7 *
8 */
9
10 #define _LGPL_SOURCE
11 #include <assert.h>
12 #include <fcntl.h>
13 #include <grp.h>
14 #include <limits.h>
15 #include <pwd.h>
16 #include <sched.h>
17 #include <signal.h>
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <string.h>
21 #include <sys/stat.h>
22 #include <sys/types.h>
23 #include <sys/wait.h>
24 #include <unistd.h>
25
26 #include <common/bytecode/bytecode.h>
27 #include <common/lttng-kernel.h>
28 #include <common/common.h>
29 #include <common/utils.h>
30 #include <common/compat/errno.h>
31 #include <common/compat/getenv.h>
32 #include <common/compat/string.h>
33 #include <common/unix.h>
34 #include <common/defaults.h>
35 #include <common/lttng-elf.h>
36 #include <common/thread.h>
37
38 #include <lttng/constant.h>
39
40 #include <common/sessiond-comm/sessiond-comm.h>
41 #include <common/filter/filter-ast.h>
42
43 #include "runas.h"
44
45 #define GETPW_BUFFER_FALLBACK_SIZE 4096
46
47 struct run_as_data;
48 struct run_as_ret;
49 typedef int (*run_as_fct)(struct run_as_data *data, struct run_as_ret *ret_value);
50
51 enum run_as_cmd {
52 RUN_AS_MKDIR,
53 RUN_AS_MKDIRAT,
54 RUN_AS_MKDIR_RECURSIVE,
55 RUN_AS_MKDIRAT_RECURSIVE,
56 RUN_AS_OPEN,
57 RUN_AS_OPENAT,
58 RUN_AS_UNLINK,
59 RUN_AS_UNLINKAT,
60 RUN_AS_RMDIR,
61 RUN_AS_RMDIRAT,
62 RUN_AS_RMDIR_RECURSIVE,
63 RUN_AS_RMDIRAT_RECURSIVE,
64 RUN_AS_RENAME,
65 RUN_AS_RENAMEAT,
66 RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET,
67 RUN_AS_EXTRACT_SDT_PROBE_OFFSETS,
68 RUN_AS_GENERATE_FILTER_BYTECODE,
69 };
70
71 struct run_as_mkdir_data {
72 int dirfd;
73 char path[LTTNG_PATH_MAX];
74 mode_t mode;
75 } LTTNG_PACKED;
76
77 struct run_as_open_data {
78 int dirfd;
79 char path[LTTNG_PATH_MAX];
80 int flags;
81 mode_t mode;
82 } LTTNG_PACKED;
83
84 struct run_as_unlink_data {
85 int dirfd;
86 char path[LTTNG_PATH_MAX];
87 } LTTNG_PACKED;
88
89 struct run_as_rmdir_data {
90 int dirfd;
91 char path[LTTNG_PATH_MAX];
92 int flags; /* enum lttng_directory_handle_rmdir_recursive_flags. */
93 } LTTNG_PACKED;
94
95 struct run_as_extract_elf_symbol_offset_data {
96 int fd;
97 char function[LTTNG_SYMBOL_NAME_LEN];
98 } LTTNG_PACKED;
99
100 struct run_as_extract_sdt_probe_offsets_data {
101 int fd;
102 char probe_name[LTTNG_SYMBOL_NAME_LEN];
103 char provider_name[LTTNG_SYMBOL_NAME_LEN];
104 } LTTNG_PACKED;
105
106 struct run_as_generate_filter_bytecode_data {
107 char filter_expression[LTTNG_FILTER_MAX_LEN];
108 } LTTNG_PACKED;
109
110 struct run_as_rename_data {
111 /*
112 * [0] = old_dirfd
113 * [1] = new_dirfd
114 */
115 int dirfds[2];
116 char old_path[LTTNG_PATH_MAX];
117 char new_path[LTTNG_PATH_MAX];
118 } LTTNG_PACKED;
119
120 struct run_as_open_ret {
121 int fd;
122 } LTTNG_PACKED;
123
124 struct run_as_extract_elf_symbol_offset_ret {
125 uint64_t offset;
126 } LTTNG_PACKED;
127
128 struct run_as_extract_sdt_probe_offsets_ret {
129 uint32_t num_offset;
130 uint64_t offsets[LTTNG_KERNEL_ABI_MAX_UPROBE_NUM];
131 } LTTNG_PACKED;
132
133 struct run_as_generate_filter_bytecode_ret {
134 /* A lttng_bytecode_filter struct with 'dynamic' payload. */
135 char bytecode[LTTNG_FILTER_MAX_LEN];
136 } LTTNG_PACKED;
137
138 struct run_as_data {
139 enum run_as_cmd cmd;
140 union {
141 struct run_as_mkdir_data mkdir;
142 struct run_as_open_data open;
143 struct run_as_unlink_data unlink;
144 struct run_as_rmdir_data rmdir;
145 struct run_as_rename_data rename;
146 struct run_as_extract_elf_symbol_offset_data extract_elf_symbol_offset;
147 struct run_as_extract_sdt_probe_offsets_data extract_sdt_probe_offsets;
148 struct run_as_generate_filter_bytecode_data generate_filter_bytecode;
149 } u;
150 uid_t uid;
151 gid_t gid;
152 } LTTNG_PACKED;
153
154 /*
155 * The run_as_ret structure holds the returned value and status of the command.
156 *
157 * The `u` union field holds the return value of the command; in most cases it
158 * represents the success or the failure of the command. In more complex
159 * commands, it holds a computed value.
160 *
161 * The _errno field is the errno recorded after the execution of the command.
162 *
163 * The _error fields is used the signify that return status of the command. For
164 * simple commands returning `int` the _error field will be the same as the
165 * ret_int field. In complex commands, it signify the success or failure of the
166 * command.
167 *
168 */
169 struct run_as_ret {
170 union {
171 int ret;
172 struct run_as_open_ret open;
173 struct run_as_extract_elf_symbol_offset_ret extract_elf_symbol_offset;
174 struct run_as_extract_sdt_probe_offsets_ret extract_sdt_probe_offsets;
175 struct run_as_generate_filter_bytecode_ret generate_filter_bytecode;
176 } u;
177 int _errno;
178 bool _error;
179 } LTTNG_PACKED;
180
181 #define COMMAND_IN_FDS(data_ptr) ({ \
182 int *fds = NULL; \
183 if (command_properties[data_ptr->cmd].in_fds_offset != -1) { \
184 fds = (int *) ((char *) data_ptr + command_properties[data_ptr->cmd].in_fds_offset); \
185 } \
186 fds; \
187 })
188
189 #define COMMAND_OUT_FDS(cmd, ret_ptr) ({ \
190 int *fds = NULL; \
191 if (command_properties[cmd].out_fds_offset != -1) { \
192 fds = (int *) ((char *) ret_ptr + command_properties[cmd].out_fds_offset); \
193 } \
194 fds; \
195 })
196
197 #define COMMAND_IN_FD_COUNT(data_ptr) ({ \
198 command_properties[data_ptr->cmd].in_fd_count; \
199 })
200
201 #define COMMAND_OUT_FD_COUNT(cmd) ({ \
202 command_properties[cmd].out_fd_count; \
203 })
204
205 #define COMMAND_USE_CWD_FD(data_ptr) command_properties[data_ptr->cmd].use_cwd_fd
206
207 struct run_as_command_properties {
208 /* Set to -1 when not applicable. */
209 ptrdiff_t in_fds_offset, out_fds_offset;
210 unsigned int in_fd_count, out_fd_count;
211 bool use_cwd_fd;
212 };
213
214 static const struct run_as_command_properties command_properties[] = {
215 [RUN_AS_MKDIR] = {
216 .in_fds_offset = offsetof(struct run_as_data, u.mkdir.dirfd),
217 .in_fd_count = 1,
218 .out_fds_offset = -1,
219 .out_fd_count = 0,
220 .use_cwd_fd = true,
221 },
222 [RUN_AS_MKDIRAT] = {
223 .in_fds_offset = offsetof(struct run_as_data, u.mkdir.dirfd),
224 .in_fd_count = 1,
225 .out_fds_offset = -1,
226 .out_fd_count = 0,
227 .use_cwd_fd = false,
228 },
229 [RUN_AS_MKDIR_RECURSIVE] = {
230 .in_fds_offset = offsetof(struct run_as_data, u.mkdir.dirfd),
231 .in_fd_count = 1,
232 .out_fds_offset = -1,
233 .out_fd_count = 0,
234 .use_cwd_fd = true,
235 },
236 [RUN_AS_MKDIRAT_RECURSIVE] = {
237 .in_fds_offset = offsetof(struct run_as_data, u.mkdir.dirfd),
238 .in_fd_count = 1,
239 .out_fds_offset = -1,
240 .out_fd_count = 0,
241 .use_cwd_fd = false,
242 },
243 [RUN_AS_OPEN] = {
244 .in_fds_offset = offsetof(struct run_as_data, u.open.dirfd),
245 .in_fd_count = 1,
246 .out_fds_offset = offsetof(struct run_as_ret, u.open.fd),
247 .out_fd_count = 1,
248 .use_cwd_fd = true,
249 },
250 [RUN_AS_OPENAT] = {
251 .in_fds_offset = offsetof(struct run_as_data, u.open.dirfd),
252 .in_fd_count = 1,
253 .out_fds_offset = offsetof(struct run_as_ret, u.open.fd),
254 .out_fd_count = 1,
255 .use_cwd_fd = false,
256 },
257 [RUN_AS_UNLINK] = {
258 .in_fds_offset = offsetof(struct run_as_data, u.unlink.dirfd),
259 .in_fd_count = 1,
260 .out_fds_offset = -1,
261 .out_fd_count = 0,
262 .use_cwd_fd = true,
263 },
264 [RUN_AS_UNLINKAT] = {
265 .in_fds_offset = offsetof(struct run_as_data, u.unlink.dirfd),
266 .in_fd_count = 1,
267 .out_fds_offset = -1,
268 .out_fd_count = 0,
269 .use_cwd_fd = false,
270 },
271 [RUN_AS_RMDIR_RECURSIVE] = {
272 .in_fds_offset = offsetof(struct run_as_data, u.rmdir.dirfd),
273 .in_fd_count = 1,
274 .out_fds_offset = -1,
275 .out_fd_count = 0,
276 .use_cwd_fd = true,
277 },
278 [RUN_AS_RMDIRAT_RECURSIVE] = {
279 .in_fds_offset = offsetof(struct run_as_data, u.rmdir.dirfd),
280 .in_fd_count = 1,
281 .out_fds_offset = -1,
282 .out_fd_count = 0,
283 .use_cwd_fd = false,
284 },
285 [RUN_AS_RMDIR] = {
286 .in_fds_offset = offsetof(struct run_as_data, u.rmdir.dirfd),
287 .in_fd_count = 1,
288 .out_fds_offset = -1,
289 .out_fd_count = 0,
290 .use_cwd_fd = true,
291 },
292 [RUN_AS_RMDIRAT] = {
293 .in_fds_offset = offsetof(struct run_as_data, u.rmdir.dirfd),
294 .in_fd_count = 1,
295 .out_fds_offset = -1,
296 .out_fd_count = 0,
297 .use_cwd_fd = false,
298 },
299 [RUN_AS_RENAME] = {
300 .in_fds_offset = offsetof(struct run_as_data, u.rename.dirfds),
301 .in_fd_count = 2,
302 .out_fds_offset = -1,
303 .out_fd_count = 0,
304 .use_cwd_fd = true,
305 },
306 [RUN_AS_RENAMEAT] = {
307 .in_fds_offset = offsetof(struct run_as_data, u.rename.dirfds),
308 .in_fd_count = 2,
309 .out_fds_offset = -1,
310 .out_fd_count = 0,
311 .use_cwd_fd = false,
312 },
313 [RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET] = {
314 .in_fds_offset = offsetof(struct run_as_data,
315 u.extract_elf_symbol_offset.fd),
316 .in_fd_count = 1,
317 .out_fds_offset = -1,
318 .out_fd_count = 0,
319 .use_cwd_fd = false,
320 },
321 [RUN_AS_EXTRACT_SDT_PROBE_OFFSETS] = {
322 .in_fds_offset = offsetof(struct run_as_data,
323 u.extract_sdt_probe_offsets.fd),
324 .in_fd_count = 1,
325 .out_fds_offset = -1,
326 .out_fd_count = 0,
327 .use_cwd_fd = false,
328 },
329 [RUN_AS_GENERATE_FILTER_BYTECODE] = {
330 .in_fds_offset = -1,
331 .in_fd_count = 0,
332 .out_fds_offset = -1,
333 .out_fd_count = 0,
334 .use_cwd_fd = false,
335 },
336 };
337
338 struct run_as_worker {
339 pid_t pid; /* Worker PID. */
340 int sockpair[2];
341 char *procname;
342 };
343
344 /* Single global worker per process (for now). */
345 static struct run_as_worker *global_worker;
346 /* Lock protecting the worker. */
347 static pthread_mutex_t worker_lock = PTHREAD_MUTEX_INITIALIZER;
348
349 #ifdef VALGRIND
350 static
351 int use_clone(void)
352 {
353 return 0;
354 }
355 #else
356 static
357 int use_clone(void)
358 {
359 return !lttng_secure_getenv("LTTNG_DEBUG_NOCLONE");
360 }
361 #endif
362
363 /*
364 * Create recursively directory using the FULL path.
365 */
366 static
367 int _mkdirat_recursive(struct run_as_data *data, struct run_as_ret *ret_value)
368 {
369 const char *path;
370 mode_t mode;
371 struct lttng_directory_handle *handle;
372
373 path = data->u.mkdir.path;
374 mode = data->u.mkdir.mode;
375
376 handle = lttng_directory_handle_create_from_dirfd(data->u.mkdir.dirfd);
377 if (!handle) {
378 ret_value->_errno = errno;
379 ret_value->_error = true;
380 ret_value->u.ret = -1;
381 goto end;
382 }
383 /* Ownership of dirfd is transferred to the handle. */
384 data->u.mkdir.dirfd = -1;
385 /* Safe to call as we have transitioned to the requested uid/gid. */
386 ret_value->u.ret = lttng_directory_handle_create_subdirectory_recursive(
387 handle, path, mode);
388 ret_value->_errno = errno;
389 ret_value->_error = (ret_value->u.ret) ? true : false;
390 lttng_directory_handle_put(handle);
391 end:
392 return ret_value->u.ret;
393 }
394
395 static
396 int _mkdirat(struct run_as_data *data, struct run_as_ret *ret_value)
397 {
398 const char *path;
399 mode_t mode;
400 struct lttng_directory_handle *handle;
401
402 path = data->u.mkdir.path;
403 mode = data->u.mkdir.mode;
404
405 handle = lttng_directory_handle_create_from_dirfd(data->u.mkdir.dirfd);
406 if (!handle) {
407 ret_value->u.ret = -1;
408 ret_value->_errno = errno;
409 ret_value->_error = true;
410 goto end;
411 }
412 /* Ownership of dirfd is transferred to the handle. */
413 data->u.mkdir.dirfd = -1;
414 /* Safe to call as we have transitioned to the requested uid/gid. */
415 ret_value->u.ret = lttng_directory_handle_create_subdirectory(
416 handle, path, mode);
417 ret_value->_errno = errno;
418 ret_value->_error = (ret_value->u.ret) ? true : false;
419 lttng_directory_handle_put(handle);
420 end:
421 return ret_value->u.ret;
422 }
423
424 static
425 int _open(struct run_as_data *data, struct run_as_ret *ret_value)
426 {
427 int fd;
428 struct lttng_directory_handle *handle;
429
430 handle = lttng_directory_handle_create_from_dirfd(data->u.open.dirfd);
431 if (!handle) {
432 ret_value->_errno = errno;
433 ret_value->_error = true;
434 ret_value->u.ret = -1;
435 goto end;
436 }
437 /* Ownership of dirfd is transferred to the handle. */
438 data->u.open.dirfd = -1;
439
440 fd = lttng_directory_handle_open_file(handle,
441 data->u.open.path, data->u.open.flags,
442 data->u.open.mode);
443 if (fd < 0) {
444 ret_value->u.ret = -1;
445 ret_value->u.open.fd = -1;
446 } else {
447 ret_value->u.ret = 0;
448 ret_value->u.open.fd = fd;
449 }
450
451 ret_value->_errno = errno;
452 ret_value->_error = fd < 0;
453 lttng_directory_handle_put(handle);
454 end:
455 return ret_value->u.ret;
456 }
457
458 static
459 int _unlink(struct run_as_data *data, struct run_as_ret *ret_value)
460 {
461 struct lttng_directory_handle *handle;
462
463 handle = lttng_directory_handle_create_from_dirfd(data->u.unlink.dirfd);
464 if (!handle) {
465 ret_value->u.ret = -1;
466 ret_value->_errno = errno;
467 ret_value->_error = true;
468 goto end;
469 }
470
471 /* Ownership of dirfd is transferred to the handle. */
472 data->u.unlink.dirfd = -1;
473
474 ret_value->u.ret = lttng_directory_handle_unlink_file(handle,
475 data->u.unlink.path);
476 ret_value->_errno = errno;
477 ret_value->_error = (ret_value->u.ret) ? true : false;
478 lttng_directory_handle_put(handle);
479 end:
480 return ret_value->u.ret;
481 }
482
483 static
484 int _rmdir(struct run_as_data *data, struct run_as_ret *ret_value)
485 {
486 struct lttng_directory_handle *handle;
487
488 handle = lttng_directory_handle_create_from_dirfd(data->u.rmdir.dirfd);
489 if (!handle) {
490 ret_value->u.ret = -1;
491 ret_value->_errno = errno;
492 ret_value->_error = true;
493 goto end;
494 }
495
496 /* Ownership of dirfd is transferred to the handle. */
497 data->u.rmdir.dirfd = -1;
498
499 ret_value->u.ret = lttng_directory_handle_remove_subdirectory(
500 handle, data->u.rmdir.path);
501 ret_value->_errno = errno;
502 ret_value->_error = (ret_value->u.ret) ? true : false;
503 lttng_directory_handle_put(handle);
504 end:
505 return ret_value->u.ret;
506 }
507
508 static
509 int _rmdir_recursive(struct run_as_data *data, struct run_as_ret *ret_value)
510 {
511 struct lttng_directory_handle *handle;
512
513 handle = lttng_directory_handle_create_from_dirfd(data->u.rmdir.dirfd);
514 if (!handle) {
515 ret_value->u.ret = -1;
516 ret_value->_errno = errno;
517 ret_value->_error = true;
518 goto end;
519 }
520
521 /* Ownership of dirfd is transferred to the handle. */
522 data->u.rmdir.dirfd = -1;
523
524 ret_value->u.ret = lttng_directory_handle_remove_subdirectory_recursive(
525 handle, data->u.rmdir.path, data->u.rmdir.flags);
526 ret_value->_errno = errno;
527 ret_value->_error = (ret_value->u.ret) ? true : false;
528 lttng_directory_handle_put(handle);
529 end:
530 return ret_value->u.ret;
531 }
532
533 static
534 int _rename(struct run_as_data *data, struct run_as_ret *ret_value)
535 {
536 const char *old_path, *new_path;
537 struct lttng_directory_handle *old_handle = NULL, *new_handle = NULL;
538
539 old_path = data->u.rename.old_path;
540 new_path = data->u.rename.new_path;
541
542 old_handle = lttng_directory_handle_create_from_dirfd(
543 data->u.rename.dirfds[0]);
544 if (!old_handle) {
545 ret_value->u.ret = -1;
546 goto end;
547 }
548 new_handle = lttng_directory_handle_create_from_dirfd(
549 data->u.rename.dirfds[1]);
550 if (!new_handle) {
551 ret_value->u.ret = -1;
552 goto end;
553 }
554
555 /* Ownership of dirfds are transferred to the handles. */
556 data->u.rename.dirfds[0] = data->u.rename.dirfds[1] = -1;
557
558 /* Safe to call as we have transitioned to the requested uid/gid. */
559 ret_value->u.ret = lttng_directory_handle_rename(
560 old_handle, old_path, new_handle, new_path);
561 end:
562 lttng_directory_handle_put(old_handle);
563 lttng_directory_handle_put(new_handle);
564 ret_value->_errno = errno;
565 ret_value->_error = (ret_value->u.ret) ? true : false;
566 return ret_value->u.ret;
567 }
568
569 #ifdef HAVE_ELF_H
570 static
571 int _extract_elf_symbol_offset(struct run_as_data *data,
572 struct run_as_ret *ret_value)
573 {
574 int ret = 0;
575 uint64_t offset;
576
577 ret_value->_error = false;
578 ret = lttng_elf_get_symbol_offset(data->u.extract_elf_symbol_offset.fd,
579 data->u.extract_elf_symbol_offset.function,
580 &offset);
581 if (ret) {
582 DBG("Failed to extract ELF function offset");
583 ret_value->_error = true;
584 }
585 ret_value->u.extract_elf_symbol_offset.offset = offset;
586
587 return ret;
588 }
589
590 static
591 int _extract_sdt_probe_offsets(struct run_as_data *data,
592 struct run_as_ret *ret_value)
593 {
594 int ret = 0;
595 uint64_t *offsets = NULL;
596 uint32_t num_offset;
597
598 ret_value->_error = false;
599
600 /* On success, this call allocates the offsets paramater. */
601 ret = lttng_elf_get_sdt_probe_offsets(
602 data->u.extract_sdt_probe_offsets.fd,
603 data->u.extract_sdt_probe_offsets.provider_name,
604 data->u.extract_sdt_probe_offsets.probe_name,
605 &offsets, &num_offset);
606
607 if (ret) {
608 DBG("Failed to extract SDT probe offsets");
609 ret_value->_error = true;
610 goto end;
611 }
612
613 if (num_offset <= 0 || num_offset > LTTNG_KERNEL_ABI_MAX_UPROBE_NUM) {
614 DBG("Wrong number of probes.");
615 ret = -1;
616 ret_value->_error = true;
617 goto free_offset;
618 }
619
620 /* Copy the content of the offsets array to the ret struct. */
621 memcpy(ret_value->u.extract_sdt_probe_offsets.offsets,
622 offsets, num_offset * sizeof(uint64_t));
623
624 ret_value->u.extract_sdt_probe_offsets.num_offset = num_offset;
625
626 free_offset:
627 free(offsets);
628 end:
629 return ret;
630 }
631 #else
632 static
633 int _extract_elf_symbol_offset(struct run_as_data *data,
634 struct run_as_ret *ret_value)
635 {
636 ERR("Unimplemented runas command RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET");
637 return -1;
638 }
639
640 static
641 int _extract_sdt_probe_offsets(struct run_as_data *data,
642 struct run_as_ret *ret_value)
643 {
644 ERR("Unimplemented runas command RUN_AS_EXTRACT_SDT_PROBE_OFFSETS");
645 return -1;
646 }
647 #endif
648
649 static
650 int _generate_filter_bytecode(struct run_as_data *data,
651 struct run_as_ret *ret_value) {
652 int ret = 0;
653 const char *filter_expression = NULL;
654 struct filter_parser_ctx *ctx = NULL;
655
656 ret_value->_error = false;
657
658 filter_expression = data->u.generate_filter_bytecode.filter_expression;
659
660 if (lttng_strnlen(filter_expression, LTTNG_FILTER_MAX_LEN - 1) == LTTNG_FILTER_MAX_LEN - 1) {
661 ret_value->_error = true;
662 ret = -1;
663 goto end;
664 }
665
666 ret = filter_parser_ctx_create_from_filter_expression(filter_expression, &ctx);
667 if (ret < 0) {
668 ret_value->_error = true;
669 ret = -1;
670 goto end;
671 }
672
673 DBG("Size of bytecode generated: %u bytes.",
674 bytecode_get_len(&ctx->bytecode->b));
675
676 /* Copy the lttng_bytecode_filter object to the return structure. */
677 memcpy(ret_value->u.generate_filter_bytecode.bytecode,
678 &ctx->bytecode->b,
679 sizeof(ctx->bytecode->b) +
680 bytecode_get_len(&ctx->bytecode->b));
681
682 end:
683 if (ctx) {
684 filter_bytecode_free(ctx);
685 filter_ir_free(ctx);
686 filter_parser_ctx_free(ctx);
687 }
688
689 return ret;
690 }
691 static
692 run_as_fct run_as_enum_to_fct(enum run_as_cmd cmd)
693 {
694 switch (cmd) {
695 case RUN_AS_MKDIR:
696 case RUN_AS_MKDIRAT:
697 return _mkdirat;
698 case RUN_AS_MKDIR_RECURSIVE:
699 case RUN_AS_MKDIRAT_RECURSIVE:
700 return _mkdirat_recursive;
701 case RUN_AS_OPEN:
702 case RUN_AS_OPENAT:
703 return _open;
704 case RUN_AS_UNLINK:
705 case RUN_AS_UNLINKAT:
706 return _unlink;
707 case RUN_AS_RMDIR:
708 case RUN_AS_RMDIRAT:
709 return _rmdir;
710 case RUN_AS_RMDIR_RECURSIVE:
711 case RUN_AS_RMDIRAT_RECURSIVE:
712 return _rmdir_recursive;
713 case RUN_AS_RENAME:
714 case RUN_AS_RENAMEAT:
715 return _rename;
716 case RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET:
717 return _extract_elf_symbol_offset;
718 case RUN_AS_EXTRACT_SDT_PROBE_OFFSETS:
719 return _extract_sdt_probe_offsets;
720 case RUN_AS_GENERATE_FILTER_BYTECODE:
721 return _generate_filter_bytecode;
722 default:
723 ERR("Unknown command %d", (int) cmd);
724 return NULL;
725 }
726 }
727
728 static
729 int do_send_fds(int sock, const int *fds, unsigned int fd_count)
730 {
731 ssize_t len;
732 unsigned int i;
733
734 for (i = 0; i < fd_count; i++) {
735 if (fds[i] < 0) {
736 DBG("Attempt to send invalid file descriptor (fd = %i)",
737 fds[i]);
738 /* Return 0 as this is not a fatal error. */
739 return 0;
740 }
741 }
742
743 len = lttcomm_send_fds_unix_sock(sock, fds, fd_count);
744 return len < 0 ? -1 : 0;
745 }
746
747 static
748 int do_recv_fds(int sock, int *fds, unsigned int fd_count)
749 {
750 int ret = 0;
751 unsigned int i;
752 ssize_t len;
753
754 len = lttcomm_recv_fds_unix_sock(sock, fds, fd_count);
755 if (len == 0) {
756 ret = -1;
757 goto end;
758 } else if (len < 0) {
759 PERROR("Failed to receive file descriptors from socket");
760 ret = -1;
761 goto end;
762 }
763
764 for (i = 0; i < fd_count; i++) {
765 if (fds[i] < 0) {
766 ERR("Invalid file descriptor received from worker (fd = %i)", fds[i]);
767 /* Return 0 as this is not a fatal error. */
768 }
769 }
770 end:
771 return ret;
772 }
773
774 static
775 int send_fds_to_worker(const struct run_as_worker *worker,
776 const struct run_as_data *data)
777 {
778 int ret = 0;
779 unsigned int i;
780
781 if (COMMAND_USE_CWD_FD(data) || COMMAND_IN_FD_COUNT(data) == 0) {
782 goto end;
783 }
784
785 for (i = 0; i < COMMAND_IN_FD_COUNT(data); i++) {
786 if (COMMAND_IN_FDS(data)[i] < 0) {
787 ERR("Refusing to send invalid fd to worker (fd = %i)",
788 COMMAND_IN_FDS(data)[i]);
789 ret = -1;
790 goto end;
791 }
792 }
793
794 ret = do_send_fds(worker->sockpair[0], COMMAND_IN_FDS(data),
795 COMMAND_IN_FD_COUNT(data));
796 if (ret < 0) {
797 PERROR("Failed to send file descriptor to run-as worker");
798 ret = -1;
799 goto end;
800 }
801 end:
802 return ret;
803 }
804
805 static
806 int send_fds_to_master(struct run_as_worker *worker, enum run_as_cmd cmd,
807 struct run_as_ret *run_as_ret)
808 {
809 int ret = 0;
810 unsigned int i;
811
812 if (COMMAND_OUT_FD_COUNT(cmd) == 0) {
813 goto end;
814 }
815
816 ret = do_send_fds(worker->sockpair[1], COMMAND_OUT_FDS(cmd, run_as_ret),
817 COMMAND_OUT_FD_COUNT(cmd));
818 if (ret < 0) {
819 PERROR("Failed to send file descriptor to master process");
820 goto end;
821 }
822
823 for (i = 0; i < COMMAND_OUT_FD_COUNT(cmd); i++) {
824 int fd = COMMAND_OUT_FDS(cmd, run_as_ret)[i];
825 if (fd >= 0) {
826 int ret_close = close(fd);
827
828 if (ret_close < 0) {
829 PERROR("Failed to close result file descriptor (fd = %i)",
830 fd);
831 }
832 }
833 }
834 end:
835 return ret;
836 }
837
838 static
839 int recv_fds_from_worker(const struct run_as_worker *worker, enum run_as_cmd cmd,
840 struct run_as_ret *run_as_ret)
841 {
842 int ret = 0;
843
844 if (COMMAND_OUT_FD_COUNT(cmd) == 0) {
845 goto end;
846 }
847
848 ret = do_recv_fds(worker->sockpair[0], COMMAND_OUT_FDS(cmd, run_as_ret),
849 COMMAND_OUT_FD_COUNT(cmd));
850 if (ret < 0) {
851 PERROR("Failed to receive file descriptor from run-as worker");
852 ret = -1;
853 }
854 end:
855 return ret;
856 }
857
858 static
859 int recv_fds_from_master(struct run_as_worker *worker, struct run_as_data *data)
860 {
861 int ret = 0;
862
863 if (COMMAND_USE_CWD_FD(data)) {
864 unsigned int i;
865
866 for (i = 0; i < COMMAND_IN_FD_COUNT(data); i++) {
867 COMMAND_IN_FDS(data)[i] = AT_FDCWD;
868 }
869 goto end;
870 }
871
872 if (COMMAND_IN_FD_COUNT(data) == 0) {
873 goto end;
874 }
875
876 ret = do_recv_fds(worker->sockpair[1], COMMAND_IN_FDS(data),
877 COMMAND_IN_FD_COUNT(data));
878 if (ret < 0) {
879 PERROR("Failed to receive file descriptors from master process");
880 ret = -1;
881 }
882 end:
883 return ret;
884 }
885
886 static
887 int cleanup_received_fds(struct run_as_data *data)
888 {
889 int ret = 0, i;
890
891 for (i = 0; i < COMMAND_IN_FD_COUNT(data); i++) {
892 if (COMMAND_IN_FDS(data)[i] == -1) {
893 continue;
894 }
895 ret = close(COMMAND_IN_FDS(data)[i]);
896 if (ret) {
897 PERROR("Failed to close file descriptor received fd in run-as worker");
898 goto end;
899 }
900 }
901 end:
902 return ret;
903 }
904
905 static int get_user_infos_from_uid(
906 uid_t uid, char **username, gid_t *primary_gid)
907 {
908 int ret;
909 char *buf = NULL;
910 size_t buf_size;
911 struct passwd pwd;
912 struct passwd *result = NULL;
913
914 /* Fetch the max size for the temporary buffer. */
915 errno = 0;
916 buf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
917 if (buf_size < 0) {
918 if (errno != 0) {
919 PERROR("Failed to query _SC_GETPW_R_SIZE_MAX");
920 goto error;
921 }
922
923 /* Limit is indeterminate. */
924 WARN("Failed to query _SC_GETPW_R_SIZE_MAX as it is "
925 "indeterminate; falling back to default buffer size");
926 buf_size = GETPW_BUFFER_FALLBACK_SIZE;
927 }
928
929 buf = zmalloc(buf_size);
930 if (buf == NULL) {
931 PERROR("Failed to allocate buffer to get password file entries");
932 goto error;
933 }
934
935 ret = getpwuid_r(uid, &pwd, buf, buf_size, &result);
936 if (ret < 0) {
937 PERROR("Failed to get user information for user: uid = %d",
938 (int) uid);
939 goto error;
940 }
941
942 if (result == NULL) {
943 ERR("Failed to find user information in password entries: uid = %d",
944 (int) uid);
945 ret = -1;
946 goto error;
947 }
948
949 *username = strdup(result->pw_name);
950 if (*username == NULL) {
951 PERROR("Failed to copy user name");
952 goto error;
953 }
954
955 *primary_gid = result->pw_gid;
956
957 end:
958 free(buf);
959 return ret;
960 error:
961 *username = NULL;
962 *primary_gid = -1;
963 ret = -1;
964 goto end;
965 }
966
967 static int demote_creds(
968 uid_t prev_uid, gid_t prev_gid, uid_t new_uid, gid_t new_gid)
969 {
970 int ret = 0;
971 gid_t primary_gid;
972 char *username = NULL;
973
974 /* Change the group id. */
975 if (prev_gid != new_gid) {
976 ret = setegid(new_gid);
977 if (ret < 0) {
978 PERROR("Failed to set effective group id: new_gid = %d",
979 (int) new_gid);
980 goto end;
981 }
982 }
983
984 /* Change the user id. */
985 if (prev_uid != new_uid) {
986 ret = get_user_infos_from_uid(new_uid, &username, &primary_gid);
987 if (ret < 0) {
988 goto end;
989 }
990
991 /*
992 * Initialize the supplementary group access list.
993 *
994 * This is needed to handle cases where the supplementary groups
995 * of the user the process is demoting-to would give it access
996 * to a given file/folder, but not it's primary group.
997 *
998 * e.g
999 * username: User1
1000 * Primary Group: User1
1001 * Secondary group: Disk, Network
1002 *
1003 * mkdir inside the following directory must work since User1
1004 * is part of the Network group.
1005 *
1006 * drwxrwx--- 2 root Network 4096 Jul 23 17:17 /tmp/my_folder/
1007 *
1008 *
1009 * The order of the following initgroups and seteuid calls is
1010 * important here;
1011 * Only a root process or one with CAP_SETGID capability can
1012 * call the the initgroups() function. We must initialize the
1013 * supplementary groups before we change the effective
1014 * UID to a less-privileged user.
1015 */
1016 ret = initgroups(username, primary_gid);
1017 if (ret < 0) {
1018 PERROR("Failed to init the supplementary group access list: "
1019 "username = `%s`, primary gid = %d", username,
1020 (int) primary_gid);
1021 goto end;
1022 }
1023
1024 ret = seteuid(new_uid);
1025 if (ret < 0) {
1026 PERROR("Failed to set effective user id: new_uid = %d",
1027 (int) new_uid);
1028 goto end;
1029 }
1030 }
1031 end:
1032 free(username);
1033 return ret;
1034 }
1035
1036 static int promote_creds(
1037 uid_t prev_uid, gid_t prev_gid, uid_t new_uid, gid_t new_gid)
1038 {
1039 int ret = 0;
1040 gid_t primary_gid;
1041 char *username = NULL;
1042
1043 /* Change the group id. */
1044 if (prev_gid != new_gid) {
1045 ret = setegid(new_gid);
1046 if (ret < 0) {
1047 PERROR("Failed to set effective group id: new_gid = %d",
1048 (int) new_gid);
1049 goto end;
1050 }
1051 }
1052
1053 /* Change the user id. */
1054 if (prev_uid != new_uid) {
1055 ret = get_user_infos_from_uid(new_uid, &username, &primary_gid);
1056 if (ret < 0) {
1057 goto end;
1058 }
1059
1060 /*
1061 * seteuid call must be done before the initgroups call because
1062 * we need to be privileged (CAP_SETGID) to call initgroups().
1063 */
1064 ret = seteuid(new_uid);
1065 if (ret < 0) {
1066 PERROR("Failed to set effective user id: new_uid = %d",
1067 (int) new_uid);
1068 goto end;
1069 }
1070
1071 /*
1072 * Initialize the supplementary group access list.
1073 *
1074 * There is a possibility the groups we set in the following
1075 * initgroups() call are not exactly the same as the ones we
1076 * had when we originally demoted. This can happen if the
1077 * /etc/group file is modified after the runas process is
1078 * forked. This is very unlikely.
1079 */
1080 ret = initgroups(username, primary_gid);
1081 if (ret < 0) {
1082 PERROR("Failed to init the supplementary group access "
1083 "list: username = `%s`, primary gid = %d",
1084 username, (int) primary_gid)
1085 goto end;
1086 }
1087 }
1088 end:
1089 free(username);
1090 return ret;
1091 }
1092
1093 /*
1094 * Return < 0 on error, 0 if OK, 1 on hangup.
1095 */
1096 static
1097 int handle_one_cmd(struct run_as_worker *worker)
1098 {
1099 int ret = 0, promote_ret;
1100 struct run_as_data data = {};
1101 ssize_t readlen, writelen;
1102 struct run_as_ret sendret = {};
1103 run_as_fct cmd;
1104 const uid_t prev_ruid = getuid();
1105 const gid_t prev_rgid = getgid();
1106
1107 /*
1108 * Stage 1: Receive run_as_data struct from the master.
1109 * The structure contains the command type and all the parameters needed for
1110 * its execution
1111 */
1112 readlen = lttcomm_recv_unix_sock(worker->sockpair[1], &data,
1113 sizeof(data));
1114 if (readlen == 0) {
1115 /* hang up */
1116 ret = 1;
1117 goto end;
1118 }
1119 if (readlen < sizeof(data)) {
1120 PERROR("lttcomm_recv_unix_sock error");
1121 ret = -1;
1122 goto end;
1123 }
1124
1125 cmd = run_as_enum_to_fct(data.cmd);
1126 if (!cmd) {
1127 ret = -1;
1128 goto end;
1129 }
1130
1131 /*
1132 * Stage 2: Receive file descriptor from master.
1133 * Some commands need a file descriptor as input so if it's needed we
1134 * receive the fd using the Unix socket.
1135 */
1136 ret = recv_fds_from_master(worker, &data);
1137 if (ret < 0) {
1138 PERROR("recv_fd_from_master error");
1139 ret = -1;
1140 goto end;
1141 }
1142
1143 ret = demote_creds(prev_ruid, prev_rgid, data.uid, data.gid);
1144 if (ret < 0) {
1145 goto write_return;
1146 }
1147
1148 /*
1149 * Also set umask to 0 for mkdir executable bit.
1150 */
1151 umask(0);
1152
1153 /*
1154 * Stage 3: Execute the command
1155 */
1156 ret = (*cmd)(&data, &sendret);
1157 if (ret < 0) {
1158 DBG("Execution of command returned an error");
1159 }
1160
1161 write_return:
1162 ret = cleanup_received_fds(&data);
1163 if (ret < 0) {
1164 ERR("Error cleaning up FD");
1165 goto promote_back;
1166 }
1167
1168 /*
1169 * Stage 4: Send run_as_ret structure to the master.
1170 * This structure contain the return value of the command and the errno.
1171 */
1172 writelen = lttcomm_send_unix_sock(worker->sockpair[1], &sendret,
1173 sizeof(sendret));
1174 if (writelen < sizeof(sendret)) {
1175 PERROR("lttcomm_send_unix_sock error");
1176 ret = -1;
1177 goto promote_back;
1178 }
1179
1180 /*
1181 * Stage 5: Send resulting file descriptors to the master.
1182 */
1183 ret = send_fds_to_master(worker, data.cmd, &sendret);
1184 if (ret < 0) {
1185 DBG("Sending FD to master returned an error");
1186 }
1187
1188 ret = 0;
1189
1190 promote_back:
1191 /* Return to previous uid/gid. */
1192 promote_ret = promote_creds(data.uid, data.gid, prev_ruid, prev_rgid);
1193 if (promote_ret < 0) {
1194 ERR("Failed to promote back to the initial credentials");
1195 }
1196
1197 end:
1198 return ret;
1199 }
1200
1201 static
1202 int run_as_worker(struct run_as_worker *worker)
1203 {
1204 int ret;
1205 ssize_t writelen;
1206 struct run_as_ret sendret;
1207 size_t proc_orig_len;
1208
1209 /*
1210 * Initialize worker. Set a different process cmdline.
1211 */
1212 proc_orig_len = strlen(worker->procname);
1213 memset(worker->procname, 0, proc_orig_len);
1214 strncpy(worker->procname, DEFAULT_RUN_AS_WORKER_NAME, proc_orig_len);
1215
1216 ret = lttng_thread_setname(DEFAULT_RUN_AS_WORKER_NAME);
1217 if (ret && ret != -ENOSYS) {
1218 /* Don't fail as this is not essential. */
1219 DBG("Failed to set pthread name attribute");
1220 }
1221
1222 memset(&sendret, 0, sizeof(sendret));
1223
1224 writelen = lttcomm_send_unix_sock(worker->sockpair[1], &sendret,
1225 sizeof(sendret));
1226 if (writelen < sizeof(sendret)) {
1227 PERROR("lttcomm_send_unix_sock error");
1228 ret = EXIT_FAILURE;
1229 goto end;
1230 }
1231
1232 for (;;) {
1233 ret = handle_one_cmd(worker);
1234 if (ret < 0) {
1235 ret = EXIT_FAILURE;
1236 goto end;
1237 } else if (ret > 0) {
1238 break;
1239 } else {
1240 continue; /* Next command. */
1241 }
1242 }
1243 ret = EXIT_SUCCESS;
1244 end:
1245 return ret;
1246 }
1247
1248 static
1249 int run_as_cmd(struct run_as_worker *worker,
1250 enum run_as_cmd cmd,
1251 struct run_as_data *data,
1252 struct run_as_ret *ret_value,
1253 uid_t uid, gid_t gid)
1254 {
1255 int ret = 0;
1256 ssize_t readlen, writelen;
1257
1258 /*
1259 * If we are non-root, we can only deal with our own uid.
1260 */
1261 if (geteuid() != 0) {
1262 if (uid != geteuid()) {
1263 ret = -1;
1264 ret_value->_errno = EPERM;
1265 ERR("Client (%d)/Server (%d) UID mismatch (and sessiond is not root)",
1266 (int) uid, (int) geteuid());
1267 goto end;
1268 }
1269 }
1270
1271 data->cmd = cmd;
1272 data->uid = uid;
1273 data->gid = gid;
1274
1275 /*
1276 * Stage 1: Send the run_as_data struct to the worker process
1277 */
1278 writelen = lttcomm_send_unix_sock(worker->sockpair[0], data,
1279 sizeof(*data));
1280 if (writelen < sizeof(*data)) {
1281 PERROR("Error writing message to run_as");
1282 ret = -1;
1283 ret_value->_errno = EIO;
1284 goto end;
1285 }
1286
1287 /*
1288 * Stage 2: Send file descriptor to the worker process if needed
1289 */
1290 ret = send_fds_to_worker(worker, data);
1291 if (ret) {
1292 PERROR("do_send_fd error");
1293 ret = -1;
1294 ret_value->_errno = EIO;
1295 goto end;
1296 }
1297
1298 /*
1299 * Stage 3: Wait for the execution of the command
1300 */
1301
1302 /*
1303 * Stage 4: Receive the run_as_ret struct containing the return value and
1304 * errno
1305 */
1306 readlen = lttcomm_recv_unix_sock(worker->sockpair[0], ret_value,
1307 sizeof(*ret_value));
1308 if (!readlen) {
1309 ERR("Run-as worker has hung-up during run_as_cmd");
1310 ret = -1;
1311 ret_value->_errno = EIO;
1312 goto end;
1313 } else if (readlen < sizeof(*ret_value)) {
1314 PERROR("Error reading response from run_as");
1315 ret = -1;
1316 ret_value->_errno = errno;
1317 goto end;
1318 }
1319
1320 if (ret_value->_error) {
1321 /* Skip stage 5 on error as there will be no fd to receive. */
1322 goto end;
1323 }
1324
1325 /*
1326 * Stage 5: Receive file descriptor if needed
1327 */
1328 ret = recv_fds_from_worker(worker, cmd, ret_value);
1329 if (ret < 0) {
1330 ERR("Error receiving fd");
1331 ret = -1;
1332 ret_value->_errno = EIO;
1333 }
1334
1335 end:
1336 return ret;
1337 }
1338
1339 /*
1340 * This is for debugging ONLY and should not be considered secure.
1341 */
1342 static
1343 int run_as_noworker(enum run_as_cmd cmd,
1344 struct run_as_data *data, struct run_as_ret *ret_value,
1345 uid_t uid, gid_t gid)
1346 {
1347 int ret, saved_errno;
1348 mode_t old_mask;
1349 run_as_fct fct;
1350
1351 fct = run_as_enum_to_fct(cmd);
1352 if (!fct) {
1353 errno = -ENOSYS;
1354 ret = -1;
1355 goto end;
1356 }
1357 old_mask = umask(0);
1358 ret = fct(data, ret_value);
1359 saved_errno = ret_value->_errno;
1360 umask(old_mask);
1361 errno = saved_errno;
1362 end:
1363 return ret;
1364 }
1365
1366 static
1367 int reset_sighandler(void)
1368 {
1369 int sig;
1370
1371 DBG("Resetting run_as worker signal handlers to default");
1372 for (sig = 1; sig <= 31; sig++) {
1373 (void) signal(sig, SIG_DFL);
1374 }
1375 return 0;
1376 }
1377
1378 static
1379 void worker_sighandler(int sig)
1380 {
1381 const char *signame;
1382
1383 /*
1384 * The worker will inherit its parent's signals since they are part of
1385 * the same process group. However, in the case of SIGINT and SIGTERM,
1386 * we want to give the worker a chance to teardown gracefully when its
1387 * parent closes the command socket.
1388 */
1389 switch (sig) {
1390 case SIGINT:
1391 signame = "SIGINT";
1392 break;
1393 case SIGTERM:
1394 signame = "SIGTERM";
1395 break;
1396 default:
1397 signame = NULL;
1398 }
1399
1400 if (signame) {
1401 DBG("run_as worker received signal %s", signame);
1402 } else {
1403 DBG("run_as_worker received signal %d", sig);
1404 }
1405 }
1406
1407 static
1408 int set_worker_sighandlers(void)
1409 {
1410 int ret = 0;
1411 sigset_t sigset;
1412 struct sigaction sa;
1413
1414 if ((ret = sigemptyset(&sigset)) < 0) {
1415 PERROR("sigemptyset");
1416 goto end;
1417 }
1418
1419 sa.sa_handler = worker_sighandler;
1420 sa.sa_mask = sigset;
1421 sa.sa_flags = 0;
1422 if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
1423 PERROR("sigaction SIGINT");
1424 goto end;
1425 }
1426
1427 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
1428 PERROR("sigaction SIGTERM");
1429 goto end;
1430 }
1431
1432 DBG("run_as signal handler set for SIGTERM and SIGINT");
1433 end:
1434 return ret;
1435 }
1436
1437 static
1438 int run_as_create_worker_no_lock(const char *procname,
1439 post_fork_cleanup_cb clean_up_func,
1440 void *clean_up_user_data)
1441 {
1442 pid_t pid;
1443 int i, ret = 0;
1444 ssize_t readlen;
1445 struct run_as_ret recvret;
1446 struct run_as_worker *worker;
1447
1448 assert(!global_worker);
1449 if (!use_clone()) {
1450 /*
1451 * Don't initialize a worker, all run_as tasks will be performed
1452 * in the current process.
1453 */
1454 ret = 0;
1455 goto end;
1456 }
1457 worker = zmalloc(sizeof(*worker));
1458 if (!worker) {
1459 ret = -ENOMEM;
1460 goto end;
1461 }
1462 worker->procname = strdup(procname);
1463 if (!worker->procname) {
1464 ret = -ENOMEM;
1465 goto error_procname_alloc;
1466 }
1467 /* Create unix socket. */
1468 if (lttcomm_create_anon_unix_socketpair(worker->sockpair) < 0) {
1469 ret = -1;
1470 goto error_sock;
1471 }
1472
1473 /* Fork worker. */
1474 pid = fork();
1475 if (pid < 0) {
1476 PERROR("fork");
1477 ret = -1;
1478 goto error_fork;
1479 } else if (pid == 0) {
1480 /* Child */
1481
1482 reset_sighandler();
1483
1484 set_worker_sighandlers();
1485
1486 logger_set_thread_name("Run-as worker", true);
1487
1488 if (clean_up_func) {
1489 if (clean_up_func(clean_up_user_data) < 0) {
1490 ERR("Run-as post-fork clean-up failed, exiting.");
1491 exit(EXIT_FAILURE);
1492 }
1493 }
1494
1495 /* Just close, no shutdown. */
1496 if (close(worker->sockpair[0])) {
1497 PERROR("close");
1498 exit(EXIT_FAILURE);
1499 }
1500
1501 /*
1502 * Close all FDs aside from STDIN, STDOUT, STDERR and sockpair[1]
1503 * Sockpair[1] is used as a control channel with the master
1504 */
1505 for (i = 3; i < sysconf(_SC_OPEN_MAX); i++) {
1506 if (i != worker->sockpair[1]) {
1507 (void) close(i);
1508 }
1509 }
1510
1511 worker->sockpair[0] = -1;
1512 ret = run_as_worker(worker);
1513 if (lttcomm_close_unix_sock(worker->sockpair[1])) {
1514 PERROR("close");
1515 ret = -1;
1516 }
1517 worker->sockpair[1] = -1;
1518 free(worker->procname);
1519 free(worker);
1520 LOG(ret ? PRINT_ERR : PRINT_DBG, "run_as worker exiting (ret = %d)", ret);
1521 exit(ret ? EXIT_FAILURE : EXIT_SUCCESS);
1522 } else {
1523 /* Parent */
1524
1525 /* Just close, no shutdown. */
1526 if (close(worker->sockpair[1])) {
1527 PERROR("close");
1528 ret = -1;
1529 goto error_fork;
1530 }
1531 worker->sockpair[1] = -1;
1532 worker->pid = pid;
1533 /* Wait for worker to become ready. */
1534 readlen = lttcomm_recv_unix_sock(worker->sockpair[0],
1535 &recvret, sizeof(recvret));
1536 if (readlen < sizeof(recvret)) {
1537 ERR("readlen: %zd", readlen);
1538 PERROR("Error reading response from run_as at creation");
1539 ret = -1;
1540 goto error_fork;
1541 }
1542 global_worker = worker;
1543 }
1544 end:
1545 return ret;
1546
1547 /* Error handling. */
1548 error_fork:
1549 for (i = 0; i < 2; i++) {
1550 if (worker->sockpair[i] < 0) {
1551 continue;
1552 }
1553 if (lttcomm_close_unix_sock(worker->sockpair[i])) {
1554 PERROR("close");
1555 }
1556 worker->sockpair[i] = -1;
1557 }
1558 error_sock:
1559 free(worker->procname);
1560 error_procname_alloc:
1561 free(worker);
1562 return ret;
1563 }
1564
1565 static
1566 void run_as_destroy_worker_no_lock(void)
1567 {
1568 struct run_as_worker *worker = global_worker;
1569
1570 DBG("Destroying run_as worker");
1571 if (!worker) {
1572 return;
1573 }
1574 /* Close unix socket */
1575 DBG("Closing run_as worker socket");
1576 if (lttcomm_close_unix_sock(worker->sockpair[0])) {
1577 PERROR("close");
1578 }
1579 worker->sockpair[0] = -1;
1580 /* Wait for worker. */
1581 for (;;) {
1582 int status;
1583 pid_t wait_ret;
1584
1585 wait_ret = waitpid(worker->pid, &status, 0);
1586 if (wait_ret < 0) {
1587 if (errno == EINTR) {
1588 continue;
1589 }
1590 PERROR("waitpid");
1591 break;
1592 }
1593
1594 if (WIFEXITED(status)) {
1595 LOG(WEXITSTATUS(status) == 0 ? PRINT_DBG : PRINT_ERR,
1596 DEFAULT_RUN_AS_WORKER_NAME " terminated with status code %d",
1597 WEXITSTATUS(status));
1598 break;
1599 } else if (WIFSIGNALED(status)) {
1600 ERR(DEFAULT_RUN_AS_WORKER_NAME " was killed by signal %d",
1601 WTERMSIG(status));
1602 break;
1603 }
1604 }
1605 free(worker->procname);
1606 free(worker);
1607 global_worker = NULL;
1608 }
1609
1610 static
1611 int run_as_restart_worker(struct run_as_worker *worker)
1612 {
1613 int ret = 0;
1614 char *procname = NULL;
1615
1616 procname = worker->procname;
1617
1618 /* Close socket to run_as worker process and clean up the zombie process */
1619 run_as_destroy_worker_no_lock();
1620
1621 /* Create a new run_as worker process*/
1622 ret = run_as_create_worker_no_lock(procname, NULL, NULL);
1623 if (ret < 0 ) {
1624 ERR("Restarting the worker process failed");
1625 ret = -1;
1626 goto err;
1627 }
1628 err:
1629 return ret;
1630 }
1631
1632 static
1633 int run_as(enum run_as_cmd cmd, struct run_as_data *data,
1634 struct run_as_ret *ret_value, uid_t uid, gid_t gid)
1635 {
1636 int ret, saved_errno;
1637
1638 pthread_mutex_lock(&worker_lock);
1639 if (use_clone()) {
1640 DBG("Using run_as worker");
1641
1642 assert(global_worker);
1643
1644 ret = run_as_cmd(global_worker, cmd, data, ret_value, uid, gid);
1645 saved_errno = ret_value->_errno;
1646
1647 /*
1648 * If the worker thread crashed the errno is set to EIO. we log
1649 * the error and start a new worker process.
1650 */
1651 if (ret == -1 && saved_errno == EIO) {
1652 DBG("Socket closed unexpectedly... "
1653 "Restarting the worker process");
1654 ret = run_as_restart_worker(global_worker);
1655 if (ret == -1) {
1656 ERR("Failed to restart worker process.");
1657 goto err;
1658 }
1659 }
1660 } else {
1661 DBG("Using run_as without worker");
1662 ret = run_as_noworker(cmd, data, ret_value, uid, gid);
1663 }
1664 err:
1665 pthread_mutex_unlock(&worker_lock);
1666 return ret;
1667 }
1668
1669 LTTNG_HIDDEN
1670 int run_as_mkdir_recursive(const char *path, mode_t mode, uid_t uid, gid_t gid)
1671 {
1672 return run_as_mkdirat_recursive(AT_FDCWD, path, mode, uid, gid);
1673 }
1674
1675 LTTNG_HIDDEN
1676 int run_as_mkdirat_recursive(int dirfd, const char *path, mode_t mode,
1677 uid_t uid, gid_t gid)
1678 {
1679 int ret;
1680 struct run_as_data data = {};
1681 struct run_as_ret run_as_ret = {};
1682
1683 DBG3("mkdirat() recursive fd = %d%s, path = %s, mode = %d, uid = %d, gid = %d",
1684 dirfd, dirfd == AT_FDCWD ? " (AT_FDCWD)" : "",
1685 path, (int) mode, (int) uid, (int) gid);
1686 ret = lttng_strncpy(data.u.mkdir.path, path,
1687 sizeof(data.u.mkdir.path));
1688 if (ret) {
1689 ERR("Failed to copy path argument of mkdirat recursive command");
1690 goto error;
1691 }
1692 data.u.mkdir.path[sizeof(data.u.mkdir.path) - 1] = '\0';
1693 data.u.mkdir.mode = mode;
1694 data.u.mkdir.dirfd = dirfd;
1695 run_as(dirfd == AT_FDCWD ? RUN_AS_MKDIR_RECURSIVE : RUN_AS_MKDIRAT_RECURSIVE,
1696 &data, &run_as_ret, uid, gid);
1697 errno = run_as_ret._errno;
1698 ret = run_as_ret.u.ret;
1699 error:
1700 return ret;
1701 }
1702
1703 LTTNG_HIDDEN
1704 int run_as_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid)
1705 {
1706 return run_as_mkdirat(AT_FDCWD, path, mode, uid, gid);
1707 }
1708
1709 LTTNG_HIDDEN
1710 int run_as_mkdirat(int dirfd, const char *path, mode_t mode,
1711 uid_t uid, gid_t gid)
1712 {
1713 int ret;
1714 struct run_as_data data = {};
1715 struct run_as_ret run_as_ret = {};
1716
1717 DBG3("mkdirat() recursive fd = %d%s, path = %s, mode = %d, uid = %d, gid = %d",
1718 dirfd, dirfd == AT_FDCWD ? " (AT_FDCWD)" : "",
1719 path, (int) mode, (int) uid, (int) gid);
1720 ret = lttng_strncpy(data.u.mkdir.path, path,
1721 sizeof(data.u.mkdir.path));
1722 if (ret) {
1723 ERR("Failed to copy path argument of mkdirat command");
1724 goto error;
1725 }
1726 data.u.mkdir.path[sizeof(data.u.mkdir.path) - 1] = '\0';
1727 data.u.mkdir.mode = mode;
1728 data.u.mkdir.dirfd = dirfd;
1729 run_as(dirfd == AT_FDCWD ? RUN_AS_MKDIR : RUN_AS_MKDIRAT,
1730 &data, &run_as_ret, uid, gid);
1731 errno = run_as_ret._errno;
1732 ret = run_as_ret.u.ret;
1733 error:
1734 return ret;
1735 }
1736
1737 LTTNG_HIDDEN
1738 int run_as_open(const char *path, int flags, mode_t mode, uid_t uid,
1739 gid_t gid)
1740 {
1741 return run_as_openat(AT_FDCWD, path, flags, mode, uid, gid);
1742 }
1743
1744 LTTNG_HIDDEN
1745 int run_as_openat(int dirfd, const char *path, int flags, mode_t mode,
1746 uid_t uid, gid_t gid)
1747 {
1748 int ret;
1749 struct run_as_data data = {};
1750 struct run_as_ret run_as_ret = {};
1751
1752 DBG3("openat() fd = %d%s, path = %s, flags = %X, mode = %d, uid %d, gid %d",
1753 dirfd, dirfd == AT_FDCWD ? " (AT_FDCWD)" : "",
1754 path, flags, (int) mode, (int) uid, (int) gid);
1755 ret = lttng_strncpy(data.u.open.path, path, sizeof(data.u.open.path));
1756 if (ret) {
1757 ERR("Failed to copy path argument of open command");
1758 goto error;
1759 }
1760 data.u.open.flags = flags;
1761 data.u.open.mode = mode;
1762 data.u.open.dirfd = dirfd;
1763 run_as(dirfd == AT_FDCWD ? RUN_AS_OPEN : RUN_AS_OPENAT,
1764 &data, &run_as_ret, uid, gid);
1765 errno = run_as_ret._errno;
1766 ret = run_as_ret.u.ret < 0 ? run_as_ret.u.ret :
1767 run_as_ret.u.open.fd;
1768 error:
1769 return ret;
1770 }
1771
1772 LTTNG_HIDDEN
1773 int run_as_unlink(const char *path, uid_t uid, gid_t gid)
1774 {
1775 return run_as_unlinkat(AT_FDCWD, path, uid, gid);
1776 }
1777
1778 LTTNG_HIDDEN
1779 int run_as_unlinkat(int dirfd, const char *path, uid_t uid, gid_t gid)
1780 {
1781 int ret;
1782 struct run_as_data data = {};
1783 struct run_as_ret run_as_ret = {};
1784
1785 DBG3("unlinkat() fd = %d%s, path = %s, uid = %d, gid = %d",
1786 dirfd, dirfd == AT_FDCWD ? " (AT_FDCWD)" : "",
1787 path, (int) uid, (int) gid);
1788 ret = lttng_strncpy(data.u.unlink.path, path,
1789 sizeof(data.u.unlink.path));
1790 if (ret) {
1791 goto error;
1792 }
1793 data.u.unlink.dirfd = dirfd;
1794 run_as(dirfd == AT_FDCWD ? RUN_AS_UNLINK : RUN_AS_UNLINKAT, &data,
1795 &run_as_ret, uid, gid);
1796 errno = run_as_ret._errno;
1797 ret = run_as_ret.u.ret;
1798 error:
1799 return ret;
1800 }
1801
1802 LTTNG_HIDDEN
1803 int run_as_rmdir(const char *path, uid_t uid, gid_t gid)
1804 {
1805 return run_as_rmdirat(AT_FDCWD, path, uid, gid);
1806 }
1807
1808 LTTNG_HIDDEN
1809 int run_as_rmdirat(int dirfd, const char *path, uid_t uid, gid_t gid)
1810 {
1811 int ret;
1812 struct run_as_data data = {};
1813 struct run_as_ret run_as_ret = {};
1814
1815 DBG3("rmdirat() fd = %d%s, path = %s, uid = %d, gid = %d",
1816 dirfd, dirfd == AT_FDCWD ? " (AT_FDCWD)" : "",
1817 path, (int) uid, (int) gid);
1818 ret = lttng_strncpy(data.u.rmdir.path, path,
1819 sizeof(data.u.rmdir.path));
1820 if (ret) {
1821 goto error;
1822 }
1823 data.u.rmdir.dirfd = dirfd;
1824 run_as(dirfd == AT_FDCWD ? RUN_AS_RMDIR : RUN_AS_RMDIRAT, &data,
1825 &run_as_ret, uid, gid);
1826 errno = run_as_ret._errno;
1827 ret = run_as_ret.u.ret;
1828 error:
1829 return ret;
1830 }
1831
1832 LTTNG_HIDDEN
1833 int run_as_rmdir_recursive(const char *path, uid_t uid, gid_t gid, int flags)
1834 {
1835 return run_as_rmdirat_recursive(AT_FDCWD, path, uid, gid, flags);
1836 }
1837
1838 LTTNG_HIDDEN
1839 int run_as_rmdirat_recursive(int dirfd, const char *path, uid_t uid, gid_t gid, int flags)
1840 {
1841 int ret;
1842 struct run_as_data data = {};
1843 struct run_as_ret run_as_ret = {};
1844
1845 DBG3("rmdirat() recursive fd = %d%s, path = %s, uid = %d, gid = %d",
1846 dirfd, dirfd == AT_FDCWD ? " (AT_FDCWD)" : "",
1847 path, (int) uid, (int) gid);
1848 ret = lttng_strncpy(data.u.rmdir.path, path,
1849 sizeof(data.u.rmdir.path));
1850 if (ret) {
1851 goto error;
1852 }
1853 data.u.rmdir.dirfd = dirfd;
1854 data.u.rmdir.flags = flags;
1855 run_as(dirfd == AT_FDCWD ? RUN_AS_RMDIR_RECURSIVE : RUN_AS_RMDIRAT_RECURSIVE,
1856 &data, &run_as_ret, uid, gid);
1857 errno = run_as_ret._errno;
1858 ret = run_as_ret.u.ret;
1859 error:
1860 return ret;
1861 }
1862
1863 LTTNG_HIDDEN
1864 int run_as_rename(const char *old, const char *new, uid_t uid, gid_t gid)
1865 {
1866 return run_as_renameat(AT_FDCWD, old, AT_FDCWD, new, uid, gid);
1867 }
1868
1869 LTTNG_HIDDEN
1870 int run_as_renameat(int old_dirfd, const char *old_name,
1871 int new_dirfd, const char *new_name, uid_t uid, gid_t gid)
1872 {
1873 int ret;
1874 struct run_as_data data = {};
1875 struct run_as_ret run_as_ret = {};
1876
1877 DBG3("renameat() old_dirfd = %d%s, old_name = %s, new_dirfd = %d%s, new_name = %s, uid = %d, gid = %d",
1878 old_dirfd, old_dirfd == AT_FDCWD ? " (AT_FDCWD)" : "",
1879 old_name,
1880 new_dirfd, new_dirfd == AT_FDCWD ? " (AT_FDCWD)" : "",
1881 new_name, (int) uid, (int) gid);
1882 ret = lttng_strncpy(data.u.rename.old_path, old_name,
1883 sizeof(data.u.rename.old_path));
1884 if (ret) {
1885 goto error;
1886 }
1887 ret = lttng_strncpy(data.u.rename.new_path, new_name,
1888 sizeof(data.u.rename.new_path));
1889 if (ret) {
1890 goto error;
1891 }
1892
1893 data.u.rename.dirfds[0] = old_dirfd;
1894 data.u.rename.dirfds[1] = new_dirfd;
1895 run_as(old_dirfd == AT_FDCWD && new_dirfd == AT_FDCWD ?
1896 RUN_AS_RENAME : RUN_AS_RENAMEAT,
1897 &data, &run_as_ret, uid, gid);
1898 errno = run_as_ret._errno;
1899 ret = run_as_ret.u.ret;
1900 error:
1901 return ret;
1902 }
1903
1904 LTTNG_HIDDEN
1905 int run_as_extract_elf_symbol_offset(int fd, const char* function,
1906 uid_t uid, gid_t gid, uint64_t *offset)
1907 {
1908 int ret;
1909 struct run_as_data data = {};
1910 struct run_as_ret run_as_ret = {};
1911
1912 DBG3("extract_elf_symbol_offset() on fd=%d and function=%s "
1913 "with for uid %d and gid %d", fd, function,
1914 (int) uid, (int) gid);
1915
1916 data.u.extract_elf_symbol_offset.fd = fd;
1917
1918 strncpy(data.u.extract_elf_symbol_offset.function, function, LTTNG_SYMBOL_NAME_LEN - 1);
1919 data.u.extract_elf_symbol_offset.function[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
1920 ret = lttng_strncpy(data.u.extract_elf_symbol_offset.function,
1921 function,
1922 sizeof(data.u.extract_elf_symbol_offset.function));
1923 if (ret) {
1924 goto error;
1925 }
1926
1927 run_as(RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET, &data, &run_as_ret, uid, gid);
1928 errno = run_as_ret._errno;
1929 if (run_as_ret._error) {
1930 ret = -1;
1931 goto error;
1932 }
1933
1934 *offset = run_as_ret.u.extract_elf_symbol_offset.offset;
1935 error:
1936 return ret;
1937 }
1938
1939 LTTNG_HIDDEN
1940 int run_as_extract_sdt_probe_offsets(int fd, const char* provider_name,
1941 const char* probe_name, uid_t uid, gid_t gid,
1942 uint64_t **offsets, uint32_t *num_offset)
1943 {
1944 int ret;
1945 struct run_as_data data = {};
1946 struct run_as_ret run_as_ret = {};
1947
1948 DBG3("extract_sdt_probe_offsets() on fd=%d, probe_name=%s and "
1949 "provider_name=%s with for uid %d and gid %d", fd,
1950 probe_name, provider_name, (int) uid, (int) gid);
1951
1952 data.u.extract_sdt_probe_offsets.fd = fd;
1953
1954 ret = lttng_strncpy(data.u.extract_sdt_probe_offsets.probe_name, probe_name,
1955 sizeof(data.u.extract_sdt_probe_offsets.probe_name));
1956 if (ret) {
1957 goto error;
1958 }
1959 ret = lttng_strncpy(data.u.extract_sdt_probe_offsets.provider_name,
1960 provider_name,
1961 sizeof(data.u.extract_sdt_probe_offsets.provider_name));
1962 if (ret) {
1963 goto error;
1964 }
1965
1966 run_as(RUN_AS_EXTRACT_SDT_PROBE_OFFSETS, &data, &run_as_ret, uid, gid);
1967 errno = run_as_ret._errno;
1968 if (run_as_ret._error) {
1969 ret = -1;
1970 goto error;
1971 }
1972
1973 *num_offset = run_as_ret.u.extract_sdt_probe_offsets.num_offset;
1974 *offsets = zmalloc(*num_offset * sizeof(uint64_t));
1975 if (!*offsets) {
1976 ret = -ENOMEM;
1977 goto error;
1978 }
1979
1980 memcpy(*offsets, run_as_ret.u.extract_sdt_probe_offsets.offsets,
1981 *num_offset * sizeof(uint64_t));
1982 error:
1983 return ret;
1984 }
1985
1986 LTTNG_HIDDEN
1987 int run_as_generate_filter_bytecode(const char *filter_expression,
1988 const struct lttng_credentials *creds,
1989 struct lttng_bytecode **bytecode)
1990 {
1991 int ret;
1992 struct run_as_data data = {};
1993 struct run_as_ret run_as_ret = {};
1994 const struct lttng_bytecode *view_bytecode = NULL;
1995 struct lttng_bytecode *local_bytecode = NULL;
1996 const uid_t uid = lttng_credentials_get_uid(creds);
1997 const gid_t gid = lttng_credentials_get_gid(creds);
1998
1999 DBG3("generate_filter_bytecode() from expression=\"%s\" for uid %d and gid %d",
2000 filter_expression, (int) uid, (int) gid);
2001
2002 ret = lttng_strncpy(data.u.generate_filter_bytecode.filter_expression, filter_expression,
2003 sizeof(data.u.generate_filter_bytecode.filter_expression));
2004 if (ret) {
2005 goto error;
2006 }
2007
2008 run_as(RUN_AS_GENERATE_FILTER_BYTECODE, &data, &run_as_ret, uid, gid);
2009 errno = run_as_ret._errno;
2010 if (run_as_ret._error) {
2011 ret = -1;
2012 goto error;
2013 }
2014
2015 view_bytecode = (const struct lttng_bytecode *) run_as_ret.u.generate_filter_bytecode.bytecode;
2016
2017 local_bytecode = zmalloc(sizeof(*local_bytecode) + view_bytecode->len);
2018 if (!local_bytecode) {
2019 ret = -ENOMEM;
2020 goto error;
2021 }
2022
2023 memcpy(local_bytecode, run_as_ret.u.generate_filter_bytecode.bytecode,
2024 sizeof(*local_bytecode) + view_bytecode->len);
2025 *bytecode = local_bytecode;
2026 error:
2027 return ret;
2028 }
2029
2030 LTTNG_HIDDEN
2031 int run_as_create_worker(const char *procname,
2032 post_fork_cleanup_cb clean_up_func,
2033 void *clean_up_user_data)
2034 {
2035 int ret;
2036
2037 pthread_mutex_lock(&worker_lock);
2038 ret = run_as_create_worker_no_lock(procname, clean_up_func,
2039 clean_up_user_data);
2040 pthread_mutex_unlock(&worker_lock);
2041 return ret;
2042 }
2043
2044 LTTNG_HIDDEN
2045 void run_as_destroy_worker(void)
2046 {
2047 pthread_mutex_lock(&worker_lock);
2048 run_as_destroy_worker_no_lock();
2049 pthread_mutex_unlock(&worker_lock);
2050 }
This page took 0.085676 seconds and 3 git commands to generate.