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