iksd.txt
上传用户:dufan58
上传日期:2007-01-05
资源大小:3407k
文件大小:59k
源码类别:

通讯/手机编程

开发平台:

Windows_Unix

  1.   IKSD - The Internet Kermit Service Daemon
  2.       UNIX SYSTEM ADMINISTRATOR'S GUIDE
  3.       The Kermit Project
  4.      Columbia University
  5.        http://www.columbia.edu/kermit/
  6.       D R A F T  #  1 5
  7.   Sun Nov 14 17:55:09 1999
  8. The Internet Kermit Service Deamon (IKSD) is C-Kermit 7.0 or later, started
  9. in a special way.  At this writing, only the UNIX version of C-Kermit
  10. contains IKSD functions, but these can be (easily?) added to the VMS, VOS,
  11. AOS/VS, and other versions too.  
  12. This is a draft.  Everything here is subject to change.
  13. CONTENTS
  14.   1.   Why IKSD?
  15.   2.   System Configuration
  16.   3.   Compile-Time Configuration Options
  17.   4.   Runtime Configuration Options
  18.   4.1.   Command-Line Options
  19.   4.2.   System Logging
  20.   4.3.   The IKSD Log File
  21.   4.4.   IKSD Configuration File
  22.   4.5.   Initialization File
  23.   5.   Access to Services
  24.   5.1.   Automatic Settings
  25.   5.2.   Authentication
  26.   5.3.   The DISABLE Command
  27.   5.4.   Shell Access
  28.   5.5.   Anonymous Users
  29.   5.6.   Management Information
  30.   6.   Open Issues
  31.   6.1.   Connection Establishment
  32.   6.2.   Shell Access
  33.   6.3.   External and/or non-Kermit Protocols
  34.   6.4.   Additional Administrative Controls
  35.   6.5.   Known Bugs
  36.   7.   Monitoring
  37.   7.1.   Database Record Format
  38.   7.2    The Display Module
  39.   7.3.   Database Management
  40.   8.   Testing
  41. 1. Why IKSD?
  42. Why run an Internet Kermit Service Daemon when you are already running
  43. an FTP server?
  44.  . Like FTP, Kermit provides a service that can be accessed from many
  45.    different platforms with a consistent set of commands, but unlike FTP,
  46.    these commands include programming constructions such as variables,
  47.    arrays, looping and selection mechanisms, and local and remote procedure
  48.    calls, thus allowing file transfer and management operations of arbitrary
  49.    complexity to be easily automated.
  50.  . Like FTP, Kermit provides both text- and binary-mode data transfer, as
  51.    well as file management capabilities.  But Kermit also offers numerous
  52.    features lacking from FTP, such as character-set translation, flexible
  53.    file selection mechanisms, preservation of timestamps and permissions,
  54.    automatic per-file text/binary mode switching (important in cross-platform
  55.    transfers), cross-platform directory-tree transfer, and a selection of file
  56.    collision options including "make backup copy of existing file and accept
  57.    incoming file", "reject incoming file", "accept incoming file only if newer
  58.    than existing file", etc.
  59.  . Unlike FTP, Kermit supports atomic file movement, in which the source
  60.    file can be deleted (or renamed, or moved) when and only when it has been
  61.    transferred successfully, as part of the transfer operation itself.
  62.  . Unlike most FTP implementations, Kermit supports recovery of interrupted
  63.    transfers from the point of failure.  You can even use it to recover
  64.    interrupted FTP transfers when FTP itself does not offer this option.
  65.  . Unlike standard FTP, Kermit can transfer data through firewalls or
  66.    proxies or NATs on a single well-known port (unless the TCP port for the
  67.    connection has been explicitly filtered).
  68.  . Unlike FTP, Kermit can transfer data across a combination of transports
  69.    (e.g. dial-up to a terminal server and thence to an Internet host).
  70.  . Authentication and data transfer can take place over secure connections
  71.    (mutually authenticated and encrypted) using established Telnet
  72.    authentication and encryption options.
  73.  . Unlike traditional Kermit use over Telnet, anonymous access is possible,
  74.    and the considerable overhead of the intervening Telnet server and
  75.    pseudoterminal service is eliminated.
  76.  . Unlike the FTP daemon (ftpd), the IKSD can be monitored in real time
  77.    by the system administrator (see Section 7).
  78. A prototype IKSD is available for public access at:
  79.   kermit.columbia.edu, port 1649
  80. This service is based in part on a new Telnet Kermit Option described in an
  81. Internet Draft:
  82.   ftp://ftp.ietf.org/internet-drafts/draft-altman-telnet-kermit-server-01.txt
  83. The Internet Kermit Service itself is discussed in a separate Internet Draft:
  84.   ftp://ftp.ietf.org/internet-drafts/draft-columbia-kermit-service-01.txt
  85. 2. System Configuration
  86. WARNING: Do NOT attempt to install a pre-7.0 version of C-Kermit as an IKSD.
  87. Earlier versions do not perform the necessary authentication and security
  88. functions, and therefore will leave your system wide open to anonymous root
  89. access.  (Don't worry, the installation procedure described here, if you
  90. follow it, and the interface to IKSD, prevent you from starting an earlier
  91. version of C-Kermit as an IKSD, since it lacks the needed command-line
  92. options and will halt with a usage message if you try to use them.)
  93. Directory organization, file system, naming conventions, and other
  94. administrative details vary from system to system and site to site, so
  95. specific instructions can not be given here.  In general, however, the steps
  96. are:
  97.  a. The C-Kermit executable should be copied to the directory that is 
  98.     normally used for launching Internet services, and renamed to "iksd".
  99.     Normally the owner and group should be root and the permission 0750.
  100.  b. The following entry should be added to the Internet services file,
  101.     normally /etc/services:
  102.       kermit   1649/tcp
  103.  c. An entry must be made in the inetd configuration file, normally
  104.     /etc/inetd.conf.  See your system-specific documentation for the
  105.     name, location, and format of this file, e.g. "man inetd" and
  106.     "man inetd.conf".  A typical example might be:
  107.       kermit  stream  tcp  nowait  root  iksd -A <other-iksd-options>
  108.     Or, with TCP wrappers:
  109.       kermit  stream  tcp  nowait  root  tcpd iksd -A <other-iksd-options>
  110.     Include full pathnames for tcpd and iksd if required.  See Section 4
  111.     for <iksd-options>.
  112.     NOTE: Different platforms might require different syntax, e.g.:
  113.       kermit stream tcp nowait root /usr/sbin/iksd iksd -A <other-iksd-options>
  114.  d. When using TCP wrappers, make the appropriate entries in its
  115.     configuration file(s), such as /etc/hosts.allow and /etc/hosts.deny.
  116.     See the TCP wrappers documentation for further info.
  117.  e. Make any required hard or soft links to the iksd executable.
  118.  f. If desired, create an IKSD configuration file (/etc/iksd.conf by default).
  119. This setup allows multiple simultaneous IKSD sessions.  A fresh IKSD process
  120. is started for each session, and disappears when IKSD exits, automatically
  121. closing the session and the connection.
  122. To kill a particular instance of IKSD, find its pid with "ps ax | grep iksd",
  123. and then kill -9 <pid> (as root).
  124. To update the IKSD program, simply replace the executable in the "launch"
  125. directory ((a) above).
  126. To discontinue IKSD service quickly, delete the iksd executable, or (to avoid
  127. unwanted console logging) replace it with (say) /bin/false.
  128. 3. Compile-Time Configuration Options
  129. You can use any C-Kermit configuration as an IKSD, ranging from a fully
  130. configured version, to a special IKSD-Only version, to any of the various
  131. "stripped-down" versions, as described in the C-Kermit Configuration Guide
  132. (ckccfg.txt) and/or Installation Instructions (ckuins.txt).
  133. The following compile-time options are specific to or of special relevance
  134. to the IKSD:
  135. TNCODE - Required for IKS.
  136.   Include Telnet protocol code, even if networking code is not included.
  137.   Defined by default if TCPSOCKET defined, otherwise must be defined
  138.   explicitly. 
  139. IKS_OPTION - Required for IKS.
  140.   Include code for the new Internet Kermit Service Option.
  141.   Currently defined automatically if TNCODE is defined.
  142. CK_LOGIN - Required for IKS.
  143.   Include user authentication code.  Defined automatically for UNIX unless
  144.   NOLOGIN defined.
  145. CK_PAM 
  146.   The IKS is to be compiled to use PAM (Pluggable Authentication Modules)
  147.   to authenticate the user for interactive logins instead of Unix password
  148.   files.  The default PAM service type for IKSD is "kermit".
  149. PAM_SERVICE_TYPE 
  150.   If CK_PAM is defined and you wish to use a service type other than
  151.   "kermit" you can define PAM_SERVICE_TYPE to equal the string you
  152.   wish to use.
  153. CK_SHADOW
  154.   If your host utilizes the shadow password system for storing user
  155.   passwords the IKS must be compiled with support for shadow passwords.
  156.   This might also require some additional libraries added the LIBS
  157.   clause, such as -lgen, for loading the getspnam() routine.
  158. CKSYSLOG
  159.   Include code for making syslog entries.  This symbol is defined
  160.   automatically if (a) CK_LOGIN is defined; (b) UNIX is defined; and (c)
  161.   NOSYSLOG is not defined.
  162. CKWTMP
  163.   Include code for making wtmp log entries.  This symbol is defined
  164.   automatically if (a) CK_LOGIN is defined; (b) UNIX is defined; and (c)
  165.   NOWTMP is not defined.
  166. WTMPFILE
  167.   String containing pathname of the default wtmp logfile.  If not specified,
  168.   a default is supplied, currently /var/log/wtmp on Linux and /usr/adm/wtmp
  169.   elsewhere.  The wtmp file can also be specified at runtime; see next
  170.   section.
  171. CK_CURSES
  172.   Need not be defined in an IKSD-only build, since curses is used only
  173.   in local mode, and the IKSD is always in remote mode, plus the fact that
  174.   curses initialization can cause spurious error messages in IKSD since it
  175.   might not have a terminal type (TERM variable) in its environment.
  176. NOLOCAL
  177.   This may be defined to exclude all code relating to the making of
  178.   both serial and network connections from the C-Kermit/IKSD executable.
  179.   This code is presently not needed, and is never used, in the IKSD.
  180.   Compiling it out reduces the size of the executable and eliminates any
  181.   possibility that a loophole could be exploited to use the IKSD as a
  182.   relay.
  183. NOPUSH
  184.   This symbol may be defined to exclude all code that is used to access
  185.   local shell or system functions, such as the RUN (!) command, the server
  186.   end of the REMOTE HOST command, file-transfer pipes and filters, etc.
  187.   Note that such code is disabled at runtime in the IKS anyway; compiling
  188.   it out completely reduces the size of the executable and the risk of
  189.   loopholes.
  190. NOICP
  191.   Disables the interactive command parser as well as long-form command-line
  192.   options (Section 4.1).  In this configuration, the IKS runs only in Kermit
  193.   Server mode, and the size of the executable is reduced dramatically.
  194.   WARNING: NOICP also inhibits extended command-line options (the ones that
  195.   start with "--"), since these share the same parsing routines as the
  196.   interactive parser.
  197. NOSPL
  198.   Disables the script programming language (INPUT, OUTPUT, FOR, WHILE,
  199.   IF, SWITCH, macros, variables, etc) without disabling the interactive
  200.   command parser. 
  201. NOGETUSERSHELL
  202.   Add this if the link steps fails because it can't resolve getusershell()
  203.   and/or endusershell().  Normally, IKSD will refuse a login if the user's
  204.   login shell is not one of those returned by getusershell() (normally,
  205.   getusershell() simply lists the shells listed in /etc/shells, but we
  206.   can't depend on this).  Thus if your site "invalidates" user IDs by
  207.   setting their login shell to something that is not really a shell (like
  208.   /etc/nologin), but does not have a getusershell() function, IKSD will
  209.   still let such users log in unless (a) you put them in the forbidden
  210.   users file (see Section 4.1), or (b) add some code to ckufio.c to check
  211.   for whatever invalid or valid shells might apply at your site.
  212. NOIKSD
  213.   This defines the symbols NOLOGIN, NOSYSLOG, NOWTMP, NOPRINTFSUBST, which
  214.   in turn prevent the definition of symbols (CK_LOGIN, CKSYSLOG, etc) that
  215.   cause IKSD-specific code to be included.
  216. CK_SYSINI
  217. CK_DSYSINI
  218.   System-wide initialization file; see Section 4.4.
  219. IKSD
  220.   Is defined automatically if NOIKSD is not defined.
  221. IKSDCONF
  222.   The name of the IKSD configuration file.  In UNIX this is
  223.   "/etc/iksd.conf" by default; elsewhere "iksd.cfg".
  224. In an IKSD-only build, you should omit the termcap/termlib and (n)curses
  225. libraries, and set up the link step to make sure the IKSD is linked with
  226. the same user authorization libraries used by your local login program.
  227. Here is a sample for SunOS 4.1.3 at a particular site:
  228. sunos41giks:
  229. @echo Making C-Kermit $(CKVER) for SunOS 4.1 with gcc for IKS...
  230. $(MAKE) wermit "CC= gcc" "CC2= gcc" 
  231. "CFLAGS= -O -DSUNOS41 -DNDGPWNAM 
  232. -DTNCODE -DNOLOCAL -DNOPUSH $(KFLAGS)" 
  233. "LIBS= -L/usr/local/lib -lpwent -lcrypt"
  234. -DNOLOCAL: excludes all code that is used to make connections.   
  235. -DNOPUSH:  excludes all code that accesses local system shells and commands.
  236. -DTNCODE:  includes Telnet protocol code even though -DNOLOCAL is included.
  237. At sites that use shadow passwords, you'll need to add -DCK_SHADOW to CFLAGS
  238. and perhaps -lgen to LIBS.
  239. Also note that the crypt() function, which is used for verifying passwords,
  240. is normally found in libc, but on some platforms it has been broken out into
  241. a separate library, such as -lcrypt, and in that case must be included in
  242. the LIBS clause.
  243. For PAM installations, here's an example /etc/pam.d/kermit file that uses
  244. EPS password files for user authentication and the standard unix modules for
  245. account and session management:
  246.   auth      required       /lib/security/pam_eps_auth.so
  247.   password  required       /lib/security/pam_eps_passwd.so
  248.   account   required       /lib/security/pam_unix_acct.so
  249.   session   required       /lib/security/pam_unix_session.so
  250. Kerberos IV, Kerberos V, and/or SRP, or any other authentication / security
  251. mechanism may be also selected at build time if you have the appropriate
  252. libraries and header files installed on your system.  See security.txt
  253. for further details.
  254. For a build that excludes all IKSD functions, it is normally sufficient
  255. to add NOIKSD to the CFLAGS, e.g.:
  256.   make aix41 KFLAGS=-DNOIKSD
  257. 4. Runtime Configuration Options
  258. The IKSD can be configured at runtime with command-line options or by an
  259. initialization file or other auxilliary file(s), in any combination.
  260. 4.1. Command-Line Options
  261. To start C-Kermit as an Internet Kermit Service Daemon, include the '-A'
  262. command-line option.  This option not only configures C-Kermit as an IKSD, but
  263. it also ensures that you are running a version of C-Kermit that can do this,
  264. i.e. C-Kermit 7.0 or later built with all the necessary compile-time options
  265. (Section 3).  If either of these conditions does not apply, the '-A' option
  266. will be invalid and the Kermit program will halt immediately.
  267. In addition to -A and the command-line options described in "Using C-Kermit"
  268. (2nd Edition), plus any other new ones described in the ckermit2.txt file, a
  269. selection of new long-form options apply specifically to the IKSD.  Long-form
  270. options work as follows:
  271.  a. All long-form options must begin with "--" (two hyphens) or "-+".  If the
  272.     option begins with "--" it is executed before or after the C-Kermit
  273.     initializaton file, according to its internal keyword flags.  If it
  274.     begins with "-+", it is executed before the init file, regardless of the
  275.     keyword flags.  There is no way to force an argument to be executed after
  276.     the init file if it has the CM_PRE bit set (see table below).
  277.  b. No spaces are allowed in the keyword.
  278.  c. If an operand contains spaces, it (or the entire option) must be quoted
  279.     according to the rules of the shell from which Kermit is invoked.
  280.  d. Case doesn't matter in the option keyword (unlike with regular
  281.     single-letter options).
  282.  e. If an operand is required, it must be included.  If no operand is
  283.     required, no operand must be included.
  284.  f. The operand follows the keyword, separated by a colon (:) or equal
  285.     sign (=).  There are no spaces between the separator and the keyword
  286.     or operand.
  287.  g. Long-form option names may be abbreviated according to the same rules as
  288.     interactive keywords.
  289.  h. On/Off operands can be On, Off, Yes, No, True, False, 0, 1, or OK (case
  290.     of letters does not matter).
  291.  i. Long-form options are available only when the interactive command parser
  292.     is built-in (i.e. not NOICP).
  293. The new long-form options are:
  294.   Option        Values    Default      CM_PRE   Effect
  295.   --anonymous   on/off    on             yes    anonymous login allowed
  296.   --bannerfile  filename  (none)         no     greeting message
  297.   -+cdfile      filelist  (see below)    no     CD message filename
  298.   -+cdmessage   on/off    on             no     CD messages on/off
  299.   -+cdmsg       on/off    on             no     synonym for cdmessage
  300.   --help        (none)    (n/a/)         no     list available --options
  301.   --helpfile    filename  (none)         no     custom text for HELP command
  302.   --initfile    filename  /.kermrc       yes    Init file for anonymous users
  303.   --nointerrupt (none)    (see below)    yes    Disables SIGINT and SIGTSTP
  304.   --permissions octalnum  0040           yes    anonymous upload permissions
  305.   --perms       octalnum  0040           yes    synonym for permissions
  306.   --root        directory /pub/ftp       yes    root for anonymous users
  307.   --syslog      number    3              yes    level of syslogging    
  308.   --timeout     number    300            yes    time limit for login
  309.   --userfile    filename  /etc/ftpusers  yes    forbidden local users list
  310.   --wtmplog     on/off    on             yes    wtmp logging on/off
  311.   --wtmpfile    filename  (see below)    yes    pathname of wtmp logfile
  312.   --xferlog     on/off    off            yes    use an ftpd-logfile
  313.   --xferfile    filename  (see below)    yes    pathname of ftpd-like logfile
  314. Note: in all options that take a <filename>, EXCEPT --cdfile, relative
  315. filenames or filenames that start with ~ are expanded to full pathnames.
  316. In more detail:
  317. --nointerrupts
  318.   Disables keyboard interrupts that are normally ensabled.  In IKSD, when it
  319.   is in interactive prompting state, commands can normally be interrupted
  320.   with Ctrl-C.  Suspending (normally via Ctrl-Z) is always disabled in IKSD.
  321. --help
  322.   Lists the extended command-line options that are available in your version
  323.   of C-Kermit.  If any options seem to be missing, that is because your
  324.   copy of C-Kermit was built with compile-time options to deselect them.
  325. --helpfile:<filename>
  326.   Specifies the name of a file to be displayed if the user types HELP
  327.   (not followed by a specific command or topic), in place of the built-in
  328.   top-level help text.  The file need not fit on one screen; more-prompting
  329.   is used if the file is more than one screen long if COMMAND MORE-PROMPTING
  330.   is ON, as it is by default.
  331. --anonymous:{on,off}
  332.   Whether anonymous logins are allowed.  By default they are allowed, so
  333.   this option need be included only to disallow them (or for clarity, to
  334.   emphasize that they are allowed).  Anonymous login occurs when the username
  335.   "anonymous" or "ftp" is given, with any password (as with ftpd).
  336. --timeout:<number>
  337.   This sets a limit (in seconds) on the amount of time the client has to log
  338.   in once the connection is made.  If successful login does not occur within
  339.   the given number of seconds, the connection is closed.  The default timeout
  340.   is 300 seconds (5 minutes).  A value of 0 or less indicates there is to be
  341.   no limit.
  342. --bannerfile:<filename>
  343.   The name of a file containing a message to be printed after the user logs
  344.   in, in place of the normal message (Copyright notice, "Type HELP or ? for
  345.   help", "Default transfer mode is...", etc).
  346. --permissions:<octalnum>
  347.   The permissions given to any file that is uploaded by an anonymous user.
  348.   0040 is the default and recommended value.  The default permits only
  349.   group-read access, and therefore prevents anonymous users from uploading
  350.   files (e.g. pirated sofware) to be downloaded by other anonymous users.
  351.   Synonym: --perms.
  352. --initfile:<filename>
  353.   The initialization file to be executed for anonymous logins.  By default
  354.   it is /.kermrc, where "/" is the root of the chroot'd file system.  Any
  355.   <filename> that you specify here must be specified in the notation of the
  356.   the chroot'd file system.  This option is independent of the '-y' option
  357.   (alternative init file), which applies only to real users.
  358. --cdmessage:{on,off,0,1,2}
  359.   For use in the Server-Side Server configuration; whenever the client 
  360.   tells the server to change directory, the server sends the contents of a
  361.   "read me" file to the client's screen.  This feature is On by default,
  362.   and operates only in client/server mode when ON or 1.  If set to 2 or
  363.   higher, it also operates when the CD command is given at the IKSD> prompt.
  364.   Synonym: --cdmsg.
  365. --cdfile:<filename> (or list)
  366.   When cdmessage is on, this is the name of the "read me" file to be sent.
  367.   Normally you would specify a relative (not absolute) name, since the file
  368.   is opened using the literal name you specified, after changing to the new
  369.   directory.  Example:
  370.   
  371.     --cdfile:READ.ME
  372.   You can also give a list of up to 8 filenames by (a) enclosing each
  373.   filename in braces, and (b) enclosing the entire list in braces.  Example:
  374.   --cdfile:{{./.readme}{READ.ME}{aaareadme.txt}{README}{read-this-first}}
  375.   When a list is given, it is searched from left to right and the first
  376.   file found is displayed.  The default list for UNIX is:
  377.     {{./.readme}{README.TXT}{READ.ME}}
  378. --database:{on,off}
  379.   Whether an active-sessions database should be kept.  On by default.
  380.   If "on", but --dbfile is not specified, /var/log/iksd.db is used.
  381.   *** NOTE: During the test phase, the directory is /tmp/ ***
  382. --dbfile:<filename>
  383.   Use this option to specify an iksd database file name.  If you include 
  384.   this option, it implies --database:on.
  385. --syslog:<number> or {on,off}
  386.   Whether and what level of syslog entries should be made.  A level of 0
  387.   (or "off" or "false" or "no") means no syslogging.  A level of "on" (or
  388.   "yes" or "true") invokes the default syslogging level.  To choose a
  389.   non-default level of syslogging, specify a number (see Section 4.2).
  390. --wtmplog:{on,off}
  391.   Whether wtmp log entries should be made.  On by default.  An entry is made
  392.   when the user logs in and when the session is closed.  The "tty name" field
  393.   is given as "iks_xxxx", where xxxx is the process ID (pid) of the IKSD.
  394.   Thus IKSD session history can be monitored via "last | grep iks_".
  395.   Anonymous logins are shown with a user ID of "ftp".
  396. --wtmpfile:<filename>
  397.   The default wtmp log file is /var/log/wtmp in Linux, and /usr/adm/wtmp
  398.   elsewhere.  In case your system's wtmp log file does not match the default,
  399.   use this option to specify the appropriate filename.
  400. --userfile:<filename>
  401.   This file contains a list of local usernames that are to be denied access
  402.   to Internet Kermit Service.  The default is /etc/ftpusers.  This can be the
  403.   same file that is used by wuftpd, and the syntax is the same: one username
  404.   per line; lines starting with "#" are ignored.  Use this option to specify
  405.   the name of a different forbidden-user file, or use --userfile:/dev/null
  406.   to disable this feature in case there is a /etc/ftpusers file but you
  407.   don't want to use it.
  408. --xferlog:{on,off}
  409.   Whether a wu-ftpd-like log should be kept.  Off by default.  If "on", but
  410.   --xferfile is not specified, /var/log/iksd.log is used.  This log is
  411.   explained in Section 4.3.
  412. --xferfile:<filename>
  413.   Use this option to specify an iksd log file name.  If you include this
  414.   option, it implies --xferlog:on.
  415. --database:{on,off}
  416.   Whether an active-sessions database should be kept.  On by default.
  417.   If "on", but --dbfile is not specified, /var/log/iksd.db is used.
  418. --dbfile:<filename>
  419.   Use this option to specify an iksd database file name.  If you include 
  420.   this option, it implies --database:on.
  421. Some of the traditional options have special significance in the IKS, e.g.:
  422. -x (server mode).
  423.   If this option is included on the IKSD command line, the Client Side Server
  424.   configuration is disabled, and the user will not get a Username: or
  425.   Password: prompt, and will not be able to access the IKSD command prompt.
  426.   A FINISH command sent to the IKSD will log it out and close the
  427.   connection, rather than returning it to its prompt.
  428. -y filename
  429.   Execute "filename" rather than the normal initialization file for real
  430.   users; this option does not apply to anonymous users.
  431. -Y (no init file)
  432.   Do not execute an initialization file, even if a real user is logging in.
  433. Examples:  
  434. iksd -A
  435.   Starts the Internet Kermit Server with all defaults in effect.  
  436. iksd -A --syslog:5
  437.   As above, but with the highest level of syslogging (section 4.2).
  438. iksd -A --anonymous:off --cdfile:READ.ME
  439.   Starts the IKSD with anonymous access forbidden and changes the name of
  440.   CD message file from the default list to READ.ME.
  441. iksd -A -x --anonym:no --cdf:READ.ME
  442.   As above, but forces the IKSD to operate only in Kermit server mode,
  443.   thus preventing user access to the IKSD command prompt.  Also illustrates
  444.   abbreviation of long-form option keywords and use of "no" as a synonym
  445.   for "off".
  446. Bad syntax in an extended command-line option causes immediate termination
  447. with the message "Extended option error", and an exit status code of 1.
  448. Brief help about command line options may be obtained at the C-Kermit prompt
  449. with "help options", and for extended options with "help extended-options".
  450. You can prototype the IKSD command line by including any desired extended
  451. options, but omitting the -A option, and then when you get the C-Kermit>
  452. prompt, use "show extended-options" to check the parsing of the options you
  453. have included.  Example:
  454. $ kermit --anonymous:ok --root:/tmp --userfile:/etc/badusers
  455. (/usr/olga/) C-Kermit>show extended-options
  456.  --bannerfile=(null)
  457.  --cdfile:./.readme
  458.  --cdmessage:0
  459.  --syslog:3
  460.  --wtmplog:1
  461.  --wtmpfile=(null)
  462.  --anonymous:1
  463.  --permission:0040
  464.  --initfile:(null)
  465.  --userfile:/etc/badusers
  466.  --root:/tmp
  467.  --xferlog=0
  468.  --xferfile=(null)
  469.  --timeout:300
  470. (/usr/olga) C-Kermit>
  471. Note that this only shows the values that were given as arguments to the
  472. extended options, or their default values, if they have any, but it does
  473. not show values that will be computed dynamically at runtime in the absence
  474. of a command-line value.  For example, --wtmplog:1 and --wtmpfile:(null)
  475. mean that an appropriate default will be supplied for the wtmp logfile name
  476. at runtime.
  477. Also note that SHOW EXTENDED-OPTIONS does not show the IKSD-specific options
  478. when this command given at the IKSD prompt by the user.  Thus this command
  479. is useful only as a prototyping tool.  (And as noted elsewhere, the IKSD
  480. command-line argument vector is also inaccessible to the IKSD user via other
  481. methods such as the &@[] array.)
  482. 4.2. System Logging
  483. System logging in UNIX is via the standard syslog() facility ("man syslog"
  484. and/or "man syslogd" for further info).
  485. All IKSD entries (except debugging, see below) appear in the daemon log, as
  486. defined in the syslog.conf file with a tag of "iksd" and the process ID (pid)
  487. of the IKSD process, and therefore can be extracted by grepping for "iksd".
  488. The system logging levels are:
  489.   0 = no logging
  490.   1 = Login/out, failed login attempts, failed Kerberos (etc) authentication
  491.   2 = Dialing out (does not apply to IKSD)
  492.   3 = Making any kinds of connections (does not apply to IKSD)
  493.   4 = Creating / receiving / deleting / renaming / copying files
  494.   5 = Sending / typing / reading / transmitting files
  495.   6 = All top-level commands and all server commands sent to iksd
  496.   7 = Commands executed from macros and command files
  497.   8 = Debug
  498. Each level includes all the levels beneath it (except 0 is not included if
  499. the logging level is greater than 0).
  500. The default logging level is 5, and is used if the --syslog: option is not
  501. included on the command line, or if is given with an affirmative keyword
  502. (yes, true, on, ok) rather than a number.  If you specify a number higher than
  503. the the maximum, it is the same as specifying the maximum.
  504. Syslog entries are at LOG_INFO priority, except for refused logins, which 
  505. are at LOG_NOTICE priority, and failed Telnet-level authentication (such as
  506. Kerberos), which are at LOG_ERR priority.
  507. Note that if C-Kermit is built with -DSYSLOGLEVEL=n (where n is a number) on
  508. the cc command line, this turns on syslogging and hardwires it to the given
  509. level for all users.  See ckuins.txt for further info.
  510. WARNING: Debug level produces VOLUMINOUS amounts of information -- it is
  511. equivalent to (in fact, it *is*) C-Kermit's debug log.  Furthermore, there is
  512. a good possibility it will contain sensitive information such as clear-text
  513. passwords.  Debug records are written to the syslog DEBUG facility, as defined
  514. (or not defined) in syslog.conf.  If you use this level of logging, make sure
  515. that the logfile defined for "daemon.debug" is secured from the public, and
  516. that there is plenty of space for it.
  517. ANOTHER WARNING: In some UNIX systems, syslogging does not work once a
  518. chroot() has occurred, which is done by iksd just as it is by ftpd for
  519. anonymous users, to restrict them to the /pub/ftp (or other desired) directory
  520. tree.  At present, SunOS and Linux are known to have this deficiency and there
  521. probably are many others.  THERE IS NO SYSLOGGING FOR ANONYMOUS USERS on these
  522. systems.  The only way to log the activities of anonymous users on such
  523. systems is to specify a transfer iksd log on the command line (Sections 4.1
  524. and 4.3).
  525. 4.3. The Transfer Log File
  526. The transfer log is disabled by default; it must be enabled on the command
  527. line (Section 4.1).
  528. The transfer log has the same format as the wu-ftpd log, and so all the same
  529. scripts can be used to process it, collect statistics, etc.  In fact, you
  530. can even have ftpd and iksd share the same log, in which case records will
  531. be intermixed.
  532. The Transfer log can also be used in regular user-mode C-Kermit sessions.
  533. The first field is fixed-length and contains spaces; subsequent fields are
  534. variable length, contain no spaces, and are separated by one or more spaces.
  535. The fields are:
  536. Timestamp
  537.   This is an asctime-style timestamp, example: "Wed Sep 16 20:19:05 1998"
  538.   It is always exactly 24 characters long, and the subfields are always in
  539.   fixed positions.
  540. Elapsed time
  541.   The whole number of seconds required to transfer the file, as a string
  542.   of decimal digits, e.g. "24".
  543. Connection
  544.   In IKSD, the IP hostname or address of the client.  For user-mode C-Kermit
  545.   transfers, The name of the network host to which C-Kermit is connected, or
  546.   the name of the serial device through which it has dialed (or has a direct
  547.   connection), or "/dev/tty" for transfers in remote mode.
  548. Bytes transferred
  549.   The number of bytes transferred, decimal digits, e.g. "1537904".
  550. Filename
  551.   The full pathname of the file that was transferred, e.g.
  552.   "/pub/ftp/kermit/a/README.TXT".  If the filename contains any spaces or
  553.   control characters, each such character is replaced by an underscore ('_')
  554.   character.
  555. Mode
  556.   The letter 'b' if the file was transferred in binary mode, or 'a'
  557.   if it was transferred in text (ASCII) mode.
  558. Options
  559.   For compatibility with the wuftpd log.  This field always contains an
  560.   underscore ('_') character.
  561. Direction
  562.   The letter 'o' if the file was transferred Out, and 'i' if the file was
  563.   transferred In.
  564. User class
  565.   The letter 'r' for real users, or 'a' for anonymous users.
  566. User identification
  567.   The user ID of a real user, or the password given by an anonymous user.
  568. Server identification
  569.   The string "iks" (Internet Kermit Server), or if C-Kermit is running
  570.   in user mode, "kermit".  This distinguishes a Kermit transfer log
  571.   record from a WU-FTPD record, which contains "ftp" in this field.
  572. Authentication class
  573.   The digit '1' if we know the user's ID on the client system, 
  574.   otherwise '0'.  Currently, always '0'.
  575. Authenticated user
  576.   If the authentication class is '1', this is the user's ID on the client
  577.   system.  Otherwise it is an asterisk ('*').  Currently it is always an
  578.   asterisk.
  579. 4.4. The IKSD Configuration File
  580. The IKSD configuration file is a place to put commands that should always
  581. be executed for every client, real or anonymous.
  582. When C-Kermit is started as IKSD, it always begins by reading the IKSD
  583. configuration file, if any.  By default this is /etc/iksd.conf (you may
  584. change the definition at compile time by adding -DIKSDCONF="filename" to
  585. CFLAGS).  This file contains ordinary C-Kermit commands.  Normally these
  586. would be SET or DISABLE commands.  In case any commands in this file write to
  587. standard output, remember that IKSD's standard output is the connection to
  588. the client.  For more ideas about what can go in the iksd.conf file,
  589. read the next section -- the difference is that when you put commands in
  590. the iksd.conf file, they apply not only to anonymous users, but to real
  591. users too.  So, for example, if you want to disable uploads for all users,
  592. you could put DISABLE SEND in the iksd.conf file, whereas if you wanted to
  593. disable them only for anonymous users, you would put this command in the
  594. anonymous-user initialization file.
  595. The IKSD configuration file is executed before the user logs in (or is
  596. otherwise authenticated), before the C-Kermit initialization file, and before
  597. any extended-format command line options that start with "--", but after any
  598. that are marked CM_PRE in the table in Section 4.1, or that start with "-+".
  599. Since execution occurs before login, the v(user) variable is meaningless
  600. here.
  601. 4.5. The Initialization File
  602. When a real user logs in to the IKSD, the C-Kermit initialization file is
  603. executed in the normal manner, depending on the compile-time configuration of
  604. the IKSD.  Normally, the user's own .kermrc file is executed, and this, in
  605. turn, executes the user's customization file, .mykermrc.  If the IKSD was
  606. built with the CK_SYSINI or CK_DSYSINI compile-time options (described in
  607. ckccfg.txt), a single, shared system-wide initialization file is executed
  608. instead; this may, in turn, execute a customization file out of the user's
  609. home directory.  You may override C-Kermit's automatic selection of
  610. initialization with the regular C-Kermit -y or -Y options on the IKSD command
  611. line, described in the C-Kermit manual.
  612. For anonymous users, the default initialization file, if any, is .kermrc in
  613. the chroot'd file system.  This default may be overridden with the
  614. --initfile:xxx command-line option.  The system administrator may include
  615. commands in this file to disable selected services for anonymous users, e.g.:
  616.   disable delete  ; Don't let anonymous users delete files
  617.   disable send    ; Don't let anonymous users send files
  618. Of course, any Kermit commands at all may be included: settings, macro
  619. definitions, etc.  (Also see Section 5.5.)
  620. When the sysadmin specifies the initialization file, this allows a high degree
  621. of fine-grained control over who is allowed access to what commands and
  622. resources, using standard C-Kermit commands, functions, and variables.  The
  623. following are particularly useful:
  624. v(date), v(ndate)
  625.   The current date, in case you want to restrict access by date.
  626.   (Also read about the new date-related functions in Section 1.6 of
  627.   ckermit2.txt.)
  628. v(day), v(nday)
  629.   The day of the week, in case you want to restrict access to certain days
  630.   of the week.
  631. v(home)
  632.   The user's home directory.
  633. v(host)
  634.   The hostname of the IKS.
  635. v(ipaddress)
  636.   The IP address of the IKS.  This and/or v(host) may be used when you are
  637.   running an IKS on multiple hosts and want to have different setups on each,
  638.   but still have a common initialization file.
  639. v(line)
  640.   The IP host name or address of the client's host.
  641. v(time), v(ntime)
  642.   The current time of day, in case you wish to restrict access to certain
  643.   times of day.
  644. v(userid)
  645.   The ID with which the user logged in to the IKS.  For anonymous logins,
  646.   this is "ftp".
  647. So, for example, if the sysadmin wishes to prevent user "olga" from using the
  648. IKS on Mondays, the initialization file could contain a command like:
  649.   if equal v(user) olga -
  650.     if equal v(nday) 1 -
  651.        exit 1 Sorry Olga - please come back another day
  652. Or suppose it is desirable to block access from all xyzcorp.com hosts between
  653. 9:00am and noon:
  654.   if match v(line) *.xyzcorp.com -
  655.     if lgt v(time) 09:00:00 -
  656.       if llt v(time) 12:00:00 -
  657.          exit 1 Sorry - Please come back after noon
  658. Or suppose a certain user is to be allowed to GET files from the server, but
  659. not SEND, PRINT, or MAIL them:
  660.   xif equal v(user) ivan {
  661.       disable send
  662.       disable print
  663.       disable mail
  664.       disable enable
  665.   }
  666.     
  667. 5. Access to Services
  668. The IKSD behaves at runtime just like the regular C-Kermit program, with
  669. any restrictions resulting from compile-time options, and with the differences
  670. noted in this section and in Section 4.
  671. 5.1. Automatic Settings
  672. When C-Kermit is started as an Internet Kermit Service, the following settings
  673. occur automatically:
  674.  a. Login (authentication) is required.
  675.  b. Shell access is disabled.
  676.  c. Server-side Telnet negotiation is enabled.
  677.  d. SET RELIABLE ON (see ckermit2.txt).
  678.  e. FAST file-transfer settings, including "cautious" unprefixing.
  679.  f. No flow control, no parity.
  680. Items d-f can be overridden with command-line options and/or in the
  681. initialization file.
  682. 5.2. Authentication
  683. The IKSD command prompt will not appear, and no commands may be given, before
  684. the user is authenticated.
  685. When the IKSD has been started without the '-x' command-line option, it issues
  686. a Username: prompt.  The user may type a username at the prompt, in which case
  687. a Password: prompt is issued, and the user must enter a password.  Three login
  688. attempts are allowed, with a pause enforced between each one.  If all three
  689. fail, the connection is closed.
  690. The user may also authenticate from the client by sending a [ REMOTE ] LOGIN
  691. command (again, only 3 tries are allowed), or by Telnet Authentication
  692. negotiations.  Prior to authentication, the IKSD will respond to only the
  693. following client commands:
  694.   [ REMOTE ] LOGIN
  695.   [ REMOTE ] LOGOUT
  696.   REMOTE HELP (or RHELP)
  697.   REMOTE EXIT (or REXIT)
  698.   BYE
  699. Once authenticated, the user may not re-authenticate or change identities.
  700. The connection persists until it is broken in any of the following ways:
  701.  a. Client sends BYE or REMOTE EXIT (REXIT) or [ REMOTE ] LOGOUT to IKSD.
  702.  b. Client sends FINISH to IKSD that has been started with '-x'.
  703.  c. User gives HANGUP or CLOSE command to the client.
  704.  d. User gives EXIT, QUIT, or LOGOUT command at IKSD prompt. 
  705. The connection is also closed if the user exits from the client, but only if
  706. it was an end-to-end Telnet connection.  There can be no guarantee that
  707. exiting from a serial communication program will close and hang up the serial
  708. connection.
  709. 5.3. The DISABLE Command
  710. In the IKSD, the DISABLE command applies not only to client/server functions,
  711. but also to the corresponding commands when given at the prompt.  For example,
  712. DISABLE DELETE disables not only REMOTE DELETE commands given from the client,
  713. but also DELETE commands given at the IKSD's command prompt, as well as
  714. implicit forms of file deletion, such as when the target of a COPY command is
  715. an existing file.
  716. The DISABLE ENABLE command is irreversible; once this command is given, the
  717. ENABLE command can not be re-enabled, and therefore no other disabled commands
  718. can be enabled either.  ENABLE is DISABLEd automatically for anonymous users,
  719. so any DISABLE commands in the anonymous-user initialization file (Section 4.4)
  720. are also irreversible.
  721. 5.4. Shell Access
  722. All forms of system and shell access are disabled in the IKS.  Thus the user
  723. can not execute REMOTE HOST commands from the client, nor access the shell
  724. from the IKS command prompt via shell escapes (!), the RUN or PUSH command, or
  725. by specifying pipes or filters in file-transfer commands, or by pipe
  726. specifications in REMOTE commands, or in any other way.  This is true even if
  727. the executable was built without the NOPUSH compile-time option.
  728. 5.5. Anonymous Users
  729. Anonymous users are allowed by default, but can be denied with --anonymous:no
  730. on the command line (Section 4.1).
  731. Anonymous users are handled in about the same way as they are by ftpd.  Their
  732. effective user ID is set to "ftp" and their file-system access is restricted
  733. to the tree rooted at the home directory of the "ftp" user, normally /pub/ftp,
  734. via chroot.  If /pub/ftp does not exist, login will fail.  In that case (or
  735. for any other desired reason), the anonymous root directory can be changed
  736. with the --root: option, e.g. --root:/tmp.  Note that, unlike ftpd, iksd does
  737. not necessarily require any particular binaries (such as ls) to be in the
  738. chroot'd tree.  DLLs might be another story, but so far these have not been
  739. needed, even with dynamically linked Kermit binaries (at least in Linux and
  740. Solaris).  Should DLLs be a problem, use a statically linked Kermit binary
  741. (if possible), or install the needed DLLs in the anonymous root.
  742. File access is according to user "ftp" and the directory and file permissions
  743. of the /pub/ftp tree.  If anonymous uploads are to be allowed, then usually
  744. only specific directories (often with a name like "incoming") are given write
  745. permission, and any files that are created in such a directory have owner
  746. "ftp", with the group set to the group of the directory.  As noted in section
  747. 4.1, the permission for all files created by anonymous users is 0040
  748. (group-read only), or whatever else the sysadmin has specified in the
  749. --permissions: command-line option.
  750. Thus, if you already have a public ftp server, most likely everything is set
  751. up appropriately already.  If anonymous ftp is allowed (by the presence of
  752. a valid user "ftp" in your system's password file), it will be allowed also
  753. for IKSD unless explicitly disallowed on the IKSD command-line (or if
  754. /pub/ftp doesn't exist and you did not supply a --root: option on the command
  755. line).
  756. In addition to the FTP-like restrictions, certain Kermit services are always
  757. denied to anonymous users.  These include:
  758.  . PRINT (at IKSD prompt) and REMOTE PRINT (from client)
  759.  . MAIL (or SEND /MAIL) at IKSD prompt and from client.
  760.  . Creation of any logs (transaction, debug, packet, etc).
  761.  . No file may be deleted, including implicitly, e.g. by the COPY command.
  762.  . FILE COLLISION is set to RENAME and may not be changed.
  763. The latter three provisions mean that anonymous users can not delete,
  764. overwrite, rename, or alter any existing files in any way, whether by file
  765. transfer or with the DELETE or RENAME command.
  766. Note that IKSD, like FTPD, does not allow directory creation by anonymous
  767. users, even when file/directory permissions would otherwise allow it.  To
  768. change this, add:
  769.   enable mkdir    ; Enable directory creation
  770. to /pub/ftp/.kermrc (or whatever other initialization file you have designated
  771. for anonymous users with --initfile).  Similarly for directory removal:
  772.   enable rmdir    ; Enable directory removal
  773. Of course directories can be removed only if (a) they are empty, and (b)
  774. their permissions allow it.
  775. 5.6. Management Information
  776. The command-line argument vector, normally accessible in the &@[] array,
  777. the top-level %0..9 variables, or by other means, is inaccessible to IKSD
  778. users.  Thus IKSD clients can not discover the IKSD startup path or options,
  779. the logfile pathnames or directories, logging level, etc.
  780. 6. Open Issues
  781. Several services that are normally provided by C-Kermit are not available
  782. when it is an Internet Kermit Service Daemon.
  783. 6.1. Connection Establishment
  784. If the user has access to the IKSD command prompt, why not allow her to "set
  785. host" or "set line" from there to another place?  Obviously this would be a
  786. security risk if allowed for anonymous users.  For authenticated users, it
  787. should be OK, but is not currently possible for Telnet connections since the
  788. IKSD is already a Telnet server on the incoming connection, and is not
  789. designed to conduct two separate Telnet sessions simultaneously.  It might be
  790. possible to allow the user to make a dialout connection, but some coding and
  791. testing would be needed should this prove desirable.
  792. 6.2. Shell Access
  793. Shell access is forbidden to anonymous users for obvious reasons.  From a
  794. security standpoint, it could be allowed for authenticated users, but there
  795. remains a technical obstacle: the absence of a terminal driver for the
  796. connection.
  797. 6.3. External and/or non-Kermit Protocols
  798. External protocols such as Zmodem can not be expected to perform any of the
  799. logging or security functions that are done by C-Kermit itself within its
  800. protocol and file modules.  Thus external protocols are disabled in the IKSD.
  801. Plus the fact that such protocols are likely to be incompatible with Telnet
  802. connections in the first place.  In more detail:
  803.  . When the user is 'anonymous' the file system is chroot'd, which means
  804.    that any external executables must exist in the chroot'd file system.
  805.    This leaves open the possibility that executables might be replaced by a
  806.    different file of the same name that has been uploaded either on top of
  807.    the existing file or just into the same directory.  If "." is in the
  808.    PATH for the process anything the user uploads with the name 'rz' or
  809.    'sz' might be executed in its place.  Therefore, the IKSD does not use
  810.    any external commands of any kind.  Not 'ls', not 'cp', not 'df', not
  811.    anything.  To allow the execution of external programs is a major
  812.    security hole in this setting.
  813.  . Most implementations of 'sz' and 'rz' are designed for remote use over a
  814.    terminal connection.  They expect to be run underneath a pseudoterminal
  815.    (PTY).  When IKSD is running there is no PTY.  In fact, when IKSD is
  816.    running there is only a raw socket; the IKSD handles all necessary
  817.    Telnet protocol translations including Telnet Network Virtual Terminal
  818.    (NVT) rules regarding quoting of Carriage Return and 0xFF depending upon
  819.    the state of the BINARY Telnet option in each direction.  'sz' and 'rz'
  820.    are completely incapable of performing these translations in either
  821.    direction and any attempt to transfer a file with them will result in a
  822.    transfer failure and the corruption of the data stream.
  823.  . IKSD supports encrypted sessions, in which case it handles the
  824.    encryption and decryption itself; an external protocol module would not
  825.    do this, and so could not be used on encrypted channels in any case.
  826. 6.4. Additional Administrative Controls
  827. Certain options available in wu-ftpd are not implemented in iksd:
  828.  . Ability to select IKSD logging for real vs anonymous users.
  829.  . Ability to select IKSD logging for inbound vs outbound files.
  830.      - Currently all transfers are logged or not logged.
  831.  . Ability to allow/restrict chmod/delete/overwrite for anonymous users.
  832.      - Currently there is no command for changing file permissions.    
  833.      - Guests may not delete files, period.
  834.      - FILE COLLISION is set to RENAME for guests and may not be changed
  835.        since all the other options allow existing files to be altered.
  836.      - There is no way to grant these capabilities to guests.
  837.  . Ability to allow directory creation by anonymous users.
  838.      - Anonymous users may not create or remove directories.
  839.  . Ability to allow/specify CD messages on a per-directory basis.
  840.  . RFC931 authentication of remote (client) user (but wu-ftpd doesn't either).
  841. These or other controls can be added if there is sufficient reason or demand.
  842. 6.5. Known Bugs
  843.  . When commands are logged in syslog, the EXIT command appears twice.
  844.  . wtmp entries show pids in hex due to length restrictions, so you'll
  845.    need to convert them to decimal before using them with ps, kill, etc.
  846. 7. MONITORING
  847. Unless you disable it, all IKSDs keep current session information in a shared
  848. database.  The IKSD instances can be within one computer or running on any
  849. number of different computers that share the same file system on the same
  850. network.  The database can be monitored by the sysadmin with a simple
  851. "systat"-like display program, which shows who is logged in, from where, and
  852. what they're doing.  (The idea is easily adapted to other servers, such as
  853. FTP.)  For maximum portability and reliability, the database is an ordinary
  854. file on disk.
  855. The IKSD database file should reside in its own directory (to avoid conflicts
  856. with other servers that might use the same filename conventions), and this
  857. directory and its files should be visible to the sysadmin without privileges
  858. (e.g. by group access) but hidden from the public for privacy reasons if other
  859. such logs (e.g. the ftpd log, syslog, etc) also are.
  860. The database is a random-access file indexed by "slot number", which is
  861. self-assigned during a quick search at startup.  Once a slot is claimed, there
  862. is no more searching; each IKSD updates its own slot in place and does not
  863. touch the others.  Slots never move.
  864. When an IKSD instance starts, it must obtain a "slot allocation lock" before
  865. it can claim its slot.  Otherwise there could be a race condition when another
  866. IKSD instance starts at the same time, in which the two could wind up with the
  867. same slot.
  868. Since exclusive access is a nonportable concept, we obtain the lock in a
  869. crude but portable manner, without recourse to kernel locks, interprocess
  870. communication, semaphores, memory-mapped files, or other platform-specific
  871. mechanisms:
  872.  a. Create a temp file in the database directory called <ip>.<pid>, where
  873.     <ip> is the local IP address as 8 hex digits and <pid> is my own
  874.     process ID (PID) in hex (no leading zeros).  This is guaranteed to be
  875.     a unique name (and if by chance a file of this name already exists, it
  876.     can't possibly be valid, so it it's ok to overwrite it).
  877.  b. Write my own ID string into the file.  The ID string is <ip>:<pid>,
  878.     where <ip> is (again) my IP address as 8 hex digits, and <pid> is my
  879.     PID in decimal (not hex).  (The reason for decimal here is
  880.     readability, so sysadmins can easily enter it into other tools or
  881.     commands; it has to be hex in the temp filename for compactness in
  882.     case of 14-character filename limitations.)
  883.  c. Try to open iksd.lck, which is the real lockfile.  If this succeeds,
  884.     read its contents (an <ip>:<pid> string).  If the <ip> not the same as
  885.     mine, consider the file locked.  If it is the same, extract the PID
  886.     and check its validity.  If it is not valid, delete the lockfile.
  887.     (Currently this step is skipped by K95 since it can't check PIDs.)
  888.  d. At this point the iksd.lck file might or might not exist.  Try to
  889.     rename the temp file to iksd.lck.  This will fail if the lockfile
  890.     exists, in which case we sleep, loop, and try again, up to a certain
  891.     number of times -- say 16 tries spaced 1 second apart.  If we fail to
  892.     get a lock, we let the user on anyway, in the spirit of service over
  893.     management.  If the rename succeeds, on the other hand, we have a lock.
  894. When and if we have obtained a lock, we open the database file itself and
  895. search the whole database (sequentially) for:
  896.  a. Free slots (In-Use flag is 0), or:
  897.  b. Stale slots(*), or:
  898.  c. Any slot with our own IP and PID (a special kind of stale slot).
  899. (*) In-Use flag is 1 and IP address is ours, but PID is invalid.
  900. In C-Kermit only (not K-95) we also perform some housekeeping duties while
  901. searching (the Windows APIs include no provisions for this):
  902.  a. Whenever a stale slot is found, we free it (set its In-Use flag to 0).
  903.  b. We remove all free slots after the last in-use slot by truncating the
  904.     database file (this keeps the database file from constantly growing as 
  905.     new highwater marks are reached).
  906. Then we claim the first one of these that was found.  If no slot was claimed,
  907. we add a new slot at the end and claim it.  If the database file did not
  908. exist, we create it and claim the first slot.  (In Windows, the IKSD listener
  909. simply deletes the existing database, if any, on initial startup.)
  910. To claim a slot:
  911.  a. We set the In-Use flag to 1, fill in the Server PID and IP address
  912.     fields with our own PID and IP address, fill in the session-start and
  913.     update time fields, and clear the other fields.
  914.  b. Then we release the lock.
  915. From this point, we can write freely into our slot regardless of locks.
  916. Notes:
  917.  a. Since all IKSDs follow the same procedure, only one can have a lock a
  918.     at a time.
  919.  b. The lockfile is readable text; it can be typed (cat'd).  The contents
  920.     are the same format on every platform, regardless of byte order or
  921.     word size.
  922.  c. This scheme allows (but does not require) multiple computers that share
  923.     a common file system to have a single IKSD database, which in turn allows
  924.     the site manager to monitor all IKSDs on all computers at once.  This
  925.     works if each computer has a unique IP address (which it must if they are
  926.     on the same network sharing a common file system; nevertheless, care must
  927.     be taken regarding IP address pools, etc).  It also depends on the file-
  928.     sharing mechanism (such as NFS) to propogate updates promptly and in
  929.     sequence.
  930.  d. While one IKSD is allocating its slot, nothing prevents other IKSD
  931.     instances that already have their own slots from updating them, since 
  932.     that does not interfere with slot allocation.
  933.  e. The tempfile name format is UNIXish and will need modification for file
  934.     systems with restrictive names, such as FAT, 14-char UNIXes, etc.  In
  935.     such cases we could (a) omit the IP address if we're not concerned about
  936.     multiple computers sharing a single database, or (b) encode the IP
  937.     address in Base 64 to make it shorter.  But probably none of this will
  938.     ever come up.
  939.  f. The design accommodates 64-bit IPv6 addresses, but for now the software
  940.     uses only 32 bits.
  941. 7.1. Database Record Format
  942. A slot is 4K (4096 octets), divided into 4 1K chunks.  The first chunk is
  943. further subdivided into shorter fields.  Numeric fields are coded in
  944. hexadecimal, right-adjusted, and left-padded with 0's.  Text fields are
  945. left-adjusted and right-padded with blanks.  Date-time fields are
  946. right-adjusted within a field of 18 with the leading blank reserved for Y10K.
  947. Date-time format is:
  948.   yyyymmdd hh:mm:ss
  949. where yyyymmdd are the numeric year, month, and day, and hh:mm:ss are the hour
  950. (24-hour clock), minute, and second.  Months and days are 1-based, leading 0's
  951. are supplied where needed.
  952. The layout of each slot is as follows (fields and byte positions are numbered
  953. from 0):
  954.    0. FLAGS (Slot/Session Flags)
  955.       Start:     0
  956.       Length:    4
  957.       Type:   Bit Mask
  958.       Format: Hex digits.   
  959.       Bit Values:
  960.        1: 1 = Slot in use, 0 = Slot is free.
  961.        2: 1 = Real user, 0 = Anonymous user.
  962.        4: 1 = Logged in, 0 = Not logged in.
  963.    1. AUTHTYPE (Authorization Type)
  964.       Start:     4
  965.       Length:    4
  966.       Type:   Number
  967.       Format: Hex digits.
  968.       Values:
  969.        0: None          8: (reserved)
  970.        1: Kerberos IV   9: (reserved)
  971.        2: Kerberos V   10: LOKI
  972.        3: SPX          11: SSA
  973.        4: MINK         12: KEA_SJ
  974.        5: SRP          13: KEA_INTEG
  975.        6: RSA          14: DSS
  976.        7: SSL          15: NTLM
  977.    2. AUTHMODE (Authorization Type)
  978.       Start:     8
  979.       Length:    4
  980.       Type:   Number
  981.       Format: Hex digits.
  982.       Values:
  983.        0: Rejected
  984.        1: Unknown
  985.        2: Other
  986.        3: User
  987.        4: Valid
  988.    3. STATE (IKSD State)
  989.       Start:    12
  990.       Length:    4
  991.       Type:   Bit Mask
  992.       Format: Hex digits.
  993.       Bit Values:
  994.        1: Initializing
  995.        2: Sending a file
  996.        4: Receiving a file
  997.        8: Executing a REMOTE command
  998.       32: At command prompt
  999.    4. PID (IKSD's Process ID)
  1000.       Start:    16
  1001.       Length:   16
  1002.       Type:   Number
  1003.       Format: Hex digits.
  1004.    5. SERVER IP (IKSD's IP Address)
  1005.       Start:    32
  1006.       Length:   16
  1007.       Type:   IP address as a series of numeric octets in network byte order
  1008.       Format: Hex digits
  1009.    6. CLIENT IP (Client's IP Address)
  1010.       Start:    48
  1011.       Length:   16
  1012.       Type:   IP address as a series of numeric octets in network byte order
  1013.       Format: Hex digits
  1014.    7. SESSION START (Date and Time session started)
  1015.       Start:    64
  1016.       Length:   18
  1017.       Type:   Date-time
  1018.       Format: Date-time string
  1019.    8. LAST UPDATE (Date and Time this record was last updated)
  1020.       Start:    82
  1021.       Length:   18
  1022.       Type:   Date-time
  1023.       Format: Date-time string
  1024.    9. ULENGTH (Username length)
  1025.       Start:   100
  1026.       Length:    4
  1027.       Type:   Number
  1028.       Format: Hex digits, right adjusted
  1029.   10. DLENGTH (Length of current directory)
  1030.       Start:   104
  1031.       Length:    4
  1032.       Type:   Number
  1033.       Format: Hex digits, right adjusted
  1034.   11. ILENGTH (Length of state-specific information)
  1035.       Start:   108
  1036.       Length:    4
  1037.       Type:   Number
  1038.       Format: Hex digits, right adjusted
  1039.   12. RESERVED
  1040.       Start:   112
  1041.       Length:  912
  1042.       Type:   None
  1043.       Format: Filled with blanks
  1044.   13. USERNAME (Username; if anonymous "anonymous:<password>")
  1045.       Start:  1024
  1046.       Length: 1024
  1047.       Type:   None
  1048.       Format: Text, ULENGTH sigificant chars, right-filled with blanks
  1049.   14. DIRECTORY (Current directory)
  1050.       Start:  2048
  1051.       Length: 1024
  1052.       Type:   None
  1053.       Format: Text, DLENGTH sigificant chars, right-filled with blanks
  1054.   15. INFO (State-specific information)
  1055.       Start:  3072
  1056.       Length: 1024
  1057.       Type:   None
  1058.       Format: Text, ILENGTH sigificant chars, right-filled with blanks
  1059. The state-specific information tells you whether IKSD is at its command prompt
  1060. or in server command wait, if it is sending or receiving a file (in which case
  1061. the filename is shown), it is executing a REMOTE command (in which case the
  1062. command is shown), or how it was terminated (BYE, REMOTE EXIT, disconnect, etc)
  1063. Notes:
  1064.  a. There are no control characters (CR, LF, NUL, etc) or 8-bit
  1065.     characters; only ASCII graphic characters are used in the
  1066.     database.  Fields are left- or right-padded with Space or '0' as
  1067.     indicated.
  1068.  b. Since the USERNAME, DIRECTORY, and INFO fields are right-padded
  1069.     with spaces, it would be laborious to isolate their actual values
  1070.     by trimming spaces from the right (since we must allow for
  1071.     internal spaces); hence the ULENGTH, DLENGTH, and ILENGTH fields.
  1072.  c. The USERNAME, DIRECTORY, and INFO fields are 1K each since 1K is
  1073.     the maximum pathname length found on common UNIX platforms (even
  1074.     though many platforms have smaller maximums).  Thus, for example,
  1075.     the current directory string might be exactly 1K long.  This is why
  1076.     its length is kept outside the block.  Also the division of the
  1077.     record into four 1K blocks tends to make for more efficient i/o.
  1078.     
  1079.  d. The IKSD database does not provide a permanent record or give
  1080.     complete information.  That's what the syslog entries and the IKSD
  1081.     log are for.
  1082. 7.2 The Display Module
  1083. The straightforward data definitions and formats allow a display module to be
  1084. written easily in the language of your choice, including scripting languages
  1085. such as Kermit's own.  A sample display module, iksdpy, is provided as a
  1086. "Kerbang" script, providing a running display of the active IKSD sessions from
  1087. the database.  In its startup mode, it lists each session in the database,
  1088. refreshing every 4 seconds.  Various keystroke commands are available for
  1089. help, quitting, etc, and to enter the detail screen for a specific session.
  1090. The detail screen, too, refreshes itself every 4 seconds.  Here you have keys
  1091. to return to the main screen, to pick another session, to cycle through
  1092. sessions, and so on.
  1093. When a slot is freed, its information is left intact so you can still see who
  1094. was using it, when, and from where, and the last thing they did before logging
  1095. out.  The old info persists until the slot is removed or reclaimed, which will
  1096. happen when the next new IKSD session starts.
  1097. The iksdpy script is short, simple, and easily extensible.  For example, while
  1098. watching a detail screen and you see somebody doing something bad, you might
  1099. like to have a "K" key to kill the session (the script already knows the pid,
  1100. so it need simply form a "!kill -9" command, including the pid).
  1101. 7.3. Database Management
  1102. The following command-line options let you disable/enable the database and
  1103. specify its location:
  1104. --database:{on,off}
  1105.   Whether an active-sessions database should be kept.  On by default.
  1106.   If "on", but --dbfile is not specified, /var/log/iksd.db is used.
  1107. --dbfile:<filename>
  1108.   Use this option to specify an iksd database file name.  If you include 
  1109.   this option, it implies --database:on.
  1110. In UNIX, the system startup procedure can delete the database file before
  1111. starting inetd, since nothing in it is valid; however, this is not necessary
  1112. since normal cleanup procedures will do the job too.  In Windows, the IKSD
  1113. listener takes care of it.
  1114. To capture a snapshot of IKSD usage, simply copy the database file.
  1115. 8. TESTING
  1116. In case you want to test IKSD on a port other than 1649, be aware that
  1117. IKS-aware Kermit clients (such as C-Kermit 7.0 and K95 1.1.18) will not
  1118. initiate Telnet negotiations with it, since it is not on a Telnet port
  1119. (i.e. 23 or 1649).  To get correct operation you'll need to force the client
  1120. to negotiate, e.g.:
  1121.   telnet hostname 3000
  1122.   set host hostname 3000 /telnet
  1123. (End of IKSD.TXT)