| Sean Middleditch | b9e4864 | 2009-03-12 23:33:27 -0400 | [diff] [blame] | 1 | ===================================================================== |
| 2 | libtelnet - TELNET protocol handling library |
| 3 | ===================================================================== |
| 4 | |
| 5 | Sean Middleditch |
| 6 | sean@sourcemud.org |
| 7 | |
| 8 | --------------------------------------------------------------------- |
| 9 | The author or authors of this code dedicate any and all copyright |
| 10 | interest in this code to the public domain. We make this dedication |
| 11 | for the benefit of the public at large and to the detriment of our |
| 12 | heirs and successors. We intend this dedication to be an overt act of |
| 13 | relinquishment in perpetuity of all present and future rights to this |
| 14 | code under copyright law. |
| 15 | --------------------------------------------------------------------- |
| 16 | |
| Sean Middleditch | 9d2f98a | 2009-03-14 05:24:56 -0400 | [diff] [blame^] | 17 | *** TODO *** |
| 18 | |
| 19 | - RFC 1143 option negotiation algorithm |
| 20 | - automatic MCCP2 handling (controllable by host app) |
| 21 | - efficient one-byte sub-requests |
| 22 | ? MCCP1 |
| 23 | ? ZMP parsing |
| 24 | ? MSSP parsing |
| 25 | ? ENVIRON/NEW-ENVIRON parsing |
| 26 | ? telnet-status testing tool |
| 27 | ? few options to make telnet-proxy even more useful |
| 28 | |
| Sean Middleditch | b9e4864 | 2009-03-12 23:33:27 -0400 | [diff] [blame] | 29 | I. INTRODUCTION |
| 30 | ===================================================================== |
| 31 | |
| 32 | libtelnet provides safe and correct handling of the core TELNET |
| 33 | protocol. It does not include any "smarts," and all use of the |
| 34 | protocol (such as deciding which options to support, enabling |
| 35 | and disabling options, or processing subrequests) must be implemented |
| 36 | by the application author. |
| 37 | |
| 38 | II. LIBTELNET API |
| 39 | ===================================================================== |
| 40 | |
| 41 | FIXME: fill in notes about user-facing API |
| 42 | |
| 43 | III. INTEGRATING LIBTELNET |
| 44 | ===================================================================== |
| 45 | |
| 46 | FIXME: fill in notes about implementing the libtelnet_*_cb functions |
| 47 | |
| 48 | IV. OUTPUT PROCESSING |
| 49 | ===================================================================== |
| 50 | |
| 51 | FIXME: fill in notes about output buffering recommendations |
| 52 | |
| 53 | V. SAFETY AND CORRECTNESS CONSIDERATIONS |
| 54 | ===================================================================== |
| 55 | |
| 56 | FIXME: fill in notes about recommending the user of libtelnet over |
| 57 | all output functions for ensuring safety |