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->tcon_flags = tcon->Flags;
147 fsinf->device_characteristics =
148 le32_to_cpu(tcon->fsDevInfo.DeviceCharacteristics);
149 fsinf->device_type = le32_to_cpu(tcon->fsDevInfo.DeviceType);
150 fsinf->fs_attributes = le32_to_cpu(tcon->fsAttrInfo.Attributes);
151 fsinf->max_path_component =
152 le32_to_cpu(tcon->fsAttrInfo.MaxPathNameComponentLength);
153 fsinf->vol_serial_number = tcon->vol_serial_number;
154 fsinf->vol_create_time = le64_to_cpu(tcon->vol_create_time);
155 fsinf->share_flags = tcon->share_flags;
156 fsinf->share_caps = le32_to_cpu(tcon->capabilities);
157 fsinf->sector_flags = tcon->ss_flags;
158 fsinf->optimal_sector_size = tcon->perf_sector_size;
159 fsinf->max_bytes_chunk = tcon->max_bytes_chunk;
160 fsinf->maximal_access = tcon->maximal_access;
161 fsinf->cifs_posix_caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
163 if (copy_to_user(arg, fsinf, sizeof(struct smb_mnt_fs_info)))
170 static int cifs_shutdown(struct super_block *sb, unsigned long arg)
172 struct cifs_sb_info *sbi = CIFS_SB(sb);
175 if (!capable(CAP_SYS_ADMIN))
178 if (get_user(flags, (__u32 __user *)arg))
181 if (flags > CIFS_GOING_FLAGS_NOLOGFLUSH)
184 if (cifs_forced_shutdown(sbi))
187 cifs_dbg(VFS, "shut down requested (%d)", flags);
188 /* trace_cifs_shutdown(sb, flags);*/
192 * https://man7.org/linux/man-pages/man2/ioctl_xfs_goingdown.2.html
193 * for more information and description of original intent of the flags
197 * We could add support later for default flag which requires:
198 * "Flush all dirty data and metadata to disk"
199 * would need to call syncfs or equivalent to flush page cache for
200 * the mount and then issue fsync to server (if nostrictsync not set)
202 case CIFS_GOING_FLAGS_DEFAULT:
203 cifs_dbg(FYI, "shutdown with default flag not supported\n");
206 * FLAGS_LOGFLUSH is easy since it asks to write out metadata (not
207 * data) but metadata writes are not cached on the client, so can treat
208 * it similarly to NOLOGFLUSH
210 case CIFS_GOING_FLAGS_LOGFLUSH:
211 case CIFS_GOING_FLAGS_NOLOGFLUSH:
212 sbi->mnt_cifs_flags |= CIFS_MOUNT_SHUTDOWN;
220 static int cifs_dump_full_key(struct cifs_tcon *tcon, struct smb3_full_key_debug_info __user *in)
222 struct smb3_full_key_debug_info out;
223 struct cifs_ses *ses;
228 if (!smb3_encryption_required(tcon)) {
233 /* copy user input into our output buffer */
234 if (copy_from_user(&out, in, sizeof(out))) {
239 if (!out.session_id) {
240 /* if ses id is 0, use current user session */
243 /* otherwise if a session id is given, look for it in all our sessions */
244 struct cifs_ses *ses_it = NULL;
245 struct TCP_Server_Info *server_it = NULL;
247 spin_lock(&cifs_tcp_ses_lock);
248 list_for_each_entry(server_it, &cifs_tcp_ses_list, tcp_ses_list) {
249 list_for_each_entry(ses_it, &server_it->smb_ses_list, smb_ses_list) {
250 spin_lock(&ses_it->ses_lock);
251 if (ses_it->ses_status != SES_EXITING &&
252 ses_it->Suid == out.session_id) {
255 * since we are using the session outside the crit
256 * section, we need to make sure it won't be released
257 * so increment its refcount
259 cifs_smb_ses_inc_refcount(ses);
260 spin_unlock(&ses_it->ses_lock);
264 spin_unlock(&ses_it->ses_lock);
268 spin_unlock(&cifs_tcp_ses_lock);
275 switch (ses->server->cipher_type) {
276 case SMB2_ENCRYPTION_AES128_CCM:
277 case SMB2_ENCRYPTION_AES128_GCM:
278 out.session_key_length = CIFS_SESS_KEY_SIZE;
279 out.server_in_key_length = out.server_out_key_length = SMB3_GCM128_CRYPTKEY_SIZE;
281 case SMB2_ENCRYPTION_AES256_CCM:
282 case SMB2_ENCRYPTION_AES256_GCM:
283 out.session_key_length = CIFS_SESS_KEY_SIZE;
284 out.server_in_key_length = out.server_out_key_length = SMB3_GCM256_CRYPTKEY_SIZE;
291 /* check if user buffer is big enough to store all the keys */
292 if (out.in_size < sizeof(out) + out.session_key_length + out.server_in_key_length
293 + out.server_out_key_length) {
298 out.session_id = ses->Suid;
299 out.cipher_type = le16_to_cpu(ses->server->cipher_type);
301 /* overwrite user input with our output */
302 if (copy_to_user(in, &out, sizeof(out))) {
307 /* append all the keys at the end of the user buffer */
309 if (copy_to_user(end, ses->auth_key.response, out.session_key_length)) {
313 end += out.session_key_length;
315 if (copy_to_user(end, ses->smb3encryptionkey, out.server_in_key_length)) {
319 end += out.server_in_key_length;
321 if (copy_to_user(end, ses->smb3decryptionkey, out.server_out_key_length)) {
328 cifs_put_smb_ses(ses);
332 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg)
334 struct inode *inode = file_inode(filep);
335 struct smb3_key_debug_info pkey_inf;
336 int rc = -ENOTTY; /* strange error - but the precedent */
338 struct cifsFileInfo *pSMBFile = filep->private_data;
339 struct cifs_tcon *tcon;
340 struct tcon_link *tlink;
341 struct cifs_sb_info *cifs_sb;
342 __u64 ExtAttrBits = 0;
343 #ifdef CONFIG_CIFS_POSIX
344 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
346 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
347 #endif /* CONFIG_CIFS_POSIX */
351 cifs_dbg(FYI, "cifs ioctl 0x%x\n", command);
352 if (pSMBFile == NULL)
353 trace_smb3_ioctl(xid, 0, command);
355 trace_smb3_ioctl(xid, pSMBFile->fid.persistent_fid, command);
358 case FS_IOC_GETFLAGS:
359 if (pSMBFile == NULL)
361 tcon = tlink_tcon(pSMBFile->tlink);
362 #ifdef CONFIG_CIFS_POSIX
363 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
364 caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
365 if (CIFS_UNIX_EXTATTR_CAP & caps) {
366 __u64 ExtAttrMask = 0;
367 rc = CIFSGetExtAttr(xid, tcon,
368 pSMBFile->fid.netfid,
369 &ExtAttrBits, &ExtAttrMask);
371 rc = put_user(ExtAttrBits &
374 if (rc != -EOPNOTSUPP)
377 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
378 #endif /* CONFIG_CIFS_POSIX */
380 if (CIFS_I(inode)->cifsAttrs & ATTR_COMPRESSED) {
381 /* add in the compressed bit */
382 ExtAttrBits = FS_COMPR_FL;
383 rc = put_user(ExtAttrBits & FS_FL_USER_VISIBLE,
387 case FS_IOC_SETFLAGS:
388 if (pSMBFile == NULL)
390 tcon = tlink_tcon(pSMBFile->tlink);
391 /* caps = le64_to_cpu(tcon->fsUnixInfo.Capability); */
393 if (get_user(ExtAttrBits, (int __user *)arg)) {
399 * if (CIFS_UNIX_EXTATTR_CAP & caps)
400 * rc = CIFSSetExtAttr(xid, tcon,
401 * pSMBFile->fid.netfid,
404 * if (rc != -EOPNOTSUPP)
408 /* Currently only flag we can set is compressed flag */
409 if ((ExtAttrBits & FS_COMPR_FL) == 0)
412 /* Try to set compress flag */
413 if (tcon->ses->server->ops->set_compression) {
414 rc = tcon->ses->server->ops->set_compression(
415 xid, tcon, pSMBFile);
416 cifs_dbg(FYI, "set compress flag rc %d\n", rc);
419 case CIFS_IOC_COPYCHUNK_FILE:
420 rc = cifs_ioctl_copychunk(xid, filep, arg);
422 case CIFS_QUERY_INFO:
423 rc = cifs_ioctl_query_info(xid, filep, arg);
425 case CIFS_IOC_SET_INTEGRITY:
426 if (pSMBFile == NULL)
428 tcon = tlink_tcon(pSMBFile->tlink);
429 if (tcon->ses->server->ops->set_integrity)
430 rc = tcon->ses->server->ops->set_integrity(xid,
435 case CIFS_IOC_GET_MNT_INFO:
436 if (pSMBFile == NULL)
438 tcon = tlink_tcon(pSMBFile->tlink);
439 rc = smb_mnt_get_fsinfo(xid, tcon, (void __user *)arg);
441 case CIFS_IOC_GET_TCON_INFO:
442 cifs_sb = CIFS_SB(inode->i_sb);
443 tlink = cifs_sb_tlink(cifs_sb);
448 tcon = tlink_tcon(tlink);
449 rc = smb_mnt_get_tcon_info(tcon, (void __user *)arg);
450 cifs_put_tlink(tlink);
452 case CIFS_ENUMERATE_SNAPSHOTS:
453 if (pSMBFile == NULL)
459 tcon = tlink_tcon(pSMBFile->tlink);
460 if (tcon->ses->server->ops->enum_snapshots)
461 rc = tcon->ses->server->ops->enum_snapshots(xid, tcon,
462 pSMBFile, (void __user *)arg);
468 * Dump encryption keys. This is an old ioctl that only
469 * handles AES-128-{CCM,GCM}.
471 if (!capable(CAP_SYS_ADMIN)) {
476 cifs_sb = CIFS_SB(inode->i_sb);
477 tlink = cifs_sb_tlink(cifs_sb);
482 tcon = tlink_tcon(tlink);
483 if (!smb3_encryption_required(tcon)) {
485 cifs_put_tlink(tlink);
488 pkey_inf.cipher_type =
489 le16_to_cpu(tcon->ses->server->cipher_type);
490 pkey_inf.Suid = tcon->ses->Suid;
491 memcpy(pkey_inf.auth_key, tcon->ses->auth_key.response,
492 16 /* SMB2_NTLMV2_SESSKEY_SIZE */);
493 memcpy(pkey_inf.smb3decryptionkey,
494 tcon->ses->smb3decryptionkey, SMB3_SIGN_KEY_SIZE);
495 memcpy(pkey_inf.smb3encryptionkey,
496 tcon->ses->smb3encryptionkey, SMB3_SIGN_KEY_SIZE);
497 if (copy_to_user((void __user *)arg, &pkey_inf,
498 sizeof(struct smb3_key_debug_info)))
502 cifs_put_tlink(tlink);
504 case CIFS_DUMP_FULL_KEY:
506 * Dump encryption keys (handles any key sizes)
508 if (pSMBFile == NULL)
510 if (!capable(CAP_SYS_ADMIN)) {
514 cifs_sb = CIFS_SB(inode->i_sb);
515 tlink = cifs_sb_tlink(cifs_sb);
521 tcon = tlink_tcon(tlink);
522 rc = cifs_dump_full_key(tcon, (void __user *)arg);
523 cifs_put_tlink(tlink);
525 case CIFS_IOC_NOTIFY:
526 if (!S_ISDIR(inode->i_mode)) {
527 /* Notify can only be done on directories */
531 cifs_sb = CIFS_SB(inode->i_sb);
532 tlink = cifs_sb_tlink(cifs_sb);
537 tcon = tlink_tcon(tlink);
538 if (tcon && tcon->ses->server->ops->notify) {
539 rc = tcon->ses->server->ops->notify(xid,
540 filep, (void __user *)arg,
541 false /* no ret data */);
542 cifs_dbg(FYI, "ioctl notify rc %d\n", rc);
545 cifs_put_tlink(tlink);
547 case CIFS_IOC_NOTIFY_INFO:
548 if (!S_ISDIR(inode->i_mode)) {
549 /* Notify can only be done on directories */
553 cifs_sb = CIFS_SB(inode->i_sb);
554 tlink = cifs_sb_tlink(cifs_sb);
559 tcon = tlink_tcon(tlink);
560 if (tcon && tcon->ses->server->ops->notify) {
561 rc = tcon->ses->server->ops->notify(xid,
562 filep, (void __user *)arg,
563 true /* return details */);
564 cifs_dbg(FYI, "ioctl notify info rc %d\n", rc);
567 cifs_put_tlink(tlink);
569 case CIFS_IOC_SHUTDOWN:
570 rc = cifs_shutdown(inode->i_sb, arg);
573 cifs_dbg(FYI, "unsupported ioctl\n");