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
, "TermType"))
77 return dupstr(getenv("TERM"));
78 if (!strcmp(name
, "UserName"))
79 return get_username();
83 int platform_default_i(const char *name
, int def
)
85 if (!strcmp(name
, "TermWidth") ||
86 !strcmp(name
, "TermHeight")) {
88 if (ioctl(0, TIOCGWINSZ
, (void *)&size
) >= 0)
89 return (!strcmp(name
, "TermWidth") ? size
.ws_col
: size
.ws_row
);
94 FontSpec
platform_default_fontspec(const char *name
)
101 Filename
platform_default_filename(const char *name
)
104 if (!strcmp(name
, "LogFileName"))
105 strcpy(ret
.path
, "putty.log");
111 char *x_get_default(const char *key
)
113 return NULL
; /* this is a stub */
115 int term_ldisc(Terminal
*term
, int mode
)
119 void ldisc_update(void *frontend
, int echo
, int edit
)
121 /* Update stdin read mode to reflect changes in line discipline. */
127 mode
.c_lflag
|= ECHO
;
129 mode
.c_lflag
&= ~ECHO
;
132 mode
.c_lflag
|= ISIG
| ICANON
;
134 mode
.c_lflag
&= ~(ISIG
| ICANON
);
136 tcsetattr(0, TCSANOW
, &mode
);
139 void cleanup_termios(void)
141 tcsetattr(0, TCSANOW
, &orig_termios
);
144 bufchain stdout_data
, stderr_data
;
146 void try_output(int is_stderr
)
148 bufchain
*chain
= (is_stderr ?
&stderr_data
: &stdout_data
);
149 int fd
= (is_stderr ?
2 : 1);
153 if (bufchain_size(chain
) == 0)
156 bufchain_prefix(chain
, &senddata
, &sendlen
);
157 ret
= write(fd
, senddata
, sendlen
);
159 bufchain_consume(chain
, ret
);
161 perror(is_stderr ?
"stderr: write" : "stdout: write");
166 int from_backend(void *frontend_handle
, int is_stderr
,
167 const char *data
, int len
)
172 bufchain_add(&stderr_data
, data
, len
);
175 bufchain_add(&stdout_data
, data
, len
);
179 osize
= bufchain_size(&stdout_data
);
180 esize
= bufchain_size(&stderr_data
);
182 return osize
+ esize
;
187 void sigwinch(int signum
)
189 write(signalpipe
[1], "x", 1);
193 * In Plink our selects are synchronous, so these functions are
196 int uxsel_input_add(int fd
, int rwx
) { return 0; }
197 void uxsel_input_remove(int id
) { }
200 * Short description of parameters.
202 static void usage(void)
204 printf("PuTTY Link: command-line connection utility\n");
206 printf("Usage: plink [options] [user@]host [command]\n");
207 printf(" (\"host\" can also be a PuTTY saved session name)\n");
208 printf("Options:\n");
209 printf(" -V print version information\n");
210 printf(" -v show verbose messages\n");
211 printf(" -load sessname Load settings from saved session\n");
212 printf(" -ssh -telnet -rlogin -raw\n");
213 printf(" force use of a particular protocol\n");
214 printf(" -P port connect to specified port\n");
215 printf(" -l user connect with specified username\n");
216 printf(" -m file read remote command(s) from file\n");
217 printf(" -batch disable all interactive prompts\n");
218 printf("The following options only apply to SSH connections:\n");
219 printf(" -pw passw login with specified password\n");
220 printf(" -D [listen-IP:]listen-port\n");
221 printf(" Dynamic SOCKS-based port forwarding\n");
222 printf(" -L [listen-IP:]listen-port:host:port\n");
223 printf(" Forward local port to remote address\n");
224 printf(" -R [listen-IP:]listen-port:host:port\n");
225 printf(" Forward remote port to local address\n");
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");
233 printf(" -N don't start a shell/command (SSH-2 only)\n");
237 static void version(void)
239 printf("plink: %s\n", ver
);
243 int main(int argc
, char **argv
)
249 int i
, fdcount
, fdsize
, fdstate
;
253 int use_subsystem
= 0;
254 void *ldisc
, *logctx
;
256 ssh_get_line
= console_get_line
;
259 fdcount
= fdsize
= 0;
261 * Initialise port and protocol to sensible defaults. (These
262 * will be overridden by more or less anything.)
264 default_protocol
= PROT_SSH
;
269 * Process the command line.
271 do_defaults(NULL
, &cfg
);
272 loaded_session
= FALSE
;
273 default_protocol
= cfg
.protocol
;
274 default_port
= cfg
.port
;
278 * Override the default protocol if PLINK_PROTOCOL is set.
280 char *p
= getenv("PLINK_PROTOCOL");
283 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
284 if (!strcmp(backends
[i
].name
, p
)) {
285 default_protocol
= cfg
.protocol
= backends
[i
].protocol
;
286 default_port
= cfg
.port
=
287 backends
[i
].backend
->default_port
;
296 int ret
= cmdline_process_param(p
, (argc
> 1 ? argv
[1] : NULL
),
300 "plink: option \"%s\" requires an argument\n", p
);
302 } else if (ret
== 2) {
304 } else if (ret
== 1) {
306 } else if (!strcmp(p
, "-batch")) {
307 console_batch_mode
= 1;
308 } else if (!strcmp(p
, "-s")) {
309 /* Save status to write to cfg later. */
311 } else if (!strcmp(p
, "-V")) {
313 } else if (!strcmp(p
, "-o")) {
316 "plink: option \"-o\" requires an argument\n");
320 provide_xrm_string(*++argv
);
323 fprintf(stderr
, "plink: unknown option \"%s\"\n", p
);
330 do_defaults(NULL
, &cfg
);
333 * If the hostname starts with "telnet:", set the
334 * protocol to Telnet and process the string as a
337 if (!strncmp(q
, "telnet:", 7)) {
341 if (q
[0] == '/' && q
[1] == '/')
343 cfg
.protocol
= PROT_TELNET
;
345 while (*p
&& *p
!= ':' && *p
!= '/')
354 strncpy(cfg
.host
, q
, sizeof(cfg
.host
) - 1);
355 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
357 char *r
, *user
, *host
;
359 * Before we process the [user@]host string, we
360 * first check for the presence of a protocol
361 * prefix (a protocol name followed by ",").
366 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
367 j
= strlen(backends
[i
].name
);
369 !memcmp(backends
[i
].name
, p
, j
)) {
370 default_protocol
= cfg
.protocol
=
371 backends
[i
].protocol
;
373 backends
[i
].backend
->default_port
;
381 * A nonzero length string followed by an @ is treated
382 * as a username. (We discount an _initial_ @.) The
383 * rest of the string (or the whole string if no @)
384 * is treated as a session name and/or hostname.
388 p
++, r
= NULL
; /* discount initial @ */
393 user
= NULL
, host
= p
;
397 * Now attempt to load a saved session with the
398 * same name as the hostname.
402 do_defaults(host
, &cfg2
);
403 if (loaded_session
|| cfg2
.host
[0] == '\0') {
404 /* No settings for this host; use defaults */
405 /* (or session was already loaded with -load) */
406 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
407 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
408 cfg
.port
= default_port
;
411 /* Ick: patch up internal pointer after copy */
412 cfg
.remote_cmd_ptr
= cfg
.remote_cmd
;
417 /* Patch in specified username. */
418 strncpy(cfg
.username
, user
,
419 sizeof(cfg
.username
) - 1);
420 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
427 cmdlen
= cmdsize
= 0;
432 if (cmdlen
>= cmdsize
) {
433 cmdsize
= cmdlen
+ 512;
434 command
= sresize(command
, cmdsize
, char);
436 command
[cmdlen
++]=*p
++;
438 if (cmdlen
>= cmdsize
) {
439 cmdsize
= cmdlen
+ 512;
440 command
= sresize(command
, cmdsize
, char);
442 command
[cmdlen
++]=' '; /* always add trailing space */
443 if (--argc
) p
= *++argv
;
445 if (cmdlen
) command
[--cmdlen
]='\0';
446 /* change trailing blank to NUL */
447 cfg
.remote_cmd_ptr
= command
;
448 cfg
.remote_cmd_ptr2
= NULL
;
449 cfg
.nopty
= TRUE
; /* command => no terminal */
451 break; /* done with cmdline */
464 * Trim leading whitespace off the hostname if it's there.
467 int space
= strspn(cfg
.host
, " \t");
468 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
471 /* See if host is of the form user@host */
472 if (cfg
.host
[0] != '\0') {
473 char *atsign
= strrchr(cfg
.host
, '@');
474 /* Make sure we're not overflowing the user field */
476 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
477 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
478 cfg
.username
[atsign
- cfg
.host
] = '\0';
480 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
485 * Perform command-line overrides on session configuration.
487 cmdline_run_saved(&cfg
);
490 * Apply subsystem status.
493 cfg
.ssh_subsys
= TRUE
;
496 * Trim a colon suffix off the hostname if it's there.
498 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
501 * Remove any remaining whitespace from the hostname.
505 while (cfg
.host
[p2
] != '\0') {
506 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
507 cfg
.host
[p1
] = cfg
.host
[p2
];
515 if (!*cfg
.remote_cmd_ptr
)
516 flags
|= FLAG_INTERACTIVE
;
519 * Select protocol. This is farmed out into a table in a
520 * separate file to enable an ssh-free variant.
525 for (i
= 0; backends
[i
].backend
!= NULL
; i
++)
526 if (backends
[i
].protocol
== cfg
.protocol
) {
527 back
= backends
[i
].backend
;
532 "Internal fault: Unsupported protocol found\n");
540 if (portnumber
!= -1)
541 cfg
.port
= portnumber
;
544 * Set up the pipe we'll use to tell us about SIGWINCH.
546 if (pipe(signalpipe
) < 0) {
550 putty_signal(SIGWINCH
, sigwinch
);
556 * Start up the connection.
558 logctx
= log_init(NULL
, &cfg
);
559 console_provide_logctx(logctx
);
563 /* nodelay is only useful if stdin is a terminal device */
564 int nodelay
= cfg
.tcp_nodelay
&& isatty(0);
566 error
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
,
567 &realhost
, nodelay
, cfg
.tcp_keepalives
);
569 fprintf(stderr
, "Unable to open connection:\n%s\n", error
);
572 back
->provide_logctx(backhandle
, logctx
);
573 ldisc
= ldisc_create(&cfg
, NULL
, back
, backhandle
, NULL
);
579 * Set up the initial console mode. We don't care if this call
580 * fails, because we know we aren't necessarily running in a
583 tcgetattr(0, &orig_termios
);
584 atexit(cleanup_termios
);
585 ldisc_update(NULL
, 1, 1);
589 fd_set rset
, wset
, xset
;
599 FD_SET_MAX(signalpipe
[0], maxfd
, rset
);
601 if (connopen
&& !sending
&&
602 back
->socket(backhandle
) != NULL
&&
603 back
->sendok(backhandle
) &&
604 back
->sendbuffer(backhandle
) < MAX_STDIN_BACKLOG
) {
605 /* If we're OK to send, then try to read from stdin. */
606 FD_SET_MAX(0, maxfd
, rset
);
609 if (bufchain_size(&stdout_data
) > 0) {
610 /* If we have data for stdout, try to write to stdout. */
611 FD_SET_MAX(1, maxfd
, wset
);
614 if (bufchain_size(&stderr_data
) > 0) {
615 /* If we have data for stderr, try to write to stderr. */
616 FD_SET_MAX(2, maxfd
, wset
);
619 /* Count the currently active fds. */
621 for (fd
= first_fd(&fdstate
, &rwx
); fd
>= 0;
622 fd
= next_fd(&fdstate
, &rwx
)) i
++;
624 /* Expand the fdlist buffer if necessary. */
627 fdlist
= sresize(fdlist
, fdsize
, int);
631 * Add all currently open fds to the select sets, and store
632 * them in fdlist as well.
635 for (fd
= first_fd(&fdstate
, &rwx
); fd
>= 0;
636 fd
= next_fd(&fdstate
, &rwx
)) {
637 fdlist
[fdcount
++] = fd
;
639 FD_SET_MAX(fd
, maxfd
, rset
);
641 FD_SET_MAX(fd
, maxfd
, wset
);
643 FD_SET_MAX(fd
, maxfd
, xset
);
647 ret
= select(maxfd
, &rset
, &wset
, &xset
, NULL
);
648 } while (ret
< 0 && errno
== EINTR
);
655 for (i
= 0; i
< fdcount
; i
++) {
658 * We must process exceptional notifications before
659 * ordinary readability ones, or we may go straight
660 * past the urgent marker.
662 if (FD_ISSET(fd
, &xset
))
663 select_result(fd
, 4);
664 if (FD_ISSET(fd
, &rset
))
665 select_result(fd
, 1);
666 if (FD_ISSET(fd
, &wset
))
667 select_result(fd
, 2);
670 if (FD_ISSET(signalpipe
[0], &rset
)) {
673 read(signalpipe
[0], c
, 1); /* ignore its value; it'll be `x' */
674 if (ioctl(0, TIOCGWINSZ
, (void *)&size
) >= 0)
675 back
->size(backhandle
, size
.ws_col
, size
.ws_row
);
678 if (FD_ISSET(0, &rset
)) {
682 if (connopen
&& back
->socket(backhandle
) != NULL
) {
683 ret
= read(0, buf
, sizeof(buf
));
685 perror("stdin: read");
687 } else if (ret
== 0) {
688 back
->special(backhandle
, TS_EOF
);
689 sending
= FALSE
; /* send nothing further after this */
691 back
->send(backhandle
, buf
, ret
);
696 if (FD_ISSET(1, &wset
)) {
700 if (FD_ISSET(2, &wset
)) {
704 if ((!connopen
|| back
->socket(backhandle
) == NULL
) &&
705 bufchain_size(&stdout_data
) == 0 &&
706 bufchain_size(&stderr_data
) == 0)
707 break; /* we closed the connection */
709 exitcode
= back
->exitcode(backhandle
);
711 fprintf(stderr
, "Remote process exit code unavailable\n");
712 exitcode
= 1; /* this is an error condition */
714 cleanup_exit(exitcode
);
715 return exitcode
; /* shouldn't happen, but placates gcc */