blob: 42a8aa71dae6d844ab22df57fc1bdc71b4296269 [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11003 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11005 * Functions for manipulating the known hosts files.
Damien Miller4af51302000-04-16 11:18:38 +10006 *
Damien Millere4340be2000-09-16 13:29:08 +11007 * As far as I am concerned, the code I have written for this software
8 * can be used freely for any purpose. Any derived versions of this
9 * software must be clearly marked as such, and if the derived work is
10 * incompatible with the protocol description in the RFC file, it must be
11 * called by a name other than "ssh" or "Secure Shell".
12 *
13 *
Ben Lindstrom44697232001-07-04 03:32:30 +000014 * Copyright (c) 1999, 2000 Markus Friedl. All rights reserved.
Damien Millere4340be2000-09-16 13:29:08 +110015 * Copyright (c) 1999 Niels Provos. All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
19 * are met:
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Damien Miller95def091999-11-25 00:26:21 +110036 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100037
38#include "includes.h"
Damien Millerd5580922003-05-14 13:40:06 +100039RCSID("$OpenBSD: hostfile.c,v 1.31 2003/04/08 20:21:28 itojun Exp $");
Damien Miller450a7a12000-03-26 13:04:51 +100040
Damien Millerd4a8b7e1999-10-27 13:42:43 +100041#include "packet.h"
Damien Miller450a7a12000-03-26 13:04:51 +100042#include "match.h"
Damien Miller450a7a12000-03-26 13:04:51 +100043#include "key.h"
44#include "hostfile.h"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000045#include "log.h"
Damien Millerd4a8b7e1999-10-27 13:42:43 +100046
Damien Miller5428f641999-11-25 11:54:57 +110047/*
Damien Miller450a7a12000-03-26 13:04:51 +100048 * Parses an RSA (number of bits, e, n) or DSA key from a string. Moves the
49 * pointer over the key. Skips any whitespace at the beginning and at end.
Damien Miller5428f641999-11-25 11:54:57 +110050 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100051
Damien Miller5b2aea92001-12-21 12:47:09 +110052int
Ben Lindstrom46c16222000-12-22 01:43:59 +000053hostfile_read_key(char **cpp, u_int *bitsp, Key *ret)
Damien Millerd4a8b7e1999-10-27 13:42:43 +100054{
Damien Miller95def091999-11-25 00:26:21 +110055 char *cp;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100056
Damien Miller95def091999-11-25 00:26:21 +110057 /* Skip leading whitespace. */
Damien Miller5428f641999-11-25 11:54:57 +110058 for (cp = *cpp; *cp == ' ' || *cp == '\t'; cp++)
59 ;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100060
Damien Miller0bc1bd82000-11-13 22:57:25 +110061 if (key_read(ret, &cp) != 1)
Damien Miller95def091999-11-25 00:26:21 +110062 return 0;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100063
Damien Miller95def091999-11-25 00:26:21 +110064 /* Skip trailing whitespace. */
Damien Miller5428f641999-11-25 11:54:57 +110065 for (; *cp == ' ' || *cp == '\t'; cp++)
66 ;
Damien Miller95def091999-11-25 00:26:21 +110067
68 /* Return results. */
69 *cpp = cp;
Damien Miller0bc1bd82000-11-13 22:57:25 +110070 *bitsp = key_size(ret);
Damien Miller95def091999-11-25 00:26:21 +110071 return 1;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100072}
73
Ben Lindstrombba81212001-06-25 05:01:22 +000074static int
Damien Miller450a7a12000-03-26 13:04:51 +100075hostfile_check_key(int bits, Key *key, const char *host, const char *filename, int linenum)
Damien Millerd4a8b7e1999-10-27 13:42:43 +100076{
Damien Miller0bc1bd82000-11-13 22:57:25 +110077 if (key == NULL || key->type != KEY_RSA1 || key->rsa == NULL)
Damien Miller450a7a12000-03-26 13:04:51 +100078 return 1;
79 if (bits != BN_num_bits(key->rsa->n)) {
Damien Miller996acd22003-04-09 20:59:48 +100080 logit("Warning: %s, line %d: keysize mismatch for host %s: "
Damien Miller450a7a12000-03-26 13:04:51 +100081 "actual %d vs. announced %d.",
82 filename, linenum, host, BN_num_bits(key->rsa->n), bits);
Damien Miller996acd22003-04-09 20:59:48 +100083 logit("Warning: replace %d with %d in %s, line %d.",
Damien Miller450a7a12000-03-26 13:04:51 +100084 bits, BN_num_bits(key->rsa->n), filename, linenum);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100085 }
Damien Miller450a7a12000-03-26 13:04:51 +100086 return 1;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100087}
88
Damien Miller5428f641999-11-25 11:54:57 +110089/*
90 * Checks whether the given host (which must be in all lowercase) is already
91 * in the list of our known hosts. Returns HOST_OK if the host is known and
92 * has the specified key, HOST_NEW if the host is not known, and HOST_CHANGED
93 * if the host is known but used to have a different host key.
Ben Lindstrom3ed66402002-08-01 01:21:56 +000094 *
95 * If no 'key' has been specified and a key of type 'keytype' is known
96 * for the specified host, then HOST_FOUND is returned.
Damien Miller5428f641999-11-25 11:54:57 +110097 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100098
Ben Lindstrom3ed66402002-08-01 01:21:56 +000099static HostStatus
100check_host_in_hostfile_by_key_or_type(const char *filename,
101 const char *host, Key *key, int keytype, Key *found, int *numret)
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000102{
Damien Miller95def091999-11-25 00:26:21 +1100103 FILE *f;
104 char line[8192];
105 int linenum = 0;
Ben Lindstromab0cedc2001-04-07 17:23:43 +0000106 u_int kbits;
Damien Miller95def091999-11-25 00:26:21 +1100107 char *cp, *cp2;
108 HostStatus end_return;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000109
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000110 debug3("check_host_in_hostfile: filename %s", filename);
Ben Lindstrom3ed66402002-08-01 01:21:56 +0000111
Damien Miller95def091999-11-25 00:26:21 +1100112 /* Open the file containing the list of known hosts. */
113 f = fopen(filename, "r");
114 if (!f)
115 return HOST_NEW;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000116
Damien Miller5428f641999-11-25 11:54:57 +1100117 /*
118 * Return value when the loop terminates. This is set to
119 * HOST_CHANGED if we have seen a different key for the host and have
120 * not found the proper one.
121 */
Damien Miller95def091999-11-25 00:26:21 +1100122 end_return = HOST_NEW;
Damien Miller7e8e8201999-11-16 13:37:16 +1100123
Ben Lindstromab0cedc2001-04-07 17:23:43 +0000124 /* Go through the file. */
Damien Miller95def091999-11-25 00:26:21 +1100125 while (fgets(line, sizeof(line), f)) {
126 cp = line;
127 linenum++;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000128
Damien Miller5428f641999-11-25 11:54:57 +1100129 /* Skip any leading whitespace, comments and empty lines. */
130 for (; *cp == ' ' || *cp == '\t'; cp++)
131 ;
Damien Miller95def091999-11-25 00:26:21 +1100132 if (!*cp || *cp == '#' || *cp == '\n')
133 continue;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000134
Damien Miller95def091999-11-25 00:26:21 +1100135 /* Find the end of the host name portion. */
Damien Miller5428f641999-11-25 11:54:57 +1100136 for (cp2 = cp; *cp2 && *cp2 != ' ' && *cp2 != '\t'; cp2++)
137 ;
Damien Miller7e8e8201999-11-16 13:37:16 +1100138
Damien Miller95def091999-11-25 00:26:21 +1100139 /* Check if the host name matches. */
Ben Lindstrom46c16222000-12-22 01:43:59 +0000140 if (match_hostname(host, cp, (u_int) (cp2 - cp)) != 1)
Damien Miller95def091999-11-25 00:26:21 +1100141 continue;
142
143 /* Got a match. Skip host name. */
144 cp = cp2;
145
Damien Miller5428f641999-11-25 11:54:57 +1100146 /*
147 * Extract the key from the line. This will skip any leading
148 * whitespace. Ignore badly formatted lines.
149 */
Damien Miller450a7a12000-03-26 13:04:51 +1000150 if (!hostfile_read_key(&cp, &kbits, found))
151 continue;
Damien Miller95def091999-11-25 00:26:21 +1100152
Ben Lindstrom46c16222000-12-22 01:43:59 +0000153 if (numret != NULL)
154 *numret = linenum;
155
Ben Lindstrom3ed66402002-08-01 01:21:56 +0000156 if (key == NULL) {
157 /* we found a key of the requested type */
158 if (found->type == keytype)
159 return HOST_FOUND;
160 continue;
161 }
162
163 if (!hostfile_check_key(kbits, found, host, filename, linenum))
164 continue;
165
Damien Miller95def091999-11-25 00:26:21 +1100166 /* Check if the current key is the same as the given key. */
Damien Miller450a7a12000-03-26 13:04:51 +1000167 if (key_equal(key, found)) {
Damien Miller95def091999-11-25 00:26:21 +1100168 /* Ok, they match. */
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000169 debug3("check_host_in_hostfile: match line %d", linenum);
Damien Miller95def091999-11-25 00:26:21 +1100170 fclose(f);
171 return HOST_OK;
172 }
Damien Miller5428f641999-11-25 11:54:57 +1100173 /*
174 * They do not match. We will continue to go through the
175 * file; however, we note that we will not return that it is
176 * new.
177 */
Damien Miller95def091999-11-25 00:26:21 +1100178 end_return = HOST_CHANGED;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000179 }
Damien Miller95def091999-11-25 00:26:21 +1100180 /* Clear variables and close the file. */
181 fclose(f);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000182
Damien Miller5428f641999-11-25 11:54:57 +1100183 /*
184 * Return either HOST_NEW or HOST_CHANGED, depending on whether we
185 * saw a different key for the host.
186 */
Damien Miller95def091999-11-25 00:26:21 +1100187 return end_return;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000188}
189
Ben Lindstrom3ed66402002-08-01 01:21:56 +0000190HostStatus
191check_host_in_hostfile(const char *filename, const char *host, Key *key,
192 Key *found, int *numret)
193{
194 if (key == NULL)
195 fatal("no key to look up");
196 return (check_host_in_hostfile_by_key_or_type(filename, host, key, 0,
197 found, numret));
198}
199
200int
201lookup_key_in_hostfile_by_type(const char *filename, const char *host,
202 int keytype, Key *found, int *numret)
203{
204 return (check_host_in_hostfile_by_key_or_type(filename, host, NULL,
205 keytype, found, numret) == HOST_FOUND);
206}
207
Damien Miller5428f641999-11-25 11:54:57 +1100208/*
209 * Appends an entry to the host file. Returns false if the entry could not
210 * be appended.
211 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000212
213int
Damien Miller450a7a12000-03-26 13:04:51 +1000214add_host_to_hostfile(const char *filename, const char *host, Key *key)
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000215{
Damien Miller95def091999-11-25 00:26:21 +1100216 FILE *f;
Damien Miller450a7a12000-03-26 13:04:51 +1000217 int success = 0;
Damien Miller450a7a12000-03-26 13:04:51 +1000218 if (key == NULL)
Damien Millereba71ba2000-04-29 23:57:08 +1000219 return 1; /* XXX ? */
Damien Miller95def091999-11-25 00:26:21 +1100220 f = fopen(filename, "a");
221 if (!f)
222 return 0;
Damien Miller450a7a12000-03-26 13:04:51 +1000223 fprintf(f, "%s ", host);
224 if (key_write(key, f)) {
Damien Miller450a7a12000-03-26 13:04:51 +1000225 success = 1;
226 } else {
Damien Millereba71ba2000-04-29 23:57:08 +1000227 error("add_host_to_hostfile: saving key in %s failed", filename);
Damien Miller95def091999-11-25 00:26:21 +1100228 }
Damien Millereba71ba2000-04-29 23:57:08 +1000229 fprintf(f, "\n");
Damien Miller95def091999-11-25 00:26:21 +1100230 fclose(f);
Damien Miller450a7a12000-03-26 13:04:51 +1000231 return success;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000232}