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(" -D listen-port Dynamic SOCKS-based port forwarding\n");
267 printf(" -L listen-port:host:port Forward local port to "
269 printf(" -R listen-port:host:port Forward remote port to"
271 printf(" -X -x enable / disable X11 forwarding\n");
272 printf(" -A -a enable / disable agent forwarding\n");
273 printf(" -t -T enable / disable pty allocation\n");
274 printf(" -1 -2 force use of particular protocol version\n");
275 printf(" -C enable compression\n");
276 printf(" -i key private key file for authentication\n");
280 int main(int argc
, char **argv
)
286 int i
, fdcount
, fdsize
, fdstate
;
292 ssh_get_line
= console_get_line
;
295 fdcount
= fdsize
= 0;
297 * Initialise port and protocol to sensible defaults. (These
298 * will be overridden by more or less anything.)
300 default_protocol
= PROT_SSH
;
305 * Process the command line.
307 do_defaults(NULL
, &cfg
);
308 default_protocol
= cfg
.protocol
;
309 default_port
= cfg
.port
;
313 * Override the default protocol if PLINK_PROTOCOL is set.
315 char *p
= getenv("PLINK_PROTOCOL");
318 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
319 if (!strcmp(backends
[i
].name
, p
)) {
320 default_protocol
= cfg
.protocol
= backends
[i
].protocol
;
321 default_port
= cfg
.port
=
322 backends
[i
].backend
->default_port
;
331 int ret
= cmdline_process_param(p
, (argc
> 1 ? argv
[1] : NULL
),
335 "plink: option \"%s\" requires an argument\n", p
);
337 } else if (ret
== 2) {
339 } else if (ret
== 1) {
341 } else if (!strcmp(p
, "-batch")) {
342 console_batch_mode
= 1;
343 } else if (!strcmp(p
, "-o")) {
346 "plink: option \"-o\" requires an argument\n");
350 provide_xrm_string(*++argv
);
353 fprintf(stderr
, "plink: unknown option \"%s\"\n", p
);
360 do_defaults(NULL
, &cfg
);
363 * If the hostname starts with "telnet:", set the
364 * protocol to Telnet and process the string as a
367 if (!strncmp(q
, "telnet:", 7)) {
371 if (q
[0] == '/' && q
[1] == '/')
373 cfg
.protocol
= PROT_TELNET
;
375 while (*p
&& *p
!= ':' && *p
!= '/')
384 strncpy(cfg
.host
, q
, sizeof(cfg
.host
) - 1);
385 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
389 * Before we process the [user@]host string, we
390 * first check for the presence of a protocol
391 * prefix (a protocol name followed by ",").
396 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
397 j
= strlen(backends
[i
].name
);
399 !memcmp(backends
[i
].name
, p
, j
)) {
400 default_protocol
= cfg
.protocol
=
401 backends
[i
].protocol
;
403 backends
[i
].backend
->default_port
;
411 * Three cases. Either (a) there's a nonzero
412 * length string followed by an @, in which
413 * case that's user and the remainder is host.
414 * Or (b) there's only one string, not counting
415 * a potential initial @, and it exists in the
416 * saved-sessions database. Or (c) only one
417 * string and it _doesn't_ exist in the
422 p
++, r
= NULL
; /* discount initial @ */
428 do_defaults(p
, &cfg2
);
429 if (cfg2
.host
[0] == '\0') {
430 /* No settings for this host; use defaults */
431 strncpy(cfg
.host
, p
, sizeof(cfg
.host
) - 1);
432 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
433 cfg
.port
= default_port
;
436 cfg
.remote_cmd_ptr
= cfg
.remote_cmd
;
440 strncpy(cfg
.username
, p
, sizeof(cfg
.username
) - 1);
441 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
442 strncpy(cfg
.host
, r
, sizeof(cfg
.host
) - 1);
443 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
444 cfg
.port
= default_port
;
450 cmdlen
= cmdsize
= 0;
455 if (cmdlen
>= cmdsize
) {
456 cmdsize
= cmdlen
+ 512;
457 command
= sresize(command
, cmdsize
, char);
459 command
[cmdlen
++]=*p
++;
461 if (cmdlen
>= cmdsize
) {
462 cmdsize
= cmdlen
+ 512;
463 command
= sresize(command
, cmdsize
, char);
465 command
[cmdlen
++]=' '; /* always add trailing space */
466 if (--argc
) p
= *++argv
;
468 if (cmdlen
) command
[--cmdlen
]='\0';
469 /* change trailing blank to NUL */
470 cfg
.remote_cmd_ptr
= command
;
471 cfg
.remote_cmd_ptr2
= NULL
;
472 cfg
.nopty
= TRUE
; /* command => no terminal */
474 break; /* done with cmdline */
487 * Trim leading whitespace off the hostname if it's there.
490 int space
= strspn(cfg
.host
, " \t");
491 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
494 /* See if host is of the form user@host */
495 if (cfg
.host
[0] != '\0') {
496 char *atsign
= strchr(cfg
.host
, '@');
497 /* Make sure we're not overflowing the user field */
499 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
500 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
501 cfg
.username
[atsign
- cfg
.host
] = '\0';
503 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
508 * Perform command-line overrides on session configuration.
510 cmdline_run_saved(&cfg
);
513 * Trim a colon suffix off the hostname if it's there.
515 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
518 * Remove any remaining whitespace from the hostname.
522 while (cfg
.host
[p2
] != '\0') {
523 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
524 cfg
.host
[p1
] = cfg
.host
[p2
];
532 if (!*cfg
.remote_cmd_ptr
)
533 flags
|= FLAG_INTERACTIVE
;
536 * Select protocol. This is farmed out into a table in a
537 * separate file to enable an ssh-free variant.
542 for (i
= 0; backends
[i
].backend
!= NULL
; i
++)
543 if (backends
[i
].protocol
== cfg
.protocol
) {
544 back
= backends
[i
].backend
;
549 "Internal fault: Unsupported protocol found\n");
557 if (portnumber
!= -1)
558 cfg
.port
= portnumber
;
561 * Set up the pipe we'll use to tell us about SIGWINCH.
563 if (pipe(signalpipe
) < 0) {
567 putty_signal(SIGWINCH
, sigwinch
);
573 * Start up the connection.
575 logctx
= log_init(NULL
, &cfg
);
579 /* nodelay is only useful if stdin is a terminal device */
580 int nodelay
= cfg
.tcp_nodelay
&& isatty(0);
582 error
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
,
585 fprintf(stderr
, "Unable to open connection:\n%s\n", error
);
588 back
->provide_logctx(backhandle
, logctx
);
589 ldisc
= ldisc_create(&cfg
, NULL
, back
, backhandle
, NULL
);
595 * Set up the initial console mode. We don't care if this call
596 * fails, because we know we aren't necessarily running in a
599 tcgetattr(0, &orig_termios
);
600 atexit(cleanup_termios
);
601 ldisc_update(NULL
, 1, 1);
605 fd_set rset
, wset
, xset
;
615 FD_SET_MAX(signalpipe
[0], maxfd
, rset
);
617 if (connopen
&& !sending
&&
618 back
->socket(backhandle
) != NULL
&&
619 back
->sendok(backhandle
) &&
620 back
->sendbuffer(backhandle
) < MAX_STDIN_BACKLOG
) {
621 /* If we're OK to send, then try to read from stdin. */
622 FD_SET_MAX(0, maxfd
, rset
);
625 if (bufchain_size(&stdout_data
) > 0) {
626 /* If we have data for stdout, try to write to stdout. */
627 FD_SET_MAX(1, maxfd
, wset
);
630 if (bufchain_size(&stderr_data
) > 0) {
631 /* If we have data for stderr, try to write to stderr. */
632 FD_SET_MAX(2, maxfd
, wset
);
635 /* Count the currently active fds. */
637 for (fd
= first_fd(&fdstate
, &rwx
); fd
>= 0;
638 fd
= next_fd(&fdstate
, &rwx
)) i
++;
640 /* Expand the fdlist buffer if necessary. */
643 fdlist
= sresize(fdlist
, fdsize
, int);
647 * Add all currently open fds to the select sets, and store
648 * them in fdlist as well.
651 for (fd
= first_fd(&fdstate
, &rwx
); fd
>= 0;
652 fd
= next_fd(&fdstate
, &rwx
)) {
653 fdlist
[fdcount
++] = fd
;
655 FD_SET_MAX(fd
, maxfd
, rset
);
657 FD_SET_MAX(fd
, maxfd
, wset
);
659 FD_SET_MAX(fd
, maxfd
, xset
);
663 ret
= select(maxfd
, &rset
, &wset
, &xset
, NULL
);
664 } while (ret
< 0 && errno
== EINTR
);
671 for (i
= 0; i
< fdcount
; i
++) {
674 * We must process exceptional notifications before
675 * ordinary readability ones, or we may go straight
676 * past the urgent marker.
678 if (FD_ISSET(fd
, &xset
))
679 select_result(fd
, 4);
680 if (FD_ISSET(fd
, &rset
))
681 select_result(fd
, 1);
682 if (FD_ISSET(fd
, &wset
))
683 select_result(fd
, 2);
686 if (FD_ISSET(signalpipe
[0], &rset
)) {
689 read(signalpipe
[0], c
, 1); /* ignore its value; it'll be `x' */
690 if (ioctl(0, TIOCGWINSZ
, (void *)&size
) >= 0)
691 back
->size(backhandle
, size
.ws_col
, size
.ws_row
);
694 if (FD_ISSET(0, &rset
)) {
698 if (connopen
&& back
->socket(backhandle
) != NULL
) {
699 ret
= read(0, buf
, sizeof(buf
));
701 perror("stdin: read");
703 } else if (ret
== 0) {
704 back
->special(backhandle
, TS_EOF
);
705 sending
= FALSE
; /* send nothing further after this */
707 back
->send(backhandle
, buf
, ret
);
712 if (FD_ISSET(1, &wset
)) {
716 if (FD_ISSET(2, &wset
)) {
720 if ((!connopen
|| back
->socket(backhandle
) == NULL
) &&
721 bufchain_size(&stdout_data
) == 0 &&
722 bufchain_size(&stderr_data
) == 0)
723 break; /* we closed the connection */
725 exitcode
= back
->exitcode(backhandle
);
727 fprintf(stderr
, "Remote process exit code unavailable\n");
728 exitcode
= 1; /* this is an error condition */
730 cleanup_exit(exitcode
);
731 return exitcode
; /* shouldn't happen, but placates gcc */