summaryrefslogtreecommitdiff
path: root/ssh.0
diff options
context:
space:
mode:
Diffstat (limited to 'ssh.0')
-rw-r--r--ssh.0982
1 files changed, 982 insertions, 0 deletions
diff --git a/ssh.0 b/ssh.0
new file mode 100644
index 000000000..2d8994ffc
--- /dev/null
+++ b/ssh.0
@@ -0,0 +1,982 @@
1SSH(1) General Commands Manual SSH(1)
2
3NAME
4 ssh M-bM-^@M-^S OpenSSH SSH client (remote login program)
5
6SYNOPSIS
7 ssh [-46AaCfGgKkMNnqsTtVvXxYy] [-B bind_interface] [-b bind_address]
8 [-c cipher_spec] [-D [bind_address:]port] [-E log_file]
9 [-e escape_char] [-F configfile] [-I pkcs11] [-i identity_file]
10 [-J destination] [-L address] [-l login_name] [-m mac_spec]
11 [-O ctl_cmd] [-o option] [-p port] [-Q query_option] [-R address]
12 [-S ctl_path] [-W host:port] [-w local_tun[:remote_tun]] destination
13 [command]
14
15DESCRIPTION
16 ssh (SSH client) is a program for logging into a remote machine and for
17 executing commands on a remote machine. It is intended to provide secure
18 encrypted communications between two untrusted hosts over an insecure
19 network. X11 connections, arbitrary TCP ports and UNIX-domain sockets
20 can also be forwarded over the secure channel.
21
22 ssh connects and logs into the specified destination, which may be
23 specified as either [user@]hostname or a URI of the form
24 ssh://[user@]hostname[:port]. The user must prove his/her identity to
25 the remote machine using one of several methods (see below).
26
27 If a command is specified, it is executed on the remote host instead of a
28 login shell.
29
30 The options are as follows:
31
32 -4 Forces ssh to use IPv4 addresses only.
33
34 -6 Forces ssh to use IPv6 addresses only.
35
36 -A Enables forwarding of the authentication agent connection. This
37 can also be specified on a per-host basis in a configuration
38 file.
39
40 Agent forwarding should be enabled with caution. Users with the
41 ability to bypass file permissions on the remote host (for the
42 agent's UNIX-domain socket) can access the local agent through
43 the forwarded connection. An attacker cannot obtain key material
44 from the agent, however they can perform operations on the keys
45 that enable them to authenticate using the identities loaded into
46 the agent.
47
48 -a Disables forwarding of the authentication agent connection.
49
50 -B bind_interface
51 Bind to the address of bind_interface before attempting to
52 connect to the destination host. This is only useful on systems
53 with more than one address.
54
55 -b bind_address
56 Use bind_address on the local machine as the source address of
57 the connection. Only useful on systems with more than one
58 address.
59
60 -C Requests compression of all data (including stdin, stdout,
61 stderr, and data for forwarded X11, TCP and UNIX-domain
62 connections). The compression algorithm is the same used by
63 gzip(1). Compression is desirable on modem lines and other slow
64 connections, but will only slow down things on fast networks.
65 The default value can be set on a host-by-host basis in the
66 configuration files; see the Compression option.
67
68 -c cipher_spec
69 Selects the cipher specification for encrypting the session.
70 cipher_spec is a comma-separated list of ciphers listed in order
71 of preference. See the Ciphers keyword in ssh_config(5) for more
72 information.
73
74 -D [bind_address:]port
75 Specifies a local M-bM-^@M-^\dynamicM-bM-^@M-^] application-level port forwarding.
76 This works by allocating a socket to listen to port on the local
77 side, optionally bound to the specified bind_address. Whenever a
78 connection is made to this port, the connection is forwarded over
79 the secure channel, and the application protocol is then used to
80 determine where to connect to from the remote machine. Currently
81 the SOCKS4 and SOCKS5 protocols are supported, and ssh will act
82 as a SOCKS server. Only root can forward privileged ports.
83 Dynamic port forwardings can also be specified in the
84 configuration file.
85
86 IPv6 addresses can be specified by enclosing the address in
87 square brackets. Only the superuser can forward privileged
88 ports. By default, the local port is bound in accordance with
89 the GatewayPorts setting. However, an explicit bind_address may
90 be used to bind the connection to a specific address. The
91 bind_address of M-bM-^@M-^\localhostM-bM-^@M-^] indicates that the listening port be
92 bound for local use only, while an empty address or M-bM-^@M-^X*M-bM-^@M-^Y indicates
93 that the port should be available from all interfaces.
94
95 -E log_file
96 Append debug logs to log_file instead of standard error.
97
98 -e escape_char
99 Sets the escape character for sessions with a pty (default: M-bM-^@M-^X~M-bM-^@M-^Y).
100 The escape character is only recognized at the beginning of a
101 line. The escape character followed by a dot (M-bM-^@M-^X.M-bM-^@M-^Y) closes the
102 connection; followed by control-Z suspends the connection; and
103 followed by itself sends the escape character once. Setting the
104 character to M-bM-^@M-^\noneM-bM-^@M-^] disables any escapes and makes the session
105 fully transparent.
106
107 -F configfile
108 Specifies an alternative per-user configuration file. If a
109 configuration file is given on the command line, the system-wide
110 configuration file (/etc/ssh/ssh_config) will be ignored. The
111 default for the per-user configuration file is ~/.ssh/config.
112
113 -f Requests ssh to go to background just before command execution.
114 This is useful if ssh is going to ask for passwords or
115 passphrases, but the user wants it in the background. This
116 implies -n. The recommended way to start X11 programs at a
117 remote site is with something like ssh -f host xterm.
118
119 If the ExitOnForwardFailure configuration option is set to M-bM-^@M-^\yesM-bM-^@M-^],
120 then a client started with -f will wait for all remote port
121 forwards to be successfully established before placing itself in
122 the background.
123
124 -G Causes ssh to print its configuration after evaluating Host and
125 Match blocks and exit.
126
127 -g Allows remote hosts to connect to local forwarded ports. If used
128 on a multiplexed connection, then this option must be specified
129 on the master process.
130
131 -I pkcs11
132 Specify the PKCS#11 shared library ssh should use to communicate
133 with a PKCS#11 token providing the user's private RSA key.
134
135 -i identity_file
136 Selects a file from which the identity (private key) for public
137 key authentication is read. The default is ~/.ssh/id_dsa,
138 ~/.ssh/id_ecdsa, ~/.ssh/id_ed25519 and ~/.ssh/id_rsa. Identity
139 files may also be specified on a per-host basis in the
140 configuration file. It is possible to have multiple -i options
141 (and multiple identities specified in configuration files). If
142 no certificates have been explicitly specified by the
143 CertificateFile directive, ssh will also try to load certificate
144 information from the filename obtained by appending -cert.pub to
145 identity filenames.
146
147 -J destination
148 Connect to the target host by first making a ssh connection to
149 the jump host described by destination and then establishing a
150 TCP forwarding to the ultimate destination from there. Multiple
151 jump hops may be specified separated by comma characters. This
152 is a shortcut to specify a ProxyJump configuration directive.
153
154 -K Enables GSSAPI-based authentication and forwarding (delegation)
155 of GSSAPI credentials to the server.
156
157 -k Disables forwarding (delegation) of GSSAPI credentials to the
158 server.
159
160 -L [bind_address:]port:host:hostport
161 -L [bind_address:]port:remote_socket
162 -L local_socket:host:hostport
163 -L local_socket:remote_socket
164 Specifies that connections to the given TCP port or Unix socket
165 on the local (client) host are to be forwarded to the given host
166 and port, or Unix socket, on the remote side. This works by
167 allocating a socket to listen to either a TCP port on the local
168 side, optionally bound to the specified bind_address, or to a
169 Unix socket. Whenever a connection is made to the local port or
170 socket, the connection is forwarded over the secure channel, and
171 a connection is made to either host port hostport, or the Unix
172 socket remote_socket, from the remote machine.
173
174 Port forwardings can also be specified in the configuration file.
175 Only the superuser can forward privileged ports. IPv6 addresses
176 can be specified by enclosing the address in square brackets.
177
178 By default, the local port is bound in accordance with the
179 GatewayPorts setting. However, an explicit bind_address may be
180 used to bind the connection to a specific address. The
181 bind_address of M-bM-^@M-^\localhostM-bM-^@M-^] indicates that the listening port be
182 bound for local use only, while an empty address or M-bM-^@M-^X*M-bM-^@M-^Y indicates
183 that the port should be available from all interfaces.
184
185 -l login_name
186 Specifies the user to log in as on the remote machine. This also
187 may be specified on a per-host basis in the configuration file.
188
189 -M Places the ssh client into M-bM-^@M-^\masterM-bM-^@M-^] mode for connection sharing.
190 Multiple -M options places ssh into M-bM-^@M-^\masterM-bM-^@M-^] mode but with
191 confirmation required using ssh-askpass(1) before each operation
192 that changes the multiplexing state (e.g. opening a new session).
193 Refer to the description of ControlMaster in ssh_config(5) for
194 details.
195
196 -m mac_spec
197 A comma-separated list of MAC (message authentication code)
198 algorithms, specified in order of preference. See the MACs
199 keyword for more information.
200
201 -N Do not execute a remote command. This is useful for just
202 forwarding ports.
203
204 -n Redirects stdin from /dev/null (actually, prevents reading from
205 stdin). This must be used when ssh is run in the background. A
206 common trick is to use this to run X11 programs on a remote
207 machine. For example, ssh -n shadows.cs.hut.fi emacs & will
208 start an emacs on shadows.cs.hut.fi, and the X11 connection will
209 be automatically forwarded over an encrypted channel. The ssh
210 program will be put in the background. (This does not work if
211 ssh needs to ask for a password or passphrase; see also the -f
212 option.)
213
214 -O ctl_cmd
215 Control an active connection multiplexing master process. When
216 the -O option is specified, the ctl_cmd argument is interpreted
217 and passed to the master process. Valid commands are: M-bM-^@M-^\checkM-bM-^@M-^]
218 (check that the master process is running), M-bM-^@M-^\forwardM-bM-^@M-^] (request
219 forwardings without command execution), M-bM-^@M-^\cancelM-bM-^@M-^] (cancel
220 forwardings), M-bM-^@M-^\exitM-bM-^@M-^] (request the master to exit), and M-bM-^@M-^\stopM-bM-^@M-^]
221 (request the master to stop accepting further multiplexing
222 requests).
223
224 -o option
225 Can be used to give options in the format used in the
226 configuration file. This is useful for specifying options for
227 which there is no separate command-line flag. For full details
228 of the options listed below, and their possible values, see
229 ssh_config(5).
230
231 AddKeysToAgent
232 AddressFamily
233 BatchMode
234 BindAddress
235 CanonicalDomains
236 CanonicalizeFallbackLocal
237 CanonicalizeHostname
238 CanonicalizeMaxDots
239 CanonicalizePermittedCNAMEs
240 CASignatureAlgorithms
241 CertificateFile
242 ChallengeResponseAuthentication
243 CheckHostIP
244 Ciphers
245 ClearAllForwardings
246 Compression
247 ConnectionAttempts
248 ConnectTimeout
249 ControlMaster
250 ControlPath
251 ControlPersist
252 DynamicForward
253 EscapeChar
254 ExitOnForwardFailure
255 FingerprintHash
256 ForwardAgent
257 ForwardX11
258 ForwardX11Timeout
259 ForwardX11Trusted
260 GatewayPorts
261 GlobalKnownHostsFile
262 GSSAPIAuthentication
263 GSSAPIDelegateCredentials
264 HashKnownHosts
265 Host
266 HostbasedAuthentication
267 HostbasedKeyTypes
268 HostKeyAlgorithms
269 HostKeyAlias
270 HostName
271 IdentitiesOnly
272 IdentityAgent
273 IdentityFile
274 IPQoS
275 KbdInteractiveAuthentication
276 KbdInteractiveDevices
277 KexAlgorithms
278 LocalCommand
279 LocalForward
280 LogLevel
281 MACs
282 Match
283 NoHostAuthenticationForLocalhost
284 NumberOfPasswordPrompts
285 PasswordAuthentication
286 PermitLocalCommand
287 PKCS11Provider
288 Port
289 PreferredAuthentications
290 ProxyCommand
291 ProxyJump
292 ProxyUseFdpass
293 PubkeyAcceptedKeyTypes
294 PubkeyAuthentication
295 RekeyLimit
296 RemoteCommand
297 RemoteForward
298 RequestTTY
299 SendEnv
300 ServerAliveInterval
301 ServerAliveCountMax
302 SetEnv
303 StreamLocalBindMask
304 StreamLocalBindUnlink
305 StrictHostKeyChecking
306 TCPKeepAlive
307 Tunnel
308 TunnelDevice
309 UpdateHostKeys
310 User
311 UserKnownHostsFile
312 VerifyHostKeyDNS
313 VisualHostKey
314 XAuthLocation
315
316 -p port
317 Port to connect to on the remote host. This can be specified on
318 a per-host basis in the configuration file.
319
320 -Q query_option
321 Queries ssh for the algorithms supported for the specified
322 version 2. The available features are: cipher (supported
323 symmetric ciphers), cipher-auth (supported symmetric ciphers that
324 support authenticated encryption), help (supported query terms
325 for use with the -Q flag), mac (supported message integrity
326 codes), kex (key exchange algorithms), key (key types), key-cert
327 (certificate key types), key-plain (non-certificate key types),
328 protocol-version (supported SSH protocol versions), and sig
329 (supported signature algorithms).
330
331 -q Quiet mode. Causes most warning and diagnostic messages to be
332 suppressed.
333
334 -R [bind_address:]port:host:hostport
335 -R [bind_address:]port:local_socket
336 -R remote_socket:host:hostport
337 -R remote_socket:local_socket
338 -R [bind_address:]port
339 Specifies that connections to the given TCP port or Unix socket
340 on the remote (server) host are to be forwarded to the local
341 side.
342
343 This works by allocating a socket to listen to either a TCP port
344 or to a Unix socket on the remote side. Whenever a connection is
345 made to this port or Unix socket, the connection is forwarded
346 over the secure channel, and a connection is made from the local
347 machine to either an explicit destination specified by host port
348 hostport, or local_socket, or, if no explicit destination was
349 specified, ssh will act as a SOCKS 4/5 proxy and forward
350 connections to the destinations requested by the remote SOCKS
351 client.
352
353 Port forwardings can also be specified in the configuration file.
354 Privileged ports can be forwarded only when logging in as root on
355 the remote machine. IPv6 addresses can be specified by enclosing
356 the address in square brackets.
357
358 By default, TCP listening sockets on the server will be bound to
359 the loopback interface only. This may be overridden by
360 specifying a bind_address. An empty bind_address, or the address
361 M-bM-^@M-^X*M-bM-^@M-^Y, indicates that the remote socket should listen on all
362 interfaces. Specifying a remote bind_address will only succeed
363 if the server's GatewayPorts option is enabled (see
364 sshd_config(5)).
365
366 If the port argument is M-bM-^@M-^X0M-bM-^@M-^Y, the listen port will be dynamically
367 allocated on the server and reported to the client at run time.
368 When used together with -O forward the allocated port will be
369 printed to the standard output.
370
371 -S ctl_path
372 Specifies the location of a control socket for connection
373 sharing, or the string M-bM-^@M-^\noneM-bM-^@M-^] to disable connection sharing.
374 Refer to the description of ControlPath and ControlMaster in
375 ssh_config(5) for details.
376
377 -s May be used to request invocation of a subsystem on the remote
378 system. Subsystems facilitate the use of SSH as a secure
379 transport for other applications (e.g. sftp(1)). The subsystem
380 is specified as the remote command.
381
382 -T Disable pseudo-terminal allocation.
383
384 -t Force pseudo-terminal allocation. This can be used to execute
385 arbitrary screen-based programs on a remote machine, which can be
386 very useful, e.g. when implementing menu services. Multiple -t
387 options force tty allocation, even if ssh has no local tty.
388
389 -V Display the version number and exit.
390
391 -v Verbose mode. Causes ssh to print debugging messages about its
392 progress. This is helpful in debugging connection,
393 authentication, and configuration problems. Multiple -v options
394 increase the verbosity. The maximum is 3.
395
396 -W host:port
397 Requests that standard input and output on the client be
398 forwarded to host on port over the secure channel. Implies -N,
399 -T, ExitOnForwardFailure and ClearAllForwardings, though these
400 can be overridden in the configuration file or using -o command
401 line options.
402
403 -w local_tun[:remote_tun]
404 Requests tunnel device forwarding with the specified tun(4)
405 devices between the client (local_tun) and the server
406 (remote_tun).
407
408 The devices may be specified by numerical ID or the keyword
409 M-bM-^@M-^\anyM-bM-^@M-^], which uses the next available tunnel device. If
410 remote_tun is not specified, it defaults to M-bM-^@M-^\anyM-bM-^@M-^]. See also the
411 Tunnel and TunnelDevice directives in ssh_config(5).
412
413 If the Tunnel directive is unset, it will be set to the default
414 tunnel mode, which is M-bM-^@M-^\point-to-pointM-bM-^@M-^]. If a different Tunnel
415 forwarding mode it desired, then it should be specified before
416 -w.
417
418 -X Enables X11 forwarding. This can also be specified on a per-host
419 basis in a configuration file.
420
421 X11 forwarding should be enabled with caution. Users with the
422 ability to bypass file permissions on the remote host (for the
423 user's X authorization database) can access the local X11 display
424 through the forwarded connection. An attacker may then be able
425 to perform activities such as keystroke monitoring.
426
427 For this reason, X11 forwarding is subjected to X11 SECURITY
428 extension restrictions by default. Please refer to the ssh -Y
429 option and the ForwardX11Trusted directive in ssh_config(5) for
430 more information.
431
432 -x Disables X11 forwarding.
433
434 -Y Enables trusted X11 forwarding. Trusted X11 forwardings are not
435 subjected to the X11 SECURITY extension controls.
436
437 -y Send log information using the syslog(3) system module. By
438 default this information is sent to stderr.
439
440 ssh may additionally obtain configuration data from a per-user
441 configuration file and a system-wide configuration file. The file format
442 and configuration options are described in ssh_config(5).
443
444AUTHENTICATION
445 The OpenSSH SSH client supports SSH protocol 2.
446
447 The methods available for authentication are: GSSAPI-based
448 authentication, host-based authentication, public key authentication,
449 challenge-response authentication, and password authentication.
450 Authentication methods are tried in the order specified above, though
451 PreferredAuthentications can be used to change the default order.
452
453 Host-based authentication works as follows: If the machine the user logs
454 in from is listed in /etc/hosts.equiv or /etc/shosts.equiv on the remote
455 machine, and the user names are the same on both sides, or if the files
456 ~/.rhosts or ~/.shosts exist in the user's home directory on the remote
457 machine and contain a line containing the name of the client machine and
458 the name of the user on that machine, the user is considered for login.
459 Additionally, the server must be able to verify the client's host key
460 (see the description of /etc/ssh/ssh_known_hosts and ~/.ssh/known_hosts,
461 below) for login to be permitted. This authentication method closes
462 security holes due to IP spoofing, DNS spoofing, and routing spoofing.
463 [Note to the administrator: /etc/hosts.equiv, ~/.rhosts, and the
464 rlogin/rsh protocol in general, are inherently insecure and should be
465 disabled if security is desired.]
466
467 Public key authentication works as follows: The scheme is based on
468 public-key cryptography, using cryptosystems where encryption and
469 decryption are done using separate keys, and it is unfeasible to derive
470 the decryption key from the encryption key. The idea is that each user
471 creates a public/private key pair for authentication purposes. The
472 server knows the public key, and only the user knows the private key.
473 ssh implements public key authentication protocol automatically, using
474 one of the DSA, ECDSA, Ed25519 or RSA algorithms. The HISTORY section of
475 ssl(8) contains a brief discussion of the DSA and RSA algorithms.
476
477 The file ~/.ssh/authorized_keys lists the public keys that are permitted
478 for logging in. When the user logs in, the ssh program tells the server
479 which key pair it would like to use for authentication. The client
480 proves that it has access to the private key and the server checks that
481 the corresponding public key is authorized to accept the account.
482
483 The server may inform the client of errors that prevented public key
484 authentication from succeeding after authentication completes using a
485 different method. These may be viewed by increasing the LogLevel to
486 DEBUG or higher (e.g. by using the -v flag).
487
488 The user creates his/her key pair by running ssh-keygen(1). This stores
489 the private key in ~/.ssh/id_dsa (DSA), ~/.ssh/id_ecdsa (ECDSA),
490 ~/.ssh/id_ed25519 (Ed25519), or ~/.ssh/id_rsa (RSA) and stores the public
491 key in ~/.ssh/id_dsa.pub (DSA), ~/.ssh/id_ecdsa.pub (ECDSA),
492 ~/.ssh/id_ed25519.pub (Ed25519), or ~/.ssh/id_rsa.pub (RSA) in the user's
493 home directory. The user should then copy the public key to
494 ~/.ssh/authorized_keys in his/her home directory on the remote machine.
495 The authorized_keys file corresponds to the conventional ~/.rhosts file,
496 and has one key per line, though the lines can be very long. After this,
497 the user can log in without giving the password.
498
499 A variation on public key authentication is available in the form of
500 certificate authentication: instead of a set of public/private keys,
501 signed certificates are used. This has the advantage that a single
502 trusted certification authority can be used in place of many
503 public/private keys. See the CERTIFICATES section of ssh-keygen(1) for
504 more information.
505
506 The most convenient way to use public key or certificate authentication
507 may be with an authentication agent. See ssh-agent(1) and (optionally)
508 the AddKeysToAgent directive in ssh_config(5) for more information.
509
510 Challenge-response authentication works as follows: The server sends an
511 arbitrary "challenge" text, and prompts for a response. Examples of
512 challenge-response authentication include BSD Authentication (see
513 login.conf(5)) and PAM (some non-OpenBSD systems).
514
515 Finally, if other authentication methods fail, ssh prompts the user for a
516 password. The password is sent to the remote host for checking; however,
517 since all communications are encrypted, the password cannot be seen by
518 someone listening on the network.
519
520 ssh automatically maintains and checks a database containing
521 identification for all hosts it has ever been used with. Host keys are
522 stored in ~/.ssh/known_hosts in the user's home directory. Additionally,
523 the file /etc/ssh/ssh_known_hosts is automatically checked for known
524 hosts. Any new hosts are automatically added to the user's file. If a
525 host's identification ever changes, ssh warns about this and disables
526 password authentication to prevent server spoofing or man-in-the-middle
527 attacks, which could otherwise be used to circumvent the encryption. The
528 StrictHostKeyChecking option can be used to control logins to machines
529 whose host key is not known or has changed.
530
531 When the user's identity has been accepted by the server, the server
532 either executes the given command in a non-interactive session or, if no
533 command has been specified, logs into the machine and gives the user a
534 normal shell as an interactive session. All communication with the
535 remote command or shell will be automatically encrypted.
536
537 If an interactive session is requested ssh by default will only request a
538 pseudo-terminal (pty) for interactive sessions when the client has one.
539 The flags -T and -t can be used to override this behaviour.
540
541 If a pseudo-terminal has been allocated the user may use the escape
542 characters noted below.
543
544 If no pseudo-terminal has been allocated, the session is transparent and
545 can be used to reliably transfer binary data. On most systems, setting
546 the escape character to M-bM-^@M-^\noneM-bM-^@M-^] will also make the session transparent
547 even if a tty is used.
548
549 The session terminates when the command or shell on the remote machine
550 exits and all X11 and TCP connections have been closed.
551
552ESCAPE CHARACTERS
553 When a pseudo-terminal has been requested, ssh supports a number of
554 functions through the use of an escape character.
555
556 A single tilde character can be sent as ~~ or by following the tilde by a
557 character other than those described below. The escape character must
558 always follow a newline to be interpreted as special. The escape
559 character can be changed in configuration files using the EscapeChar
560 configuration directive or on the command line by the -e option.
561
562 The supported escapes (assuming the default M-bM-^@M-^X~M-bM-^@M-^Y) are:
563
564 ~. Disconnect.
565
566 ~^Z Background ssh.
567
568 ~# List forwarded connections.
569
570 ~& Background ssh at logout when waiting for forwarded connection /
571 X11 sessions to terminate.
572
573 ~? Display a list of escape characters.
574
575 ~B Send a BREAK to the remote system (only useful if the peer
576 supports it).
577
578 ~C Open command line. Currently this allows the addition of port
579 forwardings using the -L, -R and -D options (see above). It also
580 allows the cancellation of existing port-forwardings with
581 -KL[bind_address:]port for local, -KR[bind_address:]port for
582 remote and -KD[bind_address:]port for dynamic port-forwardings.
583 !command allows the user to execute a local command if the
584 PermitLocalCommand option is enabled in ssh_config(5). Basic
585 help is available, using the -h option.
586
587 ~R Request rekeying of the connection (only useful if the peer
588 supports it).
589
590 ~V Decrease the verbosity (LogLevel) when errors are being written
591 to stderr.
592
593 ~v Increase the verbosity (LogLevel) when errors are being written
594 to stderr.
595
596TCP FORWARDING
597 Forwarding of arbitrary TCP connections over the secure channel can be
598 specified either on the command line or in a configuration file. One
599 possible application of TCP forwarding is a secure connection to a mail
600 server; another is going through firewalls.
601
602 In the example below, we look at encrypting communication between an IRC
603 client and server, even though the IRC server does not directly support
604 encrypted communications. This works as follows: the user connects to
605 the remote host using ssh, specifying a port to be used to forward
606 connections to the remote server. After that it is possible to start the
607 service which is to be encrypted on the client machine, connecting to the
608 same local port, and ssh will encrypt and forward the connection.
609
610 The following example tunnels an IRC session from client machine
611 M-bM-^@M-^\127.0.0.1M-bM-^@M-^] (localhost) to remote server M-bM-^@M-^\server.example.comM-bM-^@M-^]:
612
613 $ ssh -f -L 1234:localhost:6667 server.example.com sleep 10
614 $ irc -c '#users' -p 1234 pinky 127.0.0.1
615
616 This tunnels a connection to IRC server M-bM-^@M-^\server.example.comM-bM-^@M-^], joining
617 channel M-bM-^@M-^\#usersM-bM-^@M-^], nickname M-bM-^@M-^\pinkyM-bM-^@M-^], using port 1234. It doesn't matter
618 which port is used, as long as it's greater than 1023 (remember, only
619 root can open sockets on privileged ports) and doesn't conflict with any
620 ports already in use. The connection is forwarded to port 6667 on the
621 remote server, since that's the standard port for IRC services.
622
623 The -f option backgrounds ssh and the remote command M-bM-^@M-^\sleep 10M-bM-^@M-^] is
624 specified to allow an amount of time (10 seconds, in the example) to
625 start the service which is to be tunnelled. If no connections are made
626 within the time specified, ssh will exit.
627
628X11 FORWARDING
629 If the ForwardX11 variable is set to M-bM-^@M-^\yesM-bM-^@M-^] (or see the description of the
630 -X, -x, and -Y options above) and the user is using X11 (the DISPLAY
631 environment variable is set), the connection to the X11 display is
632 automatically forwarded to the remote side in such a way that any X11
633 programs started from the shell (or command) will go through the
634 encrypted channel, and the connection to the real X server will be made
635 from the local machine. The user should not manually set DISPLAY.
636 Forwarding of X11 connections can be configured on the command line or in
637 configuration files.
638
639 The DISPLAY value set by ssh will point to the server machine, but with a
640 display number greater than zero. This is normal, and happens because
641 ssh creates a M-bM-^@M-^\proxyM-bM-^@M-^] X server on the server machine for forwarding the
642 connections over the encrypted channel.
643
644 ssh will also automatically set up Xauthority data on the server machine.
645 For this purpose, it will generate a random authorization cookie, store
646 it in Xauthority on the server, and verify that any forwarded connections
647 carry this cookie and replace it by the real cookie when the connection
648 is opened. The real authentication cookie is never sent to the server
649 machine (and no cookies are sent in the plain).
650
651 If the ForwardAgent variable is set to M-bM-^@M-^\yesM-bM-^@M-^] (or see the description of
652 the -A and -a options above) and the user is using an authentication
653 agent, the connection to the agent is automatically forwarded to the
654 remote side.
655
656VERIFYING HOST KEYS
657 When connecting to a server for the first time, a fingerprint of the
658 server's public key is presented to the user (unless the option
659 StrictHostKeyChecking has been disabled). Fingerprints can be determined
660 using ssh-keygen(1):
661
662 $ ssh-keygen -l -f /etc/ssh/ssh_host_rsa_key
663
664 If the fingerprint is already known, it can be matched and the key can be
665 accepted or rejected. If only legacy (MD5) fingerprints for the server
666 are available, the ssh-keygen(1) -E option may be used to downgrade the
667 fingerprint algorithm to match.
668
669 Because of the difficulty of comparing host keys just by looking at
670 fingerprint strings, there is also support to compare host keys visually,
671 using random art. By setting the VisualHostKey option to M-bM-^@M-^\yesM-bM-^@M-^], a small
672 ASCII graphic gets displayed on every login to a server, no matter if the
673 session itself is interactive or not. By learning the pattern a known
674 server produces, a user can easily find out that the host key has changed
675 when a completely different pattern is displayed. Because these patterns
676 are not unambiguous however, a pattern that looks similar to the pattern
677 remembered only gives a good probability that the host key is the same,
678 not guaranteed proof.
679
680 To get a listing of the fingerprints along with their random art for all
681 known hosts, the following command line can be used:
682
683 $ ssh-keygen -lv -f ~/.ssh/known_hosts
684
685 If the fingerprint is unknown, an alternative method of verification is
686 available: SSH fingerprints verified by DNS. An additional resource
687 record (RR), SSHFP, is added to a zonefile and the connecting client is
688 able to match the fingerprint with that of the key presented.
689
690 In this example, we are connecting a client to a server,
691 M-bM-^@M-^\host.example.comM-bM-^@M-^]. The SSHFP resource records should first be added to
692 the zonefile for host.example.com:
693
694 $ ssh-keygen -r host.example.com.
695
696 The output lines will have to be added to the zonefile. To check that
697 the zone is answering fingerprint queries:
698
699 $ dig -t SSHFP host.example.com
700
701 Finally the client connects:
702
703 $ ssh -o "VerifyHostKeyDNS ask" host.example.com
704 [...]
705 Matching host key fingerprint found in DNS.
706 Are you sure you want to continue connecting (yes/no)?
707
708 See the VerifyHostKeyDNS option in ssh_config(5) for more information.
709
710SSH-BASED VIRTUAL PRIVATE NETWORKS
711 ssh contains support for Virtual Private Network (VPN) tunnelling using
712 the tun(4) network pseudo-device, allowing two networks to be joined
713 securely. The sshd_config(5) configuration option PermitTunnel controls
714 whether the server supports this, and at what level (layer 2 or 3
715 traffic).
716
717 The following example would connect client network 10.0.50.0/24 with
718 remote network 10.0.99.0/24 using a point-to-point connection from
719 10.1.1.1 to 10.1.1.2, provided that the SSH server running on the gateway
720 to the remote network, at 192.168.1.15, allows it.
721
722 On the client:
723
724 # ssh -f -w 0:1 192.168.1.15 true
725 # ifconfig tun0 10.1.1.1 10.1.1.2 netmask 255.255.255.252
726 # route add 10.0.99.0/24 10.1.1.2
727
728 On the server:
729
730 # ifconfig tun1 10.1.1.2 10.1.1.1 netmask 255.255.255.252
731 # route add 10.0.50.0/24 10.1.1.1
732
733 Client access may be more finely tuned via the /root/.ssh/authorized_keys
734 file (see below) and the PermitRootLogin server option. The following
735 entry would permit connections on tun(4) device 1 from user M-bM-^@M-^\janeM-bM-^@M-^] and on
736 tun device 2 from user M-bM-^@M-^\johnM-bM-^@M-^], if PermitRootLogin is set to
737 M-bM-^@M-^\forced-commands-onlyM-bM-^@M-^]:
738
739 tunnel="1",command="sh /etc/netstart tun1" ssh-rsa ... jane
740 tunnel="2",command="sh /etc/netstart tun2" ssh-rsa ... john
741
742 Since an SSH-based setup entails a fair amount of overhead, it may be
743 more suited to temporary setups, such as for wireless VPNs. More
744 permanent VPNs are better provided by tools such as ipsecctl(8) and
745 isakmpd(8).
746
747ENVIRONMENT
748 ssh will normally set the following environment variables:
749
750 DISPLAY The DISPLAY variable indicates the location of the
751 X11 server. It is automatically set by ssh to
752 point to a value of the form M-bM-^@M-^\hostname:nM-bM-^@M-^], where
753 M-bM-^@M-^\hostnameM-bM-^@M-^] indicates the host where the shell runs,
754 and M-bM-^@M-^XnM-bM-^@M-^Y is an integer M-bM-^IM-% 1. ssh uses this special
755 value to forward X11 connections over the secure
756 channel. The user should normally not set DISPLAY
757 explicitly, as that will render the X11 connection
758 insecure (and will require the user to manually
759 copy any required authorization cookies).
760
761 HOME Set to the path of the user's home directory.
762
763 LOGNAME Synonym for USER; set for compatibility with
764 systems that use this variable.
765
766 MAIL Set to the path of the user's mailbox.
767
768 PATH Set to the default PATH, as specified when
769 compiling ssh.
770
771 SSH_ASKPASS If ssh needs a passphrase, it will read the
772 passphrase from the current terminal if it was run
773 from a terminal. If ssh does not have a terminal
774 associated with it but DISPLAY and SSH_ASKPASS are
775 set, it will execute the program specified by
776 SSH_ASKPASS and open an X11 window to read the
777 passphrase. This is particularly useful when
778 calling ssh from a .xsession or related script.
779 (Note that on some machines it may be necessary to
780 redirect the input from /dev/null to make this
781 work.)
782
783 SSH_AUTH_SOCK Identifies the path of a UNIX-domain socket used to
784 communicate with the agent.
785
786 SSH_CONNECTION Identifies the client and server ends of the
787 connection. The variable contains four space-
788 separated values: client IP address, client port
789 number, server IP address, and server port number.
790
791 SSH_ORIGINAL_COMMAND This variable contains the original command line if
792 a forced command is executed. It can be used to
793 extract the original arguments.
794
795 SSH_TTY This is set to the name of the tty (path to the
796 device) associated with the current shell or
797 command. If the current session has no tty, this
798 variable is not set.
799
800 SSH_TUNNEL Optionally set by sshd(8) to contain the interface
801 names assigned if tunnel forwarding was requested
802 by the client.
803
804 SSH_USER_AUTH Optionally set by sshd(8), this variable may
805 contain a pathname to a file that lists the
806 authentication methods successfully used when the
807 session was established, including any public keys
808 that were used.
809
810 TZ This variable is set to indicate the present time
811 zone if it was set when the daemon was started
812 (i.e. the daemon passes the value on to new
813 connections).
814
815 USER Set to the name of the user logging in.
816
817 Additionally, ssh reads ~/.ssh/environment, and adds lines of the format
818 M-bM-^@M-^\VARNAME=valueM-bM-^@M-^] to the environment if the file exists and users are
819 allowed to change their environment. For more information, see the
820 PermitUserEnvironment option in sshd_config(5).
821
822FILES
823 ~/.rhosts
824 This file is used for host-based authentication (see above). On
825 some machines this file may need to be world-readable if the
826 user's home directory is on an NFS partition, because sshd(8)
827 reads it as root. Additionally, this file must be owned by the
828 user, and must not have write permissions for anyone else. The
829 recommended permission for most machines is read/write for the
830 user, and not accessible by others.
831
832 ~/.shosts
833 This file is used in exactly the same way as .rhosts, but allows
834 host-based authentication without permitting login with
835 rlogin/rsh.
836
837 ~/.ssh/
838 This directory is the default location for all user-specific
839 configuration and authentication information. There is no
840 general requirement to keep the entire contents of this directory
841 secret, but the recommended permissions are read/write/execute
842 for the user, and not accessible by others.
843
844 ~/.ssh/authorized_keys
845 Lists the public keys (DSA, ECDSA, Ed25519, RSA) that can be used
846 for logging in as this user. The format of this file is
847 described in the sshd(8) manual page. This file is not highly
848 sensitive, but the recommended permissions are read/write for the
849 user, and not accessible by others.
850
851 ~/.ssh/config
852 This is the per-user configuration file. The file format and
853 configuration options are described in ssh_config(5). Because of
854 the potential for abuse, this file must have strict permissions:
855 read/write for the user, and not writable by others.
856
857 ~/.ssh/environment
858 Contains additional definitions for environment variables; see
859 ENVIRONMENT, above.
860
861 ~/.ssh/id_dsa
862 ~/.ssh/id_ecdsa
863 ~/.ssh/id_ed25519
864 ~/.ssh/id_rsa
865 Contains the private key for authentication. These files contain
866 sensitive data and should be readable by the user but not
867 accessible by others (read/write/execute). ssh will simply
868 ignore a private key file if it is accessible by others. It is
869 possible to specify a passphrase when generating the key which
870 will be used to encrypt the sensitive part of this file using
871 AES-128.
872
873 ~/.ssh/id_dsa.pub
874 ~/.ssh/id_ecdsa.pub
875 ~/.ssh/id_ed25519.pub
876 ~/.ssh/id_rsa.pub
877 Contains the public key for authentication. These files are not
878 sensitive and can (but need not) be readable by anyone.
879
880 ~/.ssh/known_hosts
881 Contains a list of host keys for all hosts the user has logged
882 into that are not already in the systemwide list of known host
883 keys. See sshd(8) for further details of the format of this
884 file.
885
886 ~/.ssh/rc
887 Commands in this file are executed by ssh when the user logs in,
888 just before the user's shell (or command) is started. See the
889 sshd(8) manual page for more information.
890
891 /etc/hosts.equiv
892 This file is for host-based authentication (see above). It
893 should only be writable by root.
894
895 /etc/shosts.equiv
896 This file is used in exactly the same way as hosts.equiv, but
897 allows host-based authentication without permitting login with
898 rlogin/rsh.
899
900 /etc/ssh/ssh_config
901 Systemwide configuration file. The file format and configuration
902 options are described in ssh_config(5).
903
904 /etc/ssh/ssh_host_key
905 /etc/ssh/ssh_host_dsa_key
906 /etc/ssh/ssh_host_ecdsa_key
907 /etc/ssh/ssh_host_ed25519_key
908 /etc/ssh/ssh_host_rsa_key
909 These files contain the private parts of the host keys and are
910 used for host-based authentication.
911
912 /etc/ssh/ssh_known_hosts
913 Systemwide list of known host keys. This file should be prepared
914 by the system administrator to contain the public host keys of
915 all machines in the organization. It should be world-readable.
916 See sshd(8) for further details of the format of this file.
917
918 /etc/ssh/sshrc
919 Commands in this file are executed by ssh when the user logs in,
920 just before the user's shell (or command) is started. See the
921 sshd(8) manual page for more information.
922
923EXIT STATUS
924 ssh exits with the exit status of the remote command or with 255 if an
925 error occurred.
926
927SEE ALSO
928 scp(1), sftp(1), ssh-add(1), ssh-agent(1), ssh-keygen(1), ssh-keyscan(1),
929 tun(4), ssh_config(5), ssh-keysign(8), sshd(8)
930
931STANDARDS
932 S. Lehtinen and C. Lonvick, The Secure Shell (SSH) Protocol Assigned
933 Numbers, RFC 4250, January 2006.
934
935 T. Ylonen and C. Lonvick, The Secure Shell (SSH) Protocol Architecture,
936 RFC 4251, January 2006.
937
938 T. Ylonen and C. Lonvick, The Secure Shell (SSH) Authentication Protocol,
939 RFC 4252, January 2006.
940
941 T. Ylonen and C. Lonvick, The Secure Shell (SSH) Transport Layer
942 Protocol, RFC 4253, January 2006.
943
944 T. Ylonen and C. Lonvick, The Secure Shell (SSH) Connection Protocol, RFC
945 4254, January 2006.
946
947 J. Schlyter and W. Griffin, Using DNS to Securely Publish Secure Shell
948 (SSH) Key Fingerprints, RFC 4255, January 2006.
949
950 F. Cusack and M. Forssen, Generic Message Exchange Authentication for the
951 Secure Shell Protocol (SSH), RFC 4256, January 2006.
952
953 J. Galbraith and P. Remaker, The Secure Shell (SSH) Session Channel Break
954 Extension, RFC 4335, January 2006.
955
956 M. Bellare, T. Kohno, and C. Namprempre, The Secure Shell (SSH) Transport
957 Layer Encryption Modes, RFC 4344, January 2006.
958
959 B. Harris, Improved Arcfour Modes for the Secure Shell (SSH) Transport
960 Layer Protocol, RFC 4345, January 2006.
961
962 M. Friedl, N. Provos, and W. Simpson, Diffie-Hellman Group Exchange for
963 the Secure Shell (SSH) Transport Layer Protocol, RFC 4419, March 2006.
964
965 J. Galbraith and R. Thayer, The Secure Shell (SSH) Public Key File
966 Format, RFC 4716, November 2006.
967
968 D. Stebila and J. Green, Elliptic Curve Algorithm Integration in the
969 Secure Shell Transport Layer, RFC 5656, December 2009.
970
971 A. Perrig and D. Song, Hash Visualization: a New Technique to improve
972 Real-World Security, 1999, International Workshop on Cryptographic
973 Techniques and E-Commerce (CrypTEC '99).
974
975AUTHORS
976 OpenSSH is a derivative of the original and free ssh 1.2.12 release by
977 Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo
978 de Raadt and Dug Song removed many bugs, re-added newer features and
979 created OpenSSH. Markus Friedl contributed the support for SSH protocol
980 versions 1.5 and 2.0.
981
982OpenBSD 6.4 September 20, 2018 OpenBSD 6.4