release/src/router/dropbear/dbclient.1

   1 .TH dbclient 1
   2 .SH NAME
   3 dbclient \- lightweight SSH client
   4 .SH SYNOPSIS
   5 .B dbclient
   6 [\-Tt] [\-p
   7 .I port\fR] [\-i
   8 .I id\fR] [\-L
   9 .I l\fR:\fIh\fR:\fIr\fR] [\-R
  10 .I l\fR:\fIh\fR:\fIr\fR] [\-l
  11 .IR user ]
  12 .I host
  13 .RI [ command ]
  14
  15 .B dbclient
  16 [
  17 .I args ]
  18 .I [user1]@host1[%port1],[user2]@host2[%port2],...
  19
  20 .SH DESCRIPTION
  21 .B dbclient
  22 is a SSH client designed to be small enough to be used in small memory
  23 environments, while still being functional and secure enough for general use.
  24 .SH OPTIONS
  25 .TP
  26 .B \-p \fIport
  27 Connect to
  28 .I port
  29 on the remote host. Alternatively a port can be specified as hostname%port.
  30 Default is 22.
  31 .TP
  32 .B \-i \fIidfile
  33 Identity file.
  34 Read the identity key from file
  35 .I idfile
  36 (multiple allowed). This file is created with dropbearkey(1) or converted
  37 from OpenSSH with dropbearconvert(1).
  38 .TP
  39 .B \-L [\fIlistenaddress\fR]:\fIlistenport\fR:\fIhost\fR:\fIport\fR
  40 Local port forwarding.
  41 Forward the port
  42 .I listenport
  43 on the local host through the SSH connection to port
  44 .I port
  45 on the host
  46 .IR host .
  47 .TP
  48 .B \-R [\fIlistenaddress\fR]:\fIlistenport\fR:\fIhost\fR:\fIport\fR
  49 Remote port forwarding.
  50 Forward the port
  51 .I listenport
  52 on the remote host through the SSH connection to port
  53 .I port
  54 on the host
  55 .IR host .
  56 .TP
  57 .B \-l \fIuser
  58 Username.
  59 Login as
  60 .I user
  61 on the remote host.
  62 .TP
  63 .B \-t
  64 Allocate a PTY.
  65 .TP
  66 .B \-T
  67 Don't allocate a PTY.
  68 .TP
  69 .B \-N
  70 Don't request a remote shell or run any commands. Any command arguments are ignored.
  71 .TP
  72 .B \-f
  73 Fork into the background after authentication. A command argument (or -N) is required.
  74 This is useful when using password authentication.
  75 .TP
  76 .B \-g
  77 Allow non-local hosts to connect to forwarded ports. Applies to -L and -R
  78 forwarded ports, though remote connections to -R forwarded ports may be limited
  79 by the ssh server.
  80 .TP
  81 .B \-y
  82 Always accept hostkeys if they are unknown. If a hostkey mismatch occurs the
  83 connection will abort as normal. If specified a second time no host key checking
  84 is performed at all, this is usually undesirable.
  85 .TP
  86 .B \-A
  87 Forward agent connections to the remote host. dbclient will use any
  88 OpenSSH-style agent program if available ($SSH_AUTH_SOCK will be set) for
  89 public key authentication.  Forwarding is only enabled if -A is specified.
  90 .TP
  91 .B \-W \fIwindowsize
  92 Specify the per-channel receive window buffer size. Increasing this
  93 may improve network performance at the expense of memory use. Use -h to see the
  94 default buffer size.
  95 .TP
  96 .B \-K \fItimeout_seconds
  97 Ensure that traffic is transmitted at a certain interval in seconds. This is
  98 useful for working around firewalls or routers that drop connections after
  99 a certain period of inactivity. The trade-off is that a session may be
 100 closed if there is a temporary lapse of network connectivity. A setting
 101 if 0 disables keepalives.
 102 .TP
 103 .B \-I \fIidle_timeout
 104 Disconnect the session if no traffic is transmitted or received for \fIidle_timeout\fR seconds.
 105 .TP
 106 .B \-J \fIproxy_command
 107 Use the standard input/output of the program \fIproxy_command\fR rather than using
 108 a normal TCP connection. A hostname should be still be provided, as this is used for
 109 comparing saved hostkeys.
 110 .TP
 111 .B \-B \fIendhost:endport
 112 "Netcat-alike" mode, where Dropbear will connect to the given host, then create a
 113 forwarded connection to \fIendhost\fR. This will then be presented as dbclient's
 114 standard input/output.
 115 .TP
 116 .B \-c \fIcipherlist
 117 Specify a comma separated list of ciphers to enable. Use \fI-c help\fR to list possibilities.
 118 .TP
 119 .B \-m \fIMAClist
 120 Specify a comma separated list of authentication MACs to enable. Use \fI-m help\fR to list possibilities.
 121 .TP
 122 .B \-s
 123 The specified command will be requested as a subsystem, used for sftp. Dropbear doesn't implement sftp itself but the OpenSSH sftp client can be used eg \fIsftp -S dbclient user@host\fR
 124
 125 .SH MULTI-HOP
 126 Dropbear will also allow multiple "hops" to be specified, separated by commas. In
 127 this case a connection will be made to the first host, then a TCP forwarded
 128 connection will be made through that to the second host, and so on. Hosts other than
 129 the final destination will not see anything other than the encrypted SSH stream.
 130 A port for a host can be specified with a hash (eg matt@martello%44 ).
 131 This syntax can also be used with scp or rsync (specifying dbclient as the
 132 ssh/rsh command). A file can be "bounced" through multiple SSH hops, eg
 133
 134 scp -S dbclient matt@martello,root@wrt,canyons:/tmp/dump .
 135
 136 Note that hostnames are resolved by the prior hop (so "canyons" would be resolved by the host "wrt")
 137 in the example above, the same way as other -L TCP forwarded hosts are. Host keys are
 138 checked locally based on the given hostname.
 139
 140 .SH ESCAPE CHARACTERS
 141 Typing a newline followed by the  key sequence \fI~.\fR (tilde, dot) will terminate a connection.
 142 The sequence \fI~^Z\fR (tilde, ctrl-z) will background the connection. This behaviour only
 143 applies when a PTY is used.
 144
 145 .SH ENVIRONMENT
 146 .TP
 147 .B DROPBEAR_PASSWORD
 148 A password to use for remote authentication can be specified in the environment
 149 variable DROPBEAR_PASSWORD. Care should be taken that the password is not
 150 exposed to other users on a multi-user system, or stored in accessible files.
 151 .TP
 152 .B SSH_ASKPASS
 153 dbclient can use an external program to request a password from a user.
 154 SSH_ASKPASS should be set to the path of a program that will return a password
 155 on standard output. This program will only be used if either DISPLAY is set and
 156 standard input is not a TTY, or the environment variable SSH_ASKPASS_ALWAYS is
 157 set.
 158 .SH AUTHOR
 159 Matt Johnston (matt@ucc.asn.au).
 160 .br
 161 Mihnea Stoenescu wrote initial Dropbear client support
 162 .br
 163 Gerrit Pape (pape@smarden.org) wrote this manual page.
 164 .SH SEE ALSO
 165 dropbear(8), dropbearkey(1)
 166 .P
 167 https://matt.ucc.asn.au/dropbear/dropbear.html