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 connection_fatal(void *frontend, char *p, ...)
55 fprintf(stderr, "FATAL ERROR: ");
57 vfprintf(stderr, p, ap);
66 void cmdline_error(char *p, ...)
69 fprintf(stderr, "plink: ");
71 vfprintf(stderr, p, ap);
77 HANDLE inhandle, outhandle, errhandle;
78 struct handle *stdin_handle, *stdout_handle, *stderr_handle;
79 DWORD orig_console_mode;
85 static void *backhandle;
88 int term_ldisc(Terminal *term, int mode)
92 void ldisc_update(void *frontend, int echo, int edit)
94 /* Update stdin read mode to reflect changes in line discipline. */
97 mode = ENABLE_PROCESSED_INPUT;
99 mode = mode | ENABLE_ECHO_INPUT;
101 mode = mode & ~ENABLE_ECHO_INPUT;
103 mode = mode | ENABLE_LINE_INPUT;
105 mode = mode & ~ENABLE_LINE_INPUT;
106 SetConsoleMode(inhandle, mode);
109 char *get_ttymode(void *frontend, const char *mode) { return NULL; }
111 int from_backend(void *frontend_handle, int is_stderr,
112 const char *data, int len)
115 handle_write(stderr_handle, data, len);
117 handle_write(stdout_handle, data, len);
120 return handle_backlog(stdout_handle) + handle_backlog(stderr_handle);
123 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
126 * No "untrusted" output should get here (the way the code is
127 * currently, it's all diverted by FLAG_STDERR).
129 assert(!"Unexpected call to from_backend_untrusted()");
130 return 0; /* not reached */
133 int get_userpass_input(prompts_t *p, unsigned char *in, int inlen)
136 ret = cmdline_get_passwd_input(p, in, inlen);
138 ret = console_get_userpass_input(p, in, inlen);
142 static DWORD main_thread_id;
144 void agent_schedule_callback(void (*callback)(void *, void *, int),
145 void *callback_ctx, void *data, int len)
147 struct agent_callback *c = snew(struct agent_callback);
148 c->callback = callback;
149 c->callback_ctx = callback_ctx;
152 PostThreadMessage(main_thread_id, WM_AGENT_CALLBACK, 0, (LPARAM)c);
156 * Short description of parameters.
158 static void usage(void)
160 printf("PuTTY Link: command-line connection utility\n");
162 printf("Usage: plink [options] [user@]host [command]\n");
163 printf(" (\"host\" can also be a PuTTY saved session name)\n");
164 printf("Options:\n");
165 printf(" -V print version information and exit\n");
166 printf(" -pgpfp print PGP key fingerprints and exit\n");
167 printf(" -v show verbose messages\n");
168 printf(" -load sessname Load settings from saved session\n");
169 printf(" -ssh -telnet -rlogin -raw -serial\n");
170 printf(" force use of a particular protocol\n");
171 printf(" -P port connect to specified port\n");
172 printf(" -l user connect with specified username\n");
173 printf(" -batch disable all interactive prompts\n");
174 printf("The following options only apply to SSH connections:\n");
175 printf(" -pw passw login with specified password\n");
176 printf(" -D [listen-IP:]listen-port\n");
177 printf(" Dynamic SOCKS-based port forwarding\n");
178 printf(" -L [listen-IP:]listen-port:host:port\n");
179 printf(" Forward local port to remote address\n");
180 printf(" -R [listen-IP:]listen-port:host:port\n");
181 printf(" Forward remote port to local address\n");
182 printf(" -X -x enable / disable X11 forwarding\n");
183 printf(" -A -a enable / disable agent forwarding\n");
184 printf(" -t -T enable / disable pty allocation\n");
185 printf(" -1 -2 force use of particular protocol version\n");
186 printf(" -4 -6 force use of IPv4 or IPv6\n");
187 printf(" -C enable compression\n");
188 printf(" -i key private key file for authentication\n");
189 printf(" -noagent disable use of Pageant\n");
190 printf(" -agent enable use of Pageant\n");
191 printf(" -m file read remote command(s) from file\n");
192 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
193 printf(" -N don't start a shell/command (SSH-2 only)\n");
194 printf(" -nc host:port\n");
195 printf(" open tunnel in place of session (SSH-2 only)\n");
196 printf(" -sercfg configuration-string (e.g. 19200,8,n,1,X)\n");
197 printf(" Specify the serial configuration (serial only)\n");
201 static void version(void)
203 printf("plink: %s\n", ver);
207 char *do_select(SOCKET skt, int startup)
211 events = (FD_CONNECT | FD_READ | FD_WRITE |
212 FD_OOB | FD_CLOSE | FD_ACCEPT);
216 if (p_WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
217 switch (p_WSAGetLastError()) {
219 return "Network is down";
221 return "WSAEventSelect(): unknown error";
227 int stdin_gotdata(struct handle *h, void *data, int len)
231 * Special case: report read error.
234 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -len, 0,
235 buf, lenof(buf), NULL);
236 buf[lenof(buf)-1] = '\0';
237 if (buf[strlen(buf)-1] == '\n')
238 buf[strlen(buf)-1] = '\0';
239 fprintf(stderr, "Unable to read from standard input: %s\n", buf);
242 noise_ultralight(len);
243 if (connopen && back->connected(backhandle)) {
245 return back->send(backhandle, data, len);
247 back->special(backhandle, TS_EOF);
254 void stdouterr_sent(struct handle *h, int new_backlog)
256 if (new_backlog < 0) {
258 * Special case: report write error.
261 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, -new_backlog, 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 write to standard %s: %s\n",
267 (h == stdout_handle ? "output" : "error"), buf);
270 if (connopen && back->connected(backhandle)) {
271 back->unthrottle(backhandle, (handle_backlog(stdout_handle) +
272 handle_backlog(stderr_handle)));
276 int main(int argc, char **argv)
284 int use_subsystem = 0;
288 skcount = sksize = 0;
290 * Initialise port and protocol to sensible defaults. (These
291 * will be overridden by more or less anything.)
293 default_protocol = PROT_SSH;
298 * Process the command line.
300 do_defaults(NULL, &cfg);
301 loaded_session = FALSE;
302 default_protocol = cfg.protocol;
303 default_port = cfg.port;
307 * Override the default protocol if PLINK_PROTOCOL is set.
309 char *p = getenv("PLINK_PROTOCOL");
311 const Backend *b = backend_from_name(p);
313 default_protocol = cfg.protocol = b->protocol;
314 default_port = cfg.port = b->default_port;
321 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
325 "plink: option \"%s\" requires an argument\n", p);
327 } else if (ret == 2) {
329 } else if (ret == 1) {
331 } else if (!strcmp(p, "-batch")) {
332 console_batch_mode = 1;
333 } else if (!strcmp(p, "-s")) {
334 /* Save status to write to cfg later. */
336 } else if (!strcmp(p, "-V")) {
338 } else if (!strcmp(p, "-pgpfp")) {
342 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
346 if (!cfg_launchable(&cfg)) {
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 ",").
383 b = backend_from_name(p);
385 default_protocol = cfg.protocol = b->protocol;
386 portnumber = b->default_port;
392 * A nonzero length string followed by an @ is treated
393 * as a username. (We discount an _initial_ @.) The
394 * rest of the string (or the whole string if no @)
395 * is treated as a session name and/or hostname.
399 p++, r = NULL; /* discount initial @ */
404 user = NULL, host = p;
408 * Now attempt to load a saved session with the
409 * same name as the hostname.
413 do_defaults(host, &cfg2);
414 if (loaded_session || !cfg_launchable(&cfg2)) {
415 /* No settings for this host; use defaults */
416 /* (or session was already loaded with -load) */
417 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
418 cfg.host[sizeof(cfg.host) - 1] = '\0';
419 cfg.port = default_port;
426 /* Patch in specified username. */
427 strncpy(cfg.username, user,
428 sizeof(cfg.username) - 1);
429 cfg.username[sizeof(cfg.username) - 1] = '\0';
436 cmdlen = cmdsize = 0;
441 if (cmdlen >= cmdsize) {
442 cmdsize = cmdlen + 512;
443 command = sresize(command, cmdsize, char);
445 command[cmdlen++]=*p++;
447 if (cmdlen >= cmdsize) {
448 cmdsize = cmdlen + 512;
449 command = sresize(command, cmdsize, char);
451 command[cmdlen++]=' '; /* always add trailing space */
452 if (--argc) p = *++argv;
454 if (cmdlen) command[--cmdlen]='\0';
455 /* change trailing blank to NUL */
456 cfg.remote_cmd_ptr = command;
457 cfg.remote_cmd_ptr2 = NULL;
458 cfg.nopty = TRUE; /* command => no terminal */
460 break; /* done with cmdline */
468 if (!cfg_launchable(&cfg)) {
473 * Trim leading whitespace off the hostname if it's there.
476 int space = strspn(cfg.host, " \t");
477 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
480 /* See if host is of the form user@host */
481 if (cfg_launchable(&cfg)) {
482 char *atsign = strrchr(cfg.host, '@');
483 /* Make sure we're not overflowing the user field */
485 if (atsign - cfg.host < sizeof cfg.username) {
486 strncpy(cfg.username, cfg.host, atsign - cfg.host);
487 cfg.username[atsign - cfg.host] = '\0';
489 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
494 * Perform command-line overrides on session configuration.
496 cmdline_run_saved(&cfg);
499 * Apply subsystem status.
502 cfg.ssh_subsys = TRUE;
505 * Trim a colon suffix off the hostname if it's there.
507 cfg.host[strcspn(cfg.host, ":")] = '\0';
510 * Remove any remaining whitespace from the hostname.
514 while (cfg.host[p2] != '\0') {
515 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
516 cfg.host[p1] = cfg.host[p2];
524 if (!cfg.remote_cmd_ptr && !*cfg.remote_cmd && !*cfg.ssh_nc_host)
525 flags |= FLAG_INTERACTIVE;
528 * Select protocol. This is farmed out into a table in a
529 * separate file to enable an ssh-free variant.
531 back = backend_from_proto(cfg.protocol);
534 "Internal fault: Unsupported protocol found\n");
541 if (portnumber != -1)
542 cfg.port = portnumber;
545 if (p_WSAEventSelect == NULL) {
546 fprintf(stderr, "Plink requires WinSock 2\n");
550 logctx = log_init(NULL, &cfg);
551 console_provide_logctx(logctx);
554 * Start up the connection.
556 netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
560 /* nodelay is only useful if stdin is a character device (console) */
561 int nodelay = cfg.tcp_nodelay &&
562 (GetFileType(GetStdHandle(STD_INPUT_HANDLE)) == FILE_TYPE_CHAR);
564 error = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port,
565 &realhost, nodelay, cfg.tcp_keepalives);
567 fprintf(stderr, "Unable to open connection:\n%s", error);
570 back->provide_logctx(backhandle, logctx);
575 inhandle = GetStdHandle(STD_INPUT_HANDLE);
576 outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
577 errhandle = GetStdHandle(STD_ERROR_HANDLE);
580 * Turn off ECHO and LINE input modes. We don't care if this
581 * call fails, because we know we aren't necessarily running in
584 GetConsoleMode(inhandle, &orig_console_mode);
585 SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
588 * Pass the output handles to the handle-handling subsystem.
589 * (The input one we leave until we're through the
590 * authentication process.)
592 stdout_handle = handle_output_new(outhandle, stdouterr_sent, NULL, 0);
593 stderr_handle = handle_output_new(errhandle, stdouterr_sent, NULL, 0);
595 main_thread_id = GetCurrentThreadId();
599 now = GETTICKCOUNT();
607 if (!sending && back->sendok(backhandle)) {
608 stdin_handle = handle_input_new(inhandle, stdin_gotdata, NULL,
613 if (run_timers(now, &next)) {
614 ticks = next - GETTICKCOUNT();
615 if (ticks < 0) ticks = 0; /* just in case */
620 handles = handle_get_events(&nhandles);
621 handles = sresize(handles, nhandles+1, HANDLE);
622 handles[nhandles] = netevent;
623 n = MsgWaitForMultipleObjects(nhandles+1, handles, FALSE, ticks,
625 if ((unsigned)(n - WAIT_OBJECT_0) < (unsigned)nhandles) {
626 handle_got_event(handles[n - WAIT_OBJECT_0]);
627 } else if (n == WAIT_OBJECT_0 + nhandles) {
628 WSANETWORKEVENTS things;
630 extern SOCKET first_socket(int *), next_socket(int *);
631 extern int select_result(WPARAM, LPARAM);
635 * We must not call select_result() for any socket
636 * until we have finished enumerating within the tree.
637 * This is because select_result() may close the socket
638 * and modify the tree.
640 /* Count the active sockets. */
642 for (socket = first_socket(&socketstate);
643 socket != INVALID_SOCKET;
644 socket = next_socket(&socketstate)) i++;
646 /* Expand the buffer if necessary. */
649 sklist = sresize(sklist, sksize, SOCKET);
652 /* Retrieve the sockets into sklist. */
654 for (socket = first_socket(&socketstate);
655 socket != INVALID_SOCKET;
656 socket = next_socket(&socketstate)) {
657 sklist[skcount++] = socket;
660 /* Now we're done enumerating; go through the list. */
661 for (i = 0; i < skcount; i++) {
664 wp = (WPARAM) socket;
665 if (!p_WSAEnumNetworkEvents(socket, NULL, &things)) {
666 static const struct { int bit, mask; } eventtypes[] = {
667 {FD_CONNECT_BIT, FD_CONNECT},
668 {FD_READ_BIT, FD_READ},
669 {FD_CLOSE_BIT, FD_CLOSE},
670 {FD_OOB_BIT, FD_OOB},
671 {FD_WRITE_BIT, FD_WRITE},
672 {FD_ACCEPT_BIT, FD_ACCEPT},
676 noise_ultralight(socket);
677 noise_ultralight(things.lNetworkEvents);
679 for (e = 0; e < lenof(eventtypes); e++)
680 if (things.lNetworkEvents & eventtypes[e].mask) {
682 int err = things.iErrorCode[eventtypes[e].bit];
683 lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
684 connopen &= select_result(wp, lp);
688 } else if (n == WAIT_OBJECT_0 + nhandles + 1) {
690 while (PeekMessage(&msg, INVALID_HANDLE_VALUE,
691 WM_AGENT_CALLBACK, WM_AGENT_CALLBACK,
693 struct agent_callback *c = (struct agent_callback *)msg.lParam;
694 c->callback(c->callback_ctx, c->data, c->len);
699 if (n == WAIT_TIMEOUT) {
702 now = GETTICKCOUNT();
708 handle_unthrottle(stdin_handle, back->sendbuffer(backhandle));
710 if ((!connopen || !back->connected(backhandle)) &&
711 handle_backlog(stdout_handle) + handle_backlog(stderr_handle) == 0)
712 break; /* we closed the connection */
714 exitcode = back->exitcode(backhandle);
716 fprintf(stderr, "Remote process exit code unavailable\n");
717 exitcode = 1; /* this is an error condition */
719 cleanup_exit(exitcode);
720 return 0; /* placate compiler warning */