blob: dd4e11a703aa6a815bc4c7d42fc81f2918616a18 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * NFS server file handle treatment.
4 *
5 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
6 * Portions Copyright (C) 1999 G. Allen Morris III <gam3@acm.org>
7 * Extensive rewrite by Neil Brown <neilb@cse.unsw.edu.au> Southern-Spring 1999
8 * ... and again Southern-Winter 2001 to support export_operations
9 */
10
Christoph Hellwiga5694252007-07-17 04:04:28 -070011#include <linux/exportfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
Andy Adamson32c1eb02007-07-17 04:04:48 -070013#include <linux/sunrpc/svcauth_gss.h>
Boaz Harrosh9a74af22009-12-03 20:30:56 +020014#include "nfsd.h"
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050015#include "vfs.h"
J. Bruce Fields2e8138a2007-11-15 17:05:43 -050016#include "auth.h"
Trond Myklebustf01274a2020-03-01 18:21:39 -050017#include "trace.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19#define NFSDDBG_FACILITY NFSDDBG_FH
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022/*
23 * our acceptability function.
24 * if NOSUBTREECHECK, accept anything
25 * if not, require that we can walk up to exp->ex_dentry
26 * doing some checks on the 'x' bits
27 */
28static int nfsd_acceptable(void *expv, struct dentry *dentry)
29{
30 struct svc_export *exp = expv;
31 int rv;
32 struct dentry *tdentry;
33 struct dentry *parent;
34
35 if (exp->ex_flags & NFSEXP_NOSUBTREECHECK)
36 return 1;
37
38 tdentry = dget(dentry);
Jan Blunck54775492008-02-14 19:38:39 -080039 while (tdentry != exp->ex_path.dentry && !IS_ROOT(tdentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 /* make sure parents give x permission to user */
41 int err;
42 parent = dget_parent(tdentry);
Christian Brauner4609e1f2023-01-13 12:49:22 +010043 err = inode_permission(&nop_mnt_idmap,
Christian Brauner47291ba2021-01-21 14:19:24 +010044 d_inode(parent), MAY_EXEC);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 if (err < 0) {
46 dput(parent);
47 break;
48 }
49 dput(tdentry);
50 tdentry = parent;
51 }
Jan Blunck54775492008-02-14 19:38:39 -080052 if (tdentry != exp->ex_path.dentry)
Al Viro97e47fa2013-09-16 10:57:01 -040053 dprintk("nfsd_acceptable failed at %p %pd\n", tdentry, tdentry);
Jan Blunck54775492008-02-14 19:38:39 -080054 rv = (tdentry == exp->ex_path.dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 dput(tdentry);
56 return rv;
57}
58
59/* Type check. The correct error return for type mismatches does not seem to be
60 * generally agreed upon. SunOS seems to use EISDIR if file isn't S_IFREG; a
61 * comment in the NFSv3 spec says this is incorrect (implementation notes for
62 * the write call).
63 */
Al Viro83b11342006-10-19 23:28:55 -070064static inline __be32
J. Bruce Fieldse75b23f2016-07-19 17:33:04 -040065nfsd_mode_check(struct svc_rqst *rqstp, struct dentry *dentry,
66 umode_t requested)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067{
J. Bruce Fieldse75b23f2016-07-19 17:33:04 -040068 umode_t mode = d_inode(dentry)->i_mode & S_IFMT;
J. Bruce Fieldse10f9e12011-08-15 17:04:19 -040069
70 if (requested == 0) /* the caller doesn't care */
71 return nfs_ok;
J. Bruce Fieldse75b23f2016-07-19 17:33:04 -040072 if (mode == requested) {
73 if (mode == S_IFDIR && !d_can_lookup(dentry)) {
74 WARN_ON_ONCE(1);
75 return nfserr_notdir;
76 }
J. Bruce Fieldse10f9e12011-08-15 17:04:19 -040077 return nfs_ok;
J. Bruce Fieldse75b23f2016-07-19 17:33:04 -040078 }
J. Bruce Fieldse10f9e12011-08-15 17:04:19 -040079 /*
80 * v4 has an error more specific than err_notdir which we should
81 * return in preference to err_notdir:
82 */
83 if (rqstp->rq_vers == 4 && mode == S_IFLNK)
84 return nfserr_symlink;
85 if (requested == S_IFDIR)
86 return nfserr_notdir;
87 if (mode == S_IFDIR)
88 return nfserr_isdir;
89 return nfserr_inval;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090}
91
J. Bruce Fields9d7ed132018-03-08 15:49:48 -050092static bool nfsd_originating_port_ok(struct svc_rqst *rqstp, int flags)
93{
94 if (flags & NFSEXP_INSECURE_PORT)
95 return true;
96 /* We don't require gss requests to use low ports: */
97 if (rqstp->rq_cred.cr_flavor >= RPC_AUTH_GSS)
98 return true;
99 return test_bit(RQ_SECURE, &rqstp->rq_flags);
100}
101
J. Bruce Fields6fa02832007-11-12 16:05:03 -0500102static __be32 nfsd_setuser_and_check_port(struct svc_rqst *rqstp,
103 struct svc_export *exp)
104{
J. Bruce Fields12045a6e2009-12-08 18:15:52 -0500105 int flags = nfsexp_flags(rqstp, exp);
106
J. Bruce Fields6fa02832007-11-12 16:05:03 -0500107 /* Check if the request originated from a secure port. */
J. Bruce Fields9d7ed132018-03-08 15:49:48 -0500108 if (!nfsd_originating_port_ok(rqstp, flags)) {
Pavel Emelyanov5216a8e2008-02-21 10:57:45 +0300109 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
Kinglong Meea48fd0f2014-05-29 12:18:52 +0800110 dprintk("nfsd: request from insecure port %s!\n",
111 svc_print_addr(rqstp, buf, sizeof(buf)));
J. Bruce Fields6fa02832007-11-12 16:05:03 -0500112 return nfserr_perm;
113 }
114
115 /* Set user creds for this exportpoint */
116 return nfserrno(nfsd_setuser(rqstp, exp));
117}
118
Steve Dickson03a816b42009-09-09 15:06:05 -0400119static inline __be32 check_pseudo_root(struct svc_rqst *rqstp,
120 struct dentry *dentry, struct svc_export *exp)
121{
122 if (!(exp->ex_flags & NFSEXP_V4ROOT))
123 return nfs_ok;
124 /*
125 * v2/v3 clients have no need for the V4ROOT export--they use
126 * the mount protocl instead; also, further V4ROOT checks may be
127 * in v4-specific code, in which case v2/v3 clients could bypass
128 * them.
129 */
130 if (!nfsd_v4client(rqstp))
131 return nfserr_stale;
132 /*
133 * We're exposing only the directories and symlinks that have to be
134 * traversed on the way to real exports:
135 */
David Howellse36cb0b2015-01-29 12:02:35 +0000136 if (unlikely(!d_is_dir(dentry) &&
137 !d_is_symlink(dentry)))
Steve Dickson03a816b42009-09-09 15:06:05 -0400138 return nfserr_stale;
139 /*
140 * A pseudoroot export gives permission to access only one
141 * single directory; the kernel has to make another upcall
142 * before granting access to anything else under it:
143 */
144 if (unlikely(dentry != exp->ex_path.dentry))
145 return nfserr_stale;
146 return nfs_ok;
147}
148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149/*
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400150 * Use the given filehandle to look up the corresponding export and
151 * dentry. On success, the results are used to set fh_export and
152 * fh_dentry.
153 */
154static __be32 nfsd_set_fh_dentry(struct svc_rqst *rqstp, struct svc_fh *fhp)
155{
156 struct knfsd_fh *fh = &fhp->fh_handle;
NeilBrownc645a882021-09-02 11:15:29 +1000157 struct fid *fid = NULL;
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400158 struct svc_export *exp;
159 struct dentry *dentry;
160 int fileid_type;
161 int data_left = fh->fh_size/4;
NeilBrownc645a882021-09-02 11:15:29 +1000162 int len;
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400163 __be32 error;
164
165 error = nfserr_stale;
166 if (rqstp->rq_vers > 2)
167 error = nfserr_badhandle;
168 if (rqstp->rq_vers == 4 && fh->fh_size == 0)
169 return nfserr_nofilehandle;
170
NeilBrownc645a882021-09-02 11:15:29 +1000171 if (fh->fh_version != 1)
172 return error;
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400173
NeilBrownc645a882021-09-02 11:15:29 +1000174 if (--data_left < 0)
175 return error;
176 if (fh->fh_auth_type != 0)
177 return error;
178 len = key_len(fh->fh_fsid_type) / 4;
179 if (len == 0)
180 return error;
181 if (fh->fh_fsid_type == FSID_MAJOR_MINOR) {
182 /* deprecated, convert to type 3 */
183 len = key_len(FSID_ENCODE_DEV)/4;
184 fh->fh_fsid_type = FSID_ENCODE_DEV;
185 /*
186 * struct knfsd_fh uses host-endian fields, which are
187 * sometimes used to hold net-endian values. This
188 * confuses sparse, so we must use __force here to
189 * keep it from complaining.
190 */
191 fh->fh_fsid[0] = new_encode_dev(MKDEV(ntohl((__force __be32)fh->fh_fsid[0]),
192 ntohl((__force __be32)fh->fh_fsid[1])));
193 fh->fh_fsid[1] = fh->fh_fsid[2];
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400194 }
NeilBrownc645a882021-09-02 11:15:29 +1000195 data_left -= len;
196 if (data_left < 0)
197 return error;
198 exp = rqst_exp_find(rqstp, fh->fh_fsid_type, fh->fh_fsid);
199 fid = (struct fid *)(fh->fh_fsid + len);
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400200
201 error = nfserr_stale;
Trond Myklebustf01274a2020-03-01 18:21:39 -0500202 if (IS_ERR(exp)) {
203 trace_nfsd_set_fh_dentry_badexport(rqstp, fhp, PTR_ERR(exp));
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400204
Trond Myklebustf01274a2020-03-01 18:21:39 -0500205 if (PTR_ERR(exp) == -ENOENT)
206 return error;
207
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400208 return nfserrno(PTR_ERR(exp));
Trond Myklebustf01274a2020-03-01 18:21:39 -0500209 }
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400210
Neil Brown496d6c32008-05-08 13:03:09 +1000211 if (exp->ex_flags & NFSEXP_NOSUBTREECHECK) {
212 /* Elevate privileges so that the lack of 'r' or 'x'
213 * permission on some parent directory will
214 * not stop exportfs_decode_fh from being able
215 * to reconnect a directory into the dentry cache.
216 * The same problem can affect "SUBTREECHECK" exports,
217 * but as nfsd_acceptable depends on correct
218 * access control settings being in effect, we cannot
219 * fix that case easily.
220 */
David Howellsd84f4f92008-11-14 10:39:23 +1100221 struct cred *new = prepare_creds();
Kinglong Mee027bc412014-09-02 22:15:26 +0800222 if (!new) {
223 error = nfserrno(-ENOMEM);
224 goto out;
225 }
David Howellsd84f4f92008-11-14 10:39:23 +1100226 new->cap_effective =
227 cap_raise_nfsd_set(new->cap_effective,
228 new->cap_permitted);
229 put_cred(override_creds(new));
230 put_cred(new);
Neil Brown496d6c32008-05-08 13:03:09 +1000231 } else {
232 error = nfsd_setuser_and_check_port(rqstp, exp);
233 if (error)
234 goto out;
235 }
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400236
237 /*
238 * Look up the dentry using the NFS file handle.
239 */
240 error = nfserr_stale;
241 if (rqstp->rq_vers > 2)
242 error = nfserr_badhandle;
243
NeilBrownc645a882021-09-02 11:15:29 +1000244 fileid_type = fh->fh_fileid_type;
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400245
246 if (fileid_type == FILEID_ROOT)
247 dentry = dget(exp->ex_path.dentry);
248 else {
Trond Myklebust2e19d102020-11-30 17:03:18 -0500249 dentry = exportfs_decode_fh_raw(exp->ex_path.mnt, fid,
Christian Brauner620c2662024-05-24 12:19:39 +0200250 data_left, fileid_type, 0,
Trond Myklebust2e19d102020-11-30 17:03:18 -0500251 nfsd_acceptable, exp);
252 if (IS_ERR_OR_NULL(dentry)) {
Trond Myklebustf01274a2020-03-01 18:21:39 -0500253 trace_nfsd_set_fh_dentry_badhandle(rqstp, fhp,
254 dentry ? PTR_ERR(dentry) : -ESTALE);
Trond Myklebust2e19d102020-11-30 17:03:18 -0500255 switch (PTR_ERR(dentry)) {
256 case -ENOMEM:
257 case -ETIMEDOUT:
258 break;
259 default:
260 dentry = ERR_PTR(-ESTALE);
261 }
262 }
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400263 }
264 if (dentry == NULL)
265 goto out;
266 if (IS_ERR(dentry)) {
267 if (PTR_ERR(dentry) != -EINVAL)
268 error = nfserrno(PTR_ERR(dentry));
269 goto out;
270 }
271
David Howellse36cb0b2015-01-29 12:02:35 +0000272 if (d_is_dir(dentry) &&
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400273 (dentry->d_flags & DCACHE_DISCONNECTED)) {
Al Viro97e47fa2013-09-16 10:57:01 -0400274 printk("nfsd: find_fh_dentry returned a DISCONNECTED directory: %pd2\n",
275 dentry);
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400276 }
277
278 fhp->fh_dentry = dentry;
279 fhp->fh_export = exp;
Jeff Laytondaab1102020-11-30 17:03:14 -0500280
281 switch (rqstp->rq_vers) {
Trond Myklebust716a8bc2020-11-30 23:14:27 -0500282 case 4:
283 if (dentry->d_sb->s_export_op->flags & EXPORT_OP_NOATOMIC_ATTR)
284 fhp->fh_no_atomic_attr = true;
285 break;
Jeff Laytondaab1102020-11-30 17:03:14 -0500286 case 3:
287 if (dentry->d_sb->s_export_op->flags & EXPORT_OP_NOWCC)
288 fhp->fh_no_wcc = true;
289 break;
290 case 2:
291 fhp->fh_no_wcc = true;
292 }
293
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400294 return 0;
295out:
296 exp_put(exp);
297 return error;
298}
299
J. Bruce Fieldsb3d476762008-10-20 13:01:59 -0400300/**
301 * fh_verify - filehandle lookup and access checking
302 * @rqstp: pointer to current rpc request
303 * @fhp: filehandle to be verified
304 * @type: expected type of object pointed to by filehandle
305 * @access: type of access needed to object
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 *
J. Bruce Fieldsb3d476762008-10-20 13:01:59 -0400307 * Look up a dentry from the on-the-wire filehandle, check the client's
308 * access to the export, and set the current task's credentials.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 *
J. Bruce Fieldsb3d476762008-10-20 13:01:59 -0400310 * Regardless of success or failure of fh_verify(), fh_put() should be
311 * called on @fhp when the caller is finished with the filehandle.
312 *
313 * fh_verify() may be called multiple times on a given filehandle, for
314 * example, when processing an NFSv4 compound. The first call will look
315 * up a dentry using the on-the-wire filehandle. Subsequent calls will
316 * skip the lookup and just perform the other checks and possibly change
317 * the current task's credentials.
318 *
319 * @type specifies the type of object expected using one of the S_IF*
320 * constants defined in include/linux/stat.h. The caller may use zero
321 * to indicate that it doesn't care, or a negative integer to indicate
322 * that it expects something not of the given type.
323 *
324 * @access is formed from the NFSD_MAY_* constants defined in
Oleg Drokin93f580a2016-07-07 21:49:38 -0400325 * fs/nfsd/vfs.h.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 */
Al Viro83b11342006-10-19 23:28:55 -0700327__be32
Al Viro175a4eb2011-07-26 03:30:54 -0400328fh_verify(struct svc_rqst *rqstp, struct svc_fh *fhp, umode_t type, int access)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329{
Josef Bacik4b1488542024-01-26 10:39:47 -0500330 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
Amir Goldstein20ad8562021-01-06 09:52:36 +0200331 struct svc_export *exp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 struct dentry *dentry;
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400333 __be32 error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 if (!fhp->fh_dentry) {
J. Bruce Fields03550fa2008-03-14 17:51:12 -0400336 error = nfsd_set_fh_dentry(rqstp, fhp);
NeilBrownd1bbf142006-07-30 03:03:16 -0700337 if (error)
338 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 }
J. Bruce Fields864f0f62009-11-25 17:42:05 -0500340 dentry = fhp->fh_dentry;
341 exp = fhp->fh_export;
Chuck Lever05138282022-06-21 10:06:23 -0400342
343 trace_nfsd_fh_verify(rqstp, fhp, type, access);
344
J. Bruce Fields864f0f62009-11-25 17:42:05 -0500345 /*
346 * We still have to do all these permission checks, even when
347 * fh_dentry is already set:
348 * - fh_verify may be called multiple times with different
349 * "access" arguments (e.g. nfsd_proc_create calls
350 * fh_verify(...,NFSD_MAY_EXEC) first, then later (in
351 * nfsd_create) calls fh_verify(...,NFSD_MAY_CREATE).
352 * - in the NFSv4 case, the filehandle may have been filled
353 * in by fh_compose, and given a dentry, but further
354 * compound operations performed with that filehandle
355 * still need permissions checks. In the worst case, a
356 * mountpoint crossing may have changed the export
357 * options, and we may now need to use a different uid
358 * (for example, if different id-squashing options are in
359 * effect on the new filesystem).
360 */
Steve Dickson03a816b42009-09-09 15:06:05 -0400361 error = check_pseudo_root(rqstp, dentry, exp);
362 if (error)
363 goto out;
364
J. Bruce Fields864f0f62009-11-25 17:42:05 -0500365 error = nfsd_setuser_and_check_port(rqstp, exp);
366 if (error)
367 goto out;
J. Bruce Fields7fc90ec2006-06-30 01:56:14 -0700368
J. Bruce Fieldse75b23f2016-07-19 17:33:04 -0400369 error = nfsd_mode_check(rqstp, dentry, type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 if (error)
371 goto out;
372
J. Bruce Fields04716e62008-08-07 13:00:20 -0400373 /*
374 * pseudoflavor restrictions are not enforced on NLM,
375 * which clients virtually always use auth_sys for,
376 * even while using RPCSEC_GSS for NFS.
377 */
J. Bruce Fields204f4ce2011-04-08 16:32:54 -0400378 if (access & NFSD_MAY_LOCK || access & NFSD_MAY_BYPASS_GSS)
J. Bruce Fields04716e62008-08-07 13:00:20 -0400379 goto skip_pseudoflavor_check;
380 /*
381 * Clients may expect to be able to use auth_sys during mount,
382 * even if they use gss for everything else; see section 2.3.2
383 * of rfc 2623.
384 */
385 if (access & NFSD_MAY_BYPASS_GSS_ON_ROOT
386 && exp->ex_path.dentry == dentry)
387 goto skip_pseudoflavor_check;
Andy Adamson32c1eb02007-07-17 04:04:48 -0700388
J. Bruce Fields04716e62008-08-07 13:00:20 -0400389 error = check_nfsd_access(exp, rqstp);
390 if (error)
391 goto out;
392
393skip_pseudoflavor_check:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 /* Finally, check access permissions. */
J. Bruce Fields0ec757d2007-07-17 04:04:48 -0700395 error = nfsd_permission(rqstp, exp, dentry, access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396out:
Jeff Layton93c128e2022-10-12 14:42:54 -0400397 trace_nfsd_fh_verify_err(rqstp, fhp, type, access, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 if (error == nfserr_stale)
Josef Bacik4b1488542024-01-26 10:39:47 -0500399 nfsd_stats_fh_stale_inc(nn, exp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 return error;
401}
402
403
404/*
405 * Compose a file handle for an NFS reply.
406 *
407 * Note that when first composed, the dentry may not yet have
408 * an inode. In this case a call to fh_update should be made
409 * before the fh goes out on the wire ...
410 */
Christoph Hellwig6e91ea22007-10-21 16:42:03 -0700411static void _fh_update(struct svc_fh *fhp, struct svc_export *exp,
412 struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413{
Jan Blunck54775492008-02-14 19:38:39 -0800414 if (dentry != exp->ex_path.dentry) {
Christoph Hellwig6e91ea22007-10-21 16:42:03 -0700415 struct fid *fid = (struct fid *)
Christoph Hellwig5409e462014-05-07 13:49:44 +0200416 (fhp->fh_handle.fh_fsid + fhp->fh_handle.fh_size/4 - 1);
Christoph Hellwig6e91ea22007-10-21 16:42:03 -0700417 int maxsize = (fhp->fh_maxsize - fhp->fh_handle.fh_size)/4;
Amir Goldsteinb5287822023-05-02 15:48:14 +0300418 int fh_flags = (exp->ex_flags & NFSEXP_NOSUBTREECHECK) ? 0 :
419 EXPORT_FH_CONNECTABLE;
Amir Goldstein7cdafe62023-05-24 18:48:25 +0300420 int fileid_type =
421 exportfs_encode_fh(dentry, fid, &maxsize, fh_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Christoph Hellwig6e91ea22007-10-21 16:42:03 -0700423 fhp->fh_handle.fh_fileid_type =
Amir Goldstein7cdafe62023-05-24 18:48:25 +0300424 fileid_type > 0 ? fileid_type : FILEID_INVALID;
Christoph Hellwig6e91ea22007-10-21 16:42:03 -0700425 fhp->fh_handle.fh_size += maxsize * 4;
426 } else {
427 fhp->fh_handle.fh_fileid_type = FILEID_ROOT;
428 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429}
430
J. Bruce Fields8e498752009-09-02 19:31:32 -0400431static bool is_root_export(struct svc_export *exp)
432{
433 return exp->ex_path.dentry == exp->ex_path.dentry->d_sb->s_root;
434}
435
436static struct super_block *exp_sb(struct svc_export *exp)
437{
Al Virofc640052016-04-10 01:33:30 -0400438 return exp->ex_path.dentry->d_sb;
J. Bruce Fields8e498752009-09-02 19:31:32 -0400439}
440
441static bool fsid_type_ok_for_exp(u8 fsid_type, struct svc_export *exp)
442{
443 switch (fsid_type) {
444 case FSID_DEV:
445 if (!old_valid_dev(exp_sb(exp)->s_dev))
Gustavo A. R. Silvaa677a782018-08-01 19:44:05 -0500446 return false;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500447 fallthrough;
J. Bruce Fields8e498752009-09-02 19:31:32 -0400448 case FSID_MAJOR_MINOR:
449 case FSID_ENCODE_DEV:
450 return exp_sb(exp)->s_type->fs_flags & FS_REQUIRES_DEV;
451 case FSID_NUM:
452 return exp->ex_flags & NFSEXP_FSID;
453 case FSID_UUID8:
454 case FSID_UUID16:
455 if (!is_root_export(exp))
Gustavo A. R. Silvaa677a782018-08-01 19:44:05 -0500456 return false;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500457 fallthrough;
J. Bruce Fields8e498752009-09-02 19:31:32 -0400458 case FSID_UUID4_INUM:
459 case FSID_UUID16_INUM:
460 return exp->ex_uuid != NULL;
461 }
Gustavo A. R. Silvaa677a782018-08-01 19:44:05 -0500462 return true;
J. Bruce Fields8e498752009-09-02 19:31:32 -0400463}
464
J. Bruce Fieldsbc6c53d2009-09-02 19:50:40 -0400465
466static void set_version_and_fsid_type(struct svc_fh *fhp, struct svc_export *exp, struct svc_fh *ref_fh)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467{
NeilBrownb41eeef2007-05-09 02:34:57 -0700468 u8 version;
J. Bruce Fieldsbc6c53d2009-09-02 19:50:40 -0400469 u8 fsid_type;
470retry:
NeilBrownb41eeef2007-05-09 02:34:57 -0700471 version = 1;
NeilBrown7e405362006-06-30 01:56:12 -0700472 if (ref_fh && ref_fh->fh_export == exp) {
NeilBrown982aedf2007-02-14 00:33:11 -0800473 version = ref_fh->fh_handle.fh_version;
NeilBrownb41eeef2007-05-09 02:34:57 -0700474 fsid_type = ref_fh->fh_handle.fh_fsid_type;
475
NeilBrownb41eeef2007-05-09 02:34:57 -0700476 ref_fh = NULL;
477
478 switch (version) {
479 case 0xca:
NeilBrownaf6a4e22007-02-14 00:33:12 -0800480 fsid_type = FSID_DEV;
NeilBrownb41eeef2007-05-09 02:34:57 -0700481 break;
482 case 1:
483 break;
484 default:
485 goto retry;
486 }
487
J. Bruce Fields8e498752009-09-02 19:31:32 -0400488 /*
489 * As the fsid -> filesystem mapping was guided by
490 * user-space, there is no guarantee that the filesystem
491 * actually supports that fsid type. If it doesn't we
492 * loop around again without ref_fh set.
NeilBrown982aedf2007-02-14 00:33:11 -0800493 */
J. Bruce Fields8e498752009-09-02 19:31:32 -0400494 if (!fsid_type_ok_for_exp(fsid_type, exp))
495 goto retry;
Steve Dickson30fa8c02009-01-07 16:54:30 -0500496 } else if (exp->ex_flags & NFSEXP_FSID) {
497 fsid_type = FSID_NUM;
NeilBrownaf6a4e22007-02-14 00:33:12 -0800498 } else if (exp->ex_uuid) {
499 if (fhp->fh_maxsize >= 64) {
J. Bruce Fields8e498752009-09-02 19:31:32 -0400500 if (is_root_export(exp))
NeilBrownaf6a4e22007-02-14 00:33:12 -0800501 fsid_type = FSID_UUID16;
502 else
503 fsid_type = FSID_UUID16_INUM;
504 } else {
J. Bruce Fields8e498752009-09-02 19:31:32 -0400505 if (is_root_export(exp))
NeilBrownaf6a4e22007-02-14 00:33:12 -0800506 fsid_type = FSID_UUID8;
507 else
508 fsid_type = FSID_UUID4_INUM;
509 }
J. Bruce Fieldsbc6c53d2009-09-02 19:50:40 -0400510 } else if (!old_valid_dev(exp_sb(exp)->s_dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 /* for newer device numbers, we must use a newer fsid format */
NeilBrownaf6a4e22007-02-14 00:33:12 -0800512 fsid_type = FSID_ENCODE_DEV;
NeilBrown982aedf2007-02-14 00:33:11 -0800513 else
NeilBrownaf6a4e22007-02-14 00:33:12 -0800514 fsid_type = FSID_DEV;
J. Bruce Fieldsbc6c53d2009-09-02 19:50:40 -0400515 fhp->fh_handle.fh_version = version;
516 if (version)
517 fhp->fh_handle.fh_fsid_type = fsid_type;
518}
519
520__be32
521fh_compose(struct svc_fh *fhp, struct svc_export *exp, struct dentry *dentry,
522 struct svc_fh *ref_fh)
523{
524 /* ref_fh is a reference file handle.
525 * if it is non-null and for the same filesystem, then we should compose
526 * a filehandle which is of the same version, where possible.
J. Bruce Fieldsbc6c53d2009-09-02 19:50:40 -0400527 */
528
David Howells2b0143b2015-03-17 22:25:59 +0000529 struct inode * inode = d_inode(dentry);
J. Bruce Fieldsbc6c53d2009-09-02 19:50:40 -0400530 dev_t ex_dev = exp_sb(exp)->s_dev;
531
Al Viro97e47fa2013-09-16 10:57:01 -0400532 dprintk("nfsd: fh_compose(exp %02x:%02x/%ld %pd2, ino=%ld)\n",
J. Bruce Fieldsbc6c53d2009-09-02 19:50:40 -0400533 MAJOR(ex_dev), MINOR(ex_dev),
David Howells2b0143b2015-03-17 22:25:59 +0000534 (long) d_inode(exp->ex_path.dentry)->i_ino,
Al Viro97e47fa2013-09-16 10:57:01 -0400535 dentry,
J. Bruce Fieldsbc6c53d2009-09-02 19:50:40 -0400536 (inode ? inode->i_ino : 0));
537
538 /* Choose filehandle version and fsid type based on
539 * the reference filehandle (if it is in the same export)
540 * or the export options.
541 */
Christophe JAILLETd28c4422016-07-02 08:24:32 +0200542 set_version_and_fsid_type(fhp, exp, ref_fh);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Jeff Laytondaab1102020-11-30 17:03:14 -0500544 /* If we have a ref_fh, then copy the fh_no_wcc setting from it. */
545 fhp->fh_no_wcc = ref_fh ? ref_fh->fh_no_wcc : false;
546
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 if (ref_fh == fhp)
548 fh_put(ref_fh);
549
NeilBrowndd8dd402022-07-26 16:45:30 +1000550 if (fhp->fh_dentry) {
Al Viro97e47fa2013-09-16 10:57:01 -0400551 printk(KERN_ERR "fh_compose: fh %pd2 not initialized!\n",
552 dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 }
554 if (fhp->fh_maxsize < NFS_FHSIZE)
Al Viro97e47fa2013-09-16 10:57:01 -0400555 printk(KERN_ERR "fh_compose: called with maxsize %d! %pd2\n",
NeilBrown982aedf2007-02-14 00:33:11 -0800556 fhp->fh_maxsize,
Al Viro97e47fa2013-09-16 10:57:01 -0400557 dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
559 fhp->fh_dentry = dget(dentry); /* our internal copy */
Kinglong Meebf18f162014-06-10 22:06:44 +0800560 fhp->fh_export = exp_get(exp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
NeilBrownc645a882021-09-02 11:15:29 +1000562 fhp->fh_handle.fh_size =
563 key_len(fhp->fh_handle.fh_fsid_type) + 4;
564 fhp->fh_handle.fh_auth_type = 0;
Christoph Hellwig5409e462014-05-07 13:49:44 +0200565
NeilBrownc645a882021-09-02 11:15:29 +1000566 mk_fsid(fhp->fh_handle.fh_fsid_type,
567 fhp->fh_handle.fh_fsid,
568 ex_dev,
569 d_inode(exp->ex_path.dentry)->i_ino,
570 exp->ex_fsid, exp->ex_uuid);
NeilBrownaf6a4e22007-02-14 00:33:12 -0800571
NeilBrownc645a882021-09-02 11:15:29 +1000572 if (inode)
573 _fh_update(fhp, exp, dentry);
574 if (fhp->fh_handle.fh_fileid_type == FILEID_INVALID) {
575 fh_put(fhp);
Trond Myklebuste221c452024-05-06 12:30:04 -0400576 return nfserr_stale;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 }
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 return 0;
580}
581
582/*
583 * Update file handle information after changing a dentry.
584 * This is only called by nfsd_create, nfsd_create_v3 and nfsd_proc_create
585 */
Al Viro83b11342006-10-19 23:28:55 -0700586__be32
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587fh_update(struct svc_fh *fhp)
588{
589 struct dentry *dentry;
NeilBrown982aedf2007-02-14 00:33:11 -0800590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 if (!fhp->fh_dentry)
592 goto out_bad;
593
594 dentry = fhp->fh_dentry;
David Howells2b0143b2015-03-17 22:25:59 +0000595 if (d_really_is_negative(dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 goto out_negative;
NeilBrownc645a882021-09-02 11:15:29 +1000597 if (fhp->fh_handle.fh_fileid_type != FILEID_ROOT)
598 return 0;
Christoph Hellwig6e91ea22007-10-21 16:42:03 -0700599
NeilBrownc645a882021-09-02 11:15:29 +1000600 _fh_update(fhp, fhp->fh_export, dentry);
601 if (fhp->fh_handle.fh_fileid_type == FILEID_INVALID)
Trond Myklebuste221c452024-05-06 12:30:04 -0400602 return nfserr_stale;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604out_bad:
605 printk(KERN_ERR "fh_update: fh not verified!\n");
J. Bruce Fields49e73722013-09-12 09:31:39 -0400606 return nfserr_serverfault;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607out_negative:
Al Viro97e47fa2013-09-16 10:57:01 -0400608 printk(KERN_ERR "fh_update: %pd2 still negative!\n",
609 dentry);
J. Bruce Fields49e73722013-09-12 09:31:39 -0400610 return nfserr_serverfault;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611}
612
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500613/**
614 * fh_fill_pre_attrs - Fill in pre-op attributes
615 * @fhp: file handle to be updated
616 *
617 */
Jeff Laytona3320182023-07-21 10:29:10 -0400618__be32 __must_check fh_fill_pre_attrs(struct svc_fh *fhp)
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500619{
620 bool v4 = (fhp->fh_maxsize == NFS4_FHSIZE);
621 struct inode *inode;
622 struct kstat stat;
623 __be32 err;
624
625 if (fhp->fh_no_wcc || fhp->fh_pre_saved)
Jeff Laytona3320182023-07-21 10:29:10 -0400626 return nfs_ok;
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500627
628 inode = d_inode(fhp->fh_dentry);
629 err = fh_getattr(fhp, &stat);
Jeff Layton518f3752023-05-19 07:17:23 -0400630 if (err)
Jeff Laytona3320182023-07-21 10:29:10 -0400631 return err;
Jeff Layton518f3752023-05-19 07:17:23 -0400632
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500633 if (v4)
634 fhp->fh_pre_change = nfsd4_change_attribute(&stat, inode);
635
636 fhp->fh_pre_mtime = stat.mtime;
637 fhp->fh_pre_ctime = stat.ctime;
638 fhp->fh_pre_size = stat.size;
639 fhp->fh_pre_saved = true;
Jeff Laytona3320182023-07-21 10:29:10 -0400640 return nfs_ok;
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500641}
642
643/**
644 * fh_fill_post_attrs - Fill in post-op attributes
645 * @fhp: file handle to be updated
646 *
647 */
Jeff Laytona3320182023-07-21 10:29:10 -0400648__be32 fh_fill_post_attrs(struct svc_fh *fhp)
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500649{
650 bool v4 = (fhp->fh_maxsize == NFS4_FHSIZE);
651 struct inode *inode = d_inode(fhp->fh_dentry);
652 __be32 err;
653
654 if (fhp->fh_no_wcc)
Jeff Laytona3320182023-07-21 10:29:10 -0400655 return nfs_ok;
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500656
657 if (fhp->fh_post_saved)
658 printk("nfsd: inode locked twice during operation.\n");
659
660 err = fh_getattr(fhp, &fhp->fh_post_attr);
Jeff Layton518f3752023-05-19 07:17:23 -0400661 if (err)
Jeff Laytona3320182023-07-21 10:29:10 -0400662 return err;
Jeff Layton518f3752023-05-19 07:17:23 -0400663
664 fhp->fh_post_saved = true;
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500665 if (v4)
666 fhp->fh_post_change =
667 nfsd4_change_attribute(&fhp->fh_post_attr, inode);
Jeff Laytona3320182023-07-21 10:29:10 -0400668 return nfs_ok;
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500669}
670
NeilBrown19d008b2022-07-26 16:45:30 +1000671/**
672 * fh_fill_both_attrs - Fill pre-op and post-op attributes
673 * @fhp: file handle to be updated
674 *
675 * This is used when the directory wasn't changed, but wcc attributes
676 * are needed anyway.
677 */
Jeff Laytona3320182023-07-21 10:29:10 -0400678__be32 __must_check fh_fill_both_attrs(struct svc_fh *fhp)
NeilBrown19d008b2022-07-26 16:45:30 +1000679{
Jeff Laytona3320182023-07-21 10:29:10 -0400680 __be32 err;
681
682 err = fh_fill_post_attrs(fhp);
683 if (err)
684 return err;
685
NeilBrown19d008b2022-07-26 16:45:30 +1000686 fhp->fh_pre_change = fhp->fh_post_change;
687 fhp->fh_pre_mtime = fhp->fh_post_attr.mtime;
688 fhp->fh_pre_ctime = fhp->fh_post_attr.ctime;
689 fhp->fh_pre_size = fhp->fh_post_attr.size;
690 fhp->fh_pre_saved = true;
Jeff Laytona3320182023-07-21 10:29:10 -0400691 return nfs_ok;
NeilBrown19d008b2022-07-26 16:45:30 +1000692}
693
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694/*
695 * Release a file handle.
696 */
697void
698fh_put(struct svc_fh *fhp)
699{
700 struct dentry * dentry = fhp->fh_dentry;
701 struct svc_export * exp = fhp->fh_export;
702 if (dentry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 fhp->fh_dentry = NULL;
704 dput(dentry);
Chuck Leverfcb5e3f2021-12-24 14:36:49 -0500705 fh_clear_pre_post_attrs(fhp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 }
Jan Kara4a55c102012-06-12 16:20:33 +0200707 fh_drop_write(fhp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 if (exp) {
Stanislav Kinsburskya09581f2012-03-28 19:09:22 +0400709 exp_put(exp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 fhp->fh_export = NULL;
711 }
Jeff Laytondaab1102020-11-30 17:03:14 -0500712 fhp->fh_no_wcc = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 return;
714}
715
716/*
717 * Shorthand for dprintk()'s
718 */
719char * SVCFH_fmt(struct svc_fh *fhp)
720{
721 struct knfsd_fh *fh = &fhp->fh_handle;
NeilBrownd8b26072021-09-02 11:16:32 +1000722 static char buf[2+1+1+64*3+1];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
NeilBrownd8b26072021-09-02 11:16:32 +1000724 if (fh->fh_size < 0 || fh->fh_size> 64)
725 return "bad-fh";
726 sprintf(buf, "%d: %*ph", fh->fh_size, fh->fh_size, fh->fh_raw);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 return buf;
728}
NeilBrownaf6a4e22007-02-14 00:33:12 -0800729
Chuck Lever2c42f802020-10-21 11:58:41 -0400730enum fsid_source fsid_source(const struct svc_fh *fhp)
NeilBrownaf6a4e22007-02-14 00:33:12 -0800731{
732 if (fhp->fh_handle.fh_version != 1)
733 return FSIDSOURCE_DEV;
734 switch(fhp->fh_handle.fh_fsid_type) {
735 case FSID_DEV:
736 case FSID_ENCODE_DEV:
737 case FSID_MAJOR_MINOR:
J. Bruce Fields8e498752009-09-02 19:31:32 -0400738 if (exp_sb(fhp->fh_export)->s_type->fs_flags & FS_REQUIRES_DEV)
Neil Brownb8da0d12007-09-05 17:22:13 -0400739 return FSIDSOURCE_DEV;
740 break;
NeilBrownaf6a4e22007-02-14 00:33:12 -0800741 case FSID_NUM:
NeilBrownaf6a4e22007-02-14 00:33:12 -0800742 if (fhp->fh_export->ex_flags & NFSEXP_FSID)
743 return FSIDSOURCE_FSID;
Neil Brownb8da0d12007-09-05 17:22:13 -0400744 break;
745 default:
746 break;
NeilBrownaf6a4e22007-02-14 00:33:12 -0800747 }
Neil Brownb8da0d12007-09-05 17:22:13 -0400748 /* either a UUID type filehandle, or the filehandle doesn't
749 * match the export.
750 */
751 if (fhp->fh_export->ex_flags & NFSEXP_FSID)
752 return FSIDSOURCE_FSID;
753 if (fhp->fh_export->ex_uuid)
754 return FSIDSOURCE_UUID;
755 return FSIDSOURCE_DEV;
NeilBrownaf6a4e22007-02-14 00:33:12 -0800756}
Jeff Layton3139b1d2022-10-05 06:26:41 -0400757
758/*
Jeff Layton638e3e72022-09-07 14:45:01 -0400759 * We could use i_version alone as the change attribute. However, i_version
760 * can go backwards on a regular file after an unclean shutdown. On its own
761 * that doesn't necessarily cause a problem, but if i_version goes backwards
762 * and then is incremented again it could reuse a value that was previously
763 * used before boot, and a client who queried the two values might incorrectly
764 * assume nothing changed.
Jeff Layton3139b1d2022-10-05 06:26:41 -0400765 *
Jeff Layton638e3e72022-09-07 14:45:01 -0400766 * By using both ctime and the i_version counter we guarantee that as long as
767 * time doesn't go backwards we never reuse an old value. If the filesystem
768 * advertises STATX_ATTR_CHANGE_MONOTONIC, then this mitigation is not
769 * needed.
770 *
771 * We only need to do this for regular files as well. For directories, we
772 * assume that the new change attr is always logged to stable storage in some
773 * fashion before the results can be seen.
Jeff Layton3139b1d2022-10-05 06:26:41 -0400774 */
Chuck Lever263453d2023-09-18 09:57:51 -0400775u64 nfsd4_change_attribute(const struct kstat *stat, const struct inode *inode)
Jeff Layton3139b1d2022-10-05 06:26:41 -0400776{
Jeff Layton638e3e72022-09-07 14:45:01 -0400777 u64 chattr;
778
Jeff Layton638e3e72022-09-07 14:45:01 -0400779 if (stat->result_mask & STATX_CHANGE_COOKIE) {
780 chattr = stat->change_cookie;
Jeff Layton638e3e72022-09-07 14:45:01 -0400781 if (S_ISREG(inode->i_mode) &&
782 !(stat->attributes & STATX_ATTR_CHANGE_MONOTONIC)) {
783 chattr += (u64)stat->ctime.tv_sec << 30;
784 chattr += stat->ctime.tv_nsec;
785 }
786 } else {
787 chattr = time_to_chattr(&stat->ctime);
788 }
789 return chattr;
Jeff Layton3139b1d2022-10-05 06:26:41 -0400790}