1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Contains the CIFS DFS referral mounting routines used for handling
4 * traversal via DFS junction point
6 * Copyright (c) 2007 Igor Mammedov
7 * Copyright (C) International Business Machines Corp., 2008
8 * Author(s): Igor Mammedov (niallain@gmail.com)
9 * Steve French (sfrench@us.ibm.com)
12 #include <linux/dcache.h>
13 #include <linux/mount.h>
14 #include <linux/namei.h>
15 #include <linux/slab.h>
16 #include <linux/vfs.h>
18 #include <linux/inet.h>
20 #include "cifsproto.h"
22 #include "dns_resolve.h"
23 #include "cifs_debug.h"
24 #include "cifs_unicode.h"
25 #include "dfs_cache.h"
26 #include "fs_context.h"
28 static LIST_HEAD(cifs_dfs_automount_list);
30 static void cifs_dfs_expire_automounts(struct work_struct *work);
31 static DECLARE_DELAYED_WORK(cifs_dfs_automount_task,
32 cifs_dfs_expire_automounts);
33 static int cifs_dfs_mountpoint_expiry_timeout = 500 * HZ;
35 static void cifs_dfs_expire_automounts(struct work_struct *work)
37 struct list_head *list = &cifs_dfs_automount_list;
39 mark_mounts_for_expiry(list);
40 if (!list_empty(list))
41 schedule_delayed_work(&cifs_dfs_automount_task,
42 cifs_dfs_mountpoint_expiry_timeout);
45 void cifs_dfs_release_automount_timer(void)
47 BUG_ON(!list_empty(&cifs_dfs_automount_list));
48 cancel_delayed_work_sync(&cifs_dfs_automount_task);
52 * cifs_build_devname - build a devicename from a UNC and optional prepath
53 * @nodename: pointer to UNC string
54 * @prepath: pointer to prefixpath (or NULL if there isn't one)
56 * Build a new cifs devicename after chasing a DFS referral. Allocate a buffer
57 * big enough to hold the final thing. Copy the UNC from the nodename, and
58 * concatenate the prepath onto the end of it if there is one.
60 * Returns pointer to the built string, or a ERR_PTR. Caller is responsible
61 * for freeing the returned string.
64 cifs_build_devname(char *nodename, const char *prepath)
71 /* skip over any preceding delimiters */
72 nodename += strspn(nodename, "\\");
74 return ERR_PTR(-EINVAL);
76 /* get length of UNC and set pos to last char */
77 unclen = strlen(nodename);
78 pos = nodename + unclen - 1;
80 /* trim off any trailing delimiters */
81 while (*pos == '\\') {
87 * +2 for preceding "//"
88 * +1 for delimiter between UNC and prepath
89 * +1 for trailing NULL
91 pplen = prepath ? strlen(prepath) : 0;
92 dev = kmalloc(2 + unclen + 1 + pplen + 1, GFP_KERNEL);
94 return ERR_PTR(-ENOMEM);
97 /* add the initial "//" */
103 /* copy in the UNC portion from referral */
104 memcpy(pos, nodename, unclen);
107 /* copy the prefixpath remainder (if there is one) */
111 memcpy(pos, prepath, pplen);
115 /* NULL terminator */
118 convert_delimiter(dev, '/');
124 * cifs_compose_mount_options - creates mount options for referral
125 * @sb_mountdata: parent/root DFS mount options (template)
126 * @fullpath: full path in UNC format
127 * @ref: optional server's referral
128 * @devname: return the built cifs device name if passed pointer not NULL
129 * creates mount options for submount based on template options sb_mountdata
130 * and replacing unc,ip,prefixpath options with ones we've got form ref_unc.
132 * Returns: pointer to new mount options or ERR_PTR.
133 * Caller is responsible for freeing returned value if it is not error.
135 char *cifs_compose_mount_options(const char *sb_mountdata,
136 const char *fullpath,
137 const struct dfs_info3_param *ref,
142 char *mountdata = NULL;
143 const char *prepath = NULL;
150 if (sb_mountdata == NULL)
151 return ERR_PTR(-EINVAL);
154 if (WARN_ON_ONCE(!ref->node_name || ref->path_consumed < 0))
155 return ERR_PTR(-EINVAL);
157 if (strlen(fullpath) - ref->path_consumed) {
158 prepath = fullpath + ref->path_consumed;
159 /* skip initial delimiter */
160 if (*prepath == '/' || *prepath == '\\')
164 name = cifs_build_devname(ref->node_name, prepath);
168 goto compose_mount_options_err;
171 name = cifs_build_devname((char *)fullpath, NULL);
175 goto compose_mount_options_err;
179 rc = dns_resolve_server_name_to_ip(name, &srvIP, NULL);
181 cifs_dbg(FYI, "%s: Failed to resolve server part of %s to IP: %d\n",
183 goto compose_mount_options_err;
187 * In most cases, we'll be building a shorter string than the original,
188 * but we do have to assume that the address in the ip= option may be
189 * much longer than the original. Add the max length of an address
190 * string to the length of the original string to allow for worst case.
192 md_len = strlen(sb_mountdata) + INET6_ADDRSTRLEN;
193 mountdata = kzalloc(md_len + sizeof("ip=") + 1, GFP_KERNEL);
194 if (mountdata == NULL) {
196 goto compose_mount_options_err;
199 /* copy all options except of unc,ip,prefixpath */
201 if (strncmp(sb_mountdata, "sep=", 4) == 0) {
202 sep = sb_mountdata[4];
203 strncpy(mountdata, sb_mountdata, 5);
208 tkn_e = strchr(sb_mountdata + off, sep);
210 noff = strlen(sb_mountdata + off);
212 noff = tkn_e - (sb_mountdata + off) + 1;
214 if (strncasecmp(sb_mountdata + off, "cruid=", 6) == 0) {
218 if (strncasecmp(sb_mountdata + off, "unc=", 4) == 0) {
222 if (strncasecmp(sb_mountdata + off, "ip=", 3) == 0) {
226 if (strncasecmp(sb_mountdata + off, "prefixpath=", 11) == 0) {
230 strncat(mountdata, sb_mountdata + off, noff);
233 strcat(mountdata, sb_mountdata + off);
234 mountdata[md_len] = '\0';
236 /* copy new IP and ref share name */
237 if (mountdata[strlen(mountdata) - 1] != sep)
238 strncat(mountdata, &sep, 1);
239 strcat(mountdata, "ip=");
240 strcat(mountdata, srvIP);
247 /*cifs_dbg(FYI, "%s: parent mountdata: %s\n", __func__, sb_mountdata);*/
248 /*cifs_dbg(FYI, "%s: submount mountdata: %s\n", __func__, mountdata );*/
250 compose_mount_options_out:
254 compose_mount_options_err:
256 mountdata = ERR_PTR(rc);
258 goto compose_mount_options_out;
262 * Create a vfsmount that we can automount
264 static struct vfsmount *cifs_dfs_do_automount(struct path *path)
267 struct dentry *mntpt = path->dentry;
268 struct fs_context *fc;
269 struct cifs_sb_info *cifs_sb;
271 struct smb3_fs_context *ctx, *cur_ctx;
272 struct smb3_fs_context tmp;
274 struct vfsmount *mnt;
277 return ERR_PTR(-ESTALE);
280 * The MSDFS spec states that paths in DFS referral requests and
281 * responses must be prefixed by a single '\' character instead of
282 * the double backslashes usually used in the UNC. This function
283 * gives us the latter, so we must adjust the result.
285 cifs_sb = CIFS_SB(mntpt->d_sb);
286 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_NO_DFS)
287 return ERR_PTR(-EREMOTE);
289 cur_ctx = cifs_sb->ctx;
291 fc = fs_context_for_submount(path->mnt->mnt_sb->s_type, mntpt);
295 ctx = smb3_fc2context(fc);
297 page = alloc_dentry_path();
298 /* always use tree name prefix */
299 full_path = build_path_from_dentry_optional_prefix(mntpt, page, true);
300 if (IS_ERR(full_path)) {
301 mnt = ERR_CAST(full_path);
305 convert_delimiter(full_path, '/');
306 cifs_dbg(FYI, "%s: full_path: %s\n", __func__, full_path);
309 tmp.source = full_path;
310 tmp.UNC = tmp.prepath = NULL;
312 rc = smb3_fs_context_dup(ctx, &tmp);
318 rc = smb3_parse_devname(full_path, ctx);
326 free_dentry_path(page);
331 * Attempt to automount the referral
333 struct vfsmount *cifs_dfs_d_automount(struct path *path)
335 struct vfsmount *newmnt;
337 cifs_dbg(FYI, "%s: %pd\n", __func__, path->dentry);
339 newmnt = cifs_dfs_do_automount(path);
340 if (IS_ERR(newmnt)) {
341 cifs_dbg(FYI, "leaving %s [automount failed]\n" , __func__);
345 mntget(newmnt); /* prevent immediate expiration */
346 mnt_set_expiry(newmnt, &cifs_dfs_automount_list);
347 schedule_delayed_work(&cifs_dfs_automount_task,
348 cifs_dfs_mountpoint_expiry_timeout);
349 cifs_dbg(FYI, "leaving %s [ok]\n" , __func__);
353 const struct inode_operations cifs_dfs_referral_inode_operations = {