xref: /openbsd-src/usr.bin/ssh/hostfile.c (revision 1a8dbaac879b9f3335ad7fb25429ce63ac1d6bac)
1 /* $OpenBSD: hostfile.c,v 1.85 2020/10/11 22:13:37 djm Exp $ */
2 /*
3  * Author: Tatu Ylonen <ylo@cs.hut.fi>
4  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5  *                    All rights reserved
6  * Functions for manipulating the known hosts files.
7  *
8  * As far as I am concerned, the code I have written for this software
9  * can be used freely for any purpose.  Any derived versions of this
10  * software must be clearly marked as such, and if the derived work is
11  * incompatible with the protocol description in the RFC file, it must be
12  * called by a name other than "ssh" or "Secure Shell".
13  *
14  *
15  * Copyright (c) 1999, 2000 Markus Friedl.  All rights reserved.
16  * Copyright (c) 1999 Niels Provos.  All rights reserved.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  * 1. Redistributions of source code must retain the above copyright
22  *    notice, this list of conditions and the following disclaimer.
23  * 2. Redistributions in binary form must reproduce the above copyright
24  *    notice, this list of conditions and the following disclaimer in the
25  *    documentation and/or other materials provided with the distribution.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
28  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
29  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
31  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
36  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #include <sys/types.h>
40 #include <sys/stat.h>
41 
42 #include <netinet/in.h>
43 
44 #include <errno.h>
45 #include <resolv.h>
46 #include <stdio.h>
47 #include <stdlib.h>
48 #include <string.h>
49 #include <stdarg.h>
50 #include <unistd.h>
51 
52 #include "xmalloc.h"
53 #include "match.h"
54 #include "sshkey.h"
55 #include "hostfile.h"
56 #include "log.h"
57 #include "misc.h"
58 #include "pathnames.h"
59 #include "ssherr.h"
60 #include "digest.h"
61 #include "hmac.h"
62 
63 struct hostkeys {
64 	struct hostkey_entry *entries;
65 	u_int num_entries;
66 };
67 
68 /* XXX hmac is too easy to dictionary attack; use bcrypt? */
69 
70 static int
71 extract_salt(const char *s, u_int l, u_char *salt, size_t salt_len)
72 {
73 	char *p, *b64salt;
74 	u_int b64len;
75 	int ret;
76 
77 	if (l < sizeof(HASH_MAGIC) - 1) {
78 		debug2("extract_salt: string too short");
79 		return (-1);
80 	}
81 	if (strncmp(s, HASH_MAGIC, sizeof(HASH_MAGIC) - 1) != 0) {
82 		debug2("extract_salt: invalid magic identifier");
83 		return (-1);
84 	}
85 	s += sizeof(HASH_MAGIC) - 1;
86 	l -= sizeof(HASH_MAGIC) - 1;
87 	if ((p = memchr(s, HASH_DELIM, l)) == NULL) {
88 		debug2("extract_salt: missing salt termination character");
89 		return (-1);
90 	}
91 
92 	b64len = p - s;
93 	/* Sanity check */
94 	if (b64len == 0 || b64len > 1024) {
95 		debug2("extract_salt: bad encoded salt length %u", b64len);
96 		return (-1);
97 	}
98 	b64salt = xmalloc(1 + b64len);
99 	memcpy(b64salt, s, b64len);
100 	b64salt[b64len] = '\0';
101 
102 	ret = __b64_pton(b64salt, salt, salt_len);
103 	free(b64salt);
104 	if (ret == -1) {
105 		debug2("extract_salt: salt decode error");
106 		return (-1);
107 	}
108 	if (ret != (int)ssh_hmac_bytes(SSH_DIGEST_SHA1)) {
109 		debug2("extract_salt: expected salt len %zd, got %d",
110 		    ssh_hmac_bytes(SSH_DIGEST_SHA1), ret);
111 		return (-1);
112 	}
113 
114 	return (0);
115 }
116 
117 char *
118 host_hash(const char *host, const char *name_from_hostfile, u_int src_len)
119 {
120 	struct ssh_hmac_ctx *ctx;
121 	u_char salt[256], result[256];
122 	char uu_salt[512], uu_result[512];
123 	static char encoded[1024];
124 	u_int len;
125 
126 	len = ssh_digest_bytes(SSH_DIGEST_SHA1);
127 
128 	if (name_from_hostfile == NULL) {
129 		/* Create new salt */
130 		arc4random_buf(salt, len);
131 	} else {
132 		/* Extract salt from known host entry */
133 		if (extract_salt(name_from_hostfile, src_len, salt,
134 		    sizeof(salt)) == -1)
135 			return (NULL);
136 	}
137 
138 	if ((ctx = ssh_hmac_start(SSH_DIGEST_SHA1)) == NULL ||
139 	    ssh_hmac_init(ctx, salt, len) < 0 ||
140 	    ssh_hmac_update(ctx, host, strlen(host)) < 0 ||
141 	    ssh_hmac_final(ctx, result, sizeof(result)))
142 		fatal("%s: ssh_hmac failed", __func__);
143 	ssh_hmac_free(ctx);
144 
145 	if (__b64_ntop(salt, len, uu_salt, sizeof(uu_salt)) == -1 ||
146 	    __b64_ntop(result, len, uu_result, sizeof(uu_result)) == -1)
147 		fatal("%s: __b64_ntop failed", __func__);
148 
149 	snprintf(encoded, sizeof(encoded), "%s%s%c%s", HASH_MAGIC, uu_salt,
150 	    HASH_DELIM, uu_result);
151 
152 	return (encoded);
153 }
154 
155 /*
156  * Parses an RSA (number of bits, e, n) or DSA key from a string.  Moves the
157  * pointer over the key.  Skips any whitespace at the beginning and at end.
158  */
159 
160 int
161 hostfile_read_key(char **cpp, u_int *bitsp, struct sshkey *ret)
162 {
163 	char *cp;
164 
165 	/* Skip leading whitespace. */
166 	for (cp = *cpp; *cp == ' ' || *cp == '\t'; cp++)
167 		;
168 
169 	if (sshkey_read(ret, &cp) != 0)
170 		return 0;
171 
172 	/* Skip trailing whitespace. */
173 	for (; *cp == ' ' || *cp == '\t'; cp++)
174 		;
175 
176 	/* Return results. */
177 	*cpp = cp;
178 	if (bitsp != NULL)
179 		*bitsp = sshkey_size(ret);
180 	return 1;
181 }
182 
183 static HostkeyMarker
184 check_markers(char **cpp)
185 {
186 	char marker[32], *sp, *cp = *cpp;
187 	int ret = MRK_NONE;
188 
189 	while (*cp == '@') {
190 		/* Only one marker is allowed */
191 		if (ret != MRK_NONE)
192 			return MRK_ERROR;
193 		/* Markers are terminated by whitespace */
194 		if ((sp = strchr(cp, ' ')) == NULL &&
195 		    (sp = strchr(cp, '\t')) == NULL)
196 			return MRK_ERROR;
197 		/* Extract marker for comparison */
198 		if (sp <= cp + 1 || sp >= cp + sizeof(marker))
199 			return MRK_ERROR;
200 		memcpy(marker, cp, sp - cp);
201 		marker[sp - cp] = '\0';
202 		if (strcmp(marker, CA_MARKER) == 0)
203 			ret = MRK_CA;
204 		else if (strcmp(marker, REVOKE_MARKER) == 0)
205 			ret = MRK_REVOKE;
206 		else
207 			return MRK_ERROR;
208 
209 		/* Skip past marker and any whitespace that follows it */
210 		cp = sp;
211 		for (; *cp == ' ' || *cp == '\t'; cp++)
212 			;
213 	}
214 	*cpp = cp;
215 	return ret;
216 }
217 
218 struct hostkeys *
219 init_hostkeys(void)
220 {
221 	struct hostkeys *ret = xcalloc(1, sizeof(*ret));
222 
223 	ret->entries = NULL;
224 	return ret;
225 }
226 
227 struct load_callback_ctx {
228 	const char *host;
229 	u_long num_loaded;
230 	struct hostkeys *hostkeys;
231 };
232 
233 static int
234 record_hostkey(struct hostkey_foreach_line *l, void *_ctx)
235 {
236 	struct load_callback_ctx *ctx = (struct load_callback_ctx *)_ctx;
237 	struct hostkeys *hostkeys = ctx->hostkeys;
238 	struct hostkey_entry *tmp;
239 
240 	if (l->status == HKF_STATUS_INVALID) {
241 		/* XXX make this verbose() in the future */
242 		debug("%s:%ld: parse error in hostkeys file",
243 		    l->path, l->linenum);
244 		return 0;
245 	}
246 
247 	debug3("%s: found %skey type %s in file %s:%lu", __func__,
248 	    l->marker == MRK_NONE ? "" :
249 	    (l->marker == MRK_CA ? "ca " : "revoked "),
250 	    sshkey_type(l->key), l->path, l->linenum);
251 	if ((tmp = recallocarray(hostkeys->entries, hostkeys->num_entries,
252 	    hostkeys->num_entries + 1, sizeof(*hostkeys->entries))) == NULL)
253 		return SSH_ERR_ALLOC_FAIL;
254 	hostkeys->entries = tmp;
255 	hostkeys->entries[hostkeys->num_entries].host = xstrdup(ctx->host);
256 	hostkeys->entries[hostkeys->num_entries].file = xstrdup(l->path);
257 	hostkeys->entries[hostkeys->num_entries].line = l->linenum;
258 	hostkeys->entries[hostkeys->num_entries].key = l->key;
259 	l->key = NULL; /* steal it */
260 	hostkeys->entries[hostkeys->num_entries].marker = l->marker;
261 	hostkeys->num_entries++;
262 	ctx->num_loaded++;
263 
264 	return 0;
265 }
266 
267 void
268 load_hostkeys(struct hostkeys *hostkeys, const char *host, const char *path)
269 {
270 	int r;
271 	struct load_callback_ctx ctx;
272 
273 	ctx.host = host;
274 	ctx.num_loaded = 0;
275 	ctx.hostkeys = hostkeys;
276 
277 	if ((r = hostkeys_foreach(path, record_hostkey, &ctx, host, NULL,
278 	    HKF_WANT_MATCH|HKF_WANT_PARSE_KEY)) != 0) {
279 		if (r != SSH_ERR_SYSTEM_ERROR && errno != ENOENT)
280 			debug("%s: hostkeys_foreach failed for %s: %s",
281 			    __func__, path, ssh_err(r));
282 	}
283 	if (ctx.num_loaded != 0)
284 		debug3("%s: loaded %lu keys from %s", __func__,
285 		    ctx.num_loaded, host);
286 }
287 
288 void
289 free_hostkeys(struct hostkeys *hostkeys)
290 {
291 	u_int i;
292 
293 	for (i = 0; i < hostkeys->num_entries; i++) {
294 		free(hostkeys->entries[i].host);
295 		free(hostkeys->entries[i].file);
296 		sshkey_free(hostkeys->entries[i].key);
297 		explicit_bzero(hostkeys->entries + i, sizeof(*hostkeys->entries));
298 	}
299 	free(hostkeys->entries);
300 	freezero(hostkeys, sizeof(*hostkeys));
301 }
302 
303 static int
304 check_key_not_revoked(struct hostkeys *hostkeys, struct sshkey *k)
305 {
306 	int is_cert = sshkey_is_cert(k);
307 	u_int i;
308 
309 	for (i = 0; i < hostkeys->num_entries; i++) {
310 		if (hostkeys->entries[i].marker != MRK_REVOKE)
311 			continue;
312 		if (sshkey_equal_public(k, hostkeys->entries[i].key))
313 			return -1;
314 		if (is_cert && k != NULL &&
315 		    sshkey_equal_public(k->cert->signature_key,
316 		    hostkeys->entries[i].key))
317 			return -1;
318 	}
319 	return 0;
320 }
321 
322 /*
323  * Match keys against a specified key, or look one up by key type.
324  *
325  * If looking for a keytype (key == NULL) and one is found then return
326  * HOST_FOUND, otherwise HOST_NEW.
327  *
328  * If looking for a key (key != NULL):
329  *  1. If the key is a cert and a matching CA is found, return HOST_OK
330  *  2. If the key is not a cert and a matching key is found, return HOST_OK
331  *  3. If no key matches but a key with a different type is found, then
332  *     return HOST_CHANGED
333  *  4. If no matching keys are found, then return HOST_NEW.
334  *
335  * Finally, check any found key is not revoked.
336  */
337 static HostStatus
338 check_hostkeys_by_key_or_type(struct hostkeys *hostkeys,
339     struct sshkey *k, int keytype, int nid, const struct hostkey_entry **found)
340 {
341 	u_int i;
342 	HostStatus end_return = HOST_NEW;
343 	int want_cert = sshkey_is_cert(k);
344 	HostkeyMarker want_marker = want_cert ? MRK_CA : MRK_NONE;
345 
346 	if (found != NULL)
347 		*found = NULL;
348 
349 	for (i = 0; i < hostkeys->num_entries; i++) {
350 		if (hostkeys->entries[i].marker != want_marker)
351 			continue;
352 		if (k == NULL) {
353 			if (hostkeys->entries[i].key->type != keytype)
354 				continue;
355 			if (nid != -1 &&
356 			    sshkey_type_plain(keytype) == KEY_ECDSA &&
357 			    hostkeys->entries[i].key->ecdsa_nid != nid)
358 				continue;
359 			end_return = HOST_FOUND;
360 			if (found != NULL)
361 				*found = hostkeys->entries + i;
362 			k = hostkeys->entries[i].key;
363 			break;
364 		}
365 		if (want_cert) {
366 			if (sshkey_equal_public(k->cert->signature_key,
367 			    hostkeys->entries[i].key)) {
368 				/* A matching CA exists */
369 				end_return = HOST_OK;
370 				if (found != NULL)
371 					*found = hostkeys->entries + i;
372 				break;
373 			}
374 		} else {
375 			if (sshkey_equal(k, hostkeys->entries[i].key)) {
376 				end_return = HOST_OK;
377 				if (found != NULL)
378 					*found = hostkeys->entries + i;
379 				break;
380 			}
381 			/* A non-maching key exists */
382 			end_return = HOST_CHANGED;
383 			if (found != NULL)
384 				*found = hostkeys->entries + i;
385 		}
386 	}
387 	if (check_key_not_revoked(hostkeys, k) != 0) {
388 		end_return = HOST_REVOKED;
389 		if (found != NULL)
390 			*found = NULL;
391 	}
392 	return end_return;
393 }
394 
395 HostStatus
396 check_key_in_hostkeys(struct hostkeys *hostkeys, struct sshkey *key,
397     const struct hostkey_entry **found)
398 {
399 	if (key == NULL)
400 		fatal("no key to look up");
401 	return check_hostkeys_by_key_or_type(hostkeys, key, 0, -1, found);
402 }
403 
404 int
405 lookup_key_in_hostkeys_by_type(struct hostkeys *hostkeys, int keytype, int nid,
406     const struct hostkey_entry **found)
407 {
408 	return (check_hostkeys_by_key_or_type(hostkeys, NULL, keytype, nid,
409 	    found) == HOST_FOUND);
410 }
411 
412 int
413 lookup_marker_in_hostkeys(struct hostkeys *hostkeys, int want_marker)
414 {
415 	u_int i;
416 
417 	for (i = 0; i < hostkeys->num_entries; i++) {
418 		if (hostkeys->entries[i].marker == (HostkeyMarker)want_marker)
419 			return 1;
420 	}
421 	return 0;
422 }
423 
424 static int
425 write_host_entry(FILE *f, const char *host, const char *ip,
426     const struct sshkey *key, int store_hash)
427 {
428 	int r, success = 0;
429 	char *hashed_host = NULL, *lhost;
430 
431 	lhost = xstrdup(host);
432 	lowercase(lhost);
433 
434 	if (store_hash) {
435 		if ((hashed_host = host_hash(lhost, NULL, 0)) == NULL) {
436 			error("%s: host_hash failed", __func__);
437 			free(lhost);
438 			return 0;
439 		}
440 		fprintf(f, "%s ", hashed_host);
441 	} else if (ip != NULL)
442 		fprintf(f, "%s,%s ", lhost, ip);
443 	else {
444 		fprintf(f, "%s ", lhost);
445 	}
446 	free(lhost);
447 	if ((r = sshkey_write(key, f)) == 0)
448 		success = 1;
449 	else
450 		error("%s: sshkey_write failed: %s", __func__, ssh_err(r));
451 	fputc('\n', f);
452 	/* If hashing is enabled, the IP address needs to go on its own line */
453 	if (success && store_hash && ip != NULL)
454 		success = write_host_entry(f, ip, NULL, key, 1);
455 	return success;
456 }
457 
458 /*
459  * Create user ~/.ssh directory if it doesn't exist and we want to write to it.
460  * If notify is set, a message will be emitted if the directory is created.
461  */
462 void
463 hostfile_create_user_ssh_dir(const char *filename, int notify)
464 {
465 	char *dotsshdir = NULL, *p;
466 	size_t len;
467 	struct stat st;
468 
469 	if ((p = strrchr(filename, '/')) == NULL)
470 		return;
471 	len = p - filename;
472 	dotsshdir = tilde_expand_filename("~/" _PATH_SSH_USER_DIR, getuid());
473 	if (strlen(dotsshdir) > len || strncmp(filename, dotsshdir, len) != 0)
474 		goto out; /* not ~/.ssh prefixed */
475 	if (stat(dotsshdir, &st) == 0)
476 		goto out; /* dir already exists */
477 	else if (errno != ENOENT)
478 		error("Could not stat %s: %s", dotsshdir, strerror(errno));
479 	else {
480 		if (mkdir(dotsshdir, 0700) == -1)
481 			error("Could not create directory '%.200s' (%s).",
482 			    dotsshdir, strerror(errno));
483 		else if (notify)
484 			logit("Created directory '%s'.", dotsshdir);
485 	}
486  out:
487 	free(dotsshdir);
488 }
489 
490 
491 /*
492  * Appends an entry to the host file.  Returns false if the entry could not
493  * be appended.
494  */
495 int
496 add_host_to_hostfile(const char *filename, const char *host,
497     const struct sshkey *key, int store_hash)
498 {
499 	FILE *f;
500 	int success;
501 
502 	if (key == NULL)
503 		return 1;	/* XXX ? */
504 	hostfile_create_user_ssh_dir(filename, 0);
505 	f = fopen(filename, "a");
506 	if (!f)
507 		return 0;
508 	success = write_host_entry(f, host, NULL, key, store_hash);
509 	fclose(f);
510 	return success;
511 }
512 
513 struct host_delete_ctx {
514 	FILE *out;
515 	int quiet;
516 	const char *host, *ip;
517 	u_int *match_keys;	/* mask of HKF_MATCH_* for this key */
518 	struct sshkey * const *keys;
519 	size_t nkeys;
520 	int modified;
521 };
522 
523 static int
524 host_delete(struct hostkey_foreach_line *l, void *_ctx)
525 {
526 	struct host_delete_ctx *ctx = (struct host_delete_ctx *)_ctx;
527 	int loglevel = ctx->quiet ? SYSLOG_LEVEL_DEBUG1 : SYSLOG_LEVEL_VERBOSE;
528 	size_t i;
529 
530 	/* Don't remove CA and revocation lines */
531 	if (l->status == HKF_STATUS_MATCHED && l->marker == MRK_NONE) {
532 		/*
533 		 * If this line contains one of the keys that we will be
534 		 * adding later, then don't change it and mark the key for
535 		 * skipping.
536 		 */
537 		for (i = 0; i < ctx->nkeys; i++) {
538 			if (!sshkey_equal(ctx->keys[i], l->key))
539 				continue;
540 			ctx->match_keys[i] |= l->match;
541 			fprintf(ctx->out, "%s\n", l->line);
542 			debug3("%s: %s key already at %s:%ld", __func__,
543 			    sshkey_type(l->key), l->path, l->linenum);
544 			return 0;
545 		}
546 
547 		/*
548 		 * Hostname matches and has no CA/revoke marker, delete it
549 		 * by *not* writing the line to ctx->out.
550 		 */
551 		do_log2(loglevel, "%s%s%s:%ld: Removed %s key for host %s",
552 		    ctx->quiet ? __func__ : "", ctx->quiet ? ": " : "",
553 		    l->path, l->linenum, sshkey_type(l->key), ctx->host);
554 		ctx->modified = 1;
555 		return 0;
556 	}
557 	/* Retain non-matching hosts and invalid lines when deleting */
558 	if (l->status == HKF_STATUS_INVALID) {
559 		do_log2(loglevel, "%s%s%s:%ld: invalid known_hosts entry",
560 		    ctx->quiet ? __func__ : "", ctx->quiet ? ": " : "",
561 		    l->path, l->linenum);
562 	}
563 	fprintf(ctx->out, "%s\n", l->line);
564 	return 0;
565 }
566 
567 int
568 hostfile_replace_entries(const char *filename, const char *host, const char *ip,
569     struct sshkey **keys, size_t nkeys, int store_hash, int quiet, int hash_alg)
570 {
571 	int r, fd, oerrno = 0;
572 	int loglevel = quiet ? SYSLOG_LEVEL_DEBUG1 : SYSLOG_LEVEL_VERBOSE;
573 	struct host_delete_ctx ctx;
574 	char *fp, *temp = NULL, *back = NULL;
575 	const char *what;
576 	mode_t omask;
577 	size_t i;
578 	u_int want;
579 
580 	omask = umask(077);
581 
582 	memset(&ctx, 0, sizeof(ctx));
583 	ctx.host = host;
584 	ctx.ip = ip;
585 	ctx.quiet = quiet;
586 
587 	if ((ctx.match_keys = calloc(nkeys, sizeof(*ctx.match_keys))) == NULL)
588 		return SSH_ERR_ALLOC_FAIL;
589 	ctx.keys = keys;
590 	ctx.nkeys = nkeys;
591 	ctx.modified = 0;
592 
593 	/*
594 	 * Prepare temporary file for in-place deletion.
595 	 */
596 	if ((r = asprintf(&temp, "%s.XXXXXXXXXXX", filename)) == -1 ||
597 	    (r = asprintf(&back, "%s.old", filename)) == -1) {
598 		r = SSH_ERR_ALLOC_FAIL;
599 		goto fail;
600 	}
601 
602 	if ((fd = mkstemp(temp)) == -1) {
603 		oerrno = errno;
604 		error("%s: mkstemp: %s", __func__, strerror(oerrno));
605 		r = SSH_ERR_SYSTEM_ERROR;
606 		goto fail;
607 	}
608 	if ((ctx.out = fdopen(fd, "w")) == NULL) {
609 		oerrno = errno;
610 		close(fd);
611 		error("%s: fdopen: %s", __func__, strerror(oerrno));
612 		r = SSH_ERR_SYSTEM_ERROR;
613 		goto fail;
614 	}
615 
616 	/* Remove stale/mismatching entries for the specified host */
617 	if ((r = hostkeys_foreach(filename, host_delete, &ctx, host, ip,
618 	    HKF_WANT_PARSE_KEY)) != 0) {
619 		oerrno = errno;
620 		error("%s: hostkeys_foreach failed: %s", __func__, ssh_err(r));
621 		goto fail;
622 	}
623 
624 	/* Re-add the requested keys */
625 	want = HKF_MATCH_HOST | (ip == NULL ? 0 : HKF_MATCH_IP);
626 	for (i = 0; i < nkeys; i++) {
627 		if ((want & ctx.match_keys[i]) == want)
628 			continue;
629 		if ((fp = sshkey_fingerprint(keys[i], hash_alg,
630 		    SSH_FP_DEFAULT)) == NULL) {
631 			r = SSH_ERR_ALLOC_FAIL;
632 			goto fail;
633 		}
634 		/* write host/ip */
635 		what = "";
636 		if (ctx.match_keys[i] == 0) {
637 			what = "Adding new key";
638 			if (!write_host_entry(ctx.out, host, ip,
639 			    keys[i], store_hash)) {
640 				r = SSH_ERR_INTERNAL_ERROR;
641 				goto fail;
642 			}
643 		} else if ((want & ~ctx.match_keys[i]) == HKF_MATCH_HOST) {
644 			what = "Fixing match (hostname)";
645 			if (!write_host_entry(ctx.out, host, NULL,
646 			    keys[i], store_hash)) {
647 				r = SSH_ERR_INTERNAL_ERROR;
648 				goto fail;
649 			}
650 		} else if ((want & ~ctx.match_keys[i]) == HKF_MATCH_IP) {
651 			what = "Fixing match (address)";
652 			if (!write_host_entry(ctx.out, ip, NULL,
653 			    keys[i], store_hash)) {
654 				r = SSH_ERR_INTERNAL_ERROR;
655 				goto fail;
656 			}
657 		}
658 		do_log2(loglevel, "%s%s%s for %s%s%s to %s: %s %s",
659 		    quiet ? __func__ : "", quiet ? ": " : "", what,
660 		    host, ip == NULL ? "" : ",", ip == NULL ? "" : ip, filename,
661 		    sshkey_ssh_name(keys[i]), fp);
662 		free(fp);
663 		ctx.modified = 1;
664 	}
665 	fclose(ctx.out);
666 	ctx.out = NULL;
667 
668 	if (ctx.modified) {
669 		/* Backup the original file and replace it with the temporary */
670 		if (unlink(back) == -1 && errno != ENOENT) {
671 			oerrno = errno;
672 			error("%s: unlink %.100s: %s", __func__,
673 			    back, strerror(errno));
674 			r = SSH_ERR_SYSTEM_ERROR;
675 			goto fail;
676 		}
677 		if (link(filename, back) == -1) {
678 			oerrno = errno;
679 			error("%s: link %.100s to %.100s: %s", __func__,
680 			    filename, back, strerror(errno));
681 			r = SSH_ERR_SYSTEM_ERROR;
682 			goto fail;
683 		}
684 		if (rename(temp, filename) == -1) {
685 			oerrno = errno;
686 			error("%s: rename \"%s\" to \"%s\": %s", __func__,
687 			    temp, filename, strerror(errno));
688 			r = SSH_ERR_SYSTEM_ERROR;
689 			goto fail;
690 		}
691 	} else {
692 		/* No changes made; just delete the temporary file */
693 		if (unlink(temp) != 0)
694 			error("%s: unlink \"%s\": %s", __func__,
695 			    temp, strerror(errno));
696 	}
697 
698 	/* success */
699 	r = 0;
700  fail:
701 	if (temp != NULL && r != 0)
702 		unlink(temp);
703 	free(temp);
704 	free(back);
705 	if (ctx.out != NULL)
706 		fclose(ctx.out);
707 	free(ctx.match_keys);
708 	umask(omask);
709 	if (r == SSH_ERR_SYSTEM_ERROR)
710 		errno = oerrno;
711 	return r;
712 }
713 
714 static int
715 match_maybe_hashed(const char *host, const char *names, int *was_hashed)
716 {
717 	int hashed = *names == HASH_DELIM;
718 	const char *hashed_host;
719 	size_t nlen = strlen(names);
720 
721 	if (was_hashed != NULL)
722 		*was_hashed = hashed;
723 	if (hashed) {
724 		if ((hashed_host = host_hash(host, names, nlen)) == NULL)
725 			return -1;
726 		return nlen == strlen(hashed_host) &&
727 		    strncmp(hashed_host, names, nlen) == 0;
728 	}
729 	return match_hostname(host, names) == 1;
730 }
731 
732 int
733 hostkeys_foreach(const char *path, hostkeys_foreach_fn *callback, void *ctx,
734     const char *host, const char *ip, u_int options)
735 {
736 	FILE *f;
737 	char *line = NULL, ktype[128];
738 	u_long linenum = 0;
739 	char *cp, *cp2;
740 	u_int kbits;
741 	int hashed;
742 	int s, r = 0;
743 	struct hostkey_foreach_line lineinfo;
744 	size_t linesize = 0, l;
745 
746 	memset(&lineinfo, 0, sizeof(lineinfo));
747 	if (host == NULL && (options & HKF_WANT_MATCH) != 0)
748 		return SSH_ERR_INVALID_ARGUMENT;
749 	if ((f = fopen(path, "r")) == NULL)
750 		return SSH_ERR_SYSTEM_ERROR;
751 
752 	debug3("%s: reading file \"%s\"", __func__, path);
753 	while (getline(&line, &linesize, f) != -1) {
754 		linenum++;
755 		line[strcspn(line, "\n")] = '\0';
756 
757 		free(lineinfo.line);
758 		sshkey_free(lineinfo.key);
759 		memset(&lineinfo, 0, sizeof(lineinfo));
760 		lineinfo.path = path;
761 		lineinfo.linenum = linenum;
762 		lineinfo.line = xstrdup(line);
763 		lineinfo.marker = MRK_NONE;
764 		lineinfo.status = HKF_STATUS_OK;
765 		lineinfo.keytype = KEY_UNSPEC;
766 
767 		/* Skip any leading whitespace, comments and empty lines. */
768 		for (cp = line; *cp == ' ' || *cp == '\t'; cp++)
769 			;
770 		if (!*cp || *cp == '#' || *cp == '\n') {
771 			if ((options & HKF_WANT_MATCH) == 0) {
772 				lineinfo.status = HKF_STATUS_COMMENT;
773 				if ((r = callback(&lineinfo, ctx)) != 0)
774 					break;
775 			}
776 			continue;
777 		}
778 
779 		if ((lineinfo.marker = check_markers(&cp)) == MRK_ERROR) {
780 			verbose("%s: invalid marker at %s:%lu",
781 			    __func__, path, linenum);
782 			if ((options & HKF_WANT_MATCH) == 0)
783 				goto bad;
784 			continue;
785 		}
786 
787 		/* Find the end of the host name portion. */
788 		for (cp2 = cp; *cp2 && *cp2 != ' ' && *cp2 != '\t'; cp2++)
789 			;
790 		lineinfo.hosts = cp;
791 		*cp2++ = '\0';
792 
793 		/* Check if the host name matches. */
794 		if (host != NULL) {
795 			if ((s = match_maybe_hashed(host, lineinfo.hosts,
796 			    &hashed)) == -1) {
797 				debug2("%s: %s:%ld: bad host hash \"%.32s\"",
798 				    __func__, path, linenum, lineinfo.hosts);
799 				goto bad;
800 			}
801 			if (s == 1) {
802 				lineinfo.status = HKF_STATUS_MATCHED;
803 				lineinfo.match |= HKF_MATCH_HOST |
804 				    (hashed ? HKF_MATCH_HOST_HASHED : 0);
805 			}
806 			/* Try matching IP address if supplied */
807 			if (ip != NULL) {
808 				if ((s = match_maybe_hashed(ip, lineinfo.hosts,
809 				    &hashed)) == -1) {
810 					debug2("%s: %s:%ld: bad ip hash "
811 					    "\"%.32s\"", __func__, path,
812 					    linenum, lineinfo.hosts);
813 					goto bad;
814 				}
815 				if (s == 1) {
816 					lineinfo.status = HKF_STATUS_MATCHED;
817 					lineinfo.match |= HKF_MATCH_IP |
818 					    (hashed ? HKF_MATCH_IP_HASHED : 0);
819 				}
820 			}
821 			/*
822 			 * Skip this line if host matching requested and
823 			 * neither host nor address matched.
824 			 */
825 			if ((options & HKF_WANT_MATCH) != 0 &&
826 			    lineinfo.status != HKF_STATUS_MATCHED)
827 				continue;
828 		}
829 
830 		/* Got a match.  Skip host name and any following whitespace */
831 		for (; *cp2 == ' ' || *cp2 == '\t'; cp2++)
832 			;
833 		if (*cp2 == '\0' || *cp2 == '#') {
834 			debug2("%s:%ld: truncated before key type",
835 			    path, linenum);
836 			goto bad;
837 		}
838 		lineinfo.rawkey = cp = cp2;
839 
840 		if ((options & HKF_WANT_PARSE_KEY) != 0) {
841 			/*
842 			 * Extract the key from the line.  This will skip
843 			 * any leading whitespace.  Ignore badly formatted
844 			 * lines.
845 			 */
846 			if ((lineinfo.key = sshkey_new(KEY_UNSPEC)) == NULL) {
847 				error("%s: sshkey_new failed", __func__);
848 				r = SSH_ERR_ALLOC_FAIL;
849 				break;
850 			}
851 			if (!hostfile_read_key(&cp, &kbits, lineinfo.key)) {
852 				goto bad;
853 			}
854 			lineinfo.keytype = lineinfo.key->type;
855 			lineinfo.comment = cp;
856 		} else {
857 			/* Extract and parse key type */
858 			l = strcspn(lineinfo.rawkey, " \t");
859 			if (l <= 1 || l >= sizeof(ktype) ||
860 			    lineinfo.rawkey[l] == '\0')
861 				goto bad;
862 			memcpy(ktype, lineinfo.rawkey, l);
863 			ktype[l] = '\0';
864 			lineinfo.keytype = sshkey_type_from_name(ktype);
865 
866 			/*
867 			 * Assume legacy RSA1 if the first component is a short
868 			 * decimal number.
869 			 */
870 			if (lineinfo.keytype == KEY_UNSPEC && l < 8 &&
871 			    strspn(ktype, "0123456789") == l)
872 				goto bad;
873 
874 			/*
875 			 * Check that something other than whitespace follows
876 			 * the key type. This won't catch all corruption, but
877 			 * it does catch trivial truncation.
878 			 */
879 			cp2 += l; /* Skip past key type */
880 			for (; *cp2 == ' ' || *cp2 == '\t'; cp2++)
881 				;
882 			if (*cp2 == '\0' || *cp2 == '#') {
883 				debug2("%s:%ld: truncated after key type",
884 				    path, linenum);
885 				lineinfo.keytype = KEY_UNSPEC;
886 			}
887 			if (lineinfo.keytype == KEY_UNSPEC) {
888  bad:
889 				sshkey_free(lineinfo.key);
890 				lineinfo.key = NULL;
891 				lineinfo.status = HKF_STATUS_INVALID;
892 				if ((r = callback(&lineinfo, ctx)) != 0)
893 					break;
894 				continue;
895 			}
896 		}
897 		if ((r = callback(&lineinfo, ctx)) != 0)
898 			break;
899 	}
900 	sshkey_free(lineinfo.key);
901 	free(lineinfo.line);
902 	free(line);
903 	fclose(f);
904 	return r;
905 }
906