libexec/telnetd/telnetd.8

   1 .\" Copyright (c) 1983, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)telnetd.8   8.4 (Berkeley) 6/1/94
  29 .\" $FreeBSD: src/crypto/telnet/telnetd/telnetd.8,v 1.5.2.6 2002/04/13 10:59:09 markm Exp $
  30 .\"
  31 .Dd July 27, 2009
  32 .Dt TELNETD 8
  33 .Os
  34 .Sh NAME
  35 .Nm telnetd
  36 .Nd DARPA
  37 .Tn TELNET
  38 protocol server
  39 .Sh SYNOPSIS
  40 .Nm /usr/libexec/telnetd
  41 .\".Op Fl BUhlkn
  42 .Op Fl Uhlkn
  43 .Op Fl D Ar debugmode
  44 .Op Fl S Ar tos
  45 .Op Fl X Ar authtype
  46 .Op Fl a Ar authmode
  47 .Op Fl edebug
  48 .Op Fl p Ar loginprog
  49 .Op Fl u Ar len
  50 .Op Fl debug Op Ar port
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 command is a server which supports the
  55 .Tn DARPA
  56 standard
  57 .Tn TELNET
  58 virtual terminal protocol.
  59 .Nm Telnetd
  60 is normally invoked by the internet server (see
  61 .Xr inetd 8 )
  62 for requests to connect to the
  63 .Tn TELNET
  64 port as indicated by the
  65 .Pa /etc/services
  66 file (see
  67 .Xr services 5 ) .
  68 The
  69 .Fl debug
  70 option may be used to start up
  71 .Nm
  72 manually, instead of through
  73 .Xr inetd 8 .
  74 If started up this way,
  75 .Ar port
  76 may be specified to run
  77 .Nm
  78 on an alternate
  79 .Tn TCP
  80 port number.
  81 .Pp
  82 The
  83 .Nm
  84 command accepts the following options:
  85 .Bl -tag -width indent
  86 .It Fl a Ar authmode
  87 This option may be used for specifying what mode should
  88 be used for authentication.
  89 Note that this option is only useful if
  90 .Nm
  91 has been compiled with support for the
  92 .Dv AUTHENTICATION
  93 option.
  94 There are several valid values for
  95 .Ar authmode :
  96 .Bl -tag -width debug
  97 .It Cm debug
  98 Turn on authentication debugging code.
  99 .It Cm user
 100 Only allow connections when the remote user
 101 can provide valid authentication information
 102 to identify the remote user,
 103 and is allowed access to the specified account
 104 without providing a password.
 105 .It Cm valid
 106 Only allow connections when the remote user
 107 can provide valid authentication information
 108 to identify the remote user.
 109 The
 110 .Xr login 1
 111 command will provide any additional user verification
 112 needed if the remote user is not allowed automatic
 113 access to the specified account.
 114 .It Cm other
 115 Only allow connections that supply some authentication information.
 116 This option is currently not supported
 117 by any of the existing authentication mechanisms,
 118 and is thus the same as specifying
 119 .Fl a
 120 .Cm valid .
 121 .It Cm none
 122 This is the default state.
 123 Authentication information is not required.
 124 If no or insufficient authentication information
 125 is provided, then the
 126 .Xr login 1
 127 program will provide the necessary user
 128 verification.
 129 .It Cm off
 130 Disable the authentication code.
 131 All user verification will happen through the
 132 .Xr login 1
 133 program.
 134 .El
 135 .\".It Fl B
 136 .\"Specify bftp server mode.
 137 .\"In this mode,
 138 .\".Nm
 139 .\"causes login to start a
 140 .\".Xr bftp 1
 141 .\"session rather than the user's normal shell.
 142 .\"In bftp daemon mode normal logins are not supported, and it must be used
 143 .\"on a port other than the normal
 144 .\".Tn TELNET
 145 .\"port.
 146 .It Fl D Ar debugmode
 147 This option may be used for debugging purposes.
 148 This allows
 149 .Nm
 150 to print out debugging information
 151 to the connection, allowing the user to see what
 152 .Nm
 153 is doing.
 154 There are several possible values for
 155 .Ar debugmode :
 156 .Bl -tag -width exercise
 157 .It Cm options
 158 Print information about the negotiation of
 159 .Tn TELNET
 160 options.
 161 .It Cm report
 162 Print the
 163 .Cm options
 164 information, plus some additional information
 165 about what processing is going on.
 166 .It Cm netdata
 167 Display the data stream received by
 168 .Nm .
 169 .It Cm ptydata
 170 Display data written to the pty.
 171 .It Cm exercise
 172 Has not been implemented yet.
 173 .El
 174 .It Fl debug
 175 Enable debugging on each socket created by
 176 .Nm
 177 (see
 178 .Dv SO_DEBUG
 179 in
 180 .Xr socket 2 ) .
 181 .It Fl edebug
 182 If
 183 .Nm
 184 has been compiled with support for data encryption, then the
 185 .Fl edebug
 186 option may be used to enable encryption debugging code.
 187 .It Fl h
 188 Disable the printing of host-specific information before
 189 login has been completed.
 190 .It Fl k
 191 This option is only useful if
 192 .Nm
 193 has been compiled with both linemode and kludge linemode
 194 support.
 195 If the
 196 .Fl k
 197 option is specified, then if the remote client does not
 198 support the
 199 .Dv LINEMODE
 200 option, then
 201 .Nm
 202 will operate in character at a time mode.
 203 It will still support kludge linemode, but will only
 204 go into kludge linemode if the remote client requests
 205 it.
 206 (This is done by the client sending
 207 .Dv DONT SUPPRESS-GO-AHEAD
 208 and
 209 .Dv DONT ECHO . )
 210 The
 211 .Fl k
 212 option is most useful when there are remote clients
 213 that do not support kludge linemode, but pass the heuristic
 214 (if they respond with
 215 .Dv WILL TIMING-MARK
 216 in response to a
 217 .Dv DO TIMING-MARK )
 218 for kludge linemode support.
 219 .It Fl l
 220 Specify line mode.
 221 Try to force clients to use line-at-a-time mode.
 222 If the
 223 .Dv LINEMODE
 224 option is not supported, it will go
 225 into kludge linemode.
 226 .It Fl n
 227 Disable
 228 .Dv TCP
 229 keep-alives.
 230 Normally
 231 .Nm
 232 enables the
 233 .Tn TCP
 234 keep-alive mechanism to probe connections that
 235 have been idle for some period of time to determine
 236 if the client is still there, so that idle connections
 237 from machines that have crashed or can no longer
 238 be reached may be cleaned up.
 239 .It Fl p Ar loginprog
 240 Specify an alternate
 241 .Xr login 1
 242 command to run to complete the login.
 243 The alternate command must
 244 understand the same command arguments as the standard login.
 245 .It Fl S Ar tos
 246 .It Fl u Ar len
 247 This option is used to specify the size of the field
 248 in the
 249 .Dv utmp
 250 structure that holds the remote host name.
 251 If the resolved host name is longer than
 252 .Ar len ,
 253 the dotted decimal value will be used instead.
 254 This allows hosts with very long host names that
 255 overflow this field to still be uniquely identified.
 256 Specifying
 257 .Fl u0
 258 indicates that only dotted decimal addresses
 259 should be put into the
 260 .Pa utmp
 261 file.
 262 .It Fl U
 263 This option causes
 264 .Nm
 265 to refuse connections from addresses that
 266 cannot be mapped back into a symbolic name
 267 via the
 268 .Xr gethostbyaddr 3
 269 routine.
 270 .It Fl X Ar authtype
 271 This option is only valid if
 272 .Nm
 273 has been built with support for the authentication option.
 274 It disables the use of
 275 .Ar authtype
 276 authentication, and
 277 can be used to temporarily disable
 278 a specific authentication type without having to recompile
 279 .Nm .
 280 .El
 281 .Pp
 282 .Nm Telnetd
 283 operates by allocating a pseudo-terminal device (see
 284 .Xr pty 4 )
 285 for a client, then creating a login process which has
 286 the slave side of the pseudo-terminal as
 287 .Dv stdin ,
 288 .Dv stdout
 289 and
 290 .Dv stderr .
 291 .Nm Telnetd
 292 manipulates the master side of the pseudo-terminal,
 293 implementing the
 294 .Tn TELNET
 295 protocol and passing characters
 296 between the remote client and the login process.
 297 .Pp
 298 When a
 299 .Tn TELNET
 300 session is started up,
 301 .Nm
 302 sends
 303 .Tn TELNET
 304 options to the client side indicating
 305 a willingness to do the
 306 following
 307 .Tn TELNET
 308 options, which are described in more detail below:
 309 .Bd -literal -offset indent
 310 DO AUTHENTICATION
 311 WILL ENCRYPT
 312 DO TERMINAL TYPE
 313 DO TSPEED
 314 DO XDISPLOC
 315 DO NEW-ENVIRON
 316 DO ENVIRON
 317 WILL SUPPRESS GO AHEAD
 318 DO ECHO
 319 DO LINEMODE
 320 DO NAWS
 321 WILL STATUS
 322 DO LFLOW
 323 DO TIMING-MARK
 324 .Ed
 325 .Pp
 326 The pseudo-terminal allocated to the client is configured
 327 to operate in
 328 .Dq cooked
 329 mode, and with
 330 .Dv XTABS and
 331 .Dv CRMOD
 332 enabled (see
 333 .Xr tty 4 ) .
 334 .Pp
 335 .Nm Telnetd
 336 has support for enabling locally the following
 337 .Tn TELNET
 338 options:
 339 .Bl -tag -width "DO AUTHENTICATION"
 340 .It "WILL ECHO"
 341 When the
 342 .Dv LINEMODE
 343 option is enabled, a
 344 .Dv WILL ECHO
 345 or
 346 .Dv WONT ECHO
 347 will be sent to the client to indicate the
 348 current state of terminal echoing.
 349 When terminal echo is not desired, a
 350 .Dv WILL ECHO
 351 is sent to indicate that
 352 .Nm
 353 will take care of echoing any data that needs to be
 354 echoed to the terminal, and then nothing is echoed.
 355 When terminal echo is desired, a
 356 .Dv WONT ECHO
 357 is sent to indicate that
 358 .Nm
 359 will not be doing any terminal echoing, so the
 360 client should do any terminal echoing that is needed.
 361 .It "WILL BINARY"
 362 Indicate that the client is willing to send a
 363 8 bits of data, rather than the normal 7 bits
 364 of the Network Virtual Terminal.
 365 .It "WILL SGA"
 366 Indicate that it will not be sending
 367 .Dv IAC GA ,
 368 go ahead, commands.
 369 .It "WILL STATUS"
 370 Indicate a willingness to send the client, upon
 371 request, of the current status of all
 372 .Tn TELNET
 373 options.
 374 .It "WILL TIMING-MARK"
 375 Whenever a
 376 .Dv DO TIMING-MARK
 377 command is received, it is always responded
 378 to with a
 379 .Dv WILL TIMING-MARK .
 380 .It "WILL LOGOUT"
 381 When a
 382 .Dv DO LOGOUT
 383 is received, a
 384 .Dv WILL LOGOUT
 385 is sent in response, and the
 386 .Tn TELNET
 387 session is shut down.
 388 .It "WILL ENCRYPT"
 389 Only sent if
 390 .Nm
 391 is compiled with support for data encryption, and
 392 indicates a willingness to decrypt
 393 the data stream.
 394 .El
 395 .Pp
 396 .Nm Telnetd
 397 has support for enabling remotely the following
 398 .Tn TELNET
 399 options:
 400 .Bl -tag -width "DO AUTHENTICATION"
 401 .It "DO BINARY"
 402 Sent to indicate that
 403 .Nm
 404 is willing to receive an 8 bit data stream.
 405 .It "DO LFLOW"
 406 Requests that the client handle flow control
 407 characters remotely.
 408 .It "DO ECHO"
 409 This is not really supported, but is sent to identify a
 410 .Bx 4.2
 411 .Xr telnet 1
 412 client, which will improperly respond with
 413 .Dv WILL ECHO .
 414 If a
 415 .Dv WILL ECHO
 416 is received, a
 417 .Dv DONT ECHO
 418 will be sent in response.
 419 .It "DO TERMINAL-TYPE"
 420 Indicate a desire to be able to request the
 421 name of the type of terminal that is attached
 422 to the client side of the connection.
 423 .It "DO SGA"
 424 Indicate that it does not need to receive
 425 .Dv IAC GA ,
 426 the go ahead command.
 427 .It "DO NAWS"
 428 Requests that the client inform the server when
 429 the window (display) size changes.
 430 .It "DO TERMINAL-SPEED"
 431 Indicate a desire to be able to request information
 432 about the speed of the serial line to which
 433 the client is attached.
 434 .It "DO XDISPLOC"
 435 Indicate a desire to be able to request the name
 436 of the X Window System display that is associated with
 437 the telnet client.
 438 .It "DO NEW-ENVIRON"
 439 Indicate a desire to be able to request environment
 440 variable information, as described in RFC 1572.
 441 .It "DO ENVIRON"
 442 Indicate a desire to be able to request environment
 443 variable information, as described in RFC 1408.
 444 .It "DO LINEMODE"
 445 Only sent if
 446 .Nm
 447 is compiled with support for linemode, and
 448 requests that the client do line by line processing.
 449 .It "DO TIMING-MARK"
 450 Only sent if
 451 .Nm
 452 is compiled with support for both linemode and
 453 kludge linemode, and the client responded with
 454 .Dv WONT LINEMODE .
 455 If the client responds with
 456 .Dv WILL TM ,
 457 the it is assumed that the client supports
 458 kludge linemode.
 459 Note that the
 460 .Op Fl k
 461 option can be used to disable this.
 462 .It "DO AUTHENTICATION"
 463 Only sent if
 464 .Nm
 465 is compiled with support for authentication, and
 466 indicates a willingness to receive authentication
 467 information for automatic login.
 468 .It "DO ENCRYPT"
 469 Only sent if
 470 .Nm
 471 is compiled with support for data encryption, and
 472 indicates a willingness to decrypt
 473 the data stream.
 474 .El
 475 .Sh NOTES
 476 By default
 477 .Nm
 478 will read the
 479 .Em \&he ,
 480 .Em \&hn ,
 481 and
 482 .Em \&im
 483 capabilities from
 484 .Pa /etc/gettytab
 485 and use that information (if present) to determine
 486 what to display before the login: prompt.
 487 You can also use a System V style
 488 .Pa /etc/issue
 489 file by using the
 490 .Em \&if
 491 capability, which will override
 492 .Em \&im .
 493 The information specified in either
 494 .Em \&im
 495 or
 496 .Em \&if
 497 will be displayed to both console and remote logins.
 498 .\" .Sh ENVIRONMENT
 499 .Sh FILES
 500 .Bl -tag -width ".Pa /etc/services" -compact
 501 .It Pa /etc/services
 502 .It Pa /etc/gettytab
 503 .It Pa /etc/iptos
 504 (if supported)
 505 .\".It Pa /usr/ucb/bftp
 506 .\"(if supported)
 507 .El
 508 .Sh "SEE ALSO"
 509 .\".Xr bftp 1 ,
 510 .Xr login 1 ,
 511 .Xr telnet 1
 512 (if supported),
 513 .Xr gettytab 5
 514 .Sh STANDARDS
 515 .Bl -tag -compact -width ".Cm RFC 1572"
 516 .It Cm RFC 854
 517 .Tn TELNET
 518 PROTOCOL SPECIFICATION
 519 .It Cm RFC 855
 520 TELNET OPTION SPECIFICATIONS
 521 .It Cm RFC 856
 522 TELNET BINARY TRANSMISSION
 523 .It Cm RFC 857
 524 TELNET ECHO OPTION
 525 .It Cm RFC 858
 526 TELNET SUPPRESS GO AHEAD OPTION
 527 .It Cm RFC 859
 528 TELNET STATUS OPTION
 529 .It Cm RFC 860
 530 TELNET TIMING MARK OPTION
 531 .It Cm RFC 861
 532 TELNET EXTENDED OPTIONS - LIST OPTION
 533 .It Cm RFC 885
 534 TELNET END OF RECORD OPTION
 535 .It Cm RFC 1073
 536 Telnet Window Size Option
 537 .It Cm RFC 1079
 538 Telnet Terminal Speed Option
 539 .It Cm RFC 1091
 540 Telnet Terminal-Type Option
 541 .It Cm RFC 1096
 542 Telnet X Display Location Option
 543 .It Cm RFC 1123
 544 Requirements for Internet Hosts -- Application and Support
 545 .It Cm RFC 1184
 546 Telnet Linemode Option
 547 .It Cm RFC 1372
 548 Telnet Remote Flow Control Option
 549 .It Cm RFC 1416
 550 Telnet Authentication Option
 551 .It Cm RFC 1411
 552 Telnet Authentication: Kerberos Version 4
 553 .It Cm RFC 1412
 554 Telnet Authentication: SPX
 555 .It Cm RFC 1571
 556 Telnet Environment Option Interoperability Issues
 557 .It Cm RFC 1572
 558 Telnet Environment Option
 559 .El
 560 .Sh HISTORY
 561 IPv6 support was added by WIDE/KAME project.
 562 .Sh BUGS
 563 Some
 564 .Tn TELNET
 565 commands are only partially implemented.
 566 .Pp
 567 Because of bugs in the original
 568 .Bx 4.2
 569 .Xr telnet 1 ,
 570 .Nm
 571 performs some dubious protocol exchanges to try to discover if the remote
 572 client is, in fact, a
 573 .Bx 4.2
 574 .Xr telnet 1 .
 575 .Pp
 576 Binary mode
 577 has no common interpretation except between similar operating systems
 578 (Unix in this case).
 579 .Pp
 580 The terminal type name received from the remote client is converted to
 581 lower case.
 582 .Pp
 583 .Nm Telnetd
 584 never sends
 585 .Tn TELNET
 586 .Dv IAC GA
 587 (go ahead) commands.