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 show verbose messages\n");
212 printf(" -load sessname Load settings from saved session\n");
213 printf(" -ssh -telnet -rlogin -raw\n");
214 printf(" force use of a particular protocol (default SSH)\n");
215 printf(" -P port connect to specified port\n");
216 printf(" -l user connect with specified username\n");
217 printf(" -m file read remote command(s) from file\n");
218 printf(" -batch disable all interactive prompts\n");
219 printf("The following options only apply to SSH connections:\n");
220 printf(" -pw passw login with specified password\n");
221 printf(" -D listen-port Dynamic SOCKS-based port forwarding\n");
222 printf(" -L listen-port:host:port Forward local port to "
224 printf(" -R listen-port:host:port Forward remote port to"
226 printf(" -X -x enable / disable X11 forwarding\n");
227 printf(" -A -a enable / disable agent forwarding\n");
228 printf(" -t -T enable / disable pty allocation\n");
229 printf(" -1 -2 force use of particular protocol version\n");
230 printf(" -C enable compression\n");
231 printf(" -i key private key file for authentication\n");
232 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
236 int main(int argc
, char **argv
)
242 int i
, fdcount
, fdsize
, fdstate
;
246 int use_subsystem
= 0;
247 void *ldisc
, *logctx
;
249 ssh_get_line
= console_get_line
;
252 fdcount
= fdsize
= 0;
254 * Initialise port and protocol to sensible defaults. (These
255 * will be overridden by more or less anything.)
257 default_protocol
= PROT_SSH
;
262 * Process the command line.
264 do_defaults(NULL
, &cfg
);
265 default_protocol
= cfg
.protocol
;
266 default_port
= cfg
.port
;
270 * Override the default protocol if PLINK_PROTOCOL is set.
272 char *p
= getenv("PLINK_PROTOCOL");
275 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
276 if (!strcmp(backends
[i
].name
, p
)) {
277 default_protocol
= cfg
.protocol
= backends
[i
].protocol
;
278 default_port
= cfg
.port
=
279 backends
[i
].backend
->default_port
;
288 int ret
= cmdline_process_param(p
, (argc
> 1 ? argv
[1] : NULL
),
292 "plink: option \"%s\" requires an argument\n", p
);
294 } else if (ret
== 2) {
296 } else if (ret
== 1) {
298 } else if (!strcmp(p
, "-batch")) {
299 console_batch_mode
= 1;
300 } else if (!strcmp(p
, "-s")) {
301 /* Save status to write to cfg later. */
303 } else if (!strcmp(p
, "-o")) {
306 "plink: option \"-o\" requires an argument\n");
310 provide_xrm_string(*++argv
);
313 fprintf(stderr
, "plink: unknown option \"%s\"\n", p
);
320 do_defaults(NULL
, &cfg
);
323 * If the hostname starts with "telnet:", set the
324 * protocol to Telnet and process the string as a
327 if (!strncmp(q
, "telnet:", 7)) {
331 if (q
[0] == '/' && q
[1] == '/')
333 cfg
.protocol
= PROT_TELNET
;
335 while (*p
&& *p
!= ':' && *p
!= '/')
344 strncpy(cfg
.host
, q
, sizeof(cfg
.host
) - 1);
345 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
349 * Before we process the [user@]host string, we
350 * first check for the presence of a protocol
351 * prefix (a protocol name followed by ",").
356 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
357 j
= strlen(backends
[i
].name
);
359 !memcmp(backends
[i
].name
, p
, j
)) {
360 default_protocol
= cfg
.protocol
=
361 backends
[i
].protocol
;
363 backends
[i
].backend
->default_port
;
371 * Three cases. Either (a) there's a nonzero
372 * length string followed by an @, in which
373 * case that's user and the remainder is host.
374 * Or (b) there's only one string, not counting
375 * a potential initial @, and it exists in the
376 * saved-sessions database. Or (c) only one
377 * string and it _doesn't_ exist in the
382 p
++, r
= NULL
; /* discount initial @ */
388 do_defaults(p
, &cfg2
);
389 if (cfg2
.host
[0] == '\0') {
390 /* No settings for this host; use defaults */
391 strncpy(cfg
.host
, p
, sizeof(cfg
.host
) - 1);
392 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
393 cfg
.port
= default_port
;
396 cfg
.remote_cmd_ptr
= cfg
.remote_cmd
;
400 strncpy(cfg
.username
, p
, sizeof(cfg
.username
) - 1);
401 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
402 strncpy(cfg
.host
, r
, sizeof(cfg
.host
) - 1);
403 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
404 cfg
.port
= default_port
;
410 cmdlen
= cmdsize
= 0;
415 if (cmdlen
>= cmdsize
) {
416 cmdsize
= cmdlen
+ 512;
417 command
= sresize(command
, cmdsize
, char);
419 command
[cmdlen
++]=*p
++;
421 if (cmdlen
>= cmdsize
) {
422 cmdsize
= cmdlen
+ 512;
423 command
= sresize(command
, cmdsize
, char);
425 command
[cmdlen
++]=' '; /* always add trailing space */
426 if (--argc
) p
= *++argv
;
428 if (cmdlen
) command
[--cmdlen
]='\0';
429 /* change trailing blank to NUL */
430 cfg
.remote_cmd_ptr
= command
;
431 cfg
.remote_cmd_ptr2
= NULL
;
432 cfg
.nopty
= TRUE
; /* command => no terminal */
434 break; /* done with cmdline */
447 * Trim leading whitespace off the hostname if it's there.
450 int space
= strspn(cfg
.host
, " \t");
451 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
454 /* See if host is of the form user@host */
455 if (cfg
.host
[0] != '\0') {
456 char *atsign
= strchr(cfg
.host
, '@');
457 /* Make sure we're not overflowing the user field */
459 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
460 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
461 cfg
.username
[atsign
- cfg
.host
] = '\0';
463 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
468 * Perform command-line overrides on session configuration.
470 cmdline_run_saved(&cfg
);
473 * Apply subsystem status.
476 cfg
.ssh_subsys
= TRUE
;
479 * Trim a colon suffix off the hostname if it's there.
481 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
484 * Remove any remaining whitespace from the hostname.
488 while (cfg
.host
[p2
] != '\0') {
489 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
490 cfg
.host
[p1
] = cfg
.host
[p2
];
498 if (!*cfg
.remote_cmd_ptr
)
499 flags
|= FLAG_INTERACTIVE
;
502 * Select protocol. This is farmed out into a table in a
503 * separate file to enable an ssh-free variant.
508 for (i
= 0; backends
[i
].backend
!= NULL
; i
++)
509 if (backends
[i
].protocol
== cfg
.protocol
) {
510 back
= backends
[i
].backend
;
515 "Internal fault: Unsupported protocol found\n");
523 if (portnumber
!= -1)
524 cfg
.port
= portnumber
;
527 * Set up the pipe we'll use to tell us about SIGWINCH.
529 if (pipe(signalpipe
) < 0) {
533 putty_signal(SIGWINCH
, sigwinch
);
539 * Start up the connection.
541 logctx
= log_init(NULL
, &cfg
);
542 console_provide_logctx(logctx
);
546 /* nodelay is only useful if stdin is a terminal device */
547 int nodelay
= cfg
.tcp_nodelay
&& isatty(0);
549 error
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
,
552 fprintf(stderr
, "Unable to open connection:\n%s\n", error
);
555 back
->provide_logctx(backhandle
, logctx
);
556 ldisc
= ldisc_create(&cfg
, NULL
, back
, backhandle
, NULL
);
562 * Set up the initial console mode. We don't care if this call
563 * fails, because we know we aren't necessarily running in a
566 tcgetattr(0, &orig_termios
);
567 atexit(cleanup_termios
);
568 ldisc_update(NULL
, 1, 1);
572 fd_set rset
, wset
, xset
;
582 FD_SET_MAX(signalpipe
[0], maxfd
, rset
);
584 if (connopen
&& !sending
&&
585 back
->socket(backhandle
) != NULL
&&
586 back
->sendok(backhandle
) &&
587 back
->sendbuffer(backhandle
) < MAX_STDIN_BACKLOG
) {
588 /* If we're OK to send, then try to read from stdin. */
589 FD_SET_MAX(0, maxfd
, rset
);
592 if (bufchain_size(&stdout_data
) > 0) {
593 /* If we have data for stdout, try to write to stdout. */
594 FD_SET_MAX(1, maxfd
, wset
);
597 if (bufchain_size(&stderr_data
) > 0) {
598 /* If we have data for stderr, try to write to stderr. */
599 FD_SET_MAX(2, maxfd
, wset
);
602 /* Count the currently active fds. */
604 for (fd
= first_fd(&fdstate
, &rwx
); fd
>= 0;
605 fd
= next_fd(&fdstate
, &rwx
)) i
++;
607 /* Expand the fdlist buffer if necessary. */
610 fdlist
= sresize(fdlist
, fdsize
, int);
614 * Add all currently open fds to the select sets, and store
615 * them in fdlist as well.
618 for (fd
= first_fd(&fdstate
, &rwx
); fd
>= 0;
619 fd
= next_fd(&fdstate
, &rwx
)) {
620 fdlist
[fdcount
++] = fd
;
622 FD_SET_MAX(fd
, maxfd
, rset
);
624 FD_SET_MAX(fd
, maxfd
, wset
);
626 FD_SET_MAX(fd
, maxfd
, xset
);
630 ret
= select(maxfd
, &rset
, &wset
, &xset
, NULL
);
631 } while (ret
< 0 && errno
== EINTR
);
638 for (i
= 0; i
< fdcount
; i
++) {
641 * We must process exceptional notifications before
642 * ordinary readability ones, or we may go straight
643 * past the urgent marker.
645 if (FD_ISSET(fd
, &xset
))
646 select_result(fd
, 4);
647 if (FD_ISSET(fd
, &rset
))
648 select_result(fd
, 1);
649 if (FD_ISSET(fd
, &wset
))
650 select_result(fd
, 2);
653 if (FD_ISSET(signalpipe
[0], &rset
)) {
656 read(signalpipe
[0], c
, 1); /* ignore its value; it'll be `x' */
657 if (ioctl(0, TIOCGWINSZ
, (void *)&size
) >= 0)
658 back
->size(backhandle
, size
.ws_col
, size
.ws_row
);
661 if (FD_ISSET(0, &rset
)) {
665 if (connopen
&& back
->socket(backhandle
) != NULL
) {
666 ret
= read(0, buf
, sizeof(buf
));
668 perror("stdin: read");
670 } else if (ret
== 0) {
671 back
->special(backhandle
, TS_EOF
);
672 sending
= FALSE
; /* send nothing further after this */
674 back
->send(backhandle
, buf
, ret
);
679 if (FD_ISSET(1, &wset
)) {
683 if (FD_ISSET(2, &wset
)) {
687 if ((!connopen
|| back
->socket(backhandle
) == NULL
) &&
688 bufchain_size(&stdout_data
) == 0 &&
689 bufchain_size(&stderr_data
) == 0)
690 break; /* we closed the connection */
692 exitcode
= back
->exitcode(backhandle
);
694 fprintf(stderr
, "Remote process exit code unavailable\n");
695 exitcode
= 1; /* this is an error condition */
697 cleanup_exit(exitcode
);
698 return exitcode
; /* shouldn't happen, but placates gcc */