2 * PLink - a Windows command-line (stdin/stdout) variant of PuTTY.
10 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
16 #define WM_AGENT_CALLBACK (WM_APP + 4)
18 struct agent_callback {
19 void (*callback)(void *, void *, int);
25 void fatalbox(const char *p, ...)
28 fprintf(stderr, "FATAL ERROR: ");
30 vfprintf(stderr, p, ap);
39 void modalfatalbox(const char *p, ...)
42 fprintf(stderr, "FATAL ERROR: ");
44 vfprintf(stderr, p, ap);
53 void nonfatal(const char *p, ...)
56 fprintf(stderr, "ERROR: ");
58 vfprintf(stderr, p, ap);
62 void connection_fatal(void *frontend, const char *p, ...)
65 fprintf(stderr, "FATAL ERROR: ");
67 vfprintf(stderr, p, ap);
76 void cmdline_error(const char *p, ...)
79 fprintf(stderr, "plink: ");
81 vfprintf(stderr, p, ap);
87 HANDLE inhandle, outhandle, errhandle;
88 struct handle *stdin_handle, *stdout_handle, *stderr_handle;
89 DWORD orig_console_mode;
95 static void *backhandle;
98 int term_ldisc(Terminal *term, int mode)
102 void frontend_echoedit_update(void *frontend, int echo, int edit)
104 /* Update stdin read mode to reflect changes in line discipline. */
107 mode = ENABLE_PROCESSED_INPUT;
109 mode = mode | ENABLE_ECHO_INPUT;
111 mode = mode & ~ENABLE_ECHO_INPUT;
113 mode = mode | ENABLE_LINE_INPUT;
115 mode = mode & ~ENABLE_LINE_INPUT;
116 SetConsoleMode(inhandle, mode);
119 char *get_ttymode(void *frontend, const char *mode) { return NULL; }
121 int from_backend(void *frontend_handle, int is_stderr,
122 const char *data, int len)
125 handle_write(stderr_handle, data, len);
127 handle_write(stdout_handle, data, len);
130 return handle_backlog(stdout_handle) + handle_backlog(stderr_handle);
133 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
136 * No "untrusted" output should get here (the way the code is
137 * currently, it's all diverted by FLAG_STDERR).
139 assert(!"Unexpected call to from_backend_untrusted()");
140 return 0; /* not reached */
143 int from_backend_eof(void *frontend_handle)
145 handle_write_eof(stdout_handle);
146 return FALSE; /* do not respond to incoming EOF with outgoing */
149 int get_userpass_input(prompts_t *p, const unsigned char *in, int inlen)
152 ret = cmdline_get_passwd_input(p, in, inlen);
154 ret = console_get_userpass_input(p, in, inlen);
158 static DWORD main_thread_id;
160 void agent_schedule_callback(void (*callback)(void *, void *, int),
161 void *callback_ctx, void *data, int len)
163 struct agent_callback *c = snew(struct agent_callback);
164 c->callback = callback;
165 c->callback_ctx = callback_ctx;
168 PostThreadMessage(main_thread_id, WM_AGENT_CALLBACK, 0, (LPARAM)c);
172 * Short description of parameters.
174 static void usage(void)
176 printf("Plink: command-line connection utility\n");
178 printf("Usage: plink [options] [user@]host [command]\n");
179 printf(" (\"host\" can also be a PuTTY saved session name)\n");
180 printf("Options:\n");
181 printf(" -V print version information and exit\n");
182 printf(" -pgpfp print PGP key fingerprints and exit\n");
183 printf(" -v show verbose messages\n");
184 printf(" -load sessname Load settings from saved session\n");
185 printf(" -ssh -telnet -rlogin -raw -serial\n");
186 printf(" force use of a particular protocol\n");
187 printf(" -P port connect to specified port\n");
188 printf(" -l user connect with specified username\n");
189 printf(" -batch disable all interactive prompts\n");
190 printf(" -proxycmd command\n");
191 printf(" use 'command' as local proxy\n");
192 printf(" -sercfg configuration-string (e.g. 19200,8,n,1,X)\n");
193 printf(" Specify the serial configuration (serial only)\n");
194 printf("The following options only apply to SSH connections:\n");
195 printf(" -pw passw login with specified password\n");
196 printf(" -D [listen-IP:]listen-port\n");
197 printf(" Dynamic SOCKS-based port forwarding\n");
198 printf(" -L [listen-IP:]listen-port:host:port\n");
199 printf(" Forward local port to remote address\n");
200 printf(" -R [listen-IP:]listen-port:host:port\n");
201 printf(" Forward remote port to local address\n");
202 printf(" -X -x enable / disable X11 forwarding\n");
203 printf(" -A -a enable / disable agent forwarding\n");
204 printf(" -t -T enable / disable pty allocation\n");
205 printf(" -1 -2 force use of particular protocol version\n");
206 printf(" -4 -6 force use of IPv4 or IPv6\n");
207 printf(" -C enable compression\n");
208 printf(" -i key private key file for user authentication\n");
209 printf(" -noagent disable use of Pageant\n");
210 printf(" -agent enable use of Pageant\n");
211 printf(" -hostkey aa:bb:cc:...\n");
212 printf(" manually specify a host key (may be repeated)\n");
213 printf(" -m file read remote command(s) from file\n");
214 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
215 printf(" -N don't start a shell/command (SSH-2 only)\n");
216 printf(" -nc host:port\n");
217 printf(" open tunnel in place of session (SSH-2 only)\n");
218 printf(" -sshlog file\n");
219 printf(" -sshrawlog file\n");
220 printf(" log protocol details to a file\n");
221 printf(" -shareexists\n");
222 printf(" test whether a connection-sharing upstream exists\n");
226 static void version(void)
228 char *buildinfo_text = buildinfo("\n");
229 printf("plink: %s\n%s\n", ver, buildinfo_text);
230 sfree(buildinfo_text);
234 char *do_select(SOCKET skt, int startup)
238 events = (FD_CONNECT | FD_READ | FD_WRITE |
239 FD_OOB | FD_CLOSE | FD_ACCEPT);
243 if (p_WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
244 switch (p_WSAGetLastError()) {
246 return "Network is down";
248 return "WSAEventSelect(): unknown error";
254 int stdin_gotdata(struct handle *h, void *data, int len)
258 * Special case: report read error.
261 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -len, 0,
262 buf, lenof(buf), NULL);
263 buf[lenof(buf)-1] = '\0';
264 if (buf[strlen(buf)-1] == '\n')
265 buf[strlen(buf)-1] = '\0';
266 fprintf(stderr, "Unable to read from standard input: %s\n", buf);
269 noise_ultralight(len);
270 if (connopen && back->connected(backhandle)) {
272 return back->send(backhandle, data, len);
274 back->special(backhandle, TS_EOF);
281 void stdouterr_sent(struct handle *h, int new_backlog)
283 if (new_backlog < 0) {
285 * Special case: report write error.
288 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -new_backlog, 0,
289 buf, lenof(buf), NULL);
290 buf[lenof(buf)-1] = '\0';
291 if (buf[strlen(buf)-1] == '\n')
292 buf[strlen(buf)-1] = '\0';
293 fprintf(stderr, "Unable to write to standard %s: %s\n",
294 (h == stdout_handle ? "output" : "error"), buf);
297 if (connopen && back->connected(backhandle)) {
298 back->unthrottle(backhandle, (handle_backlog(stdout_handle) +
299 handle_backlog(stderr_handle)));
303 const int share_can_be_downstream = TRUE;
304 const int share_can_be_upstream = TRUE;
306 int main(int argc, char **argv)
314 int got_host = FALSE;
315 int use_subsystem = 0;
316 int just_test_share_exists = FALSE;
317 unsigned long now, next, then;
319 dll_hijacking_protection();
322 skcount = sksize = 0;
324 * Initialise port and protocol to sensible defaults. (These
325 * will be overridden by more or less anything.)
327 default_protocol = PROT_SSH;
332 * Process the command line.
335 do_defaults(NULL, conf);
336 loaded_session = FALSE;
337 default_protocol = conf_get_int(conf, CONF_protocol);
338 default_port = conf_get_int(conf, CONF_port);
342 * Override the default protocol if PLINK_PROTOCOL is set.
344 char *p = getenv("PLINK_PROTOCOL");
346 const Backend *b = backend_from_name(p);
348 default_protocol = b->protocol;
349 default_port = b->default_port;
350 conf_set_int(conf, CONF_protocol, default_protocol);
351 conf_set_int(conf, CONF_port, default_port);
358 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
362 "plink: option \"%s\" requires an argument\n", p);
364 } else if (ret == 2) {
366 } else if (ret == 1) {
368 } else if (!strcmp(p, "-batch")) {
369 console_batch_mode = 1;
370 } else if (!strcmp(p, "-s")) {
371 /* Save status to write to conf later. */
373 } else if (!strcmp(p, "-V") || !strcmp(p, "--version")) {
375 } else if (!strcmp(p, "--help")) {
377 } else if (!strcmp(p, "-pgpfp")) {
380 } else if (!strcmp(p, "-shareexists")) {
381 just_test_share_exists = TRUE;
383 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
387 if (!conf_launchable(conf) || !(got_host || loaded_session)) {
390 * If the hostname starts with "telnet:", set the
391 * protocol to Telnet and process the string as a
394 if (!strncmp(q, "telnet:", 7)) {
398 if (q[0] == '/' && q[1] == '/')
400 conf_set_int(conf, CONF_protocol, PROT_TELNET);
402 p += host_strcspn(p, ":/");
407 conf_set_int(conf, CONF_port, atoi(p));
409 conf_set_int(conf, CONF_port, -1);
410 conf_set_str(conf, CONF_host, q);
413 char *r, *user, *host;
415 * Before we process the [user@]host string, we
416 * first check for the presence of a protocol
417 * prefix (a protocol name followed by ",").
423 b = backend_from_name(p);
425 default_protocol = b->protocol;
426 conf_set_int(conf, CONF_protocol,
428 portnumber = b->default_port;
434 * A nonzero length string followed by an @ is treated
435 * as a username. (We discount an _initial_ @.) The
436 * rest of the string (or the whole string if no @)
437 * is treated as a session name and/or hostname.
441 p++, r = NULL; /* discount initial @ */
446 user = NULL, host = p;
450 * Now attempt to load a saved session with the
451 * same name as the hostname.
454 Conf *conf2 = conf_new();
455 do_defaults(host, conf2);
456 if (loaded_session || !conf_launchable(conf2)) {
457 /* No settings for this host; use defaults */
458 /* (or session was already loaded with -load) */
459 conf_set_str(conf, CONF_host, host);
460 conf_set_int(conf, CONF_port, default_port);
463 conf_copy_into(conf, conf2);
464 loaded_session = TRUE;
470 /* Patch in specified username. */
471 conf_set_str(conf, CONF_username, user);
478 cmdlen = cmdsize = 0;
483 if (cmdlen >= cmdsize) {
484 cmdsize = cmdlen + 512;
485 command = sresize(command, cmdsize, char);
487 command[cmdlen++]=*p++;
489 if (cmdlen >= cmdsize) {
490 cmdsize = cmdlen + 512;
491 command = sresize(command, cmdsize, char);
493 command[cmdlen++]=' '; /* always add trailing space */
494 if (--argc) p = *++argv;
496 if (cmdlen) command[--cmdlen]='\0';
497 /* change trailing blank to NUL */
498 conf_set_str(conf, CONF_remote_cmd, command);
499 conf_set_str(conf, CONF_remote_cmd2, "");
500 conf_set_int(conf, CONF_nopty, TRUE); /* command => no tty */
502 break; /* done with cmdline */
510 if (!conf_launchable(conf) || !(got_host || loaded_session)) {
515 * Muck about with the hostname in various ways.
518 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
519 char *host = hostbuf;
523 * Trim leading whitespace.
525 host += strspn(host, " \t");
528 * See if host is of the form user@host, and separate out
529 * the username if so.
531 if (host[0] != '\0') {
532 char *atsign = strrchr(host, '@');
535 conf_set_str(conf, CONF_username, host);
541 * Trim a colon suffix off the hostname if it's there. In
542 * order to protect unbracketed IPv6 address literals
543 * against this treatment, we do not do this if there's
544 * _more_ than one colon.
547 char *c = host_strchr(host, ':');
550 char *d = host_strchr(c+1, ':');
557 * Remove any remaining whitespace.
562 if (*q != ' ' && *q != '\t')
568 conf_set_str(conf, CONF_host, hostbuf);
573 * Perform command-line overrides on session configuration.
575 cmdline_run_saved(conf);
578 * Apply subsystem status.
581 conf_set_int(conf, CONF_ssh_subsys, TRUE);
583 if (!*conf_get_str(conf, CONF_remote_cmd) &&
584 !*conf_get_str(conf, CONF_remote_cmd2) &&
585 !*conf_get_str(conf, CONF_ssh_nc_host))
586 flags |= FLAG_INTERACTIVE;
589 * Select protocol. This is farmed out into a table in a
590 * separate file to enable an ssh-free variant.
592 back = backend_from_proto(conf_get_int(conf, CONF_protocol));
595 "Internal fault: Unsupported protocol found\n");
602 if (portnumber != -1)
603 conf_set_int(conf, CONF_port, portnumber);
606 if (p_WSAEventSelect == NULL) {
607 fprintf(stderr, "Plink requires WinSock 2\n");
612 * Plink doesn't provide any way to add forwardings after the
613 * connection is set up, so if there are none now, we can safely set
616 if (conf_get_int(conf, CONF_protocol) == PROT_SSH &&
617 !conf_get_int(conf, CONF_x11_forward) &&
618 !conf_get_int(conf, CONF_agentfwd) &&
619 !conf_get_str_nthstrkey(conf, CONF_portfwd, 0))
620 conf_set_int(conf, CONF_ssh_simple, TRUE);
622 logctx = log_init(NULL, conf);
623 console_provide_logctx(logctx);
625 if (just_test_share_exists) {
626 if (!back->test_for_upstream) {
627 fprintf(stderr, "Connection sharing not supported for connection "
628 "type '%s'\n", back->name);
631 if (back->test_for_upstream(conf_get_str(conf, CONF_host),
632 conf_get_int(conf, CONF_port), conf))
638 if (restricted_acl) {
639 logevent(NULL, "Running with restricted process ACL");
643 * Start up the connection.
645 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
649 /* nodelay is only useful if stdin is a character device (console) */
650 int nodelay = conf_get_int(conf, CONF_tcp_nodelay) &&
651 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
653 error = back->init(NULL, &backhandle, conf,
654 conf_get_str(conf, CONF_host),
655 conf_get_int(conf, CONF_port),
657 conf_get_int(conf, CONF_tcp_keepalives));
659 fprintf(stderr, "Unable to open connection:\n%s", error);
662 back->provide_logctx(backhandle, logctx);
667 inhandle = GetStdHandle(STD_INPUT_HANDLE);
668 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
669 errhandle = GetStdHandle(STD_ERROR_HANDLE);
672 * Turn off ECHO and LINE input modes. We don't care if this
673 * call fails, because we know we aren't necessarily running in
676 GetConsoleMode(inhandle, &orig_console_mode);
677 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
680 * Pass the output handles to the handle-handling subsystem.
681 * (The input one we leave until we're through the
682 * authentication process.)
684 stdout_handle = handle_output_new(outhandle, stdouterr_sent, NULL, 0);
685 stderr_handle = handle_output_new(errhandle, stdouterr_sent, NULL, 0);
687 main_thread_id = GetCurrentThreadId();
691 now = GETTICKCOUNT();
699 if (!sending && back->sendok(backhandle)) {
700 stdin_handle = handle_input_new(inhandle, stdin_gotdata, NULL,
705 if (toplevel_callback_pending()) {
708 } else if (run_timers(now, &next)) {
710 now = GETTICKCOUNT();
711 if (now - then > next - then)
717 /* no need to initialise next here because we can never
718 * get WAIT_TIMEOUT */
721 handles = handle_get_events(&nhandles);
722 handles = sresize(handles, nhandles+1, HANDLE);
723 handles[nhandles] = netevent;
724 n = MsgWaitForMultipleObjects(nhandles+1, handles, FALSE, ticks,
726 if ((unsigned)(n - WAIT_OBJECT_0) < (unsigned)nhandles) {
727 handle_got_event(handles[n - WAIT_OBJECT_0]);
728 } else if (n == WAIT_OBJECT_0 + nhandles) {
729 WSANETWORKEVENTS things;
731 extern SOCKET first_socket(int *), next_socket(int *);
732 extern int select_result(WPARAM, LPARAM);
736 * We must not call select_result() for any socket
737 * until we have finished enumerating within the tree.
738 * This is because select_result() may close the socket
739 * and modify the tree.
741 /* Count the active sockets. */
743 for (socket = first_socket(&socketstate);
744 socket != INVALID_SOCKET;
745 socket = next_socket(&socketstate)) i++;
747 /* Expand the buffer if necessary. */
750 sklist = sresize(sklist, sksize, SOCKET);
753 /* Retrieve the sockets into sklist. */
755 for (socket = first_socket(&socketstate);
756 socket != INVALID_SOCKET;
757 socket = next_socket(&socketstate)) {
758 sklist[skcount++] = socket;
761 /* Now we're done enumerating; go through the list. */
762 for (i = 0; i < skcount; i++) {
765 wp = (WPARAM) socket;
766 if (!p_WSAEnumNetworkEvents(socket, NULL, &things)) {
767 static const struct { int bit, mask; } eventtypes[] = {
768 {FD_CONNECT_BIT, FD_CONNECT},
769 {FD_READ_BIT, FD_READ},
770 {FD_CLOSE_BIT, FD_CLOSE},
771 {FD_OOB_BIT, FD_OOB},
772 {FD_WRITE_BIT, FD_WRITE},
773 {FD_ACCEPT_BIT, FD_ACCEPT},
777 noise_ultralight(socket);
778 noise_ultralight(things.lNetworkEvents);
780 for (e = 0; e < lenof(eventtypes); e++)
781 if (things.lNetworkEvents & eventtypes[e].mask) {
783 int err = things.iErrorCode[eventtypes[e].bit];
784 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
785 connopen &= select_result(wp, lp);
789 } else if (n == WAIT_OBJECT_0 + nhandles + 1) {
791 while (PeekMessage(&msg, INVALID_HANDLE_VALUE,
792 WM_AGENT_CALLBACK, WM_AGENT_CALLBACK,
794 struct agent_callback *c = (struct agent_callback *)msg.lParam;
795 c->callback(c->callback_ctx, c->data, c->len);
800 run_toplevel_callbacks();
802 if (n == WAIT_TIMEOUT) {
805 now = GETTICKCOUNT();
811 handle_unthrottle(stdin_handle, back->sendbuffer(backhandle));
813 if ((!connopen || !back->connected(backhandle)) &&
814 handle_backlog(stdout_handle) + handle_backlog(stderr_handle) == 0)
815 break; /* we closed the connection */
817 exitcode = back->exitcode(backhandle);
819 fprintf(stderr, "Remote process exit code unavailable\n");
820 exitcode = 1; /* this is an error condition */
822 cleanup_exit(exitcode);
823 return 0; /* placate compiler warning */