293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / ssh-keysign.1m
blob1ab228a28af4a270d8c5f9ec1d40ea02fecf33f2
1 '\" te
2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SSH-KEYSIGN 1M "Jun 9, 2004"
7 .SH NAME
8 ssh-keysign \- ssh helper program for host-based authentication
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBssh-keysign\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 \fBssh-keysign\fR is used by \fBssh\fR(1) to access the local host keys and
19 generate the digital signature required during host-based authentication with
20 SSH protocol version 2. This signature is of data that includes, among other
21 items, the name of the client host and the name of the client user.
22 .sp
23 .LP
24 \fBssh-keysign\fR is disabled by default and can be enabled only in the global
25 client configuration file \fB/etc/ssh/ssh_config\fR by setting
26 \fBHostbasedAuthentication\fR to \fByes\fR.
27 .sp
28 .LP
29 \fBssh-keysign\fR is not intended to be invoked by the user, but from
30 \fBssh\fR. See \fBssh\fR(1) and \fBsshd\fR(1M) for more information about
31 host-based authentication.
32 .SH FILES
33 .sp
34 .ne 2
35 .na
36 \fB\fB/etc/ssh/ssh_config\fR\fR
37 .ad
38 .RS 29n
39 Controls whether \fBssh-keysign\fR is enabled.
40 .RE
42 .sp
43 .ne 2
44 .na
45 \fB\fB/etc/ssh/ssh_host_dsa_key\fR\fR
46 .ad
47 .br
48 .na
49 \fB\fB/etc/ssh/ssh_host_rsa_key\fR\fR
50 .ad
51 .RS 29n
52 These files contain the private parts of the host keys used to generate the
53 digital signature. They should be owned by root, readable only by root, and not
54 accessible to others. Because they are readable only by root, \fBssh-keysign\fR
55 must be \fBset-uid\fR root if host-based authentication is used.
56 .RE
58 .SH SECURITY
59 .sp
60 .LP
61 ssh-keysign will not sign host-based authentication data under the following
62 conditions:
63 .RS +4
64 .TP
65 .ie t \(bu
66 .el o
67 If the \fBHostbasedAuthentication\fR client configuration parameter is not set
68 to \fByes\fR in \fB/etc/ssh/ssh_config\fR. This setting cannot be overriden in
69 users' \fB~/.ssh/ssh_config\fR files.
70 .RE
71 .RS +4
72 .TP
73 .ie t \(bu
74 .el o
75 If the client hostname and username in \fB/etc/ssh/ssh_config\fR do not match
76 the canonical hostname of the client where \fBssh-keysign\fR is invoked and the
77 name of the user invoking \fBssh-keysign\fR.
78 .RE
79 .sp
80 .LP
81 In spite of \fBssh-keysign\fR's restrictions on the contents of the host-based
82 authentication data, there remains the ability of users to use it as an avenue
83 for obtaining the client's private host keys. For this reason host-based
84 authentication is turned off by default.
85 .SH ATTRIBUTES
86 .sp
87 .LP
88 See \fBattributes\fR(5) for descriptions of the following attributes:
89 .sp
91 .sp
92 .TS
93 box;
94 c | c
95 l | l .
96 ATTRIBUTE TYPE  ATTRIBUTE VALUE
98 Interface Stability     Evolving
99 .TE
101 .SH SEE ALSO
104 \fBssh\fR(1), \fBsshd\fR(1M), \fBssh_config\fR(4), \fBattributes\fR(5)
105 .SH AUTHORS
108 Markus Friedl, \fBmarkus@openbsd.org\fR
109 .SH HISTORY
112 \fBssh-keysign\fR first appeared in Ox 3.2.