Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 1 | /* |
Sean Middleditch | 9de1598 | 2009-03-14 03:35:49 -0400 | [diff] [blame] | 2 | * Sean Middleditch |
| 3 | * sean@sourcemud.org |
| 4 | * |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 5 | * The author or authors of this code dedicate any and all copyright interest |
| 6 | * in this code to the public domain. We make this dedication for the benefit |
| 7 | * of the public at large and to the detriment of our heirs and successors. We |
| 8 | * intend this dedication to be an overt act of relinquishment in perpetuity of |
| 9 | * all present and future rights to this code under copyright law. |
| 10 | */ |
| 11 | |
Sean Middleditch | 6aef073 | 2009-03-12 23:27:35 -0400 | [diff] [blame] | 12 | #if !defined(LIBTELNET_INCLUDE) |
Sean Middleditch | aac2c12 | 2009-03-14 18:31:26 -0400 | [diff] [blame] | 13 | #define LIBTELNET_INCLUDE 1 |
Sean Middleditch | 6aef073 | 2009-03-12 23:27:35 -0400 | [diff] [blame] | 14 | |
Sean Middleditch | 3032302 | 2009-03-14 21:45:28 -0400 | [diff] [blame] | 15 | /* forward declarations */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 16 | typedef struct telnet_t telnet_t; |
| 17 | typedef struct telnet_event_t telnet_event_t; |
| 18 | typedef struct telnet_rfc1143_t telnet_rfc1143_t; |
Sean Middleditch | 3032302 | 2009-03-14 21:45:28 -0400 | [diff] [blame] | 19 | |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 20 | /* telnet special values */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 21 | #define TELNET_IAC 255 |
| 22 | #define TELNET_DONT 254 |
| 23 | #define TELNET_DO 253 |
| 24 | #define TELNET_WONT 252 |
| 25 | #define TELNET_WILL 251 |
| 26 | #define TELNET_SB 250 |
| 27 | #define TELNET_SB 250 |
| 28 | #define TELNET_GA 249 |
| 29 | #define TELNET_EL 248 |
| 30 | #define TELNET_EC 247 |
| 31 | #define TELNET_AYT 246 |
| 32 | #define TELNET_AO 245 |
| 33 | #define TELNET_IP 244 |
| 34 | #define TELNET_BREAK 243 |
| 35 | #define TELNET_DM 242 |
| 36 | #define TELNET_NOP 241 |
| 37 | #define TELNET_SE 240 |
| 38 | #define TELNET_EOR 239 |
| 39 | #define TELNET_ABORT 238 |
| 40 | #define TELNET_SUSP 237 |
| 41 | #define TELNET_EOF 236 |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 42 | |
| 43 | /* telnet options */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 44 | #define TELNET_TELOPT_BINARY 0 |
| 45 | #define TELNET_TELOPT_ECHO 1 |
| 46 | #define TELNET_TELOPT_RCP 2 |
| 47 | #define TELNET_TELOPT_SGA 3 |
| 48 | #define TELNET_TELOPT_NAMS 4 |
| 49 | #define TELNET_TELOPT_STATUS 5 |
| 50 | #define TELNET_TELOPT_TM 6 |
| 51 | #define TELNET_TELOPT_RCTE 7 |
| 52 | #define TELNET_TELOPT_NAOL 8 |
| 53 | #define TELNET_TELOPT_NAOP 9 |
| 54 | #define TELNET_TELOPT_NAOCRD 10 |
| 55 | #define TELNET_TELOPT_NAOHTS 11 |
| 56 | #define TELNET_TELOPT_NAOHTD 12 |
| 57 | #define TELNET_TELOPT_NAOFFD 13 |
| 58 | #define TELNET_TELOPT_NAOVTS 14 |
| 59 | #define TELNET_TELOPT_NAOVTD 15 |
| 60 | #define TELNET_TELOPT_NAOLFD 16 |
| 61 | #define TELNET_TELOPT_XASCII 17 |
| 62 | #define TELNET_TELOPT_LOGOUT 18 |
| 63 | #define TELNET_TELOPT_BM 19 |
| 64 | #define TELNET_TELOPT_DET 20 |
| 65 | #define TELNET_TELOPT_SUPDUP 21 |
| 66 | #define TELNET_TELOPT_SUPDUPOUTPUT 22 |
| 67 | #define TELNET_TELOPT_SNDLOC 23 |
| 68 | #define TELNET_TELOPT_TTYPE 24 |
| 69 | #define TELNET_TELOPT_EOR 25 |
| 70 | #define TELNET_TELOPT_TUID 26 |
| 71 | #define TELNET_TELOPT_OUTMRK 27 |
| 72 | #define TELNET_TELOPT_TTYLOC 28 |
| 73 | #define TELNET_TELOPT_3270REGIME 29 |
| 74 | #define TELNET_TELOPT_X3PAD 30 |
| 75 | #define TELNET_TELOPT_NAWS 31 |
| 76 | #define TELNET_TELOPT_TSPEED 32 |
| 77 | #define TELNET_TELOPT_LFLOW 33 |
| 78 | #define TELNET_TELOPT_LINEMODE 34 |
| 79 | #define TELNET_TELOPT_XDISPLOC 35 |
| 80 | #define TELNET_TELOPT_ENVIRON 36 |
| 81 | #define TELNET_TELOPT_AUTHENTICATION 37 |
| 82 | #define TELNET_TELOPT_ENCRYPT 38 |
| 83 | #define TELNET_TELOPT_NEW_ENVIRON 39 |
| 84 | #define TELNET_TELOPT_COMPRESS 85 |
| 85 | #define TELNET_TELOPT_COMPRESS2 86 |
| 86 | #define TELNET_TELOPT_ZMP 93 |
| 87 | #define TELNET_TELOPT_EXOPL 255 |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 88 | |
Sean Middleditch | 08bb05f | 2009-03-15 23:29:46 -0400 | [diff] [blame] | 89 | /* libtelnet feature flags */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 90 | #define TELNET_FLAG_PROXY (1<<0) |
Sean Middleditch | 61f8eb6 | 2009-03-14 04:57:27 -0400 | [diff] [blame] | 91 | |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 92 | #define TELNET_PFLAG_DEFLATE (1<<7) |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 93 | |
| 94 | /* telnet states */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 95 | enum telnet_state_t { |
| 96 | TELNET_STATE_DATA = 0, |
| 97 | TELNET_STATE_IAC, |
| 98 | TELNET_STATE_DO, |
| 99 | TELNET_STATE_DONT, |
| 100 | TELNET_STATE_WILL, |
| 101 | TELNET_STATE_WONT, |
| 102 | TELNET_STATE_SB, |
| 103 | TELNET_STATE_SB_DATA, |
| 104 | TELNET_STATE_SB_DATA_IAC |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 105 | }; |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 106 | typedef enum telnet_state_t telnet_state_t; |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 107 | |
| 108 | /* error codes */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 109 | enum telnet_error_t { |
| 110 | TELNET_EOK = 0, |
| 111 | TELNET_EBADVAL, /* invalid parameter, or API misuse */ |
| 112 | TELNET_ENOMEM, /* memory allocation failure */ |
| 113 | TELNET_EOVERFLOW, /* data exceeds buffer size */ |
| 114 | TELNET_EPROTOCOL, /* invalid sequence of special bytes */ |
| 115 | TELNET_ECOMPRESS /* error handling compressed streams */ |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 116 | }; |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 117 | typedef enum telnet_error_t telnet_error_t; |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 118 | |
Sean Middleditch | 637df7f | 2009-03-15 12:57:32 -0400 | [diff] [blame] | 119 | /* event codes */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 120 | enum telnet_event_type_t { |
| 121 | TELNET_EV_DATA = 0, |
| 122 | TELNET_EV_SEND, |
| 123 | TELNET_EV_IAC, |
| 124 | TELNET_EV_WILL, |
| 125 | TELNET_EV_WONT, |
| 126 | TELNET_EV_DO, |
| 127 | TELNET_EV_DONT, |
| 128 | TELNET_EV_SUBNEGOTIATION, |
| 129 | TELNET_EV_COMPRESS, |
| 130 | TELNET_EV_WARNING, |
| 131 | TELNET_EV_ERROR |
Sean Middleditch | 3032302 | 2009-03-14 21:45:28 -0400 | [diff] [blame] | 132 | }; |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 133 | typedef enum telnet_event_type_t telnet_event_type_t; |
Sean Middleditch | 3032302 | 2009-03-14 21:45:28 -0400 | [diff] [blame] | 134 | |
Sean Middleditch | 637df7f | 2009-03-15 12:57:32 -0400 | [diff] [blame] | 135 | /* event information */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 136 | struct telnet_event_t { |
Sean Middleditch | 637df7f | 2009-03-15 12:57:32 -0400 | [diff] [blame] | 137 | /* data buffer: for DATA, SEND, SUBNEGOTIATION, and ERROR events */ |
Sean Middleditch | 8daf774 | 2009-03-19 02:05:24 -0400 | [diff] [blame] | 138 | const char *buffer; |
Sean Middleditch | 340a51b | 2009-03-19 02:08:46 -0400 | [diff] [blame] | 139 | size_t size; |
Sean Middleditch | 5b5bc92 | 2009-03-15 23:02:10 -0400 | [diff] [blame] | 140 | /* type of event */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 141 | enum telnet_event_type_t type; |
Sean Middleditch | 5b5bc92 | 2009-03-15 23:02:10 -0400 | [diff] [blame] | 142 | /* IAC command */ |
| 143 | unsigned char command; |
| 144 | /* telopt info: for negotiation events SUBNEGOTIATION */ |
| 145 | unsigned char telopt; |
| 146 | /* accept status: for WILL and DO events */ |
| 147 | unsigned char accept; |
| 148 | }; |
| 149 | |
| 150 | /* option negotiation state (RFC 1143) */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 151 | struct telnet_rfc1143_t { |
Sean Middleditch | 5b5bc92 | 2009-03-15 23:02:10 -0400 | [diff] [blame] | 152 | unsigned char telopt; |
| 153 | char us:4, him:4; |
Sean Middleditch | 637df7f | 2009-03-15 12:57:32 -0400 | [diff] [blame] | 154 | }; |
| 155 | |
| 156 | /* event handler declaration */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 157 | typedef void (*telnet_event_handler_t)(telnet_t *telnet, |
| 158 | telnet_event_t *event, void *user_data); |
Sean Middleditch | 637df7f | 2009-03-15 12:57:32 -0400 | [diff] [blame] | 159 | |
Sean Middleditch | 4d9444d | 2009-03-13 22:48:05 -0400 | [diff] [blame] | 160 | /* state tracker */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 161 | struct telnet_t { |
Sean Middleditch | 9f79cc5 | 2009-03-15 13:39:24 -0400 | [diff] [blame] | 162 | /* user data */ |
| 163 | void *ud; |
Sean Middleditch | 637df7f | 2009-03-15 12:57:32 -0400 | [diff] [blame] | 164 | /* event handler */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 165 | telnet_event_handler_t eh; |
Sean Middleditch | 9de1598 | 2009-03-14 03:35:49 -0400 | [diff] [blame] | 166 | #ifdef HAVE_ZLIB |
Sean Middleditch | 3032302 | 2009-03-14 21:45:28 -0400 | [diff] [blame] | 167 | /* zlib (mccp2) compression */ |
Sean Middleditch | fbe93e3 | 2009-03-15 23:39:31 -0400 | [diff] [blame] | 168 | z_stream *z; |
Sean Middleditch | 9de1598 | 2009-03-14 03:35:49 -0400 | [diff] [blame] | 169 | #endif |
Sean Middleditch | 5b5bc92 | 2009-03-15 23:02:10 -0400 | [diff] [blame] | 170 | /* RFC1143 option negotiation states */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 171 | struct telnet_rfc1143_t *q; |
Sean Middleditch | 4d9444d | 2009-03-13 22:48:05 -0400 | [diff] [blame] | 172 | /* sub-request buffer */ |
Sean Middleditch | 8daf774 | 2009-03-19 02:05:24 -0400 | [diff] [blame] | 173 | char *buffer; |
Sean Middleditch | 4d9444d | 2009-03-13 22:48:05 -0400 | [diff] [blame] | 174 | /* current size of the buffer */ |
Sean Middleditch | 340a51b | 2009-03-19 02:08:46 -0400 | [diff] [blame] | 175 | size_t buffer_size; |
Sean Middleditch | 5b5bc92 | 2009-03-15 23:02:10 -0400 | [diff] [blame] | 176 | /* current buffer write position (also length of buffer data) */ |
Sean Middleditch | 340a51b | 2009-03-19 02:08:46 -0400 | [diff] [blame] | 177 | size_t buffer_pos; |
Sean Middleditch | 4d9444d | 2009-03-13 22:48:05 -0400 | [diff] [blame] | 178 | /* current state */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 179 | enum telnet_state_t state; |
Sean Middleditch | 08bb05f | 2009-03-15 23:29:46 -0400 | [diff] [blame] | 180 | /* option flags */ |
| 181 | unsigned char flags; |
Sean Middleditch | da0e695 | 2009-03-15 13:28:09 -0400 | [diff] [blame] | 182 | /* current subnegotiation telopt */ |
| 183 | unsigned char sb_telopt; |
Sean Middleditch | 5b5bc92 | 2009-03-15 23:02:10 -0400 | [diff] [blame] | 184 | /* length of RFC1143 queue */ |
| 185 | unsigned char q_size; |
Sean Middleditch | 4d9444d | 2009-03-13 22:48:05 -0400 | [diff] [blame] | 186 | }; |
| 187 | |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 188 | /* initialize a telnet state tracker */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 189 | extern void telnet_init(telnet_t *telnet, telnet_event_handler_t eh, |
Sean Middleditch | 08bb05f | 2009-03-15 23:29:46 -0400 | [diff] [blame] | 190 | unsigned char flags, void *user_data); |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 191 | |
| 192 | /* free up any memory allocated by a state tracker */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 193 | extern void telnet_free(telnet_t *telnet); |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 194 | |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 195 | /* push a byte buffer into the state tracker */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 196 | extern void telnet_push(telnet_t *telnet, const char *buffer, |
Sean Middleditch | 340a51b | 2009-03-19 02:08:46 -0400 | [diff] [blame] | 197 | size_t size); |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 198 | |
| 199 | /* send an iac command */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 200 | extern void telnet_send_command(telnet_t *telnet, unsigned char cmd); |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 201 | |
Sean Middleditch | 2b4bfc4 | 2009-03-16 01:25:52 -0400 | [diff] [blame] | 202 | /* send an iac command with a telopt */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 203 | extern void telnet_send_telopt(telnet_t *telnet, unsigned char cmd, |
Sean Middleditch | 2b4bfc4 | 2009-03-16 01:25:52 -0400 | [diff] [blame] | 204 | unsigned char telopt); |
| 205 | |
| 206 | /* send negotiation, with RFC1143 checking. |
| 207 | * will not actually send unless necessary, but will update internal |
| 208 | * negotiation queue. |
| 209 | */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 210 | extern void telnet_send_negotiate(telnet_t *telnet, unsigned char cmd, |
Sean Middleditch | 812358d | 2009-03-15 23:24:03 -0400 | [diff] [blame] | 211 | unsigned char opt); |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 212 | |
| 213 | /* send non-command data (escapes IAC bytes) */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 214 | extern void telnet_send_data(telnet_t *telnet, |
Sean Middleditch | 340a51b | 2009-03-19 02:08:46 -0400 | [diff] [blame] | 215 | const char *buffer, size_t size); |
Sean Middleditch | 2914485 | 2009-03-12 23:14:47 -0400 | [diff] [blame] | 216 | |
Sean Middleditch | 2b4bfc4 | 2009-03-16 01:25:52 -0400 | [diff] [blame] | 217 | /* send sub-request, equivalent to: |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 218 | * telnet_send_telopt(telnet, TELNET_SB, telopt) |
| 219 | * telnet_send_data(telnet, buffer, size); |
| 220 | * telnet_send_command(telnet, TELNET_SE); |
Sean Middleditch | 2b4bfc4 | 2009-03-16 01:25:52 -0400 | [diff] [blame] | 221 | * manually generating sequence may be easier for complex subnegotiations |
| 222 | * thare are most easily implemented with a series of send_data calls. |
| 223 | */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 224 | extern void telnet_send_subnegotiation(telnet_t *telnet, |
Sean Middleditch | 340a51b | 2009-03-19 02:08:46 -0400 | [diff] [blame] | 225 | unsigned char telopt, const char *buffer, size_t size); |
Sean Middleditch | 6aef073 | 2009-03-12 23:27:35 -0400 | [diff] [blame] | 226 | |
Sean Middleditch | 124a1c2 | 2009-03-15 13:20:03 -0400 | [diff] [blame] | 227 | /* begin sending compressed data (server only) */ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 228 | extern void telnet_begin_compress2(telnet_t *telnet); |
Sean Middleditch | 124a1c2 | 2009-03-15 13:20:03 -0400 | [diff] [blame] | 229 | |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 230 | /* printf type checking feature in GCC and some other compilers */ |
Sean Middleditch | d58f49f | 2009-03-16 12:49:35 -0400 | [diff] [blame] | 231 | #ifdef __GNUC__ |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 232 | # define TELNET_GNU_PRINTF(f,a) __attribute__((printf(f, a))) |
Sean Middleditch | d58f49f | 2009-03-16 12:49:35 -0400 | [diff] [blame] | 233 | #else |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 234 | # define TELNET_GNU_PRINTF(f,a) |
Sean Middleditch | d58f49f | 2009-03-16 12:49:35 -0400 | [diff] [blame] | 235 | #endif |
| 236 | |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 237 | /* send formatted data with \r and \n translated, and IAC escaped */ |
| 238 | extern int telnet_printf(telnet_t *telnet, const char *fmt, ...); |
Sean Middleditch | 4a15604 | 2009-03-16 17:10:58 -0400 | [diff] [blame] | 239 | |
Sean Middleditch | f65f27d | 2009-03-19 02:32:04 -0400 | [diff] [blame] | 240 | /* send formatted data with just IAC escaped */ |
| 241 | extern int telnet_printf2(telnet_t *telnet, const char *fmt, ...); |
Sean Middleditch | d58f49f | 2009-03-16 12:49:35 -0400 | [diff] [blame] | 242 | |
Sean Middleditch | 6aef073 | 2009-03-12 23:27:35 -0400 | [diff] [blame] | 243 | #endif /* !defined(LIBTELNET_INCLUDE) */ |