1 /* $OpenBSD: hostfile.c,v 1.57 2014/06/24 01:13:21 djm Exp $ */
3 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * Functions for manipulating the known hosts files.
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".
15 * Copyright (c) 1999, 2000 Markus Friedl. All rights reserved.
16 * Copyright (c) 1999 Niels Provos. All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
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.
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.
41 #include <sys/types.h>
43 #include <netinet/in.h>
62 struct hostkey_entry
*entries
;
67 extract_salt(const char *s
, u_int l
, u_char
*salt
, size_t salt_len
)
73 if (l
< sizeof(HASH_MAGIC
) - 1) {
74 debug2("extract_salt: string too short");
77 if (strncmp(s
, HASH_MAGIC
, sizeof(HASH_MAGIC
) - 1) != 0) {
78 debug2("extract_salt: invalid magic identifier");
81 s
+= sizeof(HASH_MAGIC
) - 1;
82 l
-= sizeof(HASH_MAGIC
) - 1;
83 if ((p
= memchr(s
, HASH_DELIM
, l
)) == NULL
) {
84 debug2("extract_salt: missing salt termination character");
90 if (b64len
== 0 || b64len
> 1024) {
91 debug2("extract_salt: bad encoded salt length %u", b64len
);
94 b64salt
= xmalloc(1 + b64len
);
95 memcpy(b64salt
, s
, b64len
);
96 b64salt
[b64len
] = '\0';
98 ret
= __b64_pton(b64salt
, salt
, salt_len
);
101 debug2("extract_salt: salt decode error");
104 if (ret
!= (int)ssh_hmac_bytes(SSH_DIGEST_SHA1
)) {
105 debug2("extract_salt: expected salt len %zd, got %d",
106 ssh_hmac_bytes(SSH_DIGEST_SHA1
), ret
);
114 host_hash(const char *host
, const char *name_from_hostfile
, u_int src_len
)
116 struct ssh_hmac_ctx
*ctx
;
117 u_char salt
[256], result
[256];
118 char uu_salt
[512], uu_result
[512];
119 static char encoded
[1024];
122 len
= ssh_digest_bytes(SSH_DIGEST_SHA1
);
124 if (name_from_hostfile
== NULL
) {
125 /* Create new salt */
126 for (i
= 0; i
< len
; i
++)
127 salt
[i
] = arc4random();
129 /* Extract salt from known host entry */
130 if (extract_salt(name_from_hostfile
, src_len
, salt
,
135 if ((ctx
= ssh_hmac_start(SSH_DIGEST_SHA1
)) == NULL
||
136 ssh_hmac_init(ctx
, salt
, len
) < 0 ||
137 ssh_hmac_update(ctx
, host
, strlen(host
)) < 0 ||
138 ssh_hmac_final(ctx
, result
, sizeof(result
)))
139 fatal("%s: ssh_hmac failed", __func__
);
142 if (__b64_ntop(salt
, len
, uu_salt
, sizeof(uu_salt
)) == -1 ||
143 __b64_ntop(result
, len
, uu_result
, sizeof(uu_result
)) == -1)
144 fatal("%s: __b64_ntop failed", __func__
);
146 snprintf(encoded
, sizeof(encoded
), "%s%s%c%s", HASH_MAGIC
, uu_salt
,
147 HASH_DELIM
, uu_result
);
153 * Parses an RSA (number of bits, e, n) or DSA key from a string. Moves the
154 * pointer over the key. Skips any whitespace at the beginning and at end.
158 hostfile_read_key(char **cpp
, int *bitsp
, Key
*ret
)
162 /* Skip leading whitespace. */
163 for (cp
= *cpp
; *cp
== ' ' || *cp
== '\t'; cp
++)
166 if (key_read(ret
, &cp
) != 1)
169 /* Skip trailing whitespace. */
170 for (; *cp
== ' ' || *cp
== '\t'; cp
++)
173 /* Return results. */
176 if ((*bitsp
= key_size(ret
)) <= 0)
183 hostfile_check_key(int bits
, const Key
*key
, const char *host
,
184 const char *filename
, u_long linenum
)
187 if (key
== NULL
|| key
->type
!= KEY_RSA1
|| key
->rsa
== NULL
)
189 if (bits
!= BN_num_bits(key
->rsa
->n
)) {
190 logit("Warning: %s, line %lu: keysize mismatch for host %s: "
191 "actual %d vs. announced %d.",
192 filename
, linenum
, host
, BN_num_bits(key
->rsa
->n
), bits
);
193 logit("Warning: replace %d with %d in %s, line %lu.",
194 bits
, BN_num_bits(key
->rsa
->n
), filename
, linenum
);
201 check_markers(char **cpp
)
203 char marker
[32], *sp
, *cp
= *cpp
;
207 /* Only one marker is allowed */
210 /* Markers are terminated by whitespace */
211 if ((sp
= strchr(cp
, ' ')) == NULL
&&
212 (sp
= strchr(cp
, '\t')) == NULL
)
214 /* Extract marker for comparison */
215 if (sp
<= cp
+ 1 || sp
>= cp
+ sizeof(marker
))
217 memcpy(marker
, cp
, sp
- cp
);
218 marker
[sp
- cp
] = '\0';
219 if (strcmp(marker
, CA_MARKER
) == 0)
221 else if (strcmp(marker
, REVOKE_MARKER
) == 0)
226 /* Skip past marker and any whitespace that follows it */
228 for (; *cp
== ' ' || *cp
== '\t'; cp
++)
238 struct hostkeys
*ret
= xcalloc(1, sizeof(*ret
));
245 load_hostkeys(struct hostkeys
*hostkeys
, const char *host
, const char *path
)
249 u_long linenum
= 0, num_loaded
= 0;
250 char *cp
, *cp2
, *hashed_host
;
251 HostkeyMarker marker
;
255 if ((f
= fopen(path
, "r")) == NULL
)
257 debug3("%s: loading entries for host \"%.100s\" from file \"%s\"",
258 __func__
, host
, path
);
259 while (read_keyfile_line(f
, path
, line
, sizeof(line
), &linenum
) == 0) {
262 /* Skip any leading whitespace, comments and empty lines. */
263 for (; *cp
== ' ' || *cp
== '\t'; cp
++)
265 if (!*cp
|| *cp
== '#' || *cp
== '\n')
268 if ((marker
= check_markers(&cp
)) == MRK_ERROR
) {
269 verbose("%s: invalid marker at %s:%lu",
270 __func__
, path
, linenum
);
274 /* Find the end of the host name portion. */
275 for (cp2
= cp
; *cp2
&& *cp2
!= ' ' && *cp2
!= '\t'; cp2
++)
278 /* Check if the host name matches. */
279 if (match_hostname(host
, cp
, (u_int
) (cp2
- cp
)) != 1) {
280 if (*cp
!= HASH_DELIM
)
282 hashed_host
= host_hash(host
, cp
, (u_int
) (cp2
- cp
));
283 if (hashed_host
== NULL
) {
284 debug("Invalid hashed host line %lu of %s",
288 if (strncmp(hashed_host
, cp
, (u_int
) (cp2
- cp
)) != 0)
292 /* Got a match. Skip host name. */
296 * Extract the key from the line. This will skip any leading
297 * whitespace. Ignore badly formatted lines.
299 key
= key_new(KEY_UNSPEC
);
300 if (!hostfile_read_key(&cp
, &kbits
, key
)) {
303 key
= key_new(KEY_RSA1
);
304 if (!hostfile_read_key(&cp
, &kbits
, key
)) {
312 if (!hostfile_check_key(kbits
, key
, host
, path
, linenum
))
315 debug3("%s: found %skey type %s in file %s:%lu", __func__
,
316 marker
== MRK_NONE
? "" :
317 (marker
== MRK_CA
? "ca " : "revoked "),
318 key_type(key
), path
, linenum
);
319 hostkeys
->entries
= xrealloc(hostkeys
->entries
,
320 hostkeys
->num_entries
+ 1, sizeof(*hostkeys
->entries
));
321 hostkeys
->entries
[hostkeys
->num_entries
].host
= xstrdup(host
);
322 hostkeys
->entries
[hostkeys
->num_entries
].file
= xstrdup(path
);
323 hostkeys
->entries
[hostkeys
->num_entries
].line
= linenum
;
324 hostkeys
->entries
[hostkeys
->num_entries
].key
= key
;
325 hostkeys
->entries
[hostkeys
->num_entries
].marker
= marker
;
326 hostkeys
->num_entries
++;
329 debug3("%s: loaded %lu keys", __func__
, num_loaded
);
335 free_hostkeys(struct hostkeys
*hostkeys
)
339 for (i
= 0; i
< hostkeys
->num_entries
; i
++) {
340 free(hostkeys
->entries
[i
].host
);
341 free(hostkeys
->entries
[i
].file
);
342 key_free(hostkeys
->entries
[i
].key
);
343 explicit_bzero(hostkeys
->entries
+ i
, sizeof(*hostkeys
->entries
));
345 free(hostkeys
->entries
);
346 explicit_bzero(hostkeys
, sizeof(*hostkeys
));
351 check_key_not_revoked(struct hostkeys
*hostkeys
, Key
*k
)
353 int is_cert
= key_is_cert(k
);
356 for (i
= 0; i
< hostkeys
->num_entries
; i
++) {
357 if (hostkeys
->entries
[i
].marker
!= MRK_REVOKE
)
359 if (key_equal_public(k
, hostkeys
->entries
[i
].key
))
362 key_equal_public(k
->cert
->signature_key
,
363 hostkeys
->entries
[i
].key
))
370 * Match keys against a specified key, or look one up by key type.
372 * If looking for a keytype (key == NULL) and one is found then return
373 * HOST_FOUND, otherwise HOST_NEW.
375 * If looking for a key (key != NULL):
376 * 1. If the key is a cert and a matching CA is found, return HOST_OK
377 * 2. If the key is not a cert and a matching key is found, return HOST_OK
378 * 3. If no key matches but a key with a different type is found, then
379 * return HOST_CHANGED
380 * 4. If no matching keys are found, then return HOST_NEW.
382 * Finally, check any found key is not revoked.
385 check_hostkeys_by_key_or_type(struct hostkeys
*hostkeys
,
386 Key
*k
, int keytype
, const struct hostkey_entry
**found
)
389 HostStatus end_return
= HOST_NEW
;
390 int want_cert
= key_is_cert(k
);
391 HostkeyMarker want_marker
= want_cert
? MRK_CA
: MRK_NONE
;
392 int proto
= (k
? k
->type
: keytype
) == KEY_RSA1
? 1 : 2;
397 for (i
= 0; i
< hostkeys
->num_entries
; i
++) {
398 if (proto
== 1 && hostkeys
->entries
[i
].key
->type
!= KEY_RSA1
)
400 if (proto
== 2 && hostkeys
->entries
[i
].key
->type
== KEY_RSA1
)
402 if (hostkeys
->entries
[i
].marker
!= want_marker
)
405 if (hostkeys
->entries
[i
].key
->type
!= keytype
)
407 end_return
= HOST_FOUND
;
409 *found
= hostkeys
->entries
+ i
;
410 k
= hostkeys
->entries
[i
].key
;
414 if (key_equal_public(k
->cert
->signature_key
,
415 hostkeys
->entries
[i
].key
)) {
416 /* A matching CA exists */
417 end_return
= HOST_OK
;
419 *found
= hostkeys
->entries
+ i
;
423 if (key_equal(k
, hostkeys
->entries
[i
].key
)) {
424 end_return
= HOST_OK
;
426 *found
= hostkeys
->entries
+ i
;
429 /* A non-maching key exists */
430 end_return
= HOST_CHANGED
;
432 *found
= hostkeys
->entries
+ i
;
435 if (check_key_not_revoked(hostkeys
, k
) != 0) {
436 end_return
= HOST_REVOKED
;
444 check_key_in_hostkeys(struct hostkeys
*hostkeys
, Key
*key
,
445 const struct hostkey_entry
**found
)
448 fatal("no key to look up");
449 return check_hostkeys_by_key_or_type(hostkeys
, key
, 0, found
);
453 lookup_key_in_hostkeys_by_type(struct hostkeys
*hostkeys
, int keytype
,
454 const struct hostkey_entry
**found
)
456 return (check_hostkeys_by_key_or_type(hostkeys
, NULL
, keytype
,
457 found
) == HOST_FOUND
);
461 * Appends an entry to the host file. Returns false if the entry could not
466 add_host_to_hostfile(const char *filename
, const char *host
, const Key
*key
,
471 char *hashed_host
= NULL
;
474 return 1; /* XXX ? */
475 f
= fopen(filename
, "a");
480 if ((hashed_host
= host_hash(host
, NULL
, 0)) == NULL
) {
481 error("add_host_to_hostfile: host_hash failed");
486 fprintf(f
, "%s ", store_hash
? hashed_host
: host
);
488 if (key_write(key
, f
)) {
491 error("add_host_to_hostfile: saving key in %s failed", filename
);