2 * linux/fs/nfsd/nfsfh.c
4 * NFS server file handle treatment.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
7 * Portions Copyright (C) 1999 G. Allen Morris III <gam3@acm.org>
8 * Extensive rewrite by Neil Brown <neilb@cse.unsw.edu.au> Southern-Spring 1999
9 * ... and again Southern-Winter 2001 to support export_operations
12 #include <linux/slab.h>
14 #include <linux/unistd.h>
15 #include <linux/string.h>
16 #include <linux/stat.h>
17 #include <linux/dcache.h>
18 #include <linux/exportfs.h>
19 #include <linux/mount.h>
21 #include <linux/sunrpc/clnt.h>
22 #include <linux/sunrpc/svc.h>
23 #include <linux/sunrpc/svcauth_gss.h>
24 #include <linux/nfsd/nfsd.h>
27 #define NFSDDBG_FACILITY NFSDDBG_FH
31 * our acceptability function.
32 * if NOSUBTREECHECK, accept anything
33 * if not, require that we can walk up to exp->ex_dentry
34 * doing some checks on the 'x' bits
36 static int nfsd_acceptable(void *expv
, struct dentry
*dentry
)
38 struct svc_export
*exp
= expv
;
40 struct dentry
*tdentry
;
41 struct dentry
*parent
;
43 if (exp
->ex_flags
& NFSEXP_NOSUBTREECHECK
)
46 tdentry
= dget(dentry
);
47 while (tdentry
!= exp
->ex_path
.dentry
&& !IS_ROOT(tdentry
)) {
48 /* make sure parents give x permission to user */
50 parent
= dget_parent(tdentry
);
51 err
= inode_permission(parent
->d_inode
, MAY_EXEC
);
59 if (tdentry
!= exp
->ex_path
.dentry
)
60 dprintk("nfsd_acceptable failed at %p %s\n", tdentry
, tdentry
->d_name
.name
);
61 rv
= (tdentry
== exp
->ex_path
.dentry
);
66 /* Type check. The correct error return for type mismatches does not seem to be
67 * generally agreed upon. SunOS seems to use EISDIR if file isn't S_IFREG; a
68 * comment in the NFSv3 spec says this is incorrect (implementation notes for
72 nfsd_mode_check(struct svc_rqst
*rqstp
, umode_t mode
, int type
)
74 /* Type can be negative when creating hardlinks - not to a dir */
75 if (type
> 0 && (mode
& S_IFMT
) != type
) {
76 if (rqstp
->rq_vers
== 4 && (mode
& S_IFMT
) == S_IFLNK
)
77 return nfserr_symlink
;
78 else if (type
== S_IFDIR
)
80 else if ((mode
& S_IFMT
) == S_IFDIR
)
85 if (type
< 0 && (mode
& S_IFMT
) == -type
) {
86 if (rqstp
->rq_vers
== 4 && (mode
& S_IFMT
) == S_IFLNK
)
87 return nfserr_symlink
;
88 else if (type
== -S_IFDIR
)
96 static __be32
nfsd_setuser_and_check_port(struct svc_rqst
*rqstp
,
97 struct svc_export
*exp
)
99 /* Check if the request originated from a secure port. */
100 if (!rqstp
->rq_secure
&& EX_SECURE(exp
)) {
101 RPC_IFDEBUG(char buf
[RPC_MAX_ADDRBUFLEN
]);
103 "nfsd: request from insecure port %s!\n",
104 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
108 /* Set user creds for this exportpoint */
109 return nfserrno(nfsd_setuser(rqstp
, exp
));
113 * Use the given filehandle to look up the corresponding export and
114 * dentry. On success, the results are used to set fh_export and
117 static __be32
nfsd_set_fh_dentry(struct svc_rqst
*rqstp
, struct svc_fh
*fhp
)
119 struct knfsd_fh
*fh
= &fhp
->fh_handle
;
120 struct fid
*fid
= NULL
, sfid
;
121 struct svc_export
*exp
;
122 struct dentry
*dentry
;
124 int data_left
= fh
->fh_size
/4;
127 error
= nfserr_stale
;
128 if (rqstp
->rq_vers
> 2)
129 error
= nfserr_badhandle
;
130 if (rqstp
->rq_vers
== 4 && fh
->fh_size
== 0)
131 return nfserr_nofilehandle
;
133 if (fh
->fh_version
== 1) {
138 if (fh
->fh_auth_type
!= 0)
140 len
= key_len(fh
->fh_fsid_type
) / 4;
143 if (fh
->fh_fsid_type
== FSID_MAJOR_MINOR
) {
144 /* deprecated, convert to type 3 */
145 len
= key_len(FSID_ENCODE_DEV
)/4;
146 fh
->fh_fsid_type
= FSID_ENCODE_DEV
;
147 fh
->fh_fsid
[0] = new_encode_dev(MKDEV(ntohl(fh
->fh_fsid
[0]), ntohl(fh
->fh_fsid
[1])));
148 fh
->fh_fsid
[1] = fh
->fh_fsid
[2];
153 exp
= rqst_exp_find(rqstp
, fh
->fh_fsid_type
, fh
->fh_auth
);
154 fid
= (struct fid
*)(fh
->fh_auth
+ len
);
160 if (fh
->fh_size
!= NFS_FHSIZE
)
162 /* assume old filehandle format */
163 xdev
= old_decode_dev(fh
->ofh_xdev
);
164 xino
= u32_to_ino_t(fh
->ofh_xino
);
165 mk_fsid(FSID_DEV
, tfh
, xdev
, xino
, 0, NULL
);
166 exp
= rqst_exp_find(rqstp
, FSID_DEV
, tfh
);
169 error
= nfserr_stale
;
170 if (PTR_ERR(exp
) == -ENOENT
)
174 return nfserrno(PTR_ERR(exp
));
176 if (exp
->ex_flags
& NFSEXP_NOSUBTREECHECK
) {
177 /* Elevate privileges so that the lack of 'r' or 'x'
178 * permission on some parent directory will
179 * not stop exportfs_decode_fh from being able
180 * to reconnect a directory into the dentry cache.
181 * The same problem can affect "SUBTREECHECK" exports,
182 * but as nfsd_acceptable depends on correct
183 * access control settings being in effect, we cannot
184 * fix that case easily.
186 struct cred
*new = prepare_creds();
188 return nfserrno(-ENOMEM
);
190 cap_raise_nfsd_set(new->cap_effective
,
192 put_cred(override_creds(new));
195 error
= nfsd_setuser_and_check_port(rqstp
, exp
);
201 * Look up the dentry using the NFS file handle.
203 error
= nfserr_stale
;
204 if (rqstp
->rq_vers
> 2)
205 error
= nfserr_badhandle
;
207 if (fh
->fh_version
!= 1) {
208 sfid
.i32
.ino
= fh
->ofh_ino
;
209 sfid
.i32
.gen
= fh
->ofh_generation
;
210 sfid
.i32
.parent_ino
= fh
->ofh_dirino
;
213 if (fh
->ofh_dirino
== 0)
214 fileid_type
= FILEID_INO32_GEN
;
216 fileid_type
= FILEID_INO32_GEN_PARENT
;
218 fileid_type
= fh
->fh_fileid_type
;
220 if (fileid_type
== FILEID_ROOT
)
221 dentry
= dget(exp
->ex_path
.dentry
);
223 dentry
= exportfs_decode_fh(exp
->ex_path
.mnt
, fid
,
224 data_left
, fileid_type
,
225 nfsd_acceptable
, exp
);
229 if (IS_ERR(dentry
)) {
230 if (PTR_ERR(dentry
) != -EINVAL
)
231 error
= nfserrno(PTR_ERR(dentry
));
235 if (exp
->ex_flags
& NFSEXP_NOSUBTREECHECK
) {
236 error
= nfsd_setuser_and_check_port(rqstp
, exp
);
243 if (S_ISDIR(dentry
->d_inode
->i_mode
) &&
244 (dentry
->d_flags
& DCACHE_DISCONNECTED
)) {
245 printk("nfsd: find_fh_dentry returned a DISCONNECTED directory: %s/%s\n",
246 dentry
->d_parent
->d_name
.name
, dentry
->d_name
.name
);
249 fhp
->fh_dentry
= dentry
;
250 fhp
->fh_export
= exp
;
258 * fh_verify - filehandle lookup and access checking
259 * @rqstp: pointer to current rpc request
260 * @fhp: filehandle to be verified
261 * @type: expected type of object pointed to by filehandle
262 * @access: type of access needed to object
264 * Look up a dentry from the on-the-wire filehandle, check the client's
265 * access to the export, and set the current task's credentials.
267 * Regardless of success or failure of fh_verify(), fh_put() should be
268 * called on @fhp when the caller is finished with the filehandle.
270 * fh_verify() may be called multiple times on a given filehandle, for
271 * example, when processing an NFSv4 compound. The first call will look
272 * up a dentry using the on-the-wire filehandle. Subsequent calls will
273 * skip the lookup and just perform the other checks and possibly change
274 * the current task's credentials.
276 * @type specifies the type of object expected using one of the S_IF*
277 * constants defined in include/linux/stat.h. The caller may use zero
278 * to indicate that it doesn't care, or a negative integer to indicate
279 * that it expects something not of the given type.
281 * @access is formed from the NFSD_MAY_* constants defined in
282 * include/linux/nfsd/nfsd.h.
285 fh_verify(struct svc_rqst
*rqstp
, struct svc_fh
*fhp
, int type
, int access
)
287 struct svc_export
*exp
;
288 struct dentry
*dentry
;
291 dprintk("nfsd: fh_verify(%s)\n", SVCFH_fmt(fhp
));
293 if (!fhp
->fh_dentry
) {
294 error
= nfsd_set_fh_dentry(rqstp
, fhp
);
297 dentry
= fhp
->fh_dentry
;
298 exp
= fhp
->fh_export
;
301 * just rechecking permissions
302 * (e.g. nfsproc_create calls fh_verify, then nfsd_create
305 dprintk("nfsd: fh_verify - just checking\n");
306 dentry
= fhp
->fh_dentry
;
307 exp
= fhp
->fh_export
;
309 * Set user creds for this exportpoint; necessary even
310 * in the "just checking" case because this may be a
311 * filehandle that was created by fh_compose, and that
312 * is about to be used in another nfsv4 compound
315 error
= nfsd_setuser_and_check_port(rqstp
, exp
);
320 error
= nfsd_mode_check(rqstp
, dentry
->d_inode
->i_mode
, type
);
325 * pseudoflavor restrictions are not enforced on NLM,
326 * which clients virtually always use auth_sys for,
327 * even while using RPCSEC_GSS for NFS.
329 if (access
& NFSD_MAY_LOCK
)
330 goto skip_pseudoflavor_check
;
332 * Clients may expect to be able to use auth_sys during mount,
333 * even if they use gss for everything else; see section 2.3.2
336 if (access
& NFSD_MAY_BYPASS_GSS_ON_ROOT
337 && exp
->ex_path
.dentry
== dentry
)
338 goto skip_pseudoflavor_check
;
340 error
= check_nfsd_access(exp
, rqstp
);
344 skip_pseudoflavor_check
:
345 /* Finally, check access permissions. */
346 error
= nfsd_permission(rqstp
, exp
, dentry
, access
);
349 dprintk("fh_verify: %s/%s permission failure, "
350 "acc=%x, error=%d\n",
351 dentry
->d_parent
->d_name
.name
,
353 access
, ntohl(error
));
356 if (error
== nfserr_stale
)
357 nfsdstats
.fh_stale
++;
363 * Compose a file handle for an NFS reply.
365 * Note that when first composed, the dentry may not yet have
366 * an inode. In this case a call to fh_update should be made
367 * before the fh goes out on the wire ...
369 static void _fh_update(struct svc_fh
*fhp
, struct svc_export
*exp
,
370 struct dentry
*dentry
)
372 if (dentry
!= exp
->ex_path
.dentry
) {
373 struct fid
*fid
= (struct fid
*)
374 (fhp
->fh_handle
.fh_auth
+ fhp
->fh_handle
.fh_size
/4 - 1);
375 int maxsize
= (fhp
->fh_maxsize
- fhp
->fh_handle
.fh_size
)/4;
376 int subtreecheck
= !(exp
->ex_flags
& NFSEXP_NOSUBTREECHECK
);
378 fhp
->fh_handle
.fh_fileid_type
=
379 exportfs_encode_fh(dentry
, fid
, &maxsize
, subtreecheck
);
380 fhp
->fh_handle
.fh_size
+= maxsize
* 4;
382 fhp
->fh_handle
.fh_fileid_type
= FILEID_ROOT
;
387 * for composing old style file handles
389 static inline void _fh_update_old(struct dentry
*dentry
,
390 struct svc_export
*exp
,
393 fh
->ofh_ino
= ino_t_to_u32(dentry
->d_inode
->i_ino
);
394 fh
->ofh_generation
= dentry
->d_inode
->i_generation
;
395 if (S_ISDIR(dentry
->d_inode
->i_mode
) ||
396 (exp
->ex_flags
& NFSEXP_NOSUBTREECHECK
))
401 fh_compose(struct svc_fh
*fhp
, struct svc_export
*exp
, struct dentry
*dentry
,
402 struct svc_fh
*ref_fh
)
404 /* ref_fh is a reference file handle.
405 * if it is non-null and for the same filesystem, then we should compose
406 * a filehandle which is of the same version, where possible.
407 * Currently, that means that if ref_fh->fh_handle.fh_version == 0xca
408 * Then create a 32byte filehandle using nfs_fhbase_old
414 struct inode
* inode
= dentry
->d_inode
;
415 struct dentry
*parent
= dentry
->d_parent
;
417 dev_t ex_dev
= exp
->ex_path
.dentry
->d_inode
->i_sb
->s_dev
;
418 int root_export
= (exp
->ex_path
.dentry
== exp
->ex_path
.dentry
->d_sb
->s_root
);
420 dprintk("nfsd: fh_compose(exp %02x:%02x/%ld %s/%s, ino=%ld)\n",
421 MAJOR(ex_dev
), MINOR(ex_dev
),
422 (long) exp
->ex_path
.dentry
->d_inode
->i_ino
,
423 parent
->d_name
.name
, dentry
->d_name
.name
,
424 (inode
? inode
->i_ino
: 0));
426 /* Choose filehandle version and fsid type based on
427 * the reference filehandle (if it is in the same export)
428 * or the export options.
432 if (ref_fh
&& ref_fh
->fh_export
== exp
) {
433 version
= ref_fh
->fh_handle
.fh_version
;
434 fsid_type
= ref_fh
->fh_handle
.fh_fsid_type
;
442 fsid_type
= FSID_DEV
;
450 /* Need to check that this type works for this
451 * export point. As the fsid -> filesystem mapping
452 * was guided by user-space, there is no guarantee
453 * that the filesystem actually supports that fsid
454 * type. If it doesn't we loop around again without
459 if (!old_valid_dev(ex_dev
))
462 case FSID_MAJOR_MINOR
:
463 case FSID_ENCODE_DEV
:
464 if (!(exp
->ex_path
.dentry
->d_inode
->i_sb
->s_type
->fs_flags
469 if (! (exp
->ex_flags
& NFSEXP_FSID
))
477 case FSID_UUID4_INUM
:
478 case FSID_UUID16_INUM
:
479 if (exp
->ex_uuid
== NULL
)
483 } else if (exp
->ex_flags
& NFSEXP_FSID
) {
484 fsid_type
= FSID_NUM
;
485 } else if (exp
->ex_uuid
) {
486 if (fhp
->fh_maxsize
>= 64) {
488 fsid_type
= FSID_UUID16
;
490 fsid_type
= FSID_UUID16_INUM
;
493 fsid_type
= FSID_UUID8
;
495 fsid_type
= FSID_UUID4_INUM
;
497 } else if (!old_valid_dev(ex_dev
))
498 /* for newer device numbers, we must use a newer fsid format */
499 fsid_type
= FSID_ENCODE_DEV
;
501 fsid_type
= FSID_DEV
;
506 if (fhp
->fh_locked
|| fhp
->fh_dentry
) {
507 printk(KERN_ERR
"fh_compose: fh %s/%s not initialized!\n",
508 parent
->d_name
.name
, dentry
->d_name
.name
);
510 if (fhp
->fh_maxsize
< NFS_FHSIZE
)
511 printk(KERN_ERR
"fh_compose: called with maxsize %d! %s/%s\n",
513 parent
->d_name
.name
, dentry
->d_name
.name
);
515 fhp
->fh_dentry
= dget(dentry
); /* our internal copy */
516 fhp
->fh_export
= exp
;
519 if (version
== 0xca) {
520 /* old style filehandle please */
521 memset(&fhp
->fh_handle
.fh_base
, 0, NFS_FHSIZE
);
522 fhp
->fh_handle
.fh_size
= NFS_FHSIZE
;
523 fhp
->fh_handle
.ofh_dcookie
= 0xfeebbaca;
524 fhp
->fh_handle
.ofh_dev
= old_encode_dev(ex_dev
);
525 fhp
->fh_handle
.ofh_xdev
= fhp
->fh_handle
.ofh_dev
;
526 fhp
->fh_handle
.ofh_xino
=
527 ino_t_to_u32(exp
->ex_path
.dentry
->d_inode
->i_ino
);
528 fhp
->fh_handle
.ofh_dirino
= ino_t_to_u32(parent_ino(dentry
));
530 _fh_update_old(dentry
, exp
, &fhp
->fh_handle
);
533 fhp
->fh_handle
.fh_version
= 1;
534 fhp
->fh_handle
.fh_auth_type
= 0;
535 datap
= fhp
->fh_handle
.fh_auth
+0;
536 fhp
->fh_handle
.fh_fsid_type
= fsid_type
;
537 mk_fsid(fsid_type
, datap
, ex_dev
,
538 exp
->ex_path
.dentry
->d_inode
->i_ino
,
539 exp
->ex_fsid
, exp
->ex_uuid
);
541 len
= key_len(fsid_type
);
543 fhp
->fh_handle
.fh_size
= 4 + len
;
546 _fh_update(fhp
, exp
, dentry
);
547 if (fhp
->fh_handle
.fh_fileid_type
== 255)
548 return nfserr_opnotsupp
;
555 * Update file handle information after changing a dentry.
556 * This is only called by nfsd_create, nfsd_create_v3 and nfsd_proc_create
559 fh_update(struct svc_fh
*fhp
)
561 struct dentry
*dentry
;
566 dentry
= fhp
->fh_dentry
;
567 if (!dentry
->d_inode
)
569 if (fhp
->fh_handle
.fh_version
!= 1) {
570 _fh_update_old(dentry
, fhp
->fh_export
, &fhp
->fh_handle
);
572 if (fhp
->fh_handle
.fh_fileid_type
!= FILEID_ROOT
)
575 _fh_update(fhp
, fhp
->fh_export
, dentry
);
576 if (fhp
->fh_handle
.fh_fileid_type
== 255)
577 return nfserr_opnotsupp
;
583 printk(KERN_ERR
"fh_update: fh not verified!\n");
586 printk(KERN_ERR
"fh_update: %s/%s still negative!\n",
587 dentry
->d_parent
->d_name
.name
, dentry
->d_name
.name
);
592 * Release a file handle.
595 fh_put(struct svc_fh
*fhp
)
597 struct dentry
* dentry
= fhp
->fh_dentry
;
598 struct svc_export
* exp
= fhp
->fh_export
;
601 fhp
->fh_dentry
= NULL
;
603 #ifdef CONFIG_NFSD_V3
604 fhp
->fh_pre_saved
= 0;
605 fhp
->fh_post_saved
= 0;
609 cache_put(&exp
->h
, &svc_export_cache
);
610 fhp
->fh_export
= NULL
;
616 * Shorthand for dprintk()'s
618 char * SVCFH_fmt(struct svc_fh
*fhp
)
620 struct knfsd_fh
*fh
= &fhp
->fh_handle
;
623 sprintf(buf
, "%d: %08x %08x %08x %08x %08x %08x",
625 fh
->fh_base
.fh_pad
[0],
626 fh
->fh_base
.fh_pad
[1],
627 fh
->fh_base
.fh_pad
[2],
628 fh
->fh_base
.fh_pad
[3],
629 fh
->fh_base
.fh_pad
[4],
630 fh
->fh_base
.fh_pad
[5]);
634 enum fsid_source
fsid_source(struct svc_fh
*fhp
)
636 if (fhp
->fh_handle
.fh_version
!= 1)
637 return FSIDSOURCE_DEV
;
638 switch(fhp
->fh_handle
.fh_fsid_type
) {
640 case FSID_ENCODE_DEV
:
641 case FSID_MAJOR_MINOR
:
642 if (fhp
->fh_export
->ex_path
.dentry
->d_inode
->i_sb
->s_type
->fs_flags
644 return FSIDSOURCE_DEV
;
647 if (fhp
->fh_export
->ex_flags
& NFSEXP_FSID
)
648 return FSIDSOURCE_FSID
;
653 /* either a UUID type filehandle, or the filehandle doesn't
656 if (fhp
->fh_export
->ex_flags
& NFSEXP_FSID
)
657 return FSIDSOURCE_FSID
;
658 if (fhp
->fh_export
->ex_uuid
)
659 return FSIDSOURCE_UUID
;
660 return FSIDSOURCE_DEV
;