1 // SPDX-License-Identifier: LGPL-2.1
4 * vfs operations that deal with io control
6 * Copyright (C) International Business Machines Corp., 2005,2013
7 * Author(s): Steve French (sfrench@us.ibm.com)
12 #include <linux/file.h>
13 #include <linux/mount.h>
15 #include <linux/pagemap.h>
18 #include "cifsproto.h"
19 #include "cifs_debug.h"
21 #include "cifs_ioctl.h"
22 #include "smb2proto.h"
24 #include <linux/btrfs.h>
26 static long cifs_ioctl_query_info(unsigned int xid, struct file *filep,
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;
38 path = build_path_from_dentry(dentry, page);
40 free_dentry_path(page);
44 cifs_dbg(FYI, "%s %s\n", __func__, path);
48 utf16_path = &root_path;
50 utf16_path = cifs_convert_path_to_utf16(path + 1, cifs_sb);
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);
65 if (utf16_path != &root_path)
67 free_dentry_path(page);
71 static long cifs_ioctl_copychunk(unsigned int xid, struct file *dst_file,
76 struct inode *src_inode;
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");
85 /* check if target volume is readonly and take reference */
86 rc = mnt_want_write_file(dst_file);
88 cifs_dbg(FYI, "mnt_want_write failed with rc %d\n", rc);
92 src_file = fdget(srcfd);
98 if (src_file.file->f_op->unlocked_ioctl != cifs_ioctl) {
100 cifs_dbg(VFS, "src file seems to be from a different filesystem type\n");
104 src_inode = file_inode(src_file.file);
106 if (S_ISDIR(src_inode->i_mode))
109 rc = cifs_file_copychunk_range(xid, src_file.file, 0, dst_file, 0,
110 src_inode->i_size, 0);
116 mnt_drop_write_file(dst_file);
120 static long smb_mnt_get_tcon_info(struct cifs_tcon *tcon, void __user *arg)
123 struct smb_mnt_tcon_info tcon_inf;
125 tcon_inf.tid = tcon->tid;
126 tcon_inf.session_id = tcon->ses->Suid;
128 if (copy_to_user(arg, &tcon_inf, sizeof(struct smb_mnt_tcon_info)))
134 static long smb_mnt_get_fsinfo(unsigned int xid, struct cifs_tcon *tcon,
138 struct smb_mnt_fs_info *fsinf;
140 fsinf = kzalloc(sizeof(struct smb_mnt_fs_info), GFP_KERNEL);
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);
162 if (copy_to_user(arg, fsinf, sizeof(struct smb_mnt_fs_info)))
169 static int cifs_shutdown(struct super_block *sb, unsigned long arg)
171 struct cifs_sb_info *sbi = CIFS_SB(sb);
174 if (!capable(CAP_SYS_ADMIN))
177 if (get_user(flags, (__u32 __user *)arg))
180 if (flags > CIFS_GOING_FLAGS_NOLOGFLUSH)
183 if (cifs_forced_shutdown(sbi))
186 cifs_dbg(VFS, "shut down requested (%d)", flags);
187 /* trace_cifs_shutdown(sb, flags);*/
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
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)
201 case CIFS_GOING_FLAGS_DEFAULT:
202 cifs_dbg(FYI, "shutdown with default flag not supported\n");
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
209 case CIFS_GOING_FLAGS_LOGFLUSH:
210 case CIFS_GOING_FLAGS_NOLOGFLUSH:
211 sbi->mnt_cifs_flags |= CIFS_MOUNT_SHUTDOWN;
219 static int cifs_dump_full_key(struct cifs_tcon *tcon, struct smb3_full_key_debug_info __user *in)
221 struct smb3_full_key_debug_info out;
222 struct cifs_ses *ses;
227 if (!smb3_encryption_required(tcon)) {
232 /* copy user input into our output buffer */
233 if (copy_from_user(&out, in, sizeof(out))) {
238 if (!out.session_id) {
239 /* if ses id is 0, use current user session */
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;
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) {
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
263 spin_unlock(&cifs_tcp_ses_lock);
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;
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;
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) {
293 out.session_id = ses->Suid;
294 out.cipher_type = le16_to_cpu(ses->server->cipher_type);
296 /* overwrite user input with our output */
297 if (copy_to_user(in, &out, sizeof(out))) {
302 /* append all the keys at the end of the user buffer */
304 if (copy_to_user(end, ses->auth_key.response, out.session_key_length)) {
308 end += out.session_key_length;
310 if (copy_to_user(end, ses->smb3encryptionkey, out.server_in_key_length)) {
314 end += out.server_in_key_length;
316 if (copy_to_user(end, ses->smb3decryptionkey, out.server_out_key_length)) {
323 cifs_put_smb_ses(ses);
327 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg)
329 struct inode *inode = file_inode(filep);
330 struct smb3_key_debug_info pkey_inf;
331 int rc = -ENOTTY; /* strange error - but the precedent */
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;
342 cifs_dbg(FYI, "cifs ioctl 0x%x\n", command);
344 case FS_IOC_GETFLAGS:
345 if (pSMBFile == NULL)
347 tcon = tlink_tcon(pSMBFile->tlink);
348 caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
349 #ifdef CONFIG_CIFS_POSIX
350 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
351 if (CIFS_UNIX_EXTATTR_CAP & caps) {
352 __u64 ExtAttrMask = 0;
353 rc = CIFSGetExtAttr(xid, tcon,
354 pSMBFile->fid.netfid,
355 &ExtAttrBits, &ExtAttrMask);
357 rc = put_user(ExtAttrBits &
360 if (rc != -EOPNOTSUPP)
363 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
364 #endif /* CONFIG_CIFS_POSIX */
366 if (CIFS_I(inode)->cifsAttrs & ATTR_COMPRESSED) {
367 /* add in the compressed bit */
368 ExtAttrBits = FS_COMPR_FL;
369 rc = put_user(ExtAttrBits & FS_FL_USER_VISIBLE,
373 case FS_IOC_SETFLAGS:
374 if (pSMBFile == NULL)
376 tcon = tlink_tcon(pSMBFile->tlink);
377 /* caps = le64_to_cpu(tcon->fsUnixInfo.Capability); */
379 if (get_user(ExtAttrBits, (int __user *)arg)) {
385 * if (CIFS_UNIX_EXTATTR_CAP & caps)
386 * rc = CIFSSetExtAttr(xid, tcon,
387 * pSMBFile->fid.netfid,
390 * if (rc != -EOPNOTSUPP)
394 /* Currently only flag we can set is compressed flag */
395 if ((ExtAttrBits & FS_COMPR_FL) == 0)
398 /* Try to set compress flag */
399 if (tcon->ses->server->ops->set_compression) {
400 rc = tcon->ses->server->ops->set_compression(
401 xid, tcon, pSMBFile);
402 cifs_dbg(FYI, "set compress flag rc %d\n", rc);
405 case CIFS_IOC_COPYCHUNK_FILE:
406 rc = cifs_ioctl_copychunk(xid, filep, arg);
408 case CIFS_QUERY_INFO:
409 rc = cifs_ioctl_query_info(xid, filep, arg);
411 case CIFS_IOC_SET_INTEGRITY:
412 if (pSMBFile == NULL)
414 tcon = tlink_tcon(pSMBFile->tlink);
415 if (tcon->ses->server->ops->set_integrity)
416 rc = tcon->ses->server->ops->set_integrity(xid,
421 case CIFS_IOC_GET_MNT_INFO:
422 if (pSMBFile == NULL)
424 tcon = tlink_tcon(pSMBFile->tlink);
425 rc = smb_mnt_get_fsinfo(xid, tcon, (void __user *)arg);
427 case CIFS_IOC_GET_TCON_INFO:
428 cifs_sb = CIFS_SB(inode->i_sb);
429 tlink = cifs_sb_tlink(cifs_sb);
434 tcon = tlink_tcon(tlink);
435 rc = smb_mnt_get_tcon_info(tcon, (void __user *)arg);
436 cifs_put_tlink(tlink);
438 case CIFS_ENUMERATE_SNAPSHOTS:
439 if (pSMBFile == NULL)
445 tcon = tlink_tcon(pSMBFile->tlink);
446 if (tcon->ses->server->ops->enum_snapshots)
447 rc = tcon->ses->server->ops->enum_snapshots(xid, tcon,
448 pSMBFile, (void __user *)arg);
454 * Dump encryption keys. This is an old ioctl that only
455 * handles AES-128-{CCM,GCM}.
457 if (pSMBFile == NULL)
459 if (!capable(CAP_SYS_ADMIN)) {
464 tcon = tlink_tcon(pSMBFile->tlink);
465 if (!smb3_encryption_required(tcon)) {
469 pkey_inf.cipher_type =
470 le16_to_cpu(tcon->ses->server->cipher_type);
471 pkey_inf.Suid = tcon->ses->Suid;
472 memcpy(pkey_inf.auth_key, tcon->ses->auth_key.response,
473 16 /* SMB2_NTLMV2_SESSKEY_SIZE */);
474 memcpy(pkey_inf.smb3decryptionkey,
475 tcon->ses->smb3decryptionkey, SMB3_SIGN_KEY_SIZE);
476 memcpy(pkey_inf.smb3encryptionkey,
477 tcon->ses->smb3encryptionkey, SMB3_SIGN_KEY_SIZE);
478 if (copy_to_user((void __user *)arg, &pkey_inf,
479 sizeof(struct smb3_key_debug_info)))
484 case CIFS_DUMP_FULL_KEY:
486 * Dump encryption keys (handles any key sizes)
488 if (pSMBFile == NULL)
490 if (!capable(CAP_SYS_ADMIN)) {
494 tcon = tlink_tcon(pSMBFile->tlink);
495 rc = cifs_dump_full_key(tcon, (void __user *)arg);
497 case CIFS_IOC_NOTIFY:
498 if (!S_ISDIR(inode->i_mode)) {
499 /* Notify can only be done on directories */
503 cifs_sb = CIFS_SB(inode->i_sb);
504 tlink = cifs_sb_tlink(cifs_sb);
509 tcon = tlink_tcon(tlink);
510 if (tcon && tcon->ses->server->ops->notify) {
511 rc = tcon->ses->server->ops->notify(xid,
512 filep, (void __user *)arg,
513 false /* no ret data */);
514 cifs_dbg(FYI, "ioctl notify rc %d\n", rc);
517 cifs_put_tlink(tlink);
519 case CIFS_IOC_NOTIFY_INFO:
520 if (!S_ISDIR(inode->i_mode)) {
521 /* Notify can only be done on directories */
525 cifs_sb = CIFS_SB(inode->i_sb);
526 tlink = cifs_sb_tlink(cifs_sb);
531 tcon = tlink_tcon(tlink);
532 if (tcon && tcon->ses->server->ops->notify) {
533 rc = tcon->ses->server->ops->notify(xid,
534 filep, (void __user *)arg,
535 true /* return details */);
536 cifs_dbg(FYI, "ioctl notify info rc %d\n", rc);
539 cifs_put_tlink(tlink);
541 case CIFS_IOC_SHUTDOWN:
542 rc = cifs_shutdown(inode->i_sb, arg);
545 cifs_dbg(FYI, "unsupported ioctl\n");