1/*
2 * Copyright (c) 2006-2016 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29/*
30 * miscellaneous support functions for NFSv4
31 */
32#include <sys/param.h>
33#include <sys/proc.h>
34#include <sys/kauth.h>
35#include <sys/systm.h>
36#include <sys/kernel.h>
37#include <sys/mount_internal.h>
38#include <sys/vnode_internal.h>
39#include <sys/kpi_mbuf.h>
40#include <sys/socket.h>
41#include <sys/stat.h>
42#include <sys/malloc.h>
43#include <sys/syscall.h>
44#include <sys/ubc_internal.h>
45#include <sys/fcntl.h>
46#include <sys/quota.h>
47#include <sys/domain.h>
48#include <libkern/OSAtomic.h>
49#include <kern/thread_call.h>
50
51#include <sys/vm.h>
52#include <sys/vmparam.h>
53
54#include <sys/time.h>
55#include <kern/clock.h>
56
57#include <nfs/rpcv2.h>
58#include <nfs/nfsproto.h>
59#include <nfs/nfs.h>
60#include <nfs/nfsnode.h>
61#include <nfs/xdr_subs.h>
62#include <nfs/nfsm_subs.h>
63#include <nfs/nfs_gss.h>
64#include <nfs/nfsmount.h>
65#include <nfs/nfs_lock.h>
66
67#include <miscfs/specfs/specdev.h>
68
69#include <netinet/in.h>
70#include <net/kpi_interface.h>
71
72/*
73 * NFS_MAX_WHO is the maximum length of a string representation used
74 * in as an ace who, owner, or group. There is no explicit limit in the
75 * protocol, however the kauth routines have a limit of MAPATHLEN for
76 * strings including the trailing null character, so we impose that
77 * limit. This should be changed if kauth routines change.
78 *
79 * We also want some reasonable maximum, as 32 bits worth of string length
80 * is liable to cause problems. At the very least this limit must guarantee
81 * that any express that contains the 32 bit length from off the wire used in
82 * allocations does not overflow.
83 */
84#define NFS_MAX_WHO MAXPATHLEN
85
86/*
87 * Create the unique client ID to use for this mount.
88 *
89 * Format: unique ID + en0_address + server_address + mntfromname + mntonname
90 *
91 * We could possibly use one client ID for all mounts of the same server;
92 * however, that would complicate some aspects of state management.
93 *
94 * Each mount socket connection sends a SETCLIENTID. If the ID is the same but
95 * the verifier (mounttime) changes, then all previous (mounts') state gets dropped.
96 *
97 * State is typically managed per-mount and in order to keep it that way
98 * each mount needs to use a separate client ID. However, we also need to
99 * make sure that each mount uses the same client ID each time.
100 *
101 * In an attempt to differentiate mounts we include the mntfromname and mntonname
102 * strings to the client ID (as long as they fit). We also make sure that the
103 * value does not conflict with any existing values in use (changing the unique ID).
104 *
105 * Note that info such as the server's address may change over the lifetime of the
106 * mount. But the client ID will not be updated because we don't want it changing
107 * simply because we switched to a different server address.
108 */
109int
110nfs4_init_clientid(struct nfsmount *nmp)
111{
112 struct nfs_client_id *ncip, *ncip2;
113 struct sockaddr *saddr;
114 int error, len, len2, cmp;
115 struct vfsstatfs *vsfs;
116
117 static uint8_t en0addr[6];
118 static uint8_t en0addr_set = 0;
119
120 lck_mtx_lock(nfs_global_mutex);
121 if (!en0addr_set) {
122 ifnet_t interface = NULL;
123 error = ifnet_find_by_name("en0", &interface);
124 if (!error)
125 error = ifnet_lladdr_copy_bytes(interface, en0addr, sizeof(en0addr));
126 if (error)
127 printf("nfs4_init_clientid: error getting en0 address, %d\n", error);
128 if (!error)
129 en0addr_set = 1;
130 if (interface)
131 ifnet_release(interface);
132 }
133 lck_mtx_unlock(nfs_global_mutex);
134
135 MALLOC(ncip, struct nfs_client_id *, sizeof(struct nfs_client_id), M_TEMP, M_WAITOK);
136 if (!ncip)
137 return (ENOMEM);
138
139 vsfs = vfs_statfs(nmp->nm_mountp);
140 saddr = nmp->nm_saddr;
141 ncip->nci_idlen = sizeof(uint32_t) + sizeof(en0addr) + saddr->sa_len +
142 strlen(vsfs->f_mntfromname) + 1 + strlen(vsfs->f_mntonname) + 1;
143 if (ncip->nci_idlen > NFS4_OPAQUE_LIMIT)
144 ncip->nci_idlen = NFS4_OPAQUE_LIMIT;
145 MALLOC(ncip->nci_id, char *, ncip->nci_idlen, M_TEMP, M_WAITOK);
146 if (!ncip->nci_id) {
147 FREE(ncip, M_TEMP);
148 return (ENOMEM);
149 }
150
151 *(uint32_t*)ncip->nci_id = 0;
152 len = sizeof(uint32_t);
153 len2 = min(sizeof(en0addr), ncip->nci_idlen-len);
154 bcopy(en0addr, &ncip->nci_id[len], len2);
155 len += sizeof(en0addr);
156 len2 = min(saddr->sa_len, ncip->nci_idlen-len);
157 bcopy(saddr, &ncip->nci_id[len], len2);
158 len += len2;
159 if (len < ncip->nci_idlen) {
160 len2 = strlcpy(&ncip->nci_id[len], vsfs->f_mntfromname, ncip->nci_idlen-len);
161 if (len2 < (ncip->nci_idlen - len))
162 len += len2 + 1;
163 else
164 len = ncip->nci_idlen;
165 }
166 if (len < ncip->nci_idlen) {
167 len2 = strlcpy(&ncip->nci_id[len], vsfs->f_mntonname, ncip->nci_idlen-len);
168 if (len2 < (ncip->nci_idlen - len))
169 len += len2 + 1;
170 else
171 len = ncip->nci_idlen;
172 }
173
174 /* make sure the ID is unique, and add it to the sorted list */
175 lck_mtx_lock(nfs_global_mutex);
176 TAILQ_FOREACH(ncip2, &nfsclientids, nci_link) {
177 if (ncip->nci_idlen > ncip2->nci_idlen)
178 continue;
179 if (ncip->nci_idlen < ncip2->nci_idlen)
180 break;
181 cmp = bcmp(ncip->nci_id + sizeof(uint32_t),
182 ncip2->nci_id + sizeof(uint32_t),
183 ncip->nci_idlen - sizeof(uint32_t));
184 if (cmp > 0)
185 continue;
186 if (cmp < 0)
187 break;
188 if (*(uint32_t*)ncip->nci_id > *(uint32_t*)ncip2->nci_id)
189 continue;
190 if (*(uint32_t*)ncip->nci_id < *(uint32_t*)ncip2->nci_id)
191 break;
192 *(uint32_t*)ncip->nci_id += 1;
193 }
194 if (*(uint32_t*)ncip->nci_id)
195 printf("nfs client ID collision (%d) for %s on %s\n", *(uint32_t*)ncip->nci_id,
196 vsfs->f_mntfromname, vsfs->f_mntonname);
197 if (ncip2)
198 TAILQ_INSERT_BEFORE(ncip2, ncip, nci_link);
199 else
200 TAILQ_INSERT_TAIL(&nfsclientids, ncip, nci_link);
201 nmp->nm_longid = ncip;
202 lck_mtx_unlock(nfs_global_mutex);
203
204 return (0);
205}
206
207/*
208 * NFSv4 SETCLIENTID
209 */
210int
211nfs4_setclientid(struct nfsmount *nmp)
212{
213 uint64_t verifier, xid;
214 int error = 0, status, numops;
215 uint32_t bitmap[NFS_ATTR_BITMAP_LEN];
216 thread_t thd;
217 kauth_cred_t cred;
218 struct nfsm_chain nmreq, nmrep;
219 struct sockaddr_storage ss;
220 void *sinaddr = NULL;
221 char raddr[MAX_IPv6_STR_LEN];
222 char uaddr[MAX_IPv6_STR_LEN+16];
223 int ualen = 0;
224 in_port_t port;
225
226 thd = current_thread();
227 cred = IS_VALID_CRED(nmp->nm_mcred) ? nmp->nm_mcred : vfs_context_ucred(vfs_context_kernel());
228 kauth_cred_ref(cred);
229
230 nfsm_chain_null(&nmreq);
231 nfsm_chain_null(&nmrep);
232
233 if (!nmp->nm_longid)
234 error = nfs4_init_clientid(nmp);
235
236 // SETCLIENTID
237 numops = 1;
238 nfsm_chain_build_alloc_init(error, &nmreq, 14 * NFSX_UNSIGNED + nmp->nm_longid->nci_idlen);
239 nfsm_chain_add_compound_header(error, &nmreq, "setclid", nmp->nm_minor_vers, numops);
240 numops--;
241 nfsm_chain_add_32(error, &nmreq, NFS_OP_SETCLIENTID);
242 /* nfs_client_id4 client; */
243 nfsm_chain_add_64(error, &nmreq, nmp->nm_mounttime);
244 nfsm_chain_add_32(error, &nmreq, nmp->nm_longid->nci_idlen);
245 nfsm_chain_add_opaque(error, &nmreq, nmp->nm_longid->nci_id, nmp->nm_longid->nci_idlen);
246 nfsmout_if(error);
247 /* cb_client4 callback; */
248 if (!NMFLAG(nmp, NOCALLBACK) && nmp->nm_cbid && nfs4_cb_port &&
249 !sock_getsockname(nmp->nm_nso->nso_so, (struct sockaddr*)&ss, sizeof(ss))) {
250 if (ss.ss_family == AF_INET) {
251 sinaddr = &((struct sockaddr_in*)&ss)->sin_addr;
252 port = nfs4_cb_port;
253 } else if (ss.ss_family == AF_INET6) {
254 sinaddr = &((struct sockaddr_in6*)&ss)->sin6_addr;
255 port = nfs4_cb_port6;
256 }
257 if (sinaddr && port && (inet_ntop(ss.ss_family, sinaddr, raddr, sizeof(raddr)) == raddr)) {
258 /* assemble r_addr = universal address (nmp->nm_nso->nso_so source IP addr + port) */
259 ualen = snprintf(uaddr, sizeof(uaddr), "%s.%d.%d", raddr,
260 ((port >> 8) & 0xff),
261 (port & 0xff));
262 /* make sure it fit, give up if it didn't */
263 if (ualen >= (int)sizeof(uaddr))
264 ualen = 0;
265 }
266 }
267 if (ualen > 0) {
268 /* add callback info */
269 nfsm_chain_add_32(error, &nmreq, NFS4_CALLBACK_PROG); /* callback program */
270 if (ss.ss_family == AF_INET)
271 nfsm_chain_add_string(error, &nmreq, "tcp", 3); /* callback r_netid */
272 else if (ss.ss_family == AF_INET6)
273 nfsm_chain_add_string(error, &nmreq, "tcp6", 4); /* callback r_netid */
274 nfsm_chain_add_string(error, &nmreq, uaddr, ualen); /* callback r_addr */
275 nfsm_chain_add_32(error, &nmreq, nmp->nm_cbid); /* callback_ident */
276 } else {
277 /* don't provide valid callback info */
278 nfsm_chain_add_32(error, &nmreq, 0); /* callback program */
279 nfsm_chain_add_string(error, &nmreq, "", 0); /* callback r_netid */
280 nfsm_chain_add_string(error, &nmreq, "", 0); /* callback r_addr */
281 nfsm_chain_add_32(error, &nmreq, 0); /* callback_ident */
282 }
283 nfsm_chain_build_done(error, &nmreq);
284 nfsm_assert(error, (numops == 0), EPROTO);
285 nfsmout_if(error);
286 error = nfs_request2(NULL, nmp->nm_mountp, &nmreq, NFSPROC4_COMPOUND, thd, cred, NULL, R_SETUP, &nmrep, &xid, &status);
287 nfsm_chain_skip_tag(error, &nmrep);
288 nfsm_chain_get_32(error, &nmrep, numops);
289 if (!error && (numops != 1) && status)
290 error = status;
291 nfsm_chain_op_check(error, &nmrep, NFS_OP_SETCLIENTID);
292 if (error == NFSERR_CLID_INUSE)
293 printf("nfs4_setclientid: client ID in use?\n");
294 nfsmout_if(error);
295 nfsm_chain_get_64(error, &nmrep, nmp->nm_clientid);
296 nfsm_chain_get_64(error, &nmrep, verifier);
297 nfsm_chain_cleanup(&nmreq);
298 nfsm_chain_cleanup(&nmrep);
299
300 // SETCLIENTID_CONFIRM
301 numops = 1;
302 nfsm_chain_build_alloc_init(error, &nmreq, 15 * NFSX_UNSIGNED);
303 nfsm_chain_add_compound_header(error, &nmreq, "setclid_conf", nmp->nm_minor_vers, numops);
304 numops--;
305 nfsm_chain_add_32(error, &nmreq, NFS_OP_SETCLIENTID_CONFIRM);
306 nfsm_chain_add_64(error, &nmreq, nmp->nm_clientid);
307 nfsm_chain_add_64(error, &nmreq, verifier);
308 nfsm_chain_build_done(error, &nmreq);
309 nfsm_assert(error, (numops == 0), EPROTO);
310 nfsmout_if(error);
311 error = nfs_request2(NULL, nmp->nm_mountp, &nmreq, NFSPROC4_COMPOUND, thd, cred, NULL, R_SETUP, &nmrep, &xid, &status);
312 nfsm_chain_skip_tag(error, &nmrep);
313 nfsm_chain_get_32(error, &nmrep, numops);
314 nfsm_chain_op_check(error, &nmrep, NFS_OP_SETCLIENTID_CONFIRM);
315 if (error)
316 printf("nfs4_setclientid: confirm error %d\n", error);
317 lck_mtx_lock(&nmp->nm_lock);
318 if (!error)
319 nmp->nm_state |= NFSSTA_CLIENTID;
320 lck_mtx_unlock(&nmp->nm_lock);
321
322 nfsmout_if(error || !nmp->nm_dnp);
323
324 /* take the opportunity to refresh fs attributes too */
325 // PUTFH, GETATTR(FS)
326 numops = 2;
327 nfsm_chain_build_alloc_init(error, &nmreq, 23 * NFSX_UNSIGNED);
328 nfsm_chain_add_compound_header(error, &nmreq, "setclid_attr", nmp->nm_minor_vers, numops);
329 numops--;
330 nfsm_chain_add_32(error, &nmreq, NFS_OP_PUTFH);
331 nfsm_chain_add_fh(error, &nmreq, nmp->nm_vers, nmp->nm_dnp->n_fhp, nmp->nm_dnp->n_fhsize);
332 numops--;
333 nfsm_chain_add_32(error, &nmreq, NFS_OP_GETATTR);
334 NFS_CLEAR_ATTRIBUTES(bitmap);
335 NFS4_PER_FS_ATTRIBUTES(bitmap);
336 nfsm_chain_add_bitmap(error, &nmreq, bitmap, NFS_ATTR_BITMAP_LEN);
337 nfsm_chain_build_done(error, &nmreq);
338 nfsm_assert(error, (numops == 0), EPROTO);
339 nfsmout_if(error);
340 error = nfs_request2(NULL, nmp->nm_mountp, &nmreq, NFSPROC4_COMPOUND, thd, cred, NULL, R_SETUP, &nmrep, &xid, &status);
341 nfsm_chain_skip_tag(error, &nmrep);
342 nfsm_chain_get_32(error, &nmrep, numops);
343 lck_mtx_lock(&nmp->nm_lock);
344 nfsm_chain_op_check(error, &nmrep, NFS_OP_PUTFH);
345 nfsm_chain_op_check(error, &nmrep, NFS_OP_GETATTR);
346 if (!error)
347 error = nfs4_parsefattr(&nmrep, &nmp->nm_fsattr, NULL, NULL, NULL, NULL);
348 lck_mtx_unlock(&nmp->nm_lock);
349 if (error) /* ignore any error from the getattr */
350 error = 0;
351nfsmout:
352 nfsm_chain_cleanup(&nmreq);
353 nfsm_chain_cleanup(&nmrep);
354 kauth_cred_unref(&cred);
355 if (error)
356 printf("nfs4_setclientid failed, %d\n", error);
357 return (error);
358}
359
360/*
361 * renew/check lease state on server
362 */
363int
364nfs4_renew(struct nfsmount *nmp, int rpcflag)
365{
366 int error = 0, status, numops;
367 u_int64_t xid;
368 struct nfsm_chain nmreq, nmrep;
369 kauth_cred_t cred;
370
371 cred = IS_VALID_CRED(nmp->nm_mcred) ? nmp->nm_mcred : vfs_context_ucred(vfs_context_kernel());
372 kauth_cred_ref(cred);
373
374 nfsm_chain_null(&nmreq);
375 nfsm_chain_null(&nmrep);
376
377 // RENEW
378 numops = 1;
379 nfsm_chain_build_alloc_init(error, &nmreq, 8 * NFSX_UNSIGNED);
380 nfsm_chain_add_compound_header(error, &nmreq, "renew", nmp->nm_minor_vers, numops);
381 numops--;
382 nfsm_chain_add_32(error, &nmreq, NFS_OP_RENEW);
383 nfsm_chain_add_64(error, &nmreq, nmp->nm_clientid);
384 nfsm_chain_build_done(error, &nmreq);
385 nfsm_assert(error, (numops == 0), EPROTO);
386 nfsmout_if(error);
387 error = nfs_request2(NULL, nmp->nm_mountp, &nmreq, NFSPROC4_COMPOUND,
388 current_thread(), cred, NULL, rpcflag, &nmrep, &xid, &status);
389 nfsm_chain_skip_tag(error, &nmrep);
390 nfsm_chain_get_32(error, &nmrep, numops);
391 nfsm_chain_op_check(error, &nmrep, NFS_OP_RENEW);
392nfsmout:
393 nfsm_chain_cleanup(&nmreq);
394 nfsm_chain_cleanup(&nmrep);
395 kauth_cred_unref(&cred);
396 return (error);
397}
398
399
400/*
401 * periodic timer to renew lease state on server
402 */
403void
404nfs4_renew_timer(void *param0, __unused void *param1)
405{
406 struct nfsmount *nmp = param0;
407 u_int64_t clientid;
408 int error = 0, interval;
409
410 lck_mtx_lock(&nmp->nm_lock);
411 clientid = nmp->nm_clientid;
412 if ((nmp->nm_state & NFSSTA_RECOVER) || !(nmp->nm_sockflags & NMSOCK_READY)) {
413 lck_mtx_unlock(&nmp->nm_lock);
414 goto out;
415 }
416 lck_mtx_unlock(&nmp->nm_lock);
417
418 error = nfs4_renew(nmp, R_RECOVER);
419out:
420 if (error == ETIMEDOUT)
421 nfs_need_reconnect(nmp);
422 else if (error)
423 printf("nfs4_renew_timer: error %d\n", error);
424 lck_mtx_lock(&nmp->nm_lock);
425 if (error && (error != ETIMEDOUT) &&
426 (nmp->nm_clientid == clientid) && !(nmp->nm_state & NFSSTA_RECOVER)) {
427 printf("nfs4_renew_timer: error %d, initiating recovery\n", error);
428 nfs_need_recover(nmp, error);
429 }
430
431 interval = nmp->nm_fsattr.nfsa_lease / (error ? 4 : 2);
432 if ((interval < 1) || (nmp->nm_state & NFSSTA_RECOVER))
433 interval = 1;
434 lck_mtx_unlock(&nmp->nm_lock);
435 nfs_interval_timer_start(nmp->nm_renew_timer, interval * 1000);
436}
437
438/*
439 * get the list of supported security flavors
440 *
441 * How we get them depends on what args we are given:
442 *
443 * FH? Name? Action
444 * ----- ----- ------
445 * YES YES Use the fh and name provided
446 * YES NO 4.1-only just use the fh provided
447 * NO YES Use the node's (or root) fh and the name provided
448 * NO NO Use the node's parent and the node's name (4.1 will just use node's fh)
449 */
450int
451nfs4_secinfo_rpc(struct nfsmount *nmp, struct nfsreq_secinfo_args *siap, kauth_cred_t cred, uint32_t *sec, int *seccountp)
452{
453 int error = 0, status, nfsvers, numops, namelen, fhsize;
454 vnode_t dvp = NULLVP;
455 nfsnode_t np, dnp;
456 u_char *fhp;
457 const char *vname = NULL, *name;
458 uint64_t xid;
459 struct nfsm_chain nmreq, nmrep;
460
461 *seccountp = 0;
462 if (nfs_mount_gone(nmp))
463 return (ENXIO);
464 nfsvers = nmp->nm_vers;
465 np = siap->rsia_np;
466
467 nfsm_chain_null(&nmreq);
468 nfsm_chain_null(&nmrep);
469
470 fhp = siap->rsia_fh;
471 fhsize = fhp ? siap->rsia_fhsize : 0;
472 name = siap->rsia_name;
473 namelen = name ? siap->rsia_namelen : 0;
474 if (name && !namelen)
475 namelen = strlen(name);
476 if (!fhp && name) {
477 if (!np) /* use PUTROOTFH */
478 goto gotargs;
479 fhp = np->n_fhp;
480 fhsize = np->n_fhsize;
481 }
482 if (fhp && name)
483 goto gotargs;
484
485 if (!np)
486 return (EIO);
487 nfs_node_lock_force(np);
488 if ((vnode_vtype(NFSTOV(np)) != VDIR) && np->n_sillyrename) {
489 /*
490 * The node's been sillyrenamed, so we need to use
491 * the sillyrename directory/name to do the open.
492 */
493 struct nfs_sillyrename *nsp = np->n_sillyrename;
494 dnp = nsp->nsr_dnp;
495 dvp = NFSTOV(dnp);
496 if ((error = vnode_get(dvp))) {
497 nfs_node_unlock(np);
498 goto nfsmout;
499 }
500 fhp = dnp->n_fhp;
501 fhsize = dnp->n_fhsize;
502 name = nsp->nsr_name;
503 namelen = nsp->nsr_namlen;
504 } else {
505 /*
506 * [sigh] We can't trust VFS to get the parent right for named
507 * attribute nodes. (It likes to reparent the nodes after we've
508 * created them.) Luckily we can probably get the right parent
509 * from the n_parent we have stashed away.
510 */
511 if ((np->n_vattr.nva_flags & NFS_FFLAG_IS_ATTR) &&
512 (((dvp = np->n_parent)) && (error = vnode_get(dvp))))
513 dvp = NULL;
514 if (!dvp)
515 dvp = vnode_getparent(NFSTOV(np));
516 vname = vnode_getname(NFSTOV(np));
517 if (!dvp || !vname) {
518 if (!error)
519 error = EIO;
520 nfs_node_unlock(np);
521 goto nfsmout;
522 }
523 dnp = VTONFS(dvp);
524 fhp = dnp->n_fhp;
525 fhsize = dnp->n_fhsize;
526 name = vname;
527 namelen = strnlen(vname, MAXPATHLEN);
528 }
529 nfs_node_unlock(np);
530
531gotargs:
532 // PUT(ROOT)FH + SECINFO
533 numops = 2;
534 nfsm_chain_build_alloc_init(error, &nmreq,
535 4 * NFSX_UNSIGNED + NFSX_FH(nfsvers) + nfsm_rndup(namelen));
536 nfsm_chain_add_compound_header(error, &nmreq, "secinfo", nmp->nm_minor_vers, numops);
537 numops--;
538 if (fhp) {
539 nfsm_chain_add_32(error, &nmreq, NFS_OP_PUTFH);
540 nfsm_chain_add_fh(error, &nmreq, nfsvers, fhp, fhsize);
541 } else {
542 nfsm_chain_add_32(error, &nmreq, NFS_OP_PUTROOTFH);
543 }
544 numops--;
545 nfsm_chain_add_32(error, &nmreq, NFS_OP_SECINFO);
546 nfsm_chain_add_name(error, &nmreq, name, namelen, nmp);
547 nfsm_chain_build_done(error, &nmreq);
548 nfsm_assert(error, (numops == 0), EPROTO);
549 nfsmout_if(error);
550 error = nfs_request2(np, nmp->nm_mountp, &nmreq, NFSPROC4_COMPOUND,
551 current_thread(), cred, NULL, 0, &nmrep, &xid, &status);
552 nfsm_chain_skip_tag(error, &nmrep);
553 nfsm_chain_get_32(error, &nmrep, numops);
554 nfsm_chain_op_check(error, &nmrep, fhp ? NFS_OP_PUTFH : NFS_OP_PUTROOTFH);
555 nfsm_chain_op_check(error, &nmrep, NFS_OP_SECINFO);
556 nfsmout_if(error);
557 error = nfsm_chain_get_secinfo(&nmrep, sec, seccountp);
558nfsmout:
559 nfsm_chain_cleanup(&nmreq);
560 nfsm_chain_cleanup(&nmrep);
561 if (vname)
562 vnode_putname(vname);
563 if (dvp != NULLVP)
564 vnode_put(dvp);
565 return (error);
566}
567
568/*
569 * Parse an NFSv4 SECINFO array to an array of pseudo flavors.
570 * (Note: also works for MOUNTv3 security arrays.)
571 */
572int
573nfsm_chain_get_secinfo(struct nfsm_chain *nmc, uint32_t *sec, int *seccountp)
574{
575 int error = 0, secmax, seccount, srvcount;
576 uint32_t flavor, val;
577 u_char oid[12];
578
579 seccount = srvcount = 0;
580 secmax = *seccountp;
581 *seccountp = 0;
582
583 nfsm_chain_get_32(error, nmc, srvcount);
584 while (!error && (srvcount > 0) && (seccount < secmax)) {
585 nfsm_chain_get_32(error, nmc, flavor);
586 nfsmout_if(error);
587 switch (flavor) {
588 case RPCAUTH_NONE:
589 case RPCAUTH_SYS:
590 case RPCAUTH_KRB5:
591 case RPCAUTH_KRB5I:
592 case RPCAUTH_KRB5P:
593 sec[seccount++] = flavor;
594 break;
595 case RPCSEC_GSS:
596 /* we only recognize KRB5, KRB5I, KRB5P */
597 nfsm_chain_get_32(error, nmc, val); /* OID length */
598 nfsmout_if(error);
599 if (val != sizeof(krb5_mech_oid)) {
600 nfsm_chain_adv(error, nmc, val);
601 nfsm_chain_adv(error, nmc, 2*NFSX_UNSIGNED);
602 break;
603 }
604 nfsm_chain_get_opaque(error, nmc, val, oid); /* OID bytes */
605 nfsmout_if(error);
606 if (bcmp(oid, krb5_mech_oid, sizeof(krb5_mech_oid))) {
607 nfsm_chain_adv(error, nmc, 2*NFSX_UNSIGNED);
608 break;
609 }
610 nfsm_chain_get_32(error, nmc, val); /* QOP */
611 nfsm_chain_get_32(error, nmc, val); /* SERVICE */
612 nfsmout_if(error);
613 switch (val) {
614 case RPCSEC_GSS_SVC_NONE:
615 sec[seccount++] = RPCAUTH_KRB5;
616 break;
617 case RPCSEC_GSS_SVC_INTEGRITY:
618 sec[seccount++] = RPCAUTH_KRB5I;
619 break;
620 case RPCSEC_GSS_SVC_PRIVACY:
621 sec[seccount++] = RPCAUTH_KRB5P;
622 break;
623 }
624 break;
625 }
626 srvcount--;
627 }
628nfsmout:
629 if (!error)
630 *seccountp = seccount;
631 return (error);
632}
633
634
635/*
636 * Fetch the FS_LOCATIONS attribute for the node found at directory/name.
637 */
638int
639nfs4_get_fs_locations(
640 struct nfsmount *nmp,
641 nfsnode_t dnp,
642 u_char *fhp,
643 int fhsize,
644 const char *name,
645 vfs_context_t ctx,
646 struct nfs_fs_locations *nfslsp)
647{
648 int error = 0, numops, status;
649 uint32_t bitmap[NFS_ATTR_BITMAP_LEN];
650 struct nfsreq rq, *req = &rq;
651 struct nfsreq_secinfo_args si;
652 struct nfsm_chain nmreq, nmrep;
653 uint64_t xid;
654
655 if (!fhp && dnp) {
656 fhp = dnp->n_fhp;
657 fhsize = dnp->n_fhsize;
658 }
659 if (!fhp)
660 return (EINVAL);
661
662 nfsm_chain_null(&nmreq);
663 nfsm_chain_null(&nmrep);
664
665 NFSREQ_SECINFO_SET(&si, NULL, fhp, fhsize, name, 0);
666 numops = 3;
667 nfsm_chain_build_alloc_init(error, &nmreq, 18 * NFSX_UNSIGNED);
668 nfsm_chain_add_compound_header(error, &nmreq, "fs_locations", nmp->nm_minor_vers, numops);
669 numops--;
670 nfsm_chain_add_32(error, &nmreq, NFS_OP_PUTFH);
671 nfsm_chain_add_fh(error, &nmreq, NFS_VER4, fhp, fhsize);
672 numops--;
673 nfsm_chain_add_32(error, &nmreq, NFS_OP_LOOKUP);
674 nfsm_chain_add_name(error, &nmreq, name, strlen(name), nmp);
675 numops--;
676 nfsm_chain_add_32(error, &nmreq, NFS_OP_GETATTR);
677 NFS_CLEAR_ATTRIBUTES(bitmap);
678 NFS_BITMAP_SET(bitmap, NFS_FATTR_FS_LOCATIONS);
679 nfsm_chain_add_bitmap(error, &nmreq, bitmap, NFS_ATTR_BITMAP_LEN);
680 nfsm_chain_build_done(error, &nmreq);
681 nfsm_assert(error, (numops == 0), EPROTO);
682 nfsmout_if(error);
683 error = nfs_request_async(dnp, nmp->nm_mountp, &nmreq, NFSPROC4_COMPOUND,
684 vfs_context_thread(ctx), vfs_context_ucred(ctx), &si, 0, NULL, &req);
685 if (!error)
686 error = nfs_request_async_finish(req, &nmrep, &xid, &status);
687 nfsm_chain_skip_tag(error, &nmrep);
688 nfsm_chain_get_32(error, &nmrep, numops);
689 nfsm_chain_op_check(error, &nmrep, NFS_OP_PUTFH);
690 nfsm_chain_op_check(error, &nmrep, NFS_OP_LOOKUP);
691 nfsm_chain_op_check(error, &nmrep, NFS_OP_GETATTR);
692 nfsmout_if(error);
693 error = nfs4_parsefattr(&nmrep, NULL, NULL, NULL, NULL, nfslsp);
694nfsmout:
695 nfsm_chain_cleanup(&nmrep);
696 nfsm_chain_cleanup(&nmreq);
697 return (error);
698}
699
700/*
701 * Referral trigger nodes may not have many attributes provided by the
702 * server, so put some default values in place.
703 */
704void
705nfs4_default_attrs_for_referral_trigger(
706 nfsnode_t dnp,
707 char *name,
708 int namelen,
709 struct nfs_vattr *nvap,
710 fhandle_t *fhp)
711{
712 struct timespec now;
713 nanotime(&now);
714 int len;
715
716 nvap->nva_flags = NFS_FFLAG_TRIGGER | NFS_FFLAG_TRIGGER_REFERRAL;
717 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_TYPE)) {
718 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_TYPE);
719 nvap->nva_type = VDIR;
720 }
721 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_FSID)) {
722 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_FSID);
723 nvap->nva_fsid.major = 0;
724 nvap->nva_fsid.minor = 0;
725 }
726 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_OWNER) && dnp) {
727 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_OWNER);
728 nvap->nva_uid = dnp->n_vattr.nva_uid;
729 nvap->nva_uuuid = dnp->n_vattr.nva_uuuid;
730 }
731 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_OWNER_GROUP) && dnp) {
732 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_OWNER_GROUP);
733 nvap->nva_gid = dnp->n_vattr.nva_gid;
734 nvap->nva_guuid = dnp->n_vattr.nva_guuid;
735 }
736 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_MODE)) {
737 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_MODE);
738 nvap->nva_mode = 0777;
739 }
740 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_SIZE)) {
741 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_SIZE);
742 nvap->nva_size = 0;
743 }
744 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_SPACE_USED)) {
745 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_SPACE_USED);
746 nvap->nva_bytes = 0;
747 }
748 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_NUMLINKS)) {
749 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_NUMLINKS);
750 nvap->nva_nlink = 2;
751 }
752 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_TIME_ACCESS)) {
753 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_TIME_ACCESS);
754 nvap->nva_timesec[NFSTIME_ACCESS] = now.tv_sec;
755 nvap->nva_timensec[NFSTIME_ACCESS] = now.tv_nsec;
756 }
757 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_TIME_MODIFY)) {
758 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_TIME_MODIFY);
759 nvap->nva_timesec[NFSTIME_MODIFY] = now.tv_sec;
760 nvap->nva_timensec[NFSTIME_MODIFY] = now.tv_nsec;
761 }
762 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_TIME_METADATA)) {
763 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_TIME_METADATA);
764 nvap->nva_timesec[NFSTIME_CHANGE] = now.tv_sec;
765 nvap->nva_timensec[NFSTIME_CHANGE] = now.tv_nsec;
766 }
767 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_FILEID)) {
768 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_FILEID);
769 nvap->nva_fileid = 42;
770 }
771 if (!NFS_BITMAP_ISSET(nvap->nva_bitmap, NFS_FATTR_FILEHANDLE) && dnp && name && fhp) {
772 /* Build a fake filehandle made up of parent node pointer and name */
773 NFS_BITMAP_SET(nvap->nva_bitmap, NFS_FATTR_FILEHANDLE);
774 bcopy(&dnp, &fhp->fh_data[0], sizeof(dnp));
775 len = sizeof(fhp->fh_data) - sizeof(dnp);
776 bcopy(name, &fhp->fh_data[0] + sizeof(dnp), MIN(len, namelen));
777 fhp->fh_len = sizeof(dnp) + namelen;
778 if (fhp->fh_len > (int)sizeof(fhp->fh_data))
779 fhp->fh_len = sizeof(fhp->fh_data);
780 }
781}
782
783/*
784 * Set NFS bitmap according to what's set in vnode_attr (and supported by the server).
785 */
786void
787nfs_vattr_set_bitmap(struct nfsmount *nmp, uint32_t *bitmap, struct vnode_attr *vap)
788{
789 int i;
790
791 NFS_CLEAR_ATTRIBUTES(bitmap);
792 if (VATTR_IS_ACTIVE(vap, va_data_size))
793 NFS_BITMAP_SET(bitmap, NFS_FATTR_SIZE);
794 if (VATTR_IS_ACTIVE(vap, va_acl) && (nmp->nm_fsattr.nfsa_flags & NFS_FSFLAG_ACL))
795 NFS_BITMAP_SET(bitmap, NFS_FATTR_ACL);
796 if (VATTR_IS_ACTIVE(vap, va_flags)) {
797 NFS_BITMAP_SET(bitmap, NFS_FATTR_ARCHIVE);
798 NFS_BITMAP_SET(bitmap, NFS_FATTR_HIDDEN);
799 }
800 // NFS_BITMAP_SET(bitmap, NFS_FATTR_MIMETYPE)
801 if (VATTR_IS_ACTIVE(vap, va_mode) && !NMFLAG(nmp, ACLONLY))
802 NFS_BITMAP_SET(bitmap, NFS_FATTR_MODE);
803 if (VATTR_IS_ACTIVE(vap, va_uid) || VATTR_IS_ACTIVE(vap, va_uuuid))
804 NFS_BITMAP_SET(bitmap, NFS_FATTR_OWNER);
805 if (VATTR_IS_ACTIVE(vap, va_gid) || VATTR_IS_ACTIVE(vap, va_guuid))
806 NFS_BITMAP_SET(bitmap, NFS_FATTR_OWNER_GROUP);
807 // NFS_BITMAP_SET(bitmap, NFS_FATTR_SYSTEM)
808 if (vap->va_vaflags & VA_UTIMES_NULL) {
809 NFS_BITMAP_SET(bitmap, NFS_FATTR_TIME_ACCESS_SET);
810 NFS_BITMAP_SET(bitmap, NFS_FATTR_TIME_MODIFY_SET);
811 } else {
812 if (VATTR_IS_ACTIVE(vap, va_access_time))
813 NFS_BITMAP_SET(bitmap, NFS_FATTR_TIME_ACCESS_SET);
814 if (VATTR_IS_ACTIVE(vap, va_modify_time))
815 NFS_BITMAP_SET(bitmap, NFS_FATTR_TIME_MODIFY_SET);
816 }
817 if (VATTR_IS_ACTIVE(vap, va_backup_time))
818 NFS_BITMAP_SET(bitmap, NFS_FATTR_TIME_BACKUP);
819 if (VATTR_IS_ACTIVE(vap, va_create_time))
820 NFS_BITMAP_SET(bitmap, NFS_FATTR_TIME_CREATE);
821 /* and limit to what is supported by server */
822 for (i=0; i < NFS_ATTR_BITMAP_LEN; i++)
823 bitmap[i] &= nmp->nm_fsattr.nfsa_supp_attr[i];
824}
825
826/*
827 * Convert between NFSv4 and VFS ACE types
828 */
829uint32_t
830nfs4_ace_nfstype_to_vfstype(uint32_t nfsacetype, int *errorp)
831{
832 switch (nfsacetype) {
833 case NFS_ACE_ACCESS_ALLOWED_ACE_TYPE:
834 return KAUTH_ACE_PERMIT;
835 case NFS_ACE_ACCESS_DENIED_ACE_TYPE:
836 return KAUTH_ACE_DENY;
837 case NFS_ACE_SYSTEM_AUDIT_ACE_TYPE:
838 return KAUTH_ACE_AUDIT;
839 case NFS_ACE_SYSTEM_ALARM_ACE_TYPE:
840 return KAUTH_ACE_ALARM;
841 }
842 *errorp = EBADRPC;
843 return 0;
844}
845
846uint32_t
847nfs4_ace_vfstype_to_nfstype(uint32_t vfstype, int *errorp)
848{
849 switch (vfstype) {
850 case KAUTH_ACE_PERMIT:
851 return NFS_ACE_ACCESS_ALLOWED_ACE_TYPE;
852 case KAUTH_ACE_DENY:
853 return NFS_ACE_ACCESS_DENIED_ACE_TYPE;
854 case KAUTH_ACE_AUDIT:
855 return NFS_ACE_SYSTEM_AUDIT_ACE_TYPE;
856 case KAUTH_ACE_ALARM:
857 return NFS_ACE_SYSTEM_ALARM_ACE_TYPE;
858 }
859 *errorp = EINVAL;
860 return 0;
861}
862
863/*
864 * Convert between NFSv4 and VFS ACE flags
865 */
866uint32_t
867nfs4_ace_nfsflags_to_vfsflags(uint32_t nfsflags)
868{
869 uint32_t vfsflags = 0;
870
871 if (nfsflags & NFS_ACE_FILE_INHERIT_ACE)
872 vfsflags |= KAUTH_ACE_FILE_INHERIT;
873 if (nfsflags & NFS_ACE_DIRECTORY_INHERIT_ACE)
874 vfsflags |= KAUTH_ACE_DIRECTORY_INHERIT;
875 if (nfsflags & NFS_ACE_NO_PROPAGATE_INHERIT_ACE)
876 vfsflags |= KAUTH_ACE_LIMIT_INHERIT;
877 if (nfsflags & NFS_ACE_INHERIT_ONLY_ACE)
878 vfsflags |= KAUTH_ACE_ONLY_INHERIT;
879 if (nfsflags & NFS_ACE_SUCCESSFUL_ACCESS_ACE_FLAG)
880 vfsflags |= KAUTH_ACE_SUCCESS;
881 if (nfsflags & NFS_ACE_FAILED_ACCESS_ACE_FLAG)
882 vfsflags |= KAUTH_ACE_FAILURE;
883 if (nfsflags & NFS_ACE_INHERITED_ACE)
884 vfsflags |= KAUTH_ACE_INHERITED;
885
886 return (vfsflags);
887}
888
889uint32_t
890nfs4_ace_vfsflags_to_nfsflags(uint32_t vfsflags)
891{
892 uint32_t nfsflags = 0;
893
894 if (vfsflags & KAUTH_ACE_FILE_INHERIT)
895 nfsflags |= NFS_ACE_FILE_INHERIT_ACE;
896 if (vfsflags & KAUTH_ACE_DIRECTORY_INHERIT)
897 nfsflags |= NFS_ACE_DIRECTORY_INHERIT_ACE;
898 if (vfsflags & KAUTH_ACE_LIMIT_INHERIT)
899 nfsflags |= NFS_ACE_NO_PROPAGATE_INHERIT_ACE;
900 if (vfsflags & KAUTH_ACE_ONLY_INHERIT)
901 nfsflags |= NFS_ACE_INHERIT_ONLY_ACE;
902 if (vfsflags & KAUTH_ACE_SUCCESS)
903 nfsflags |= NFS_ACE_SUCCESSFUL_ACCESS_ACE_FLAG;
904 if (vfsflags & KAUTH_ACE_FAILURE)
905 nfsflags |= NFS_ACE_FAILED_ACCESS_ACE_FLAG;
906 if (vfsflags & KAUTH_ACE_INHERITED)
907 nfsflags |= NFS_ACE_INHERITED_ACE;
908
909 return (nfsflags);
910}
911
912/*
913 * Convert between NFSv4 ACE access masks and VFS access rights
914 */
915uint32_t
916nfs4_ace_nfsmask_to_vfsrights(uint32_t nfsmask)
917{
918 uint32_t vfsrights = 0;
919
920 if (nfsmask & NFS_ACE_READ_DATA)
921 vfsrights |= KAUTH_VNODE_READ_DATA;
922 if (nfsmask & NFS_ACE_LIST_DIRECTORY)
923 vfsrights |= KAUTH_VNODE_LIST_DIRECTORY;
924 if (nfsmask & NFS_ACE_WRITE_DATA)
925 vfsrights |= KAUTH_VNODE_WRITE_DATA;
926 if (nfsmask & NFS_ACE_ADD_FILE)
927 vfsrights |= KAUTH_VNODE_ADD_FILE;
928 if (nfsmask & NFS_ACE_APPEND_DATA)
929 vfsrights |= KAUTH_VNODE_APPEND_DATA;
930 if (nfsmask & NFS_ACE_ADD_SUBDIRECTORY)
931 vfsrights |= KAUTH_VNODE_ADD_SUBDIRECTORY;
932 if (nfsmask & NFS_ACE_READ_NAMED_ATTRS)
933 vfsrights |= KAUTH_VNODE_READ_EXTATTRIBUTES;
934 if (nfsmask & NFS_ACE_WRITE_NAMED_ATTRS)
935 vfsrights |= KAUTH_VNODE_WRITE_EXTATTRIBUTES;
936 if (nfsmask & NFS_ACE_EXECUTE)
937 vfsrights |= KAUTH_VNODE_EXECUTE;
938 if (nfsmask & NFS_ACE_DELETE_CHILD)
939 vfsrights |= KAUTH_VNODE_DELETE_CHILD;
940 if (nfsmask & NFS_ACE_READ_ATTRIBUTES)
941 vfsrights |= KAUTH_VNODE_READ_ATTRIBUTES;
942 if (nfsmask & NFS_ACE_WRITE_ATTRIBUTES)
943 vfsrights |= KAUTH_VNODE_WRITE_ATTRIBUTES;
944 if (nfsmask & NFS_ACE_DELETE)
945 vfsrights |= KAUTH_VNODE_DELETE;
946 if (nfsmask & NFS_ACE_READ_ACL)
947 vfsrights |= KAUTH_VNODE_READ_SECURITY;
948 if (nfsmask & NFS_ACE_WRITE_ACL)
949 vfsrights |= KAUTH_VNODE_WRITE_SECURITY;
950 if (nfsmask & NFS_ACE_WRITE_OWNER)
951 vfsrights |= KAUTH_VNODE_CHANGE_OWNER;
952 if (nfsmask & NFS_ACE_SYNCHRONIZE)
953 vfsrights |= KAUTH_VNODE_SYNCHRONIZE;
954 if ((nfsmask & NFS_ACE_GENERIC_READ) == NFS_ACE_GENERIC_READ)
955 vfsrights |= KAUTH_ACE_GENERIC_READ;
956 if ((nfsmask & NFS_ACE_GENERIC_WRITE) == NFS_ACE_GENERIC_WRITE)
957 vfsrights |= KAUTH_ACE_GENERIC_WRITE;
958 if ((nfsmask & NFS_ACE_GENERIC_EXECUTE) == NFS_ACE_GENERIC_EXECUTE)
959 vfsrights |= KAUTH_ACE_GENERIC_EXECUTE;
960
961 return (vfsrights);
962}
963
964uint32_t
965nfs4_ace_vfsrights_to_nfsmask(uint32_t vfsrights)
966{
967 uint32_t nfsmask = 0;
968
969 if (vfsrights & KAUTH_VNODE_READ_DATA)
970 nfsmask |= NFS_ACE_READ_DATA;
971 if (vfsrights & KAUTH_VNODE_LIST_DIRECTORY)
972 nfsmask |= NFS_ACE_LIST_DIRECTORY;
973 if (vfsrights & KAUTH_VNODE_WRITE_DATA)
974 nfsmask |= NFS_ACE_WRITE_DATA;
975 if (vfsrights & KAUTH_VNODE_ADD_FILE)
976 nfsmask |= NFS_ACE_ADD_FILE;
977 if (vfsrights & KAUTH_VNODE_APPEND_DATA)
978 nfsmask |= NFS_ACE_APPEND_DATA;
979 if (vfsrights & KAUTH_VNODE_ADD_SUBDIRECTORY)
980 nfsmask |= NFS_ACE_ADD_SUBDIRECTORY;
981 if (vfsrights & KAUTH_VNODE_READ_EXTATTRIBUTES)
982 nfsmask |= NFS_ACE_READ_NAMED_ATTRS;
983 if (vfsrights & KAUTH_VNODE_WRITE_EXTATTRIBUTES)
984 nfsmask |= NFS_ACE_WRITE_NAMED_ATTRS;
985 if (vfsrights & KAUTH_VNODE_EXECUTE)
986 nfsmask |= NFS_ACE_EXECUTE;
987 if (vfsrights & KAUTH_VNODE_DELETE_CHILD)
988 nfsmask |= NFS_ACE_DELETE_CHILD;
989 if (vfsrights & KAUTH_VNODE_READ_ATTRIBUTES)
990 nfsmask |= NFS_ACE_READ_ATTRIBUTES;
991 if (vfsrights & KAUTH_VNODE_WRITE_ATTRIBUTES)
992 nfsmask |= NFS_ACE_WRITE_ATTRIBUTES;
993 if (vfsrights & KAUTH_VNODE_DELETE)
994 nfsmask |= NFS_ACE_DELETE;
995 if (vfsrights & KAUTH_VNODE_READ_SECURITY)
996 nfsmask |= NFS_ACE_READ_ACL;
997 if (vfsrights & KAUTH_VNODE_WRITE_SECURITY)
998 nfsmask |= NFS_ACE_WRITE_ACL;
999 if (vfsrights & KAUTH_VNODE_CHANGE_OWNER)
1000 nfsmask |= NFS_ACE_WRITE_OWNER;
1001 if (vfsrights & KAUTH_VNODE_SYNCHRONIZE)
1002 nfsmask |= NFS_ACE_SYNCHRONIZE;
1003 if (vfsrights & KAUTH_ACE_GENERIC_READ)
1004 nfsmask |= NFS_ACE_GENERIC_READ;
1005 if (vfsrights & KAUTH_ACE_GENERIC_WRITE)
1006 nfsmask |= NFS_ACE_GENERIC_WRITE;
1007 if (vfsrights & KAUTH_ACE_GENERIC_EXECUTE)
1008 nfsmask |= NFS_ACE_GENERIC_EXECUTE;
1009 if (vfsrights & KAUTH_ACE_GENERIC_ALL)
1010 nfsmask |= (KAUTH_ACE_GENERIC_READ|KAUTH_ACE_GENERIC_WRITE|NFS_ACE_GENERIC_EXECUTE);
1011
1012 return (nfsmask);
1013}
1014
1015/*
1016 * nfs4_wkid2sidd::
1017 * mapid a wellknown identity to guid.
1018 * Return 0 on success ENOENT if id does not map and EINVAL if the id is not a well known name.
1019 */
1020static int
1021nfs4_wkid2sid(const char *id, ntsid_t *sp)
1022{
1023 size_t len = strnlen(id, MAXIDNAMELEN);
1024
1025 if (len == MAXIDNAMELEN || id[len-1] != '@')
1026 return (EINVAL);
1027
1028 bzero(sp, sizeof(ntsid_t));
1029 sp->sid_kind = 1;
1030 sp->sid_authcount = 1;
1031 if (!strcmp(id, "OWNER@")) {
1032 // S-1-3-0
1033 sp->sid_authority[5] = 3;
1034 sp->sid_authorities[0] = 0;
1035 } else if (!strcmp(id, "GROUP@")) {
1036 // S-1-3-1
1037 sp->sid_authority[5] = 3;
1038 sp->sid_authorities[0] = 1;
1039 } else if (!strcmp(id, "EVERYONE@")) {
1040 // S-1-1-0
1041 sp->sid_authority[5] = 1;
1042 sp->sid_authorities[0] = 0;
1043 } else if (!strcmp(id, "INTERACTIVE@")) {
1044 // S-1-5-4
1045 sp->sid_authority[5] = 5;
1046 sp->sid_authorities[0] = 4;
1047 } else if (!strcmp(id, "NETWORK@")) {
1048 // S-1-5-2
1049 sp->sid_authority[5] = 5;
1050 sp->sid_authorities[0] = 2;
1051 } else if (!strcmp(id, "DIALUP@")) {
1052 // S-1-5-1
1053 sp->sid_authority[5] = 5;
1054 sp->sid_authorities[0] = 1;
1055 } else if (!strcmp(id, "BATCH@")) {
1056 // S-1-5-3
1057 sp->sid_authority[5] = 5;
1058 sp->sid_authorities[0] = 3;
1059 } else if (!strcmp(id, "ANONYMOUS@")) {
1060 // S-1-5-7
1061 sp->sid_authority[5] = 5;
1062 sp->sid_authorities[0] = 7;
1063 } else if (!strcmp(id, "AUTHENTICATED@")) {
1064 // S-1-5-11
1065 sp->sid_authority[5] = 5;
1066 sp->sid_authorities[0] = 11;
1067 } else if (!strcmp(id, "SERVICE@")) {
1068 // S-1-5-6
1069 sp->sid_authority[5] = 5;
1070 sp->sid_authorities[0] = 6;
1071 } else {
1072 // S-1-0-0 "NOBODY"
1073 sp->sid_authority[5] = 0;
1074 sp->sid_authorities[0] = 0;
1075 }
1076 return (0);
1077}
1078
1079static int
1080nfs4_fallback_name(const char *id, int have_at)
1081{
1082 if (have_at) {
1083 /* must be user@domain */
1084 /* try to identify some well-known IDs */
1085 if (!strncmp(id, "root@", 5))
1086 return (0);
1087 else if (!strncmp(id, "wheel@", 6))
1088 return (0);
1089 else if (!strncmp(id, "nobody@", 7))
1090 return (-2);
1091 else if (!strncmp(id, "nfsnobody@", 10))
1092 return (-2);
1093 }
1094 return (-2);
1095}
1096
1097static void
1098nfs4_mapid_log(int error, const char *idstr, int isgroup, guid_t *gp)
1099{
1100 if (error && (nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_FAILED_MAPPINGS))
1101 printf("nfs4_id2guid: idmap failed for %s %s error %d\n", idstr, isgroup ? "G" : " ", error);
1102 if (!error && (nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_SUCCESSFUL_MAPPINGS))
1103 printf("nfs4_id2guid: idmap for %s %s got guid "
1104 "%02x%02x%02x%02x_%02x%02x%02x%02x_%02x%02x%02x%02x_%02x%02x%02x%02x\n",
1105 idstr, isgroup ? "G" : " ",
1106 gp->g_guid[0], gp->g_guid[1], gp->g_guid[2], gp->g_guid[3],
1107 gp->g_guid[4], gp->g_guid[5], gp->g_guid[6], gp->g_guid[7],
1108 gp->g_guid[8], gp->g_guid[9], gp->g_guid[10], gp->g_guid[11],
1109 gp->g_guid[12], gp->g_guid[13], gp->g_guid[14], gp->g_guid[15]);
1110}
1111
1112static char *
1113nfs4_map_domain(char *id, char **atp)
1114{
1115 char *at = *atp;
1116 char *dsnode, *otw_nfs4domain;
1117 char *new_id = NULL;
1118 size_t otw_domain_len;
1119 size_t otw_id_2_at_len;
1120 int error;
1121
1122 if (at == NULL)
1123 at = strchr(id, '@');
1124 if (at == NULL || *at != '@')
1125 return (NULL);
1126
1127 otw_nfs4domain = at + 1;
1128 otw_domain_len = strnlen(otw_nfs4domain, MAXPATHLEN);
1129 otw_id_2_at_len = at - id + 1;
1130
1131 MALLOC_ZONE(dsnode, char*, MAXPATHLEN, M_NAMEI, M_WAITOK);
1132 /* first try to map nfs4 domain to dsnode for scoped lookups */
1133 error = kauth_cred_nfs4domain2dsnode(otw_nfs4domain, dsnode);
1134 if (!error) {
1135 /* Success! Make new id be id@dsnode */
1136 size_t dsnode_len = strnlen(dsnode, MAXPATHLEN);
1137 size_t new_id_len = otw_id_2_at_len + dsnode_len + 1;
1138 char tmp;
1139
1140 MALLOC(new_id, char*, new_id_len, M_TEMP, M_WAITOK);
1141 tmp = *otw_nfs4domain;
1142 *otw_nfs4domain = '\0'; /* Chop of the old domain */
1143 strlcpy(new_id, id, MAXPATHLEN);
1144 *otw_nfs4domain = tmp; /* Be nice and preserve callers original id */
1145 strlcat(new_id, dsnode, MAXPATHLEN);
1146 at = strchr(new_id, '@');
1147 } else {
1148 /* Bummer:-( See if default nfs4 set for unscoped lookup */
1149 size_t default_domain_len = strnlen(nfs4_default_domain, MAXPATHLEN);
1150
1151 if ((otw_domain_len == default_domain_len) &&
1152 (strncmp(otw_nfs4domain, nfs4_default_domain, otw_domain_len) == 0)) {
1153 /* Woohoo! We have matching domains, do unscoped lookups */
1154 *at = '\0';
1155 }
1156 }
1157 FREE_ZONE(dsnode, MAXPATHLEN, M_NAMEI);
1158
1159 if (nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_SUCCESSFUL_MAPPINGS) {
1160 printf("nfs4_id2guid: after domain mapping id is %s\n", id);
1161 }
1162
1163 *atp = at;
1164 return (new_id);
1165}
1166
1167/*
1168 * Map an NFSv4 ID string to a VFS guid.
1169 *
1170 * Try to use the ID mapping service... but we may fallback to trying to do it ourselves.
1171 */
1172int
1173nfs4_id2guid(/*const*/ char *id, guid_t *guidp, int isgroup)
1174{
1175 int error = 0;
1176 ntsid_t sid;
1177 long num;
1178 char *p, *at, *new_id = NULL;
1179
1180 *guidp = kauth_null_guid;
1181
1182 /*
1183 * First check if it is just a simple numeric ID string or a special "XXX@" name.
1184 * If it's a number, there's no need trying to ask the IDMAP service to map it.
1185 * If it's a special "XXX@" name, we want to make sure to treat it as a group.
1186 */
1187 num = 1;
1188 at = NULL;
1189 p = id;
1190 while (*p) {
1191 if ((*p < '0') || (*p > '9'))
1192 num = 0;
1193 if (*p == '@')
1194 at = p;
1195 p++;
1196 }
1197
1198 if (num) {
1199 /* must be numeric ID (or empty) */
1200 num = *id ? strtol(id, NULL, 10) : -2;
1201 if (isgroup)
1202 error = kauth_cred_gid2guid((gid_t)num, guidp);
1203 else
1204 error = kauth_cred_uid2guid((uid_t)num, guidp);
1205 nfs4_mapid_log(error, id, isgroup, guidp);
1206 return (error);
1207 }
1208
1209 /* See if this is a well known NFSv4 name */
1210 error = nfs4_wkid2sid(id, &sid);
1211 if (!error) {
1212 error = kauth_cred_ntsid2guid(&sid, guidp);
1213 nfs4_mapid_log(error, id, 1, guidp);
1214 return (error);
1215 }
1216
1217 /* Handle nfs4 domain first */
1218 if (at && at[1]) {
1219 new_id = nfs4_map_domain(id, &at);
1220 if (new_id)
1221 id = new_id;
1222 }
1223
1224 /* Now try to do actual id mapping */
1225 if (nfs_idmap_ctrl & NFS_IDMAP_CTRL_USE_IDMAP_SERVICE) {
1226 /*
1227 * Ask the ID mapping service to map the ID string to a GUID.
1228 *
1229 * [sigh] this isn't a "pwnam/grnam" it's an NFS ID string!
1230 */
1231 if (isgroup)
1232 error = kauth_cred_grnam2guid(id, guidp);
1233 else
1234 error = kauth_cred_pwnam2guid(id, guidp);
1235 nfs4_mapid_log(error, id, isgroup, guidp);
1236 } else {
1237 error = ENOTSUP;
1238 }
1239
1240 if (error) {
1241 /*
1242 * fallback path... see if we can come up with an answer ourselves.
1243 */
1244 num = nfs4_fallback_name(id, at != NULL);
1245 if (isgroup)
1246 error = kauth_cred_gid2guid((gid_t)num, guidp);
1247 else
1248 error = kauth_cred_uid2guid((uid_t)num, guidp);
1249 nfs4_mapid_log(error, id, isgroup, guidp);
1250 }
1251
1252
1253 /* restore @ symbol in case we clobered for unscoped lookup */
1254 if (at && *at == '\0')
1255 *at = '@';
1256
1257 /* free mapped domain id string */
1258 if (new_id)
1259 FREE(new_id, M_TEMP);
1260
1261 return (error);
1262}
1263
1264/*
1265 * nfs4_sid2wkid:
1266 * mapid a wellknown identity to guid.
1267 * returns well known name for the sid or NULL if sid does not map.
1268 */
1269#define MAXWELLKNOWNID 18
1270
1271static const char*
1272nfs4_sid2wkid(ntsid_t *sp)
1273{
1274 if ((sp->sid_kind == 1) && (sp->sid_authcount == 1)) {
1275 /* check if it's one of our well-known ACE WHO names */
1276 if (sp->sid_authority[5] == 0) {
1277 if (sp->sid_authorities[0] == 0) // S-1-0-0
1278 return ("nobody@localdomain");
1279 } else if (sp->sid_authority[5] == 1) {
1280 if (sp->sid_authorities[0] == 0) // S-1-1-0
1281 return ("EVERYONE@");
1282 } else if (sp->sid_authority[5] == 3) {
1283 if (sp->sid_authorities[0] == 0) // S-1-3-0
1284 return ("OWNER@");
1285 else if (sp->sid_authorities[0] == 1) // S-1-3-1
1286 return ("GROUP@");
1287 } else if (sp->sid_authority[5] == 5) {
1288 if (sp->sid_authorities[0] == 1) // S-1-5-1
1289 return ("DIALUP@");
1290 else if (sp->sid_authorities[0] == 2) // S-1-5-2
1291 return ("NETWORK@");
1292 else if (sp->sid_authorities[0] == 3) // S-1-5-3
1293 return ("BATCH@");
1294 else if (sp->sid_authorities[0] == 4) // S-1-5-4
1295 return ("INTERACTIVE@");
1296 else if (sp->sid_authorities[0] == 6) // S-1-5-6
1297 return ("SERVICE@");
1298 else if (sp->sid_authorities[0] == 7) // S-1-5-7
1299 return ("ANONYMOUS@");
1300 else if (sp->sid_authorities[0] == 11) // S-1-5-11
1301 return ("AUTHENTICATED@");
1302 }
1303 }
1304 return (NULL);
1305}
1306
1307static void
1308nfs4_mapguid_log(int error, const char *where, guid_t *gp, int isgroup, const char *idstr)
1309{
1310 if (error && (nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_FAILED_MAPPINGS))
1311 printf("nfs4_guid2id: %s idmap failed for "
1312 "%02x%02x%02x%02x_%02x%02x%02x%02x_%02x%02x%02x%02x_%02x%02x%02x%02x %s "
1313 "error %d\n", where,
1314 gp->g_guid[0], gp->g_guid[1], gp->g_guid[2], gp->g_guid[3],
1315 gp->g_guid[4], gp->g_guid[5], gp->g_guid[6], gp->g_guid[7],
1316 gp->g_guid[8], gp->g_guid[9], gp->g_guid[10], gp->g_guid[11],
1317 gp->g_guid[12], gp->g_guid[13], gp->g_guid[14], gp->g_guid[15],
1318 isgroup ? "G" : " ", error);
1319 if (!error && (nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_SUCCESSFUL_MAPPINGS))
1320 printf("nfs4_guid2id: %s idmap for "
1321 "%02x%02x%02x%02x_%02x%02x%02x%02x_%02x%02x%02x%02x_%02x%02x%02x%02x %s "
1322 "got ID %s\n", where,
1323 gp->g_guid[0], gp->g_guid[1], gp->g_guid[2], gp->g_guid[3],
1324 gp->g_guid[4], gp->g_guid[5], gp->g_guid[6], gp->g_guid[7],
1325 gp->g_guid[8], gp->g_guid[9], gp->g_guid[10], gp->g_guid[11],
1326 gp->g_guid[12], gp->g_guid[13], gp->g_guid[14], gp->g_guid[15],
1327 isgroup ? "G" : " ", idstr);
1328}
1329
1330static int
1331nfs4_addv4domain(char *id, size_t *idlen)
1332{
1333 char *at = NULL, *cp;
1334 int have_domain;
1335 int error = 0;
1336 size_t idsize;
1337
1338
1339 if (id == NULL || *id == '\0')
1340 return (EINVAL);
1341
1342 for (cp = id; *cp != '\0'; cp++) {
1343 if (*cp == '@') {
1344 at = cp;
1345 break;
1346 }
1347 }
1348
1349 have_domain = (at && at[1] != '\0');
1350
1351 if (have_domain) {
1352 char *dsnode = at + 1;
1353 char *nfs4domain;
1354 size_t domain_len;
1355 char *mapped_domain;
1356
1357 MALLOC_ZONE(nfs4domain, char*, MAXPATHLEN, M_NAMEI, M_WAITOK);
1358 error = kauth_cred_dsnode2nfs4domain(dsnode, nfs4domain);
1359 if (!error) {
1360 domain_len = strnlen(nfs4domain, MAXPATHLEN);
1361 mapped_domain = nfs4domain;
1362 } else {
1363 error = 0;
1364 domain_len = strnlen(nfs4_default_domain, MAXPATHLEN);
1365 mapped_domain = nfs4_default_domain;
1366 }
1367 if (domain_len) {
1368 /* chop off id after the '@' */
1369 at[1] = '\0';
1370 /* Add our mapped_domain */
1371 idsize = strlcat(id, mapped_domain, *idlen);
1372 if (*idlen > idsize)
1373 *idlen = idsize;
1374 else
1375 error = ENOSPC;
1376 }
1377 FREE_ZONE(nfs4domain, MAXPATHLEN, M_NAMEI);
1378 } else if (at == NULL) {
1379 /*
1380 * If we didn't find an 'at' then cp points to the end of id passed in.
1381 * and if we have a nfs4_default_domain set. Try to append the
1382 * default domain if we have root or set ENOSPC.
1383 */
1384 size_t default_domain_len = strnlen(nfs4_default_domain, MAXPATHLEN);
1385
1386 if (default_domain_len) {
1387 strlcat(id, "@", *idlen);
1388 idsize = strlcat(id, nfs4_default_domain, *idlen);
1389 if (*idlen > idsize)
1390 *idlen = idsize;
1391 else
1392 error = ENOSPC;
1393 } else {
1394 ; /* Unscoped name otw */
1395 }
1396 }
1397
1398 if (!error && nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_SUCCESSFUL_MAPPINGS)
1399 printf("nfs4_guid2id: id after nfs4 domain map: %s[%zd].\n", id, *idlen);
1400
1401 return (error);
1402}
1403
1404static char *
1405nfs4_fallback_id(int numid, int isgrp, char *buf, size_t size)
1406{
1407 const char *idp = NULL;
1408
1409 if (!(nfs_idmap_ctrl & NFS_IDMAP_CTRL_FALLBACK_NO_COMMON_IDS)) {
1410 /* map well known uid's to strings */
1411 if (numid == 0)
1412 idp = isgrp ? "wheel" : "root";
1413 else if (numid == -2)
1414 idp = "nobody";
1415 }
1416 if (!idp) {
1417 /* or just use a decimal number string. */
1418 snprintf(buf, size-1, "%d", numid);
1419 buf[size-1] = '\0';
1420 } else {
1421 size_t idplen = strlcpy(buf, idp, size);
1422 if (idplen >= size)
1423 return (NULL);
1424 }
1425
1426 return (buf);
1427}
1428
1429/*
1430 * Map a VFS guid to an NFSv4 ID string.
1431 *
1432 * Try to use the ID mapping service... but we may fallback to trying to do it ourselves.
1433 */
1434int
1435nfs4_guid2id(guid_t *guidp, char *id, size_t *idlen, int isgroup)
1436{
1437 int error = 0;
1438 size_t id1len, len;
1439 char *id1buf, *id1;
1440 char numbuf[32];
1441 ntsid_t sid;
1442
1443 id1buf = id1 = NULL;
1444 id1len = 0;
1445
1446 /*
1447 * See if our guid maps to a well known NFSv4 name
1448 */
1449 error = kauth_cred_guid2ntsid(guidp, &sid);
1450 if (!error) {
1451 const char *wkid = nfs4_sid2wkid(&sid);
1452 if (wkid) {
1453 len = strnlen(wkid, MAXWELLKNOWNID);
1454 strlcpy(id, wkid, *idlen);
1455 error = (len < *idlen) ? 0 : ENOSPC;
1456 *idlen = len;
1457 nfs4_mapguid_log(error, "kauth_cred_guid2ntsid", guidp, 1, id);
1458 return (error);
1459 }
1460 } else {
1461 nfs4_mapguid_log(error, "kauth_cred_guid2ntsid", guidp, isgroup, NULL);
1462 }
1463
1464 if (nfs_idmap_ctrl & NFS_IDMAP_CTRL_USE_IDMAP_SERVICE) {
1465 /*
1466 * Ask the ID mapping service to map the GUID to an ID string.
1467 *
1468 * [sigh] this isn't a "pwnam" it's an NFS id string!
1469 */
1470
1471 /*
1472 * Stupid kauth_cred_guid2pwnam() function requires that the buffer
1473 * be at least MAXPATHLEN bytes long even though most if not all ID
1474 * strings will be much much shorter than that.
1475 */
1476
1477 if (*idlen < MAXPATHLEN) {
1478 MALLOC_ZONE(id1buf, char*, MAXPATHLEN, M_NAMEI, M_WAITOK);
1479 id1 = id1buf;
1480 id1len = MAXPATHLEN;
1481 } else {
1482 id1 = id;
1483 id1len = *idlen;
1484 }
1485
1486 if (isgroup)
1487 error = kauth_cred_guid2grnam(guidp, id1);
1488 else
1489 error = kauth_cred_guid2pwnam(guidp, id1);
1490 if (error)
1491 nfs4_mapguid_log(error, "kauth_cred2[pw|gr]nam", guidp, isgroup, id1);
1492 } else {
1493 error = ENOTSUP;
1494 }
1495
1496 if (error) {
1497 /*
1498 * fallback path... see if we can come up with an answer ourselves.
1499 */
1500 uid_t uid;
1501
1502 /* OK, let's just try mapping it to a UID/GID */
1503 if (isgroup)
1504 error = kauth_cred_guid2gid(guidp, (gid_t*)&uid);
1505 else
1506 error = kauth_cred_guid2uid(guidp, &uid);
1507 if (!error) {
1508 char *fbidp = nfs4_fallback_id(uid, isgroup, numbuf, sizeof(numbuf));
1509 if (fbidp == NULL)
1510 error = ENOSPC;
1511 else
1512 id1 = fbidp;
1513 }
1514 } else {
1515 error = nfs4_addv4domain(id1, &id1len);
1516 }
1517
1518 if (!error) {
1519
1520 if (id1 != id) {
1521 /* copy idmap result to output buffer */
1522 len = strlcpy(id, id1, *idlen);
1523 if (len >= *idlen)
1524 error = ENOSPC;
1525 else
1526 *idlen = len;
1527 }
1528 }
1529 nfs4_mapguid_log(error, "End of routine", guidp, isgroup, id1);
1530
1531 if (id1buf)
1532 FREE_ZONE(id1buf, MAXPATHLEN, M_NAMEI);
1533
1534 return (error);
1535}
1536
1537/*
1538 * Set a vnode attr's supported bits according to the given bitmap
1539 */
1540void
1541nfs_vattr_set_supported(uint32_t *bitmap, struct vnode_attr *vap)
1542{
1543 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TYPE))
1544 VATTR_SET_SUPPORTED(vap, va_type);
1545 // if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_CHANGE))
1546 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SIZE))
1547 VATTR_SET_SUPPORTED(vap, va_data_size);
1548 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FSID))
1549 VATTR_SET_SUPPORTED(vap, va_fsid);
1550 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_ACL))
1551 VATTR_SET_SUPPORTED(vap, va_acl);
1552 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_ARCHIVE))
1553 VATTR_SET_SUPPORTED(vap, va_flags);
1554 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FILEID))
1555 VATTR_SET_SUPPORTED(vap, va_fileid);
1556 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_HIDDEN))
1557 VATTR_SET_SUPPORTED(vap, va_flags);
1558 // if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MIMETYPE))
1559 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MODE))
1560 VATTR_SET_SUPPORTED(vap, va_mode);
1561 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_NUMLINKS))
1562 VATTR_SET_SUPPORTED(vap, va_nlink);
1563 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_OWNER)) {
1564 VATTR_SET_SUPPORTED(vap, va_uid);
1565 VATTR_SET_SUPPORTED(vap, va_uuuid);
1566 }
1567 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_OWNER_GROUP)) {
1568 VATTR_SET_SUPPORTED(vap, va_gid);
1569 VATTR_SET_SUPPORTED(vap, va_guuid);
1570 }
1571 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_RAWDEV))
1572 VATTR_SET_SUPPORTED(vap, va_rdev);
1573 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SPACE_USED))
1574 VATTR_SET_SUPPORTED(vap, va_total_alloc);
1575 // if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SYSTEM))
1576 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_ACCESS))
1577 VATTR_SET_SUPPORTED(vap, va_access_time);
1578 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_BACKUP))
1579 VATTR_SET_SUPPORTED(vap, va_backup_time);
1580 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_CREATE))
1581 VATTR_SET_SUPPORTED(vap, va_create_time);
1582 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_METADATA))
1583 VATTR_SET_SUPPORTED(vap, va_change_time);
1584 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_MODIFY))
1585 VATTR_SET_SUPPORTED(vap, va_modify_time);
1586}
1587
1588/*
1589 * Parse the attributes that are in the mbuf list and store them in
1590 * the given structures.
1591 */
1592int
1593nfs4_parsefattr(
1594 struct nfsm_chain *nmc,
1595 struct nfs_fsattr *nfsap,
1596 struct nfs_vattr *nvap,
1597 fhandle_t *fhp,
1598 struct dqblk *dqbp,
1599 struct nfs_fs_locations *nfslsp)
1600{
1601 int error = 0, error2, rderror = 0, attrbytes;
1602 uint32_t val, val2, val3, i;
1603 uint32_t bitmap[NFS_ATTR_BITMAP_LEN], len;
1604 size_t slen;
1605 char sbuf[64], *s;
1606 struct nfs_fsattr nfsa_dummy;
1607 struct nfs_vattr nva_dummy;
1608 struct dqblk dqb_dummy;
1609 kauth_acl_t acl = NULL;
1610 uint32_t ace_type, ace_flags, ace_mask;
1611 struct nfs_fs_locations nfsls_dummy;
1612 struct sockaddr_storage ss;
1613
1614 /* if not interested in some values... throw 'em into a local dummy variable */
1615 if (!nfsap)
1616 nfsap = &nfsa_dummy;
1617 if (!nvap)
1618 nvap = &nva_dummy;
1619 if (!dqbp)
1620 dqbp = &dqb_dummy;
1621 if (!nfslsp)
1622 nfslsp = &nfsls_dummy;
1623 bzero(nfslsp, sizeof(*nfslsp));
1624
1625 attrbytes = val = val2 = val3 = 0;
1626 s = sbuf;
1627 slen = sizeof(sbuf);
1628 NVATTR_INIT(nvap);
1629
1630 len = NFS_ATTR_BITMAP_LEN;
1631 nfsm_chain_get_bitmap(error, nmc, bitmap, len);
1632 /* add bits to object/fs attr bitmaps */
1633 for (i=0; i < NFS_ATTR_BITMAP_LEN; i++) {
1634 nvap->nva_bitmap[i] |= bitmap[i] & nfs_object_attr_bitmap[i];
1635 nfsap->nfsa_bitmap[i] |= bitmap[i] & nfs_fs_attr_bitmap[i];
1636 }
1637
1638 nfsm_chain_get_32(error, nmc, attrbytes);
1639 nfsmout_if(error);
1640
1641 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SUPPORTED_ATTRS)) {
1642 len = NFS_ATTR_BITMAP_LEN;
1643 nfsm_chain_get_bitmap(error, nmc, nfsap->nfsa_supp_attr, len);
1644 attrbytes -= (len + 1) * NFSX_UNSIGNED;
1645 }
1646 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TYPE)) {
1647 nfsm_chain_get_32(error, nmc, val);
1648 nvap->nva_type = nfstov_type(val, NFS_VER4);
1649 if ((val == NFATTRDIR) || (val == NFNAMEDATTR))
1650 nvap->nva_flags |= NFS_FFLAG_IS_ATTR;
1651 else
1652 nvap->nva_flags &= ~NFS_FFLAG_IS_ATTR;
1653 attrbytes -= NFSX_UNSIGNED;
1654 }
1655 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FH_EXPIRE_TYPE)) {
1656 nfsm_chain_get_32(error, nmc, val);
1657 nfsmout_if(error);
1658 nfsap->nfsa_flags &= ~NFS_FSFLAG_FHTYPE_MASK;
1659 nfsap->nfsa_flags |= val << NFS_FSFLAG_FHTYPE_SHIFT;
1660 if (val & ~0xff)
1661 printf("nfs: warning unknown fh type: 0x%x\n", val);
1662 attrbytes -= NFSX_UNSIGNED;
1663 }
1664 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_CHANGE)) {
1665 nfsm_chain_get_64(error, nmc, nvap->nva_change);
1666 attrbytes -= 2 * NFSX_UNSIGNED;
1667 }
1668 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SIZE)) {
1669 nfsm_chain_get_64(error, nmc, nvap->nva_size);
1670 attrbytes -= 2 * NFSX_UNSIGNED;
1671 }
1672 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_LINK_SUPPORT)) {
1673 nfsm_chain_get_32(error, nmc, val);
1674 if (val)
1675 nfsap->nfsa_flags |= NFS_FSFLAG_LINK;
1676 else
1677 nfsap->nfsa_flags &= ~NFS_FSFLAG_LINK;
1678 attrbytes -= NFSX_UNSIGNED;
1679 }
1680 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SYMLINK_SUPPORT)) {
1681 nfsm_chain_get_32(error, nmc, val);
1682 if (val)
1683 nfsap->nfsa_flags |= NFS_FSFLAG_SYMLINK;
1684 else
1685 nfsap->nfsa_flags &= ~NFS_FSFLAG_SYMLINK;
1686 attrbytes -= NFSX_UNSIGNED;
1687 }
1688 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_NAMED_ATTR)) {
1689 nfsm_chain_get_32(error, nmc, val);
1690 if (val)
1691 nvap->nva_flags |= NFS_FFLAG_HAS_NAMED_ATTRS;
1692 else
1693 nvap->nva_flags &= ~NFS_FFLAG_HAS_NAMED_ATTRS;
1694 attrbytes -= NFSX_UNSIGNED;
1695 }
1696 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FSID)) {
1697 nfsm_chain_get_64(error, nmc, nvap->nva_fsid.major);
1698 nfsm_chain_get_64(error, nmc, nvap->nva_fsid.minor);
1699 attrbytes -= 4 * NFSX_UNSIGNED;
1700 }
1701 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_UNIQUE_HANDLES)) {
1702 nfsm_chain_get_32(error, nmc, val);
1703 if (val)
1704 nfsap->nfsa_flags |= NFS_FSFLAG_UNIQUE_FH;
1705 else
1706 nfsap->nfsa_flags &= ~NFS_FSFLAG_UNIQUE_FH;
1707 attrbytes -= NFSX_UNSIGNED;
1708 }
1709 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_LEASE_TIME)) {
1710 nfsm_chain_get_32(error, nmc, nfsap->nfsa_lease);
1711 attrbytes -= NFSX_UNSIGNED;
1712 }
1713 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_RDATTR_ERROR)) {
1714 nfsm_chain_get_32(error, nmc, rderror);
1715 attrbytes -= NFSX_UNSIGNED;
1716 if (!rderror) { /* no error */
1717 NFS_BITMAP_CLR(bitmap, NFS_FATTR_RDATTR_ERROR);
1718 NFS_BITMAP_CLR(nvap->nva_bitmap, NFS_FATTR_RDATTR_ERROR);
1719 }
1720 }
1721 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_ACL)) {
1722 error2 = 0;
1723 ace_type = ace_flags = ace_mask = 0;
1724 nfsm_chain_get_32(error, nmc, val); /* ACE count */
1725 if (!error && (val > KAUTH_ACL_MAX_ENTRIES))
1726 error = EOVERFLOW;
1727 if (!error && !((acl = kauth_acl_alloc(val))))
1728 error = ENOMEM;
1729 if (!error && acl) {
1730 acl->acl_entrycount = val;
1731 acl->acl_flags = 0;
1732 }
1733 attrbytes -= NFSX_UNSIGNED;
1734 nfsm_assert(error, (attrbytes >= 0), EBADRPC);
1735 for (i=0; !error && (i < val); i++) {
1736 nfsm_chain_get_32(error, nmc, ace_type);
1737 nfsm_chain_get_32(error, nmc, ace_flags);
1738 nfsm_chain_get_32(error, nmc, ace_mask);
1739 nfsm_chain_get_32(error, nmc, len);
1740 if (!error && len >= NFS_MAX_WHO)
1741 error = EBADRPC;
1742 acl->acl_ace[i].ace_flags = nfs4_ace_nfstype_to_vfstype(ace_type, &error);
1743 acl->acl_ace[i].ace_flags |= nfs4_ace_nfsflags_to_vfsflags(ace_flags);
1744 acl->acl_ace[i].ace_rights = nfs4_ace_nfsmask_to_vfsrights(ace_mask);
1745 if (!error && !error2 && (len >= slen)) {
1746 if (s != sbuf) {
1747 FREE(s, M_TEMP);
1748 s = sbuf;
1749 slen = sizeof(sbuf);
1750 }
1751 /* Let's add a bit more if we can to the allocation as to try and avoid future allocations */
1752 MALLOC(s, char*, (len + 16 < NFS_MAX_WHO) ? len+16 : NFS_MAX_WHO, M_TEMP, M_WAITOK);
1753 if (s)
1754 slen = (len + 16 < NFS_MAX_WHO) ? len+16 : NFS_MAX_WHO;
1755 else
1756 error = ENOMEM;
1757 }
1758 if (error2)
1759 nfsm_chain_adv(error, nmc, nfsm_rndup(len));
1760 else
1761 nfsm_chain_get_opaque(error, nmc, len, s);
1762 if (!error && !error2) {
1763 s[len] = '\0';
1764 error2 = nfs4_id2guid(s, &acl->acl_ace[i].ace_applicable,
1765 (ace_flags & NFS_ACE_IDENTIFIER_GROUP));
1766 if (error2 && (nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_FAILED_MAPPINGS))
1767 printf("nfs4_parsefattr: ACE WHO %s is no one, no guid?, error %d\n", s, error2);
1768 }
1769 attrbytes -= 4*NFSX_UNSIGNED + nfsm_rndup(len);
1770 nfsm_assert(error, (attrbytes >= 0), EBADRPC);
1771 }
1772 nfsmout_if(error);
1773 if ((nvap != &nva_dummy) && !error2) {
1774 nvap->nva_acl = acl;
1775 acl = NULL;
1776 }
1777 }
1778 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_ACLSUPPORT)) {
1779 /*
1780 * Support ACLs if: the server supports DENY/ALLOC ACEs and
1781 * (just to be safe) FATTR_ACL is in the supported list too.
1782 */
1783 nfsm_chain_get_32(error, nmc, val);
1784 if ((val & (NFS_ACL_SUPPORT_ALLOW_ACL|NFS_ACL_SUPPORT_DENY_ACL)) &&
1785 NFS_BITMAP_ISSET(nfsap->nfsa_supp_attr, NFS_FATTR_ACL)) {
1786 nfsap->nfsa_flags |= NFS_FSFLAG_ACL;
1787 } else {
1788 nfsap->nfsa_flags &= ~NFS_FSFLAG_ACL;
1789 }
1790 attrbytes -= NFSX_UNSIGNED;
1791 }
1792 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_ARCHIVE)) { /* SF_ARCHIVED */
1793 nfsm_chain_get_32(error, nmc, val);
1794 if (val)
1795 nvap->nva_flags |= NFS_FFLAG_ARCHIVED;
1796 else
1797 nvap->nva_flags &= ~NFS_FFLAG_ARCHIVED;
1798 attrbytes -= NFSX_UNSIGNED;
1799 }
1800 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_CANSETTIME)) {
1801 nfsm_chain_get_32(error, nmc, val);
1802 if (val)
1803 nfsap->nfsa_flags |= NFS_FSFLAG_SET_TIME;
1804 else
1805 nfsap->nfsa_flags &= ~NFS_FSFLAG_SET_TIME;
1806 attrbytes -= NFSX_UNSIGNED;
1807 }
1808 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_CASE_INSENSITIVE)) {
1809 nfsm_chain_get_32(error, nmc, val);
1810 if (val)
1811 nfsap->nfsa_flags |= NFS_FSFLAG_CASE_INSENSITIVE;
1812 else
1813 nfsap->nfsa_flags &= ~NFS_FSFLAG_CASE_INSENSITIVE;
1814 attrbytes -= NFSX_UNSIGNED;
1815 }
1816 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_CASE_PRESERVING)) {
1817 nfsm_chain_get_32(error, nmc, val);
1818 if (val)
1819 nfsap->nfsa_flags |= NFS_FSFLAG_CASE_PRESERVING;
1820 else
1821 nfsap->nfsa_flags &= ~NFS_FSFLAG_CASE_PRESERVING;
1822 attrbytes -= NFSX_UNSIGNED;
1823 }
1824 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_CHOWN_RESTRICTED)) {
1825 nfsm_chain_get_32(error, nmc, val);
1826 if (val)
1827 nfsap->nfsa_flags |= NFS_FSFLAG_CHOWN_RESTRICTED;
1828 else
1829 nfsap->nfsa_flags &= ~NFS_FSFLAG_CHOWN_RESTRICTED;
1830 attrbytes -= NFSX_UNSIGNED;
1831 }
1832 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FILEHANDLE)) {
1833 nfsm_chain_get_32(error, nmc, val);
1834 if (error == 0 && val > NFS_MAX_FH_SIZE)
1835 error = EBADRPC;
1836 nfsmout_if(error);
1837 if (fhp) {
1838 fhp->fh_len = val;
1839 nfsm_chain_get_opaque(error, nmc, nfsm_rndup(val), fhp->fh_data);
1840 } else {
1841 nfsm_chain_adv(error, nmc, nfsm_rndup(val));
1842 }
1843 attrbytes -= NFSX_UNSIGNED + nfsm_rndup(val);
1844 }
1845 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FILEID)) {
1846 nfsm_chain_get_64(error, nmc, nvap->nva_fileid);
1847 attrbytes -= 2 * NFSX_UNSIGNED;
1848 }
1849 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FILES_AVAIL)) {
1850 nfsm_chain_get_64(error, nmc, nfsap->nfsa_files_avail);
1851 attrbytes -= 2 * NFSX_UNSIGNED;
1852 }
1853 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FILES_FREE)) {
1854 nfsm_chain_get_64(error, nmc, nfsap->nfsa_files_free);
1855 attrbytes -= 2 * NFSX_UNSIGNED;
1856 }
1857 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FILES_TOTAL)) {
1858 nfsm_chain_get_64(error, nmc, nfsap->nfsa_files_total);
1859 attrbytes -= 2 * NFSX_UNSIGNED;
1860 }
1861 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_FS_LOCATIONS)) {
1862 uint32_t loc, serv, comp;
1863 struct nfs_fs_location *fsl;
1864 struct nfs_fs_server *fss;
1865 struct nfs_fs_path *fsp;
1866
1867 /* get root pathname */
1868 fsp = &nfslsp->nl_root;
1869 nfsm_chain_get_32(error, nmc, fsp->np_compcount); /* component count */
1870 attrbytes -= NFSX_UNSIGNED;
1871 /* sanity check component count */
1872 if (!error && (fsp->np_compcount > MAXPATHLEN))
1873 error = EBADRPC;
1874 nfsmout_if(error);
1875 if (fsp->np_compcount) {
1876 MALLOC(fsp->np_components, char **, fsp->np_compcount * sizeof(char*), M_TEMP, M_WAITOK|M_ZERO);
1877 if (!fsp->np_components)
1878 error = ENOMEM;
1879 }
1880 for (comp = 0; comp < fsp->np_compcount; comp++) {
1881 nfsm_chain_get_32(error, nmc, val); /* component length */
1882 /* sanity check component length */
1883 if (!error && (val == 0)) {
1884 /*
1885 * Apparently some people think a path with zero components should
1886 * be encoded with one zero-length component. So, just ignore any
1887 * zero length components.
1888 */
1889 comp--;
1890 fsp->np_compcount--;
1891 if (fsp->np_compcount == 0) {
1892 FREE(fsp->np_components, M_TEMP);
1893 fsp->np_components = NULL;
1894 }
1895 attrbytes -= NFSX_UNSIGNED;
1896 continue;
1897 }
1898 if (!error && ((val < 1) || (val > MAXPATHLEN)))
1899 error = EBADRPC;
1900 nfsmout_if(error);
1901 MALLOC(fsp->np_components[comp], char *, val+1, M_TEMP, M_WAITOK|M_ZERO);
1902 if (!fsp->np_components[comp])
1903 error = ENOMEM;
1904 nfsmout_if(error);
1905 nfsm_chain_get_opaque(error, nmc, val, fsp->np_components[comp]); /* component */
1906 attrbytes -= NFSX_UNSIGNED + nfsm_rndup(val);
1907 }
1908 nfsm_chain_get_32(error, nmc, nfslsp->nl_numlocs); /* fs location count */
1909 attrbytes -= NFSX_UNSIGNED;
1910 /* sanity check location count */
1911 if (!error && (nfslsp->nl_numlocs > 256))
1912 error = EBADRPC;
1913 nfsmout_if(error);
1914 if (nfslsp->nl_numlocs > 0) {
1915 MALLOC(nfslsp->nl_locations, struct nfs_fs_location **, nfslsp->nl_numlocs * sizeof(struct nfs_fs_location*), M_TEMP, M_WAITOK|M_ZERO);
1916 if (!nfslsp->nl_locations)
1917 error = ENOMEM;
1918 }
1919 nfsmout_if(error);
1920 for (loc = 0; loc < nfslsp->nl_numlocs; loc++) {
1921 nfsmout_if(error);
1922 MALLOC(fsl, struct nfs_fs_location *, sizeof(struct nfs_fs_location), M_TEMP, M_WAITOK|M_ZERO);
1923 if (!fsl)
1924 error = ENOMEM;
1925 nfslsp->nl_locations[loc] = fsl;
1926 nfsm_chain_get_32(error, nmc, fsl->nl_servcount); /* server count */
1927 attrbytes -= NFSX_UNSIGNED;
1928 /* sanity check server count */
1929 if (!error && ((fsl->nl_servcount < 1) || (fsl->nl_servcount > 256)))
1930 error = EBADRPC;
1931 nfsmout_if(error);
1932 MALLOC(fsl->nl_servers, struct nfs_fs_server **, fsl->nl_servcount * sizeof(struct nfs_fs_server*), M_TEMP, M_WAITOK|M_ZERO);
1933 if (!fsl->nl_servers)
1934 error = ENOMEM;
1935 for (serv = 0; serv < fsl->nl_servcount; serv++) {
1936 nfsmout_if(error);
1937 MALLOC(fss, struct nfs_fs_server *, sizeof(struct nfs_fs_server), M_TEMP, M_WAITOK|M_ZERO);
1938 if (!fss)
1939 error = ENOMEM;
1940 fsl->nl_servers[serv] = fss;
1941 nfsm_chain_get_32(error, nmc, val); /* server name length */
1942 /* sanity check server name length */
1943 if (!error && ((val < 1) || (val > MAXPATHLEN)))
1944 error = EINVAL;
1945 nfsmout_if(error);
1946 MALLOC(fss->ns_name, char *, val+1, M_TEMP, M_WAITOK|M_ZERO);
1947 if (!fss->ns_name)
1948 error = ENOMEM;
1949 nfsm_chain_get_opaque(error, nmc, val, fss->ns_name); /* server name */
1950 attrbytes -= NFSX_UNSIGNED + nfsm_rndup(val);
1951 nfsmout_if(error);
1952 /* copy name to address if it converts to a sockaddr */
1953 if (nfs_uaddr2sockaddr(fss->ns_name, (struct sockaddr*)&ss)) {
1954 fss->ns_addrcount = 1;
1955 MALLOC(fss->ns_addresses, char **, sizeof(char *), M_TEMP, M_WAITOK|M_ZERO);
1956 if (!fss->ns_addresses)
1957 error = ENOMEM;
1958 nfsmout_if(error);
1959 MALLOC(fss->ns_addresses[0], char *, val+1, M_TEMP, M_WAITOK|M_ZERO);
1960 if (!fss->ns_addresses[0])
1961 error = ENOMEM;
1962 nfsmout_if(error);
1963 strlcpy(fss->ns_addresses[0], fss->ns_name, val+1);
1964 }
1965 }
1966 /* get pathname */
1967 fsp = &fsl->nl_path;
1968 nfsm_chain_get_32(error, nmc, fsp->np_compcount); /* component count */
1969 attrbytes -= NFSX_UNSIGNED;
1970 /* sanity check component count */
1971 if (!error && (fsp->np_compcount > MAXPATHLEN))
1972 error = EINVAL;
1973 nfsmout_if(error);
1974 if (fsp->np_compcount) {
1975 MALLOC(fsp->np_components, char **, fsp->np_compcount * sizeof(char*), M_TEMP, M_WAITOK|M_ZERO);
1976 if (!fsp->np_components)
1977 error = ENOMEM;
1978 }
1979 for (comp = 0; comp < fsp->np_compcount; comp++) {
1980 nfsm_chain_get_32(error, nmc, val); /* component length */
1981 /* sanity check component length */
1982 if (!error && (val == 0)) {
1983 /*
1984 * Apparently some people think a path with zero components should
1985 * be encoded with one zero-length component. So, just ignore any
1986 * zero length components.
1987 */
1988 comp--;
1989 fsp->np_compcount--;
1990 if (fsp->np_compcount == 0) {
1991 FREE(fsp->np_components, M_TEMP);
1992 fsp->np_components = NULL;
1993 }
1994 attrbytes -= NFSX_UNSIGNED;
1995 continue;
1996 }
1997 if (!error && ((val < 1) || (val > MAXPATHLEN)))
1998 error = EINVAL;
1999 nfsmout_if(error);
2000 MALLOC(fsp->np_components[comp], char *, val+1, M_TEMP, M_WAITOK|M_ZERO);
2001 if (!fsp->np_components[comp])
2002 error = ENOMEM;
2003 nfsm_chain_get_opaque(error, nmc, val, fsp->np_components[comp]); /* component */
2004 attrbytes -= NFSX_UNSIGNED + nfsm_rndup(val);
2005 }
2006 }
2007 nfsm_assert(error, (attrbytes >= 0), EBADRPC);
2008 }
2009 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_HIDDEN)) { /* UF_HIDDEN */
2010 nfsm_chain_get_32(error, nmc, val);
2011 if (val)
2012 nvap->nva_flags |= NFS_FFLAG_HIDDEN;
2013 else
2014 nvap->nva_flags &= ~NFS_FFLAG_HIDDEN;
2015 attrbytes -= NFSX_UNSIGNED;
2016 }
2017 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_HOMOGENEOUS)) {
2018 /* XXX If NOT homogeneous, we may need to clear flags on the mount */
2019 nfsm_chain_get_32(error, nmc, val);
2020 if (val)
2021 nfsap->nfsa_flags |= NFS_FSFLAG_HOMOGENEOUS;
2022 else
2023 nfsap->nfsa_flags &= ~NFS_FSFLAG_HOMOGENEOUS;
2024 attrbytes -= NFSX_UNSIGNED;
2025 }
2026 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MAXFILESIZE)) {
2027 nfsm_chain_get_64(error, nmc, nfsap->nfsa_maxfilesize);
2028 attrbytes -= 2 * NFSX_UNSIGNED;
2029 }
2030 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MAXLINK)) {
2031 nfsm_chain_get_32(error, nmc, nvap->nva_maxlink);
2032 if (!error && (nfsap->nfsa_maxlink > INT32_MAX))
2033 nfsap->nfsa_maxlink = INT32_MAX;
2034 attrbytes -= NFSX_UNSIGNED;
2035 }
2036 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MAXNAME)) {
2037 nfsm_chain_get_32(error, nmc, nfsap->nfsa_maxname);
2038 if (!error && (nfsap->nfsa_maxname > INT32_MAX))
2039 nfsap->nfsa_maxname = INT32_MAX;
2040 attrbytes -= NFSX_UNSIGNED;
2041 }
2042 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MAXREAD)) {
2043 nfsm_chain_get_64(error, nmc, nfsap->nfsa_maxread);
2044 attrbytes -= 2 * NFSX_UNSIGNED;
2045 }
2046 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MAXWRITE)) {
2047 nfsm_chain_get_64(error, nmc, nfsap->nfsa_maxwrite);
2048 attrbytes -= 2 * NFSX_UNSIGNED;
2049 }
2050 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MIMETYPE)) {
2051 nfsm_chain_get_32(error, nmc, val);
2052 nfsm_chain_adv(error, nmc, nfsm_rndup(val));
2053 attrbytes -= NFSX_UNSIGNED + nfsm_rndup(val);
2054 }
2055 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MODE)) {
2056 nfsm_chain_get_32(error, nmc, nvap->nva_mode);
2057 attrbytes -= NFSX_UNSIGNED;
2058 }
2059 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_NO_TRUNC)) {
2060 nfsm_chain_get_32(error, nmc, val);
2061 if (val)
2062 nfsap->nfsa_flags |= NFS_FSFLAG_NO_TRUNC;
2063 else
2064 nfsap->nfsa_flags &= ~NFS_FSFLAG_NO_TRUNC;
2065 attrbytes -= NFSX_UNSIGNED;
2066 }
2067 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_NUMLINKS)) {
2068 nfsm_chain_get_32(error, nmc, val);
2069 nvap->nva_nlink = val;
2070 attrbytes -= NFSX_UNSIGNED;
2071 }
2072 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_OWNER)) {
2073 nfsm_chain_get_32(error, nmc, len);
2074 if (!error && len >= NFS_MAX_WHO)
2075 error = EBADRPC;
2076 if (!error && (len >= slen)) {
2077 if (s != sbuf) {
2078 FREE(s, M_TEMP);
2079 s = sbuf;
2080 slen = sizeof(sbuf);
2081 }
2082 /* Let's add a bit more if we can to the allocation as to try and avoid future allocations */
2083 MALLOC(s, char*, (len + 16 < NFS_MAX_WHO) ? len+16 : NFS_MAX_WHO, M_TEMP, M_WAITOK);
2084 if (s)
2085 slen = (len + 16 < NFS_MAX_WHO) ? len+16 : NFS_MAX_WHO;
2086 else
2087 error = ENOMEM;
2088 }
2089 nfsm_chain_get_opaque(error, nmc, len, s);
2090 if (!error) {
2091 s[len] = '\0';
2092 error = nfs4_id2guid(s, &nvap->nva_uuuid, 0);
2093 if (!error)
2094 error = kauth_cred_guid2uid(&nvap->nva_uuuid, &nvap->nva_uid);
2095 if (error) {
2096 /* unable to get either GUID or UID, set to default */
2097 nvap->nva_uid = (uid_t)(-2);
2098 if (nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_FAILED_MAPPINGS)
2099 printf("nfs4_parsefattr: owner %s is no one, no %s?, error %d\n", s,
2100 kauth_guid_equal(&nvap->nva_uuuid, &kauth_null_guid) ? "guid" : "uid",
2101 error);
2102 error = 0;
2103 }
2104 }
2105 attrbytes -= NFSX_UNSIGNED + nfsm_rndup(len);
2106 }
2107 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_OWNER_GROUP)) {
2108 nfsm_chain_get_32(error, nmc, len);
2109 if (!error && len >= NFS_MAX_WHO)
2110 error = EBADRPC;
2111 if (!error && (len >= slen)) {
2112 if (s != sbuf) {
2113 FREE(s, M_TEMP);
2114 s = sbuf;
2115 slen = sizeof(sbuf);
2116 }
2117 /* Let's add a bit more if we can to the allocation as to try and avoid future allocations */
2118 MALLOC(s, char*, (len + 16 < NFS_MAX_WHO) ? len+16 : NFS_MAX_WHO, M_TEMP, M_WAITOK);
2119 if (s)
2120 slen = (len + 16 < NFS_MAX_WHO) ? len+16 : NFS_MAX_WHO;
2121 else
2122 error = ENOMEM;
2123 }
2124 nfsm_chain_get_opaque(error, nmc, len, s);
2125 if (!error) {
2126 s[len] = '\0';
2127 error = nfs4_id2guid(s, &nvap->nva_guuid, 1);
2128 if (!error)
2129 error = kauth_cred_guid2gid(&nvap->nva_guuid, &nvap->nva_gid);
2130 if (error) {
2131 /* unable to get either GUID or GID, set to default */
2132 nvap->nva_gid = (gid_t)(-2);
2133 if (nfs_idmap_ctrl & NFS_IDMAP_CTRL_LOG_FAILED_MAPPINGS)
2134 printf("nfs4_parsefattr: group %s is no one, no %s?, error %d\n", s,
2135 kauth_guid_equal(&nvap->nva_guuid, &kauth_null_guid) ? "guid" : "gid",
2136 error);
2137 error = 0;
2138 }
2139 }
2140 attrbytes -= NFSX_UNSIGNED + nfsm_rndup(len);
2141 }
2142 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_QUOTA_AVAIL_HARD)) {
2143 nfsm_chain_get_64(error, nmc, dqbp->dqb_bhardlimit);
2144 attrbytes -= 2 * NFSX_UNSIGNED;
2145 }
2146 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_QUOTA_AVAIL_SOFT)) {
2147 nfsm_chain_get_64(error, nmc, dqbp->dqb_bsoftlimit);
2148 attrbytes -= 2 * NFSX_UNSIGNED;
2149 }
2150 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_QUOTA_USED)) {
2151 nfsm_chain_get_64(error, nmc, dqbp->dqb_curbytes);
2152 attrbytes -= 2 * NFSX_UNSIGNED;
2153 }
2154 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_RAWDEV)) {
2155 nfsm_chain_get_32(error, nmc, nvap->nva_rawdev.specdata1);
2156 nfsm_chain_get_32(error, nmc, nvap->nva_rawdev.specdata2);
2157 attrbytes -= 2 * NFSX_UNSIGNED;
2158 }
2159 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SPACE_AVAIL)) {
2160 nfsm_chain_get_64(error, nmc, nfsap->nfsa_space_avail);
2161 attrbytes -= 2 * NFSX_UNSIGNED;
2162 }
2163 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SPACE_FREE)) {
2164 nfsm_chain_get_64(error, nmc, nfsap->nfsa_space_free);
2165 attrbytes -= 2 * NFSX_UNSIGNED;
2166 }
2167 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SPACE_TOTAL)) {
2168 nfsm_chain_get_64(error, nmc, nfsap->nfsa_space_total);
2169 attrbytes -= 2 * NFSX_UNSIGNED;
2170 }
2171 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SPACE_USED)) {
2172 nfsm_chain_get_64(error, nmc, nvap->nva_bytes);
2173 attrbytes -= 2 * NFSX_UNSIGNED;
2174 }
2175 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SYSTEM)) {
2176 /* we'd support this if we had a flag to map it to... */
2177 nfsm_chain_adv(error, nmc, NFSX_UNSIGNED);
2178 attrbytes -= NFSX_UNSIGNED;
2179 }
2180 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_ACCESS)) {
2181 nfsm_chain_get_64(error, nmc, nvap->nva_timesec[NFSTIME_ACCESS]);
2182 nfsm_chain_get_32(error, nmc, nvap->nva_timensec[NFSTIME_ACCESS]);
2183 attrbytes -= 3 * NFSX_UNSIGNED;
2184 }
2185 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_ACCESS_SET)) {
2186 nfsm_chain_adv(error, nmc, 4*NFSX_UNSIGNED); /* just skip it */
2187 attrbytes -= 4 * NFSX_UNSIGNED;
2188 }
2189 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_BACKUP)) {
2190 nfsm_chain_get_64(error, nmc, nvap->nva_timesec[NFSTIME_BACKUP]);
2191 nfsm_chain_get_32(error, nmc, nvap->nva_timensec[NFSTIME_BACKUP]);
2192 attrbytes -= 3 * NFSX_UNSIGNED;
2193 }
2194 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_CREATE)) {
2195 nfsm_chain_get_64(error, nmc, nvap->nva_timesec[NFSTIME_CREATE]);
2196 nfsm_chain_get_32(error, nmc, nvap->nva_timensec[NFSTIME_CREATE]);
2197 attrbytes -= 3 * NFSX_UNSIGNED;
2198 }
2199 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_DELTA)) { /* skip for now */
2200 nfsm_chain_adv(error, nmc, 3*NFSX_UNSIGNED);
2201 attrbytes -= 3 * NFSX_UNSIGNED;
2202 }
2203 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_METADATA)) {
2204 nfsm_chain_get_64(error, nmc, nvap->nva_timesec[NFSTIME_CHANGE]);
2205 nfsm_chain_get_32(error, nmc, nvap->nva_timensec[NFSTIME_CHANGE]);
2206 attrbytes -= 3 * NFSX_UNSIGNED;
2207 }
2208 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_MODIFY)) {
2209 nfsm_chain_get_64(error, nmc, nvap->nva_timesec[NFSTIME_MODIFY]);
2210 nfsm_chain_get_32(error, nmc, nvap->nva_timensec[NFSTIME_MODIFY]);
2211 attrbytes -= 3 * NFSX_UNSIGNED;
2212 }
2213 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_MODIFY_SET)) {
2214 nfsm_chain_adv(error, nmc, 4*NFSX_UNSIGNED); /* just skip it */
2215 attrbytes -= 4 * NFSX_UNSIGNED;
2216 }
2217 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MOUNTED_ON_FILEID)) {
2218#if CONFIG_TRIGGERS
2219 /* we prefer the mounted on file ID, so just replace the fileid */
2220 nfsm_chain_get_64(error, nmc, nvap->nva_fileid);
2221#else
2222 nfsm_chain_adv(error, nmc, 2*NFSX_UNSIGNED);
2223#endif
2224 attrbytes -= 2 * NFSX_UNSIGNED;
2225 }
2226 /* advance over any leftover attrbytes */
2227 nfsm_assert(error, (attrbytes >= 0), EBADRPC);
2228 nfsm_chain_adv(error, nmc, nfsm_rndup(attrbytes));
2229nfsmout:
2230 if (error)
2231 nfs_fs_locations_cleanup(nfslsp);
2232 if (!error && rderror)
2233 error = rderror;
2234 /* free up temporary resources */
2235 if (s && (s != sbuf))
2236 FREE(s, M_TEMP);
2237 if (acl)
2238 kauth_acl_free(acl);
2239 if (error && nvap->nva_acl) {
2240 kauth_acl_free(nvap->nva_acl);
2241 nvap->nva_acl = NULL;
2242 }
2243 return (error);
2244}
2245
2246/*
2247 * Add an NFSv4 "sattr" structure to an mbuf chain
2248 */
2249int
2250nfsm_chain_add_fattr4_f(struct nfsm_chain *nmc, struct vnode_attr *vap, struct nfsmount *nmp)
2251{
2252 int error = 0, attrbytes, i, isgroup;
2253 size_t slen, len;
2254 uint32_t *pattrbytes, val, acecount;;
2255 uint32_t bitmap[NFS_ATTR_BITMAP_LEN];
2256 char sbuf[64], *s;
2257 kauth_acl_t acl;
2258 gid_t gid;
2259
2260 s = sbuf;
2261 slen = sizeof(sbuf);
2262
2263 /* First calculate the bitmap... */
2264 nfs_vattr_set_bitmap(nmp, bitmap, vap);
2265
2266 /*
2267 * Now pack it all together:
2268 * BITMAP, #BYTES, ATTRS
2269 * Keep a pointer to the length so we can set it later.
2270 */
2271 nfsm_chain_add_bitmap(error, nmc, bitmap, NFS_ATTR_BITMAP_LEN);
2272 attrbytes = 0;
2273 nfsm_chain_add_32(error, nmc, attrbytes);
2274 pattrbytes = (uint32_t*)(nmc->nmc_ptr - NFSX_UNSIGNED);
2275
2276 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_SIZE)) {
2277 nfsm_chain_add_64(error, nmc, vap->va_data_size);
2278 attrbytes += 2*NFSX_UNSIGNED;
2279 }
2280 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_ACL)) {
2281 acl = vap->va_acl;
2282 if (!acl || (acl->acl_entrycount == KAUTH_FILESEC_NOACL))
2283 acecount = 0;
2284 else
2285 acecount = acl->acl_entrycount;
2286 nfsm_chain_add_32(error, nmc, acecount);
2287 attrbytes += NFSX_UNSIGNED;
2288 for (i=0; !error && (i < (int)acecount); i++) {
2289 val = (acl->acl_ace[i].ace_flags & KAUTH_ACE_KINDMASK);
2290 val = nfs4_ace_vfstype_to_nfstype(val, &error);
2291 nfsm_chain_add_32(error, nmc, val);
2292 val = nfs4_ace_vfsflags_to_nfsflags(acl->acl_ace[i].ace_flags);
2293 isgroup = (kauth_cred_guid2gid(&acl->acl_ace[i].ace_applicable, &gid) == 0);
2294 val |= (isgroup) ? NFS_ACE_IDENTIFIER_GROUP : 0;
2295 nfsm_chain_add_32(error, nmc, val);
2296 val = nfs4_ace_vfsrights_to_nfsmask(acl->acl_ace[i].ace_rights);
2297 nfsm_chain_add_32(error, nmc, val);
2298 len = slen;
2299 error = nfs4_guid2id(&acl->acl_ace[i].ace_applicable, s, &len, isgroup);
2300 if (error == ENOSPC) {
2301 if (s != sbuf) {
2302 FREE(s, M_TEMP);
2303 s = sbuf;
2304 }
2305 len += 8;
2306 MALLOC(s, char*, len, M_TEMP, M_WAITOK);
2307 if (s) {
2308 slen = len;
2309 error = nfs4_guid2id(&acl->acl_ace[i].ace_applicable, s, &len, isgroup);
2310 } else {
2311 error = ENOMEM;
2312 }
2313 }
2314 nfsm_chain_add_name(error, nmc, s, len, nmp);
2315 attrbytes += 4*NFSX_UNSIGNED + nfsm_rndup(len);
2316 }
2317 }
2318 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_ARCHIVE)) {
2319 nfsm_chain_add_32(error, nmc, (vap->va_flags & SF_ARCHIVED) ? 1 : 0);
2320 attrbytes += NFSX_UNSIGNED;
2321 }
2322 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_HIDDEN)) {
2323 nfsm_chain_add_32(error, nmc, (vap->va_flags & UF_HIDDEN) ? 1 : 0);
2324 attrbytes += NFSX_UNSIGNED;
2325 }
2326 // NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MIMETYPE)
2327 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_MODE)) {
2328 nfsm_chain_add_32(error, nmc, vap->va_mode);
2329 attrbytes += NFSX_UNSIGNED;
2330 }
2331 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_OWNER)) {
2332 nfsmout_if(error);
2333 /* if we have va_uuuid use it, otherwise use uid */
2334 if (!VATTR_IS_ACTIVE(vap, va_uuuid)) {
2335 error = kauth_cred_uid2guid(vap->va_uid, &vap->va_uuuid);
2336 nfsmout_if(error);
2337 }
2338 len = slen;
2339 error = nfs4_guid2id(&vap->va_uuuid, s, &len, 0);
2340 if (error == ENOSPC) {
2341 if (s != sbuf) {
2342 FREE(s, M_TEMP);
2343 s = sbuf;
2344 }
2345 len += 8;
2346 MALLOC(s, char*, len, M_TEMP, M_WAITOK);
2347 if (s) {
2348 slen = len;
2349 error = nfs4_guid2id(&vap->va_uuuid, s, &len, 0);
2350 } else {
2351 error = ENOMEM;
2352 }
2353 }
2354 nfsm_chain_add_name(error, nmc, s, len, nmp);
2355 attrbytes += NFSX_UNSIGNED + nfsm_rndup(len);
2356 }
2357 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_OWNER_GROUP)) {
2358 nfsmout_if(error);
2359 /* if we have va_guuid use it, otherwise use gid */
2360 if (!VATTR_IS_ACTIVE(vap, va_guuid)) {
2361 error = kauth_cred_gid2guid(vap->va_gid, &vap->va_guuid);
2362 nfsmout_if(error);
2363 }
2364 len = slen;
2365 error = nfs4_guid2id(&vap->va_guuid, s, &len, 1);
2366 if (error == ENOSPC) {
2367 if (s != sbuf) {
2368 FREE(s, M_TEMP);
2369 s = sbuf;
2370 }
2371 len += 8;
2372 MALLOC(s, char*, len, M_TEMP, M_WAITOK);
2373 if (s) {
2374 slen = len;
2375 error = nfs4_guid2id(&vap->va_guuid, s, &len, 1);
2376 } else {
2377 error = ENOMEM;
2378 }
2379 }
2380 nfsm_chain_add_name(error, nmc, s, len, nmp);
2381 attrbytes += NFSX_UNSIGNED + nfsm_rndup(len);
2382 }
2383 // NFS_BITMAP_SET(bitmap, NFS_FATTR_SYSTEM)
2384 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_ACCESS_SET)) {
2385 if (vap->va_vaflags & VA_UTIMES_NULL) {
2386 nfsm_chain_add_32(error, nmc, NFS4_TIME_SET_TO_SERVER);
2387 attrbytes += NFSX_UNSIGNED;
2388 } else {
2389 nfsm_chain_add_32(error, nmc, NFS4_TIME_SET_TO_CLIENT);
2390 nfsm_chain_add_64(error, nmc, vap->va_access_time.tv_sec);
2391 nfsm_chain_add_32(error, nmc, vap->va_access_time.tv_nsec);
2392 attrbytes += 4*NFSX_UNSIGNED;
2393 }
2394 }
2395 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_BACKUP)) {
2396 nfsm_chain_add_64(error, nmc, vap->va_backup_time.tv_sec);
2397 nfsm_chain_add_32(error, nmc, vap->va_backup_time.tv_nsec);
2398 attrbytes += 3*NFSX_UNSIGNED;
2399 }
2400 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_CREATE)) {
2401 nfsm_chain_add_64(error, nmc, vap->va_create_time.tv_sec);
2402 nfsm_chain_add_32(error, nmc, vap->va_create_time.tv_nsec);
2403 attrbytes += 3*NFSX_UNSIGNED;
2404 }
2405 if (NFS_BITMAP_ISSET(bitmap, NFS_FATTR_TIME_MODIFY_SET)) {
2406 if (vap->va_vaflags & VA_UTIMES_NULL) {
2407 nfsm_chain_add_32(error, nmc, NFS4_TIME_SET_TO_SERVER);
2408 attrbytes += NFSX_UNSIGNED;
2409 } else {
2410 nfsm_chain_add_32(error, nmc, NFS4_TIME_SET_TO_CLIENT);
2411 nfsm_chain_add_64(error, nmc, vap->va_modify_time.tv_sec);
2412 nfsm_chain_add_32(error, nmc, vap->va_modify_time.tv_nsec);
2413 attrbytes += 4*NFSX_UNSIGNED;
2414 }
2415 }
2416 nfsmout_if(error);
2417 /* Now, set the attribute data length */
2418 *pattrbytes = txdr_unsigned(attrbytes);
2419nfsmout:
2420 if (s && (s != sbuf))
2421 FREE(s, M_TEMP);
2422 return (error);
2423}
2424
2425/*
2426 * Got the given error and need to start recovery (if not already started).
2427 * Note: nmp must be locked!
2428 */
2429void
2430nfs_need_recover(struct nfsmount *nmp, int error)
2431{
2432 int wake = !(nmp->nm_state & NFSSTA_RECOVER);
2433
2434 nmp->nm_state |= NFSSTA_RECOVER;
2435 if ((error == NFSERR_ADMIN_REVOKED) ||
2436 (error == NFSERR_EXPIRED) ||
2437 (error == NFSERR_STALE_CLIENTID))
2438 nmp->nm_state |= NFSSTA_RECOVER_EXPIRED;
2439 if (wake)
2440 nfs_mount_sock_thread_wake(nmp);
2441}
2442
2443/*
2444 * After recovery due to state expiry, check each node and
2445 * drop any lingering delegation we thought we had.
2446 *
2447 * If a node has an open that is not lost and is not marked
2448 * for reopen, then we hold onto any delegation because it is
2449 * likely newly-granted.
2450 */
2451static void
2452nfs4_expired_check_delegation(nfsnode_t np, vfs_context_t ctx)
2453{
2454 struct nfsmount *nmp = NFSTONMP(np);
2455 struct nfs_open_file *nofp;
2456 int drop = 1;
2457
2458 if ((np->n_flag & NREVOKE) || !(np->n_openflags & N_DELEG_MASK))
2459 return;
2460
2461 lck_mtx_lock(&np->n_openlock);
2462
2463 TAILQ_FOREACH(nofp, &np->n_opens, nof_link) {
2464 if (!nofp->nof_opencnt)
2465 continue;
2466 if (nofp->nof_flags & NFS_OPEN_FILE_LOST)
2467 continue;
2468 if (nofp->nof_flags & NFS_OPEN_FILE_REOPEN)
2469 continue;
2470 /* we have an open that is not lost and not marked for reopen */
2471 // XXX print out what's keeping this node from dropping the delegation.
2472 NP(nofp->nof_np, "nfs4_expired_check_delegation: !drop: opencnt %d flags 0x%x access %d %d mmap %d %d",
2473 nofp->nof_opencnt, nofp->nof_flags,
2474 nofp->nof_access, nofp->nof_deny,
2475 nofp->nof_mmap_access, nofp->nof_mmap_deny);
2476 drop = 0;
2477 break;
2478 }
2479
2480 if (drop) {
2481 /* need to drop a delegation */
2482 if (np->n_dreturn.tqe_next != NFSNOLIST) {
2483 /* remove this node from the delegation return list */
2484 lck_mtx_lock(&nmp->nm_lock);
2485 if (np->n_dreturn.tqe_next != NFSNOLIST) {
2486 TAILQ_REMOVE(&nmp->nm_dreturnq, np, n_dreturn);
2487 np->n_dreturn.tqe_next = NFSNOLIST;
2488 }
2489 lck_mtx_unlock(&nmp->nm_lock);
2490 }
2491 if (np->n_openflags & N_DELEG_MASK) {
2492 np->n_openflags &= ~N_DELEG_MASK;
2493 lck_mtx_lock(&nmp->nm_lock);
2494 if (np->n_dlink.tqe_next != NFSNOLIST) {
2495 TAILQ_REMOVE(&nmp->nm_delegations, np, n_dlink);
2496 np->n_dlink.tqe_next = NFSNOLIST;
2497 }
2498 lck_mtx_unlock(&nmp->nm_lock);
2499 nfs4_delegreturn_rpc(nmp, np->n_fhp, np->n_fhsize, &np->n_dstateid,
2500 0, vfs_context_thread(ctx), vfs_context_ucred(ctx));
2501 }
2502 }
2503
2504 lck_mtx_unlock(&np->n_openlock);
2505}
2506
2507/*
2508 * Recover state for an NFS mount.
2509 *
2510 * Iterates over all open files, reclaiming opens and lock state.
2511 */
2512void
2513nfs_recover(struct nfsmount *nmp)
2514{
2515 struct timespec ts = { 1, 0 };
2516 int error, lost, reopen;
2517 struct nfs_open_owner *noop;
2518 struct nfs_open_file *nofp;
2519 struct nfs_file_lock *nflp, *nextnflp;
2520 struct nfs_lock_owner *nlop;
2521 thread_t thd = current_thread();
2522 nfsnode_t np, nextnp;
2523 struct timeval now;
2524
2525restart:
2526 error = 0;
2527 lck_mtx_lock(&nmp->nm_lock);
2528 /*
2529 * First, wait for the state inuse count to go to zero so
2530 * we know there are no state operations in progress.
2531 */
2532 do {
2533 if ((error = nfs_sigintr(nmp, NULL, NULL, 1)))
2534 break;
2535 if (!(nmp->nm_sockflags & NMSOCK_READY))
2536 error = EPIPE;
2537 if (nmp->nm_state & (NFSSTA_FORCE|NFSSTA_DEAD))
2538 error = ENXIO;
2539 if (nmp->nm_sockflags & NMSOCK_UNMOUNT)
2540 error = ENXIO;
2541 if (error)
2542 break;
2543 if (nmp->nm_stateinuse)
2544 msleep(&nmp->nm_stateinuse, &nmp->nm_lock, (PZERO-1), "nfsrecoverstartwait", &ts);
2545 } while (nmp->nm_stateinuse);
2546 if (error) {
2547 if (error == EPIPE)
2548 printf("nfs recovery reconnecting for %s, 0x%x\n", vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid);
2549 else
2550 printf("nfs recovery aborted for %s, 0x%x\n", vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid);
2551 lck_mtx_unlock(&nmp->nm_lock);
2552 return;
2553 }
2554
2555 microuptime(&now);
2556 if (now.tv_sec == nmp->nm_recover_start) {
2557 printf("nfs recovery throttled for %s, 0x%x\n", vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid);
2558 lck_mtx_unlock(&nmp->nm_lock);
2559 tsleep(nfs_recover, (PZERO-1), "nfsrecoverrestart", hz);
2560 goto restart;
2561 }
2562 nmp->nm_recover_start = now.tv_sec;
2563 if (++nmp->nm_stategenid == 0)
2564 ++nmp->nm_stategenid;
2565 printf("nfs recovery started for %s, 0x%x\n", vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid);
2566 lck_mtx_unlock(&nmp->nm_lock);
2567
2568 /* for each open owner... */
2569 TAILQ_FOREACH(noop, &nmp->nm_open_owners, noo_link) {
2570 /* for each of its opens... */
2571 TAILQ_FOREACH(nofp, &noop->noo_opens, nof_oolink) {
2572 if (!nofp->nof_access || (nofp->nof_flags & NFS_OPEN_FILE_LOST) || (nofp->nof_np->n_flag & NREVOKE))
2573 continue;
2574 lost = reopen = 0;
2575 /* for NFSv2/v3, just skip straight to lock reclaim */
2576 if (nmp->nm_vers < NFS_VER4)
2577 goto reclaim_locks;
2578 if (nofp->nof_rw_drw)
2579 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_BOTH, NFS_OPEN_SHARE_DENY_BOTH);
2580 if (!error && nofp->nof_w_drw)
2581 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_WRITE, NFS_OPEN_SHARE_DENY_BOTH);
2582 if (!error && nofp->nof_r_drw)
2583 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_READ, NFS_OPEN_SHARE_DENY_BOTH);
2584 if (!error && nofp->nof_rw_dw)
2585 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_BOTH, NFS_OPEN_SHARE_DENY_WRITE);
2586 if (!error && nofp->nof_w_dw)
2587 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_WRITE, NFS_OPEN_SHARE_DENY_WRITE);
2588 if (!error && nofp->nof_r_dw)
2589 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_READ, NFS_OPEN_SHARE_DENY_WRITE);
2590 /*
2591 * deny-none opens with no locks can just be reopened (later) if reclaim fails.
2592 */
2593 if (!error && nofp->nof_rw) {
2594 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_BOTH, NFS_OPEN_SHARE_DENY_NONE);
2595 if ((error == NFSERR_ADMIN_REVOKED) || (error == NFSERR_EXPIRED) || (error == NFSERR_NO_GRACE)) {
2596 reopen = error;
2597 error = 0;
2598 }
2599 }
2600 if (!error && !reopen && nofp->nof_w) {
2601 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_WRITE, NFS_OPEN_SHARE_DENY_NONE);
2602 if ((error == NFSERR_ADMIN_REVOKED) || (error == NFSERR_EXPIRED) || (error == NFSERR_NO_GRACE)) {
2603 reopen = error;
2604 error = 0;
2605 }
2606 }
2607 if (!error && !reopen && nofp->nof_r) {
2608 error = nfs4_open_reclaim_rpc(nofp, NFS_OPEN_SHARE_ACCESS_READ, NFS_OPEN_SHARE_DENY_NONE);
2609 if ((error == NFSERR_ADMIN_REVOKED) || (error == NFSERR_EXPIRED) || (error == NFSERR_NO_GRACE)) {
2610 reopen = error;
2611 error = 0;
2612 }
2613 }
2614
2615 /*
2616 * If we hold delegated state but we don't have any non-delegated opens,
2617 * then we should attempt to claim that state now (but don't return the
2618 * delegation unless asked to).
2619 */
2620 if ((nofp->nof_d_rw_drw || nofp->nof_d_w_drw || nofp->nof_d_r_drw ||
2621 nofp->nof_d_rw_dw || nofp->nof_d_w_dw || nofp->nof_d_r_dw ||
2622 nofp->nof_d_rw || nofp->nof_d_w || nofp->nof_d_r) &&
2623 (!nofp->nof_rw_drw && !nofp->nof_w_drw && !nofp->nof_r_drw &&
2624 !nofp->nof_rw_dw && !nofp->nof_w_dw && !nofp->nof_r_dw &&
2625 !nofp->nof_rw && !nofp->nof_w && !nofp->nof_r)) {
2626 if (!error && !nfs_open_state_set_busy(nofp->nof_np, NULL)) {
2627 error = nfs4_claim_delegated_state_for_node(nofp->nof_np, R_RECOVER);
2628 if (!error && (nofp->nof_flags & NFS_OPEN_FILE_REOPEN))
2629 reopen = EAGAIN;
2630 nfs_open_state_clear_busy(nofp->nof_np);
2631 /* if claim didn't go well, we may need to return delegation now */
2632 if (nofp->nof_np->n_openflags & N_DELEG_RETURN) {
2633 nfs4_delegation_return(nofp->nof_np, R_RECOVER, thd, noop->noo_cred);
2634 if (!(nmp->nm_sockflags & NMSOCK_READY))
2635 error = ETIMEDOUT; /* looks like we need a reconnect */
2636 }
2637 }
2638 }
2639
2640 /*
2641 * Handle any issue claiming open state.
2642 * Potential reopens need to first confirm that there are no locks.
2643 */
2644 if (error || reopen) {
2645 /* restart recovery? */
2646 if ((error == ETIMEDOUT) || nfs_mount_state_error_should_restart(error)) {
2647 if (error == ETIMEDOUT)
2648 nfs_need_reconnect(nmp);
2649 tsleep(nfs_recover, (PZERO-1), "nfsrecoverrestart", hz);
2650 printf("nfs recovery restarting for %s, 0x%x, error %d\n",
2651 vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid, error);
2652 goto restart;
2653 }
2654 if (reopen && (nfs_check_for_locks(noop, nofp) == 0)) {
2655 /* just reopen the file on next access */
2656 NP(nofp->nof_np, "nfs_recover: %d, need reopen for %d %p 0x%x", reopen,
2657 kauth_cred_getuid(noop->noo_cred), nofp->nof_np, nofp->nof_np->n_flag);
2658 lck_mtx_lock(&nofp->nof_lock);
2659 nofp->nof_flags |= NFS_OPEN_FILE_REOPEN;
2660 lck_mtx_unlock(&nofp->nof_lock);
2661 } else {
2662 /* open file state lost */
2663 if (reopen)
2664 NP(nofp->nof_np, "nfs_recover: %d, can't reopen because of locks %d %p", reopen,
2665 kauth_cred_getuid(noop->noo_cred), nofp->nof_np);
2666 lost = 1;
2667 error = 0;
2668 reopen = 0;
2669 }
2670 } else {
2671 /* no error, so make sure the reopen flag isn't set */
2672 lck_mtx_lock(&nofp->nof_lock);
2673 nofp->nof_flags &= ~NFS_OPEN_FILE_REOPEN;
2674 lck_mtx_unlock(&nofp->nof_lock);
2675 }
2676
2677 /*
2678 * Scan this node's lock owner list for entries with this open owner,
2679 * then walk the lock owner's held lock list recovering each lock.
2680 */
2681reclaim_locks:
2682 TAILQ_FOREACH(nlop, &nofp->nof_np->n_lock_owners, nlo_link) {
2683 if (lost || reopen)
2684 break;
2685 if (nlop->nlo_open_owner != noop)
2686 continue;
2687 TAILQ_FOREACH_SAFE(nflp, &nlop->nlo_locks, nfl_lolink, nextnflp) {
2688 /* skip dead & blocked lock requests (shouldn't be any in the held lock list) */
2689 if (nflp->nfl_flags & (NFS_FILE_LOCK_DEAD|NFS_FILE_LOCK_BLOCKED))
2690 continue;
2691 /* skip delegated locks */
2692 if (nflp->nfl_flags & NFS_FILE_LOCK_DELEGATED)
2693 continue;
2694 error = nmp->nm_funcs->nf_setlock_rpc(nofp->nof_np, nofp, nflp, 1, R_RECOVER, thd, noop->noo_cred);
2695 if (error)
2696 NP(nofp->nof_np, "nfs: lock reclaim (0x%llx, 0x%llx) %s %d",
2697 nflp->nfl_start, nflp->nfl_end,
2698 error ? "failed" : "succeeded", error);
2699 if (!error)
2700 continue;
2701 /* restart recovery? */
2702 if ((error == ETIMEDOUT) || nfs_mount_state_error_should_restart(error)) {
2703 if (error == ETIMEDOUT)
2704 nfs_need_reconnect(nmp);
2705 tsleep(nfs_recover, (PZERO-1), "nfsrecoverrestart", hz);
2706 printf("nfs recovery restarting for %s, 0x%x, error %d\n",
2707 vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid, error);
2708 goto restart;
2709 }
2710 /* lock state lost - attempt to close file */
2711 lost = 1;
2712 error = 0;
2713 break;
2714 }
2715 }
2716
2717 /*
2718 * If we've determined that we need to reopen the file then we probably
2719 * didn't receive any delegation we think we hold. We should attempt to
2720 * return that delegation (and claim any delegated state).
2721 *
2722 * If we hold a delegation that is marked for return, then we should
2723 * return it now.
2724 */
2725 if ((nofp->nof_np->n_openflags & N_DELEG_RETURN) ||
2726 (reopen && (nofp->nof_np->n_openflags & N_DELEG_MASK))) {
2727 nfs4_delegation_return(nofp->nof_np, R_RECOVER, thd, noop->noo_cred);
2728 if (!(nmp->nm_sockflags & NMSOCK_READY)) {
2729 /* looks like we need a reconnect */
2730 tsleep(nfs_recover, (PZERO-1), "nfsrecoverrestart", hz);
2731 printf("nfs recovery restarting for %s, 0x%x, error %d\n",
2732 vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid, error);
2733 goto restart;
2734 }
2735 }
2736
2737 if (lost) {
2738 /* revoke open file state */
2739 NP(nofp->nof_np, "nfs_recover: state lost for %d %p 0x%x",
2740 kauth_cred_getuid(noop->noo_cred), nofp->nof_np, nofp->nof_np->n_flag);
2741 nfs_revoke_open_state_for_node(nofp->nof_np);
2742 }
2743 }
2744 }
2745
2746 if (!error) {
2747 /* If state expired, make sure we're not holding onto any stale delegations */
2748 lck_mtx_lock(&nmp->nm_lock);
2749 if ((nmp->nm_vers >= NFS_VER4) && (nmp->nm_state & NFSSTA_RECOVER_EXPIRED)) {
2750recheckdeleg:
2751 TAILQ_FOREACH_SAFE(np, &nmp->nm_delegations, n_dlink, nextnp) {
2752 lck_mtx_unlock(&nmp->nm_lock);
2753 nfs4_expired_check_delegation(np, vfs_context_kernel());
2754 lck_mtx_lock(&nmp->nm_lock);
2755 if (nextnp == NFSNOLIST)
2756 goto recheckdeleg;
2757 }
2758 }
2759 nmp->nm_state &= ~(NFSSTA_RECOVER|NFSSTA_RECOVER_EXPIRED);
2760 wakeup(&nmp->nm_state);
2761 printf("nfs recovery completed for %s, 0x%x\n",
2762 vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid);
2763 lck_mtx_unlock(&nmp->nm_lock);
2764 } else {
2765 printf("nfs recovery failed for %s, 0x%x, error %d\n",
2766 vfs_statfs(nmp->nm_mountp)->f_mntfromname, nmp->nm_stategenid, error);
2767 }
2768}
2769