blob: 19b0dbc533c8e7f7406b3f82deef3f8b4165e49e [file] [log] [blame]
jmc@openbsd.orga685ae82016-02-17 07:38:19 +00001.\" $OpenBSD: ssh-keysign.8,v 1.15 2016/02/17 07:38:19 jmc Exp $
Ben Lindstrom1bad2562002-06-06 19:57:33 +00002.\"
3.\" Copyright (c) 2002 Markus Friedl. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\" notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\" notice, this list of conditions and the following disclaimer in the
12.\" documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
jmc@openbsd.orga685ae82016-02-17 07:38:19 +000025.Dd $Mdocdate: February 17 2016 $
Ben Lindstrom1bad2562002-06-06 19:57:33 +000026.Dt SSH-KEYSIGN 8
27.Os
28.Sh NAME
29.Nm ssh-keysign
Damien Miller1faa7132006-03-15 11:55:31 +110030.Nd ssh helper program for host-based authentication
Ben Lindstrom1bad2562002-06-06 19:57:33 +000031.Sh SYNOPSIS
Ben Lindstrom11d470d2002-06-11 15:50:13 +000032.Nm
Ben Lindstrom1bad2562002-06-06 19:57:33 +000033.Sh DESCRIPTION
34.Nm
35is used by
36.Xr ssh 1
Ben Lindstrom11d470d2002-06-11 15:50:13 +000037to access the local host keys and generate the digital signature
jmc@openbsd.orga685ae82016-02-17 07:38:19 +000038required during host-based authentication.
Ben Lindstrom5d35a2f2002-07-04 00:19:40 +000039.Pp
40.Nm
41is disabled by default and can only be enabled in the
Ben Lindstrom2594d9a2002-12-23 02:09:59 +000042global client configuration file
Ben Lindstrom5d35a2f2002-07-04 00:19:40 +000043.Pa /etc/ssh/ssh_config
44by setting
Ben Lindstromb6df73b2002-11-09 15:52:31 +000045.Cm EnableSSHKeysign
Ben Lindstrom5d35a2f2002-07-04 00:19:40 +000046to
47.Dq yes .
48.Pp
Ben Lindstrom1bad2562002-06-06 19:57:33 +000049.Nm
50is not intended to be invoked by the user, but from
51.Xr ssh 1 .
52See
53.Xr ssh 1
54and
55.Xr sshd 8
Damien Miller1faa7132006-03-15 11:55:31 +110056for more information about host-based authentication.
Ben Lindstrom11d470d2002-06-11 15:50:13 +000057.Sh FILES
Damien Millerafdae612010-08-31 22:31:14 +100058.Bl -tag -width Ds -compact
Ben Lindstrom5d35a2f2002-07-04 00:19:40 +000059.It Pa /etc/ssh/ssh_config
60Controls whether
61.Nm
62is enabled.
Damien Millerafdae612010-08-31 22:31:14 +100063.Pp
64.It Pa /etc/ssh/ssh_host_dsa_key
Damien Millereb8b60e2010-08-31 22:41:14 +100065.It Pa /etc/ssh/ssh_host_ecdsa_key
Damien Miller8ba0ead2013-12-18 17:46:27 +110066.It Pa /etc/ssh/ssh_host_ed25519_key
Damien Millerafdae612010-08-31 22:31:14 +100067.It Pa /etc/ssh/ssh_host_rsa_key
Ben Lindstrom11d470d2002-06-11 15:50:13 +000068These files contain the private parts of the host keys used to
Damien Miller495dca32003-04-01 21:42:14 +100069generate the digital signature.
70They should be owned by root, readable only by root, and not
Ben Lindstrom11d470d2002-06-11 15:50:13 +000071accessible to others.
72Since they are readable only by root,
73.Nm
Damien Miller1faa7132006-03-15 11:55:31 +110074must be set-uid root if host-based authentication is used.
Damien Millerafdae612010-08-31 22:31:14 +100075.Pp
76.It Pa /etc/ssh/ssh_host_dsa_key-cert.pub
Damien Millereb8b60e2010-08-31 22:41:14 +100077.It Pa /etc/ssh/ssh_host_ecdsa_key-cert.pub
Damien Miller8ba0ead2013-12-18 17:46:27 +110078.It Pa /etc/ssh/ssh_host_ed25519_key-cert.pub
Damien Millerafdae612010-08-31 22:31:14 +100079.It Pa /etc/ssh/ssh_host_rsa_key-cert.pub
Damien Millerc1583312010-08-05 13:04:50 +100080If these files exist they are assumed to contain public certificate
81information corresponding with the private keys above.
Ben Lindstrom11d470d2002-06-11 15:50:13 +000082.El
Ben Lindstrom1bad2562002-06-06 19:57:33 +000083.Sh SEE ALSO
84.Xr ssh 1 ,
Ben Lindstrom11d470d2002-06-11 15:50:13 +000085.Xr ssh-keygen 1 ,
Ben Lindstrom5d35a2f2002-07-04 00:19:40 +000086.Xr ssh_config 5 ,
Ben Lindstrom1bad2562002-06-06 19:57:33 +000087.Xr sshd 8
Ben Lindstrom1bad2562002-06-06 19:57:33 +000088.Sh HISTORY
89.Nm
90first appeared in
91.Ox 3.2 .
Damien Millerf1ce5052003-06-11 22:04:39 +100092.Sh AUTHORS
Damien Millerbf836e52013-07-18 16:14:13 +100093.An Markus Friedl Aq Mt markus@openbsd.org