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 modalfatalbox(char *p, ...)
35 fprintf(stderr, "FATAL ERROR: ");
37 vfprintf(stderr, p, ap);
43 void connection_fatal(char *p, ...)
46 fprintf(stderr, "FATAL ERROR: ");
48 vfprintf(stderr, p, ap);
54 void cmdline_error(char *p, ...)
57 fprintf(stderr, "plink: ");
59 vfprintf(stderr, p, ap);
65 static char *password = NULL;
67 HANDLE inhandle, outhandle, errhandle;
68 DWORD orig_console_mode;
72 int term_ldisc(int mode)
76 void ldisc_update(int echo, int edit)
78 /* Update stdin read mode to reflect changes in line discipline. */
81 mode = ENABLE_PROCESSED_INPUT;
83 mode = mode | ENABLE_ECHO_INPUT;
85 mode = mode & ~ENABLE_ECHO_INPUT;
87 mode = mode | ENABLE_LINE_INPUT;
89 mode = mode & ~ENABLE_LINE_INPUT;
90 SetConsoleMode(inhandle, mode);
96 HANDLE event, eventback;
99 static DWORD WINAPI stdin_read_thread(void *param)
101 struct input_data *idata = (struct input_data *) param;
104 inhandle = GetStdHandle(STD_INPUT_HANDLE);
106 while (ReadFile(inhandle, idata->buffer, sizeof(idata->buffer),
107 &idata->len, NULL) && idata->len > 0) {
108 SetEvent(idata->event);
109 WaitForSingleObject(idata->eventback, INFINITE);
113 SetEvent(idata->event);
119 DWORD len, lenwritten;
123 HANDLE event, eventback;
127 static DWORD WINAPI stdout_write_thread(void *param)
129 struct output_data *odata = (struct output_data *) param;
130 HANDLE outhandle, errhandle;
132 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
133 errhandle = GetStdHandle(STD_ERROR_HANDLE);
136 WaitForSingleObject(odata->eventback, INFINITE);
140 WriteFile(odata->is_stderr ? errhandle : outhandle,
141 odata->buffer, odata->len, &odata->lenwritten, NULL);
142 SetEvent(odata->event);
148 bufchain stdout_data, stderr_data;
149 struct output_data odata, edata;
151 void try_output(int is_stderr)
153 struct output_data *data = (is_stderr ? &edata : &odata);
158 bufchain_prefix(is_stderr ? &stderr_data : &stdout_data,
159 &senddata, &sendlen);
160 data->buffer = senddata;
162 SetEvent(data->eventback);
167 int from_backend(int is_stderr, char *data, int len)
169 HANDLE h = (is_stderr ? errhandle : outhandle);
175 bufchain_add(&stderr_data, data, len);
178 bufchain_add(&stdout_data, data, len);
182 osize = bufchain_size(&stdout_data);
183 esize = bufchain_size(&stderr_data);
185 return osize + esize;
189 * Short description of parameters.
191 static void usage(void)
193 printf("PuTTY Link: command-line connection utility\n");
195 printf("Usage: plink [options] [user@]host [command]\n");
196 printf(" (\"host\" can also be a PuTTY saved session name)\n");
197 printf("Options:\n");
198 printf(" -v show verbose messages\n");
199 printf(" -load sessname Load settings from saved session\n");
200 printf(" -ssh -telnet -rlogin -raw\n");
201 printf(" force use of a particular protocol (default SSH)\n");
202 printf(" -P port connect to specified port\n");
203 printf(" -l user connect with specified username\n");
204 printf(" -m file read remote command(s) from file\n");
205 printf(" -batch disable all interactive prompts\n");
206 printf("The following options only apply to SSH connections:\n");
207 printf(" -pw passw login with specified password\n");
208 printf(" -L listen-port:host:port Forward local port to "
210 printf(" -R listen-port:host:port Forward remote port to"
212 printf(" -X -x enable / disable X11 forwarding\n");
213 printf(" -A -a enable / disable agent forwarding\n");
214 printf(" -t -T enable / disable pty allocation\n");
215 printf(" -1 -2 force use of particular protocol version\n");
216 printf(" -C enable compression\n");
217 printf(" -i key private key file for authentication\n");
221 char *do_select(SOCKET skt, int startup)
225 events = (FD_CONNECT | FD_READ | FD_WRITE |
226 FD_OOB | FD_CLOSE | FD_ACCEPT);
230 if (WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
231 switch (WSAGetLastError()) {
233 return "Network is down";
235 return "WSAAsyncSelect(): unknown error";
241 int main(int argc, char **argv)
245 WSAEVENT stdinevent, stdoutevent, stderrevent;
247 DWORD in_threadid, out_threadid, err_threadid;
248 struct input_data idata;
257 ssh_get_line = console_get_line;
260 skcount = sksize = 0;
262 * Initialise port and protocol to sensible defaults. (These
263 * will be overridden by more or less anything.)
265 default_protocol = PROT_SSH;
270 * Process the command line.
272 do_defaults(NULL, &cfg);
273 default_protocol = cfg.protocol;
274 default_port = cfg.port;
277 * Override the default protocol if PLINK_PROTOCOL is set.
279 char *p = getenv("PLINK_PROTOCOL");
282 for (i = 0; backends[i].backend != NULL; i++) {
283 if (!strcmp(backends[i].name, p)) {
284 default_protocol = cfg.protocol = backends[i].protocol;
285 default_port = cfg.port =
286 backends[i].backend->default_port;
295 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL), 1);
298 "plink: option \"%s\" requires an argument\n", p);
299 } else if (ret == 2) {
301 } else if (ret == 1) {
303 } else if (!strcmp(p, "-batch")) {
304 console_batch_mode = 1;
310 * If the hostname starts with "telnet:", set the
311 * protocol to Telnet and process the string as a
314 if (!strncmp(q, "telnet:", 7)) {
318 if (q[0] == '/' && q[1] == '/')
320 cfg.protocol = PROT_TELNET;
322 while (*p && *p != ':' && *p != '/')
331 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
332 cfg.host[sizeof(cfg.host) - 1] = '\0';
336 * Before we process the [user@]host string, we
337 * first check for the presence of a protocol
338 * prefix (a protocol name followed by ",").
343 for (i = 0; backends[i].backend != NULL; i++) {
344 j = strlen(backends[i].name);
346 !memcmp(backends[i].name, p, j)) {
347 default_protocol = cfg.protocol =
348 backends[i].protocol;
350 backends[i].backend->default_port;
358 * Three cases. Either (a) there's a nonzero
359 * length string followed by an @, in which
360 * case that's user and the remainder is host.
361 * Or (b) there's only one string, not counting
362 * a potential initial @, and it exists in the
363 * saved-sessions database. Or (c) only one
364 * string and it _doesn't_ exist in the
369 p++, r = NULL; /* discount initial @ */
375 do_defaults(p, &cfg2);
376 if (cfg2.host[0] == '\0') {
377 /* No settings for this host; use defaults */
378 strncpy(cfg.host, p, sizeof(cfg.host) - 1);
379 cfg.host[sizeof(cfg.host) - 1] = '\0';
380 cfg.port = default_port;
383 cfg.remote_cmd_ptr = cfg.remote_cmd;
387 strncpy(cfg.username, p, sizeof(cfg.username) - 1);
388 cfg.username[sizeof(cfg.username) - 1] = '\0';
389 strncpy(cfg.host, r, sizeof(cfg.host) - 1);
390 cfg.host[sizeof(cfg.host) - 1] = '\0';
391 cfg.port = default_port;
397 cmdlen = cmdsize = 0;
402 if (cmdlen >= cmdsize) {
403 cmdsize = cmdlen + 512;
404 command = srealloc(command, cmdsize);
406 command[cmdlen++]=*p++;
408 if (cmdlen >= cmdsize) {
409 cmdsize = cmdlen + 512;
410 command = srealloc(command, cmdsize);
412 command[cmdlen++]=' '; /* always add trailing space */
413 if (--argc) p = *++argv;
415 if (cmdlen) command[--cmdlen]='\0';
416 /* change trailing blank to NUL */
417 cfg.remote_cmd_ptr = command;
418 cfg.remote_cmd_ptr2 = NULL;
419 cfg.nopty = TRUE; /* command => no terminal */
421 break; /* done with cmdline */
431 * Trim leading whitespace off the hostname if it's there.
434 int space = strspn(cfg.host, " \t");
435 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
438 /* See if host is of the form user@host */
439 if (cfg.host[0] != '\0') {
440 char *atsign = strchr(cfg.host, '@');
441 /* Make sure we're not overflowing the user field */
443 if (atsign - cfg.host < sizeof cfg.username) {
444 strncpy(cfg.username, cfg.host, atsign - cfg.host);
445 cfg.username[atsign - cfg.host] = '\0';
447 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
452 * Perform command-line overrides on session configuration.
457 * Trim a colon suffix off the hostname if it's there.
459 cfg.host[strcspn(cfg.host, ":")] = '\0';
461 if (!*cfg.remote_cmd_ptr)
462 flags |= FLAG_INTERACTIVE;
465 * Select protocol. This is farmed out into a table in a
466 * separate file to enable an ssh-free variant.
471 for (i = 0; backends[i].backend != NULL; i++)
472 if (backends[i].protocol == cfg.protocol) {
473 back = backends[i].backend;
478 "Internal fault: Unsupported protocol found\n");
486 if (portnumber != -1)
487 cfg.port = portnumber;
490 * Initialise WinSock.
492 winsock_ver = MAKEWORD(2, 0);
493 if (WSAStartup(winsock_ver, &wsadata)) {
494 MessageBox(NULL, "Unable to initialise WinSock", "WinSock Error",
495 MB_OK | MB_ICONEXCLAMATION);
498 if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 0) {
499 MessageBox(NULL, "WinSock version is incompatible with 2.0",
500 "WinSock Error", MB_OK | MB_ICONEXCLAMATION);
507 * Start up the connection.
509 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
513 /* nodelay is only useful if stdin is a character device (console) */
514 int nodelay = cfg.tcp_nodelay &&
515 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
517 error = back->init(cfg.host, cfg.port, &realhost, nodelay);
519 fprintf(stderr, "Unable to open connection:\n%s", error);
526 stdinevent = CreateEvent(NULL, FALSE, FALSE, NULL);
527 stdoutevent = CreateEvent(NULL, FALSE, FALSE, NULL);
528 stderrevent = CreateEvent(NULL, FALSE, FALSE, NULL);
530 inhandle = GetStdHandle(STD_INPUT_HANDLE);
531 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
532 errhandle = GetStdHandle(STD_ERROR_HANDLE);
533 GetConsoleMode(inhandle, &orig_console_mode);
534 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
537 * Turn off ECHO and LINE input modes. We don't care if this
538 * call fails, because we know we aren't necessarily running in
541 handles[0] = netevent;
542 handles[1] = stdinevent;
543 handles[2] = stdoutevent;
544 handles[3] = stderrevent;
548 * Create spare threads to write to stdout and stderr, so we
549 * can arrange asynchronous writes.
551 odata.event = stdoutevent;
552 odata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
554 odata.busy = odata.done = 0;
555 if (!CreateThread(NULL, 0, stdout_write_thread,
556 &odata, 0, &out_threadid)) {
557 fprintf(stderr, "Unable to create output thread\n");
560 edata.event = stderrevent;
561 edata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
563 edata.busy = edata.done = 0;
564 if (!CreateThread(NULL, 0, stdout_write_thread,
565 &edata, 0, &err_threadid)) {
566 fprintf(stderr, "Unable to create error output thread\n");
573 if (!sending && back->sendok()) {
575 * Create a separate thread to read from stdin. This is
576 * a total pain, but I can't find another way to do it:
578 * - an overlapped ReadFile or ReadFileEx just doesn't
579 * happen; we get failure from ReadFileEx, and
580 * ReadFile blocks despite being given an OVERLAPPED
581 * structure. Perhaps we can't do overlapped reads
582 * on consoles. WHY THE HELL NOT?
584 * - WaitForMultipleObjects(netevent, console) doesn't
585 * work, because it signals the console when
586 * _anything_ happens, including mouse motions and
587 * other things that don't cause data to be readable
588 * - so we're back to ReadFile blocking.
590 idata.event = stdinevent;
591 idata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
592 if (!CreateThread(NULL, 0, stdin_read_thread,
593 &idata, 0, &in_threadid)) {
594 fprintf(stderr, "Unable to create input thread\n");
600 n = WaitForMultipleObjects(4, handles, FALSE, INFINITE);
602 WSANETWORKEVENTS things;
604 extern SOCKET first_socket(int *), next_socket(int *);
605 extern int select_result(WPARAM, LPARAM);
609 * We must not call select_result() for any socket
610 * until we have finished enumerating within the tree.
611 * This is because select_result() may close the socket
612 * and modify the tree.
614 /* Count the active sockets. */
616 for (socket = first_socket(&socketstate);
617 socket != INVALID_SOCKET;
618 socket = next_socket(&socketstate)) i++;
620 /* Expand the buffer if necessary. */
623 sklist = srealloc(sklist, sksize * sizeof(*sklist));
626 /* Retrieve the sockets into sklist. */
628 for (socket = first_socket(&socketstate);
629 socket != INVALID_SOCKET;
630 socket = next_socket(&socketstate)) {
631 sklist[skcount++] = socket;
634 /* Now we're done enumerating; go through the list. */
635 for (i = 0; i < skcount; i++) {
638 wp = (WPARAM) socket;
639 if (!WSAEnumNetworkEvents(socket, NULL, &things)) {
640 static const struct { int bit, mask; } eventtypes[] = {
641 {FD_CONNECT_BIT, FD_CONNECT},
642 {FD_READ_BIT, FD_READ},
643 {FD_CLOSE_BIT, FD_CLOSE},
644 {FD_OOB_BIT, FD_OOB},
645 {FD_WRITE_BIT, FD_WRITE},
646 {FD_ACCEPT_BIT, FD_ACCEPT},
650 noise_ultralight(socket);
651 noise_ultralight(things.lNetworkEvents);
653 for (e = 0; e < lenof(eventtypes); e++)
654 if (things.lNetworkEvents & eventtypes[e].mask) {
656 int err = things.iErrorCode[eventtypes[e].bit];
657 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
658 connopen &= select_result(wp, lp);
664 noise_ultralight(idata.len);
665 if (connopen && back->socket() != NULL) {
667 back->send(idata.buffer, idata.len);
669 back->special(TS_EOF);
674 if (!odata.writeret) {
675 fprintf(stderr, "Unable to write to standard output\n");
678 bufchain_consume(&stdout_data, odata.lenwritten);
679 if (bufchain_size(&stdout_data) > 0)
681 if (connopen && back->socket() != NULL) {
682 back->unthrottle(bufchain_size(&stdout_data) +
683 bufchain_size(&stderr_data));
687 if (!edata.writeret) {
688 fprintf(stderr, "Unable to write to standard output\n");
691 bufchain_consume(&stderr_data, edata.lenwritten);
692 if (bufchain_size(&stderr_data) > 0)
694 if (connopen && back->socket() != NULL) {
695 back->unthrottle(bufchain_size(&stdout_data) +
696 bufchain_size(&stderr_data));
699 if (!reading && back->sendbuffer() < MAX_STDIN_BACKLOG) {
700 SetEvent(idata.eventback);
703 if ((!connopen || back->socket() == NULL) &&
704 bufchain_size(&stdout_data) == 0 &&
705 bufchain_size(&stderr_data) == 0)
706 break; /* we closed the connection */
709 exitcode = back->exitcode();
711 fprintf(stderr, "Remote process exit code unavailable\n");
712 exitcode = 1; /* this is an error condition */