Weaken the assertion in general_textout(). It was failing in the
[u/mdw/putty] / windows / winplink.c
1 /*
2 * PLink - a Windows command-line (stdin/stdout) variant of PuTTY.
3 */
4
5 #include <stdio.h>
6 #include <stdlib.h>
7 #include <assert.h>
8 #include <stdarg.h>
9
10 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
11 #include "putty.h"
12 #include "storage.h"
13 #include "tree234.h"
14
15 #define WM_AGENT_CALLBACK (WM_APP + 4)
16
17 struct agent_callback {
18 void (*callback)(void *, void *, int);
19 void *callback_ctx;
20 void *data;
21 int len;
22 };
23
24 void fatalbox(char *p, ...)
25 {
26 va_list ap;
27 fprintf(stderr, "FATAL ERROR: ");
28 va_start(ap, p);
29 vfprintf(stderr, p, ap);
30 va_end(ap);
31 fputc('\n', stderr);
32 if (logctx) {
33 log_free(logctx);
34 logctx = NULL;
35 }
36 cleanup_exit(1);
37 }
38 void modalfatalbox(char *p, ...)
39 {
40 va_list ap;
41 fprintf(stderr, "FATAL ERROR: ");
42 va_start(ap, p);
43 vfprintf(stderr, p, ap);
44 va_end(ap);
45 fputc('\n', stderr);
46 if (logctx) {
47 log_free(logctx);
48 logctx = NULL;
49 }
50 cleanup_exit(1);
51 }
52 void connection_fatal(void *frontend, char *p, ...)
53 {
54 va_list ap;
55 fprintf(stderr, "FATAL ERROR: ");
56 va_start(ap, p);
57 vfprintf(stderr, p, ap);
58 va_end(ap);
59 fputc('\n', stderr);
60 if (logctx) {
61 log_free(logctx);
62 logctx = NULL;
63 }
64 cleanup_exit(1);
65 }
66 void cmdline_error(char *p, ...)
67 {
68 va_list ap;
69 fprintf(stderr, "plink: ");
70 va_start(ap, p);
71 vfprintf(stderr, p, ap);
72 va_end(ap);
73 fputc('\n', stderr);
74 exit(1);
75 }
76
77 HANDLE inhandle, outhandle, errhandle;
78 struct handle *stdin_handle, *stdout_handle, *stderr_handle;
79 DWORD orig_console_mode;
80 int connopen;
81
82 WSAEVENT netevent;
83
84 static Backend *back;
85 static void *backhandle;
86 static Config cfg;
87
88 int term_ldisc(Terminal *term, int mode)
89 {
90 return FALSE;
91 }
92 void ldisc_update(void *frontend, int echo, int edit)
93 {
94 /* Update stdin read mode to reflect changes in line discipline. */
95 DWORD mode;
96
97 mode = ENABLE_PROCESSED_INPUT;
98 if (echo)
99 mode = mode | ENABLE_ECHO_INPUT;
100 else
101 mode = mode & ~ENABLE_ECHO_INPUT;
102 if (edit)
103 mode = mode | ENABLE_LINE_INPUT;
104 else
105 mode = mode & ~ENABLE_LINE_INPUT;
106 SetConsoleMode(inhandle, mode);
107 }
108
109 char *get_ttymode(void *frontend, const char *mode) { return NULL; }
110
111 int from_backend(void *frontend_handle, int is_stderr,
112 const char *data, int len)
113 {
114 if (is_stderr) {
115 handle_write(stderr_handle, data, len);
116 } else {
117 handle_write(stdout_handle, data, len);
118 }
119
120 return handle_backlog(stdout_handle) + handle_backlog(stderr_handle);
121 }
122
123 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
124 {
125 /*
126 * No "untrusted" output should get here (the way the code is
127 * currently, it's all diverted by FLAG_STDERR).
128 */
129 assert(!"Unexpected call to from_backend_untrusted()");
130 return 0; /* not reached */
131 }
132
133 int get_userpass_input(prompts_t *p, unsigned char *in, int inlen)
134 {
135 int ret;
136 ret = cmdline_get_passwd_input(p, in, inlen);
137 if (ret == -1)
138 ret = console_get_userpass_input(p, in, inlen);
139 return ret;
140 }
141
142 static DWORD main_thread_id;
143
144 void agent_schedule_callback(void (*callback)(void *, void *, int),
145 void *callback_ctx, void *data, int len)
146 {
147 struct agent_callback *c = snew(struct agent_callback);
148 c->callback = callback;
149 c->callback_ctx = callback_ctx;
150 c->data = data;
151 c->len = len;
152 PostThreadMessage(main_thread_id, WM_AGENT_CALLBACK, 0, (LPARAM)c);
153 }
154
155 /*
156 * Short description of parameters.
157 */
158 static void usage(void)
159 {
160 printf("PuTTY Link: command-line connection utility\n");
161 printf("%s\n", ver);
162 printf("Usage: plink [options] [user@]host [command]\n");
163 printf(" (\"host\" can also be a PuTTY saved session name)\n");
164 printf("Options:\n");
165 printf(" -V print version information and exit\n");
166 printf(" -pgpfp print PGP key fingerprints and exit\n");
167 printf(" -v show verbose messages\n");
168 printf(" -load sessname Load settings from saved session\n");
169 printf(" -ssh -telnet -rlogin -raw\n");
170 printf(" force use of a particular protocol\n");
171 printf(" -P port connect to specified port\n");
172 printf(" -l user connect with specified username\n");
173 printf(" -batch disable all interactive prompts\n");
174 printf("The following options only apply to SSH connections:\n");
175 printf(" -pw passw login with specified password\n");
176 printf(" -D [listen-IP:]listen-port\n");
177 printf(" Dynamic SOCKS-based port forwarding\n");
178 printf(" -L [listen-IP:]listen-port:host:port\n");
179 printf(" Forward local port to remote address\n");
180 printf(" -R [listen-IP:]listen-port:host:port\n");
181 printf(" Forward remote port to local address\n");
182 printf(" -X -x enable / disable X11 forwarding\n");
183 printf(" -A -a enable / disable agent forwarding\n");
184 printf(" -t -T enable / disable pty allocation\n");
185 printf(" -1 -2 force use of particular protocol version\n");
186 printf(" -4 -6 force use of IPv4 or IPv6\n");
187 printf(" -C enable compression\n");
188 printf(" -i key private key file for authentication\n");
189 printf(" -noagent disable use of Pageant\n");
190 printf(" -agent enable use of Pageant\n");
191 printf(" -m file read remote command(s) from file\n");
192 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
193 printf(" -N don't start a shell/command (SSH-2 only)\n");
194 printf(" -nc host:port\n");
195 printf(" open tunnel in place of session (SSH-2 only)\n");
196 exit(1);
197 }
198
199 static void version(void)
200 {
201 printf("plink: %s\n", ver);
202 exit(1);
203 }
204
205 char *do_select(SOCKET skt, int startup)
206 {
207 int events;
208 if (startup) {
209 events = (FD_CONNECT | FD_READ | FD_WRITE |
210 FD_OOB | FD_CLOSE | FD_ACCEPT);
211 } else {
212 events = 0;
213 }
214 if (p_WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
215 switch (p_WSAGetLastError()) {
216 case WSAENETDOWN:
217 return "Network is down";
218 default:
219 return "WSAEventSelect(): unknown error";
220 }
221 }
222 return NULL;
223 }
224
225 int stdin_gotdata(struct handle *h, void *data, int len)
226 {
227 if (len < 0) {
228 /*
229 * Special case: report read error.
230 */
231 char buf[4096];
232 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -len, 0,
233 buf, lenof(buf), NULL);
234 buf[lenof(buf)-1] = '\0';
235 if (buf[strlen(buf)-1] == '\n')
236 buf[strlen(buf)-1] = '\0';
237 fprintf(stderr, "Unable to read from standard input: %s\n", buf);
238 cleanup_exit(0);
239 }
240 noise_ultralight(len);
241 if (connopen && back->connected(backhandle)) {
242 if (len > 0) {
243 return back->send(backhandle, data, len);
244 } else {
245 back->special(backhandle, TS_EOF);
246 return 0;
247 }
248 } else
249 return 0;
250 }
251
252 void stdouterr_sent(struct handle *h, int new_backlog)
253 {
254 if (new_backlog < 0) {
255 /*
256 * Special case: report write error.
257 */
258 char buf[4096];
259 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -new_backlog, 0,
260 buf, lenof(buf), NULL);
261 buf[lenof(buf)-1] = '\0';
262 if (buf[strlen(buf)-1] == '\n')
263 buf[strlen(buf)-1] = '\0';
264 fprintf(stderr, "Unable to write to standard %s: %s\n",
265 (h == stdout_handle ? "output" : "error"), buf);
266 cleanup_exit(0);
267 }
268 if (connopen && back->connected(backhandle)) {
269 back->unthrottle(backhandle, (handle_backlog(stdout_handle) +
270 handle_backlog(stderr_handle)));
271 }
272 }
273
274 int main(int argc, char **argv)
275 {
276 int sending;
277 int portnumber = -1;
278 SOCKET *sklist;
279 int skcount, sksize;
280 int exitcode;
281 int errors;
282 int use_subsystem = 0;
283 long now, next;
284
285 sklist = NULL;
286 skcount = sksize = 0;
287 /*
288 * Initialise port and protocol to sensible defaults. (These
289 * will be overridden by more or less anything.)
290 */
291 default_protocol = PROT_SSH;
292 default_port = 22;
293
294 flags = FLAG_STDERR;
295 /*
296 * Process the command line.
297 */
298 do_defaults(NULL, &cfg);
299 loaded_session = FALSE;
300 default_protocol = cfg.protocol;
301 default_port = cfg.port;
302 errors = 0;
303 {
304 /*
305 * Override the default protocol if PLINK_PROTOCOL is set.
306 */
307 char *p = getenv("PLINK_PROTOCOL");
308 if (p) {
309 const Backend *b = backend_from_name(p);
310 if (b) {
311 default_protocol = cfg.protocol = b->protocol;
312 default_port = cfg.port = b->default_port;
313 }
314 }
315 }
316 while (--argc) {
317 char *p = *++argv;
318 if (*p == '-') {
319 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
320 1, &cfg);
321 if (ret == -2) {
322 fprintf(stderr,
323 "plink: option \"%s\" requires an argument\n", p);
324 errors = 1;
325 } else if (ret == 2) {
326 --argc, ++argv;
327 } else if (ret == 1) {
328 continue;
329 } else if (!strcmp(p, "-batch")) {
330 console_batch_mode = 1;
331 } else if (!strcmp(p, "-s")) {
332 /* Save status to write to cfg later. */
333 use_subsystem = 1;
334 } else if (!strcmp(p, "-V")) {
335 version();
336 } else if (!strcmp(p, "-pgpfp")) {
337 pgp_fingerprints();
338 exit(1);
339 } else {
340 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
341 errors = 1;
342 }
343 } else if (*p) {
344 if (!cfg_launchable(&cfg)) {
345 char *q = p;
346 /*
347 * If the hostname starts with "telnet:", set the
348 * protocol to Telnet and process the string as a
349 * Telnet URL.
350 */
351 if (!strncmp(q, "telnet:", 7)) {
352 char c;
353
354 q += 7;
355 if (q[0] == '/' && q[1] == '/')
356 q += 2;
357 cfg.protocol = PROT_TELNET;
358 p = q;
359 while (*p && *p != ':' && *p != '/')
360 p++;
361 c = *p;
362 if (*p)
363 *p++ = '\0';
364 if (c == ':')
365 cfg.port = atoi(p);
366 else
367 cfg.port = -1;
368 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
369 cfg.host[sizeof(cfg.host) - 1] = '\0';
370 } else {
371 char *r, *user, *host;
372 /*
373 * Before we process the [user@]host string, we
374 * first check for the presence of a protocol
375 * prefix (a protocol name followed by ",").
376 */
377 r = strchr(p, ',');
378 if (r) {
379 const Backend *b;
380 *r = '\0';
381 b = backend_from_name(p);
382 if (b) {
383 default_protocol = cfg.protocol = b->protocol;
384 portnumber = b->default_port;
385 }
386 p = r + 1;
387 }
388
389 /*
390 * A nonzero length string followed by an @ is treated
391 * as a username. (We discount an _initial_ @.) The
392 * rest of the string (or the whole string if no @)
393 * is treated as a session name and/or hostname.
394 */
395 r = strrchr(p, '@');
396 if (r == p)
397 p++, r = NULL; /* discount initial @ */
398 if (r) {
399 *r++ = '\0';
400 user = p, host = r;
401 } else {
402 user = NULL, host = p;
403 }
404
405 /*
406 * Now attempt to load a saved session with the
407 * same name as the hostname.
408 */
409 {
410 Config cfg2;
411 do_defaults(host, &cfg2);
412 if (loaded_session || !cfg_launchable(&cfg2)) {
413 /* No settings for this host; use defaults */
414 /* (or session was already loaded with -load) */
415 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
416 cfg.host[sizeof(cfg.host) - 1] = '\0';
417 cfg.port = default_port;
418 } else {
419 cfg = cfg2;
420 }
421 }
422
423 if (user) {
424 /* Patch in specified username. */
425 strncpy(cfg.username, user,
426 sizeof(cfg.username) - 1);
427 cfg.username[sizeof(cfg.username) - 1] = '\0';
428 }
429
430 }
431 } else {
432 char *command;
433 int cmdlen, cmdsize;
434 cmdlen = cmdsize = 0;
435 command = NULL;
436
437 while (argc) {
438 while (*p) {
439 if (cmdlen >= cmdsize) {
440 cmdsize = cmdlen + 512;
441 command = sresize(command, cmdsize, char);
442 }
443 command[cmdlen++]=*p++;
444 }
445 if (cmdlen >= cmdsize) {
446 cmdsize = cmdlen + 512;
447 command = sresize(command, cmdsize, char);
448 }
449 command[cmdlen++]=' '; /* always add trailing space */
450 if (--argc) p = *++argv;
451 }
452 if (cmdlen) command[--cmdlen]='\0';
453 /* change trailing blank to NUL */
454 cfg.remote_cmd_ptr = command;
455 cfg.remote_cmd_ptr2 = NULL;
456 cfg.nopty = TRUE; /* command => no terminal */
457
458 break; /* done with cmdline */
459 }
460 }
461 }
462
463 if (errors)
464 return 1;
465
466 if (!cfg_launchable(&cfg)) {
467 usage();
468 }
469
470 /*
471 * Trim leading whitespace off the hostname if it's there.
472 */
473 {
474 int space = strspn(cfg.host, " \t");
475 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
476 }
477
478 /* See if host is of the form user@host */
479 if (cfg_launchable(&cfg)) {
480 char *atsign = strrchr(cfg.host, '@');
481 /* Make sure we're not overflowing the user field */
482 if (atsign) {
483 if (atsign - cfg.host < sizeof cfg.username) {
484 strncpy(cfg.username, cfg.host, atsign - cfg.host);
485 cfg.username[atsign - cfg.host] = '\0';
486 }
487 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
488 }
489 }
490
491 /*
492 * Perform command-line overrides on session configuration.
493 */
494 cmdline_run_saved(&cfg);
495
496 /*
497 * Apply subsystem status.
498 */
499 if (use_subsystem)
500 cfg.ssh_subsys = TRUE;
501
502 /*
503 * Trim a colon suffix off the hostname if it's there.
504 */
505 cfg.host[strcspn(cfg.host, ":")] = '\0';
506
507 /*
508 * Remove any remaining whitespace from the hostname.
509 */
510 {
511 int p1 = 0, p2 = 0;
512 while (cfg.host[p2] != '\0') {
513 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
514 cfg.host[p1] = cfg.host[p2];
515 p1++;
516 }
517 p2++;
518 }
519 cfg.host[p1] = '\0';
520 }
521
522 if (!cfg.remote_cmd_ptr && !*cfg.remote_cmd && !*cfg.ssh_nc_host)
523 flags |= FLAG_INTERACTIVE;
524
525 /*
526 * Select protocol. This is farmed out into a table in a
527 * separate file to enable an ssh-free variant.
528 */
529 back = backend_from_proto(cfg.protocol);
530 if (back == NULL) {
531 fprintf(stderr,
532 "Internal fault: Unsupported protocol found\n");
533 return 1;
534 }
535
536 /*
537 * Select port.
538 */
539 if (portnumber != -1)
540 cfg.port = portnumber;
541
542 sk_init();
543 if (p_WSAEventSelect == NULL) {
544 fprintf(stderr, "Plink requires WinSock 2\n");
545 return 1;
546 }
547
548 logctx = log_init(NULL, &cfg);
549 console_provide_logctx(logctx);
550
551 /*
552 * Start up the connection.
553 */
554 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
555 {
556 const char *error;
557 char *realhost;
558 /* nodelay is only useful if stdin is a character device (console) */
559 int nodelay = cfg.tcp_nodelay &&
560 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
561
562 error = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port,
563 &realhost, nodelay, cfg.tcp_keepalives);
564 if (error) {
565 fprintf(stderr, "Unable to open connection:\n%s", error);
566 return 1;
567 }
568 back->provide_logctx(backhandle, logctx);
569 sfree(realhost);
570 }
571 connopen = 1;
572
573 inhandle = GetStdHandle(STD_INPUT_HANDLE);
574 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
575 errhandle = GetStdHandle(STD_ERROR_HANDLE);
576
577 /*
578 * Turn off ECHO and LINE input modes. We don't care if this
579 * call fails, because we know we aren't necessarily running in
580 * a console.
581 */
582 GetConsoleMode(inhandle, &orig_console_mode);
583 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
584
585 /*
586 * Pass the output handles to the handle-handling subsystem.
587 * (The input one we leave until we're through the
588 * authentication process.)
589 */
590 stdout_handle = handle_output_new(outhandle, stdouterr_sent, NULL, 0);
591 stderr_handle = handle_output_new(errhandle, stdouterr_sent, NULL, 0);
592
593 main_thread_id = GetCurrentThreadId();
594
595 sending = FALSE;
596
597 now = GETTICKCOUNT();
598
599 while (1) {
600 int nhandles;
601 HANDLE *handles;
602 int n;
603 DWORD ticks;
604
605 if (!sending && back->sendok(backhandle)) {
606 stdin_handle = handle_input_new(inhandle, stdin_gotdata, NULL,
607 0);
608 sending = TRUE;
609 }
610
611 if (run_timers(now, &next)) {
612 ticks = next - GETTICKCOUNT();
613 if (ticks < 0) ticks = 0; /* just in case */
614 } else {
615 ticks = INFINITE;
616 }
617
618 handles = handle_get_events(&nhandles);
619 handles = sresize(handles, nhandles+1, HANDLE);
620 handles[nhandles] = netevent;
621 n = MsgWaitForMultipleObjects(nhandles+1, handles, FALSE, ticks,
622 QS_POSTMESSAGE);
623 if ((unsigned)(n - WAIT_OBJECT_0) < (unsigned)nhandles) {
624 handle_got_event(handles[n - WAIT_OBJECT_0]);
625 } else if (n == WAIT_OBJECT_0 + nhandles) {
626 WSANETWORKEVENTS things;
627 SOCKET socket;
628 extern SOCKET first_socket(int *), next_socket(int *);
629 extern int select_result(WPARAM, LPARAM);
630 int i, socketstate;
631
632 /*
633 * We must not call select_result() for any socket
634 * until we have finished enumerating within the tree.
635 * This is because select_result() may close the socket
636 * and modify the tree.
637 */
638 /* Count the active sockets. */
639 i = 0;
640 for (socket = first_socket(&socketstate);
641 socket != INVALID_SOCKET;
642 socket = next_socket(&socketstate)) i++;
643
644 /* Expand the buffer if necessary. */
645 if (i > sksize) {
646 sksize = i + 16;
647 sklist = sresize(sklist, sksize, SOCKET);
648 }
649
650 /* Retrieve the sockets into sklist. */
651 skcount = 0;
652 for (socket = first_socket(&socketstate);
653 socket != INVALID_SOCKET;
654 socket = next_socket(&socketstate)) {
655 sklist[skcount++] = socket;
656 }
657
658 /* Now we're done enumerating; go through the list. */
659 for (i = 0; i < skcount; i++) {
660 WPARAM wp;
661 socket = sklist[i];
662 wp = (WPARAM) socket;
663 if (!p_WSAEnumNetworkEvents(socket, NULL, &things)) {
664 static const struct { int bit, mask; } eventtypes[] = {
665 {FD_CONNECT_BIT, FD_CONNECT},
666 {FD_READ_BIT, FD_READ},
667 {FD_CLOSE_BIT, FD_CLOSE},
668 {FD_OOB_BIT, FD_OOB},
669 {FD_WRITE_BIT, FD_WRITE},
670 {FD_ACCEPT_BIT, FD_ACCEPT},
671 };
672 int e;
673
674 noise_ultralight(socket);
675 noise_ultralight(things.lNetworkEvents);
676
677 for (e = 0; e < lenof(eventtypes); e++)
678 if (things.lNetworkEvents & eventtypes[e].mask) {
679 LPARAM lp;
680 int err = things.iErrorCode[eventtypes[e].bit];
681 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
682 connopen &= select_result(wp, lp);
683 }
684 }
685 }
686 } else if (n == WAIT_OBJECT_0 + nhandles + 1) {
687 MSG msg;
688 while (PeekMessage(&msg, INVALID_HANDLE_VALUE,
689 WM_AGENT_CALLBACK, WM_AGENT_CALLBACK,
690 PM_REMOVE)) {
691 struct agent_callback *c = (struct agent_callback *)msg.lParam;
692 c->callback(c->callback_ctx, c->data, c->len);
693 sfree(c);
694 }
695 }
696
697 if (n == WAIT_TIMEOUT) {
698 now = next;
699 } else {
700 now = GETTICKCOUNT();
701 }
702
703 sfree(handles);
704
705 if (sending)
706 handle_unthrottle(stdin_handle, back->sendbuffer(backhandle));
707
708 if ((!connopen || !back->connected(backhandle)) &&
709 handle_backlog(stdout_handle) + handle_backlog(stderr_handle) == 0)
710 break; /* we closed the connection */
711 }
712 exitcode = back->exitcode(backhandle);
713 if (exitcode < 0) {
714 fprintf(stderr, "Remote process exit code unavailable\n");
715 exitcode = 1; /* this is an error condition */
716 }
717 cleanup_exit(exitcode);
718 return 0; /* placate compiler warning */
719 }