release/src/router/dropbear/dropbear.8

   1 .TH dropbear 8
   2 .SH NAME
   3 dropbear \- lightweight SSH2 server
   4 .SH SYNOPSIS
   5 .B dropbear
   6 [\-FEmwsgjki] [\-b
   7 .I banner\fR] [\-d
   8 .I dsskey\fR] [\-r
   9 .I rsakey\fR] [\-p
  10 .IR [address:]port ]
  11 .SH DESCRIPTION
  12 .B dropbear
  13 is a SSH 2 server designed to be small enough to be used in small memory
  14 environments, while still being functional and secure enough for general use.
  15 .SH OPTIONS
  16 .TP
  17 .B \-b \fIbanner
  18 bannerfile.
  19 Display the contents of the file
  20 .I banner
  21 before user login (default: none).
  22 .TP
  23 .B \-d \fIdsskey
  24 dsskeyfile.
  25 Use the contents of the file
  26 .I dsskey
  27 for the DSS host key (default: /etc/dropbear/dropbear_dss_host_key).
  28 Note that
  29 some SSH implementations
  30 use the term "DSA" rather than "DSS", they mean the same thing.
  31 This file is generated with
  32 .BR dropbearkey (8).
  33 .TP
  34 .B \-r \fIrsakey
  35 rsakeyfile.
  36 Use the contents of the file
  37 .I rsakey
  38 for the rsa host key (default: /etc/dropbear/dropbear_rsa_host_key).
  39 This file is generated with
  40 .BR dropbearkey (8).
  41 .TP
  42 .B \-F
  43 Don't fork into background.
  44 .TP
  45 .B \-E
  46 Log to standard error rather than syslog.
  47 .TP
  48 .B \-m
  49 Don't display the message of the day on login.
  50 .TP
  51 .B \-w
  52 Disallow root logins.
  53 .TP
  54 .B \-s
  55 Disable password logins.
  56 .TP
  57 .B \-g
  58 Disable password logins for root.
  59 .TP
  60 .B \-j
  61 Disable local port forwarding.
  62 .TP
  63 .B \-k
  64 Disable remote port forwarding.
  65 .TP
  66 .B \-p \fI[address:]port
  67 Listen on specified
  68 .I address
  69 and TCP
  70 .I port.
  71 If just a port is given listen
  72 on all addresses.
  73 up to 10 can be specified (default 22 if none specified).
  74 .TP
  75 .B \-i
  76 Service program mode.
  77 Use this option to run
  78 .B dropbear
  79 under TCP/IP servers like inetd, tcpsvd, or tcpserver.
  80 In program mode the \-F option is implied, and \-p options are ignored.
  81 .TP
  82 .B \-P \fIpidfile
  83 Specify a pidfile to create when running as a daemon. If not specified, the
  84 default is /var/run/dropbear.pid
  85 .TP
  86 .B \-a
  87 Allow remote hosts to connect to forwarded ports.
  88 .TP
  89 .B \-W \fIwindowsize
  90 Specify the per-channel receive window buffer size. Increasing this
  91 may improve network performance at the expense of memory use. Use -h to see the
  92 default buffer size.
  93 .TP
  94 .B \-K \fItimeout_seconds
  95 Ensure that traffic is transmitted at a certain interval in seconds. This is
  96 useful for working around firewalls or routers that drop connections after
  97 a certain period of inactivity. The trade-off is that a session may be
  98 closed if there is a temporary lapse of network connectivity. A setting
  99 if 0 disables keepalives.
 100 .TP
 101 .B \-I \fIidle_timeout
 102 Disconnect the session if no traffic is transmitted or received for \fIidle_timeout\fR seconds.
 103 .SH FILES
 104
 105 .TP
 106 Authorized Keys
 107
 108 ~/.ssh/authorized_keys can be set up to allow remote login with a RSA or DSS
 109 key. Each line is of the form
 110 .TP
 111 [restrictions] ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIgAsp... [comment]
 112
 113 and can be extracted from a Dropbear private host key with "dropbearkey -y". This is the same format as used by OpenSSH, though the restrictions are a subset (keys with unknown restrictions are ignored).
 114 Restrictions are comma separated, with double quotes around spaces in arguments.
 115 Available restrictions are:
 116
 117 .TP
 118 .B no-port-forwarding
 119 Don't allow port forwarding for this connection
 120
 121 .TP
 122 .B no-agent-forwarding
 123 Don't allow agent forwarding for this connection
 124
 125 .TP
 126 .B no-X11-forwarding
 127 Don't allow X11 forwarding for this connection
 128
 129 .TP
 130 .B no-pty
 131 Disable PTY allocation. Note that a user can still obtain most of the
 132 same functionality with other means even if no-pty is set.
 133
 134 .TP
 135 .B command="\fIforced_command\fR"
 136 Disregard the command provided by the user and always run \fIforced_command\fR.
 137
 138 The authorized_keys file and its containing ~/.ssh directory must only be
 139 writable by the user, otherwise Dropbear will not allow a login using public
 140 key authentication.
 141
 142 .TP
 143 Host Key Files
 144
 145 Host key files are read at startup from a standard location, by default
 146 /etc/dropbear/dropbear_dss_host_key and /etc/dropbear/dropbear_rsa_host_key
 147 or specified on the commandline with -d or -r. These are of the form generated
 148 by dropbearkey.
 149
 150 .TP
 151 Message Of The Day
 152
 153 By default the file /etc/motd will be printed for any login shell (unless
 154 disabled at compile-time). This can also be disabled per-user
 155 by creating a file ~/.hushlogin .
 156
 157 .SH ENVIRONMENT VARIABLES
 158 Dropbear sets the standard variables USER, LOGNAME, HOME, SHELL, PATH, and TERM.
 159
 160 The variables below are set for sessions as appropriate.
 161
 162 .TP
 163 .B SSH_TTY
 164 This is set to the allocated TTY if a PTY was used.
 165
 166 .TP
 167 .B SSH_CONNECTION
 168 Contains "<remote_ip> <remote_port> <local_ip> <local_port>".
 169
 170 .TP
 171 .B DISPLAY
 172 Set X11 forwarding is used.
 173
 174 .TP
 175 .B SSH_ORIGINAL_COMMAND
 176 If a 'command=' authorized_keys option was used, the original command is specified
 177 in this variable. If a shell was requested this is set to an empty value.
 178
 179 .TP
 180 .B SSH_AUTH_SOCK
 181 Set to a forwarded ssh-agent connection.
 182
 183
 184
 185 .SH AUTHOR
 186 Matt Johnston (matt@ucc.asn.au).
 187 .br
 188 Gerrit Pape (pape@smarden.org) wrote this manual page.
 189 .SH SEE ALSO
 190 dropbearkey(8), dbclient(1)
 191 .P
 192 http://matt.ucc.asn.au/dropbear/dropbear.html