2 * linux/fs/nfs/nfs4namespace.c
4 * Copyright (C) 2005 Trond Myklebust <Trond.Myklebust@netapp.com>
5 * - Modified by David Howells <dhowells@redhat.com>
10 #include <linux/dcache.h>
11 #include <linux/mount.h>
12 #include <linux/namei.h>
13 #include <linux/nfs_fs.h>
14 #include <linux/nfs_mount.h>
15 #include <linux/slab.h>
16 #include <linux/string.h>
17 #include <linux/sunrpc/clnt.h>
18 #include <linux/sunrpc/addr.h>
19 #include <linux/vfs.h>
20 #include <linux/inet.h>
23 #include "dns_resolve.h"
25 #define NFSDBG_FACILITY NFSDBG_VFS
28 * Convert the NFSv4 pathname components into a standard posix path.
30 * Note that the resulting string will be placed at the end of the buffer
32 static inline char *nfs4_pathname_string(const struct nfs4_pathname *pathname,
33 char *buffer, ssize_t buflen)
35 char *end = buffer + buflen;
41 n = pathname->ncomponents;
43 const struct nfs4_string *component = &pathname->components[n];
44 buflen -= component->len + 1;
47 end -= component->len;
48 memcpy(end, component->data, component->len);
53 return ERR_PTR(-ENAMETOOLONG);
57 * return the path component of "<server>:<path>"
58 * nfspath - the "<server>:<path>" string
59 * end - one past the last char that could contain "<server>:"
60 * returns NULL on failure
62 static char *nfs_path_component(const char *nfspath, const char *end)
66 if (*nfspath == '[') {
67 /* parse [] escaped IPv6 addrs */
68 p = strchr(nfspath, ']');
69 if (p != NULL && ++p < end && *p == ':')
72 /* otherwise split on first colon */
73 p = strchr(nfspath, ':');
74 if (p != NULL && p < end)
81 * Determine the mount path as a string
83 static char *nfs4_path(struct dentry *dentry, char *buffer, ssize_t buflen)
86 char *path = nfs_path(&limit, dentry, buffer, buflen,
89 char *path_component = nfs_path_component(path, limit);
91 return path_component;
97 * Check that fs_locations::fs_root [RFC3530 6.3] is a prefix for what we
98 * believe to be the server path to this dentry
100 static int nfs4_validate_fspath(struct dentry *dentry,
101 const struct nfs4_fs_locations *locations,
102 char *page, char *page2)
104 const char *path, *fs_path;
106 path = nfs4_path(dentry, page, PAGE_SIZE);
108 return PTR_ERR(path);
110 fs_path = nfs4_pathname_string(&locations->fs_path, page2, PAGE_SIZE);
112 return PTR_ERR(fs_path);
114 if (strncmp(path, fs_path, strlen(fs_path)) != 0) {
115 dprintk("%s: path %s does not begin with fsroot %s\n",
116 __func__, path, fs_path);
123 static size_t nfs_parse_server_name(char *string, size_t len,
124 struct sockaddr *sa, size_t salen, struct net *net)
128 ret = rpc_pton(net, string, len, sa, salen);
130 ret = nfs_dns_resolve_name(net, string, len, sa, salen);
138 * nfs_find_best_sec - Find a security mechanism supported locally
139 * @server: NFS server struct
140 * @flavors: List of security tuples returned by SECINFO procedure
142 * Return an rpc client that uses the first security mechanism in
143 * "flavors" that is locally supported. The "flavors" array
144 * is searched in the order returned from the server, per RFC 3530
145 * recommendation and each flavor is checked for membership in the
146 * sec= mount option list if it exists.
148 * Return -EPERM if no matching flavor is found in the array.
150 * Please call rpc_shutdown_client() when you are done with this rpc client.
153 static struct rpc_clnt *nfs_find_best_sec(struct rpc_clnt *clnt,
154 struct nfs_server *server,
155 struct nfs4_secinfo_flavors *flavors)
157 rpc_authflavor_t pflavor;
158 struct nfs4_secinfo4 *secinfo;
161 for (i = 0; i < flavors->num_flavors; i++) {
162 secinfo = &flavors->flavors[i];
164 switch (secinfo->flavor) {
168 pflavor = rpcauth_get_pseudoflavor(secinfo->flavor,
169 &secinfo->flavor_info);
170 /* does the pseudoflavor match a sec= mount opt? */
171 if (pflavor != RPC_AUTH_MAXFLAVOR &&
172 nfs_auth_info_match(&server->auth_info, pflavor)) {
173 struct rpc_clnt *new;
174 struct rpc_cred *cred;
176 /* Cloning creates an rpc_auth for the flavor */
177 new = rpc_clone_client_set_auth(clnt, pflavor);
181 * Check that the user actually can use the
182 * flavor. This is mostly for RPC_AUTH_GSS
183 * where cr_init obtains a gss context
185 cred = rpcauth_lookupcred(new->cl_auth, 0);
187 rpc_shutdown_client(new);
195 return ERR_PTR(-EPERM);
199 * nfs4_negotiate_security - in response to an NFS4ERR_WRONGSEC on lookup,
200 * return an rpc_clnt that uses the best available security flavor with
201 * respect to the secinfo flavor list and the sec= mount options.
203 * @clnt: RPC client to clone
204 * @inode: directory inode
207 * Please call rpc_shutdown_client() when you are done with this rpc client.
210 nfs4_negotiate_security(struct rpc_clnt *clnt, struct inode *inode,
214 struct nfs4_secinfo_flavors *flavors;
215 struct rpc_clnt *new;
218 page = alloc_page(GFP_KERNEL);
220 return ERR_PTR(-ENOMEM);
222 flavors = page_address(page);
224 err = nfs4_proc_secinfo(inode, name, flavors);
230 new = nfs_find_best_sec(clnt, NFS_SERVER(inode), flavors);
237 static struct vfsmount *try_location(struct nfs_clone_mount *mountdata,
238 char *page, char *page2,
239 const struct nfs4_fs_location *location)
241 const size_t addr_bufsize = sizeof(struct sockaddr_storage);
242 struct net *net = rpc_net_ns(NFS_SB(mountdata->sb)->client);
243 struct vfsmount *mnt = ERR_PTR(-ENOENT);
245 unsigned int maxbuflen;
248 mnt_path = nfs4_pathname_string(&location->rootpath, page2, PAGE_SIZE);
249 if (IS_ERR(mnt_path))
250 return ERR_CAST(mnt_path);
251 mountdata->mnt_path = mnt_path;
252 maxbuflen = mnt_path - 1 - page2;
254 mountdata->addr = kmalloc(addr_bufsize, GFP_KERNEL);
255 if (mountdata->addr == NULL)
256 return ERR_PTR(-ENOMEM);
258 for (s = 0; s < location->nservers; s++) {
259 const struct nfs4_string *buf = &location->servers[s];
261 if (buf->len <= 0 || buf->len >= maxbuflen)
264 if (memchr(buf->data, IPV6_SCOPE_DELIMITER, buf->len))
267 mountdata->addrlen = nfs_parse_server_name(buf->data, buf->len,
268 mountdata->addr, addr_bufsize, net);
269 if (mountdata->addrlen == 0)
272 rpc_set_port(mountdata->addr, NFS_PORT);
274 memcpy(page2, buf->data, buf->len);
275 page2[buf->len] = '\0';
276 mountdata->hostname = page2;
278 snprintf(page, PAGE_SIZE, "%s:%s",
280 mountdata->mnt_path);
282 mnt = vfs_kern_mount(&nfs4_referral_fs_type, 0, page, mountdata);
286 kfree(mountdata->addr);
291 * nfs_follow_referral - set up mountpoint when hitting a referral on moved error
292 * @dentry - parent directory
293 * @locations - array of NFSv4 server location information
296 static struct vfsmount *nfs_follow_referral(struct dentry *dentry,
297 const struct nfs4_fs_locations *locations)
299 struct vfsmount *mnt = ERR_PTR(-ENOENT);
300 struct nfs_clone_mount mountdata = {
303 .authflavor = NFS_SB(dentry->d_sb)->client->cl_auth->au_flavor,
305 char *page = NULL, *page2 = NULL;
308 if (locations == NULL || locations->nlocations <= 0)
311 dprintk("%s: referral at %pd2\n", __func__, dentry);
313 page = (char *) __get_free_page(GFP_USER);
317 page2 = (char *) __get_free_page(GFP_USER);
321 /* Ensure fs path is a prefix of current dentry path */
322 error = nfs4_validate_fspath(dentry, locations, page, page2);
324 mnt = ERR_PTR(error);
328 for (loc = 0; loc < locations->nlocations; loc++) {
329 const struct nfs4_fs_location *location = &locations->locations[loc];
331 if (location == NULL || location->nservers <= 0 ||
332 location->rootpath.ncomponents == 0)
335 mnt = try_location(&mountdata, page, page2, location);
341 free_page((unsigned long) page);
342 free_page((unsigned long) page2);
343 dprintk("%s: done\n", __func__);
348 * nfs_do_refmount - handle crossing a referral on server
349 * @dentry - dentry of referral
352 static struct vfsmount *nfs_do_refmount(struct rpc_clnt *client, struct dentry *dentry)
354 struct vfsmount *mnt = ERR_PTR(-ENOMEM);
355 struct dentry *parent;
356 struct nfs4_fs_locations *fs_locations = NULL;
360 /* BUG_ON(IS_ROOT(dentry)); */
361 dprintk("%s: enter\n", __func__);
363 page = alloc_page(GFP_KERNEL);
367 fs_locations = kmalloc(sizeof(struct nfs4_fs_locations), GFP_KERNEL);
368 if (fs_locations == NULL)
372 mnt = ERR_PTR(-ENOENT);
374 parent = dget_parent(dentry);
375 dprintk("%s: getting locations for %pd2\n",
378 err = nfs4_proc_fs_locations(client, d_inode(parent), &dentry->d_name, fs_locations, page);
381 fs_locations->nlocations <= 0 ||
382 fs_locations->fs_path.ncomponents <= 0)
385 mnt = nfs_follow_referral(dentry, fs_locations);
390 dprintk("%s: done\n", __func__);
394 struct vfsmount *nfs4_submount(struct nfs_server *server, struct dentry *dentry,
395 struct nfs_fh *fh, struct nfs_fattr *fattr)
397 rpc_authflavor_t flavor = server->client->cl_auth->au_flavor;
398 struct dentry *parent = dget_parent(dentry);
399 struct inode *dir = d_inode(parent);
400 struct qstr *name = &dentry->d_name;
401 struct rpc_clnt *client;
402 struct vfsmount *mnt;
404 /* Look it up again to get its attributes and sec flavor */
405 client = nfs4_proc_lookup_mountpoint(dir, name, fh, fattr);
408 return ERR_CAST(client);
410 if (fattr->valid & NFS_ATTR_FATTR_V4_REFERRAL) {
411 mnt = nfs_do_refmount(client, dentry);
415 if (client->cl_auth->au_flavor != flavor)
416 flavor = client->cl_auth->au_flavor;
417 mnt = nfs_do_submount(dentry, fh, fattr, flavor);
419 rpc_shutdown_client(client);
424 * Try one location from the fs_locations array.
426 * Returns zero on success, or a negative errno value.
428 static int nfs4_try_replacing_one_location(struct nfs_server *server,
429 char *page, char *page2,
430 const struct nfs4_fs_location *location)
432 const size_t addr_bufsize = sizeof(struct sockaddr_storage);
433 struct net *net = rpc_net_ns(server->client);
434 struct sockaddr *sap;
439 sap = kmalloc(addr_bufsize, GFP_KERNEL);
444 for (s = 0; s < location->nservers; s++) {
445 const struct nfs4_string *buf = &location->servers[s];
448 if (buf->len <= 0 || buf->len > PAGE_SIZE)
451 if (memchr(buf->data, IPV6_SCOPE_DELIMITER, buf->len) != NULL)
454 salen = nfs_parse_server_name(buf->data, buf->len,
455 sap, addr_bufsize, net);
458 rpc_set_port(sap, NFS_PORT);
461 hostname = kstrndup(buf->data, buf->len, GFP_KERNEL);
462 if (hostname == NULL)
465 error = nfs4_update_server(server, hostname, sap, salen, net);
476 * nfs4_replace_transport - set up transport to destination server
478 * @server: export being migrated
479 * @locations: fs_locations array
481 * Returns zero on success, or a negative errno value.
483 * The client tries all the entries in the "locations" array, in the
484 * order returned by the server, until one works or the end of the
487 int nfs4_replace_transport(struct nfs_server *server,
488 const struct nfs4_fs_locations *locations)
490 char *page = NULL, *page2 = NULL;
494 if (locations == NULL || locations->nlocations <= 0)
498 page = (char *) __get_free_page(GFP_USER);
501 page2 = (char *) __get_free_page(GFP_USER);
505 for (loc = 0; loc < locations->nlocations; loc++) {
506 const struct nfs4_fs_location *location =
507 &locations->locations[loc];
509 if (location == NULL || location->nservers <= 0 ||
510 location->rootpath.ncomponents == 0)
513 error = nfs4_try_replacing_one_location(server, page,
520 free_page((unsigned long)page);
521 free_page((unsigned long)page2);