xref: /linux/fs/smb/client/ioctl.c (revision 6a87e0f0ce1ae8d70566935215430e718ea776ff)
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_fsinfo(unsigned int xid, struct cifs_tcon *tcon,
121 				void __user *arg)
122 {
123 	int rc = 0;
124 	struct smb_mnt_fs_info *fsinf;
125 
126 	fsinf = kzalloc(sizeof(struct smb_mnt_fs_info), GFP_KERNEL);
127 	if (fsinf == NULL)
128 		return -ENOMEM;
129 
130 	fsinf->version = 1;
131 	fsinf->protocol_id = tcon->ses->server->vals->protocol_id;
132 	fsinf->device_characteristics =
133 			le32_to_cpu(tcon->fsDevInfo.DeviceCharacteristics);
134 	fsinf->device_type = le32_to_cpu(tcon->fsDevInfo.DeviceType);
135 	fsinf->fs_attributes = le32_to_cpu(tcon->fsAttrInfo.Attributes);
136 	fsinf->max_path_component =
137 		le32_to_cpu(tcon->fsAttrInfo.MaxPathNameComponentLength);
138 	fsinf->vol_serial_number = tcon->vol_serial_number;
139 	fsinf->vol_create_time = le64_to_cpu(tcon->vol_create_time);
140 	fsinf->share_flags = tcon->share_flags;
141 	fsinf->share_caps = le32_to_cpu(tcon->capabilities);
142 	fsinf->sector_flags = tcon->ss_flags;
143 	fsinf->optimal_sector_size = tcon->perf_sector_size;
144 	fsinf->max_bytes_chunk = tcon->max_bytes_chunk;
145 	fsinf->maximal_access = tcon->maximal_access;
146 	fsinf->cifs_posix_caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
147 
148 	if (copy_to_user(arg, fsinf, sizeof(struct smb_mnt_fs_info)))
149 		rc = -EFAULT;
150 
151 	kfree(fsinf);
152 	return rc;
153 }
154 
155 static int cifs_shutdown(struct super_block *sb, unsigned long arg)
156 {
157 	struct cifs_sb_info *sbi = CIFS_SB(sb);
158 	__u32 flags;
159 
160 	if (!capable(CAP_SYS_ADMIN))
161 		return -EPERM;
162 
163 	if (get_user(flags, (__u32 __user *)arg))
164 		return -EFAULT;
165 
166 	if (flags > CIFS_GOING_FLAGS_NOLOGFLUSH)
167 		return -EINVAL;
168 
169 	if (cifs_forced_shutdown(sbi))
170 		return 0;
171 
172 	cifs_dbg(VFS, "shut down requested (%d)", flags);
173 /*	trace_cifs_shutdown(sb, flags);*/
174 
175 	/*
176 	 * see:
177 	 *   https://man7.org/linux/man-pages/man2/ioctl_xfs_goingdown.2.html
178 	 * for more information and description of original intent of the flags
179 	 */
180 	switch (flags) {
181 	/*
182 	 * We could add support later for default flag which requires:
183 	 *     "Flush all dirty data and metadata to disk"
184 	 * would need to call syncfs or equivalent to flush page cache for
185 	 * the mount and then issue fsync to server (if nostrictsync not set)
186 	 */
187 	case CIFS_GOING_FLAGS_DEFAULT:
188 		cifs_dbg(FYI, "shutdown with default flag not supported\n");
189 		return -EINVAL;
190 	/*
191 	 * FLAGS_LOGFLUSH is easy since it asks to write out metadata (not
192 	 * data) but metadata writes are not cached on the client, so can treat
193 	 * it similarly to NOLOGFLUSH
194 	 */
195 	case CIFS_GOING_FLAGS_LOGFLUSH:
196 	case CIFS_GOING_FLAGS_NOLOGFLUSH:
197 		sbi->mnt_cifs_flags |= CIFS_MOUNT_SHUTDOWN;
198 		return 0;
199 	default:
200 		return -EINVAL;
201 	}
202 	return 0;
203 }
204 
205 static int cifs_dump_full_key(struct cifs_tcon *tcon, struct smb3_full_key_debug_info __user *in)
206 {
207 	struct smb3_full_key_debug_info out;
208 	struct cifs_ses *ses;
209 	int rc = 0;
210 	bool found = false;
211 	u8 __user *end;
212 
213 	if (!smb3_encryption_required(tcon)) {
214 		rc = -EOPNOTSUPP;
215 		goto out;
216 	}
217 
218 	/* copy user input into our output buffer */
219 	if (copy_from_user(&out, in, sizeof(out))) {
220 		rc = -EINVAL;
221 		goto out;
222 	}
223 
224 	if (!out.session_id) {
225 		/* if ses id is 0, use current user session */
226 		ses = tcon->ses;
227 	} else {
228 		/* otherwise if a session id is given, look for it in all our sessions */
229 		struct cifs_ses *ses_it = NULL;
230 		struct TCP_Server_Info *server_it = NULL;
231 
232 		spin_lock(&cifs_tcp_ses_lock);
233 		list_for_each_entry(server_it, &cifs_tcp_ses_list, tcp_ses_list) {
234 			list_for_each_entry(ses_it, &server_it->smb_ses_list, smb_ses_list) {
235 				if (ses_it->Suid == out.session_id) {
236 					ses = ses_it;
237 					/*
238 					 * since we are using the session outside the crit
239 					 * section, we need to make sure it won't be released
240 					 * so increment its refcount
241 					 */
242 					cifs_smb_ses_inc_refcount(ses);
243 					found = true;
244 					goto search_end;
245 				}
246 			}
247 		}
248 search_end:
249 		spin_unlock(&cifs_tcp_ses_lock);
250 		if (!found) {
251 			rc = -ENOENT;
252 			goto out;
253 		}
254 	}
255 
256 	switch (ses->server->cipher_type) {
257 	case SMB2_ENCRYPTION_AES128_CCM:
258 	case SMB2_ENCRYPTION_AES128_GCM:
259 		out.session_key_length = CIFS_SESS_KEY_SIZE;
260 		out.server_in_key_length = out.server_out_key_length = SMB3_GCM128_CRYPTKEY_SIZE;
261 		break;
262 	case SMB2_ENCRYPTION_AES256_CCM:
263 	case SMB2_ENCRYPTION_AES256_GCM:
264 		out.session_key_length = CIFS_SESS_KEY_SIZE;
265 		out.server_in_key_length = out.server_out_key_length = SMB3_GCM256_CRYPTKEY_SIZE;
266 		break;
267 	default:
268 		rc = -EOPNOTSUPP;
269 		goto out;
270 	}
271 
272 	/* check if user buffer is big enough to store all the keys */
273 	if (out.in_size < sizeof(out) + out.session_key_length + out.server_in_key_length
274 	    + out.server_out_key_length) {
275 		rc = -ENOBUFS;
276 		goto out;
277 	}
278 
279 	out.session_id = ses->Suid;
280 	out.cipher_type = le16_to_cpu(ses->server->cipher_type);
281 
282 	/* overwrite user input with our output */
283 	if (copy_to_user(in, &out, sizeof(out))) {
284 		rc = -EINVAL;
285 		goto out;
286 	}
287 
288 	/* append all the keys at the end of the user buffer */
289 	end = in->data;
290 	if (copy_to_user(end, ses->auth_key.response, out.session_key_length)) {
291 		rc = -EINVAL;
292 		goto out;
293 	}
294 	end += out.session_key_length;
295 
296 	if (copy_to_user(end, ses->smb3encryptionkey, out.server_in_key_length)) {
297 		rc = -EINVAL;
298 		goto out;
299 	}
300 	end += out.server_in_key_length;
301 
302 	if (copy_to_user(end, ses->smb3decryptionkey, out.server_out_key_length)) {
303 		rc = -EINVAL;
304 		goto out;
305 	}
306 
307 out:
308 	if (found)
309 		cifs_put_smb_ses(ses);
310 	return rc;
311 }
312 
313 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg)
314 {
315 	struct inode *inode = file_inode(filep);
316 	struct smb3_key_debug_info pkey_inf;
317 	int rc = -ENOTTY; /* strange error - but the precedent */
318 	unsigned int xid;
319 	struct cifsFileInfo *pSMBFile = filep->private_data;
320 	struct cifs_tcon *tcon;
321 	struct tcon_link *tlink;
322 	struct cifs_sb_info *cifs_sb;
323 	__u64	ExtAttrBits = 0;
324 #ifdef CONFIG_CIFS_POSIX
325 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
326 	__u64   caps;
327 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
328 #endif /* CONFIG_CIFS_POSIX */
329 
330 	xid = get_xid();
331 
332 	cifs_dbg(FYI, "cifs ioctl 0x%x\n", command);
333 	switch (command) {
334 		case FS_IOC_GETFLAGS:
335 			if (pSMBFile == NULL)
336 				break;
337 			tcon = tlink_tcon(pSMBFile->tlink);
338 #ifdef CONFIG_CIFS_POSIX
339 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
340 			caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
341 			if (CIFS_UNIX_EXTATTR_CAP & caps) {
342 				__u64	ExtAttrMask = 0;
343 				rc = CIFSGetExtAttr(xid, tcon,
344 						    pSMBFile->fid.netfid,
345 						    &ExtAttrBits, &ExtAttrMask);
346 				if (rc == 0)
347 					rc = put_user(ExtAttrBits &
348 						FS_FL_USER_VISIBLE,
349 						(int __user *)arg);
350 				if (rc != -EOPNOTSUPP)
351 					break;
352 			}
353 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
354 #endif /* CONFIG_CIFS_POSIX */
355 			rc = 0;
356 			if (CIFS_I(inode)->cifsAttrs & ATTR_COMPRESSED) {
357 				/* add in the compressed bit */
358 				ExtAttrBits = FS_COMPR_FL;
359 				rc = put_user(ExtAttrBits & FS_FL_USER_VISIBLE,
360 					      (int __user *)arg);
361 			}
362 			break;
363 		case FS_IOC_SETFLAGS:
364 			if (pSMBFile == NULL)
365 				break;
366 			tcon = tlink_tcon(pSMBFile->tlink);
367 			/* caps = le64_to_cpu(tcon->fsUnixInfo.Capability); */
368 
369 			if (get_user(ExtAttrBits, (int __user *)arg)) {
370 				rc = -EFAULT;
371 				break;
372 			}
373 
374 			/*
375 			 * if (CIFS_UNIX_EXTATTR_CAP & caps)
376 			 *	rc = CIFSSetExtAttr(xid, tcon,
377 			 *		       pSMBFile->fid.netfid,
378 			 *		       extAttrBits,
379 			 *		       &ExtAttrMask);
380 			 * if (rc != -EOPNOTSUPP)
381 			 *	break;
382 			 */
383 
384 			/* Currently only flag we can set is compressed flag */
385 			if ((ExtAttrBits & FS_COMPR_FL) == 0)
386 				break;
387 
388 			/* Try to set compress flag */
389 			if (tcon->ses->server->ops->set_compression) {
390 				rc = tcon->ses->server->ops->set_compression(
391 							xid, tcon, pSMBFile);
392 				cifs_dbg(FYI, "set compress flag rc %d\n", rc);
393 			}
394 			break;
395 		case CIFS_IOC_COPYCHUNK_FILE:
396 			rc = cifs_ioctl_copychunk(xid, filep, arg);
397 			break;
398 		case CIFS_QUERY_INFO:
399 			rc = cifs_ioctl_query_info(xid, filep, arg);
400 			break;
401 		case CIFS_IOC_SET_INTEGRITY:
402 			if (pSMBFile == NULL)
403 				break;
404 			tcon = tlink_tcon(pSMBFile->tlink);
405 			if (tcon->ses->server->ops->set_integrity)
406 				rc = tcon->ses->server->ops->set_integrity(xid,
407 						tcon, pSMBFile);
408 			else
409 				rc = -EOPNOTSUPP;
410 			break;
411 		case CIFS_IOC_GET_MNT_INFO:
412 			if (pSMBFile == NULL)
413 				break;
414 			tcon = tlink_tcon(pSMBFile->tlink);
415 			rc = smb_mnt_get_fsinfo(xid, tcon, (void __user *)arg);
416 			break;
417 		case CIFS_ENUMERATE_SNAPSHOTS:
418 			if (pSMBFile == NULL)
419 				break;
420 			if (arg == 0) {
421 				rc = -EINVAL;
422 				goto cifs_ioc_exit;
423 			}
424 			tcon = tlink_tcon(pSMBFile->tlink);
425 			if (tcon->ses->server->ops->enum_snapshots)
426 				rc = tcon->ses->server->ops->enum_snapshots(xid, tcon,
427 						pSMBFile, (void __user *)arg);
428 			else
429 				rc = -EOPNOTSUPP;
430 			break;
431 		case CIFS_DUMP_KEY:
432 			/*
433 			 * Dump encryption keys. This is an old ioctl that only
434 			 * handles AES-128-{CCM,GCM}.
435 			 */
436 			if (!capable(CAP_SYS_ADMIN)) {
437 				rc = -EACCES;
438 				break;
439 			}
440 
441 			cifs_sb = CIFS_SB(inode->i_sb);
442 			tlink = cifs_sb_tlink(cifs_sb);
443 			if (IS_ERR(tlink)) {
444 				rc = PTR_ERR(tlink);
445 				break;
446 			}
447 			tcon = tlink_tcon(tlink);
448 			if (!smb3_encryption_required(tcon)) {
449 				rc = -EOPNOTSUPP;
450 				cifs_put_tlink(tlink);
451 				break;
452 			}
453 			pkey_inf.cipher_type =
454 				le16_to_cpu(tcon->ses->server->cipher_type);
455 			pkey_inf.Suid = tcon->ses->Suid;
456 			memcpy(pkey_inf.auth_key, tcon->ses->auth_key.response,
457 					16 /* SMB2_NTLMV2_SESSKEY_SIZE */);
458 			memcpy(pkey_inf.smb3decryptionkey,
459 			      tcon->ses->smb3decryptionkey, SMB3_SIGN_KEY_SIZE);
460 			memcpy(pkey_inf.smb3encryptionkey,
461 			      tcon->ses->smb3encryptionkey, SMB3_SIGN_KEY_SIZE);
462 			if (copy_to_user((void __user *)arg, &pkey_inf,
463 					sizeof(struct smb3_key_debug_info)))
464 				rc = -EFAULT;
465 			else
466 				rc = 0;
467 			cifs_put_tlink(tlink);
468 			break;
469 		case CIFS_DUMP_FULL_KEY:
470 			/*
471 			 * Dump encryption keys (handles any key sizes)
472 			 */
473 			if (pSMBFile == NULL)
474 				break;
475 			if (!capable(CAP_SYS_ADMIN)) {
476 				rc = -EACCES;
477 				break;
478 			}
479 			cifs_sb = CIFS_SB(inode->i_sb);
480 			tlink = cifs_sb_tlink(cifs_sb);
481 			if (IS_ERR(tlink)) {
482 				rc = PTR_ERR(tlink);
483 				break;
484 			}
485 
486 			tcon = tlink_tcon(tlink);
487 			rc = cifs_dump_full_key(tcon, (void __user *)arg);
488 			cifs_put_tlink(tlink);
489 			break;
490 		case CIFS_IOC_NOTIFY:
491 			if (!S_ISDIR(inode->i_mode)) {
492 				/* Notify can only be done on directories */
493 				rc = -EOPNOTSUPP;
494 				break;
495 			}
496 			cifs_sb = CIFS_SB(inode->i_sb);
497 			tlink = cifs_sb_tlink(cifs_sb);
498 			if (IS_ERR(tlink)) {
499 				rc = PTR_ERR(tlink);
500 				break;
501 			}
502 			tcon = tlink_tcon(tlink);
503 			if (tcon && tcon->ses->server->ops->notify) {
504 				rc = tcon->ses->server->ops->notify(xid,
505 						filep, (void __user *)arg,
506 						false /* no ret data */);
507 				cifs_dbg(FYI, "ioctl notify rc %d\n", rc);
508 			} else
509 				rc = -EOPNOTSUPP;
510 			cifs_put_tlink(tlink);
511 			break;
512 		case CIFS_IOC_NOTIFY_INFO:
513 			if (!S_ISDIR(inode->i_mode)) {
514 				/* Notify can only be done on directories */
515 				rc = -EOPNOTSUPP;
516 				break;
517 			}
518 			cifs_sb = CIFS_SB(inode->i_sb);
519 			tlink = cifs_sb_tlink(cifs_sb);
520 			if (IS_ERR(tlink)) {
521 				rc = PTR_ERR(tlink);
522 				break;
523 			}
524 			tcon = tlink_tcon(tlink);
525 			if (tcon && tcon->ses->server->ops->notify) {
526 				rc = tcon->ses->server->ops->notify(xid,
527 						filep, (void __user *)arg,
528 						true /* return details */);
529 				cifs_dbg(FYI, "ioctl notify info rc %d\n", rc);
530 			} else
531 				rc = -EOPNOTSUPP;
532 			cifs_put_tlink(tlink);
533 			break;
534 		case CIFS_IOC_SHUTDOWN:
535 			rc = cifs_shutdown(inode->i_sb, arg);
536 			break;
537 		default:
538 			cifs_dbg(FYI, "unsupported ioctl\n");
539 			break;
540 	}
541 cifs_ioc_exit:
542 	free_xid(xid);
543 	return rc;
544 }
545