| blob | 6cdb031b3591c05e658e5aa07962d3dfe0be307e |
1 /*\r
2 * "Raw" backend.\r
3 */\r
4 \r
5 #include <stdio.h>\r
6 #include <stdlib.h>\r
7 #include <limits.h>\r
8 \r
9 #include "putty.h"\r
10 \r
11 #ifndef FALSE\r
12 #define FALSE 0\r
13 #endif\r
14 #ifndef TRUE\r
15 #define TRUE 1\r
16 #endif\r
17 \r
18 #define RAW_MAX_BACKLOG 4096\r
19 \r
20 typedef struct raw_backend_data {\r
21 const struct plug_function_table *fn;\r
22 /* the above field _must_ be first in the structure */\r
23 \r
24 Socket s;\r
25 int closed_on_socket_error;\r
26 int bufsize;\r
27 void *frontend;\r
28 int sent_console_eof, sent_socket_eof, session_started;\r
29 \r
30 Conf *conf;\r
31 } *Raw;\r
32 \r
33 static void raw_size(void *handle, int width, int height);\r
34 \r
35 static void c_write(Raw raw, char *buf, int len)\r
36 {\r
37 int backlog = from_backend(raw->frontend, 0, buf, len);\r
38 sk_set_frozen(raw->s, backlog > RAW_MAX_BACKLOG);\r
39 }\r
40 \r
41 static void raw_log(Plug plug, int type, SockAddr addr, int port,\r
42 const char *error_msg, int error_code)\r
43 {\r
44 Raw raw = (Raw) plug;\r
45 backend_socket_log(raw->frontend, type, addr, port,\r
46 error_msg, error_code, raw->conf, raw->session_started);\r
47 }\r
48 \r
49 static void raw_check_close(Raw raw)\r
50 {\r
51 /*\r
52 * Called after we send EOF on either the socket or the console.\r
53 * Its job is to wind up the session once we have sent EOF on both.\r
54 */\r
55 if (raw->sent_console_eof && raw->sent_socket_eof) {\r
56 if (raw->s) {\r
57 sk_close(raw->s);\r
58 raw->s = NULL;\r
59 notify_remote_exit(raw->frontend);\r
60 }\r
61 }\r
62 }\r
63 \r
64 static int raw_closing(Plug plug, const char *error_msg, int error_code,\r
65 int calling_back)\r
66 {\r
67 Raw raw = (Raw) plug;\r
68 \r
69 if (error_msg) {\r
70 /* A socket error has occurred. */\r
71 if (raw->s) {\r
72 sk_close(raw->s);\r
73 raw->s = NULL;\r
74 raw->closed_on_socket_error = TRUE;\r
75 notify_remote_exit(raw->frontend);\r
76 }\r
77 logevent(raw->frontend, error_msg);\r
78 connection_fatal(raw->frontend, "%s", error_msg);\r
79 } else {\r
80 /* Otherwise, the remote side closed the connection normally. */\r
81 if (!raw->sent_console_eof && from_backend_eof(raw->frontend)) {\r
82 /*\r
83 * The front end wants us to close the outgoing side of the\r
84 * connection as soon as we see EOF from the far end.\r
85 */\r
86 if (!raw->sent_socket_eof) {\r
87 if (raw->s)\r
88 sk_write_eof(raw->s);\r
89 raw->sent_socket_eof= TRUE;\r
90 }\r
91 }\r
92 raw->sent_console_eof = TRUE;\r
93 raw_check_close(raw);\r
94 }\r
95 return 0;\r
96 }\r
97 \r
98 static int raw_receive(Plug plug, int urgent, char *data, int len)\r
99 {\r
100 Raw raw = (Raw) plug;\r
101 c_write(raw, data, len);\r
102 /* We count 'session start', for proxy logging purposes, as being\r
103 * when data is received from the network and printed. */\r
104 raw->session_started = TRUE;\r
105 return 1;\r
106 }\r
107 \r
108 static void raw_sent(Plug plug, int bufsize)\r
109 {\r
110 Raw raw = (Raw) plug;\r
111 raw->bufsize = bufsize;\r
112 }\r
113 \r
114 /*\r
115 * Called to set up the raw connection.\r
116 * \r
117 * Returns an error message, or NULL on success.\r
118 *\r
119 * Also places the canonical host name into `realhost'. It must be\r
120 * freed by the caller.\r
121 */\r
122 static const char *raw_init(void *frontend_handle, void **backend_handle,\r
123 Conf *conf,\r
124 const char *host, int port, char **realhost,\r
125 int nodelay, int keepalive)\r
126 {\r
127 static const struct plug_function_table fn_table = {\r
128 raw_log,\r
129 raw_closing,\r
130 raw_receive,\r
131 raw_sent\r
132 };\r
133 SockAddr addr;\r
134 const char *err;\r
135 Raw raw;\r
136 int addressfamily;\r
137 char *loghost;\r
138 \r
139 raw = snew(struct raw_backend_data);\r
140 raw->fn = &fn_table;\r
141 raw->s = NULL;\r
142 raw->closed_on_socket_error = FALSE;\r
143 *backend_handle = raw;\r
144 raw->sent_console_eof = raw->sent_socket_eof = FALSE;\r
145 raw->bufsize = 0;\r
146 raw->session_started = FALSE;\r
147 raw->conf = conf_copy(conf);\r
148 \r
149 raw->frontend = frontend_handle;\r
150 \r
151 addressfamily = conf_get_int(conf, CONF_addressfamily);\r
152 /*\r
153 * Try to find host.\r
154 */\r
155 addr = name_lookup(host, port, realhost, conf, addressfamily,\r
156 raw->frontend, "main connection");\r
157 if ((err = sk_addr_error(addr)) != NULL) {\r
158 sk_addr_free(addr);\r
159 return err;\r
160 }\r
161 \r
162 if (port < 0)\r
163 port = 23; /* default telnet port */\r
164 \r
165 /*\r
166 * Open socket.\r
167 */\r
168 raw->s = new_connection(addr, *realhost, port, 0, 1, nodelay, keepalive,\r
169 (Plug) raw, conf);\r
170 if ((err = sk_socket_error(raw->s)) != NULL)\r
171 return err;\r
172 \r
173 loghost = conf_get_str(conf, CONF_loghost);\r
174 if (*loghost) {\r
175 char *colon;\r
176 \r
177 sfree(*realhost);\r
178 *realhost = dupstr(loghost);\r
179 \r
180 colon = host_strrchr(*realhost, ':');\r
181 if (colon)\r
182 *colon++ = '\0';\r
183 }\r
184 \r
185 return NULL;\r
186 }\r
187 \r
188 static void raw_free(void *handle)\r
189 {\r
190 Raw raw = (Raw) handle;\r
191 \r
192 if (raw->s)\r
193 sk_close(raw->s);\r
194 conf_free(raw->conf);\r
195 sfree(raw);\r
196 }\r
197 \r
198 /*\r
199 * Stub routine (we don't have any need to reconfigure this backend).\r
200 */\r
201 static void raw_reconfig(void *handle, Conf *conf)\r
202 {\r
203 }\r
204 \r
205 /*\r
206 * Called to send data down the raw connection.\r
207 */\r
208 static int raw_send(void *handle, const char *buf, int len)\r
209 {\r
210 Raw raw = (Raw) handle;\r
211 \r
212 if (raw->s == NULL)\r
213 return 0;\r
214 \r
215 raw->bufsize = sk_write(raw->s, buf, len);\r
216 \r
217 return raw->bufsize;\r
218 }\r
219 \r
220 /*\r
221 * Called to query the current socket sendability status.\r
222 */\r
223 static int raw_sendbuffer(void *handle)\r
224 {\r
225 Raw raw = (Raw) handle;\r
226 return raw->bufsize;\r
227 }\r
228 \r
229 /*\r
230 * Called to set the size of the window\r
231 */\r
232 static void raw_size(void *handle, int width, int height)\r
233 {\r
234 /* Do nothing! */\r
235 return;\r
236 }\r
237 \r
238 /*\r
239 * Send raw special codes. We only handle outgoing EOF here.\r
240 */\r
241 static void raw_special(void *handle, Telnet_Special code)\r
242 {\r
243 Raw raw = (Raw) handle;\r
244 if (code == TS_EOF && raw->s) {\r
245 sk_write_eof(raw->s);\r
246 raw->sent_socket_eof= TRUE;\r
247 raw_check_close(raw);\r
248 }\r
249 \r
250 return;\r
251 }\r
252 \r
253 /*\r
254 * Return a list of the special codes that make sense in this\r
255 * protocol.\r
256 */\r
257 static const struct telnet_special *raw_get_specials(void *handle)\r
258 {\r
259 return NULL;\r
260 }\r
261 \r
262 static int raw_connected(void *handle)\r
263 {\r
264 Raw raw = (Raw) handle;\r
265 return raw->s != NULL;\r
266 }\r
267 \r
268 static int raw_sendok(void *handle)\r
269 {\r
270 return 1;\r
271 }\r
272 \r
273 static void raw_unthrottle(void *handle, int backlog)\r
274 {\r
275 Raw raw = (Raw) handle;\r
276 sk_set_frozen(raw->s, backlog > RAW_MAX_BACKLOG);\r
277 }\r
278 \r
279 static int raw_ldisc(void *handle, int option)\r
280 {\r
281 if (option == LD_EDIT || option == LD_ECHO)\r
282 return 1;\r
283 return 0;\r
284 }\r
285 \r
286 static void raw_provide_ldisc(void *handle, void *ldisc)\r
287 {\r
288 /* This is a stub. */\r
289 }\r
290 \r
291 static void raw_provide_logctx(void *handle, void *logctx)\r
292 {\r
293 /* This is a stub. */\r
294 }\r
295 \r
296 static int raw_exitcode(void *handle)\r
297 {\r
298 Raw raw = (Raw) handle;\r
299 if (raw->s != NULL)\r
300 return -1; /* still connected */\r
301 else if (raw->closed_on_socket_error)\r
302 return INT_MAX; /* a socket error counts as an unclean exit */\r
303 else\r
304 /* Exit codes are a meaningless concept in the Raw protocol */\r
305 return 0;\r
306 }\r
307 \r
308 /*\r
309 * cfg_info for Raw does nothing at all.\r
310 */\r
311 static int raw_cfg_info(void *handle)\r
312 {\r
313 return 0;\r
314 }\r
315 \r
316 Backend raw_backend = {\r
317 raw_init,\r
318 raw_free,\r
319 raw_reconfig,\r
320 raw_send,\r
321 raw_sendbuffer,\r
322 raw_size,\r
323 raw_special,\r
324 raw_get_specials,\r
325 raw_connected,\r
326 raw_exitcode,\r
327 raw_sendok,\r
328 raw_ldisc,\r
329 raw_provide_ldisc,\r
330 raw_provide_logctx,\r
331 raw_unthrottle,\r
332 raw_cfg_info,\r
333 NULL /* test_for_upstream */,\r
334 "raw",\r
335 PROT_RAW,\r
336 0\r
337 };\r