fs: add vfs_cmd_create()
[linux-block.git] / fs / fsopen.c
CommitLineData
b4d0d230 1// SPDX-License-Identifier: GPL-2.0-or-later
24dcb3d9
DH
2/* Filesystem access-by-fd.
3 *
4 * Copyright (C) 2017 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
24dcb3d9
DH
6 */
7
8#include <linux/fs_context.h>
ecdab150 9#include <linux/fs_parser.h>
24dcb3d9
DH
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>
ecdab150 18#include "internal.h"
24dcb3d9
DH
19#include "mount.h"
20
007ec26c
DH
21/*
22 * Allow the user to read back any error, warning or informational messages.
23 */
24static ssize_t fscontext_read(struct file *file,
25 char __user *_buf, size_t len, loff_t *pos)
26{
27 struct fs_context *fc = file->private_data;
cc3c0b53 28 struct fc_log *log = fc->log.log;
007ec26c
DH
29 unsigned int logsize = ARRAY_SIZE(log->buffer);
30 ssize_t ret;
31 char *p;
32 bool need_free;
33 int index, n;
34
35 ret = mutex_lock_interruptible(&fc->uapi_mutex);
36 if (ret < 0)
37 return ret;
38
39 if (log->head == log->tail) {
40 mutex_unlock(&fc->uapi_mutex);
41 return -ENODATA;
42 }
43
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);
49 log->tail++;
50 mutex_unlock(&fc->uapi_mutex);
51
52 ret = -EMSGSIZE;
53 n = strlen(p);
54 if (n > len)
55 goto err_free;
56 ret = -EFAULT;
57 if (copy_to_user(_buf, p, n) != 0)
58 goto err_free;
59 ret = n;
60
61err_free:
62 if (need_free)
63 kfree(p);
64 return ret;
65}
66
24dcb3d9
DH
67static int fscontext_release(struct inode *inode, struct file *file)
68{
69 struct fs_context *fc = file->private_data;
70
71 if (fc) {
72 file->private_data = NULL;
73 put_fs_context(fc);
74 }
75 return 0;
76}
77
78const struct file_operations fscontext_fops = {
007ec26c 79 .read = fscontext_read,
24dcb3d9
DH
80 .release = fscontext_release,
81 .llseek = no_llseek,
82};
83
84/*
85 * Attach a filesystem context to a file and an fd.
86 */
87static int fscontext_create_fd(struct fs_context *fc, unsigned int o_flags)
88{
89 int fd;
90
1cdc415f 91 fd = anon_inode_getfd("[fscontext]", &fscontext_fops, fc,
24dcb3d9
DH
92 O_RDWR | o_flags);
93 if (fd < 0)
94 put_fs_context(fc);
95 return fd;
96}
97
007ec26c
DH
98static int fscontext_alloc_log(struct fs_context *fc)
99{
cc3c0b53
AV
100 fc->log.log = kzalloc(sizeof(*fc->log.log), GFP_KERNEL);
101 if (!fc->log.log)
007ec26c 102 return -ENOMEM;
cc3c0b53
AV
103 refcount_set(&fc->log.log->usage, 1);
104 fc->log.log->owner = fc->fs_type->owner;
007ec26c
DH
105 return 0;
106}
107
24dcb3d9
DH
108/*
109 * Open a filesystem by name so that it can be configured for mounting.
110 *
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).
114 */
115SYSCALL_DEFINE2(fsopen, const char __user *, _fs_name, unsigned int, flags)
116{
117 struct file_system_type *fs_type;
118 struct fs_context *fc;
119 const char *fs_name;
007ec26c 120 int ret;
24dcb3d9 121
a5f85d78 122 if (!may_mount())
24dcb3d9
DH
123 return -EPERM;
124
125 if (flags & ~FSOPEN_CLOEXEC)
126 return -EINVAL;
127
128 fs_name = strndup_user(_fs_name, PAGE_SIZE);
129 if (IS_ERR(fs_name))
130 return PTR_ERR(fs_name);
131
132 fs_type = get_fs_type(fs_name);
133 kfree(fs_name);
134 if (!fs_type)
135 return -ENODEV;
136
137 fc = fs_context_for_mount(fs_type, 0);
138 put_filesystem(fs_type);
139 if (IS_ERR(fc))
140 return PTR_ERR(fc);
141
142 fc->phase = FS_CONTEXT_CREATE_PARAMS;
007ec26c
DH
143
144 ret = fscontext_alloc_log(fc);
145 if (ret < 0)
146 goto err_fc;
147
24dcb3d9 148 return fscontext_create_fd(fc, flags & FSOPEN_CLOEXEC ? O_CLOEXEC : 0);
007ec26c
DH
149
150err_fc:
151 put_fs_context(fc);
152 return ret;
24dcb3d9 153}
ecdab150 154
cf3cba4a
DH
155/*
156 * Pick a superblock into a context for reconfiguration.
157 */
158SYSCALL_DEFINE3(fspick, int, dfd, const char __user *, path, unsigned int, flags)
159{
160 struct fs_context *fc;
161 struct path target;
162 unsigned int lookup_flags;
163 int ret;
164
a5f85d78 165 if (!may_mount())
cf3cba4a
DH
166 return -EPERM;
167
168 if ((flags & ~(FSPICK_CLOEXEC |
169 FSPICK_SYMLINK_NOFOLLOW |
170 FSPICK_NO_AUTOMOUNT |
171 FSPICK_EMPTY_PATH)) != 0)
172 return -EINVAL;
173
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);
182 if (ret < 0)
183 goto err;
184
185 ret = -EINVAL;
186 if (target.mnt->mnt_root != target.dentry)
187 goto err_path;
188
189 fc = fs_context_for_reconfigure(target.dentry, 0, 0);
190 if (IS_ERR(fc)) {
191 ret = PTR_ERR(fc);
192 goto err_path;
193 }
194
195 fc->phase = FS_CONTEXT_RECONF_PARAMS;
196
197 ret = fscontext_alloc_log(fc);
198 if (ret < 0)
199 goto err_fc;
200
201 path_put(&target);
202 return fscontext_create_fd(fc, flags & FSPICK_CLOEXEC ? O_CLOEXEC : 0);
203
204err_fc:
205 put_fs_context(fc);
206err_path:
207 path_put(&target);
208err:
209 return ret;
210}
211
dae8b08d
CB
212static int vfs_cmd_create(struct fs_context *fc)
213{
214 struct super_block *sb;
215 int ret;
216
217 if (fc->phase != FS_CONTEXT_CREATE_PARAMS)
218 return -EBUSY;
219
220 if (!mount_capable(fc))
221 return -EPERM;
222
223 fc->phase = FS_CONTEXT_CREATING;
224
225 ret = vfs_get_tree(fc);
226 if (ret) {
227 fc->phase = FS_CONTEXT_FAILED;
228 return ret;
229 }
230
231 sb = fc->root->d_sb;
232 ret = security_sb_kern_mount(sb);
233 if (unlikely(ret)) {
234 fc_drop_locked(fc);
235 fc->phase = FS_CONTEXT_FAILED;
236 return ret;
237 }
238
239 /* vfs_get_tree() callchains will have grabbed @s_umount */
240 up_write(&sb->s_umount);
241 fc->phase = FS_CONTEXT_AWAITING_MOUNT;
242 return 0;
243}
244
ecdab150
DH
245/*
246 * Check the state and apply the configuration. Note that this function is
247 * allowed to 'steal' the value by setting param->xxx to NULL before returning.
248 */
249static int vfs_fsconfig_locked(struct fs_context *fc, int cmd,
250 struct fs_parameter *param)
251{
252 struct super_block *sb;
253 int ret;
254
255 ret = finish_clean_context(fc);
256 if (ret)
257 return ret;
258 switch (cmd) {
259 case FSCONFIG_CMD_CREATE:
dae8b08d 260 return vfs_cmd_create(fc);
ecdab150
DH
261 case FSCONFIG_CMD_RECONFIGURE:
262 if (fc->phase != FS_CONTEXT_RECONF_PARAMS)
263 return -EBUSY;
264 fc->phase = FS_CONTEXT_RECONFIGURING;
265 sb = fc->root->d_sb;
266 if (!ns_capable(sb->s_user_ns, CAP_SYS_ADMIN)) {
267 ret = -EPERM;
268 break;
269 }
270 down_write(&sb->s_umount);
271 ret = reconfigure_super(fc);
272 up_write(&sb->s_umount);
273 if (ret)
274 break;
275 vfs_clean_context(fc);
276 return 0;
277 default:
278 if (fc->phase != FS_CONTEXT_CREATE_PARAMS &&
279 fc->phase != FS_CONTEXT_RECONF_PARAMS)
280 return -EBUSY;
281
282 return vfs_parse_fs_param(fc, param);
283 }
284 fc->phase = FS_CONTEXT_FAILED;
285 return ret;
286}
287
288/**
289 * sys_fsconfig - Set parameters and trigger actions on a context
290 * @fd: The filesystem context to act upon
291 * @cmd: The action to take
292 * @_key: Where appropriate, the parameter key to set
293 * @_value: Where appropriate, the parameter value to set
294 * @aux: Additional information for the value
295 *
296 * This system call is used to set parameters on a context, including
297 * superblock settings, data source and security labelling.
298 *
299 * Actions include triggering the creation of a superblock and the
300 * reconfiguration of the superblock attached to the specified context.
301 *
302 * When setting a parameter, @cmd indicates the type of value being proposed
303 * and @_key indicates the parameter to be altered.
304 *
305 * @_value and @aux are used to specify the value, should a value be required:
306 *
307 * (*) fsconfig_set_flag: No value is specified. The parameter must be boolean
308 * in nature. The key may be prefixed with "no" to invert the
309 * setting. @_value must be NULL and @aux must be 0.
310 *
311 * (*) fsconfig_set_string: A string value is specified. The parameter can be
312 * expecting boolean, integer, string or take a path. A conversion to an
313 * appropriate type will be attempted (which may include looking up as a
314 * path). @_value points to a NUL-terminated string and @aux must be 0.
315 *
316 * (*) fsconfig_set_binary: A binary blob is specified. @_value points to the
317 * blob and @aux indicates its size. The parameter must be expecting a
318 * blob.
319 *
320 * (*) fsconfig_set_path: A non-empty path is specified. The parameter must be
321 * expecting a path object. @_value points to a NUL-terminated string that
322 * is the path and @aux is a file descriptor at which to start a relative
323 * lookup or AT_FDCWD.
324 *
325 * (*) fsconfig_set_path_empty: As fsconfig_set_path, but with AT_EMPTY_PATH
326 * implied.
327 *
328 * (*) fsconfig_set_fd: An open file descriptor is specified. @_value must be
329 * NULL and @aux indicates the file descriptor.
330 */
331SYSCALL_DEFINE5(fsconfig,
332 int, fd,
333 unsigned int, cmd,
334 const char __user *, _key,
335 const void __user *, _value,
336 int, aux)
337{
338 struct fs_context *fc;
339 struct fd f;
340 int ret;
aa1918f9 341 int lookup_flags = 0;
ecdab150
DH
342
343 struct fs_parameter param = {
344 .type = fs_value_is_undefined,
345 };
346
347 if (fd < 0)
348 return -EINVAL;
349
350 switch (cmd) {
351 case FSCONFIG_SET_FLAG:
352 if (!_key || _value || aux)
353 return -EINVAL;
354 break;
355 case FSCONFIG_SET_STRING:
356 if (!_key || !_value || aux)
357 return -EINVAL;
358 break;
359 case FSCONFIG_SET_BINARY:
360 if (!_key || !_value || aux <= 0 || aux > 1024 * 1024)
361 return -EINVAL;
362 break;
363 case FSCONFIG_SET_PATH:
364 case FSCONFIG_SET_PATH_EMPTY:
365 if (!_key || !_value || (aux != AT_FDCWD && aux < 0))
366 return -EINVAL;
367 break;
368 case FSCONFIG_SET_FD:
369 if (!_key || _value || aux < 0)
370 return -EINVAL;
371 break;
372 case FSCONFIG_CMD_CREATE:
373 case FSCONFIG_CMD_RECONFIGURE:
374 if (_key || _value || aux)
375 return -EINVAL;
376 break;
377 default:
378 return -EOPNOTSUPP;
379 }
380
381 f = fdget(fd);
382 if (!f.file)
383 return -EBADF;
384 ret = -EINVAL;
385 if (f.file->f_op != &fscontext_fops)
386 goto out_f;
387
388 fc = f.file->private_data;
389 if (fc->ops == &legacy_fs_context_ops) {
390 switch (cmd) {
391 case FSCONFIG_SET_BINARY:
392 case FSCONFIG_SET_PATH:
393 case FSCONFIG_SET_PATH_EMPTY:
394 case FSCONFIG_SET_FD:
395 ret = -EOPNOTSUPP;
396 goto out_f;
397 }
398 }
399
400 if (_key) {
401 param.key = strndup_user(_key, 256);
402 if (IS_ERR(param.key)) {
403 ret = PTR_ERR(param.key);
404 goto out_f;
405 }
406 }
407
408 switch (cmd) {
409 case FSCONFIG_SET_FLAG:
410 param.type = fs_value_is_flag;
411 break;
412 case FSCONFIG_SET_STRING:
413 param.type = fs_value_is_string;
414 param.string = strndup_user(_value, 256);
415 if (IS_ERR(param.string)) {
416 ret = PTR_ERR(param.string);
417 goto out_key;
418 }
419 param.size = strlen(param.string);
420 break;
421 case FSCONFIG_SET_BINARY:
422 param.type = fs_value_is_blob;
423 param.size = aux;
424 param.blob = memdup_user_nul(_value, aux);
425 if (IS_ERR(param.blob)) {
426 ret = PTR_ERR(param.blob);
427 goto out_key;
428 }
429 break;
aa1918f9
AV
430 case FSCONFIG_SET_PATH_EMPTY:
431 lookup_flags = LOOKUP_EMPTY;
df561f66 432 fallthrough;
ecdab150
DH
433 case FSCONFIG_SET_PATH:
434 param.type = fs_value_is_filename;
aa1918f9 435 param.name = getname_flags(_value, lookup_flags, NULL);
ecdab150
DH
436 if (IS_ERR(param.name)) {
437 ret = PTR_ERR(param.name);
438 goto out_key;
439 }
440 param.dirfd = aux;
441 param.size = strlen(param.name->name);
442 break;
443 case FSCONFIG_SET_FD:
444 param.type = fs_value_is_file;
445 ret = -EBADF;
446 param.file = fget(aux);
447 if (!param.file)
448 goto out_key;
449 break;
450 default:
451 break;
452 }
453
454 ret = mutex_lock_interruptible(&fc->uapi_mutex);
455 if (ret == 0) {
456 ret = vfs_fsconfig_locked(fc, cmd, &param);
457 mutex_unlock(&fc->uapi_mutex);
458 }
459
460 /* Clean up the our record of any value that we obtained from
461 * userspace. Note that the value may have been stolen by the LSM or
462 * filesystem, in which case the value pointer will have been cleared.
463 */
464 switch (cmd) {
465 case FSCONFIG_SET_STRING:
466 case FSCONFIG_SET_BINARY:
467 kfree(param.string);
468 break;
469 case FSCONFIG_SET_PATH:
470 case FSCONFIG_SET_PATH_EMPTY:
471 if (param.name)
472 putname(param.name);
473 break;
474 case FSCONFIG_SET_FD:
475 if (param.file)
476 fput(param.file);
477 break;
478 default:
479 break;
480 }
481out_key:
482 kfree(param.key);
483out_f:
484 fdput(f);
485 return ret;
486}