2 * PLink - a command-line (stdin/stdout) variant of PuTTY.
14 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
19 #define MAX_STDIN_BACKLOG 4096
21 void fatalbox(char *p, ...)
24 fprintf(stderr, "FATAL ERROR: ");
26 vfprintf(stderr, p, ap);
32 void connection_fatal(char *p, ...)
35 fprintf(stderr, "FATAL ERROR: ");
37 vfprintf(stderr, p, ap);
43 void cmdline_error(char *p, ...)
46 fprintf(stderr, "plink: ");
48 vfprintf(stderr, p, ap);
54 static char *password = NULL;
56 HANDLE inhandle, outhandle, errhandle;
57 DWORD orig_console_mode;
61 int term_ldisc(int mode)
65 void ldisc_update(int echo, int edit)
67 /* Update stdin read mode to reflect changes in line discipline. */
70 mode = ENABLE_PROCESSED_INPUT;
72 mode = mode | ENABLE_ECHO_INPUT;
74 mode = mode & ~ENABLE_ECHO_INPUT;
76 mode = mode | ENABLE_LINE_INPUT;
78 mode = mode & ~ENABLE_LINE_INPUT;
79 SetConsoleMode(inhandle, mode);
85 HANDLE event, eventback;
88 static DWORD WINAPI stdin_read_thread(void *param)
90 struct input_data *idata = (struct input_data *) param;
93 inhandle = GetStdHandle(STD_INPUT_HANDLE);
95 while (ReadFile(inhandle, idata->buffer, sizeof(idata->buffer),
96 &idata->len, NULL) && idata->len > 0) {
97 SetEvent(idata->event);
98 WaitForSingleObject(idata->eventback, INFINITE);
102 SetEvent(idata->event);
108 DWORD len, lenwritten;
112 HANDLE event, eventback;
116 static DWORD WINAPI stdout_write_thread(void *param)
118 struct output_data *odata = (struct output_data *) param;
119 HANDLE outhandle, errhandle;
121 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
122 errhandle = GetStdHandle(STD_ERROR_HANDLE);
125 WaitForSingleObject(odata->eventback, INFINITE);
129 WriteFile(odata->is_stderr ? errhandle : outhandle,
130 odata->buffer, odata->len, &odata->lenwritten, NULL);
131 SetEvent(odata->event);
137 bufchain stdout_data, stderr_data;
138 struct output_data odata, edata;
140 void try_output(int is_stderr)
142 struct output_data *data = (is_stderr ? &edata : &odata);
147 bufchain_prefix(is_stderr ? &stderr_data : &stdout_data,
148 &senddata, &sendlen);
149 data->buffer = senddata;
151 SetEvent(data->eventback);
156 int from_backend(int is_stderr, char *data, int len)
158 HANDLE h = (is_stderr ? errhandle : outhandle);
164 bufchain_add(&stderr_data, data, len);
167 bufchain_add(&stdout_data, data, len);
171 osize = bufchain_size(&stdout_data);
172 esize = bufchain_size(&stderr_data);
174 return osize + esize;
178 * Short description of parameters.
180 static void usage(void)
182 printf("PuTTY Link: command-line connection utility\n");
184 printf("Usage: plink [options] [user@]host [command]\n");
185 printf(" (\"host\" can also be a PuTTY saved session name)\n");
186 printf("Options:\n");
187 printf(" -v show verbose messages\n");
188 printf(" -ssh force use of ssh protocol\n");
189 printf(" -P port connect to specified port\n");
190 printf(" -pw passw login with specified password\n");
191 printf(" -m file read remote command(s) from file\n");
192 printf(" -L listen-port:host:port Forward local port to "
194 printf(" -R listen-port:host:port Forward remote port to"
199 char *do_select(SOCKET skt, int startup)
203 events = (FD_CONNECT | FD_READ | FD_WRITE |
204 FD_OOB | FD_CLOSE | FD_ACCEPT);
208 if (WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
209 switch (WSAGetLastError()) {
211 return "Network is down";
213 return "WSAAsyncSelect(): unknown error";
219 int main(int argc, char **argv)
223 WSAEVENT stdinevent, stdoutevent, stderrevent;
225 DWORD in_threadid, out_threadid, err_threadid;
226 struct input_data idata;
235 ssh_get_line = console_get_line;
238 skcount = sksize = 0;
240 * Initialise port and protocol to sensible defaults. (These
241 * will be overridden by more or less anything.)
243 default_protocol = PROT_SSH;
248 * Process the command line.
250 do_defaults(NULL, &cfg);
251 default_protocol = cfg.protocol;
252 default_port = cfg.port;
255 * Override the default protocol if PLINK_PROTOCOL is set.
257 char *p = getenv("PLINK_PROTOCOL");
260 for (i = 0; backends[i].backend != NULL; i++) {
261 if (!strcmp(backends[i].name, p)) {
262 default_protocol = cfg.protocol = backends[i].protocol;
263 default_port = cfg.port =
264 backends[i].backend->default_port;
273 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL), 1);
276 "plink: option \"%s\" requires an argument\n", p);
277 } else if (ret == 2) {
279 } else if (ret == 1) {
281 } else if (!strcmp(p, "-batch")) {
282 console_batch_mode = 1;
283 } else if (!strcmp(p, "-log")) {
284 logfile = "putty.log";
290 * If the hostname starts with "telnet:", set the
291 * protocol to Telnet and process the string as a
294 if (!strncmp(q, "telnet:", 7)) {
298 if (q[0] == '/' && q[1] == '/')
300 cfg.protocol = PROT_TELNET;
302 while (*p && *p != ':' && *p != '/')
311 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
312 cfg.host[sizeof(cfg.host) - 1] = '\0';
316 * Before we process the [user@]host string, we
317 * first check for the presence of a protocol
318 * prefix (a protocol name followed by ",").
323 for (i = 0; backends[i].backend != NULL; i++) {
324 j = strlen(backends[i].name);
326 !memcmp(backends[i].name, p, j)) {
327 default_protocol = cfg.protocol =
328 backends[i].protocol;
330 backends[i].backend->default_port;
338 * Three cases. Either (a) there's a nonzero
339 * length string followed by an @, in which
340 * case that's user and the remainder is host.
341 * Or (b) there's only one string, not counting
342 * a potential initial @, and it exists in the
343 * saved-sessions database. Or (c) only one
344 * string and it _doesn't_ exist in the
349 p++, r = NULL; /* discount initial @ */
355 do_defaults(p, &cfg2);
356 if (cfg2.host[0] == '\0') {
357 /* No settings for this host; use defaults */
358 strncpy(cfg.host, p, sizeof(cfg.host) - 1);
359 cfg.host[sizeof(cfg.host) - 1] = '\0';
360 cfg.port = default_port;
363 cfg.remote_cmd_ptr = cfg.remote_cmd;
367 strncpy(cfg.username, p, sizeof(cfg.username) - 1);
368 cfg.username[sizeof(cfg.username) - 1] = '\0';
369 strncpy(cfg.host, r, sizeof(cfg.host) - 1);
370 cfg.host[sizeof(cfg.host) - 1] = '\0';
371 cfg.port = default_port;
377 cmdlen = cmdsize = 0;
382 if (cmdlen >= cmdsize) {
383 cmdsize = cmdlen + 512;
384 command = srealloc(command, cmdsize);
386 command[cmdlen++]=*p++;
388 if (cmdlen >= cmdsize) {
389 cmdsize = cmdlen + 512;
390 command = srealloc(command, cmdsize);
392 command[cmdlen++]=' '; /* always add trailing space */
393 if (--argc) p = *++argv;
395 if (cmdlen) command[--cmdlen]='\0';
396 /* change trailing blank to NUL */
397 cfg.remote_cmd_ptr = command;
398 cfg.remote_cmd_ptr2 = NULL;
399 cfg.nopty = TRUE; /* command => no terminal */
401 break; /* done with cmdline */
411 * Trim leading whitespace off the hostname if it's there.
414 int space = strspn(cfg.host, " \t");
415 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
418 /* See if host is of the form user@host */
419 if (cfg.host[0] != '\0') {
420 char *atsign = strchr(cfg.host, '@');
421 /* Make sure we're not overflowing the user field */
423 if (atsign - cfg.host < sizeof cfg.username) {
424 strncpy(cfg.username, cfg.host, atsign - cfg.host);
425 cfg.username[atsign - cfg.host] = '\0';
427 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
432 * Perform command-line overrides on session configuration.
437 * Trim a colon suffix off the hostname if it's there.
439 cfg.host[strcspn(cfg.host, ":")] = '\0';
441 if (!*cfg.remote_cmd_ptr)
442 flags |= FLAG_INTERACTIVE;
445 * Select protocol. This is farmed out into a table in a
446 * separate file to enable an ssh-free variant.
451 for (i = 0; backends[i].backend != NULL; i++)
452 if (backends[i].protocol == cfg.protocol) {
453 back = backends[i].backend;
458 "Internal fault: Unsupported protocol found\n");
466 if (portnumber != -1)
467 cfg.port = portnumber;
470 * Initialise WinSock.
472 winsock_ver = MAKEWORD(2, 0);
473 if (WSAStartup(winsock_ver, &wsadata)) {
474 MessageBox(NULL, "Unable to initialise WinSock", "WinSock Error",
475 MB_OK | MB_ICONEXCLAMATION);
478 if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 0) {
479 MessageBox(NULL, "WinSock version is incompatible with 2.0",
480 "WinSock Error", MB_OK | MB_ICONEXCLAMATION);
487 * Start up the connection.
489 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
493 /* nodelay is only useful if stdin is a character device (console) */
494 int nodelay = cfg.tcp_nodelay &&
495 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
497 error = back->init(cfg.host, cfg.port, &realhost, nodelay);
499 fprintf(stderr, "Unable to open connection:\n%s", error);
506 stdinevent = CreateEvent(NULL, FALSE, FALSE, NULL);
507 stdoutevent = CreateEvent(NULL, FALSE, FALSE, NULL);
508 stderrevent = CreateEvent(NULL, FALSE, FALSE, NULL);
510 inhandle = GetStdHandle(STD_INPUT_HANDLE);
511 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
512 errhandle = GetStdHandle(STD_ERROR_HANDLE);
513 GetConsoleMode(inhandle, &orig_console_mode);
514 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
517 * Turn off ECHO and LINE input modes. We don't care if this
518 * call fails, because we know we aren't necessarily running in
521 handles[0] = netevent;
522 handles[1] = stdinevent;
523 handles[2] = stdoutevent;
524 handles[3] = stderrevent;
528 * Create spare threads to write to stdout and stderr, so we
529 * can arrange asynchronous writes.
531 odata.event = stdoutevent;
532 odata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
534 odata.busy = odata.done = 0;
535 if (!CreateThread(NULL, 0, stdout_write_thread,
536 &odata, 0, &out_threadid)) {
537 fprintf(stderr, "Unable to create output thread\n");
540 edata.event = stderrevent;
541 edata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
543 edata.busy = edata.done = 0;
544 if (!CreateThread(NULL, 0, stdout_write_thread,
545 &edata, 0, &err_threadid)) {
546 fprintf(stderr, "Unable to create error output thread\n");
553 if (!sending && back->sendok()) {
555 * Create a separate thread to read from stdin. This is
556 * a total pain, but I can't find another way to do it:
558 * - an overlapped ReadFile or ReadFileEx just doesn't
559 * happen; we get failure from ReadFileEx, and
560 * ReadFile blocks despite being given an OVERLAPPED
561 * structure. Perhaps we can't do overlapped reads
562 * on consoles. WHY THE HELL NOT?
564 * - WaitForMultipleObjects(netevent, console) doesn't
565 * work, because it signals the console when
566 * _anything_ happens, including mouse motions and
567 * other things that don't cause data to be readable
568 * - so we're back to ReadFile blocking.
570 idata.event = stdinevent;
571 idata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
572 if (!CreateThread(NULL, 0, stdin_read_thread,
573 &idata, 0, &in_threadid)) {
574 fprintf(stderr, "Unable to create input thread\n");
580 n = WaitForMultipleObjects(4, handles, FALSE, INFINITE);
582 WSANETWORKEVENTS things;
584 extern SOCKET first_socket(int *), next_socket(int *);
585 extern int select_result(WPARAM, LPARAM);
589 * We must not call select_result() for any socket
590 * until we have finished enumerating within the tree.
591 * This is because select_result() may close the socket
592 * and modify the tree.
594 /* Count the active sockets. */
596 for (socket = first_socket(&socketstate);
597 socket != INVALID_SOCKET;
598 socket = next_socket(&socketstate)) i++;
600 /* Expand the buffer if necessary. */
603 sklist = srealloc(sklist, sksize * sizeof(*sklist));
606 /* Retrieve the sockets into sklist. */
608 for (socket = first_socket(&socketstate);
609 socket != INVALID_SOCKET;
610 socket = next_socket(&socketstate)) {
611 sklist[skcount++] = socket;
614 /* Now we're done enumerating; go through the list. */
615 for (i = 0; i < skcount; i++) {
618 wp = (WPARAM) socket;
619 if (!WSAEnumNetworkEvents(socket, NULL, &things)) {
620 static const struct { int bit, mask; } eventtypes[] = {
621 {FD_CONNECT_BIT, FD_CONNECT},
622 {FD_READ_BIT, FD_READ},
623 {FD_CLOSE_BIT, FD_CLOSE},
624 {FD_OOB_BIT, FD_OOB},
625 {FD_WRITE_BIT, FD_WRITE},
626 {FD_ACCEPT_BIT, FD_ACCEPT},
630 noise_ultralight(socket);
631 noise_ultralight(things.lNetworkEvents);
633 for (e = 0; e < lenof(eventtypes); e++)
634 if (things.lNetworkEvents & eventtypes[e].mask) {
636 int err = things.iErrorCode[eventtypes[e].bit];
637 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
638 connopen &= select_result(wp, lp);
644 noise_ultralight(idata.len);
645 if (connopen && back->socket() != NULL) {
647 back->send(idata.buffer, idata.len);
649 back->special(TS_EOF);
654 if (!odata.writeret) {
655 fprintf(stderr, "Unable to write to standard output\n");
658 bufchain_consume(&stdout_data, odata.lenwritten);
659 if (bufchain_size(&stdout_data) > 0)
661 if (connopen && back->socket() != NULL) {
662 back->unthrottle(bufchain_size(&stdout_data) +
663 bufchain_size(&stderr_data));
667 if (!edata.writeret) {
668 fprintf(stderr, "Unable to write to standard output\n");
671 bufchain_consume(&stderr_data, edata.lenwritten);
672 if (bufchain_size(&stderr_data) > 0)
674 if (connopen && back->socket() != NULL) {
675 back->unthrottle(bufchain_size(&stdout_data) +
676 bufchain_size(&stderr_data));
679 if (!reading && back->sendbuffer() < MAX_STDIN_BACKLOG) {
680 SetEvent(idata.eventback);
683 if ((!connopen || back->socket() == NULL) &&
684 bufchain_size(&stdout_data) == 0 &&
685 bufchain_size(&stderr_data) == 0)
686 break; /* we closed the connection */
689 exitcode = back->exitcode();
691 fprintf(stderr, "Remote process exit code unavailable\n");
692 exitcode = 1; /* this is an error condition */