fs/cifs/cifs_dfs_ref.c

   1 /*
   2  *   Contains the CIFS DFS referral mounting routines used for handling
   3  *   traversal via DFS junction point
   4  *
   5  *   Copyright (c) 2007 Igor Mammedov
   6  *   Copyright (C) International Business Machines  Corp., 2008
   7  *   Author(s): Igor Mammedov (niallain@gmail.com)
   8  *              Steve French (sfrench@us.ibm.com)
   9  *   This program is free software; you can redistribute it and/or
  10  *   modify it under the terms of the GNU General Public License
  11  *   as published by the Free Software Foundation; either version
  12  *   2 of the License, or (at your option) any later version.
  13  */
  14
  15 #include <linux/dcache.h>
  16 #include <linux/mount.h>
  17 #include <linux/namei.h>
  18 #include <linux/slab.h>
  19 #include <linux/vfs.h>
  20 #include <linux/fs.h>
  21 #include <linux/inet.h>
  22 #include "cifsglob.h"
  23 #include "cifsproto.h"
  24 #include "cifsfs.h"
  25 #include "dns_resolve.h"
  26 #include "cifs_debug.h"
  27 #include "cifs_unicode.h"
  28
  29 static LIST_HEAD(cifs_dfs_automount_list);
  30
  31 static void cifs_dfs_expire_automounts(struct work_struct *work);
  32 static DECLARE_DELAYED_WORK(cifs_dfs_automount_task,
  33                             cifs_dfs_expire_automounts);
  34 static int cifs_dfs_mountpoint_expiry_timeout = 500 * HZ;
  35
  36 static void cifs_dfs_expire_automounts(struct work_struct *work)
  37 {
  38         struct list_head *list = &cifs_dfs_automount_list;
  39
  40         mark_mounts_for_expiry(list);
  41         if (!list_empty(list))
  42                 schedule_delayed_work(&cifs_dfs_automount_task,
  43                                       cifs_dfs_mountpoint_expiry_timeout);
  44 }
  45
  46 void cifs_dfs_release_automount_timer(void)
  47 {
  48         BUG_ON(!list_empty(&cifs_dfs_automount_list));
  49         cancel_delayed_work_sync(&cifs_dfs_automount_task);
  50 }
  51
  52 /**
  53  * cifs_build_devname - build a devicename from a UNC and optional prepath
  54  * @nodename:   pointer to UNC string
  55  * @prepath:    pointer to prefixpath (or NULL if there isn't one)
  56  *
  57  * Build a new cifs devicename after chasing a DFS referral. Allocate a buffer
  58  * big enough to hold the final thing. Copy the UNC from the nodename, and
  59  * concatenate the prepath onto the end of it if there is one.
  60  *
  61  * Returns pointer to the built string, or a ERR_PTR. Caller is responsible
  62  * for freeing the returned string.
  63  */
  64 static char *
  65 cifs_build_devname(char *nodename, const char *prepath)
  66 {
  67         size_t pplen;
  68         size_t unclen;
  69         char *dev;
  70         char *pos;
  71
  72         /* skip over any preceding delimiters */
  73         nodename += strspn(nodename, "\\");
  74         if (!*nodename)
  75                 return ERR_PTR(-EINVAL);
  76
  77         /* get length of UNC and set pos to last char */
  78         unclen = strlen(nodename);
  79         pos = nodename + unclen - 1;
  80
  81         /* trim off any trailing delimiters */
  82         while (*pos == '\\') {
  83                 --pos;
  84                 --unclen;
  85         }
  86
  87         /* allocate a buffer:
  88          * +2 for preceding "//"
  89          * +1 for delimiter between UNC and prepath
  90          * +1 for trailing NULL
  91          */
  92         pplen = prepath ? strlen(prepath) : 0;
  93         dev = kmalloc(2 + unclen + 1 + pplen + 1, GFP_KERNEL);
  94         if (!dev)
  95                 return ERR_PTR(-ENOMEM);
  96
  97         pos = dev;
  98         /* add the initial "//" */
  99         *pos = '/';
 100         ++pos;
 101         *pos = '/';
 102         ++pos;
 103
 104         /* copy in the UNC portion from referral */
 105         memcpy(pos, nodename, unclen);
 106         pos += unclen;
 107
 108         /* copy the prefixpath remainder (if there is one) */
 109         if (pplen) {
 110                 *pos = '/';
 111                 ++pos;
 112                 memcpy(pos, prepath, pplen);
 113                 pos += pplen;
 114         }
 115
 116         /* NULL terminator */
 117         *pos = '\0';
 118
 119         convert_delimiter(dev, '/');
 120         return dev;
 121 }
 122
 123
 124 /**
 125  * cifs_compose_mount_options   -       creates mount options for refferral
 126  * @sb_mountdata:       parent/root DFS mount options (template)
 127  * @fullpath:           full path in UNC format
 128  * @ref:                server's referral
 129  * @devname:            optional pointer for saving device name
 130  *
 131  * creates mount options for submount based on template options sb_mountdata
 132  * and replacing unc,ip,prefixpath options with ones we've got form ref_unc.
 133  *
 134  * Returns: pointer to new mount options or ERR_PTR.
 135  * Caller is responcible for freeing retunrned value if it is not error.
 136  */
 137 char *cifs_compose_mount_options(const char *sb_mountdata,
 138                                    const char *fullpath,
 139                                    const struct dfs_info3_param *ref,
 140                                    char **devname)
 141 {
 142         int rc;
 143         char *name;
 144         char *mountdata = NULL;
 145         const char *prepath = NULL;
 146         int md_len;
 147         char *tkn_e;
 148         char *srvIP = NULL;
 149         char sep = ',';
 150         int off, noff;
 151
 152         if (sb_mountdata == NULL)
 153                 return ERR_PTR(-EINVAL);
 154
 155         if (strlen(fullpath) - ref->path_consumed) {
 156                 prepath = fullpath + ref->path_consumed;
 157                 /* skip initial delimiter */
 158                 if (*prepath == '/' || *prepath == '\\')
 159                         prepath++;
 160         }
 161
 162         name = cifs_build_devname(ref->node_name, prepath);
 163         if (IS_ERR(name)) {
 164                 rc = PTR_ERR(name);
 165                 name = NULL;
 166                 goto compose_mount_options_err;
 167         }
 168
 169         rc = dns_resolve_server_name_to_ip(name, &srvIP);
 170         if (rc < 0) {
 171                 cifs_dbg(FYI, "%s: Failed to resolve server part of %s to IP: %d\n",
 172                          __func__, name, rc);
 173                 goto compose_mount_options_err;
 174         }
 175
 176         /*
 177          * In most cases, we'll be building a shorter string than the original,
 178          * but we do have to assume that the address in the ip= option may be
 179          * much longer than the original. Add the max length of an address
 180          * string to the length of the original string to allow for worst case.
 181          */
 182         md_len = strlen(sb_mountdata) + INET6_ADDRSTRLEN;
 183         mountdata = kzalloc(md_len + sizeof("ip=") + 1, GFP_KERNEL);
 184         if (mountdata == NULL) {
 185                 rc = -ENOMEM;
 186                 goto compose_mount_options_err;
 187         }
 188
 189         /* copy all options except of unc,ip,prefixpath */
 190         off = 0;
 191         if (strncmp(sb_mountdata, "sep=", 4) == 0) {
 192                         sep = sb_mountdata[4];
 193                         strncpy(mountdata, sb_mountdata, 5);
 194                         off += 5;
 195         }
 196
 197         do {
 198                 tkn_e = strchr(sb_mountdata + off, sep);
 199                 if (tkn_e == NULL)
 200                         noff = strlen(sb_mountdata + off);
 201                 else
 202                         noff = tkn_e - (sb_mountdata + off) + 1;
 203
 204                 if (strncasecmp(sb_mountdata + off, "unc=", 4) == 0) {
 205                         off += noff;
 206                         continue;
 207                 }
 208                 if (strncasecmp(sb_mountdata + off, "ip=", 3) == 0) {
 209                         off += noff;
 210                         continue;
 211                 }
 212                 if (strncasecmp(sb_mountdata + off, "prefixpath=", 11) == 0) {
 213                         off += noff;
 214                         continue;
 215                 }
 216                 strncat(mountdata, sb_mountdata + off, noff);
 217                 off += noff;
 218         } while (tkn_e);
 219         strcat(mountdata, sb_mountdata + off);
 220         mountdata[md_len] = '\0';
 221
 222         /* copy new IP and ref share name */
 223         if (mountdata[strlen(mountdata) - 1] != sep)
 224                 strncat(mountdata, &sep, 1);
 225         strcat(mountdata, "ip=");
 226         strcat(mountdata, srvIP);
 227
 228         if (devname)
 229                 *devname = name;
 230
 231         /*cifs_dbg(FYI, "%s: parent mountdata: %s\n", __func__, sb_mountdata);*/
 232         /*cifs_dbg(FYI, "%s: submount mountdata: %s\n", __func__, mountdata );*/
 233
 234 compose_mount_options_out:
 235         kfree(srvIP);
 236         return mountdata;
 237
 238 compose_mount_options_err:
 239         kfree(mountdata);
 240         mountdata = ERR_PTR(rc);
 241         kfree(name);
 242         goto compose_mount_options_out;
 243 }
 244
 245 /**
 246  * cifs_dfs_do_refmount - mounts specified path using provided refferal
 247  * @cifs_sb:            parent/root superblock
 248  * @fullpath:           full path in UNC format
 249  * @ref:                server's referral
 250  */
 251 static struct vfsmount *cifs_dfs_do_refmount(struct dentry *mntpt,
 252                 struct cifs_sb_info *cifs_sb,
 253                 const char *fullpath, const struct dfs_info3_param *ref)
 254 {
 255         struct vfsmount *mnt;
 256         char *mountdata;
 257         char *devname = NULL;
 258
 259         /* strip first '\' from fullpath */
 260         mountdata = cifs_compose_mount_options(cifs_sb->mountdata,
 261                         fullpath + 1, ref, &devname);
 262
 263         if (IS_ERR(mountdata))
 264                 return (struct vfsmount *)mountdata;
 265
 266         mnt = vfs_submount(mntpt, &cifs_fs_type, devname, mountdata);
 267         kfree(mountdata);
 268         kfree(devname);
 269         return mnt;
 270
 271 }
 272
 273 static void dump_referral(const struct dfs_info3_param *ref)
 274 {
 275         cifs_dbg(FYI, "DFS: ref path: %s\n", ref->path_name);
 276         cifs_dbg(FYI, "DFS: node path: %s\n", ref->node_name);
 277         cifs_dbg(FYI, "DFS: fl: %hd, srv_type: %hd\n",
 278                  ref->flags, ref->server_type);
 279         cifs_dbg(FYI, "DFS: ref_flags: %hd, path_consumed: %hd\n",
 280                  ref->ref_flag, ref->path_consumed);
 281 }
 282
 283 /*
 284  * Create a vfsmount that we can automount
 285  */
 286 static struct vfsmount *cifs_dfs_do_automount(struct dentry *mntpt)
 287 {
 288         struct dfs_info3_param *referrals = NULL;
 289         unsigned int num_referrals = 0;
 290         struct cifs_sb_info *cifs_sb;
 291         struct cifs_ses *ses;
 292         char *full_path;
 293         unsigned int xid;
 294         int i;
 295         int rc;
 296         struct vfsmount *mnt;
 297         struct tcon_link *tlink;
 298
 299         cifs_dbg(FYI, "in %s\n", __func__);
 300         BUG_ON(IS_ROOT(mntpt));
 301
 302         /*
 303          * The MSDFS spec states that paths in DFS referral requests and
 304          * responses must be prefixed by a single '\' character instead of
 305          * the double backslashes usually used in the UNC. This function
 306          * gives us the latter, so we must adjust the result.
 307          */
 308         mnt = ERR_PTR(-ENOMEM);
 309
 310         cifs_sb = CIFS_SB(mntpt->d_sb);
 311         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_NO_DFS) {
 312                 mnt = ERR_PTR(-EREMOTE);
 313                 goto cdda_exit;
 314         }
 315
 316         /* always use tree name prefix */
 317         full_path = build_path_from_dentry_optional_prefix(mntpt, true);
 318         if (full_path == NULL)
 319                 goto cdda_exit;
 320
 321         tlink = cifs_sb_tlink(cifs_sb);
 322         if (IS_ERR(tlink)) {
 323                 mnt = ERR_CAST(tlink);
 324                 goto free_full_path;
 325         }
 326         ses = tlink_tcon(tlink)->ses;
 327
 328         xid = get_xid();
 329         rc = get_dfs_path(xid, ses, full_path + 1, cifs_sb->local_nls,
 330                 &num_referrals, &referrals,
 331                 cifs_remap(cifs_sb));
 332         free_xid(xid);
 333
 334         cifs_put_tlink(tlink);
 335
 336         mnt = ERR_PTR(-ENOENT);
 337         for (i = 0; i < num_referrals; i++) {
 338                 int len;
 339                 dump_referral(referrals + i);
 340                 /* connect to a node */
 341                 len = strlen(referrals[i].node_name);
 342                 if (len < 2) {
 343                         cifs_dbg(VFS, "%s: Net Address path too short: %s\n",
 344                                  __func__, referrals[i].node_name);
 345                         mnt = ERR_PTR(-EINVAL);
 346                         break;
 347                 }
 348                 mnt = cifs_dfs_do_refmount(mntpt, cifs_sb,
 349                                 full_path, referrals + i);
 350                 cifs_dbg(FYI, "%s: cifs_dfs_do_refmount:%s , mnt:%p\n",
 351                          __func__, referrals[i].node_name, mnt);
 352                 if (!IS_ERR(mnt))
 353                         goto success;
 354         }
 355
 356         /* no valid submounts were found; return error from get_dfs_path() by
 357          * preference */
 358         if (rc != 0)
 359                 mnt = ERR_PTR(rc);
 360
 361 success:
 362         free_dfs_info_array(referrals, num_referrals);
 363 free_full_path:
 364         kfree(full_path);
 365 cdda_exit:
 366         cifs_dbg(FYI, "leaving %s\n" , __func__);
 367         return mnt;
 368 }
 369
 370 /*
 371  * Attempt to automount the referral
 372  */
 373 struct vfsmount *cifs_dfs_d_automount(struct path *path)
 374 {
 375         struct vfsmount *newmnt;
 376
 377         cifs_dbg(FYI, "in %s\n", __func__);
 378
 379         newmnt = cifs_dfs_do_automount(path->dentry);
 380         if (IS_ERR(newmnt)) {
 381                 cifs_dbg(FYI, "leaving %s [automount failed]\n" , __func__);
 382                 return newmnt;
 383         }
 384
 385         mntget(newmnt); /* prevent immediate expiration */
 386         mnt_set_expiry(newmnt, &cifs_dfs_automount_list);
 387         schedule_delayed_work(&cifs_dfs_automount_task,
 388                               cifs_dfs_mountpoint_expiry_timeout);
 389         cifs_dbg(FYI, "leaving %s [ok]\n" , __func__);
 390         return newmnt;
 391 }
 392
 393 const struct inode_operations cifs_dfs_referral_inode_operations = {
 394 };