This is an old revision of the document!
Table of Contents
Terminal Server
The Synchronet Terminal Server is responsible for providing that “old school” BBS user interface over dial-up modems and classic Internet console protocols (e.g. Telnet).
Features
- Supports ANSI X3.64 (color and monochrome), PETSCII, RIP, and dumb terminals
Configure
The Synchronet Terminal Server can be configured via SCFG:Servers->Terminal Server:
╔══════════════════════════════════════════════╗ ║ Terminal Server ║ ╠══════════════════════════════════════════════╣ ║ │Enabled Yes ║ ║ │Log Level Informational ║ ║ │First Node 1 ║ ║ │Last Node 4 ║ ║ │SSH Support... Port 22 ║ ║ │Telnet Support... Port 23 ║ ║ │RLogin Support... Port 513 ║ ║ │DOS Program Support Yes ║ ║ │40 Column PETSCII Port 64 ║ ║ │80 Column PETSCII Port 128 ║ ║ │Max Concurrent Connections Unlimited ║ ║ │Max Login Inactivity 10 minutes ║ ║ │Max New User Inactivity 1 hour ║ ║ │Max User Inactivity 10 minutes ║ ║ │Output Buffer Drain Timeout 10 ms ║ ║ │Execute Timed Events Yes ║ ║ │Execute QWK-related Events Yes ║ ║ │Lookup Client Hostname Yes ║ ║ │JavaScript Settings... ║ ║ │Failed Login Attempts... ║ ╚══════════════════════════════════════════════╝
╔════════════════════════════════════════════╗ ║ SSH Support ║ ╠════════════════════════════════════════════╣ ║ │Enabled Yes ║ ║ │Interfaces 0.0.0.0, :: ║ ║ │Port 22 ║ ║ │Connect Timeout 10 seconds ║ ║ │Error Level Warning ║ ║ │File Transfer (SFTP) Support No ║ ║ │Max SFTP Inactivity N/A ║ ╚════════════════════════════════════════════╝
╔════════════════════════════════════════════╗ ║ Telnet Support ║ ╠════════════════════════════════════════════╣ ║ │Enabled Yes ║ ║ │Interfaces 0.0.0.0, :: ║ ║ │Port 23 ║ ║ │Command Debug No ║ ║ │Send Go-Aheads Yes ║ ╚════════════════════════════════════════════╝
╔════════════════════════════════════════════╗ ║ RLogin Support ║ ╠════════════════════════════════════════════╣ ║ │Enabled Yes ║ ║ │Interfaces 0.0.0.0, :: ║ ║ │Port 513 ║ ╚════════════════════════════════════════════╝
... or configured (on Windows) via SBBSCTRL:Telnet->Configure dialog
... or configured by manually editing the [BBS]
section of the ctrl/sbbs.ini
file
Key Bindings
Global Ctrl-Keys
These control-key combinations have special purpose at almost any-time while using the Terminal Server:
Ctrl-Key | Description |
---|---|
Ctrl-K | Display a Ctrl-key Menu |
Ctrl-C | Stop the current process / listing / operation |
Ctrl-O | Toggle auto-pause prompt temporarily |
Ctrl-Z | Toggle raw input/output mode |
Ctrl-U | List users online |
Ctrl-P | Page for chat or send instant-message or telegram to users |
Ctrl-T | Display current time information |
Global control-keys are handled in sbbs_t::handle_ctrlkey(), called from sbbs_t::inkey() in inkey.cpp
and exposed in JavaScript via console.inkey().
Global control key handling may be disabled/re-enabled (per key) programmatically via the JavaScript console.ctrlkey_passthru property:
js.on_exit("console.ctrlkey_passthru = " + console.ctrlkey_passthru); console.ctrlkey_passthru|=(1<<16); // Disable Ctrl-P handling in sbbs
Custom global control-key handlers may be installed via SCFG->External Programs->Global Hot Key Events:
╔═══════════════════════════════════════════╗ ║ Global Hot Key Events ║ ╠═══════════════════════════════════════════╣ ║ │Ctrl-P ?privatemsg.js ║ ║ │Ctrl-U ?nodelist.js -active ║ ║ │ ║ ╚═══════════════════════════════════════════╝
Line Input
Additional control-key combinations have special behavior during line (text string) input:
Ctrl-Key | Description |
---|---|
Ctrl-N | Move to next word in line |
Ctrl-\ | Move to previous word in line |
Ctrl-D | Delete word to the right |
Ctrl-W | Delete word to the left |
Ctrl-Y | Delete from the cursor to the end of the line |
Ctrl-X | Delete the entire current line |
Ctrl-L | Center the line and complete input |
Ctrl-Z | Undo (revert edited line) |
Ctrl-R | Redraw current line |
Ctrl-A | Insert an attribute code (when allowed) |
Ctrl-G | Insert a beep character (when allowed) |
The line/string input control-keys are handled via sbbs_t::getstr() in getstr.cpp
and exposed in JavaScript via console.getstr().
Extended Keys
The Synchronet Terminal Server endeavors to support most extended-keys (e.g. home, end, arrow-keys, etc.) on most terminals while simultaneously supporting control-key equivalents for all terminals.
Extended Key | Decimal | Hex | Ctrl-Key | ANSI1) | Other2) | Description (typical use) |
---|---|---|---|---|---|---|
Home | 2 | 02 | Ctrl-B | \e[H | \e[1~ | Move cursor to beginning of line or top of page/list/document |
End | 5 | 05 | Ctrl-E | \e[K and \e[F | \e[4~ | Move cursor to end of line or bottom of page/list/document |
Up-arrow | 30 | 1E | Ctrl-Caret | \e[A | Move cursor up one line or recall previous history item | |
Down-arrow | 10 | 0A | Ctrl-J | \e[B | Move cursor down one line or recall next history item | |
Left-arrow | 29 | 1D | Ctrl-] | \e[D | Move cursor to the left | |
Right-arrow | 6 | 06 | Ctrl-F | \e[C | Move cursor to the right | |
Page-up | 16 | 10 | Ctrl-P | \e[V | \e[5~ | Move cursor up one page |
Page-down | 14 | 0E | Ctrl-N | \e[U | \e[6~ | Move cursor up one page |
Insert | 22 | 16 | Ctrl-V | \e[@ | \e[2~ | Toggle insert/overwrite text mode |
Delete | 127 | 7F | Ctrl-? | \e[3~ | Delete character under cursor (delete-right), also Ctrl-Backspace |
Telnet
Telnet clients (a.k.a. terminal programs) are supported, by default, on the standard Telnet TCP port: 23.
The Synchronet Terminal Server will negotiate Telnet options with the client (enforcing echo and non-line-at-a-time modes), perform IAC
(character 255) escaping, and CR/LF->CR and CR/NUL->CR translation (when not in binary mode).
Options
Telnet options are negotiated between the client and server, normally without any indication to the user.
Telnet options can be re-negotiated at any time during a Telnet session, but most options are only negotiated during the initial connection.
Options | Request | Description |
---|---|---|
ECHO | WILL | Server will provide the echo of input keys, so request the the terminal does not echo (RFC-857) |
SUP_GA | WILL | Server does not send or expect to receive any Telnet Go-Ahead (GA) commands (RFC-858) |
TERM_TYPE | DO | Server would like the client to provide the terminal-type, if available (RFC-930) |
TERM_SPEED | DO | Server would like the client to provide the terminal-speed, if available (RFC-1079) |
SEND_LOCATION | DO | Server would like the client to provide the user's location, if available (RFC-779) |
NEGOTIATE_WINDOW_SIZE | DO | Server would like the client to provide the terminal dimensions (cols x rows), if available (RFC-1073) |
NEW_ENVIRON | DO | Server would like the client to provide environment variables (RFC-1572) - unused |
The BINARY_TX option (disabling special treatment of CR/LF and CR/NUL) is dynamically negotiated as needed, for file transfers.
Debugging
The Terminal server logs all Telnet option negotiations using a Debugging log-level:
6/20 05:56:41p Node 1 sending telnet cmd: WILL Echo 6/20 05:56:41p Node 1 sending telnet cmd: WILL Suppress Go Ahead 6/20 05:56:41p Node 1 sending telnet cmd: DO Terminal Type 6/20 05:56:41p Node 1 sending telnet cmd: DO Terminal Speed 6/20 05:56:41p Node 1 sending telnet cmd: DO Send Location 6/20 05:56:41p Node 1 sending telnet cmd: DO Negotiate About Window Size 6/20 05:56:41p Node 1 sending telnet cmd: DO New Environment Option 6/20 05:56:41p Node 1 received telnet cmd: DO Echo 6/20 05:56:41p Node 1 received telnet cmd: DO Suppress Go Ahead 6/20 05:56:41p Node 1 received telnet cmd: WILL Terminal Type 6/20 05:56:41p Node 1 requesting telnet terminal type 6/20 05:56:41p Node 1 received telnet cmd: WON'T Terminal Speed 6/20 05:56:41p Node 1 sending telnet cmd: DON'T Terminal Speed 6/20 05:56:41p Node 1 received telnet cmd: WON'T Send Location 6/20 05:56:41p Node 1 sending telnet cmd: DON'T Send Location 6/20 05:56:41p Node 1 received telnet cmd: WILL Negotiate About Window Size 6/20 05:56:41p Node 1 received telnet sub-negotiation command: Negotiate About Window Size 6/20 05:56:41p Node 1 received telnet window size: 80x24 6/20 05:56:41p Node 1 received telnet cmd: WON'T New Environment Option 6/20 05:56:41p Node 1 received telnet sub-negotiation command: Terminal Type 6/20 05:56:41p Node 1 received telnet terminal type: ANSI
SSH
Secure Shell version 2 clients are supported, by default, on the standard SSH TCP port: 22.
SSHv2 support provided by cryptlib.
cryptlib.key
The SSH private key is stored in the file ctrl/cryptlib.key
and is encrypted with the configured System Password (from SCFG->System). If the System Password is changed after the cryptlib.key
file has been generated (and encrypted), you will need to delete the key file and recycle the terminal server for the key file to be regenerated and re-encrypted with the new System Password.
The following Terminal Server log message indicates a problem decrypting the cryptlib.key
file:
'Couldn't import the session key used to protect the private key' (-22) getting private key
RLogin
BSD Rlogin (RFC-1282) clients are supported, by default, on the standard RLogin TCP port: 513.
History
Synchronet's RLogin support has gone through some significant changes since its introduction in 2000.
SBBS v3.00c 2000
- digital man added initial support for accepting connections from BSD RLogin:
The Synchronet Telnet Server (later referred to as the “Terminal Server”) was enhanced to recognize the BSD RLogin connect sequence on a secondary port (TCP port 513 by default) and bypass the “Login:” prompt if the username specified in either first (client-user-name
) or second (server-user-name
) strings sent from the RLogin client were recognized as a valid user/login ID (alias). The default behavior was to compare the first (client-user-name
) string as the attempted login ID but this could be changed by checking the SBBSCTRL:Telnet->Configure->RLogin->Use 2nd Login Name checkbox. Comparing *both* RLogin-client provided strings was not supported (only one or the other would be compared against the user database).
- The password prompt was still displayed and a valid password required in order to login as the identified user ID. If the user ID was not recognized as a valid user, then the new user application process was started (with the user's alias automatically filled in with the specified
client-user-name
orserver-user-name
value).
SBBS v3.10g 2002
- digital man added support for the Telnet gateway module to be optionally used as a gateway to an RLogin server (e.g. TradeWars Game Server, aka TWGS) - by specifying the
TG_RLOGIN
mode flag to thetelnet_gate
function (via Baja or JavaScript). The current user's login ID (alias) was sent as theclient-user-name
string and the user's real name was sent as theserver-user-name
string as part of the outbound RLogin connection establishment.
SBBS v3.12a 2004
- Deuce changed the default configuration to enable/accept RLogin connections.
- Deuce added support for automatic-login if a valid user password was supplied in either the
client-user-name
orserver-user-name
strings sent from the RLogin client (which string was assumed to be the user ID and which was assumed to be the password was determined by the “Use 2nd Login Name” option) or the client's IP address was listed in the (newly introduced)text/rlogin.can
file, then the user would be automatically logged in without needing to provide/send a password.
SBBS v3.13a 2005
- Deuce changed the RLogin connection behavior as follows:
if (specified user does not exist) { if (rlogin password recieved) { create new user with specified password } else { create new user with random password show password to user allow user to change password validate new password } } else { if(password is correct) { logon user } else { prompt for current password } }
SBBS v3.16a 2012
- echicken added a new mode flag (
TG_SENDPASS
) to thetelnet_gate
function which if combined withTG_RLOGIN
mode flag would send the current user's password as the second RLogin string (server-user-name
) during an outbound RLogin connection (instead of the default behavior of sending the current user's real name).
SBBS v3.16a 2013
- mcmlxxix removed echicken's
TG_SENDPASS
mode flag support and created a new function (bbs.rlogin_gate
) which accepted arguments to be sent to the remote RLogin server (presumably, the user's name and password, in that order).
SBBS v3.16b 2014
- digital man removed and deprecated the
USE_2ND_RLOGIN
option (and related sbbs command-line option and sbbsctrl checkbox) as this is now the only behavior supported by the Synchronet Terminal Server: the first string received from the RLogin client (client-user-name
) may be a password, the second string received (server-user-name
) must be a valid user ID (alias). - digital man changed the
bbs.rlogin_gate
function to accept 3 optional arguments:client-user-name
,server-user-name
, andterminal
, in the order specified by the RFC-1282.
JavaScript
Additional JavaScript objects are available to Terminal Server modules only: