2 * PLink - a Windows command-line (stdin/stdout) variant of PuTTY.
10 #define PUTTY_DO_GLOBALS /* actually _define_ globals */
15 #define WM_AGENT_CALLBACK (WM_APP + 4)
17 struct agent_callback
{
18 void (*callback
)(void *, void *, int);
24 void fatalbox(char *p
, ...)
27 fprintf(stderr
, "FATAL ERROR: ");
29 vfprintf(stderr
, p
, ap
);
38 void modalfatalbox(char *p
, ...)
41 fprintf(stderr
, "FATAL ERROR: ");
43 vfprintf(stderr
, p
, ap
);
52 void connection_fatal(void *frontend
, char *p
, ...)
55 fprintf(stderr
, "FATAL ERROR: ");
57 vfprintf(stderr
, p
, ap
);
66 void cmdline_error(char *p
, ...)
69 fprintf(stderr
, "plink: ");
71 vfprintf(stderr
, p
, ap
);
77 HANDLE inhandle
, outhandle
, errhandle
;
78 struct handle
*stdin_handle
, *stdout_handle
, *stderr_handle
;
79 DWORD orig_console_mode
;
85 static void *backhandle
;
88 int term_ldisc(Terminal
*term
, int mode
)
92 void ldisc_update(void *frontend
, int echo
, int edit
)
94 /* Update stdin read mode to reflect changes in line discipline. */
97 mode
= ENABLE_PROCESSED_INPUT
;
99 mode
= mode
| ENABLE_ECHO_INPUT
;
101 mode
= mode
& ~ENABLE_ECHO_INPUT
;
103 mode
= mode
| ENABLE_LINE_INPUT
;
105 mode
= mode
& ~ENABLE_LINE_INPUT
;
106 SetConsoleMode(inhandle
, mode
);
109 char *get_ttymode(void *frontend
, const char *mode
) { return NULL
; }
111 int from_backend(void *frontend_handle
, int is_stderr
,
112 const char *data
, int len
)
115 handle_write(stderr_handle
, data
, len
);
117 handle_write(stdout_handle
, data
, len
);
120 return handle_backlog(stdout_handle
) + handle_backlog(stderr_handle
);
123 int from_backend_untrusted(void *frontend_handle
, const char *data
, int len
)
126 * No "untrusted" output should get here (the way the code is
127 * currently, it's all diverted by FLAG_STDERR).
129 assert(!"Unexpected call to from_backend_untrusted()");
130 return 0; /* not reached */
133 int get_userpass_input(prompts_t
*p
, unsigned char *in
, int inlen
)
136 ret
= cmdline_get_passwd_input(p
, in
, inlen
);
138 ret
= console_get_userpass_input(p
, in
, inlen
);
142 static DWORD main_thread_id
;
144 void agent_schedule_callback(void (*callback
)(void *, void *, int),
145 void *callback_ctx
, void *data
, int len
)
147 struct agent_callback
*c
= snew(struct agent_callback
);
148 c
->callback
= callback
;
149 c
->callback_ctx
= callback_ctx
;
152 PostThreadMessage(main_thread_id
, WM_AGENT_CALLBACK
, 0, (LPARAM
)c
);
156 * Short description of parameters.
158 static void usage(void)
160 printf("PuTTY Link: command-line connection utility\n");
162 printf("Usage: plink [options] [user@]host [command]\n");
163 printf(" (\"host\" can also be a PuTTY saved session name)\n");
164 printf("Options:\n");
165 printf(" -V print version information and exit\n");
166 printf(" -pgpfp print PGP key fingerprints and exit\n");
167 printf(" -v show verbose messages\n");
168 printf(" -load sessname Load settings from saved session\n");
169 printf(" -ssh -telnet -rlogin -raw -serial\n");
170 printf(" force use of a particular protocol\n");
171 printf(" -P port connect to specified port\n");
172 printf(" -l user connect with specified username\n");
173 printf(" -batch disable all interactive prompts\n");
174 printf("The following options only apply to SSH connections:\n");
175 printf(" -pw passw login with specified password\n");
176 printf(" -D [listen-IP:]listen-port\n");
177 printf(" Dynamic SOCKS-based port forwarding\n");
178 printf(" -L [listen-IP:]listen-port:host:port\n");
179 printf(" Forward local port to remote address\n");
180 printf(" -R [listen-IP:]listen-port:host:port\n");
181 printf(" Forward remote port to local address\n");
182 printf(" -X -x enable / disable X11 forwarding\n");
183 printf(" -A -a enable / disable agent forwarding\n");
184 printf(" -t -T enable / disable pty allocation\n");
185 printf(" -1 -2 force use of particular protocol version\n");
186 printf(" -4 -6 force use of IPv4 or IPv6\n");
187 printf(" -C enable compression\n");
188 printf(" -i key private key file for authentication\n");
189 printf(" -noagent disable use of Pageant\n");
190 printf(" -agent enable use of Pageant\n");
191 printf(" -m file read remote command(s) from file\n");
192 printf(" -s remote command is an SSH subsystem (SSH-2 only)\n");
193 printf(" -N don't start a shell/command (SSH-2 only)\n");
194 printf(" -nc host:port\n");
195 printf(" open tunnel in place of session (SSH-2 only)\n");
196 printf(" -sercfg configuration-string (e.g. 19200,8,n,1,X)\n");
197 printf(" Specify the serial configuration (serial only)\n");
201 static void version(void)
203 printf("plink: %s\n", ver
);
207 char *do_select(SOCKET skt
, int startup
)
211 events
= (FD_CONNECT
| FD_READ
| FD_WRITE
|
212 FD_OOB
| FD_CLOSE
| FD_ACCEPT
);
216 if (p_WSAEventSelect(skt
, netevent
, events
) == SOCKET_ERROR
) {
217 switch (p_WSAGetLastError()) {
219 return "Network is down";
221 return "WSAEventSelect(): unknown error";
227 int stdin_gotdata(struct handle
*h
, void *data
, int len
)
231 * Special case: report read error.
234 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, -len
, 0,
235 buf
, lenof(buf
), NULL
);
236 buf
[lenof(buf
)-1] = '\0';
237 if (buf
[strlen(buf
)-1] == '\n')
238 buf
[strlen(buf
)-1] = '\0';
239 fprintf(stderr
, "Unable to read from standard input: %s\n", buf
);
242 noise_ultralight(len
);
243 if (connopen
&& back
->connected(backhandle
)) {
245 return back
->send(backhandle
, data
, len
);
247 back
->special(backhandle
, TS_EOF
);
254 void stdouterr_sent(struct handle
*h
, int new_backlog
)
256 if (new_backlog
< 0) {
258 * Special case: report write error.
261 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, -new_backlog
, 0,
262 buf
, lenof(buf
), NULL
);
263 buf
[lenof(buf
)-1] = '\0';
264 if (buf
[strlen(buf
)-1] == '\n')
265 buf
[strlen(buf
)-1] = '\0';
266 fprintf(stderr
, "Unable to write to standard %s: %s\n",
267 (h
== stdout_handle ?
"output" : "error"), buf
);
270 if (connopen
&& back
->connected(backhandle
)) {
271 back
->unthrottle(backhandle
, (handle_backlog(stdout_handle
) +
272 handle_backlog(stderr_handle
)));
276 int main(int argc
, char **argv
)
284 int got_host
= FALSE
;
285 int use_subsystem
= 0;
289 skcount
= sksize
= 0;
291 * Initialise port and protocol to sensible defaults. (These
292 * will be overridden by more or less anything.)
294 default_protocol
= PROT_SSH
;
299 * Process the command line.
302 do_defaults(NULL
, conf
);
303 loaded_session
= FALSE
;
304 default_protocol
= conf_get_int(conf
, CONF_protocol
);
305 default_port
= conf_get_int(conf
, CONF_port
);
309 * Override the default protocol if PLINK_PROTOCOL is set.
311 char *p
= getenv("PLINK_PROTOCOL");
313 const Backend
*b
= backend_from_name(p
);
315 default_protocol
= b
->protocol
;
316 default_port
= b
->default_port
;
317 conf_set_int(conf
, CONF_protocol
, default_protocol
);
318 conf_set_int(conf
, CONF_port
, default_port
);
325 int ret
= cmdline_process_param(p
, (argc
> 1 ? argv
[1] : NULL
),
329 "plink: option \"%s\" requires an argument\n", p
);
331 } else if (ret
== 2) {
333 } else if (ret
== 1) {
335 } else if (!strcmp(p
, "-batch")) {
336 console_batch_mode
= 1;
337 } else if (!strcmp(p
, "-s")) {
338 /* Save status to write to conf later. */
340 } else if (!strcmp(p
, "-V")) {
342 } else if (!strcmp(p
, "-pgpfp")) {
346 fprintf(stderr
, "plink: unknown option \"%s\"\n", p
);
350 if (!conf_launchable(conf
) || !(got_host
|| loaded_session
)) {
353 * If the hostname starts with "telnet:", set the
354 * protocol to Telnet and process the string as a
357 if (!strncmp(q
, "telnet:", 7)) {
361 if (q
[0] == '/' && q
[1] == '/')
363 conf_set_int(conf
, CONF_protocol
, PROT_TELNET
);
365 while (*p
&& *p
!= ':' && *p
!= '/')
371 conf_set_int(conf
, CONF_port
, atoi(p
));
373 conf_set_int(conf
, CONF_port
, -1);
374 conf_set_str(conf
, CONF_host
, q
);
377 char *r
, *user
, *host
;
379 * Before we process the [user@]host string, we
380 * first check for the presence of a protocol
381 * prefix (a protocol name followed by ",").
387 b
= backend_from_name(p
);
389 default_protocol
= b
->protocol
;
390 conf_set_int(conf
, CONF_protocol
,
392 portnumber
= b
->default_port
;
398 * A nonzero length string followed by an @ is treated
399 * as a username. (We discount an _initial_ @.) The
400 * rest of the string (or the whole string if no @)
401 * is treated as a session name and/or hostname.
405 p
++, r
= NULL
; /* discount initial @ */
410 user
= NULL
, host
= p
;
414 * Now attempt to load a saved session with the
415 * same name as the hostname.
418 Conf
*conf2
= conf_new();
419 do_defaults(host
, conf2
);
420 if (loaded_session
|| !conf_launchable(conf2
)) {
421 /* No settings for this host; use defaults */
422 /* (or session was already loaded with -load) */
423 conf_set_str(conf
, CONF_host
, host
);
424 conf_set_int(conf
, CONF_port
, default_port
);
427 conf_copy_into(conf
, conf2
);
428 loaded_session
= TRUE
;
434 /* Patch in specified username. */
435 conf_set_str(conf
, CONF_username
, user
);
442 cmdlen
= cmdsize
= 0;
447 if (cmdlen
>= cmdsize
) {
448 cmdsize
= cmdlen
+ 512;
449 command
= sresize(command
, cmdsize
, char);
451 command
[cmdlen
++]=*p
++;
453 if (cmdlen
>= cmdsize
) {
454 cmdsize
= cmdlen
+ 512;
455 command
= sresize(command
, cmdsize
, char);
457 command
[cmdlen
++]=' '; /* always add trailing space */
458 if (--argc
) p
= *++argv
;
460 if (cmdlen
) command
[--cmdlen
]='\0';
461 /* change trailing blank to NUL */
462 conf_set_str(conf
, CONF_remote_cmd
, command
);
463 conf_set_str(conf
, CONF_remote_cmd2
, "");
464 conf_set_int(conf
, CONF_nopty
, TRUE
); /* command => no tty */
466 break; /* done with cmdline */
474 if (!conf_launchable(conf
) || !(got_host
|| loaded_session
)) {
479 * Muck about with the hostname in various ways.
482 char *hostbuf
= dupstr(conf_get_str(conf
, CONF_host
));
483 char *host
= hostbuf
;
487 * Trim leading whitespace.
489 host
+= strspn(host
, " \t");
492 * See if host is of the form user@host, and separate out
493 * the username if so.
495 if (host
[0] != '\0') {
496 char *atsign
= strrchr(host
, '@');
499 conf_set_str(conf
, CONF_username
, host
);
505 * Trim off a colon suffix if it's there.
507 host
[strcspn(host
, ":")] = '\0';
510 * Remove any remaining whitespace.
515 if (*q
!= ' ' && *q
!= '\t')
521 conf_set_str(conf
, CONF_host
, hostbuf
);
526 * Perform command-line overrides on session configuration.
528 cmdline_run_saved(conf
);
531 * Apply subsystem status.
534 conf_set_int(conf
, CONF_ssh_subsys
, TRUE
);
536 if (!*conf_get_str(conf
, CONF_remote_cmd
) &&
537 !*conf_get_str(conf
, CONF_remote_cmd2
) &&
538 !*conf_get_str(conf
, CONF_ssh_nc_host
))
539 flags
|= FLAG_INTERACTIVE
;
542 * Select protocol. This is farmed out into a table in a
543 * separate file to enable an ssh-free variant.
545 back
= backend_from_proto(conf_get_int(conf
, CONF_protocol
));
548 "Internal fault: Unsupported protocol found\n");
555 if (portnumber
!= -1)
556 conf_set_int(conf
, CONF_port
, portnumber
);
559 if (p_WSAEventSelect
== NULL
) {
560 fprintf(stderr
, "Plink requires WinSock 2\n");
564 logctx
= log_init(NULL
, conf
);
565 console_provide_logctx(logctx
);
568 * Start up the connection.
570 netevent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
574 /* nodelay is only useful if stdin is a character device (console) */
575 int nodelay
= conf_get_int(conf
, CONF_tcp_nodelay
) &&
576 (GetFileType(GetStdHandle(STD_INPUT_HANDLE
)) == FILE_TYPE_CHAR
);
578 error
= back
->init(NULL
, &backhandle
, conf
,
579 conf_get_str(conf
, CONF_host
),
580 conf_get_int(conf
, CONF_port
),
582 conf_get_int(conf
, CONF_tcp_keepalives
));
584 fprintf(stderr
, "Unable to open connection:\n%s", error
);
587 back
->provide_logctx(backhandle
, logctx
);
592 inhandle
= GetStdHandle(STD_INPUT_HANDLE
);
593 outhandle
= GetStdHandle(STD_OUTPUT_HANDLE
);
594 errhandle
= GetStdHandle(STD_ERROR_HANDLE
);
597 * Turn off ECHO and LINE input modes. We don't care if this
598 * call fails, because we know we aren't necessarily running in
601 GetConsoleMode(inhandle
, &orig_console_mode
);
602 SetConsoleMode(inhandle
, ENABLE_PROCESSED_INPUT
);
605 * Pass the output handles to the handle-handling subsystem.
606 * (The input one we leave until we're through the
607 * authentication process.)
609 stdout_handle
= handle_output_new(outhandle
, stdouterr_sent
, NULL
, 0);
610 stderr_handle
= handle_output_new(errhandle
, stdouterr_sent
, NULL
, 0);
612 main_thread_id
= GetCurrentThreadId();
616 now
= GETTICKCOUNT();
624 if (!sending
&& back
->sendok(backhandle
)) {
625 stdin_handle
= handle_input_new(inhandle
, stdin_gotdata
, NULL
,
630 if (run_timers(now
, &next
)) {
631 ticks
= next
- GETTICKCOUNT();
632 if (ticks
< 0) ticks
= 0; /* just in case */
637 handles
= handle_get_events(&nhandles
);
638 handles
= sresize(handles
, nhandles
+1, HANDLE
);
639 handles
[nhandles
] = netevent
;
640 n
= MsgWaitForMultipleObjects(nhandles
+1, handles
, FALSE
, ticks
,
642 if ((unsigned)(n
- WAIT_OBJECT_0
) < (unsigned)nhandles
) {
643 handle_got_event(handles
[n
- WAIT_OBJECT_0
]);
644 } else if (n
== WAIT_OBJECT_0
+ nhandles
) {
645 WSANETWORKEVENTS things
;
647 extern SOCKET
first_socket(int *), next_socket(int *);
648 extern int select_result(WPARAM
, LPARAM
);
652 * We must not call select_result() for any socket
653 * until we have finished enumerating within the tree.
654 * This is because select_result() may close the socket
655 * and modify the tree.
657 /* Count the active sockets. */
659 for (socket
= first_socket(&socketstate
);
660 socket
!= INVALID_SOCKET
;
661 socket
= next_socket(&socketstate
)) i
++;
663 /* Expand the buffer if necessary. */
666 sklist
= sresize(sklist
, sksize
, SOCKET
);
669 /* Retrieve the sockets into sklist. */
671 for (socket
= first_socket(&socketstate
);
672 socket
!= INVALID_SOCKET
;
673 socket
= next_socket(&socketstate
)) {
674 sklist
[skcount
++] = socket
;
677 /* Now we're done enumerating; go through the list. */
678 for (i
= 0; i
< skcount
; i
++) {
681 wp
= (WPARAM
) socket
;
682 if (!p_WSAEnumNetworkEvents(socket
, NULL
, &things
)) {
683 static const struct { int bit
, mask
; } eventtypes
[] = {
684 {FD_CONNECT_BIT
, FD_CONNECT
},
685 {FD_READ_BIT
, FD_READ
},
686 {FD_CLOSE_BIT
, FD_CLOSE
},
687 {FD_OOB_BIT
, FD_OOB
},
688 {FD_WRITE_BIT
, FD_WRITE
},
689 {FD_ACCEPT_BIT
, FD_ACCEPT
},
693 noise_ultralight(socket
);
694 noise_ultralight(things
.lNetworkEvents
);
696 for (e
= 0; e
< lenof(eventtypes
); e
++)
697 if (things
.lNetworkEvents
& eventtypes
[e
].mask
) {
699 int err
= things
.iErrorCode
[eventtypes
[e
].bit
];
700 lp
= WSAMAKESELECTREPLY(eventtypes
[e
].mask
, err
);
701 connopen
&= select_result(wp
, lp
);
705 } else if (n
== WAIT_OBJECT_0
+ nhandles
+ 1) {
707 while (PeekMessage(&msg
, INVALID_HANDLE_VALUE
,
708 WM_AGENT_CALLBACK
, WM_AGENT_CALLBACK
,
710 struct agent_callback
*c
= (struct agent_callback
*)msg
.lParam
;
711 c
->callback(c
->callback_ctx
, c
->data
, c
->len
);
716 if (n
== WAIT_TIMEOUT
) {
719 now
= GETTICKCOUNT();
725 handle_unthrottle(stdin_handle
, back
->sendbuffer(backhandle
));
727 if ((!connopen
|| !back
->connected(backhandle
)) &&
728 handle_backlog(stdout_handle
) + handle_backlog(stderr_handle
) == 0)
729 break; /* we closed the connection */
731 exitcode
= back
->exitcode(backhandle
);
733 fprintf(stderr
, "Remote process exit code unavailable\n");
734 exitcode
= 1; /* this is an error condition */
736 cleanup_exit(exitcode
);
737 return 0; /* placate compiler warning */