blob: 693d0655bb10c4288806771f75acd11482c95ccb [file] [log] [blame]
Sean Middleditch29144852009-03-12 23:14:47 -04001/*
Sean Middleditch9de15982009-03-14 03:35:49 -04002 * Sean Middleditch
3 * sean@sourcemud.org
4 *
Sean Middleditch29144852009-03-12 23:14:47 -04005 * 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 Middleditch6aef0732009-03-12 23:27:35 -040012#if !defined(LIBTELNET_INCLUDE)
Sean Middleditchaac2c122009-03-14 18:31:26 -040013#define LIBTELNET_INCLUDE 1
Sean Middleditch6aef0732009-03-12 23:27:35 -040014
Sean Middleditch30323022009-03-14 21:45:28 -040015/* forward declarations */
16struct libtelnet_t;
17struct libtelnet_cb_t;
18
Sean Middleditch29144852009-03-12 23:14:47 -040019/* telnet special values */
20#define LIBTELNET_IAC 255
21#define LIBTELNET_DONT 254
22#define LIBTELNET_DO 253
23#define LIBTELNET_WONT 252
24#define LIBTELNET_WILL 251
25#define LIBTELNET_SB 250
Sean Middleditchc04224b2009-03-14 18:30:57 -040026#define LIBTELNET_SB 250
27#define LIBTELNET_GA 249
28#define LIBTELNET_EL 248
29#define LIBTELNET_EC 247
30#define LIBTELNET_AYT 246
31#define LIBTELNET_AO 245
32#define LIBTELNET_IP 244
33#define LIBTELNET_BREAK 243
34#define LIBTELNET_DM 242
35#define LIBTELNET_NOP 241
Sean Middleditch29144852009-03-12 23:14:47 -040036#define LIBTELNET_SE 240
Sean Middleditchc04224b2009-03-14 18:30:57 -040037#define LIBTELNET_EOR 239
38#define LIBTELNET_ABORT 238
39#define LIBTELNET_SUSP 237
40#define LIBTELNET_EOF 236
Sean Middleditch29144852009-03-12 23:14:47 -040041
42/* telnet options */
Sean Middleditchc04224b2009-03-14 18:30:57 -040043#define LIBTELNET_TELOPT_BINARY 0
44#define LIBTELNET_TELOPT_ECHO 1
45#define LIBTELNET_TELOPT_RCP 2
46#define LIBTELNET_TELOPT_SGA 3
47#define LIBTELNET_TELOPT_NAMS 4
48#define LIBTELNET_TELOPT_STATUS 5
49#define LIBTELNET_TELOPT_TM 6
50#define LIBTELNET_TELOPT_RCTE 7
51#define LIBTELNET_TELOPT_NAOL 8
52#define LIBTELNET_TELOPT_NAOP 9
53#define LIBTELNET_TELOPT_NAOCRD 10
54#define LIBTELNET_TELOPT_NAOHTS 11
55#define LIBTELNET_TELOPT_NAOHTD 12
56#define LIBTELNET_TELOPT_NAOFFD 13
57#define LIBTELNET_TELOPT_NAOVTS 14
58#define LIBTELNET_TELOPT_NAOVTD 15
59#define LIBTELNET_TELOPT_NAOLFD 16
60#define LIBTELNET_TELOPT_XASCII 17
61#define LIBTELNET_TELOPT_LOGOUT 18
62#define LIBTELNET_TELOPT_BM 19
63#define LIBTELNET_TELOPT_DET 20
64#define LIBTELNET_TELOPT_SUPDUP 21
65#define LIBTELNET_TELOPT_SUPDUPOUTPUT 22
66#define LIBTELNET_TELOPT_SNDLOC 23
67#define LIBTELNET_TELOPT_TTYPE 24
68#define LIBTELNET_TELOPT_EOR 25
69#define LIBTELNET_TELOPT_TUID 26
70#define LIBTELNET_TELOPT_OUTMRK 27
71#define LIBTELNET_TELOPT_TTYLOC 28
72#define LIBTELNET_TELOPT_3270REGIME 29
73#define LIBTELNET_TELOPT_X3PAD 30
74#define LIBTELNET_TELOPT_NAWS 31
75#define LIBTELNET_TELOPT_TSPEED 32
76#define LIBTELNET_TELOPT_LFLOW 33
77#define LIBTELNET_TELOPT_LINEMODE 34
78#define LIBTELNET_TELOPT_XDISPLOC 35
79#define LIBTELNET_TELOPT_ENVIRON 36
80#define LIBTELNET_TELOPT_AUTHENTICATION 37
81#define LIBTELNET_TELOPT_ENCRYPT 38
82#define LIBTELNET_TELOPT_NEW_ENVIRON 39
83#define LIBTELNET_TELOPT_COMPRESS 85
84#define LIBTELNET_TELOPT_COMPRESS2 86
85#define LIBTELNET_TELOPT_ZMP 93
86#define LIBTELNET_TELOPT_EXOPL 255
Sean Middleditch29144852009-03-12 23:14:47 -040087
Sean Middleditch61f8eb62009-03-14 04:57:27 -040088/* libtelnet modes */
89enum libtelnet_mode_t {
90 LIBTELNET_MODE_SERVER = 0,
91 LIBTELNET_MODE_CLIENT
92};
93
Sean Middleditch29144852009-03-12 23:14:47 -040094/* telnet states */
95enum libtelnet_state_t {
Sean Middleditch9de15982009-03-14 03:35:49 -040096 LIBTELNET_STATE_DATA = 0,
Sean Middleditch29144852009-03-12 23:14:47 -040097 LIBTELNET_STATE_IAC,
98 LIBTELNET_STATE_DO,
99 LIBTELNET_STATE_DONT,
100 LIBTELNET_STATE_WILL,
101 LIBTELNET_STATE_WONT,
102 LIBTELNET_STATE_SB,
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400103 LIBTELNET_STATE_SB_IAC
Sean Middleditch29144852009-03-12 23:14:47 -0400104};
105
106/* error codes */
107enum libtelnet_error_t {
108 LIBTELNET_ERROR_OK = 0,
Sean Middleditchb1e452e2009-03-12 23:26:34 -0400109 LIBTELNET_ERROR_NOMEM, /* memory allocation failure */
Sean Middleditch78f400f2009-03-14 01:26:43 -0400110 LIBTELNET_ERROR_OVERFLOW, /* data exceeds buffer size */
Sean Middleditch29144852009-03-12 23:14:47 -0400111 LIBTELNET_ERROR_PROTOCOL, /* invalid sequence of special bytes */
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400112 LIBTELNET_ERROR_UNKNOWN /* some crazy unexplainable unknown error */
Sean Middleditch29144852009-03-12 23:14:47 -0400113};
114
Sean Middleditch30323022009-03-14 21:45:28 -0400115/* libtelnet callback declarations */
116struct libtelnet_cb_t {
117 /* received (processed) data */
Sean Middleditchd922c6f2009-03-14 22:35:01 -0400118 void (*data)(struct libtelnet_t *telnet, unsigned char *buffer,
119 unsigned int size, void *user_data);
Sean Middleditch30323022009-03-14 21:45:28 -0400120 /* processed data to buffer for sending */
Sean Middleditchd922c6f2009-03-14 22:35:01 -0400121 void (*send)(struct libtelnet_t *telnet, unsigned char *buffer,
122 unsigned int size, void *user_data);
Sean Middleditch30323022009-03-14 21:45:28 -0400123 /* unknown command notification */
Sean Middleditchd922c6f2009-03-14 22:35:01 -0400124 void (*command)(struct libtelnet_t *telnet, unsigned char cmd,
Sean Middleditch30323022009-03-14 21:45:28 -0400125 void *user_data);
Sean Middleditchd922c6f2009-03-14 22:35:01 -0400126 /* negotiation notification */
127 void (*negotiate)(struct libtelnet_t *telnet, unsigned char cmd,
128 unsigned char opt, void *user_data);
129 /* unknown subnegotiation notification */
130 void (*subnegotiation)(struct libtelnet_t *telnet, unsigned char opt,
131 unsigned char *data, unsigned int size, void *user_data);
Sean Middleditch30323022009-03-14 21:45:28 -0400132 /* error handler */
Sean Middleditchd922c6f2009-03-14 22:35:01 -0400133 void (*error)(struct libtelnet_t *telnet, enum libtelnet_error_t error,
134 const char *msg, void *user_data);
Sean Middleditch30323022009-03-14 21:45:28 -0400135
136 #ifdef HAVE_ZLIB
137 void (*compress)(struct libtelnet_t *telnet,
138 char enabled, void *user_data);
139 #endif
140};
141
Sean Middleditch4d9444d2009-03-13 22:48:05 -0400142/* state tracker */
143struct libtelnet_t {
Sean Middleditch30323022009-03-14 21:45:28 -0400144 /* callback table */
145 struct libtelnet_cb_t *cb;
Sean Middleditch9de15982009-03-14 03:35:49 -0400146#ifdef HAVE_ZLIB
Sean Middleditch30323022009-03-14 21:45:28 -0400147 /* zlib (mccp2) compression */
Sean Middleditch9de15982009-03-14 03:35:49 -0400148 z_stream *zlib;
149#endif
Sean Middleditch4d9444d2009-03-13 22:48:05 -0400150 /* sub-request buffer */
151 unsigned char *buffer;
152 /* current size of the buffer */
153 unsigned int size;
154 /* length of data in the buffer */
155 unsigned int length;
156 /* current state */
157 enum libtelnet_state_t state;
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400158 /* processing mode */
159 enum libtelnet_mode_t mode;
Sean Middleditch4d9444d2009-03-13 22:48:05 -0400160};
161
Sean Middleditch29144852009-03-12 23:14:47 -0400162/* initialize a telnet state tracker */
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400163extern void libtelnet_init(struct libtelnet_t *telnet,
Sean Middleditch30323022009-03-14 21:45:28 -0400164 struct libtelnet_cb_t *cb, enum libtelnet_mode_t mode);
Sean Middleditch29144852009-03-12 23:14:47 -0400165
166/* free up any memory allocated by a state tracker */
Sean Middleditch51ad6792009-03-13 20:15:59 -0400167extern void libtelnet_free(struct libtelnet_t *telnet);
Sean Middleditch29144852009-03-12 23:14:47 -0400168
Sean Middleditch29144852009-03-12 23:14:47 -0400169/* push a byte buffer into the state tracker */
Sean Middleditch8b5e2b12009-03-13 23:39:18 -0400170extern void libtelnet_push(struct libtelnet_t *telnet,
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400171 unsigned char *buffer, unsigned int size, void *user_data);
Sean Middleditch29144852009-03-12 23:14:47 -0400172
173/* send an iac command */
Sean Middleditchb1e452e2009-03-12 23:26:34 -0400174extern void libtelnet_send_command(struct libtelnet_t *telnet,
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400175 unsigned char cmd, void *user_data);
Sean Middleditch29144852009-03-12 23:14:47 -0400176
177/* send negotiation */
Sean Middleditchb1e452e2009-03-12 23:26:34 -0400178extern void libtelnet_send_negotiate(struct libtelnet_t *telnet,
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400179 unsigned char cmd, unsigned char opt, void *user_data);
Sean Middleditch29144852009-03-12 23:14:47 -0400180
181/* send non-command data (escapes IAC bytes) */
Sean Middleditchb1e452e2009-03-12 23:26:34 -0400182extern void libtelnet_send_data(struct libtelnet_t *telnet,
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400183 unsigned char *buffer, unsigned int size, void *user_data);
Sean Middleditch29144852009-03-12 23:14:47 -0400184
185/* send sub-request */
Sean Middleditch6b372882009-03-14 13:06:47 -0400186extern void libtelnet_send_subnegotiation(struct libtelnet_t *telnet,
Sean Middleditchc974b972009-03-14 13:23:33 -0400187 unsigned char opt, unsigned char *buffer, unsigned int size,
Sean Middleditch61f8eb62009-03-14 04:57:27 -0400188 void *user_data);
Sean Middleditch6aef0732009-03-12 23:27:35 -0400189
190#endif /* !defined(LIBTELNET_INCLUDE) */