RWhois Server Operations Guide Release 1.5.0 1-Feb-98 ------------------------------------------------------------------------ Introduction This document provides an overview of the basic descriptions and operations necessary to run an RWhois server installation. The RWhois server package consists of the server process itself (rwhoisd), tools to enable and manage the native database (rwhois_indexer, repack), and a number of configuration files (rwhoisd.conf and rwhoisd.dir, for example). The Programs The following offers a brief description of the programs and utilities found in the RWhois server release. rwhoisd rwhoisd is the RWhois protocol server. Summary: rwhoisd [-c config file] [-r] [-s] [-Vvq] [-di] -c Config File: Specifies the main configuration file to use (defaults to 'rwhoisd' in the current working directory). -r Root: Specifies that the server will run as a root server and not generate any 'punt' referrals. -s Security: Turns chrooting ON. -V Very Verbose: Logging verbosity is set to 7 (debug). -v Verbose: Logging verbosity is set to 6 (info). -q Quiet: Logging verbosity is set to 2 (alert). -d Daemon mode: Server will put itself into the background and run in a stand-alone mode. -i Inetd mode: Server will run itself as a single shot and accept input and output from stdin and stdout. Except for the '-c' option, all of the command line options are also accessible in the main configuration file itself. The command line options override the configuration file settings. rwhois_indexer Summary: rwhois_indexer [-c config file] [-C class] [-A auth area] [-ivqn] [-s suffix|file list ?] -c Config File: Specifies the main configuration file to use (defaults to 'rwhoisd' in the current working directory). -C Class: Specifies which class of objects to index. Defaults to all classes -A Auth Area: Specifies which authority area to index. Defaults to all authority areas -I Initialize: Remove the old (registered) index files first. -v Verbose: Logging verbosity is set to 6 (info). -q Quiet: Logging verbosity is set to 2 (alert). -n No Syntax Checks: The indexer will not check for schema compliance during indexing. -s Suffix mode: Configuration Files At start up, the RWhois server reads various configuration files. They are categorized into the general (server) configuration files and authority area (database) configuration files. General Configuration Files General configuration files consist of the main configuration file, directive configuration file, extended directive configuration file, directive security files, and the RWhois parent file. In these configuration files, extra white space is ignored and lines beginning with the '#' character are treated as comments. 1. Main Configuration File (rwhois.conf) The main configuration file is a "-log-file If logging to file, each log level can be directed to a different file using this file. Verbosity The level at which logging occurs; higher numbers mean more logging. The levels correspond numerically to the syslog levels (0 is emergency, 7 is debug). pgp-uid The user id string of the server itself, this is the key into a pgp keyring. pgp-pwfile The path to a file containing the password to the rwhois server's private key. pgp-bin-path The path to the pgp binary itself, this should be an absolute path for security reasons. pgp-keyring-path The is the path to the server's pgp keyring directory. query-allow-wildcard A flag indicating whether the '*' wildcard will be allowed at all; defaults to TRUE. query-allow-substr A flag indicating whether the leading wildcard construct will be allowed, thus allowing substring searches to occur; defaults to FALSE max-children An integer repesenting the maximum number of children (sessions) allowed at one time. Attempts to connect after the limit has be reached will exit with an rwhois error. A value of zero (the default) indicates no maximum. cidr-search-directionA value (either UP or DOWN) indicating which direction CIDR searches will traverse. DOWN, the default, means that a search on a network will return that network and/or any sub-networks. skip-referral-search Do not search for down (more specific) referrals. The default is OFF. It is not recommended that this be turned on. Example: root-dir: /home/databases/rwhois/sample.data bin-path: bin auth-area-file: rwhoisd.auth_area directive-file: rwhoisd.dir x-directive-file: rwhoisd.x.dir max-hits-default: 20 max-hits-ceiling: 2000 register-spool: register_spool punt-file: rwhoisd.root local-host: host.domain.com local-port: 4321 security-allow: rwhoisd.allow security-deny: rwhoisd.deny deadman-time: 200 server-type: daemon userid: guest chrooted: yes server-contact: contact@host.domain.com use-syslog: no default-log-file: rwhoisd.log 2. Directive Configuration File (rwhois.dir) The directive configuration file contains entries to enable or disable the RWhois directives. Example: Soa yes Register no 3. Extended Directive Configuration File (rwhois.x.dir) The extended directive configuration file is a "