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 if (ses_it->Suid == out.session_id) {
253 * since we are using the session outside the crit
254 * section, we need to make sure it won't be released
255 * so increment its refcount
257 cifs_smb_ses_inc_refcount(ses);
264 spin_unlock(&cifs_tcp_ses_lock);
271 switch (ses->server->cipher_type) {
272 case SMB2_ENCRYPTION_AES128_CCM:
273 case SMB2_ENCRYPTION_AES128_GCM:
274 out.session_key_length = CIFS_SESS_KEY_SIZE;
275 out.server_in_key_length = out.server_out_key_length = SMB3_GCM128_CRYPTKEY_SIZE;
277 case SMB2_ENCRYPTION_AES256_CCM:
278 case SMB2_ENCRYPTION_AES256_GCM:
279 out.session_key_length = CIFS_SESS_KEY_SIZE;
280 out.server_in_key_length = out.server_out_key_length = SMB3_GCM256_CRYPTKEY_SIZE;
287 /* check if user buffer is big enough to store all the keys */
288 if (out.in_size < sizeof(out) + out.session_key_length + out.server_in_key_length
289 + out.server_out_key_length) {
294 out.session_id = ses->Suid;
295 out.cipher_type = le16_to_cpu(ses->server->cipher_type);
297 /* overwrite user input with our output */
298 if (copy_to_user(in, &out, sizeof(out))) {
303 /* append all the keys at the end of the user buffer */
305 if (copy_to_user(end, ses->auth_key.response, out.session_key_length)) {
309 end += out.session_key_length;
311 if (copy_to_user(end, ses->smb3encryptionkey, out.server_in_key_length)) {
315 end += out.server_in_key_length;
317 if (copy_to_user(end, ses->smb3decryptionkey, out.server_out_key_length)) {
324 cifs_put_smb_ses(ses);
328 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg)
330 struct inode *inode = file_inode(filep);
331 struct smb3_key_debug_info pkey_inf;
332 int rc = -ENOTTY; /* strange error - but the precedent */
334 struct cifsFileInfo *pSMBFile = filep->private_data;
335 struct cifs_tcon *tcon;
336 struct tcon_link *tlink;
337 struct cifs_sb_info *cifs_sb;
338 __u64 ExtAttrBits = 0;
339 #ifdef CONFIG_CIFS_POSIX
340 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
342 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
343 #endif /* CONFIG_CIFS_POSIX */
347 cifs_dbg(FYI, "cifs ioctl 0x%x\n", command);
349 case FS_IOC_GETFLAGS:
350 if (pSMBFile == NULL)
352 tcon = tlink_tcon(pSMBFile->tlink);
353 #ifdef CONFIG_CIFS_POSIX
354 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
355 caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
356 if (CIFS_UNIX_EXTATTR_CAP & caps) {
357 __u64 ExtAttrMask = 0;
358 rc = CIFSGetExtAttr(xid, tcon,
359 pSMBFile->fid.netfid,
360 &ExtAttrBits, &ExtAttrMask);
362 rc = put_user(ExtAttrBits &
365 if (rc != -EOPNOTSUPP)
368 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
369 #endif /* CONFIG_CIFS_POSIX */
371 if (CIFS_I(inode)->cifsAttrs & ATTR_COMPRESSED) {
372 /* add in the compressed bit */
373 ExtAttrBits = FS_COMPR_FL;
374 rc = put_user(ExtAttrBits & FS_FL_USER_VISIBLE,
378 case FS_IOC_SETFLAGS:
379 if (pSMBFile == NULL)
381 tcon = tlink_tcon(pSMBFile->tlink);
382 /* caps = le64_to_cpu(tcon->fsUnixInfo.Capability); */
384 if (get_user(ExtAttrBits, (int __user *)arg)) {
390 * if (CIFS_UNIX_EXTATTR_CAP & caps)
391 * rc = CIFSSetExtAttr(xid, tcon,
392 * pSMBFile->fid.netfid,
395 * if (rc != -EOPNOTSUPP)
399 /* Currently only flag we can set is compressed flag */
400 if ((ExtAttrBits & FS_COMPR_FL) == 0)
403 /* Try to set compress flag */
404 if (tcon->ses->server->ops->set_compression) {
405 rc = tcon->ses->server->ops->set_compression(
406 xid, tcon, pSMBFile);
407 cifs_dbg(FYI, "set compress flag rc %d\n", rc);
410 case CIFS_IOC_COPYCHUNK_FILE:
411 rc = cifs_ioctl_copychunk(xid, filep, arg);
413 case CIFS_QUERY_INFO:
414 rc = cifs_ioctl_query_info(xid, filep, arg);
416 case CIFS_IOC_SET_INTEGRITY:
417 if (pSMBFile == NULL)
419 tcon = tlink_tcon(pSMBFile->tlink);
420 if (tcon->ses->server->ops->set_integrity)
421 rc = tcon->ses->server->ops->set_integrity(xid,
426 case CIFS_IOC_GET_MNT_INFO:
427 if (pSMBFile == NULL)
429 tcon = tlink_tcon(pSMBFile->tlink);
430 rc = smb_mnt_get_fsinfo(xid, tcon, (void __user *)arg);
432 case CIFS_IOC_GET_TCON_INFO:
433 cifs_sb = CIFS_SB(inode->i_sb);
434 tlink = cifs_sb_tlink(cifs_sb);
439 tcon = tlink_tcon(tlink);
440 rc = smb_mnt_get_tcon_info(tcon, (void __user *)arg);
441 cifs_put_tlink(tlink);
443 case CIFS_ENUMERATE_SNAPSHOTS:
444 if (pSMBFile == NULL)
450 tcon = tlink_tcon(pSMBFile->tlink);
451 if (tcon->ses->server->ops->enum_snapshots)
452 rc = tcon->ses->server->ops->enum_snapshots(xid, tcon,
453 pSMBFile, (void __user *)arg);
459 * Dump encryption keys. This is an old ioctl that only
460 * handles AES-128-{CCM,GCM}.
462 if (!capable(CAP_SYS_ADMIN)) {
467 cifs_sb = CIFS_SB(inode->i_sb);
468 tlink = cifs_sb_tlink(cifs_sb);
473 tcon = tlink_tcon(tlink);
474 if (!smb3_encryption_required(tcon)) {
476 cifs_put_tlink(tlink);
479 pkey_inf.cipher_type =
480 le16_to_cpu(tcon->ses->server->cipher_type);
481 pkey_inf.Suid = tcon->ses->Suid;
482 memcpy(pkey_inf.auth_key, tcon->ses->auth_key.response,
483 16 /* SMB2_NTLMV2_SESSKEY_SIZE */);
484 memcpy(pkey_inf.smb3decryptionkey,
485 tcon->ses->smb3decryptionkey, SMB3_SIGN_KEY_SIZE);
486 memcpy(pkey_inf.smb3encryptionkey,
487 tcon->ses->smb3encryptionkey, SMB3_SIGN_KEY_SIZE);
488 if (copy_to_user((void __user *)arg, &pkey_inf,
489 sizeof(struct smb3_key_debug_info)))
493 cifs_put_tlink(tlink);
495 case CIFS_DUMP_FULL_KEY:
497 * Dump encryption keys (handles any key sizes)
499 if (pSMBFile == NULL)
501 if (!capable(CAP_SYS_ADMIN)) {
505 cifs_sb = CIFS_SB(inode->i_sb);
506 tlink = cifs_sb_tlink(cifs_sb);
512 tcon = tlink_tcon(tlink);
513 rc = cifs_dump_full_key(tcon, (void __user *)arg);
514 cifs_put_tlink(tlink);
516 case CIFS_IOC_NOTIFY:
517 if (!S_ISDIR(inode->i_mode)) {
518 /* Notify can only be done on directories */
522 cifs_sb = CIFS_SB(inode->i_sb);
523 tlink = cifs_sb_tlink(cifs_sb);
528 tcon = tlink_tcon(tlink);
529 if (tcon && tcon->ses->server->ops->notify) {
530 rc = tcon->ses->server->ops->notify(xid,
531 filep, (void __user *)arg,
532 false /* no ret data */);
533 cifs_dbg(FYI, "ioctl notify rc %d\n", rc);
536 cifs_put_tlink(tlink);
538 case CIFS_IOC_NOTIFY_INFO:
539 if (!S_ISDIR(inode->i_mode)) {
540 /* Notify can only be done on directories */
544 cifs_sb = CIFS_SB(inode->i_sb);
545 tlink = cifs_sb_tlink(cifs_sb);
550 tcon = tlink_tcon(tlink);
551 if (tcon && tcon->ses->server->ops->notify) {
552 rc = tcon->ses->server->ops->notify(xid,
553 filep, (void __user *)arg,
554 true /* return details */);
555 cifs_dbg(FYI, "ioctl notify info rc %d\n", rc);
558 cifs_put_tlink(tlink);
560 case CIFS_IOC_SHUTDOWN:
561 rc = cifs_shutdown(inode->i_sb, arg);
564 cifs_dbg(FYI, "unsupported ioctl\n");