xref: /freebsd/crypto/openssh/auth2-pubkey.c (revision 0183e0151669735d62584fbba9125ed90716af5e)
1 /* $OpenBSD: auth2-pubkey.c,v 1.60 2016/11/30 02:57:40 djm Exp $ */
2 /*
3  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25 
26 #include "includes.h"
27 
28 #include <sys/types.h>
29 #include <sys/stat.h>
30 #include <sys/wait.h>
31 
32 #include <errno.h>
33 #include <fcntl.h>
34 #ifdef HAVE_PATHS_H
35 # include <paths.h>
36 #endif
37 #include <pwd.h>
38 #include <signal.h>
39 #include <stdio.h>
40 #include <stdarg.h>
41 #include <string.h>
42 #include <time.h>
43 #include <unistd.h>
44 #include <limits.h>
45 
46 #include "xmalloc.h"
47 #include "ssh.h"
48 #include "ssh2.h"
49 #include "packet.h"
50 #include "buffer.h"
51 #include "log.h"
52 #include "misc.h"
53 #include "servconf.h"
54 #include "compat.h"
55 #include "key.h"
56 #include "hostfile.h"
57 #include "auth.h"
58 #include "pathnames.h"
59 #include "uidswap.h"
60 #include "auth-options.h"
61 #include "canohost.h"
62 #ifdef GSSAPI
63 #include "ssh-gss.h"
64 #endif
65 #include "monitor_wrap.h"
66 #include "authfile.h"
67 #include "match.h"
68 #include "ssherr.h"
69 #include "channels.h" /* XXX for session.h */
70 #include "session.h" /* XXX for child_set_env(); refactor? */
71 
72 /* import */
73 extern ServerOptions options;
74 extern u_char *session_id2;
75 extern u_int session_id2_len;
76 
77 static int
78 userauth_pubkey(Authctxt *authctxt)
79 {
80 	Buffer b;
81 	Key *key = NULL;
82 	char *pkalg, *userstyle, *fp = NULL;
83 	u_char *pkblob, *sig;
84 	u_int alen, blen, slen;
85 	int have_sig, pktype;
86 	int authenticated = 0;
87 
88 	if (!authctxt->valid) {
89 		debug2("%s: disabled because of invalid user", __func__);
90 		return 0;
91 	}
92 	have_sig = packet_get_char();
93 	if (datafellows & SSH_BUG_PKAUTH) {
94 		debug2("%s: SSH_BUG_PKAUTH", __func__);
95 		/* no explicit pkalg given */
96 		pkblob = packet_get_string(&blen);
97 		buffer_init(&b);
98 		buffer_append(&b, pkblob, blen);
99 		/* so we have to extract the pkalg from the pkblob */
100 		pkalg = buffer_get_string(&b, &alen);
101 		buffer_free(&b);
102 	} else {
103 		pkalg = packet_get_string(&alen);
104 		pkblob = packet_get_string(&blen);
105 	}
106 	pktype = key_type_from_name(pkalg);
107 	if (pktype == KEY_UNSPEC) {
108 		/* this is perfectly legal */
109 		logit("%s: unsupported public key algorithm: %s",
110 		    __func__, pkalg);
111 		goto done;
112 	}
113 	key = key_from_blob(pkblob, blen);
114 	if (key == NULL) {
115 		error("%s: cannot decode key: %s", __func__, pkalg);
116 		goto done;
117 	}
118 	if (key->type != pktype) {
119 		error("%s: type mismatch for decoded key "
120 		    "(received %d, expected %d)", __func__, key->type, pktype);
121 		goto done;
122 	}
123 	if (key_type_plain(key->type) == KEY_RSA &&
124 	    (datafellows & SSH_BUG_RSASIGMD5) != 0) {
125 		logit("Refusing RSA key because client uses unsafe "
126 		    "signature scheme");
127 		goto done;
128 	}
129 	fp = sshkey_fingerprint(key, options.fingerprint_hash, SSH_FP_DEFAULT);
130 	if (auth2_userkey_already_used(authctxt, key)) {
131 		logit("refusing previously-used %s key", key_type(key));
132 		goto done;
133 	}
134 	if (match_pattern_list(sshkey_ssh_name(key),
135 	    options.pubkey_key_types, 0) != 1) {
136 		logit("%s: key type %s not in PubkeyAcceptedKeyTypes",
137 		    __func__, sshkey_ssh_name(key));
138 		goto done;
139 	}
140 
141 	if (have_sig) {
142 		debug3("%s: have signature for %s %s",
143 		    __func__, sshkey_type(key), fp);
144 		sig = packet_get_string(&slen);
145 		packet_check_eom();
146 		buffer_init(&b);
147 		if (datafellows & SSH_OLD_SESSIONID) {
148 			buffer_append(&b, session_id2, session_id2_len);
149 		} else {
150 			buffer_put_string(&b, session_id2, session_id2_len);
151 		}
152 		/* reconstruct packet */
153 		buffer_put_char(&b, SSH2_MSG_USERAUTH_REQUEST);
154 		xasprintf(&userstyle, "%s%s%s", authctxt->user,
155 		    authctxt->style ? ":" : "",
156 		    authctxt->style ? authctxt->style : "");
157 		buffer_put_cstring(&b, userstyle);
158 		free(userstyle);
159 		buffer_put_cstring(&b,
160 		    datafellows & SSH_BUG_PKSERVICE ?
161 		    "ssh-userauth" :
162 		    authctxt->service);
163 		if (datafellows & SSH_BUG_PKAUTH) {
164 			buffer_put_char(&b, have_sig);
165 		} else {
166 			buffer_put_cstring(&b, "publickey");
167 			buffer_put_char(&b, have_sig);
168 			buffer_put_cstring(&b, pkalg);
169 		}
170 		buffer_put_string(&b, pkblob, blen);
171 #ifdef DEBUG_PK
172 		buffer_dump(&b);
173 #endif
174 		pubkey_auth_info(authctxt, key, NULL);
175 
176 		/* test for correct signature */
177 		authenticated = 0;
178 		if (PRIVSEP(user_key_allowed(authctxt->pw, key, 1)) &&
179 		    PRIVSEP(key_verify(key, sig, slen, buffer_ptr(&b),
180 		    buffer_len(&b))) == 1) {
181 			authenticated = 1;
182 			/* Record the successful key to prevent reuse */
183 			auth2_record_userkey(authctxt, key);
184 			key = NULL; /* Don't free below */
185 		}
186 		buffer_free(&b);
187 		free(sig);
188 	} else {
189 		debug("%s: test whether pkalg/pkblob are acceptable for %s %s",
190 		    __func__, sshkey_type(key), fp);
191 		packet_check_eom();
192 
193 		/* XXX fake reply and always send PK_OK ? */
194 		/*
195 		 * XXX this allows testing whether a user is allowed
196 		 * to login: if you happen to have a valid pubkey this
197 		 * message is sent. the message is NEVER sent at all
198 		 * if a user is not allowed to login. is this an
199 		 * issue? -markus
200 		 */
201 		if (PRIVSEP(user_key_allowed(authctxt->pw, key, 0))) {
202 			packet_start(SSH2_MSG_USERAUTH_PK_OK);
203 			packet_put_string(pkalg, alen);
204 			packet_put_string(pkblob, blen);
205 			packet_send();
206 			packet_write_wait();
207 			authctxt->postponed = 1;
208 		}
209 	}
210 	if (authenticated != 1)
211 		auth_clear_options();
212 done:
213 	debug2("%s: authenticated %d pkalg %s", __func__, authenticated, pkalg);
214 	if (key != NULL)
215 		key_free(key);
216 	free(pkalg);
217 	free(pkblob);
218 	free(fp);
219 	return authenticated;
220 }
221 
222 void
223 pubkey_auth_info(Authctxt *authctxt, const Key *key, const char *fmt, ...)
224 {
225 	char *fp, *extra;
226 	va_list ap;
227 	int i;
228 
229 	extra = NULL;
230 	if (fmt != NULL) {
231 		va_start(ap, fmt);
232 		i = vasprintf(&extra, fmt, ap);
233 		va_end(ap);
234 		if (i < 0 || extra == NULL)
235 			fatal("%s: vasprintf failed", __func__);
236 	}
237 
238 	if (key_is_cert(key)) {
239 		fp = sshkey_fingerprint(key->cert->signature_key,
240 		    options.fingerprint_hash, SSH_FP_DEFAULT);
241 		auth_info(authctxt, "%s ID %s (serial %llu) CA %s %s%s%s",
242 		    key_type(key), key->cert->key_id,
243 		    (unsigned long long)key->cert->serial,
244 		    key_type(key->cert->signature_key),
245 		    fp == NULL ? "(null)" : fp,
246 		    extra == NULL ? "" : ", ", extra == NULL ? "" : extra);
247 		free(fp);
248 	} else {
249 		fp = sshkey_fingerprint(key, options.fingerprint_hash,
250 		    SSH_FP_DEFAULT);
251 		auth_info(authctxt, "%s %s%s%s", key_type(key),
252 		    fp == NULL ? "(null)" : fp,
253 		    extra == NULL ? "" : ", ", extra == NULL ? "" : extra);
254 		free(fp);
255 	}
256 	free(extra);
257 }
258 
259 /*
260  * Splits 's' into an argument vector. Handles quoted string and basic
261  * escape characters (\\, \", \'). Caller must free the argument vector
262  * and its members.
263  */
264 static int
265 split_argv(const char *s, int *argcp, char ***argvp)
266 {
267 	int r = SSH_ERR_INTERNAL_ERROR;
268 	int argc = 0, quote, i, j;
269 	char *arg, **argv = xcalloc(1, sizeof(*argv));
270 
271 	*argvp = NULL;
272 	*argcp = 0;
273 
274 	for (i = 0; s[i] != '\0'; i++) {
275 		/* Skip leading whitespace */
276 		if (s[i] == ' ' || s[i] == '\t')
277 			continue;
278 
279 		/* Start of a token */
280 		quote = 0;
281 		if (s[i] == '\\' &&
282 		    (s[i + 1] == '\'' || s[i + 1] == '\"' || s[i + 1] == '\\'))
283 			i++;
284 		else if (s[i] == '\'' || s[i] == '"')
285 			quote = s[i++];
286 
287 		argv = xreallocarray(argv, (argc + 2), sizeof(*argv));
288 		arg = argv[argc++] = xcalloc(1, strlen(s + i) + 1);
289 		argv[argc] = NULL;
290 
291 		/* Copy the token in, removing escapes */
292 		for (j = 0; s[i] != '\0'; i++) {
293 			if (s[i] == '\\') {
294 				if (s[i + 1] == '\'' ||
295 				    s[i + 1] == '\"' ||
296 				    s[i + 1] == '\\') {
297 					i++; /* Skip '\' */
298 					arg[j++] = s[i];
299 				} else {
300 					/* Unrecognised escape */
301 					arg[j++] = s[i];
302 				}
303 			} else if (quote == 0 && (s[i] == ' ' || s[i] == '\t'))
304 				break; /* done */
305 			else if (quote != 0 && s[i] == quote)
306 				break; /* done */
307 			else
308 				arg[j++] = s[i];
309 		}
310 		if (s[i] == '\0') {
311 			if (quote != 0) {
312 				/* Ran out of string looking for close quote */
313 				r = SSH_ERR_INVALID_FORMAT;
314 				goto out;
315 			}
316 			break;
317 		}
318 	}
319 	/* Success */
320 	*argcp = argc;
321 	*argvp = argv;
322 	argc = 0;
323 	argv = NULL;
324 	r = 0;
325  out:
326 	if (argc != 0 && argv != NULL) {
327 		for (i = 0; i < argc; i++)
328 			free(argv[i]);
329 		free(argv);
330 	}
331 	return r;
332 }
333 
334 /*
335  * Reassemble an argument vector into a string, quoting and escaping as
336  * necessary. Caller must free returned string.
337  */
338 static char *
339 assemble_argv(int argc, char **argv)
340 {
341 	int i, j, ws, r;
342 	char c, *ret;
343 	struct sshbuf *buf, *arg;
344 
345 	if ((buf = sshbuf_new()) == NULL || (arg = sshbuf_new()) == NULL)
346 		fatal("%s: sshbuf_new failed", __func__);
347 
348 	for (i = 0; i < argc; i++) {
349 		ws = 0;
350 		sshbuf_reset(arg);
351 		for (j = 0; argv[i][j] != '\0'; j++) {
352 			r = 0;
353 			c = argv[i][j];
354 			switch (c) {
355 			case ' ':
356 			case '\t':
357 				ws = 1;
358 				r = sshbuf_put_u8(arg, c);
359 				break;
360 			case '\\':
361 			case '\'':
362 			case '"':
363 				if ((r = sshbuf_put_u8(arg, '\\')) != 0)
364 					break;
365 				/* FALLTHROUGH */
366 			default:
367 				r = sshbuf_put_u8(arg, c);
368 				break;
369 			}
370 			if (r != 0)
371 				fatal("%s: sshbuf_put_u8: %s",
372 				    __func__, ssh_err(r));
373 		}
374 		if ((i != 0 && (r = sshbuf_put_u8(buf, ' ')) != 0) ||
375 		    (ws != 0 && (r = sshbuf_put_u8(buf, '"')) != 0) ||
376 		    (r = sshbuf_putb(buf, arg)) != 0 ||
377 		    (ws != 0 && (r = sshbuf_put_u8(buf, '"')) != 0))
378 			fatal("%s: buffer error: %s", __func__, ssh_err(r));
379 	}
380 	if ((ret = malloc(sshbuf_len(buf) + 1)) == NULL)
381 		fatal("%s: malloc failed", __func__);
382 	memcpy(ret, sshbuf_ptr(buf), sshbuf_len(buf));
383 	ret[sshbuf_len(buf)] = '\0';
384 	sshbuf_free(buf);
385 	sshbuf_free(arg);
386 	return ret;
387 }
388 
389 /*
390  * Runs command in a subprocess. Returns pid on success and a FILE* to the
391  * subprocess' stdout or 0 on failure.
392  * NB. "command" is only used for logging.
393  */
394 static pid_t
395 subprocess(const char *tag, struct passwd *pw, const char *command,
396     int ac, char **av, FILE **child)
397 {
398 	FILE *f;
399 	struct stat st;
400 	int devnull, p[2], i;
401 	pid_t pid;
402 	char *cp, errmsg[512];
403 	u_int envsize;
404 	char **child_env;
405 
406 	*child = NULL;
407 
408 	debug3("%s: %s command \"%s\" running as %s", __func__,
409 	    tag, command, pw->pw_name);
410 
411 	/* Verify the path exists and is safe-ish to execute */
412 	if (*av[0] != '/') {
413 		error("%s path is not absolute", tag);
414 		return 0;
415 	}
416 	temporarily_use_uid(pw);
417 	if (stat(av[0], &st) < 0) {
418 		error("Could not stat %s \"%s\": %s", tag,
419 		    av[0], strerror(errno));
420 		restore_uid();
421 		return 0;
422 	}
423 	if (auth_secure_path(av[0], &st, NULL, 0,
424 	    errmsg, sizeof(errmsg)) != 0) {
425 		error("Unsafe %s \"%s\": %s", tag, av[0], errmsg);
426 		restore_uid();
427 		return 0;
428 	}
429 
430 	/*
431 	 * Run the command; stderr is left in place, stdout is the
432 	 * authorized_keys output.
433 	 */
434 	if (pipe(p) != 0) {
435 		error("%s: pipe: %s", tag, strerror(errno));
436 		restore_uid();
437 		return 0;
438 	}
439 
440 	/*
441 	 * Don't want to call this in the child, where it can fatal() and
442 	 * run cleanup_exit() code.
443 	 */
444 	restore_uid();
445 
446 	switch ((pid = fork())) {
447 	case -1: /* error */
448 		error("%s: fork: %s", tag, strerror(errno));
449 		close(p[0]);
450 		close(p[1]);
451 		return 0;
452 	case 0: /* child */
453 		/* Prepare a minimal environment for the child. */
454 		envsize = 5;
455 		child_env = xcalloc(sizeof(*child_env), envsize);
456 		child_set_env(&child_env, &envsize, "PATH", _PATH_STDPATH);
457 		child_set_env(&child_env, &envsize, "USER", pw->pw_name);
458 		child_set_env(&child_env, &envsize, "LOGNAME", pw->pw_name);
459 		child_set_env(&child_env, &envsize, "HOME", pw->pw_dir);
460 		if ((cp = getenv("LANG")) != NULL)
461 			child_set_env(&child_env, &envsize, "LANG", cp);
462 
463 		for (i = 0; i < NSIG; i++)
464 			signal(i, SIG_DFL);
465 
466 		if ((devnull = open(_PATH_DEVNULL, O_RDWR)) == -1) {
467 			error("%s: open %s: %s", tag, _PATH_DEVNULL,
468 			    strerror(errno));
469 			_exit(1);
470 		}
471 		/* Keep stderr around a while longer to catch errors */
472 		if (dup2(devnull, STDIN_FILENO) == -1 ||
473 		    dup2(p[1], STDOUT_FILENO) == -1) {
474 			error("%s: dup2: %s", tag, strerror(errno));
475 			_exit(1);
476 		}
477 		closefrom(STDERR_FILENO + 1);
478 
479 		/* Don't use permanently_set_uid() here to avoid fatal() */
480 		if (setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) != 0) {
481 			error("%s: setresgid %u: %s", tag, (u_int)pw->pw_gid,
482 			    strerror(errno));
483 			_exit(1);
484 		}
485 		if (setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid) != 0) {
486 			error("%s: setresuid %u: %s", tag, (u_int)pw->pw_uid,
487 			    strerror(errno));
488 			_exit(1);
489 		}
490 		/* stdin is pointed to /dev/null at this point */
491 		if (dup2(STDIN_FILENO, STDERR_FILENO) == -1) {
492 			error("%s: dup2: %s", tag, strerror(errno));
493 			_exit(1);
494 		}
495 
496 		execve(av[0], av, child_env);
497 		error("%s exec \"%s\": %s", tag, command, strerror(errno));
498 		_exit(127);
499 	default: /* parent */
500 		break;
501 	}
502 
503 	close(p[1]);
504 	if ((f = fdopen(p[0], "r")) == NULL) {
505 		error("%s: fdopen: %s", tag, strerror(errno));
506 		close(p[0]);
507 		/* Don't leave zombie child */
508 		kill(pid, SIGTERM);
509 		while (waitpid(pid, NULL, 0) == -1 && errno == EINTR)
510 			;
511 		return 0;
512 	}
513 	/* Success */
514 	debug3("%s: %s pid %ld", __func__, tag, (long)pid);
515 	*child = f;
516 	return pid;
517 }
518 
519 /* Returns 0 if pid exited cleanly, non-zero otherwise */
520 static int
521 exited_cleanly(pid_t pid, const char *tag, const char *cmd)
522 {
523 	int status;
524 
525 	while (waitpid(pid, &status, 0) == -1) {
526 		if (errno != EINTR) {
527 			error("%s: waitpid: %s", tag, strerror(errno));
528 			return -1;
529 		}
530 	}
531 	if (WIFSIGNALED(status)) {
532 		error("%s %s exited on signal %d", tag, cmd, WTERMSIG(status));
533 		return -1;
534 	} else if (WEXITSTATUS(status) != 0) {
535 		error("%s %s failed, status %d", tag, cmd, WEXITSTATUS(status));
536 		return -1;
537 	}
538 	return 0;
539 }
540 
541 static int
542 match_principals_option(const char *principal_list, struct sshkey_cert *cert)
543 {
544 	char *result;
545 	u_int i;
546 
547 	/* XXX percent_expand() sequences for authorized_principals? */
548 
549 	for (i = 0; i < cert->nprincipals; i++) {
550 		if ((result = match_list(cert->principals[i],
551 		    principal_list, NULL)) != NULL) {
552 			debug3("matched principal from key options \"%.100s\"",
553 			    result);
554 			free(result);
555 			return 1;
556 		}
557 	}
558 	return 0;
559 }
560 
561 static int
562 process_principals(FILE *f, char *file, struct passwd *pw,
563     const struct sshkey_cert *cert)
564 {
565 	char line[SSH_MAX_PUBKEY_BYTES], *cp, *ep, *line_opts;
566 	u_long linenum = 0;
567 	u_int i;
568 
569 	while (read_keyfile_line(f, file, line, sizeof(line), &linenum) != -1) {
570 		/* Skip leading whitespace. */
571 		for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
572 			;
573 		/* Skip blank and comment lines. */
574 		if ((ep = strchr(cp, '#')) != NULL)
575 			*ep = '\0';
576 		if (!*cp || *cp == '\n')
577 			continue;
578 		/* Trim trailing whitespace. */
579 		ep = cp + strlen(cp) - 1;
580 		while (ep > cp && (*ep == '\n' || *ep == ' ' || *ep == '\t'))
581 			*ep-- = '\0';
582 		/*
583 		 * If the line has internal whitespace then assume it has
584 		 * key options.
585 		 */
586 		line_opts = NULL;
587 		if ((ep = strrchr(cp, ' ')) != NULL ||
588 		    (ep = strrchr(cp, '\t')) != NULL) {
589 			for (; *ep == ' ' || *ep == '\t'; ep++)
590 				;
591 			line_opts = cp;
592 			cp = ep;
593 		}
594 		for (i = 0; i < cert->nprincipals; i++) {
595 			if (strcmp(cp, cert->principals[i]) == 0) {
596 				debug3("%s:%lu: matched principal \"%.100s\"",
597 				    file == NULL ? "(command)" : file,
598 				    linenum, cert->principals[i]);
599 				if (auth_parse_options(pw, line_opts,
600 				    file, linenum) != 1)
601 					continue;
602 				return 1;
603 			}
604 		}
605 	}
606 	return 0;
607 }
608 
609 static int
610 match_principals_file(char *file, struct passwd *pw, struct sshkey_cert *cert)
611 {
612 	FILE *f;
613 	int success;
614 
615 	temporarily_use_uid(pw);
616 	debug("trying authorized principals file %s", file);
617 	if ((f = auth_openprincipals(file, pw, options.strict_modes)) == NULL) {
618 		restore_uid();
619 		return 0;
620 	}
621 	success = process_principals(f, file, pw, cert);
622 	fclose(f);
623 	restore_uid();
624 	return success;
625 }
626 
627 /*
628  * Checks whether principal is allowed in output of command.
629  * returns 1 if the principal is allowed or 0 otherwise.
630  */
631 static int
632 match_principals_command(struct passwd *user_pw, const struct sshkey *key)
633 {
634 	const struct sshkey_cert *cert = key->cert;
635 	FILE *f = NULL;
636 	int r, ok, found_principal = 0;
637 	struct passwd *pw;
638 	int i, ac = 0, uid_swapped = 0;
639 	pid_t pid;
640 	char *tmp, *username = NULL, *command = NULL, **av = NULL;
641 	char *ca_fp = NULL, *key_fp = NULL, *catext = NULL, *keytext = NULL;
642 	char serial_s[16];
643 	void (*osigchld)(int);
644 
645 	if (options.authorized_principals_command == NULL)
646 		return 0;
647 	if (options.authorized_principals_command_user == NULL) {
648 		error("No user for AuthorizedPrincipalsCommand specified, "
649 		    "skipping");
650 		return 0;
651 	}
652 
653 	/*
654 	 * NB. all returns later this function should go via "out" to
655 	 * ensure the original SIGCHLD handler is restored properly.
656 	 */
657 	osigchld = signal(SIGCHLD, SIG_DFL);
658 
659 	/* Prepare and verify the user for the command */
660 	username = percent_expand(options.authorized_principals_command_user,
661 	    "u", user_pw->pw_name, (char *)NULL);
662 	pw = getpwnam(username);
663 	if (pw == NULL) {
664 		error("AuthorizedPrincipalsCommandUser \"%s\" not found: %s",
665 		    username, strerror(errno));
666 		goto out;
667 	}
668 
669 	/* Turn the command into an argument vector */
670 	if (split_argv(options.authorized_principals_command, &ac, &av) != 0) {
671 		error("AuthorizedPrincipalsCommand \"%s\" contains "
672 		    "invalid quotes", command);
673 		goto out;
674 	}
675 	if (ac == 0) {
676 		error("AuthorizedPrincipalsCommand \"%s\" yielded no arguments",
677 		    command);
678 		goto out;
679 	}
680 	if ((ca_fp = sshkey_fingerprint(cert->signature_key,
681 	    options.fingerprint_hash, SSH_FP_DEFAULT)) == NULL) {
682 		error("%s: sshkey_fingerprint failed", __func__);
683 		goto out;
684 	}
685 	if ((key_fp = sshkey_fingerprint(key,
686 	    options.fingerprint_hash, SSH_FP_DEFAULT)) == NULL) {
687 		error("%s: sshkey_fingerprint failed", __func__);
688 		goto out;
689 	}
690 	if ((r = sshkey_to_base64(cert->signature_key, &catext)) != 0) {
691 		error("%s: sshkey_to_base64 failed: %s", __func__, ssh_err(r));
692 		goto out;
693 	}
694 	if ((r = sshkey_to_base64(key, &keytext)) != 0) {
695 		error("%s: sshkey_to_base64 failed: %s", __func__, ssh_err(r));
696 		goto out;
697 	}
698 	snprintf(serial_s, sizeof(serial_s), "%llu",
699 	    (unsigned long long)cert->serial);
700 	for (i = 1; i < ac; i++) {
701 		tmp = percent_expand(av[i],
702 		    "u", user_pw->pw_name,
703 		    "h", user_pw->pw_dir,
704 		    "t", sshkey_ssh_name(key),
705 		    "T", sshkey_ssh_name(cert->signature_key),
706 		    "f", key_fp,
707 		    "F", ca_fp,
708 		    "k", keytext,
709 		    "K", catext,
710 		    "i", cert->key_id,
711 		    "s", serial_s,
712 		    (char *)NULL);
713 		if (tmp == NULL)
714 			fatal("%s: percent_expand failed", __func__);
715 		free(av[i]);
716 		av[i] = tmp;
717 	}
718 	/* Prepare a printable command for logs, etc. */
719 	command = assemble_argv(ac, av);
720 
721 	if ((pid = subprocess("AuthorizedPrincipalsCommand", pw, command,
722 	    ac, av, &f)) == 0)
723 		goto out;
724 
725 	uid_swapped = 1;
726 	temporarily_use_uid(pw);
727 
728 	ok = process_principals(f, NULL, pw, cert);
729 
730 	if (exited_cleanly(pid, "AuthorizedPrincipalsCommand", command) != 0)
731 		goto out;
732 
733 	/* Read completed successfully */
734 	found_principal = ok;
735  out:
736 	if (f != NULL)
737 		fclose(f);
738 	signal(SIGCHLD, osigchld);
739 	for (i = 0; i < ac; i++)
740 		free(av[i]);
741 	free(av);
742 	if (uid_swapped)
743 		restore_uid();
744 	free(command);
745 	free(username);
746 	free(ca_fp);
747 	free(key_fp);
748 	free(catext);
749 	free(keytext);
750 	return found_principal;
751 }
752 /*
753  * Checks whether key is allowed in authorized_keys-format file,
754  * returns 1 if the key is allowed or 0 otherwise.
755  */
756 static int
757 check_authkeys_file(FILE *f, char *file, Key* key, struct passwd *pw)
758 {
759 	char line[SSH_MAX_PUBKEY_BYTES];
760 	int found_key = 0;
761 	u_long linenum = 0;
762 	Key *found;
763 
764 	found_key = 0;
765 
766 	found = NULL;
767 	while (read_keyfile_line(f, file, line, sizeof(line), &linenum) != -1) {
768 		char *cp, *key_options = NULL, *fp = NULL;
769 		const char *reason = NULL;
770 
771 		if (found != NULL)
772 			key_free(found);
773 		found = key_new(key_is_cert(key) ? KEY_UNSPEC : key->type);
774 		auth_clear_options();
775 
776 		/* Skip leading whitespace, empty and comment lines. */
777 		for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
778 			;
779 		if (!*cp || *cp == '\n' || *cp == '#')
780 			continue;
781 
782 		if (key_read(found, &cp) != 1) {
783 			/* no key?  check if there are options for this key */
784 			int quoted = 0;
785 			debug2("user_key_allowed: check options: '%s'", cp);
786 			key_options = cp;
787 			for (; *cp && (quoted || (*cp != ' ' && *cp != '\t')); cp++) {
788 				if (*cp == '\\' && cp[1] == '"')
789 					cp++;	/* Skip both */
790 				else if (*cp == '"')
791 					quoted = !quoted;
792 			}
793 			/* Skip remaining whitespace. */
794 			for (; *cp == ' ' || *cp == '\t'; cp++)
795 				;
796 			if (key_read(found, &cp) != 1) {
797 				debug2("user_key_allowed: advance: '%s'", cp);
798 				/* still no key?  advance to next line*/
799 				continue;
800 			}
801 		}
802 		if (key_is_cert(key)) {
803 			if (!key_equal(found, key->cert->signature_key))
804 				continue;
805 			if (auth_parse_options(pw, key_options, file,
806 			    linenum) != 1)
807 				continue;
808 			if (!key_is_cert_authority)
809 				continue;
810 			if ((fp = sshkey_fingerprint(found,
811 			    options.fingerprint_hash, SSH_FP_DEFAULT)) == NULL)
812 				continue;
813 			debug("matching CA found: file %s, line %lu, %s %s",
814 			    file, linenum, key_type(found), fp);
815 			/*
816 			 * If the user has specified a list of principals as
817 			 * a key option, then prefer that list to matching
818 			 * their username in the certificate principals list.
819 			 */
820 			if (authorized_principals != NULL &&
821 			    !match_principals_option(authorized_principals,
822 			    key->cert)) {
823 				reason = "Certificate does not contain an "
824 				    "authorized principal";
825  fail_reason:
826 				free(fp);
827 				error("%s", reason);
828 				auth_debug_add("%s", reason);
829 				continue;
830 			}
831 			if (key_cert_check_authority(key, 0, 0,
832 			    authorized_principals == NULL ? pw->pw_name : NULL,
833 			    &reason) != 0)
834 				goto fail_reason;
835 			if (auth_cert_options(key, pw, &reason) != 0)
836 				goto fail_reason;
837 			verbose("Accepted certificate ID \"%s\" (serial %llu) "
838 			    "signed by %s CA %s via %s", key->cert->key_id,
839 			    (unsigned long long)key->cert->serial,
840 			    key_type(found), fp, file);
841 			free(fp);
842 			found_key = 1;
843 			break;
844 		} else if (key_equal(found, key)) {
845 			if (auth_parse_options(pw, key_options, file,
846 			    linenum) != 1)
847 				continue;
848 			if (key_is_cert_authority)
849 				continue;
850 			if ((fp = sshkey_fingerprint(found,
851 			    options.fingerprint_hash, SSH_FP_DEFAULT)) == NULL)
852 				continue;
853 			debug("matching key found: file %s, line %lu %s %s",
854 			    file, linenum, key_type(found), fp);
855 			free(fp);
856 			found_key = 1;
857 			break;
858 		}
859 	}
860 	if (found != NULL)
861 		key_free(found);
862 	if (!found_key)
863 		debug2("key not found");
864 	return found_key;
865 }
866 
867 /* Authenticate a certificate key against TrustedUserCAKeys */
868 static int
869 user_cert_trusted_ca(struct passwd *pw, Key *key)
870 {
871 	char *ca_fp, *principals_file = NULL;
872 	const char *reason;
873 	int ret = 0, found_principal = 0, use_authorized_principals;
874 
875 	if (!key_is_cert(key) || options.trusted_user_ca_keys == NULL)
876 		return 0;
877 
878 	if ((ca_fp = sshkey_fingerprint(key->cert->signature_key,
879 	    options.fingerprint_hash, SSH_FP_DEFAULT)) == NULL)
880 		return 0;
881 
882 	if (sshkey_in_file(key->cert->signature_key,
883 	    options.trusted_user_ca_keys, 1, 0) != 0) {
884 		debug2("%s: CA %s %s is not listed in %s", __func__,
885 		    key_type(key->cert->signature_key), ca_fp,
886 		    options.trusted_user_ca_keys);
887 		goto out;
888 	}
889 	/*
890 	 * If AuthorizedPrincipals is in use, then compare the certificate
891 	 * principals against the names in that file rather than matching
892 	 * against the username.
893 	 */
894 	if ((principals_file = authorized_principals_file(pw)) != NULL) {
895 		if (match_principals_file(principals_file, pw, key->cert))
896 			found_principal = 1;
897 	}
898 	/* Try querying command if specified */
899 	if (!found_principal && match_principals_command(pw, key))
900 		found_principal = 1;
901 	/* If principals file or command is specified, then require a match */
902 	use_authorized_principals = principals_file != NULL ||
903             options.authorized_principals_command != NULL;
904 	if (!found_principal && use_authorized_principals) {
905 		reason = "Certificate does not contain an authorized principal";
906  fail_reason:
907 		error("%s", reason);
908 		auth_debug_add("%s", reason);
909 		goto out;
910 	}
911 	if (key_cert_check_authority(key, 0, 1,
912 	    use_authorized_principals ? NULL : pw->pw_name, &reason) != 0)
913 		goto fail_reason;
914 	if (auth_cert_options(key, pw, &reason) != 0)
915 		goto fail_reason;
916 
917 	verbose("Accepted certificate ID \"%s\" (serial %llu) signed by "
918 	    "%s CA %s via %s", key->cert->key_id,
919 	    (unsigned long long)key->cert->serial,
920 	    key_type(key->cert->signature_key), ca_fp,
921 	    options.trusted_user_ca_keys);
922 	ret = 1;
923 
924  out:
925 	free(principals_file);
926 	free(ca_fp);
927 	return ret;
928 }
929 
930 /*
931  * Checks whether key is allowed in file.
932  * returns 1 if the key is allowed or 0 otherwise.
933  */
934 static int
935 user_key_allowed2(struct passwd *pw, Key *key, char *file)
936 {
937 	FILE *f;
938 	int found_key = 0;
939 
940 	/* Temporarily use the user's uid. */
941 	temporarily_use_uid(pw);
942 
943 	debug("trying public key file %s", file);
944 	if ((f = auth_openkeyfile(file, pw, options.strict_modes)) != NULL) {
945 		found_key = check_authkeys_file(f, file, key, pw);
946 		fclose(f);
947 	}
948 
949 	restore_uid();
950 	return found_key;
951 }
952 
953 /*
954  * Checks whether key is allowed in output of command.
955  * returns 1 if the key is allowed or 0 otherwise.
956  */
957 static int
958 user_key_command_allowed2(struct passwd *user_pw, Key *key)
959 {
960 	FILE *f = NULL;
961 	int r, ok, found_key = 0;
962 	struct passwd *pw;
963 	int i, uid_swapped = 0, ac = 0;
964 	pid_t pid;
965 	char *username = NULL, *key_fp = NULL, *keytext = NULL;
966 	char *tmp, *command = NULL, **av = NULL;
967 	void (*osigchld)(int);
968 
969 	if (options.authorized_keys_command == NULL)
970 		return 0;
971 	if (options.authorized_keys_command_user == NULL) {
972 		error("No user for AuthorizedKeysCommand specified, skipping");
973 		return 0;
974 	}
975 
976 	/*
977 	 * NB. all returns later this function should go via "out" to
978 	 * ensure the original SIGCHLD handler is restored properly.
979 	 */
980 	osigchld = signal(SIGCHLD, SIG_DFL);
981 
982 	/* Prepare and verify the user for the command */
983 	username = percent_expand(options.authorized_keys_command_user,
984 	    "u", user_pw->pw_name, (char *)NULL);
985 	pw = getpwnam(username);
986 	if (pw == NULL) {
987 		error("AuthorizedKeysCommandUser \"%s\" not found: %s",
988 		    username, strerror(errno));
989 		goto out;
990 	}
991 
992 	/* Prepare AuthorizedKeysCommand */
993 	if ((key_fp = sshkey_fingerprint(key, options.fingerprint_hash,
994 	    SSH_FP_DEFAULT)) == NULL) {
995 		error("%s: sshkey_fingerprint failed", __func__);
996 		goto out;
997 	}
998 	if ((r = sshkey_to_base64(key, &keytext)) != 0) {
999 		error("%s: sshkey_to_base64 failed: %s", __func__, ssh_err(r));
1000 		goto out;
1001 	}
1002 
1003 	/* Turn the command into an argument vector */
1004 	if (split_argv(options.authorized_keys_command, &ac, &av) != 0) {
1005 		error("AuthorizedKeysCommand \"%s\" contains invalid quotes",
1006 		    command);
1007 		goto out;
1008 	}
1009 	if (ac == 0) {
1010 		error("AuthorizedKeysCommand \"%s\" yielded no arguments",
1011 		    command);
1012 		goto out;
1013 	}
1014 	for (i = 1; i < ac; i++) {
1015 		tmp = percent_expand(av[i],
1016 		    "u", user_pw->pw_name,
1017 		    "h", user_pw->pw_dir,
1018 		    "t", sshkey_ssh_name(key),
1019 		    "f", key_fp,
1020 		    "k", keytext,
1021 		    (char *)NULL);
1022 		if (tmp == NULL)
1023 			fatal("%s: percent_expand failed", __func__);
1024 		free(av[i]);
1025 		av[i] = tmp;
1026 	}
1027 	/* Prepare a printable command for logs, etc. */
1028 	command = assemble_argv(ac, av);
1029 
1030 	/*
1031 	 * If AuthorizedKeysCommand was run without arguments
1032 	 * then fall back to the old behaviour of passing the
1033 	 * target username as a single argument.
1034 	 */
1035 	if (ac == 1) {
1036 		av = xreallocarray(av, ac + 2, sizeof(*av));
1037 		av[1] = xstrdup(user_pw->pw_name);
1038 		av[2] = NULL;
1039 		/* Fix up command too, since it is used in log messages */
1040 		free(command);
1041 		xasprintf(&command, "%s %s", av[0], av[1]);
1042 	}
1043 
1044 	if ((pid = subprocess("AuthorizedKeysCommand", pw, command,
1045 	    ac, av, &f)) == 0)
1046 		goto out;
1047 
1048 	uid_swapped = 1;
1049 	temporarily_use_uid(pw);
1050 
1051 	ok = check_authkeys_file(f, options.authorized_keys_command, key, pw);
1052 
1053 	if (exited_cleanly(pid, "AuthorizedKeysCommand", command) != 0)
1054 		goto out;
1055 
1056 	/* Read completed successfully */
1057 	found_key = ok;
1058  out:
1059 	if (f != NULL)
1060 		fclose(f);
1061 	signal(SIGCHLD, osigchld);
1062 	for (i = 0; i < ac; i++)
1063 		free(av[i]);
1064 	free(av);
1065 	if (uid_swapped)
1066 		restore_uid();
1067 	free(command);
1068 	free(username);
1069 	free(key_fp);
1070 	free(keytext);
1071 	return found_key;
1072 }
1073 
1074 /*
1075  * Check whether key authenticates and authorises the user.
1076  */
1077 int
1078 user_key_allowed(struct passwd *pw, Key *key, int auth_attempt)
1079 {
1080 	u_int success, i;
1081 	char *file;
1082 
1083 	if (auth_key_is_revoked(key))
1084 		return 0;
1085 	if (key_is_cert(key) && auth_key_is_revoked(key->cert->signature_key))
1086 		return 0;
1087 
1088 	success = user_cert_trusted_ca(pw, key);
1089 	if (success)
1090 		return success;
1091 
1092 	success = user_key_command_allowed2(pw, key);
1093 	if (success > 0)
1094 		return success;
1095 
1096 	for (i = 0; !success && i < options.num_authkeys_files; i++) {
1097 
1098 		if (strcasecmp(options.authorized_keys_files[i], "none") == 0)
1099 			continue;
1100 		file = expand_authorized_keys(
1101 		    options.authorized_keys_files[i], pw);
1102 
1103 		success = user_key_allowed2(pw, key, file);
1104 		free(file);
1105 	}
1106 
1107 	return success;
1108 }
1109 
1110 /* Records a public key in the list of previously-successful keys */
1111 void
1112 auth2_record_userkey(Authctxt *authctxt, struct sshkey *key)
1113 {
1114 	struct sshkey **tmp;
1115 
1116 	if (authctxt->nprev_userkeys >= INT_MAX ||
1117 	    (tmp = reallocarray(authctxt->prev_userkeys,
1118 	    authctxt->nprev_userkeys + 1, sizeof(*tmp))) == NULL)
1119 		fatal("%s: reallocarray failed", __func__);
1120 	authctxt->prev_userkeys = tmp;
1121 	authctxt->prev_userkeys[authctxt->nprev_userkeys] = key;
1122 	authctxt->nprev_userkeys++;
1123 }
1124 
1125 /* Checks whether a key has already been used successfully for authentication */
1126 int
1127 auth2_userkey_already_used(Authctxt *authctxt, struct sshkey *key)
1128 {
1129 	u_int i;
1130 
1131 	for (i = 0; i < authctxt->nprev_userkeys; i++) {
1132 		if (sshkey_equal_public(key, authctxt->prev_userkeys[i])) {
1133 			return 1;
1134 		}
1135 	}
1136 	return 0;
1137 }
1138 
1139 Authmethod method_pubkey = {
1140 	"publickey",
1141 	userauth_pubkey,
1142 	&options.pubkey_authentication
1143 };
1144