1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */ 27 /* All Rights Reserved */ 28 29 #ifndef _NFS_EXPORT_H 30 #define _NFS_EXPORT_H 31 32 #include <nfs/nfs_sec.h> 33 #include <nfs/auth.h> 34 #include <sys/vnode.h> 35 #include <nfs/nfs4.h> 36 #include <sys/kiconv.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* 43 * nfs pseudo flavor number is owned by IANA. Need to make sure the 44 * Solaris specific NFS_FLAVOR_NOMAP number will not overlap with any 45 * new IANA defined pseudo flavor numbers. The chance for the overlap 46 * is very small since the growth of new flavor numbers is expected 47 * to be limited. 48 */ 49 #define NFS_FLAVOR_NOMAP 999999 /* no nfs flavor mapping */ 50 51 /* 52 * As duplicate flavors can be passed into exportfs in the arguments, we 53 * allocate a cleaned up array with non duplicate flavors on the stack. 54 * So we need to know how much to allocate. 55 */ 56 #define MAX_FLAVORS 6 /* none, sys, dh, krb5, krb5i krb5p */ 57 58 /* 59 * Note: exported_lock is currently used to ensure the integrity of 60 * the secinfo fields. 61 */ 62 struct secinfo { 63 seconfig_t s_secinfo; /* /etc/nfssec.conf entry */ 64 unsigned int s_flags; /* flags (see below) */ 65 int32_t s_refcnt; /* reference count for tracking */ 66 /* how many children (self included) */ 67 /* use this flavor. */ 68 int s_window; /* window */ 69 uint_t s_rootid; /* UID to use for authorized roots */ 70 int s_rootcnt; /* count of root names */ 71 caddr_t *s_rootnames; /* array of root names */ 72 /* they are strings for AUTH_DES and */ 73 /* rpc_gss_principal_t for RPCSEC_GSS */ 74 }; 75 76 #ifdef _SYSCALL32 77 struct secinfo32 { 78 seconfig32_t s_secinfo; /* /etc/nfssec.conf entry */ 79 uint32_t s_flags; /* flags (see below) */ 80 int32_t s_refcnt; /* reference count for tracking */ 81 /* how many children (self included) */ 82 /* use this flavor. */ 83 int32_t s_window; /* window */ 84 uint32_t s_rootid; /* UID to use for authorized roots */ 85 int32_t s_rootcnt; /* count of root names */ 86 caddr32_t s_rootnames; /* array of root names */ 87 /* they are strings for AUTH_DES and */ 88 /* rpc_gss_principal_t for RPCSEC_GSS */ 89 }; 90 #endif /* _SYSCALL32 */ 91 92 /* 93 * security negotiation related 94 */ 95 96 #define SEC_QUERY 0x01 /* query sec modes */ 97 98 struct sec_ol { 99 int sec_flags; /* security nego flags */ 100 uint_t sec_index; /* index into sec flavor array */ 101 }; 102 103 /* 104 * Per-mode flags (secinfo.s_flags) 105 */ 106 #define M_RO 0x01 /* exported ro to all */ 107 #define M_ROL 0x02 /* exported ro to all listed */ 108 #define M_RW 0x04 /* exported rw to all */ 109 #define M_RWL 0x08 /* exported ro to all listed */ 110 #define M_ROOT 0x10 /* root list is defined */ 111 #define M_4SEC_EXPORTED 0x20 /* this is an explicitly shared flavor */ 112 #define M_NONE 0x40 /* none list is defined */ 113 114 /* invalid secinfo reference count */ 115 #define SEC_REF_INVALID(p) ((p)->s_refcnt < 1) 116 117 /* last secinfo reference */ 118 #define SEC_REF_LAST(p) ((p)->s_refcnt == 1) 119 120 /* sec flavor explicitly shared for the exported node */ 121 #define SEC_REF_EXPORTED(p) ((p)->s_flags & M_4SEC_EXPORTED) 122 123 /* the only reference count left is for referring itself */ 124 #define SEC_REF_SELF(p) (SEC_REF_LAST(p) && SEC_REF_EXPORTED(p)) 125 126 /* 127 * The export information passed to exportfs() (Version 2) 128 */ 129 #define EX_CURRENT_VERSION 2 /* current version of exportdata struct */ 130 131 struct exportdata { 132 int ex_version; /* structure version */ 133 char *ex_path; /* exported path */ 134 size_t ex_pathlen; /* path length */ 135 int ex_flags; /* flags */ 136 unsigned int ex_anon; /* uid for unauthenticated requests */ 137 int ex_seccnt; /* count of security modes */ 138 struct secinfo *ex_secinfo; /* security mode info */ 139 char *ex_index; /* index file for public filesystem */ 140 char *ex_log_buffer; /* path to logging buffer file */ 141 size_t ex_log_bufferlen; /* buffer file path len */ 142 char *ex_tag; /* tag used to identify log config */ 143 size_t ex_taglen; /* tag length */ 144 }; 145 146 #ifdef _SYSCALL32 147 struct exportdata32 { 148 int32_t ex_version; /* structure version */ 149 caddr32_t ex_path; /* exported path */ 150 int32_t ex_pathlen; /* path length */ 151 int32_t ex_flags; /* flags */ 152 uint32_t ex_anon; /* uid for unauthenticated requests */ 153 int32_t ex_seccnt; /* count of security modes */ 154 caddr32_t ex_secinfo; /* security mode info */ 155 caddr32_t ex_index; /* index file for public filesystem */ 156 caddr32_t ex_log_buffer; /* path to logging buffer file */ 157 int32_t ex_log_bufferlen; /* buffer file path len */ 158 caddr32_t ex_tag; /* tag used to identify log config */ 159 int32_t ex_taglen; /* tag length */ 160 }; 161 #endif /* _SYSCALL32 */ 162 163 /* 164 * exported vfs flags. 165 */ 166 167 #define EX_NOSUID 0x01 /* exported with unsetable set[ug]ids */ 168 #define EX_ACLOK 0x02 /* exported with maximal access if acl exists */ 169 #define EX_PUBLIC 0x04 /* exported with public filehandle */ 170 #define EX_NOSUB 0x08 /* no nfs_getfh or MCL below export point */ 171 #define EX_INDEX 0x10 /* exported with index file specified */ 172 #define EX_LOG 0x20 /* logging enabled */ 173 #define EX_LOG_ALLOPS 0x40 /* logging of all RPC operations enabled */ 174 /* by default only operations which affect */ 175 /* transaction logging are enabled */ 176 #define EX_PSEUDO 0x80 /* pseudo filesystem export */ 177 #ifdef VOLATILE_FH_TEST 178 #define EX_VOLFH 0x100 /* XXX nfsv4 fh may expire anytime */ 179 #define EX_VOLRNM 0x200 /* XXX nfsv4 fh expire at rename */ 180 #define EX_VOLMIG 0x400 /* XXX nfsv4 fh expire at migration */ 181 #define EX_NOEXPOPEN 0x800 /* XXX nfsv4 fh no expire with open */ 182 #endif /* VOLATILE_FH_TEST */ 183 184 #define EX_CHARMAP 0x1000 /* NFS may need a character set conversion */ 185 186 #ifdef _KERNEL 187 188 #define RPC_IDEMPOTENT 0x1 /* idempotent or not */ 189 /* 190 * Be very careful about which NFS procedures get the RPC_ALLOWANON bit. 191 * Right now, it this bit is on, we ignore the results of per NFS request 192 * access control. 193 */ 194 #define RPC_ALLOWANON 0x2 /* allow anonymous access */ 195 #define RPC_MAPRESP 0x4 /* use mapped response buffer */ 196 #define RPC_AVOIDWORK 0x8 /* do work avoidance for dups */ 197 #define RPC_PUBLICFH_OK 0x10 /* allow use of public filehandle */ 198 199 /* 200 * RPC_ALL is an or of all above bits to be used with "don't care" 201 * nfsv4 ops. The flags of an nfsv4 request is the bit-AND of the 202 * per-op flags. 203 */ 204 #define RPC_ALL (RPC_IDEMPOTENT|RPC_ALLOWANON|RPC_AVOIDWORK|RPC_PUBLICFH_OK) 205 206 207 #ifdef VOLATILE_FH_TEST 208 struct ex_vol_rename { 209 nfs_fh4_fmt_t vrn_fh_fmt; 210 struct ex_vol_rename *vrn_next; 211 }; 212 #endif /* VOLATILE_FH_TEST */ 213 214 /* 215 * An authorization cache entry 216 */ 217 struct auth_cache { 218 struct netbuf auth_addr; 219 int auth_flavor; 220 int auth_access; 221 time_t auth_time; 222 struct auth_cache *auth_next; 223 }; 224 225 #define AUTH_TABLESIZE 32 226 227 /* 228 * Structure containing log file meta-data. 229 */ 230 struct log_file { 231 unsigned int lf_flags; /* flags (see below) */ 232 int lf_writers; /* outstanding writers */ 233 int lf_refcnt; /* references to this struct */ 234 caddr_t lf_path; /* buffer file location */ 235 vnode_t *lf_vp; /* vnode for the buffer file */ 236 kmutex_t lf_lock; 237 kcondvar_t lf_cv_waiters; 238 }; 239 240 /* 241 * log_file and log_buffer flags. 242 */ 243 #define L_WAITING 0x01 /* flush of in-core data to stable */ 244 /* storage in progress */ 245 #define L_PRINTED 0x02 /* error message printed to console */ 246 #define L_ERROR 0x04 /* error condition detected */ 247 248 /* 249 * The logging buffer information. 250 * This structure may be shared by multiple exportinfo structures, 251 * if they share the same buffer file. 252 * This structure contains the basic information about the buffer, such 253 * as it's location in the filesystem. 254 * 255 * 'lb_lock' protects all the fields in this structure except for 'lb_path', 256 * and 'lb_next'. 257 * 'lb_path' is a write-once/read-many field which needs no locking, it is 258 * set before the structure is linked to any exportinfo structure. 259 * 'lb_next' is protected by the log_buffer_list_lock. 260 */ 261 struct log_buffer { 262 unsigned int lb_flags; /* L_ONLIST set? */ 263 int lb_refcnt; /* references to this struct */ 264 unsigned int lb_rec_id; /* used to generate unique id */ 265 caddr_t lb_path; /* buffer file pathname */ 266 struct log_file *lb_logfile; /* points to log_file structure */ 267 kmutex_t lb_lock; 268 struct log_buffer *lb_next; 269 kcondvar_t lb_cv_waiters; 270 caddr_t lb_records; /* linked list of records to write */ 271 int lb_num_recs; /* # of records to write */ 272 ssize_t lb_size_queued; /* number of bytes queued for write */ 273 }; 274 275 #define LOG_BUFFER_HOLD(lbp) { \ 276 mutex_enter(&(lbp)->lb_lock); \ 277 (lbp)->lb_refcnt++; \ 278 mutex_exit(&(lbp)->lb_lock); \ 279 } 280 281 #define LOG_BUFFER_RELE(lbp) { \ 282 log_buffer_rele(lbp); \ 283 } 284 285 /* 286 * Structure for character set conversion mapping based on client address. 287 */ 288 struct charset_cache { 289 struct charset_cache *next; 290 kiconv_t inbound; 291 kiconv_t outbound; 292 struct sockaddr client_addr; 293 }; 294 295 /* Forward declarations */ 296 struct exportinfo; 297 struct exp_visible; 298 struct svc_req; 299 300 /* 301 * Treenodes are used to build tree representing every node which is part 302 * of nfs server pseudo namespace. 303 * This tree is interconnected with both exportinfo and exp_visible struct. 304 * When there is a need to walk the namespace (either starting in 305 * exportinfo or in exp_visible) we first make a step aside (to the left), 306 * walk up or down as needed, and then we step back (to the right). 307 * 308 * 309 * 310 * NEW DATA STRUCT ORIGINAL DATA STRUCT 311 * 312 * ns_root +---+ +----------+ 313 * | / | |PSEUDO EXP|-->+---+ +---+ +---+ 314 * +---+--------- ----+----------+ | a |-->| k |-->| b | 315 * /\ +---+ +---+ +---+ 316 * / \ . . . 317 * +---+...\......... ..................... . . 318 * *| a | \ +----------+ . . 319 * +---+-----\------- ----|REAL EXP a| . . 320 * / \ +----------+ . . 321 * / +===+... ............................. . 322 * / *| k | +----------+ . 323 * / +===+--- ----|REAL EXP k| . 324 * / +----------+ . 325 * +===+................ ..................................... 326 * *| b | +----------+ 327 * +===+---------------- ----|REAL EXP b|-->+---+ 328 * \ +----------+ | d | 329 * +===+............. ...................+---+ 330 * | d | +----------+ 331 * +===+------------- ----|PSEUDO EXP|-->+---+ +---+ 332 * / +----------+ | e |-->| g | 333 * +---+................. ...................+---+ +---+ 334 * | e | . 335 * +---+ . 336 * \ . 337 * +---+.............. ............................ 338 * *| g | +----------+ 339 * +---+-------------- ----|REAL EXP g| 340 * +----------+ 341 * 342 * 343 * 344 * +===+ +---+ +---+ 345 * | b |..mountpoint | e |..directory/file *| a |..node is shared 346 * +===+ (VROOT) +---+ +---+ 347 * 348 * 349 * Bi-directional interconnect: 350 * 351 * treenode_t::tree_exi --------- exportinfo_t::exi_tree 352 * treenode_t::tree_vis ......... exp_visible_t::vis_tree 353 */ 354 /* Access to treenode_t is under protection of exported_lock RW_LOCK */ 355 typedef struct treenode { 356 /* support for generic n-ary trees */ 357 struct treenode *tree_parent; 358 struct treenode *tree_child_first; 359 struct treenode *tree_sibling; /* next sibling */ 360 /* private, nfs specific part */ 361 struct exportinfo *tree_exi; 362 struct exp_visible *tree_vis; 363 } treenode_t; 364 365 /* 366 * TREE_ROOT checks if the node corresponds to a filesystem root 367 * TREE_EXPORTED checks if the node is explicitly shared 368 */ 369 370 #define TREE_ROOT(t) \ 371 ((t)->tree_exi && (t)->tree_exi->exi_vp->v_flag & VROOT) 372 373 #define TREE_EXPORTED(t) \ 374 ((t)->tree_exi && !PSEUDO((t)->tree_exi)) 375 376 /* Root of nfs pseudo namespace */ 377 extern treenode_t *ns_root; 378 379 #define EXPTABLESIZE 16 380 381 /* 382 * A node associated with an export entry on the 383 * list of exported filesystems. 384 * 385 * exi_count+exi_lock protects an individual exportinfo from being freed 386 * when in use. 387 * You must have the writer lock on exported_lock to add/delete an exportinfo 388 * structure to/from the list. 389 * 390 * exi_volatile_dev maps to VSW_VOLATILEDEV. It means that the 391 * underlying fs devno can change on each mount. When set, the server 392 * should not use va_fsid for a GETATTR(FATTR4_FSID) reply. It must 393 * use exi_fsid because it is guaranteed to be persistent. This isn't 394 * in any way related to NFS4 volatile filehandles. 395 */ 396 struct exportinfo { 397 struct exportdata exi_export; 398 fsid_t exi_fsid; 399 struct fid exi_fid; 400 struct exportinfo *exi_hash; 401 struct treenode *exi_tree; 402 fhandle_t exi_fh; 403 krwlock_t exi_cache_lock; 404 kmutex_t exi_lock; 405 uint_t exi_count; 406 vnode_t *exi_vp; 407 vnode_t *exi_dvp; 408 struct auth_cache *exi_cache[AUTH_TABLESIZE]; 409 struct log_buffer *exi_logbuffer; 410 struct exp_visible *exi_visible; 411 struct charset_cache *exi_charset; 412 unsigned exi_volatile_dev:1; 413 unsigned exi_moved:1; 414 #ifdef VOLATILE_FH_TEST 415 uint32_t exi_volatile_id; 416 struct ex_vol_rename *exi_vol_rename; 417 kmutex_t exi_vol_rename_lock; 418 #endif /* VOLATILE_FH_TEST */ 419 }; 420 421 typedef struct exportinfo exportinfo_t; 422 typedef struct exportdata exportdata_t; 423 typedef struct secinfo secinfo_t; 424 425 /* 426 * exp_visible is a visible list per filesystem. It is for filesystems 427 * that may need a limited view of its contents. A pseudo export and 428 * a real export at the mount point (VROOT) which has a subtree shared 429 * has a visible list. 430 * 431 * The exi_visible field is NULL for normal, non=pseudo filesystems 432 * which do not have any subtree exported. If the field is non-null, 433 * it points to a list of visible entries, identified by vis_fid and/or 434 * vis_ino. The presence of a "visible" list means that if this export 435 * can only have a limited view, it can only view the entries in the 436 * exp_visible list. The directories in the fid list comprise paths that 437 * lead to exported directories. 438 * 439 * The vis_count field records the number of paths in this filesystem 440 * that use this directory. The vis_exported field is non-zero if the 441 * entry is an exported directory (leaf node). 442 * 443 * exp_visible itself is not reference counted. Each exp_visible is 444 * referenced twice: 445 * 1) from treenode::tree_vis 446 * 2) linked from exportinfo::exi_visible 447 * The 'owner' of exp_visible is the exportinfo structure. exp_visible should 448 * be always freed only from exportinfo_t, never from treenode::tree_vis. 449 */ 450 451 struct exp_visible { 452 vnode_t *vis_vp; 453 fid_t vis_fid; 454 u_longlong_t vis_ino; 455 int vis_count; 456 int vis_exported; 457 struct exp_visible *vis_next; 458 struct treenode *vis_tree; 459 struct secinfo *vis_secinfo; 460 int vis_seccnt; 461 }; 462 typedef struct exp_visible exp_visible_t; 463 464 #define PSEUDO(exi) ((exi)->exi_export.ex_flags & EX_PSEUDO) 465 466 #define EQFSID(fsidp1, fsidp2) \ 467 (((fsidp1)->val[0] == (fsidp2)->val[0]) && \ 468 ((fsidp1)->val[1] == (fsidp2)->val[1])) 469 470 #define EQFID(fidp1, fidp2) \ 471 ((fidp1)->fid_len == (fidp2)->fid_len && \ 472 bcmp((char *)(fidp1)->fid_data, (char *)(fidp2)->fid_data, \ 473 (uint_t)(fidp1)->fid_len) == 0) 474 475 #define exportmatch(exi, fsid, fid) \ 476 (EQFSID(&(exi)->exi_fsid, (fsid)) && EQFID(&(exi)->exi_fid, (fid))) 477 478 /* 479 * Returns true iff exported filesystem is read-only to the given host. 480 * 481 * Note: this macro should be as fast as possible since it's called 482 * on each NFS modification request. 483 */ 484 #define rdonly(exi, req) (nfsauth_access(exi, req) & NFSAUTH_RO) 485 #define rdonly4(exi, vp, req) \ 486 (vn_is_readonly(vp) || \ 487 (nfsauth4_access(exi, vp, req) & (NFSAUTH_RO | NFSAUTH_LIMITED))) 488 489 extern int nfsauth4_access(struct exportinfo *, vnode_t *, 490 struct svc_req *); 491 extern int nfsauth4_secinfo_access(struct exportinfo *, 492 struct svc_req *, int, int); 493 extern int nfs_fhhash(fsid_t *, fid_t *); 494 extern int nfs_fhbcmp(char *, char *, int); 495 extern int nfs_exportinit(void); 496 extern void nfs_exportfini(void); 497 extern int chk_clnt_sec(struct exportinfo *, struct svc_req *req); 498 extern int makefh(fhandle_t *, struct vnode *, struct exportinfo *); 499 extern int makefh_ol(fhandle_t *, struct exportinfo *, uint_t); 500 extern int makefh3(nfs_fh3 *, struct vnode *, struct exportinfo *); 501 extern int makefh3_ol(nfs_fh3 *, struct exportinfo *, uint_t); 502 extern vnode_t *nfs_fhtovp(fhandle_t *, struct exportinfo *); 503 extern vnode_t *nfs3_fhtovp(nfs_fh3 *, struct exportinfo *); 504 extern vnode_t *lm_fhtovp(fhandle_t *fh); 505 extern vnode_t *lm_nfs3_fhtovp(nfs_fh3 *fh); 506 extern struct exportinfo *checkexport(fsid_t *, struct fid *); 507 extern struct exportinfo *checkexport4(fsid_t *, struct fid *, vnode_t *vp); 508 extern void exi_rele(struct exportinfo *); 509 extern struct exportinfo *nfs_vptoexi(vnode_t *, vnode_t *, cred_t *, int *, 510 int *, bool_t); 511 extern int nfs_check_vpexi(vnode_t *, vnode_t *, cred_t *, 512 struct exportinfo **); 513 extern void export_link(struct exportinfo *); 514 extern int export_unlink(fsid_t *, fid_t *, vnode_t *, 515 struct exportinfo **); 516 extern vnode_t *untraverse(vnode_t *); 517 extern int vn_is_nfs_reparse(vnode_t *, cred_t *); 518 extern int client_is_downrev(struct svc_req *); 519 extern char *build_symlink(vnode_t *, cred_t *, size_t *); 520 521 /* 522 * Functions that handle the NFSv4 server namespace 523 */ 524 extern exportinfo_t *vis2exi(struct exp_visible *); 525 extern int treeclimb_export(struct exportinfo *); 526 extern void treeclimb_unexport(struct exportinfo *); 527 extern int nfs_visible(struct exportinfo *, vnode_t *, int *); 528 extern int nfs_visible_inode(struct exportinfo *, ino64_t, int *); 529 extern int has_visible(struct exportinfo *, vnode_t *); 530 extern void free_visible(struct exp_visible *); 531 extern int nfs_exported(struct exportinfo *, vnode_t *); 532 extern int pseudo_exportfs(vnode_t *, struct exp_visible *, 533 struct exportdata *, struct exportinfo **); 534 extern int vop_fid_pseudo(vnode_t *, fid_t *fidp); 535 extern int nfs4_vget_pseudo(struct exportinfo *, vnode_t **, fid_t *); 536 /* 537 * Functions that handle the NFSv4 server namespace security flavors 538 * information. 539 */ 540 extern void srv_secinfo_exp2pseu(struct exportdata *, struct exportdata *); 541 extern void srv_secinfo_list_free(struct secinfo *, int); 542 543 /* 544 * "public" and default (root) location for public filehandle 545 */ 546 extern struct exportinfo *exi_public, *exi_root; 547 extern fhandle_t nullfh2; /* for comparing V2 filehandles */ 548 extern krwlock_t exported_lock; 549 extern struct exportinfo *exptable[]; 550 551 /* 552 * Two macros for identifying public filehandles. 553 * A v2 public filehandle is 32 zero bytes. 554 * A v3 public filehandle is zero length. 555 */ 556 #define PUBLIC_FH2(fh) \ 557 ((fh)->fh_fsid.val[1] == 0 && \ 558 bcmp((fh), &nullfh2, sizeof (fhandle_t)) == 0) 559 560 #define PUBLIC_FH3(fh) \ 561 ((fh)->fh3_length == 0) 562 563 extern int makefh4(nfs_fh4 *, struct vnode *, struct exportinfo *); 564 extern vnode_t *nfs4_fhtovp(nfs_fh4 *, struct exportinfo *, nfsstat4 *); 565 566 #endif /* _KERNEL */ 567 568 #ifdef __cplusplus 569 } 570 #endif 571 572 #endif /* _NFS_EXPORT_H */ 573