home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
DP Tool Club 19
/
CD_ASCQ_19_010295.iso
/
vrac
/
ka9qdr20.zip
/
KA9QDOOR.DOC
< prev
next >
Wrap
Text File
|
1994-11-25
|
36KB
|
1,143 lines
KA9QDOOR (tm)
Provides a Full TCP/IP Internet Gateway
by
Runnning KA9Q NOS as a PCBoard DOOR
Version 2.0
Copyright (C) 1990-94
All Rights Reserved
by
KEY SOFTWARE PRODUCTS
440 Ninth Avenue
Menlo Park, California 94025-1802
415-364-9847
KA9QDOOR is a trademark of Key Software Products.
PCBoard is a trademark of Clark Development Corporation.
TABLE OF CONTENTS
CHAPTER 1 - INTRODUCTION ........................... 1
CHAPTER 2 - CONFIGURING KA9Q NOS (NET.EXE) ............ 3
CHAPTER 3 - CONFIGURING THE PCBOARD DOOR COMMAND ....... 5
CHAPTER 4 - CONFIGURING KA9QDOOR .................... 6
4.1 Registration Information .................... 6
4.1.1 Registered Owner ....................... 6
4.1.2 Access Key ............................. 6
4.2 Options related to NET.EXE .................... 6
4.2.1 Program Filespec ....................... 6
4.2.2 Configuration Filespec ................. 7
4.2.3 Termination String ..................... 7
4.3 Operating Limits ............................ 7
4.3.1 Time Limit ............................. 8
4.3.2 Inactivity Limit ....................... 8
4.3.3 Minimum Baud Rate ....................... 8
4.3.4 Hardware handshaking ................... 8
4.3.5 Operating Hours ........................ 9
4.4 Display Files ............................... 9
4.4.1 Startup Message ........................ 9
4.4.2 Time Limit Message ...................... 9
4.4.3 Inactivity Message ..................... 9
4.4.4 Low Speed Message ....................... 10
4.4.5 Operating Hours Message ................. 10
4.5 Log Files ................................... 10
CHAPTER 5 - CUSTOMIZING THE DISPLAY FILES ............. 12
5.1 PCBoard Display Macros ....................... 12
5.2 Macros Unique to KA9QDOOR ..................... 12
5.3 Justification and Spacing .................... 12
5.3.1 No Justification ....................... 13
5.3.2 Left Justification ..................... 13
5.3.3 Center Justification ................... 13
5.3.4 Right Justification .................... 13
5.4 The DISPLAY Program .......................... 13
APPENDIX 1 - HOW TO REACH US .......................... 15
APPENDIX 2 - RETRIEVING FILES FROM KEY SOFTWARE PRODUCTS 16
APPENDIX 3 - LIMITED WARRANTY ....................... 17
Nov 25, 1994 KA9QDOOR (tm) 1
CHAPTER 1 - INTRODUCTION
Many BBS's now offer E-Mail access to the Internet. But few if
any offer a real TCP/IP connection. As compared to mere E-Mail
access, providing a TCP/IP connection opens up a large number of
new possibilities to callers, such as the ability to remote
login to Internet hosts in foreign countries using Telnet, or to
access files on those hosts using FTP, or to search for
information using Gopher, Archie, and the new multimedia
hypertext browser, Mosaic.
KA9QDOOR (together with the KA9Q NOS program) establishes a
logical two-way connection between the user's serial line and
the Internet:
+----------+ |
User's | | | Local Area Network
Modem <----->| KA9QDOOR |<----+ connected to the
| | | Internet
+----------+ |
BBS Machine
As indicated, the physical connection between the BBS machine
and the Internet is usually by means of an Ethernet card
attached to a local area network that is attached to the
Internet. However, this connection could instead be simply a
separate modem connection to a commercial Internet access
provider, such as NETCOM.
TCP/IP encapsulates data in packets and transfers those packets
according to specific communication protocols. This requires
that data on the serial line between the BBS and the caller must
obey one of two popular serial protocols: either the Serial Link
Internet Protocol (SLIP) or the Point-to-Point Protocol (PPP).
Thus the gateway software (running in the BBS machine) and the
"client" software running on the caller's machine) must both
support SLIP and/or PPP protocols.
The freeware KA9Q NOS program (NET.EXE) can be used as the
gateway software, and supports both SLIP and PPP protocols.
However, since NET was designed to run as a stand-alone program,
and not with a BBS, it does not:
1. Terminate when user's time limit expires.
2. Terminate when user hangs up.
3. Terminate when there's no activity for some period
of time.
4. Record termination in PCBoard log file.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 2
5. Provide colorized or parameterized messages to
user.
6. Restrict users by baud rate.
7. Restrict hours of operation.
KA9QDOOR was designed to solve these limitations. It runs as a
PCBoard BBS door command, and loads and executes NET while
providing all the missing services listed above. While NET is
running, KA9QDOOR is constantly checking to see if the user's
time has expired, if he hung up the phone, or if he's inactive.
In any of these situations, KA9QDOOR terminates NET in a
graceful manner.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 3
CHAPTER 2 - CONFIGURING KA9Q NOS (NET.EXE)
Most of the hard work in setting up the gateway is configuring
KA9Q NOS (NET). We strongly suggest that begin by trying to get
NET running stand alone. That will probably be about 90% of the
work; setting up the door using KA9QDOOR is relatively trivial
by comparison.
This document is not intended to teach you about NET; you will
definitely need to obtain a copy of the documentation for NET
(see Appendices). However, we've included a file called
AUTOEXEC.NET that is a sample configuration file to operate NET
as a SLIP to Ethernet gateway. A similar file could be prepared
to implement a PPP to Ethernet gateway if you prefer.
Although the specific parameters in this file are ficticious (to
protect the system it came from), it is STRONGLY recommend that
you follow the example, changing only the parameters indicated
as in
ip address 130.253.15.148
# ^^^^^^^^^^^^^^
and NOT the number or order of the commands.
There are two reasons why it's important to use NET's built-in
SLIP or PPP serial port drivers ("attach asy") rather than an
external packet driver.
First, a packet driver is usually installed as a TSR and thus is
resident while PCBoard is running; this usually interferes with
regular operation of PCBoard. (The built-in drivers of NET are
only resident while NET is running, and thus cannot interfere
with PCBoard.)
Second, KA9QDOOR automatically scans NET's configuration file
and sets the baud rate used by NET to the same value used by
PCBoard. It does this by searching for an "attach asy" command
that specifies the same serial port base address as that used by
PCBoard.
You'll probably need the help of the network administrator who
takes care of your local area network. They'll need to assign
an Internet style name to your BBS and at least three Internet
IP addresses to you: one for the Ethernet card in the BBS and
two for the two ends of the serial (SLIP) link - i.e., one for
the BBS itself and another for the caller. You'll need to check
with this same person to get the IP address of your network's
name server and router, as well as their help regarding the
"netmask", "route", "rip", and "arp" entries.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 4
You may also need to modify the "attach packet" command
according to the software interrupt vector you use for your
Ethernet card's packet driver, and the "attach asy" command
according to the base address, interrupt vector, and DTE (PC to
modem) baud rate of your BBS's modem.
Don't expect that coming up with all the right parameters will
be easy. And be sure to obtain a copy of the documentation for
the NET program you're using - it (and a competent network
administrator) are the best (and only) resources to work from.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 5
CHAPTER 3 - CONFIGURING THE PCBOARD DOOR COMMAND
To run KA9QDOOR as a PCBoard door, you must create a batch file
(without the ".BAT" extension) that contains the commands to be
performed. For KA9QDOOR, this is trivial. The file should
contain simply
C:\KA9QDOOR\KA9QDOOR <filespec>
BOARD
where "<filespec>" specifies the location of KA9QDOOR's
configuration file (described in the next chapter).
Do NOT add commands to the door batch file that change the
default drive or directory before KA9QDOOR runs. It expects to
find the DOOR.SYS file in the same drive and directory that
PCBoard is in when the door command begins executing.
If the name of the door batch file is "SLIP", then the
corresponding entry in the PCBoard setup should be:
USER DOOR
Filename Password Sec Login SYS SYS Shell Path to DOOR Files
-------- -------- --- ----- --- --- ----- ------------------
SLIP 0 N N Y N C:\KA9QDOOR
Of course you may change some of the above settings, but be sure
to enter "N" under the "USER.SYS" column, and "Y" under the
"DOOR.SYS" column. For further details, please refer to the
PCBoard documentation.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 6
CHAPTER 4 - CONFIGURING KA9QDOOR
KA9QDOOR requires a single command line argument, which is the
name of its configuration file. This is a text file of options,
one per line. Each option consists of a keyword followed by a
separator and a string. Blank lines and lines beginning with
anything other than a letter are considered comments and are
ignored. Any character can serve as a separator; we recommend
either an equals sign (=) or a colon (:).
4.1 Registration Information
The unlicensed version of KA9QDOOR imposes a maximum time limit
of ten minutes per session. To eliminate this restriction, you
must purchase an access key from Key Software Products. The key
is derived from your name; both your name and the corresponding
key must be entered as options to remove the unlicensed
restrictions.
4.1.1 Registered Owner
Syntax: owner=<your name>
Example: owner=John Doe
Purpose: Specifies the name used when you obtained your access
key by registering KA9QDOOR. KA9QDOOR behaves as an
unlicensed version if omitted.
4.1.2 Access Key
Syntax: key=<character sequence>
Example: key=12345678
Purpose: Specifies the access key you obtained when you
registered KA9QDOOR. KA9QDOOR behaves as an unlicensed
version if omitted.
4.2 Options related to NET.EXE
The following options specify information needed to run the KA9Q
NOS program (NET.EXE).
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 7
4.2.1 Program Filespec
Syntax: filespec=<program filespec>
Example: filespec=c:\bin\net.exe
Purpose: Specifies the name and location of the executable file
image of the NET.EXE program. Required.
4.2.2 Configuration Filespec
Syntax: cmdtail=<configuration filespec>
Example: cmdtail=c:\slip\autoexec.net
Purpose: Specifies the command line options for the NET.EXE
program. Required; the last option in the string must
be the filespec specifying the name and location of
NET's configuration file.
4.2.3 Termination String
Syntax: stuffkeyboard=<string>
Example: stuffkeyboard=exit<cr>
Purpose: Specifies the keyboard sequence to be stuffed into the
keyboard type ahead buffer in order to terminate
NET.EXE. Required.
Since KA9QDOOR was designed to be as general-purpose as
possible, there are several rather obvious "macros"
(such as the "<cr>" in "exit<cr>" above) that can be
used to represent special keystrokes, as follows:
<pgdn> <pgup> <home> <end>
<del> <ins> <esc> <escape>
<left> <right> <up> <down>
<bs> <backspace> <cr> <enter>
<return> <tab>
and <f1> through <f12>
4.3 Operating Limits
The following options control various operating limits that are
monitored while NET.EXE is running:
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 8
4.3.1 Time Limit
Syntax: maxminutes=<number>
Example: maxminutes=30
Purpose: Overrides the time remaining as specified by PCBoard if
lower. If omitted, time remaining is that specified by
PCBoard.
4.3.2 Inactivity Limit
Syntax: idleminutes=<minutes>,<packet vector>
Example: idleminutes=10,96
Purpose: Establishes an upper limit on how long the session can
remain inactive before it is terminated. It does this
by monitoring calls to the (Ethernet) packet driver
through its API - a software interrupt known as the
"packet vector", specified as a decimal number. If
omitted, no inactivity limit is imposed.
4.3.3 Minimum Baud Rate
Syntax: mindcespeed=<baudrate>[,<security>]
Example: mindcespeed=9600
Example: mindcespeed=9600,100
Purpose: Specifies a minimum baud rate required to use the
gateway, and an optional security level required to
override the minimum baud rate. If omitted, no minimum
baud rate will be required.
4.3.4 Hardware handshaking
Syntax: checkcts=[ 1 | 0 ]
Example: checkcts=1
Purpose: If 1, specifies that hardware handshaking (CTS) should
be enabled on the BBS modem port. If omitted, default
is determined by DTE versus DCE speed: default is
enabled if DTE speed is greater than DCE speed
(compression enabled), else not.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 9
4.3.5 Operating Hours
Syntax: ophours=<hh:mm-hh:mm>
Example: ophours=21:00-23:00
Purpose: To establish the hours of operation for the gateway;
attempts to use the gateway at other times will be
disallowed. Times must be specified in 24 hour
format. If omitted, the gateway may be used at any
time.
4.4 Display Files
KA9QDOOR sends the following display files to the user as
indicated. Each file may be customized with special "macros" to
colorize the display files or with macros that are replaced by
user-specific or configuration-specific information. See the
following chapter for a complete list of supported macros.
4.4.1 Startup Message
Syntax: startupmsg=<filespec>
Example: startupmsg=c:\slip\startup.msg
Purpose: Specifies the location of a display file sent to the
user when the gateway is initialized. If omitted, no
display file is sent.
4.4.2 Time Limit Message
Syntax: timeoutmsg=<filespec>
Example: timeoutmsg=c:\slip\timeout.msg
Purpose: Specifies the location of a display file sent to the
user if the session is terminated because it exceeded
the time limit. If omitted, no display file is sent.
Note: This display file may be irrelevant, since it is sent
as raw ascii, without any TCP/IP packaging. I.e., the
user may never see it!
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 10
4.4.3 Inactivity Message
Syntax: idlemsg=<filespec>
Example: idlemsg=c:\slip\tooidle.msg
Purpose: Specifies the location of a display file sent to the
user if the session is terminated because it was idle
for more than the number of minutes set by the
"idleminutes" option (described earlier). If omitted,
no display file is sent.
Note: This display file may be irrelevant, since it is sent
as raw ascii, without any TCP/IP packaging. I.e., the
user may never see it!
4.4.4 Low Speed Message
Syntax: lospeedmsg=<filespec>
Example: lospeedmsg=c:\slip\lospeed.msg
Purpose: Specifies the location of a display file sent to the
user if the his baud rate is less than that required by
the "mindcespeed" option (described earlier). If
omitted, no display file is sent.
4.4.5 Operating Hours Message
Syntax: ophoursmsg=<filespec>
Example: ophoursmsg=c:\slip\ophours.msg
Purpose: Specifies the location of a display file sent to the
user if the he attempts to use the gateway at other
than the hours specified by the "ophours" option
(described earlier). If omitted, no display file is
sent.
4.5 Log Files
KA9QDOOR automatically updates the PCBoard CALLER file, entering
the termination status of the connection. However for
convenience, you may request an additional separate log unique
to KA9QDOOR:
Syntax: ka9qdoorlog=<filespec>
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 11
Example: ka9qdoorlog=c:\slip\slip.log
Each entry in the log is a fixed-length 64 byte ascii record,
such as:
05-31-94 11:30 (32) Dan Lewis [User hung up]
The number in parentheses is the number of minutes the caller
spent in the door.
You may create another PCBoard DOOR batch file to do nothing but
simply view this log by adding the "/LOG" command line option as
shown below.
C:\KA9QDOOR\KA9QDOOR /LOG <filespec>
BOARD
where "<filespec>" specifies the location of KA9QDOOR's
configuration file.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 12
CHAPTER 5 - CUSTOMIZING THE DISPLAY FILES
The distribution package includes five sample display files:
TOOIDLE.MSG Displayed on hangup after long inactivity
OPHOURS.MSG Displayed during off hours
STARTUP.MSG Displayed on start of gateway session
LOSPEED.MSG Displayed if baud rate is too low
TIMEOUT.MSG Displayed on hangup when time runs out
These files have been customized by the use of certain
predefined "macros". Some of these macros are a subset of those
supported by PCBoard, while others are unique to KA9QDOOR.
5.1 PCBoard Display Macros
The following PCBoard display macros, plus all of PCBoard's
"@X##" color control macros, may be used within KA9QDOOR display
files. For a description of what they represent, refer to the
PCBoard documentation.
@BEEP@ @CLREOL@ @CLS@
@FIRST@ @MINLEFT@ @SECURITY@
@SYSDATE@ @SYSTIME@ @USER@
@POS:#@
5.2 Macros Unique to KA9QDOOR
The following additional display file macros are also supported
by KA9QDOOR.
@DCESPEED@ Current DCE (carrier) speed
@DTESPEED@ Current DTE (PC-Modem) speed
@EXPIRETIME@ Expire time in HH:MM format
@IDLEMINS@ Maximum inactivity time
@MINDCESPEED@ Minimum DCE (carrier) speed
@OPHOURS@ Hours of operation
@OVERRIDE@ Override security for mindcespeed
5.3 Justification and Spacing
Any of the text insertion macros used in KA9QDOOR display files
can appear in one of four forms as discussed in the following
paragraphs. These options allow you to precisely control
spacing, and allow you to draw a box around a message - even
when replacement text within a line has a varying length.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 13
5.3.1 No Justification
Syntax: @<keyword>@
Example: @USER@
Purpose: Inserts the replacment text, using as many columns as
are necessary.
5.3.2 Left Justification
Syntax: @<keyword>:<number>@
or: @<keyword>:<number>L@
Example: @USER:15@
or: @USER:15L@
Purpose: Insert the replacement text, left justifying it within
a field whose width is specified by the number
following the colon. If more columns are required than
provided in the field width, the field is expanded.
macro.
5.3.3 Center Justification
Syntax: @<keyword>:<number>C@
Example: @USER:15C@
Purpose: Insert the replacement text, centering it within a
field whose width is specified by the number following
the colon. If more columns are required than provided
in the field width, the field is expanded.
5.3.4 Right Justification
Syntax: @<keyword>:<number>R@
Example: @USER:15R@
Purpose: Insert the replacement text, right justifying it within
a field whose width is specified by the number
following the colon. If more columns are required than
provided in the field width, the field is expanded.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 14
5.4 The DISPLAY Program
Included among the distribution files is DISPLAY.EXE, a program
that helps design a display file by allowing it to be viewed
offline. The command line syntax is:
DISPLAY [-g] [-7] <filespec>
Where: <filespec> Is the name of the display file.
The filename extension defaults
to ".MSG" if omitted.
[] Denotes an optional argument.
-g Disables (color) graphics and
ANSI control sequences.
Default is enabled and requires
ANSI.SYS to be installed.
-7 Replaces 8-bit graphics characters
with suitable 7-bit alternatives.
DISPLAY uses a predefined set of replacement strings for the
various text insertion macros such as @USER@.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 15
APPENDIX 1 - HOW TO REACH US
BBS/FAX: 415-364-9847
Parameters: 1200-28800 baud (v.34/v.FC)
8 data bits, No Parity
If you have access to electronic mail, you can send us a message
via any of the following:
On COMPUSERVE, send mail to:
>Internet:tech.support@ksp.com
On PRODIGY, send mail to: VGDC59A
On INTERNET, UUCP, or BITNET, send mail to:
tech.support@ksp.com
On FIDONET, address mail to "UUCP" at nearest fidonet site which
provides a gateway to Internet, such as 1:105/42.
1st line of message: To: tech.support@ksp.com
On MCI,
At the "To:" prompt enter: TECH SUPPORT (EMS)
At the "EMS:" prompt enter: Internet
At the "Mbx:" prompt enter: tech.support@ksp.com
On APPLELINK, send mail to:
tech.support@ksp.com@dasnet#
On TELENET's Telemail Service:
Send to: [INTERMAIL/USCISI]TELEMAIL/USA
1st line of message: Forward: ARPA
2nd line of message: To: tech.support@ksp.com
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 16
APPENDIX 2 - RETRIEVING FILES FROM KEY SOFTWARE PRODUCTS
You will need a copy of NET.EXE and it's documentation. Your
callers will need SLIP software on their end as well, such as
Trumpet Winsock (for Microsoft Windows) or the packet driver
SLIPPER or CSLIPPER.
These files are available from the KSP BBS, either by calling in
and downloading, or via e-mail using the "LISTSERV" capabilities
of the BBS; we do NOT have "real" FTP capability in case you
were wondering.
The relevant filenames on the Key Software Products BBS are:
KA9QNOS.ZIP: KA9Q NOS network gateway software and docs.
SLIPPR13.ZIP: TCP/IP packet drivers for serial SLIP & CSLIP
TWSK10A.ZIP: Trumpet Winsock TCP/IP for Windows.
Directions for calling the BBS directly are provided in the
previous appendix.
To use LISTSERV, you must send a message addressed to the
Internet address listserv@ksp.com. The message must contain an
LISTSERV command entered as a single line of text, and it must
be the first line in the message. The LISTSERV commands that are
supported include:
Command: LIST tlbmm-l
Purpose: Returns an e-mail message listing all of the file directories
on the BBS by number and description.
Command: LIST tlbmm-l 2
Purpose: Returns an e-mail message listing all of the files in
directory #2 of the BBS. (The files KA9QNOS.ZIP,
TWSK10A.ZIP, and SLIPPR13.ZIP are in directory #7
of the Key Software Products BBS.)
Command: GET tlbmm-l KA9QNOS.ZIP
Purpose: Returns an e-mail message containing a uuencoded version of
the file KA9QNOS.ZIP. To extract the file, you must save
the message as a file on your system, edit out the e-mail
header at the beginning of the file, and then use a program
called UUDECODE (commonly available on Unix) to convert the
uuencoded version back to the original ZIP format, and then
(finally) use PKUNZIP to extract the contents of the file.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved
Nov 25, 1994 KA9QDOOR (tm) 17
APPENDIX 3 - LIMITED WARRANTY
This software is provided 'as is' without warranty of any kind,
either expressed or implied, including, but not limited to the
implied warranties of merchantability and fitness for a
particular purpose. The entire risk as to the quality and
performance of the program is with you.
Some states do not allow the exclusion of implied warranties, so
the above exclusions may not apply to you. This warranty gives
you specific legal rights and you may also have other rights
which vary from state to state.
Key Software Products has taken due care in preparing the
documentation and software included in KA9QDOOR to ascertain
their correctness and effectiveness. However, Key Software
Products does not warrant that operation of this software will
be uninterrupted or error free. In no event shall Key Software
Products be liable for incidental or consequential damages in
connection with or arising out of the furnishing, performance,
or use of this software.
LICENSE
You MAY use this software on any computer or computers in your
possession, but on no more than one computer at any given time.
You MAY copy this software into any machine readable or printed
form for backup or modification purposes in support of your use
of the software.
You MAY distribute the original unmodified, unlicensed version
of this software, but you may not charge a fee exceeding $5.00
to cover the cost of duplicating, shipping, and handling. You
may NOT distribute a licensed version of this software.
You may NOT use, copy, modify, sublicense, assign or transfer
this software and its license, or any copy or modification, in
whole or in part, except as expressly provided for in this
license.
Copyright (C) 1990-94, Key Software Products. All Rights Reserved