smb/client/ioctl.c

   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_tcon_info(struct cifs_tcon *tcon, void __user *arg)
 121 {
 122         int rc = 0;
 123         struct smb_mnt_tcon_info tcon_inf;
 124
 125         tcon_inf.tid = tcon->tid;
 126         tcon_inf.session_id = tcon->ses->Suid;
 127
 128         if (copy_to_user(arg, &tcon_inf, sizeof(struct smb_mnt_tcon_info)))
 129                 rc = -EFAULT;
 130
 131         return rc;
 132 }
 133
 134 static long smb_mnt_get_fsinfo(unsigned int xid, struct cifs_tcon *tcon,
 135                                 void __user *arg)
 136 {
 137         int rc = 0;
 138         struct smb_mnt_fs_info *fsinf;
 139
 140         fsinf = kzalloc(sizeof(struct smb_mnt_fs_info), GFP_KERNEL);
 141         if (fsinf == NULL)
 142                 return -ENOMEM;
 143
 144         fsinf->version = 1;
 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);
 161
 162         if (copy_to_user(arg, fsinf, sizeof(struct smb_mnt_fs_info)))
 163                 rc = -EFAULT;
 164
 165         kfree(fsinf);
 166         return rc;
 167 }
 168
 169 static int cifs_shutdown(struct super_block *sb, unsigned long arg)
 170 {
 171         struct cifs_sb_info *sbi = CIFS_SB(sb);
 172         __u32 flags;
 173
 174         if (!capable(CAP_SYS_ADMIN))
 175                 return -EPERM;
 176
 177         if (get_user(flags, (__u32 __user *)arg))
 178                 return -EFAULT;
 179
 180         if (flags > CIFS_GOING_FLAGS_NOLOGFLUSH)
 181                 return -EINVAL;
 182
 183         if (cifs_forced_shutdown(sbi))
 184                 return 0;
 185
 186         cifs_dbg(VFS, "shut down requested (%d)", flags);
 187 /*      trace_cifs_shutdown(sb, flags);*/
 188
 189         /*
 190          * see:
 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
 193          */
 194         switch (flags) {
 195         /*
 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)
 200          */
 201         case CIFS_GOING_FLAGS_DEFAULT:
 202                 cifs_dbg(FYI, "shutdown with default flag not supported\n");
 203                 return -EINVAL;
 204         /*
 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
 208          */
 209         case CIFS_GOING_FLAGS_LOGFLUSH:
 210         case CIFS_GOING_FLAGS_NOLOGFLUSH:
 211                 sbi->mnt_cifs_flags |= CIFS_MOUNT_SHUTDOWN;
 212                 return 0;
 213         default:
 214                 return -EINVAL;
 215         }
 216         return 0;
 217 }
 218
 219 static int cifs_dump_full_key(struct cifs_tcon *tcon, struct smb3_full_key_debug_info __user *in)
 220 {
 221         struct smb3_full_key_debug_info out;
 222         struct cifs_ses *ses;
 223         int rc = 0;
 224         bool found = false;
 225         u8 __user *end;
 226
 227         if (!smb3_encryption_required(tcon)) {
 228                 rc = -EOPNOTSUPP;
 229                 goto out;
 230         }
 231
 232         /* copy user input into our output buffer */
 233         if (copy_from_user(&out, in, sizeof(out))) {
 234                 rc = -EINVAL;
 235                 goto out;
 236         }
 237
 238         if (!out.session_id) {
 239                 /* if ses id is 0, use current user session */
 240                 ses = tcon->ses;
 241         } else {
 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;
 245
 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) {
 250                                         ses = ses_it;
 251                                         /*
 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
 255                                          */
 256                                         ses->ses_count++;
 257                                         found = true;
 258                                         goto search_end;
 259                                 }
 260                         }
 261                 }
 262 search_end:
 263                 spin_unlock(&cifs_tcp_ses_lock);
 264                 if (!found) {
 265                         rc = -ENOENT;
 266                         goto out;
 267                 }
 268         }
 269
 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;
 275                 break;
 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;
 280                 break;
 281         default:
 282                 rc = -EOPNOTSUPP;
 283                 goto out;
 284         }
 285
 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) {
 289                 rc = -ENOBUFS;
 290                 goto out;
 291         }
 292
 293         out.session_id = ses->Suid;
 294         out.cipher_type = le16_to_cpu(ses->server->cipher_type);
 295
 296         /* overwrite user input with our output */
 297         if (copy_to_user(in, &out, sizeof(out))) {
 298                 rc = -EINVAL;
 299                 goto out;
 300         }
 301
 302         /* append all the keys at the end of the user buffer */
 303         end = in->data;
 304         if (copy_to_user(end, ses->auth_key.response, out.session_key_length)) {
 305                 rc = -EINVAL;
 306                 goto out;
 307         }
 308         end += out.session_key_length;
 309
 310         if (copy_to_user(end, ses->smb3encryptionkey, out.server_in_key_length)) {
 311                 rc = -EINVAL;
 312                 goto out;
 313         }
 314         end += out.server_in_key_length;
 315
 316         if (copy_to_user(end, ses->smb3decryptionkey, out.server_out_key_length)) {
 317                 rc = -EINVAL;
 318                 goto out;
 319         }
 320
 321 out:
 322         if (found)
 323                 cifs_put_smb_ses(ses);
 324         return rc;
 325 }
 326
 327 long cifs_ioctl(struct file *filep, unsigned int command, unsigned long arg)
 328 {
 329         struct inode *inode = file_inode(filep);
 330         struct smb3_key_debug_info pkey_inf;
 331         int rc = -ENOTTY; /* strange error - but the precedent */
 332         unsigned int xid;
 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;
 338         __u64   caps;
 339
 340         xid = get_xid();
 341
 342         cifs_dbg(FYI, "cifs ioctl 0x%x\n", command);
 343         switch (command) {
 344                 case FS_IOC_GETFLAGS:
 345                         if (pSMBFile == NULL)
 346                                 break;
 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);
 356                                 if (rc == 0)
 357                                         rc = put_user(ExtAttrBits &
 358                                                 FS_FL_USER_VISIBLE,
 359                                                 (int __user *)arg);
 360                                 if (rc != -EOPNOTSUPP)
 361                                         break;
 362                         }
 363 #endif /* CONFIG_CIFS_ALLOW_INSECURE_LEGACY */
 364 #endif /* CONFIG_CIFS_POSIX */
 365                         rc = 0;
 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,
 370                                               (int __user *)arg);
 371                         }
 372                         break;
 373                 case FS_IOC_SETFLAGS:
 374                         if (pSMBFile == NULL)
 375                                 break;
 376                         tcon = tlink_tcon(pSMBFile->tlink);
 377                         /* caps = le64_to_cpu(tcon->fsUnixInfo.Capability); */
 378
 379                         if (get_user(ExtAttrBits, (int __user *)arg)) {
 380                                 rc = -EFAULT;
 381                                 break;
 382                         }
 383
 384                         /*
 385                          * if (CIFS_UNIX_EXTATTR_CAP & caps)
 386                          *      rc = CIFSSetExtAttr(xid, tcon,
 387                          *                     pSMBFile->fid.netfid,
 388                          *                     extAttrBits,
 389                          *                     &ExtAttrMask);
 390                          * if (rc != -EOPNOTSUPP)
 391                          *      break;
 392                          */
 393
 394                         /* Currently only flag we can set is compressed flag */
 395                         if ((ExtAttrBits & FS_COMPR_FL) == 0)
 396                                 break;
 397
 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);
 403                         }
 404                         break;
 405                 case CIFS_IOC_COPYCHUNK_FILE:
 406                         rc = cifs_ioctl_copychunk(xid, filep, arg);
 407                         break;
 408                 case CIFS_QUERY_INFO:
 409                         rc = cifs_ioctl_query_info(xid, filep, arg);
 410                         break;
 411                 case CIFS_IOC_SET_INTEGRITY:
 412                         if (pSMBFile == NULL)
 413                                 break;
 414                         tcon = tlink_tcon(pSMBFile->tlink);
 415                         if (tcon->ses->server->ops->set_integrity)
 416                                 rc = tcon->ses->server->ops->set_integrity(xid,
 417                                                 tcon, pSMBFile);
 418                         else
 419                                 rc = -EOPNOTSUPP;
 420                         break;
 421                 case CIFS_IOC_GET_MNT_INFO:
 422                         if (pSMBFile == NULL)
 423                                 break;
 424                         tcon = tlink_tcon(pSMBFile->tlink);
 425                         rc = smb_mnt_get_fsinfo(xid, tcon, (void __user *)arg);
 426                         break;
 427                 case CIFS_IOC_GET_TCON_INFO:
 428                         cifs_sb = CIFS_SB(inode->i_sb);
 429                         tlink = cifs_sb_tlink(cifs_sb);
 430                         if (IS_ERR(tlink)) {
 431                                 rc = PTR_ERR(tlink);
 432                                 break;
 433                         }
 434                         tcon = tlink_tcon(tlink);
 435                         rc = smb_mnt_get_tcon_info(tcon, (void __user *)arg);
 436                         cifs_put_tlink(tlink);
 437                         break;
 438                 case CIFS_ENUMERATE_SNAPSHOTS:
 439                         if (pSMBFile == NULL)
 440                                 break;
 441                         if (arg == 0) {
 442                                 rc = -EINVAL;
 443                                 goto cifs_ioc_exit;
 444                         }
 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);
 449                         else
 450                                 rc = -EOPNOTSUPP;
 451                         break;
 452                 case CIFS_DUMP_KEY:
 453                         /*
 454                          * Dump encryption keys. This is an old ioctl that only
 455                          * handles AES-128-{CCM,GCM}.
 456                          */
 457                         if (pSMBFile == NULL)
 458                                 break;
 459                         if (!capable(CAP_SYS_ADMIN)) {
 460                                 rc = -EACCES;
 461                                 break;
 462                         }
 463
 464                         tcon = tlink_tcon(pSMBFile->tlink);
 465                         if (!smb3_encryption_required(tcon)) {
 466                                 rc = -EOPNOTSUPP;
 467                                 break;
 468                         }
 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)))
 480                                 rc = -EFAULT;
 481                         else
 482                                 rc = 0;
 483                         break;
 484                 case CIFS_DUMP_FULL_KEY:
 485                         /*
 486                          * Dump encryption keys (handles any key sizes)
 487                          */
 488                         if (pSMBFile == NULL)
 489                                 break;
 490                         if (!capable(CAP_SYS_ADMIN)) {
 491                                 rc = -EACCES;
 492                                 break;
 493                         }
 494                         tcon = tlink_tcon(pSMBFile->tlink);
 495                         rc = cifs_dump_full_key(tcon, (void __user *)arg);
 496                         break;
 497                 case CIFS_IOC_NOTIFY:
 498                         if (!S_ISDIR(inode->i_mode)) {
 499                                 /* Notify can only be done on directories */
 500                                 rc = -EOPNOTSUPP;
 501                                 break;
 502                         }
 503                         cifs_sb = CIFS_SB(inode->i_sb);
 504                         tlink = cifs_sb_tlink(cifs_sb);
 505                         if (IS_ERR(tlink)) {
 506                                 rc = PTR_ERR(tlink);
 507                                 break;
 508                         }
 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);
 515                         } else
 516                                 rc = -EOPNOTSUPP;
 517                         cifs_put_tlink(tlink);
 518                         break;
 519                 case CIFS_IOC_NOTIFY_INFO:
 520                         if (!S_ISDIR(inode->i_mode)) {
 521                                 /* Notify can only be done on directories */
 522                                 rc = -EOPNOTSUPP;
 523                                 break;
 524                         }
 525                         cifs_sb = CIFS_SB(inode->i_sb);
 526                         tlink = cifs_sb_tlink(cifs_sb);
 527                         if (IS_ERR(tlink)) {
 528                                 rc = PTR_ERR(tlink);
 529                                 break;
 530                         }
 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);
 537                         } else
 538                                 rc = -EOPNOTSUPP;
 539                         cifs_put_tlink(tlink);
 540                         break;
 541                 case CIFS_IOC_SHUTDOWN:
 542                         rc = cifs_shutdown(inode->i_sb, arg);
 543                         break;
 544                 default:
 545                         cifs_dbg(FYI, "unsupported ioctl\n");
 546                         break;
 547         }
 548 cifs_ioc_exit:
 549         free_xid(xid);
 550         return rc;
 551 }