Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / XCBV145.ZIP / XCBV.DOC < prev next >

Wrap

Text File | 1993-03-07 | 27.2 KB | 591 lines

╔══════════════════════════════════╗ ║ The Express Call-Back Verifier ║ ║ Version 1.45 ║ ║ For Renegade Bulletin Boards ║ ║ Copyright 1993 Phil Baggett ║ ║ All Rights Reserved ║ ╚══════════════════════════════════╝ FILE LIST --------- The Express Call-Back Verifier (XCBV) package consists of the following files: XCBV.EXE - Main program file XCBV.DOC - Main documentation HISTORY.DOC - Program revision history UPGRADE.DOC - Upgrade information XCBV.CFG - Configuration file XCBV.BAT - Sample batch file XCBV.DAT - Call-back database REGISTER.FRM - Registration form AUTOUPLD.* BADNUM.* INSTRUCT.* INUSE.* INTRO.* <-- Sample display files NOLONGD.* NOTIME.* PHONEDUP.* SUCCESS.* LICENSE ------- You may use this program for a trial period of 14 days; thereafter you must register with the author or discontinue use. There is no registration fee, so in essence this program is FREE. See "REGISTRATION" near the end of this file. You may freely distribute this package so long as all files are unmodified and are included in each transfer. You may NOT distribute, by any means whatsoever, the "key" file you receive when you register (which is not part of this evaluation package). COMPATIBILITY ------------- This version of the XCBV is compatible with Renegade release 02-28-93. Compatibility with other versions is not guaranteed, since Renegade's file structures are likely to change. (If you chance it with another version, back up your USERS.DAT first, located in the DATA directory.) I plan to modify this program as needed to be compatible with future versions of Renegade if there's enough demand for it (i.e. registrations). INTRODUCTION ------------ The Express Call-Back Verifier serves these main purposes: (1) Automatically upgrades users' access levels to predetermined values after successful verification. (2) Keeps a record of users' tested-and-verified phone numbers. (3) Allows SysOps to prevent users from calling under multiple user accounts. This CBV is quite different from others you may have used. Foremost is the simplicity involved in set-up and maintenance. You don't have to list all your local phone number prefixes. Neither do you have to rely on other add-on utilities to keep your call-back records up to date. ■ SysOps, whether running the door locally or from a remote location, can search through and edit the call-back database, which will contain each verified user's real name, phone number, and date of verification. ■ A special option is included for globally scanning and updating the call-back database, so SysOps can plug some or all users' current phone numbers into the database. ■ Customized text or ANSI files will be displayed at appropriate times when the door is being run, so you can give the program a personal touch. ■ Keeps a detailed log of all errors, call-back failures, and other noteworthy events (unless error logging is turned off). INSTALLATION ------------ To install the program, first make a new subdirectory and copy all the files there, and then follow the instructions below. -- Configuration -- Use a text editor to modify the configuration file, XCBV.CFG, as shown below. Each line must begin at the leftmost column of the file, and be sure not to add or remove any lines. (Text beginning with a less-than sign (<) is ignored. The .CFG file itself includes brief descriptions for each line.) Line 1: Name of your BBS (displayed after calling the user back). Line 2: Whether to test for BBS data file compatibility (Y or N). Use this option to turn off compatibility checking if the program reports a compatibility error and you KNOW that this version of the verifier is designed to work with your version of Renegade. (I recommend backing up your USERS.DAT file first.) Line 3: BBS main directory (for example, C:\BBS\). Line 4: Name of your BBS dropfile, NOT including path; must be either CALLINFO.BBS, PCBOARD.SYS, or DORINFOx.DEF. (DOOR.SYS, as generated by Renegade, will not work with this program, due to the fact that my door-building toolkit does not support the new (longer) DOOR.SYS standard that Renegade produces <sigh>.) CALLINFO.BBS has been tested with Renegade and is recommended. Line 5: Minimum time required to run call-back, in minutes. When a user runs the verifier and doesn't have this much time remaining, a special file (described later) is displayed and the program exits back to the BBS. Line 6: Path to log file. If no path is given -- only a filename -- the current directory is used. If this line is blank (just spaces), logging is turned off. Line 7: High Security Access level (valid range is 0 to 255). When a user with at least this SL (the SysOp) runs the door, the program will allow the user to run in Edit Mode, or to perform a simulated call-back. The next four lines specify the access you want to give successfully verified users. Refer elsewhere for more information on what these specifications mean. Line 8: New Security Level (SL). Valid range is 0 to 255. Line 9: New Download Security Level (DSL). Valid range is 0 to 255. Line 10: New AC flags (access condition flags). (A user's AC flags specify restrictions and/or special access, and are usually represented inside Renegade in the form "----------/----".) The following table lists the AC flags along with a designating character label: RESTRICTIONS L - Restricted to one call per day C - Can't page the SysOp V - Posts marked unvalidated U - Can't list users A - Can't change the AutoMessage * - Can't post anonomously P - Can't post at all E - Can't send any E-mail K - Can't vote M - Force E-mail deletion SPECIAL ACCESS 1 - No UL/DL ratio 2 - No post/call ratio 3 - No file points checking 4 - Protection from deletion Characters in the configuration line that are not listed above are ignored. If any above character is present, the corresponding setting is turned on; otherwise it's turned off. Examples: --------K-/-2-- 2K Both of these sample lines have the same effect (although the first may look more familiar): the "Can't vote" and "No post/call ratio" AC flags will be turned on, and all others will be turned off. Line 11: New AR flags. (There are 26 AR flags, labeled A-Z. The meaning of each is defined by the SysOp.) On this line, list the AR flags you want turned on; unlisted flags are turned off. Example: CDG <-- Flags C, D, and G turned on; others off. The next two lines should be configured for your modem. Line 12: Modem initialization string to use prior to call-back (should not exceed 40 characters). The default provided in the .CFG file should work for most low-speed (2400 baud or slower) Hayes-compatible modems. Generally, this should be similar to your Renegade initialization string. The modem must be initialized as follows: * Command Echo off * Send result codes * Respond with digit result codes (not words) * Auto-answer disabled Line 13: Dial prefix for your modem (should not exceed 40 characters). The default should work for most Hayes-compatible modems. Line 14: Whether to hang up after ALL call-backs (Y or N). This is not usually necessary, since long-distance callers are always disconnected. If you specify Yes, all callers -- even local -- are disconnected; otherwise, local callers are returned to the BBS. (Be sure to edit your display files, described below, to reflect your set-up.) Line 15: Whether to allow long-distance (LD) call-backs (Y or N). (This option has no effect if the following "auto-upgrade" option is enabled.) Line 16: Whether to auto-upgrade LD callers (Y or N). If you enable this option (specify Yes), any user who answers Yes when asked if he is LD is immediately upgraded and returned to the BBS, and his phone number is recorded in the database as if he'd actually been verified by call-back. (Program still checks for an illegal or duplicate phone number first.) This is included for SysOps who don't want to allow LD call-backs, yet still allow quick verification in order to treat LD callers fairly. This implies a certain amount of trust for new users (you'll be trading security for user convenience). Line 17: Prefix to dial before a LD user's phone number, normally "1-" (should not exceed 10 characters). Naturally, this is never used if LD call-backs are not allowed. Line 18: Number of call-back attempts to make before giving up. After line 18 is the "special area codes" section of the configuration. Here, list any special 3-digit area codes that require certain dialing prefixes (up to 10). Beside each code, separated by a space, you can specify exactly what to dial before the phone number when calling users within that area. If you don't give a prefix, then only the user's actual number is dialed (###-####). (A line with three dashes marks the end of this list -- don't remove that line.) Examples: 404 <- For area code 404, just dial "###-####" (no prefix) 234 8- <- For 234, dial "8-###-####" 567 9,567 <- For 567, dial "9,567-###-####" Next is the "illegal dialing sequences" section. Here you can list any sequences of digits that the program should not be allowed to dial as the first part of a number. Each line may contain a number sequence up to 14 digits; up to 100 sequences may be listed. This feature provides a safeguard against users trying to cause the SysOp grief by making the verifier call the 911 emergency service, 976 or 1-900 toll numbers, etc. (This list should also end with three dashes.) NOTE: This feature was not intended to be used to "lock out" problem users. The easiest way to do that is explained later under "EDIT MODE". -- Display Files -- Edit the special display files as desired (or create your own) to conform to your set-up. When the program needs to display one of these, it first looks for the filename with the .ANS extension, and if found, shows it as an ANSI display (if the user has ANSI). Otherwise, it looks for the .ASC extension and shows it. (This method is similar to how Renegade itself works.) Note that Renegade color codes are not supported, so use .ANS files if you want color. The display files (not including extensions) are: INTRO - Displayed first, just after the program title and copyright information. INUSE - Displayed if someone's using the program on another node. NOTIME - Displayed when user has less than the configured minimum time remaining. NOLONGD - Displayed to long-distance callers if long-distance call-backs are not allowed, AND "auto-upgrade LD callers" is disabled. AUTOUPLD - Displayed to long-distance callers if "auto-upgrade LD callers" enabled (see "Configuration" above), just before returning to BBS. BADNUM - Displayed when user supplies a number that would cause an illegal dialing sequence (described above), just before giving him another try. PHONEDUP - Displayed when user's phone number is already recorded in the call-back database under someone else's name. INSTRUCT - Displayed just before asking the user if he/she is ready to disconnect for call-back. SUCCESS - Displayed after successful verification. -- The Batch File -- Make a batch file called XCBV.BAT (or modify the sample provided) that changes to the correct directory and executes the main program with the %1 parameter. Example: c: cd \bbs\doors\xcbv xcbv %1 -- Renegade Set-up -- Inside Renegade, add a menu command that generates the appropriate dropfile type and runs the above batch file with the @E parameter. For example: Menu filename: MAIN Command #1 of 26 1. Long descript :(=)Call-Back Verifier - For new users 2. Short descript:(=)Call-Back Ver. 3. Menu keys := 4. ACS required :"s255|(s30!s31)" 5. Cmdkeys :DW 6. Options :d:\bbs\doors\xcbv.bat @E Flags :None Q. Quit The above menu command would run the verifier when the user pressed the equals sign (=). Only users with a SL of either 255 (the SysOp) or 30 (new user perhaps) could access the command. This example would create a CALLINFO.BBS dropfile, and run XCBV.BAT (located in the D:\BBS\DOORS\ directory), with the @E MCI code, which is the BBS node number. Include the @E even if your board has only one node. Instead of having the option on a displayed menu, as would be the case above, you might want to have Renegade automatically run the verifier if the user has a certain "new user" SL. Refer elsewhere for more information about Renegade's menu commands. PRELIMINARY NOTES ----------------- NOTICE: If you use this program, be sure to register with the author. Remember, currently this is a FREE program. See "REGISTRATION" near the end of this file. Before you use this program, BACKUP YOUR USER FILE (USERS.DAT)! This file should be located in your DATA directory. Although the program's been tested extensively, there are no guarantees. Be warned. The program will function locally (without a real carrier), but it will not attempt the actual call-back process, and nothing is ever written to the log file. When run locally, the program runs through a simulated call-back, to allow you to see what users will see. Remote users with the High Security Access SL can also do this. In a simulated call-back, the phone number is not added to the database, and the user's access is unchanged. I don't recommend that you disable error logging, at least until you have the program running smoothly. If a user reports that he received a "Fatal Error" message, you'll need to check the log file. You'll also need to periodically check the log to make sure folks are not having problems getting verified. The most recent messages are listed at the bottom of the file. You can edit or delete the log file at any time if desired. As with all your important BBS files, you should backup the call-back database file (XCBV.DAT) regularly in case it somehow gets corrupted. Also, never try to empty the database by deleting the file. Instead, use the "Zap database" option within Edit Mode. (If you accidentally delete it, re-install it from the original archive.) If you have any problems getting the program to work properly, see "TROUBLESHOOTING" later in this document. USING THE PROGRAM ----------------- Use of the program is fairly straightforward. When a user runs the program, it asks him whether he is long-distance. If he says yes, and the SysOp allows LD call-backs, the LD prefix is dialed before the number; if he says no and he's lying, the call shouldn't go through since the LD prefix is not used. If user says he is LD and LD call-back is not allowed, a special file is displayed and the program exits back to the BBS. The program allows the user to correct his phone number (obtained from his BBS record) if necessary. If the user tries to make the verifier dial an illegal sequence (see "INSTALLATION" above), the attempt is recorded in the log file (if used), and the number is refused. If the user is already on record (same name and phone number), and his SL is less than the configured verified SL, the program immediately upgrades the user and exits back to the BBS. Because of this, you shouldn't allow those whom you purposely downgraded to run the verifier. After calling the user back, the program asks for the user's BBS password. If incorrect after 3 tries, the user is disconnected; if correct, the user's REAL name and phone number are stored in the database, and the user is upgraded as specified in the configuration file (see "INSTALLATION"). Local callers are returned to the BBS (unless you set up the program to always hang up); long-distance callers are disconnected after call-back to save on your phone bill. If verification fails, either because it can't reconnect or the user failed the password check, the user's access is unchanged, and the reason for failure is written to the log file (if used). In cases where the program disconnects the user, upon returning to the board Renegade will detect a lost carrier, so there will be a "Hung up" entry in Renegade's SysOp log, which is normal. When a user can't complete call-back verification (because there's a duplicate phone number on record, he's calling LD and LD call-backs are disabled, etc.), you'll need to manually upgrade the user if you want to give him access. EDIT MODE --------- A user with High Security Access (see "INSTALLATION") can run the CBV in "Edit Mode". This mode allows viewing/editing of the call-back database. You can search for a certain record by partial user real name or phone number, and make any desired changes. Most commands on the menus are self-explanatory. Note that you can usually abort an operation by just hitting ENTER at the prompt. When running searches on the database, just hitting ENTER when prompted for a "partial" name or number causes every record to match. Otherwise, if you enter a search string the program will find records that contain that string of characters anywhere in the field. If you want to "lock out" a certain phone number, simply add a call-back record to the database. For the user name, you might want to enter something like "LOCKED"; then for the phone number, enter the number you want "locked out". (This method allows you to search for "LOCKED" in the user name field to view/edit all your lock-outs.) ADDING NUMBERS FROM YOUR BBS USER FILE -------------------------------------- One Edit Mode option that deserves explanation, the "Scan & update records" option, was included so that you could have a fairly accurate and complete record of all your current users' phone numbers when you first install the verifier, without forcing all current users to run it. USE THIS WITH CAUTION, because indiscriminate use will cause undesired additions to the database. If the program has already verified a substantial number of people, you might want to backup the database just before using this option. With this option, you can scan for certain user names, certain security levels, or all users. It searches through your BBS user file, looking for numbers not already in the call-back database, and adds them (you can confirm each addition if desired). Keep in mind that the numbers in Renegade's user file are users' voice numbers, so in a few cases the number added to the call-back database may not be the user's data line. The "scan" option also reports (on screen and to the log file, if used) any duplicate phone numbers it finds (when the users' real names don't match), which is helpful for tracking down users who have already logged on as different people (if the user gave the same phone number for each user account). Remember that these may in fact be separate individuals who reside in the same household, so you'll have to decide what to do about their access (voice verification perhaps). In the case of duplicates, the one already in the database will remain there, and the duplicate in the user file is not added. Remember, the "Scan & update records" option should normally only be needed ONCE -- when you first install the verifier -- if you use it at all. After that, the program will keep a lookout for duplicate numbers as each user tries to get verified. TROUBLESHOOTING --------------- This section was included to help solve common problems that occur while using (or trying to use) this program. If you're still having problems after looking over this section, please don't hesitate to contact the author or another SysOp that uses this program. First of all, an improper configuration can be the cause of many errors, so check this first. Make SURE the XCBV.CFG file has the required set-up information on the correct line numbers. Do this by comparing each line of your .CFG with those in the sample .CFG included in THIS release, and re-read the line-by-line set-up instructions under "INSTALLATION" in this document. As an alternative, simply copy the original .CFG file and modify it for your set-up again. It's likely that .CFG files used with older versions WILL NOT WORK with this version. Here are some common problems and their causes: ■■■ Program reports "Error accessing BBS dropfile..." The indicated dropfile doesn't exist. This error has several causes: 1. You're running the program from outside Renegade (the DOS command line), and a dropfile doesn't exist in the proper place. Try running it from a menu while logged onto your board. 2. The dropfile type you specified in the .CFG is not the same as the one Renegade created. If you use CALLINFO.BBS, then your Cmdkeys field in your menu command should be DW. 3. Your "Path for door files" setting, inside Renegade's "Modem/Node Configuration" under "System Configuration", is blank or otherwise incorrect. Make sure this is set to the path where you want dropfiles created when your doors are run. Do this for each node if you're running a multi-node system. ■■■ Program reports "Error opening XCBV.CFG" The program can't find the .CFG file. Make sure the Options field of your Renegade menu command specifies the full path to the BATCH file (that changes to your XCBV directory and runs XCBV.EXE) and NOT the .EXE itself. CONTACTING THE AUTHOR --------------------- Thanks for trying this program, and if you have any comments, questions, or problems, please let me know. The quickest way to reach me is to call my BBS: UNITRON (404) 445-8200 (300-14,400 * N-8-1) Located in Dallas, GA If you prefer, or if you can't seem to reach me any other way, please write to this address: Phil Baggett 3285 Buchanan Hwy. Dallas, GA 30132 REGISTRATION ------------ As previously mentioned, there is NO REGISTRATION FEE. When you register this program, you'll receive a "key" file that you copy to your XCBV directory to remove the "unregistered" message from the program. This "key" will register future versions as well, unless I change the registration requirements. There are two ways to register: To register via conventional mail, edit the included REGISTER.FRM file and mail it, along with $2 for return postage (cash, check, or money order payable to Phil Baggett), to the author's address (given above). In addition to the key file, the disk you receive will also include the latest version of the program. If you prefer, call and register as a user on my BBS, and upload your completed REGISTER.FRM file (renamed to something else, perhaps with your name in it, to avoid filename conflicts). A few days later, you can call again and download your key file from a special file base. Remember: You may NOT distribute the key file you receive in any manner whatsoever. DISCLAIMER ---------- The Author, Phil Baggett, hereby disclaims all warranties, express or implied, concerning this software. The Author shall not be liable for any damage caused by this software, whether or not he is aware that such damage may occur. Furthermore, the Author is not responsible for errors in any part of the software documentation. By using this software, the user agrees to these terms. In addition, I don't guarantee that this program won't scramble or otherwise destroy or deface your user file, or any other file, in some vicious and unpredictable way. <<END>>