1 // SPDX-License-Identifier: GPL-2.0
3 * kernel userspace event delivery
5 * Copyright (C) 2004 Red Hat, Inc. All rights reserved.
6 * Copyright (C) 2004 Novell, Inc. All rights reserved.
7 * Copyright (C) 2004 IBM, Inc. All rights reserved.
10 * Robert Love <rml@novell.com>
11 * Kay Sievers <kay.sievers@vrfy.org>
12 * Arjan van de Ven <arjanv@redhat.com>
13 * Greg Kroah-Hartman <greg@kroah.com>
16 #include <linux/spinlock.h>
17 #include <linux/string.h>
18 #include <linux/kobject.h>
19 #include <linux/export.h>
20 #include <linux/kmod.h>
21 #include <linux/slab.h>
22 #include <linux/socket.h>
23 #include <linux/skbuff.h>
24 #include <linux/netlink.h>
25 #include <linux/uidgid.h>
26 #include <linux/uuid.h>
27 #include <linux/ctype.h>
29 #include <net/netlink.h>
30 #include <net/net_namespace.h>
34 #ifdef CONFIG_UEVENT_HELPER
35 char uevent_helper[UEVENT_HELPER_PATH_LEN] = CONFIG_UEVENT_HELPER_PATH;
39 struct list_head list;
44 static LIST_HEAD(uevent_sock_list);
47 /* This lock protects uevent_seqnum and uevent_sock_list */
48 static DEFINE_MUTEX(uevent_sock_mutex);
50 /* the strings here must match the enum in include/linux/kobject.h */
51 static const char *kobject_actions[] = {
53 [KOBJ_REMOVE] = "remove",
54 [KOBJ_CHANGE] = "change",
56 [KOBJ_ONLINE] = "online",
57 [KOBJ_OFFLINE] = "offline",
59 [KOBJ_UNBIND] = "unbind",
62 static int kobject_action_type(const char *buf, size_t count,
63 enum kobject_action *type,
66 enum kobject_action action;
68 const char *args_start;
71 if (count && (buf[count-1] == '\n' || buf[count-1] == '\0'))
77 args_start = strnchr(buf, count, ' ');
79 count_first = args_start - buf;
80 args_start = args_start + 1;
84 for (action = 0; action < ARRAY_SIZE(kobject_actions); action++) {
85 if (strncmp(kobject_actions[action], buf, count_first) != 0)
87 if (kobject_actions[action][count_first] != '\0')
99 static const char *action_arg_word_end(const char *buf, const char *buf_end,
102 const char *next = buf;
104 while (next <= buf_end && *next != delim)
105 if (!isalnum(*next++))
114 static int kobject_action_args(const char *buf, size_t count,
115 struct kobj_uevent_env **ret_env)
117 struct kobj_uevent_env *env = NULL;
118 const char *next, *buf_end, *key;
122 if (count && (buf[count - 1] == '\n' || buf[count - 1] == '\0'))
128 env = kzalloc(sizeof(*env), GFP_KERNEL);
132 /* first arg is UUID */
133 if (count < UUID_STRING_LEN || !uuid_is_valid(buf) ||
134 add_uevent_var(env, "SYNTH_UUID=%.*s", UUID_STRING_LEN, buf))
138 * the rest are custom environment variables in KEY=VALUE
139 * format with ' ' delimiter between each KEY=VALUE pair
141 next = buf + UUID_STRING_LEN;
142 buf_end = buf + count - 1;
144 while (next <= buf_end) {
148 /* skip the ' ', key must follow */
154 next = action_arg_word_end(buf, buf_end, '=');
155 if (!next || next > buf_end || *next != '=')
157 key_len = next - buf;
159 /* skip the '=', value must follow */
160 if (++next > buf_end)
164 next = action_arg_word_end(buf, buf_end, ' ');
168 if (add_uevent_var(env, "SYNTH_ARG_%.*s=%.*s",
169 key_len, key, (int) (next - buf), buf))
183 * kobject_synth_uevent - send synthetic uevent with arguments
185 * @kobj: struct kobject for which synthetic uevent is to be generated
186 * @buf: buffer containing action type and action args, newline is ignored
187 * @count: length of buffer
189 * Returns 0 if kobject_synthetic_uevent() is completed with success or the
190 * corresponding error when it fails.
192 int kobject_synth_uevent(struct kobject *kobj, const char *buf, size_t count)
194 char *no_uuid_envp[] = { "SYNTH_UUID=0", NULL };
195 enum kobject_action action;
196 const char *action_args;
197 struct kobj_uevent_env *env;
198 const char *msg = NULL, *devpath;
201 r = kobject_action_type(buf, count, &action, &action_args);
203 msg = "unknown uevent action string\n";
208 r = kobject_uevent_env(kobj, action, no_uuid_envp);
212 r = kobject_action_args(action_args,
213 count - (action_args - buf), &env);
215 msg = "incorrect uevent action arguments\n";
222 r = kobject_uevent_env(kobj, action, env->envp);
226 devpath = kobject_get_path(kobj, GFP_KERNEL);
227 printk(KERN_WARNING "synth uevent: %s: %s",
228 devpath ?: "unknown device",
229 msg ?: "failed to send uevent");
235 #ifdef CONFIG_UEVENT_HELPER
236 static int kobj_usermode_filter(struct kobject *kobj)
238 const struct kobj_ns_type_operations *ops;
240 ops = kobj_ns_ops(kobj);
242 const void *init_ns, *ns;
243 ns = kobj->ktype->namespace(kobj);
244 init_ns = ops->initial_ns();
245 return ns != init_ns;
251 static int init_uevent_argv(struct kobj_uevent_env *env, const char *subsystem)
255 len = strlcpy(&env->buf[env->buflen], subsystem,
256 sizeof(env->buf) - env->buflen);
257 if (len >= (sizeof(env->buf) - env->buflen)) {
258 WARN(1, KERN_ERR "init_uevent_argv: buffer size too small\n");
262 env->argv[0] = uevent_helper;
263 env->argv[1] = &env->buf[env->buflen];
266 env->buflen += len + 1;
270 static void cleanup_uevent_env(struct subprocess_info *info)
277 static struct sk_buff *alloc_uevent_skb(struct kobj_uevent_env *env,
278 const char *action_string,
281 struct netlink_skb_parms *parms;
282 struct sk_buff *skb = NULL;
286 /* allocate message with maximum possible size */
287 len = strlen(action_string) + strlen(devpath) + 2;
288 skb = alloc_skb(len + env->buflen, GFP_KERNEL);
293 scratch = skb_put(skb, len);
294 sprintf(scratch, "%s@%s", action_string, devpath);
296 skb_put_data(skb, env->buf, env->buflen);
298 parms = &NETLINK_CB(skb);
299 parms->creds.uid = GLOBAL_ROOT_UID;
300 parms->creds.gid = GLOBAL_ROOT_GID;
301 parms->dst_group = 1;
307 static int uevent_net_broadcast_untagged(struct kobj_uevent_env *env,
308 const char *action_string,
311 struct sk_buff *skb = NULL;
312 struct uevent_sock *ue_sk;
315 /* send netlink message */
316 list_for_each_entry(ue_sk, &uevent_sock_list, list) {
317 struct sock *uevent_sock = ue_sk->sk;
319 if (!netlink_has_listeners(uevent_sock, 1))
324 skb = alloc_uevent_skb(env, action_string, devpath);
329 retval = netlink_broadcast(uevent_sock, skb_get(skb), 0, 1,
331 /* ENOBUFS should be handled in userspace */
332 if (retval == -ENOBUFS || retval == -ESRCH)
340 static int uevent_net_broadcast_tagged(struct sock *usk,
341 struct kobj_uevent_env *env,
342 const char *action_string,
345 struct user_namespace *owning_user_ns = sock_net(usk)->user_ns;
346 struct sk_buff *skb = NULL;
349 skb = alloc_uevent_skb(env, action_string, devpath);
353 /* fix credentials */
354 if (owning_user_ns != &init_user_ns) {
355 struct netlink_skb_parms *parms = &NETLINK_CB(skb);
360 root_uid = make_kuid(owning_user_ns, 0);
361 if (uid_valid(root_uid))
362 parms->creds.uid = root_uid;
365 root_gid = make_kgid(owning_user_ns, 0);
366 if (gid_valid(root_gid))
367 parms->creds.gid = root_gid;
370 ret = netlink_broadcast(usk, skb, 0, 1, GFP_KERNEL);
371 /* ENOBUFS should be handled in userspace */
372 if (ret == -ENOBUFS || ret == -ESRCH)
379 static int kobject_uevent_net_broadcast(struct kobject *kobj,
380 struct kobj_uevent_env *env,
381 const char *action_string,
387 const struct kobj_ns_type_operations *ops;
388 const struct net *net = NULL;
390 ops = kobj_ns_ops(kobj);
391 if (!ops && kobj->kset) {
392 struct kobject *ksobj = &kobj->kset->kobj;
393 if (ksobj->parent != NULL)
394 ops = kobj_ns_ops(ksobj->parent);
397 /* kobjects currently only carry network namespace tags and they
398 * are the only tag relevant here since we want to decide which
399 * network namespaces to broadcast the uevent into.
401 if (ops && ops->netlink_ns && kobj->ktype->namespace)
402 if (ops->type == KOBJ_NS_TYPE_NET)
403 net = kobj->ktype->namespace(kobj);
406 ret = uevent_net_broadcast_untagged(env, action_string,
409 ret = uevent_net_broadcast_tagged(net->uevent_sock->sk, env,
410 action_string, devpath);
416 static void zap_modalias_env(struct kobj_uevent_env *env)
418 static const char modalias_prefix[] = "MODALIAS=";
422 for (i = 0; i < env->envp_idx;) {
423 if (strncmp(env->envp[i], modalias_prefix,
424 sizeof(modalias_prefix) - 1)) {
429 len = strlen(env->envp[i]) + 1;
431 if (i != env->envp_idx - 1) {
432 memmove(env->envp[i], env->envp[i + 1],
435 for (j = i; j < env->envp_idx - 1; j++)
436 env->envp[j] = env->envp[j + 1] - len;
445 * kobject_uevent_env - send an uevent with environmental data
447 * @kobj: struct kobject that the action is happening to
448 * @action: action that is happening
449 * @envp_ext: pointer to environmental data
451 * Returns 0 if kobject_uevent_env() is completed with success or the
452 * corresponding error when it fails.
454 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
457 struct kobj_uevent_env *env;
458 const char *action_string = kobject_actions[action];
459 const char *devpath = NULL;
460 const char *subsystem;
461 struct kobject *top_kobj;
463 const struct kset_uevent_ops *uevent_ops;
467 pr_debug("kobject: '%s' (%p): %s\n",
468 kobject_name(kobj), kobj, __func__);
470 /* search the kset we belong to */
472 while (!top_kobj->kset && top_kobj->parent)
473 top_kobj = top_kobj->parent;
475 if (!top_kobj->kset) {
476 pr_debug("kobject: '%s' (%p): %s: attempted to send uevent "
477 "without kset!\n", kobject_name(kobj), kobj,
482 kset = top_kobj->kset;
483 uevent_ops = kset->uevent_ops;
485 /* skip the event, if uevent_suppress is set*/
486 if (kobj->uevent_suppress) {
487 pr_debug("kobject: '%s' (%p): %s: uevent_suppress "
488 "caused the event to drop!\n",
489 kobject_name(kobj), kobj, __func__);
492 /* skip the event, if the filter returns zero. */
493 if (uevent_ops && uevent_ops->filter)
494 if (!uevent_ops->filter(kset, kobj)) {
495 pr_debug("kobject: '%s' (%p): %s: filter function "
496 "caused the event to drop!\n",
497 kobject_name(kobj), kobj, __func__);
501 /* originating subsystem */
502 if (uevent_ops && uevent_ops->name)
503 subsystem = uevent_ops->name(kset, kobj);
505 subsystem = kobject_name(&kset->kobj);
507 pr_debug("kobject: '%s' (%p): %s: unset subsystem caused the "
508 "event to drop!\n", kobject_name(kobj), kobj,
513 /* environment buffer */
514 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
518 /* complete object path */
519 devpath = kobject_get_path(kobj, GFP_KERNEL);
526 retval = add_uevent_var(env, "ACTION=%s", action_string);
529 retval = add_uevent_var(env, "DEVPATH=%s", devpath);
532 retval = add_uevent_var(env, "SUBSYSTEM=%s", subsystem);
536 /* keys passed in from the caller */
538 for (i = 0; envp_ext[i]; i++) {
539 retval = add_uevent_var(env, "%s", envp_ext[i]);
545 /* let the kset specific function add its stuff */
546 if (uevent_ops && uevent_ops->uevent) {
547 retval = uevent_ops->uevent(kset, kobj, env);
549 pr_debug("kobject: '%s' (%p): %s: uevent() returned "
550 "%d\n", kobject_name(kobj), kobj,
559 * Mark "add" event so we can make sure we deliver "remove"
560 * event to userspace during automatic cleanup. If
561 * the object did send an "add" event, "remove" will
562 * automatically generated by the core, if not already done
565 kobj->state_add_uevent_sent = 1;
569 kobj->state_remove_uevent_sent = 1;
573 zap_modalias_env(env);
580 mutex_lock(&uevent_sock_mutex);
581 /* we will send an event, so request a new sequence number */
582 retval = add_uevent_var(env, "SEQNUM=%llu", (unsigned long long)++uevent_seqnum);
584 mutex_unlock(&uevent_sock_mutex);
587 retval = kobject_uevent_net_broadcast(kobj, env, action_string,
589 mutex_unlock(&uevent_sock_mutex);
591 #ifdef CONFIG_UEVENT_HELPER
592 /* call uevent_helper, usually only enabled during early boot */
593 if (uevent_helper[0] && !kobj_usermode_filter(kobj)) {
594 struct subprocess_info *info;
596 retval = add_uevent_var(env, "HOME=/");
599 retval = add_uevent_var(env,
600 "PATH=/sbin:/bin:/usr/sbin:/usr/bin");
603 retval = init_uevent_argv(env, subsystem);
608 info = call_usermodehelper_setup(env->argv[0], env->argv,
609 env->envp, GFP_KERNEL,
610 NULL, cleanup_uevent_env, env);
612 retval = call_usermodehelper_exec(info, UMH_NO_WAIT);
613 env = NULL; /* freed by cleanup_uevent_env */
623 EXPORT_SYMBOL_GPL(kobject_uevent_env);
626 * kobject_uevent - notify userspace by sending an uevent
628 * @kobj: struct kobject that the action is happening to
629 * @action: action that is happening
631 * Returns 0 if kobject_uevent() is completed with success or the
632 * corresponding error when it fails.
634 int kobject_uevent(struct kobject *kobj, enum kobject_action action)
636 return kobject_uevent_env(kobj, action, NULL);
638 EXPORT_SYMBOL_GPL(kobject_uevent);
641 * add_uevent_var - add key value string to the environment buffer
642 * @env: environment buffer structure
643 * @format: printf format for the key=value pair
645 * Returns 0 if environment variable was added successfully or -ENOMEM
646 * if no space was available.
648 int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
653 if (env->envp_idx >= ARRAY_SIZE(env->envp)) {
654 WARN(1, KERN_ERR "add_uevent_var: too many keys\n");
658 va_start(args, format);
659 len = vsnprintf(&env->buf[env->buflen],
660 sizeof(env->buf) - env->buflen,
664 if (len >= (sizeof(env->buf) - env->buflen)) {
665 WARN(1, KERN_ERR "add_uevent_var: buffer size too small\n");
669 env->envp[env->envp_idx++] = &env->buf[env->buflen];
670 env->buflen += len + 1;
673 EXPORT_SYMBOL_GPL(add_uevent_var);
675 #if defined(CONFIG_NET)
676 static int uevent_net_broadcast(struct sock *usk, struct sk_buff *skb,
677 struct netlink_ext_ack *extack)
679 /* u64 to chars: 2^64 - 1 = 21 chars */
680 char buf[sizeof("SEQNUM=") + 21];
681 struct sk_buff *skbc;
684 /* bump and prepare sequence number */
685 ret = snprintf(buf, sizeof(buf), "SEQNUM=%llu", ++uevent_seqnum);
686 if (ret < 0 || (size_t)ret >= sizeof(buf))
690 /* verify message does not overflow */
691 if ((skb->len + ret) > UEVENT_BUFFER_SIZE) {
692 NL_SET_ERR_MSG(extack, "uevent message too big");
696 /* copy skb and extend to accommodate sequence number */
697 skbc = skb_copy_expand(skb, 0, ret, GFP_KERNEL);
701 /* append sequence number */
702 skb_put_data(skbc, buf, ret);
704 /* remove msg header */
705 skb_pull(skbc, NLMSG_HDRLEN);
707 /* set portid 0 to inform userspace message comes from kernel */
708 NETLINK_CB(skbc).portid = 0;
709 NETLINK_CB(skbc).dst_group = 1;
711 ret = netlink_broadcast(usk, skbc, 0, 1, GFP_KERNEL);
712 /* ENOBUFS should be handled in userspace */
713 if (ret == -ENOBUFS || ret == -ESRCH)
719 static int uevent_net_rcv_skb(struct sk_buff *skb, struct nlmsghdr *nlh,
720 struct netlink_ext_ack *extack)
725 if (!nlmsg_data(nlh))
729 * Verify that we are allowed to send messages to the target
730 * network namespace. The caller must have CAP_SYS_ADMIN in the
731 * owning user namespace of the target network namespace.
733 net = sock_net(NETLINK_CB(skb).sk);
734 if (!netlink_ns_capable(skb, net->user_ns, CAP_SYS_ADMIN)) {
735 NL_SET_ERR_MSG(extack, "missing CAP_SYS_ADMIN capability");
739 mutex_lock(&uevent_sock_mutex);
740 ret = uevent_net_broadcast(net->uevent_sock->sk, skb, extack);
741 mutex_unlock(&uevent_sock_mutex);
746 static void uevent_net_rcv(struct sk_buff *skb)
748 netlink_rcv_skb(skb, &uevent_net_rcv_skb);
751 static int uevent_net_init(struct net *net)
753 struct uevent_sock *ue_sk;
754 struct netlink_kernel_cfg cfg = {
756 .input = uevent_net_rcv,
757 .flags = NL_CFG_F_NONROOT_RECV
760 ue_sk = kzalloc(sizeof(*ue_sk), GFP_KERNEL);
764 ue_sk->sk = netlink_kernel_create(net, NETLINK_KOBJECT_UEVENT, &cfg);
767 "kobject_uevent: unable to create netlink socket!\n");
772 net->uevent_sock = ue_sk;
774 /* Restrict uevents to initial user namespace. */
775 if (sock_net(ue_sk->sk)->user_ns == &init_user_ns) {
776 mutex_lock(&uevent_sock_mutex);
777 list_add_tail(&ue_sk->list, &uevent_sock_list);
778 mutex_unlock(&uevent_sock_mutex);
784 static void uevent_net_exit(struct net *net)
786 struct uevent_sock *ue_sk = net->uevent_sock;
788 if (sock_net(ue_sk->sk)->user_ns == &init_user_ns) {
789 mutex_lock(&uevent_sock_mutex);
790 list_del(&ue_sk->list);
791 mutex_unlock(&uevent_sock_mutex);
794 netlink_kernel_release(ue_sk->sk);
798 static struct pernet_operations uevent_net_ops = {
799 .init = uevent_net_init,
800 .exit = uevent_net_exit,
803 static int __init kobject_uevent_init(void)
805 return register_pernet_subsys(&uevent_net_ops);
809 postcore_initcall(kobject_uevent_init);