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(void *frontend, 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;
73 static void *backhandle;
75 int term_ldisc(Terminal *term, int mode)
79 void ldisc_update(void *frontend, int echo, int edit)
81 /* Update stdin read mode to reflect changes in line discipline. */
84 mode = ENABLE_PROCESSED_INPUT;
86 mode = mode | ENABLE_ECHO_INPUT;
88 mode = mode & ~ENABLE_ECHO_INPUT;
90 mode = mode | ENABLE_LINE_INPUT;
92 mode = mode & ~ENABLE_LINE_INPUT;
93 SetConsoleMode(inhandle, mode);
99 HANDLE event, eventback;
102 static DWORD WINAPI stdin_read_thread(void *param)
104 struct input_data *idata = (struct input_data *) param;
107 inhandle = GetStdHandle(STD_INPUT_HANDLE);
109 while (ReadFile(inhandle, idata->buffer, sizeof(idata->buffer),
110 &idata->len, NULL) && idata->len > 0) {
111 SetEvent(idata->event);
112 WaitForSingleObject(idata->eventback, INFINITE);
116 SetEvent(idata->event);
122 DWORD len, lenwritten;
126 HANDLE event, eventback;
130 static DWORD WINAPI stdout_write_thread(void *param)
132 struct output_data *odata = (struct output_data *) param;
133 HANDLE outhandle, errhandle;
135 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
136 errhandle = GetStdHandle(STD_ERROR_HANDLE);
139 WaitForSingleObject(odata->eventback, INFINITE);
143 WriteFile(odata->is_stderr ? errhandle : outhandle,
144 odata->buffer, odata->len, &odata->lenwritten, NULL);
145 SetEvent(odata->event);
151 bufchain stdout_data, stderr_data;
152 struct output_data odata, edata;
154 void try_output(int is_stderr)
156 struct output_data *data = (is_stderr ? &edata : &odata);
161 bufchain_prefix(is_stderr ? &stderr_data : &stdout_data,
162 &senddata, &sendlen);
163 data->buffer = senddata;
165 SetEvent(data->eventback);
170 int from_backend(void *frontend_handle, int is_stderr, char *data, int len)
172 HANDLE h = (is_stderr ? errhandle : outhandle);
178 bufchain_add(&stderr_data, data, len);
181 bufchain_add(&stdout_data, data, len);
185 osize = bufchain_size(&stdout_data);
186 esize = bufchain_size(&stderr_data);
188 return osize + esize;
192 * Short description of parameters.
194 static void usage(void)
196 printf("PuTTY Link: command-line connection utility\n");
198 printf("Usage: plink [options] [user@]host [command]\n");
199 printf(" (\"host\" can also be a PuTTY saved session name)\n");
200 printf("Options:\n");
201 printf(" -v show verbose messages\n");
202 printf(" -load sessname Load settings from saved session\n");
203 printf(" -ssh -telnet -rlogin -raw\n");
204 printf(" force use of a particular protocol (default SSH)\n");
205 printf(" -P port connect to specified port\n");
206 printf(" -l user connect with specified username\n");
207 printf(" -m file read remote command(s) from file\n");
208 printf(" -batch disable all interactive prompts\n");
209 printf("The following options only apply to SSH connections:\n");
210 printf(" -pw passw login with specified password\n");
211 printf(" -L listen-port:host:port Forward local port to "
213 printf(" -R listen-port:host:port Forward remote port to"
215 printf(" -X -x enable / disable X11 forwarding\n");
216 printf(" -A -a enable / disable agent forwarding\n");
217 printf(" -t -T enable / disable pty allocation\n");
218 printf(" -1 -2 force use of particular protocol version\n");
219 printf(" -C enable compression\n");
220 printf(" -i key private key file for authentication\n");
224 char *do_select(SOCKET skt, int startup)
228 events = (FD_CONNECT | FD_READ | FD_WRITE |
229 FD_OOB | FD_CLOSE | FD_ACCEPT);
233 if (WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
234 switch (WSAGetLastError()) {
236 return "Network is down";
238 return "WSAAsyncSelect(): unknown error";
244 int main(int argc, char **argv)
248 WSAEVENT stdinevent, stdoutevent, stderrevent;
250 DWORD in_threadid, out_threadid, err_threadid;
251 struct input_data idata;
261 ssh_get_line = console_get_line;
264 skcount = sksize = 0;
266 * Initialise port and protocol to sensible defaults. (These
267 * will be overridden by more or less anything.)
269 default_protocol = PROT_SSH;
274 * Process the command line.
276 do_defaults(NULL, &cfg);
277 default_protocol = cfg.protocol;
278 default_port = cfg.port;
282 * Override the default protocol if PLINK_PROTOCOL is set.
284 char *p = getenv("PLINK_PROTOCOL");
287 for (i = 0; backends[i].backend != NULL; i++) {
288 if (!strcmp(backends[i].name, p)) {
289 default_protocol = cfg.protocol = backends[i].protocol;
290 default_port = cfg.port =
291 backends[i].backend->default_port;
300 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL), 1);
303 "plink: option \"%s\" requires an argument\n", p);
305 } else if (ret == 2) {
307 } else if (ret == 1) {
309 } else if (!strcmp(p, "-batch")) {
310 console_batch_mode = 1;
312 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
319 * If the hostname starts with "telnet:", set the
320 * protocol to Telnet and process the string as a
323 if (!strncmp(q, "telnet:", 7)) {
327 if (q[0] == '/' && q[1] == '/')
329 cfg.protocol = PROT_TELNET;
331 while (*p && *p != ':' && *p != '/')
340 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
341 cfg.host[sizeof(cfg.host) - 1] = '\0';
345 * Before we process the [user@]host string, we
346 * first check for the presence of a protocol
347 * prefix (a protocol name followed by ",").
352 for (i = 0; backends[i].backend != NULL; i++) {
353 j = strlen(backends[i].name);
355 !memcmp(backends[i].name, p, j)) {
356 default_protocol = cfg.protocol =
357 backends[i].protocol;
359 backends[i].backend->default_port;
367 * Three cases. Either (a) there's a nonzero
368 * length string followed by an @, in which
369 * case that's user and the remainder is host.
370 * Or (b) there's only one string, not counting
371 * a potential initial @, and it exists in the
372 * saved-sessions database. Or (c) only one
373 * string and it _doesn't_ exist in the
378 p++, r = NULL; /* discount initial @ */
384 do_defaults(p, &cfg2);
385 if (cfg2.host[0] == '\0') {
386 /* No settings for this host; use defaults */
387 strncpy(cfg.host, p, sizeof(cfg.host) - 1);
388 cfg.host[sizeof(cfg.host) - 1] = '\0';
389 cfg.port = default_port;
392 cfg.remote_cmd_ptr = cfg.remote_cmd;
396 strncpy(cfg.username, p, sizeof(cfg.username) - 1);
397 cfg.username[sizeof(cfg.username) - 1] = '\0';
398 strncpy(cfg.host, r, sizeof(cfg.host) - 1);
399 cfg.host[sizeof(cfg.host) - 1] = '\0';
400 cfg.port = default_port;
406 cmdlen = cmdsize = 0;
411 if (cmdlen >= cmdsize) {
412 cmdsize = cmdlen + 512;
413 command = srealloc(command, cmdsize);
415 command[cmdlen++]=*p++;
417 if (cmdlen >= cmdsize) {
418 cmdsize = cmdlen + 512;
419 command = srealloc(command, cmdsize);
421 command[cmdlen++]=' '; /* always add trailing space */
422 if (--argc) p = *++argv;
424 if (cmdlen) command[--cmdlen]='\0';
425 /* change trailing blank to NUL */
426 cfg.remote_cmd_ptr = command;
427 cfg.remote_cmd_ptr2 = NULL;
428 cfg.nopty = TRUE; /* command => no terminal */
430 break; /* done with cmdline */
443 * Trim leading whitespace off the hostname if it's there.
446 int space = strspn(cfg.host, " \t");
447 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
450 /* See if host is of the form user@host */
451 if (cfg.host[0] != '\0') {
452 char *atsign = strchr(cfg.host, '@');
453 /* Make sure we're not overflowing the user field */
455 if (atsign - cfg.host < sizeof cfg.username) {
456 strncpy(cfg.username, cfg.host, atsign - cfg.host);
457 cfg.username[atsign - cfg.host] = '\0';
459 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
464 * Perform command-line overrides on session configuration.
469 * Trim a colon suffix off the hostname if it's there.
471 cfg.host[strcspn(cfg.host, ":")] = '\0';
474 * Remove any remaining whitespace from the hostname.
478 while (cfg.host[p2] != '\0') {
479 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
480 cfg.host[p1] = cfg.host[p2];
488 if (!*cfg.remote_cmd_ptr)
489 flags |= FLAG_INTERACTIVE;
492 * Select protocol. This is farmed out into a table in a
493 * separate file to enable an ssh-free variant.
498 for (i = 0; backends[i].backend != NULL; i++)
499 if (backends[i].protocol == cfg.protocol) {
500 back = backends[i].backend;
505 "Internal fault: Unsupported protocol found\n");
513 if (portnumber != -1)
514 cfg.port = portnumber;
517 * Initialise WinSock.
519 winsock_ver = MAKEWORD(2, 0);
520 if (WSAStartup(winsock_ver, &wsadata)) {
521 MessageBox(NULL, "Unable to initialise WinSock", "WinSock Error",
522 MB_OK | MB_ICONEXCLAMATION);
525 if (LOBYTE(wsadata.wVersion) != 2 || HIBYTE(wsadata.wVersion) != 0) {
526 MessageBox(NULL, "WinSock version is incompatible with 2.0",
527 "WinSock Error", MB_OK | MB_ICONEXCLAMATION);
534 * Start up the connection.
536 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
540 /* nodelay is only useful if stdin is a character device (console) */
541 int nodelay = cfg.tcp_nodelay &&
542 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
544 error = back->init(NULL, &backhandle, cfg.host, cfg.port,
547 fprintf(stderr, "Unable to open connection:\n%s", error);
550 logctx = log_init(NULL);
551 back->provide_logctx(backhandle, logctx);
556 stdinevent = CreateEvent(NULL, FALSE, FALSE, NULL);
557 stdoutevent = CreateEvent(NULL, FALSE, FALSE, NULL);
558 stderrevent = CreateEvent(NULL, FALSE, FALSE, NULL);
560 inhandle = GetStdHandle(STD_INPUT_HANDLE);
561 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
562 errhandle = GetStdHandle(STD_ERROR_HANDLE);
563 GetConsoleMode(inhandle, &orig_console_mode);
564 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
567 * Turn off ECHO and LINE input modes. We don't care if this
568 * call fails, because we know we aren't necessarily running in
571 handles[0] = netevent;
572 handles[1] = stdinevent;
573 handles[2] = stdoutevent;
574 handles[3] = stderrevent;
578 * Create spare threads to write to stdout and stderr, so we
579 * can arrange asynchronous writes.
581 odata.event = stdoutevent;
582 odata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
584 odata.busy = odata.done = 0;
585 if (!CreateThread(NULL, 0, stdout_write_thread,
586 &odata, 0, &out_threadid)) {
587 fprintf(stderr, "Unable to create output thread\n");
590 edata.event = stderrevent;
591 edata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
593 edata.busy = edata.done = 0;
594 if (!CreateThread(NULL, 0, stdout_write_thread,
595 &edata, 0, &err_threadid)) {
596 fprintf(stderr, "Unable to create error output thread\n");
603 if (!sending && back->sendok(backhandle)) {
605 * Create a separate thread to read from stdin. This is
606 * a total pain, but I can't find another way to do it:
608 * - an overlapped ReadFile or ReadFileEx just doesn't
609 * happen; we get failure from ReadFileEx, and
610 * ReadFile blocks despite being given an OVERLAPPED
611 * structure. Perhaps we can't do overlapped reads
612 * on consoles. WHY THE HELL NOT?
614 * - WaitForMultipleObjects(netevent, console) doesn't
615 * work, because it signals the console when
616 * _anything_ happens, including mouse motions and
617 * other things that don't cause data to be readable
618 * - so we're back to ReadFile blocking.
620 idata.event = stdinevent;
621 idata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
622 if (!CreateThread(NULL, 0, stdin_read_thread,
623 &idata, 0, &in_threadid)) {
624 fprintf(stderr, "Unable to create input thread\n");
630 n = WaitForMultipleObjects(4, handles, FALSE, INFINITE);
632 WSANETWORKEVENTS things;
634 extern SOCKET first_socket(int *), next_socket(int *);
635 extern int select_result(WPARAM, LPARAM);
639 * We must not call select_result() for any socket
640 * until we have finished enumerating within the tree.
641 * This is because select_result() may close the socket
642 * and modify the tree.
644 /* Count the active sockets. */
646 for (socket = first_socket(&socketstate);
647 socket != INVALID_SOCKET;
648 socket = next_socket(&socketstate)) i++;
650 /* Expand the buffer if necessary. */
653 sklist = srealloc(sklist, sksize * sizeof(*sklist));
656 /* Retrieve the sockets into sklist. */
658 for (socket = first_socket(&socketstate);
659 socket != INVALID_SOCKET;
660 socket = next_socket(&socketstate)) {
661 sklist[skcount++] = socket;
664 /* Now we're done enumerating; go through the list. */
665 for (i = 0; i < skcount; i++) {
668 wp = (WPARAM) socket;
669 if (!WSAEnumNetworkEvents(socket, NULL, &things)) {
670 static const struct { int bit, mask; } eventtypes[] = {
671 {FD_CONNECT_BIT, FD_CONNECT},
672 {FD_READ_BIT, FD_READ},
673 {FD_CLOSE_BIT, FD_CLOSE},
674 {FD_OOB_BIT, FD_OOB},
675 {FD_WRITE_BIT, FD_WRITE},
676 {FD_ACCEPT_BIT, FD_ACCEPT},
680 noise_ultralight(socket);
681 noise_ultralight(things.lNetworkEvents);
683 for (e = 0; e < lenof(eventtypes); e++)
684 if (things.lNetworkEvents & eventtypes[e].mask) {
686 int err = things.iErrorCode[eventtypes[e].bit];
687 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
688 connopen &= select_result(wp, lp);
694 noise_ultralight(idata.len);
695 if (connopen && back->socket(backhandle) != NULL) {
697 back->send(backhandle, idata.buffer, idata.len);
699 back->special(backhandle, TS_EOF);
704 if (!odata.writeret) {
705 fprintf(stderr, "Unable to write to standard output\n");
708 bufchain_consume(&stdout_data, odata.lenwritten);
709 if (bufchain_size(&stdout_data) > 0)
711 if (connopen && back->socket(backhandle) != NULL) {
712 back->unthrottle(backhandle, bufchain_size(&stdout_data) +
713 bufchain_size(&stderr_data));
717 if (!edata.writeret) {
718 fprintf(stderr, "Unable to write to standard output\n");
721 bufchain_consume(&stderr_data, edata.lenwritten);
722 if (bufchain_size(&stderr_data) > 0)
724 if (connopen && back->socket(backhandle) != NULL) {
725 back->unthrottle(backhandle, bufchain_size(&stdout_data) +
726 bufchain_size(&stderr_data));
729 if (!reading && back->sendbuffer(backhandle) < MAX_STDIN_BACKLOG) {
730 SetEvent(idata.eventback);
733 if ((!connopen || back->socket(backhandle) == NULL) &&
734 bufchain_size(&stdout_data) == 0 &&
735 bufchain_size(&stderr_data) == 0)
736 break; /* we closed the connection */
739 exitcode = back->exitcode(backhandle);
741 fprintf(stderr, "Remote process exit code unavailable\n");
742 exitcode = 1; /* this is an error condition */