KERMIT PROTOCOL MANUAL KERMIT PROTOCOL MANUAL KERMIT PROTOCOL MANUAL _____ _______ Fifth Edition Frank da Cruz Columbia University Center for Computing Activities New York, New York 10027 3 April 1984 Copyright (C) 1981,1982,1983,1984 Trustees of Columbia University in the City of New York __________ __ _______ __ ___ __________ __ ___________ __ ____ __ Permission is granted to any individual or institution to copy or ___ ____ ________ ___ ___ ________ _________ __ __ ______ ___ use this document and the programs described in it, except for __________ __________ ________ explicitly commercial purposes. Preface to the Fourth Edition Preface to the Fourth Edition Preface to the Fourth Edition Page 1 Preface to the Fourth Edition Preface to the Fourth Edition Preface to the Fourth Edition The fourth edition (November 1983) of the KERMIT Protocol Manual incorporates some new ideas that grew from our experience in attempting to implement some of the features described in earlier editions, particularly user/server functions. These include a mechanism to allow batch transfers to be interrupted gracefully for either the current file or the entire batch of files; a "capability mask"; a protocol extension for passing file attributes. In addition, numbers are now written in decimal notation rather than octal, which was confusing to many readers. Also, several incompatible changes were made in minor areas where no attempts at an implementation had yet been made; these include: - The format and interpretation of the operands to the server commands. - Usurpation of the reserved fields 10-11 of the Send-Init packet, and addition of new reserved fields. Most of the remaining material has been rewritten and reorganized, and much new material added, including a section on the recommended vocabulary for documen- tation and commands. The previous edition of the Protocol Manual attempted to define "protocol ver- sion 3"; this edition abandons that concept. Since KERMIT development is an unorganized, disorderly, distributed enterprise, no requirement can be imposed on KERMIT implementors to include a certain set of capabilities in their im- plementations. Rather, in this edition we attempt to define the basic functionality of KERMIT, and then describe various optional functions. The key principle is that any implementation of KERMIT should work with any other, no matter how advanced the one or how primitive the other. The capabily mask and other Send-Init fields attempt to promote this principle. FIFTH EDITION FIFTH EDITION FIFTH EDITION The fifth edition (March 1984) attempts to clarify some fine points that had been left ambiguous in the 4th edition, particularly with respect to when and how prefix encoding is done, and when it is not, and about switching between block check types. A mechanism is suggested (in the Attributes section) for file archiving, and several attributes have been rearranged and some others ad- ded (this should do no harm, since no one to date has attempted to implement the attributes packet). A more complete protocol state table is provided, a few minor additions are made to the collection of packet types. Preface to the Fourth Edition Preface to the Fourth Edition Preface to the Fourth Edition Page 2 A FEW WORDS... A FEW WORDS... A FEW WORDS... Before deciding to write a new version of KERMIT, please bear in mind that the philosophy of KERMIT has always been that is not, and never should become, a commercial product, sold for profit. Its goal is to promote communication and sharing, and KERMIT itself should be freely shared, and not sold. Media and reproduction costs may be recouped if desired, but profit should not be the mo- tive. Vendors of commercial software, however, may request permission to in- clude KERMIT with, or in, their programs provided certain conditions are met, including that credit for the protocol be given to Columbia and that the price of the product not be raised substantially beyond media and reproduction costs for inclusion of KERMIT. Contact the KERMIT group at Columbia if you have any questions about this. Prospective KERMIT implementors should check with us in any case, to be sure that someone else has not already done, or started to do, the same thing you propose to do. KERMIT is distributed from Columbia University on magnetic tape. Complete or- ______ _____ _____ dering instructions can be found in the Kermit Users Guide. Direct inquiries about KERMIT to: KERMIT Distribution Columbia University Center for Computing Activities 7th Floor, Watson Laboratory 612 West 115th Street New York, NY 10025 ACKNOWLEDGEMENTS ACKNOWLEDGEMENTS ACKNOWLEDGEMENTS Bill Catchings and I designed the basic KERMIT protocol at Columbia University in 1981. For ideas, we looked at some of the ANSI models (X3.57, X3.66), the ISO OSI model, some real-world "asynchronous protocols" (including the Stanford Dialnet project, the University of Utah TTYFTP project), as well as at file transfer on full-blown networks like DECnet and ARPAnet. Bill wrote the first two programs to implement the protocol, one for the DEC-20, one for a CP/M-80 microcomputer, and in the process worked out most of the details and heuristics required for basic file transfer. Meanwhile, Daphne Tzoar and Vace Kundakci, also of Columbia, worked out the additional details necessary for IBM mainframe communication. Much credit should also go to Bernie Eiben of Digital Equipment Corporation for promoting widespread use of KERMIT and for adding many insights into how it should operate, and to Nick Bush and Bob McQueen of Stevens Institute of Tech- nology, for many contributions to the "advanced" parts of the protocol, and for several major KERMIT implementations. Thanks to the many people all over the world who have contributed new KERMIT Preface to the Fourth Edition Preface to the Fourth Edition Preface to the Fourth Edition Page 3 implementations, who have helped with KERMIT distribution through various user groups, and who have contributed to the quality of the protocol and its many implementations by reporting or fixing problems, criticizing the design, or suggesting new features. DISCLAIMER DISCLAIMER DISCLAIMER __ ________ __ ___ ________ ___ __ ___ ________ __ ___ _____________ ________ No warranty of the software nor of the accuracy of the documentation surround- ___ __ __ _________ __ _______ ___ _______ ___ _______ ___ ________ __________ ing it is expressed or implied, and neither the authors nor Columbia University ___________ ___ _________ _________ ____ _______ __ _____________ ______ acknowledge any liability resulting from program or documentation errors. Introduction Introduction Introduction Page 4 CHAPTER 1 CHAPTER 1 CHAPTER 1 INTRODUCTION INTRODUCTION INTRODUCTION This manual describes the KERMIT protocol. It is assumed that you understand the purpose and operation of the Kermit file transfer facility, described in ______ _____ _____ the Kermit Users Guide, and basic terminology of data communications and com- puter programming. 1.1. Background 1.1. Background 1.1. Background The KERMIT file transfer protocol is intended for use in an environment where there may be a diverse mixture of computers -- micros, personal computers, workstations, laboratory computers, timesharing systems -- from a variety of manufacturers. All these systems need have in common is the ability to com- municate in ASCII over ordinary serial telecommunication lines. KERMIT was originally designed at Columbia University to meet the need for file transfer between our DECSYSTEM-20 and IBM 370-series mainframes and various microcomputers. It turned out that the diverse characteristics of these three kinds of systems resulted in a design that was general enough to fit almost any system. The IBM mainframe, in particular, strains most common assumptions about how computers communicate. 1.2. Overview 1.2. Overview 1.2. Overview The KERMIT protocol is specifically designed for character-oriented transmis- sion over serial telecommunication lines. The design allows for the restric- tions and peculiarities of the medium and the requirements of diverse operating environments -- buffering, duplex, parity, character set, file organization, etc. The protocol is carried out by KERMIT programs on each end of the serial connection sending "packets" back and forth; the sender sends file names, file contents, and control information; the receiver acknowledges (positively or negatively) each packet. The packets have a layered design, more or less in keeping with the ANSI and ISO philosophies, with the outermost fields used by the data link layer to verify data integrity, the next by the session layer to verify continuity, and the data itself at the application level. Connections between systems are established by the ordinary user. In a typical case, the user runs KERMIT on a microcomputer, enters terminal emulation, con- nects to a remote host computer (perhaps by dialing up), logs in, runs KERMIT on the remote host, and then issues commands to that KERMIT to start a file transfer, "escapes" back to the micro, and issues commands to that KERMIT to start its side of the file transfer. Files may be transferred singly or in groups. __________ Basic KERMIT provides only file transfer, and that is provided for sequential _____ ____ files only, though the protocol attempts to allow for various types of sequen- tial files. Microcomputer implementations of KERMIT are also expected to Introduction Introduction Introduction Page 5 provide terminal emulation, to facilitate the initial connection. More advanced implementations simplify the "user interface" somewhat by allow- ing the KERMIT on the remote host to run as a "server", which can transfer files in either direction upon command from the local "user" Kermit. The serv- er can also provide additional functionality, such as file management, mes- sages, mail, and so forth. Other optional features also exist, including a variety of block check types, a mechanism for passing 8-bit data through a 7-bit communication link, a way to compressing a repeated sequence of charac- ters, and so forth. As local area networks become more popular, inexpensive, and standardized, the demand for KERMIT and similar protocols may dwindle, but will never wither away entirely. Unlike hardwired networks, KERMIT gives the ordinary user the power ___ ___ to establish reliable error-free connections between any two computers; this may always be necessary for one-shot or long-haul connections. Definitions Definitions Definitions Page 6 CHAPTER 2 CHAPTER 2 CHAPTER 2 DEFINITIONS DEFINITIONS DEFINITIONS 2.1. General Terminology 2.1. General Terminology 2.1. General Terminology ___ TTY: This is the term commonly used for a device which is connected to a com- puter over an EIA RS-232 serial telecommunication line. This device is most commonly an ASCII terminal, but it may be a microcomputer or even a large multi-user computer emulating an ASCII terminal. Most computers provide hardware (RS-232 connectors and UARTs) and software (device drivers) to support TTY connections; this is what makes TTY-oriented file transfer protocols like KERMIT possible on almost any system at little or no cost. _____ LOCAL: When two machines are connected, the LOCAL machine is the one which you interact with directly, and which is in control of the terminal. The "local Kermit" is the one that runs on the local machine. A local Kermit always com- municates over an external device (the micro's communication port, an assigned TTY line, etc). ______ REMOTE: The REMOTE machine is the one on the far side of the connection, which you must interact with "through" the local machine. The "remote Kermit" runs on the remote machine. A remote Kermit usually communicates over its own "console", "controlling terminal", or "standard i/o" device. ____ HOST: Another word for "computer", usually meaning a computer that can provide a home for multiple users or applications. This term should be avoided in KER- MIT lore, unless preceded immediately by LOCAL or REMOTE, to denote which host is meant. ______ SERVER: An implementation of remote Kermit that can accept commands in packet form from a local Kermit program, instead of directly from the user. ____ USER: In addition to its usual use to denote the person using a system or program, "user" will also be used refer to the local Kermit program, when the remote Kermit is a server. 2.2. Numbers 2.2. Numbers 2.2. Numbers _______ All numbers in the following text are expressed in decimal (base 10) notation unless otherwise specified. Numbers are also referred to in terms of their bit positions in a computer word. Since KERMIT may be implemented on computers with various word sizes, we start numbering the bits from the "right" -- bit 0 is the least significant. Bits 0-5 are the 6 least significant bits; if they were all set to one, the value would be 63. A special quirk in terminology, however, refers to the high order bit of a character as it is transmitted on the communication line, as the "8th bit". More properly, it is bit 7, since we start counting from 0. References to the Definitions Definitions Definitions Page 7 "8th bit" generally are with regard to that bit which ASCII transmission sets aside for use as a parity bit. KERMIT concerns itself with whether this bit can be usurped for the transmission of data, and if not, it may resort to "8th-bit prefixing". 2.3. Character Set 2.3. Character Set 2.3. Character Set __________ All characters are in ASCII (American national Standard Code for Information Interchange) representation, ANSI standard X3.4-1968. All implementations of KERMIT transmit and receive characters only in ASCII. The ASCII character set is listed in Appendix V. _____ _________ __________ ASCII_character_mnemonics: NUL Null, idle, ASCII character 0. SOH Start-of-header, ASCII character 1 (Control-A). SP Space, blank, ASCII 32. CR Carriage return, ASCII 13 (Control-M). LF Linefeed, ASCII 10 (Control-J). CRLF A carriage-return linefeed sequence. DEL Delete, rubout, ASCII 127. _______ _________ A control_character is considered to be any byte whose low order 7 bits are in the range 0 through 31, or equal to 127. In this document, control characters are written in several ways: Control-A This denotes ASCII character 1, commonly referred to as "Control-A". Control-B is ASCII character 2, and so forth. CTRL-A This is a common abbreviation for "Control-A". A control character is generally typed at a computer terminal by holding down the key marked CTRL and pressing the corresponding alphabetic character, in this case "A". ^A "Uparrow" notation for CTRL-A. Many computer systems "echo" control characters in this fashion. _________ _____ _________ A printable_ASCII_character is considered to be any character in the range 32 (SP) through 126 (tilde). 2.4. Conversion Functions 2.4. Conversion Functions 2.4. Conversion Functions Several conversion functions are useful in the description of the protocol and in the program example. The machine that Kermit runs on need operate only on integer data; these are functions that operate upon the numeric value of single ASCII characters. _ char(x) = x+32 Transforms the integer x, which is assumed to lie in the range 0 to 94, into a printable ASCII character; 0 becomes SP, 1 be- Definitions Definitions Definitions Page 8 comes "!", 3 becomes "#", etc. unchar(x) = x-32 _ Transforms the character x, which is assumed to be in the printable range (SP through tilde), into an integer in the range 0 to 94. ctl(x) = x XOR 64 Maps between control characters and their printable represen- _ tations, preserving the high-order bit. If x is a control character, then x = ctl(ctl(x)) that is, the same function is used to controllify and uncon- trollify. The argument is assumed to be a true control charac- ter (0 to 31, or 127), or the result of applying CTL to a true control character (i.e. 63 to 95). The transformation is a mnemonic one -- ^A becomes A and vice versa. 2.5. Protocol Jargon 2.5. Protocol Jargon 2.5. Protocol Jargon ______ A Packet is a clearly delimited string of characters, comprised of "control fields" nested around data; the control fields allow a KERMIT program to deter- mine whether the data has been transmitted correctly and completely. A packet is the unit of transmission in the KERMIT protocol. ___ ACK stands for "Acknowledge". An ACK is a packet that is sent to acknowledge receipt of another packet. Not to be confused with the ASCII character ACK. ___ NAK stands for "Negative Acknowledge". A NAK is a packet sent to say that a corrupted or incomplete packet was received, the wrong packet was received, or an expected packet was not received. Not to be confused with the ASCII charac- ter NAK. _______ A timeout is an event that can occur if expected data does not arrive within a specified amount of time. The program generating the input request can set a "timer interrupt" to break it out of a nonresponsive read, so that recovery procedures may be activated. System Requirements System Requirements System Requirements Page 9 CHAPTER 3 CHAPTER 3 CHAPTER 3 SYSTEM REQUIREMENTS SYSTEM REQUIREMENTS SYSTEM REQUIREMENTS The KERMIT protocol requires that: - The host can send and receive characters using 7- or 8-bit ASCII en- coding over an EIA RS-232 physical connection, either hardwired or dialup. - All printable ASCII characters are acceptable as input to the host 1 and will not be transformed in any way . Similarly, any intervening network or communications equipment ("smart modems", TELENET, ter- minal concentrators, port selectors, etc) must not transform or swal- low any printable ASCII characters. _______ _________ - A single ASCII control character can pass from one system to the other without transformation. This character is used for packet synchronization. The character is normally Control-A (SOH, ASCII 1), but can be redefined. - If a host requires a line terminator for terminal input, that ter- minator must be a single ASCII control character, such as CR or LF, distinct from the packet synchronization character. - When using a job's controlling terminal for file transfer, the system must allow the KERMIT program to set the terminal to no echo, in- finite width (no "wraparound" or CRLF insertion by the operating system), and no "formatting" of incoming or outgoing characters (for instance, raising lowercase letters to uppercase, transforming con- trol characters to printable sequences, etc). In short, the terminal must be put in "binary" or "raw" mode, and, hopefully, restored af- terwards to normal operation. - The host's terminal input processor should be capable of receiving a single burst of 40 to 100 characters at normal transmission speeds. This is the typical size of packet. Note that most of these requirements rule out the use of KERMIT through IBM 3270 / ASCII protocol converters. ___ KERMIT does not require: - That the connection run at any particular baud rate. _______________ 1 If they are translated to another character set, like EBCDIC, the KERMIT program must be able to reconstruct the packet as it appeared on the communication line, before transformation. System Requirements System Requirements System Requirements Page 10 - That the system can do XON/XOFF or any other kind of flow control. System- or hardware-level flow control can help, but it's not neces- sary. See section 5.7. - That the system is capable of full duplex operation. Any mixture of half and full duplex systems is supported. - That the system can transmit or receive 8-bit bytes. KERMIT will take advantage of 8-bit connections to send binary files; if an 8-bit connection is not possible, then binary files may be sent using an optional prefix encoding. Printable Text versus Binary Data Printable Text versus Binary Data Printable Text versus Binary Data Page 11 CHAPTER 4 CHAPTER 4 CHAPTER 4 PRINTABLE TEXT VERSUS BINARY DATA PRINTABLE TEXT VERSUS BINARY DATA PRINTABLE TEXT VERSUS BINARY DATA For transmission between unlike systems, files must be assigned to either of _________ ____ ______ two catagories: printable text or binary. A printable text file is one that can make sense on an unlike system -- a docu- ment, program source, textual data, etc. A binary file is one that will not (and probably can not) make sense on an unlike system -- an executable program, numbers stored in internal format, etc. On systems with 8-bit bytes, printable 2 ASCII files will have the high order bit of each byte set to zero (since ASCII is a 7-bit code) whereas binary files will use the high order bit of each byte for data, in which case its value can vary from byte to byte. Many computers have no way to distinguish a printable file from a binary file -- especially one originating from an unlike system -- so the user may have to give an explicit command to Kermit to tell it whether to perform these conver- sions. 4.1. Printable Text Files 4.1. Printable Text Files 4.1. Printable Text Files A primary goal of KERMIT is for printable text files to be useful on the target system after transfer. This requires a standard representation for text during transmission. KERMIT's standard is simple: 7-bit ASCII characters, with "logical records" (lines) delimited by CRLFs. It is the responsibility of sys- tems that do not store printable files in this fashion to perform the necessary conversions upon input and output. For instance, IBM mainframes might strip trailing blanks on output and add them back on input; UNIX would prepend a CR to its normal record terminator, LF, upon output and discard it upon input. In addition, IBM mainframes must do EBCDIC/ASCII translation for text files. No other conversions (e.g. tab expansion) are performed upon text files. This representation is chosen because it corresponds to the way text files are stored on most microcomputers and on many other systems. In many common cases, no transformations are necessary at all. _______________ 2 There are some exceptions, such as systems that store text files in so- called "negative ASCII", or text files produced by word processors that use the high order bit to indicate underline or boldface attributes. Printable Text versus Binary Data Printable Text versus Binary Data Printable Text versus Binary Data Page 12 4.2. Binary Files 4.2. Binary Files 4.2. Binary Files Binary files are transmitted as though they were a sequence of characters. The difference from printable files is that the status of the "8th bit" must be preserved. When binary files are transmitted to an unlike system, the main ob- jective is that they can be brought back to the original system (or one like it) intact; no special conversions should be done during transmission, except to make the data fit the transmission medium. For binary files, eight bit character transmission is permissible as long as the two Kermit programs involved can control the value of the parity bit, and no intervening communications equipment will change its value. In that case, the 8th bit of a transmitted character will match that of the original data byte, after any control-prefixing has been done. When one or both sides cannot control the parity bit, a special prefix character may be inserted, as described below. Systems that do not store binary data in 8-bit bytes, or whose word size is not a multiple of 8, may make special provisions for "image mode" transfer of bi- nary files. This may be done within the basic protocol by having the two sides implicitly agree upon a scheme for packing the data into 7- or 8-bit ASCII characters, or else the more flexible (but optional) file attributes feature may be used. The former method is used on PDP-10 36-bit word machines, in which text is stored five 7-bit bytes per word; the value of the "odd bit" is sent as the parity bit of every 5th word. File Transfer File Transfer File Transfer Page 13 CHAPTER 5 CHAPTER 5 CHAPTER 5 FILE TRANSFER FILE TRANSFER FILE TRANSFER ___________ The file transfer protocol takes place over a transaction. A transaction is an exchange of packets beginning with a Send-Init (S) packet, and ending with a 3 Break Transmission (B) or Error (E) packet , and may include the transfer of one or more files, all in the same direction. In order to minimize the unfor- seen, KERMIT packets do not contain any control characters except one specially designated to mark the beginning of a packet. Except for the packet marker, only printable characters are transmitted. The following sequence charac- ______ terizes basic Kermit operation; the sender is the machine that is sending ________ files; the receiver is the machine receiving the files. 1. The sender transmits a Send-Initiate (S) packet to specify its parameters (packet length, timeout, etc; these are explained below). 2. The receiver sends an ACK (Y) packet, with its own parameters in the data field. 3. The sender transmits a File-Header (F) packet, which contains the file's name in the data field. The receiver ACKs the F packet, with no data in the data field of the ACK (optionally, it may contain the name under which the receiver will store the file). 4. The sender sends the contents of the file, in Data (D) packets. Any data not in the printable range is prefixed and replaced by a print- able equivalent. Each D packet is acknowledged before the next one is sent. 5. When all the file data has been sent, the sender sends an End-Of- File (Z) packet. The receiver ACKs it. 6. If there is another file to send, the process is repeated beginning at step 3. 7. When no more files remain to be sent, the sender transmits an End- Of-Transmission (B) packet. The receiver ACKs it. This ends the transaction, and closes the logical connection (the physical connec- tion remains open). ________ ______ Each packet has a sequence number, starting with 0 for the Send Init. The ack- nowledgment (ACK or NAK) for a packet has the same packet number as the packet being acknowledged. Once an acknowledgment is successfully received the packet number is increased by one, modulo 64. _______________ 3 A transaction should also be considered terminated when one side or the other has stopped without sending an Error packet. File Transfer File Transfer File Transfer Page 14 If the sender is remote, it waits for a certain amount of time (somewhere in the 5-30 second range) before transmitting the Send-Init, to give the user time to escape back to the local KERMIT and tell it to receive files. 5.1. Conditioning the Terminal 5.1. Conditioning the Terminal 5.1. Conditioning the Terminal KERMIT is most commonly run with the user sitting at a microcomputer, connected through a communications port to a remote timesharing system. The remote KER- MIT is using its job's own "controlling terminal" for file transfer. While the microcomputer's port is an ordinary device, a timesharing job's controlling terminal is a special one, and often performs many services that would inter- fere with normal operation of KERMIT. Such services include echoing (on full duplex systems), wrapping lines by inserting carriage return linefeed sequences at the terminal width, pausing at the end of a screen or page full of text, displaying system messages, alphabetic case conversion, control character in- tepretation, and so forth. Mainframe KERMIT programs should be prepared to disable as many of these services as possible before packet communication begins, and to restore them to their original condition at the end of a trans- action. Disabling these services is usually known as "putting the terminal in binary mode." KERMIT's use of printable control character equivalents, variable packet lengths, redefinable markers and prefixes, and allowance for any characters at all to appear between packets with no adverse effects provide a great deal of adaptability for those systems that do not allow certain (or any) of these fea- tures to be disabled. 5.2. Timeouts, NAKs, and Retries 5.2. Timeouts, NAKs, and Retries 5.2. Timeouts, NAKs, and Retries If a KERMIT program is capable of setting a timer interrupt, or setting a time limit on an input request, it should do so whenever attempting to read a packet from the communication line, whether sending or receiving files. Having read a packet, it should turn off the timer. If the sender times out waiting for an acknowledgement, it should send the same packet again, repeating the process a certain number of times up to a retry limit, or until an acknowledgement is received. If the receiver times out waiting for a packet, it can send either a NAK packet for the expected packet or another ACK for the last packet it got. If a packet from the sender is garbled or lost in transmission (the latter is detected when the sequence number increases by more than 1, modulo 64, the former by a bad checksum), the receiver sends a NAK for the garbled or missing packet. If an ACK or a NAK from the receiver is garbled or lost, the sender ignores it; in that case, one side or the other will time out and retransmit. A retry count is maintained, and there is a retry threshold, normally set around 5. Whenever a packet is resent -- because of a timeout, or because it was NAK'd -- the counter is incremented. When it reaches the threshold, the transaction is terminated and the counter reset. File Transfer File Transfer File Transfer Page 15 If neither side is capable of timing out, a facility for manual intervention must be available on the local KERMIT. Typically, this will work by sampling the keyboard (console) periodically; if input, such as a CR, appears, then the same action is taken as if a timeout had occurred. The local KERMIT keeps a running display of the packet number or byte count on the screen to allow the user to detect when traffic has stopped. At this point, manual intervention should break the deadlock. Shared systems which can become sluggish when heavily used should adjust their own timeout intervals on a per-packet basis, based on the system load, so that file transfers won't fail simply because the system was too slow. Normally, only one side should be doing timeouts, preferably the side with the greatest knowledge of the "environment" -- system load, baud rate, and so forth, so as to optimally adjust the timeout interval for each packet. If both sides are timing out, their intervals should differ sufficiently to prevent collisions. 5.3. Errors 5.3. Errors 5.3. Errors During file transfer, the sender may encounter an i/o error on the disk, or the receiver may attempt to write to a full or write-protected device. Any con- dition that will prevent successful transmission of the file is called a "fatal error". Fatal errors should be detected, and the transfer shut down grace- fully, with the pertinent information provided to the user. Error packets provide a mechanism to do this. If a fatal error takes place on either the sending or receiving side, the side which encountered the error should send an Error (E) packet. The E packet con- tains a brief textual error message in the data field. Both the sender and receiver should be prepared to receive an Error packet at any time during the transaction. Both the sender and receiver of the Error packet should halt, or go back into into user command mode (a server should return to server command wait). The side that is local should print the error message on the screen. There is no provision for sending nonfatal error messages, warnings, or infor- mation messages during a transaction. It would be possible to add such a fea- ture, but this would require both sides agree to use it through setting of a bit in the capability mask, since older KERMITs that did not know about such a feature would encounter an unexpected packet type and would enter the fatal er- ror state. In any case, the utility of such a feature is questionable, since there is no guarantee that the user will be present to see such messages at the time they are sent; even if they are saved up for later perusal in a "message box", their significance may be long past by the time the user reads them. See the section on Robustness, below. File Transfer File Transfer File Transfer Page 16 5.4. Heuristics 5.4. Heuristics 5.4. Heuristics During any transaction, several heuristics are useful: 1. A NAK for the current packet is equivalent to an ACK for the pre- vious packet (modulo 64). This handles the common situation in which a packet is successfully received, and then ACK'd, but the ACK is lost. The ACKing side then times out waiting for the next packet _ _ and NAKs it. The side that receives a NAK for packet n+1 while _ _ _ waiting for an ACK for packet n simply sends packet n+1. _ 2. If packet n arrives more than once, simply ACK it and discard it. This can happen when the first ACK was lost. Resending the ACK is ___ necessary and sufficient -- don't write the packet out to the file again! 3. When opening a connection, discard the contents of the line's input buffer before reading or sending the first packet. This is espe- cially important if the other side is in receive mode (or acting as a server), in which case it may have been sending out periodic NAKs for your expected SEND-INIT or command packet. If you don't do this, you may find that there are sufficient NAKs to prevent the transfer -- you send a Send-Init, read the response, which is an old NAK, so you send another Send-Init, read the next old NAK, and so forth, up to the retransmission limit, and give up before getting to the ACKs that are waiting in line behind all the old NAKs. If the number of NAKs is below the cutoff, then each packet may be trans- mitted multiply. 4. Similarly, before sending a packet, you should clear the input buff- er (after looking for any required handshake character). Failure to clear the buffer could result in propogation of the repetition of a packet caused by stacked-up NAKs. 5.5. File Names 5.5. File Names 5.5. File Names The syntax for file names can vary widely from system to system. To avoid problems, it is suggested that filenames be represented in the File Header (F) packet in a "normal form", by default (that is, there should be an option to override such conversions). 1. Delete all pathnames and attributes from the file specification. The file header packet should not contain directory or device names; if it does, it may cause the recipient to try to store the file in an inaccessible or nonexistent area, or it may result in a very strange filename. 2. After stripping any pathname, convert the remainder of the file ____ ____ specification to the form "name.type", with no restriction on length (except that it fit in the data field of the F packet), and: File Transfer File Transfer File Transfer Page 17 a. Include no more than one dot. ____ ____ b. Use digits, uppercase letters only in name and type. Special characters like "$", "_", "-", "&", and so forth should be disallowed, since they're sure to cause problems on one system or another. The recipient, of course, cannot depend upon the sender to follow this conven- tion, and should still take precautions. However, since most file systems em- body the notion of a file name and a file type, this convention will allow these items to be expressed in a way that an unlike system can understand. The particular notation is chosen simply because it is the most common. The recipient must worry about the length of the name and type fields of the file name. If either is too long, they must be truncated. If the result (whether truncated or not) is the same as the name of a file that already ex- ists in the same area, the recipient should have the ability to take some spe- cial action to avoid writing over the original file. KERMIT implementations that convert file specifications to normal form by default should have an option to override this feature. This would be most useful when transferring files between like systems, perhaps used in conjunc- tion with "image mode" file transfer. This could allow, for instance, one UNIX system to send an entire directory tree to another UNIX system. 5.6. Robustness 5.6. Robustness 5.6. Robustness A major feature of the KERMIT protocol is the ability to transfer multiple files. Whether a particular KERMIT program can actually send multiple files depends on the capabilities of the program and the host operating system (any KERMIT program can receive multiple files). If a KERMIT program can send multiple files, it should make every attempt to send the entire group specified. If it fails to send a particular file, it should not terminate the entire batch, but should go on the the next one, and proceed until an attempt has been made to send each file in the group. Operating in this robust manner, however, gives rise to a problem: the user must be notified of a failure to send any particular file. Unfortunately, it is not sufficient to print a message to the screen since the user may not be physically present. A better solution would be to have the sender optionally keep a log of the transaction, giving the name of each file for which an at- tempt was made, and stating whether the attempt was successful, and if not, the reason. Additional aids to robustness are described in the Optional Features section, below. File Transfer File Transfer File Transfer Page 18 5.7. Flow Control 5.7. Flow Control 5.7. Flow Control On full duplex connections, XON/XOFF flow control can generally be used in con- junction with KERMIT file transfer with no ill effects. This is because XOFFs are sent in the opposite direction of packet flow, so they will not interfere with the packets themselves. XON/XOFF, therefore, need not be implemented by the KERMIT program, but can done by the host system. If the host system provides this capability, it should be used -- if both sides can respond XON/XOFF signals, then buffer overruns and the resulting costly packet retransmissions can be avoided. Beware, however, of the following situation: remote Kermit is sending periodic NAKs, local system is buffering them on the operating system level (because the user has not started the local end of the file transfer yet); local line buffer becomes full, local systems sends XOFF, remote starts buffering them up on its end, user finally starts file transfer on local end, clears buffer, local operating system sends XON, and then all the remotely buffered NAKs show up, causing the packet echoing problem described above, despite the buffer clear- ing. Flow control via modem signals can also be used when available. Note that flow control should not be confused with "handshake" or "line turnaround" techniques that are used on simplex or half-duplex communication lines. 5.8. Basic KERMIT Protocol State Table 5.8. Basic KERMIT Protocol State Table 5.8. Basic KERMIT Protocol State Table The KERMIT protocol can be described as a set of states and transitions, and rules for what to do when changing from one state to another. State changes occur based on the type of packets that are sent or received, or errors that may occur. Packets always go back and forth; the sender of a file always sends data packets of some kind (init, header, data) and the receiver always returns ACK or NAK packets. Upon entering a given state, a certain kind of packet is either being sent or is expected to arrive -- this is shown on top of the description of that state. As a result of the action, various responses may occur; these are shown in the EVENT column. For each event, an appropriate ACTION is taken, and the protocol enters a NEW STATE. The following table specifies basic KERMIT operation. Timeouts and error con- ditions have been omitted from the following table for simplicity, but the ac- tion is as described above. Server operation and some of the advanced features are also omitted. A full-blown state table is given subsequently. File Transfer File Transfer File Transfer Page 19 _____ _____ ______ ___ _____ STATE EVENT ACTION NEW_STATE ____ ______ -- SEND STATES -- ____ ____ ____ ______ ____ _________ ______ Send_Send-Init_Packet_____________________________________ S Get NAK,bad ACK (None) S Get good ACK Set remote's params, open file SF (Other) (None) A ____ ____ ______ ______ ____ ___________ ______ Send_File-Header_Packet___________________________________ SF Get NAK,bad ACK (None) SF Get good ACK Get bufferful of file data SD (Other) (None) A ____ ____ ____ ______ ____ _________ ______ Send_File-Data_Packet_____________________________________ SD Get NAK,bad ACK (None) SD Get good ACK Get bufferful of file data SD (End of file) (None) SZ (Other) (None) A ____ ___ ______ ____ ___ ______ Send_EOF_Packet___________________________________________ SZ Get NAK,bad ACK (None) SZ Get good ACK Get next file to send SF (No more files) (None) SB (Other) (None) A ____ _____ ___ ______ ____ _____ _____ ______ Send_Break_(EOT)_Packet___________________________________ SB Get NAK,bad ACK (None) SB Get good ACK (None) C (Other) (None) A _______ ______ -- RECEIVE STATES -- ____ ___ ____ ____ ______ ____ ___ _________ ______ Wait_for_Send-Init_Packet_________________________________ R Get Send-Init ACK w/local params RF (Other) (None) A ____ ___ ____ ______ ______ ____ ___ ___________ ______ Wait_for_File-Header_Packet_______________________________ RF Get Send-Init ACK w/local params (previous ACK was lost) RF Get Send-EOF ACK (prev ACK lost) RF Get Break ACK C Get File-Header Open file, ACK RD (Other) (None) A File Transfer File Transfer File Transfer Page 20 ____ ___ ____ ____ ______ ____ ___ _________ ______ Wait_for_File-Data_Packet_________________________________ RD Get previous packet(D,F) ACK it again RD Get EOF ACK it, close the file RF Get good data Write to file, ACK RD (Other) (None) A ______ ______ __ _______ ___ _________ -- STATES COMMON TO SENDING AND RECEIVING -- C (Send Complete) start A ("Abort") start Packet Format Packet Format Packet Format Page 21 CHAPTER 6 CHAPTER 6 CHAPTER 6 PACKET FORMAT PACKET FORMAT PACKET FORMAT 6.1. Fields 6.1. Fields 6.1. Fields The KERMIT protocol is built around exchange of packets of the following for- mat: +------+-----------+-----------+------+------------+-------+ | MARK | char(LEN) | char(SEQ) | TYPE | DATA | CHECK | +------+-----------+-----------+------+------------+-------+ where all fields consist of ASCII characters. The fields are: ____ MARK The synchronization character that marks the beginning of the packet. This should normally be CTRL-A, but may be redefined. ___ LEN The number of ASCII characters within the packet that follow this field, in other words the packet length minus two. Since this number is transformed to a single character via the char() function, packet character counts of 0 to 94 (decimal) are permitted, and 96 (decimal) is the maximum total packet length. The length does not include end- of-line or padding characters, which are outside the packet and are strictly for the benefit of the operating system or communications equipment, but it does include the block check characters. ___ SEQ The packet sequence number, modulo 64, ranging from 0 to 63. Sequence numbers "wrap around" to 0 after each group of 64 packets. ____ TYPE The packet type, a single ASCII character. The following packet types are required: D Data packet Y Acknowledge (ACK) N Negative acknowledge (NAK) S Send initiate (exchange parameters) B Break transmission (EOT) F File header Z End of file (EOF) E Error ________ ___ ________ ___ T Reserved for internal use The NAK packet is used only to indicate that the expected packet was not received correctly, never to supply other kinds of information, ______ such as refusal to perform a requested service. The NAK packet always has an empty data field. The T "packet" is used internally by many KERMIT programs to indicate that a timeout occurred. ____ DATA The "contents" of the packet, if any contents are required in the given type of packet, interpreted according to the packet type. Control characters (bytes whose low order 7 bits are in the ASCII control range Packet Format Packet Format Packet Format Page 22 0-31, or 127) are preceded by a special prefix character, normally "#", and "uncontrollified" via ctl(). A prefixed sequence may not be broken across packets. Logical records in printable files are delimited with CRLFs, suitably prefixed (e.g. "#M#J"). Logical records need not cor- respond to packets. Any prefix characters are included in the count. Optional encoding for 8-bit data and repeated characters is described later. _____ CHECK A block check on the characters in the packet between, but not includ- ing, the mark and the block check itself. The check for each packet is computed by both hosts, and must agree if a packet is to be accepted. A single-character arithmetic checksum is the normal and required block check. Only six bits of the arithmetic sum are included. In order that all the bits of each data character contribute to this quantity, bits 6 and 7 of the final value are added to the quantity formed by _ bits 0-5. Thus if s is the arithmetic sum of the ASCII characters, then _____ _ _ check = char((s + ((s AND 192)/64)) AND 63) This is the default block check, and all Kermits must be capable of performing it. Other optional block check types are described later. The block check is based on the ASCII values of all the characters in the packet, including control fields and prefix characters. Non-ASCII systems must translate to ASCII before performing the block check cal- culation. 6.2. Terminator 6.2. Terminator 6.2. Terminator Any line terminator that is required by the system may be appended to the packet; this is carriage return (ASCII 15) by default. Line terminators are not considered part of the packet, and are included for in the count or check- sum. Terminators are not necessary to the protocol, and are invisible to it, as are any characters that may appear between packets. If a host cannot do single character input from a TTY line, then a terminator will be required when sending to that host. The terminator can be specified in the initial connec- tion exchange. Some KERMIT implementations also use the terminator for another reason -- speed. Some systems are not fast enough to take in a packet and decode it character by character at high baud rates; by blindly reading and storing all characters between the MARK and the EOL, they are able to absorb the incoming characters at full speed and then process them at their own rate. Packet Format Packet Format Packet Format Page 23 6.3. Other Interpacket Data 6.3. Other Interpacket Data 6.3. Other Interpacket Data The space between packets may be used for any desired purpose. Handshaking characters may be necessary on certain connections, others may require screen control or other sequences to keep the packets flowing. 6.4. Encoding, Prefixing, Block Check 6.4. Encoding, Prefixing, Block Check 6.4. Encoding, Prefixing, Block Check _______ ______ MARK, LEN, SEQ, TYPE, and CHECK are control fields. Control fields are always literal single-character fields, except that the CHECK field may be extended by one or two additional check characters. Each control field is encoded by char() or taken literally, but never prefixed. The control fields never con- tain 8-bit data. The DATA field contains a string of data characters in which any control characters are encoded printably and preceded with the control prefix. The decision to prefix a character in this way depends upon whether its low order 7 bits are in the ASCII control range, i.e. 0-31 or 127. Prefix characters that appear in the data must themselves be prefixed by the control prefix, but un- like control characters, these retain their literal value in the packet. The treatment of the high order ("8th") bit of a data byte is as follows: - If the communication channel allows 8 data bits per character, then the original value of the 8th bit is retained in the prefixed charac- ter. For instance, a data byte corresponding to a Control-A with the 8th bit set would be send as a control prefix, normally "#", without ____ the 8th bit set, followed by ctl(^A) with the 8th bit set. In binary notation, this would be 00100011 10000001 In this case, the 8th bit is figured into all block check calcula- tions. - If the communication channel or one of the hosts required parity on each character, and both sides were capable of 8th-bit prefixing, then the 8th bit will be used for parity, and must not be included in the block check. 8th bit prefixing is an option feature described in greater detail in Section 8, below. ___ - If parity is being used but 8th-bit prefixing is not being done, then the value of the 8th bit of each data byte will be lost and binary files will not be transmitted correctly. Again, the 8th bit does not figure into the block check. ______ The data fields of all packets are subject to prefix encoding, except S, I, and A packets, and their ACKs (see below). Initial Connection Initial Connection Initial Connection Page 24 CHAPTER 7 CHAPTER 7 CHAPTER 7 INITIAL CONNECTION INITIAL CONNECTION INITIAL CONNECTION Initial connection occurs when the user has started up a Kermit program on both ends of the physical connection. One Kermit has been directed (in one way or another) to send a file, and the other to receive it. The receiving Kermit waits for a "Send-Init" packet from the sending Kermit. It doesn't matter whether the sending Kermit is started before or after the receiving Kermit (if before, the Send-Init packet should be retransmitted periodically until the receiving Kermit acknowledges it). The data field of the Send-Init packet is optional; trailing fields can be omitted (or left blank, i.e. contain a space) to accept or specify default values. The Send-Init packet contains a string of configuration information in its data field. The receiver sends an ACK for the Send-Init, whose data field contains its own configuration parameters. The data field of the Send-Init and the ACK _______ to the Send-Init are literal, that is, there is no prefix encoding. This is ___ _____ because the two parties will not know how to do prefix encoding until after the configuration data is exchanged. It is important to note that newly invented fields are added at the right, so that old KERMIT programs that do not have code to handle the new fields will act as if they were not there. For this reason, the default value for any field, indicated by blank, should result in the behavior that occurred before the new field was defined or added. 1 2 3 4 5 6 7 8 9 10... +------+------+------+------+------+------+------+------+------+------- | MAXL | TIME | NPAD | PADC | EOL | QCTL | QBIN | CHKT | REPT | CAPAS +------+------+------+------+------+------+------+------+------+------- The fields are as follows (the first and second person "I" and "you" are used to distinguish the two sides). Fields are encoded printably using the char() function unless indicated otherwise. ____ 1. MAXL The maximum length packet I want to receive, a number up to 94 (decimal). You respond with the maximum you want me to send. This allows systems to adjust to each other's buffer sizes, or to the con- dition of the transmission medium. ____ 2. TIME The number of seconds after which I want you to time me out while waiting for a packet from me. You respond with the amount of time I should wait for packets from you. This allows the two sides to ac- commodate to different line speeds or other factors that could cause timing problems. Only one side needs to time out. If both sides time out, then the timeout intervals should not be close together. ____ 3. NPAD The number of padding characters I want to precede each incoming packet; you respond in kind. Padding may be necessary when sending to a half duplex system that requires some time to change the direc- tion of transmission, although in practice this situation is more Initial Connection Initial Connection Initial Connection Page 25 commonly handled by a "handshake" mechanism. ____ 4. PADC The control character I need for padding, if any, transformed by ___ ctl() (not char()) to make it printable. You respond in kind. Nor- mally NUL (ASCII 0), some systems use DEL (ASCII 127). This field is to be ignored if the value NPAD is zero. ___ 5. EOL The character I need to terminate an incoming packet, if any. You respond in kind. Most systems that require a line terminator for terminal input accept carriage return for this purpose (note, because there is no way to specify that no EOL should be sent, it would have been better to use ctl() for this field rather than char(), but it's too late now). ____ 6. QCTL (verbatim) The printable ASCII character I will use to quote control characters, normally and by default "#". You respond with the one you will use. ___ _________ ______ ______ __ ___ ___ __ ________ ________ __ ___ ______ The following fields relate to the use of OPTIONAL features of the KERMIT ________ _________ __ _______ _ protocol, described in section 8. ____ 7. QBIN (verbatim) The printable ASCII character I want to use to quote characters which have the 8th bit set, for transmitting binary files when the parity bit cannot be used for data. Since this kind of quoting increases both processor and transmission overhead, it is normally to be avoided. If used, the quote character must be in the range ASCII 33-62 ("!" through ">") or 96-126 ("`" through "~"), but different from the control-quoting character. This field is inter- preted as follows: Y I agree to 8-bit quoting if you request it. N I will not do 8-bit quoting. & (or any other character in the range 33-62 or 96-126) I want to do 8-bit quoting using this character (it will be done if the other Kermit puts a Y in this field, or responds with the same prefix character, such as &). The recommended 8th-bit quoting prefix character is "&". ________ ____ Anything Else : 8-bit quoting will not be done. Note that this scheme allows either side to initiate the request, and the order does not matter. For instance, a micro capable of 8-bit communication will normally put a "Y" in this field whereas a mainframe that uses parity will always put an "&". No matter who sends first, this combination will result in election of 8th-bit quoting. ____ 8. CHKT Check Type, the method for detecting errors. "1" for single-charac- ter checksum (the normal and required method), "2" for two-character checksum (optional), "3" for three-character CRC-CCITT (optional). If your response agrees, the designated method will be used; other- wise the single-character checksum will be used. Initial Connection Initial Connection Initial Connection Page 26 ____ 9. REPT The prefix character I will use to indicate a repeated character. This can be any printable character in the range ASCII 33-62 or 96-126, but different from the control and 8th-bit prefixes. SP (32) denotes no repeat count processing is to be done. Tilde ("~") is the recommended and normal repeat prefix. If you don't respond iden- tically, repeat counts will not be done. Groups of at least 3 or 4 identical characters may be transmitted more efficiently using a repeat count, though an individual implementation may wish to set a different threshhold. _____ 10-?. CAPAS A bit mask, in which each bit position corresponds to a capability of KERMIT, and is set to 1 if that capability is present, or 0 if it is not. Each character contains a 6-bit field (transformed by CHAR()), whose low order bit is set to 1 if another capability byte follows, and to 0 in the last capability byte. The capabilities defined so far are: ________ #1 Reserved ________ #2 Reserved #3 Ability to accept "A" packets (file attributes) The capability byte as defined so far would then look like: bit5 bit4 bit3 bit2 bit1 bit0 +----+----+----+----+----+----+ | #1 | #2 | #3 | -- | -- | 0 | +----+----+----+----+----+----+ If all these capabilities were "on", the value of the byte would be 70 (octal). When capabilities 4, 5 and 6 are added, the capability mask will look like this: bit5 bit4 bit3 bit2 bit1 bit0 bit5 bit4 bit3 bit2 bit1 bit0 +----+----+----+----+----+----+ +----+----+----+----+----+----+ | #1 | #2 | #3 | #4 | #5 | 1 | | #6 | -- | -- | -- | -- | 0 | +----+----+----+----+----+----+ +----+----+----+----+----+----+ ____ _ ________ ______ Next 4: Reserved_Fields Sites that wish to add their own parameters to the initial connection negotiation must start at the 5th field after the last capability byte. Any intervening fields may be left blank (that is, they may contain the space character). These fields are reserved for future use by the standard KERMIT protocol. ___ _______ ___ ___ ___ ______ ________ ____ __ ________ The control, 8th-bit, and repeat prefixes must be distinct. The receiving Kermit responds with an ACK ("Y") packet in the same format to indicate its own preferences, options, and parameters. The ACK need not con- tain the same number of fields as the the Send-Init. From that point, the two KERMIT programs are "configured" to communicate with each other for the remainder of the transaction. In the case of 8th-bit quoting, one side must Initial Connection Initial Connection Initial Connection Page 27 specify the character to be used, and the other must agree with a "Y" in the same field, but the order in which this occurs does not matter. Similarly for checksums -- if one side requests 2 character checksums and the other side responds with a "1" or with nothing at all, then single-character checksums will be done, since not all implementations can be expected to do 2-character checksums or CRCs. And for repeat counts; if the repeat field of the send-init and the ACK do not agree, repeat processing will not be done. All Send-Init fields are optional. The data field may be left totally empty. Similarly, intervening fields may be defaulted by setting them to blank. Ker- mit implementations should know what to do in these cases, namely apply ap- propriate defaults. The defaults should be: MAXL: 80 NPAD: 0, no padding PADC: 0 (NUL) EOL: CR (carriage return) QCTL: the character "#" QBIN: none, don't do 8-bit quoting CHKT: "1", single-character checksum REPT: No repeat count processing MASK: All zeros (no special capabilities) There are no prolonged negotiations in the initial connection sequence -- there is one Send-Init and one ACK in reply. Everything must be settled in this ex- change. The very first Send-Init may not get through if the sending Kermit makes wrong assumptions about the receiving host. For instance, the receiving host may re- quire certain parity, some padding, handshaking, or a special end of line character in order to read the Send-Init packet. For this reason, there should be a way for the user the user to specify whatever may be necessary to get the first packet through. A parity field is not provided in the Send-Init packet because it could not be of use. If the sender requires a certain kind of parity, it will also be send- ______ ing it. If the receiver does not know this in advance, i.e. before getting the Send-Init, it will not be able to read the Send-Init packet. Optional Features Optional Features Optional Features Page 28 CHAPTER 8 CHAPTER 8 CHAPTER 8 OPTIONAL FEATURES OPTIONAL FEATURES OPTIONAL FEATURES The foregoing sections have discussed basic, required operations for any KERMIT implementation. The following sections discuss optional and advanced features. 8.1. 8th-Bit and Repeat Count Prefixing 8.1. 8th-Bit and Repeat Count Prefixing 8.1. 8th-Bit and Repeat Count Prefixing Prefix quoting of control characters is mandatory. In addition, prefixing may also be used for 8-bit quantities or repeat counts, when both KERMIT programs agree to do so. 8th-bit prefixing can allow 8-bit binary data pass through 7-bit physical links. Repeat count prefixing can improve the throughput of certain kinds of files dramatically; binary files (particularly executable programs) and structured text (highly indented or columnar text) tend to be the major beneficiaries. When more than one type of prefixing is in effect, a single data character can be preceded by more than one prefix character. Repeat count processing can only be requested by the sender, and will only be used by the sender if the receiver agrees. 8th-bit prefixing is a special case because its use is nor- mally not desirable, since it increases both processing and transmission over- head. However, since it is the only straightforward mechanism for binary file transfer available to those systems that usurp the parity bit, a receiver must be able to request the sender to do 8th-bit quoting, since most senders will not normally do it by default. The repeat prefix is followed immediately by a single-character repeat count, encoded printably via char(), followed by the character itself (perhaps prefixed by control or 8th bit quotes, as explained below). The repeat count may express values from 0 to 94. If a character appears more than 94 times in a row, it must be "cut off" at 94, emitted with all appropriate prefixes, and "restarted". The following table should clarify Kermit's quoting mechanism (the final line shows how a sequence of 120 consecutive NULs would be encoded): Quoted With _________ ______________ ______ _____ ___ _ Character Representation Repeat_Count_for_6 A A ~(A ["(" is ASCII 40 - 32 = 6] ^A #A ~(#A 'A &A ~(&A '^A &#A ~(&#A # ## ~(## '# &## ~(&## & #& ~(#& '& &#& ~(&#& ~ #~ ~(#~ '~ &#~ ~(&#~ NUL #@ ~~#@~:#@ [120 NULs] A represents any printable character, ^A represents any control character, 'x represents any character with the 8th bit set. The # character is used for control-character quoting, and the & character for 8-bit quoting. The repeat Optional Features Optional Features Optional Features Page 29 count must always precede any other prefix character. The repeat count is taken literally (after transformation by unchar(); for instance "#" and "&" im- mediately following a "~" denote repeat counts, not control characters or 8-bit characters. The control quote character "#" is most closely bound to the data character, then the 8-bit prefix, then the repeat count; in other words, the order is: repeat prefix and count, 8-bit quote, control quote, and the data ___ character itself. To illustrate, note that &#A is not equivalent to #&A. When the parity bit is available for data, then 8th-bit quoting should not be done, and the 8th bit of the prefixed character will have the same value as the 8th bit of the original data byte. In that case, the table looks like this: Quoted With _________ ______________ ______ _____ ___ _ Character Representation Repeat_Count_for_6 'A 'A ~('A '^A #'A ~(#'A '# #'# ~(#'# '& '& ~('& '~ #'~ ~(#'~ Note that since 8th bit quoting is not being done, "&" is not being used as an 8th bit prefix character, so it does not need to be quoted with "#". Also, note that the 8th bit is set on the final argument of the repeat sequence, no matter how long, and not on any of the prefix characters. Finally, remember the following rules: ________ _________ ____ ___ __ ______ ______ _______ - Prefixed sequences must not be broken across packets. _______ ___ ___ ___ ______ _____ ________ ____ __ ________ - Control, 8th-bit, and repeat count prefixes must be distinct. ____ ______ __ ___ _______ ____ ____ _______ ___ ______ ________ - Data fields of all packets must pass through the prefix encoding _________ ______ ___ _ _ ___ _ _______ ___ ____ __ _____ _______ mechanism, except for S, I, and A packets, and ACKs to those packets. In the first rule above, note that a prefixed sequence means a single character ___ ___ and all its prefixes, like ~%&#X, not a sequence like #M#J, which is two prefixed sequences. 8.2. Server Operation 8.2. Server Operation 8.2. Server Operation A KERMIT server is a KERMIT program running remotely with no "user interface". All commands to the server arrive in packets from the local KERMIT. SERVER operation is much more convenient than basic operation, since the user need never again interact directly with the remote KERMIT program after once start- ing it up in server mode, and therefore need not issue complementary SEND and RECEIVE commands on the two sides to get a file transfer started; rather, a single command (such as SEND or GET) to the local KERMIT suffices. KERMIT ser- vers can also provide services beyond file transfer. Between transactions, a Kermit server waits for packets containing server com- mands. The packet sequence number is always set back to 0 after a transaction. Optional Features Optional Features Optional Features Page 30 A Kermit server in command wait should be looking for packet 0, and command packets sent to servers should also be packet 0. Certain server commands will result in the exchange of multiple packets. Those operations proceed exactly like file transfer. A KERMIT server program waiting for a command packet is said to be in "server command wait". Once put into server command wait, the server should never leave it until it gets a command packet telling it to do so. This means that after any transaction is terminated, either normally or by any kind of error, the server must go back into command wait. While in command wait, a server may elect to send out periodic NAKs for packet 0, the expected command packet. Since the user may be disconnected from the server for long periods of time (hours), the interval between these NAKs should be significantly longer than the normal timeout interval (say, 30-60 seconds, rather than 5-10). The peri- odic NAKs are useful for breaking the deadlock that would occur if a local program was unable to time out, and sent a command that was lost. On the other hand, they can cause problems for local KERMIT programs that cannot clear their input buffers, or for systems that do XON/XOFF blindly, causing the NAKs to buffered in the server's host system output buffer, to be suddenly released en masse when an XON appears. For this reason, servers should have an option to set the command-wait wakeup interval, or to disable it altogher. Server operation must be implemented in two places: in the server itself, and in any KERMIT program that will be communicating with a server. The server must have code to read the server commands from packets and respond to them. The user KERMIT must have code to parse the user's server-related commands, to form the server command packets, and to handle the responses to those server commands. 8.2.1. Server Commands 8.2.1. Server Commands 8.2.1. Server Commands Server commands are listed below. Not all of them have been implemented, and some may never be, but their use should be reserved. Although server-mode operation is optional, certain commands should be implemented in every server. These include Send-Init (S), Receive-Init (R), and the Generic Logout (GL) and/or Finish (GF) commands. If the server receives a command it does not un- derstand, or cannot execute, it should respond with an Error (E) packet con- taining a message like "Unimplemented Server Command" and both sides should set the packet sequence number back to 0, and the server should remain in server command wait. Only a GL or GF command should terminate server operation. Server commands are as follows: S Send Initiate (exchange parameters, server waits for a file). R Receive Initiate (ask the server to send the specified files). I Initialize (exchange parameters). X Text header. Allows transfer of text to the user's screen in response to a generic or host command. This works just like file transfer except that the destination "device" is the screen rather than a file. Data field may contain a filename, title, or other heading. C Host Command. The data field contains a string to be executed as a command Optional Features Optional Features Optional Features Page 31 by the host system command processor. K KERMIT Command. The data field contains a string in the interactive com- mand language of the KERMIT server (normally a SET command) to be executed as if it were typed in at command level. G Generic Kermit Command. Single character in data field (possibly followed by operands, shown in {braces}, optional fields in [brackets]) specifies the command: I Login [{*user[*password[*account]]}] C CWD, Change Working Directory [{*directory[*password]}] L Logout, Bye F Finish (Shut down the server, but don't logout). D Directory [{*filespec}] U Disk Usage Query [{*area}] E Erase (delete) {*filespec} T Type {*filespec} R Rename {*oldname*newname} K Copy {*source*destination} W Who's logged in? (Finger) [{*user ID or network host[*options]}] M Send a short Message {*destination*text} H Help [{*topic}] Q Server Status Query P Program {*[program-filespec][*program-commands]} J Journal {*command[*argument]} V Variable {*command[*argument[*argument]]} Note that field length encoding is used within the data field of all Generic command packets, but not within the data fields of the other pack- ets, such as S, I, R, X, K, and C. Asterisk as used above ("*") represents a single-character length field, en- coded using char(), for the operand that follows it; thus lengths from 0 to 94 may be specified. This allows multiple operands to be clearly delimited regardless of their contents. All server commands that send arguments in their data fields should pass through the prefix encoding mechanism. Thus if a data character or length field happens to correspond to an active prefix character, it must itself be ______ prefixed. The field length denotes the length of the field before prefix en- _____ coding and (hopefully) after prefix decoding. For example, to send a generic command with two fields, "ABC" and "ZZZZZZZZ", first each field would be prefixed by char() of its length, in this case char(3) and char(8), giving "#ABC(ZZZZZZZZ". But "#" is the normal control prefix character so it must be prefixed itself, and the eight Z's can be condensed to 3 characters using a repeat prefix (if repeat counts are in effect), so the result after encoding would be "##ABC(~(Z" (assuming the repeat prefix is tilde ("~"). The recipient would decode this back into the original "#ABC(ZZZZZZZZ" before attempting to extract the two fields. Since a generic command must fit into a single packet, the program sending the command should ensure that the command actually fits, and should not include length fields that point beyond the end of the packet. Servers, however, Optional Features Optional Features Optional Features Page 32 should be defensive and not attempt to process any characters beyond the end of the data field, even if the argument length field would lead them to do so. 8.2.2. Timing 8.2.2. Timing 8.2.2. Timing KERMIT does not provide a mechanism for suspending and continuing a trans- action. This means that text sent to the user's screen should not be frozen for long periods (i.e. not longer than the timeout period times the retry threshold). Between transactions, when the server has no tasks pending, it may send out periodic NAKs (always with type 1 checksums) to prevent a deadlock in case a command was sent to it but was lost. These NAKs can pile up in the local "user" Kermit's input buffer (if it has one), so the user Kermit should be prepared to clear its input buffer before sending a command to a server. Meanwhile, servers should recognize that some systems provide no function to do this (or even when they do, the process can be foiled by system flow control firmware) and should therefore provide a way turn off or slow down the command- wait NAKs. 8.2.3. The R Command 8.2.3. The R Command 8.2.3. The R Command The R packet, generally sent by a local Kermit program whose user typed a GET command, tells the server to send the files specified by the name in the data field of the R packet. Since we can't assume that the two Kermits are running on like systems, the local (user) Kermit must parse the file specification as a character string and let the server to check it. If the server can open and ___ __ ___________ read the specified file, it sends a Send-Init (S) packet -- not an acknowledge- ____ ment! -- to the user, and then completes the file-sending transaction, as described above. If the server cannot send the file, it should respond with an error (E) packet containing a reason, like "File not found" or "Read access required". 8.2.4. The K Command 8.2.4. The K Command 8.2.4. The K Command The K packet can contain a character string which the server interprets as a command in its own interactive command language. This facility is useful for achieving the same effect as a direct command without having to shut down the server, connect back to the remote system, continue it (or start a new one), and issue the desired commands. The server responds with an ACK if the command was executed successfully, or an error packet otherwise. The most likely use for the K packet might be for transmitting SET commands, e.g. for switching be- tween text and binary file modes. Optional Features Optional Features Optional Features Page 33 8.2.5. Short and Long Replies 8.2.5. Short and Long Replies 8.2.5. Short and Long Replies Any request made of a server may be answered in either of two ways, and any User Kermit that makes such a request should be prepared for either kind of reply: _ _____ _____ - A short reply. This consists of a single ACK packet, which may con- tain text in its data field. For instance, the user might send a disk space query to the server, and the server might ACK the request with a short character string in the data field, such as "12K bytes free". The user KERMIT should display this text on the screen. _ ____ _____ - A long reply. This proceeds exactly like a file transfer (and in some cases it may be a file transfer). It begins with one of the following: * A File-Header (F) packet (optionally followed by one or more At- tributes packets; these are discussed later); * A Text-Header (X) packet. * A Send-Init (S) Packet, followed by an X or F packet. After the X or F packet comes an arbitrary number of Data (D) pack- ets, then an End-Of-File (Z) packet, and finally a Break-Transmission (B) packet, as for ordinary file transfer. A long reply should begin with an S packet unless an I-packet exchange has al- ___ ready taken place, and the type 1 (single-character) block check is being used. 8.2.6. Additional Server Commands 8.2.6. Additional Server Commands 8.2.6. Additional Server Commands The following server commands request the server to perform tasks other than sending or receiving files. Almost any of these can have either short or long replies. For instance, the Generic Erase (GE) command may elicit a simple ACK, or a stream of packets containing the names of all the files it erased (or didn't erase). These commands are now described in more detail; arguments are as provided in commands typed to the user KERMIT (subject to prefix encoding); no transformations to any kind of normal or canonic form are done -- filenames and other operands are in the syntax of the server's host system. I Login. For use when a KERMIT server is kept perpetually running on a dedi- cated line. This lets a new user obtain an identity on the server's host system. If the data field is empty, this removes the user's identity, so that the next user does not get access to it. L Logout, Bye. This shuts down the server entirely, causing the server it- self to log out its own job. This is for use when the server has been started up manually by the user, who then wishes to shut it down remotely. For a perpetual, dedicated server, this command simply removes the server's access rights to the current user's files, and leaves the server waiting Optional Features Optional Features Optional Features Page 34 for a new login command. F Finish. This is to allow the user to shut down the server, putting its terminal back into normal (as opposed to binary or raw) mode, and putting the server's job back at system command level, still logged in, so that the user can connect back to the job. For a perpetual, dedicated server, this command behaves as the L (BYE) command. C CWD. Change Working Directory. This sets the default directory or area for file transfer on the server's host. With no operands, this command sets the default area to be the user's own default area. D Directory. Send a directory listing to the user. The user program can display it on the terminal or store it in a file, as it chooses. The directory listing should contain file sizes and creation dates as well as file names, if possible. A wildcard or other file-group designator may be specified to ask the server list only those files that match. If no operand is given, all files in the current area should be shown. U Disk Usage Query. The server responds with the amount of space used and the amount left free to use, in K bytes (or other units, which should be specified). E Erase (delete). Delete the specified file or file group. T Type. Send the specified file or file group, indicating (by starting with an X packet rather than an F packet, or else by using the Type attribute) that the file is to be displayed on the screen, rather than stored. R Rename. Change the name of the file or files as indicated. The string in- dicating the new name may contain other attributes, such as protection code, permitted in file specifications by the host. K Copy. Produce a new copy of the file or file group, as indicated, leaving the source file(s) unmodified. W Who's logged in? (Finger). With no arguments, list all the users who are logged in on the server's host system. If an argument is specified, provide more detailed information on the specified user or network host. M Short Message. Send the given short (single-packet) message to the in- dicated user's screen. P Program. This command has two arguments, program name (filespec), and command(s) for the program. The first field is required, but may be left null (i.e. zero length). If it is null, the currently loaded program is "fed" the specified command. If not null, the specified program is loaded and started; if a program command is given it is fed to the program as an initial command (for instance, as a command line argument on systems that support that concept). In any case, the output of the program is sent back in packets as either a long or short reply, as described above. Optional Features Optional Features Optional Features Page 35 J Journal. This command controls server transaction logging. The data field contains one of the following: + Begin/resume logging transactions. If a filename is given, close any currently open transaction and then open the specified file as the new transaction log. If no name given, but a log file was already open, resume logging to that file. If no filename was given and no log was open, the server should open a log with a default name, like TRANSACTION.LOG. - Stop logging transactions, but don't close the current transaction log file. C Stop logging and close the current log. S Send the transaction log as a file. If it was open, close it first. Transaction logging is the recording of the progress of file transfers. It should contain entries showing the name of each file transferred, when the transfer began and ended, whether it completed successfully, and if not, why. _______ V Set or Query a variable. The command can be S or Q. The first argument is the variable name. The second argument, if any, is the value. S Set the specified variable to the specified value. If the value is null, then undefine the variable. If the variable is null then do nothing. If the variable did not exist before, create it. The server should respond with an ACK if successful, and Error packet otherwise. Q Query the value of the named variable. If no variable is supplied, display the value of all active variables. The server responds with either a short or long reply, as described above. If a queried vari- able does not exist, a null value is returned. Variables are named by character strings, and have character string values, which may be static or dynamic. For instance, a server might have built-in variables like "system name" which never changes, or others like "mail status" which, when queried, cause the server to check to see if the user has any new mail. 8.2.7. Host Commands 8.2.7. Host Commands 8.2.7. Host Commands Host commands are conceptually simple, but may be hard to implement on some systems. The C packet contains a text string in its data field which is simply fed to the server's host system command processor; any output from the proces- sor is sent back to the user in KERMIT packets, as either a short or long reply. Implementation of this facility under UNIX, with its forking process structure and i/o redirection via pipes, is quite natural. On other systems, it could be Optional Features Optional Features Optional Features Page 36 virtually impossible. 8.2.8. Exchanging Parameters Before Server Commands 8.2.8. Exchanging Parameters Before Server Commands 8.2.8. Exchanging Parameters Before Server Commands In basic KERMIT, the Send-Init exchange is always sufficient to configure the two sides to each other. During server operation, on the other hand, some transactions may not begin with a Send-Init packet. For instance, when the user sends an R packet to ask the server to send a file, the server chooses what block check option to use. Or if the user requests a directory listing, the server does not know what packet length to use. The solution to this problem is the "I" (Init-Info) packet. It is exactly like a Send-Init packet, and the ACK works the same way too. However, receipt of an I packet does not cause transition to file-send state. The I-packet exchange simply allows the two sides to set their parameters, in preparation for the next transaction. Servers should be able to receive and ACK "I" packets when in server command wait. User KERMITs need not send "I" packets, however; in that case, the serv- er will assume all the defaults for the user listed on page 27, or whatever parameters have been set by other means (e.g. SET commands typed to the server before it was put in server mode). User Kermits which send I packets should be prepared to receive and ignore an Error packet in response. This could happen if the server has not implemented I packets. 8.3. Alternate Block Check Types 8.3. Alternate Block Check Types 8.3. Alternate Block Check Types There are two optional kinds of block checks: ____ _ Type_2 A two-character checksum based on the low order 12 bits of the arithmetic sum of the characters in the packet (from the LEN field through the last data character, inclusive) as follows: 1 2 --------+--------------+-------------+ ...data | char(b6-b11) | char(b0-b5) | --------+--------------+-------------+ For instance, if the 16-bit result is 154321 (octal), then the 2 character block check would be "C1". ____ _ Type_3 Three-character 16-bit CRC-CCITT. The CRC calculation treats the data it operates upon as a string of bits with the low order bit of the first character first and the high order bit of the last character last. The in- itial value of the CRC is taken as 0; the 16-bit CRC is the remainder after Optional Features Optional Features Optional Features Page 37 16 12 5 _ _ _ dividing the data bit string by the polynomial X +X +X +1 (this calcula- tion can actually be done a character at a time, using a simple table lookup algorithm). The result is represented as three printable characters at the end of the packet, as follows: 1 2 3 --------+---------------+--------------+-------------+ ...data | char(b12-b15) | char(b6-b11) | char(b0-b5) | --------+---------------+--------------+-------------+ For instance, if the 16-bit result is 154321 (octal), then the 3 character block check would be "-C1". The CRC technique chosen here agrees with many hardware implementations (e.g. the VAX CRC instruction). A useful refer- ence on table-driven CRC calculations can be found in "Byte-wise CRC ____ _____ Calculations" by Aram Perez in IEEE MICRO, June 1983, p.40. The single-character checksum has proven quite adequate in practice. The other options can be used only if both sides agree to do so via Init packet (S or I) exchange. The 2 and 3 character block checks should only be used under con- ditions of severe line noise and packet corruption. Since type 2 and 3 block checks are optional, not all KERMITs can be expected to understand them. Therefore, during initial connection, communication must begin using the type 1 block check. If type 2 or 3 block checks are agreed to ____ _____ during the "I" or "S" packet exchange, the switch will occur only after the Send-Init has been sent and ACK'd with a type 1 block check. This means that the first packet with a type 2 or 3 block check must always be an "F" or "X" packet. Upon completion of a transaction, both sides must switch back to type 1 (to allow for the fact that neither side has any way of knowing when the _____ other side has been stopped and restarted). The transaction is over after a "B" or "E" packet has been sent and ACK'd, or after any error that terminates the transaction prematurely or abnormally. A consequence of the foregoing rule is that if a type 2 or 3 block check is to ____ be used, a long reply sent by the server must begin with a Send-Init (S) packet, even if an I packet exchange had already occurred. If type 1 block checks are being used, the S packet can be skipped and the transfer can start with an X or F packet. A server that has completed a transaction and is awaiting a new command may send out periodic NAKs for that command (packet 0). Those NAKs must have type 1 block checks. The use of alternate block check types can cause certain complications. For instance, if the server gets a horrible error (so bad that it doesn't even send an error packet) and reverts to command wait, sending NAKs for packet 0 using a type 1 block check, while a transfer using type 2 or 3 block checks was in progress, neither side will be able to read the other's packets. Communication can also grind to a halt if A sends a Send-Init requesting, say, type 3 block checks, B ACKs the request, switches to type 3 and waits for the X or F packet with a type 3 block check, but the ACK was lost, so A resends the S packet with Optional Features Optional Features Optional Features Page 38 a type 1 block check. Situations like this will ultimately resolve themselves after the two sides retransmit up to their retry threshhold, but can be rec- tified earlier by the use of two heuristics: - The packet reader can assume that if the packet type is "S", the block check type is 1. - A NAK packet never has anything in its data field. Therefore, the block check type can always be deduced by the packet reader from the length field of a NAK. In fact, it is the value of the length field minus 2. A NAK can therefore be thought of as a kind of "universal synchronizer". These heuristics tend violate the layered nature of the protocol, since the packet reader should normally be totally unconcerned with the packet type (which is of interest to the application level which invokes the packet reader). A better design would have had each packet include an indicator of the type of its own block check; this would have allowed the block check type to be changed dynamically during a transaction to adapt to changing conditions. But it's too late for that now... 8.4. Interrupting a File Transfer 8.4. Interrupting a File Transfer 8.4. Interrupting a File Transfer This section describes an optional feature of the KERMIT protocol to allow graceful interruption of file transfer. This feature is unrelated to server operation. To interrupt sending a file, send an EOF ("Z") packet in place of the next data packet, including a "D" (for Discard) in the data field. The recipient ACKs the Z packet normally, but does not retain the file. This does not interfere with older Kermits on the receiving end; they will not inspect the data field and will close the file normally. The mechanism can be triggered by typing an interrupt character at the console of the sending KERMIT program. If a (wildcard) file group is being sent, it is possible to skip to the next file or to terminate the entire batch; the protocol is the same in either case, but the desired action could be selected by different interrupt characters, e.g. CTRL-X to skip the current file, CTRL-Z to skip the rest of the batch. To interrupt receiving a file, put an "X" in the data field of an ACK for a data packet. To interrupt receiving an entire file group, use a "Z". The user could trigger this mechanism by typing an interrupt character by typing, say, CTRL-X and CTRL-Z, respectively, at the receiving KERMIT's console. A sender that was aware of the new feature, upon finding one of these codes, would act as described above, i.e. send a "Z" packet with a "D" code; a sender that did not implement this feature would simply ignore the codes and continue sending. In this case, and if the user wanted the whole batch to be cancelled (or only one file was being sent), the receiving KERMIT program, after determining that the sender had ignored the "X" or "Z" code, could send an Error (E) packet to stop the transfer. The sender may also choose to send a Z packet containing the D code when it Optional Features Optional Features Optional Features Page 39 detects that the file it is sending cannot be sent correctly and completely -- for instance, after sending some packets correctly, it gets an i/o error reading the file. Or, it notices that the "8th bit" of a file byte is set when the file is being sent as a text file and no provision has been made for trans- mitting the 8th bit. 8.5. Transmitting File Attributes 8.5. Transmitting File Attributes 8.5. Transmitting File Attributes The optional Attributes (A) packet provides a mechanism for the sender of a file to provide additional information about it. This packet can be sent if the receiver has indicated its ability to process it by setting the Attributes bit in the capability mask. If both sides set this bit in the Kermit capability mask, then the sender, after sending the filename in the "F" packet and receiving an acknowledgement, may (but does not have to) send an "A" packet to provide file attribute information. ___ Setting the Attributes bit in the capability mask does not indicate support for any particular attributes, only that the receiver is prepared to accept the "A" packet. The attributes are given in the data field of the "A" packet. The data field consists of 0 or more subfields, which may occur in any order. Each subfield is of the following form: +-----------+--------------+------+ | ATTRIBUTE | char(LENGTH) | DATA | +-----------+--------------+------+ where ATTRIBUTE is a single printable character other than space, LENGTH is the length of the data characters (0 to 94), with 32 added to produce a single printable character, and ______ DATA is length characters worth of data, all printable characters. No quoting or prefixing is done on any of this data. More than one attribute packet may be sent. The only requirement is that all the A packets for a file must immediately follow its File header (or X) packet, and precede the first Data packet. There may be 93 different attributes, one for each of the 93 printable ASCII characters other than space. These are assigned in ASCII order. ! (ASCII 33) Length. The data field gives the length in K (1024) bytes, as a printable decimal number, e.g. "!#109". This will allow the receiver to determine in advance whether there is sufficient room for the file, and/or how long the transfer will take. Optional Features Optional Features Optional Features Page 40 " (ASCII 34) Type. The data field can contain some indicator of the nature of the file. Operands are enclosed in {braces}, optional items in [brackets]. A[{xx}] ASCII text, containing no 8-bit quantities, logical records (lines) delimited by the (quoted) control character sequence {xx}, represented here by its printable counterpart (MJ = CRLF, J = LF, etc). For instance AMJ means that the ap- pearance of #M#J (the normal prefixed CRLF sequence) in a file data packet indicates the end of a record, assuming the current control prefix is "#". If {xx} is omitted, MJ will be assumed. B[{xx}] Binary. {xx} indicates in what manner the file is binary: 8 (default) The file is a sequence of 8-bit bytes, which must be saved as is. The 8th bit may be sent "bare", or prefixed according to the Send-Init negotiation about 8th-bit prefixing. 36 The file is a PDP-10 format binary file, in which five 7-bit bytes are fit into one 36-bit word, with the final bit of each word being represented as the "parity bit" of every 5th character (perhaps prefixed). _____ ____ ____ __ ______ _________ D{x} Moved from here to FORMAT attribute _____ ____ ____ __ ______ _________ F{x} Moved from here to FORMAT attribute I[{x}] Image. The file is being sent exactly as it is represented on the system of origin. For use between like systems. There are {x} usable bits per character, before prefixing. For instance, to send binary data from a system with 9-bit bytes, it might be convenient to send three 6-bit characters for every two 9-bit bytes. Default {x} is 8. # (ASCII 35) Creation Date, expressed as "[yy]yymmdd[ hh:mm[:ss]]" (ISO standard julian format), e.g. 831009 23:59. The time is optional; if given, it should be in 24-hour format, and the seconds may be omitted, and a single space should separate the time from the date. $ (ASCII 36) Creator's ID, expressed as a character string of the given length. % (ASCII 37) Account to charge the file to, character string. & (ASCII 38) Area in which to store the file, character string. Optional Features Optional Features Optional Features Page 41 ' (ASCII 39) Password for above, character string. ( (ASCII 40) Block Size. The file has, or is to be stored with, the given block size. ) (ASCII 41) Access: N New, the normal case -- create a new file of the given name. S Supersede (overwrite) any file of the same name. A Append to file of the given name. * (ASCII 42) Encoding: A ASCII, normal ASCII encoding with any necessary prefixing, etc. H Hexidecimal "nibble" encoding. E EBCDIC (sent as if it were a binary file). X Encrypted. Q{x} _ Huffman Encoded for compression. First x bytes of the file are the key. # (ASCII 43) Disposition (operands are specified in the syntax of the receiver's host system): M{user(s)} Send the file as Mail to the specified user(s). O{destination} Send the file as a lOng terminal message to the specified destination (terminal, job, or user). S[{options}] Submit the file as a batch job, with any specified options. P[{options}] Print the file on a system printer, with any specified options, which may specify a particular printer, forms, etc. T Type the file on the screen. L[{aaa}] Load the file into memory at the given address, if any. X[{aaa}] Load the file into memory at the given address and eXecute it. A Archive the file; save the file together with the at- tribute packets that preceded it, so that it can be sent back to the system of origin with all its at- Optional Features Optional Features Optional Features Page 42 tributes intact. A file stored in this way should be specially marked so that the KERMIT that sends it back will recognize the attribute information as dis- tinct from the file data. , (ASCII 44) Protection. Protection code for the file, in the syntax of the receiver's host file system. With no operand, store according to the system's default protection for the destination area. - (ASCII 45) Protection. Protection code for the file with respect to the "public" or "world", expressed generically in a 6-bit quantity (made printable by char()), in which the bits have the following meaning: b0: Read Access b1: Write Access b2: Execute Access b3: Append Access b4: Delete Access b5: Directory Listing A one in the bit position means allow the corresponding type of ac- cess, a zero means prohibit it. For example, the letter "E" in this field would allow read, execute, and directory listing access (unchar("E") = 69-32 = 37 = 100101 binary). . (ASCII 46) Machine and operating system of origin. This is useful in conjunc- tion with the archive disposition attribute. It allows a file, once archived, to be transferred among different types of systems, retain- ing its archive status, until it finds its way to a machine with the right characteristics to de-archive it. The systems are denoted by codes; the first character is the major system designator, the second designates the specific model or operating system. A third character may be added to make further distinctions, for instance operating system version. The systems below do not form a complete collection; many more can and probably will be added. A Apple microcomputers 1 Apple II, DOS 2 Apple III 3 Macintosh 4 Lisa B Sperry (Univac) mainframes 1 1100 series, EXEC C CDC mainframes Optional Features Optional Features Optional Features Page 43 1 Cyber series, NOS D DEC Systems 1 DECsystem-10/20, TOPS-10 2 DECsystem-10/20, TOPS-20 3 DECsystem-10/20, TENEX 4 DECsystem-10/20, ITS 5 DECsystem-10/20, WAITS 6 DECsystem-10/20, MAXC 7 VAX-11, VMS 8 PDP-11, RSX-11 9 PDP-11, IAS A PDP-11, RSTS/E B PDP-11, RT-11 C Professional-300, P/OS D Word Processor (WPS or DECmate), WPS D Honeywell mainframes 1 MULTICS systems 2 DPS series, running CP-6 F Data General machines 1 RDOS 2 AOS G PR1ME machines, PRIMOS H Hewlett-Packard machines 1 HP-1000, RTE 2 HP-3000, MPE I IBM 370-series and compatible mainframes 1 VM/CMS 2 MVS/TSO 3 DOS 4 MUSIC 5 GUTS 6 MTS J Tandy microcomputers, TRSDOS K Atari micros, DOS ________ L-T Reserved U Portable Operating or File Systems Optional Features Optional Features Optional Features Page 44 1 UNIX 2 Software Tools 3 CP/M-80 4 CP/M-86 5 CP/M-68K 6 MP/M 7 Concurrent CP/M 8 MS-DOS 9 UCSD p-System A MUMPS / (ASCII 47) Format of the data within the packets. A{xx} Variable length delimited records, terminated by the character sequence {xx}, where xx is a string of one or more control characters, represented here by their unprefixed printable equivalents, e.g. MJ for ^M^J (CRLF). D{x} Variable length undelimited records. Each logical record begins with an {x}-character ASCII decimal length field (similar to ANSI tape format "D"). For example, "D$" would indicate 4-digit length fields, like "0132". F{xxxx} Fixed-length undelimited records. Each logical record is {xxxx} bytes long. R{x} For record-oriented transfers, to be used in combina- tion with one of the formats given above. Each record begins (in the case of D format, after the length field) with an x-character long position field indicating the byte position within the file at which this record is to be stored. M{x} For record-oriented transfers, to be used in combina- tion with one of the formats given above. Maximum record length for a variable-length record. 0 (ASCII 48) Special system-dependent parameters for storing the file on the sys- tem of origin, for specification of exotic attributes not covered ex- plicitly by any of the KERMIT attribute descriptors. These are given as a character string in the system's own language, for example a list of DCB parameters in IBM Job Control Language. 1-@ (ASCII 49-64) ________ Reserved Other attributes can be imagined, and can be added later if needed. However, two important points should be noted: Optional Features Optional Features Optional Features Page 45 - The receiver may have absolutely no way of honoring, or even record- ing, a given attribute. For instance, CP/M-80 has no slot for crea- tion date or creator's ID in its FCB; the DEC-20 has no concept of block size, etc. - The sender may have no way of determining the correct values of any of the attributes. This is particularly true when sending files of foreign origin. The "A" packet mechanism only provides a way to send certain information about a file to the receiver, with no provision or guarantee about what the receiver may do with it. That information may be obtained directly from the file's directory entry (FCB, FDB, ...), or specified via user command. The ACK to the "A" packet may in turn have information in its data field. However, no complicated negotiations about file attributes may take place, so the net result is that the receiver may either refuse the file or accept it. The receiver may reply to the "A" packet with any of the following codes in the data field of the ACK packet: (empty data field) I accept the file, go ahead and send it. N[{xxx}] I refuse the file as specified, don't send it; {xxx} is a string of zero or more of the attribute characters listed above, to specify what attributes I object to (e.g. "!" means it's too long, "&" means I don't have write access to the specified area, etc). Y[{xxx}] I agree to receive the file, but I cannot honor attributes {xxx}, so I will store the file according to my own defaults. Y (degenerate case of Y{xxx}, equivalent to , above) How the receiver actually replies is an implementation decision. A NAK in response to the "A" packet means, of course, that the receiver did not receive the "A" correctly, not that it refuses to receive the file. 8.6. Advanced KERMIT Protocol State Table 8.6. Advanced KERMIT Protocol State Table 8.6. Advanced KERMIT Protocol State Table The simple table presented previously is sufficient for a basic KERMIT im- plementation. The following is a state table for the full Kermit protocol, in- cluding both server mode and sending commands to a server Kermit. It does not include handling of the file attributes packet (A). Note that states whose names start with "Send" always send a packet each time they are entered (even when the previous state was the same). States whose name starts with "Rec", always wait for a packet to be received (up to the timeout value), and process the received packet. States whose names do not include either send or receive do not process packets directly. These are states which perform some local operation and then change to another state. Optional Features Optional Features Optional Features Page 46 The initial state is determined by the user's command. A "server" command enters at Rec_Server_Idle. A "send" command enters at Send_Init. A "receive" command (the old non-server version, not a "get" command) enters at Rec_Init. Any generic command, the "get" command, and the "host" command enter at either Send_Server_Init or Send_Gen_Cmd, depending upon the expected response. Under "Rec'd Msg", the packet type of the incoming message is shown, followed by the packet number in parentheses; (n) means the current packet number, (n-1) and (n+1) mean the previous and next packet numbers (modulo 64), (0) means packet number zero. Following the packet number may be slash and a letter, in- dicating some special signal in the data field. For instance Z(n)/D indicates _ a Z (EOF) packet, sequence number n, with a "D" in the data field. Under "Action", "r+" means that the retry count is incremented and compared with a threshhold; if the threshhold is exceeded, an Error packet is sent and the state changes to "Abort". "n+" means that the packet number is incre- _ mented, modulo 64, and the retry count, r, is set back to zero. _____ _____ ___ ______ ____ _____ State Rec'd_Msg Action Next_state ______ ____ _______ ___ _ _______ Rec_Server_Idle -- Server idle, waiting for a message Set n and r to 0 I(0) Send ACK Rec_Server_Idle S(0) Process params, ACK with params, n+ Rec_File R(0) Save file name Send_Init K, C or G(0) Short reply: ACK(0)/reply Rec_Server_Idle Long reply: init needed Send_Init init not needed, n+ Open_File Timeout Send NAK(0) Rec_Server_Idle Other Error Rec_Server_Idle _____ _____ ___ ___ ______ _______ _______ Rec_Init -- Entry point for non-server RECEIVE command Set n and r to 0 S(0) Process params, send ACK with params, n+ Rec_File Timeout Send NAK(0), r+ Rec_Init Other NAK Abort Optional Features Optional Features Optional Features Page 47 ____ ___ _ ____ ______ __ ___ _______ Rec_File -- Look for a file header or EOT message F(n) Open file, ACK, n+ Rec_Data X(n) Prepare to type on screen, ACK, n+ Rec_Data B(n) ACK Complete S(n-1) ACK with params, r+ Rec_File Z(n-1) ACK, r+ Rec_File Timeout NAK, r+ Rec_File Other NAK Abort _______ ____ __ __ ___ __ ____ Rec_Data -- Receive data up to end of file D(n) Store data, ACK, n+; If interruption wanted include X or Z in ACK Rec_Data D(n-1) Send ACK, r+ Rec-Data Z(n) Close file, ACK, n+ Rec_File Z(n)/D Discard file, ACK, n+ Rec_File F(n-1) Send ACK, r+ Rec_Data X(n-1) Send ACK, r+ Rec_Data Timeout Send NAK, r+ Rec_Data Other Send E Abort ____ _____ ___ ____ _______ Send_Init -- Also entry for SEND command Set n and r to 0, send S(0) with parameters Y(0) Process params, n+ Open_File N, Timeout r+ Send_Init Other r+ Send_Init ____ ____ __ ___ __ ____ __ ____ Open_File -- Open file or set up text to send Send_File ____ ____ __ ____ ______ Send_File -- Send file or text header Send F or X(n) Y(n), N(n+1) Get first buffer of Send_Data or Send_Eof if data, n+ empty file or text N, Timeout r+ Send_File Other Abort Optional Features Optional Features Optional Features Page 48 ____ ________ __ ____ __ _______ ___________ Send_Data -- Send contents of file or textual information Send D(n) with current buffer Y(n), N(n+1) n+, Get next buffer Send_Data or Send_Eof if at end of file or text Y(n)/X or Z n+ Send_Eof N, Timeout r+ Send_Data Other Abort ____ ___ __ ____ _________ Send_Eof -- Send end of file indicator Send Z(n); if interrupting send Z(n)/D Y(n), N(n+1) Open next file, n+ Send_File if more, or Send_Break if no more or if interrupt "Z". N, Timeout r+ Send_Eof Other Abort ___ __ ___________ Send_Break -- End of Transaction Send B(n) Y(n), N(0) Complete N(n), Timeout Send_Break Other Abort _____ ___ ______ ________ _____ ______ _____ ________ Send_Server_Init - Entry for Server commands which expect large response. Send I(0) with parameters Y(0) Process params Send_Gen_Cmd N, Timeout r+ Send_Server_Init E Use default params Send_Gen_Cmd Other Abort Optional Features Optional Features Optional Features Page 49 _____ ___ ______ ________ _____ ______ _____ ________ ___ Send_Gen_Cmd - Entry for Server commands which expect short response (ACK) Send G, R or C(0) S(0) Process params, ACK with params, n+ Rec_File X(1) Setup to type on terminal, n+ Rec_Data Y(0) Type data on TTY Complete N, Timeout r+ Send_Gen_Cmd Other Abort __________ __________ __ ___________ Complete -- Successful Completion of Transaction Set n and r to 0; If server, reset params, enter Rec_Server_Idle otherwise exit _________ ___________ __ ___________ Abort -- Premature Termination of Transaction Reset any open file, set n and r to 0 If server, reset params, enter Rec_Server_Idle otherwise exit Exit, Logout states Exit or Logout Note that the generic commands determine the next state as follows: 1. If the command is not supported, an error packet is sent and the next state is "Abort". 2. If the command generates a response which can be fit into the data portion of an ACK, an ACK is sent with the text (quoted as necessary) in the data portion. 3. If the command generates a large response or must send a file, noth- ing is sent from the Rec_Server_Idle state, and the next state is either Send_Init (if either no I message was received or if alter- nate block check types are to be used), or Open_File (if an I mes- sage was received and the single character block check is to be used). 4. If the command is Logout, an ACK is sent and the new state is Optional Features Optional Features Optional Features Page 50 Logout. 5. If the command is Exit, an ACK is sent and the new state is Exit. KERMIT Commands KERMIT Commands KERMIT Commands Page 51 CHAPTER 9 CHAPTER 9 CHAPTER 9 KERMIT COMMANDS KERMIT COMMANDS KERMIT COMMANDS The following list of KERMIT commands and terms is suggested. It is not in- tended to recommend a particular style of command parsing, only to promote a consistent vocabulary, both in documentation and in choosing the names for com- mands. 9.1. Basic Commands 9.1. Basic Commands 9.1. Basic Commands SEND This verb tells a Kermit program to send one or more files from its own file structure. RECEIVE This verb should tell a Kermit program to expect one or more files to arrive. GET This verb should tell a user Kermit to send one or more files. Some Kermit implementations have separate RECEIVE and GET commands; others use RECEIVE for both purposes, which creates confusion. Since it can be useful, even necessary, to specify different names for source and destination files, these commands should take operands as follows (optional operands in [brackets]): SEND local-source-filespec [remote-destination-filespec] If the destination file specification is included, this will go in the file header packet, instead of the file's local name. RECEIVE [local-destination-filespec] If the destination filespec is given, the incoming file will be stored under that name, rather than the one in the file header pakcet. GET remote-source-filespec [local-destination-filespec] If the destination filespec is given, the incoming file will be stored under that name, rather than the one in the file header packet. ___ If a file group is being sent or received, alternate names should not be used. 9.2. Program Management Commands 9.2. Program Management Commands 9.2. Program Management Commands EXIT Leave the KERMIT program, doing whatever cleaning up must be done -- deassigning of devices, closing of files, etc. QUIT Leave the KERMIT program without cleaning up, in such a manner as to allow further manipulation of the files and devices. PUSH Preserve the current KERMIT environment and enter the system command processor. TAKE Read and execute KERMIT program commands from a local file. KERMIT Commands KERMIT Commands KERMIT Commands Page 52 LOG Specify a log for file transfer transactions, or for terminal session loggin. 9.3. Terminal Emulation Commands 9.3. Terminal Emulation Commands 9.3. Terminal Emulation Commands CONNECT This verb, valid only for a local Kermit, means to go into terminal emulation mode; present the illusion of being directly connected as a terminal to the remote system. Provide an "escape character" to allow the user to "get back" to the local system. The escape character, when typed, should take a single-character argument; the following are sug- gested: 0 (zero) Transmit a NUL B Transmit a BREAK C Close the connection, return to local KERMIT command level P Push to system command processor Q Quit logging (if logging is being done) R Resume logging S Show status of connection ? Show the available arguments to the escape character _ ______ ____ __ ___ ______ _________ (a second copy of the escape character): Transmit the escape character itself Lower case equivalents should be accepted. If any invalid argument is typed, issue a beep. Also see the SET command. 9.4. Special User-Mode Commands 9.4. Special User-Mode Commands 9.4. Special User-Mode Commands These commands are used only by Users of Servers. BYE This command sends a message to the remote server to log itself out, and upon successful completion, terminate the local Kermit program. FINISH This command causes the remote server to shut itself down gracefully without logging out its job, leaving the local KERMIT at KERMIT command level, allowing the user to re-CONNECT to the remote job. 9.5. Commands Whose Object Should Be Specified 9.5. Commands Whose Object Should Be Specified 9.5. Commands Whose Object Should Be Specified Some Kermit implementations include various local file management services and commands to invoke them. For instance, an implementation might have commands to let you get directory listings, delete files, switch disks, and inquire about free disk space without having to exit and restart the program. In ad- dition, remote servers may also provide such services. A user Kermit must be able to distinguish between commands aimed at its own system and those aimed at the remote one. When any confusion is possible, such a command may be prefixed by one of the following "object prefixes": KERMIT Commands KERMIT Commands KERMIT Commands Page 53 REMOTE Ask the remote Kermit server to provide this service. LOCAL Perform the service locally. If the "object prefix" is omitted, the command should be executed locally. The services include: LOGIN This should be used in its timesharing sense, to create an identity ("job", "session", "access", "account") on the system. LOGOUT To terminate a session that was initiated by LOGIN. COPY Make a new copy of the specified file with the specified name. CWD Change Working Directory. This is ugly, but more natural verbs like CONNECT and ATTACH are too imprecise. CWD is the ARPAnet file transfer standard command to invoke this function. DIRECTORY Provide a list of the names, and possibly other attributes, of the files in the current working directory (or the specified directory). DELETE Delete the specified files. ERASE This could be a synomym for DELETE, since its meaning is clear. (It doesn't seem wise to include UNDELETE or UNERASE in the standard list; most systems don't support such a function, and users' expectations should not be toyed with...) KERMIT Send a command to the remote KERMIT server in its own interactive com- mand syntax. RENAME Change the name of the specified file. TYPE Display the contents of the specified file(s) at the terminal. SPACE Tell how much space is used and available for storing files in the cur- rent working directory (or the specified directory). SUBMIT Submit the specified file(s) for background (batch) processing. PRINT Print the specified file(s) on a printer. MOUNT Request a mount of the specified tape, disk, or other removable storage medium. WHO Show who is logged in (e.g. to a timesharing system), or give infor- mation about a specified user or network host. MAIL Send electronic mail to the specified user(s). KERMIT Commands KERMIT Commands KERMIT Commands Page 54 MESSAGE Send a terminal message (on a network or timesharing system). HELP Give brief information about how to use KERMIT. SET Set various parameters relating to debugging, transmission, file mode, and so forth. SHOW Display settings of SET parameters, capabilities in force, etc. STATISTICS Give information about the performance of the most recent file transfer -- elapsed time, effective baud rate, various counts, etc. HOST Pass the given command string to the specified (i.e. remote or local) host for execution in its own command language. LOGGING Open or close a remote transaction or debugging log. 9.6. The SET Command 9.6. The SET Command 9.6. The SET Command A SET command should be provided to allow the user to tailor a connection to the peculiarities of the communication path, the local or remote file system, etc. Here are some parameters that should be SET-able: BLOCK-CHECK Specify the type of block check to be used: single character checksum, two-character checksum, 3-character CRC. DEBUGGING Display or log the packet traffic, packet numbers, and/or program states. Useful for debugging new versions of KERMIT, novel combina- tions of KERMIT programs, etc. DELAY How many seconds a remote (non-server) KERMIT should wait before send- ing the Send-Init packet, to give the user time to escape back to the local KERMIT and type a RECEIVE command. DUPLEX For terminal emulation, specify FULL or HALF duplex echoing. EIGHT-BIT-PREFIXING Specify that "8th bit" prefixing must be done; normally it will not be done. END-OF-LINE Specify any line terminator that must be used after a packet. ESCAPE Specify the escape character for terminal emulation. FILE attributes Almost any of the attributes listed above in the Attributes section (8.5). The most common need is to tell the KERMIT program whether an KERMIT Commands KERMIT Commands KERMIT Commands Page 55 incoming or outbound file is text or binary. FLOW-CONTROL Specify the flow control mechanism for the line, such as XON/XOFF, DTR/CTS, etc. Allow flow control to be turned off as well as on. Flow control is done only on full-duplex connections. HANDSHAKE Specify any line-access negotiation that must be used or simulated during file transfer. For instance, a half duplex system will often need to "turn the line around" after sending a packet, in order to give you permission to reply. A common handshake is XON (^Q); the current user of the line transmits an XON when done transmitting data. LINE Specify the line or device designator for the connection. This is for use in a KERMIT program that can run in either remote or local mode; the default line is the controlling terminal (for remote operation). If an external device is used, local operation is presumed. LOG Specify a local file in which to keep a log of the transaction. There may be logs for debugging purposes (packet traffic, state transitions, etc) and for auditing purposes (to record the name and disposition of each file transferred). MARKER Change the start-of-packet marker from the default of SOH (CTRL-A) to some other control character, in case one or both systems has problems using CTRL-A for this purpose. PACKET-LENGTH The maximum length for a packet. This should normally be no less than 30 or 40, and can never be greater than 96. Short packets can be an advantage on noisy lines; they reduce the probabily of a particular packet being corrupted, as well as the retransmission overhead when corruption does occur. PADDING The number of padding characters that should be sent before each packet, and what the padding character should be. Rarely necessary. PARITY Specify the parity (ODD, EVEN, MARK, SPACE, NONE) of the physical con- nection. If other than none, the "8th bit" cannot be used to transmit data and must not be used by either side in block check computation. PAUSE How many seconds to pause after receiving a packet before sending the next packet. Normally 0, but when a system communication processor or front end has trouble keeping up with the traffic, a short pause be- tween packets may allow it to recover its wits; hopefully, something under a second will suffice. PREFIX Change the default prefix for control characters, 8-bit characters, or repeated quantities. PROMPT Change the program's prompt. This is useful when running KERMIT be- KERMIT Commands KERMIT Commands KERMIT Commands Page 56 tween two systems whose prompt is the same, to eliminate confusion about which KERMIT you are talking to. REPEAT-COUNT-PROCESSING Change the default for repeat count processing. Normally, it will be done if both KERMIT programs agree to do it. RETRY The maximum number of times to attempt to send or receive a packet be- fore giving up. The normal number is about 5, but the user should be able to adjust it according to the condition of the line, the load on the systems, etc. TIMEOUT Specify the length of the timer to set when waiting for a packet to ar- rive. 9.7. Macros, the DEFINE Command 9.7. Macros, the DEFINE Command 9.7. Macros, the DEFINE Command In addition to the individual set commands, a "macro" facility is recommended to allow users to combine the characteristics of specific systems into a single SET option. For example: DEFINE IBM = PARITY ODD, DUPLEX HALF, HANDSHAKE XON DEFINE UNIX = PARITY NONE, DUPLEX FULL DEFINE TELENET = PARITY MARK This could be done by providing a fancy runtime parser for commands like this (which could be automatically TAKEn from the user's KERMIT initialization file upon program startup), or simply hardwired into the SET command table. With these definitions in place, the user would simply type "SET IBM", "SET UNIX", and so forth, to set up the program to communication to the remote sys- tem. Terminal Emulation Terminal Emulation Terminal Emulation Page 57 CHAPTER 10 CHAPTER 10 CHAPTER 10 TERMINAL EMULATION TERMINAL EMULATION TERMINAL EMULATION The local system must be able to act as a terminal so that the user can connect to the remote system, log in, and start up the remote KERMIT. Terminal emulation should be provided by any KERMIT program that runs locally, so that the user need not exit and restart the local KERMIT program in order to switch between terminal and protocol operation. On smaller systems, this is particularly important for various reasons -- restarting the program and typing in all the necessary SET commands is too inconvenient and time-consuming; in some micros, switching in and out of terminal emulation may cause carrier to drop, etc. Only bare-bones terminal emulation need be supplied by KERMIT; there is no need to emulate any particular kind of "smart" terminal. Simple "dumb" terminal emulation is sufficient to do the job. Emulation of fancier terminals is nice to have, however, to take advantage of the remote system's editing and display capabilities. In some cases, microcomputer firmware will take care of this. To build emulation for a particular type of terminal into the program, you must interpret and act upon escape sequences as they arrive at the port. No error checking is done during terminal emulation. It is "outside the protocol"; characters go back and forth "bare". In this sense, terminal emula- tion through KERMIT is no better than actually using a real terminal. Some KERMIT implementations may allow logging of the terminal emulation session to a local file. Such a facility allows "capture" of remote typescripts and files, again with no error checking or correction. When this facility is provided, it is also desirable to have a convenient way of "toggling" the log- ging on and off. If the local system does not provide system- or firmware-level flow control, like XON/XOFF, the terminal emulation program should attempt to simulate it, especially if logging is being done. The terminal emulation facility should be able to handle either remote or local echoing (full or half duplex), any required handshake, and it should be able to transmit any parity required by the remote side or the communication medium. A terminal emulator works by continuously sampling both console input from the local terminal and input from the communication line. Simple input and output functions will not suffice, however, since if you ask for input from a certain ____ device and there is none available, you will generally block until input does become available, during which time you will be missing input from the other device. Thus you must have a way to bounce back and forth regardless of whether input is available. Several mechanisms are commonly used: - Continuously jump back and forth between the port status register and the console status register, checking the status bits for input available. This is only practical on single-user, single-process systems, where the CPU has nothing else to do. Terminal Emulation Terminal Emulation Terminal Emulation Page 58 - Issue an ordinary blocking input request for the port, but enable in- terrupts on console input, or vice versa. - Handle port input in one process and console input in another, paral- lel process. The UNIX KERMIT program listed in this manual uses this method. Any input at the port should be displayed immediately on the screen. Any input from the console should be output immediately to the port. In addition, if the connection is half duplex, console input should also be sent immediately to the screen. The terminal emulation code must examine each console character to determine whether it is the "escape character". If so, it should take the next character as a special command, which it executes. These commands are described above, in section 9.3. The terminal emulator should be able to send every ASCII character, NUL through DEL, and it should also be able to transmit a BREAK signal (BREAK is not a character, but an "escape" from ASCII transmission in which a 0 is put on the line for about a quarter of a second, regardless of the baud rate, with no framing bits). BREAK is important when communicating with various systems, such as IBM mainframes. Finally, it is sometimes necessary to perform certain transformations on the CR character that is normally typed to end a line of input. Some systems use LF, EOT, or other characters for this function. To complicate matters, intervening communications equipment (particularly the public packet-switched networks) may have their own independent requirements. Thus if using KERMIT to communicate over, say, TRANSPAC with a system that uses LF for end-of-line, it may be necessary to transform CR into LFCR (linefeed first -- the CR tells the network to send the packet, which will contain the LF, and the host uses the LF for termination). The user should be provided with a mechanism for specifying this ________ transformation, a command like "SET CR sequence". Writing a KERMIT Program Writing a KERMIT Program Writing a KERMIT Program Page 59 CHAPTER 11 CHAPTER 11 CHAPTER 11 WRITING A KERMIT PROGRAM WRITING A KERMIT PROGRAM WRITING A KERMIT PROGRAM Before writing a new implementation of KERMIT or modifying an old one, first be sure to contact the KERMIT Distribution center at Columbia University to make sure that you're not duplicating someone else's effort, and that you have all the latest material to work from. If you do write or significantly modify (or document) a KERMIT program, please send it back to Columbia so that it can be included in the standard KERMIT distribution and others can benifit from it. It is only through this kind of sharing that KERMIT has grown from its modest beginnings to its present scale. The following sections provide some hints on KERMIT programming. 11.1. Program Organization 11.1. Program Organization 11.1. Program Organization A basic KERMIT implementation can usually be written as a relatively small program, self-contained in a single source file. However, it is often the case that a program written to run on one system will be adapted to run on other systems as well. In that case, it is best to avoid having totally divergent sources, because when new features are added to (or bugs fixed in) the system- independent parts of the program -- i.e. to the protocol itself -- only one im- plementation will reap the benefits initially, and the other will require pain- ful, error-prone "retrofitting" to bring it up to the same level. Thus, if there is any chance that a KERMIT program will run on more than one machine, or under more than one operating system, or support more than one kind of port or modem, etc, it is desirable to isolate the system-dependent parts in a way that makes the common parts usable by the various implementations. There are several approaches: 1. Runtime support. If possible, the program can inspect the hardware or inquire of the system about relevant parameters, and configure itself dynamically at startup time. This is hardly ever possible. 2. Conditional compilation (or assembly). If the number of systems or options to be supported is small, the system dependent code can be enclosed in conditional compilation brackets (like IF IBMPC .... ENDIF). An example is provided in UNIX KERMIT listing included with this manual. However, as the number of system dependencies to be supported grows, this method becomes unwieldy and error-prone -- installing support for system X tends to break the pre-existing support for system Y. 3. Modular composition. When there is a potentially large number of options a program should support, it should be broken up into separate modules (source files), with clearly specified, simple calling conventions. This allows people with new options to provide their own support for them in an easy way, without endangering any existing support. Suggested modules for a KERMIT program are: Writing a KERMIT Program Writing a KERMIT Program Writing a KERMIT Program Page 60 - System-Indendent protocol handling: state switching, packet formation, encoding (prefixing) and decoding, etc. - User Interface: the command parser. Putting this in a separate module allows plug-in of command parsers to suit the user's taste, to mimic the style of the host system command parser or some popular application, etc. - Screen i/o: This module would contain the screen control codes, cursor positioning routines, etc. - Port i/o: Allows support of various port hardware. This module can define the port status register location, the status bits, and so forth, and can implement the functions to read and write characters at the port. - Modem control: This module would support any kind of "intelligent" modem, which is not simply a transparent exten- sion of the communications port. Such modems may accept spe- cial commands to perform functions like dialing out, redialing a recent number, hanging up, etc., and may need special in- itialization (for instance, setting modem signals like DTR). - Console input: This module would supply the function to get characters from the console; it would know about the status register locations and bits, interrupt structure, key-to- character mappings, etc., and could also implement key redefinitions, keystroke macros, programmable function keys, expanded control and meta functions, etc. - Terminal Emulation: This module would interpret escape se- quences in the incoming character stream (obtained from the port i/o module) for the particular type of terminal being emu- lated and interpret them by making appropriate calls the the screen i/o module, and it would send user typein (obtained from the console input module) out the serial port (again using the port i/o module). Ideally, this module could be replacable by other modules to emulate different kinds of terminals (e.g. ANSI, VT52, ADM3A, etc). - File i/o: This module contains all the knowledge about the host system's file structure; how to open and close files, perform "get next file" operations, read and write files, determine and set their attributes, detect the end of a file, and so forth, and provides the functions, including buffering, to get a character from a file and put a character to a file. This module may also provide file management services for local files -- directory listings, deleting, renaming, copying, and so forth. - Definitions and Data: Separate modules might also be kept for compile-time parameter definitions and for global runtime data. Writing a KERMIT Program Writing a KERMIT Program Writing a KERMIT Program Page 61 11.2. Programming Language 11.2. Programming Language 11.2. Programming Language The language to be used in writing a KERMIT program is more than a matter of taste. The primary consideration is that the language provide the necessary functionality and speed. For instance, a microcomputer implementation of BASIC may not allow the kind of low-level access to device registers needed to do terminal emulation, or to detect console input during file transfer, or even if it can do these things, it might not be able to run fast enough do drive the communication line at the desired baud rate. The second consideration in choosing a language is portability. This is used in two senses: (1) whether the language is in the public domain (or, equiv- alently, provided "free" as part of the basic system), and (2) whether it is well standardized and in wide use on a variety of systems. A language that is portable in both senses is to be preferred. Whatever programming language is selected, it is important that all lines in the program source be kept to 80 characters or less (after expansion of tabs). This is because KERMIT material must often be shipped over RJE and other card- format communication links. In addition, it is important that the names of all files used in creating and supporting a particular KERMIT implementation be (possibly a subset) of the form NAME.TYPE, where NAME is limited to six characters, and TYPE is limited to three, and where the NAME of each file begin with a common 2 or 3 character prefix. This is so that all related files will be grouped together in an al- phabetic directory listing, and so when all of the hundreds of KERMIT related files are placed together on a tape, all names will be both legal and unique, especially on systems (like PDP-11 operating systems) with restrictive file naming conventions. 11.3. Documentation 11.3. Documentation 11.3. Documentation A new KERMIT program should be thoroughly documented; one of the hallmarks of KERMIT is its documentation. The documentation should be at both the user level (how to use the program, what the commands are, etc, similar to the ______ _____ _____ documentation presently found in the Kermit Users Guide), and the implemen- tation level (describe system dependencies, give pointers for adapting to new systems, and so forth). In addition, programs themselves should contain copious commentary. Like program source, documentation should be kept within 80-character lines. If possible, a section for the implementation should be written for the KERMIT User Guide using the UNILOGIC Scribe formatting language (subsets of which are also to be found in some microcomputer text processing software such as Perfect Writer or Final Word), using the same general conventions as the existic Scribe-format implementation sections. KERMIT programs should also contain a revision history, in which each change is briefly explained, assigned an "edit number", and the programmer and site are identified. The lines or sections comprising the edit should be marked with Writing a KERMIT Program Writing a KERMIT Program Writing a KERMIT Program Page 62 the corresponding edit number, and the KERMIT program, upon startup, should an- nounce its version and edit numbers, so that when users complain of problems we will know what version of the program is in question. The version number changes when the functionality has been changed sufficiently to require major revisions of user documentation. The edit number should in- crease (monotonically, irrespective of version number) whenever a change is made to the program. The edit numbers are very important for program manage- ment; after shipping out a version of, say, CP/M KERMIT-80, we often receive many copies of it, each containing its own set of changes, which we must recon- cile in some manner. Edit numbers help a great deal here. 11.4. Bootstrapping 11.4. Bootstrapping 11.4. Bootstrapping Finally, a bootstrap procedure should be provided. KERMIT is generally dis- tributed on magnetic tape to large central sites; the users at those sites need ways of "downloading" the various implementations to their micros and other local systems. A simple bootstrap procedure would consist of precise instruc- tions on how to accomplish an "unguarded" capture of the program. Perhaps a simple, short program can be written for each each end that will do the job; listings and instructions can be provided for the user to type in and run these programs. Packet Format and Types Packet Format and Types Packet Format and Types Page 63 I. PACKET FORMAT AND TYPES I. PACKET FORMAT AND TYPES I. PACKET FORMAT AND TYPES KERMIT Packet Layout: KERMIT Packet Layout: KERMIT Packet Layout: +------+-----+-----+------+------------+-------+ | MARK | LEN | SEQ | TYPE | DATA | CHECK | +------+-----+-----+------+------------+-------+ Send-Init Data Field Layout: Send-Init Data Field Layout: Send-Init Data Field Layout: 1 2 3 4 5 6 7 8 9 10... +------+------+------+------+------+------+------+------+------+------- | MAXL | TIME | NPAD | PADC | EOL | QCTL | QBIN | CHKT | REPT | CAPAS +------+------+------+------+------+------+------+------+------+------- KERMIT packet types and subtypes; required types are marked with an asterisk (*): Y* Acknowledge (ACK) N* Negative acknowledge (NAK) S* Send initiate (exchange parameters) I Initialize (exchange parameters) F* File header A File attributes D* Data packet Z* End of file (EOF) B* Break transmission (EOT) E* Error R Receive Initiate (ask the server to send the specified files) C Host Command K KERMIT Command ________ ___ ________ ___ T Reserved for internal use ___________ G Generic Kermit Command; Subcommands: I Login (or logout) C CWD, Change Working Directory L Bye F Finish D Directory U Disk Usage Query E Erase, Delete T Type R Rename K Copy W Who's logged in? M Short Message H Help Q Server Status Query P Program Invocation J Journal Control V Variable Set/Query List of Features List of Features List of Features Page 64 II. LIST OF FEATURES II. LIST OF FEATURES II. LIST OF FEATURES There's no true linear scale along which to rate Kermit implementations. A basic, minimal implementation provides file transfer in both directions, and, for microcomputers (PC's, workstations, other single user systems), terminal emulation. Even within this framework, there can be variations. For instance, ____ _____ can the program send a file group in a single command, or must a command be issued for each file? Can it time out? Here is a list of features that may be present; for any KERMIT implementation, the documentation should show whether these features exist, and how to invoke them. - File groups. Can it send a group of files with a single command, using "wildcard", pattern, or list notation? Can it successfully send or receive a group of files of mixed types? Can it recover from an error on a particular file and go on to the next one? Can it keep a log of the files involved showing the disposition of each? - Filenames. Can it take action to avoid overwriting a local file when a new file of the same name arrives? Can it convert filenames to and from legal or "normal form"? - File types. Can binary as well as text files be transmitted? - 8th-Bit prefixing. Can it send and receive 8-bit data through a 7-bit channel using the prefixing mechanism? - Repeat-Count processing. Can it send and receive data with repeated characters replaced by a prefix sequence? - Terminal Emulation. Does it have a terminal emulation facility? Does it provide various communication options, such as duplex, parity, and handshake selection? Can it transmit all ASCII charac- ters? Can it transmit BREAK? Can it log the remote session locally, to provide unguarded file capture? - Communications Options. Can duplex, parity, handshake, and line ter- minator be specified for file transfer? - Block Check Options. In addition to the basic single-character checksum, can the two-character checksum and the three-character CRC be selected? - Basic Server. Can it run in server mode, accepting commands to send or receive files, and to shut itself down? - Advanced Server. Can it accept server commands to delete files, provide directory listings, send messages, and forth? - Issue Commands to Server. Can it send commands to a server, and handle all possible responses? - Host Commands. Can it parse and send remote "host commands"? If it List of Features List of Features List of Features Page 65 is a server, can it pass these commands to the host system command processor and return the results to the local user Kermit? - Interrupt File Transfers. Can it interrupt sending or receiving a file? Can it respond to interrupt requests from the other side? - Local File Management Services. Are there commands to get local directory directory listings, delete local files, and so forth? - File Attributes. Can it send file attribute information about local files, and can deal with incoming file attribute information? Can alternate dispositions be specified. Can files be archived? - Debugging Capability. Can packet traffic be logged, examined, single-stepped? Unresolved Issues Unresolved Issues Unresolved Issues Page 66 III. UNRESOLVED ISSUES III. UNRESOLVED ISSUES III. UNRESOLVED ISSUES KERMIT doesn't do everything. Here is a short list of things it doesn't do, or could do better. - KERMIT cannot be used through IBM 3270 protocol emulators. These are devices that allow asynchronous ASCII terminals or PCs to communicate with IBM mainframes as though they were synchronous full-screen dis- plays. The problems include: (a) the protocol converter translates from EBCDIC to ASCII -- that is, it assumes it is receiving EBCDIC when KERMIT is supposed to be sending ASCII -- according to its own translate table, which may vary from site to site, and is not a 1-to-1 mapping in any case; (b) non-printing control characters (like SOH) cannot be sent at all; (c) the protocol converter looks for 3270 formatting commands and translates them to escape sequences for the ASCII terminal, possibly modifying packet data; (d) the IBM system automatically pauses at the end of each screenful; (e) the protocol converter thinks it knows what is "on the screen" and may attempt to optimize. In general, one never knows exactly how a particular protocol converter will work, or how it may differ from another one. Still, it may be possible to work around these problems if the Ker- mits on either end are put into a special "3270 mode", "clear the screen" between each packet, and agree on some special convention for packet delimitation and data translation. - Control character prefixing. This can get pretty expensive for bi- nary files or other files that contain lots of control characters. Since most hosts won't choke on every single control character, it might be a good idea for each host to inform the other of what con- trol characters it can receive "bare". On the other hand, this could backfire when the two hosts are connected by a network or device that chokes on control characters that neither of the hosts choke on. For hardwired connections with no unknown factors, however, many control characters could be sent "bare". - When long sequences of characters in the control range are being sent, individually prefixing each character is costly. Shift-in/ shift-out codes might be used more effectively here. Same for long strings of characters with the parity bit on, when 8th-bit prefixing is being done. The cost would be yet another set of prefix charac- ters, and the associated complexity of packet formation and decoding. - In some situations, certain printable characters can't get through a communication link. For instance, a network terminal server might reserve "@" as its attention character. Should the protocol allow some way to encode such characters for translation? A set of user- definable escape sequences could be useful here. - Ironically, some systems do not fare well with KERMIT's small packet sizes. These are typically big mainframes that expect to communicate with block mode terminals, receiving thousands of characters at a time. Such systems find that KERMIT is simply too expensive to run. Unresolved Issues Unresolved Issues Unresolved Issues Page 67 Meanwhile, other systems that can run KERMIT with no difficulty find the performance disappointing (the efficiency generally works out somewhere between 50 and 80 percent, i.e. data characters divided by the speed of the the transmission line, in characters per second). These two problems could be solved in either of two ways: allow longer packets, or allow multiple data packets to be sent end to end. * Without changing the format or encoding of the packet control fields, it might be possible to have longer packets by reserving packet lengths of 0, 1, 2, 3 to be codes for bigger numbers like 200, 500, 1000, 2000. However, the longer the packet, the greater the probability of corruption, and the longer to retransmit once corrupted. In addition, the adequacy of the single-character block check would be much reduced for long packets; long packets should therefore be sent with type 2 or 3 block checks. * It would be possible to extend the protocol to allow transmis- sion of data packets while ACKs were still outstanding, and any ACK would be taken as an ACK for the specified packet and all previous ones. A limit on the number of outstanding ACKs could be agreed upon; the maximum size of this "floating window" would have to be less than 64, which is where KERMIT packet numbers wrap around, and the window could not extend over a wraparound _ or else KERMIT would have no way of knowing whether n times 64 packets had been skipped. A floating window of 8 and a packet size of 95 would give about the same effect as 700-character packets. A NAK would require the sender to back up all the way to the NAK'd packet. A future edition of the Protocol Manual might include a specification for floating windows. A KERMIT Program A KERMIT Program A KERMIT Program Page 68 IV. A KERMIT PROGRAM IV. A KERMIT PROGRAM IV. A KERMIT PROGRAM What follows is a listing of a real production version of KERMIT, written in 4 the C language . It is designed to run under various versions of the UNIX operating system. The basic KERMIT functionality is present, but very little in the way of optional features. Only the most rudimentary (UNIX-style) com- mand parser is provided. The program illustrates many of the considerations described in this manual, with respect to the protocol, the program design, and so forth. It must be emphasized that this is a bare minimum implementation of Kermit. Anyone writing a new Kermit from scratch is encouraged to look at the source ______ _____ for one of the more advanced implementations as a model (check the Kermit Users _____ Guide for a list of KERMIT implementations and their features). Although you may not understand the language it's written in, there should be profuse com- ments that can be useful. The following program uses decimal notation for numbers, and tochar() rather than char() for integer-to-character conversion. /* * K e r m i t File Transfer Utility * * UNIX Kermit, Columbia University, 1981, 1982, 1983 * Bill Catchings, Bob Cattani, Chris Maio, Frank da Cruz, Alan Crosswell * * Also: Jim Guyton, Rand Corporation * Walter Underwood, Ford Aerospace * * usage: kermit c [lbe line baud escapechar] to connect * kermit s [d..iflb line baud] file ... to send files * kermit r [d..iflb line baud] to receive files * * where c=connect, s=send, r=receive, * d=debug, i=image mode, f=no filename conversion, l=tty line, * b=baud rate, e=escape char. * * For remote Kermit, format is either: * kermit r to receive files * or kermit s file ... to send files * */ _______________ 4 ___ _ ___________ ________ Kernighan & Ritchie, The_C_Programming_Language: Prentice-Hall (1978) A KERMIT Program A KERMIT Program A KERMIT Program Page 69 /* * Modification History: * * Oct. 17 Included fixes from Alan Crosswell (CUCCA) for IBM_UTS: * - Changed MYEOL character from \n to \r. * - Change char to int in bufill so getc would return -1 on * EOF instead of 255 (-1 truncated to 8 bits) * - Added read() in rpack to eat the EOL character * - Added fflush() call in printmsg to force the output * NOTE: The last three changes are not conditionally compiled * since they should work equally well on any system. * * Changed Berkeley 4.x conditional compilation flag from * UNIX4X to UCB4X. * Added support for error packets and cleaned up the printing * routines. */ #include /* Standard UNIX definitions */ /* Conditional compilation for different machines/operating systems */ /* One and only one of the following lines should be 1 */ #define UCB4X 1 /* Berkeley 4.x UNIX */ #define TOPS_20 0 /* TOPS-20 */ #define IBM_UTS 0 /* Amdahl UTS on IBM systems */ #define VAX_VMS 0 /* VAX/VMS (not yet implemented) */ /* Conditional compilation for the different Unix variants */ /* 0 means don't compile it, nonzero means do */ #if UCB4X #define V6_LIBS 0 /* Dont't use retrofit libraries */ #define NO_FIONREAD 0 /* We have ioctl(FIONREAD,...) for flushinput() */ #define NO_TANDEM 0 /* We have TANDEM line discipline (xon/xoff) */ #endif #if IBM_UTS #define V6_LIBS 0 /* Don't use retrofit libraries */ #define NO_FIONREAD 1 /* No ioctl(FIONREAD,...) for flushinput() */ #define NO_TANDEM 1 /* No TANDEM line discipline (xon/xoff) */ #endif A KERMIT Program A KERMIT Program A KERMIT Program Page 70 #if V6_LIBS #include #include #include #else #include #include #include #endif #if NO_TANDEM #define TANDEM 0 /* define it to be nothing if it's unsupported */ #endif /* Symbol Definitions */ #define MAXPACKSIZ 94 /* Maximum packet size */ #define SOH 1 /* Start of header */ #define CR 13 /* ASCII Carriage Return */ #define SP 32 /* ASCII space */ #define DEL 127 /* Delete (rubout) */ #define ESCCHR '^' /* Default escape character for CONNECT */ #define MAXTRY 10 /* Times to retry a packet */ #define MYQUOTE '#' /* Quote character I will use */ #define MYPAD 0 /* Number of padding characters I will need */ #define MYPCHAR 0 /* Padding character I need (NULL) */ #if IBM_UTS #define MYEOL '\r' /* End-Of-Line character for UTS systems */ #else #define MYEOL '\n' /* End-Of-Line character I need */ #endif #define MYTIME 10 /* Seconds after which I should be timed out */ #define MAXTIM 60 /* Maximum timeout interval */ #define MINTIM 2 /* Minumum timeout interval */ #define TRUE -1 /* Boolean constants */ #define FALSE 0 /* Macro Definitions */ A KERMIT Program A KERMIT Program A KERMIT Program Page 71 /* * tochar: converts a control character to a printable one by adding a space. * * unchar: undoes tochar. * * ctl: converts between control characters and printable characters by * toggling the control bit (ie. ^A becomes A and A becomes ^A). */ #define tochar(ch) ((ch) + ' ') #define unchar(ch) ((ch) - ' ') #define ctl(ch) ((ch) ^ 64 ) /* Global Variables */ int size, /* Size of present data */ rpsiz, /* Maximum receive packet size */ spsiz, /* Maximum send packet size */ pad, /* How much padding to send */ timint, /* Timeout for foreign host on sends */ n, /* Packet number */ numtry, /* Times this packet retried */ oldtry, /* Times previous packet retried */ ttyfd, /* File descriptor of tty for I/O, 0 if remote */ remote, /* -1 means we're a remote kermit */ image, /* -1 means 8-bit mode */ debug, /* indicates level of debugging output (0=none) */ filnamcnv, /* -1 means do file name case conversions */ filecount; /* Number of files left to send */ char state, /* Present state of the automaton */ padchar, /* Padding character to send */ eol, /* End-Of-Line character to send */ escchr, /* Connect command escape character */ quote, /* Quote character in incoming data */ **filelist, /* List of files to be sent */ *filnam, /* Current file name */ recpkt[MAXPACKSIZ], /* Receive packet buffer */ packet[MAXPACKSIZ]; /* Packet buffer */ FILE *fp, /* File pointer for current disk file */ *log; /* File pointer for Logfile */ jmp_buf env; /* Environment ptr for timeout longjump */ A KERMIT Program A KERMIT Program A KERMIT Program Page 72 /* * m a i n * * Main routine - parse command and options, set up the * tty lines, and dispatch to the appropriate routine. */ main(argc,argv) int argc; /* Character pointers to and count of */ char **argv; /* command line arguments */ { char *ttyname, /* tty name for LINE argument */ *cp; /* char pointer */ int speed, /* speed of assigned tty, */ cflg, rflg, sflg; /* flags for CONNECT, RECEIVE, SEND */ struct sgttyb rawmode, /* Controlling tty raw mode */ cookedmode, /* Controlling tty cooked mode */ ttymode; /* mode of tty line in LINE option */ if (argc < 2) usage(); /* Make sure there's a command line */ cp = *++argv; argv++; argc -= 2; /* Set up pointers to args */ /* Initialize these values and hope the first packet will get across OK */ eol = CR; /* EOL for outgoing packets */ quote = '#'; /* Standard control-quote char "#" */ pad = 0; /* No padding */ padchar = NULL; /* Use null if any padding wanted */ speed = cflg = sflg = rflg = 0; /* Turn off all parse flags */ ttyname = 0; /* Default is remote mode */ #if UCB4X /* Default to 7-bit masking, CRLF */ image = FALSE; /* translation and filename case */ filnamcnv = TRUE; /* conversion for UNIX systems */ #else image = TRUE; /* Default to no processing for */ filnamcnv = FALSE; /* non-UNIX systems */ #endif escchr = ESCCHR; /* Default escape character */ while ((*cp) != NULL) /* Parse characters in first arg. */ switch (*cp++) { case 'c': cflg++; break; /* C = Connect command */ case 's': sflg++; break; /* S = Send command */ case 'r': rflg++; break; /* R = Receive command */ A KERMIT Program A KERMIT Program A KERMIT Program Page 73 case 'd': /* D = Increment debug mode count */ debug++; break; case 'f': filnamcnv = FALSE; /* F = don't do case conversion */ break; /* on filenames */ case 'i': /* I = Image (8-bit) mode */ image = TRUE; break; /* (this is default for non-UNIX) */ case 'l': /* L = specify tty line to use */ if (argc--) ttyname = *argv++; else usage(); if (debug) printf("Line to remote host is %s\n",ttyname); break; case 'e': /* E = specify escape char */ if (argc--) escchr = **argv++; else usage(); if (debug) printf("Escape char is \"%c\"\n",escchr); break; case 'b': /* B = specify baud rate */ #if UCB4X if (argc--) speed = atoi(*argv++); else usage(); if (debug) printf("Line speed to remote host is %d\n",speed); break; #else printmsg("Speed setting implemented for Unix only."); exit(1); #endif } /* Done parsing */ if ((cflg+sflg+rflg) != 1) /* Only one command allowed */ usage(); A KERMIT Program A KERMIT Program A KERMIT Program Page 74 if (ttyname) /* If LINE was specified, we */ { /* operate in local mode */ ttyfd = open(ttyname,2); /* Open the tty line */ if (ttyfd < 0) { printmsg("Cannot open %s",ttyname); exit(1); } remote = FALSE; /* Indicate we're in local mode */ } else /* No LINE specified so we operate */ { /* in remote mode (ie. controlling */ ttyfd = 0; /* tty is the communications line) */ remote = TRUE; } /* Put the proper tty into the correct mode */ if (remote) /* If remote, use controlling tty */ { gtty(0,&cookedmode); /* Save current mode so we can */ gtty(0,&rawmode); /* restore it later */ rawmode.sg_flags |= (RAW|TANDEM); rawmode.sg_flags &= ~(ECHO|CRMOD); stty(0,&rawmode); /* Put tty in raw mode */ } else /* Local, use assigned line */ { gtty(ttyfd,&ttymode); ttymode.sg_flags |= (RAW|TANDEM); ttymode.sg_flags &= ~(ECHO|CRMOD); #if UCB4X /* Speed changing for UNIX only */ if (speed) /* User specified a speed? */ { switch(speed) /* Get internal system code */ { case 110: speed = B110; break; case 150: speed = B150; break; case 300: speed = B300; break; case 1200: speed = B1200; break; case 2400: speed = B2400; break; case 4800: speed = B4800; break; case 9600: speed = B9600; break; A KERMIT Program A KERMIT Program A KERMIT Program Page 75 default: printmsg("Bad line speed."); exit(1); } ttymode.sg_ispeed = speed; ttymode.sg_ospeed = speed; } #endif /* UCB4X */ stty(ttyfd,&ttymode); /* Put asg'd tty in raw mode */ } /* All set up, now execute the command that was given. */ if (debug) { printf("Debugging level = %d\n\n",debug); if (cflg) printf("Connect command\n\n"); if (sflg) printf("Send command\n\n"); if (rflg) printf("Receive command\n\n"); } if (cflg) connect(); /* Connect command */ if (sflg) /* Send command */ { if (argc--) filnam = *argv++; /* Get file to send */ else { if (remote) stty(0,&cookedmode); /* Restore controlling tty's modes */ usage(); /* and give error */ } fp = NULL; /* Indicate no file open yet */ filelist = argv; /* Set up the rest of the file list */ filecount = argc; /* Number of files left to send */ if (sendsw() == FALSE) /* Send the file(s) */ printmsg("Send failed."); /* Report failure */ else /* or */ printmsg("done."); /* success */ } if (rflg) /* Receive command */ { if (recsw() == FALSE) /* Receive the file(s) */ printmsg("Receive failed."); else /* Report failure */ printmsg("done."); /* or success */ } A KERMIT Program A KERMIT Program A KERMIT Program Page 76 if (remote) stty(0,&cookedmode); /* Restore controlling tty's modes */ } /* * s e n d s w * * Sendsw is the state table switcher for sending files. It loops until * either it finishes, or an error is encountered. The routines called * by sendsw are responsible for changing the state. * */ sendsw() { char sinit(), sfile(), sdata(), seof(), sbreak(); state = 'S'; /* Send initiate is the start state */ n = 0; /* Initialize message number */ numtry = 0; /* Say no tries yet */ while(TRUE) /* Do this as long as necessary */ { if (debug) printf("sendsw state: %c\n",state); switch(state) { case 'S': state = sinit(); break; /* Send-Init */ case 'F': state = sfile(); break; /* Send-File */ case 'D': state = sdata(); break; /* Send-Data */ case 'Z': state = seof(); break; /* Send-End-of-File */ case 'B': state = sbreak(); break; /* Send-Break */ case 'C': return (TRUE); /* Complete */ case 'A': return (FALSE); /* "Abort" */ default: return (FALSE); /* Unknown, fail */ } } } /* * s i n i t * * Send Initiate: send this host's parameters and get other side's back. */ char sinit() { int num, len; /* Packet number, length */ if (numtry++ > MAXTRY) return('A'); /* If too many tries, give up */ spar(packet); /* Fill up init info packet */ A KERMIT Program A KERMIT Program A KERMIT Program Page 77 flushinput(); /* Flush pending input */ spack('S',n,6,packet); /* Send an S packet */ switch(rpack(&len,&num,recpkt)) /* What was the reply? */ { case 'N': return(state); /* NAK, try it again */ case 'Y': /* ACK */ if (n != num) /* If wrong ACK, stay in S state */ return(state); /* and try again */ rpar(recpkt); /* Get other side's init info */ if (eol == 0) eol = '\n'; /* Check and set defaults */ if (quote == 0) quote = '#'; numtry = 0; /* Reset try counter */ n = (n+1)%64; /* Bump packet count */ return('F'); /* OK, switch state to F */ case 'E': /* Error packet received */ prerrpkt(recpkt); /* Print it out and */ return('A'); /* abort */ case FALSE: return(state); /* Receive failure, try again */ default: return('A'); /* Anything else, just "abort" */ } } /* * s f i l e * * Send File Header. */ char sfile() { int num, len; /* Packet number, length */ char filnam1[50], /* Converted file name */ *newfilnam, /* Pointer to file name to send */ *cp; /* char pointer */ if (numtry++ > MAXTRY) return('A'); /* If too many tries, give up */ A KERMIT Program A KERMIT Program A KERMIT Program Page 78 if (fp == NULL) /* If not already open, */ { if (debug) printf(" Opening %s for sending.\n",filnam); fp = fopen(filnam,"r"); /* open the file to be sent */ if (fp == NULL) /* If bad file pointer, give up */ { error("Cannot open file %s",filnam); return('A'); } } strcpy(filnam1, filnam); /* Copy file name */ newfilnam = cp = filnam1; while (*cp != '\0') /* Strip off all leading directory */ if (*cp++ == '/') /* names (ie. up to the last /). */ newfilnam = cp; if (filnamcnv) /* Convert lower case to upper */ for (cp = newfilnam; *cp != '\0'; cp++) if (*cp >= 'a' && *cp <= 'z') *cp ^= 040; len = cp - newfilnam; /* Compute length of new filename */ printmsg("Sending %s as %s",filnam,newfilnam); spack('F',n,len,newfilnam); /* Send an F packet */ switch(rpack(&len,&num,recpkt)) /* What was the reply? */ { case 'N': /* NAK, just stay in this state, */ num = (--num<0 ? 63:num); /* unless it's NAK for next packet */ if (n != num) /* which is just like an ACK for */ return(state); /* this packet so fall thru to... */ case 'Y': /* ACK */ if (n != num) return(state); /* If wrong ACK, stay in F state */ numtry = 0; /* Reset try counter */ n = (n+1)%64; /* Bump packet count */ size = bufill(packet); /* Get first data from file */ return('D'); /* Switch state to D */ case 'E': /* Error packet received */ prerrpkt(recpkt); /* Print it out and */ return('A'); /* abort */ case FALSE: return(state); /* Receive failure, stay in F state */ default: return('A'); /* Something else, just "abort" */ } } A KERMIT Program A KERMIT Program A KERMIT Program Page 79 /* * s d a t a * * Send File Data */ char sdata() { int num, len; /* Packet number, length */ if (numtry++ > MAXTRY) return('A'); /* If too many tries, give up */ spack('D',n,size,packet); /* Send a D packet */ switch(rpack(&len,&num,recpkt)) /* What was the reply? */ { case 'N': /* NAK, just stay in this state, */ num = (--num<0 ? 63:num); /* unless it's NAK for next packet */ if (n != num) /* which is just like an ACK for */ return(state); /* this packet so fall thru to... */ case 'Y': /* ACK */ if (n != num) return(state); /* If wrong ACK, fail */ numtry = 0; /* Reset try counter */ n = (n+1)%64; /* Bump packet count */ if ((size = bufill(packet)) == EOF) /* Get data from file */ return('Z'); /* If EOF set state to that */ return('D'); /* Got data, stay in state D */ case 'E': /* Error packet received */ prerrpkt(recpkt); /* Print it out and */ return('A'); /* abort */ case FALSE: return(state); /* Receive failure, stay in D */ default: return('A'); /* Anything else, "abort" */ } } /* * s e o f * * Send End-Of-File. */ char seof() { int num, len; /* Packet number, length */ if (numtry++ > MAXTRY) return('A'); /* If too many tries, "abort" */ A KERMIT Program A KERMIT Program A KERMIT Program Page 80 spack('Z',n,0,packet); /* Send a 'Z' packet */ switch(rpack(&len,&num,recpkt)) /* What was the reply? */ { case 'N': /* NAK, just stay in this state, */ num = (--num<0 ? 63:num); /* unless it's NAK for next packet, */ if (n != num) /* which is just like an ACK for */ return(state); /* this packet so fall thru to... */ case 'Y': /* ACK */ if (n != num) return(state); /* If wrong ACK, hold out */ numtry = 0; /* Reset try counter */ n = (n+1)%64; /* and bump packet count */ if (debug) printf(" Closing input file %s, ",filnam); fclose(fp); /* Close the input file */ fp = NULL; /* Set flag indicating no file open */ if (debug) printf("looking for next file...\n"); if (gnxtfl() == FALSE) /* No more files go? */ return('B'); /* if not, break, EOT, all done */ if (debug) printf(" New file is %s\n",filnam); return('F'); /* More files, switch state to F */ case 'E': /* Error packet received */ prerrpkt(recpkt); /* Print it out and */ return('A'); /* abort */ case FALSE: return(state); /* Receive failure, stay in Z */ default: return('A'); /* Something else, "abort" */ } } /* * s b r e a k * * Send Break (EOT) */ char sbreak() { int num, len; /* Packet number, length */ if (numtry++ > MAXTRY) return('A'); /* If too many tries "abort" */ spack('B',n,0,packet); /* Send a B packet */ switch (rpack(&len,&num,recpkt)) /* What was the reply? */ { case 'N': /* NAK, just stay in this state, */ num = (--num<0 ? 63:num); /* unless NAK for previous packet, */ if (n != num) /* which is just like an ACK for */ return(state); /* this packet so fall thru to... */ A KERMIT Program A KERMIT Program A KERMIT Program Page 81 case 'Y': /* ACK */ if (n != num) return(state); /* If wrong ACK, fail */ numtry = 0; /* Reset try counter */ n = (n+1)%64; /* and bump packet count */ return('C'); /* Switch state to Complete */ case 'E': /* Error packet received */ prerrpkt(recpkt); /* Print it out and */ return('A'); /* abort */ case FALSE: return(state); /* Receive failure, stay in B */ default: return ('A'); /* Other, "abort" */ } } /* * r e c s w * * This is the state table switcher for receiving files. */ recsw() { char rinit(), rfile(), rdata(); /* Use these procedures */ state = 'R'; /* Receive-Init is the start state */ n = 0; /* Initialize message number */ numtry = 0; /* Say no tries yet */ while(TRUE) { if (debug) printf(" recsw state: %c\n",state); switch(state) /* Do until done */ { case 'R': state = rinit(); break; /* Receive-Init */ case 'F': state = rfile(); break; /* Receive-File */ case 'D': state = rdata(); break; /* Receive-Data */ case 'C': return(TRUE); /* Complete state */ case 'A': return(FALSE); /* "Abort" state */ } } } /* * r i n i t * * Receive Initialization */ A KERMIT Program A KERMIT Program A KERMIT Program Page 82 char rinit() { int len, num; /* Packet length, number */ if (numtry++ > MAXTRY) return('A'); /* If too many tries, "abort" */ switch(rpack(&len,&num,packet)) /* Get a packet */ { case 'S': /* Send-Init */ rpar(packet); /* Get the other side's init data */ spar(packet); /* Fill up packet with my init info */ spack('Y',n,6,packet); /* ACK with my parameters */ oldtry = numtry; /* Save old try count */ numtry = 0; /* Start a new counter */ n = (n+1)%64; /* Bump packet number, mod 64 */ return('F'); /* Enter File-Receive state */ case 'E': /* Error packet received */ prerrpkt(recpkt); /* Print it out and */ return('A'); /* abort */ case FALSE: /* Didn't get packet */ spack('N',n,0,0); /* Return a NAK */ return(state); /* Keep trying */ default: return('A'); /* Some other packet type, "abort" */ } } /* * r f i l e * * Receive File Header */ char rfile() { int num, len; /* Packet number, length */ char filnam1[50]; /* Holds the converted file name */ if (numtry++ > MAXTRY) return('A'); /* "abort" if too many tries */ A KERMIT Program A KERMIT Program A KERMIT Program Page 83 switch(rpack(&len,&num,packet)) /* Get a packet */ { case 'S': /* Send-Init, maybe our ACK lost */ if (oldtry++ > MAXTRY) return('A'); /* If too many tries "abort" */ if (num == ((n==0) ? 63:n-1)) /* Previous packet, mod 64? */ { /* Yes, ACK it again with */ spar(packet); /* our Send-Init parameters */ spack('Y',num,6,packet); numtry = 0; /* Reset try counter */ return(state); /* Stay in this state */ } else return('A'); /* Not previous packet, "abort" */ case 'Z': /* End-Of-File */ if (oldtry++ > MAXTRY) return('A'); if (num == ((n==0) ? 63:n-1)) /* Previous packet, mod 64? */ { /* Yes, ACK it again. */ spack('Y',num,0,0); numtry = 0; return(state); /* Stay in this state */ } else return('A'); /* Not previous packet, "abort" */ case 'F': /* File Header (just what we want) */ if (num != n) return('A'); /* The packet number must be right */ strcpy(filnam1, packet); /* Copy the file name */ if (filnamcnv) /* Convert upper case to lower */ for (filnam=filnam1; *filnam != '\0'; filnam++) if (*filnam >= 'A' && *filnam <= 'Z') *filnam |= 040; if ((fp=fopen(filnam1,"w"))==NULL) /* Try to open a new file */ { error("Cannot create %s",filnam1); /* Give up if can't */ return('A'); } else /* OK, give message */ printmsg("Receiving %s as %s",packet,filnam1); spack('Y',n,0,0); /* Acknowledge the file header */ oldtry = numtry; /* Reset try counters */ numtry = 0; /* ... */ n = (n+1)%64; /* Bump packet number, mod 64 */ return('D'); /* Switch to Data state */ case 'B': /* Break transmission (EOT) */ if (num != n) return ('A'); /* Need right packet number here */ spack('Y',n,0,0); /* Say OK */ return('C'); /* Go to complete state */ A KERMIT Program A KERMIT Program A KERMIT Program Page 84 case 'E': /* Error packet received */ prerrpkt(recpkt); /* Print it out and */ return('A'); /* abort */ case FALSE: /* Didn't get packet */ spack('N',n,0,0); /* Return a NAK */ return(state); /* Keep trying */ default: return ('A'); /* Some other packet, "abort" */ } } /* * r d a t a * * Receive Data */ char rdata() { int num, len; /* Packet number, length */ if (numtry++ > MAXTRY) return('A'); /* "abort" if too many tries */ switch(rpack(&len,&num,packet)) /* Get packet */ { case 'D': /* Got Data packet */ if (num != n) /* Right packet? */ { /* No */ if (oldtry++ > MAXTRY) return('A'); /* If too many tries, abort */ if (num == ((n==0) ? 63:n-1)) /* Else check packet number */ { /* Previous packet again? */ spack('Y',num,6,packet); /* Yes, re-ACK it */ numtry = 0; /* Reset try counter */ return(state); /* Don't write out data! */ } else return('A'); /* sorry, wrong number */ } /* Got data with right packet number */ bufemp(packet,len); /* Write the data to the file */ spack('Y',n,0,0); /* Acknowledge the packet */ oldtry = numtry; /* Reset the try counters */ numtry = 0; /* ... */ n = (n+1)%64; /* Bump packet number, mod 64 */ return('D'); /* Remain in data state */ A KERMIT Program A KERMIT Program A KERMIT Program Page 85 case 'F': /* Got a File Header */ if (oldtry++ > MAXTRY) return('A'); /* If too many tries, "abort" */ if (num == ((n==0) ? 63:n-1)) /* Else check packet number */ { /* It was the previous one */ spack('Y',num,0,0); /* ACK it again */ numtry = 0; /* Reset try counter */ return(state); /* Stay in Data state */ } else return('A'); /* Not previous packet, "abort" */ case 'Z': /* End-Of-File */ if (num != n) return('A'); /* Must have right packet number */ spack('Y',n,0,0); /* OK, ACK it. */ fclose(fp); /* Close the file */ n = (n+1)%64; /* Bump packet number */ return('F'); /* Go back to Receive File state */ case 'E': /* Error packet received */ prerrpkt(recpkt); /* Print it out and */ return('A'); /* abort */ case FALSE: /* Didn't get packet */ spack('N',n,0,0); /* Return a NAK */ return(state); /* Keep trying */ default: return('A'); /* Some other packet, "abort" */ } } /* * c o n n e c t * * Establish a virtual terminal connection with the remote host, over an * assigned tty line. */ connect() { int pid, /* Holds process id of child */ connected; /* Boolean connect flag */ char bel = '\07', c; struct sgttyb rawmode, /* Controlling tty raw mode */ cookedmode; /* Controlling tty cooked mode */ A KERMIT Program A KERMIT Program A KERMIT Program Page 86 if (remote) /* Nothing to connect to in remote */ { /* mode, so just return */ printmsg("No line specified for connection."); return; } gtty(0,&cookedmode); /* Save current mode so we can */ gtty(0,&rawmode); /* restore it later */ rawmode.sg_flags |= (RAW|TANDEM); rawmode.sg_flags &= ~(ECHO|CRMOD); stty(0,&rawmode); /* Put tty in raw mode */ pid = fork(); /* Start fork to get typeout from remote host */ if (pid) /* Parent: send type-in to remote host */ { printmsg("connected...\r"); connected = TRUE; /* Put us in "connect mode" */ while (connected) { read(0,&c,1); /* Get a character */ if ((c&0177) == escchr) /* Check for escape character */ { read(0,&c,1); if ((c&0177) == escchr) write(ttyfd,&c,1); else switch (c&0177) { case 'c': case 'C': connected = FALSE; write(0,"\r\n",2); break; case 'h': case 'H': write(0,"\r\nYes, I'm still here...\r\n",26); break; A KERMIT Program A KERMIT Program A KERMIT Program Page 87 default: write(0,&bel,1); break; } } else { /* If not escape charater, */ write(ttyfd,&c,1); /* write it out */ c = NULL; /* Nullify it (why?) */ } } kill(pid,9); /* Done, kill the child */ wait(0); /* and bury him */ stty(0,&cookedmode); /* Restore tty mode */ printmsg("disconnected."); return; /* Done */ } else /* Child does the reading from the remote host */ { while(1) /* Do this forever */ { read(ttyfd,&c,1); write(1,&c,1); } } } /* * KERMIT utilities. */ clkint() /* Timer interrupt handler */ { longjmp(env,TRUE); /* Tell rpack to give up */ } /* * s p a c k * * Send a Packet */ spack(type,num,len,data) char type, *data; int num, len; { int i; /* Character loop counter */ char chksum, buffer[100]; /* Checksum, packet buffer */ register char *bufp; /* Buffer pointer */ A KERMIT Program A KERMIT Program A KERMIT Program Page 88 if (debug>1) /* Display outgoing packet */ { if (data != NULL) data[len] = '\0'; /* Null-terminate data to print it */ printf(" spack type: %c\n",type); printf(" num: %d\n",num); printf(" len: %d\n",len); if (data != NULL) printf(" data: \"%s\"\n",data); } bufp = buffer; /* Set up buffer pointer */ for (i=1; i<=pad; i++) write(ttyfd,&padchar,1); /* Issue any padding */ *bufp++ = SOH; /* Packet marker, ASCII 1 (SOH) */ *bufp++ = tochar(len+3); /* Send the character count */ chksum = tochar(len+3); /* Initialize the checksum */ *bufp++ = tochar(num); /* Packet number */ chksum += tochar(num); /* Update checksum */ *bufp++ = type; /* Packet type */ chksum += type; /* Update checksum */ for (i=0; i> 6)+chksum)&077; /* Compute final checksum */ *bufp++ = tochar(chksum); /* Put it in the packet */ *bufp = eol; /* Extra-packet line terminator */ write(ttyfd, buffer,bufp-buffer+1); /* Send the packet */ } /* * r p a c k * * Read a Packet */ rpack(len,num,data) int *len, *num; /* Packet length, number */ char *data; /* Packet data */ { int i, done; /* Data character number, loop exit */ char t, /* Current input character */ type, /* Packet type */ cchksum, /* Our (computed) checksum */ rchksum; /* Checksum received from other host */ A KERMIT Program A KERMIT Program A KERMIT Program Page 89 #if UCB4X /* TOPS-20 can't handle timeouts... */ if (setjmp(env)) return FALSE; /* Timed out, fail */ signal(SIGALRM,clkint); /* Setup the timeout */ if ((timint > MAXTIM) || (timint < MINTIM)) timint = MYTIME; alarm(timint); #endif /* UCB4X */ while (t != SOH) /* Wait for packet header */ { read(ttyfd,&t,1); t &= 0177; /* Handle parity */ } done = FALSE; /* Got SOH, init loop */ while (!done) /* Loop to get a packet */ { read(ttyfd,&t,1); /* Get character */ if (!image) t &= 0177; /* Handle parity */ if (t == SOH) continue; /* Resynchronize if SOH */ cchksum = t; /* Start the checksum */ *len = unchar(t)-3; /* Character count */ read(ttyfd,&t,1); /* Get character */ if (!image) t &= 0177; /* Handle parity */ if (t == SOH) continue; /* Resynchronize if SOH */ cchksum = cchksum + t; /* Update checksum */ *num = unchar(t); /* Packet number */ read(ttyfd,&t,1); /* Get character */ if (!image) t &= 0177; /* Handle parity */ if (t == SOH) continue; /* Resynchronize if SOH */ cchksum = cchksum + t; /* Update checksum */ type = t; /* Packet type */ for (i=0; i<*len; i++) /* The data itself, if any */ { /* Loop for character count */ read(ttyfd,&t,1); /* Get character */ if (!image) t &= 0177; /* Handle parity */ if (t == SOH) continue; /* Resynch if SOH */ cchksum = cchksum + t; /* Update checksum */ data[i] = t; /* Put it in the data buffer */ } data[*len] = 0; /* Mark the end of the data */ read(ttyfd,&t,1); /* Get last character (checksum) */ rchksum = unchar(t); /* Convert to numeric */ read(ttyfd,&t,1); /* get EOL character and toss it */ if (!image) t &= 0177; /* Handle parity */ if (t == SOH) continue; /* Resynchronize if SOH */ done = TRUE; /* Got checksum, done */ } A KERMIT Program A KERMIT Program A KERMIT Program Page 90 #if UCB4X alarm(0); /* Disable the timer interrupt */ #endif if (debug>1) /* Display incoming packet */ { if (data != NULL) data[*len] = '\0'; /* Null-terminate data to print it */ printf(" rpack type: %c\n",type); printf(" num: %d\n",*num); printf(" len: %d\n",*len); if (data != NULL) printf(" data: \"%s\"\n",data); } /* Fold in bits 7,8 to compute */ cchksum = (((cchksum&0300) >> 6)+cchksum)&077; /* final checksum */ if (cchksum != rchksum) return(FALSE); return(type); /* All OK, return packet type */ } /* * b u f i l l * * Get a bufferful of data from the file that's being sent. * Only control-quoting is done; 8-bit & repeat count prefixes are * not handled. */ bufill(buffer) char buffer[]; /* Buffer */ { int i, /* Loop index */ t; /* Char read from file */ char t7; /* 7-bit version of above */ i = 0; /* Init data buffer pointer */ while((t = getc(fp)) != EOF) /* Get the next character */ { t7 = t & 0177; /* Get low order 7 bits */ A KERMIT Program A KERMIT Program A KERMIT Program Page 91 if (t7 < SP || t7==DEL || t7==quote) /* Does this char require */ { /* special handling? */ if (t=='\n' && !image) { /* Do LF->CRLF mapping if !image */ buffer[i++] = quote; buffer[i++] = ctl('\r'); } buffer[i++] = quote; /* Quote the character */ if (t7 != quote) { t = ctl(t); /* and uncontrolify */ t7 = ctl(t7); } } if (image) buffer[i++] = t; /* Deposit the character itself */ else buffer[i++] = t7; if (i >= spsiz-8) return(i); /* Check length */ } if (i==0) return(EOF); /* Wind up here only on EOF */ return(i); /* Handle partial buffer */ } /* * b u f e m p * * Put data from an incoming packet into a file. */ bufemp(buffer,len) char buffer[]; /* Buffer */ int len; /* Length */ { int i; /* Counter */ char t; /* Character holder */ for (i=0; i Right angle bracket 0 063 077 3F 6F ? Question mark 1 064 100 40 7C @ "At" sign The ASCII Character Set The ASCII Character Set The ASCII Character Set Page 99 Upper-case alphabetic characters (letters): .....ASCII.... EBCDIC ___ ___ ___ ___ ___ ____ _______ Bit Dec Oct Hex Hex Char Remarks 0 065 101 41 C1 A 0 066 102 42 C2 B 1 067 103 43 C3 C 0 068 104 44 C4 D 1 069 105 45 C5 E 1 070 106 46 C6 F 0 071 107 47 C7 G 0 072 110 48 C8 H 1 073 111 49 C9 I 1 074 112 4A D1 J 0 075 113 4B D2 K 1 076 114 4C D3 L 0 077 115 4D D4 M 0 078 116 4E D5 N 1 079 117 4F D6 O 0 080 120 50 D7 P 1 081 121 51 D8 Q 1 082 122 52 D9 R 0 083 123 53 E2 S 1 084 124 54 E3 T 0 085 125 55 E4 U 0 086 126 56 E5 V 1 087 127 57 E6 W 1 088 130 58 E7 X 0 089 131 59 E8 Y 0 090 132 5A E9 Z More punctuation characters: .....ASCII.... EBCDIC ___ ___ ___ ___ ___ ____ _______ Bit Dec Oct Hex Hex Char Remarks 1 091 133 5B AD [ Left square bracket 0 092 134 5C E0 \ Backslash 1 093 135 5D BD ] Right square bracket 1 094 136 5E 5F ^ Circumflex, up arrow 0 095 137 5F 6D _ Underscore, left arrow 0 096 140 60 79 ` Accent grave The ASCII Character Set The ASCII Character Set The ASCII Character Set Page 100 Lower-case alphabetic characters (letters): .....ASCII.... EBCDIC ___ ___ ___ ___ ___ ____ _______ Bit Dec Oct Hex Hex Char Remarks 1 097 141 61 81 a 1 098 142 62 82 b 0 099 143 63 83 c 1 100 144 64 84 d 0 101 145 65 85 e 0 102 146 66 86 f 1 103 147 67 87 g 1 104 150 68 88 h 0 105 151 69 89 i 0 106 152 6A 91 j 1 107 153 6B 92 k 0 108 154 6C 93 l 1 109 155 6D 94 m 1 110 156 6E 95 n 0 111 157 6F 96 o 1 112 160 70 97 p 0 113 161 71 98 q 0 114 162 72 99 r 1 115 163 73 A2 s 0 116 164 74 A3 t 1 117 165 75 A4 u 1 118 166 76 A5 v 0 119 167 77 A6 w 0 120 170 78 A7 x 1 121 171 79 A8 y 1 122 172 7A A9 z More punctuation characters: .....ASCII.... EBCDIC ___ ___ ___ ___ ___ ____ _______ Bit Dec Oct Hex Hex Char Remarks 0 123 173 7B C0 { Left brace (curly bracket) 1 124 174 7C 4F | Vertical bar 0 125 175 7D D0 } Right brace (curly bracket) 0 126 176 7E 7E ~ Tilde Finally, one more nonprintable character: 0 127 177 7F 07 DEL Delete, rubout Index Index Index Page 101 INDEX INDEX INDEX Local 6 8th Bit 6, 28 Logical Record 11 Logical Records 11 ACK 8 Long Reply 33 ASCII 7, 11, 96 NAK 8, 38 Baud 9 Normal Form for File Names 16 Binary Files 10, 11, 12 Binary Mode 9 Packet 8, 21 Bit Positions 6 Parity 23, 27, 97 Block Check 22, 23 Prefix 28, 31 Bootstrap 62 Prefixed Sequence 29 BREAK 58 Printable Files 11 Program, Kermit 59, 68 Capabilies 26 Protocol 4 CAPAS 26 Char(x) 7 Raw Mode 9 Checksum 22 Records 11 Control Character 7 Remote 6, 9 Control Characters 21, 97 Repeat Prefix 28 Control Fields 23 Reserved Fields 26 Ctl(x) 8 Send-Init 24 Data Encoding 23 Sequence Number 13 DEFINE 56 Sequential Files 4 Duplex 10 Server 6 Server Command Wait 30 EBCDIC 9, 11, 96 Server Commands 33 Edit Number 61 Server Operation 29 Encoding 28, 31 Short Reply 33 End-Of-Line (EOL) 9, 22 SOH 9 Errors 15 Tab Expansion 11 Fatal Errors 15 Text Files 11 File Names 16 Timeout 8 Flow Control 9, 18 Transaction 13 Full Duplex 10 Transaction Log 17 TTY 6 GET Command 32 Unchar(x) 8 Half Duplex 10 User 6 Host 6 XON/XOFF 10, 18, 97 Initial Connection 24 KERMIT 4 Language, Programming 61 Line Terminator 22 Line Terminator (see End-Of-Line) Table of Contents Table of Contents Table of Contents Page i Table of Contents Table of Contents Table of Contents 1. Introduction 1. Introduction 1. Introduction 4 1.1. Background 4 1.2. Overview 4 2. Definitions 2. Definitions 2. Definitions 6 2.1. General Terminology 6 2.2. Numbers 6 2.3. Character Set 7 2.4. Conversion Functions 7 2.5. Protocol Jargon 8 3. System Requirements 3. System Requirements 3. System Requirements 9 4. Printable Text versus Binary Data 4. Printable Text versus Binary Data 4. Printable Text versus Binary Data 11 4.1. Printable Text Files 11 4.2. Binary Files 12 5. File Transfer 5. File Transfer 5. File Transfer 13 5.1. Conditioning the Terminal 14 5.2. Timeouts, NAKs, and Retries 14 5.3. Errors 15 5.4. Heuristics 16 5.5. File Names 16 5.6. Robustness 17 5.7. Flow Control 18 5.8. Basic KERMIT Protocol State Table 18 6. Packet Format 6. Packet Format 6. Packet Format 21 6.1. Fields 21 6.2. Terminator 22 6.3. Other Interpacket Data 23 6.4. Encoding, Prefixing, Block Check 23 7. Initial Connection 7. Initial Connection 7. Initial Connection 24 8. Optional Features 8. Optional Features 8. Optional Features 28 8.1. 8th-Bit and Repeat Count Prefixing 28 8.2. Server Operation 29 8.2.1. Server Commands 30 8.2.2. Timing 32 8.2.3. The R Command 32 8.2.4. The K Command 32 8.2.5. Short and Long Replies 33 8.2.6. Additional Server Commands 33 Table of Contents Table of Contents Table of Contents Page ii 8.2.7. Host Commands 35 8.2.8. Exchanging Parameters Before Server Commands 36 8.3. Alternate Block Check Types 36 8.4. Interrupting a File Transfer 38 8.5. Transmitting File Attributes 39 8.6. Advanced KERMIT Protocol State Table 45 9. KERMIT Commands 9. KERMIT Commands 9. KERMIT Commands 51 9.1. Basic Commands 51 9.2. Program Management Commands 51 9.3. Terminal Emulation Commands 52 9.4. Special User-Mode Commands 52 9.5. Commands Whose Object Should Be Specified 52 9.6. The SET Command 54 9.7. Macros, the DEFINE Command 56 10. Terminal Emulation 10. Terminal Emulation 10. Terminal Emulation 57 11. Writing a KERMIT Program 11. Writing a KERMIT Program 11. Writing a KERMIT Program 59 11.1. Program Organization 59 11.2. Programming Language 61 11.3. Documentation 61 11.4. Bootstrapping 62 I. Packet Format and Types I. Packet Format and Types I. Packet Format and Types 63 II. List of Features II. List of Features II. List of Features 64 III. Unresolved Issues III. Unresolved Issues III. Unresolved Issues 66 IV. A KERMIT Program IV. A KERMIT Program IV. A KERMIT Program 68 V. The ASCII Character Set V. The ASCII Character Set V. The ASCII Character Set 96 Index Index Index 101