Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * umh - the kernel usermode helper
4 */
5#include <linux/module.h>
6#include <linux/sched.h>
7#include <linux/sched/task.h>
8#include <linux/binfmts.h>
9#include <linux/syscalls.h>
10#include <linux/unistd.h>
11#include <linux/kmod.h>
12#include <linux/slab.h>
13#include <linux/completion.h>
14#include <linux/cred.h>
15#include <linux/file.h>
16#include <linux/fdtable.h>
17#include <linux/workqueue.h>
18#include <linux/security.h>
19#include <linux/mount.h>
20#include <linux/kernel.h>
21#include <linux/init.h>
22#include <linux/resource.h>
23#include <linux/notifier.h>
24#include <linux/suspend.h>
25#include <linux/rwsem.h>
26#include <linux/ptrace.h>
27#include <linux/async.h>
28#include <linux/uaccess.h>
29#include <linux/shmem_fs.h>
30#include <linux/pipe_fs_i.h>
31
32#include <trace/events/module.h>
33
34#define CAP_BSET (void *)1
35#define CAP_PI (void *)2
36
37static kernel_cap_t usermodehelper_bset = CAP_FULL_SET;
38static kernel_cap_t usermodehelper_inheritable = CAP_FULL_SET;
39static DEFINE_SPINLOCK(umh_sysctl_lock);
40static DECLARE_RWSEM(umhelper_sem);
41static LIST_HEAD(umh_list);
42static DEFINE_MUTEX(umh_list_lock);
43
44static void call_usermodehelper_freeinfo(struct subprocess_info *info)
45{
46 if (info->cleanup)
47 (*info->cleanup)(info);
48 kfree(info);
49}
50
51static void umh_complete(struct subprocess_info *sub_info)
52{
53 struct completion *comp = xchg(&sub_info->complete, NULL);
54 /*
55 * See call_usermodehelper_exec(). If xchg() returns NULL
56 * we own sub_info, the UMH_KILLABLE caller has gone away
57 * or the caller used UMH_NO_WAIT.
58 */
59 if (comp)
60 complete(comp);
61 else
62 call_usermodehelper_freeinfo(sub_info);
63}
64
65/*
66 * This is the task which runs the usermode application
67 */
68static int call_usermodehelper_exec_async(void *data)
69{
70 struct subprocess_info *sub_info = data;
71 struct cred *new;
72 int retval;
73
74 spin_lock_irq(¤t->sighand->siglock);
75 flush_signal_handlers(current, 1);
76 spin_unlock_irq(¤t->sighand->siglock);
77
78 /*
79 * Our parent (unbound workqueue) runs with elevated scheduling
80 * priority. Avoid propagating that into the userspace child.
81 */
82 set_user_nice(current, 0);
83
84 retval = -ENOMEM;
85 new = prepare_kernel_cred(current);
86 if (!new)
87 goto out;
88
89 spin_lock(&umh_sysctl_lock);
90 new->cap_bset = cap_intersect(usermodehelper_bset, new->cap_bset);
91 new->cap_inheritable = cap_intersect(usermodehelper_inheritable,
92 new->cap_inheritable);
93 spin_unlock(&umh_sysctl_lock);
94
95 if (sub_info->init) {
96 retval = sub_info->init(sub_info, new);
97 if (retval) {
98 abort_creds(new);
99 goto out;
100 }
101 }
102
103 commit_creds(new);
104
105 sub_info->pid = task_pid_nr(current);
106 if (sub_info->file) {
107 retval = do_execve_file(sub_info->file,
108 sub_info->argv, sub_info->envp);
109 if (!retval)
110 current->flags |= PF_UMH;
111 } else
112 retval = do_execve(getname_kernel(sub_info->path),
113 (const char __user *const __user *)sub_info->argv,
114 (const char __user *const __user *)sub_info->envp);
115out:
116 sub_info->retval = retval;
117 /*
118 * call_usermodehelper_exec_sync() will call umh_complete
119 * if UHM_WAIT_PROC.
120 */
121 if (!(sub_info->wait & UMH_WAIT_PROC))
122 umh_complete(sub_info);
123 if (!retval)
124 return 0;
125 do_exit(0);
126}
127
128/* Handles UMH_WAIT_PROC. */
129static void call_usermodehelper_exec_sync(struct subprocess_info *sub_info)
130{
131 pid_t pid;
132
133 /* If SIGCLD is ignored kernel_wait4 won't populate the status. */
134 kernel_sigaction(SIGCHLD, SIG_DFL);
135 pid = kernel_thread(call_usermodehelper_exec_async, sub_info, SIGCHLD);
136 if (pid < 0) {
137 sub_info->retval = pid;
138 } else {
139 int ret = -ECHILD;
140 /*
141 * Normally it is bogus to call wait4() from in-kernel because
142 * wait4() wants to write the exit code to a userspace address.
143 * But call_usermodehelper_exec_sync() always runs as kernel
144 * thread (workqueue) and put_user() to a kernel address works
145 * OK for kernel threads, due to their having an mm_segment_t
146 * which spans the entire address space.
147 *
148 * Thus the __user pointer cast is valid here.
149 */
150 kernel_wait4(pid, (int __user *)&ret, 0, NULL);
151
152 /*
153 * If ret is 0, either call_usermodehelper_exec_async failed and
154 * the real error code is already in sub_info->retval or
155 * sub_info->retval is 0 anyway, so don't mess with it then.
156 */
157 if (ret)
158 sub_info->retval = ret;
159 }
160
161 /* Restore default kernel sig handler */
162 kernel_sigaction(SIGCHLD, SIG_IGN);
163
164 umh_complete(sub_info);
165}
166
167/*
168 * We need to create the usermodehelper kernel thread from a task that is affine
169 * to an optimized set of CPUs (or nohz housekeeping ones) such that they
170 * inherit a widest affinity irrespective of call_usermodehelper() callers with
171 * possibly reduced affinity (eg: per-cpu workqueues). We don't want
172 * usermodehelper targets to contend a busy CPU.
173 *
174 * Unbound workqueues provide such wide affinity and allow to block on
175 * UMH_WAIT_PROC requests without blocking pending request (up to some limit).
176 *
177 * Besides, workqueues provide the privilege level that caller might not have
178 * to perform the usermodehelper request.
179 *
180 */
181static void call_usermodehelper_exec_work(struct work_struct *work)
182{
183 struct subprocess_info *sub_info =
184 container_of(work, struct subprocess_info, work);
185
186 if (sub_info->wait & UMH_WAIT_PROC) {
187 call_usermodehelper_exec_sync(sub_info);
188 } else {
189 pid_t pid;
190 /*
191 * Use CLONE_PARENT to reparent it to kthreadd; we do not
192 * want to pollute current->children, and we need a parent
193 * that always ignores SIGCHLD to ensure auto-reaping.
194 */
195 pid = kernel_thread(call_usermodehelper_exec_async, sub_info,
196 CLONE_PARENT | SIGCHLD);
197 if (pid < 0) {
198 sub_info->retval = pid;
199 umh_complete(sub_info);
200 }
201 }
202}
203
204/*
205 * If set, call_usermodehelper_exec() will exit immediately returning -EBUSY
206 * (used for preventing user land processes from being created after the user
207 * land has been frozen during a system-wide hibernation or suspend operation).
208 * Should always be manipulated under umhelper_sem acquired for write.
209 */
210static enum umh_disable_depth usermodehelper_disabled = UMH_DISABLED;
211
212/* Number of helpers running */
213static atomic_t running_helpers = ATOMIC_INIT(0);
214
215/*
216 * Wait queue head used by usermodehelper_disable() to wait for all running
217 * helpers to finish.
218 */
219static DECLARE_WAIT_QUEUE_HEAD(running_helpers_waitq);
220
221/*
222 * Used by usermodehelper_read_lock_wait() to wait for usermodehelper_disabled
223 * to become 'false'.
224 */
225static DECLARE_WAIT_QUEUE_HEAD(usermodehelper_disabled_waitq);
226
227/*
228 * Time to wait for running_helpers to become zero before the setting of
229 * usermodehelper_disabled in usermodehelper_disable() fails
230 */
231#define RUNNING_HELPERS_TIMEOUT (5 * HZ)
232
233int usermodehelper_read_trylock(void)
234{
235 DEFINE_WAIT(wait);
236 int ret = 0;
237
238 down_read(&umhelper_sem);
239 for (;;) {
240 prepare_to_wait(&usermodehelper_disabled_waitq, &wait,
241 TASK_INTERRUPTIBLE);
242 if (!usermodehelper_disabled)
243 break;
244
245 if (usermodehelper_disabled == UMH_DISABLED)
246 ret = -EAGAIN;
247
248 up_read(&umhelper_sem);
249
250 if (ret)
251 break;
252
253 schedule();
254 try_to_freeze();
255
256 down_read(&umhelper_sem);
257 }
258 finish_wait(&usermodehelper_disabled_waitq, &wait);
259 return ret;
260}
261EXPORT_SYMBOL_GPL(usermodehelper_read_trylock);
262
263long usermodehelper_read_lock_wait(long timeout)
264{
265 DEFINE_WAIT(wait);
266
267 if (timeout < 0)
268 return -EINVAL;
269
270 down_read(&umhelper_sem);
271 for (;;) {
272 prepare_to_wait(&usermodehelper_disabled_waitq, &wait,
273 TASK_UNINTERRUPTIBLE);
274 if (!usermodehelper_disabled)
275 break;
276
277 up_read(&umhelper_sem);
278
279 timeout = schedule_timeout(timeout);
280 if (!timeout)
281 break;
282
283 down_read(&umhelper_sem);
284 }
285 finish_wait(&usermodehelper_disabled_waitq, &wait);
286 return timeout;
287}
288EXPORT_SYMBOL_GPL(usermodehelper_read_lock_wait);
289
290void usermodehelper_read_unlock(void)
291{
292 up_read(&umhelper_sem);
293}
294EXPORT_SYMBOL_GPL(usermodehelper_read_unlock);
295
296/**
297 * __usermodehelper_set_disable_depth - Modify usermodehelper_disabled.
298 * @depth: New value to assign to usermodehelper_disabled.
299 *
300 * Change the value of usermodehelper_disabled (under umhelper_sem locked for
301 * writing) and wakeup tasks waiting for it to change.
302 */
303void __usermodehelper_set_disable_depth(enum umh_disable_depth depth)
304{
305 down_write(&umhelper_sem);
306 usermodehelper_disabled = depth;
307 wake_up(&usermodehelper_disabled_waitq);
308 up_write(&umhelper_sem);
309}
310
311/**
312 * __usermodehelper_disable - Prevent new helpers from being started.
313 * @depth: New value to assign to usermodehelper_disabled.
314 *
315 * Set usermodehelper_disabled to @depth and wait for running helpers to exit.
316 */
317int __usermodehelper_disable(enum umh_disable_depth depth)
318{
319 long retval;
320
321 if (!depth)
322 return -EINVAL;
323
324 down_write(&umhelper_sem);
325 usermodehelper_disabled = depth;
326 up_write(&umhelper_sem);
327
328 /*
329 * From now on call_usermodehelper_exec() won't start any new
330 * helpers, so it is sufficient if running_helpers turns out to
331 * be zero at one point (it may be increased later, but that
332 * doesn't matter).
333 */
334 retval = wait_event_timeout(running_helpers_waitq,
335 atomic_read(&running_helpers) == 0,
336 RUNNING_HELPERS_TIMEOUT);
337 if (retval)
338 return 0;
339
340 __usermodehelper_set_disable_depth(UMH_ENABLED);
341 return -EAGAIN;
342}
343
344static void helper_lock(void)
345{
346 atomic_inc(&running_helpers);
347 smp_mb__after_atomic();
348}
349
350static void helper_unlock(void)
351{
352 if (atomic_dec_and_test(&running_helpers))
353 wake_up(&running_helpers_waitq);
354}
355
356/**
357 * call_usermodehelper_setup - prepare to call a usermode helper
358 * @path: path to usermode executable
359 * @argv: arg vector for process
360 * @envp: environment for process
361 * @gfp_mask: gfp mask for memory allocation
362 * @cleanup: a cleanup function
363 * @init: an init function
364 * @data: arbitrary context sensitive data
365 *
366 * Returns either %NULL on allocation failure, or a subprocess_info
367 * structure. This should be passed to call_usermodehelper_exec to
368 * exec the process and free the structure.
369 *
370 * The init function is used to customize the helper process prior to
371 * exec. A non-zero return code causes the process to error out, exit,
372 * and return the failure to the calling process
373 *
374 * The cleanup function is just before ethe subprocess_info is about to
375 * be freed. This can be used for freeing the argv and envp. The
376 * Function must be runnable in either a process context or the
377 * context in which call_usermodehelper_exec is called.
378 */
379struct subprocess_info *call_usermodehelper_setup(const char *path, char **argv,
380 char **envp, gfp_t gfp_mask,
381 int (*init)(struct subprocess_info *info, struct cred *new),
382 void (*cleanup)(struct subprocess_info *info),
383 void *data)
384{
385 struct subprocess_info *sub_info;
386 sub_info = kzalloc(sizeof(struct subprocess_info), gfp_mask);
387 if (!sub_info)
388 goto out;
389
390 INIT_WORK(&sub_info->work, call_usermodehelper_exec_work);
391
392#ifdef CONFIG_STATIC_USERMODEHELPER
393 sub_info->path = CONFIG_STATIC_USERMODEHELPER_PATH;
394#else
395 sub_info->path = path;
396#endif
397 sub_info->argv = argv;
398 sub_info->envp = envp;
399
400 sub_info->cleanup = cleanup;
401 sub_info->init = init;
402 sub_info->data = data;
403 out:
404 return sub_info;
405}
406EXPORT_SYMBOL(call_usermodehelper_setup);
407
408struct subprocess_info *call_usermodehelper_setup_file(struct file *file,
409 int (*init)(struct subprocess_info *info, struct cred *new),
410 void (*cleanup)(struct subprocess_info *info), void *data)
411{
412 struct subprocess_info *sub_info;
413 struct umh_info *info = data;
414 const char *cmdline = (info->cmdline) ? info->cmdline : "usermodehelper";
415
416 sub_info = kzalloc(sizeof(struct subprocess_info), GFP_KERNEL);
417 if (!sub_info)
418 return NULL;
419
420 sub_info->argv = argv_split(GFP_KERNEL, cmdline, NULL);
421 if (!sub_info->argv) {
422 kfree(sub_info);
423 return NULL;
424 }
425
426 INIT_WORK(&sub_info->work, call_usermodehelper_exec_work);
427 sub_info->path = "none";
428 sub_info->file = file;
429 sub_info->init = init;
430 sub_info->cleanup = cleanup;
431 sub_info->data = data;
432 return sub_info;
433}
434
435static int umh_pipe_setup(struct subprocess_info *info, struct cred *new)
436{
437 struct umh_info *umh_info = info->data;
438 struct file *from_umh[2];
439 struct file *to_umh[2];
440 int err;
441
442 /* create pipe to send data to umh */
443 err = create_pipe_files(to_umh, 0);
444 if (err)
445 return err;
446 err = replace_fd(0, to_umh[0], 0);
447 fput(to_umh[0]);
448 if (err < 0) {
449 fput(to_umh[1]);
450 return err;
451 }
452
453 /* create pipe to receive data from umh */
454 err = create_pipe_files(from_umh, 0);
455 if (err) {
456 fput(to_umh[1]);
457 replace_fd(0, NULL, 0);
458 return err;
459 }
460 err = replace_fd(1, from_umh[1], 0);
461 fput(from_umh[1]);
462 if (err < 0) {
463 fput(to_umh[1]);
464 replace_fd(0, NULL, 0);
465 fput(from_umh[0]);
466 return err;
467 }
468
469 umh_info->pipe_to_umh = to_umh[1];
470 umh_info->pipe_from_umh = from_umh[0];
471 return 0;
472}
473
474static void umh_clean_and_save_pid(struct subprocess_info *info)
475{
476 struct umh_info *umh_info = info->data;
477
478 argv_free(info->argv);
479 umh_info->pid = info->pid;
480}
481
482/**
483 * fork_usermode_blob - fork a blob of bytes as a usermode process
484 * @data: a blob of bytes that can be do_execv-ed as a file
485 * @len: length of the blob
486 * @info: information about usermode process (shouldn't be NULL)
487 *
488 * If info->cmdline is set it will be used as command line for the
489 * user process, else "usermodehelper" is used.
490 *
491 * Returns either negative error or zero which indicates success
492 * in executing a blob of bytes as a usermode process. In such
493 * case 'struct umh_info *info' is populated with two pipes
494 * and a pid of the process. The caller is responsible for health
495 * check of the user process, killing it via pid, and closing the
496 * pipes when user process is no longer needed.
497 */
498int fork_usermode_blob(void *data, size_t len, struct umh_info *info)
499{
500 struct subprocess_info *sub_info;
501 struct file *file;
502 ssize_t written;
503 loff_t pos = 0;
504 int err;
505
506 file = shmem_kernel_file_setup("", len, 0);
507 if (IS_ERR(file))
508 return PTR_ERR(file);
509
510 written = kernel_write(file, data, len, &pos);
511 if (written != len) {
512 err = written;
513 if (err >= 0)
514 err = -ENOMEM;
515 goto out;
516 }
517
518 err = -ENOMEM;
519 sub_info = call_usermodehelper_setup_file(file, umh_pipe_setup,
520 umh_clean_and_save_pid, info);
521 if (!sub_info)
522 goto out;
523
524 err = call_usermodehelper_exec(sub_info, UMH_WAIT_EXEC);
525 if (!err) {
526 mutex_lock(&umh_list_lock);
527 list_add(&info->list, &umh_list);
528 mutex_unlock(&umh_list_lock);
529 }
530out:
531 fput(file);
532 return err;
533}
534EXPORT_SYMBOL_GPL(fork_usermode_blob);
535
536/**
537 * call_usermodehelper_exec - start a usermode application
538 * @sub_info: information about the subprocessa
539 * @wait: wait for the application to finish and return status.
540 * when UMH_NO_WAIT don't wait at all, but you get no useful error back
541 * when the program couldn't be exec'ed. This makes it safe to call
542 * from interrupt context.
543 *
544 * Runs a user-space application. The application is started
545 * asynchronously if wait is not set, and runs as a child of system workqueues.
546 * (ie. it runs with full root capabilities and optimized affinity).
547 */
548int call_usermodehelper_exec(struct subprocess_info *sub_info, int wait)
549{
550 DECLARE_COMPLETION_ONSTACK(done);
551 int retval = 0;
552
553 if (!sub_info->path) {
554 call_usermodehelper_freeinfo(sub_info);
555 return -EINVAL;
556 }
557 helper_lock();
558 if (usermodehelper_disabled) {
559 retval = -EBUSY;
560 goto out;
561 }
562
563 /*
564 * If there is no binary for us to call, then just return and get out of
565 * here. This allows us to set STATIC_USERMODEHELPER_PATH to "" and
566 * disable all call_usermodehelper() calls.
567 */
568 if (strlen(sub_info->path) == 0)
569 goto out;
570
571 /*
572 * Set the completion pointer only if there is a waiter.
573 * This makes it possible to use umh_complete to free
574 * the data structure in case of UMH_NO_WAIT.
575 */
576 sub_info->complete = (wait == UMH_NO_WAIT) ? NULL : &done;
577 sub_info->wait = wait;
578
579 queue_work(system_unbound_wq, &sub_info->work);
580 if (wait == UMH_NO_WAIT) /* task has freed sub_info */
581 goto unlock;
582
583 if (wait & UMH_KILLABLE) {
584 retval = wait_for_completion_killable(&done);
585 if (!retval)
586 goto wait_done;
587
588 /* umh_complete() will see NULL and free sub_info */
589 if (xchg(&sub_info->complete, NULL))
590 goto unlock;
591 /* fallthrough, umh_complete() was already called */
592 }
593
594 wait_for_completion(&done);
595wait_done:
596 retval = sub_info->retval;
597out:
598 call_usermodehelper_freeinfo(sub_info);
599unlock:
600 helper_unlock();
601 return retval;
602}
603EXPORT_SYMBOL(call_usermodehelper_exec);
604
605/**
606 * call_usermodehelper() - prepare and start a usermode application
607 * @path: path to usermode executable
608 * @argv: arg vector for process
609 * @envp: environment for process
610 * @wait: wait for the application to finish and return status.
611 * when UMH_NO_WAIT don't wait at all, but you get no useful error back
612 * when the program couldn't be exec'ed. This makes it safe to call
613 * from interrupt context.
614 *
615 * This function is the equivalent to use call_usermodehelper_setup() and
616 * call_usermodehelper_exec().
617 */
618int call_usermodehelper(const char *path, char **argv, char **envp, int wait)
619{
620 struct subprocess_info *info;
621 gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL;
622
623 info = call_usermodehelper_setup(path, argv, envp, gfp_mask,
624 NULL, NULL, NULL);
625 if (info == NULL)
626 return -ENOMEM;
627
628 return call_usermodehelper_exec(info, wait);
629}
630EXPORT_SYMBOL(call_usermodehelper);
631
632static int proc_cap_handler(struct ctl_table *table, int write,
633 void __user *buffer, size_t *lenp, loff_t *ppos)
634{
635 struct ctl_table t;
636 unsigned long cap_array[_KERNEL_CAPABILITY_U32S];
637 kernel_cap_t new_cap;
638 int err, i;
639
640 if (write && (!capable(CAP_SETPCAP) ||
641 !capable(CAP_SYS_MODULE)))
642 return -EPERM;
643
644 /*
645 * convert from the global kernel_cap_t to the ulong array to print to
646 * userspace if this is a read.
647 */
648 spin_lock(&umh_sysctl_lock);
649 for (i = 0; i < _KERNEL_CAPABILITY_U32S; i++) {
650 if (table->data == CAP_BSET)
651 cap_array[i] = usermodehelper_bset.cap[i];
652 else if (table->data == CAP_PI)
653 cap_array[i] = usermodehelper_inheritable.cap[i];
654 else
655 BUG();
656 }
657 spin_unlock(&umh_sysctl_lock);
658
659 t = *table;
660 t.data = &cap_array;
661
662 /*
663 * actually read or write and array of ulongs from userspace. Remember
664 * these are least significant 32 bits first
665 */
666 err = proc_doulongvec_minmax(&t, write, buffer, lenp, ppos);
667 if (err < 0)
668 return err;
669
670 /*
671 * convert from the sysctl array of ulongs to the kernel_cap_t
672 * internal representation
673 */
674 for (i = 0; i < _KERNEL_CAPABILITY_U32S; i++)
675 new_cap.cap[i] = cap_array[i];
676
677 /*
678 * Drop everything not in the new_cap (but don't add things)
679 */
680 if (write) {
681 spin_lock(&umh_sysctl_lock);
682 if (table->data == CAP_BSET)
683 usermodehelper_bset = cap_intersect(usermodehelper_bset, new_cap);
684 if (table->data == CAP_PI)
685 usermodehelper_inheritable = cap_intersect(usermodehelper_inheritable, new_cap);
686 spin_unlock(&umh_sysctl_lock);
687 }
688
689 return 0;
690}
691
692void __exit_umh(struct task_struct *tsk)
693{
694 struct umh_info *info;
695 pid_t pid = tsk->pid;
696
697 mutex_lock(&umh_list_lock);
698 list_for_each_entry(info, &umh_list, list) {
699 if (info->pid == pid) {
700 list_del(&info->list);
701 mutex_unlock(&umh_list_lock);
702 goto out;
703 }
704 }
705 mutex_unlock(&umh_list_lock);
706 return;
707out:
708 if (info->cleanup)
709 info->cleanup(info);
710}
711
712struct ctl_table usermodehelper_table[] = {
713 {
714 .procname = "bset",
715 .data = CAP_BSET,
716 .maxlen = _KERNEL_CAPABILITY_U32S * sizeof(unsigned long),
717 .mode = 0600,
718 .proc_handler = proc_cap_handler,
719 },
720 {
721 .procname = "inheritable",
722 .data = CAP_PI,
723 .maxlen = _KERNEL_CAPABILITY_U32S * sizeof(unsigned long),
724 .mode = 0600,
725 .proc_handler = proc_cap_handler,
726 },
727 { }
728};
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * umh - the kernel usermode helper
4 */
5#include <linux/module.h>
6#include <linux/sched.h>
7#include <linux/sched/task.h>
8#include <linux/binfmts.h>
9#include <linux/syscalls.h>
10#include <linux/unistd.h>
11#include <linux/kmod.h>
12#include <linux/slab.h>
13#include <linux/completion.h>
14#include <linux/cred.h>
15#include <linux/file.h>
16#include <linux/fdtable.h>
17#include <linux/fs_struct.h>
18#include <linux/workqueue.h>
19#include <linux/security.h>
20#include <linux/mount.h>
21#include <linux/kernel.h>
22#include <linux/init.h>
23#include <linux/resource.h>
24#include <linux/notifier.h>
25#include <linux/suspend.h>
26#include <linux/rwsem.h>
27#include <linux/ptrace.h>
28#include <linux/async.h>
29#include <linux/uaccess.h>
30#include <linux/initrd.h>
31#include <linux/freezer.h>
32
33#include <trace/events/module.h>
34
35static kernel_cap_t usermodehelper_bset = CAP_FULL_SET;
36static kernel_cap_t usermodehelper_inheritable = CAP_FULL_SET;
37static DEFINE_SPINLOCK(umh_sysctl_lock);
38static DECLARE_RWSEM(umhelper_sem);
39
40static void call_usermodehelper_freeinfo(struct subprocess_info *info)
41{
42 if (info->cleanup)
43 (*info->cleanup)(info);
44 kfree(info);
45}
46
47static void umh_complete(struct subprocess_info *sub_info)
48{
49 struct completion *comp = xchg(&sub_info->complete, NULL);
50 /*
51 * See call_usermodehelper_exec(). If xchg() returns NULL
52 * we own sub_info, the UMH_KILLABLE caller has gone away
53 * or the caller used UMH_NO_WAIT.
54 */
55 if (comp)
56 complete(comp);
57 else
58 call_usermodehelper_freeinfo(sub_info);
59}
60
61/*
62 * This is the task which runs the usermode application
63 */
64static int call_usermodehelper_exec_async(void *data)
65{
66 struct subprocess_info *sub_info = data;
67 struct cred *new;
68 int retval;
69
70 spin_lock_irq(¤t->sighand->siglock);
71 flush_signal_handlers(current, 1);
72 spin_unlock_irq(¤t->sighand->siglock);
73
74 /*
75 * Initial kernel threads share ther FS with init, in order to
76 * get the init root directory. But we've now created a new
77 * thread that is going to execve a user process and has its own
78 * 'struct fs_struct'. Reset umask to the default.
79 */
80 current->fs->umask = 0022;
81
82 /*
83 * Our parent (unbound workqueue) runs with elevated scheduling
84 * priority. Avoid propagating that into the userspace child.
85 */
86 set_user_nice(current, 0);
87
88 retval = -ENOMEM;
89 new = prepare_kernel_cred(current);
90 if (!new)
91 goto out;
92
93 spin_lock(&umh_sysctl_lock);
94 new->cap_bset = cap_intersect(usermodehelper_bset, new->cap_bset);
95 new->cap_inheritable = cap_intersect(usermodehelper_inheritable,
96 new->cap_inheritable);
97 spin_unlock(&umh_sysctl_lock);
98
99 if (sub_info->init) {
100 retval = sub_info->init(sub_info, new);
101 if (retval) {
102 abort_creds(new);
103 goto out;
104 }
105 }
106
107 commit_creds(new);
108
109 wait_for_initramfs();
110 retval = kernel_execve(sub_info->path,
111 (const char *const *)sub_info->argv,
112 (const char *const *)sub_info->envp);
113out:
114 sub_info->retval = retval;
115 /*
116 * call_usermodehelper_exec_sync() will call umh_complete
117 * if UHM_WAIT_PROC.
118 */
119 if (!(sub_info->wait & UMH_WAIT_PROC))
120 umh_complete(sub_info);
121 if (!retval)
122 return 0;
123 do_exit(0);
124}
125
126/* Handles UMH_WAIT_PROC. */
127static void call_usermodehelper_exec_sync(struct subprocess_info *sub_info)
128{
129 pid_t pid;
130
131 /* If SIGCLD is ignored do_wait won't populate the status. */
132 kernel_sigaction(SIGCHLD, SIG_DFL);
133 pid = user_mode_thread(call_usermodehelper_exec_async, sub_info, SIGCHLD);
134 if (pid < 0)
135 sub_info->retval = pid;
136 else
137 kernel_wait(pid, &sub_info->retval);
138
139 /* Restore default kernel sig handler */
140 kernel_sigaction(SIGCHLD, SIG_IGN);
141 umh_complete(sub_info);
142}
143
144/*
145 * We need to create the usermodehelper kernel thread from a task that is affine
146 * to an optimized set of CPUs (or nohz housekeeping ones) such that they
147 * inherit a widest affinity irrespective of call_usermodehelper() callers with
148 * possibly reduced affinity (eg: per-cpu workqueues). We don't want
149 * usermodehelper targets to contend a busy CPU.
150 *
151 * Unbound workqueues provide such wide affinity and allow to block on
152 * UMH_WAIT_PROC requests without blocking pending request (up to some limit).
153 *
154 * Besides, workqueues provide the privilege level that caller might not have
155 * to perform the usermodehelper request.
156 *
157 */
158static void call_usermodehelper_exec_work(struct work_struct *work)
159{
160 struct subprocess_info *sub_info =
161 container_of(work, struct subprocess_info, work);
162
163 if (sub_info->wait & UMH_WAIT_PROC) {
164 call_usermodehelper_exec_sync(sub_info);
165 } else {
166 pid_t pid;
167 /*
168 * Use CLONE_PARENT to reparent it to kthreadd; we do not
169 * want to pollute current->children, and we need a parent
170 * that always ignores SIGCHLD to ensure auto-reaping.
171 */
172 pid = user_mode_thread(call_usermodehelper_exec_async, sub_info,
173 CLONE_PARENT | SIGCHLD);
174 if (pid < 0) {
175 sub_info->retval = pid;
176 umh_complete(sub_info);
177 }
178 }
179}
180
181/*
182 * If set, call_usermodehelper_exec() will exit immediately returning -EBUSY
183 * (used for preventing user land processes from being created after the user
184 * land has been frozen during a system-wide hibernation or suspend operation).
185 * Should always be manipulated under umhelper_sem acquired for write.
186 */
187static enum umh_disable_depth usermodehelper_disabled = UMH_DISABLED;
188
189/* Number of helpers running */
190static atomic_t running_helpers = ATOMIC_INIT(0);
191
192/*
193 * Wait queue head used by usermodehelper_disable() to wait for all running
194 * helpers to finish.
195 */
196static DECLARE_WAIT_QUEUE_HEAD(running_helpers_waitq);
197
198/*
199 * Used by usermodehelper_read_lock_wait() to wait for usermodehelper_disabled
200 * to become 'false'.
201 */
202static DECLARE_WAIT_QUEUE_HEAD(usermodehelper_disabled_waitq);
203
204/*
205 * Time to wait for running_helpers to become zero before the setting of
206 * usermodehelper_disabled in usermodehelper_disable() fails
207 */
208#define RUNNING_HELPERS_TIMEOUT (5 * HZ)
209
210int usermodehelper_read_trylock(void)
211{
212 DEFINE_WAIT(wait);
213 int ret = 0;
214
215 down_read(&umhelper_sem);
216 for (;;) {
217 prepare_to_wait(&usermodehelper_disabled_waitq, &wait,
218 TASK_INTERRUPTIBLE);
219 if (!usermodehelper_disabled)
220 break;
221
222 if (usermodehelper_disabled == UMH_DISABLED)
223 ret = -EAGAIN;
224
225 up_read(&umhelper_sem);
226
227 if (ret)
228 break;
229
230 schedule();
231 try_to_freeze();
232
233 down_read(&umhelper_sem);
234 }
235 finish_wait(&usermodehelper_disabled_waitq, &wait);
236 return ret;
237}
238EXPORT_SYMBOL_GPL(usermodehelper_read_trylock);
239
240long usermodehelper_read_lock_wait(long timeout)
241{
242 DEFINE_WAIT(wait);
243
244 if (timeout < 0)
245 return -EINVAL;
246
247 down_read(&umhelper_sem);
248 for (;;) {
249 prepare_to_wait(&usermodehelper_disabled_waitq, &wait,
250 TASK_UNINTERRUPTIBLE);
251 if (!usermodehelper_disabled)
252 break;
253
254 up_read(&umhelper_sem);
255
256 timeout = schedule_timeout(timeout);
257 if (!timeout)
258 break;
259
260 down_read(&umhelper_sem);
261 }
262 finish_wait(&usermodehelper_disabled_waitq, &wait);
263 return timeout;
264}
265EXPORT_SYMBOL_GPL(usermodehelper_read_lock_wait);
266
267void usermodehelper_read_unlock(void)
268{
269 up_read(&umhelper_sem);
270}
271EXPORT_SYMBOL_GPL(usermodehelper_read_unlock);
272
273/**
274 * __usermodehelper_set_disable_depth - Modify usermodehelper_disabled.
275 * @depth: New value to assign to usermodehelper_disabled.
276 *
277 * Change the value of usermodehelper_disabled (under umhelper_sem locked for
278 * writing) and wakeup tasks waiting for it to change.
279 */
280void __usermodehelper_set_disable_depth(enum umh_disable_depth depth)
281{
282 down_write(&umhelper_sem);
283 usermodehelper_disabled = depth;
284 wake_up(&usermodehelper_disabled_waitq);
285 up_write(&umhelper_sem);
286}
287
288/**
289 * __usermodehelper_disable - Prevent new helpers from being started.
290 * @depth: New value to assign to usermodehelper_disabled.
291 *
292 * Set usermodehelper_disabled to @depth and wait for running helpers to exit.
293 */
294int __usermodehelper_disable(enum umh_disable_depth depth)
295{
296 long retval;
297
298 if (!depth)
299 return -EINVAL;
300
301 down_write(&umhelper_sem);
302 usermodehelper_disabled = depth;
303 up_write(&umhelper_sem);
304
305 /*
306 * From now on call_usermodehelper_exec() won't start any new
307 * helpers, so it is sufficient if running_helpers turns out to
308 * be zero at one point (it may be increased later, but that
309 * doesn't matter).
310 */
311 retval = wait_event_timeout(running_helpers_waitq,
312 atomic_read(&running_helpers) == 0,
313 RUNNING_HELPERS_TIMEOUT);
314 if (retval)
315 return 0;
316
317 __usermodehelper_set_disable_depth(UMH_ENABLED);
318 return -EAGAIN;
319}
320
321static void helper_lock(void)
322{
323 atomic_inc(&running_helpers);
324 smp_mb__after_atomic();
325}
326
327static void helper_unlock(void)
328{
329 if (atomic_dec_and_test(&running_helpers))
330 wake_up(&running_helpers_waitq);
331}
332
333/**
334 * call_usermodehelper_setup - prepare to call a usermode helper
335 * @path: path to usermode executable
336 * @argv: arg vector for process
337 * @envp: environment for process
338 * @gfp_mask: gfp mask for memory allocation
339 * @init: an init function
340 * @cleanup: a cleanup function
341 * @data: arbitrary context sensitive data
342 *
343 * Returns either %NULL on allocation failure, or a subprocess_info
344 * structure. This should be passed to call_usermodehelper_exec to
345 * exec the process and free the structure.
346 *
347 * The init function is used to customize the helper process prior to
348 * exec. A non-zero return code causes the process to error out, exit,
349 * and return the failure to the calling process
350 *
351 * The cleanup function is just before the subprocess_info is about to
352 * be freed. This can be used for freeing the argv and envp. The
353 * Function must be runnable in either a process context or the
354 * context in which call_usermodehelper_exec is called.
355 */
356struct subprocess_info *call_usermodehelper_setup(const char *path, char **argv,
357 char **envp, gfp_t gfp_mask,
358 int (*init)(struct subprocess_info *info, struct cred *new),
359 void (*cleanup)(struct subprocess_info *info),
360 void *data)
361{
362 struct subprocess_info *sub_info;
363 sub_info = kzalloc(sizeof(struct subprocess_info), gfp_mask);
364 if (!sub_info)
365 goto out;
366
367 INIT_WORK(&sub_info->work, call_usermodehelper_exec_work);
368
369#ifdef CONFIG_STATIC_USERMODEHELPER
370 sub_info->path = CONFIG_STATIC_USERMODEHELPER_PATH;
371#else
372 sub_info->path = path;
373#endif
374 sub_info->argv = argv;
375 sub_info->envp = envp;
376
377 sub_info->cleanup = cleanup;
378 sub_info->init = init;
379 sub_info->data = data;
380 out:
381 return sub_info;
382}
383EXPORT_SYMBOL(call_usermodehelper_setup);
384
385/**
386 * call_usermodehelper_exec - start a usermode application
387 * @sub_info: information about the subprocess
388 * @wait: wait for the application to finish and return status.
389 * when UMH_NO_WAIT don't wait at all, but you get no useful error back
390 * when the program couldn't be exec'ed. This makes it safe to call
391 * from interrupt context.
392 *
393 * Runs a user-space application. The application is started
394 * asynchronously if wait is not set, and runs as a child of system workqueues.
395 * (ie. it runs with full root capabilities and optimized affinity).
396 *
397 * Note: successful return value does not guarantee the helper was called at
398 * all. You can't rely on sub_info->{init,cleanup} being called even for
399 * UMH_WAIT_* wait modes as STATIC_USERMODEHELPER_PATH="" turns all helpers
400 * into a successful no-op.
401 */
402int call_usermodehelper_exec(struct subprocess_info *sub_info, int wait)
403{
404 unsigned int state = TASK_UNINTERRUPTIBLE;
405 DECLARE_COMPLETION_ONSTACK(done);
406 int retval = 0;
407
408 if (!sub_info->path) {
409 call_usermodehelper_freeinfo(sub_info);
410 return -EINVAL;
411 }
412 helper_lock();
413 if (usermodehelper_disabled) {
414 retval = -EBUSY;
415 goto out;
416 }
417
418 /*
419 * If there is no binary for us to call, then just return and get out of
420 * here. This allows us to set STATIC_USERMODEHELPER_PATH to "" and
421 * disable all call_usermodehelper() calls.
422 */
423 if (strlen(sub_info->path) == 0)
424 goto out;
425
426 /*
427 * Set the completion pointer only if there is a waiter.
428 * This makes it possible to use umh_complete to free
429 * the data structure in case of UMH_NO_WAIT.
430 */
431 sub_info->complete = (wait == UMH_NO_WAIT) ? NULL : &done;
432 sub_info->wait = wait;
433
434 queue_work(system_unbound_wq, &sub_info->work);
435 if (wait == UMH_NO_WAIT) /* task has freed sub_info */
436 goto unlock;
437
438 if (wait & UMH_FREEZABLE)
439 state |= TASK_FREEZABLE;
440
441 if (wait & UMH_KILLABLE) {
442 retval = wait_for_completion_state(&done, state | TASK_KILLABLE);
443 if (!retval)
444 goto wait_done;
445
446 /* umh_complete() will see NULL and free sub_info */
447 if (xchg(&sub_info->complete, NULL))
448 goto unlock;
449
450 /*
451 * fallthrough; in case of -ERESTARTSYS now do uninterruptible
452 * wait_for_completion_state(). Since umh_complete() shall call
453 * complete() in a moment if xchg() above returned NULL, this
454 * uninterruptible wait_for_completion_state() will not block
455 * SIGKILL'ed processes for long.
456 */
457 }
458 wait_for_completion_state(&done, state);
459
460wait_done:
461 retval = sub_info->retval;
462out:
463 call_usermodehelper_freeinfo(sub_info);
464unlock:
465 helper_unlock();
466 return retval;
467}
468EXPORT_SYMBOL(call_usermodehelper_exec);
469
470/**
471 * call_usermodehelper() - prepare and start a usermode application
472 * @path: path to usermode executable
473 * @argv: arg vector for process
474 * @envp: environment for process
475 * @wait: wait for the application to finish and return status.
476 * when UMH_NO_WAIT don't wait at all, but you get no useful error back
477 * when the program couldn't be exec'ed. This makes it safe to call
478 * from interrupt context.
479 *
480 * This function is the equivalent to use call_usermodehelper_setup() and
481 * call_usermodehelper_exec().
482 */
483int call_usermodehelper(const char *path, char **argv, char **envp, int wait)
484{
485 struct subprocess_info *info;
486 gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL;
487
488 info = call_usermodehelper_setup(path, argv, envp, gfp_mask,
489 NULL, NULL, NULL);
490 if (info == NULL)
491 return -ENOMEM;
492
493 return call_usermodehelper_exec(info, wait);
494}
495EXPORT_SYMBOL(call_usermodehelper);
496
497#if defined(CONFIG_SYSCTL)
498static int proc_cap_handler(struct ctl_table *table, int write,
499 void *buffer, size_t *lenp, loff_t *ppos)
500{
501 struct ctl_table t;
502 unsigned long cap_array[2];
503 kernel_cap_t new_cap, *cap;
504 int err;
505
506 if (write && (!capable(CAP_SETPCAP) ||
507 !capable(CAP_SYS_MODULE)))
508 return -EPERM;
509
510 /*
511 * convert from the global kernel_cap_t to the ulong array to print to
512 * userspace if this is a read.
513 *
514 * Legacy format: capabilities are exposed as two 32-bit values
515 */
516 cap = table->data;
517 spin_lock(&umh_sysctl_lock);
518 cap_array[0] = (u32) cap->val;
519 cap_array[1] = cap->val >> 32;
520 spin_unlock(&umh_sysctl_lock);
521
522 t = *table;
523 t.data = &cap_array;
524
525 /*
526 * actually read or write and array of ulongs from userspace. Remember
527 * these are least significant 32 bits first
528 */
529 err = proc_doulongvec_minmax(&t, write, buffer, lenp, ppos);
530 if (err < 0)
531 return err;
532
533 new_cap.val = (u32)cap_array[0];
534 new_cap.val += (u64)cap_array[1] << 32;
535
536 /*
537 * Drop everything not in the new_cap (but don't add things)
538 */
539 if (write) {
540 spin_lock(&umh_sysctl_lock);
541 *cap = cap_intersect(*cap, new_cap);
542 spin_unlock(&umh_sysctl_lock);
543 }
544
545 return 0;
546}
547
548static struct ctl_table usermodehelper_table[] = {
549 {
550 .procname = "bset",
551 .data = &usermodehelper_bset,
552 .maxlen = 2 * sizeof(unsigned long),
553 .mode = 0600,
554 .proc_handler = proc_cap_handler,
555 },
556 {
557 .procname = "inheritable",
558 .data = &usermodehelper_inheritable,
559 .maxlen = 2 * sizeof(unsigned long),
560 .mode = 0600,
561 .proc_handler = proc_cap_handler,
562 },
563 { }
564};
565
566static int __init init_umh_sysctls(void)
567{
568 register_sysctl_init("kernel/usermodehelper", usermodehelper_table);
569 return 0;
570}
571early_initcall(init_umh_sysctls);
572#endif /* CONFIG_SYSCTL */