Explicitly set MIN and TIME when in raw mode to request single characters
[sgt/putty] / unix / uxplink.c
1 /*
2 * PLink - a command-line (stdin/stdout) variant of PuTTY.
3 */
4
5 #include <stdio.h>
6 #include <stdlib.h>
7 #include <errno.h>
8 #include <assert.h>
9 #include <stdarg.h>
10 #include <signal.h>
11 #include <unistd.h>
12 #include <fcntl.h>
13 #include <termios.h>
14 #include <pwd.h>
15 #include <sys/ioctl.h>
16 #include <sys/select.h>
17
18 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
19 #include "putty.h"
20 #include "storage.h"
21 #include "tree234.h"
22
23 #define MAX_STDIN_BACKLOG 4096
24
25 void fatalbox(char *p, ...)
26 {
27 va_list ap;
28 fprintf(stderr, "FATAL ERROR: ");
29 va_start(ap, p);
30 vfprintf(stderr, p, ap);
31 va_end(ap);
32 fputc('\n', stderr);
33 cleanup_exit(1);
34 }
35 void modalfatalbox(char *p, ...)
36 {
37 va_list ap;
38 fprintf(stderr, "FATAL ERROR: ");
39 va_start(ap, p);
40 vfprintf(stderr, p, ap);
41 va_end(ap);
42 fputc('\n', stderr);
43 cleanup_exit(1);
44 }
45 void connection_fatal(void *frontend, char *p, ...)
46 {
47 va_list ap;
48 fprintf(stderr, "FATAL ERROR: ");
49 va_start(ap, p);
50 vfprintf(stderr, p, ap);
51 va_end(ap);
52 fputc('\n', stderr);
53 cleanup_exit(1);
54 }
55 void cmdline_error(char *p, ...)
56 {
57 va_list ap;
58 fprintf(stderr, "plink: ");
59 va_start(ap, p);
60 vfprintf(stderr, p, ap);
61 va_end(ap);
62 fputc('\n', stderr);
63 exit(1);
64 }
65
66 struct termios orig_termios;
67
68 static Backend *back;
69 static void *backhandle;
70 static Config cfg;
71
72 /*
73 * Default settings that are specific to pterm.
74 */
75 char *platform_default_s(const char *name)
76 {
77 if (!strcmp(name, "TermType"))
78 return dupstr(getenv("TERM"));
79 if (!strcmp(name, "UserName"))
80 return get_username();
81 return NULL;
82 }
83
84 int platform_default_i(const char *name, int def)
85 {
86 if (!strcmp(name, "TermWidth") ||
87 !strcmp(name, "TermHeight")) {
88 struct winsize size;
89 if (ioctl(0, TIOCGWINSZ, (void *)&size) >= 0)
90 return (!strcmp(name, "TermWidth") ? size.ws_col : size.ws_row);
91 }
92 return def;
93 }
94
95 FontSpec platform_default_fontspec(const char *name)
96 {
97 FontSpec ret;
98 *ret.name = '\0';
99 return ret;
100 }
101
102 Filename platform_default_filename(const char *name)
103 {
104 Filename ret;
105 if (!strcmp(name, "LogFileName"))
106 strcpy(ret.path, "putty.log");
107 else
108 *ret.path = '\0';
109 return ret;
110 }
111
112 char *x_get_default(const char *key)
113 {
114 return NULL; /* this is a stub */
115 }
116 int term_ldisc(Terminal *term, int mode)
117 {
118 return FALSE;
119 }
120 void ldisc_update(void *frontend, int echo, int edit)
121 {
122 /* Update stdin read mode to reflect changes in line discipline. */
123 struct termios mode;
124
125 mode = orig_termios;
126
127 if (echo)
128 mode.c_lflag |= ECHO;
129 else
130 mode.c_lflag &= ~ECHO;
131
132 if (edit) {
133 mode.c_iflag |= ICRNL;
134 mode.c_lflag |= ISIG | ICANON;
135 } else {
136 mode.c_iflag &= ~ICRNL;
137 mode.c_lflag &= ~(ISIG | ICANON);
138 mode.c_cc[VMIN] = 1;
139 mode.c_cc[VTIME] = 0;
140 }
141
142 tcsetattr(0, TCSANOW, &mode);
143 }
144
145 void cleanup_termios(void)
146 {
147 tcsetattr(0, TCSANOW, &orig_termios);
148 }
149
150 bufchain stdout_data, stderr_data;
151
152 void try_output(int is_stderr)
153 {
154 bufchain *chain = (is_stderr ? &stderr_data : &stdout_data);
155 int fd = (is_stderr ? 2 : 1);
156 void *senddata;
157 int sendlen, ret;
158
159 if (bufchain_size(chain) == 0)
160 return;
161
162 bufchain_prefix(chain, &senddata, &sendlen);
163 ret = write(fd, senddata, sendlen);
164 if (ret > 0)
165 bufchain_consume(chain, ret);
166 else if (ret < 0) {
167 perror(is_stderr ? "stderr: write" : "stdout: write");
168 exit(1);
169 }
170 }
171
172 int from_backend(void *frontend_handle, int is_stderr,
173 const char *data, int len)
174 {
175 int osize, esize;
176
177 if (is_stderr) {
178 bufchain_add(&stderr_data, data, len);
179 try_output(1);
180 } else {
181 bufchain_add(&stdout_data, data, len);
182 try_output(0);
183 }
184
185 osize = bufchain_size(&stdout_data);
186 esize = bufchain_size(&stderr_data);
187
188 return osize + esize;
189 }
190
191 int signalpipe[2];
192
193 void sigwinch(int signum)
194 {
195 write(signalpipe[1], "x", 1);
196 }
197
198 /*
199 * In Plink our selects are synchronous, so these functions are
200 * empty stubs.
201 */
202 int uxsel_input_add(int fd, int rwx) { return 0; }
203 void uxsel_input_remove(int id) { }
204
205 /*
206 * Short description of parameters.
207 */
208 static void usage(void)
209 {
210 printf("PuTTY Link: command-line connection utility\n");
211 printf("%s\n", ver);
212 printf("Usage: plink [options] [user@]host [command]\n");
213 printf(" (\"host\" can also be a PuTTY saved session name)\n");
214 printf("Options:\n");
215 printf(" -V print version information\n");
216 printf(" -v show verbose messages\n");
217 printf(" -load sessname Load settings from saved session\n");
218 printf(" -ssh -telnet -rlogin -raw\n");
219 printf(" force use of a particular protocol\n");
220 printf(" -P port connect to specified port\n");
221 printf(" -l user connect with specified username\n");
222 printf(" -batch disable all interactive prompts\n");
223 printf("The following options only apply to SSH connections:\n");
224 printf(" -pw passw login with specified password\n");
225 printf(" -D [listen-IP:]listen-port\n");
226 printf(" Dynamic SOCKS-based port forwarding\n");
227 printf(" -L [listen-IP:]listen-port:host:port\n");
228 printf(" Forward local port to remote address\n");
229 printf(" -R [listen-IP:]listen-port:host:port\n");
230 printf(" Forward remote port to local address\n");
231 printf(" -X -x enable / disable X11 forwarding\n");
232 printf(" -A -a enable / disable agent forwarding\n");
233 printf(" -t -T enable / disable pty allocation\n");
234 printf(" -1 -2 force use of particular protocol version\n");
235 printf(" -4 -6 force use of IPv4 or IPv6\n");
236 printf(" -C enable compression\n");
237 printf(" -i key private key file for authentication\n");
238 printf(" -m file read remote command(s) from file\n");
239 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
240 printf(" -N don't start a shell/command (SSH-2 only)\n");
241 exit(1);
242 }
243
244 static void version(void)
245 {
246 printf("plink: %s\n", ver);
247 exit(1);
248 }
249
250 int main(int argc, char **argv)
251 {
252 int sending;
253 int portnumber = -1;
254 int *fdlist;
255 int fd;
256 int i, fdcount, fdsize, fdstate;
257 int connopen;
258 int exitcode;
259 int errors;
260 int use_subsystem = 0;
261 void *ldisc, *logctx;
262 long now;
263
264 ssh_get_line = console_get_line;
265
266 fdlist = NULL;
267 fdcount = fdsize = 0;
268 /*
269 * Initialise port and protocol to sensible defaults. (These
270 * will be overridden by more or less anything.)
271 */
272 default_protocol = PROT_SSH;
273 default_port = 22;
274
275 flags = FLAG_STDERR;
276 /*
277 * Process the command line.
278 */
279 do_defaults(NULL, &cfg);
280 loaded_session = FALSE;
281 default_protocol = cfg.protocol;
282 default_port = cfg.port;
283 errors = 0;
284 {
285 /*
286 * Override the default protocol if PLINK_PROTOCOL is set.
287 */
288 char *p = getenv("PLINK_PROTOCOL");
289 int i;
290 if (p) {
291 for (i = 0; backends[i].backend != NULL; i++) {
292 if (!strcmp(backends[i].name, p)) {
293 default_protocol = cfg.protocol = backends[i].protocol;
294 default_port = cfg.port =
295 backends[i].backend->default_port;
296 break;
297 }
298 }
299 }
300 }
301 while (--argc) {
302 char *p = *++argv;
303 if (*p == '-') {
304 int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
305 1, &cfg);
306 if (ret == -2) {
307 fprintf(stderr,
308 "plink: option \"%s\" requires an argument\n", p);
309 errors = 1;
310 } else if (ret == 2) {
311 --argc, ++argv;
312 } else if (ret == 1) {
313 continue;
314 } else if (!strcmp(p, "-batch")) {
315 console_batch_mode = 1;
316 } else if (!strcmp(p, "-s")) {
317 /* Save status to write to cfg later. */
318 use_subsystem = 1;
319 } else if (!strcmp(p, "-V")) {
320 version();
321 } else if (!strcmp(p, "-o")) {
322 if (argc <= 1) {
323 fprintf(stderr,
324 "plink: option \"-o\" requires an argument\n");
325 errors = 1;
326 } else {
327 --argc;
328 provide_xrm_string(*++argv);
329 }
330 } else {
331 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
332 errors = 1;
333 }
334 } else if (*p) {
335 if (!*cfg.host) {
336 char *q = p;
337
338 do_defaults(NULL, &cfg);
339
340 /*
341 * If the hostname starts with "telnet:", set the
342 * protocol to Telnet and process the string as a
343 * Telnet URL.
344 */
345 if (!strncmp(q, "telnet:", 7)) {
346 char c;
347
348 q += 7;
349 if (q[0] == '/' && q[1] == '/')
350 q += 2;
351 cfg.protocol = PROT_TELNET;
352 p = q;
353 while (*p && *p != ':' && *p != '/')
354 p++;
355 c = *p;
356 if (*p)
357 *p++ = '\0';
358 if (c == ':')
359 cfg.port = atoi(p);
360 else
361 cfg.port = -1;
362 strncpy(cfg.host, q, sizeof(cfg.host) - 1);
363 cfg.host[sizeof(cfg.host) - 1] = '\0';
364 } else {
365 char *r, *user, *host;
366 /*
367 * Before we process the [user@]host string, we
368 * first check for the presence of a protocol
369 * prefix (a protocol name followed by ",").
370 */
371 r = strchr(p, ',');
372 if (r) {
373 int i, j;
374 for (i = 0; backends[i].backend != NULL; i++) {
375 j = strlen(backends[i].name);
376 if (j == r - p &&
377 !memcmp(backends[i].name, p, j)) {
378 default_protocol = cfg.protocol =
379 backends[i].protocol;
380 portnumber =
381 backends[i].backend->default_port;
382 p = r + 1;
383 break;
384 }
385 }
386 }
387
388 /*
389 * A nonzero length string followed by an @ is treated
390 * as a username. (We discount an _initial_ @.) The
391 * rest of the string (or the whole string if no @)
392 * is treated as a session name and/or hostname.
393 */
394 r = strrchr(p, '@');
395 if (r == p)
396 p++, r = NULL; /* discount initial @ */
397 if (r) {
398 *r++ = '\0';
399 user = p, host = r;
400 } else {
401 user = NULL, host = p;
402 }
403
404 /*
405 * Now attempt to load a saved session with the
406 * same name as the hostname.
407 */
408 {
409 Config cfg2;
410 do_defaults(host, &cfg2);
411 if (loaded_session || cfg2.host[0] == '\0') {
412 /* No settings for this host; use defaults */
413 /* (or session was already loaded with -load) */
414 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
415 cfg.host[sizeof(cfg.host) - 1] = '\0';
416 cfg.port = default_port;
417 } else {
418 cfg = cfg2;
419 }
420 }
421
422 if (user) {
423 /* Patch in specified username. */
424 strncpy(cfg.username, user,
425 sizeof(cfg.username) - 1);
426 cfg.username[sizeof(cfg.username) - 1] = '\0';
427 }
428
429 }
430 } else {
431 char *command;
432 int cmdlen, cmdsize;
433 cmdlen = cmdsize = 0;
434 command = NULL;
435
436 while (argc) {
437 while (*p) {
438 if (cmdlen >= cmdsize) {
439 cmdsize = cmdlen + 512;
440 command = sresize(command, cmdsize, char);
441 }
442 command[cmdlen++]=*p++;
443 }
444 if (cmdlen >= cmdsize) {
445 cmdsize = cmdlen + 512;
446 command = sresize(command, cmdsize, char);
447 }
448 command[cmdlen++]=' '; /* always add trailing space */
449 if (--argc) p = *++argv;
450 }
451 if (cmdlen) command[--cmdlen]='\0';
452 /* change trailing blank to NUL */
453 cfg.remote_cmd_ptr = command;
454 cfg.remote_cmd_ptr2 = NULL;
455 cfg.nopty = TRUE; /* command => no terminal */
456
457 break; /* done with cmdline */
458 }
459 }
460 }
461
462 if (errors)
463 return 1;
464
465 if (!*cfg.host) {
466 usage();
467 }
468
469 /*
470 * Trim leading whitespace off the hostname if it's there.
471 */
472 {
473 int space = strspn(cfg.host, " \t");
474 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
475 }
476
477 /* See if host is of the form user@host */
478 if (cfg.host[0] != '\0') {
479 char *atsign = strrchr(cfg.host, '@');
480 /* Make sure we're not overflowing the user field */
481 if (atsign) {
482 if (atsign - cfg.host < sizeof cfg.username) {
483 strncpy(cfg.username, cfg.host, atsign - cfg.host);
484 cfg.username[atsign - cfg.host] = '\0';
485 }
486 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
487 }
488 }
489
490 /*
491 * Perform command-line overrides on session configuration.
492 */
493 cmdline_run_saved(&cfg);
494
495 /*
496 * Apply subsystem status.
497 */
498 if (use_subsystem)
499 cfg.ssh_subsys = TRUE;
500
501 /*
502 * Trim a colon suffix off the hostname if it's there.
503 */
504 cfg.host[strcspn(cfg.host, ":")] = '\0';
505
506 /*
507 * Remove any remaining whitespace from the hostname.
508 */
509 {
510 int p1 = 0, p2 = 0;
511 while (cfg.host[p2] != '\0') {
512 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
513 cfg.host[p1] = cfg.host[p2];
514 p1++;
515 }
516 p2++;
517 }
518 cfg.host[p1] = '\0';
519 }
520
521 if (!cfg.remote_cmd_ptr && !*cfg.remote_cmd)
522 flags |= FLAG_INTERACTIVE;
523
524 /*
525 * Select protocol. This is farmed out into a table in a
526 * separate file to enable an ssh-free variant.
527 */
528 {
529 int i;
530 back = NULL;
531 for (i = 0; backends[i].backend != NULL; i++)
532 if (backends[i].protocol == cfg.protocol) {
533 back = backends[i].backend;
534 break;
535 }
536 if (back == NULL) {
537 fprintf(stderr,
538 "Internal fault: Unsupported protocol found\n");
539 return 1;
540 }
541 }
542
543 /*
544 * Select port.
545 */
546 if (portnumber != -1)
547 cfg.port = portnumber;
548
549 /*
550 * Set up the pipe we'll use to tell us about SIGWINCH.
551 */
552 if (pipe(signalpipe) < 0) {
553 perror("pipe");
554 exit(1);
555 }
556 putty_signal(SIGWINCH, sigwinch);
557
558 sk_init();
559 uxsel_init();
560
561 /*
562 * Start up the connection.
563 */
564 logctx = log_init(NULL, &cfg);
565 console_provide_logctx(logctx);
566 {
567 const char *error;
568 char *realhost;
569 /* nodelay is only useful if stdin is a terminal device */
570 int nodelay = cfg.tcp_nodelay && isatty(0);
571
572 error = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port,
573 &realhost, nodelay, cfg.tcp_keepalives);
574 if (error) {
575 fprintf(stderr, "Unable to open connection:\n%s\n", error);
576 return 1;
577 }
578 back->provide_logctx(backhandle, logctx);
579 ldisc = ldisc_create(&cfg, NULL, back, backhandle, NULL);
580 sfree(realhost);
581 }
582 connopen = 1;
583
584 /*
585 * Set up the initial console mode. We don't care if this call
586 * fails, because we know we aren't necessarily running in a
587 * console.
588 */
589 tcgetattr(0, &orig_termios);
590 atexit(cleanup_termios);
591 ldisc_update(NULL, 1, 1);
592 sending = FALSE;
593 now = GETTICKCOUNT();
594
595 while (1) {
596 fd_set rset, wset, xset;
597 int maxfd;
598 int rwx;
599 int ret;
600
601 FD_ZERO(&rset);
602 FD_ZERO(&wset);
603 FD_ZERO(&xset);
604 maxfd = 0;
605
606 FD_SET_MAX(signalpipe[0], maxfd, rset);
607
608 if (connopen && !sending &&
609 back->socket(backhandle) != NULL &&
610 back->sendok(backhandle) &&
611 back->sendbuffer(backhandle) < MAX_STDIN_BACKLOG) {
612 /* If we're OK to send, then try to read from stdin. */
613 FD_SET_MAX(0, maxfd, rset);
614 }
615
616 if (bufchain_size(&stdout_data) > 0) {
617 /* If we have data for stdout, try to write to stdout. */
618 FD_SET_MAX(1, maxfd, wset);
619 }
620
621 if (bufchain_size(&stderr_data) > 0) {
622 /* If we have data for stderr, try to write to stderr. */
623 FD_SET_MAX(2, maxfd, wset);
624 }
625
626 /* Count the currently active fds. */
627 i = 0;
628 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
629 fd = next_fd(&fdstate, &rwx)) i++;
630
631 /* Expand the fdlist buffer if necessary. */
632 if (i > fdsize) {
633 fdsize = i + 16;
634 fdlist = sresize(fdlist, fdsize, int);
635 }
636
637 /*
638 * Add all currently open fds to the select sets, and store
639 * them in fdlist as well.
640 */
641 fdcount = 0;
642 for (fd = first_fd(&fdstate, &rwx); fd >= 0;
643 fd = next_fd(&fdstate, &rwx)) {
644 fdlist[fdcount++] = fd;
645 if (rwx & 1)
646 FD_SET_MAX(fd, maxfd, rset);
647 if (rwx & 2)
648 FD_SET_MAX(fd, maxfd, wset);
649 if (rwx & 4)
650 FD_SET_MAX(fd, maxfd, xset);
651 }
652
653 do {
654 long next, ticks;
655 struct timeval tv, *ptv;
656
657 if (run_timers(now, &next)) {
658 ticks = next - GETTICKCOUNT();
659 if (ticks < 0) ticks = 0; /* just in case */
660 tv.tv_sec = ticks / 1000;
661 tv.tv_usec = ticks % 1000 * 1000;
662 ptv = &tv;
663 } else {
664 ptv = NULL;
665 }
666 ret = select(maxfd, &rset, &wset, &xset, ptv);
667 if (ret == 0)
668 now = next;
669 else
670 now = GETTICKCOUNT();
671 } while (ret < 0 && errno == EINTR);
672
673 if (ret < 0) {
674 perror("select");
675 exit(1);
676 }
677
678 for (i = 0; i < fdcount; i++) {
679 fd = fdlist[i];
680 /*
681 * We must process exceptional notifications before
682 * ordinary readability ones, or we may go straight
683 * past the urgent marker.
684 */
685 if (FD_ISSET(fd, &xset))
686 select_result(fd, 4);
687 if (FD_ISSET(fd, &rset))
688 select_result(fd, 1);
689 if (FD_ISSET(fd, &wset))
690 select_result(fd, 2);
691 }
692
693 if (FD_ISSET(signalpipe[0], &rset)) {
694 char c[1];
695 struct winsize size;
696 read(signalpipe[0], c, 1); /* ignore its value; it'll be `x' */
697 if (ioctl(0, TIOCGWINSZ, (void *)&size) >= 0)
698 back->size(backhandle, size.ws_col, size.ws_row);
699 }
700
701 if (FD_ISSET(0, &rset)) {
702 char buf[4096];
703 int ret;
704
705 if (connopen && back->socket(backhandle) != NULL) {
706 ret = read(0, buf, sizeof(buf));
707 if (ret < 0) {
708 perror("stdin: read");
709 exit(1);
710 } else if (ret == 0) {
711 back->special(backhandle, TS_EOF);
712 sending = FALSE; /* send nothing further after this */
713 } else {
714 back->send(backhandle, buf, ret);
715 }
716 }
717 }
718
719 if (FD_ISSET(1, &wset)) {
720 try_output(0);
721 }
722
723 if (FD_ISSET(2, &wset)) {
724 try_output(1);
725 }
726
727 if ((!connopen || back->socket(backhandle) == NULL) &&
728 bufchain_size(&stdout_data) == 0 &&
729 bufchain_size(&stderr_data) == 0)
730 break; /* we closed the connection */
731 }
732 exitcode = back->exitcode(backhandle);
733 if (exitcode < 0) {
734 fprintf(stderr, "Remote process exit code unavailable\n");
735 exitcode = 1; /* this is an error condition */
736 }
737 cleanup_exit(exitcode);
738 return exitcode; /* shouldn't happen, but placates gcc */
739 }