2 * PLink - a command-line (stdin/stdout) variant of PuTTY.
15 #include <sys/ioctl.h>
17 #ifndef HAVE_NO_SYS_SELECT_H
18 #include <sys/select.h>
21 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
26 #define MAX_STDIN_BACKLOG 4096
28 void fatalbox(char *p, ...)
31 fprintf(stderr, "FATAL ERROR: ");
33 vfprintf(stderr, p, ap);
38 void modalfatalbox(char *p, ...)
41 fprintf(stderr, "FATAL ERROR: ");
43 vfprintf(stderr, p, ap);
48 void connection_fatal(void *frontend, char *p, ...)
51 fprintf(stderr, "FATAL ERROR: ");
53 vfprintf(stderr, p, ap);
58 void cmdline_error(char *p, ...)
61 fprintf(stderr, "plink: ");
63 vfprintf(stderr, p, ap);
69 static int local_tty = 0; /* do we have a local tty? */
70 static struct termios orig_termios;
73 static void *backhandle;
77 * Default settings that are specific to pterm.
79 char *platform_default_s(const char *name)
81 if (!strcmp(name, "TermType"))
82 return dupstr(getenv("TERM"));
83 if (!strcmp(name, "UserName"))
84 return get_username();
88 int platform_default_i(const char *name, int def)
90 if (!strcmp(name, "TermWidth") ||
91 !strcmp(name, "TermHeight")) {
93 if (ioctl(0, TIOCGWINSZ, (void *)&size) >= 0)
94 return (!strcmp(name, "TermWidth") ? size.ws_col : size.ws_row);
99 FontSpec platform_default_fontspec(const char *name)
106 Filename platform_default_filename(const char *name)
109 if (!strcmp(name, "LogFileName"))
110 strcpy(ret.path, "putty.log");
116 char *x_get_default(const char *key)
118 return NULL; /* this is a stub */
120 int term_ldisc(Terminal *term, int mode)
124 void ldisc_update(void *frontend, int echo, int edit)
126 /* Update stdin read mode to reflect changes in line discipline. */
129 if (!local_tty) return;
134 mode.c_lflag |= ECHO;
136 mode.c_lflag &= ~ECHO;
139 mode.c_iflag |= ICRNL;
140 mode.c_lflag |= ISIG | ICANON;
141 mode.c_oflag |= OPOST;
143 mode.c_iflag &= ~ICRNL;
144 mode.c_lflag &= ~(ISIG | ICANON);
145 mode.c_oflag &= ~OPOST;
146 /* Solaris sets these to unhelpful values */
148 mode.c_cc[VTIME] = 0;
149 /* FIXME: perhaps what we do with IXON/IXOFF should be an
150 * argument to ldisc_update(), to allow implementation of SSH-2
151 * "xon-xoff" and Rlogin's equivalent? */
152 mode.c_iflag &= ~IXON;
153 mode.c_iflag &= ~IXOFF;
156 * Mark parity errors and (more important) BREAK on input. This
157 * is more complex than it need be because POSIX-2001 suggests
158 * that escaping of valid 0xff in the input stream is dependent on
159 * IGNPAR being clear even though marking of BREAK isn't. NetBSD
160 * 2.0 goes one worse and makes it dependent on INPCK too. We
161 * deal with this by forcing these flags into a useful state and
162 * then faking the state in which we found them in from_tty() if
163 * we get passed a parity or framing error.
165 mode.c_iflag = (mode.c_iflag | INPCK | PARMRK) & ~IGNPAR;
167 tcsetattr(0, TCSANOW, &mode);
170 /* Helper function to extract a special character from a termios. */
171 static char *get_ttychar(struct termios *t, int index)
173 cc_t c = t->c_cc[index];
174 #if defined(_POSIX_VDISABLE)
175 if (c == _POSIX_VDISABLE)
176 return dupprintf("");
178 return dupprintf("^<%d>", c);
181 char *get_ttymode(void *frontend, const char *mode)
184 * Propagate appropriate terminal modes from the local terminal,
187 if (!local_tty) return NULL;
189 #define GET_CHAR(ourname, uxname) \
191 if (strcmp(mode, ourname) == 0) \
192 return get_ttychar(&orig_termios, uxname); \
194 #define GET_BOOL(ourname, uxname, uxmemb, transform) \
196 if (strcmp(mode, ourname) == 0) { \
197 int b = (orig_termios.uxmemb & uxname) != 0; \
199 return dupprintf("%d", b); \
204 * Modes that want to be the same on all terminal devices involved.
206 /* All the special characters supported by SSH */
208 GET_CHAR("INTR", VINTR);
211 GET_CHAR("QUIT", VQUIT);
214 GET_CHAR("ERASE", VERASE);
217 GET_CHAR("KILL", VKILL);
220 GET_CHAR("EOF", VEOF);
223 GET_CHAR("EOL", VEOL);
226 GET_CHAR("EOL2", VEOL2);
229 GET_CHAR("START", VSTART);
232 GET_CHAR("STOP", VSTOP);
235 GET_CHAR("SUSP", VSUSP);
238 GET_CHAR("DSUSP", VDSUSP);
240 #if defined(VREPRINT)
241 GET_CHAR("REPRINT", VREPRINT);
244 GET_CHAR("WERASE", VWERASE);
247 GET_CHAR("LNEXT", VLNEXT);
250 GET_CHAR("FLUSH", VFLUSH);
253 GET_CHAR("SWTCH", VSWTCH);
256 GET_CHAR("STATUS", VSTATUS);
258 #if defined(VDISCARD)
259 GET_CHAR("DISCARD", VDISCARD);
261 /* Modes that "configure" other major modes. These should probably be
262 * considered as user preferences. */
263 /* Configuration of ICANON */
265 GET_BOOL("ECHOK", ECHOK, c_lflag, );
268 GET_BOOL("ECHOKE", ECHOKE, c_lflag, );
271 GET_BOOL("ECHOE", ECHOE, c_lflag, );
274 GET_BOOL("ECHONL", ECHONL, c_lflag, );
277 GET_BOOL("XCASE", XCASE, c_lflag, );
279 /* Configuration of ECHO */
281 GET_BOOL("ECHOCTL", ECHOCTL, c_lflag, );
283 /* Configuration of IXON/IXOFF */
285 GET_BOOL("IXANY", IXANY, c_iflag, );
287 /* Configuration of OPOST */
289 GET_BOOL("OLCUC", OLCUC, c_oflag, );
292 GET_BOOL("ONLCR", ONLCR, c_oflag, );
295 GET_BOOL("OCRNL", OCRNL, c_oflag, );
298 GET_BOOL("ONOCR", ONOCR, c_oflag, );
301 GET_BOOL("ONLRET", ONLRET, c_oflag, );
305 * Modes that want to be set in only one place, and that we have
309 GET_BOOL("ISIG", ISIG, c_lflag, );
312 GET_BOOL("ICANON", ICANON, c_lflag, );
315 GET_BOOL("ECHO", ECHO, c_lflag, );
318 GET_BOOL("IXON", IXON, c_iflag, );
321 GET_BOOL("IXOFF", IXOFF, c_iflag, );
324 GET_BOOL("OPOST", OPOST, c_oflag, );
328 * We do not propagate the following modes:
329 * - Parity/serial settings, which are a local affair and don't
330 * make sense propagated over SSH's 8-bit byte-stream.
331 * IGNPAR PARMRK INPCK CS7 CS8 PARENB PARODD
332 * - Things that want to be enabled in one place that we don't
337 * - Things I don't know what to do with. (FIXME)
338 * ISTRIP IMAXBEL NOFLSH TOSTOP IEXTEN
345 /* Fall through to here for unrecognised names, or ones that are
346 * unsupported on this platform */
350 void cleanup_termios(void)
353 tcsetattr(0, TCSANOW, &orig_termios);
356 bufchain stdout_data, stderr_data;
358 void try_output(int is_stderr)
360 bufchain *chain = (is_stderr ? &stderr_data : &stdout_data);
361 int fd = (is_stderr ? 2 : 1);
365 if (bufchain_size(chain) == 0)
368 bufchain_prefix(chain, &senddata, &sendlen);
369 ret = write(fd, senddata, sendlen);
371 bufchain_consume(chain, ret);
373 perror(is_stderr ? "stderr: write" : "stdout: write");
378 int from_backend(void *frontend_handle, int is_stderr,
379 const char *data, int len)
384 bufchain_add(&stderr_data, data, len);
387 bufchain_add(&stdout_data, data, len);
391 osize = bufchain_size(&stdout_data);
392 esize = bufchain_size(&stderr_data);
394 return osize + esize;
397 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
400 * No "untrusted" output should get here (the way the code is
401 * currently, it's all diverted by FLAG_STDERR).
403 assert(!"Unexpected call to from_backend_untrusted()");
404 return 0; /* not reached */
407 int get_userpass_input(prompts_t *p, unsigned char *in, int inlen)
410 ret = cmdline_get_passwd_input(p, in, inlen);
412 ret = console_get_userpass_input(p, in, inlen);
417 * Handle data from a local tty in PARMRK format.
419 static void from_tty(void *buf, unsigned len)
422 static enum {NORMAL, FF, FF00} state = NORMAL;
424 p = buf; end = buf + len;
432 q = memchr(p, '\xff', end - p);
433 if (q == NULL) q = end;
434 back->send(backhandle, p, q - p);
440 back->send(backhandle, p, 1);
443 } else if (*p == '\0') {
450 back->special(backhandle, TS_BRK);
453 * Pretend that PARMRK wasn't set. This involves
454 * faking what INPCK and IGNPAR would have done if
455 * we hadn't overridden them. Unfortunately, we
456 * can't do this entirely correctly because INPCK
457 * distinguishes between framing and parity
458 * errors, but PARMRK format represents both in
459 * the same way. We assume that parity errors are
460 * more common than framing errors, and hence
461 * treat all input errors as being subject to
464 if (orig_termios.c_iflag & INPCK) {
465 /* If IGNPAR is set, we throw away the character. */
466 if (!(orig_termios.c_iflag & IGNPAR)) {
467 /* PE/FE get passed on as NUL. */
469 back->send(backhandle, p, 1);
472 /* INPCK not set. Assume we got a parity error. */
473 back->send(backhandle, p, 1);
484 void sigwinch(int signum)
486 write(signalpipe[1], "x", 1);
490 * In Plink our selects are synchronous, so these functions are
493 int uxsel_input_add(int fd, int rwx) { return 0; }
494 void uxsel_input_remove(int id) { }
497 * Short description of parameters.
499 static void usage(void)
501 printf("PuTTY Link: command-line connection utility\n");
503 printf("Usage: plink [options] [user@]host [command]\n");
504 printf(" (\"host\" can also be a PuTTY saved session name)\n");
505 printf("Options:\n");
506 printf(" -V print version information and exit\n");
507 printf(" -pgpfp print PGP key fingerprints and exit\n");
508 printf(" -v show verbose messages\n");
509 printf(" -load sessname Load settings from saved session\n");
510 printf(" -ssh -telnet -rlogin -raw\n");
511 printf(" force use of a particular protocol\n");
512 printf(" -P port connect to specified port\n");
513 printf(" -l user connect with specified username\n");
514 printf(" -batch disable all interactive prompts\n");
515 printf("The following options only apply to SSH connections:\n");
516 printf(" -pw passw login with specified password\n");
517 printf(" -D [listen-IP:]listen-port\n");
518 printf(" Dynamic SOCKS-based port forwarding\n");
519 printf(" -L [listen-IP:]listen-port:host:port\n");
520 printf(" Forward local port to remote address\n");
521 printf(" -R [listen-IP:]listen-port:host:port\n");
522 printf(" Forward remote port to local address\n");
523 printf(" -X -x enable / disable X11 forwarding\n");
524 printf(" -A -a enable / disable agent forwarding\n");
525 printf(" -t -T enable / disable pty allocation\n");
526 printf(" -1 -2 force use of particular protocol version\n");
527 printf(" -4 -6 force use of IPv4 or IPv6\n");
528 printf(" -C enable compression\n");
529 printf(" -i key private key file for authentication\n");
530 printf(" -m file read remote command(s) from file\n");
531 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
532 printf(" -N don't start a shell/command (SSH-2 only)\n");
536 static void version(void)
538 printf("plink: %s\n", ver);
542 int main(int argc, char **argv)
548 int i, fdcount, fdsize, fdstate;
552 int use_subsystem = 0;
553 void *ldisc, *logctx;
557 fdcount = fdsize = 0;
559 * Initialise port and protocol to sensible defaults. (These
560 * will be overridden by more or less anything.)
562 default_protocol = PROT_SSH;
567 * Process the command line.
569 do_defaults(NULL, &cfg);
570 loaded_session = FALSE;
571 default_protocol = cfg.protocol;
572 default_port = cfg.port;
576 * Override the default protocol if PLINK_PROTOCOL is set.
578 char *p = getenv("PLINK_PROTOCOL");
581 for (i = 0; backends[i].backend != NULL; i++) {
582 if (!strcmp(backends[i].name, p)) {
583 default_protocol = cfg.protocol = backends[i].protocol;
584 default_port = cfg.port =
585 backends[i].backend->default_port;
594 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
598 "plink: option \"%s\" requires an argument\n", p);
600 } else if (ret == 2) {
602 } else if (ret == 1) {
604 } else if (!strcmp(p, "-batch")) {
605 console_batch_mode = 1;
606 } else if (!strcmp(p, "-s")) {
607 /* Save status to write to cfg later. */
609 } else if (!strcmp(p, "-V")) {
611 } else if (!strcmp(p, "-pgpfp")) {
614 } else if (!strcmp(p, "-o")) {
617 "plink: option \"-o\" requires an argument\n");
621 provide_xrm_string(*++argv);
624 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
632 * If the hostname starts with "telnet:", set the
633 * protocol to Telnet and process the string as a
636 if (!strncmp(q, "telnet:", 7)) {
640 if (q[0] == '/' && q[1] == '/')
642 cfg.protocol = PROT_TELNET;
644 while (*p && *p != ':' && *p != '/')
653 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
654 cfg.host[sizeof(cfg.host) - 1] = '\0';
656 char *r, *user, *host;
658 * Before we process the [user@]host string, we
659 * first check for the presence of a protocol
660 * prefix (a protocol name followed by ",").
665 for (i = 0; backends[i].backend != NULL; i++) {
666 j = strlen(backends[i].name);
668 !memcmp(backends[i].name, p, j)) {
669 default_protocol = cfg.protocol =
670 backends[i].protocol;
672 backends[i].backend->default_port;
680 * A nonzero length string followed by an @ is treated
681 * as a username. (We discount an _initial_ @.) The
682 * rest of the string (or the whole string if no @)
683 * is treated as a session name and/or hostname.
687 p++, r = NULL; /* discount initial @ */
692 user = NULL, host = p;
696 * Now attempt to load a saved session with the
697 * same name as the hostname.
701 do_defaults(host, &cfg2);
702 if (loaded_session || cfg2.host[0] == '\0') {
703 /* No settings for this host; use defaults */
704 /* (or session was already loaded with -load) */
705 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
706 cfg.host[sizeof(cfg.host) - 1] = '\0';
707 cfg.port = default_port;
714 /* Patch in specified username. */
715 strncpy(cfg.username, user,
716 sizeof(cfg.username) - 1);
717 cfg.username[sizeof(cfg.username) - 1] = '\0';
724 cmdlen = cmdsize = 0;
729 if (cmdlen >= cmdsize) {
730 cmdsize = cmdlen + 512;
731 command = sresize(command, cmdsize, char);
733 command[cmdlen++]=*p++;
735 if (cmdlen >= cmdsize) {
736 cmdsize = cmdlen + 512;
737 command = sresize(command, cmdsize, char);
739 command[cmdlen++]=' '; /* always add trailing space */
740 if (--argc) p = *++argv;
742 if (cmdlen) command[--cmdlen]='\0';
743 /* change trailing blank to NUL */
744 cfg.remote_cmd_ptr = command;
745 cfg.remote_cmd_ptr2 = NULL;
746 cfg.nopty = TRUE; /* command => no terminal */
748 break; /* done with cmdline */
761 * Trim leading whitespace off the hostname if it's there.
764 int space = strspn(cfg.host, " \t");
765 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
768 /* See if host is of the form user@host */
769 if (cfg.host[0] != '\0') {
770 char *atsign = strrchr(cfg.host, '@');
771 /* Make sure we're not overflowing the user field */
773 if (atsign - cfg.host < sizeof cfg.username) {
774 strncpy(cfg.username, cfg.host, atsign - cfg.host);
775 cfg.username[atsign - cfg.host] = '\0';
777 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
782 * Perform command-line overrides on session configuration.
784 cmdline_run_saved(&cfg);
787 * Apply subsystem status.
790 cfg.ssh_subsys = TRUE;
793 * Trim a colon suffix off the hostname if it's there.
795 cfg.host[strcspn(cfg.host, ":")] = '\0';
798 * Remove any remaining whitespace from the hostname.
802 while (cfg.host[p2] != '\0') {
803 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
804 cfg.host[p1] = cfg.host[p2];
812 if (!cfg.remote_cmd_ptr && !*cfg.remote_cmd)
813 flags |= FLAG_INTERACTIVE;
816 * Select protocol. This is farmed out into a table in a
817 * separate file to enable an ssh-free variant.
822 for (i = 0; backends[i].backend != NULL; i++)
823 if (backends[i].protocol == cfg.protocol) {
824 back = backends[i].backend;
829 "Internal fault: Unsupported protocol found\n");
837 if (portnumber != -1)
838 cfg.port = portnumber;
841 * Set up the pipe we'll use to tell us about SIGWINCH.
843 if (pipe(signalpipe) < 0) {
847 putty_signal(SIGWINCH, sigwinch);
853 * Start up the connection.
855 logctx = log_init(NULL, &cfg);
856 console_provide_logctx(logctx);
860 /* nodelay is only useful if stdin is a terminal device */
861 int nodelay = cfg.tcp_nodelay && isatty(0);
863 error = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port,
864 &realhost, nodelay, cfg.tcp_keepalives);
866 fprintf(stderr, "Unable to open connection:\n%s\n", error);
869 back->provide_logctx(backhandle, logctx);
870 ldisc = ldisc_create(&cfg, NULL, back, backhandle, NULL);
876 * Set up the initial console mode. We don't care if this call
877 * fails, because we know we aren't necessarily running in a
880 local_tty = (tcgetattr(0, &orig_termios) == 0);
881 atexit(cleanup_termios);
882 ldisc_update(NULL, 1, 1);
884 now = GETTICKCOUNT();
887 fd_set rset, wset, xset;
897 FD_SET_MAX(signalpipe[0], maxfd, rset);
899 if (connopen && !sending &&
900 back->socket(backhandle) != NULL &&
901 back->sendok(backhandle) &&
902 back->sendbuffer(backhandle) < MAX_STDIN_BACKLOG) {
903 /* If we're OK to send, then try to read from stdin. */
904 FD_SET_MAX(0, maxfd, rset);
907 if (bufchain_size(&stdout_data) > 0) {
908 /* If we have data for stdout, try to write to stdout. */
909 FD_SET_MAX(1, maxfd, wset);
912 if (bufchain_size(&stderr_data) > 0) {
913 /* If we have data for stderr, try to write to stderr. */
914 FD_SET_MAX(2, maxfd, wset);
917 /* Count the currently active fds. */
919 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
920 fd = next_fd(&fdstate, &rwx)) i++;
922 /* Expand the fdlist buffer if necessary. */
925 fdlist = sresize(fdlist, fdsize, int);
929 * Add all currently open fds to the select sets, and store
930 * them in fdlist as well.
933 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
934 fd = next_fd(&fdstate, &rwx)) {
935 fdlist[fdcount++] = fd;
937 FD_SET_MAX(fd, maxfd, rset);
939 FD_SET_MAX(fd, maxfd, wset);
941 FD_SET_MAX(fd, maxfd, xset);
946 struct timeval tv, *ptv;
948 if (run_timers(now, &next)) {
949 ticks = next - GETTICKCOUNT();
950 if (ticks < 0) ticks = 0; /* just in case */
951 tv.tv_sec = ticks / 1000;
952 tv.tv_usec = ticks % 1000 * 1000;
957 ret = select(maxfd, &rset, &wset, &xset, ptv);
961 long newnow = GETTICKCOUNT();
963 * Check to see whether the system clock has
964 * changed massively during the select.
966 if (newnow - now < 0 || newnow - now > next - now) {
968 * If so, look at the elapsed time in the
969 * select and use it to compute a new
972 long othernow = now + tv.tv_sec * 1000 + tv.tv_usec / 1000;
973 /* So we'd like GETTICKCOUNT to have returned othernow,
974 * but instead it return newnow. Hence ... */
975 tickcount_offset += othernow - newnow;
981 } while (ret < 0 && errno == EINTR);
988 for (i = 0; i < fdcount; i++) {
991 * We must process exceptional notifications before
992 * ordinary readability ones, or we may go straight
993 * past the urgent marker.
995 if (FD_ISSET(fd, &xset))
996 select_result(fd, 4);
997 if (FD_ISSET(fd, &rset))
998 select_result(fd, 1);
999 if (FD_ISSET(fd, &wset))
1000 select_result(fd, 2);
1003 if (FD_ISSET(signalpipe[0], &rset)) {
1005 struct winsize size;
1006 read(signalpipe[0], c, 1); /* ignore its value; it'll be `x' */
1007 if (ioctl(0, TIOCGWINSZ, (void *)&size) >= 0)
1008 back->size(backhandle, size.ws_col, size.ws_row);
1011 if (FD_ISSET(0, &rset)) {
1015 if (connopen && back->socket(backhandle) != NULL) {
1016 ret = read(0, buf, sizeof(buf));
1018 perror("stdin: read");
1020 } else if (ret == 0) {
1021 back->special(backhandle, TS_EOF);
1022 sending = FALSE; /* send nothing further after this */
1027 back->send(backhandle, buf, ret);
1032 if (FD_ISSET(1, &wset)) {
1036 if (FD_ISSET(2, &wset)) {
1040 if ((!connopen || back->socket(backhandle) == NULL) &&
1041 bufchain_size(&stdout_data) == 0 &&
1042 bufchain_size(&stderr_data) == 0)
1043 break; /* we closed the connection */
1045 exitcode = back->exitcode(backhandle);
1047 fprintf(stderr, "Remote process exit code unavailable\n");
1048 exitcode = 1; /* this is an error condition */
1050 cleanup_exit(exitcode);
1051 return exitcode; /* shouldn't happen, but placates gcc */