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