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_APP + 4)
17 struct agent_callback {
18 void (*callback)(void *, void *, int);
24 void fatalbox(char *p, ...)
27 fprintf(stderr, "FATAL ERROR: ");
29 vfprintf(stderr, p, ap);
38 void modalfatalbox(char *p, ...)
41 fprintf(stderr, "FATAL ERROR: ");
43 vfprintf(stderr, p, ap);
52 void nonfatal(char *p, ...)
55 fprintf(stderr, "ERROR: ");
57 vfprintf(stderr, p, ap);
61 void connection_fatal(void *frontend, char *p, ...)
64 fprintf(stderr, "FATAL ERROR: ");
66 vfprintf(stderr, p, ap);
75 void cmdline_error(char *p, ...)
78 fprintf(stderr, "plink: ");
80 vfprintf(stderr, p, ap);
86 HANDLE inhandle, outhandle, errhandle;
87 struct handle *stdin_handle, *stdout_handle, *stderr_handle;
88 DWORD orig_console_mode;
94 static void *backhandle;
97 int term_ldisc(Terminal *term, int mode)
101 void ldisc_update(void *frontend, int echo, int edit)
103 /* Update stdin read mode to reflect changes in line discipline. */
106 mode = ENABLE_PROCESSED_INPUT;
108 mode = mode | ENABLE_ECHO_INPUT;
110 mode = mode & ~ENABLE_ECHO_INPUT;
112 mode = mode | ENABLE_LINE_INPUT;
114 mode = mode & ~ENABLE_LINE_INPUT;
115 SetConsoleMode(inhandle, mode);
118 char *get_ttymode(void *frontend, const char *mode) { return NULL; }
120 int from_backend(void *frontend_handle, int is_stderr,
121 const char *data, int len)
124 handle_write(stderr_handle, data, len);
126 handle_write(stdout_handle, data, len);
129 return handle_backlog(stdout_handle) + handle_backlog(stderr_handle);
132 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
135 * No "untrusted" output should get here (the way the code is
136 * currently, it's all diverted by FLAG_STDERR).
138 assert(!"Unexpected call to from_backend_untrusted()");
139 return 0; /* not reached */
142 int from_backend_eof(void *frontend_handle)
144 handle_write_eof(stdout_handle);
145 return FALSE; /* do not respond to incoming EOF with outgoing */
148 int get_userpass_input(prompts_t *p, unsigned char *in, int inlen)
151 ret = cmdline_get_passwd_input(p, in, inlen);
153 ret = console_get_userpass_input(p, in, inlen);
157 static DWORD main_thread_id;
159 void agent_schedule_callback(void (*callback)(void *, void *, int),
160 void *callback_ctx, void *data, int len)
162 struct agent_callback *c = snew(struct agent_callback);
163 c->callback = callback;
164 c->callback_ctx = callback_ctx;
167 PostThreadMessage(main_thread_id, WM_AGENT_CALLBACK, 0, (LPARAM)c);
171 * Short description of parameters.
173 static void usage(void)
175 printf("PuTTY Link: command-line connection utility\n");
177 printf("Usage: plink [options] [user@]host [command]\n");
178 printf(" (\"host\" can also be a PuTTY saved session name)\n");
179 printf("Options:\n");
180 printf(" -V print version information and exit\n");
181 printf(" -pgpfp print PGP key fingerprints and exit\n");
182 printf(" -v show verbose messages\n");
183 printf(" -load sessname Load settings from saved session\n");
184 printf(" -ssh -telnet -rlogin -raw -serial\n");
185 printf(" force use of a particular protocol\n");
186 printf(" -P port connect to specified port\n");
187 printf(" -l user connect with specified username\n");
188 printf(" -batch disable all interactive prompts\n");
189 printf(" -sercfg configuration-string (e.g. 19200,8,n,1,X)\n");
190 printf(" Specify the serial configuration (serial only)\n");
191 printf("The following options only apply to SSH connections:\n");
192 printf(" -pw passw login with specified password\n");
193 printf(" -D [listen-IP:]listen-port\n");
194 printf(" Dynamic SOCKS-based port forwarding\n");
195 printf(" -L [listen-IP:]listen-port:host:port\n");
196 printf(" Forward local port to remote address\n");
197 printf(" -R [listen-IP:]listen-port:host:port\n");
198 printf(" Forward remote port to local address\n");
199 printf(" -X -x enable / disable X11 forwarding\n");
200 printf(" -A -a enable / disable agent forwarding\n");
201 printf(" -t -T enable / disable pty allocation\n");
202 printf(" -1 -2 force use of particular protocol version\n");
203 printf(" -4 -6 force use of IPv4 or IPv6\n");
204 printf(" -C enable compression\n");
205 printf(" -i key private key file for user authentication\n");
206 printf(" -noagent disable use of Pageant\n");
207 printf(" -agent enable use of Pageant\n");
208 printf(" -hostkey aa:bb:cc:...\n");
209 printf(" manually specify a host key (may be repeated)\n");
210 printf(" -m file read remote command(s) from file\n");
211 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
212 printf(" -N don't start a shell/command (SSH-2 only)\n");
213 printf(" -nc host:port\n");
214 printf(" open tunnel in place of session (SSH-2 only)\n");
218 static void version(void)
220 printf("plink: %s\n", ver);
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 (p_WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
234 switch (p_WSAGetLastError()) {
236 return "Network is down";
238 return "WSAEventSelect(): unknown error";
244 int stdin_gotdata(struct handle *h, void *data, int len)
248 * Special case: report read error.
251 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -len, 0,
252 buf, lenof(buf), NULL);
253 buf[lenof(buf)-1] = '\0';
254 if (buf[strlen(buf)-1] == '\n')
255 buf[strlen(buf)-1] = '\0';
256 fprintf(stderr, "Unable to read from standard input: %s\n", buf);
259 noise_ultralight(len);
260 if (connopen && back->connected(backhandle)) {
262 return back->send(backhandle, data, len);
264 back->special(backhandle, TS_EOF);
271 void stdouterr_sent(struct handle *h, int new_backlog)
273 if (new_backlog < 0) {
275 * Special case: report write error.
278 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -new_backlog, 0,
279 buf, lenof(buf), NULL);
280 buf[lenof(buf)-1] = '\0';
281 if (buf[strlen(buf)-1] == '\n')
282 buf[strlen(buf)-1] = '\0';
283 fprintf(stderr, "Unable to write to standard %s: %s\n",
284 (h == stdout_handle ? "output" : "error"), buf);
287 if (connopen && back->connected(backhandle)) {
288 back->unthrottle(backhandle, (handle_backlog(stdout_handle) +
289 handle_backlog(stderr_handle)));
293 const int share_can_be_downstream = TRUE;
294 const int share_can_be_upstream = TRUE;
296 int main(int argc, char **argv)
304 int got_host = FALSE;
305 int use_subsystem = 0;
306 unsigned long now, next, then;
309 skcount = sksize = 0;
311 * Initialise port and protocol to sensible defaults. (These
312 * will be overridden by more or less anything.)
314 default_protocol = PROT_SSH;
319 * Process the command line.
322 do_defaults(NULL, conf);
323 loaded_session = FALSE;
324 default_protocol = conf_get_int(conf, CONF_protocol);
325 default_port = conf_get_int(conf, CONF_port);
329 * Override the default protocol if PLINK_PROTOCOL is set.
331 char *p = getenv("PLINK_PROTOCOL");
333 const Backend *b = backend_from_name(p);
335 default_protocol = b->protocol;
336 default_port = b->default_port;
337 conf_set_int(conf, CONF_protocol, default_protocol);
338 conf_set_int(conf, CONF_port, default_port);
345 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
349 "plink: option \"%s\" requires an argument\n", p);
351 } else if (ret == 2) {
353 } else if (ret == 1) {
355 } else if (!strcmp(p, "-batch")) {
356 console_batch_mode = 1;
357 } else if (!strcmp(p, "-s")) {
358 /* Save status to write to conf later. */
360 } else if (!strcmp(p, "-V") || !strcmp(p, "--version")) {
362 } else if (!strcmp(p, "--help")) {
364 } else if (!strcmp(p, "-pgpfp")) {
368 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
372 if (!conf_launchable(conf) || !(got_host || loaded_session)) {
375 * If the hostname starts with "telnet:", set the
376 * protocol to Telnet and process the string as a
379 if (!strncmp(q, "telnet:", 7)) {
383 if (q[0] == '/' && q[1] == '/')
385 conf_set_int(conf, CONF_protocol, PROT_TELNET);
387 p += host_strcspn(p, ":/");
392 conf_set_int(conf, CONF_port, atoi(p));
394 conf_set_int(conf, CONF_port, -1);
395 conf_set_str(conf, CONF_host, q);
398 char *r, *user, *host;
400 * Before we process the [user@]host string, we
401 * first check for the presence of a protocol
402 * prefix (a protocol name followed by ",").
408 b = backend_from_name(p);
410 default_protocol = b->protocol;
411 conf_set_int(conf, CONF_protocol,
413 portnumber = b->default_port;
419 * A nonzero length string followed by an @ is treated
420 * as a username. (We discount an _initial_ @.) The
421 * rest of the string (or the whole string if no @)
422 * is treated as a session name and/or hostname.
426 p++, r = NULL; /* discount initial @ */
431 user = NULL, host = p;
435 * Now attempt to load a saved session with the
436 * same name as the hostname.
439 Conf *conf2 = conf_new();
440 do_defaults(host, conf2);
441 if (loaded_session || !conf_launchable(conf2)) {
442 /* No settings for this host; use defaults */
443 /* (or session was already loaded with -load) */
444 conf_set_str(conf, CONF_host, host);
445 conf_set_int(conf, CONF_port, default_port);
448 conf_copy_into(conf, conf2);
449 loaded_session = TRUE;
455 /* Patch in specified username. */
456 conf_set_str(conf, CONF_username, user);
463 cmdlen = cmdsize = 0;
468 if (cmdlen >= cmdsize) {
469 cmdsize = cmdlen + 512;
470 command = sresize(command, cmdsize, char);
472 command[cmdlen++]=*p++;
474 if (cmdlen >= cmdsize) {
475 cmdsize = cmdlen + 512;
476 command = sresize(command, cmdsize, char);
478 command[cmdlen++]=' '; /* always add trailing space */
479 if (--argc) p = *++argv;
481 if (cmdlen) command[--cmdlen]='\0';
482 /* change trailing blank to NUL */
483 conf_set_str(conf, CONF_remote_cmd, command);
484 conf_set_str(conf, CONF_remote_cmd2, "");
485 conf_set_int(conf, CONF_nopty, TRUE); /* command => no tty */
487 break; /* done with cmdline */
495 if (!conf_launchable(conf) || !(got_host || loaded_session)) {
500 * Muck about with the hostname in various ways.
503 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
504 char *host = hostbuf;
508 * Trim leading whitespace.
510 host += strspn(host, " \t");
513 * See if host is of the form user@host, and separate out
514 * the username if so.
516 if (host[0] != '\0') {
517 char *atsign = strrchr(host, '@');
520 conf_set_str(conf, CONF_username, host);
526 * Trim a colon suffix off the hostname if it's there. In
527 * order to protect unbracketed IPv6 address literals
528 * against this treatment, we do not do this if there's
529 * _more_ than one colon.
532 char *c = host_strchr(host, ':');
535 char *d = host_strchr(c+1, ':');
542 * Remove any remaining whitespace.
547 if (*q != ' ' && *q != '\t')
553 conf_set_str(conf, CONF_host, hostbuf);
558 * Perform command-line overrides on session configuration.
560 cmdline_run_saved(conf);
563 * Apply subsystem status.
566 conf_set_int(conf, CONF_ssh_subsys, TRUE);
568 if (!*conf_get_str(conf, CONF_remote_cmd) &&
569 !*conf_get_str(conf, CONF_remote_cmd2) &&
570 !*conf_get_str(conf, CONF_ssh_nc_host))
571 flags |= FLAG_INTERACTIVE;
574 * Select protocol. This is farmed out into a table in a
575 * separate file to enable an ssh-free variant.
577 back = backend_from_proto(conf_get_int(conf, CONF_protocol));
580 "Internal fault: Unsupported protocol found\n");
587 if (portnumber != -1)
588 conf_set_int(conf, CONF_port, portnumber);
591 if (p_WSAEventSelect == NULL) {
592 fprintf(stderr, "Plink requires WinSock 2\n");
596 logctx = log_init(NULL, conf);
597 console_provide_logctx(logctx);
600 * Start up the connection.
602 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
606 /* nodelay is only useful if stdin is a character device (console) */
607 int nodelay = conf_get_int(conf, CONF_tcp_nodelay) &&
608 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
610 error = back->init(NULL, &backhandle, conf,
611 conf_get_str(conf, CONF_host),
612 conf_get_int(conf, CONF_port),
614 conf_get_int(conf, CONF_tcp_keepalives));
616 fprintf(stderr, "Unable to open connection:\n%s", error);
619 back->provide_logctx(backhandle, logctx);
624 inhandle = GetStdHandle(STD_INPUT_HANDLE);
625 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
626 errhandle = GetStdHandle(STD_ERROR_HANDLE);
629 * Turn off ECHO and LINE input modes. We don't care if this
630 * call fails, because we know we aren't necessarily running in
633 GetConsoleMode(inhandle, &orig_console_mode);
634 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
637 * Pass the output handles to the handle-handling subsystem.
638 * (The input one we leave until we're through the
639 * authentication process.)
641 stdout_handle = handle_output_new(outhandle, stdouterr_sent, NULL, 0);
642 stderr_handle = handle_output_new(errhandle, stdouterr_sent, NULL, 0);
644 main_thread_id = GetCurrentThreadId();
648 now = GETTICKCOUNT();
656 if (!sending && back->sendok(backhandle)) {
657 stdin_handle = handle_input_new(inhandle, stdin_gotdata, NULL,
662 if (toplevel_callback_pending()) {
665 } else if (run_timers(now, &next)) {
667 now = GETTICKCOUNT();
668 if (now - then > next - then)
674 /* no need to initialise next here because we can never
675 * get WAIT_TIMEOUT */
678 handles = handle_get_events(&nhandles);
679 handles = sresize(handles, nhandles+1, HANDLE);
680 handles[nhandles] = netevent;
681 n = MsgWaitForMultipleObjects(nhandles+1, handles, FALSE, ticks,
683 if ((unsigned)(n - WAIT_OBJECT_0) < (unsigned)nhandles) {
684 handle_got_event(handles[n - WAIT_OBJECT_0]);
685 } else if (n == WAIT_OBJECT_0 + nhandles) {
686 WSANETWORKEVENTS things;
688 extern SOCKET first_socket(int *), next_socket(int *);
689 extern int select_result(WPARAM, LPARAM);
693 * We must not call select_result() for any socket
694 * until we have finished enumerating within the tree.
695 * This is because select_result() may close the socket
696 * and modify the tree.
698 /* Count the active sockets. */
700 for (socket = first_socket(&socketstate);
701 socket != INVALID_SOCKET;
702 socket = next_socket(&socketstate)) i++;
704 /* Expand the buffer if necessary. */
707 sklist = sresize(sklist, sksize, SOCKET);
710 /* Retrieve the sockets into sklist. */
712 for (socket = first_socket(&socketstate);
713 socket != INVALID_SOCKET;
714 socket = next_socket(&socketstate)) {
715 sklist[skcount++] = socket;
718 /* Now we're done enumerating; go through the list. */
719 for (i = 0; i < skcount; i++) {
722 wp = (WPARAM) socket;
723 if (!p_WSAEnumNetworkEvents(socket, NULL, &things)) {
724 static const struct { int bit, mask; } eventtypes[] = {
725 {FD_CONNECT_BIT, FD_CONNECT},
726 {FD_READ_BIT, FD_READ},
727 {FD_CLOSE_BIT, FD_CLOSE},
728 {FD_OOB_BIT, FD_OOB},
729 {FD_WRITE_BIT, FD_WRITE},
730 {FD_ACCEPT_BIT, FD_ACCEPT},
734 noise_ultralight(socket);
735 noise_ultralight(things.lNetworkEvents);
737 for (e = 0; e < lenof(eventtypes); e++)
738 if (things.lNetworkEvents & eventtypes[e].mask) {
740 int err = things.iErrorCode[eventtypes[e].bit];
741 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
742 connopen &= select_result(wp, lp);
746 } else if (n == WAIT_OBJECT_0 + nhandles + 1) {
748 while (PeekMessage(&msg, INVALID_HANDLE_VALUE,
749 WM_AGENT_CALLBACK, WM_AGENT_CALLBACK,
751 struct agent_callback *c = (struct agent_callback *)msg.lParam;
752 c->callback(c->callback_ctx, c->data, c->len);
757 run_toplevel_callbacks();
759 if (n == WAIT_TIMEOUT) {
762 now = GETTICKCOUNT();
768 handle_unthrottle(stdin_handle, back->sendbuffer(backhandle));
770 if ((!connopen || !back->connected(backhandle)) &&
771 handle_backlog(stdout_handle) + handle_backlog(stderr_handle) == 0)
772 break; /* we closed the connection */
774 exitcode = back->exitcode(backhandle);
776 fprintf(stderr, "Remote process exit code unavailable\n");
777 exitcode = 1; /* this is an error condition */
779 cleanup_exit(exitcode);
780 return 0; /* placate compiler warning */