xref: /openbmc/linux/fs/smb/client/ioctl.c (revision e9b7b8b3)
1 // SPDX-License-Identifier: LGPL-2.1
2 /*
3  *
4  *   vfs operations that deal with io control
5  *
6  *   Copyright (C) International Business Machines  Corp., 2005,2013
7  *   Author(s): Steve French (sfrench@us.ibm.com)
8  *
9  */
10 
11 #include <linux/fs.h>
12 #include <linux/file.h>
13 #include <linux/mount.h>
14 #include <linux/mm.h>
15 #include <linux/pagemap.h>
16 #include "cifspdu.h"
17 #include "cifsglob.h"
18 #include "cifsproto.h"
19 #include "cifs_debug.h"
20 #include "cifsfs.h"
21 #include "cifs_ioctl.h"
22 #include "smb2proto.h"
23 #include "smb2glob.h"
24 #include <linux/btrfs.h>
25 
26 static long cifs_ioctl_query_info(unsigned int xid, struct file *filep,
27 				  unsigned long p)
28 {
29 	struct inode *inode = file_inode(filep);
30 	struct cifs_sb_info *cifs_sb = CIFS_SB(inode->i_sb);
31 	struct cifs_tcon *tcon = cifs_sb_master_tcon(cifs_sb);
32 	struct dentry *dentry = filep->f_path.dentry;
33 	const unsigned char *path;
34 	void *page = alloc_dentry_path();
35 	__le16 *utf16_path = NULL, root_path;
36 	int rc = 0;
37 
38 	path = build_path_from_dentry(dentry, page);
39 	if (IS_ERR(path)) {
40 		free_dentry_path(page);
41 		return PTR_ERR(path);
42 	}
43 
44 	cifs_dbg(FYI, "%s %s\n", __func__, path);
45 
46 	if (!path[0]) {
47 		root_path = 0;
48 		utf16_path = &root_path;
49 	} else {
50 		utf16_path = cifs_convert_path_to_utf16(path + 1, cifs_sb);
51 		if (!utf16_path) {
52 			rc = -ENOMEM;
53 			goto ici_exit;
54 		}
55 	}
56 
57 	if (tcon->ses->server->ops->ioctl_query_info)
58 		rc = tcon->ses->server->ops->ioctl_query_info(
59 				xid, tcon, cifs_sb, utf16_path,
60 				filep->private_data ? 0 : 1, p);
61 	else
62 		rc = -EOPNOTSUPP;
63 
64  ici_exit:
65 	if (utf16_path != &root_path)
66 		kfree(utf16_path);
67 	free_dentry_path(page);
68 	return rc;
69 }
70 
71 static long cifs_ioctl_copychunk(unsigned int xid, struct file *dst_file,
72 			unsigned long srcfd)
73 {
74 	int rc;
75 	struct fd src_file;
76 	struct inode *src_inode;
77 
78 	cifs_dbg(FYI, "ioctl copychunk range\n");
79 	/* the destination must be opened for writing */
80 	if (!(dst_file->f_mode & FMODE_WRITE)) {
81 		cifs_dbg(FYI, "file target not open for write\n");
82 		return -EINVAL;
83 	}
84 
85 	/* check if target volume is readonly and take reference */
86 	rc = mnt_want_write_file(dst_file);
87 	if (rc) {
88 		cifs_dbg(FYI, "mnt_want_write failed with rc %d\n", rc);
89 		return rc;
90 	}
91 
92 	src_file = fdget(srcfd);
93 	if (!src_file.file) {
94 		rc = -EBADF;
95 		goto out_drop_write;
96 	}
97 
98 	if (src_file.file->f_op->unlocked_ioctl != cifs_ioctl) {
99 		rc = -EBADF;
100 		cifs_dbg(VFS, "src file seems to be from a different filesystem type\n");
101 		goto out_fput;
102 	}
103 
104 	src_inode = file_inode(src_file.file);
105 	rc = -EINVAL;
106 	if (S_ISDIR(src_inode->i_mode))
107 		goto out_fput;
108 
109 	rc = cifs_file_copychunk_range(xid, src_file.file, 0, dst_file, 0,
110 					src_inode->i_size, 0);
111 	if (rc > 0)
112 		rc = 0;
113 out_fput:
114 	fdput(src_file);
115 out_drop_write:
116 	mnt_drop_write_file(dst_file);
117 	return rc;
118 }
119 
120 static long smb_mnt_get_tcon_info(struct cifs_tcon *tcon, void __user *arg)
121 {
122 	int rc = 0;
123 	struct smb_mnt_tcon_info tcon_inf;
124 
125 	tcon_inf.tid = tcon->tid;
126 	tcon_inf.session_id = tcon->ses->Suid;
127 
128 	if (copy_to_user(arg, &tcon_inf, sizeof(struct smb_mnt_tcon_info)))
129 		rc = -EFAULT;
130 
131 	return rc;
132 }
133 
134 static long smb_mnt_get_fsinfo(unsigned int xid, struct cifs_tcon *tcon,
135 				void __user *arg)
136 {
137 	int rc = 0;
138 	struct smb_mnt_fs_info *fsinf;
139 
140 	fsinf = kzalloc(sizeof(struct smb_mnt_fs_info), GFP_KERNEL);
141 	if (fsinf == NULL)
142 		return -ENOMEM;
143 
144 	fsinf->version = 1;
145 	fsinf->protocol_id = tcon->ses->server->vals->protocol_id;
146 	fsinf->device_characteristics =
147 			le32_to_cpu(tcon->fsDevInfo.DeviceCharacteristics);
148 	fsinf->device_type = le32_to_cpu(tcon->fsDevInfo.DeviceType);
149 	fsinf->fs_attributes = le32_to_cpu(tcon->fsAttrInfo.Attributes);
150 	fsinf->max_path_component =
151 		le32_to_cpu(tcon->fsAttrInfo.MaxPathNameComponentLength);
152 	fsinf->vol_serial_number = tcon->vol_serial_number;
153 	fsinf->vol_create_time = le64_to_cpu(tcon->vol_create_time);
154 	fsinf->share_flags = tcon->share_flags;
155 	fsinf->share_caps = le32_to_cpu(tcon->capabilities);
156 	fsinf->sector_flags = tcon->ss_flags;
157 	fsinf->optimal_sector_size = tcon->perf_sector_size;
158 	fsinf->max_bytes_chunk = tcon->max_bytes_chunk;
159 	fsinf->maximal_access = tcon->maximal_access;
160 	fsinf->cifs_posix_caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
161 
162 	if (copy_to_user(arg, fsinf, sizeof(struct smb_mnt_fs_info)))
163 		rc = -EFAULT;
164 
165 	kfree(fsinf);
166 	return rc;
167 }
168 
169 static int cifs_shutdown(struct super_block *sb, unsigned long arg)
170 {
171 	struct cifs_sb_info *sbi = CIFS_SB(sb);
172 	__u32 flags;
173 
174 	if (!capable(CAP_SYS_ADMIN))
175 		return -EPERM;
176 
177 	if (get_user(flags, (__u32 __user *)arg))
178 		return -EFAULT;
179 
180 	if (flags > CIFS_GOING_FLAGS_NOLOGFLUSH)
181 		return -EINVAL;
182 
183 	if (cifs_forced_shutdown(sbi))
184 		return 0;
185 
186 	cifs_dbg(VFS, "shut down requested (%d)", flags);
187 /*	trace_cifs_shutdown(sb, flags);*/
188 
189 	/*
190 	 * see:
191 	 *   https://man7.org/linux/man-pages/man2/ioctl_xfs_goingdown.2.html
192 	 * for more information and description of original intent of the flags
193 	 */
194 	switch (flags) {
195 	/*
196 	 * We could add support later for default flag which requires:
197 	 *     "Flush all dirty data and metadata to disk"
198 	 * would need to call syncfs or equivalent to flush page cache for
199 	 * the mount and then issue fsync to server (if nostrictsync not set)
200 	 */
201 	case CIFS_GOING_FLAGS_DEFAULT:
202 		cifs_dbg(FYI, "shutdown with default flag not supported\n");
203 		return -EINVAL;
204 	/*
205 	 * FLAGS_LOGFLUSH is easy since it asks to write out metadata (not
206 	 * data) but metadata writes are not cached on the client, so can treat
207 	 * it similarly to NOLOGFLUSH
208 	 */
209 	case CIFS_GOING_FLAGS_LOGFLUSH:
210 	case CIFS_GOING_FLAGS_NOLOGFLUSH:
211 		sbi->mnt_cifs_flags |= CIFS_MOUNT_SHUTDOWN;
212 		return 0;
213 	default:
214 		return -EINVAL;
215 	}
216 	return 0;
217 }
218 
219 static int cifs_dump_full_key(struct cifs_tcon *tcon, struct smb3_full_key_debug_info __user *in)
220 {
221 	struct smb3_full_key_debug_info out;
222 	struct cifs_ses *ses;
223 	int rc = 0;
224 	bool found = false;
225 	u8 __user *end;
226 
227 	if (!smb3_encryption_required(tcon)) {
228 		rc = -EOPNOTSUPP;
229 		goto out;
230 	}
231 
232 	/* copy user input into our output buffer */
233 	if (copy_from_user(&out, in, sizeof(out))) {
234 		rc = -EINVAL;
235 		goto out;
236 	}
237 
238 	if (!out.session_id) {
239 		/* if ses id is 0, use current user session */
240 		ses = tcon->ses;
241 	} else {
242 		/* otherwise if a session id is given, look for it in all our sessions */
243 		struct cifs_ses *ses_it = NULL;
244 		struct TCP_Server_Info *server_it = NULL;
245 
246 		spin_lock(&cifs_tcp_ses_lock);
247 		list_for_each_entry(server_it, &cifs_tcp_ses_list, tcp_ses_list) {
248 			list_for_each_entry(ses_it, &server_it->smb_ses_list, smb_ses_list) {
249 				if (ses_it->Suid == out.session_id) {
250 					ses = ses_it;
251 					/*
252 					 * since we are using the session outside the crit
253 					 * section, we need to make sure it won't be released
254 					 * so increment its refcount
255 					 */
256 					cifs_smb_ses_inc_refcount(ses);
257 					found = true;
258 					goto search_end;
259 				}
260 			}
261 		}
262 search_end:
263 		spin_unlock(&cifs_tcp_ses_lock);
264 		if (!found) {
265 			rc = -ENOENT;
266 			goto out;
267 		}
268 	}
269 
270 	switch (ses->server->cipher_type) {
271 	case SMB2_ENCRYPTION_AES128_CCM:
272 	case SMB2_ENCRYPTION_AES128_GCM:
273 		out.session_key_length = CIFS_SESS_KEY_SIZE;
274 		out.server_in_key_length = out.server_out_key_length = SMB3_GCM128_CRYPTKEY_SIZE;
275 		break;
276 	case SMB2_ENCRYPTION_AES256_CCM:
277 	case SMB2_ENCRYPTION_AES256_GCM:
278 		out.session_key_length = CIFS_SESS_KEY_SIZE;
279 		out.server_in_key_length = out.server_out_key_length = SMB3_GCM256_CRYPTKEY_SIZE;
280 		break;
281 	default:
282 		rc = -EOPNOTSUPP;
283 		goto out;
284 	}
285 
286 	/* check if user buffer is big enough to store all the keys */
287 	if (out.in_size < sizeof(out) + out.session_key_length + out.server_in_key_length
288 	    + out.server_out_key_length) {
289 		rc = -ENOBUFS;
290 		goto out;
291 	}
292 
293 	out.session_id = ses->Suid;
294 	out.cipher_type = le16_to_cpu(ses->server->cipher_type);
295 
296 	/* overwrite user input with our output */
297 	if (copy_to_user(in, &out, sizeof(out))) {
298 		rc = -EINVAL;
299 		goto out;
300 	}
301 
302 	/* append all the keys at the end of the user buffer */
303 	end = in->data;
304 	if (copy_to_user(end, ses->auth_key.response, out.session_key_length)) {
305 		rc = -EINVAL;
306 		goto out;
307 	}
308 	end += out.session_key_length;
309 
310 	if (copy_to_user(end, ses->smb3encryptionkey, out.server_in_key_length)) {
311 		rc = -EINVAL;
312 		goto out;
313 	}
314 	end += out.server_in_key_length;
315 
316 	if (copy_to_user(end, ses->smb3decryptionkey, out.server_out_key_length)) {
317 		rc = -EINVAL;
318 		goto out;
319 	}
320 
321 out:
322 	if (found)
323 		cifs_put_smb_ses(ses);
324 	return rc;
325 }
326 
327 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg)
328 {
329 	struct inode *inode = file_inode(filep);
330 	struct smb3_key_debug_info pkey_inf;
331 	int rc = -ENOTTY; /* strange error - but the precedent */
332 	unsigned int xid;
333 	struct cifsFileInfo *pSMBFile = filep->private_data;
334 	struct cifs_tcon *tcon;
335 	struct tcon_link *tlink;
336 	struct cifs_sb_info *cifs_sb;
337 	__u64	ExtAttrBits = 0;
338 #ifdef CONFIG_CIFS_POSIX
339 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
340 	__u64   caps;
341 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
342 #endif /* CONFIG_CIFS_POSIX */
343 
344 	xid = get_xid();
345 
346 	cifs_dbg(FYI, "cifs ioctl 0x%x\n", command);
347 	switch (command) {
348 		case FS_IOC_GETFLAGS:
349 			if (pSMBFile == NULL)
350 				break;
351 			tcon = tlink_tcon(pSMBFile->tlink);
352 #ifdef CONFIG_CIFS_POSIX
353 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
354 			caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
355 			if (CIFS_UNIX_EXTATTR_CAP & caps) {
356 				__u64	ExtAttrMask = 0;
357 				rc = CIFSGetExtAttr(xid, tcon,
358 						    pSMBFile->fid.netfid,
359 						    &ExtAttrBits, &ExtAttrMask);
360 				if (rc == 0)
361 					rc = put_user(ExtAttrBits &
362 						FS_FL_USER_VISIBLE,
363 						(int __user *)arg);
364 				if (rc != -EOPNOTSUPP)
365 					break;
366 			}
367 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
368 #endif /* CONFIG_CIFS_POSIX */
369 			rc = 0;
370 			if (CIFS_I(inode)->cifsAttrs & ATTR_COMPRESSED) {
371 				/* add in the compressed bit */
372 				ExtAttrBits = FS_COMPR_FL;
373 				rc = put_user(ExtAttrBits & FS_FL_USER_VISIBLE,
374 					      (int __user *)arg);
375 			}
376 			break;
377 		case FS_IOC_SETFLAGS:
378 			if (pSMBFile == NULL)
379 				break;
380 			tcon = tlink_tcon(pSMBFile->tlink);
381 			/* caps = le64_to_cpu(tcon->fsUnixInfo.Capability); */
382 
383 			if (get_user(ExtAttrBits, (int __user *)arg)) {
384 				rc = -EFAULT;
385 				break;
386 			}
387 
388 			/*
389 			 * if (CIFS_UNIX_EXTATTR_CAP & caps)
390 			 *	rc = CIFSSetExtAttr(xid, tcon,
391 			 *		       pSMBFile->fid.netfid,
392 			 *		       extAttrBits,
393 			 *		       &ExtAttrMask);
394 			 * if (rc != -EOPNOTSUPP)
395 			 *	break;
396 			 */
397 
398 			/* Currently only flag we can set is compressed flag */
399 			if ((ExtAttrBits & FS_COMPR_FL) == 0)
400 				break;
401 
402 			/* Try to set compress flag */
403 			if (tcon->ses->server->ops->set_compression) {
404 				rc = tcon->ses->server->ops->set_compression(
405 							xid, tcon, pSMBFile);
406 				cifs_dbg(FYI, "set compress flag rc %d\n", rc);
407 			}
408 			break;
409 		case CIFS_IOC_COPYCHUNK_FILE:
410 			rc = cifs_ioctl_copychunk(xid, filep, arg);
411 			break;
412 		case CIFS_QUERY_INFO:
413 			rc = cifs_ioctl_query_info(xid, filep, arg);
414 			break;
415 		case CIFS_IOC_SET_INTEGRITY:
416 			if (pSMBFile == NULL)
417 				break;
418 			tcon = tlink_tcon(pSMBFile->tlink);
419 			if (tcon->ses->server->ops->set_integrity)
420 				rc = tcon->ses->server->ops->set_integrity(xid,
421 						tcon, pSMBFile);
422 			else
423 				rc = -EOPNOTSUPP;
424 			break;
425 		case CIFS_IOC_GET_MNT_INFO:
426 			if (pSMBFile == NULL)
427 				break;
428 			tcon = tlink_tcon(pSMBFile->tlink);
429 			rc = smb_mnt_get_fsinfo(xid, tcon, (void __user *)arg);
430 			break;
431 		case CIFS_IOC_GET_TCON_INFO:
432 			cifs_sb = CIFS_SB(inode->i_sb);
433 			tlink = cifs_sb_tlink(cifs_sb);
434 			if (IS_ERR(tlink)) {
435 				rc = PTR_ERR(tlink);
436 				break;
437 			}
438 			tcon = tlink_tcon(tlink);
439 			rc = smb_mnt_get_tcon_info(tcon, (void __user *)arg);
440 			cifs_put_tlink(tlink);
441 			break;
442 		case CIFS_ENUMERATE_SNAPSHOTS:
443 			if (pSMBFile == NULL)
444 				break;
445 			if (arg == 0) {
446 				rc = -EINVAL;
447 				goto cifs_ioc_exit;
448 			}
449 			tcon = tlink_tcon(pSMBFile->tlink);
450 			if (tcon->ses->server->ops->enum_snapshots)
451 				rc = tcon->ses->server->ops->enum_snapshots(xid, tcon,
452 						pSMBFile, (void __user *)arg);
453 			else
454 				rc = -EOPNOTSUPP;
455 			break;
456 		case CIFS_DUMP_KEY:
457 			/*
458 			 * Dump encryption keys. This is an old ioctl that only
459 			 * handles AES-128-{CCM,GCM}.
460 			 */
461 			if (!capable(CAP_SYS_ADMIN)) {
462 				rc = -EACCES;
463 				break;
464 			}
465 
466 			cifs_sb = CIFS_SB(inode->i_sb);
467 			tlink = cifs_sb_tlink(cifs_sb);
468 			if (IS_ERR(tlink)) {
469 				rc = PTR_ERR(tlink);
470 				break;
471 			}
472 			tcon = tlink_tcon(tlink);
473 			if (!smb3_encryption_required(tcon)) {
474 				rc = -EOPNOTSUPP;
475 				cifs_put_tlink(tlink);
476 				break;
477 			}
478 			pkey_inf.cipher_type =
479 				le16_to_cpu(tcon->ses->server->cipher_type);
480 			pkey_inf.Suid = tcon->ses->Suid;
481 			memcpy(pkey_inf.auth_key, tcon->ses->auth_key.response,
482 					16 /* SMB2_NTLMV2_SESSKEY_SIZE */);
483 			memcpy(pkey_inf.smb3decryptionkey,
484 			      tcon->ses->smb3decryptionkey, SMB3_SIGN_KEY_SIZE);
485 			memcpy(pkey_inf.smb3encryptionkey,
486 			      tcon->ses->smb3encryptionkey, SMB3_SIGN_KEY_SIZE);
487 			if (copy_to_user((void __user *)arg, &pkey_inf,
488 					sizeof(struct smb3_key_debug_info)))
489 				rc = -EFAULT;
490 			else
491 				rc = 0;
492 			cifs_put_tlink(tlink);
493 			break;
494 		case CIFS_DUMP_FULL_KEY:
495 			/*
496 			 * Dump encryption keys (handles any key sizes)
497 			 */
498 			if (pSMBFile == NULL)
499 				break;
500 			if (!capable(CAP_SYS_ADMIN)) {
501 				rc = -EACCES;
502 				break;
503 			}
504 			cifs_sb = CIFS_SB(inode->i_sb);
505 			tlink = cifs_sb_tlink(cifs_sb);
506 			if (IS_ERR(tlink)) {
507 				rc = PTR_ERR(tlink);
508 				break;
509 			}
510 
511 			tcon = tlink_tcon(tlink);
512 			rc = cifs_dump_full_key(tcon, (void __user *)arg);
513 			cifs_put_tlink(tlink);
514 			break;
515 		case CIFS_IOC_NOTIFY:
516 			if (!S_ISDIR(inode->i_mode)) {
517 				/* Notify can only be done on directories */
518 				rc = -EOPNOTSUPP;
519 				break;
520 			}
521 			cifs_sb = CIFS_SB(inode->i_sb);
522 			tlink = cifs_sb_tlink(cifs_sb);
523 			if (IS_ERR(tlink)) {
524 				rc = PTR_ERR(tlink);
525 				break;
526 			}
527 			tcon = tlink_tcon(tlink);
528 			if (tcon && tcon->ses->server->ops->notify) {
529 				rc = tcon->ses->server->ops->notify(xid,
530 						filep, (void __user *)arg,
531 						false /* no ret data */);
532 				cifs_dbg(FYI, "ioctl notify rc %d\n", rc);
533 			} else
534 				rc = -EOPNOTSUPP;
535 			cifs_put_tlink(tlink);
536 			break;
537 		case CIFS_IOC_NOTIFY_INFO:
538 			if (!S_ISDIR(inode->i_mode)) {
539 				/* Notify can only be done on directories */
540 				rc = -EOPNOTSUPP;
541 				break;
542 			}
543 			cifs_sb = CIFS_SB(inode->i_sb);
544 			tlink = cifs_sb_tlink(cifs_sb);
545 			if (IS_ERR(tlink)) {
546 				rc = PTR_ERR(tlink);
547 				break;
548 			}
549 			tcon = tlink_tcon(tlink);
550 			if (tcon && tcon->ses->server->ops->notify) {
551 				rc = tcon->ses->server->ops->notify(xid,
552 						filep, (void __user *)arg,
553 						true /* return details */);
554 				cifs_dbg(FYI, "ioctl notify info rc %d\n", rc);
555 			} else
556 				rc = -EOPNOTSUPP;
557 			cifs_put_tlink(tlink);
558 			break;
559 		case CIFS_IOC_SHUTDOWN:
560 			rc = cifs_shutdown(inode->i_sb, arg);
561 			break;
562 		default:
563 			cifs_dbg(FYI, "unsupported ioctl\n");
564 			break;
565 	}
566 cifs_ioc_exit:
567 	free_xid(xid);
568 	return rc;
569 }
570