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