sys/fs/nfsserver/nfs_nfsdkrpc.c

   1 /*-
   2  * Copyright (c) 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Rick Macklem at The University of Guelph.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  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.
  19  *
  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
  30  * SUCH DAMAGE.
  31  *
  32  */
  33
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36
  37 #include <sys/param.h>
  38 #include <sys/systm.h>
  39
  40 #include "opt_inet6.h"
  41 #include "opt_kgssapi.h"
  42
  43 #include <fs/nfs/nfsport.h>
  44
  45 #include <rpc/rpc.h>
  46 #include <rpc/rpcsec_gss.h>
  47
  48 #include <nfs/nfs_fha.h>
  49 #include <fs/nfsserver/nfs_fha_new.h>
  50
  51 #include <security/mac/mac_framework.h>
  52
  53 NFSDLOCKMUTEX;
  54 NFSV4ROOTLOCKMUTEX;
  55 struct nfsv4lock nfsd_suspend_lock;
  56
  57 /*
  58  * Mapping of old NFS Version 2 RPC numbers to generic numbers.
  59  */
  60 int newnfs_nfsv3_procid[NFS_V3NPROCS] = {
  61         NFSPROC_NULL,
  62         NFSPROC_GETATTR,
  63         NFSPROC_SETATTR,
  64         NFSPROC_NOOP,
  65         NFSPROC_LOOKUP,
  66         NFSPROC_READLINK,
  67         NFSPROC_READ,
  68         NFSPROC_NOOP,
  69         NFSPROC_WRITE,
  70         NFSPROC_CREATE,
  71         NFSPROC_REMOVE,
  72         NFSPROC_RENAME,
  73         NFSPROC_LINK,
  74         NFSPROC_SYMLINK,
  75         NFSPROC_MKDIR,
  76         NFSPROC_RMDIR,
  77         NFSPROC_READDIR,
  78         NFSPROC_FSSTAT,
  79         NFSPROC_NOOP,
  80         NFSPROC_NOOP,
  81         NFSPROC_NOOP,
  82         NFSPROC_NOOP,
  83 };
  84
  85
  86 SYSCTL_DECL(_vfs_nfsd);
  87
  88 SVCPOOL         *nfsrvd_pool;
  89
  90 static int      nfs_privport = 0;
  91 SYSCTL_INT(_vfs_nfsd, OID_AUTO, nfs_privport, CTLFLAG_RW,
  92     &nfs_privport, 0,
  93     "Only allow clients using a privileged port for NFSv2 and 3");
  94
  95 static int      nfs_minvers = NFS_VER2;
  96 SYSCTL_INT(_vfs_nfsd, OID_AUTO, server_min_nfsvers, CTLFLAG_RW,
  97     &nfs_minvers, 0, "The lowest version of NFS handled by the server");
  98
  99 static int      nfs_maxvers = NFS_VER4;
 100 SYSCTL_INT(_vfs_nfsd, OID_AUTO, server_max_nfsvers, CTLFLAG_RW,
 101     &nfs_maxvers, 0, "The highest version of NFS handled by the server");
 102
 103 static int nfs_proc(struct nfsrv_descript *, u_int32_t, SVCXPRT *xprt,
 104     struct nfsrvcache **);
 105
 106 extern u_long sb_max_adj;
 107 extern int newnfs_numnfsd;
 108 extern struct proc *nfsd_master_proc;
 109
 110 /*
 111  * NFS server system calls
 112  */
 113
 114 static void
 115 nfssvc_program(struct svc_req *rqst, SVCXPRT *xprt)
 116 {
 117         struct nfsrv_descript nd;
 118         struct nfsrvcache *rp = NULL;
 119         int cacherep, credflavor;
 120
 121         memset(&nd, 0, sizeof(nd));
 122         if (rqst->rq_vers == NFS_VER2) {
 123                 if (rqst->rq_proc > NFSV2PROC_STATFS ||
 124                     newnfs_nfsv3_procid[rqst->rq_proc] == NFSPROC_NOOP) {
 125                         svcerr_noproc(rqst);
 126                         svc_freereq(rqst);
 127                         goto out;
 128                 }
 129                 nd.nd_procnum = newnfs_nfsv3_procid[rqst->rq_proc];
 130                 nd.nd_flag = ND_NFSV2;
 131         } else if (rqst->rq_vers == NFS_VER3) {
 132                 if (rqst->rq_proc >= NFS_V3NPROCS) {
 133                         svcerr_noproc(rqst);
 134                         svc_freereq(rqst);
 135                         goto out;
 136                 }
 137                 nd.nd_procnum = rqst->rq_proc;
 138                 nd.nd_flag = ND_NFSV3;
 139         } else {
 140                 if (rqst->rq_proc != NFSPROC_NULL &&
 141                     rqst->rq_proc != NFSV4PROC_COMPOUND) {
 142                         svcerr_noproc(rqst);
 143                         svc_freereq(rqst);
 144                         goto out;
 145                 }
 146                 nd.nd_procnum = rqst->rq_proc;
 147                 nd.nd_flag = ND_NFSV4;
 148         }
 149
 150         /*
 151          * Note: we want rq_addr, not svc_getrpccaller for nd_nam2 -
 152          * NFS_SRVMAXDATA uses a NULL value for nd_nam2 to detect TCP
 153          * mounts.
 154          */
 155         nd.nd_mrep = rqst->rq_args;
 156         rqst->rq_args = NULL;
 157         newnfs_realign(&nd.nd_mrep, M_WAITOK);
 158         nd.nd_md = nd.nd_mrep;
 159         nd.nd_dpos = mtod(nd.nd_md, caddr_t);
 160         nd.nd_nam = svc_getrpccaller(rqst);
 161         nd.nd_nam2 = rqst->rq_addr;
 162         nd.nd_mreq = NULL;
 163         nd.nd_cred = NULL;
 164
 165         if (nfs_privport && (nd.nd_flag & ND_NFSV4) == 0) {
 166                 /* Check if source port is privileged */
 167                 u_short port;
 168                 struct sockaddr *nam = nd.nd_nam;
 169                 struct sockaddr_in *sin;
 170
 171                 sin = (struct sockaddr_in *)nam;
 172                 /*
 173                  * INET/INET6 - same code:
 174                  *    sin_port and sin6_port are at same offset
 175                  */
 176                 port = ntohs(sin->sin_port);
 177                 if (port >= IPPORT_RESERVED &&
 178                     nd.nd_procnum != NFSPROC_NULL) {
 179 #ifdef INET6
 180                         char b6[INET6_ADDRSTRLEN];
 181 #if defined(KLD_MODULE)
 182                         /* Do not use ip6_sprintf: the nfs module should work without INET6. */
 183 #define ip6_sprintf(buf, a)                                             \
 184                         (sprintf((buf), "%x:%x:%x:%x:%x:%x:%x:%x",      \
 185                             (a)->s6_addr16[0], (a)->s6_addr16[1],       \
 186                             (a)->s6_addr16[2], (a)->s6_addr16[3],       \
 187                             (a)->s6_addr16[4], (a)->s6_addr16[5],       \
 188                             (a)->s6_addr16[6], (a)->s6_addr16[7]),      \
 189                             (buf))
 190 #endif
 191 #endif
 192                         printf("NFS request from unprivileged port (%s:%d)\n",
 193 #ifdef INET6
 194                             sin->sin_family == AF_INET6 ?
 195                             ip6_sprintf(b6, &satosin6(sin)->sin6_addr) :
 196 #if defined(KLD_MODULE)
 197 #undef ip6_sprintf
 198 #endif
 199 #endif
 200                             inet_ntoa(sin->sin_addr), port);
 201                         svcerr_weakauth(rqst);
 202                         svc_freereq(rqst);
 203                         m_freem(nd.nd_mrep);
 204                         goto out;
 205                 }
 206         }
 207
 208         if (nd.nd_procnum != NFSPROC_NULL) {
 209                 if (!svc_getcred(rqst, &nd.nd_cred, &credflavor)) {
 210                         svcerr_weakauth(rqst);
 211                         svc_freereq(rqst);
 212                         m_freem(nd.nd_mrep);
 213                         goto out;
 214                 }
 215
 216                 /* Set the flag based on credflavor */
 217                 if (credflavor == RPCSEC_GSS_KRB5) {
 218                         nd.nd_flag |= ND_GSS;
 219                 } else if (credflavor == RPCSEC_GSS_KRB5I) {
 220                         nd.nd_flag |= (ND_GSS | ND_GSSINTEGRITY);
 221                 } else if (credflavor == RPCSEC_GSS_KRB5P) {
 222                         nd.nd_flag |= (ND_GSS | ND_GSSPRIVACY);
 223                 } else if (credflavor != AUTH_SYS) {
 224                         svcerr_weakauth(rqst);
 225                         svc_freereq(rqst);
 226                         m_freem(nd.nd_mrep);
 227                         goto out;
 228                 }
 229
 230 #ifdef MAC
 231                 mac_cred_associate_nfsd(nd.nd_cred);
 232 #endif
 233                 /*
 234                  * Get a refcnt (shared lock) on nfsd_suspend_lock.
 235                  * NFSSVC_SUSPENDNFSD will take an exclusive lock on
 236                  * nfsd_suspend_lock to suspend these threads.
 237                  * This must be done here, before the check of
 238                  * nfsv4root exports by nfsvno_v4rootexport().
 239                  */
 240                 NFSLOCKV4ROOTMUTEX();
 241                 nfsv4_getref(&nfsd_suspend_lock, NULL, NFSV4ROOTLOCKMUTEXPTR,
 242                     NULL);
 243                 NFSUNLOCKV4ROOTMUTEX();
 244
 245                 if ((nd.nd_flag & ND_NFSV4) != 0) {
 246                         nd.nd_repstat = nfsvno_v4rootexport(&nd);
 247                         if (nd.nd_repstat != 0) {
 248                                 NFSLOCKV4ROOTMUTEX();
 249                                 nfsv4_relref(&nfsd_suspend_lock);
 250                                 NFSUNLOCKV4ROOTMUTEX();
 251                                 svcerr_weakauth(rqst);
 252                                 svc_freereq(rqst);
 253                                 m_freem(nd.nd_mrep);
 254                                 goto out;
 255                         }
 256                 }
 257
 258                 cacherep = nfs_proc(&nd, rqst->rq_xid, xprt, &rp);
 259                 NFSLOCKV4ROOTMUTEX();
 260                 nfsv4_relref(&nfsd_suspend_lock);
 261                 NFSUNLOCKV4ROOTMUTEX();
 262         } else {
 263                 NFSMGET(nd.nd_mreq);
 264                 nd.nd_mreq->m_len = 0;
 265                 cacherep = RC_REPLY;
 266         }
 267         if (nd.nd_mrep != NULL)
 268                 m_freem(nd.nd_mrep);
 269
 270         if (nd.nd_cred != NULL)
 271                 crfree(nd.nd_cred);
 272
 273         if (cacherep == RC_DROPIT) {
 274                 if (nd.nd_mreq != NULL)
 275                         m_freem(nd.nd_mreq);
 276                 svc_freereq(rqst);
 277                 goto out;
 278         }
 279
 280         if (nd.nd_mreq == NULL) {
 281                 svcerr_decode(rqst);
 282                 svc_freereq(rqst);
 283                 goto out;
 284         }
 285
 286         if (nd.nd_repstat & NFSERR_AUTHERR) {
 287                 svcerr_auth(rqst, nd.nd_repstat & ~NFSERR_AUTHERR);
 288                 if (nd.nd_mreq != NULL)
 289                         m_freem(nd.nd_mreq);
 290         } else if (!svc_sendreply_mbuf(rqst, nd.nd_mreq)) {
 291                 svcerr_systemerr(rqst);
 292         }
 293         if (rp != NULL) {
 294                 nfsrvd_sentcache(rp, (rqst->rq_reply_seq != 0 ||
 295                     SVC_ACK(xprt, NULL)), rqst->rq_reply_seq);
 296         }
 297         svc_freereq(rqst);
 298
 299 out:
 300         NFSEXITCODE(0);
 301 }
 302
 303 /*
 304  * Check the cache and, optionally, do the RPC.
 305  * Return the appropriate cache response.
 306  */
 307 static int
 308 nfs_proc(struct nfsrv_descript *nd, u_int32_t xid, SVCXPRT *xprt,
 309     struct nfsrvcache **rpp)
 310 {
 311         struct thread *td = curthread;
 312         int cacherep = RC_DOIT, isdgram;
 313         uint32_t ack;
 314
 315         *rpp = NULL;
 316         if (nd->nd_nam2 == NULL) {
 317                 nd->nd_flag |= ND_STREAMSOCK;
 318                 isdgram = 0;
 319         } else {
 320                 isdgram = 1;
 321         }
 322
 323         /*
 324          * Two cases:
 325          * 1 - For NFSv2 over UDP, if we are near our malloc/mget
 326          *     limit, just drop the request. There is no
 327          *     NFSERR_RESOURCE or NFSERR_DELAY for NFSv2 and the
 328          *     client will timeout/retry over UDP in a little while.
 329          * 2 - nd_repstat == 0 && nd_mreq == NULL, which
 330          *     means a normal nfs rpc, so check the cache
 331          */
 332         if ((nd->nd_flag & ND_NFSV2) && nd->nd_nam2 != NULL &&
 333             nfsrv_mallocmget_limit()) {
 334                 cacherep = RC_DROPIT;
 335         } else {
 336                 /*
 337                  * For NFSv3, play it safe and assume that the client is
 338                  * doing retries on the same TCP connection.
 339                  */
 340                 if ((nd->nd_flag & (ND_NFSV4 | ND_STREAMSOCK)) ==
 341                     ND_STREAMSOCK)
 342                         nd->nd_flag |= ND_SAMETCPCONN;
 343                 nd->nd_retxid = xid;
 344                 nd->nd_tcpconntime = NFSD_MONOSEC;
 345                 nd->nd_sockref = xprt->xp_sockref;
 346                 cacherep = nfsrvd_getcache(nd);
 347                 ack = 0;
 348                 SVC_ACK(xprt, &ack);
 349                 nfsrc_trimcache(xprt->xp_sockref, ack, 0);
 350         }
 351
 352         /*
 353          * Handle the request. There are three cases.
 354          * RC_DOIT - do the RPC
 355          * RC_REPLY - return the reply already created
 356          * RC_DROPIT - just throw the request away
 357          */
 358         if (cacherep == RC_DOIT) {
 359                 nfsrvd_dorpc(nd, isdgram, td);
 360                 if (nd->nd_repstat == NFSERR_DONTREPLY)
 361                         cacherep = RC_DROPIT;
 362                 else
 363                         cacherep = RC_REPLY;
 364                 *rpp = nfsrvd_updatecache(nd);
 365         }
 366
 367         NFSEXITCODE2(0, nd);
 368         return (cacherep);
 369 }
 370
 371 static void
 372 nfssvc_loss(SVCXPRT *xprt)
 373 {
 374         uint32_t ack;
 375
 376         ack = 0;
 377         SVC_ACK(xprt, &ack);
 378         nfsrc_trimcache(xprt->xp_sockref, ack, 1);
 379 }
 380
 381 /*
 382  * Adds a socket to the list for servicing by nfsds.
 383  */
 384 int
 385 nfsrvd_addsock(struct file *fp)
 386 {
 387         int siz;
 388         struct socket *so;
 389         int error = 0;
 390         SVCXPRT *xprt;
 391         static u_int64_t sockref = 0;
 392
 393         so = fp->f_data;
 394
 395         siz = sb_max_adj;
 396         error = soreserve(so, siz, siz);
 397         if (error)
 398                 goto out;
 399
 400         /*
 401          * Steal the socket from userland so that it doesn't close
 402          * unexpectedly.
 403          */
 404         if (so->so_type == SOCK_DGRAM)
 405                 xprt = svc_dg_create(nfsrvd_pool, so, 0, 0);
 406         else
 407                 xprt = svc_vc_create(nfsrvd_pool, so, 0, 0);
 408         if (xprt) {
 409                 fp->f_ops = &badfileops;
 410                 fp->f_data = NULL;
 411                 xprt->xp_sockref = ++sockref;
 412                 if (nfs_minvers == NFS_VER2)
 413                         svc_reg(xprt, NFS_PROG, NFS_VER2, nfssvc_program,
 414                             NULL);
 415                 if (nfs_minvers <= NFS_VER3 && nfs_maxvers >= NFS_VER3)
 416                         svc_reg(xprt, NFS_PROG, NFS_VER3, nfssvc_program,
 417                             NULL);
 418                 if (nfs_maxvers >= NFS_VER4)
 419                         svc_reg(xprt, NFS_PROG, NFS_VER4, nfssvc_program,
 420                             NULL);
 421                 if (so->so_type == SOCK_STREAM)
 422                         svc_loss_reg(xprt, nfssvc_loss);
 423                 SVC_RELEASE(xprt);
 424         }
 425
 426 out:
 427         NFSEXITCODE(error);
 428         return (error);
 429 }
 430
 431 /*
 432  * Called by nfssvc() for nfsds. Just loops around servicing rpc requests
 433  * until it is killed by a signal.
 434  */
 435 int
 436 nfsrvd_nfsd(struct thread *td, struct nfsd_nfsd_args *args)
 437 {
 438         char principal[MAXHOSTNAMELEN + 5];
 439         int error = 0;
 440         bool_t ret2, ret3, ret4;
 441
 442         error = copyinstr(args->principal, principal, sizeof (principal),
 443             NULL);
 444         if (error)
 445                 goto out;
 446
 447         /*
 448          * Only the first nfsd actually does any work. The RPC code
 449          * adds threads to it as needed. Any extra processes offered
 450          * by nfsd just exit. If nfsd is new enough, it will call us
 451          * once with a structure that specifies how many threads to
 452          * use.
 453          */
 454         NFSD_LOCK();
 455         if (newnfs_numnfsd == 0) {
 456                 newnfs_numnfsd++;
 457
 458                 NFSD_UNLOCK();
 459
 460                 /* An empty string implies AUTH_SYS only. */
 461                 if (principal[0] != '\0') {
 462                         ret2 = rpc_gss_set_svc_name_call(principal,
 463                             "kerberosv5", GSS_C_INDEFINITE, NFS_PROG, NFS_VER2);
 464                         ret3 = rpc_gss_set_svc_name_call(principal,
 465                             "kerberosv5", GSS_C_INDEFINITE, NFS_PROG, NFS_VER3);
 466                         ret4 = rpc_gss_set_svc_name_call(principal,
 467                             "kerberosv5", GSS_C_INDEFINITE, NFS_PROG, NFS_VER4);
 468
 469                         if (!ret2 || !ret3 || !ret4)
 470                                 printf("nfsd: can't register svc name\n");
 471                 }
 472
 473                 nfsrvd_pool->sp_minthreads = args->minthreads;
 474                 nfsrvd_pool->sp_maxthreads = args->maxthreads;
 475
 476                 svc_run(nfsrvd_pool);
 477
 478                 if (principal[0] != '\0') {
 479                         rpc_gss_clear_svc_name_call(NFS_PROG, NFS_VER2);
 480                         rpc_gss_clear_svc_name_call(NFS_PROG, NFS_VER3);
 481                         rpc_gss_clear_svc_name_call(NFS_PROG, NFS_VER4);
 482                 }
 483
 484                 NFSD_LOCK();
 485                 newnfs_numnfsd--;
 486                 nfsrvd_init(1);
 487         }
 488         NFSD_UNLOCK();
 489
 490 out:
 491         NFSEXITCODE(error);
 492         return (error);
 493 }
 494
 495 /*
 496  * Initialize the data structures for the server.
 497  * Handshake with any new nfsds starting up to avoid any chance of
 498  * corruption.
 499  */
 500 void
 501 nfsrvd_init(int terminating)
 502 {
 503
 504         NFSD_LOCK_ASSERT();
 505
 506         if (terminating) {
 507                 nfsd_master_proc = NULL;
 508                 NFSD_UNLOCK();
 509                 svcpool_destroy(nfsrvd_pool);
 510                 nfsrvd_pool = NULL;
 511                 NFSD_LOCK();
 512         }
 513
 514         NFSD_UNLOCK();
 515
 516         nfsrvd_pool = svcpool_create("nfsd", SYSCTL_STATIC_CHILDREN(_vfs_nfsd));
 517         nfsrvd_pool->sp_rcache = NULL;
 518         nfsrvd_pool->sp_assign = fhanew_assign;
 519         nfsrvd_pool->sp_done = fha_nd_complete;
 520
 521         NFSD_LOCK();
 522 }
 523