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(" -sercfg configuration-string (e.g. 19200,8,n,1,X)\n");
191 printf(" Specify the serial configuration (serial only)\n");
192 printf("The following options only apply to SSH connections:\n");
193 printf(" -pw passw login with specified password\n");
194 printf(" -D [listen-IP:]listen-port\n");
195 printf(" Dynamic SOCKS-based port forwarding\n");
196 printf(" -L [listen-IP:]listen-port:host:port\n");
197 printf(" Forward local port to remote address\n");
198 printf(" -R [listen-IP:]listen-port:host:port\n");
199 printf(" Forward remote port to local address\n");
200 printf(" -X -x enable / disable X11 forwarding\n");
201 printf(" -A -a enable / disable agent forwarding\n");
202 printf(" -t -T enable / disable pty allocation\n");
203 printf(" -1 -2 force use of particular protocol version\n");
204 printf(" -4 -6 force use of IPv4 or IPv6\n");
205 printf(" -C enable compression\n");
206 printf(" -i key private key file for user authentication\n");
207 printf(" -noagent disable use of Pageant\n");
208 printf(" -agent enable use of Pageant\n");
209 printf(" -hostkey aa:bb:cc:...\n");
210 printf(" manually specify a host key (may be repeated)\n");
211 printf(" -m file read remote command(s) from file\n");
212 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
213 printf(" -N don't start a shell/command (SSH-2 only)\n");
214 printf(" -nc host:port\n");
215 printf(" open tunnel in place of session (SSH-2 only)\n");
216 printf(" -sshlog file\n");
217 printf(" -sshrawlog file\n");
218 printf(" log protocol details to a file\n");
219 printf(" -shareexists\n");
220 printf(" test whether a connection-sharing upstream exists\n");
224 static void version(void)
226 printf("plink: %s\n", ver);
230 char *do_select(SOCKET skt, int startup)
234 events = (FD_CONNECT | FD_READ | FD_WRITE |
235 FD_OOB | FD_CLOSE | FD_ACCEPT);
239 if (p_WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
240 switch (p_WSAGetLastError()) {
242 return "Network is down";
244 return "WSAEventSelect(): unknown error";
250 int stdin_gotdata(struct handle *h, void *data, int len)
254 * Special case: report read error.
257 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -len, 0,
258 buf, lenof(buf), NULL);
259 buf[lenof(buf)-1] = '\0';
260 if (buf[strlen(buf)-1] == '\n')
261 buf[strlen(buf)-1] = '\0';
262 fprintf(stderr, "Unable to read from standard input: %s\n", buf);
265 noise_ultralight(len);
266 if (connopen && back->connected(backhandle)) {
268 return back->send(backhandle, data, len);
270 back->special(backhandle, TS_EOF);
277 void stdouterr_sent(struct handle *h, int new_backlog)
279 if (new_backlog < 0) {
281 * Special case: report write error.
284 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -new_backlog, 0,
285 buf, lenof(buf), NULL);
286 buf[lenof(buf)-1] = '\0';
287 if (buf[strlen(buf)-1] == '\n')
288 buf[strlen(buf)-1] = '\0';
289 fprintf(stderr, "Unable to write to standard %s: %s\n",
290 (h == stdout_handle ? "output" : "error"), buf);
293 if (connopen && back->connected(backhandle)) {
294 back->unthrottle(backhandle, (handle_backlog(stdout_handle) +
295 handle_backlog(stderr_handle)));
299 const int share_can_be_downstream = TRUE;
300 const int share_can_be_upstream = TRUE;
302 int main(int argc, char **argv)
310 int got_host = FALSE;
311 int use_subsystem = 0;
312 int just_test_share_exists = FALSE;
313 unsigned long now, next, then;
316 skcount = sksize = 0;
318 * Initialise port and protocol to sensible defaults. (These
319 * will be overridden by more or less anything.)
321 default_protocol = PROT_SSH;
326 * Process the command line.
329 do_defaults(NULL, conf);
330 loaded_session = FALSE;
331 default_protocol = conf_get_int(conf, CONF_protocol);
332 default_port = conf_get_int(conf, CONF_port);
336 * Override the default protocol if PLINK_PROTOCOL is set.
338 char *p = getenv("PLINK_PROTOCOL");
340 const Backend *b = backend_from_name(p);
342 default_protocol = b->protocol;
343 default_port = b->default_port;
344 conf_set_int(conf, CONF_protocol, default_protocol);
345 conf_set_int(conf, CONF_port, default_port);
352 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
356 "plink: option \"%s\" requires an argument\n", p);
358 } else if (ret == 2) {
360 } else if (ret == 1) {
362 } else if (!strcmp(p, "-batch")) {
363 console_batch_mode = 1;
364 } else if (!strcmp(p, "-s")) {
365 /* Save status to write to conf later. */
367 } else if (!strcmp(p, "-V") || !strcmp(p, "--version")) {
369 } else if (!strcmp(p, "--help")) {
371 } else if (!strcmp(p, "-pgpfp")) {
374 } else if (!strcmp(p, "-shareexists")) {
375 just_test_share_exists = TRUE;
377 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
381 if (!conf_launchable(conf) || !(got_host || loaded_session)) {
384 * If the hostname starts with "telnet:", set the
385 * protocol to Telnet and process the string as a
388 if (!strncmp(q, "telnet:", 7)) {
392 if (q[0] == '/' && q[1] == '/')
394 conf_set_int(conf, CONF_protocol, PROT_TELNET);
396 p += host_strcspn(p, ":/");
401 conf_set_int(conf, CONF_port, atoi(p));
403 conf_set_int(conf, CONF_port, -1);
404 conf_set_str(conf, CONF_host, q);
407 char *r, *user, *host;
409 * Before we process the [user@]host string, we
410 * first check for the presence of a protocol
411 * prefix (a protocol name followed by ",").
417 b = backend_from_name(p);
419 default_protocol = b->protocol;
420 conf_set_int(conf, CONF_protocol,
422 portnumber = b->default_port;
428 * A nonzero length string followed by an @ is treated
429 * as a username. (We discount an _initial_ @.) The
430 * rest of the string (or the whole string if no @)
431 * is treated as a session name and/or hostname.
435 p++, r = NULL; /* discount initial @ */
440 user = NULL, host = p;
444 * Now attempt to load a saved session with the
445 * same name as the hostname.
448 Conf *conf2 = conf_new();
449 do_defaults(host, conf2);
450 if (loaded_session || !conf_launchable(conf2)) {
451 /* No settings for this host; use defaults */
452 /* (or session was already loaded with -load) */
453 conf_set_str(conf, CONF_host, host);
454 conf_set_int(conf, CONF_port, default_port);
457 conf_copy_into(conf, conf2);
458 loaded_session = TRUE;
464 /* Patch in specified username. */
465 conf_set_str(conf, CONF_username, user);
472 cmdlen = cmdsize = 0;
477 if (cmdlen >= cmdsize) {
478 cmdsize = cmdlen + 512;
479 command = sresize(command, cmdsize, char);
481 command[cmdlen++]=*p++;
483 if (cmdlen >= cmdsize) {
484 cmdsize = cmdlen + 512;
485 command = sresize(command, cmdsize, char);
487 command[cmdlen++]=' '; /* always add trailing space */
488 if (--argc) p = *++argv;
490 if (cmdlen) command[--cmdlen]='\0';
491 /* change trailing blank to NUL */
492 conf_set_str(conf, CONF_remote_cmd, command);
493 conf_set_str(conf, CONF_remote_cmd2, "");
494 conf_set_int(conf, CONF_nopty, TRUE); /* command => no tty */
496 break; /* done with cmdline */
501 #if !defined UNPROTECT && !defined NO_SECURITY
503 * Protect our process.
507 if (!setprocessacl(error)) {
508 char *message = dupprintf("Could not restrict process ACL: %s",
510 logevent(NULL, message);
520 if (!conf_launchable(conf) || !(got_host || loaded_session)) {
525 * Muck about with the hostname in various ways.
528 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
529 char *host = hostbuf;
533 * Trim leading whitespace.
535 host += strspn(host, " \t");
538 * See if host is of the form user@host, and separate out
539 * the username if so.
541 if (host[0] != '\0') {
542 char *atsign = strrchr(host, '@');
545 conf_set_str(conf, CONF_username, host);
551 * Trim a colon suffix off the hostname if it's there. In
552 * order to protect unbracketed IPv6 address literals
553 * against this treatment, we do not do this if there's
554 * _more_ than one colon.
557 char *c = host_strchr(host, ':');
560 char *d = host_strchr(c+1, ':');
567 * Remove any remaining whitespace.
572 if (*q != ' ' && *q != '\t')
578 conf_set_str(conf, CONF_host, hostbuf);
583 * Perform command-line overrides on session configuration.
585 cmdline_run_saved(conf);
588 * Apply subsystem status.
591 conf_set_int(conf, CONF_ssh_subsys, TRUE);
593 if (!*conf_get_str(conf, CONF_remote_cmd) &&
594 !*conf_get_str(conf, CONF_remote_cmd2) &&
595 !*conf_get_str(conf, CONF_ssh_nc_host))
596 flags |= FLAG_INTERACTIVE;
599 * Select protocol. This is farmed out into a table in a
600 * separate file to enable an ssh-free variant.
602 back = backend_from_proto(conf_get_int(conf, CONF_protocol));
605 "Internal fault: Unsupported protocol found\n");
612 if (portnumber != -1)
613 conf_set_int(conf, CONF_port, portnumber);
616 if (p_WSAEventSelect == NULL) {
617 fprintf(stderr, "Plink requires WinSock 2\n");
621 logctx = log_init(NULL, conf);
622 console_provide_logctx(logctx);
624 if (just_test_share_exists) {
625 if (!back->test_for_upstream) {
626 fprintf(stderr, "Connection sharing not supported for connection "
627 "type '%s'\n", back->name);
630 if (back->test_for_upstream(conf_get_str(conf, CONF_host),
631 conf_get_int(conf, CONF_port), conf))
638 * Start up the connection.
640 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
644 /* nodelay is only useful if stdin is a character device (console) */
645 int nodelay = conf_get_int(conf, CONF_tcp_nodelay) &&
646 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
648 error = back->init(NULL, &backhandle, conf,
649 conf_get_str(conf, CONF_host),
650 conf_get_int(conf, CONF_port),
652 conf_get_int(conf, CONF_tcp_keepalives));
654 fprintf(stderr, "Unable to open connection:\n%s", error);
657 back->provide_logctx(backhandle, logctx);
662 inhandle = GetStdHandle(STD_INPUT_HANDLE);
663 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
664 errhandle = GetStdHandle(STD_ERROR_HANDLE);
667 * Turn off ECHO and LINE input modes. We don't care if this
668 * call fails, because we know we aren't necessarily running in
671 GetConsoleMode(inhandle, &orig_console_mode);
672 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
675 * Pass the output handles to the handle-handling subsystem.
676 * (The input one we leave until we're through the
677 * authentication process.)
679 stdout_handle = handle_output_new(outhandle, stdouterr_sent, NULL, 0);
680 stderr_handle = handle_output_new(errhandle, stdouterr_sent, NULL, 0);
682 main_thread_id = GetCurrentThreadId();
686 now = GETTICKCOUNT();
694 if (!sending && back->sendok(backhandle)) {
695 stdin_handle = handle_input_new(inhandle, stdin_gotdata, NULL,
700 if (toplevel_callback_pending()) {
703 } else if (run_timers(now, &next)) {
705 now = GETTICKCOUNT();
706 if (now - then > next - then)
712 /* no need to initialise next here because we can never
713 * get WAIT_TIMEOUT */
716 handles = handle_get_events(&nhandles);
717 handles = sresize(handles, nhandles+1, HANDLE);
718 handles[nhandles] = netevent;
719 n = MsgWaitForMultipleObjects(nhandles+1, handles, FALSE, ticks,
721 if ((unsigned)(n - WAIT_OBJECT_0) < (unsigned)nhandles) {
722 handle_got_event(handles[n - WAIT_OBJECT_0]);
723 } else if (n == WAIT_OBJECT_0 + nhandles) {
724 WSANETWORKEVENTS things;
726 extern SOCKET first_socket(int *), next_socket(int *);
727 extern int select_result(WPARAM, LPARAM);
731 * We must not call select_result() for any socket
732 * until we have finished enumerating within the tree.
733 * This is because select_result() may close the socket
734 * and modify the tree.
736 /* Count the active sockets. */
738 for (socket = first_socket(&socketstate);
739 socket != INVALID_SOCKET;
740 socket = next_socket(&socketstate)) i++;
742 /* Expand the buffer if necessary. */
745 sklist = sresize(sklist, sksize, SOCKET);
748 /* Retrieve the sockets into sklist. */
750 for (socket = first_socket(&socketstate);
751 socket != INVALID_SOCKET;
752 socket = next_socket(&socketstate)) {
753 sklist[skcount++] = socket;
756 /* Now we're done enumerating; go through the list. */
757 for (i = 0; i < skcount; i++) {
760 wp = (WPARAM) socket;
761 if (!p_WSAEnumNetworkEvents(socket, NULL, &things)) {
762 static const struct { int bit, mask; } eventtypes[] = {
763 {FD_CONNECT_BIT, FD_CONNECT},
764 {FD_READ_BIT, FD_READ},
765 {FD_CLOSE_BIT, FD_CLOSE},
766 {FD_OOB_BIT, FD_OOB},
767 {FD_WRITE_BIT, FD_WRITE},
768 {FD_ACCEPT_BIT, FD_ACCEPT},
772 noise_ultralight(socket);
773 noise_ultralight(things.lNetworkEvents);
775 for (e = 0; e < lenof(eventtypes); e++)
776 if (things.lNetworkEvents & eventtypes[e].mask) {
778 int err = things.iErrorCode[eventtypes[e].bit];
779 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
780 connopen &= select_result(wp, lp);
784 } else if (n == WAIT_OBJECT_0 + nhandles + 1) {
786 while (PeekMessage(&msg, INVALID_HANDLE_VALUE,
787 WM_AGENT_CALLBACK, WM_AGENT_CALLBACK,
789 struct agent_callback *c = (struct agent_callback *)msg.lParam;
790 c->callback(c->callback_ctx, c->data, c->len);
795 run_toplevel_callbacks();
797 if (n == WAIT_TIMEOUT) {
800 now = GETTICKCOUNT();
806 handle_unthrottle(stdin_handle, back->sendbuffer(backhandle));
808 if ((!connopen || !back->connected(backhandle)) &&
809 handle_backlog(stdout_handle) + handle_backlog(stderr_handle) == 0)
810 break; /* we closed the connection */
812 exitcode = back->exitcode(backhandle);
814 fprintf(stderr, "Remote process exit code unavailable\n");
815 exitcode = 1; /* this is an error condition */
817 cleanup_exit(exitcode);
818 return 0; /* placate compiler warning */