crypto/openssh/ssh-keyscan.1

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