| 1 |
.\" $OpenBSD: ssh-keysign.8,v 1.18 2024/06/17 08:30:29 djm Exp $ |
| 2 |
.\" |
| 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 |
.\" |
| 25 |
.Dd $Mdocdate: June 17 2024 $ |
| 26 |
.Dt SSH-KEYSIGN 8 |
| 27 |
.Os |
| 28 |
.Sh NAME |
| 29 |
.Nm ssh-keysign |
| 30 |
.Nd OpenSSH helper for host-based authentication |
| 31 |
.Sh SYNOPSIS |
| 32 |
.Nm |
| 33 |
.Sh DESCRIPTION |
| 34 |
.Nm |
| 35 |
is used by |
| 36 |
.Xr ssh 1 |
| 37 |
to access the local host keys and generate the digital signature |
| 38 |
required during host-based authentication. |
| 39 |
.Pp |
| 40 |
.Nm |
| 41 |
is disabled by default and can only be enabled in the |
| 42 |
global client configuration file |
| 43 |
.Pa /etc/ssh/ssh_config |
| 44 |
by setting |
| 45 |
.Cm EnableSSHKeysign |
| 46 |
to |
| 47 |
.Dq yes . |
| 48 |
.Pp |
| 49 |
.Nm |
| 50 |
is not intended to be invoked by the user, but from |
| 51 |
.Xr ssh 1 . |
| 52 |
See |
| 53 |
.Xr ssh 1 |
| 54 |
and |
| 55 |
.Xr sshd 8 |
| 56 |
for more information about host-based authentication. |
| 57 |
.Sh FILES |
| 58 |
.Bl -tag -width Ds -compact |
| 59 |
.It Pa /etc/ssh/ssh_config |
| 60 |
Controls whether |
| 61 |
.Nm |
| 62 |
is enabled. |
| 63 |
.Pp |
| 64 |
.It Pa /etc/ssh/ssh_host_ecdsa_key |
| 65 |
.It Pa /etc/ssh/ssh_host_ed25519_key |
| 66 |
.It Pa /etc/ssh/ssh_host_rsa_key |
| 67 |
These files contain the private parts of the host keys used to |
| 68 |
generate the digital signature. |
| 69 |
They should be owned by root, readable only by root, and not |
| 70 |
accessible to others. |
| 71 |
Since they are readable only by root, |
| 72 |
.Nm |
| 73 |
must be set-uid root if host-based authentication is used. |
| 74 |
.Pp |
| 75 |
.It Pa /etc/ssh/ssh_host_ecdsa_key-cert.pub |
| 76 |
.It Pa /etc/ssh/ssh_host_ed25519_key-cert.pub |
| 77 |
.It Pa /etc/ssh/ssh_host_rsa_key-cert.pub |
| 78 |
If these files exist, they are assumed to contain public certificate |
| 79 |
information corresponding with the private keys above. |
| 80 |
.El |
| 81 |
.Sh SEE ALSO |
| 82 |
.Xr ssh 1 , |
| 83 |
.Xr ssh-keygen 1 , |
| 84 |
.Xr ssh_config 5 , |
| 85 |
.Xr sshd 8 |
| 86 |
.Sh HISTORY |
| 87 |
.Nm |
| 88 |
first appeared in |
| 89 |
.Ox 3.2 . |
| 90 |
.Sh AUTHORS |
| 91 |
.An Markus Friedl Aq Mt [email protected] |