2 * Copyright (c) 2009 Rick Macklem, University of Guelph
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/param.h>
29 #include <sys/errno.h>
30 #include <sys/linker.h>
31 #include <sys/module.h>
32 #include <sys/mount.h>
33 #include <sys/socket.h>
34 #include <sys/socketvar.h>
35 #include <sys/sysctl.h>
37 #include <sys/ucred.h>
38 #include <sys/vnode.h>
41 #include <netinet/in.h>
43 #include <arpa/inet.h>
45 #include <nfs/nfssvc.h>
49 #include <fs/nfs/rpcv2.h>
50 #include <fs/nfs/nfsproto.h>
51 #include <fs/nfs/nfskpiport.h>
52 #include <fs/nfs/nfs.h>
67 * This program loads the password and group databases into the kernel
71 static void cleanup_term(int);
72 static void usage(void);
73 static void nfsuserdsrv(struct svc_req *, SVCXPRT *);
74 static bool_t xdr_getid(XDR *, caddr_t);
75 static bool_t xdr_getname(XDR *, caddr_t);
76 static bool_t xdr_retval(XDR *, caddr_t);
77 static int nfsbind_localhost(void);
80 #define MAXNFSUSERD 20
82 #define MAXUSERMAX 100000
84 #define DEFUSERMAX 200
85 #define DEFUSERTIMEOUT (1 * 60)
89 char name[MAXNAME + 1];
92 u_char *dnsname = "default.domain";
93 u_char *defaultuser = "nobody";
94 uid_t defaultuid = 65534;
95 u_char *defaultgroup = "nogroup";
96 gid_t defaultgid = 65533;
97 int verbose = 0, im_a_server = 0, nfsuserdcnt = -1, forcestart = 0;
98 int defusertimeout = DEFUSERTIMEOUT, manage_gids = 0;
99 pid_t servers[MAXNFSUSERD];
100 static struct sockaddr_storage fromip;
102 static struct in6_addr in6loopback = IN6ADDR_LOOPBACK_INIT;
106 main(int argc, char *argv[])
109 int error, fnd_dup, len, mustfreeai = 0, start_uidpos;
110 struct nfsd_idargs nid;
115 struct nfsuserd_args nargs;
117 char hostname[MAXHOSTNAMELEN + 1], *cp;
118 struct addrinfo *aip, hints;
119 static uid_t check_dups[MAXUSERMAX];
123 struct sockaddr_in *sin;
126 struct sockaddr_in6 *sin6;
131 if (modfind("nfscommon") < 0) {
132 /* Not present in kernel, try loading it */
133 if (kldload("nfscommon") < 0 ||
134 modfind("nfscommon") < 0)
135 errx(1, "Experimental nfs subsystem is not available");
139 * First, figure out what our domain name and Kerberos Realm
140 * seem to be. Command line args may override these later.
142 if (gethostname(hostname, MAXHOSTNAMELEN) == 0) {
143 if ((cp = strchr(hostname, '.')) != NULL &&
147 memset((void *)&hints, 0, sizeof (hints));
148 hints.ai_flags = AI_CANONNAME;
149 error = getaddrinfo(hostname, NULL, &hints, &aip);
151 if (aip->ai_canonname != NULL &&
152 (cp = strchr(aip->ai_canonname, '.')) != NULL
153 && *(cp + 1) != '\0') {
164 * See if this server handles IPv4 or IPv6 and set up the default
169 s = socket(PF_INET6, SOCK_DGRAM, 0);
171 fromip.ss_family = AF_INET6;
172 fromip.ss_len = sizeof(struct sockaddr_in6);
173 sin6 = (struct sockaddr_in6 *)&fromip;
174 sin6->sin6_addr = in6loopback;
180 s = socket(PF_INET, SOCK_DGRAM, 0);
182 fromip.ss_family = AF_INET;
183 fromip.ss_len = sizeof(struct sockaddr_in);
184 sin = (struct sockaddr_in *)&fromip;
185 sin->sin_addr.s_addr = htonl(INADDR_LOOPBACK);
191 err(1, "Can't create a inet/inet6 socket");
193 nid.nid_usermax = DEFUSERMAX;
194 nid.nid_usertimeout = defusertimeout;
199 if (!strcmp(*argv, "-domain")) {
204 strncpy(hostname, *argv, MAXHOSTNAMELEN);
205 hostname[MAXHOSTNAMELEN] = '\0';
207 } else if (!strcmp(*argv, "-verbose")) {
209 } else if (!strcmp(*argv, "-force")) {
211 } else if (!strcmp(*argv, "-manage-gids")) {
213 } else if (!strcmp(*argv, "-usermax")) {
219 if (i < MINUSERMAX || i > MAXUSERMAX) {
221 "usermax %d out of range %d<->%d\n", i,
222 MINUSERMAX, MAXUSERMAX);
226 } else if (!strcmp(*argv, "-usertimeout")) {
232 if (i < 0 || i > 100000) {
234 "usertimeout %d out of range 0<->100000\n",
238 nid.nid_usertimeout = defusertimeout = i * 60;
239 } else if (nfsuserdcnt == -1) {
240 nfsuserdcnt = atoi(*argv);
243 if (nfsuserdcnt > MAXNFSUSERD) {
244 warnx("nfsuserd count %d; reset to %d",
245 nfsuserdcnt, DEFNFSUSERD);
246 nfsuserdcnt = DEFNFSUSERD;
255 nfsuserdcnt = DEFNFSUSERD;
258 * Strip off leading and trailing '.'s in domain name and map
259 * alphabetics to lower case.
261 while (*dnsname == '.')
263 if (*dnsname == '\0')
264 errx(1, "Domain name all '.'");
265 len = strlen(dnsname);
266 cp = dnsname + len - 1;
272 for (i = 0; i < len; i++) {
273 if (!isascii(dnsname[i]))
274 errx(1, "Domain name has non-ascii char");
275 if (isupper(dnsname[i]))
276 dnsname[i] = tolower(dnsname[i]);
280 * If the nfsuserd died off ungracefully, this is necessary to
281 * get them to start again.
283 if (forcestart && nfssvc(NFSSVC_NFSUSERDDELPORT, NULL) < 0)
284 errx(1, "Can't do nfssvc() to delete the port");
288 "nfsuserd: domain=%s usermax=%d usertimeout=%d\n",
289 dnsname, nid.nid_usermax, nid.nid_usertimeout);
291 for (i = 0; i < nfsuserdcnt; i++)
292 servers[i] = (pid_t)-1;
294 nargs.nuserd_family = fromip.ss_family;
296 * Set up the service port to accept requests via UDP from
297 * localhost (INADDR_LOOPBACK or IN6ADDR_LOOPBACK_INIT).
299 if ((sock = socket(nargs.nuserd_family, SOCK_DGRAM, IPPROTO_UDP)) < 0)
300 err(1, "cannot create udp socket");
303 * Not sure what this does, so I'll leave it here for now.
305 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &one, sizeof(one));
307 if ((udptransp = svcudp_create(sock)) == NULL)
308 err(1, "Can't set up socket");
311 * By not specifying a protocol, it is linked into the
312 * dispatch queue, but not registered with portmapper,
313 * which is just what I want.
315 if (!svc_register(udptransp, RPCPROG_NFSUSERD, RPCNFSUSERD_VERS,
317 err(1, "Can't register nfsuserd");
320 * Tell the kernel what my port# is.
322 nargs.nuserd_port = htons(udptransp->xp_port);
324 printf("portnum=0x%x\n", nargs.nuserd_port);
326 if (nfssvc(NFSSVC_NFSUSERDPORT | NFSSVC_NEWSTRUCT, &nargs) < 0) {
327 if (errno == EPERM) {
329 jailed_size = sizeof(jailed);
330 sysctlbyname("security.jail.jailed", &jailed,
331 &jailed_size, NULL, 0);
333 fprintf(stderr, "Cannot start nfsuserd. "
334 "allow.nfsd might not be configured\n");
336 fprintf(stderr, "Cannot start nfsuserd "
337 "when already running.");
338 fprintf(stderr, " If not running, "
339 "use the -force option.\n");
342 fprintf(stderr, "Can't do nfssvc() to add port\n");
348 pwd = getpwnam(defaultuser);
350 nid.nid_uid = pwd->pw_uid;
352 nid.nid_uid = defaultuid;
353 grp = getgrnam(defaultgroup);
355 nid.nid_gid = grp->gr_gid;
357 nid.nid_gid = defaultgid;
358 nid.nid_name = dnsname;
359 nid.nid_namelen = strlen(nid.nid_name);
362 nid.nid_flag = NFSID_INITIALIZE;
364 printf("Initialize uid=%d gid=%d dns=%s\n", nid.nid_uid, nid.nid_gid,
367 error = nfssvc(NFSSVC_IDNAME | NFSSVC_NEWSTRUCT, &nid);
369 errx(1, "Can't initialize nfs user/groups");
374 * Loop around adding all groups.
377 while (i < nid.nid_usermax && (grp = getgrent())) {
378 nid.nid_gid = grp->gr_gid;
379 nid.nid_name = grp->gr_name;
380 nid.nid_namelen = strlen(grp->gr_name);
383 nid.nid_flag = NFSID_ADDGID;
385 printf("add gid=%d name=%s\n", nid.nid_gid, nid.nid_name);
387 error = nfssvc(NFSSVC_IDNAME | NFSSVC_NEWSTRUCT, &nid);
389 errx(1, "Can't add group %s", grp->gr_name);
396 * Loop around adding all users.
400 while (i < nid.nid_usermax && (pwd = getpwent())) {
403 * Yes, this is inefficient, but it is only done once when
404 * the daemon is started and will run in a fraction of a second
405 * for nid_usermax at 10000. If nid_usermax is cranked up to
406 * 100000, it will take several seconds, depending on the CPU.
408 for (j = 0; j < (i - start_uidpos); j++)
409 if (check_dups[j] == pwd->pw_uid) {
410 /* Found another entry for uid, so skip it */
416 check_dups[i - start_uidpos] = pwd->pw_uid;
417 nid.nid_uid = pwd->pw_uid;
418 nid.nid_name = pwd->pw_name;
419 nid.nid_namelen = strlen(pwd->pw_name);
420 if (manage_gids != 0) {
421 /* Get the group list for this user. */
423 if (getgrouplist(pwd->pw_name, pwd->pw_gid, grps,
425 syslog(LOG_ERR, "Group list too small");
426 nid.nid_ngroup = ngroup;
432 nid.nid_flag = NFSID_ADDUID;
434 printf("add uid=%d name=%s\n", nid.nid_uid, nid.nid_name);
436 error = nfssvc(NFSSVC_IDNAME | NFSSVC_NEWSTRUCT, &nid);
438 errx(1, "Can't add user %s", pwd->pw_name);
445 * I should feel guilty for not calling this for all the above exit()
446 * upon error cases, but I don't.
455 * Temporarily block SIGUSR1 and SIGCHLD, so servers[] can't
458 sigemptyset(&signew);
459 sigaddset(&signew, SIGUSR1);
460 sigaddset(&signew, SIGCHLD);
461 sigprocmask(SIG_BLOCK, &signew, NULL);
464 (void)signal(SIGHUP, SIG_IGN);
465 (void)signal(SIGINT, SIG_IGN);
466 (void)signal(SIGQUIT, SIG_IGN);
467 (void)signal(SIGTERM, SIG_IGN);
468 (void)signal(SIGUSR1, cleanup_term);
469 (void)signal(SIGCHLD, cleanup_term);
471 openlog("nfsuserd:", LOG_PID, LOG_DAEMON);
474 * Fork off the server daemons that do the work. All the master
475 * does is terminate them and cleanup.
477 for (i = 0; i < nfsuserdcnt; i++) {
479 if (servers[i] == 0) {
481 setproctitle("server");
482 sigemptyset(&signew);
483 sigaddset(&signew, SIGUSR1);
484 sigprocmask(SIG_UNBLOCK, &signew, NULL);
490 syslog(LOG_ERR, "nfsuserd died: %m");
492 } else if (servers[i] < 0) {
493 syslog(LOG_ERR, "fork: %m");
498 * Just wait for SIGUSR1 or a child to die and then...
499 * As the Governor of California would say, "Terminate them".
501 setproctitle("master");
502 sigemptyset(&signew);
508 * The nfsuserd rpc service
511 nfsuserdsrv(struct svc_req *rqstp, SVCXPRT *transp)
516 #if defined(INET) || defined(INET6)
521 struct nfsd_idargs nid;
525 struct sockaddr_in *fromsin, *sin;
528 struct sockaddr_in6 *fromsin6, *sin6;
529 char buf[INET6_ADDRSTRLEN];
533 * Only handle requests from localhost on a reserved port number.
534 * If the upcall is from a different address, call nfsbind_localhost()
535 * to check for a remapping of localhost, due to jails.
536 * (Since a reserved port # at localhost implies a client with
537 * local root, there won't be a security breach. This is about
538 * the only case I can think of where a reserved port # means
541 if (rqstp->rq_proc != NULLPROC) {
542 switch (fromip.ss_family) {
545 if (transp->xp_rtaddr.len < sizeof(*sin)) {
546 syslog(LOG_ERR, "xp_rtaddr too small");
547 svcerr_weakauth(transp);
550 sin = (struct sockaddr_in *)transp->xp_rtaddr.buf;
551 fromsin = (struct sockaddr_in *)&fromip;
552 sport = ntohs(sin->sin_port);
553 if (sport >= IPPORT_RESERVED) {
554 syslog(LOG_ERR, "not a reserved port#");
555 svcerr_weakauth(transp);
559 if (sin->sin_addr.s_addr != fromsin->sin_addr.s_addr)
560 ret = nfsbind_localhost();
561 if (ret == 0 || sin->sin_addr.s_addr !=
562 fromsin->sin_addr.s_addr) {
563 syslog(LOG_ERR, "bad from ip %s",
564 inet_ntoa(sin->sin_addr));
565 svcerr_weakauth(transp);
572 if (transp->xp_rtaddr.len < sizeof(*sin6)) {
573 syslog(LOG_ERR, "xp_rtaddr too small");
574 svcerr_weakauth(transp);
577 sin6 = (struct sockaddr_in6 *)transp->xp_rtaddr.buf;
578 fromsin6 = (struct sockaddr_in6 *)&fromip;
579 sport = ntohs(sin6->sin6_port);
580 if (sport >= IPV6PORT_RESERVED) {
581 syslog(LOG_ERR, "not a reserved port#");
582 svcerr_weakauth(transp);
586 if (!IN6_ARE_ADDR_EQUAL(&sin6->sin6_addr,
587 &fromsin6->sin6_addr))
588 ret = nfsbind_localhost();
589 if (ret == 0 || !IN6_ARE_ADDR_EQUAL(&sin6->sin6_addr,
590 &fromsin6->sin6_addr)) {
591 if (inet_ntop(AF_INET6, &sin6->sin6_addr, buf,
592 INET6_ADDRSTRLEN) != NULL)
593 syslog(LOG_ERR, "bad from ip %s", buf);
595 syslog(LOG_ERR, "bad from ip6 addr");
596 svcerr_weakauth(transp);
603 switch (rqstp->rq_proc) {
605 if (!svc_sendreply(transp, (xdrproc_t)xdr_void, NULL))
606 syslog(LOG_ERR, "Can't send reply");
608 case RPCNFSUSERD_GETUID:
609 if (!svc_getargs(transp, (xdrproc_t)xdr_getid,
611 svcerr_decode(transp);
614 pwd = getpwuid((uid_t)info.id);
617 nid.nid_usertimeout = defusertimeout;
618 nid.nid_uid = pwd->pw_uid;
619 nid.nid_name = pwd->pw_name;
620 if (manage_gids != 0) {
621 /* Get the group list for this user. */
623 if (getgrouplist(pwd->pw_name, pwd->pw_gid,
625 syslog(LOG_ERR, "Group list too small");
626 nid.nid_ngroup = ngroup;
633 nid.nid_usertimeout = 5;
634 nid.nid_uid = (uid_t)info.id;
635 nid.nid_name = defaultuser;
639 nid.nid_namelen = strlen(nid.nid_name);
640 nid.nid_flag = NFSID_ADDUID;
641 error = nfssvc(NFSSVC_IDNAME | NFSSVC_NEWSTRUCT, &nid);
644 syslog(LOG_ERR, "Can't add user %s\n", pwd->pw_name);
645 } else if (verbose) {
646 syslog(LOG_ERR,"Added uid=%d name=%s\n",
647 nid.nid_uid, nid.nid_name);
649 if (!svc_sendreply(transp, (xdrproc_t)xdr_retval,
651 syslog(LOG_ERR, "Can't send reply");
653 case RPCNFSUSERD_GETGID:
654 if (!svc_getargs(transp, (xdrproc_t)xdr_getid,
656 svcerr_decode(transp);
659 grp = getgrgid((gid_t)info.id);
662 nid.nid_usertimeout = defusertimeout;
663 nid.nid_gid = grp->gr_gid;
664 nid.nid_name = grp->gr_name;
666 nid.nid_usertimeout = 5;
667 nid.nid_gid = (gid_t)info.id;
668 nid.nid_name = defaultgroup;
670 nid.nid_namelen = strlen(nid.nid_name);
673 nid.nid_flag = NFSID_ADDGID;
674 error = nfssvc(NFSSVC_IDNAME | NFSSVC_NEWSTRUCT, &nid);
677 syslog(LOG_ERR, "Can't add group %s\n",
679 } else if (verbose) {
680 syslog(LOG_ERR,"Added gid=%d name=%s\n",
681 nid.nid_gid, nid.nid_name);
683 if (!svc_sendreply(transp, (xdrproc_t)xdr_retval,
685 syslog(LOG_ERR, "Can't send reply");
687 case RPCNFSUSERD_GETUSER:
688 if (!svc_getargs(transp, (xdrproc_t)xdr_getname,
690 svcerr_decode(transp);
693 pwd = getpwnam(info.name);
696 nid.nid_usertimeout = defusertimeout;
697 nid.nid_uid = pwd->pw_uid;
698 nid.nid_name = pwd->pw_name;
700 nid.nid_usertimeout = 5;
701 nid.nid_uid = defaultuid;
702 nid.nid_name = info.name;
704 nid.nid_namelen = strlen(nid.nid_name);
707 nid.nid_flag = NFSID_ADDUSERNAME;
708 error = nfssvc(NFSSVC_IDNAME | NFSSVC_NEWSTRUCT, &nid);
711 syslog(LOG_ERR, "Can't add user %s\n", pwd->pw_name);
712 } else if (verbose) {
713 syslog(LOG_ERR,"Added uid=%d name=%s\n",
714 nid.nid_uid, nid.nid_name);
716 if (!svc_sendreply(transp, (xdrproc_t)xdr_retval,
718 syslog(LOG_ERR, "Can't send reply");
720 case RPCNFSUSERD_GETGROUP:
721 if (!svc_getargs(transp, (xdrproc_t)xdr_getname,
723 svcerr_decode(transp);
726 grp = getgrnam(info.name);
729 nid.nid_usertimeout = defusertimeout;
730 nid.nid_gid = grp->gr_gid;
731 nid.nid_name = grp->gr_name;
733 nid.nid_usertimeout = 5;
734 nid.nid_gid = defaultgid;
735 nid.nid_name = info.name;
737 nid.nid_namelen = strlen(nid.nid_name);
740 nid.nid_flag = NFSID_ADDGROUPNAME;
741 error = nfssvc(NFSSVC_IDNAME | NFSSVC_NEWSTRUCT, &nid);
744 syslog(LOG_ERR, "Can't add group %s\n",
746 } else if (verbose) {
747 syslog(LOG_ERR,"Added gid=%d name=%s\n",
748 nid.nid_gid, nid.nid_name);
750 if (!svc_sendreply(transp, (xdrproc_t)xdr_retval,
752 syslog(LOG_ERR, "Can't send reply");
755 svcerr_noproc(transp);
761 * Xdr routine to get an id number
764 xdr_getid(XDR *xdrsp, caddr_t cp)
766 struct info *ifp = (struct info *)cp;
768 return (xdr_long(xdrsp, &ifp->id));
772 * Xdr routine to get a user name
775 xdr_getname(XDR *xdrsp, caddr_t cp)
777 struct info *ifp = (struct info *)cp;
780 if (!xdr_long(xdrsp, &len))
784 if (!xdr_opaque(xdrsp, ifp->name, len))
786 ifp->name[len] = '\0';
791 * Xdr routine to return the value.
794 xdr_retval(XDR *xdrsp, caddr_t cp)
796 struct info *ifp = (struct info *)cp;
800 return (xdr_long(xdrsp, &val));
804 * cleanup_term() called via SIGUSR1.
807 cleanup_term(int signo __unused)
815 * Ok, so I'm the master.
816 * As the Governor of California might say, "Terminate them".
819 for (i = 0; i < nfsuserdcnt; i++) {
820 if (servers[i] != (pid_t)-1) {
822 kill(servers[i], SIGUSR1);
827 * and wait for them to die
829 for (i = 0; i < cnt; i++)
830 wait3(NULL, 0, NULL);
833 * Finally, get rid of the socket
835 if (nfssvc(NFSSVC_NFSUSERDDELPORT, NULL) < 0) {
836 syslog(LOG_ERR, "Can't do nfssvc() to delete the port\n");
843 * Get the IP address that the localhost address maps to.
844 * This is needed when jails map localhost to another IP address.
847 nfsbind_localhost(void)
850 struct sockaddr_in sin;
853 struct sockaddr_in6 sin6;
858 switch (fromip.ss_family) {
861 s = socket(PF_INET6, SOCK_DGRAM, 0);
864 memset(&sin6, 0, sizeof(sin6));
865 sin6.sin6_len = sizeof(sin6);
866 sin6.sin6_family = AF_INET6;
867 sin6.sin6_addr = in6loopback;
869 ret = bind(s, (struct sockaddr *)&sin6, sizeof(sin6));
878 s = socket(PF_INET, SOCK_DGRAM, 0);
881 memset(&sin, 0, sizeof(sin));
882 sin.sin_len = sizeof(sin);
883 sin.sin_family = AF_INET;
884 sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
886 ret = bind(s, (struct sockaddr *)&sin, sizeof(sin));
894 memset(&fromip, 0, sizeof(fromip));
895 slen = sizeof(fromip);
896 ret = getsockname(s, (struct sockaddr *)&fromip, &slen);
908 "usage: nfsuserd [-usermax cache_size] [-usertimeout minutes] [-verbose] [-manage-gids] [-domain domain_name] [n]");