2 * PLink - a command-line (stdin/stdout) variant of PuTTY.
15 #include <sys/ioctl.h>
17 /* More helpful version of the FD_SET macro, to also handle maxfd. */
18 #define FD_SET_MAX(fd, max, set) do { \
20 if (max < fd + 1) max = fd + 1; \
23 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
28 #define MAX_STDIN_BACKLOG 4096
30 void fatalbox(char *p
, ...)
33 fprintf(stderr
, "FATAL ERROR: ");
35 vfprintf(stderr
, p
, ap
);
40 void modalfatalbox(char *p
, ...)
43 fprintf(stderr
, "FATAL ERROR: ");
45 vfprintf(stderr
, p
, ap
);
50 void connection_fatal(void *frontend
, char *p
, ...)
53 fprintf(stderr
, "FATAL ERROR: ");
55 vfprintf(stderr
, p
, ap
);
60 void cmdline_error(char *p
, ...)
63 fprintf(stderr
, "plink: ");
65 vfprintf(stderr
, p
, ap
);
71 struct termios orig_termios
;
74 static void *backhandle
;
78 * Default settings that are specific to pterm.
80 char *platform_default_s(const char *name
)
82 if (!strcmp(name
, "X11Display"))
83 return getenv("DISPLAY");
84 if (!strcmp(name
, "TermType"))
85 return getenv("TERM");
86 if (!strcmp(name
, "UserName")) {
88 * Remote login username will default to the local username.
92 char *user
, *ret
= NULL
;
95 * First, find who we think we are using getlogin. If this
96 * agrees with our uid, we'll go along with it. This should
97 * allow sharing of uids between several login names whilst
98 * coping correctly with people who have su'ed.
106 if (p
&& p
->pw_uid
== uid
) {
108 * The result of getlogin() really does correspond to
114 * If that didn't work, for whatever reason, we'll do
115 * the simpler version: look up our uid in the password
116 * file and map it straight to a name.
128 int platform_default_i(const char *name
, int def
)
130 if (!strcmp(name
, "TermWidth") ||
131 !strcmp(name
, "TermHeight")) {
133 if (ioctl(0, TIOCGWINSZ
, (void *)&size
) >= 0)
134 return (!strcmp(name
, "TermWidth") ? size
.ws_col
: size
.ws_row
);
139 FontSpec
platform_default_fontspec(const char *name
)
146 Filename
platform_default_filename(const char *name
)
149 if (!strcmp(name
, "LogFileName"))
150 strcpy(ret
.path
, "putty.log");
156 char *x_get_default(const char *key
)
158 return NULL
; /* this is a stub */
160 int term_ldisc(Terminal
*term
, int mode
)
164 void ldisc_update(void *frontend
, int echo
, int edit
)
166 /* Update stdin read mode to reflect changes in line discipline. */
172 mode
.c_lflag
|= ECHO
;
174 mode
.c_lflag
&= ~ECHO
;
177 mode
.c_lflag
|= ISIG
| ICANON
;
179 mode
.c_lflag
&= ~(ISIG
| ICANON
);
181 tcsetattr(0, TCSANOW
, &mode
);
184 void cleanup_termios(void)
186 tcsetattr(0, TCSANOW
, &orig_termios
);
189 bufchain stdout_data
, stderr_data
;
191 void try_output(int is_stderr
)
193 bufchain
*chain
= (is_stderr ?
&stderr_data
: &stdout_data
);
194 int fd
= (is_stderr ?
2 : 1);
198 if (bufchain_size(chain
) == 0)
201 bufchain_prefix(chain
, &senddata
, &sendlen
);
202 ret
= write(fd
, senddata
, sendlen
);
204 bufchain_consume(chain
, ret
);
206 perror(is_stderr ?
"stderr: write" : "stdout: write");
211 int from_backend(void *frontend_handle
, int is_stderr
,
212 const char *data
, int len
)
219 bufchain_add(&stderr_data
, data
, len
);
222 bufchain_add(&stdout_data
, data
, len
);
226 osize
= bufchain_size(&stdout_data
);
227 esize
= bufchain_size(&stderr_data
);
229 return osize
+ esize
;
234 void sigwinch(int signum
)
236 write(signalpipe
[1], "x", 1);
240 * In Plink our selects are synchronous, so these functions are
243 int uxsel_input_add(int fd
, int rwx
) { return 0; }
244 void uxsel_input_remove(int id
) { }
247 * Short description of parameters.
249 static void usage(void)
251 printf("PuTTY Link: command-line connection utility\n");
253 printf("Usage: plink [options] [user@]host [command]\n");
254 printf(" (\"host\" can also be a PuTTY saved session name)\n");
255 printf("Options:\n");
256 printf(" -v show verbose messages\n");
257 printf(" -load sessname Load settings from saved session\n");
258 printf(" -ssh -telnet -rlogin -raw\n");
259 printf(" force use of a particular protocol (default SSH)\n");
260 printf(" -P port connect to specified port\n");
261 printf(" -l user connect with specified username\n");
262 printf(" -m file read remote command(s) from file\n");
263 printf(" -batch disable all interactive prompts\n");
264 printf("The following options only apply to SSH connections:\n");
265 printf(" -pw passw login with specified password\n");
266 printf(" -L listen-port:host:port Forward local port to "
268 printf(" -R listen-port:host:port Forward remote port to"
270 printf(" -X -x enable / disable X11 forwarding\n");
271 printf(" -A -a enable / disable agent forwarding\n");
272 printf(" -t -T enable / disable pty allocation\n");
273 printf(" -1 -2 force use of particular protocol version\n");
274 printf(" -C enable compression\n");
275 printf(" -i key private key file for authentication\n");
279 int main(int argc
, char **argv
)
285 int i
, fdcount
, fdsize
, fdstate
;
291 ssh_get_line
= console_get_line
;
294 fdcount
= fdsize
= 0;
296 * Initialise port and protocol to sensible defaults. (These
297 * will be overridden by more or less anything.)
299 default_protocol
= PROT_SSH
;
304 * Process the command line.
306 do_defaults(NULL
, &cfg
);
307 default_protocol
= cfg
.protocol
;
308 default_port
= cfg
.port
;
312 * Override the default protocol if PLINK_PROTOCOL is set.
314 char *p
= getenv("PLINK_PROTOCOL");
317 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
318 if (!strcmp(backends
[i
].name
, p
)) {
319 default_protocol
= cfg
.protocol
= backends
[i
].protocol
;
320 default_port
= cfg
.port
=
321 backends
[i
].backend
->default_port
;
330 int ret
= cmdline_process_param(p
, (argc
> 1 ? argv
[1] : NULL
),
334 "plink: option \"%s\" requires an argument\n", p
);
336 } else if (ret
== 2) {
338 } else if (ret
== 1) {
340 } else if (!strcmp(p
, "-batch")) {
341 console_batch_mode
= 1;
342 } else if (!strcmp(p
, "-o")) {
345 "plink: option \"-o\" requires an argument\n");
349 provide_xrm_string(*++argv
);
352 fprintf(stderr
, "plink: unknown option \"%s\"\n", p
);
359 do_defaults(NULL
, &cfg
);
362 * If the hostname starts with "telnet:", set the
363 * protocol to Telnet and process the string as a
366 if (!strncmp(q
, "telnet:", 7)) {
370 if (q
[0] == '/' && q
[1] == '/')
372 cfg
.protocol
= PROT_TELNET
;
374 while (*p
&& *p
!= ':' && *p
!= '/')
383 strncpy(cfg
.host
, q
, sizeof(cfg
.host
) - 1);
384 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
388 * Before we process the [user@]host string, we
389 * first check for the presence of a protocol
390 * prefix (a protocol name followed by ",").
395 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
396 j
= strlen(backends
[i
].name
);
398 !memcmp(backends
[i
].name
, p
, j
)) {
399 default_protocol
= cfg
.protocol
=
400 backends
[i
].protocol
;
402 backends
[i
].backend
->default_port
;
410 * Three cases. Either (a) there's a nonzero
411 * length string followed by an @, in which
412 * case that's user and the remainder is host.
413 * Or (b) there's only one string, not counting
414 * a potential initial @, and it exists in the
415 * saved-sessions database. Or (c) only one
416 * string and it _doesn't_ exist in the
421 p
++, r
= NULL
; /* discount initial @ */
427 do_defaults(p
, &cfg2
);
428 if (cfg2
.host
[0] == '\0') {
429 /* No settings for this host; use defaults */
430 strncpy(cfg
.host
, p
, sizeof(cfg
.host
) - 1);
431 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
432 cfg
.port
= default_port
;
435 cfg
.remote_cmd_ptr
= cfg
.remote_cmd
;
439 strncpy(cfg
.username
, p
, sizeof(cfg
.username
) - 1);
440 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
441 strncpy(cfg
.host
, r
, sizeof(cfg
.host
) - 1);
442 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
443 cfg
.port
= default_port
;
449 cmdlen
= cmdsize
= 0;
454 if (cmdlen
>= cmdsize
) {
455 cmdsize
= cmdlen
+ 512;
456 command
= sresize(command
, cmdsize
, char);
458 command
[cmdlen
++]=*p
++;
460 if (cmdlen
>= cmdsize
) {
461 cmdsize
= cmdlen
+ 512;
462 command
= sresize(command
, cmdsize
, char);
464 command
[cmdlen
++]=' '; /* always add trailing space */
465 if (--argc
) p
= *++argv
;
467 if (cmdlen
) command
[--cmdlen
]='\0';
468 /* change trailing blank to NUL */
469 cfg
.remote_cmd_ptr
= command
;
470 cfg
.remote_cmd_ptr2
= NULL
;
471 cfg
.nopty
= TRUE
; /* command => no terminal */
473 break; /* done with cmdline */
486 * Trim leading whitespace off the hostname if it's there.
489 int space
= strspn(cfg
.host
, " \t");
490 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
493 /* See if host is of the form user@host */
494 if (cfg
.host
[0] != '\0') {
495 char *atsign
= strchr(cfg
.host
, '@');
496 /* Make sure we're not overflowing the user field */
498 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
499 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
500 cfg
.username
[atsign
- cfg
.host
] = '\0';
502 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
507 * Perform command-line overrides on session configuration.
509 cmdline_run_saved(&cfg
);
512 * Trim a colon suffix off the hostname if it's there.
514 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
517 * Remove any remaining whitespace from the hostname.
521 while (cfg
.host
[p2
] != '\0') {
522 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
523 cfg
.host
[p1
] = cfg
.host
[p2
];
531 if (!*cfg
.remote_cmd_ptr
)
532 flags
|= FLAG_INTERACTIVE
;
535 * Select protocol. This is farmed out into a table in a
536 * separate file to enable an ssh-free variant.
541 for (i
= 0; backends
[i
].backend
!= NULL
; i
++)
542 if (backends
[i
].protocol
== cfg
.protocol
) {
543 back
= backends
[i
].backend
;
548 "Internal fault: Unsupported protocol found\n");
556 if (portnumber
!= -1)
557 cfg
.port
= portnumber
;
560 * Set up the pipe we'll use to tell us about SIGWINCH.
562 if (pipe(signalpipe
) < 0) {
566 putty_signal(SIGWINCH
, sigwinch
);
572 * Start up the connection.
574 logctx
= log_init(NULL
, &cfg
);
578 /* nodelay is only useful if stdin is a terminal device */
579 int nodelay
= cfg
.tcp_nodelay
&& isatty(0);
581 error
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
,
584 fprintf(stderr
, "Unable to open connection:\n%s\n", error
);
587 back
->provide_logctx(backhandle
, logctx
);
588 ldisc
= ldisc_create(&cfg
, NULL
, back
, backhandle
, NULL
);
594 * Set up the initial console mode. We don't care if this call
595 * fails, because we know we aren't necessarily running in a
598 tcgetattr(0, &orig_termios
);
599 atexit(cleanup_termios
);
600 ldisc_update(NULL
, 1, 1);
604 fd_set rset
, wset
, xset
;
614 FD_SET_MAX(signalpipe
[0], maxfd
, rset
);
616 if (connopen
&& !sending
&&
617 back
->socket(backhandle
) != NULL
&&
618 back
->sendok(backhandle
) &&
619 back
->sendbuffer(backhandle
) < MAX_STDIN_BACKLOG
) {
620 /* If we're OK to send, then try to read from stdin. */
621 FD_SET_MAX(0, maxfd
, rset
);
624 if (bufchain_size(&stdout_data
) > 0) {
625 /* If we have data for stdout, try to write to stdout. */
626 FD_SET_MAX(1, maxfd
, wset
);
629 if (bufchain_size(&stderr_data
) > 0) {
630 /* If we have data for stderr, try to write to stderr. */
631 FD_SET_MAX(2, maxfd
, wset
);
634 /* Count the currently active fds. */
636 for (fd
= first_fd(&fdstate
, &rwx
); fd
>= 0;
637 fd
= next_fd(&fdstate
, &rwx
)) i
++;
639 /* Expand the fdlist buffer if necessary. */
642 fdlist
= sresize(fdlist
, fdsize
, int);
646 * Add all currently open fds to the select sets, and store
647 * them in fdlist as well.
650 for (fd
= first_fd(&fdstate
, &rwx
); fd
>= 0;
651 fd
= next_fd(&fdstate
, &rwx
)) {
652 fdlist
[fdcount
++] = fd
;
654 FD_SET_MAX(fd
, maxfd
, rset
);
656 FD_SET_MAX(fd
, maxfd
, wset
);
658 FD_SET_MAX(fd
, maxfd
, xset
);
662 ret
= select(maxfd
, &rset
, &wset
, &xset
, NULL
);
663 } while (ret
< 0 && errno
== EINTR
);
670 for (i
= 0; i
< fdcount
; i
++) {
673 * We must process exceptional notifications before
674 * ordinary readability ones, or we may go straight
675 * past the urgent marker.
677 if (FD_ISSET(fd
, &xset
))
678 select_result(fd
, 4);
679 if (FD_ISSET(fd
, &rset
))
680 select_result(fd
, 1);
681 if (FD_ISSET(fd
, &wset
))
682 select_result(fd
, 2);
685 if (FD_ISSET(signalpipe
[0], &rset
)) {
688 read(signalpipe
[0], c
, 1); /* ignore its value; it'll be `x' */
689 if (ioctl(0, TIOCGWINSZ
, (void *)&size
) >= 0)
690 back
->size(backhandle
, size
.ws_col
, size
.ws_row
);
693 if (FD_ISSET(0, &rset
)) {
697 if (connopen
&& back
->socket(backhandle
) != NULL
) {
698 ret
= read(0, buf
, sizeof(buf
));
700 perror("stdin: read");
702 } else if (ret
== 0) {
703 back
->special(backhandle
, TS_EOF
);
704 sending
= FALSE
; /* send nothing further after this */
706 back
->send(backhandle
, buf
, ret
);
711 if (FD_ISSET(1, &wset
)) {
715 if (FD_ISSET(2, &wset
)) {
719 if ((!connopen
|| back
->socket(backhandle
) == NULL
) &&
720 bufchain_size(&stdout_data
) == 0 &&
721 bufchain_size(&stderr_data
) == 0)
722 break; /* we closed the connection */
724 exitcode
= back
->exitcode(backhandle
);
726 fprintf(stderr
, "Remote process exit code unavailable\n");
727 exitcode
= 1; /* this is an error condition */
729 cleanup_exit(exitcode
);
730 return exitcode
; /* shouldn't happen, but placates gcc */