xref: /freebsd/crypto/openssh/ssh-keysign.8 (revision 9ecd54f24fe9fa373e07c9fd7c052deb2188f545)
1.\" $OpenBSD: ssh-keysign.8,v 1.14 2013/12/07 11:58:46 naddy Exp $
2.\" $FreeBSD$
3.\"
4.\" Copyright (c) 2002 Markus Friedl.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd December 7, 2013
27.Dt SSH-KEYSIGN 8
28.Os
29.Sh NAME
30.Nm ssh-keysign
31.Nd ssh helper program for host-based authentication
32.Sh SYNOPSIS
33.Nm
34.Sh DESCRIPTION
35.Nm
36is used by
37.Xr ssh 1
38to access the local host keys and generate the digital signature
39required during host-based authentication with SSH protocol version 2.
40.Pp
41.Nm
42is disabled by default and can only be enabled in the
43global client configuration file
44.Pa /etc/ssh/ssh_config
45by setting
46.Cm EnableSSHKeysign
47to
48.Dq yes .
49.Pp
50.Nm
51is not intended to be invoked by the user, but from
52.Xr ssh 1 .
53See
54.Xr ssh 1
55and
56.Xr sshd 8
57for more information about host-based authentication.
58.Sh FILES
59.Bl -tag -width Ds -compact
60.It Pa /etc/ssh/ssh_config
61Controls whether
62.Nm
63is enabled.
64.Pp
65.It Pa /etc/ssh/ssh_host_dsa_key
66.It Pa /etc/ssh/ssh_host_ecdsa_key
67.It Pa /etc/ssh/ssh_host_ed25519_key
68.It Pa /etc/ssh/ssh_host_rsa_key
69These files contain the private parts of the host keys used to
70generate the digital signature.
71They should be owned by root, readable only by root, and not
72accessible to others.
73Since they are readable only by root,
74.Nm
75must be set-uid root if host-based authentication is used.
76.Pp
77.It Pa /etc/ssh/ssh_host_dsa_key-cert.pub
78.It Pa /etc/ssh/ssh_host_ecdsa_key-cert.pub
79.It Pa /etc/ssh/ssh_host_ed25519_key-cert.pub
80.It Pa /etc/ssh/ssh_host_rsa_key-cert.pub
81If these files exist they are assumed to contain public certificate
82information corresponding with the private keys above.
83.El
84.Sh SEE ALSO
85.Xr ssh 1 ,
86.Xr ssh-keygen 1 ,
87.Xr ssh_config 5 ,
88.Xr sshd 8
89.Sh HISTORY
90.Nm
91first appeared in
92.Ox 3.2 .
93.Sh AUTHORS
94.An Markus Friedl Aq Mt markus@openbsd.org
95