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>
33 atomic64_t uevent_seqnum
;
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
);
45 /* This lock protects uevent_sock_list */
46 static DEFINE_MUTEX(uevent_sock_mutex
);
49 /* the strings here must match the enum in include/linux/kobject.h */
50 static const char *kobject_actions
[] = {
52 [KOBJ_REMOVE
] = "remove",
53 [KOBJ_CHANGE
] = "change",
55 [KOBJ_ONLINE
] = "online",
56 [KOBJ_OFFLINE
] = "offline",
58 [KOBJ_UNBIND
] = "unbind",
61 static int kobject_action_type(const char *buf
, size_t count
,
62 enum kobject_action
*type
,
65 enum kobject_action action
;
67 const char *args_start
;
70 if (count
&& (buf
[count
-1] == '\n' || buf
[count
-1] == '\0'))
76 args_start
= strnchr(buf
, count
, ' ');
78 count_first
= args_start
- buf
;
79 args_start
= args_start
+ 1;
83 for (action
= 0; action
< ARRAY_SIZE(kobject_actions
); action
++) {
84 if (strncmp(kobject_actions
[action
], buf
, count_first
) != 0)
86 if (kobject_actions
[action
][count_first
] != '\0')
98 static const char *action_arg_word_end(const char *buf
, const char *buf_end
,
101 const char *next
= buf
;
103 while (next
<= buf_end
&& *next
!= delim
)
104 if (!isalnum(*next
++))
113 static int kobject_action_args(const char *buf
, size_t count
,
114 struct kobj_uevent_env
**ret_env
)
116 struct kobj_uevent_env
*env
= NULL
;
117 const char *next
, *buf_end
, *key
;
121 if (count
&& (buf
[count
- 1] == '\n' || buf
[count
- 1] == '\0'))
127 env
= kzalloc(sizeof(*env
), GFP_KERNEL
);
131 /* first arg is UUID */
132 if (count
< UUID_STRING_LEN
|| !uuid_is_valid(buf
) ||
133 add_uevent_var(env
, "SYNTH_UUID=%.*s", UUID_STRING_LEN
, buf
))
137 * the rest are custom environment variables in KEY=VALUE
138 * format with ' ' delimiter between each KEY=VALUE pair
140 next
= buf
+ UUID_STRING_LEN
;
141 buf_end
= buf
+ count
- 1;
143 while (next
<= buf_end
) {
147 /* skip the ' ', key must follow */
153 next
= action_arg_word_end(buf
, buf_end
, '=');
154 if (!next
|| next
> buf_end
|| *next
!= '=')
156 key_len
= next
- buf
;
158 /* skip the '=', value must follow */
159 if (++next
> buf_end
)
163 next
= action_arg_word_end(buf
, buf_end
, ' ');
167 if (add_uevent_var(env
, "SYNTH_ARG_%.*s=%.*s",
168 key_len
, key
, (int) (next
- buf
), buf
))
182 * kobject_synth_uevent - send synthetic uevent with arguments
184 * @kobj: struct kobject for which synthetic uevent is to be generated
185 * @buf: buffer containing action type and action args, newline is ignored
186 * @count: length of buffer
188 * Returns 0 if kobject_synthetic_uevent() is completed with success or the
189 * corresponding error when it fails.
191 int kobject_synth_uevent(struct kobject
*kobj
, const char *buf
, size_t count
)
193 char *no_uuid_envp
[] = { "SYNTH_UUID=0", NULL
};
194 enum kobject_action action
;
195 const char *action_args
;
196 struct kobj_uevent_env
*env
;
197 const char *msg
= NULL
, *devpath
;
200 r
= kobject_action_type(buf
, count
, &action
, &action_args
);
202 msg
= "unknown uevent action string";
207 r
= kobject_uevent_env(kobj
, action
, no_uuid_envp
);
211 r
= kobject_action_args(action_args
,
212 count
- (action_args
- buf
), &env
);
214 msg
= "incorrect uevent action arguments";
221 r
= kobject_uevent_env(kobj
, action
, env
->envp
);
225 devpath
= kobject_get_path(kobj
, GFP_KERNEL
);
226 pr_warn("synth uevent: %s: %s\n",
227 devpath
?: "unknown device",
228 msg
?: "failed to send uevent");
234 #ifdef CONFIG_UEVENT_HELPER
235 static int kobj_usermode_filter(struct kobject
*kobj
)
237 const struct kobj_ns_type_operations
*ops
;
239 ops
= kobj_ns_ops(kobj
);
241 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
)
253 int buffer_size
= sizeof(env
->buf
) - env
->buflen
;
256 len
= strscpy(&env
->buf
[env
->buflen
], subsystem
, buffer_size
);
258 pr_warn("%s: insufficient buffer space (%u left) for %s\n",
259 __func__
, buffer_size
, subsystem
);
263 env
->argv
[0] = uevent_helper
;
264 env
->argv
[1] = &env
->buf
[env
->buflen
];
267 env
->buflen
+= len
+ 1;
271 static void cleanup_uevent_env(struct subprocess_info
*info
)
278 static struct sk_buff
*alloc_uevent_skb(struct kobj_uevent_env
*env
,
279 const char *action_string
,
282 struct netlink_skb_parms
*parms
;
283 struct sk_buff
*skb
= NULL
;
287 /* allocate message with maximum possible size */
288 len
= strlen(action_string
) + strlen(devpath
) + 2;
289 skb
= alloc_skb(len
+ env
->buflen
, GFP_KERNEL
);
294 scratch
= skb_put(skb
, len
);
295 sprintf(scratch
, "%s@%s", action_string
, devpath
);
297 skb_put_data(skb
, env
->buf
, env
->buflen
);
299 parms
= &NETLINK_CB(skb
);
300 parms
->creds
.uid
= GLOBAL_ROOT_UID
;
301 parms
->creds
.gid
= GLOBAL_ROOT_GID
;
302 parms
->dst_group
= 1;
308 static int uevent_net_broadcast_untagged(struct kobj_uevent_env
*env
,
309 const char *action_string
,
312 struct sk_buff
*skb
= NULL
;
313 struct uevent_sock
*ue_sk
;
316 /* send netlink message */
317 mutex_lock(&uevent_sock_mutex
);
318 list_for_each_entry(ue_sk
, &uevent_sock_list
, list
) {
319 struct sock
*uevent_sock
= ue_sk
->sk
;
321 if (!netlink_has_listeners(uevent_sock
, 1))
326 skb
= alloc_uevent_skb(env
, action_string
, devpath
);
331 retval
= netlink_broadcast(uevent_sock
, skb_get(skb
), 0, 1,
333 /* ENOBUFS should be handled in userspace */
334 if (retval
== -ENOBUFS
|| retval
== -ESRCH
)
337 mutex_unlock(&uevent_sock_mutex
);
343 static int uevent_net_broadcast_tagged(struct sock
*usk
,
344 struct kobj_uevent_env
*env
,
345 const char *action_string
,
348 struct user_namespace
*owning_user_ns
= sock_net(usk
)->user_ns
;
349 struct sk_buff
*skb
= NULL
;
352 skb
= alloc_uevent_skb(env
, action_string
, devpath
);
356 /* fix credentials */
357 if (owning_user_ns
!= &init_user_ns
) {
358 struct netlink_skb_parms
*parms
= &NETLINK_CB(skb
);
363 root_uid
= make_kuid(owning_user_ns
, 0);
364 if (uid_valid(root_uid
))
365 parms
->creds
.uid
= root_uid
;
368 root_gid
= make_kgid(owning_user_ns
, 0);
369 if (gid_valid(root_gid
))
370 parms
->creds
.gid
= root_gid
;
373 ret
= netlink_broadcast(usk
, skb
, 0, 1, GFP_KERNEL
);
374 /* ENOBUFS should be handled in userspace */
375 if (ret
== -ENOBUFS
|| ret
== -ESRCH
)
382 static int kobject_uevent_net_broadcast(struct kobject
*kobj
,
383 struct kobj_uevent_env
*env
,
384 const char *action_string
,
390 const struct kobj_ns_type_operations
*ops
;
391 const struct net
*net
= NULL
;
393 ops
= kobj_ns_ops(kobj
);
394 if (!ops
&& kobj
->kset
) {
395 struct kobject
*ksobj
= &kobj
->kset
->kobj
;
397 if (ksobj
->parent
!= NULL
)
398 ops
= kobj_ns_ops(ksobj
->parent
);
401 /* kobjects currently only carry network namespace tags and they
402 * are the only tag relevant here since we want to decide which
403 * network namespaces to broadcast the uevent into.
405 if (ops
&& ops
->netlink_ns
&& kobj
->ktype
->namespace)
406 if (ops
->type
== KOBJ_NS_TYPE_NET
)
407 net
= kobj
->ktype
->namespace(kobj
);
410 ret
= uevent_net_broadcast_untagged(env
, action_string
,
413 ret
= uevent_net_broadcast_tagged(net
->uevent_sock
->sk
, env
,
414 action_string
, devpath
);
420 static void zap_modalias_env(struct kobj_uevent_env
*env
)
422 static const char modalias_prefix
[] = "MODALIAS=";
426 for (i
= 0; i
< env
->envp_idx
;) {
427 if (strncmp(env
->envp
[i
], modalias_prefix
,
428 sizeof(modalias_prefix
) - 1)) {
433 len
= strlen(env
->envp
[i
]) + 1;
435 if (i
!= env
->envp_idx
- 1) {
436 memmove(env
->envp
[i
], env
->envp
[i
+ 1],
439 for (j
= i
; j
< env
->envp_idx
- 1; j
++)
440 env
->envp
[j
] = env
->envp
[j
+ 1] - len
;
449 * kobject_uevent_env - send an uevent with environmental data
451 * @kobj: struct kobject that the action is happening to
452 * @action: action that is happening
453 * @envp_ext: pointer to environmental data
455 * Returns 0 if kobject_uevent_env() is completed with success or the
456 * corresponding error when it fails.
458 int kobject_uevent_env(struct kobject
*kobj
, enum kobject_action action
,
461 struct kobj_uevent_env
*env
;
462 const char *action_string
= kobject_actions
[action
];
463 const char *devpath
= NULL
;
464 const char *subsystem
;
465 struct kobject
*top_kobj
;
467 const struct kset_uevent_ops
*uevent_ops
;
472 * Mark "remove" event done regardless of result, for some subsystems
473 * do not want to re-trigger "remove" event via automatic cleanup.
475 if (action
== KOBJ_REMOVE
)
476 kobj
->state_remove_uevent_sent
= 1;
478 pr_debug("kobject: '%s' (%p): %s\n",
479 kobject_name(kobj
), kobj
, __func__
);
481 /* search the kset we belong to */
483 while (!top_kobj
->kset
&& top_kobj
->parent
)
484 top_kobj
= top_kobj
->parent
;
486 if (!top_kobj
->kset
) {
487 pr_debug("kobject: '%s' (%p): %s: attempted to send uevent "
488 "without kset!\n", kobject_name(kobj
), kobj
,
493 kset
= top_kobj
->kset
;
494 uevent_ops
= kset
->uevent_ops
;
496 /* skip the event, if uevent_suppress is set*/
497 if (kobj
->uevent_suppress
) {
498 pr_debug("kobject: '%s' (%p): %s: uevent_suppress "
499 "caused the event to drop!\n",
500 kobject_name(kobj
), kobj
, __func__
);
503 /* skip the event, if the filter returns zero. */
504 if (uevent_ops
&& uevent_ops
->filter
)
505 if (!uevent_ops
->filter(kobj
)) {
506 pr_debug("kobject: '%s' (%p): %s: filter function "
507 "caused the event to drop!\n",
508 kobject_name(kobj
), kobj
, __func__
);
512 /* originating subsystem */
513 if (uevent_ops
&& uevent_ops
->name
)
514 subsystem
= uevent_ops
->name(kobj
);
516 subsystem
= kobject_name(&kset
->kobj
);
518 pr_debug("kobject: '%s' (%p): %s: unset subsystem caused the "
519 "event to drop!\n", kobject_name(kobj
), kobj
,
524 /* environment buffer */
525 env
= kzalloc(sizeof(struct kobj_uevent_env
), GFP_KERNEL
);
529 /* complete object path */
530 devpath
= kobject_get_path(kobj
, GFP_KERNEL
);
537 retval
= add_uevent_var(env
, "ACTION=%s", action_string
);
540 retval
= add_uevent_var(env
, "DEVPATH=%s", devpath
);
543 retval
= add_uevent_var(env
, "SUBSYSTEM=%s", subsystem
);
547 /* keys passed in from the caller */
549 for (i
= 0; envp_ext
[i
]; i
++) {
550 retval
= add_uevent_var(env
, "%s", envp_ext
[i
]);
556 /* let the kset specific function add its stuff */
557 if (uevent_ops
&& uevent_ops
->uevent
) {
558 retval
= uevent_ops
->uevent(kobj
, env
);
560 pr_debug("kobject: '%s' (%p): %s: uevent() returned "
561 "%d\n", kobject_name(kobj
), kobj
,
570 * Mark "add" event so we can make sure we deliver "remove"
571 * event to userspace during automatic cleanup. If
572 * the object did send an "add" event, "remove" will
573 * automatically generated by the core, if not already done
576 kobj
->state_add_uevent_sent
= 1;
580 zap_modalias_env(env
);
587 /* we will send an event, so request a new sequence number */
588 retval
= add_uevent_var(env
, "SEQNUM=%llu",
589 atomic64_inc_return(&uevent_seqnum
));
593 retval
= kobject_uevent_net_broadcast(kobj
, env
, action_string
,
596 #ifdef CONFIG_UEVENT_HELPER
597 /* call uevent_helper, usually only enabled during early boot */
598 if (uevent_helper
[0] && !kobj_usermode_filter(kobj
)) {
599 struct subprocess_info
*info
;
601 retval
= add_uevent_var(env
, "HOME=/");
604 retval
= add_uevent_var(env
,
605 "PATH=/sbin:/bin:/usr/sbin:/usr/bin");
608 retval
= init_uevent_argv(env
, subsystem
);
613 info
= call_usermodehelper_setup(env
->argv
[0], env
->argv
,
614 env
->envp
, GFP_KERNEL
,
615 NULL
, cleanup_uevent_env
, env
);
617 retval
= call_usermodehelper_exec(info
, UMH_NO_WAIT
);
618 env
= NULL
; /* freed by cleanup_uevent_env */
628 EXPORT_SYMBOL_GPL(kobject_uevent_env
);
631 * kobject_uevent - notify userspace by sending an uevent
633 * @kobj: struct kobject that the action is happening to
634 * @action: action that is happening
636 * Returns 0 if kobject_uevent() is completed with success or the
637 * corresponding error when it fails.
639 int kobject_uevent(struct kobject
*kobj
, enum kobject_action action
)
641 return kobject_uevent_env(kobj
, action
, NULL
);
643 EXPORT_SYMBOL_GPL(kobject_uevent
);
646 * add_uevent_var - add key value string to the environment buffer
647 * @env: environment buffer structure
648 * @format: printf format for the key=value pair
650 * Returns 0 if environment variable was added successfully or -ENOMEM
651 * if no space was available.
653 int add_uevent_var(struct kobj_uevent_env
*env
, const char *format
, ...)
658 if (env
->envp_idx
>= ARRAY_SIZE(env
->envp
)) {
659 WARN(1, KERN_ERR
"add_uevent_var: too many keys\n");
663 va_start(args
, format
);
664 len
= vsnprintf(&env
->buf
[env
->buflen
],
665 sizeof(env
->buf
) - env
->buflen
,
669 if (len
>= (sizeof(env
->buf
) - env
->buflen
)) {
670 WARN(1, KERN_ERR
"add_uevent_var: buffer size too small\n");
674 env
->envp
[env
->envp_idx
++] = &env
->buf
[env
->buflen
];
675 env
->buflen
+= len
+ 1;
678 EXPORT_SYMBOL_GPL(add_uevent_var
);
680 #if defined(CONFIG_NET)
681 static int uevent_net_broadcast(struct sock
*usk
, struct sk_buff
*skb
,
682 struct netlink_ext_ack
*extack
)
684 /* u64 to chars: 2^64 - 1 = 21 chars */
685 char buf
[sizeof("SEQNUM=") + 21];
686 struct sk_buff
*skbc
;
689 /* bump and prepare sequence number */
690 ret
= snprintf(buf
, sizeof(buf
), "SEQNUM=%llu",
691 atomic64_inc_return(&uevent_seqnum
));
692 if (ret
< 0 || (size_t)ret
>= sizeof(buf
))
696 /* verify message does not overflow */
697 if ((skb
->len
+ ret
) > UEVENT_BUFFER_SIZE
) {
698 NL_SET_ERR_MSG(extack
, "uevent message too big");
702 /* copy skb and extend to accommodate sequence number */
703 skbc
= skb_copy_expand(skb
, 0, ret
, GFP_KERNEL
);
707 /* append sequence number */
708 skb_put_data(skbc
, buf
, ret
);
710 /* remove msg header */
711 skb_pull(skbc
, NLMSG_HDRLEN
);
713 /* set portid 0 to inform userspace message comes from kernel */
714 NETLINK_CB(skbc
).portid
= 0;
715 NETLINK_CB(skbc
).dst_group
= 1;
717 ret
= netlink_broadcast(usk
, skbc
, 0, 1, GFP_KERNEL
);
718 /* ENOBUFS should be handled in userspace */
719 if (ret
== -ENOBUFS
|| ret
== -ESRCH
)
725 static int uevent_net_rcv_skb(struct sk_buff
*skb
, struct nlmsghdr
*nlh
,
726 struct netlink_ext_ack
*extack
)
731 if (!nlmsg_data(nlh
))
735 * Verify that we are allowed to send messages to the target
736 * network namespace. The caller must have CAP_SYS_ADMIN in the
737 * owning user namespace of the target network namespace.
739 net
= sock_net(NETLINK_CB(skb
).sk
);
740 if (!netlink_ns_capable(skb
, net
->user_ns
, CAP_SYS_ADMIN
)) {
741 NL_SET_ERR_MSG(extack
, "missing CAP_SYS_ADMIN capability");
745 ret
= uevent_net_broadcast(net
->uevent_sock
->sk
, skb
, extack
);
750 static void uevent_net_rcv(struct sk_buff
*skb
)
752 netlink_rcv_skb(skb
, &uevent_net_rcv_skb
);
755 static int uevent_net_init(struct net
*net
)
757 struct uevent_sock
*ue_sk
;
758 struct netlink_kernel_cfg cfg
= {
760 .input
= uevent_net_rcv
,
761 .flags
= NL_CFG_F_NONROOT_RECV
764 ue_sk
= kzalloc(sizeof(*ue_sk
), GFP_KERNEL
);
768 ue_sk
->sk
= netlink_kernel_create(net
, NETLINK_KOBJECT_UEVENT
, &cfg
);
770 pr_err("kobject_uevent: unable to create netlink socket!\n");
775 net
->uevent_sock
= ue_sk
;
777 /* Restrict uevents to initial user namespace. */
778 if (sock_net(ue_sk
->sk
)->user_ns
== &init_user_ns
) {
779 mutex_lock(&uevent_sock_mutex
);
780 list_add_tail(&ue_sk
->list
, &uevent_sock_list
);
781 mutex_unlock(&uevent_sock_mutex
);
787 static void uevent_net_exit(struct net
*net
)
789 struct uevent_sock
*ue_sk
= net
->uevent_sock
;
791 if (sock_net(ue_sk
->sk
)->user_ns
== &init_user_ns
) {
792 mutex_lock(&uevent_sock_mutex
);
793 list_del(&ue_sk
->list
);
794 mutex_unlock(&uevent_sock_mutex
);
797 netlink_kernel_release(ue_sk
->sk
);
801 static struct pernet_operations uevent_net_ops
= {
802 .init
= uevent_net_init
,
803 .exit
= uevent_net_exit
,
806 static int __init
kobject_uevent_init(void)
808 return register_pernet_subsys(&uevent_net_ops
);
812 postcore_initcall(kobject_uevent_init
);