crypto/openssh/hostfile.c

   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.30 2002/07/24 16:11:18 markus Exp $");
  40 RCSID("$FreeBSD: src/crypto/openssh/hostfile.c,v 1.1.1.1.2.5 2003/02/03 17:31:06 des Exp $");
  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 static int
  76 hostfile_check_key(int bits, Key *key, const char *host, const char *filename, int linenum)
  77 {
  78         if (key == NULL || key->type != KEY_RSA1 || key->rsa == NULL)
  79                 return 1;
  80         if (bits != BN_num_bits(key->rsa->n)) {
  81                 log("Warning: %s, line %d: keysize mismatch for host %s: "
  82                     "actual %d vs. announced %d.",
  83                     filename, linenum, host, BN_num_bits(key->rsa->n), bits);
  84                 log("Warning: replace %d with %d in %s, line %d.",
  85                     bits, BN_num_bits(key->rsa->n), filename, linenum);
  86         }
  87         return 1;
  88 }
  89
  90 /*
  91  * Checks whether the given host (which must be in all lowercase) is already
  92  * in the list of our known hosts. Returns HOST_OK if the host is known and
  93  * has the specified key, HOST_NEW if the host is not known, and HOST_CHANGED
  94  * if the host is known but used to have a different host key.
  95  *
  96  * If no 'key' has been specified and a key of type 'keytype' is known
  97  * for the specified host, then HOST_FOUND is returned.
  98  */
  99
 100 static HostStatus
 101 check_host_in_hostfile_by_key_or_type(const char *filename,
 102     const char *host, Key *key, int keytype, Key *found, int *numret)
 103 {
 104         FILE *f;
 105         char line[8192];
 106         int linenum = 0;
 107         u_int kbits;
 108         char *cp, *cp2;
 109         HostStatus end_return;
 110
 111         debug3("check_host_in_hostfile: filename %s", filename);
 112
 113         /* Open the file containing the list of known hosts. */
 114         f = fopen(filename, "r");
 115         if (!f)
 116                 return HOST_NEW;
 117
 118         /*
 119          * Return value when the loop terminates.  This is set to
 120          * HOST_CHANGED if we have seen a different key for the host and have
 121          * not found the proper one.
 122          */
 123         end_return = HOST_NEW;
 124
 125         /* Go through the file. */
 126         while (fgets(line, sizeof(line), f)) {
 127                 cp = line;
 128                 linenum++;
 129
 130                 /* Skip any leading whitespace, comments and empty lines. */
 131                 for (; *cp == ' ' || *cp == '\t'; cp++)
 132                         ;
 133                 if (!*cp || *cp == '#' || *cp == '\n')
 134                         continue;
 135
 136                 /* Find the end of the host name portion. */
 137                 for (cp2 = cp; *cp2 && *cp2 != ' ' && *cp2 != '\t'; cp2++)
 138                         ;
 139
 140                 /* Check if the host name matches. */
 141                 if (match_hostname(host, cp, (u_int) (cp2 - cp)) != 1)
 142                         continue;
 143
 144                 /* Got a match.  Skip host name. */
 145                 cp = cp2;
 146
 147                 /*
 148                  * Extract the key from the line.  This will skip any leading
 149                  * whitespace.  Ignore badly formatted lines.
 150                  */
 151                 if (!hostfile_read_key(&cp, &kbits, found))
 152                         continue;
 153
 154                 if (numret != NULL)
 155                         *numret = linenum;
 156
 157                 if (key == NULL) {
 158                         /* we found a key of the requested type */
 159                         if (found->type == keytype)
 160                                 return HOST_FOUND;
 161                         continue;
 162                 }
 163
 164                 if (!hostfile_check_key(kbits, found, host, filename, linenum))
 165                         continue;
 166
 167                 /* Check if the current key is the same as the given key. */
 168                 if (key_equal(key, found)) {
 169                         /* Ok, they match. */
 170                         debug3("check_host_in_hostfile: match line %d", linenum);
 171                         fclose(f);
 172                         return HOST_OK;
 173                 }
 174                 /*
 175                  * They do not match.  We will continue to go through the
 176                  * file; however, we note that we will not return that it is
 177                  * new.
 178                  */
 179                 end_return = HOST_CHANGED;
 180         }
 181         /* Clear variables and close the file. */
 182         fclose(f);
 183
 184         /*
 185          * Return either HOST_NEW or HOST_CHANGED, depending on whether we
 186          * saw a different key for the host.
 187          */
 188         return end_return;
 189 }
 190
 191 HostStatus
 192 check_host_in_hostfile(const char *filename, const char *host, Key *key,
 193     Key *found, int *numret)
 194 {
 195         if (key == NULL)
 196                 fatal("no key to look up");
 197         return (check_host_in_hostfile_by_key_or_type(filename, host, key, 0,
 198             found, numret));
 199 }
 200
 201 int
 202 lookup_key_in_hostfile_by_type(const char *filename, const char *host,
 203     int keytype, Key *found, int *numret)
 204 {
 205         return (check_host_in_hostfile_by_key_or_type(filename, host, NULL,
 206             keytype, found, numret) == HOST_FOUND);
 207 }
 208
 209 /*
 210  * Appends an entry to the host file.  Returns false if the entry could not
 211  * be appended.
 212  */
 213
 214 int
 215 add_host_to_hostfile(const char *filename, const char *host, Key *key)
 216 {
 217         FILE *f;
 218         int success = 0;
 219         if (key == NULL)
 220                 return 1;       /* XXX ? */
 221         f = fopen(filename, "a");
 222         if (!f)
 223                 return 0;
 224         fprintf(f, "%s ", host);
 225         if (key_write(key, f)) {
 226                 success = 1;
 227         } else {
 228                 error("add_host_to_hostfile: saving key in %s failed", filename);
 229         }
 230         fprintf(f, "\n");
 231         fclose(f);
 232         return success;
 233 }