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