home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / e / id-iks-00.txt < prev    next >
Text File  |  2020-01-01  |  32KB  |  759 lines

  1. Internet Engineering Task Force                            Frank da Cruz
  2. INTERNET-DRAFT                                         Jeffrey E. Altman
  3. <draft-columbia-kermit-service-00.txt>               Columbia University
  4.                                                            7 August 1998
  5.                                                Expires: 12 February 1999
  6.  
  7.  
  8.                         INTERNET KERMIT SERVICE
  9.  
  10.                                 DRAFT 00
  11.  
  12.  
  13. STATUS OF THIS MEMO
  14.  
  15. This document is an Internet-Draft.  Internet-Drafts are working
  16. documents of the Internet Engineering Task Force (IETF), its areas, and
  17. its working groups.  Note that other groups may also distribute working
  18. documents as Internet-Drafts.
  19.  
  20. Internet-Drafts are draft documents valid for a maximum of six months
  21. and may be updated, replaced, or obsoleted by other documents at any
  22. time.  It is inappropriate to use Internet-Drafts as reference material
  23. or to cite them other than as "work in progress".
  24.  
  25. To view the entire list of current Internet-Drafts, please check the
  26. "1id-abstracts.txt" listing contained in the Internet-Drafts Shadow
  27. Directories on ftp.is.ca.za (Africa), ftp.nordu.net (Northern Europe),
  28. ftp.nis.garr.it (Southern Europe), munnari.oz.au (Pacific Rim),
  29. ftp.ietf.org (US East Coast), or ftp.isi.edu (US West Coast).
  30.  
  31.  
  32. ABSTRACT
  33.  
  34. This document describes a new file transfer service for the Internet
  35. based on Telnet Protocol for option negotiation and Kermit Protocol for
  36. file transfer and management.  The Internet Kermit Service provides
  37. access to both authenticated and anonymous users.  The use of Kermit
  38. protocol over a Telnet connection provides several advantages over FTP,
  39. including easy traversal of firewalls, transfers over multiple
  40. transports, and security via a combination of supported Telnet
  41. authentication and encryption option negotiations, plus significant
  42. functional benefits.
  43.  
  44.  
  45. CONTENTS
  46.  
  47.   1. INTRODUCTION
  48.   2. BACKGROUND
  49.   2.1. History
  50.   2.2. Motivation
  51.   3. THE INTERNET KERMIT SERVICE MODEL
  52.   3.1. Server-Side Kermit Server
  53.   3.2. Client-Side Kermit Server
  54.   3.3. Loosely Coupled Operation
  55.   4. AUTHENTICATION
  56.   4.1. Telnet Authentication
  57.   4.2. Plaintext Authentication via Kermit REMOTE LOGIN
  58.   4.3. Plaintext Authentication via Command Prompt
  59.   4.4. Anonymous Login
  60.   5. SERVICES
  61.   5.1. Features for System Administrators
  62.   5.2. Features for Users
  63.   5.3. User Interface
  64.   6. REFERENCES
  65.   7. AUTHORS' ADDRESS
  66.  
  67.  
  68. 1. INTRODUCTION
  69.  
  70. The Internet Kermit Service is intended to:
  71.  
  72.  1. Provide direct access to Kermit services without requiring the
  73.     user to first login to a shell account;
  74.  
  75.  2. Provide Kermit services to anonymous users;
  76.  
  77.  3. Provide services to all Telnet clients that support Kermit file
  78.     transfer protocol via a simple, predictable, scriptable, and
  79.     well-documented textual interface;
  80.  
  81.  4. Provide direct and tightly-coupled access to a Kermit server
  82.     when requested via the Telnet Kermit Option [TKO].
  83.  
  84. This draft assumes knowledge of Transmission Control Protocol, the
  85. Telnet Protocol [TEL], the Kermit File Transfer Protocol [KER,PRF],
  86. Telnet Kermit Option [TKO], and the commands and features of Kermit
  87. software [CKB,CMG,K95].
  88.  
  89. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
  90. "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
  91. document are to be interpreted as described in RFC 2119 [BCP].
  92.  
  93. Definitions:
  94.  
  95. Kermit server
  96.   A software program that is ready to accept and act upon commands in
  97.   the form of well-defined Kermit packets [KER].
  98.  
  99. Kermit client
  100.   A software program that receives requests through its user interface
  101.   from a human user (or a script or other source) and translates them
  102.   to command packets, which it sends to a Kermit server, thus
  103.   initiating a Kermit protocol transaction such as the transfer of one
  104.   or more files.
  105.  
  106.  
  107. 2. BACKGROUND
  108.  
  109. 2.1. History
  110.  
  111. "Kermit" is the name of an extensible platform- and medium-independent
  112. file transfer and management protocol [KER,PRF] and of a suite of
  113. communications software programs that implement it and integrate it with
  114. other communications functions [CMG,CKB,K95].
  115.  
  116. The Kermit protocol was first developed at Columbia University in New
  117. York City in 1981 for transferring files without errors between diverse
  118. types of computers over potentially hostile communication links.  Since
  119. 1981, the Kermit Project at Columbia University has expanded the
  120. protocol, developed communications software that implements it upon key
  121. platforms, and worked with volunteer programmers at other sites adapting
  122. Kermit protocol to other platforms or communication methods.  The Kermit
  123. Project also serves as the central point of Kermit software development,
  124. support, information, and distribution throughout the world.
  125.  
  126. Kermit software is now available for nearly every computer and operating
  127. system in existence.  The major features of the most popular Kermit
  128. programs are:
  129.  
  130.  . Connection establishment and maintenance for a variety of connection
  131.    methods including direct serial, dialup, TCP/IP, X.25, DECnet, and
  132.    NETBIOS.
  133.  
  134.  . Terminal emulation.
  135.  
  136.  . Error-free transfer of both text and binary files, individually or
  137.    in groups.
  138.  
  139.  . Character-set translation during both terminal emulation and
  140.    text-mode file transfer -- a unique feature of Kermit software.
  141.  
  142.  . Remote file management through the client/server protocol.
  143.  
  144.  . A powerful and portable scripting language allowing complete
  145.    automation of any task that can be performed manually.
  146.  
  147. Kermit's command and script language is consistent across all platforms
  148. and communication methods, thus offering a unified method for
  149. accomplishing a wide range of communication tasks manually or under
  150. script control.
  151.  
  152. A single Kermit program combines the functions of many different
  153. programs such as uucp, cu, tip, telnet, rlogin, ftp, iconv, and expect:
  154. it is a Telnet and Rlogin client that can also transfer files; it is a
  155. file transfer program that can also convert character sets; it is a
  156. dialout program that can use dialing directories and understands country
  157. codes and area codes; it is fully scriptable; it offers both
  158. client/server and interactive modes of operation.  In its desktop
  159. versions (particularly for DOS, Windows, and OS/2) it offers all the
  160. features of communications software that are usually lacking from
  161. Internet client software (key mapping, colors, scrollback, mouse
  162. functions, printer control, etc)
  163.  
  164. Kermit software is widely used throughout the academic, government, and
  165. corporate spheres, both in the USA and internationally.
  166.  
  167. In addition to the Kermit software developed and/or distributed by the
  168. Kermit Project at Columbia University, hundreds of other software
  169. products -- commercial, shareware, and freeware -- also include some
  170. level of support for the Kermit protocol.  Thus there are hundreds,
  171. perhaps thousands, of independent and interoperable Kermit protocol
  172. implementations based upon the open Kermit protocol specification [KER].
  173.  
  174. The Internet has formed the primary mechanism by which users and
  175. developers of Kermit software have collaborated to produce feature and
  176. command sets that continually evolve to meet their needs as technology
  177. changes.
  178.  
  179. 2.2. Motivation.
  180.  
  181. Kermit protocol and software makes connections from one computer to
  182. another and transfers data between them.  Countless people "live" in
  183. Kermit all day long; as a customizable Telnet or Rlogin (or serial
  184. communication) client with a wide selection of terminal emulations and
  185. convenience features, it is their window onto the Internet.
  186.  
  187. Others use it in more creative ways, including some that involve key
  188. parts of the Internet, e.g. in batch or cron jobs that update news or
  189. Web servers or fetch email, or to monitor routers, terminal servers, and
  190. hubs and dial pagers when faults are detected.  It is used by vendors of
  191. telecommunications equipment for remote diagnosis, patching, and
  192. updates.  Telecom managers often use Kermit scripts to configure PBXs,
  193. muxes, routers, or terminal servers.  In the world of commerce, Kermit
  194. is widely used for financial transactions, EDI, medical claim
  195. submission, and so forth.  It is used with mobile barcode readers in
  196. warehousing and inventory applications.  It is found in US Postal
  197. Service sorting and scanning equipment.  It connects many of the
  198. logistics and supply systems throughout the military.  It is found in
  199. fast-food restaurant cash registers, milling and die-cutting machines,
  200. textile looms and cutters, printing presses, and medical diagnostic
  201. equipment.  It was the communications backbone of the 1994 Brazilian
  202. national election -- the largest in history.
  203.  
  204. And yet there has never been a strong, explicit connection of Kermit
  205. with the Internet.  In the early years, Kermit acted as a kind of
  206. do-it-yourself network, enabling ordinary users to make connections that
  207. were not already there, and for some years was the predominant method of
  208. connecting a personal computer to the ARPAnet (e.g. by dialing a TAC).
  209.  
  210. Nowadays, however, with so many of the world's computers on the
  211. Internet, the role of Kermit software and protocol is changing.  Kermit
  212. users on the network would like to have the features, functions, and
  213. interface they are accustomed to -- especially the automation features
  214. -- available for use in settings where presently only tools like FTP are
  215. available -- and even more so in situations where standard software like
  216. FTP can't be used.
  217.  
  218. An Internet Kermit Service can fill this role, and augment the data
  219. transfer power and flexibity of other Internet applications such as Web
  220. browsers:
  221.  
  222.  . Like FTP, Kermit provides a service that can be accessed from many
  223.    different platforms with a consistent set of commands, but unlike
  224.    FTP, these commands include programming constructions such as
  225.    variables, arrays, looping and selection mechanisms, and local and
  226.    remote procedure calls.
  227.  
  228.  . Like FTP, Kermit provides both text- and binary-mode data transfer,
  229.    as well as file management capabilities.  But Kermit also offers
  230.    numerous features lacking from FTP, such as character-set
  231.    translation, flexible file selection mechanisms, attribute
  232.    preservation, and so on (see Section 5.3 for a longer list).
  233.  
  234.  . Unlike standard FTP, Kermit can transfer data through firewalls or
  235.    proxies on a single well-known port.
  236.  
  237.  . Unlike FTP, Kermit can transfer data across a combination of
  238.    transports (e.g. dial-up to a terminal server and thence to an
  239.    Internet host).
  240.  
  241.  . Authentication and data transfer can take place over secure
  242.    connections (mutually authenticated and encrypted) using established
  243.    Telnet authentication and encryption options.
  244.  
  245.  . Unlike traditional Kermit use over Telnet, anonymous access is
  246.    possible, and the considerable overhead of the intervening Telnet
  247.    server and pseudoterminal service is eliminated.
  248.  
  249. Until now the primary obstacles to an Internet Kermit Service have been:
  250.  
  251.  . Issues of authentication and anonymous access.  These have been
  252.    addressed in our prototype, as described Section 4 of this document.
  253.  
  254.  . Issues of coordination and control.  A Kermit software program can be
  255.    in any of several "modes": at its command prompt or menu, awaiting
  256.    commands from the user; in terminal mode, in which the user's
  257.    keystrokes are sent to the remote computer or service; or in protocol
  258.    mode, in which two Kermit programs communicate via well-defined
  259.    Kermit packets [KER].  Commands or operations valid in one mode do
  260.    not necessarily work in another.  Until now, it has been the user's
  261.    responsibility to switch modes at one or both ends of the connection
  262.    as needed.  A companion draft [TKO] to this one specifies a mechanism
  263.    to closely couple the client and server via Telnet protocol
  264.    negotiations, allowing each to know the other's state and to switch
  265.    to the appropriate mode automatically so a valid and useful
  266.    relationship obtains at all times.
  267.  
  268.  . Lack of a standard TCP port.  Port 1649 was assigned by the IANA for
  269.    this purpose (via email from Joyce Reynolds, 27 September 1995).
  270.    This port is provisionally designated as "Inspect" in the Internet
  271.    Assigned Numbers List of Registered Ports [IAN] until a standard is
  272.    issued for its use.  This document proposes such a standard.
  273.  
  274.  
  275. 3. THE INTERNET KERMIT SERVICE MODEL
  276.  
  277. The Internet Kermit Service (IKS) uses a standard Telnet [TEL]
  278. connection, in which all Telnet rules apply.  Unlike FTP, which requires
  279. additional TCP connections, IKS uses a single channel for both signaling
  280. and data transfer.  The connection is multiplexed via (a) Telnet
  281. options, and (b) Kermit protocol messages.  This allows existing Telnet
  282. clients that also support the Kermit protocol, whether or not they
  283. support the Telnet Kermit Option [TKO], to use the IKS and take
  284. advantage of all relevant Telnet options including authentication and
  285. encryption.
  286.  
  287. The system Internet services daemon (e.g. inetd) waits for a connection
  288. on the Kermit socket (1649) and then starts the IKS on the new
  289. connection.  The IKS performs the familiar Telnet negotiations including
  290. the Telnet Kermit option.  Unlike a standard Telnet server, the IKS does
  291. not support the ability to present the user with an interactive system
  292. shell.  The Kermit socket is used only for file transfer and management
  293. functions provided by Kermit file transfer protocol and the Kermit
  294. script language.
  295.  
  296. Once the connection is established, the Telnet Kermit Option is
  297. negotiated in both directions.  The results determine which of the
  298. following configurations is used by the Telnet client and Server:
  299.  
  300.  . Server-side Kermit Server (SKS)
  301.  . Client-side Kermit Server (CKS)
  302.  . No Kermit Server (NKS)
  303.  
  304. Different procedures and functions apply to each configuration.  The
  305. configuration may be changed at any time by Telnet Kermit Option
  306. subnegotiations, which assure that the Telnet client and server are
  307. always in compatible states.
  308.  
  309. The three configurations are described in the following sections.
  310.  
  311. 3.1. Server-Side Kermit Server
  312.  
  313. In the Server-Side Kermit Server (SKS) configuration, the Telnet server
  314. is the Kermit server and the Telnet client is the Kermit client.  This
  315. configuration is used when both Telnet client and IKS support the Telnet
  316. Kermit Option and the IKS sends WILL KERMIT to the Telnet client and
  317. receives DO KERMIT from the Telnet client [TKO].
  318.  
  319. In this case, the IKS immediately starts a Kermit server and reports
  320. this to the Telnet client with a Telnet KERMIT START-SERVER
  321. subnegotiation.
  322.  
  323. The SKS configuration is appropriate when the user wishes to interact
  324. only with the Telnet client's commands or menus.
  325.  
  326. If authentication was not performed with one of the Telnet
  327. Authentication Option protocols, the Kermit server rejects all Kermit
  328. protocol operations (except REMOTE LOGIN, REMOTE HELP, REMOTE EXIT, BYE,
  329. or FINISH -- that is, the ones that request help, that log in, that
  330. close the connection, or that change the status of the connection)
  331. until:
  332.  
  333.  . A Kermit REMOTE LOGIN command successfully authenticates the user;
  334.  
  335.  . The login retry limit is reached;
  336.  
  337.  . A Kermit BYE or REMOTE EXIT command is received, which closes
  338.    the connection;
  339.  
  340.  . A Kermit FINISH command or a Telnet KERMIT REQ-KERMIT-STOP
  341.    subnegotiation is received to request the IKS exit from Kermit
  342.    server mode.  At this point, the IKS can either exit and close
  343.    the connection or issue an interactive login prompt, depending
  344.    on how it was started or configured by the system administrator.
  345.  
  346. Once the user is authenticated:
  347.  
  348.  . The Telnet client configures itself for Kermit client/server
  349.    operation, with itself as the Kermit client, communicating with the
  350.    server only by Kermit packets, and optionally adjusting its menus or
  351.    commands to eliminate functions (such as terminal emulation) that
  352.    make no sense in this context.
  353.  
  354.  . The relationship persists until the Telnet client and IKS agree to
  355.    terminate the Kermit server via Kermit protocol commands (BYE,
  356.    FINISH, or REMOTE EXIT), or by Telnet Kermit Option subnegotiation,
  357.    or by closing the connection.
  358.  
  359. 3.2. Client-Side Kermit Server
  360.  
  361. In the Client-Side Kermit Server (CKS) configuration, the Telnet server
  362. is the Kermit client, and the Telnet client is the Kermit server.  This
  363. configuration is used when the IKS has sent WONT KERMIT or SB KERMIT
  364. STOP-SERVER, and the Telnet Client has sent WILL KERMIT and SB KERMIT
  365. START-SERVER, indicating that it is prepared to accept and process
  366. Kermit protocol packets.
  367.  
  368. In the CKS configuration, the Telnet client assumes the role of Kermit
  369. server by virtue of its ability to recognize and process Kermit protocol
  370. packets in its terminal emulator.  Thus the Telnet client must not send
  371. WILL KERMIT or the KERMIT START-SERVER subnegotiation unless its
  372. terminal emulator is capable of recognizing Kermit packets.
  373.  
  374. If the IKS is at top command level (as opposed to executing a script),
  375. or when it reaches top level after finishing a script, it issues its
  376. interactive command prompt.
  377.  
  378. At the point, the user may type commands or send scripted commands to
  379. the IKS command prompt.  When a data-transfer command (such as SEND) is
  380. issued by the user at the IKS prompt, a Kermit packet is transmitted and
  381. recognized by the Telnet client, causing it to automatically perform the
  382. requested action (e.g. receive a file), and then resume its previous
  383. mode (terminal emulation or script execution) when the data transfer is
  384. complete.
  385.  
  386. Thus, in the CKS configuration, data transfers are initiated by the IKS
  387. rather than by the Telnet client.  This configuration is useful when the
  388. user prefers the command interface or repertoire of the server to that
  389. of the client.
  390.  
  391. If the IKS sends a Telnet KERMIT START-SERVER subnegotiation, the
  392. relationship switches automatically to Server-Side Kermit Server
  393. (Section 3.1), in which the Telnet client is the Kermit client and the
  394. Telnet server is the Kermit server.
  395.  
  396. If the Telnet client sends a KERMIT STOP-SERVER subnegotiation, the
  397. connection switches to No Kermit Server (Section 3.3) and the IKS issues
  398. its command prompt.  At this point, neither side is a Kermit server, and
  399. both sides may optionally disable Kermit protocol commands.  Subsequent
  400. user action can designate one side or the other as the Kermit server, as
  401. desired.
  402.  
  403. 3.3. No Kermit Server
  404.  
  405. If both Telnet client and IKS send WONT KERMIT or SB KERMIT STOP-SERVER,
  406. or if the Kermit client and server are connected across multiple hosts
  407. or transports, thus precluding end-to-end Telnet negotiation, a Kermit
  408. server is not known to be available.  In the KERMIT STOP-SERVER case,
  409. the Kermit partners can later switch back to SKS or CKS, but in the
  410. other two cases, there is no such signaling and loose coupling
  411. characterizes the entire session.
  412.  
  413. In the No Kermit Server (NKS) configuration, the IKS presents a command
  414. prompt to the Telnet client.  As in the Client-Side Kermit Server
  415. configuration, plain-text commands are issued to the IKS.
  416.  
  417. In the loosely coupled NKS configuration, the Telnet client does not
  418. know the state of the Telnet server, and so can not automatically adjust
  419. its commands and menus to present only valid choices, or automatically
  420. change its state to complement the server's; it is the user's
  421. responsibility to assure that the "mode" (command prompt, terminal
  422. emulation, server command wait) of each Kermit partner is appropriate
  423. for each action.  Thus an Internet Kermit Server appears as an ordinary
  424. remote Kermit program to any Telnet client that does not implement the
  425. Telnet Kermit Option, or in which this feature is disabled or can not be
  426. used.
  427.  
  428. The NKS configuration allows successful manual operation of the IKS
  429. through Telnet clients that do not support the Telnet Kermit Option.
  430. The Telnet client might or might not support Kermit "autodownload" and
  431. "autoupload"; if it does not, then the user is forced to "escape back"
  432. and re-CONNECT in the traditional and familiar manner [CKB,CMG,K95].
  433.  
  434. 4. AUTHENTICATION
  435.  
  436. Authentication is provided in one of two ways:
  437.  
  438.  . The Telnet AUTHENTICATION option;
  439.  
  440.  . Plaintext userid/password verification.
  441.  
  442. 4.1. Telnet Authentication
  443.  
  444. The use of one of the many Telnet authentication protocols removes the
  445. need to transmit passwords in plaintext across public networks.  In
  446. addition, the exchange of authentication information often provides a
  447. shared secret that can be used with the experimental Telnet Encryption
  448. Option protocols to encrypt the connection in one or both directions.
  449.  
  450. 4.2. Plaintext Authentication via Kermit REMOTE LOGIN
  451.  
  452. In the Server-Side Kermit Server configuration, if the client is not yet
  453. authenticated, the client must log in using a REMOTE LOGIN command, in
  454. which a Kermit packet containing user ID and password in clear text is
  455. sent from the Telnet client to the Telnet server, which then calls upon
  456. local mechanisms to authenticate the user.  Any packets other than login
  457. (or REMOTE HELP, REMOTE EXIT, FINISH, or BYE) packets are rejected
  458. (returned with an error message) until the user is authenticated.  If
  459. the number of unsuccessful login attempts exceeds the limit, the
  460. connection is closed.  Many Kermit client programs support this login
  461. method already.
  462.  
  463. 4.3. Plaintext Authentication via Command Prompt
  464.  
  465. In the Client-Side Kermit Server and No Kermit Server configurations,
  466. the server presents the user with a plain-text interactive interface
  467. that begins with the server issuing "Username:" and "Password:" prompts,
  468. just as if the user were logging in to a multiuser timesharing system
  469. such as VMS or UNIX.  When a password is not required an empty response
  470. can be given.  Invalid username-password combinations result in a new
  471. series of prompts up to the login retry limit, and then disconnection.
  472.  
  473. 4.4. Anonymous Login
  474.  
  475. When the username is "anonymous" or "ftp", the IKS behaves like an
  476. anonymous ftp server, in a manner appropriate to the underlying
  477. platform.  In UNIX, for example, access is restricted to a designated
  478. area of the file system.  A password might or might not be required,
  479. according to the preference of the site administrator.
  480.  
  481. 5. SERVICES
  482.  
  483. The Internet Kermit Service includes features for both users and system
  484. administrators.  The prototype IKS is incorporated into a new release of
  485. Columbia University's C-Kermit software, which is the "master" Kermit
  486. software program in terms of features and command language.  An overview
  487. of C-Kermit can be found at:
  488.  
  489.   http://www.columbia.edu/kermit/ckermit.html
  490.  
  491. (At some point during the lifetime of this draft, an IKS will be
  492. deployed at Columbia University for worldwide public access to the
  493. Kermit FTP site.)
  494.  
  495. When C-Kermit is employed as an Internet Kermit Service, it may offer
  496. all its functions to "real" users (those who are authenticated as
  497. specific users), and a safe subset of its functions to anonymous users.
  498.  
  499. The Internet Kermit Service resembles an FTP server in that it performs
  500. its own authentication and uses a well-defined protocol to communicate
  501. with its client, but differs from the FTP server by also offering (at
  502. the system manager's discretion) an interactive user interface to the
  503. Telnet client when it is in terminal mode.  It also differs from FTP in
  504. restricting all protocol messages and data transfer to a single socket
  505. connection.
  506.  
  507. 5.1. Features for System Administrators
  508.  
  509. The system administrator can supply IKS configuration parameters as
  510. command-line options or in a configuration file, or both in combination.
  511. Such parameters include:
  512.  
  513.  . Whether anonymous logins are allowed.
  514.  
  515.  . The file system or root directory to which anonymous users are
  516.    restricted.
  517.  
  518.  . Specification of permissions and other attributes to be assigned to
  519.    files uploaded by anonymous users.
  520.  
  521.  . Whether to make session entries in system logs.
  522.  
  523.  . Specific services to disable: reception of files, sending of files,
  524.    sending of email, printing, changing of directories, getting
  525.    directory listings, deleting files, etc (see next section).
  526.  
  527.  . Whether access to the interactive command prompt is allowed.
  528.  
  529. 5.2. Features for Users
  530.  
  531. The IKS supports a wide range of services, including, but not limited
  532. to, the following:
  533.  
  534.  . Authentication as a real user or anonymously.
  535.  
  536.  . Transmission of files to which read access is allowed.
  537.  
  538.  . Reception of files into directories or devices to which write access
  539.    is allowed.
  540.  
  541.  . The ability to display a file on the client's screen.
  542.  
  543.  . Ability to list files.
  544.  
  545.  . Ability to change its working (default) directory.
  546.  
  547.  . Ability to delete files to which write or delete access is allowed.
  548.  
  549.  . Ability to rename and copy files
  550.  
  551.  . Ability to create and remove directories.
  552.  
  553.  . The ability to route received files to a specified printer, or to
  554.    send them as email to a specified address list.
  555.  
  556.  . Client control of server parameter settings, within limits
  557.    established by the server system administrator.
  558.  
  559.  . Transmission of variables from client to server or vice versa.
  560.  
  561.  . Remote and local script execution.
  562.  
  563.  . Remote and local procedure execution.
  564.  
  565. File transfer features include:
  566.  
  567.  . Kermit text-mode transfers incorporate not only record-format
  568.    conversion, but also character-set translation;
  569.  
  570.  . Kermit can switch automatically between text and binary mode on a
  571.    per-file basis when sending groups of files by matching each file's
  572.    name with a pattern list.
  573.  
  574.  . A selection of file collision options, including "make backup copy
  575.    of existing file and accept incoming file", "reject incoming file",
  576.    "accept incoming file only if newer than existing file", etc.
  577.  
  578.  . Numerous methods for selecting the files to be transferred, including
  579.    pattern matching, lists of filenames (or patterns), exception lists,
  580.    date and/or size ranges, etc.
  581.  
  582.  . Filename conversion and file renaming.
  583.  
  584.  . Automatic directory creation if elected and enabled.
  585.  
  586.  . Standard mechanisms for directory traversal, allowing transmission of
  587.    entire directory trees or other file hierarchies even between unlike
  588.    file systems such as VMS, UNIX, and Windows.
  589.  
  590.  . Atomic file movement: optionally, the source file can be deleted
  591.    (or renamed, or moved) when and only when it has been transferred
  592.    successfully.
  593.  
  594.  . Kermit can retain file attributes including time stamps and
  595.    permissions (at the user's or system administrator's discretion),
  596.    even between unlike platforms;
  597.  
  598.  . Recovery of interrupted transfers from the point of failure.
  599.  
  600.  . File-transfer pipes and filters.
  601.  
  602. Script programming features include:
  603.  
  604.  . Macros with parameter substitution.
  605.  
  606.  . Built-in and user-defined variables and arrays, with global
  607.    or local scope.
  608.  
  609.  . Built-in and user-defined functions.  Built-in functions include:
  610.     - String functions
  611.     - Arithmetic functions
  612.     - Date / time functions
  613.     - File functions
  614.  
  615.  . Input search for multiple simultaneous targets.
  616.  
  617.  . IF-ELSE, WHILE, FOR, SWITCH, GOTO, C-like block structure.
  618.  
  619.  . Every command returns a completion status that may be tested
  620.    and used as a basis for subsequent actions.
  621.  
  622. 5.3. User Interface
  623.  
  624. The Internet Kermit Service uses the Kermit command and script language,
  625. as implemented in Columbia University's C-Kermit communication software
  626. [CKB].  This program and its command language are portable to all known
  627. varieties of UNIX, as well as to Windows 95/98/NT, OS/2, Digital
  628. (Open)VMS, Stratus VOS, Data General AOS/VS, Plan 9, OS-9, QNX, the
  629. Commodore Amiga, and other platforms.  The C-Kermit command language is
  630. a superset of that of other Kermit software programs including MS-DOS
  631. Kermit for DOS and Windows 3.x, IBM Mainframe Kermit for VM/CMS,
  632. MVS/TSO, CICS, and MUSIC, PDP-11 Kermit for RT-11, RSTS/E, RSX-11, and
  633. IAS, and dozens of other Kermit programs.
  634.  
  635. It is far beyond the scope of this document to enumerate, let alone
  636. describe, the commands and services of C-Kermit; this is the subject of
  637. a 600-page book [CKB], augmented by hundreds of pages of online
  638. material.  A brief overview is included here.
  639.  
  640. Commands are based on English words.  There is no plan at present to
  641. support other natural languages (Italian, Portuguese, Norwegian,
  642. Russian, Hebrew, Japanese, Cherokee, etc) as alternative bases for
  643. command words, since this would reduce the portability of scripts.
  644. However, since the command language includes a macro capability, macros
  645. may be defined to provide selected commands in different languages if
  646. desired.
  647.  
  648. Certain commands can apply either locally or remotely, for example "CD"
  649. (Change Directory).  The convention is to prefix the command with the
  650. word REMOTE if it is to apply remotely.  Example: "cd foo" changes to
  651. the "foo" directory on the computer where the command was given; "remote
  652. cd foo" sends a Kermit packet to the Kermit server requesting it to
  653. change its directory to "foo".  The commands in this category include:
  654.  
  655.   ASSIGN <variable> <value>      Assign a value to a variable.
  656.   CD <directory>                 Change working directory.
  657.   COPY <files> <destination>     Copy file(s)
  658.   DELETE <files>                 Delete file(s)
  659.   DIRECTORY [ <pattern> ]        List file(s)
  660.   EXIT                           Exit
  661.   HELP [ <topic-or-command> ]    Display help text
  662.   MKDIR <directory>              Create a directory
  663.   PRINT <files>                  Print file(s)
  664.   PWD                            Print working directory
  665.   RENAME <old> <new>             Rename file(s)
  666.   RMDIR <directory>              Remove a directory
  667.   SET <parameter> <value>        Change a parameter's value
  668.   TYPE <file>                    Display the contents of a file
  669.  
  670. As a convenience, REMOTE commands also have short synonyms: RASSIGN,
  671. RCD, RCOPY, RDELETE, and so forth.
  672.  
  673. The basic file transfer commands are:
  674.  
  675.   SEND [ modifiers ] <files>    Send file(s) (to server)
  676.   GET [ modifiers ] <files>     Get file(s) (from server)
  677.  
  678. These commands take a file name, pattern, or list, plus various optional
  679. modifiers, including transfer mode specifiers (text, binary), file
  680. selectors (date, size, exception list), aliasing, name and path options,
  681. disposition specifiers, and so on.
  682.  
  683. In addition to the commands listed above, the following commands are
  684. sent by the client to the server:
  685.  
  686.   REMOTE QUERY                   Get value of variable or procedure
  687.   BYE                            Log out and close the connection
  688.   FINISH                         Request the server leave server mode
  689.  
  690. Like all Kermit client/server commands, these can be disabled if
  691. desired.
  692.  
  693. Of course there are numerous other commands with purely local effect,
  694. such as the many scripting commands.  These, plus all the commands
  695. above, are fully documented in [CKB].  The repertoire grows over time,
  696. but never in a way that invalidates existing scripts.
  697.  
  698. The system administrator can allow or forbid access to any of these
  699. features, and to the command language as a whole.  In the latter case,
  700. the IKS may be accessed only as a Kermit server, by giving commands to
  701. the client.
  702.  
  703.  
  704. 6. REFERENCES
  705.  
  706. [TKO] Altman, Jeffrey E., and Frank da Cruz,
  707.       Telnet Kermit Option,
  708.       Internet Draft <draft-altman-telnet-kermit-server-00.txt>,
  709.       August 1998.
  710.  
  711. [BCP] Bradner, Scott, RFC 2119, "Best Current Practice", March 1997.
  712.  
  713. [KER] da Cruz, Frank, "Kermit, A File Transfer Protocol", Digital Press/
  714.       Butterworth Heinemann, Newton, MA (1987).  379 pages,
  715.       ISBN 0-932376-88-6.
  716.  
  717. [CKB] da Cruz, Frank, and Christine M. Gianone, "Using C-Kermit", Second
  718.       Edition, Digital Press / Butterworth-Heinemann, Woburn, MA (1997).
  719.       622 pages, ISBN 1-55558-164-1.
  720.  
  721. [CMG] Gianone, Christine M., "Using MS-DOS Kermit", Second Edition,
  722.       Digital Press / Butterworth-Heinemann, Woburn, MA (1992). 345
  723.       pages, ISBN 1-55558-082-3.
  724.  
  725. [K95] Gianone, Christine M., and Frank da Cruz, "Kermit 95", Manning
  726.       Publications, Greenwich CT, (1996). 88 pages, ISBN 1-884777-14-7.
  727.  
  728. [PRF] Huggins, James K., "Kermit Protocol - Formal Specification and
  729.       Verification", in Boerger, E., "Specification and Validation
  730.       Methods", Oxford University Press (1995).  ISBN 0-19-853854-5.
  731.  
  732. [FTP] Postel, J., and J. Reynolds, "File Transfer Protocol (FTP)",
  733.       RFC959, October 1985.
  734.  
  735. [TEL] Postel, J., and J. Reynolds, "Telnet Protocol Specification",
  736.       RFC854, May 1983, et seq.
  737.  
  738. [IAN] Internet Assigned Numbers Authority:
  739.       http://www.iana.org/numbers.html
  740.       http://www.iana.org/assignment/port-numbers
  741.  
  742.  
  743. 7. AUTHORS' ADDRESS
  744.  
  745. Frank da Cruz
  746. fdc@columbia.edu
  747.  
  748. Jeffrey E. Altman
  749. jaltman@columbia.edu
  750.  
  751. The Kermit Project
  752. Columbia University
  753. 612 West 115th Street
  754. New York NY 10025-7799
  755. USA
  756. http://www.columbia.edu/kermit/
  757.  
  758. (end)
  759.