xref: /freebsd/crypto/openssh/hostfile.c (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
1 /*
2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4  *                    All rights reserved
5  * Functions for manipulating the known hosts files.
6  *
7  * 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  *
14  * Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
15  * 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.
36  */
37 
38 #include "includes.h"
39 RCSID("$OpenBSD: hostfile.c,v 1.26 2001/04/12 19:15:24 markus Exp $");
40 RCSID("$FreeBSD$");
41 
42 #include "packet.h"
43 #include "match.h"
44 #include "key.h"
45 #include "hostfile.h"
46 #include "log.h"
47 
48 /*
49  * Parses an RSA (number of bits, e, n) or DSA key from a string.  Moves the
50  * pointer over the key.  Skips any whitespace at the beginning and at end.
51  */
52 
53 int
54 hostfile_read_key(char **cpp, u_int *bitsp, Key *ret)
55 {
56 	char *cp;
57 
58 	/* Skip leading whitespace. */
59 	for (cp = *cpp; *cp == ' ' || *cp == '\t'; cp++)
60 		;
61 
62 	if (key_read(ret, &cp) != 1)
63 		return 0;
64 
65 	/* Skip trailing whitespace. */
66 	for (; *cp == ' ' || *cp == '\t'; cp++)
67 		;
68 
69 	/* Return results. */
70 	*cpp = cp;
71 	*bitsp = key_size(ret);
72 	return 1;
73 }
74 
75 int
76 auth_rsa_read_key(char **cpp, u_int *bitsp, BIGNUM * e, BIGNUM * n)
77 {
78 	Key *k = key_new(KEY_RSA1);
79 	int ret = hostfile_read_key(cpp, bitsp, k);
80 	BN_copy(e, k->rsa->e);
81 	BN_copy(n, k->rsa->n);
82 	key_free(k);
83 	return ret;
84 }
85 
86 int
87 hostfile_check_key(int bits, Key *key, const char *host, const char *filename, int linenum)
88 {
89 	if (key == NULL || key->type != KEY_RSA1 || key->rsa == NULL)
90 		return 1;
91 	if (bits != BN_num_bits(key->rsa->n)) {
92 		log("Warning: %s, line %d: keysize mismatch for host %s: "
93 		    "actual %d vs. announced %d.",
94 		    filename, linenum, host, BN_num_bits(key->rsa->n), bits);
95 		log("Warning: replace %d with %d in %s, line %d.",
96 		    bits, BN_num_bits(key->rsa->n), filename, linenum);
97 	}
98 	return 1;
99 }
100 
101 /*
102  * Checks whether the given host (which must be in all lowercase) is already
103  * in the list of our known hosts. Returns HOST_OK if the host is known and
104  * has the specified key, HOST_NEW if the host is not known, and HOST_CHANGED
105  * if the host is known but used to have a different host key.
106  */
107 
108 HostStatus
109 check_host_in_hostfile(const char *filename, const char *host, Key *key,
110     Key *found, int *numret)
111 {
112 	FILE *f;
113 	char line[8192];
114 	int linenum = 0;
115 	u_int kbits;
116 	char *cp, *cp2;
117 	HostStatus end_return;
118 
119 	debug3("check_host_in_hostfile: filename %s", filename);
120 	if (key == NULL)
121 		fatal("no key to look up");
122 	/* Open the file containing the list of known hosts. */
123 	f = fopen(filename, "r");
124 	if (!f)
125 		return HOST_NEW;
126 
127 	/*
128 	 * Return value when the loop terminates.  This is set to
129 	 * HOST_CHANGED if we have seen a different key for the host and have
130 	 * not found the proper one.
131 	 */
132 	end_return = HOST_NEW;
133 
134 	/* Go through the file. */
135 	while (fgets(line, sizeof(line), f)) {
136 		cp = line;
137 		linenum++;
138 
139 		/* Skip any leading whitespace, comments and empty lines. */
140 		for (; *cp == ' ' || *cp == '\t'; cp++)
141 			;
142 		if (!*cp || *cp == '#' || *cp == '\n')
143 			continue;
144 
145 		/* Find the end of the host name portion. */
146 		for (cp2 = cp; *cp2 && *cp2 != ' ' && *cp2 != '\t'; cp2++)
147 			;
148 
149 		/* Check if the host name matches. */
150 		if (match_hostname(host, cp, (u_int) (cp2 - cp)) != 1)
151 			continue;
152 
153 		/* Got a match.  Skip host name. */
154 		cp = cp2;
155 
156 		/*
157 		 * Extract the key from the line.  This will skip any leading
158 		 * whitespace.  Ignore badly formatted lines.
159 		 */
160 		if (!hostfile_read_key(&cp, &kbits, found))
161 			continue;
162 		if (!hostfile_check_key(kbits, found, host, filename, linenum))
163 			continue;
164 
165 		if (numret != NULL)
166 			*numret = linenum;
167 
168 		/* Check if the current key is the same as the given key. */
169 		if (key_equal(key, found)) {
170 			/* Ok, they match. */
171 			debug3("check_host_in_hostfile: match line %d", linenum);
172 			fclose(f);
173 			return HOST_OK;
174 		}
175 		/*
176 		 * They do not match.  We will continue to go through the
177 		 * file; however, we note that we will not return that it is
178 		 * new.
179 		 */
180 		end_return = HOST_CHANGED;
181 	}
182 	/* Clear variables and close the file. */
183 	fclose(f);
184 
185 	/*
186 	 * Return either HOST_NEW or HOST_CHANGED, depending on whether we
187 	 * saw a different key for the host.
188 	 */
189 	return end_return;
190 }
191 
192 /*
193  * Appends an entry to the host file.  Returns false if the entry could not
194  * be appended.
195  */
196 
197 int
198 add_host_to_hostfile(const char *filename, const char *host, Key *key)
199 {
200 	FILE *f;
201 	int success = 0;
202 	if (key == NULL)
203 		return 1;	/* XXX ? */
204 	f = fopen(filename, "a");
205 	if (!f)
206 		return 0;
207 	fprintf(f, "%s ", host);
208 	if (key_write(key, f)) {
209 		success = 1;
210 	} else {
211 		error("add_host_to_hostfile: saving key in %s failed", filename);
212 	}
213 	fprintf(f, "\n");
214 	fclose(f);
215 	return success;
216 }
217