1 // SPDX-License-Identifier: GPL-2.0
3 * Supplementary group IDs
5 #include <linux/cred.h>
6 #include <linux/export.h>
7 #include <linux/slab.h>
8 #include <linux/security.h>
9 #include <linux/sort.h>
10 #include <linux/syscalls.h>
11 #include <linux/user_namespace.h>
12 #include <linux/vmalloc.h>
13 #include <linux/uaccess.h>
15 struct group_info *groups_alloc(int gidsetsize)
17 struct group_info *gi;
18 gi = kvmalloc(struct_size(gi, gid, gidsetsize), GFP_KERNEL_ACCOUNT);
22 refcount_set(&gi->usage, 1);
23 gi->ngroups = gidsetsize;
27 EXPORT_SYMBOL(groups_alloc);
29 void groups_free(struct group_info *group_info)
34 EXPORT_SYMBOL(groups_free);
36 /* export the group_info to a user-space array */
37 static int groups_to_user(gid_t __user *grouplist,
38 const struct group_info *group_info)
40 struct user_namespace *user_ns = current_user_ns();
42 unsigned int count = group_info->ngroups;
44 for (i = 0; i < count; i++) {
46 gid = from_kgid_munged(user_ns, group_info->gid[i]);
47 if (put_user(gid, grouplist+i))
53 /* fill a group_info from a user-space array - it must be allocated already */
54 static int groups_from_user(struct group_info *group_info,
55 gid_t __user *grouplist)
57 struct user_namespace *user_ns = current_user_ns();
59 unsigned int count = group_info->ngroups;
61 for (i = 0; i < count; i++) {
64 if (get_user(gid, grouplist+i))
67 kgid = make_kgid(user_ns, gid);
71 group_info->gid[i] = kgid;
76 static int gid_cmp(const void *_a, const void *_b)
78 kgid_t a = *(kgid_t *)_a;
79 kgid_t b = *(kgid_t *)_b;
81 return gid_gt(a, b) - gid_lt(a, b);
84 void groups_sort(struct group_info *group_info)
86 sort(group_info->gid, group_info->ngroups, sizeof(*group_info->gid),
89 EXPORT_SYMBOL(groups_sort);
91 /* a simple bsearch */
92 int groups_search(const struct group_info *group_info, kgid_t grp)
94 unsigned int left, right;
100 right = group_info->ngroups;
101 while (left < right) {
102 unsigned int mid = (left+right)/2;
103 if (gid_gt(grp, group_info->gid[mid]))
105 else if (gid_lt(grp, group_info->gid[mid]))
114 * set_groups - Change a group subscription in a set of credentials
115 * @new: The newly prepared set of credentials to alter
116 * @group_info: The group list to install
118 void set_groups(struct cred *new, struct group_info *group_info)
120 put_group_info(new->group_info);
121 get_group_info(group_info);
122 new->group_info = group_info;
125 EXPORT_SYMBOL(set_groups);
128 * set_current_groups - Change current's group subscription
129 * @group_info: The group list to impose
131 * Validate a group subscription and, if valid, impose it upon current's task
134 int set_current_groups(struct group_info *group_info)
137 const struct cred *old;
140 new = prepare_creds();
144 old = current_cred();
146 set_groups(new, group_info);
148 retval = security_task_fix_setgroups(new, old);
152 return commit_creds(new);
159 EXPORT_SYMBOL(set_current_groups);
161 SYSCALL_DEFINE2(getgroups, int, gidsetsize, gid_t __user *, grouplist)
163 const struct cred *cred = current_cred();
169 /* no need to grab task_lock here; it cannot change */
170 i = cred->group_info->ngroups;
172 if (i > gidsetsize) {
176 if (groups_to_user(grouplist, cred->group_info)) {
185 bool may_setgroups(void)
187 struct user_namespace *user_ns = current_user_ns();
189 return ns_capable_setid(user_ns, CAP_SETGID) &&
190 userns_may_setgroups(user_ns);
194 * SMP: Our groups are copy-on-write. We can set them safely
195 * without another task interfering.
198 SYSCALL_DEFINE2(setgroups, int, gidsetsize, gid_t __user *, grouplist)
200 struct group_info *group_info;
203 if (!may_setgroups())
205 if ((unsigned)gidsetsize > NGROUPS_MAX)
208 group_info = groups_alloc(gidsetsize);
211 retval = groups_from_user(group_info, grouplist);
213 put_group_info(group_info);
217 groups_sort(group_info);
218 retval = set_current_groups(group_info);
219 put_group_info(group_info);
225 * Check whether we're fsgid/egid or in the supplemental group..
227 int in_group_p(kgid_t grp)
229 const struct cred *cred = current_cred();
232 if (!gid_eq(grp, cred->fsgid))
233 retval = groups_search(cred->group_info, grp);
237 EXPORT_SYMBOL(in_group_p);
239 int in_egroup_p(kgid_t grp)
241 const struct cred *cred = current_cred();
244 if (!gid_eq(grp, cred->egid))
245 retval = groups_search(cred->group_info, grp);
249 EXPORT_SYMBOL(in_egroup_p);