crypto/openssh/ssh-keyscan.1

   1 .\"     $OpenBSD: ssh-keyscan.1,v 1.29 2010/08/31 11:54:45 djm Exp $
   2 .\"     $FreeBSD$
   3 .\"
   4 .\" Copyright 1995, 1996 by David Mazieres <dm@lcs.mit.edu>.
   5 .\"
   6 .\" Modification and redistribution in source and binary forms is
   7 .\" permitted provided that due credit is given to the author and the
   8 .\" OpenBSD project by leaving this copyright notice intact.
   9 .\"
  10 .Dd August 31, 2010
  11 .Dt SSH-KEYSCAN 1
  12 .Os
  13 .Sh NAME
  14 .Nm ssh-keyscan
  15 .Nd gather ssh public keys
  16 .Sh SYNOPSIS
  17 .Nm ssh-keyscan
  18 .Bk -words
  19 .Op Fl 46Hv
  20 .Op Fl f Ar file
  21 .Op Fl p Ar port
  22 .Op Fl T Ar timeout
  23 .Op Fl t Ar type
  24 .Op Ar host | addrlist namelist
  25 .Ar ...
  26 .Ek
  27 .Sh DESCRIPTION
  28 .Nm
  29 is a utility for gathering the public ssh host keys of a number of
  30 hosts.
  31 It was designed to aid in building and verifying
  32 .Pa ssh_known_hosts
  33 files.
  34 .Nm
  35 provides a minimal interface suitable for use by shell and perl
  36 scripts.
  37 .Pp
  38 .Nm
  39 uses non-blocking socket I/O to contact as many hosts as possible in
  40 parallel, so it is very efficient.
  41 The keys from a domain of 1,000
  42 hosts can be collected in tens of seconds, even when some of those
  43 hosts are down or do not run ssh.
  44 For scanning, one does not need
  45 login access to the machines that are being scanned, nor does the
  46 scanning process involve any encryption.
  47 .Pp
  48 The options are as follows:
  49 .Bl -tag -width Ds
  50 .It Fl 4
  51 Forces
  52 .Nm
  53 to use IPv4 addresses only.
  54 .It Fl 6
  55 Forces
  56 .Nm
  57 to use IPv6 addresses only.
  58 .It Fl f Ar file
  59 Read hosts or
  60 .Pa addrlist namelist
  61 pairs from this file, one per line.
  62 If
  63 .Pa -
  64 is supplied instead of a filename,
  65 .Nm
  66 will read hosts or
  67 .Pa addrlist namelist
  68 pairs from the standard input.
  69 .It Fl H
  70 Hash all hostnames and addresses in the output.
  71 Hashed names may be used normally by
  72 .Nm ssh
  73 and
  74 .Nm sshd ,
  75 but they do not reveal identifying information should the file's contents
  76 be disclosed.
  77 .It Fl p Ar port
  78 Port to connect to on the remote host.
  79 .It Fl T Ar timeout
  80 Set the timeout for connection attempts.
  81 If
  82 .Pa timeout
  83 seconds have elapsed since a connection was initiated to a host or since the
  84 last time anything was read from that host, then the connection is
  85 closed and the host in question considered unavailable.
  86 Default is 5 seconds.
  87 .It Fl t Ar type
  88 Specifies the type of the key to fetch from the scanned hosts.
  89 The possible values are
  90 .Dq rsa1
  91 for protocol version 1 and
  92 .Dq dsa ,
  93 .Dq ecdsa
  94 or
  95 .Dq rsa
  96 for protocol version 2.
  97 Multiple values may be specified by separating them with commas.
  98 The default is
  99 .Dq rsa .
 100 .It Fl v
 101 Verbose mode.
 102 Causes
 103 .Nm
 104 to print debugging messages about its progress.
 105 .El
 106 .Sh SECURITY
 107 If an ssh_known_hosts file is constructed using
 108 .Nm
 109 without verifying the keys, users will be vulnerable to
 110 .Em man in the middle
 111 attacks.
 112 On the other hand, if the security model allows such a risk,
 113 .Nm
 114 can help in the detection of tampered keyfiles or man in the middle
 115 attacks which have begun after the ssh_known_hosts file was created.
 116 .Sh FILES
 117 .Pa Input format:
 118 .Bd -literal
 119 1.2.3.4,1.2.4.4 name.my.domain,name,n.my.domain,n,1.2.3.4,1.2.4.4
 120 .Ed
 121 .Pp
 122 .Pa Output format for rsa1 keys:
 123 .Bd -literal
 124 host-or-namelist bits exponent modulus
 125 .Ed
 126 .Pp
 127 .Pa Output format for rsa, dsa and ecdsa keys:
 128 .Bd -literal
 129 host-or-namelist keytype base64-encoded-key
 130 .Ed
 131 .Pp
 132 Where
 133 .Pa keytype
 134 is either
 135 .Dq ecdsa-sha2-nistp256 ,
 136 .Dq ecdsa-sha2-nistp384 ,
 137 .Dq ecdsa-sha2-nistp521 ,
 138 .Dq ssh-dss
 139 or
 140 .Dq ssh-rsa .
 141 .Pp
 142 .Pa /etc/ssh/ssh_known_hosts
 143 .Sh EXAMPLES
 144 Print the
 145 .Pa rsa
 146 host key for machine
 147 .Pa hostname :
 148 .Bd -literal
 149 $ ssh-keyscan hostname
 150 .Ed
 151 .Pp
 152 Find all hosts from the file
 153 .Pa ssh_hosts
 154 which have new or different keys from those in the sorted file
 155 .Pa ssh_known_hosts :
 156 .Bd -literal
 157 $ ssh-keyscan -t rsa,dsa,ecdsa -f ssh_hosts | \e
 158         sort -u - ssh_known_hosts | diff ssh_known_hosts -
 159 .Ed
 160 .Sh SEE ALSO
 161 .Xr ssh 1 ,
 162 .Xr sshd 8
 163 .Sh AUTHORS
 164 .An -nosplit
 165 .An David Mazieres Aq dm@lcs.mit.edu
 166 wrote the initial version, and
 167 .An Wayne Davison Aq wayned@users.sourceforge.net
 168 added support for protocol version 2.
 169 .Sh BUGS
 170 It generates "Connection closed by remote host" messages on the consoles
 171 of all the machines it scans if the server is older than version 2.9.
 172 This is because it opens a connection to the ssh port, reads the public
 173 key, and drops the connection as soon as it gets the key.