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, "X11Display"))
77 return dupstr(getenv("DISPLAY"));
78 if (!strcmp(name, "TermType"))
79 return dupstr(getenv("TERM"));
80 if (!strcmp(name, "UserName"))
81 return get_username();
85 int platform_default_i(const char *name, int def)
87 if (!strcmp(name, "TermWidth") ||
88 !strcmp(name, "TermHeight")) {
90 if (ioctl(0, TIOCGWINSZ, (void *)&size) >= 0)
91 return (!strcmp(name, "TermWidth") ? size.ws_col : size.ws_row);
96 FontSpec platform_default_fontspec(const char *name)
103 Filename platform_default_filename(const char *name)
106 if (!strcmp(name, "LogFileName"))
107 strcpy(ret.path, "putty.log");
113 char *x_get_default(const char *key)
115 return NULL; /* this is a stub */
117 int term_ldisc(Terminal *term, int mode)
121 void ldisc_update(void *frontend, int echo, int edit)
123 /* Update stdin read mode to reflect changes in line discipline. */
129 mode.c_lflag |= ECHO;
131 mode.c_lflag &= ~ECHO;
134 mode.c_lflag |= ISIG | ICANON;
136 mode.c_lflag &= ~(ISIG | ICANON);
138 tcsetattr(0, TCSANOW, &mode);
141 void cleanup_termios(void)
143 tcsetattr(0, TCSANOW, &orig_termios);
146 bufchain stdout_data, stderr_data;
148 void try_output(int is_stderr)
150 bufchain *chain = (is_stderr ? &stderr_data : &stdout_data);
151 int fd = (is_stderr ? 2 : 1);
155 if (bufchain_size(chain) == 0)
158 bufchain_prefix(chain, &senddata, &sendlen);
159 ret = write(fd, senddata, sendlen);
161 bufchain_consume(chain, ret);
163 perror(is_stderr ? "stderr: write" : "stdout: write");
168 int from_backend(void *frontend_handle, int is_stderr,
169 const char *data, int len)
174 bufchain_add(&stderr_data, data, len);
177 bufchain_add(&stdout_data, data, len);
181 osize = bufchain_size(&stdout_data);
182 esize = bufchain_size(&stderr_data);
184 return osize + esize;
189 void sigwinch(int signum)
191 write(signalpipe[1], "x", 1);
195 * In Plink our selects are synchronous, so these functions are
198 int uxsel_input_add(int fd, int rwx) { return 0; }
199 void uxsel_input_remove(int id) { }
202 * Short description of parameters.
204 static void usage(void)
206 printf("PuTTY Link: command-line connection utility\n");
208 printf("Usage: plink [options] [user@]host [command]\n");
209 printf(" (\"host\" can also be a PuTTY saved session name)\n");
210 printf("Options:\n");
211 printf(" -V print version information\n");
212 printf(" -v show verbose messages\n");
213 printf(" -load sessname Load settings from saved session\n");
214 printf(" -ssh -telnet -rlogin -raw\n");
215 printf(" force use of a particular protocol (default SSH)\n");
216 printf(" -P port connect to specified port\n");
217 printf(" -l user connect with specified username\n");
218 printf(" -m file read remote command(s) from file\n");
219 printf(" -batch disable all interactive prompts\n");
220 printf("The following options only apply to SSH connections:\n");
221 printf(" -pw passw login with specified password\n");
222 printf(" -D [listen-IP:]listen-port\n");
223 printf(" Dynamic SOCKS-based port forwarding\n");
224 printf(" -L [listen-IP:]listen-port:host:port\n");
225 printf(" Forward local port to remote address\n");
226 printf(" -R [listen-IP:]listen-port:host:port\n");
227 printf(" Forward remote port to local address\n");
228 printf(" -X -x enable / disable X11 forwarding\n");
229 printf(" -A -a enable / disable agent forwarding\n");
230 printf(" -t -T enable / disable pty allocation\n");
231 printf(" -1 -2 force use of particular protocol version\n");
232 printf(" -C enable compression\n");
233 printf(" -i key private key file for authentication\n");
234 printf(" -s remote command is an SSH subsystem (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;
257 ssh_get_line = console_get_line;
260 fdcount = fdsize = 0;
262 * Initialise port and protocol to sensible defaults. (These
263 * will be overridden by more or less anything.)
265 default_protocol = PROT_SSH;
270 * Process the command line.
272 do_defaults(NULL, &cfg);
273 loaded_session = FALSE;
274 default_protocol = cfg.protocol;
275 default_port = cfg.port;
279 * Override the default protocol if PLINK_PROTOCOL is set.
281 char *p = getenv("PLINK_PROTOCOL");
284 for (i = 0; backends[i].backend != NULL; i++) {
285 if (!strcmp(backends[i].name, p)) {
286 default_protocol = cfg.protocol = backends[i].protocol;
287 default_port = cfg.port =
288 backends[i].backend->default_port;
297 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
301 "plink: option \"%s\" requires an argument\n", p);
303 } else if (ret == 2) {
305 } else if (ret == 1) {
307 } else if (!strcmp(p, "-batch")) {
308 console_batch_mode = 1;
309 } else if (!strcmp(p, "-s")) {
310 /* Save status to write to cfg later. */
312 } else if (!strcmp(p, "-V")) {
314 } else if (!strcmp(p, "-o")) {
317 "plink: option \"-o\" requires an argument\n");
321 provide_xrm_string(*++argv);
324 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
331 do_defaults(NULL, &cfg);
334 * If the hostname starts with "telnet:", set the
335 * protocol to Telnet and process the string as a
338 if (!strncmp(q, "telnet:", 7)) {
342 if (q[0] == '/' && q[1] == '/')
344 cfg.protocol = PROT_TELNET;
346 while (*p && *p != ':' && *p != '/')
355 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
356 cfg.host[sizeof(cfg.host) - 1] = '\0';
360 * Before we process the [user@]host string, we
361 * first check for the presence of a protocol
362 * prefix (a protocol name followed by ",").
367 for (i = 0; backends[i].backend != NULL; i++) {
368 j = strlen(backends[i].name);
370 !memcmp(backends[i].name, p, j)) {
371 default_protocol = cfg.protocol =
372 backends[i].protocol;
374 backends[i].backend->default_port;
382 * Three cases. Either (a) there's a nonzero
383 * length string followed by an @, in which
384 * case that's user and the remainder is host.
385 * Or (b) there's only one string, not counting
386 * a potential initial @, and it exists in the
387 * saved-sessions database. Or (c) only one
388 * string and it _doesn't_ exist in the
393 p++, r = NULL; /* discount initial @ */
399 do_defaults(p, &cfg2);
400 if (loaded_session || cfg2.host[0] == '\0') {
401 /* No settings for this host; use defaults */
402 /* (or session was already loaded with -load) */
403 strncpy(cfg.host, p, sizeof(cfg.host) - 1);
404 cfg.host[sizeof(cfg.host) - 1] = '\0';
405 cfg.port = default_port;
408 /* Ick: patch up internal pointer after copy */
409 cfg.remote_cmd_ptr = cfg.remote_cmd;
413 strncpy(cfg.username, p, sizeof(cfg.username) - 1);
414 cfg.username[sizeof(cfg.username) - 1] = '\0';
415 strncpy(cfg.host, r, sizeof(cfg.host) - 1);
416 cfg.host[sizeof(cfg.host) - 1] = '\0';
417 cfg.port = default_port;
423 cmdlen = cmdsize = 0;
428 if (cmdlen >= cmdsize) {
429 cmdsize = cmdlen + 512;
430 command = sresize(command, cmdsize, char);
432 command[cmdlen++]=*p++;
434 if (cmdlen >= cmdsize) {
435 cmdsize = cmdlen + 512;
436 command = sresize(command, cmdsize, char);
438 command[cmdlen++]=' '; /* always add trailing space */
439 if (--argc) p = *++argv;
441 if (cmdlen) command[--cmdlen]='\0';
442 /* change trailing blank to NUL */
443 cfg.remote_cmd_ptr = command;
444 cfg.remote_cmd_ptr2 = NULL;
445 cfg.nopty = TRUE; /* command => no terminal */
447 break; /* done with cmdline */
460 * Trim leading whitespace off the hostname if it's there.
463 int space = strspn(cfg.host, " \t");
464 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
467 /* See if host is of the form user@host */
468 if (cfg.host[0] != '\0') {
469 char *atsign = strchr(cfg.host, '@');
470 /* Make sure we're not overflowing the user field */
472 if (atsign - cfg.host < sizeof cfg.username) {
473 strncpy(cfg.username, cfg.host, atsign - cfg.host);
474 cfg.username[atsign - cfg.host] = '\0';
476 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
481 * Perform command-line overrides on session configuration.
483 cmdline_run_saved(&cfg);
486 * Apply subsystem status.
489 cfg.ssh_subsys = TRUE;
492 * Trim a colon suffix off the hostname if it's there.
494 cfg.host[strcspn(cfg.host, ":")] = '\0';
497 * Remove any remaining whitespace from the hostname.
501 while (cfg.host[p2] != '\0') {
502 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
503 cfg.host[p1] = cfg.host[p2];
511 if (!*cfg.remote_cmd_ptr)
512 flags |= FLAG_INTERACTIVE;
515 * Select protocol. This is farmed out into a table in a
516 * separate file to enable an ssh-free variant.
521 for (i = 0; backends[i].backend != NULL; i++)
522 if (backends[i].protocol == cfg.protocol) {
523 back = backends[i].backend;
528 "Internal fault: Unsupported protocol found\n");
536 if (portnumber != -1)
537 cfg.port = portnumber;
540 * Set up the pipe we'll use to tell us about SIGWINCH.
542 if (pipe(signalpipe) < 0) {
546 putty_signal(SIGWINCH, sigwinch);
552 * Start up the connection.
554 logctx = log_init(NULL, &cfg);
555 console_provide_logctx(logctx);
559 /* nodelay is only useful if stdin is a terminal device */
560 int nodelay = cfg.tcp_nodelay && isatty(0);
562 error = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port,
563 &realhost, nodelay, cfg.tcp_keepalives);
565 fprintf(stderr, "Unable to open connection:\n%s\n", error);
568 back->provide_logctx(backhandle, logctx);
569 ldisc = ldisc_create(&cfg, NULL, back, backhandle, NULL);
575 * Set up the initial console mode. We don't care if this call
576 * fails, because we know we aren't necessarily running in a
579 tcgetattr(0, &orig_termios);
580 atexit(cleanup_termios);
581 ldisc_update(NULL, 1, 1);
585 fd_set rset, wset, xset;
595 FD_SET_MAX(signalpipe[0], maxfd, rset);
597 if (connopen && !sending &&
598 back->socket(backhandle) != NULL &&
599 back->sendok(backhandle) &&
600 back->sendbuffer(backhandle) < MAX_STDIN_BACKLOG) {
601 /* If we're OK to send, then try to read from stdin. */
602 FD_SET_MAX(0, maxfd, rset);
605 if (bufchain_size(&stdout_data) > 0) {
606 /* If we have data for stdout, try to write to stdout. */
607 FD_SET_MAX(1, maxfd, wset);
610 if (bufchain_size(&stderr_data) > 0) {
611 /* If we have data for stderr, try to write to stderr. */
612 FD_SET_MAX(2, maxfd, wset);
615 /* Count the currently active fds. */
617 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
618 fd = next_fd(&fdstate, &rwx)) i++;
620 /* Expand the fdlist buffer if necessary. */
623 fdlist = sresize(fdlist, fdsize, int);
627 * Add all currently open fds to the select sets, and store
628 * them in fdlist as well.
631 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
632 fd = next_fd(&fdstate, &rwx)) {
633 fdlist[fdcount++] = fd;
635 FD_SET_MAX(fd, maxfd, rset);
637 FD_SET_MAX(fd, maxfd, wset);
639 FD_SET_MAX(fd, maxfd, xset);
643 ret = select(maxfd, &rset, &wset, &xset, NULL);
644 } while (ret < 0 && errno == EINTR);
651 for (i = 0; i < fdcount; i++) {
654 * We must process exceptional notifications before
655 * ordinary readability ones, or we may go straight
656 * past the urgent marker.
658 if (FD_ISSET(fd, &xset))
659 select_result(fd, 4);
660 if (FD_ISSET(fd, &rset))
661 select_result(fd, 1);
662 if (FD_ISSET(fd, &wset))
663 select_result(fd, 2);
666 if (FD_ISSET(signalpipe[0], &rset)) {
669 read(signalpipe[0], c, 1); /* ignore its value; it'll be `x' */
670 if (ioctl(0, TIOCGWINSZ, (void *)&size) >= 0)
671 back->size(backhandle, size.ws_col, size.ws_row);
674 if (FD_ISSET(0, &rset)) {
678 if (connopen && back->socket(backhandle) != NULL) {
679 ret = read(0, buf, sizeof(buf));
681 perror("stdin: read");
683 } else if (ret == 0) {
684 back->special(backhandle, TS_EOF);
685 sending = FALSE; /* send nothing further after this */
687 back->send(backhandle, buf, ret);
692 if (FD_ISSET(1, &wset)) {
696 if (FD_ISSET(2, &wset)) {
700 if ((!connopen || back->socket(backhandle) == NULL) &&
701 bufchain_size(&stdout_data) == 0 &&
702 bufchain_size(&stderr_data) == 0)
703 break; /* we closed the connection */
705 exitcode = back->exitcode(backhandle);
707 fprintf(stderr, "Remote process exit code unavailable\n");
708 exitcode = 1; /* this is an error condition */
710 cleanup_exit(exitcode);
711 return exitcode; /* shouldn't happen, but placates gcc */