]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - windows/winplink.c
Fix `puttygen-unix-perms': f_open(), PuTTY's wrapper on fopen, now
[PuTTY.git] / windows / winplink.c
1 /*
2  * PLink - a Windows command-line (stdin/stdout) variant of PuTTY.
3  */
4
5 #include <stdio.h>
6 #include <stdlib.h>
7 #include <assert.h>
8 #include <stdarg.h>
9
10 #define PUTTY_DO_GLOBALS               /* actually _define_ globals */
11 #include "putty.h"
12 #include "storage.h"
13 #include "tree234.h"
14
15 #define WM_AGENT_CALLBACK (WM_APP + 4)
16
17 struct agent_callback {
18     void (*callback)(void *, void *, int);
19     void *callback_ctx;
20     void *data;
21     int len;
22 };
23
24 void fatalbox(char *p, ...)
25 {
26     va_list ap;
27     fprintf(stderr, "FATAL ERROR: ");
28     va_start(ap, p);
29     vfprintf(stderr, p, ap);
30     va_end(ap);
31     fputc('\n', stderr);
32     if (logctx) {
33         log_free(logctx);
34         logctx = NULL;
35     }
36     cleanup_exit(1);
37 }
38 void modalfatalbox(char *p, ...)
39 {
40     va_list ap;
41     fprintf(stderr, "FATAL ERROR: ");
42     va_start(ap, p);
43     vfprintf(stderr, p, ap);
44     va_end(ap);
45     fputc('\n', stderr);
46     if (logctx) {
47         log_free(logctx);
48         logctx = NULL;
49     }
50     cleanup_exit(1);
51 }
52 void connection_fatal(void *frontend, char *p, ...)
53 {
54     va_list ap;
55     fprintf(stderr, "FATAL ERROR: ");
56     va_start(ap, p);
57     vfprintf(stderr, p, ap);
58     va_end(ap);
59     fputc('\n', stderr);
60     if (logctx) {
61         log_free(logctx);
62         logctx = NULL;
63     }
64     cleanup_exit(1);
65 }
66 void cmdline_error(char *p, ...)
67 {
68     va_list ap;
69     fprintf(stderr, "plink: ");
70     va_start(ap, p);
71     vfprintf(stderr, p, ap);
72     va_end(ap);
73     fputc('\n', stderr);
74     exit(1);
75 }
76
77 HANDLE inhandle, outhandle, errhandle;
78 struct handle *stdin_handle, *stdout_handle, *stderr_handle;
79 DWORD orig_console_mode;
80 int connopen;
81
82 WSAEVENT netevent;
83
84 static Backend *back;
85 static void *backhandle;
86 static Config cfg;
87
88 int term_ldisc(Terminal *term, int mode)
89 {
90     return FALSE;
91 }
92 void ldisc_update(void *frontend, int echo, int edit)
93 {
94     /* Update stdin read mode to reflect changes in line discipline. */
95     DWORD mode;
96
97     mode = ENABLE_PROCESSED_INPUT;
98     if (echo)
99         mode = mode | ENABLE_ECHO_INPUT;
100     else
101         mode = mode & ~ENABLE_ECHO_INPUT;
102     if (edit)
103         mode = mode | ENABLE_LINE_INPUT;
104     else
105         mode = mode & ~ENABLE_LINE_INPUT;
106     SetConsoleMode(inhandle, mode);
107 }
108
109 char *get_ttymode(void *frontend, const char *mode) { return NULL; }
110
111 int from_backend(void *frontend_handle, int is_stderr,
112                  const char *data, int len)
113 {
114     if (is_stderr) {
115         handle_write(stderr_handle, data, len);
116     } else {
117         handle_write(stdout_handle, data, len);
118     }
119
120     return handle_backlog(stdout_handle) + handle_backlog(stderr_handle);
121 }
122
123 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
124 {
125     /*
126      * No "untrusted" output should get here (the way the code is
127      * currently, it's all diverted by FLAG_STDERR).
128      */
129     assert(!"Unexpected call to from_backend_untrusted()");
130     return 0; /* not reached */
131 }
132
133 int get_userpass_input(prompts_t *p, unsigned char *in, int inlen)
134 {
135     int ret;
136     ret = cmdline_get_passwd_input(p, in, inlen);
137     if (ret == -1)
138         ret = console_get_userpass_input(p, in, inlen);
139     return ret;
140 }
141
142 static DWORD main_thread_id;
143
144 void agent_schedule_callback(void (*callback)(void *, void *, int),
145                              void *callback_ctx, void *data, int len)
146 {
147     struct agent_callback *c = snew(struct agent_callback);
148     c->callback = callback;
149     c->callback_ctx = callback_ctx;
150     c->data = data;
151     c->len = len;
152     PostThreadMessage(main_thread_id, WM_AGENT_CALLBACK, 0, (LPARAM)c);
153 }
154
155 /*
156  *  Short description of parameters.
157  */
158 static void usage(void)
159 {
160     printf("PuTTY Link: command-line connection utility\n");
161     printf("%s\n", ver);
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\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     exit(1);
197 }
198
199 static void version(void)
200 {
201     printf("plink: %s\n", ver);
202     exit(1);
203 }
204
205 char *do_select(SOCKET skt, int startup)
206 {
207     int events;
208     if (startup) {
209         events = (FD_CONNECT | FD_READ | FD_WRITE |
210                   FD_OOB | FD_CLOSE | FD_ACCEPT);
211     } else {
212         events = 0;
213     }
214     if (p_WSAEventSelect(skt, netevent, events) == SOCKET_ERROR) {
215         switch (p_WSAGetLastError()) {
216           case WSAENETDOWN:
217             return "Network is down";
218           default:
219             return "WSAEventSelect(): unknown error";
220         }
221     }
222     return NULL;
223 }
224
225 int stdin_gotdata(struct handle *h, void *data, int len)
226 {
227     if (len < 0) {
228         /*
229          * Special case: report read error.
230          */
231         fprintf(stderr, "Unable to read from standard input\n");
232         cleanup_exit(0);
233     }
234     noise_ultralight(len);
235     if (connopen && back->connected(backhandle)) {
236         if (len > 0) {
237             return back->send(backhandle, data, len);
238         } else {
239             back->special(backhandle, TS_EOF);
240             return 0;
241         }
242     } else
243         return 0;
244 }
245
246 void stdouterr_sent(struct handle *h, int new_backlog)
247 {
248     if (new_backlog < 0) {
249         /*
250          * Special case: report write error.
251          */
252         fprintf(stderr, "Unable to write to standard %s\n",
253                 (h == stdout_handle ? "output" : "error"));
254         cleanup_exit(0);
255     }
256     if (connopen && back->connected(backhandle)) {
257         back->unthrottle(backhandle, (handle_backlog(stdout_handle) +
258                                       handle_backlog(stderr_handle)));
259     }
260 }
261
262 int main(int argc, char **argv)
263 {
264     int sending;
265     int portnumber = -1;
266     SOCKET *sklist;
267     int skcount, sksize;
268     int exitcode;
269     int errors;
270     int use_subsystem = 0;
271     long now, next;
272
273     sklist = NULL;
274     skcount = sksize = 0;
275     /*
276      * Initialise port and protocol to sensible defaults. (These
277      * will be overridden by more or less anything.)
278      */
279     default_protocol = PROT_SSH;
280     default_port = 22;
281
282     flags = FLAG_STDERR;
283     /*
284      * Process the command line.
285      */
286     do_defaults(NULL, &cfg);
287     loaded_session = FALSE;
288     default_protocol = cfg.protocol;
289     default_port = cfg.port;
290     errors = 0;
291     {
292         /*
293          * Override the default protocol if PLINK_PROTOCOL is set.
294          */
295         char *p = getenv("PLINK_PROTOCOL");
296         int i;
297         if (p) {
298             for (i = 0; backends[i].backend != NULL; i++) {
299                 if (!strcmp(backends[i].name, p)) {
300                     default_protocol = cfg.protocol = backends[i].protocol;
301                     default_port = cfg.port =
302                         backends[i].backend->default_port;
303                     break;
304                 }
305             }
306         }
307     }
308     while (--argc) {
309         char *p = *++argv;
310         if (*p == '-') {
311             int ret = cmdline_process_param(p, (argc > 1 ? argv[1] : NULL),
312                                             1, &cfg);
313             if (ret == -2) {
314                 fprintf(stderr,
315                         "plink: option \"%s\" requires an argument\n", p);
316                 errors = 1;
317             } else if (ret == 2) {
318                 --argc, ++argv;
319             } else if (ret == 1) {
320                 continue;
321             } else if (!strcmp(p, "-batch")) {
322                 console_batch_mode = 1;
323             } else if (!strcmp(p, "-s")) {
324                 /* Save status to write to cfg later. */
325                 use_subsystem = 1;
326             } else if (!strcmp(p, "-V")) {
327                 version();
328             } else if (!strcmp(p, "-pgpfp")) {
329                 pgp_fingerprints();
330                 exit(1);
331             } else {
332                 fprintf(stderr, "plink: unknown option \"%s\"\n", p);
333                 errors = 1;
334             }
335         } else if (*p) {
336             if (!cfg_launchable(&cfg)) {
337                 char *q = p;
338                 /*
339                  * If the hostname starts with "telnet:", set the
340                  * protocol to Telnet and process the string as a
341                  * Telnet URL.
342                  */
343                 if (!strncmp(q, "telnet:", 7)) {
344                     char c;
345
346                     q += 7;
347                     if (q[0] == '/' && q[1] == '/')
348                         q += 2;
349                     cfg.protocol = PROT_TELNET;
350                     p = q;
351                     while (*p && *p != ':' && *p != '/')
352                         p++;
353                     c = *p;
354                     if (*p)
355                         *p++ = '\0';
356                     if (c == ':')
357                         cfg.port = atoi(p);
358                     else
359                         cfg.port = -1;
360                     strncpy(cfg.host, q, sizeof(cfg.host) - 1);
361                     cfg.host[sizeof(cfg.host) - 1] = '\0';
362                 } else {
363                     char *r, *user, *host;
364                     /*
365                      * Before we process the [user@]host string, we
366                      * first check for the presence of a protocol
367                      * prefix (a protocol name followed by ",").
368                      */
369                     r = strchr(p, ',');
370                     if (r) {
371                         int i, j;
372                         for (i = 0; backends[i].backend != NULL; i++) {
373                             j = strlen(backends[i].name);
374                             if (j == r - p &&
375                                 !memcmp(backends[i].name, p, j)) {
376                                 default_protocol = cfg.protocol =
377                                     backends[i].protocol;
378                                 portnumber =
379                                     backends[i].backend->default_port;
380                                 p = r + 1;
381                                 break;
382                             }
383                         }
384                     }
385
386                     /*
387                      * A nonzero length string followed by an @ is treated
388                      * as a username. (We discount an _initial_ @.) The
389                      * rest of the string (or the whole string if no @)
390                      * is treated as a session name and/or hostname.
391                      */
392                     r = strrchr(p, '@');
393                     if (r == p)
394                         p++, r = NULL; /* discount initial @ */
395                     if (r) {
396                         *r++ = '\0';
397                         user = p, host = r;
398                     } else {
399                         user = NULL, host = p;
400                     }
401
402                     /*
403                      * Now attempt to load a saved session with the
404                      * same name as the hostname.
405                      */
406                     {
407                         Config cfg2;
408                         do_defaults(host, &cfg2);
409                         if (loaded_session || !cfg_launchable(&cfg2)) {
410                             /* No settings for this host; use defaults */
411                             /* (or session was already loaded with -load) */
412                             strncpy(cfg.host, host, sizeof(cfg.host) - 1);
413                             cfg.host[sizeof(cfg.host) - 1] = '\0';
414                             cfg.port = default_port;
415                         } else {
416                             cfg = cfg2;
417                         }
418                     }
419
420                     if (user) {
421                         /* Patch in specified username. */
422                         strncpy(cfg.username, user,
423                                 sizeof(cfg.username) - 1);
424                         cfg.username[sizeof(cfg.username) - 1] = '\0';
425                     }
426
427                 }
428             } else {
429                 char *command;
430                 int cmdlen, cmdsize;
431                 cmdlen = cmdsize = 0;
432                 command = NULL;
433
434                 while (argc) {
435                     while (*p) {
436                         if (cmdlen >= cmdsize) {
437                             cmdsize = cmdlen + 512;
438                             command = sresize(command, cmdsize, char);
439                         }
440                         command[cmdlen++]=*p++;
441                     }
442                     if (cmdlen >= cmdsize) {
443                         cmdsize = cmdlen + 512;
444                         command = sresize(command, cmdsize, char);
445                     }
446                     command[cmdlen++]=' '; /* always add trailing space */
447                     if (--argc) p = *++argv;
448                 }
449                 if (cmdlen) command[--cmdlen]='\0';
450                                        /* change trailing blank to NUL */
451                 cfg.remote_cmd_ptr = command;
452                 cfg.remote_cmd_ptr2 = NULL;
453                 cfg.nopty = TRUE;      /* command => no terminal */
454
455                 break;                 /* done with cmdline */
456             }
457         }
458     }
459
460     if (errors)
461         return 1;
462
463     if (!cfg_launchable(&cfg)) {
464         usage();
465     }
466
467     /*
468      * Trim leading whitespace off the hostname if it's there.
469      */
470     {
471         int space = strspn(cfg.host, " \t");
472         memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
473     }
474
475     /* See if host is of the form user@host */
476     if (cfg_launchable(&cfg)) {
477         char *atsign = strrchr(cfg.host, '@');
478         /* Make sure we're not overflowing the user field */
479         if (atsign) {
480             if (atsign - cfg.host < sizeof cfg.username) {
481                 strncpy(cfg.username, cfg.host, atsign - cfg.host);
482                 cfg.username[atsign - cfg.host] = '\0';
483             }
484             memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
485         }
486     }
487
488     /*
489      * Perform command-line overrides on session configuration.
490      */
491     cmdline_run_saved(&cfg);
492
493     /*
494      * Apply subsystem status.
495      */
496     if (use_subsystem)
497         cfg.ssh_subsys = TRUE;
498
499     /*
500      * Trim a colon suffix off the hostname if it's there.
501      */
502     cfg.host[strcspn(cfg.host, ":")] = '\0';
503
504     /*
505      * Remove any remaining whitespace from the hostname.
506      */
507     {
508         int p1 = 0, p2 = 0;
509         while (cfg.host[p2] != '\0') {
510             if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
511                 cfg.host[p1] = cfg.host[p2];
512                 p1++;
513             }
514             p2++;
515         }
516         cfg.host[p1] = '\0';
517     }
518
519     if (!cfg.remote_cmd_ptr && !*cfg.remote_cmd && !*cfg.ssh_nc_host)
520         flags |= FLAG_INTERACTIVE;
521
522     /*
523      * Select protocol. This is farmed out into a table in a
524      * separate file to enable an ssh-free variant.
525      */
526     {
527         int i;
528         back = NULL;
529         for (i = 0; backends[i].backend != NULL; i++)
530             if (backends[i].protocol == cfg.protocol) {
531                 back = backends[i].backend;
532                 break;
533             }
534         if (back == NULL) {
535             fprintf(stderr,
536                     "Internal fault: Unsupported protocol found\n");
537             return 1;
538         }
539     }
540
541     /*
542      * Select port.
543      */
544     if (portnumber != -1)
545         cfg.port = portnumber;
546
547     sk_init();
548     if (p_WSAEventSelect == NULL) {
549         fprintf(stderr, "Plink requires WinSock 2\n");
550         return 1;
551     }
552
553     logctx = log_init(NULL, &cfg);
554     console_provide_logctx(logctx);
555
556     /*
557      * Start up the connection.
558      */
559     netevent = CreateEvent(NULL, FALSE, FALSE, NULL);
560     {
561         const char *error;
562         char *realhost;
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);
566
567         error = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port,
568                            &realhost, nodelay, cfg.tcp_keepalives);
569         if (error) {
570             fprintf(stderr, "Unable to open connection:\n%s", error);
571             return 1;
572         }
573         back->provide_logctx(backhandle, logctx);
574         sfree(realhost);
575     }
576     connopen = 1;
577
578     inhandle = GetStdHandle(STD_INPUT_HANDLE);
579     outhandle = GetStdHandle(STD_OUTPUT_HANDLE);
580     errhandle = GetStdHandle(STD_ERROR_HANDLE);
581
582     /*
583      * Turn off ECHO and LINE input modes. We don't care if this
584      * call fails, because we know we aren't necessarily running in
585      * a console.
586      */
587     GetConsoleMode(inhandle, &orig_console_mode);
588     SetConsoleMode(inhandle, ENABLE_PROCESSED_INPUT);
589
590     /*
591      * Pass the output handles to the handle-handling subsystem.
592      * (The input one we leave until we're through the
593      * authentication process.)
594      */
595     stdout_handle = handle_output_new(outhandle, stdouterr_sent, NULL, 0);
596     stderr_handle = handle_output_new(errhandle, stdouterr_sent, NULL, 0);
597
598     main_thread_id = GetCurrentThreadId();
599
600     sending = FALSE;
601
602     now = GETTICKCOUNT();
603
604     while (1) {
605         int nhandles;
606         HANDLE *handles;        
607         int n;
608         DWORD ticks;
609
610         if (!sending && back->sendok(backhandle)) {
611             stdin_handle = handle_input_new(inhandle, stdin_gotdata, NULL,
612                                             0);
613             sending = TRUE;
614         }
615
616         if (run_timers(now, &next)) {
617             ticks = next - GETTICKCOUNT();
618             if (ticks < 0) ticks = 0;  /* just in case */
619         } else {
620             ticks = INFINITE;
621         }
622
623         handles = handle_get_events(&nhandles);
624         handles = sresize(handles, nhandles+1, HANDLE);
625         handles[nhandles] = netevent;
626         n = MsgWaitForMultipleObjects(nhandles+1, handles, FALSE, ticks,
627                                       QS_POSTMESSAGE);
628         if ((unsigned)(n - WAIT_OBJECT_0) < (unsigned)nhandles) {
629             handle_got_event(handles[n - WAIT_OBJECT_0]);
630         } else if (n == WAIT_OBJECT_0 + nhandles) {
631             WSANETWORKEVENTS things;
632             SOCKET socket;
633             extern SOCKET first_socket(int *), next_socket(int *);
634             extern int select_result(WPARAM, LPARAM);
635             int i, socketstate;
636
637             /*
638              * We must not call select_result() for any socket
639              * until we have finished enumerating within the tree.
640              * This is because select_result() may close the socket
641              * and modify the tree.
642              */
643             /* Count the active sockets. */
644             i = 0;
645             for (socket = first_socket(&socketstate);
646                  socket != INVALID_SOCKET;
647                  socket = next_socket(&socketstate)) i++;
648
649             /* Expand the buffer if necessary. */
650             if (i > sksize) {
651                 sksize = i + 16;
652                 sklist = sresize(sklist, sksize, SOCKET);
653             }
654
655             /* Retrieve the sockets into sklist. */
656             skcount = 0;
657             for (socket = first_socket(&socketstate);
658                  socket != INVALID_SOCKET;
659                  socket = next_socket(&socketstate)) {
660                 sklist[skcount++] = socket;
661             }
662
663             /* Now we're done enumerating; go through the list. */
664             for (i = 0; i < skcount; i++) {
665                 WPARAM wp;
666                 socket = sklist[i];
667                 wp = (WPARAM) socket;
668                 if (!p_WSAEnumNetworkEvents(socket, NULL, &things)) {
669                     static const struct { int bit, mask; } eventtypes[] = {
670                         {FD_CONNECT_BIT, FD_CONNECT},
671                         {FD_READ_BIT, FD_READ},
672                         {FD_CLOSE_BIT, FD_CLOSE},
673                         {FD_OOB_BIT, FD_OOB},
674                         {FD_WRITE_BIT, FD_WRITE},
675                         {FD_ACCEPT_BIT, FD_ACCEPT},
676                     };
677                     int e;
678
679                     noise_ultralight(socket);
680                     noise_ultralight(things.lNetworkEvents);
681
682                     for (e = 0; e < lenof(eventtypes); e++)
683                         if (things.lNetworkEvents & eventtypes[e].mask) {
684                             LPARAM lp;
685                             int err = things.iErrorCode[eventtypes[e].bit];
686                             lp = WSAMAKESELECTREPLY(eventtypes[e].mask, err);
687                             connopen &= select_result(wp, lp);
688                         }
689                 }
690             }
691         } else if (n == WAIT_OBJECT_0 + nhandles + 1) {
692             MSG msg;
693             while (PeekMessage(&msg, INVALID_HANDLE_VALUE,
694                                WM_AGENT_CALLBACK, WM_AGENT_CALLBACK,
695                                PM_REMOVE)) {
696                 struct agent_callback *c = (struct agent_callback *)msg.lParam;
697                 c->callback(c->callback_ctx, c->data, c->len);
698                 sfree(c);
699             }
700         }
701
702         if (n == WAIT_TIMEOUT) {
703             now = next;
704         } else {
705             now = GETTICKCOUNT();
706         }
707
708         sfree(handles);
709
710         if (sending)
711             handle_unthrottle(stdin_handle, back->sendbuffer(backhandle));
712
713         if ((!connopen || !back->connected(backhandle)) &&
714             handle_backlog(stdout_handle) + handle_backlog(stderr_handle) == 0)
715             break;                     /* we closed the connection */
716     }
717     exitcode = back->exitcode(backhandle);
718     if (exitcode < 0) {
719         fprintf(stderr, "Remote process exit code unavailable\n");
720         exitcode = 1;                  /* this is an error condition */
721     }
722     cleanup_exit(exitcode);
723     return 0;                          /* placate compiler warning */
724 }