1 // SPDX-License-Identifier: LGPL-2.1
5 * vfs operations that deal with io control
7 * Copyright (C) International Business Machines Corp., 2005,2013
8 * Author(s): Steve French (sfrench@us.ibm.com)
13 #include <linux/file.h>
14 #include <linux/mount.h>
16 #include <linux/pagemap.h>
19 #include "cifsproto.h"
20 #include "cifs_debug.h"
22 #include "cifs_ioctl.h"
23 #include "smb2proto.h"
25 #include <linux/btrfs.h>
27 static long cifs_ioctl_query_info(unsigned int xid, struct file *filep,
30 struct inode *inode = file_inode(filep);
31 struct cifs_sb_info *cifs_sb = CIFS_SB(inode->i_sb);
32 struct cifs_tcon *tcon = cifs_sb_master_tcon(cifs_sb);
33 struct dentry *dentry = filep->f_path.dentry;
34 const unsigned char *path;
35 void *page = alloc_dentry_path();
36 __le16 *utf16_path = NULL, root_path;
39 path = build_path_from_dentry(dentry, page);
41 free_dentry_path(page);
45 cifs_dbg(FYI, "%s %s\n", __func__, path);
49 utf16_path = &root_path;
51 utf16_path = cifs_convert_path_to_utf16(path + 1, cifs_sb);
58 if (tcon->ses->server->ops->ioctl_query_info)
59 rc = tcon->ses->server->ops->ioctl_query_info(
60 xid, tcon, cifs_sb, utf16_path,
61 filep->private_data ? 0 : 1, p);
66 if (utf16_path != &root_path)
68 free_dentry_path(page);
72 static long cifs_ioctl_copychunk(unsigned int xid, struct file *dst_file,
77 struct inode *src_inode;
79 cifs_dbg(FYI, "ioctl copychunk range\n");
80 /* the destination must be opened for writing */
81 if (!(dst_file->f_mode & FMODE_WRITE)) {
82 cifs_dbg(FYI, "file target not open for write\n");
86 /* check if target volume is readonly and take reference */
87 rc = mnt_want_write_file(dst_file);
89 cifs_dbg(FYI, "mnt_want_write failed with rc %d\n", rc);
93 src_file = fdget(srcfd);
99 if (src_file.file->f_op->unlocked_ioctl != cifs_ioctl) {
101 cifs_dbg(VFS, "src file seems to be from a different filesystem type\n");
105 src_inode = file_inode(src_file.file);
107 if (S_ISDIR(src_inode->i_mode))
110 rc = cifs_file_copychunk_range(xid, src_file.file, 0, dst_file, 0,
111 src_inode->i_size, 0);
117 mnt_drop_write_file(dst_file);
121 static long smb_mnt_get_fsinfo(unsigned int xid, struct cifs_tcon *tcon,
125 struct smb_mnt_fs_info *fsinf;
127 fsinf = kzalloc(sizeof(struct smb_mnt_fs_info), GFP_KERNEL);
132 fsinf->protocol_id = tcon->ses->server->vals->protocol_id;
133 fsinf->device_characteristics =
134 le32_to_cpu(tcon->fsDevInfo.DeviceCharacteristics);
135 fsinf->device_type = le32_to_cpu(tcon->fsDevInfo.DeviceType);
136 fsinf->fs_attributes = le32_to_cpu(tcon->fsAttrInfo.Attributes);
137 fsinf->max_path_component =
138 le32_to_cpu(tcon->fsAttrInfo.MaxPathNameComponentLength);
139 fsinf->vol_serial_number = tcon->vol_serial_number;
140 fsinf->vol_create_time = le64_to_cpu(tcon->vol_create_time);
141 fsinf->share_flags = tcon->share_flags;
142 fsinf->share_caps = le32_to_cpu(tcon->capabilities);
143 fsinf->sector_flags = tcon->ss_flags;
144 fsinf->optimal_sector_size = tcon->perf_sector_size;
145 fsinf->max_bytes_chunk = tcon->max_bytes_chunk;
146 fsinf->maximal_access = tcon->maximal_access;
147 fsinf->cifs_posix_caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
149 if (copy_to_user(arg, fsinf, sizeof(struct smb_mnt_fs_info)))
156 static int cifs_shutdown(struct super_block *sb, unsigned long arg)
158 struct cifs_sb_info *sbi = CIFS_SB(sb);
161 if (!capable(CAP_SYS_ADMIN))
164 if (get_user(flags, (__u32 __user *)arg))
167 if (flags > CIFS_GOING_FLAGS_NOLOGFLUSH)
170 if (cifs_forced_shutdown(sbi))
173 cifs_dbg(VFS, "shut down requested (%d)", flags);
174 /* trace_cifs_shutdown(sb, flags);*/
178 * https://man7.org/linux/man-pages/man2/ioctl_xfs_goingdown.2.html
179 * for more information and description of original intent of the flags
183 * We could add support later for default flag which requires:
184 * "Flush all dirty data and metadata to disk"
185 * would need to call syncfs or equivalent to flush page cache for
186 * the mount and then issue fsync to server (if nostrictsync not set)
188 case CIFS_GOING_FLAGS_DEFAULT:
189 cifs_dbg(FYI, "shutdown with default flag not supported\n");
192 * FLAGS_LOGFLUSH is easy since it asks to write out metadata (not
193 * data) but metadata writes are not cached on the client, so can treat
194 * it similarly to NOLOGFLUSH
196 case CIFS_GOING_FLAGS_LOGFLUSH:
197 case CIFS_GOING_FLAGS_NOLOGFLUSH:
198 sbi->mnt_cifs_flags |= CIFS_MOUNT_SHUTDOWN;
206 static int cifs_dump_full_key(struct cifs_tcon *tcon, struct smb3_full_key_debug_info __user *in)
208 struct smb3_full_key_debug_info out;
209 struct cifs_ses *ses;
214 if (!smb3_encryption_required(tcon)) {
219 /* copy user input into our output buffer */
220 if (copy_from_user(&out, in, sizeof(out))) {
225 if (!out.session_id) {
226 /* if ses id is 0, use current user session */
229 /* otherwise if a session id is given, look for it in all our sessions */
230 struct cifs_ses *ses_it = NULL;
231 struct TCP_Server_Info *server_it = NULL;
233 spin_lock(&cifs_tcp_ses_lock);
234 list_for_each_entry(server_it, &cifs_tcp_ses_list, tcp_ses_list) {
235 list_for_each_entry(ses_it, &server_it->smb_ses_list, smb_ses_list) {
236 if (ses_it->Suid == out.session_id) {
239 * since we are using the session outside the crit
240 * section, we need to make sure it won't be released
241 * so increment its refcount
250 spin_unlock(&cifs_tcp_ses_lock);
257 switch (ses->server->cipher_type) {
258 case SMB2_ENCRYPTION_AES128_CCM:
259 case SMB2_ENCRYPTION_AES128_GCM:
260 out.session_key_length = CIFS_SESS_KEY_SIZE;
261 out.server_in_key_length = out.server_out_key_length = SMB3_GCM128_CRYPTKEY_SIZE;
263 case SMB2_ENCRYPTION_AES256_CCM:
264 case SMB2_ENCRYPTION_AES256_GCM:
265 out.session_key_length = CIFS_SESS_KEY_SIZE;
266 out.server_in_key_length = out.server_out_key_length = SMB3_GCM256_CRYPTKEY_SIZE;
273 /* check if user buffer is big enough to store all the keys */
274 if (out.in_size < sizeof(out) + out.session_key_length + out.server_in_key_length
275 + out.server_out_key_length) {
280 out.session_id = ses->Suid;
281 out.cipher_type = le16_to_cpu(ses->server->cipher_type);
283 /* overwrite user input with our output */
284 if (copy_to_user(in, &out, sizeof(out))) {
289 /* append all the keys at the end of the user buffer */
291 if (copy_to_user(end, ses->auth_key.response, out.session_key_length)) {
295 end += out.session_key_length;
297 if (copy_to_user(end, ses->smb3encryptionkey, out.server_in_key_length)) {
301 end += out.server_in_key_length;
303 if (copy_to_user(end, ses->smb3decryptionkey, out.server_out_key_length)) {
310 cifs_put_smb_ses(ses);
314 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg)
316 struct inode *inode = file_inode(filep);
317 struct smb3_key_debug_info pkey_inf;
318 int rc = -ENOTTY; /* strange error - but the precedent */
320 struct cifsFileInfo *pSMBFile = filep->private_data;
321 struct cifs_tcon *tcon;
322 struct tcon_link *tlink;
323 struct cifs_sb_info *cifs_sb;
324 __u64 ExtAttrBits = 0;
329 cifs_dbg(FYI, "cifs ioctl 0x%x\n", command);
331 case FS_IOC_GETFLAGS:
332 if (pSMBFile == NULL)
334 tcon = tlink_tcon(pSMBFile->tlink);
335 caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
336 #ifdef CONFIG_CIFS_POSIX
337 if (CIFS_UNIX_EXTATTR_CAP & caps) {
338 __u64 ExtAttrMask = 0;
339 rc = CIFSGetExtAttr(xid, tcon,
340 pSMBFile->fid.netfid,
341 &ExtAttrBits, &ExtAttrMask);
343 rc = put_user(ExtAttrBits &
346 if (rc != EOPNOTSUPP)
349 #endif /* CONFIG_CIFS_POSIX */
351 if (CIFS_I(inode)->cifsAttrs & ATTR_COMPRESSED) {
352 /* add in the compressed bit */
353 ExtAttrBits = FS_COMPR_FL;
354 rc = put_user(ExtAttrBits & FS_FL_USER_VISIBLE,
358 case FS_IOC_SETFLAGS:
359 if (pSMBFile == NULL)
361 tcon = tlink_tcon(pSMBFile->tlink);
362 caps = le64_to_cpu(tcon->fsUnixInfo.Capability);
364 if (get_user(ExtAttrBits, (int __user *)arg)) {
370 * if (CIFS_UNIX_EXTATTR_CAP & caps)
371 * rc = CIFSSetExtAttr(xid, tcon,
372 * pSMBFile->fid.netfid,
375 * if (rc != EOPNOTSUPP)
379 /* Currently only flag we can set is compressed flag */
380 if ((ExtAttrBits & FS_COMPR_FL) == 0)
383 /* Try to set compress flag */
384 if (tcon->ses->server->ops->set_compression) {
385 rc = tcon->ses->server->ops->set_compression(
386 xid, tcon, pSMBFile);
387 cifs_dbg(FYI, "set compress flag rc %d\n", rc);
390 case CIFS_IOC_COPYCHUNK_FILE:
391 rc = cifs_ioctl_copychunk(xid, filep, arg);
393 case CIFS_QUERY_INFO:
394 rc = cifs_ioctl_query_info(xid, filep, arg);
396 case CIFS_IOC_SET_INTEGRITY:
397 if (pSMBFile == NULL)
399 tcon = tlink_tcon(pSMBFile->tlink);
400 if (tcon->ses->server->ops->set_integrity)
401 rc = tcon->ses->server->ops->set_integrity(xid,
406 case CIFS_IOC_GET_MNT_INFO:
407 if (pSMBFile == NULL)
409 tcon = tlink_tcon(pSMBFile->tlink);
410 rc = smb_mnt_get_fsinfo(xid, tcon, (void __user *)arg);
412 case CIFS_ENUMERATE_SNAPSHOTS:
413 if (pSMBFile == NULL)
419 tcon = tlink_tcon(pSMBFile->tlink);
420 if (tcon->ses->server->ops->enum_snapshots)
421 rc = tcon->ses->server->ops->enum_snapshots(xid, tcon,
422 pSMBFile, (void __user *)arg);
428 * Dump encryption keys. This is an old ioctl that only
429 * handles AES-128-{CCM,GCM}.
431 if (pSMBFile == NULL)
433 if (!capable(CAP_SYS_ADMIN)) {
438 tcon = tlink_tcon(pSMBFile->tlink);
439 if (!smb3_encryption_required(tcon)) {
443 pkey_inf.cipher_type =
444 le16_to_cpu(tcon->ses->server->cipher_type);
445 pkey_inf.Suid = tcon->ses->Suid;
446 memcpy(pkey_inf.auth_key, tcon->ses->auth_key.response,
447 16 /* SMB2_NTLMV2_SESSKEY_SIZE */);
448 memcpy(pkey_inf.smb3decryptionkey,
449 tcon->ses->smb3decryptionkey, SMB3_SIGN_KEY_SIZE);
450 memcpy(pkey_inf.smb3encryptionkey,
451 tcon->ses->smb3encryptionkey, SMB3_SIGN_KEY_SIZE);
452 if (copy_to_user((void __user *)arg, &pkey_inf,
453 sizeof(struct smb3_key_debug_info)))
458 case CIFS_DUMP_FULL_KEY:
460 * Dump encryption keys (handles any key sizes)
462 if (pSMBFile == NULL)
464 if (!capable(CAP_SYS_ADMIN)) {
468 tcon = tlink_tcon(pSMBFile->tlink);
469 rc = cifs_dump_full_key(tcon, (void __user *)arg);
471 case CIFS_IOC_NOTIFY:
472 if (!S_ISDIR(inode->i_mode)) {
473 /* Notify can only be done on directories */
477 cifs_sb = CIFS_SB(inode->i_sb);
478 tlink = cifs_sb_tlink(cifs_sb);
483 tcon = tlink_tcon(tlink);
484 if (tcon && tcon->ses->server->ops->notify) {
485 rc = tcon->ses->server->ops->notify(xid,
486 filep, (void __user *)arg);
487 cifs_dbg(FYI, "ioctl notify rc %d\n", rc);
490 cifs_put_tlink(tlink);
492 case CIFS_IOC_SHUTDOWN:
493 rc = cifs_shutdown(inode->i_sb, arg);
496 cifs_dbg(FYI, "unsupported ioctl\n");