2 * PLink - a command-line (stdin/stdout) variant of PuTTY.
15 #include <sys/ioctl.h>
17 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
22 #define MAX_STDIN_BACKLOG 4096
24 void fatalbox(char *p, ...)
27 fprintf(stderr, "FATAL ERROR: ");
29 vfprintf(stderr, p, ap);
34 void modalfatalbox(char *p, ...)
37 fprintf(stderr, "FATAL ERROR: ");
39 vfprintf(stderr, p, ap);
44 void connection_fatal(void *frontend, char *p, ...)
47 fprintf(stderr, "FATAL ERROR: ");
49 vfprintf(stderr, p, ap);
54 void cmdline_error(char *p, ...)
57 fprintf(stderr, "plink: ");
59 vfprintf(stderr, p, ap);
65 struct termios orig_termios;
68 static void *backhandle;
72 * Default settings that are specific to pterm.
74 char *platform_default_s(const char *name)
76 if (!strcmp(name, "TermType"))
77 return dupstr(getenv("TERM"));
78 if (!strcmp(name, "UserName"))
79 return get_username();
83 int platform_default_i(const char *name, int def)
85 if (!strcmp(name, "TermWidth") ||
86 !strcmp(name, "TermHeight")) {
88 if (ioctl(0, TIOCGWINSZ, (void *)&size) >= 0)
89 return (!strcmp(name, "TermWidth") ? size.ws_col : size.ws_row);
94 FontSpec platform_default_fontspec(const char *name)
101 Filename platform_default_filename(const char *name)
104 if (!strcmp(name, "LogFileName"))
105 strcpy(ret.path, "putty.log");
111 char *x_get_default(const char *key)
113 return NULL; /* this is a stub */
115 int term_ldisc(Terminal *term, int mode)
119 void ldisc_update(void *frontend, int echo, int edit)
121 /* Update stdin read mode to reflect changes in line discipline. */
127 mode.c_lflag |= ECHO;
129 mode.c_lflag &= ~ECHO;
132 mode.c_lflag |= ISIG | ICANON;
134 mode.c_lflag &= ~(ISIG | ICANON);
136 tcsetattr(0, TCSANOW, &mode);
139 void cleanup_termios(void)
141 tcsetattr(0, TCSANOW, &orig_termios);
144 bufchain stdout_data, stderr_data;
146 void try_output(int is_stderr)
148 bufchain *chain = (is_stderr ? &stderr_data : &stdout_data);
149 int fd = (is_stderr ? 2 : 1);
153 if (bufchain_size(chain) == 0)
156 bufchain_prefix(chain, &senddata, &sendlen);
157 ret = write(fd, senddata, sendlen);
159 bufchain_consume(chain, ret);
161 perror(is_stderr ? "stderr: write" : "stdout: write");
166 int from_backend(void *frontend_handle, int is_stderr,
167 const char *data, int len)
172 bufchain_add(&stderr_data, data, len);
175 bufchain_add(&stdout_data, data, len);
179 osize = bufchain_size(&stdout_data);
180 esize = bufchain_size(&stderr_data);
182 return osize + esize;
187 void sigwinch(int signum)
189 write(signalpipe[1], "x", 1);
193 * In Plink our selects are synchronous, so these functions are
196 int uxsel_input_add(int fd, int rwx) { return 0; }
197 void uxsel_input_remove(int id) { }
200 * Short description of parameters.
202 static void usage(void)
204 printf("PuTTY Link: command-line connection utility\n");
206 printf("Usage: plink [options] [user@]host [command]\n");
207 printf(" (\"host\" can also be a PuTTY saved session name)\n");
208 printf("Options:\n");
209 printf(" -V print version information\n");
210 printf(" -v show verbose messages\n");
211 printf(" -load sessname Load settings from saved session\n");
212 printf(" -ssh -telnet -rlogin -raw\n");
213 printf(" force use of a particular protocol\n");
214 printf(" -P port connect to specified port\n");
215 printf(" -l user connect with specified username\n");
216 printf(" -m file read remote command(s) from file\n");
217 printf(" -batch disable all interactive prompts\n");
218 printf("The following options only apply to SSH connections:\n");
219 printf(" -pw passw login with specified password\n");
220 printf(" -D [listen-IP:]listen-port\n");
221 printf(" Dynamic SOCKS-based port forwarding\n");
222 printf(" -L [listen-IP:]listen-port:host:port\n");
223 printf(" Forward local port to remote address\n");
224 printf(" -R [listen-IP:]listen-port:host:port\n");
225 printf(" Forward remote port to local address\n");
226 printf(" -X -x enable / disable X11 forwarding\n");
227 printf(" -A -a enable / disable agent forwarding\n");
228 printf(" -t -T enable / disable pty allocation\n");
229 printf(" -1 -2 force use of particular protocol version\n");
230 printf(" -4 -6 force use of IPv4 or IPv6\n");
231 printf(" -C enable compression\n");
232 printf(" -i key private key file for authentication\n");
233 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
234 printf(" -N don't start a shell/command (SSH-2 only)\n");
238 static void version(void)
240 printf("plink: %s\n", ver);
244 int main(int argc, char **argv)
250 int i, fdcount, fdsize, fdstate;
254 int use_subsystem = 0;
255 void *ldisc, *logctx;
258 ssh_get_line = console_get_line;
261 fdcount = fdsize = 0;
263 * Initialise port and protocol to sensible defaults. (These
264 * will be overridden by more or less anything.)
266 default_protocol = PROT_SSH;
271 * Process the command line.
273 do_defaults(NULL, &cfg);
274 loaded_session = FALSE;
275 default_protocol = cfg.protocol;
276 default_port = cfg.port;
280 * Override the default protocol if PLINK_PROTOCOL is set.
282 char *p = getenv("PLINK_PROTOCOL");
285 for (i = 0; backends[i].backend != NULL; i++) {
286 if (!strcmp(backends[i].name, p)) {
287 default_protocol = cfg.protocol = backends[i].protocol;
288 default_port = cfg.port =
289 backends[i].backend->default_port;
298 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
302 "plink: option \"%s\" requires an argument\n", p);
304 } else if (ret == 2) {
306 } else if (ret == 1) {
308 } else if (!strcmp(p, "-batch")) {
309 console_batch_mode = 1;
310 } else if (!strcmp(p, "-s")) {
311 /* Save status to write to cfg later. */
313 } else if (!strcmp(p, "-V")) {
315 } else if (!strcmp(p, "-o")) {
318 "plink: option \"-o\" requires an argument\n");
322 provide_xrm_string(*++argv);
325 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
332 do_defaults(NULL, &cfg);
335 * If the hostname starts with "telnet:", set the
336 * protocol to Telnet and process the string as a
339 if (!strncmp(q, "telnet:", 7)) {
343 if (q[0] == '/' && q[1] == '/')
345 cfg.protocol = PROT_TELNET;
347 while (*p && *p != ':' && *p != '/')
356 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
357 cfg.host[sizeof(cfg.host) - 1] = '\0';
359 char *r, *user, *host;
361 * Before we process the [user@]host string, we
362 * first check for the presence of a protocol
363 * prefix (a protocol name followed by ",").
368 for (i = 0; backends[i].backend != NULL; i++) {
369 j = strlen(backends[i].name);
371 !memcmp(backends[i].name, p, j)) {
372 default_protocol = cfg.protocol =
373 backends[i].protocol;
375 backends[i].backend->default_port;
383 * A nonzero length string followed by an @ is treated
384 * as a username. (We discount an _initial_ @.) The
385 * rest of the string (or the whole string if no @)
386 * is treated as a session name and/or hostname.
390 p++, r = NULL; /* discount initial @ */
395 user = NULL, host = p;
399 * Now attempt to load a saved session with the
400 * same name as the hostname.
404 do_defaults(host, &cfg2);
405 if (loaded_session || cfg2.host[0] == '\0') {
406 /* No settings for this host; use defaults */
407 /* (or session was already loaded with -load) */
408 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
409 cfg.host[sizeof(cfg.host) - 1] = '\0';
410 cfg.port = default_port;
413 /* Ick: patch up internal pointer after copy */
414 cfg.remote_cmd_ptr = cfg.remote_cmd;
419 /* Patch in specified username. */
420 strncpy(cfg.username, user,
421 sizeof(cfg.username) - 1);
422 cfg.username[sizeof(cfg.username) - 1] = '\0';
429 cmdlen = cmdsize = 0;
434 if (cmdlen >= cmdsize) {
435 cmdsize = cmdlen + 512;
436 command = sresize(command, cmdsize, char);
438 command[cmdlen++]=*p++;
440 if (cmdlen >= cmdsize) {
441 cmdsize = cmdlen + 512;
442 command = sresize(command, cmdsize, char);
444 command[cmdlen++]=' '; /* always add trailing space */
445 if (--argc) p = *++argv;
447 if (cmdlen) command[--cmdlen]='\0';
448 /* change trailing blank to NUL */
449 cfg.remote_cmd_ptr = command;
450 cfg.remote_cmd_ptr2 = NULL;
451 cfg.nopty = TRUE; /* command => no terminal */
453 break; /* done with cmdline */
466 * Trim leading whitespace off the hostname if it's there.
469 int space = strspn(cfg.host, " \t");
470 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
473 /* See if host is of the form user@host */
474 if (cfg.host[0] != '\0') {
475 char *atsign = strrchr(cfg.host, '@');
476 /* Make sure we're not overflowing the user field */
478 if (atsign - cfg.host < sizeof cfg.username) {
479 strncpy(cfg.username, cfg.host, atsign - cfg.host);
480 cfg.username[atsign - cfg.host] = '\0';
482 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
487 * Perform command-line overrides on session configuration.
489 cmdline_run_saved(&cfg);
492 * Apply subsystem status.
495 cfg.ssh_subsys = TRUE;
498 * Trim a colon suffix off the hostname if it's there.
500 cfg.host[strcspn(cfg.host, ":")] = '\0';
503 * Remove any remaining whitespace from the hostname.
507 while (cfg.host[p2] != '\0') {
508 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
509 cfg.host[p1] = cfg.host[p2];
517 if (!*cfg.remote_cmd_ptr)
518 flags |= FLAG_INTERACTIVE;
521 * Select protocol. This is farmed out into a table in a
522 * separate file to enable an ssh-free variant.
527 for (i = 0; backends[i].backend != NULL; i++)
528 if (backends[i].protocol == cfg.protocol) {
529 back = backends[i].backend;
534 "Internal fault: Unsupported protocol found\n");
542 if (portnumber != -1)
543 cfg.port = portnumber;
546 * Set up the pipe we'll use to tell us about SIGWINCH.
548 if (pipe(signalpipe) < 0) {
552 putty_signal(SIGWINCH, sigwinch);
558 * Start up the connection.
560 logctx = log_init(NULL, &cfg);
561 console_provide_logctx(logctx);
565 /* nodelay is only useful if stdin is a terminal device */
566 int nodelay = cfg.tcp_nodelay && isatty(0);
568 error = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port,
569 &realhost, nodelay, cfg.tcp_keepalives);
571 fprintf(stderr, "Unable to open connection:\n%s\n", error);
574 back->provide_logctx(backhandle, logctx);
575 ldisc = ldisc_create(&cfg, NULL, back, backhandle, NULL);
581 * Set up the initial console mode. We don't care if this call
582 * fails, because we know we aren't necessarily running in a
585 tcgetattr(0, &orig_termios);
586 atexit(cleanup_termios);
587 ldisc_update(NULL, 1, 1);
589 now = GETTICKCOUNT();
592 fd_set rset, wset, xset;
602 FD_SET_MAX(signalpipe[0], maxfd, rset);
604 if (connopen && !sending &&
605 back->socket(backhandle) != NULL &&
606 back->sendok(backhandle) &&
607 back->sendbuffer(backhandle) < MAX_STDIN_BACKLOG) {
608 /* If we're OK to send, then try to read from stdin. */
609 FD_SET_MAX(0, maxfd, rset);
612 if (bufchain_size(&stdout_data) > 0) {
613 /* If we have data for stdout, try to write to stdout. */
614 FD_SET_MAX(1, maxfd, wset);
617 if (bufchain_size(&stderr_data) > 0) {
618 /* If we have data for stderr, try to write to stderr. */
619 FD_SET_MAX(2, maxfd, wset);
622 /* Count the currently active fds. */
624 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
625 fd = next_fd(&fdstate, &rwx)) i++;
627 /* Expand the fdlist buffer if necessary. */
630 fdlist = sresize(fdlist, fdsize, int);
634 * Add all currently open fds to the select sets, and store
635 * them in fdlist as well.
638 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
639 fd = next_fd(&fdstate, &rwx)) {
640 fdlist[fdcount++] = fd;
642 FD_SET_MAX(fd, maxfd, rset);
644 FD_SET_MAX(fd, maxfd, wset);
646 FD_SET_MAX(fd, maxfd, xset);
651 struct timeval tv, *ptv;
653 if (run_timers(now, &next)) {
654 ticks = next - GETTICKCOUNT();
655 if (ticks < 0) ticks = 0; /* just in case */
656 tv.tv_sec = ticks / 1000;
657 tv.tv_usec = ticks % 1000 * 1000;
662 ret = select(maxfd, &rset, &wset, &xset, ptv);
666 now = GETTICKCOUNT();
667 } while (ret < 0 && errno == EINTR);
674 for (i = 0; i < fdcount; i++) {
677 * We must process exceptional notifications before
678 * ordinary readability ones, or we may go straight
679 * past the urgent marker.
681 if (FD_ISSET(fd, &xset))
682 select_result(fd, 4);
683 if (FD_ISSET(fd, &rset))
684 select_result(fd, 1);
685 if (FD_ISSET(fd, &wset))
686 select_result(fd, 2);
689 if (FD_ISSET(signalpipe[0], &rset)) {
692 read(signalpipe[0], c, 1); /* ignore its value; it'll be `x' */
693 if (ioctl(0, TIOCGWINSZ, (void *)&size) >= 0)
694 back->size(backhandle, size.ws_col, size.ws_row);
697 if (FD_ISSET(0, &rset)) {
701 if (connopen && back->socket(backhandle) != NULL) {
702 ret = read(0, buf, sizeof(buf));
704 perror("stdin: read");
706 } else if (ret == 0) {
707 back->special(backhandle, TS_EOF);
708 sending = FALSE; /* send nothing further after this */
710 back->send(backhandle, buf, ret);
715 if (FD_ISSET(1, &wset)) {
719 if (FD_ISSET(2, &wset)) {
723 if ((!connopen || back->socket(backhandle) == NULL) &&
724 bufchain_size(&stdout_data) == 0 &&
725 bufchain_size(&stderr_data) == 0)
726 break; /* we closed the connection */
728 exitcode = back->exitcode(backhandle);
730 fprintf(stderr, "Remote process exit code unavailable\n");
731 exitcode = 1; /* this is an error condition */
733 cleanup_exit(exitcode);
734 return exitcode; /* shouldn't happen, but placates gcc */