blob: e956cba94338184416c96925690f21493fc61ab6 [file] [log] [blame]
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +00001/*
2 * Contains the CIFS DFS referral mounting routines used for handling
3 * traversal via DFS junction point
4 *
5 * Copyright (c) 2007 Igor Mammedov
Steve French366781c2008-01-25 10:12:41 +00006 * Copyright (C) International Business Machines Corp., 2008
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +00007 * Author(s): Igor Mammedov (niallain@gmail.com)
Steve French366781c2008-01-25 10:12:41 +00008 * Steve French (sfrench@us.ibm.com)
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +00009 * 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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090018#include <linux/slab.h>
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000019#include <linux/vfs.h>
20#include <linux/fs.h>
Jeff Layton166faf22013-05-24 07:40:04 -040021#include <linux/inet.h>
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000022#include "cifsglob.h"
23#include "cifsproto.h"
24#include "cifsfs.h"
25#include "dns_resolve.h"
26#include "cifs_debug.h"
Nakajima Akirabc8ebdc42015-02-13 15:35:58 +090027#include "cifs_unicode.h"
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000028
Steve French8d142132008-04-16 03:56:51 +000029static LIST_HEAD(cifs_dfs_automount_list);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000030
Igor Mammedov78d31a32008-04-24 12:56:07 +040031static void cifs_dfs_expire_automounts(struct work_struct *work);
32static DECLARE_DELAYED_WORK(cifs_dfs_automount_task,
33 cifs_dfs_expire_automounts);
34static int cifs_dfs_mountpoint_expiry_timeout = 500 * HZ;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000035
Igor Mammedov78d31a32008-04-24 12:56:07 +040036static void cifs_dfs_expire_automounts(struct work_struct *work)
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000037{
Igor Mammedov78d31a32008-04-24 12:56:07 +040038 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
46void cifs_dfs_release_automount_timer(void)
47{
48 BUG_ON(!list_empty(&cifs_dfs_automount_list));
Tejun Heo3e24e132010-10-19 17:55:54 +020049 cancel_delayed_work_sync(&cifs_dfs_automount_task);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000050}
51
52/**
Jeff Laytond9deef02013-05-24 07:40:06 -040053 * 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)
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000056 *
Jeff Laytond9deef02013-05-24 07:40:06 -040057 * 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.
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000063 */
Jeff Laytond9deef02013-05-24 07:40:06 -040064static char *
65cifs_build_devname(char *nodename, const char *prepath)
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000066{
Jeff Laytond9deef02013-05-24 07:40:06 -040067 size_t pplen;
68 size_t unclen;
69 char *dev;
70 char *pos;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000071
Jeff Laytond9deef02013-05-24 07:40:06 -040072 /* 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)
Jeff Layton7b91e262009-07-23 15:22:30 -040095 return ERR_PTR(-ENOMEM);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +000096
Jeff Laytond9deef02013-05-24 07:40:06 -040097 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;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000114 }
115
Jeff Laytond9deef02013-05-24 07:40:06 -0400116 /* NULL terminator */
117 *pos = '\0';
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000118
Jeff Laytond9deef02013-05-24 07:40:06 -0400119 convert_delimiter(dev, '/');
120 return dev;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000121}
122
123
124/**
Steve Frenchc6c00912009-03-18 05:50:07 +0000125 * cifs_compose_mount_options - creates mount options for refferral
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000126 * @sb_mountdata: parent/root DFS mount options (template)
Steve Frenchc6c00912009-03-18 05:50:07 +0000127 * @fullpath: full path in UNC format
Igor Mammedov2c556082008-10-23 13:58:42 +0400128 * @ref: server's referral
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000129 * @devname: 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 */
Steve Frenchc6c00912009-03-18 05:50:07 +0000137char *cifs_compose_mount_options(const char *sb_mountdata,
138 const char *fullpath,
Igor Mammedov2c556082008-10-23 13:58:42 +0400139 const struct dfs_info3_param *ref,
Steve French366781c2008-01-25 10:12:41 +0000140 char **devname)
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000141{
142 int rc;
Steve Frenchc6fbba02008-12-18 01:41:20 +0000143 char *mountdata = NULL;
Jeff Laytond9deef02013-05-24 07:40:06 -0400144 const char *prepath = NULL;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000145 int md_len;
146 char *tkn_e;
147 char *srvIP = NULL;
148 char sep = ',';
149 int off, noff;
150
151 if (sb_mountdata == NULL)
152 return ERR_PTR(-EINVAL);
153
Jeff Laytond9deef02013-05-24 07:40:06 -0400154 if (strlen(fullpath) - ref->path_consumed)
155 prepath = fullpath + ref->path_consumed;
156
157 *devname = cifs_build_devname(ref->node_name, prepath);
Jeff Layton7b91e262009-07-23 15:22:30 -0400158 if (IS_ERR(*devname)) {
159 rc = PTR_ERR(*devname);
160 *devname = NULL;
161 goto compose_mount_options_err;
162 }
163
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000164 rc = dns_resolve_server_name_to_ip(*devname, &srvIP);
David Howells67b76262010-07-22 18:33:01 +0100165 if (rc < 0) {
Joe Perchesf96637b2013-05-04 22:12:25 -0500166 cifs_dbg(FYI, "%s: Failed to resolve server part of %s to IP: %d\n",
167 __func__, *devname, rc);
Steve Frenchc6fbba02008-12-18 01:41:20 +0000168 goto compose_mount_options_err;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000169 }
Jeff Laytonb8028982011-07-26 12:20:18 -0400170
Jeff Laytond9deef02013-05-24 07:40:06 -0400171 /*
172 * In most cases, we'll be building a shorter string than the original,
173 * but we do have to assume that the address in the ip= option may be
174 * much longer than the original. Add the max length of an address
175 * string to the length of the original string to allow for worst case.
Igor Mammedov2c556082008-10-23 13:58:42 +0400176 */
Jeff Laytond9deef02013-05-24 07:40:06 -0400177 md_len = strlen(sb_mountdata) + INET6_ADDRSTRLEN;
Insu Yunf34d69c2016-02-01 11:34:58 -0500178 mountdata = kzalloc(md_len + sizeof("ip=") + 1, GFP_KERNEL);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000179 if (mountdata == NULL) {
Steve Frenchc6fbba02008-12-18 01:41:20 +0000180 rc = -ENOMEM;
181 goto compose_mount_options_err;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000182 }
183
184 /* copy all options except of unc,ip,prefixpath */
185 off = 0;
186 if (strncmp(sb_mountdata, "sep=", 4) == 0) {
187 sep = sb_mountdata[4];
188 strncpy(mountdata, sb_mountdata, 5);
189 off += 5;
190 }
Igor Mammedov2c556082008-10-23 13:58:42 +0400191
192 do {
193 tkn_e = strchr(sb_mountdata + off, sep);
194 if (tkn_e == NULL)
195 noff = strlen(sb_mountdata + off);
196 else
197 noff = tkn_e - (sb_mountdata + off) + 1;
198
Rasmus Villemoes87e747c2014-10-13 15:54:35 -0700199 if (strncasecmp(sb_mountdata + off, "unc=", 4) == 0) {
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000200 off += noff;
201 continue;
202 }
Rasmus Villemoes87e747c2014-10-13 15:54:35 -0700203 if (strncasecmp(sb_mountdata + off, "ip=", 3) == 0) {
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000204 off += noff;
205 continue;
206 }
Rasmus Villemoes87e747c2014-10-13 15:54:35 -0700207 if (strncasecmp(sb_mountdata + off, "prefixpath=", 11) == 0) {
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000208 off += noff;
209 continue;
210 }
Igor Mammedov2c556082008-10-23 13:58:42 +0400211 strncat(mountdata, sb_mountdata + off, noff);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000212 off += noff;
Igor Mammedov2c556082008-10-23 13:58:42 +0400213 } while (tkn_e);
214 strcat(mountdata, sb_mountdata + off);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000215 mountdata[md_len] = '\0';
216
217 /* copy new IP and ref share name */
Igor Mammedov2c556082008-10-23 13:58:42 +0400218 if (mountdata[strlen(mountdata) - 1] != sep)
219 strncat(mountdata, &sep, 1);
220 strcat(mountdata, "ip=");
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000221 strcat(mountdata, srvIP);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000222
Joe Perchesf96637b2013-05-04 22:12:25 -0500223 /*cifs_dbg(FYI, "%s: parent mountdata: %s\n", __func__, sb_mountdata);*/
224 /*cifs_dbg(FYI, "%s: submount mountdata: %s\n", __func__, mountdata );*/
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000225
226compose_mount_options_out:
227 kfree(srvIP);
228 return mountdata;
Steve Frenchc6fbba02008-12-18 01:41:20 +0000229
230compose_mount_options_err:
231 kfree(mountdata);
232 mountdata = ERR_PTR(rc);
Cong Ding10b8c7d2013-01-22 19:20:58 -0500233 kfree(*devname);
234 *devname = NULL;
Steve Frenchc6fbba02008-12-18 01:41:20 +0000235 goto compose_mount_options_out;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000236}
237
Steve Frenchf67909c2010-07-26 18:20:16 +0000238/**
239 * cifs_dfs_do_refmount - mounts specified path using provided refferal
240 * @cifs_sb: parent/root superblock
241 * @fullpath: full path in UNC format
242 * @ref: server's referral
243 */
244static struct vfsmount *cifs_dfs_do_refmount(struct cifs_sb_info *cifs_sb,
245 const char *fullpath, const struct dfs_info3_param *ref)
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000246{
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000247 struct vfsmount *mnt;
248 char *mountdata;
Steve French366781c2008-01-25 10:12:41 +0000249 char *devname = NULL;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000250
Steve Frenchf67909c2010-07-26 18:20:16 +0000251 /* strip first '\' from fullpath */
Steve Frenchc6c00912009-03-18 05:50:07 +0000252 mountdata = cifs_compose_mount_options(cifs_sb->mountdata,
253 fullpath + 1, ref, &devname);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000254
255 if (IS_ERR(mountdata))
256 return (struct vfsmount *)mountdata;
257
258 mnt = vfs_kern_mount(&cifs_fs_type, 0, devname, mountdata);
259 kfree(mountdata);
260 kfree(devname);
261 return mnt;
262
263}
264
Steve French366781c2008-01-25 10:12:41 +0000265static void dump_referral(const struct dfs_info3_param *ref)
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000266{
Joe Perchesf96637b2013-05-04 22:12:25 -0500267 cifs_dbg(FYI, "DFS: ref path: %s\n", ref->path_name);
268 cifs_dbg(FYI, "DFS: node path: %s\n", ref->node_name);
269 cifs_dbg(FYI, "DFS: fl: %hd, srv_type: %hd\n",
270 ref->flags, ref->server_type);
271 cifs_dbg(FYI, "DFS: ref_flags: %hd, path_consumed: %hd\n",
272 ref->ref_flag, ref->path_consumed);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000273}
274
David Howells01c64fe2011-01-14 18:45:47 +0000275/*
276 * Create a vfsmount that we can automount
277 */
278static struct vfsmount *cifs_dfs_do_automount(struct dentry *mntpt)
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000279{
280 struct dfs_info3_param *referrals = NULL;
281 unsigned int num_referrals = 0;
282 struct cifs_sb_info *cifs_sb;
Steve French96daf2b2011-05-27 04:34:02 +0000283 struct cifs_ses *ses;
David Howells01c64fe2011-01-14 18:45:47 +0000284 char *full_path;
Pavel Shilovsky6d5786a2012-06-20 11:21:16 +0400285 unsigned int xid;
286 int i;
David Howells01c64fe2011-01-14 18:45:47 +0000287 int rc;
288 struct vfsmount *mnt;
Jeff Layton7ffec372010-09-29 19:51:11 -0400289 struct tcon_link *tlink;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000290
Joe Perchesf96637b2013-05-04 22:12:25 -0500291 cifs_dbg(FYI, "in %s\n", __func__);
David Howells01c64fe2011-01-14 18:45:47 +0000292 BUG_ON(IS_ROOT(mntpt));
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000293
Steve Frenchc6fbba02008-12-18 01:41:20 +0000294 /*
295 * The MSDFS spec states that paths in DFS referral requests and
296 * responses must be prefixed by a single '\' character instead of
297 * the double backslashes usually used in the UNC. This function
298 * gives us the latter, so we must adjust the result.
299 */
David Howells01c64fe2011-01-14 18:45:47 +0000300 mnt = ERR_PTR(-ENOMEM);
301 full_path = build_path_from_dentry(mntpt);
302 if (full_path == NULL)
Jeff Layton31c26592011-01-31 07:24:46 -0500303 goto cdda_exit;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000304
David Howells2b0143b2015-03-17 22:25:59 +0000305 cifs_sb = CIFS_SB(d_inode(mntpt)->i_sb);
Jeff Layton7ffec372010-09-29 19:51:11 -0400306 tlink = cifs_sb_tlink(cifs_sb);
307 if (IS_ERR(tlink)) {
David Howells01c64fe2011-01-14 18:45:47 +0000308 mnt = ERR_CAST(tlink);
309 goto free_full_path;
Jeff Layton7ffec372010-09-29 19:51:11 -0400310 }
311 ses = tlink_tcon(tlink)->ses;
312
Pavel Shilovsky6d5786a2012-06-20 11:21:16 +0400313 xid = get_xid();
Jeff Layton7ffec372010-09-29 19:51:11 -0400314 rc = get_dfs_path(xid, ses, full_path + 1, cifs_sb->local_nls,
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000315 &num_referrals, &referrals,
Nakajima Akirabc8ebdc42015-02-13 15:35:58 +0900316 cifs_remap(cifs_sb));
Pavel Shilovsky6d5786a2012-06-20 11:21:16 +0400317 free_xid(xid);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000318
Jeff Layton7ffec372010-09-29 19:51:11 -0400319 cifs_put_tlink(tlink);
320
David Howells01c64fe2011-01-14 18:45:47 +0000321 mnt = ERR_PTR(-ENOENT);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000322 for (i = 0; i < num_referrals; i++) {
Steve Frenchcf398e32009-05-01 03:50:42 +0000323 int len;
David Howells01c64fe2011-01-14 18:45:47 +0000324 dump_referral(referrals + i);
Igor Mammedov1af28ce2009-03-17 19:00:30 +0300325 /* connect to a node */
Igor Mammedov1af28ce2009-03-17 19:00:30 +0300326 len = strlen(referrals[i].node_name);
327 if (len < 2) {
Joe Perchesf96637b2013-05-04 22:12:25 -0500328 cifs_dbg(VFS, "%s: Net Address path too short: %s\n",
329 __func__, referrals[i].node_name);
David Howells01c64fe2011-01-14 18:45:47 +0000330 mnt = ERR_PTR(-EINVAL);
331 break;
Igor Mammedov1af28ce2009-03-17 19:00:30 +0300332 }
Steve Frenchf67909c2010-07-26 18:20:16 +0000333 mnt = cifs_dfs_do_refmount(cifs_sb,
334 full_path, referrals + i);
Joe Perchesf96637b2013-05-04 22:12:25 -0500335 cifs_dbg(FYI, "%s: cifs_dfs_do_refmount:%s , mnt:%p\n",
336 __func__, referrals[i].node_name, mnt);
Igor Mammedov1af28ce2009-03-17 19:00:30 +0300337 if (!IS_ERR(mnt))
David Howells01c64fe2011-01-14 18:45:47 +0000338 goto success;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000339 }
340
David Howells01c64fe2011-01-14 18:45:47 +0000341 /* no valid submounts were found; return error from get_dfs_path() by
342 * preference */
343 if (rc != 0)
344 mnt = ERR_PTR(rc);
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000345
David Howells01c64fe2011-01-14 18:45:47 +0000346success:
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000347 free_dfs_info_array(referrals, num_referrals);
David Howells01c64fe2011-01-14 18:45:47 +0000348free_full_path:
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000349 kfree(full_path);
Jeff Layton31c26592011-01-31 07:24:46 -0500350cdda_exit:
Joe Perchesf96637b2013-05-04 22:12:25 -0500351 cifs_dbg(FYI, "leaving %s\n" , __func__);
David Howells01c64fe2011-01-14 18:45:47 +0000352 return mnt;
353}
354
355/*
356 * Attempt to automount the referral
357 */
358struct vfsmount *cifs_dfs_d_automount(struct path *path)
359{
360 struct vfsmount *newmnt;
David Howells01c64fe2011-01-14 18:45:47 +0000361
Joe Perchesf96637b2013-05-04 22:12:25 -0500362 cifs_dbg(FYI, "in %s\n", __func__);
David Howells01c64fe2011-01-14 18:45:47 +0000363
364 newmnt = cifs_dfs_do_automount(path->dentry);
365 if (IS_ERR(newmnt)) {
Joe Perchesf96637b2013-05-04 22:12:25 -0500366 cifs_dbg(FYI, "leaving %s [automount failed]\n" , __func__);
David Howells01c64fe2011-01-14 18:45:47 +0000367 return newmnt;
368 }
369
David Howellsea5b7782011-01-14 19:10:03 +0000370 mntget(newmnt); /* prevent immediate expiration */
371 mnt_set_expiry(newmnt, &cifs_dfs_automount_list);
372 schedule_delayed_work(&cifs_dfs_automount_task,
373 cifs_dfs_mountpoint_expiry_timeout);
Joe Perchesf96637b2013-05-04 22:12:25 -0500374 cifs_dbg(FYI, "leaving %s [ok]\n" , __func__);
David Howellsea5b7782011-01-14 19:10:03 +0000375 return newmnt;
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000376}
377
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700378const struct inode_operations cifs_dfs_referral_inode_operations = {
Igor Mammedov6d5ae0d2008-01-25 03:28:31 +0000379};