2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include "opt_inet6.h"
38 #include "opt_kgssapi.h"
40 #include <fs/nfs/nfsport.h>
43 #include <rpc/rpcsec_gss.h>
45 #include <security/mac/mac_framework.h>
50 * Mapping of old NFS Version 2 RPC numbers to generic numbers.
52 static int newnfs_nfsv3_procid[NFS_V3NPROCS] = {
78 SYSCTL_DECL(_vfs_nfsd);
82 static int nfs_privport = 0;
83 SYSCTL_INT(_vfs_nfsd, OID_AUTO, nfs_privport, CTLFLAG_RW,
85 "Only allow clients using a privileged port for NFSv2 and 3");
87 static int nfs_minvers = NFS_VER2;
88 SYSCTL_INT(_vfs_nfsd, OID_AUTO, server_min_nfsvers, CTLFLAG_RW,
89 &nfs_minvers, 0, "The lowest version of NFS handled by the server");
91 static int nfs_maxvers = NFS_VER4;
92 SYSCTL_INT(_vfs_nfsd, OID_AUTO, server_max_nfsvers, CTLFLAG_RW,
93 &nfs_maxvers, 0, "The highest version of NFS handled by the server");
95 static int nfs_proc(struct nfsrv_descript *, u_int32_t, struct socket *,
96 u_int64_t, struct nfsrvcache **);
98 extern u_long sb_max_adj;
99 extern int newnfs_numnfsd;
100 extern struct proc *nfsd_master_proc;
103 * NFS server system calls
107 nfssvc_program(struct svc_req *rqst, SVCXPRT *xprt)
109 struct nfsrv_descript nd;
110 struct nfsrvcache *rp = NULL;
111 int cacherep, credflavor;
113 memset(&nd, 0, sizeof(nd));
114 if (rqst->rq_vers == NFS_VER2) {
115 if (rqst->rq_proc > NFSV2PROC_STATFS) {
120 nd.nd_procnum = newnfs_nfsv3_procid[rqst->rq_proc];
121 nd.nd_flag = ND_NFSV2;
122 } else if (rqst->rq_vers == NFS_VER3) {
123 if (rqst->rq_proc >= NFS_V3NPROCS) {
128 nd.nd_procnum = rqst->rq_proc;
129 nd.nd_flag = ND_NFSV3;
131 if (rqst->rq_proc != NFSPROC_NULL &&
132 rqst->rq_proc != NFSV4PROC_COMPOUND) {
137 nd.nd_procnum = rqst->rq_proc;
138 nd.nd_flag = ND_NFSV4;
142 * Note: we want rq_addr, not svc_getrpccaller for nd_nam2 -
143 * NFS_SRVMAXDATA uses a NULL value for nd_nam2 to detect TCP
146 nd.nd_mrep = rqst->rq_args;
147 rqst->rq_args = NULL;
148 newnfs_realign(&nd.nd_mrep);
149 nd.nd_md = nd.nd_mrep;
150 nd.nd_dpos = mtod(nd.nd_md, caddr_t);
151 nd.nd_nam = svc_getrpccaller(rqst);
152 nd.nd_nam2 = rqst->rq_addr;
156 if (nfs_privport && (nd.nd_flag & ND_NFSV4) == 0) {
157 /* Check if source port is privileged */
159 struct sockaddr *nam = nd.nd_nam;
160 struct sockaddr_in *sin;
162 sin = (struct sockaddr_in *)nam;
164 * INET/INET6 - same code:
165 * sin_port and sin6_port are at same offset
167 port = ntohs(sin->sin_port);
168 if (port >= IPPORT_RESERVED &&
169 nd.nd_procnum != NFSPROC_NULL) {
171 char b6[INET6_ADDRSTRLEN];
172 #if defined(KLD_MODULE)
173 /* Do not use ip6_sprintf: the nfs module should work without INET6. */
174 #define ip6_sprintf(buf, a) \
175 (sprintf((buf), "%x:%x:%x:%x:%x:%x:%x:%x", \
176 (a)->s6_addr16[0], (a)->s6_addr16[1], \
177 (a)->s6_addr16[2], (a)->s6_addr16[3], \
178 (a)->s6_addr16[4], (a)->s6_addr16[5], \
179 (a)->s6_addr16[6], (a)->s6_addr16[7]), \
183 printf("NFS request from unprivileged port (%s:%d)\n",
185 sin->sin_family == AF_INET6 ?
186 ip6_sprintf(b6, &satosin6(sin)->sin6_addr) :
187 #if defined(KLD_MODULE)
191 inet_ntoa(sin->sin_addr), port);
192 svcerr_weakauth(rqst);
199 if (nd.nd_procnum != NFSPROC_NULL) {
200 if (!svc_getcred(rqst, &nd.nd_cred, &credflavor)) {
201 svcerr_weakauth(rqst);
207 /* Set the flag based on credflavor */
208 if (credflavor == RPCSEC_GSS_KRB5) {
209 nd.nd_flag |= ND_GSS;
210 } else if (credflavor == RPCSEC_GSS_KRB5I) {
211 nd.nd_flag |= (ND_GSS | ND_GSSINTEGRITY);
212 } else if (credflavor == RPCSEC_GSS_KRB5P) {
213 nd.nd_flag |= (ND_GSS | ND_GSSPRIVACY);
214 } else if (credflavor != AUTH_SYS) {
215 svcerr_weakauth(rqst);
222 mac_cred_associate_nfsd(nd.nd_cred);
224 if ((nd.nd_flag & ND_NFSV4) != 0) {
225 nd.nd_repstat = nfsvno_v4rootexport(&nd);
226 if (nd.nd_repstat != 0) {
227 svcerr_weakauth(rqst);
234 cacherep = nfs_proc(&nd, rqst->rq_xid, xprt->xp_socket,
235 xprt->xp_sockref, &rp);
238 nd.nd_mreq->m_len = 0;
241 if (nd.nd_mrep != NULL)
244 if (nd.nd_cred != NULL)
247 if (cacherep == RC_DROPIT) {
248 if (nd.nd_mreq != NULL)
254 if (nd.nd_mreq == NULL) {
260 if (nd.nd_repstat & NFSERR_AUTHERR) {
261 svcerr_auth(rqst, nd.nd_repstat & ~NFSERR_AUTHERR);
262 if (nd.nd_mreq != NULL)
264 } else if (!svc_sendreply_mbuf(rqst, nd.nd_mreq)) {
265 svcerr_systemerr(rqst);
268 nfsrvd_sentcache(rp, xprt->xp_socket, 0);
276 * Check the cache and, optionally, do the RPC.
277 * Return the appropriate cache response.
280 nfs_proc(struct nfsrv_descript *nd, u_int32_t xid, struct socket *so,
281 u_int64_t sockref, struct nfsrvcache **rpp)
283 struct thread *td = curthread;
284 int cacherep = RC_DOIT, isdgram;
287 if (nd->nd_nam2 == NULL) {
288 nd->nd_flag |= ND_STREAMSOCK;
293 NFSGETTIME(&nd->nd_starttime);
297 * 1 - For NFSv2 over UDP, if we are near our malloc/mget
298 * limit, just drop the request. There is no
299 * NFSERR_RESOURCE or NFSERR_DELAY for NFSv2 and the
300 * client will timeout/retry over UDP in a little while.
301 * 2 - nd_repstat == 0 && nd_mreq == NULL, which
302 * means a normal nfs rpc, so check the cache
304 if ((nd->nd_flag & ND_NFSV2) && nd->nd_nam2 != NULL &&
305 nfsrv_mallocmget_limit()) {
306 cacherep = RC_DROPIT;
309 * For NFSv3, play it safe and assume that the client is
310 * doing retries on the same TCP connection.
312 if ((nd->nd_flag & (ND_NFSV4 | ND_STREAMSOCK)) ==
314 nd->nd_flag |= ND_SAMETCPCONN;
316 nd->nd_tcpconntime = NFSD_MONOSEC;
317 nd->nd_sockref = sockref;
318 cacherep = nfsrvd_getcache(nd, so);
322 * Handle the request. There are three cases.
323 * RC_DOIT - do the RPC
324 * RC_REPLY - return the reply already created
325 * RC_DROPIT - just throw the request away
327 if (cacherep == RC_DOIT) {
328 nfsrvd_dorpc(nd, isdgram, td);
329 if (nd->nd_repstat == NFSERR_DONTREPLY)
330 cacherep = RC_DROPIT;
333 *rpp = nfsrvd_updatecache(nd, so);
341 * Adds a socket to the list for servicing by nfsds.
344 nfsrvd_addsock(struct file *fp)
350 static u_int64_t sockref = 0;
355 error = soreserve(so, siz, siz);
360 * Steal the socket from userland so that it doesn't close
363 if (so->so_type == SOCK_DGRAM)
364 xprt = svc_dg_create(nfsrvd_pool, so, 0, 0);
366 xprt = svc_vc_create(nfsrvd_pool, so, 0, 0);
368 fp->f_ops = &badfileops;
370 xprt->xp_sockref = ++sockref;
371 if (nfs_minvers == NFS_VER2)
372 svc_reg(xprt, NFS_PROG, NFS_VER2, nfssvc_program,
374 if (nfs_minvers <= NFS_VER3 && nfs_maxvers >= NFS_VER3)
375 svc_reg(xprt, NFS_PROG, NFS_VER3, nfssvc_program,
377 if (nfs_maxvers >= NFS_VER4)
378 svc_reg(xprt, NFS_PROG, NFS_VER4, nfssvc_program,
389 * Called by nfssvc() for nfsds. Just loops around servicing rpc requests
390 * until it is killed by a signal.
393 nfsrvd_nfsd(struct thread *td, struct nfsd_nfsd_args *args)
395 char principal[MAXHOSTNAMELEN + 5];
397 bool_t ret2, ret3, ret4;
399 error = copyinstr(args->principal, principal, sizeof (principal),
405 * Only the first nfsd actually does any work. The RPC code
406 * adds threads to it as needed. Any extra processes offered
407 * by nfsd just exit. If nfsd is new enough, it will call us
408 * once with a structure that specifies how many threads to
412 if (newnfs_numnfsd == 0) {
417 /* An empty string implies AUTH_SYS only. */
418 if (principal[0] != '\0') {
419 ret2 = rpc_gss_set_svc_name_call(principal,
420 "kerberosv5", GSS_C_INDEFINITE, NFS_PROG, NFS_VER2);
421 ret3 = rpc_gss_set_svc_name_call(principal,
422 "kerberosv5", GSS_C_INDEFINITE, NFS_PROG, NFS_VER3);
423 ret4 = rpc_gss_set_svc_name_call(principal,
424 "kerberosv5", GSS_C_INDEFINITE, NFS_PROG, NFS_VER4);
426 if (!ret2 || !ret3 || !ret4)
427 printf("nfsd: can't register svc name\n");
430 nfsrvd_pool->sp_minthreads = args->minthreads;
431 nfsrvd_pool->sp_maxthreads = args->maxthreads;
433 svc_run(nfsrvd_pool);
435 if (principal[0] != '\0') {
436 rpc_gss_clear_svc_name_call(NFS_PROG, NFS_VER2);
437 rpc_gss_clear_svc_name_call(NFS_PROG, NFS_VER3);
438 rpc_gss_clear_svc_name_call(NFS_PROG, NFS_VER4);
453 * Initialize the data structures for the server.
454 * Handshake with any new nfsds starting up to avoid any chance of
458 nfsrvd_init(int terminating)
464 nfsd_master_proc = NULL;
466 svcpool_destroy(nfsrvd_pool);
473 nfsrvd_pool = svcpool_create("nfsd", SYSCTL_STATIC_CHILDREN(_vfs_nfsd));
474 nfsrvd_pool->sp_rcache = NULL;
475 nfsrvd_pool->sp_assign = NULL;
476 nfsrvd_pool->sp_done = NULL;