xref: /linux-6.15/include/linux/user_namespace.h (revision b206f281)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_USER_NAMESPACE_H
3 #define _LINUX_USER_NAMESPACE_H
4 
5 #include <linux/kref.h>
6 #include <linux/nsproxy.h>
7 #include <linux/ns_common.h>
8 #include <linux/sched.h>
9 #include <linux/workqueue.h>
10 #include <linux/rwsem.h>
11 #include <linux/sysctl.h>
12 #include <linux/err.h>
13 
14 #define UID_GID_MAP_MAX_BASE_EXTENTS 5
15 #define UID_GID_MAP_MAX_EXTENTS 340
16 
17 struct uid_gid_extent {
18 	u32 first;
19 	u32 lower_first;
20 	u32 count;
21 };
22 
23 struct uid_gid_map { /* 64 bytes -- 1 cache line */
24 	u32 nr_extents;
25 	union {
26 		struct uid_gid_extent extent[UID_GID_MAP_MAX_BASE_EXTENTS];
27 		struct {
28 			struct uid_gid_extent *forward;
29 			struct uid_gid_extent *reverse;
30 		};
31 	};
32 };
33 
34 #define USERNS_SETGROUPS_ALLOWED 1UL
35 
36 #define USERNS_INIT_FLAGS USERNS_SETGROUPS_ALLOWED
37 
38 struct ucounts;
39 
40 enum ucount_type {
41 	UCOUNT_USER_NAMESPACES,
42 	UCOUNT_PID_NAMESPACES,
43 	UCOUNT_UTS_NAMESPACES,
44 	UCOUNT_IPC_NAMESPACES,
45 	UCOUNT_NET_NAMESPACES,
46 	UCOUNT_MNT_NAMESPACES,
47 	UCOUNT_CGROUP_NAMESPACES,
48 #ifdef CONFIG_INOTIFY_USER
49 	UCOUNT_INOTIFY_INSTANCES,
50 	UCOUNT_INOTIFY_WATCHES,
51 #endif
52 	UCOUNT_COUNTS,
53 };
54 
55 struct user_namespace {
56 	struct uid_gid_map	uid_map;
57 	struct uid_gid_map	gid_map;
58 	struct uid_gid_map	projid_map;
59 	atomic_t		count;
60 	struct user_namespace	*parent;
61 	int			level;
62 	kuid_t			owner;
63 	kgid_t			group;
64 	struct ns_common	ns;
65 	unsigned long		flags;
66 
67 #ifdef CONFIG_KEYS
68 	/* List of joinable keyrings in this namespace */
69 	struct list_head	keyring_name_list;
70 #endif
71 
72 	/* Register of per-UID persistent keyrings for this namespace */
73 #ifdef CONFIG_PERSISTENT_KEYRINGS
74 	struct key		*persistent_keyring_register;
75 	struct rw_semaphore	persistent_keyring_register_sem;
76 #endif
77 	struct work_struct	work;
78 #ifdef CONFIG_SYSCTL
79 	struct ctl_table_set	set;
80 	struct ctl_table_header *sysctls;
81 #endif
82 	struct ucounts		*ucounts;
83 	int ucount_max[UCOUNT_COUNTS];
84 } __randomize_layout;
85 
86 struct ucounts {
87 	struct hlist_node node;
88 	struct user_namespace *ns;
89 	kuid_t uid;
90 	int count;
91 	atomic_t ucount[UCOUNT_COUNTS];
92 };
93 
94 extern struct user_namespace init_user_ns;
95 
96 bool setup_userns_sysctls(struct user_namespace *ns);
97 void retire_userns_sysctls(struct user_namespace *ns);
98 struct ucounts *inc_ucount(struct user_namespace *ns, kuid_t uid, enum ucount_type type);
99 void dec_ucount(struct ucounts *ucounts, enum ucount_type type);
100 
101 #ifdef CONFIG_USER_NS
102 
103 static inline struct user_namespace *get_user_ns(struct user_namespace *ns)
104 {
105 	if (ns)
106 		atomic_inc(&ns->count);
107 	return ns;
108 }
109 
110 extern int create_user_ns(struct cred *new);
111 extern int unshare_userns(unsigned long unshare_flags, struct cred **new_cred);
112 extern void __put_user_ns(struct user_namespace *ns);
113 
114 static inline void put_user_ns(struct user_namespace *ns)
115 {
116 	if (ns && atomic_dec_and_test(&ns->count))
117 		__put_user_ns(ns);
118 }
119 
120 struct seq_operations;
121 extern const struct seq_operations proc_uid_seq_operations;
122 extern const struct seq_operations proc_gid_seq_operations;
123 extern const struct seq_operations proc_projid_seq_operations;
124 extern ssize_t proc_uid_map_write(struct file *, const char __user *, size_t, loff_t *);
125 extern ssize_t proc_gid_map_write(struct file *, const char __user *, size_t, loff_t *);
126 extern ssize_t proc_projid_map_write(struct file *, const char __user *, size_t, loff_t *);
127 extern ssize_t proc_setgroups_write(struct file *, const char __user *, size_t, loff_t *);
128 extern int proc_setgroups_show(struct seq_file *m, void *v);
129 extern bool userns_may_setgroups(const struct user_namespace *ns);
130 extern bool in_userns(const struct user_namespace *ancestor,
131 		       const struct user_namespace *child);
132 extern bool current_in_userns(const struct user_namespace *target_ns);
133 struct ns_common *ns_get_owner(struct ns_common *ns);
134 #else
135 
136 static inline struct user_namespace *get_user_ns(struct user_namespace *ns)
137 {
138 	return &init_user_ns;
139 }
140 
141 static inline int create_user_ns(struct cred *new)
142 {
143 	return -EINVAL;
144 }
145 
146 static inline int unshare_userns(unsigned long unshare_flags,
147 				 struct cred **new_cred)
148 {
149 	if (unshare_flags & CLONE_NEWUSER)
150 		return -EINVAL;
151 	return 0;
152 }
153 
154 static inline void put_user_ns(struct user_namespace *ns)
155 {
156 }
157 
158 static inline bool userns_may_setgroups(const struct user_namespace *ns)
159 {
160 	return true;
161 }
162 
163 static inline bool in_userns(const struct user_namespace *ancestor,
164 			     const struct user_namespace *child)
165 {
166 	return true;
167 }
168 
169 static inline bool current_in_userns(const struct user_namespace *target_ns)
170 {
171 	return true;
172 }
173 
174 static inline struct ns_common *ns_get_owner(struct ns_common *ns)
175 {
176 	return ERR_PTR(-EPERM);
177 }
178 #endif
179 
180 #endif /* _LINUX_USER_H */
181