SafeFire PPP

v.0.9 beta

Plugin Reference

PL_PPP plugin library

This plugin library allows user to establish communications using Point To Point protocol, attach to OS/2 TCPIP stack (by creating PPP devices) and use some PPP NCPs over established connection.

PPPPort plugin

This pugin allows user to create PPP connection over Asyncronious device (like Modem, COM port (using null-modem cable) or ISDN adapter (using COM emulation software)).

It has next two stream packs (both are operating in Single Connection Mode - only binding to 0 connection index is allowed):

  1. IO
    Packets recevied from this stream pack will be transfered over PPP connection; Packets received from PPP connection will be put to this stream pack.

    Stream will be set UP after establishing of connection and put DOWN on connection termination.

  2. DOD
    Packets recevied from this stream pack will trigger Dial On Demand functions.

    Stream pack will be used only if DOD is enabled

    Stream will be set UP on startup or after connection termination and put DOWN after establishing of PPP connection.

It processes next configuration variables:
Name Type Default Value Description
General settings
restart decimal -1 How many times to retry connection. -1 mean indefinite
priority.class decimal 3 Communication threads priority class
priority.delta decimal 0 Communication threads priority delta
port.* Communication port and dialing settings
port.name string com1 Communication Port name. Either local (i.e. "com1") or remote (i.e. "\\server\comshare")
port.speed decimal 38400 Baud Rate port will be locked to
port.rtscts boolean no If to setup port for hardware flow control
port.dcd boolean no If to use DCD as Carrier Detect signal
port.dtr boolean no If to use DTR to hang up connection
port.share boolean yes If to share port with other programs.
port.script string Connection script parameter
port.script.mode list DIAL Type of connection script used. Possible values: DIAL, SLATTACH, REXX. See Readme to get details
port.script.timeout time(seconds) 45 Connection script timeout
port.phones string Phones list (DIAL mode only)
port.modem.init string ATZ Modem init string (DIAL mode only)
port.modem.dial string ATD Modem dial prefix (DIAL mode only)
port.modem.redial.min time(seconds) 5 Minimal delay between calls
port.modem.redial.max time(seconds) 20 Maximum delay between calls
port.modem.connect string CONNECT Modem "CONNECT" repsponse (DIAL mode only)
port.modem.busy string BUSY Modem "BUSY" response (DIAL mode only)
port.modem.nocarrier string NO CARRIER Modem "NO CARRIER" response (DIAL mode only)
port.modem.nodialtone string NO DIALTONE Modem "NO DIALTONE" response (DIAL mode only)
port.modem.ring string RING Modem dialing indicator (DIAL mode only)
timeout.* Connection timeout settings
timeout.idle.time time(seconds) -1 How long to wait after the last packet before closing connection. -1 means timer disabled
timeout.idle.exit boolean no If to exit SafeFire PPP after closing idled connection
timeout.idle.notify.start time(seconds) 0 When to start idle timeout notification (time before closing connection)
timeout.idle.notify.period time(seconds) 0 How often to repeat notifies.
timeout.connection.time time(seconds) -1 Maximum connection period
timeout.connection.exit boolean no If to exit after closing "long" connection
timeout.connection.notify.start time(seconds) 0 When to start connection timeout notifications (time before closing connections)
timeout.connection.notify.period time(seconds) 0 How often to repeat notifications
ip.* Internet Protocol settings
ip.address IP 0.0.0.0 Use as my IP. Do not argee for other. Request from peer if 0
ip.peeraddress IP 0.0.0.0 Send as peer's IP. Use peer-provided if 0.
Note: If multiuser authentication is enabled, PPP will not use this variable.
ip.dns.primary IP 0.0.0.0 Send to peer as Primary DNS value (if not 0)
ip.dns.secondary IP 0.0.0.0 Send to peer as Secondary DNS (if not 0)
ip.restart time(seconds) 3 How often to repeat IPCP requests
ip.max.configure decimal 10 How many IPCP requests to send before closing connection
auth.* Authentication settings
auth.authreq bool no If to require client to authenticate (enable for server mode)
auth.server.*
auth.client.*
All this options can be specified in two ways:
  • General option - will be used for all authentication protocol. One must use variable names for this table
  • Protocol-specific option - will be used for specified authentication protocol only. One must add protocol name and a point after "auth.server." or "auth.client." part.
Using this feature you can specify different options for different protocol. I.E. to have one authentication database for PAP and other for CHAP.
Example: "auth.server.clientname" will be passed to all protocols while "auth.server.pap.clientname" only to PAP.
Current authentication protocol list includes PAP, CHAP, MSCHAP.
Note: CHAP and MSCHAP must be treated as fully independant protocols. I.E. you can have MSCHAP enabled while CHAP is disabled.
auth.server.enabled boolean yes If the protocol is enabled
auth.server.servername string This server's name. (Used only by both CHAPs)
auth.server.clientname string User's name. This option won't be used if authbase is specified
auth.server.clientpass string User's password. This option won't be used if authbase is specified
auth.server.authbase string Authorization database module and it's parameters
auth.client.enabled boolean yes If the protocol is enabled
auth.client.servername string Check server name before passing passwords. (Used only by both CHAPs)
auth.client.clientname string Your user name
auth.client.clientpass string Your password
callback.* Callback settings
callback.mode list NONE Mode of callback opterations. Possible values are: "NONE" (disabled), "CLIENT" (client mode), "SERVER" (server mode).
Note: You must use server authentication with authorization database to use callback server mode.
callback.client.operation decimal 6 Callback operation as speicified in RFC. 6 means CBCP callback mode. (For modification by advanced users only)
callback.client.location string Callback location for non-CBCP callback modes. (For modification by advanced users only)
callback.client.phone string User's phone number. Used in CBCP mode only. Set if either server don't know your phone number or has the list of your numbers.
callback.client.delay time(seconds) 10 Delay before redialing proposed for server
callback.chat.script
callback.chat.script.mode
callback.chat.script.timeout
callback.chat.modem.*
This setting has the same meanings as in port.* variables. They must be set to perform callback call (or wait for callback from server in client mode). Proposed client setting are:
callback.chat.script.mode=SLATTACH
callback.chat.script.timeout=120
callback.chat.script=ATZ OK \c RING ATA CONNECT
callback.chat.modem.redial.min=0
callback.chat.modem.redial.max=0
Return to documentation index SafeFire PPP (C) Link Guard Solutions 1999