1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Filesystem access-by-fd.
4 * Copyright (C) 2017 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #include <linux/fs_context.h>
9 #include <linux/fs_parser.h>
10 #include <linux/slab.h>
11 #include <linux/uaccess.h>
12 #include <linux/syscalls.h>
13 #include <linux/security.h>
14 #include <linux/anon_inodes.h>
15 #include <linux/namei.h>
16 #include <linux/file.h>
17 #include <uapi/linux/mount.h>
22 * Allow the user to read back any error, warning or informational messages.
24 static ssize_t fscontext_read(struct file *file,
25 char __user *_buf, size_t len, loff_t *pos)
27 struct fs_context *fc = file->private_data;
28 struct fc_log *log = fc->log.log;
29 unsigned int logsize = ARRAY_SIZE(log->buffer);
35 ret = mutex_lock_interruptible(&fc->uapi_mutex);
39 if (log->head == log->tail) {
40 mutex_unlock(&fc->uapi_mutex);
44 index = log->tail & (logsize - 1);
45 p = log->buffer[index];
46 need_free = log->need_free & (1 << index);
47 log->buffer[index] = NULL;
48 log->need_free &= ~(1 << index);
50 mutex_unlock(&fc->uapi_mutex);
57 if (copy_to_user(_buf, p, n) != 0)
67 static int fscontext_release(struct inode *inode, struct file *file)
69 struct fs_context *fc = file->private_data;
72 file->private_data = NULL;
78 const struct file_operations fscontext_fops = {
79 .read = fscontext_read,
80 .release = fscontext_release,
85 * Attach a filesystem context to a file and an fd.
87 static int fscontext_create_fd(struct fs_context *fc, unsigned int o_flags)
91 fd = anon_inode_getfd("[fscontext]", &fscontext_fops, fc,
98 static int fscontext_alloc_log(struct fs_context *fc)
100 fc->log.log = kzalloc(sizeof(*fc->log.log), GFP_KERNEL);
103 refcount_set(&fc->log.log->usage, 1);
104 fc->log.log->owner = fc->fs_type->owner;
109 * Open a filesystem by name so that it can be configured for mounting.
111 * We are allowed to specify a container in which the filesystem will be
112 * opened, thereby indicating which namespaces will be used (notably, which
113 * network namespace will be used for network filesystems).
115 SYSCALL_DEFINE2(fsopen, const char __user *, _fs_name, unsigned int, flags)
117 struct file_system_type *fs_type;
118 struct fs_context *fc;
122 if (!ns_capable(current->nsproxy->mnt_ns->user_ns, CAP_SYS_ADMIN))
125 if (flags & ~FSOPEN_CLOEXEC)
128 fs_name = strndup_user(_fs_name, PAGE_SIZE);
130 return PTR_ERR(fs_name);
132 fs_type = get_fs_type(fs_name);
137 fc = fs_context_for_mount(fs_type, 0);
138 put_filesystem(fs_type);
142 fc->phase = FS_CONTEXT_CREATE_PARAMS;
144 ret = fscontext_alloc_log(fc);
148 return fscontext_create_fd(fc, flags & FSOPEN_CLOEXEC ? O_CLOEXEC : 0);
156 * Pick a superblock into a context for reconfiguration.
158 SYSCALL_DEFINE3(fspick, int, dfd, const char __user *, path, unsigned int, flags)
160 struct fs_context *fc;
162 unsigned int lookup_flags;
165 if (!ns_capable(current->nsproxy->mnt_ns->user_ns, CAP_SYS_ADMIN))
168 if ((flags & ~(FSPICK_CLOEXEC |
169 FSPICK_SYMLINK_NOFOLLOW |
170 FSPICK_NO_AUTOMOUNT |
171 FSPICK_EMPTY_PATH)) != 0)
174 lookup_flags = LOOKUP_FOLLOW | LOOKUP_AUTOMOUNT;
175 if (flags & FSPICK_SYMLINK_NOFOLLOW)
176 lookup_flags &= ~LOOKUP_FOLLOW;
177 if (flags & FSPICK_NO_AUTOMOUNT)
178 lookup_flags &= ~LOOKUP_AUTOMOUNT;
179 if (flags & FSPICK_EMPTY_PATH)
180 lookup_flags |= LOOKUP_EMPTY;
181 ret = user_path_at(dfd, path, lookup_flags, &target);
186 if (target.mnt->mnt_root != target.dentry)
189 fc = fs_context_for_reconfigure(target.dentry, 0, 0);
195 fc->phase = FS_CONTEXT_RECONF_PARAMS;
197 ret = fscontext_alloc_log(fc);
202 return fscontext_create_fd(fc, flags & FSPICK_CLOEXEC ? O_CLOEXEC : 0);
213 * Check the state and apply the configuration. Note that this function is
214 * allowed to 'steal' the value by setting param->xxx to NULL before returning.
216 static int vfs_fsconfig_locked(struct fs_context *fc, int cmd,
217 struct fs_parameter *param)
219 struct super_block *sb;
222 ret = finish_clean_context(fc);
226 case FSCONFIG_CMD_CREATE:
227 if (fc->phase != FS_CONTEXT_CREATE_PARAMS)
229 if (!mount_capable(fc))
231 fc->phase = FS_CONTEXT_CREATING;
232 ret = vfs_get_tree(fc);
236 ret = security_sb_kern_mount(sb);
241 up_write(&sb->s_umount);
242 fc->phase = FS_CONTEXT_AWAITING_MOUNT;
244 case FSCONFIG_CMD_RECONFIGURE:
245 if (fc->phase != FS_CONTEXT_RECONF_PARAMS)
247 fc->phase = FS_CONTEXT_RECONFIGURING;
249 if (!ns_capable(sb->s_user_ns, CAP_SYS_ADMIN)) {
253 down_write(&sb->s_umount);
254 ret = reconfigure_super(fc);
255 up_write(&sb->s_umount);
258 vfs_clean_context(fc);
261 if (fc->phase != FS_CONTEXT_CREATE_PARAMS &&
262 fc->phase != FS_CONTEXT_RECONF_PARAMS)
265 return vfs_parse_fs_param(fc, param);
267 fc->phase = FS_CONTEXT_FAILED;
272 * sys_fsconfig - Set parameters and trigger actions on a context
273 * @fd: The filesystem context to act upon
274 * @cmd: The action to take
275 * @_key: Where appropriate, the parameter key to set
276 * @_value: Where appropriate, the parameter value to set
277 * @aux: Additional information for the value
279 * This system call is used to set parameters on a context, including
280 * superblock settings, data source and security labelling.
282 * Actions include triggering the creation of a superblock and the
283 * reconfiguration of the superblock attached to the specified context.
285 * When setting a parameter, @cmd indicates the type of value being proposed
286 * and @_key indicates the parameter to be altered.
288 * @_value and @aux are used to specify the value, should a value be required:
290 * (*) fsconfig_set_flag: No value is specified. The parameter must be boolean
291 * in nature. The key may be prefixed with "no" to invert the
292 * setting. @_value must be NULL and @aux must be 0.
294 * (*) fsconfig_set_string: A string value is specified. The parameter can be
295 * expecting boolean, integer, string or take a path. A conversion to an
296 * appropriate type will be attempted (which may include looking up as a
297 * path). @_value points to a NUL-terminated string and @aux must be 0.
299 * (*) fsconfig_set_binary: A binary blob is specified. @_value points to the
300 * blob and @aux indicates its size. The parameter must be expecting a
303 * (*) fsconfig_set_path: A non-empty path is specified. The parameter must be
304 * expecting a path object. @_value points to a NUL-terminated string that
305 * is the path and @aux is a file descriptor at which to start a relative
306 * lookup or AT_FDCWD.
308 * (*) fsconfig_set_path_empty: As fsconfig_set_path, but with AT_EMPTY_PATH
311 * (*) fsconfig_set_fd: An open file descriptor is specified. @_value must be
312 * NULL and @aux indicates the file descriptor.
314 SYSCALL_DEFINE5(fsconfig,
317 const char __user *, _key,
318 const void __user *, _value,
321 struct fs_context *fc;
324 int lookup_flags = 0;
326 struct fs_parameter param = {
327 .type = fs_value_is_undefined,
334 case FSCONFIG_SET_FLAG:
335 if (!_key || _value || aux)
338 case FSCONFIG_SET_STRING:
339 if (!_key || !_value || aux)
342 case FSCONFIG_SET_BINARY:
343 if (!_key || !_value || aux <= 0 || aux > 1024 * 1024)
346 case FSCONFIG_SET_PATH:
347 case FSCONFIG_SET_PATH_EMPTY:
348 if (!_key || !_value || (aux != AT_FDCWD && aux < 0))
351 case FSCONFIG_SET_FD:
352 if (!_key || _value || aux < 0)
355 case FSCONFIG_CMD_CREATE:
356 case FSCONFIG_CMD_RECONFIGURE:
357 if (_key || _value || aux)
368 if (f.file->f_op != &fscontext_fops)
371 fc = f.file->private_data;
372 if (fc->ops == &legacy_fs_context_ops) {
374 case FSCONFIG_SET_BINARY:
375 case FSCONFIG_SET_PATH:
376 case FSCONFIG_SET_PATH_EMPTY:
377 case FSCONFIG_SET_FD:
384 param.key = strndup_user(_key, 256);
385 if (IS_ERR(param.key)) {
386 ret = PTR_ERR(param.key);
392 case FSCONFIG_SET_FLAG:
393 param.type = fs_value_is_flag;
395 case FSCONFIG_SET_STRING:
396 param.type = fs_value_is_string;
397 param.string = strndup_user(_value, 256);
398 if (IS_ERR(param.string)) {
399 ret = PTR_ERR(param.string);
402 param.size = strlen(param.string);
404 case FSCONFIG_SET_BINARY:
405 param.type = fs_value_is_blob;
407 param.blob = memdup_user_nul(_value, aux);
408 if (IS_ERR(param.blob)) {
409 ret = PTR_ERR(param.blob);
413 case FSCONFIG_SET_PATH_EMPTY:
414 lookup_flags = LOOKUP_EMPTY;
416 case FSCONFIG_SET_PATH:
417 param.type = fs_value_is_filename;
418 param.name = getname_flags(_value, lookup_flags, NULL);
419 if (IS_ERR(param.name)) {
420 ret = PTR_ERR(param.name);
424 param.size = strlen(param.name->name);
426 case FSCONFIG_SET_FD:
427 param.type = fs_value_is_file;
429 param.file = fget(aux);
437 ret = mutex_lock_interruptible(&fc->uapi_mutex);
439 ret = vfs_fsconfig_locked(fc, cmd, ¶m);
440 mutex_unlock(&fc->uapi_mutex);
443 /* Clean up the our record of any value that we obtained from
444 * userspace. Note that the value may have been stolen by the LSM or
445 * filesystem, in which case the value pointer will have been cleared.
448 case FSCONFIG_SET_STRING:
449 case FSCONFIG_SET_BINARY:
452 case FSCONFIG_SET_PATH:
453 case FSCONFIG_SET_PATH_EMPTY:
457 case FSCONFIG_SET_FD: