xref: /freebsd/lib/libutil/pw_util.c (revision c6ec7d31830ab1c80edae95ad5e4b9dba10c47ac)
1 /*-
2  * Copyright (c) 1990, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  * Copyright (c) 2002 Networks Associates Technology, Inc.
5  * All rights reserved.
6  *
7  * Portions of this software were developed for the FreeBSD Project by
8  * ThinkSec AS and NAI Labs, the Security Research Division of Network
9  * Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
10  * ("CBOSS"), as part of the DARPA CHATS research program.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #ifndef lint
38 #if 0
39 static const char sccsid[] = "@(#)pw_util.c	8.3 (Berkeley) 4/2/94";
40 #endif
41 static const char rcsid[] =
42   "$FreeBSD$";
43 #endif /* not lint */
44 
45 /*
46  * This file is used by all the "password" programs; vipw(8), chpass(1),
47  * and passwd(1).
48  */
49 
50 #include <sys/param.h>
51 #include <sys/errno.h>
52 #include <sys/time.h>
53 #include <sys/resource.h>
54 #include <sys/stat.h>
55 #include <sys/wait.h>
56 
57 #include <ctype.h>
58 #include <err.h>
59 #include <fcntl.h>
60 #include <inttypes.h>
61 #include <libgen.h>
62 #include <paths.h>
63 #include <pwd.h>
64 #include <signal.h>
65 #include <stdio.h>
66 #include <stdlib.h>
67 #include <string.h>
68 #include <unistd.h>
69 
70 #include "libutil.h"
71 
72 static pid_t editpid = -1;
73 static int lockfd = -1;
74 static char masterpasswd[PATH_MAX];
75 static char passwd_dir[PATH_MAX];
76 static char tempname[PATH_MAX];
77 static int initialized;
78 
79 #if 0
80 void
81 pw_cont(int sig)
82 {
83 
84 	if (editpid != -1)
85 		kill(editpid, sig);
86 }
87 #endif
88 
89 /*
90  * Initialize statics and set limits, signals & umask to try to avoid
91  * interruptions, crashes etc. that might expose passord data.
92  */
93 int
94 pw_init(const char *dir, const char *master)
95 {
96 #if 0
97 	struct rlimit rlim;
98 #endif
99 
100 	if (dir == NULL) {
101 		strcpy(passwd_dir, _PATH_ETC);
102 	} else {
103 		if (strlen(dir) >= sizeof(passwd_dir)) {
104 			errno = ENAMETOOLONG;
105 			return (-1);
106 		}
107 		strcpy(passwd_dir, dir);
108 	}
109 
110 	if (master == NULL) {
111 		if (dir == NULL) {
112 			strcpy(masterpasswd, _PATH_MASTERPASSWD);
113 		} else if (snprintf(masterpasswd, sizeof(masterpasswd), "%s/%s",
114 		    passwd_dir, _MASTERPASSWD) > (int)sizeof(masterpasswd)) {
115 			errno = ENAMETOOLONG;
116 			return (-1);
117 		}
118 	} else {
119 		if (strlen(master) >= sizeof(masterpasswd)) {
120 			errno = ENAMETOOLONG;
121 			return (-1);
122 		}
123 		strcpy(masterpasswd, master);
124 	}
125 
126 	/*
127 	 * The code that follows is extremely disruptive to the calling
128 	 * process, and is therefore disabled until someone can conceive
129 	 * of a realistic scenario where it would fend off a compromise.
130 	 * Race conditions concerning the temporary files can be guarded
131 	 * against in other ways than masking signals (by checking stat(2)
132 	 * results after creation).
133 	 */
134 #if 0
135 	/* Unlimited resource limits. */
136 	rlim.rlim_cur = rlim.rlim_max = RLIM_INFINITY;
137 	(void)setrlimit(RLIMIT_CPU, &rlim);
138 	(void)setrlimit(RLIMIT_FSIZE, &rlim);
139 	(void)setrlimit(RLIMIT_STACK, &rlim);
140 	(void)setrlimit(RLIMIT_DATA, &rlim);
141 	(void)setrlimit(RLIMIT_RSS, &rlim);
142 
143 	/* Don't drop core (not really necessary, but GP's). */
144 	rlim.rlim_cur = rlim.rlim_max = 0;
145 	(void)setrlimit(RLIMIT_CORE, &rlim);
146 
147 	/* Turn off signals. */
148 	(void)signal(SIGALRM, SIG_IGN);
149 	(void)signal(SIGHUP, SIG_IGN);
150 	(void)signal(SIGINT, SIG_IGN);
151 	(void)signal(SIGPIPE, SIG_IGN);
152 	(void)signal(SIGQUIT, SIG_IGN);
153 	(void)signal(SIGTERM, SIG_IGN);
154 	(void)signal(SIGCONT, pw_cont);
155 
156 	/* Create with exact permissions. */
157 	(void)umask(0);
158 #endif
159 	initialized = 1;
160 	return (0);
161 }
162 
163 /*
164  * Lock the master password file.
165  */
166 int
167 pw_lock(void)
168 {
169 
170 	if (*masterpasswd == '\0')
171 		return (-1);
172 
173 	/*
174 	 * If the master password file doesn't exist, the system is hosed.
175 	 * Might as well try to build one.  Set the close-on-exec bit so
176 	 * that users can't get at the encrypted passwords while editing.
177 	 * Open should allow flock'ing the file; see 4.4BSD.	XXX
178 	 */
179 	for (;;) {
180 		struct stat st;
181 
182 		lockfd = open(masterpasswd, O_RDONLY, 0);
183 		if (lockfd < 0 || fcntl(lockfd, F_SETFD, 1) == -1)
184 			err(1, "%s", masterpasswd);
185 		/* XXX vulnerable to race conditions */
186 		if (flock(lockfd, LOCK_EX|LOCK_NB) == -1) {
187 			if (errno == EWOULDBLOCK) {
188 				errx(1, "the password db file is busy");
189 			} else {
190 				err(1, "could not lock the passwd file: ");
191 			}
192 		}
193 
194 		/*
195 		 * If the password file was replaced while we were trying to
196 		 * get the lock, our hardlink count will be 0 and we have to
197 		 * close and retry.
198 		 */
199 		if (fstat(lockfd, &st) == -1)
200 			err(1, "fstat() failed: ");
201 		if (st.st_nlink != 0)
202 			break;
203 		close(lockfd);
204 		lockfd = -1;
205 	}
206 	return (lockfd);
207 }
208 
209 /*
210  * Create and open a presumably safe temp file for editing the password
211  * data, and copy the master password file into it.
212  */
213 int
214 pw_tmp(int mfd)
215 {
216 	char buf[8192];
217 	ssize_t nr;
218 	const char *p;
219 	int tfd;
220 
221 	if (*masterpasswd == '\0')
222 		return (-1);
223 	if ((p = strrchr(masterpasswd, '/')))
224 		++p;
225 	else
226 		p = masterpasswd;
227 	if (snprintf(tempname, sizeof(tempname), "%.*spw.XXXXXX",
228 		(int)(p - masterpasswd), masterpasswd) >= (int)sizeof(tempname)) {
229 		errno = ENAMETOOLONG;
230 		return (-1);
231 	}
232 	if ((tfd = mkstemp(tempname)) == -1)
233 		return (-1);
234 	if (mfd != -1) {
235 		while ((nr = read(mfd, buf, sizeof(buf))) > 0)
236 			if (write(tfd, buf, (size_t)nr) != nr)
237 				break;
238 		if (nr != 0) {
239 			unlink(tempname);
240 			*tempname = '\0';
241 			close(tfd);
242 			return (-1);
243 		}
244 	}
245 	return (tfd);
246 }
247 
248 /*
249  * Regenerate the password database.
250  */
251 int
252 pw_mkdb(const char *user)
253 {
254 	int pstat;
255 	pid_t pid;
256 
257 	(void)fflush(stderr);
258 	switch ((pid = fork())) {
259 	case -1:
260 		return (-1);
261 	case 0:
262 		/* child */
263 		if (user == NULL)
264 			execl(_PATH_PWD_MKDB, "pwd_mkdb", "-p",
265 			    "-d", passwd_dir, tempname, (char *)NULL);
266 		else
267 			execl(_PATH_PWD_MKDB, "pwd_mkdb", "-p",
268 			    "-d", passwd_dir, "-u", user, tempname,
269 			    (char *)NULL);
270 		_exit(1);
271 		/* NOTREACHED */
272 	default:
273 		/* parent */
274 		break;
275 	}
276 	if (waitpid(pid, &pstat, 0) == -1)
277 		return (-1);
278 	if (WIFEXITED(pstat) && WEXITSTATUS(pstat) == 0)
279 		return (0);
280 	errno = 0;
281 	return (-1);
282 }
283 
284 /*
285  * Edit the temp file.  Return -1 on error, >0 if the file was modified, 0
286  * if it was not.
287  */
288 int
289 pw_edit(int notsetuid)
290 {
291 	struct sigaction sa, sa_int, sa_quit;
292 	sigset_t oldsigset, nsigset;
293 	struct stat st1, st2;
294 	const char *editor;
295 	int pstat;
296 
297 	if ((editor = getenv("EDITOR")) == NULL)
298 		editor = _PATH_VI;
299 	if (stat(tempname, &st1) == -1)
300 		return (-1);
301 	sa.sa_handler = SIG_IGN;
302 	sigemptyset(&sa.sa_mask);
303 	sa.sa_flags = 0;
304 	sigaction(SIGINT, &sa, &sa_int);
305 	sigaction(SIGQUIT, &sa, &sa_quit);
306 	sigemptyset(&nsigset);
307 	sigaddset(&nsigset, SIGCHLD);
308 	sigprocmask(SIG_BLOCK, &nsigset, &oldsigset);
309 	switch ((editpid = fork())) {
310 	case -1:
311 		return (-1);
312 	case 0:
313 		sigaction(SIGINT, &sa_int, NULL);
314 		sigaction(SIGQUIT, &sa_quit, NULL);
315 		sigprocmask(SIG_SETMASK, &oldsigset, NULL);
316 		if (notsetuid) {
317 			(void)setgid(getgid());
318 			(void)setuid(getuid());
319 		}
320 		errno = 0;
321 		execlp(editor, basename(editor), tempname, (char *)NULL);
322 		_exit(errno);
323 	default:
324 		/* parent */
325 		break;
326 	}
327 	for (;;) {
328 		if (waitpid(editpid, &pstat, WUNTRACED) == -1) {
329 			if (errno == EINTR)
330 				continue;
331 			unlink(tempname);
332 			editpid = -1;
333 			break;
334 		} else if (WIFSTOPPED(pstat)) {
335 			raise(WSTOPSIG(pstat));
336 		} else if (WIFEXITED(pstat) && WEXITSTATUS(pstat) == 0) {
337 			editpid = -1;
338 			break;
339 		} else {
340 			unlink(tempname);
341 			editpid = -1;
342 			break;
343 		}
344 	}
345 	sigaction(SIGINT, &sa_int, NULL);
346 	sigaction(SIGQUIT, &sa_quit, NULL);
347 	sigprocmask(SIG_SETMASK, &oldsigset, NULL);
348 	if (stat(tempname, &st2) == -1)
349 		return (-1);
350 	return (st1.st_mtim.tv_sec != st2.st_mtim.tv_sec ||
351 	    st1.st_mtim.tv_nsec != st2.st_mtim.tv_nsec);
352 }
353 
354 /*
355  * Clean up.  Preserve errno for the caller's convenience.
356  */
357 void
358 pw_fini(void)
359 {
360 	int serrno, status;
361 
362 	if (!initialized)
363 		return;
364 	initialized = 0;
365 	serrno = errno;
366 	if (editpid != -1) {
367 		kill(editpid, SIGTERM);
368 		kill(editpid, SIGCONT);
369 		waitpid(editpid, &status, 0);
370 		editpid = -1;
371 	}
372 	if (*tempname != '\0') {
373 		unlink(tempname);
374 		*tempname = '\0';
375 	}
376 	if (lockfd != -1)
377 		close(lockfd);
378 	errno = serrno;
379 }
380 
381 /*
382  * Compares two struct pwds.
383  */
384 int
385 pw_equal(const struct passwd *pw1, const struct passwd *pw2)
386 {
387 	return (strcmp(pw1->pw_name, pw2->pw_name) == 0 &&
388 	    pw1->pw_uid == pw2->pw_uid &&
389 	    pw1->pw_gid == pw2->pw_gid &&
390 	    strcmp(pw1->pw_class, pw2->pw_class) == 0 &&
391 	    pw1->pw_change == pw2->pw_change &&
392 	    pw1->pw_expire == pw2->pw_expire &&
393 	    strcmp(pw1->pw_gecos, pw2->pw_gecos) == 0 &&
394 	    strcmp(pw1->pw_dir, pw2->pw_dir) == 0 &&
395 	    strcmp(pw1->pw_shell, pw2->pw_shell) == 0);
396 }
397 
398 /*
399  * Make a passwd line out of a struct passwd.
400  */
401 char *
402 pw_make(const struct passwd *pw)
403 {
404 	char *line;
405 
406 	asprintf(&line, "%s:%s:%ju:%ju:%s:%ju:%ju:%s:%s:%s", pw->pw_name,
407 	    pw->pw_passwd, (uintmax_t)pw->pw_uid, (uintmax_t)pw->pw_gid,
408 	    pw->pw_class, (uintmax_t)pw->pw_change, (uintmax_t)pw->pw_expire,
409 	    pw->pw_gecos, pw->pw_dir, pw->pw_shell);
410 	return (line);
411 }
412 
413 /*
414  * Make a passwd line (in v7 format) out of a struct passwd
415  */
416 char *
417 pw_make_v7(const struct passwd *pw)
418 {
419 	char *line;
420 
421 	asprintf(&line, "%s:*:%ju:%ju:%s:%s:%s", pw->pw_name,
422 	    (uintmax_t)pw->pw_uid, (uintmax_t)pw->pw_gid,
423 	    pw->pw_gecos, pw->pw_dir, pw->pw_shell);
424 	return (line);
425 }
426 
427 /*
428  * Copy password file from one descriptor to another, replacing, deleting
429  * or adding a single record on the way.
430  */
431 int
432 pw_copy(int ffd, int tfd, const struct passwd *pw, struct passwd *old_pw)
433 {
434 	char buf[8192], *end, *line, *p, *q, *r, t;
435 	struct passwd *fpw;
436 	const struct passwd *spw;
437 	size_t len;
438 	int eof, readlen;
439 
440 	if (old_pw == NULL && pw == NULL)
441 			return (-1);
442 
443 	spw = old_pw;
444 	/* deleting a user */
445 	if (pw == NULL) {
446 		line = NULL;
447 	} else {
448 		if ((line = pw_make(pw)) == NULL)
449 			return (-1);
450 	}
451 
452 	/* adding a user */
453 	if (spw == NULL)
454 		spw = pw;
455 
456 	eof = 0;
457 	len = 0;
458 	p = q = end = buf;
459 	for (;;) {
460 		/* find the end of the current line */
461 		for (p = q; q < end && *q != '\0'; ++q)
462 			if (*q == '\n')
463 				break;
464 
465 		/* if we don't have a complete line, fill up the buffer */
466 		if (q >= end) {
467 			if (eof)
468 				break;
469 			if ((size_t)(q - p) >= sizeof(buf)) {
470 				warnx("passwd line too long");
471 				errno = EINVAL; /* hack */
472 				goto err;
473 			}
474 			if (p < end) {
475 				q = memmove(buf, p, end - p);
476 				end -= p - buf;
477 			} else {
478 				p = q = end = buf;
479 			}
480 			readlen = read(ffd, end, sizeof(buf) - (end - buf));
481 			if (readlen == -1)
482 				goto err;
483 			else
484 				len = (size_t)readlen;
485 			if (len == 0 && p == buf)
486 				break;
487 			end += len;
488 			len = end - buf;
489 			if (len < (ssize_t)sizeof(buf)) {
490 				eof = 1;
491 				if (len > 0 && buf[len - 1] != '\n')
492 					++len, *end++ = '\n';
493 			}
494 			continue;
495 		}
496 
497 		/* is it a blank line or a comment? */
498 		for (r = p; r < q && isspace(*r); ++r)
499 			/* nothing */ ;
500 		if (r == q || *r == '#') {
501 			/* yep */
502 			if (write(tfd, p, q - p + 1) != q - p + 1)
503 				goto err;
504 			++q;
505 			continue;
506 		}
507 
508 		/* is it the one we're looking for? */
509 
510 		t = *q;
511 		*q = '\0';
512 
513 		fpw = pw_scan(r, PWSCAN_MASTER);
514 
515 		/*
516 		 * fpw is either the struct passwd for the current line,
517 		 * or NULL if the line is malformed.
518 		 */
519 
520 		*q = t;
521 		if (fpw == NULL || strcmp(fpw->pw_name, spw->pw_name) != 0) {
522 			/* nope */
523 			if (fpw != NULL)
524 				free(fpw);
525 			if (write(tfd, p, q - p + 1) != q - p + 1)
526 				goto err;
527 			++q;
528 			continue;
529 		}
530 		if (old_pw && !pw_equal(fpw, old_pw)) {
531 			warnx("entry inconsistent");
532 			free(fpw);
533 			errno = EINVAL; /* hack */
534 			goto err;
535 		}
536 		free(fpw);
537 
538 		/* it is, replace or remove it */
539 		if (line != NULL) {
540 			len = strlen(line);
541 			if (write(tfd, line, len) != (int)len)
542 				goto err;
543 		} else {
544 			/* when removed, avoid the \n */
545 			q++;
546 		}
547 		/* we're done, just copy the rest over */
548 		for (;;) {
549 			if (write(tfd, q, end - q) != end - q)
550 				goto err;
551 			q = buf;
552 			readlen = read(ffd, buf, sizeof(buf));
553 			if (readlen == 0)
554 				break;
555 			else
556 				len = (size_t)readlen;
557 			if (readlen == -1)
558 				goto err;
559 			end = buf + len;
560 		}
561 		goto done;
562 	}
563 
564 	/* if we got here, we didn't find the old entry */
565 	if (line == NULL) {
566 		errno = ENOENT;
567 		goto err;
568 	}
569 	len = strlen(line);
570 	if ((size_t)write(tfd, line, len) != len ||
571 	    write(tfd, "\n", 1) != 1)
572 		goto err;
573  done:
574 	if (line != NULL)
575 		free(line);
576 	return (0);
577  err:
578 	if (line != NULL)
579 		free(line);
580 	return (-1);
581 }
582 
583 /*
584  * Return the current value of tempname.
585  */
586 const char *
587 pw_tempname(void)
588 {
589 
590 	return (tempname);
591 }
592 
593 /*
594  * Duplicate a struct passwd.
595  */
596 struct passwd *
597 pw_dup(const struct passwd *pw)
598 {
599 	char *dst;
600 	struct passwd *npw;
601 	ssize_t len;
602 
603 	len = sizeof(*npw);
604 	if (pw->pw_name != NULL)
605 		len += strlen(pw->pw_name) + 1;
606 	if (pw->pw_passwd != NULL)
607 		len += strlen(pw->pw_passwd) + 1;
608 	if (pw->pw_class != NULL)
609 		len += strlen(pw->pw_class) + 1;
610 	if (pw->pw_gecos != NULL)
611 		len += strlen(pw->pw_gecos) + 1;
612 	if (pw->pw_dir != NULL)
613 		len += strlen(pw->pw_dir) + 1;
614 	if (pw->pw_shell != NULL)
615 		len += strlen(pw->pw_shell) + 1;
616 	if ((npw = malloc((size_t)len)) == NULL)
617 		return (NULL);
618 	memcpy(npw, pw, sizeof(*npw));
619 	dst = (char *)npw + sizeof(*npw);
620 	if (pw->pw_name != NULL) {
621 		npw->pw_name = dst;
622 		dst = stpcpy(npw->pw_name, pw->pw_name) + 1;
623 	}
624 	if (pw->pw_passwd != NULL) {
625 		npw->pw_passwd = dst;
626 		dst = stpcpy(npw->pw_passwd, pw->pw_passwd) + 1;
627 	}
628 	if (pw->pw_class != NULL) {
629 		npw->pw_class = dst;
630 		dst = stpcpy(npw->pw_class, pw->pw_class) + 1;
631 	}
632 	if (pw->pw_gecos != NULL) {
633 		npw->pw_gecos = dst;
634 		dst = stpcpy(npw->pw_gecos, pw->pw_gecos) + 1;
635 	}
636 	if (pw->pw_dir != NULL) {
637 		npw->pw_dir = dst;
638 		dst = stpcpy(npw->pw_dir, pw->pw_dir) + 1;
639 	}
640 	if (pw->pw_shell != NULL) {
641 		npw->pw_shell = dst;
642 		dst = stpcpy(npw->pw_shell, pw->pw_shell) + 1;
643 	}
644 	return (npw);
645 }
646 
647 #include "pw_scan.h"
648 
649 /*
650  * Wrapper around an internal libc function
651  */
652 struct passwd *
653 pw_scan(const char *line, int flags)
654 {
655 	struct passwd pw, *ret;
656 	char *bp;
657 
658 	if ((bp = strdup(line)) == NULL)
659 		return (NULL);
660 	if (!__pw_scan(bp, &pw, flags)) {
661 		free(bp);
662 		return (NULL);
663 	}
664 	ret = pw_dup(&pw);
665 	free(bp);
666 	return (ret);
667 }
668