2 * PLink - a Windows command-line (stdin/stdout) variant of PuTTY.
10 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
15 #define WM_AGENT_CALLBACK (WM_XUSER + 4)
17 #define MAX_STDIN_BACKLOG 4096
19 struct agent_callback {
20 void (*callback)(void *, void *, int);
26 void fatalbox(char *p, ...)
29 fprintf(stderr, "FATAL ERROR: ");
31 vfprintf(stderr, p, ap);
36 void modalfatalbox(char *p, ...)
39 fprintf(stderr, "FATAL ERROR: ");
41 vfprintf(stderr, p, ap);
46 void connection_fatal(void *frontend, char *p, ...)
49 fprintf(stderr, "FATAL ERROR: ");
51 vfprintf(stderr, p, ap);
56 void cmdline_error(char *p, ...)
59 fprintf(stderr, "plink: ");
61 vfprintf(stderr, p, ap);
67 HANDLE inhandle, outhandle, errhandle;
68 DWORD orig_console_mode;
73 static void *backhandle;
76 int term_ldisc(Terminal *term, int mode)
80 void ldisc_update(void *frontend, int echo, int edit)
82 /* Update stdin read mode to reflect changes in line discipline. */
85 mode = ENABLE_PROCESSED_INPUT;
87 mode = mode | ENABLE_ECHO_INPUT;
89 mode = mode & ~ENABLE_ECHO_INPUT;
91 mode = mode | ENABLE_LINE_INPUT;
93 mode = mode & ~ENABLE_LINE_INPUT;
94 SetConsoleMode(inhandle, mode);
100 HANDLE event, eventback;
103 static DWORD WINAPI stdin_read_thread(void *param)
105 struct input_data *idata = (struct input_data *) param;
108 inhandle = GetStdHandle(STD_INPUT_HANDLE);
110 while (ReadFile(inhandle, idata->buffer, sizeof(idata->buffer),
111 &idata->len, NULL) && idata->len > 0) {
112 SetEvent(idata->event);
113 WaitForSingleObject(idata->eventback, INFINITE);
117 SetEvent(idata->event);
123 DWORD len, lenwritten;
127 HANDLE event, eventback;
131 static DWORD WINAPI stdout_write_thread(void *param)
133 struct output_data *odata = (struct output_data *) param;
134 HANDLE outhandle, errhandle;
136 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
137 errhandle = GetStdHandle(STD_ERROR_HANDLE);
140 WaitForSingleObject(odata->eventback, INFINITE);
144 WriteFile(odata->is_stderr ? errhandle : outhandle,
145 odata->buffer, odata->len, &odata->lenwritten, NULL);
146 SetEvent(odata->event);
152 bufchain stdout_data, stderr_data;
153 struct output_data odata, edata;
155 void try_output(int is_stderr)
157 struct output_data *data = (is_stderr ? &edata : &odata);
162 bufchain_prefix(is_stderr ? &stderr_data : &stdout_data,
163 &senddata, &sendlen);
164 data->buffer = senddata;
166 SetEvent(data->eventback);
171 int from_backend(void *frontend_handle, int is_stderr,
172 const char *data, int len)
177 bufchain_add(&stderr_data, data, len);
180 bufchain_add(&stdout_data, data, len);
184 osize = bufchain_size(&stdout_data);
185 esize = bufchain_size(&stderr_data);
187 return osize + esize;
190 static DWORD main_thread_id;
192 void agent_schedule_callback(void (*callback)(void *, void *, int),
193 void *callback_ctx, void *data, int len)
195 struct agent_callback *c = snew(struct agent_callback);
196 c->callback = callback;
197 c->callback_ctx = callback_ctx;
200 PostThreadMessage(main_thread_id, WM_AGENT_CALLBACK, 0, (LPARAM)c);
204 * Short description of parameters.
206 static void usage(void)
208 printf("PuTTY Link: command-line connection utility\n");
210 printf("Usage: plink [options] [user@]host [command]\n");
211 printf(" (\"host\" can also be a PuTTY saved session name)\n");
212 printf("Options:\n");
213 printf(" -V print version information\n");
214 printf(" -v show verbose messages\n");
215 printf(" -load sessname Load settings from saved session\n");
216 printf(" -ssh -telnet -rlogin -raw\n");
217 printf(" force use of a particular protocol\n");
218 printf(" -P port connect to specified port\n");
219 printf(" -l user connect with specified username\n");
220 printf(" -m file read remote command(s) from file\n");
221 printf(" -batch disable all interactive prompts\n");
222 printf("The following options only apply to SSH connections:\n");
223 printf(" -pw passw login with specified password\n");
224 printf(" -D [listen-IP:]listen-port\n");
225 printf(" Dynamic SOCKS-based port forwarding\n");
226 printf(" -L [listen-IP:]listen-port:host:port\n");
227 printf(" Forward local port to remote address\n");
228 printf(" -R [listen-IP:]listen-port:host:port\n");
229 printf(" Forward remote port to local address\n");
230 printf(" -X -x enable / disable X11 forwarding\n");
231 printf(" -A -a enable / disable agent forwarding\n");
232 printf(" -t -T enable / disable pty allocation\n");
233 printf(" -1 -2 force use of particular protocol version\n");
234 printf(" -C enable compression\n");
235 printf(" -i key private key file for authentication\n");
236 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
237 printf(" -N don't start a shell/command (SSH-2 only)\n");
241 static void version(void)
243 printf("plink: %s\n", ver);
247 char *do_select(SOCKET skt, int startup)
251 events = (FD_CONNECT | FD_READ | FD_WRITE |
252 FD_OOB | FD_CLOSE | FD_ACCEPT);
256 if (p_WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
257 switch (p_WSAGetLastError()) {
259 return "Network is down";
261 return "WSAEventSelect(): unknown error";
267 int main(int argc, char **argv)
269 WSAEVENT stdinevent, stdoutevent, stderrevent;
271 DWORD in_threadid, out_threadid, err_threadid;
272 struct input_data idata;
281 int use_subsystem = 0;
284 ssh_get_line = console_get_line;
287 skcount = sksize = 0;
289 * Initialise port and protocol to sensible defaults. (These
290 * will be overridden by more or less anything.)
292 default_protocol = PROT_SSH;
297 * Process the command line.
299 do_defaults(NULL, &cfg);
300 loaded_session = FALSE;
301 default_protocol = cfg.protocol;
302 default_port = cfg.port;
306 * Override the default protocol if PLINK_PROTOCOL is set.
308 char *p = getenv("PLINK_PROTOCOL");
311 for (i = 0; backends[i].backend != NULL; i++) {
312 if (!strcmp(backends[i].name, p)) {
313 default_protocol = cfg.protocol = backends[i].protocol;
314 default_port = cfg.port =
315 backends[i].backend->default_port;
324 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
328 "plink: option \"%s\" requires an argument\n", p);
330 } else if (ret == 2) {
332 } else if (ret == 1) {
334 } else if (!strcmp(p, "-batch")) {
335 console_batch_mode = 1;
336 } else if (!strcmp(p, "-s")) {
337 /* Save status to write to cfg later. */
339 } else if (!strcmp(p, "-V")) {
342 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
349 * If the hostname starts with "telnet:", set the
350 * protocol to Telnet and process the string as a
353 if (!strncmp(q, "telnet:", 7)) {
357 if (q[0] == '/' && q[1] == '/')
359 cfg.protocol = PROT_TELNET;
361 while (*p && *p != ':' && *p != '/')
370 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
371 cfg.host[sizeof(cfg.host) - 1] = '\0';
373 char *r, *user, *host;
375 * Before we process the [user@]host string, we
376 * first check for the presence of a protocol
377 * prefix (a protocol name followed by ",").
382 for (i = 0; backends[i].backend != NULL; i++) {
383 j = strlen(backends[i].name);
385 !memcmp(backends[i].name, p, j)) {
386 default_protocol = cfg.protocol =
387 backends[i].protocol;
389 backends[i].backend->default_port;
397 * A nonzero length string followed by an @ is treated
398 * as a username. (We discount an _initial_ @.) The
399 * rest of the string (or the whole string if no @)
400 * is treated as a session name and/or hostname.
404 p++, r = NULL; /* discount initial @ */
409 user = NULL, host = p;
413 * Now attempt to load a saved session with the
414 * same name as the hostname.
418 do_defaults(host, &cfg2);
419 if (loaded_session || cfg2.host[0] == '\0') {
420 /* No settings for this host; use defaults */
421 /* (or session was already loaded with -load) */
422 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
423 cfg.host[sizeof(cfg.host) - 1] = '\0';
424 cfg.port = default_port;
427 /* Ick: patch up internal pointer after copy */
428 cfg.remote_cmd_ptr = cfg.remote_cmd;
433 /* Patch in specified username. */
434 strncpy(cfg.username, user,
435 sizeof(cfg.username) - 1);
436 cfg.username[sizeof(cfg.username) - 1] = '\0';
443 cmdlen = cmdsize = 0;
448 if (cmdlen >= cmdsize) {
449 cmdsize = cmdlen + 512;
450 command = sresize(command, cmdsize, char);
452 command[cmdlen++]=*p++;
454 if (cmdlen >= cmdsize) {
455 cmdsize = cmdlen + 512;
456 command = sresize(command, cmdsize, char);
458 command[cmdlen++]=' '; /* always add trailing space */
459 if (--argc) p = *++argv;
461 if (cmdlen) command[--cmdlen]='\0';
462 /* change trailing blank to NUL */
463 cfg.remote_cmd_ptr = command;
464 cfg.remote_cmd_ptr2 = NULL;
465 cfg.nopty = TRUE; /* command => no terminal */
467 break; /* done with cmdline */
480 * Trim leading whitespace off the hostname if it's there.
483 int space = strspn(cfg.host, " \t");
484 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
487 /* See if host is of the form user@host */
488 if (cfg.host[0] != '\0') {
489 char *atsign = strrchr(cfg.host, '@');
490 /* Make sure we're not overflowing the user field */
492 if (atsign - cfg.host < sizeof cfg.username) {
493 strncpy(cfg.username, cfg.host, atsign - cfg.host);
494 cfg.username[atsign - cfg.host] = '\0';
496 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
501 * Perform command-line overrides on session configuration.
503 cmdline_run_saved(&cfg);
506 * Apply subsystem status.
509 cfg.ssh_subsys = TRUE;
512 * Trim a colon suffix off the hostname if it's there.
514 cfg.host[strcspn(cfg.host, ":")] = '\0';
517 * Remove any remaining whitespace from the hostname.
521 while (cfg.host[p2] != '\0') {
522 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
523 cfg.host[p1] = cfg.host[p2];
531 if (!*cfg.remote_cmd_ptr)
532 flags |= FLAG_INTERACTIVE;
535 * Select protocol. This is farmed out into a table in a
536 * separate file to enable an ssh-free variant.
541 for (i = 0; backends[i].backend != NULL; i++)
542 if (backends[i].protocol == cfg.protocol) {
543 back = backends[i].backend;
548 "Internal fault: Unsupported protocol found\n");
556 if (portnumber != -1)
557 cfg.port = portnumber;
560 if (p_WSAEventSelect == NULL) {
561 fprintf(stderr, "Plink requires WinSock 2\n");
566 * Start up the connection.
568 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
572 /* nodelay is only useful if stdin is a character device (console) */
573 int nodelay = cfg.tcp_nodelay &&
574 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
576 error = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port,
577 &realhost, nodelay, cfg.tcp_keepalives);
579 fprintf(stderr, "Unable to open connection:\n%s", error);
582 logctx = log_init(NULL, &cfg);
583 back->provide_logctx(backhandle, logctx);
584 console_provide_logctx(logctx);
589 stdinevent = CreateEvent(NULL, FALSE, FALSE, NULL);
590 stdoutevent = CreateEvent(NULL, FALSE, FALSE, NULL);
591 stderrevent = CreateEvent(NULL, FALSE, FALSE, NULL);
593 inhandle = GetStdHandle(STD_INPUT_HANDLE);
594 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
595 errhandle = GetStdHandle(STD_ERROR_HANDLE);
596 GetConsoleMode(inhandle, &orig_console_mode);
597 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
599 main_thread_id = GetCurrentThreadId();
602 * Turn off ECHO and LINE input modes. We don't care if this
603 * call fails, because we know we aren't necessarily running in
606 handles[0] = netevent;
607 handles[1] = stdinevent;
608 handles[2] = stdoutevent;
609 handles[3] = stderrevent;
613 * Create spare threads to write to stdout and stderr, so we
614 * can arrange asynchronous writes.
616 odata.event = stdoutevent;
617 odata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
619 odata.busy = odata.done = 0;
620 if (!CreateThread(NULL, 0, stdout_write_thread,
621 &odata, 0, &out_threadid)) {
622 fprintf(stderr, "Unable to create output thread\n");
625 edata.event = stderrevent;
626 edata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
628 edata.busy = edata.done = 0;
629 if (!CreateThread(NULL, 0, stdout_write_thread,
630 &edata, 0, &err_threadid)) {
631 fprintf(stderr, "Unable to create error output thread\n");
635 now = GETTICKCOUNT();
641 if (!sending && back->sendok(backhandle)) {
643 * Create a separate thread to read from stdin. This is
644 * a total pain, but I can't find another way to do it:
646 * - an overlapped ReadFile or ReadFileEx just doesn't
647 * happen; we get failure from ReadFileEx, and
648 * ReadFile blocks despite being given an OVERLAPPED
649 * structure. Perhaps we can't do overlapped reads
650 * on consoles. WHY THE HELL NOT?
652 * - WaitForMultipleObjects(netevent, console) doesn't
653 * work, because it signals the console when
654 * _anything_ happens, including mouse motions and
655 * other things that don't cause data to be readable
656 * - so we're back to ReadFile blocking.
658 idata.event = stdinevent;
659 idata.eventback = CreateEvent(NULL, FALSE, FALSE, NULL);
660 if (!CreateThread(NULL, 0, stdin_read_thread,
661 &idata, 0, &in_threadid)) {
662 fprintf(stderr, "Unable to create input thread\n");
668 if (run_timers(now, &next)) {
669 ticks = next - GETTICKCOUNT();
670 if (ticks < 0) ticks = 0; /* just in case */
675 n = MsgWaitForMultipleObjects(4, handles, FALSE, ticks,
677 if (n == WAIT_OBJECT_0 + 0) {
678 WSANETWORKEVENTS things;
680 extern SOCKET first_socket(int *), next_socket(int *);
681 extern int select_result(WPARAM, LPARAM);
685 * We must not call select_result() for any socket
686 * until we have finished enumerating within the tree.
687 * This is because select_result() may close the socket
688 * and modify the tree.
690 /* Count the active sockets. */
692 for (socket = first_socket(&socketstate);
693 socket != INVALID_SOCKET;
694 socket = next_socket(&socketstate)) i++;
696 /* Expand the buffer if necessary. */
699 sklist = sresize(sklist, sksize, SOCKET);
702 /* Retrieve the sockets into sklist. */
704 for (socket = first_socket(&socketstate);
705 socket != INVALID_SOCKET;
706 socket = next_socket(&socketstate)) {
707 sklist[skcount++] = socket;
710 /* Now we're done enumerating; go through the list. */
711 for (i = 0; i < skcount; i++) {
714 wp = (WPARAM) socket;
715 if (!p_WSAEnumNetworkEvents(socket, NULL, &things)) {
716 static const struct { int bit, mask; } eventtypes[] = {
717 {FD_CONNECT_BIT, FD_CONNECT},
718 {FD_READ_BIT, FD_READ},
719 {FD_CLOSE_BIT, FD_CLOSE},
720 {FD_OOB_BIT, FD_OOB},
721 {FD_WRITE_BIT, FD_WRITE},
722 {FD_ACCEPT_BIT, FD_ACCEPT},
726 noise_ultralight(socket);
727 noise_ultralight(things.lNetworkEvents);
729 for (e = 0; e < lenof(eventtypes); e++)
730 if (things.lNetworkEvents & eventtypes[e].mask) {
732 int err = things.iErrorCode[eventtypes[e].bit];
733 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
734 connopen &= select_result(wp, lp);
738 } else if (n == WAIT_OBJECT_0 + 1) {
740 noise_ultralight(idata.len);
741 if (connopen && back->socket(backhandle) != NULL) {
743 back->send(backhandle, idata.buffer, idata.len);
745 back->special(backhandle, TS_EOF);
748 } else if (n == WAIT_OBJECT_0 + 2) {
750 if (!odata.writeret) {
751 fprintf(stderr, "Unable to write to standard output\n");
754 bufchain_consume(&stdout_data, odata.lenwritten);
755 if (bufchain_size(&stdout_data) > 0)
757 if (connopen && back->socket(backhandle) != NULL) {
758 back->unthrottle(backhandle, bufchain_size(&stdout_data) +
759 bufchain_size(&stderr_data));
761 } else if (n == WAIT_OBJECT_0 + 3) {
763 if (!edata.writeret) {
764 fprintf(stderr, "Unable to write to standard output\n");
767 bufchain_consume(&stderr_data, edata.lenwritten);
768 if (bufchain_size(&stderr_data) > 0)
770 if (connopen && back->socket(backhandle) != NULL) {
771 back->unthrottle(backhandle, bufchain_size(&stdout_data) +
772 bufchain_size(&stderr_data));
774 } else if (n == WAIT_OBJECT_0 + 4) {
776 while (PeekMessage(&msg, INVALID_HANDLE_VALUE,
777 WM_AGENT_CALLBACK, WM_AGENT_CALLBACK,
779 struct agent_callback *c = (struct agent_callback *)msg.lParam;
780 c->callback(c->callback_ctx, c->data, c->len);
785 if (n == WAIT_TIMEOUT) {
788 now = GETTICKCOUNT();
791 if (!reading && back->sendbuffer(backhandle) < MAX_STDIN_BACKLOG) {
792 SetEvent(idata.eventback);
795 if ((!connopen || back->socket(backhandle) == NULL) &&
796 bufchain_size(&stdout_data) == 0 &&
797 bufchain_size(&stderr_data) == 0)
798 break; /* we closed the connection */
800 exitcode = back->exitcode(backhandle);
802 fprintf(stderr, "Remote process exit code unavailable\n");
803 exitcode = 1; /* this is an error condition */
805 cleanup_exit(exitcode);
806 return 0; /* placate compiler warning */