~ubuntu-branches/ubuntu/lucid/openssh/lucid

« back to all changes in this revision

Viewing changes to sshd.8

  • Committer: Bazaar Package Importer
  • Author(s): Colin Watson
  • Date: 2008-09-30 23:09:58 UTC
  • mfrom: (1.13.3 upstream) (29 hardy)
  • mto: This revision was merged to the branch mainline in revision 43.
  • Revision ID: james.westby@ubuntu.com-20080930230958-o6vsgn8c4mm959s0
Tags: 1:5.1p1-3
* Remove unnecessary ssh-vulnkey output in non-verbose mode when no
  compromised or unknown keys were found (closes: #496495).
* Configure with --disable-strip; dh_strip will deal with stripping
  binaries and will honour DEB_BUILD_OPTIONS (thanks, Bernhard R. Link;
  closes: #498681).
* Fix handling of zero-length server banners (thanks, Tomas Mraz; closes:
  #497026).

Show diffs side-by-side

added added

removed removed

Lines of Context:
34
34
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35
35
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36
36
.\"
37
 
.\" $OpenBSD: sshd.8,v 1.234 2006/08/21 08:15:57 dtucker Exp $
38
 
.Dd September 25, 1999
 
37
.\" $OpenBSD: sshd.8,v 1.246 2008/07/02 02:24:18 djm Exp $
 
38
.Dd $Mdocdate: July 2 2008 $
39
39
.Dt SSHD 8
40
40
.Os
41
41
.Sh NAME
44
44
.Sh SYNOPSIS
45
45
.Nm sshd
46
46
.Bk -words
47
 
.Op Fl 46Ddeiqt
 
47
.Op Fl 46DdeiqTt
48
48
.Op Fl b Ar bits
 
49
.Op Fl C Ar connection_spec
49
50
.Op Fl f Ar config_file
50
51
.Op Fl g Ar login_grace_time
51
52
.Op Fl h Ar host_key_file
58
59
.Nm
59
60
(OpenSSH Daemon) is the daemon program for
60
61
.Xr ssh 1 .
61
 
Together these programs replace rlogin and rsh, and
62
 
provide secure encrypted communications between two untrusted hosts
 
62
Together these programs replace
 
63
.Xr rlogin 1
 
64
and
 
65
.Xr rsh 1 ,
 
66
and provide secure encrypted communications between two untrusted hosts
63
67
over an insecure network.
64
68
.Pp
65
69
.Nm
96
100
to use IPv6 addresses only.
97
101
.It Fl b Ar bits
98
102
Specifies the number of bits in the ephemeral protocol version 1
99
 
server key (default 768).
 
103
server key (default 1024).
 
104
.It Fl C Ar connection_spec
 
105
Specify the connection parameters to use for the
 
106
.Fl T
 
107
extended test mode.
 
108
If provided, any
 
109
.Cm Match
 
110
directives in the configuration file
 
111
that would apply to the specified user, host, and address will be set before
 
112
the configuration is written to standard output.
 
113
The connection parameters are supplied as keyword=value pairs.
 
114
The keywords are
 
115
.Dq user ,
 
116
.Dq host ,
 
117
and
 
118
.Dq addr .
 
119
All are required and may be supplied in any order, either with multiple
 
120
.Fl C
 
121
options or as a comma-separated list.
100
122
.It Fl D
101
123
When this option is specified,
102
124
.Nm
117
139
When this option is specified,
118
140
.Nm
119
141
will send the output to the standard error instead of the system log.
120
 
.It Fl f Ar configuration_file
 
142
.It Fl f Ar config_file
121
143
Specifies the name of the configuration file.
122
144
The default is
123
145
.Pa /etc/ssh/sshd_config .
191
213
If a second 
192
214
.Fl q
193
215
is given then nothing is sent to the system log.
 
216
.It Fl T
 
217
Extended test mode.
 
218
Check the validity of the configuration file, output the effective configuration
 
219
to stdout and then exit.
 
220
Optionally,
 
221
.Cm Match
 
222
rules may be applied by specifying the connection parameters using one or more
 
223
.Fl C
 
224
options.
194
225
.It Fl t
195
226
Test mode.
196
227
Only check the validity of the configuration file and sanity of the keys.
276
307
to use from those offered by the server.
277
308
Additionally, session integrity is provided
278
309
through a cryptographic message authentication code
279
 
(hmac-sha1 or hmac-md5).
 
310
(hmac-md5, hmac-sha1, umac-64 or hmac-ripemd160).
280
311
.Pp
281
312
Finally, the server and the client enter an authentication dialog.
282
313
The client tries to authenticate itself using
302
333
a leading
303
334
.Ql \&*LOCKED\&*
304
335
on FreeBSD and a leading
305
 
.Ql \&!!
306
 
on Linux).  If there is a requirement to disable password authentication
 
336
.Ql \&!
 
337
on most Linuxes).
 
338
If there is a requirement to disable password authentication
307
339
for the account while allowing still public-key, then the passwd field
308
340
should be set to something other than these values (eg
309
341
.Ql NP
502
534
.Cm UseLogin
503
535
is enabled.
504
536
.It Cm from="pattern-list"
505
 
Specifies that in addition to public key authentication, the canonical name
506
 
of the remote host must be present in the comma-separated list of
507
 
patterns.
508
 
The purpose
509
 
of this option is to optionally increase security: public key authentication
510
 
by itself does not trust the network or name servers or anything (but
511
 
the key); however, if somebody somehow steals the key, the key
 
537
Specifies that in addition to public key authentication, either the canonical
 
538
name of the remote host or its IP address must be present in the
 
539
comma-separated list of patterns.
 
540
See
 
541
.Sx PATTERNS
 
542
in
 
543
.Xr ssh_config 5
 
544
for more information on patterns.
 
545
.Pp
 
546
In addition to the wildcard matching that may be applied to hostnames or
 
547
addresses, a
 
548
.Cm from
 
549
stanza may match IP addressess using CIDR address/masklen notation.
 
550
.Pp
 
551
The purpose of this option is to optionally increase security: public key
 
552
authentication by itself does not trust the network or name servers or
 
553
anything (but the key); however, if somebody somehow steals the key, the key
512
554
permits an intruder to log in from anywhere in the world.
513
555
This additional option makes using a stolen key more difficult (name
514
556
servers and/or routers would have to be compromised in addition to
515
557
just the key).
516
 
.Pp
517
 
See
518
 
.Sx PATTERNS
519
 
in
520
 
.Xr ssh_config 5
521
 
for more information on patterns.
522
558
.It Cm no-agent-forwarding
523
559
Forbids authentication agent forwarding when this key is used for
524
560
authentication.
530
566
option.
531
567
.It Cm no-pty
532
568
Prevents tty allocation (a request to allocate a pty will fail).
 
569
.It Cm no-user-rc
 
570
Disables execution of
 
571
.Pa ~/.ssh/rc .
533
572
.It Cm no-X11-forwarding
534
573
Forbids X11 forwarding when this key is used for authentication.
535
574
Any X11 forward requests by the client will return an error.
681
720
but allows host-based authentication without permitting login with
682
721
rlogin/rsh.
683
722
.Pp
 
723
.It ~/.ssh/
 
724
This directory is the default location for all user-specific configuration
 
725
and authentication information.
 
726
There is no general requirement to keep the entire contents of this directory
 
727
secret, but the recommended permissions are read/write/execute for the user,
 
728
and not accessible by others.
 
729
.Pp
684
730
.It ~/.ssh/authorized_keys
685
731
Lists the public keys (RSA/DSA) that can be used for logging in as this user.
686
732
The format of this file is described above.
761
807
but allows host-based authentication without permitting login with
762
808
rlogin/rsh.
763
809
.Pp
764
 
.It /etc/ssh/ssh_known_hosts
765
 
Systemwide list of known host keys.
766
 
This file should be prepared by the
767
 
system administrator to contain the public host keys of all machines in the
768
 
organization.
769
 
The format of this file is described above.
770
 
This file should be writable only by root/the owner and
771
 
should be world-readable.
772
 
.Pp
773
810
.It /etc/ssh/ssh_host_key
774
811
.It /etc/ssh/ssh_host_dsa_key
775
812
.It /etc/ssh/ssh_host_rsa_key
793
830
These files are created using
794
831
.Xr ssh-keygen 1 .
795
832
.Pp
 
833
.It /etc/ssh/ssh_known_hosts
 
834
Systemwide list of known host keys.
 
835
This file should be prepared by the
 
836
system administrator to contain the public host keys of all machines in the
 
837
organization.
 
838
The format of this file is described above.
 
839
This file should be writable only by root/the owner and
 
840
should be world-readable.
 
841
.Pp
796
842
.It /etc/ssh/sshd_config
797
843
Contains configuration data for
798
844
.Nm sshd .
829
875
.Xr ssh-add 1 ,
830
876
.Xr ssh-agent 1 ,
831
877
.Xr ssh-keygen 1 ,
 
878
.Xr ssh-keyscan 1 ,
 
879
.Xr ssh-vulnkey 1 ,
832
880
.Xr chroot 2 ,
833
881
.Xr hosts_access 5 ,
834
882
.Xr login.conf 5 ,