2 * PLink - a command-line (stdin/stdout) variant of PuTTY.
14 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
19 #define WM_AGENT_CALLBACK (WM_XUSER + 4)
21 #define MAX_STDIN_BACKLOG 4096
23 struct agent_callback
{
24 void (*callback
)(void *, void *, int);
30 void fatalbox(char *p
, ...)
33 fprintf(stderr
, "FATAL ERROR: ");
35 vfprintf(stderr
, p
, ap
);
41 void modalfatalbox(char *p
, ...)
44 fprintf(stderr
, "FATAL ERROR: ");
46 vfprintf(stderr
, p
, ap
);
52 void connection_fatal(void *frontend
, char *p
, ...)
55 fprintf(stderr
, "FATAL ERROR: ");
57 vfprintf(stderr
, p
, ap
);
63 void cmdline_error(char *p
, ...)
66 fprintf(stderr
, "plink: ");
68 vfprintf(stderr
, p
, ap
);
74 HANDLE inhandle
, outhandle
, errhandle
;
75 DWORD orig_console_mode
;
80 static void *backhandle
;
83 int term_ldisc(Terminal
*term
, int mode
)
87 void ldisc_update(void *frontend
, int echo
, int edit
)
89 /* Update stdin read mode to reflect changes in line discipline. */
92 mode
= ENABLE_PROCESSED_INPUT
;
94 mode
= mode
| ENABLE_ECHO_INPUT
;
96 mode
= mode
& ~ENABLE_ECHO_INPUT
;
98 mode
= mode
| ENABLE_LINE_INPUT
;
100 mode
= mode
& ~ENABLE_LINE_INPUT
;
101 SetConsoleMode(inhandle
, mode
);
107 HANDLE event
, eventback
;
110 static DWORD WINAPI
stdin_read_thread(void *param
)
112 struct input_data
*idata
= (struct input_data
*) param
;
115 inhandle
= GetStdHandle(STD_INPUT_HANDLE
);
117 while (ReadFile(inhandle
, idata
->buffer
, sizeof(idata
->buffer
),
118 &idata
->len
, NULL
) && idata
->len
> 0) {
119 SetEvent(idata
->event
);
120 WaitForSingleObject(idata
->eventback
, INFINITE
);
124 SetEvent(idata
->event
);
130 DWORD len
, lenwritten
;
134 HANDLE event
, eventback
;
138 static DWORD WINAPI
stdout_write_thread(void *param
)
140 struct output_data
*odata
= (struct output_data
*) param
;
141 HANDLE outhandle
, errhandle
;
143 outhandle
= GetStdHandle(STD_OUTPUT_HANDLE
);
144 errhandle
= GetStdHandle(STD_ERROR_HANDLE
);
147 WaitForSingleObject(odata
->eventback
, INFINITE
);
151 WriteFile(odata
->is_stderr ? errhandle
: outhandle
,
152 odata
->buffer
, odata
->len
, &odata
->lenwritten
, NULL
);
153 SetEvent(odata
->event
);
159 bufchain stdout_data
, stderr_data
;
160 struct output_data odata
, edata
;
162 void try_output(int is_stderr
)
164 struct output_data
*data
= (is_stderr ?
&edata
: &odata
);
169 bufchain_prefix(is_stderr ?
&stderr_data
: &stdout_data
,
170 &senddata
, &sendlen
);
171 data
->buffer
= senddata
;
173 SetEvent(data
->eventback
);
178 int from_backend(void *frontend_handle
, int is_stderr
,
179 const char *data
, int len
)
186 bufchain_add(&stderr_data
, data
, len
);
189 bufchain_add(&stdout_data
, data
, len
);
193 osize
= bufchain_size(&stdout_data
);
194 esize
= bufchain_size(&stderr_data
);
196 return osize
+ esize
;
199 static DWORD main_thread_id
;
201 void agent_schedule_callback(void (*callback
)(void *, void *, int),
202 void *callback_ctx
, void *data
, int len
)
204 struct agent_callback
*c
= snew(struct agent_callback
);
205 c
->callback
= callback
;
206 c
->callback_ctx
= callback_ctx
;
209 PostThreadMessage(main_thread_id
, WM_AGENT_CALLBACK
, 0, (LPARAM
)c
);
213 * Short description of parameters.
215 static void usage(void)
217 printf("PuTTY Link: command-line connection utility\n");
219 printf("Usage: plink [options] [user@]host [command]\n");
220 printf(" (\"host\" can also be a PuTTY saved session name)\n");
221 printf("Options:\n");
222 printf(" -v show verbose messages\n");
223 printf(" -load sessname Load settings from saved session\n");
224 printf(" -ssh -telnet -rlogin -raw\n");
225 printf(" force use of a particular protocol (default SSH)\n");
226 printf(" -P port connect to specified port\n");
227 printf(" -l user connect with specified username\n");
228 printf(" -m file read remote command(s) from file\n");
229 printf(" -batch disable all interactive prompts\n");
230 printf("The following options only apply to SSH connections:\n");
231 printf(" -pw passw login with specified password\n");
232 printf(" -D listen-port Dynamic SOCKS-based port forwarding\n");
233 printf(" -L listen-port:host:port Forward local port to "
235 printf(" -R listen-port:host:port Forward remote port to"
237 printf(" -X -x enable / disable X11 forwarding\n");
238 printf(" -A -a enable / disable agent forwarding\n");
239 printf(" -t -T enable / disable pty allocation\n");
240 printf(" -1 -2 force use of particular protocol version\n");
241 printf(" -C enable compression\n");
242 printf(" -i key private key file for authentication\n");
246 char *do_select(SOCKET skt
, int startup
)
250 events
= (FD_CONNECT
| FD_READ
| FD_WRITE
|
251 FD_OOB
| FD_CLOSE
| FD_ACCEPT
);
255 if (WSAEventSelect(skt
, netevent
, events
) == SOCKET_ERROR
) {
256 switch (WSAGetLastError()) {
258 return "Network is down";
260 return "WSAAsyncSelect(): unknown error";
266 int main(int argc
, char **argv
)
270 WSAEVENT stdinevent
, stdoutevent
, stderrevent
;
272 DWORD in_threadid
, out_threadid
, err_threadid
;
273 struct input_data idata
;
283 ssh_get_line
= console_get_line
;
286 skcount
= sksize
= 0;
288 * Initialise port and protocol to sensible defaults. (These
289 * will be overridden by more or less anything.)
291 default_protocol
= PROT_SSH
;
296 * Process the command line.
298 do_defaults(NULL
, &cfg
);
299 default_protocol
= cfg
.protocol
;
300 default_port
= cfg
.port
;
304 * Override the default protocol if PLINK_PROTOCOL is set.
306 char *p
= getenv("PLINK_PROTOCOL");
309 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
310 if (!strcmp(backends
[i
].name
, p
)) {
311 default_protocol
= cfg
.protocol
= backends
[i
].protocol
;
312 default_port
= cfg
.port
=
313 backends
[i
].backend
->default_port
;
322 int ret
= cmdline_process_param(p
, (argc
> 1 ? argv
[1] : NULL
),
326 "plink: option \"%s\" requires an argument\n", p
);
328 } else if (ret
== 2) {
330 } else if (ret
== 1) {
332 } else if (!strcmp(p
, "-batch")) {
333 console_batch_mode
= 1;
335 fprintf(stderr
, "plink: unknown option \"%s\"\n", p
);
342 * If the hostname starts with "telnet:", set the
343 * protocol to Telnet and process the string as a
346 if (!strncmp(q
, "telnet:", 7)) {
350 if (q
[0] == '/' && q
[1] == '/')
352 cfg
.protocol
= PROT_TELNET
;
354 while (*p
&& *p
!= ':' && *p
!= '/')
363 strncpy(cfg
.host
, q
, sizeof(cfg
.host
) - 1);
364 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
368 * Before we process the [user@]host string, we
369 * first check for the presence of a protocol
370 * prefix (a protocol name followed by ",").
375 for (i
= 0; backends
[i
].backend
!= NULL
; i
++) {
376 j
= strlen(backends
[i
].name
);
378 !memcmp(backends
[i
].name
, p
, j
)) {
379 default_protocol
= cfg
.protocol
=
380 backends
[i
].protocol
;
382 backends
[i
].backend
->default_port
;
390 * Three cases. Either (a) there's a nonzero
391 * length string followed by an @, in which
392 * case that's user and the remainder is host.
393 * Or (b) there's only one string, not counting
394 * a potential initial @, and it exists in the
395 * saved-sessions database. Or (c) only one
396 * string and it _doesn't_ exist in the
401 p
++, r
= NULL
; /* discount initial @ */
407 do_defaults(p
, &cfg2
);
408 if (cfg2
.host
[0] == '\0') {
409 /* No settings for this host; use defaults */
410 strncpy(cfg
.host
, p
, sizeof(cfg
.host
) - 1);
411 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
412 cfg
.port
= default_port
;
415 cfg
.remote_cmd_ptr
= cfg
.remote_cmd
;
419 strncpy(cfg
.username
, p
, sizeof(cfg
.username
) - 1);
420 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
421 strncpy(cfg
.host
, r
, sizeof(cfg
.host
) - 1);
422 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
423 cfg
.port
= default_port
;
429 cmdlen
= cmdsize
= 0;
434 if (cmdlen
>= cmdsize
) {
435 cmdsize
= cmdlen
+ 512;
436 command
= sresize(command
, cmdsize
, char);
438 command
[cmdlen
++]=*p
++;
440 if (cmdlen
>= cmdsize
) {
441 cmdsize
= cmdlen
+ 512;
442 command
= sresize(command
, cmdsize
, char);
444 command
[cmdlen
++]=' '; /* always add trailing space */
445 if (--argc
) p
= *++argv
;
447 if (cmdlen
) command
[--cmdlen
]='\0';
448 /* change trailing blank to NUL */
449 cfg
.remote_cmd_ptr
= command
;
450 cfg
.remote_cmd_ptr2
= NULL
;
451 cfg
.nopty
= TRUE
; /* command => no terminal */
453 break; /* done with cmdline */
466 * Trim leading whitespace off the hostname if it's there.
469 int space
= strspn(cfg
.host
, " \t");
470 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
473 /* See if host is of the form user@host */
474 if (cfg
.host
[0] != '\0') {
475 char *atsign
= strchr(cfg
.host
, '@');
476 /* Make sure we're not overflowing the user field */
478 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
479 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
480 cfg
.username
[atsign
- cfg
.host
] = '\0';
482 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
487 * Perform command-line overrides on session configuration.
489 cmdline_run_saved(&cfg
);
492 * Trim a colon suffix off the hostname if it's there.
494 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
497 * Remove any remaining whitespace from the hostname.
501 while (cfg
.host
[p2
] != '\0') {
502 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
503 cfg
.host
[p1
] = cfg
.host
[p2
];
511 if (!*cfg
.remote_cmd_ptr
)
512 flags
|= FLAG_INTERACTIVE
;
515 * Select protocol. This is farmed out into a table in a
516 * separate file to enable an ssh-free variant.
521 for (i
= 0; backends
[i
].backend
!= NULL
; i
++)
522 if (backends
[i
].protocol
== cfg
.protocol
) {
523 back
= backends
[i
].backend
;
528 "Internal fault: Unsupported protocol found\n");
536 if (portnumber
!= -1)
537 cfg
.port
= portnumber
;
540 * Initialise WinSock.
542 winsock_ver
= MAKEWORD(2, 0);
543 if (WSAStartup(winsock_ver
, &wsadata
)) {
544 MessageBox(NULL
, "Unable to initialise WinSock", "WinSock Error",
545 MB_OK
| MB_ICONEXCLAMATION
);
548 if (LOBYTE(wsadata
.wVersion
) != 2 || HIBYTE(wsadata
.wVersion
) != 0) {
549 MessageBox(NULL
, "WinSock version is incompatible with 2.0",
550 "WinSock Error", MB_OK
| MB_ICONEXCLAMATION
);
557 * Start up the connection.
559 netevent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
563 /* nodelay is only useful if stdin is a character device (console) */
564 int nodelay
= cfg
.tcp_nodelay
&&
565 (GetFileType(GetStdHandle(STD_INPUT_HANDLE
)) == FILE_TYPE_CHAR
);
567 error
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
,
570 fprintf(stderr
, "Unable to open connection:\n%s", error
);
573 logctx
= log_init(NULL
, &cfg
);
574 back
->provide_logctx(backhandle
, logctx
);
575 console_provide_logctx(logctx
);
580 stdinevent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
581 stdoutevent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
582 stderrevent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
584 inhandle
= GetStdHandle(STD_INPUT_HANDLE
);
585 outhandle
= GetStdHandle(STD_OUTPUT_HANDLE
);
586 errhandle
= GetStdHandle(STD_ERROR_HANDLE
);
587 GetConsoleMode(inhandle
, &orig_console_mode
);
588 SetConsoleMode(inhandle
, ENABLE_PROCESSED_INPUT
);
590 main_thread_id
= GetCurrentThreadId();
593 * Turn off ECHO and LINE input modes. We don't care if this
594 * call fails, because we know we aren't necessarily running in
597 handles
[0] = netevent
;
598 handles
[1] = stdinevent
;
599 handles
[2] = stdoutevent
;
600 handles
[3] = stderrevent
;
604 * Create spare threads to write to stdout and stderr, so we
605 * can arrange asynchronous writes.
607 odata
.event
= stdoutevent
;
608 odata
.eventback
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
610 odata
.busy
= odata
.done
= 0;
611 if (!CreateThread(NULL
, 0, stdout_write_thread
,
612 &odata
, 0, &out_threadid
)) {
613 fprintf(stderr
, "Unable to create output thread\n");
616 edata
.event
= stderrevent
;
617 edata
.eventback
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
619 edata
.busy
= edata
.done
= 0;
620 if (!CreateThread(NULL
, 0, stdout_write_thread
,
621 &edata
, 0, &err_threadid
)) {
622 fprintf(stderr
, "Unable to create error output thread\n");
629 if (!sending
&& back
->sendok(backhandle
)) {
631 * Create a separate thread to read from stdin. This is
632 * a total pain, but I can't find another way to do it:
634 * - an overlapped ReadFile or ReadFileEx just doesn't
635 * happen; we get failure from ReadFileEx, and
636 * ReadFile blocks despite being given an OVERLAPPED
637 * structure. Perhaps we can't do overlapped reads
638 * on consoles. WHY THE HELL NOT?
640 * - WaitForMultipleObjects(netevent, console) doesn't
641 * work, because it signals the console when
642 * _anything_ happens, including mouse motions and
643 * other things that don't cause data to be readable
644 * - so we're back to ReadFile blocking.
646 idata
.event
= stdinevent
;
647 idata
.eventback
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
648 if (!CreateThread(NULL
, 0, stdin_read_thread
,
649 &idata
, 0, &in_threadid
)) {
650 fprintf(stderr
, "Unable to create input thread\n");
656 n
= MsgWaitForMultipleObjects(4, handles
, FALSE
, INFINITE
,
659 WSANETWORKEVENTS things
;
661 extern SOCKET
first_socket(int *), next_socket(int *);
662 extern int select_result(WPARAM
, LPARAM
);
666 * We must not call select_result() for any socket
667 * until we have finished enumerating within the tree.
668 * This is because select_result() may close the socket
669 * and modify the tree.
671 /* Count the active sockets. */
673 for (socket
= first_socket(&socketstate
);
674 socket
!= INVALID_SOCKET
;
675 socket
= next_socket(&socketstate
)) i
++;
677 /* Expand the buffer if necessary. */
680 sklist
= sresize(sklist
, sksize
, SOCKET
);
683 /* Retrieve the sockets into sklist. */
685 for (socket
= first_socket(&socketstate
);
686 socket
!= INVALID_SOCKET
;
687 socket
= next_socket(&socketstate
)) {
688 sklist
[skcount
++] = socket
;
691 /* Now we're done enumerating; go through the list. */
692 for (i
= 0; i
< skcount
; i
++) {
695 wp
= (WPARAM
) socket
;
696 if (!WSAEnumNetworkEvents(socket
, NULL
, &things
)) {
697 static const struct { int bit
, mask
; } eventtypes
[] = {
698 {FD_CONNECT_BIT
, FD_CONNECT
},
699 {FD_READ_BIT
, FD_READ
},
700 {FD_CLOSE_BIT
, FD_CLOSE
},
701 {FD_OOB_BIT
, FD_OOB
},
702 {FD_WRITE_BIT
, FD_WRITE
},
703 {FD_ACCEPT_BIT
, FD_ACCEPT
},
707 noise_ultralight(socket
);
708 noise_ultralight(things
.lNetworkEvents
);
710 for (e
= 0; e
< lenof(eventtypes
); e
++)
711 if (things
.lNetworkEvents
& eventtypes
[e
].mask
) {
713 int err
= things
.iErrorCode
[eventtypes
[e
].bit
];
714 lp
= WSAMAKESELECTREPLY(eventtypes
[e
].mask
, err
);
715 connopen
&= select_result(wp
, lp
);
721 noise_ultralight(idata
.len
);
722 if (connopen
&& back
->socket(backhandle
) != NULL
) {
724 back
->send(backhandle
, idata
.buffer
, idata
.len
);
726 back
->special(backhandle
, TS_EOF
);
731 if (!odata
.writeret
) {
732 fprintf(stderr
, "Unable to write to standard output\n");
735 bufchain_consume(&stdout_data
, odata
.lenwritten
);
736 if (bufchain_size(&stdout_data
) > 0)
738 if (connopen
&& back
->socket(backhandle
) != NULL
) {
739 back
->unthrottle(backhandle
, bufchain_size(&stdout_data
) +
740 bufchain_size(&stderr_data
));
744 if (!edata
.writeret
) {
745 fprintf(stderr
, "Unable to write to standard output\n");
748 bufchain_consume(&stderr_data
, edata
.lenwritten
);
749 if (bufchain_size(&stderr_data
) > 0)
751 if (connopen
&& back
->socket(backhandle
) != NULL
) {
752 back
->unthrottle(backhandle
, bufchain_size(&stdout_data
) +
753 bufchain_size(&stderr_data
));
757 while (PeekMessage(&msg
, INVALID_HANDLE_VALUE
,
758 WM_AGENT_CALLBACK
, WM_AGENT_CALLBACK
,
760 struct agent_callback
*c
= (struct agent_callback
*)msg
.lParam
;
761 c
->callback(c
->callback_ctx
, c
->data
, c
->len
);
765 if (!reading
&& back
->sendbuffer(backhandle
) < MAX_STDIN_BACKLOG
) {
766 SetEvent(idata
.eventback
);
769 if ((!connopen
|| back
->socket(backhandle
) == NULL
) &&
770 bufchain_size(&stdout_data
) == 0 &&
771 bufchain_size(&stderr_data
) == 0)
772 break; /* we closed the connection */
775 exitcode
= back
->exitcode(backhandle
);
777 fprintf(stderr
, "Remote process exit code unavailable\n");
778 exitcode
= 1; /* this is an error condition */