Fix a couple of code paths on which, if fxp_readdir returned an error,
[u/mdw/putty] / psftp.c
1 /*
2 * psftp.c: (platform-independent) front end for PSFTP.
3 */
4
5 #include <stdio.h>
6 #include <stdlib.h>
7 #include <stdarg.h>
8 #include <assert.h>
9 #include <limits.h>
10
11 #define PUTTY_DO_GLOBALS
12 #include "putty.h"
13 #include "psftp.h"
14 #include "storage.h"
15 #include "ssh.h"
16 #include "sftp.h"
17 #include "int64.h"
18
19 const char *const appname = "PSFTP";
20
21 /*
22 * Since SFTP is a request-response oriented protocol, it requires
23 * no buffer management: when we send data, we stop and wait for an
24 * acknowledgement _anyway_, and so we can't possibly overfill our
25 * send buffer.
26 */
27
28 static int psftp_connect(char *userhost, char *user, int portnumber);
29 static int do_sftp_init(void);
30 void do_sftp_cleanup();
31
32 /* ----------------------------------------------------------------------
33 * sftp client state.
34 */
35
36 char *pwd, *homedir;
37 static Backend *back;
38 static void *backhandle;
39 static Conf *conf;
40 int sent_eof = FALSE;
41
42 /* ----------------------------------------------------------------------
43 * Manage sending requests and waiting for replies.
44 */
45 struct sftp_packet *sftp_wait_for_reply(struct sftp_request *req)
46 {
47 struct sftp_packet *pktin;
48 struct sftp_request *rreq;
49
50 sftp_register(req);
51 pktin = sftp_recv();
52 if (pktin == NULL)
53 connection_fatal(NULL, "did not receive SFTP response packet "
54 "from server");
55 rreq = sftp_find_request(pktin);
56 if (rreq != req)
57 connection_fatal(NULL, "unable to understand SFTP response packet "
58 "from server: %s", fxp_error());
59 return pktin;
60 }
61
62 /* ----------------------------------------------------------------------
63 * Higher-level helper functions used in commands.
64 */
65
66 /*
67 * Attempt to canonify a pathname starting from the pwd. If
68 * canonification fails, at least fall back to returning a _valid_
69 * pathname (though it may be ugly, eg /home/simon/../foobar).
70 */
71 char *canonify(char *name)
72 {
73 char *fullname, *canonname;
74 struct sftp_packet *pktin;
75 struct sftp_request *req;
76
77 if (name[0] == '/') {
78 fullname = dupstr(name);
79 } else {
80 char *slash;
81 if (pwd[strlen(pwd) - 1] == '/')
82 slash = "";
83 else
84 slash = "/";
85 fullname = dupcat(pwd, slash, name, NULL);
86 }
87
88 req = fxp_realpath_send(fullname);
89 pktin = sftp_wait_for_reply(req);
90 canonname = fxp_realpath_recv(pktin, req);
91
92 if (canonname) {
93 sfree(fullname);
94 return canonname;
95 } else {
96 /*
97 * Attempt number 2. Some FXP_REALPATH implementations
98 * (glibc-based ones, in particular) require the _whole_
99 * path to point to something that exists, whereas others
100 * (BSD-based) only require all but the last component to
101 * exist. So if the first call failed, we should strip off
102 * everything from the last slash onwards and try again,
103 * then put the final component back on.
104 *
105 * Special cases:
106 *
107 * - if the last component is "/." or "/..", then we don't
108 * bother trying this because there's no way it can work.
109 *
110 * - if the thing actually ends with a "/", we remove it
111 * before we start. Except if the string is "/" itself
112 * (although I can't see why we'd have got here if so,
113 * because surely "/" would have worked the first
114 * time?), in which case we don't bother.
115 *
116 * - if there's no slash in the string at all, give up in
117 * confusion (we expect at least one because of the way
118 * we constructed the string).
119 */
120
121 int i;
122 char *returnname;
123
124 i = strlen(fullname);
125 if (i > 2 && fullname[i - 1] == '/')
126 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
127 while (i > 0 && fullname[--i] != '/');
128
129 /*
130 * Give up on special cases.
131 */
132 if (fullname[i] != '/' || /* no slash at all */
133 !strcmp(fullname + i, "/.") || /* ends in /. */
134 !strcmp(fullname + i, "/..") || /* ends in /.. */
135 !strcmp(fullname, "/")) {
136 return fullname;
137 }
138
139 /*
140 * Now i points at the slash. Deal with the final special
141 * case i==0 (ie the whole path was "/nonexistentfile").
142 */
143 fullname[i] = '\0'; /* separate the string */
144 if (i == 0) {
145 req = fxp_realpath_send("/");
146 } else {
147 req = fxp_realpath_send(fullname);
148 }
149 pktin = sftp_wait_for_reply(req);
150 canonname = fxp_realpath_recv(pktin, req);
151
152 if (!canonname) {
153 /* Even that failed. Restore our best guess at the
154 * constructed filename and give up */
155 fullname[i] = '/'; /* restore slash and last component */
156 return fullname;
157 }
158
159 /*
160 * We have a canonical name for all but the last path
161 * component. Concatenate the last component and return.
162 */
163 returnname = dupcat(canonname,
164 canonname[strlen(canonname) - 1] ==
165 '/' ? "" : "/", fullname + i + 1, NULL);
166 sfree(fullname);
167 sfree(canonname);
168 return returnname;
169 }
170 }
171
172 /*
173 * Return a pointer to the portion of str that comes after the last
174 * slash (or backslash or colon, if `local' is TRUE).
175 */
176 static char *stripslashes(char *str, int local)
177 {
178 char *p;
179
180 if (local) {
181 p = strchr(str, ':');
182 if (p) str = p+1;
183 }
184
185 p = strrchr(str, '/');
186 if (p) str = p+1;
187
188 if (local) {
189 p = strrchr(str, '\\');
190 if (p) str = p+1;
191 }
192
193 return str;
194 }
195
196 /*
197 * qsort comparison routine for fxp_name structures. Sorts by real
198 * file name.
199 */
200 static int sftp_name_compare(const void *av, const void *bv)
201 {
202 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
203 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
204 return strcmp((*a)->filename, (*b)->filename);
205 }
206
207 /*
208 * Likewise, but for a bare char *.
209 */
210 static int bare_name_compare(const void *av, const void *bv)
211 {
212 const char **a = (const char **) av;
213 const char **b = (const char **) bv;
214 return strcmp(*a, *b);
215 }
216
217 static void not_connected(void)
218 {
219 printf("psftp: not connected to a host; use \"open host.name\"\n");
220 }
221
222 /* ----------------------------------------------------------------------
223 * The meat of the `get' and `put' commands.
224 */
225 int sftp_get_file(char *fname, char *outfname, int recurse, int restart)
226 {
227 struct fxp_handle *fh;
228 struct sftp_packet *pktin;
229 struct sftp_request *req;
230 struct fxp_xfer *xfer;
231 uint64 offset;
232 WFile *file;
233 int ret, shown_err = FALSE;
234 struct fxp_attrs attrs;
235
236 /*
237 * In recursive mode, see if we're dealing with a directory.
238 * (If we're not in recursive mode, we need not even check: the
239 * subsequent FXP_OPEN will return a usable error message.)
240 */
241 if (recurse) {
242 int result;
243
244 req = fxp_stat_send(fname);
245 pktin = sftp_wait_for_reply(req);
246 result = fxp_stat_recv(pktin, req, &attrs);
247
248 if (result &&
249 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
250 (attrs.permissions & 0040000)) {
251
252 struct fxp_handle *dirhandle;
253 int nnames, namesize;
254 struct fxp_name **ournames;
255 struct fxp_names *names;
256 int i;
257
258 /*
259 * First, attempt to create the destination directory,
260 * unless it already exists.
261 */
262 if (file_type(outfname) != FILE_TYPE_DIRECTORY &&
263 !create_directory(outfname)) {
264 printf("%s: Cannot create directory\n", outfname);
265 return 0;
266 }
267
268 /*
269 * Now get the list of filenames in the remote
270 * directory.
271 */
272 req = fxp_opendir_send(fname);
273 pktin = sftp_wait_for_reply(req);
274 dirhandle = fxp_opendir_recv(pktin, req);
275
276 if (!dirhandle) {
277 printf("%s: unable to open directory: %s\n",
278 fname, fxp_error());
279 return 0;
280 }
281 nnames = namesize = 0;
282 ournames = NULL;
283 while (1) {
284 int i;
285
286 req = fxp_readdir_send(dirhandle);
287 pktin = sftp_wait_for_reply(req);
288 names = fxp_readdir_recv(pktin, req);
289
290 if (names == NULL) {
291 if (fxp_error_type() == SSH_FX_EOF)
292 break;
293 printf("%s: reading directory: %s\n", fname, fxp_error());
294
295 req = fxp_close_send(dirhandle);
296 pktin = sftp_wait_for_reply(req);
297 fxp_close_recv(pktin, req);
298
299 sfree(ournames);
300 return 0;
301 }
302 if (names->nnames == 0) {
303 fxp_free_names(names);
304 break;
305 }
306 if (nnames + names->nnames >= namesize) {
307 namesize += names->nnames + 128;
308 ournames = sresize(ournames, namesize, struct fxp_name *);
309 }
310 for (i = 0; i < names->nnames; i++)
311 if (strcmp(names->names[i].filename, ".") &&
312 strcmp(names->names[i].filename, "..")) {
313 if (!vet_filename(names->names[i].filename)) {
314 printf("ignoring potentially dangerous server-"
315 "supplied filename '%s'\n",
316 names->names[i].filename);
317 } else {
318 ournames[nnames++] =
319 fxp_dup_name(&names->names[i]);
320 }
321 }
322 fxp_free_names(names);
323 }
324 req = fxp_close_send(dirhandle);
325 pktin = sftp_wait_for_reply(req);
326 fxp_close_recv(pktin, req);
327
328 /*
329 * Sort the names into a clear order. This ought to
330 * make things more predictable when we're doing a
331 * reget of the same directory, just in case two
332 * readdirs on the same remote directory return a
333 * different order.
334 */
335 if (nnames > 0)
336 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
337
338 /*
339 * If we're in restart mode, find the last filename on
340 * this list that already exists. We may have to do a
341 * reget on _that_ file, but shouldn't have to do
342 * anything on the previous files.
343 *
344 * If none of them exists, of course, we start at 0.
345 */
346 i = 0;
347 if (restart) {
348 while (i < nnames) {
349 char *nextoutfname;
350 int ret;
351 nextoutfname = dir_file_cat(outfname,
352 ournames[i]->filename);
353 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
354 sfree(nextoutfname);
355 if (ret)
356 break;
357 i++;
358 }
359 if (i > 0)
360 i--;
361 }
362
363 /*
364 * Now we're ready to recurse. Starting at ournames[i]
365 * and continuing on to the end of the list, we
366 * construct a new source and target file name, and
367 * call sftp_get_file again.
368 */
369 for (; i < nnames; i++) {
370 char *nextfname, *nextoutfname;
371 int ret;
372
373 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
374 nextoutfname = dir_file_cat(outfname, ournames[i]->filename);
375 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
376 restart = FALSE; /* after first partial file, do full */
377 sfree(nextoutfname);
378 sfree(nextfname);
379 if (!ret) {
380 for (i = 0; i < nnames; i++) {
381 fxp_free_name(ournames[i]);
382 }
383 sfree(ournames);
384 return 0;
385 }
386 }
387
388 /*
389 * Done this recursion level. Free everything.
390 */
391 for (i = 0; i < nnames; i++) {
392 fxp_free_name(ournames[i]);
393 }
394 sfree(ournames);
395
396 return 1;
397 }
398 }
399
400 req = fxp_stat_send(fname);
401 pktin = sftp_wait_for_reply(req);
402 if (!fxp_stat_recv(pktin, req, &attrs))
403 attrs.flags = 0;
404
405 req = fxp_open_send(fname, SSH_FXF_READ, NULL);
406 pktin = sftp_wait_for_reply(req);
407 fh = fxp_open_recv(pktin, req);
408
409 if (!fh) {
410 printf("%s: open for read: %s\n", fname, fxp_error());
411 return 0;
412 }
413
414 if (restart) {
415 file = open_existing_wfile(outfname, NULL);
416 } else {
417 file = open_new_file(outfname, GET_PERMISSIONS(attrs));
418 }
419
420 if (!file) {
421 printf("local: unable to open %s\n", outfname);
422
423 req = fxp_close_send(fh);
424 pktin = sftp_wait_for_reply(req);
425 fxp_close_recv(pktin, req);
426
427 return 0;
428 }
429
430 if (restart) {
431 char decbuf[30];
432 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
433 close_wfile(file);
434 printf("reget: cannot restart %s - file too large\n",
435 outfname);
436 req = fxp_close_send(fh);
437 pktin = sftp_wait_for_reply(req);
438 fxp_close_recv(pktin, req);
439
440 return 0;
441 }
442
443 offset = get_file_posn(file);
444 uint64_decimal(offset, decbuf);
445 printf("reget: restarting at file position %s\n", decbuf);
446 } else {
447 offset = uint64_make(0, 0);
448 }
449
450 printf("remote:%s => local:%s\n", fname, outfname);
451
452 /*
453 * FIXME: we can use FXP_FSTAT here to get the file size, and
454 * thus put up a progress bar.
455 */
456 ret = 1;
457 xfer = xfer_download_init(fh, offset);
458 while (!xfer_done(xfer)) {
459 void *vbuf;
460 int ret, len;
461 int wpos, wlen;
462
463 xfer_download_queue(xfer);
464 pktin = sftp_recv();
465 ret = xfer_download_gotpkt(xfer, pktin);
466 if (ret <= 0) {
467 if (!shown_err) {
468 printf("error while reading: %s\n", fxp_error());
469 shown_err = TRUE;
470 }
471 ret = 0;
472 }
473
474 while (xfer_download_data(xfer, &vbuf, &len)) {
475 unsigned char *buf = (unsigned char *)vbuf;
476
477 wpos = 0;
478 while (wpos < len) {
479 wlen = write_to_file(file, buf + wpos, len - wpos);
480 if (wlen <= 0) {
481 printf("error while writing local file\n");
482 ret = 0;
483 xfer_set_error(xfer);
484 break;
485 }
486 wpos += wlen;
487 }
488 if (wpos < len) { /* we had an error */
489 ret = 0;
490 xfer_set_error(xfer);
491 }
492
493 sfree(vbuf);
494 }
495 }
496
497 xfer_cleanup(xfer);
498
499 close_wfile(file);
500
501 req = fxp_close_send(fh);
502 pktin = sftp_wait_for_reply(req);
503 fxp_close_recv(pktin, req);
504
505 return ret;
506 }
507
508 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
509 {
510 struct fxp_handle *fh;
511 struct fxp_xfer *xfer;
512 struct sftp_packet *pktin;
513 struct sftp_request *req;
514 uint64 offset;
515 RFile *file;
516 int ret, err, eof;
517 struct fxp_attrs attrs;
518 long permissions;
519
520 /*
521 * In recursive mode, see if we're dealing with a directory.
522 * (If we're not in recursive mode, we need not even check: the
523 * subsequent fopen will return an error message.)
524 */
525 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
526 int result;
527 int nnames, namesize;
528 char *name, **ournames;
529 DirHandle *dh;
530 int i;
531
532 /*
533 * First, attempt to create the destination directory,
534 * unless it already exists.
535 */
536 req = fxp_stat_send(outfname);
537 pktin = sftp_wait_for_reply(req);
538 result = fxp_stat_recv(pktin, req, &attrs);
539 if (!result ||
540 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
541 !(attrs.permissions & 0040000)) {
542 req = fxp_mkdir_send(outfname);
543 pktin = sftp_wait_for_reply(req);
544 result = fxp_mkdir_recv(pktin, req);
545
546 if (!result) {
547 printf("%s: create directory: %s\n",
548 outfname, fxp_error());
549 return 0;
550 }
551 }
552
553 /*
554 * Now get the list of filenames in the local directory.
555 */
556 nnames = namesize = 0;
557 ournames = NULL;
558
559 dh = open_directory(fname);
560 if (!dh) {
561 printf("%s: unable to open directory\n", fname);
562 return 0;
563 }
564 while ((name = read_filename(dh)) != NULL) {
565 if (nnames >= namesize) {
566 namesize += 128;
567 ournames = sresize(ournames, namesize, char *);
568 }
569 ournames[nnames++] = name;
570 }
571 close_directory(dh);
572
573 /*
574 * Sort the names into a clear order. This ought to make
575 * things more predictable when we're doing a reput of the
576 * same directory, just in case two readdirs on the same
577 * local directory return a different order.
578 */
579 if (nnames > 0)
580 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
581
582 /*
583 * If we're in restart mode, find the last filename on this
584 * list that already exists. We may have to do a reput on
585 * _that_ file, but shouldn't have to do anything on the
586 * previous files.
587 *
588 * If none of them exists, of course, we start at 0.
589 */
590 i = 0;
591 if (restart) {
592 while (i < nnames) {
593 char *nextoutfname;
594 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
595 req = fxp_stat_send(nextoutfname);
596 pktin = sftp_wait_for_reply(req);
597 result = fxp_stat_recv(pktin, req, &attrs);
598 sfree(nextoutfname);
599 if (!result)
600 break;
601 i++;
602 }
603 if (i > 0)
604 i--;
605 }
606
607 /*
608 * Now we're ready to recurse. Starting at ournames[i]
609 * and continuing on to the end of the list, we
610 * construct a new source and target file name, and
611 * call sftp_put_file again.
612 */
613 for (; i < nnames; i++) {
614 char *nextfname, *nextoutfname;
615 int ret;
616
617 nextfname = dir_file_cat(fname, ournames[i]);
618 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
619 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
620 restart = FALSE; /* after first partial file, do full */
621 sfree(nextoutfname);
622 sfree(nextfname);
623 if (!ret) {
624 for (i = 0; i < nnames; i++) {
625 sfree(ournames[i]);
626 }
627 sfree(ournames);
628 return 0;
629 }
630 }
631
632 /*
633 * Done this recursion level. Free everything.
634 */
635 for (i = 0; i < nnames; i++) {
636 sfree(ournames[i]);
637 }
638 sfree(ournames);
639
640 return 1;
641 }
642
643 file = open_existing_file(fname, NULL, NULL, NULL, &permissions);
644 if (!file) {
645 printf("local: unable to open %s\n", fname);
646 return 0;
647 }
648 attrs.flags = 0;
649 PUT_PERMISSIONS(attrs, permissions);
650 if (restart) {
651 req = fxp_open_send(outfname, SSH_FXF_WRITE, &attrs);
652 } else {
653 req = fxp_open_send(outfname,
654 SSH_FXF_WRITE | SSH_FXF_CREAT | SSH_FXF_TRUNC,
655 &attrs);
656 }
657 pktin = sftp_wait_for_reply(req);
658 fh = fxp_open_recv(pktin, req);
659
660 if (!fh) {
661 close_rfile(file);
662 printf("%s: open for write: %s\n", outfname, fxp_error());
663 return 0;
664 }
665
666 if (restart) {
667 char decbuf[30];
668 struct fxp_attrs attrs;
669 int ret;
670
671 req = fxp_fstat_send(fh);
672 pktin = sftp_wait_for_reply(req);
673 ret = fxp_fstat_recv(pktin, req, &attrs);
674
675 if (!ret) {
676 close_rfile(file);
677 printf("read size of %s: %s\n", outfname, fxp_error());
678 return 0;
679 }
680 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
681 close_rfile(file);
682 printf("read size of %s: size was not given\n", outfname);
683 return 0;
684 }
685 offset = attrs.size;
686 uint64_decimal(offset, decbuf);
687 printf("reput: restarting at file position %s\n", decbuf);
688
689 if (seek_file((WFile *)file, offset, FROM_START) != 0)
690 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
691 } else {
692 offset = uint64_make(0, 0);
693 }
694
695 printf("local:%s => remote:%s\n", fname, outfname);
696
697 /*
698 * FIXME: we can use FXP_FSTAT here to get the file size, and
699 * thus put up a progress bar.
700 */
701 ret = 1;
702 xfer = xfer_upload_init(fh, offset);
703 err = eof = 0;
704 while ((!err && !eof) || !xfer_done(xfer)) {
705 char buffer[4096];
706 int len, ret;
707
708 while (xfer_upload_ready(xfer) && !err && !eof) {
709 len = read_from_file(file, buffer, sizeof(buffer));
710 if (len == -1) {
711 printf("error while reading local file\n");
712 err = 1;
713 } else if (len == 0) {
714 eof = 1;
715 } else {
716 xfer_upload_data(xfer, buffer, len);
717 }
718 }
719
720 if (!xfer_done(xfer)) {
721 pktin = sftp_recv();
722 ret = xfer_upload_gotpkt(xfer, pktin);
723 if (ret <= 0 && !err) {
724 printf("error while writing: %s\n", fxp_error());
725 err = 1;
726 }
727 }
728 }
729
730 xfer_cleanup(xfer);
731
732 req = fxp_close_send(fh);
733 pktin = sftp_wait_for_reply(req);
734 fxp_close_recv(pktin, req);
735
736 close_rfile(file);
737
738 return ret;
739 }
740
741 /* ----------------------------------------------------------------------
742 * A remote wildcard matcher, providing a similar interface to the
743 * local one in psftp.h.
744 */
745
746 typedef struct SftpWildcardMatcher {
747 struct fxp_handle *dirh;
748 struct fxp_names *names;
749 int namepos;
750 char *wildcard, *prefix;
751 } SftpWildcardMatcher;
752
753 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
754 {
755 struct sftp_packet *pktin;
756 struct sftp_request *req;
757 char *wildcard;
758 char *unwcdir, *tmpdir, *cdir;
759 int len, check;
760 SftpWildcardMatcher *swcm;
761 struct fxp_handle *dirh;
762
763 /*
764 * We don't handle multi-level wildcards; so we expect to find
765 * a fully specified directory part, followed by a wildcard
766 * after that.
767 */
768 wildcard = stripslashes(name, 0);
769
770 unwcdir = dupstr(name);
771 len = wildcard - name;
772 unwcdir[len] = '\0';
773 if (len > 0 && unwcdir[len-1] == '/')
774 unwcdir[len-1] = '\0';
775 tmpdir = snewn(1 + len, char);
776 check = wc_unescape(tmpdir, unwcdir);
777 sfree(tmpdir);
778
779 if (!check) {
780 printf("Multiple-level wildcards are not supported\n");
781 sfree(unwcdir);
782 return NULL;
783 }
784
785 cdir = canonify(unwcdir);
786
787 req = fxp_opendir_send(cdir);
788 pktin = sftp_wait_for_reply(req);
789 dirh = fxp_opendir_recv(pktin, req);
790
791 if (dirh) {
792 swcm = snew(SftpWildcardMatcher);
793 swcm->dirh = dirh;
794 swcm->names = NULL;
795 swcm->wildcard = dupstr(wildcard);
796 swcm->prefix = unwcdir;
797 } else {
798 printf("Unable to open %s: %s\n", cdir, fxp_error());
799 swcm = NULL;
800 sfree(unwcdir);
801 }
802
803 sfree(cdir);
804
805 return swcm;
806 }
807
808 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
809 {
810 struct fxp_name *name;
811 struct sftp_packet *pktin;
812 struct sftp_request *req;
813
814 while (1) {
815 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
816 fxp_free_names(swcm->names);
817 swcm->names = NULL;
818 }
819
820 if (!swcm->names) {
821 req = fxp_readdir_send(swcm->dirh);
822 pktin = sftp_wait_for_reply(req);
823 swcm->names = fxp_readdir_recv(pktin, req);
824
825 if (!swcm->names) {
826 if (fxp_error_type() != SSH_FX_EOF)
827 printf("%s: reading directory: %s\n", swcm->prefix,
828 fxp_error());
829 return NULL;
830 } else if (swcm->names->nnames == 0) {
831 /*
832 * Another failure mode which we treat as EOF is if
833 * the server reports success from FXP_READDIR but
834 * returns no actual names. This is unusual, since
835 * from most servers you'd expect at least "." and
836 * "..", but there's nothing forbidding a server from
837 * omitting those if it wants to.
838 */
839 return NULL;
840 }
841
842 swcm->namepos = 0;
843 }
844
845 assert(swcm->names && swcm->namepos < swcm->names->nnames);
846
847 name = &swcm->names->names[swcm->namepos++];
848
849 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
850 continue; /* expected bad filenames */
851
852 if (!vet_filename(name->filename)) {
853 printf("ignoring potentially dangerous server-"
854 "supplied filename '%s'\n", name->filename);
855 continue; /* unexpected bad filename */
856 }
857
858 if (!wc_match(swcm->wildcard, name->filename))
859 continue; /* doesn't match the wildcard */
860
861 /*
862 * We have a working filename. Return it.
863 */
864 return dupprintf("%s%s%s", swcm->prefix,
865 (!swcm->prefix[0] ||
866 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
867 "" : "/"),
868 name->filename);
869 }
870 }
871
872 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
873 {
874 struct sftp_packet *pktin;
875 struct sftp_request *req;
876
877 req = fxp_close_send(swcm->dirh);
878 pktin = sftp_wait_for_reply(req);
879 fxp_close_recv(pktin, req);
880
881 if (swcm->names)
882 fxp_free_names(swcm->names);
883
884 sfree(swcm->prefix);
885 sfree(swcm->wildcard);
886
887 sfree(swcm);
888 }
889
890 /*
891 * General function to match a potential wildcard in a filename
892 * argument and iterate over every matching file. Used in several
893 * PSFTP commands (rmdir, rm, chmod, mv).
894 */
895 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
896 {
897 char *unwcfname, *newname, *cname;
898 int is_wc, ret;
899
900 unwcfname = snewn(strlen(filename)+1, char);
901 is_wc = !wc_unescape(unwcfname, filename);
902
903 if (is_wc) {
904 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
905 int matched = FALSE;
906 sfree(unwcfname);
907
908 if (!swcm)
909 return 0;
910
911 ret = 1;
912
913 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
914 cname = canonify(newname);
915 if (!cname) {
916 printf("%s: canonify: %s\n", newname, fxp_error());
917 ret = 0;
918 }
919 matched = TRUE;
920 ret &= func(ctx, cname);
921 sfree(cname);
922 }
923
924 if (!matched) {
925 /* Politely warn the user that nothing matched. */
926 printf("%s: nothing matched\n", filename);
927 }
928
929 sftp_finish_wildcard_matching(swcm);
930 } else {
931 cname = canonify(unwcfname);
932 if (!cname) {
933 printf("%s: canonify: %s\n", filename, fxp_error());
934 ret = 0;
935 }
936 ret = func(ctx, cname);
937 sfree(cname);
938 sfree(unwcfname);
939 }
940
941 return ret;
942 }
943
944 /*
945 * Handy helper function.
946 */
947 int is_wildcard(char *name)
948 {
949 char *unwcfname = snewn(strlen(name)+1, char);
950 int is_wc = !wc_unescape(unwcfname, name);
951 sfree(unwcfname);
952 return is_wc;
953 }
954
955 /* ----------------------------------------------------------------------
956 * Actual sftp commands.
957 */
958 struct sftp_command {
959 char **words;
960 int nwords, wordssize;
961 int (*obey) (struct sftp_command *); /* returns <0 to quit */
962 };
963
964 int sftp_cmd_null(struct sftp_command *cmd)
965 {
966 return 1; /* success */
967 }
968
969 int sftp_cmd_unknown(struct sftp_command *cmd)
970 {
971 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
972 return 0; /* failure */
973 }
974
975 int sftp_cmd_quit(struct sftp_command *cmd)
976 {
977 return -1;
978 }
979
980 int sftp_cmd_close(struct sftp_command *cmd)
981 {
982 if (back == NULL) {
983 not_connected();
984 return 0;
985 }
986
987 if (back != NULL && back->connected(backhandle)) {
988 char ch;
989 back->special(backhandle, TS_EOF);
990 sent_eof = TRUE;
991 sftp_recvdata(&ch, 1);
992 }
993 do_sftp_cleanup();
994
995 return 0;
996 }
997
998 /*
999 * List a directory. If no arguments are given, list pwd; otherwise
1000 * list the directory given in words[1].
1001 */
1002 int sftp_cmd_ls(struct sftp_command *cmd)
1003 {
1004 struct fxp_handle *dirh;
1005 struct fxp_names *names;
1006 struct fxp_name **ournames;
1007 int nnames, namesize;
1008 char *dir, *cdir, *unwcdir, *wildcard;
1009 struct sftp_packet *pktin;
1010 struct sftp_request *req;
1011 int i;
1012
1013 if (back == NULL) {
1014 not_connected();
1015 return 0;
1016 }
1017
1018 if (cmd->nwords < 2)
1019 dir = ".";
1020 else
1021 dir = cmd->words[1];
1022
1023 unwcdir = snewn(1 + strlen(dir), char);
1024 if (wc_unescape(unwcdir, dir)) {
1025 dir = unwcdir;
1026 wildcard = NULL;
1027 } else {
1028 char *tmpdir;
1029 int len, check;
1030
1031 wildcard = stripslashes(dir, 0);
1032 unwcdir = dupstr(dir);
1033 len = wildcard - dir;
1034 unwcdir[len] = '\0';
1035 if (len > 0 && unwcdir[len-1] == '/')
1036 unwcdir[len-1] = '\0';
1037 tmpdir = snewn(1 + len, char);
1038 check = wc_unescape(tmpdir, unwcdir);
1039 sfree(tmpdir);
1040 if (!check) {
1041 printf("Multiple-level wildcards are not supported\n");
1042 sfree(unwcdir);
1043 return 0;
1044 }
1045 dir = unwcdir;
1046 }
1047
1048 cdir = canonify(dir);
1049 if (!cdir) {
1050 printf("%s: canonify: %s\n", dir, fxp_error());
1051 sfree(unwcdir);
1052 return 0;
1053 }
1054
1055 printf("Listing directory %s\n", cdir);
1056
1057 req = fxp_opendir_send(cdir);
1058 pktin = sftp_wait_for_reply(req);
1059 dirh = fxp_opendir_recv(pktin, req);
1060
1061 if (dirh == NULL) {
1062 printf("Unable to open %s: %s\n", dir, fxp_error());
1063 } else {
1064 nnames = namesize = 0;
1065 ournames = NULL;
1066
1067 while (1) {
1068
1069 req = fxp_readdir_send(dirh);
1070 pktin = sftp_wait_for_reply(req);
1071 names = fxp_readdir_recv(pktin, req);
1072
1073 if (names == NULL) {
1074 if (fxp_error_type() == SSH_FX_EOF)
1075 break;
1076 printf("Reading directory %s: %s\n", dir, fxp_error());
1077 break;
1078 }
1079 if (names->nnames == 0) {
1080 fxp_free_names(names);
1081 break;
1082 }
1083
1084 if (nnames + names->nnames >= namesize) {
1085 namesize += names->nnames + 128;
1086 ournames = sresize(ournames, namesize, struct fxp_name *);
1087 }
1088
1089 for (i = 0; i < names->nnames; i++)
1090 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1091 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1092
1093 fxp_free_names(names);
1094 }
1095 req = fxp_close_send(dirh);
1096 pktin = sftp_wait_for_reply(req);
1097 fxp_close_recv(pktin, req);
1098
1099 /*
1100 * Now we have our filenames. Sort them by actual file
1101 * name, and then output the longname parts.
1102 */
1103 if (nnames > 0)
1104 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1105
1106 /*
1107 * And print them.
1108 */
1109 for (i = 0; i < nnames; i++) {
1110 printf("%s\n", ournames[i]->longname);
1111 fxp_free_name(ournames[i]);
1112 }
1113 sfree(ournames);
1114 }
1115
1116 sfree(cdir);
1117 sfree(unwcdir);
1118
1119 return 1;
1120 }
1121
1122 /*
1123 * Change directories. We do this by canonifying the new name, then
1124 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1125 */
1126 int sftp_cmd_cd(struct sftp_command *cmd)
1127 {
1128 struct fxp_handle *dirh;
1129 struct sftp_packet *pktin;
1130 struct sftp_request *req;
1131 char *dir;
1132
1133 if (back == NULL) {
1134 not_connected();
1135 return 0;
1136 }
1137
1138 if (cmd->nwords < 2)
1139 dir = dupstr(homedir);
1140 else
1141 dir = canonify(cmd->words[1]);
1142
1143 if (!dir) {
1144 printf("%s: canonify: %s\n", dir, fxp_error());
1145 return 0;
1146 }
1147
1148 req = fxp_opendir_send(dir);
1149 pktin = sftp_wait_for_reply(req);
1150 dirh = fxp_opendir_recv(pktin, req);
1151
1152 if (!dirh) {
1153 printf("Directory %s: %s\n", dir, fxp_error());
1154 sfree(dir);
1155 return 0;
1156 }
1157
1158 req = fxp_close_send(dirh);
1159 pktin = sftp_wait_for_reply(req);
1160 fxp_close_recv(pktin, req);
1161
1162 sfree(pwd);
1163 pwd = dir;
1164 printf("Remote directory is now %s\n", pwd);
1165
1166 return 1;
1167 }
1168
1169 /*
1170 * Print current directory. Easy as pie.
1171 */
1172 int sftp_cmd_pwd(struct sftp_command *cmd)
1173 {
1174 if (back == NULL) {
1175 not_connected();
1176 return 0;
1177 }
1178
1179 printf("Remote directory is %s\n", pwd);
1180 return 1;
1181 }
1182
1183 /*
1184 * Get a file and save it at the local end. We have three very
1185 * similar commands here. The basic one is `get'; `reget' differs
1186 * in that it checks for the existence of the destination file and
1187 * starts from where a previous aborted transfer left off; `mget'
1188 * differs in that it interprets all its arguments as files to
1189 * transfer (never as a different local name for a remote file) and
1190 * can handle wildcards.
1191 */
1192 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1193 {
1194 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1195 int i, ret;
1196 int recurse = FALSE;
1197
1198 if (back == NULL) {
1199 not_connected();
1200 return 0;
1201 }
1202
1203 i = 1;
1204 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1205 if (!strcmp(cmd->words[i], "--")) {
1206 /* finish processing options */
1207 i++;
1208 break;
1209 } else if (!strcmp(cmd->words[i], "-r")) {
1210 recurse = TRUE;
1211 } else {
1212 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1213 return 0;
1214 }
1215 i++;
1216 }
1217
1218 if (i >= cmd->nwords) {
1219 printf("%s: expects a filename\n", cmd->words[0]);
1220 return 0;
1221 }
1222
1223 ret = 1;
1224 do {
1225 SftpWildcardMatcher *swcm;
1226
1227 origfname = cmd->words[i++];
1228 unwcfname = snewn(strlen(origfname)+1, char);
1229
1230 if (multiple && !wc_unescape(unwcfname, origfname)) {
1231 swcm = sftp_begin_wildcard_matching(origfname);
1232 if (!swcm) {
1233 sfree(unwcfname);
1234 continue;
1235 }
1236 origwfname = sftp_wildcard_get_filename(swcm);
1237 if (!origwfname) {
1238 /* Politely warn the user that nothing matched. */
1239 printf("%s: nothing matched\n", origfname);
1240 sftp_finish_wildcard_matching(swcm);
1241 sfree(unwcfname);
1242 continue;
1243 }
1244 } else {
1245 origwfname = origfname;
1246 swcm = NULL;
1247 }
1248
1249 while (origwfname) {
1250 fname = canonify(origwfname);
1251
1252 if (!fname) {
1253 printf("%s: canonify: %s\n", origwfname, fxp_error());
1254 sfree(unwcfname);
1255 return 0;
1256 }
1257
1258 if (!multiple && i < cmd->nwords)
1259 outfname = cmd->words[i++];
1260 else
1261 outfname = stripslashes(origwfname, 0);
1262
1263 ret = sftp_get_file(fname, outfname, recurse, restart);
1264
1265 sfree(fname);
1266
1267 if (swcm) {
1268 sfree(origwfname);
1269 origwfname = sftp_wildcard_get_filename(swcm);
1270 } else {
1271 origwfname = NULL;
1272 }
1273 }
1274 sfree(unwcfname);
1275 if (swcm)
1276 sftp_finish_wildcard_matching(swcm);
1277 if (!ret)
1278 return ret;
1279
1280 } while (multiple && i < cmd->nwords);
1281
1282 return ret;
1283 }
1284 int sftp_cmd_get(struct sftp_command *cmd)
1285 {
1286 return sftp_general_get(cmd, 0, 0);
1287 }
1288 int sftp_cmd_mget(struct sftp_command *cmd)
1289 {
1290 return sftp_general_get(cmd, 0, 1);
1291 }
1292 int sftp_cmd_reget(struct sftp_command *cmd)
1293 {
1294 return sftp_general_get(cmd, 1, 0);
1295 }
1296
1297 /*
1298 * Send a file and store it at the remote end. We have three very
1299 * similar commands here. The basic one is `put'; `reput' differs
1300 * in that it checks for the existence of the destination file and
1301 * starts from where a previous aborted transfer left off; `mput'
1302 * differs in that it interprets all its arguments as files to
1303 * transfer (never as a different remote name for a local file) and
1304 * can handle wildcards.
1305 */
1306 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1307 {
1308 char *fname, *wfname, *origoutfname, *outfname;
1309 int i, ret;
1310 int recurse = FALSE;
1311
1312 if (back == NULL) {
1313 not_connected();
1314 return 0;
1315 }
1316
1317 i = 1;
1318 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1319 if (!strcmp(cmd->words[i], "--")) {
1320 /* finish processing options */
1321 i++;
1322 break;
1323 } else if (!strcmp(cmd->words[i], "-r")) {
1324 recurse = TRUE;
1325 } else {
1326 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1327 return 0;
1328 }
1329 i++;
1330 }
1331
1332 if (i >= cmd->nwords) {
1333 printf("%s: expects a filename\n", cmd->words[0]);
1334 return 0;
1335 }
1336
1337 ret = 1;
1338 do {
1339 WildcardMatcher *wcm;
1340 fname = cmd->words[i++];
1341
1342 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1343 wcm = begin_wildcard_matching(fname);
1344 wfname = wildcard_get_filename(wcm);
1345 if (!wfname) {
1346 /* Politely warn the user that nothing matched. */
1347 printf("%s: nothing matched\n", fname);
1348 finish_wildcard_matching(wcm);
1349 continue;
1350 }
1351 } else {
1352 wfname = fname;
1353 wcm = NULL;
1354 }
1355
1356 while (wfname) {
1357 if (!multiple && i < cmd->nwords)
1358 origoutfname = cmd->words[i++];
1359 else
1360 origoutfname = stripslashes(wfname, 1);
1361
1362 outfname = canonify(origoutfname);
1363 if (!outfname) {
1364 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1365 if (wcm) {
1366 sfree(wfname);
1367 finish_wildcard_matching(wcm);
1368 }
1369 return 0;
1370 }
1371 ret = sftp_put_file(wfname, outfname, recurse, restart);
1372 sfree(outfname);
1373
1374 if (wcm) {
1375 sfree(wfname);
1376 wfname = wildcard_get_filename(wcm);
1377 } else {
1378 wfname = NULL;
1379 }
1380 }
1381
1382 if (wcm)
1383 finish_wildcard_matching(wcm);
1384
1385 if (!ret)
1386 return ret;
1387
1388 } while (multiple && i < cmd->nwords);
1389
1390 return ret;
1391 }
1392 int sftp_cmd_put(struct sftp_command *cmd)
1393 {
1394 return sftp_general_put(cmd, 0, 0);
1395 }
1396 int sftp_cmd_mput(struct sftp_command *cmd)
1397 {
1398 return sftp_general_put(cmd, 0, 1);
1399 }
1400 int sftp_cmd_reput(struct sftp_command *cmd)
1401 {
1402 return sftp_general_put(cmd, 1, 0);
1403 }
1404
1405 int sftp_cmd_mkdir(struct sftp_command *cmd)
1406 {
1407 char *dir;
1408 struct sftp_packet *pktin;
1409 struct sftp_request *req;
1410 int result;
1411 int i, ret;
1412
1413 if (back == NULL) {
1414 not_connected();
1415 return 0;
1416 }
1417
1418 if (cmd->nwords < 2) {
1419 printf("mkdir: expects a directory\n");
1420 return 0;
1421 }
1422
1423 ret = 1;
1424 for (i = 1; i < cmd->nwords; i++) {
1425 dir = canonify(cmd->words[i]);
1426 if (!dir) {
1427 printf("%s: canonify: %s\n", dir, fxp_error());
1428 return 0;
1429 }
1430
1431 req = fxp_mkdir_send(dir);
1432 pktin = sftp_wait_for_reply(req);
1433 result = fxp_mkdir_recv(pktin, req);
1434
1435 if (!result) {
1436 printf("mkdir %s: %s\n", dir, fxp_error());
1437 ret = 0;
1438 } else
1439 printf("mkdir %s: OK\n", dir);
1440
1441 sfree(dir);
1442 }
1443
1444 return ret;
1445 }
1446
1447 static int sftp_action_rmdir(void *vctx, char *dir)
1448 {
1449 struct sftp_packet *pktin;
1450 struct sftp_request *req;
1451 int result;
1452
1453 req = fxp_rmdir_send(dir);
1454 pktin = sftp_wait_for_reply(req);
1455 result = fxp_rmdir_recv(pktin, req);
1456
1457 if (!result) {
1458 printf("rmdir %s: %s\n", dir, fxp_error());
1459 return 0;
1460 }
1461
1462 printf("rmdir %s: OK\n", dir);
1463
1464 return 1;
1465 }
1466
1467 int sftp_cmd_rmdir(struct sftp_command *cmd)
1468 {
1469 int i, ret;
1470
1471 if (back == NULL) {
1472 not_connected();
1473 return 0;
1474 }
1475
1476 if (cmd->nwords < 2) {
1477 printf("rmdir: expects a directory\n");
1478 return 0;
1479 }
1480
1481 ret = 1;
1482 for (i = 1; i < cmd->nwords; i++)
1483 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1484
1485 return ret;
1486 }
1487
1488 static int sftp_action_rm(void *vctx, char *fname)
1489 {
1490 struct sftp_packet *pktin;
1491 struct sftp_request *req;
1492 int result;
1493
1494 req = fxp_remove_send(fname);
1495 pktin = sftp_wait_for_reply(req);
1496 result = fxp_remove_recv(pktin, req);
1497
1498 if (!result) {
1499 printf("rm %s: %s\n", fname, fxp_error());
1500 return 0;
1501 }
1502
1503 printf("rm %s: OK\n", fname);
1504
1505 return 1;
1506 }
1507
1508 int sftp_cmd_rm(struct sftp_command *cmd)
1509 {
1510 int i, ret;
1511
1512 if (back == NULL) {
1513 not_connected();
1514 return 0;
1515 }
1516
1517 if (cmd->nwords < 2) {
1518 printf("rm: expects a filename\n");
1519 return 0;
1520 }
1521
1522 ret = 1;
1523 for (i = 1; i < cmd->nwords; i++)
1524 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1525
1526 return ret;
1527 }
1528
1529 static int check_is_dir(char *dstfname)
1530 {
1531 struct sftp_packet *pktin;
1532 struct sftp_request *req;
1533 struct fxp_attrs attrs;
1534 int result;
1535
1536 req = fxp_stat_send(dstfname);
1537 pktin = sftp_wait_for_reply(req);
1538 result = fxp_stat_recv(pktin, req, &attrs);
1539
1540 if (result &&
1541 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1542 (attrs.permissions & 0040000))
1543 return TRUE;
1544 else
1545 return FALSE;
1546 }
1547
1548 struct sftp_context_mv {
1549 char *dstfname;
1550 int dest_is_dir;
1551 };
1552
1553 static int sftp_action_mv(void *vctx, char *srcfname)
1554 {
1555 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1556 struct sftp_packet *pktin;
1557 struct sftp_request *req;
1558 const char *error;
1559 char *finalfname, *newcanon = NULL;
1560 int ret, result;
1561
1562 if (ctx->dest_is_dir) {
1563 char *p;
1564 char *newname;
1565
1566 p = srcfname + strlen(srcfname);
1567 while (p > srcfname && p[-1] != '/') p--;
1568 newname = dupcat(ctx->dstfname, "/", p, NULL);
1569 newcanon = canonify(newname);
1570 if (!newcanon) {
1571 printf("%s: canonify: %s\n", newname, fxp_error());
1572 sfree(newname);
1573 return 0;
1574 }
1575 sfree(newname);
1576
1577 finalfname = newcanon;
1578 } else {
1579 finalfname = ctx->dstfname;
1580 }
1581
1582 req = fxp_rename_send(srcfname, finalfname);
1583 pktin = sftp_wait_for_reply(req);
1584 result = fxp_rename_recv(pktin, req);
1585
1586 error = result ? NULL : fxp_error();
1587
1588 if (error) {
1589 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1590 ret = 0;
1591 } else {
1592 printf("%s -> %s\n", srcfname, finalfname);
1593 ret = 1;
1594 }
1595
1596 sfree(newcanon);
1597 return ret;
1598 }
1599
1600 int sftp_cmd_mv(struct sftp_command *cmd)
1601 {
1602 struct sftp_context_mv actx, *ctx = &actx;
1603 int i, ret;
1604
1605 if (back == NULL) {
1606 not_connected();
1607 return 0;
1608 }
1609
1610 if (cmd->nwords < 3) {
1611 printf("mv: expects two filenames\n");
1612 return 0;
1613 }
1614
1615 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1616 if (!ctx->dstfname) {
1617 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1618 return 0;
1619 }
1620
1621 /*
1622 * If there's more than one source argument, or one source
1623 * argument which is a wildcard, we _require_ that the
1624 * destination is a directory.
1625 */
1626 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1627 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1628 printf("mv: multiple or wildcard arguments require the destination"
1629 " to be a directory\n");
1630 sfree(ctx->dstfname);
1631 return 0;
1632 }
1633
1634 /*
1635 * Now iterate over the source arguments.
1636 */
1637 ret = 1;
1638 for (i = 1; i < cmd->nwords-1; i++)
1639 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1640
1641 sfree(ctx->dstfname);
1642 return ret;
1643 }
1644
1645 struct sftp_context_chmod {
1646 unsigned attrs_clr, attrs_xor;
1647 };
1648
1649 static int sftp_action_chmod(void *vctx, char *fname)
1650 {
1651 struct fxp_attrs attrs;
1652 struct sftp_packet *pktin;
1653 struct sftp_request *req;
1654 int result;
1655 unsigned oldperms, newperms;
1656 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1657
1658 req = fxp_stat_send(fname);
1659 pktin = sftp_wait_for_reply(req);
1660 result = fxp_stat_recv(pktin, req, &attrs);
1661
1662 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1663 printf("get attrs for %s: %s\n", fname,
1664 result ? "file permissions not provided" : fxp_error());
1665 return 0;
1666 }
1667
1668 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1669 oldperms = attrs.permissions & 07777;
1670 attrs.permissions &= ~ctx->attrs_clr;
1671 attrs.permissions ^= ctx->attrs_xor;
1672 newperms = attrs.permissions & 07777;
1673
1674 if (oldperms == newperms)
1675 return 1; /* no need to do anything! */
1676
1677 req = fxp_setstat_send(fname, attrs);
1678 pktin = sftp_wait_for_reply(req);
1679 result = fxp_setstat_recv(pktin, req);
1680
1681 if (!result) {
1682 printf("set attrs for %s: %s\n", fname, fxp_error());
1683 return 0;
1684 }
1685
1686 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1687
1688 return 1;
1689 }
1690
1691 int sftp_cmd_chmod(struct sftp_command *cmd)
1692 {
1693 char *mode;
1694 int i, ret;
1695 struct sftp_context_chmod actx, *ctx = &actx;
1696
1697 if (back == NULL) {
1698 not_connected();
1699 return 0;
1700 }
1701
1702 if (cmd->nwords < 3) {
1703 printf("chmod: expects a mode specifier and a filename\n");
1704 return 0;
1705 }
1706
1707 /*
1708 * Attempt to parse the mode specifier in cmd->words[1]. We
1709 * don't support the full horror of Unix chmod; instead we
1710 * support a much simpler syntax in which the user can either
1711 * specify an octal number, or a comma-separated sequence of
1712 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1713 * _only_ be omitted if the only attribute mentioned is t,
1714 * since all others require a user/group/other specification.
1715 * Additionally, the s attribute may not be specified for any
1716 * [ugoa] specifications other than exactly u or exactly g.
1717 */
1718 ctx->attrs_clr = ctx->attrs_xor = 0;
1719 mode = cmd->words[1];
1720 if (mode[0] >= '0' && mode[0] <= '9') {
1721 if (mode[strspn(mode, "01234567")]) {
1722 printf("chmod: numeric file modes should"
1723 " contain digits 0-7 only\n");
1724 return 0;
1725 }
1726 ctx->attrs_clr = 07777;
1727 sscanf(mode, "%o", &ctx->attrs_xor);
1728 ctx->attrs_xor &= ctx->attrs_clr;
1729 } else {
1730 while (*mode) {
1731 char *modebegin = mode;
1732 unsigned subset, perms;
1733 int action;
1734
1735 subset = 0;
1736 while (*mode && *mode != ',' &&
1737 *mode != '+' && *mode != '-' && *mode != '=') {
1738 switch (*mode) {
1739 case 'u': subset |= 04700; break; /* setuid, user perms */
1740 case 'g': subset |= 02070; break; /* setgid, group perms */
1741 case 'o': subset |= 00007; break; /* just other perms */
1742 case 'a': subset |= 06777; break; /* all of the above */
1743 default:
1744 printf("chmod: file mode '%.*s' contains unrecognised"
1745 " user/group/other specifier '%c'\n",
1746 (int)strcspn(modebegin, ","), modebegin, *mode);
1747 return 0;
1748 }
1749 mode++;
1750 }
1751 if (!*mode || *mode == ',') {
1752 printf("chmod: file mode '%.*s' is incomplete\n",
1753 (int)strcspn(modebegin, ","), modebegin);
1754 return 0;
1755 }
1756 action = *mode++;
1757 if (!*mode || *mode == ',') {
1758 printf("chmod: file mode '%.*s' is incomplete\n",
1759 (int)strcspn(modebegin, ","), modebegin);
1760 return 0;
1761 }
1762 perms = 0;
1763 while (*mode && *mode != ',') {
1764 switch (*mode) {
1765 case 'r': perms |= 00444; break;
1766 case 'w': perms |= 00222; break;
1767 case 'x': perms |= 00111; break;
1768 case 't': perms |= 01000; subset |= 01000; break;
1769 case 's':
1770 if ((subset & 06777) != 04700 &&
1771 (subset & 06777) != 02070) {
1772 printf("chmod: file mode '%.*s': set[ug]id bit should"
1773 " be used with exactly one of u or g only\n",
1774 (int)strcspn(modebegin, ","), modebegin);
1775 return 0;
1776 }
1777 perms |= 06000;
1778 break;
1779 default:
1780 printf("chmod: file mode '%.*s' contains unrecognised"
1781 " permission specifier '%c'\n",
1782 (int)strcspn(modebegin, ","), modebegin, *mode);
1783 return 0;
1784 }
1785 mode++;
1786 }
1787 if (!(subset & 06777) && (perms &~ subset)) {
1788 printf("chmod: file mode '%.*s' contains no user/group/other"
1789 " specifier and permissions other than 't' \n",
1790 (int)strcspn(modebegin, ","), modebegin);
1791 return 0;
1792 }
1793 perms &= subset;
1794 switch (action) {
1795 case '+':
1796 ctx->attrs_clr |= perms;
1797 ctx->attrs_xor |= perms;
1798 break;
1799 case '-':
1800 ctx->attrs_clr |= perms;
1801 ctx->attrs_xor &= ~perms;
1802 break;
1803 case '=':
1804 ctx->attrs_clr |= subset;
1805 ctx->attrs_xor |= perms;
1806 break;
1807 }
1808 if (*mode) mode++; /* eat comma */
1809 }
1810 }
1811
1812 ret = 1;
1813 for (i = 2; i < cmd->nwords; i++)
1814 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1815
1816 return ret;
1817 }
1818
1819 static int sftp_cmd_open(struct sftp_command *cmd)
1820 {
1821 int portnumber;
1822
1823 if (back != NULL) {
1824 printf("psftp: already connected\n");
1825 return 0;
1826 }
1827
1828 if (cmd->nwords < 2) {
1829 printf("open: expects a host name\n");
1830 return 0;
1831 }
1832
1833 if (cmd->nwords > 2) {
1834 portnumber = atoi(cmd->words[2]);
1835 if (portnumber == 0) {
1836 printf("open: invalid port number\n");
1837 return 0;
1838 }
1839 } else
1840 portnumber = 0;
1841
1842 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1843 back = NULL; /* connection is already closed */
1844 return -1; /* this is fatal */
1845 }
1846 do_sftp_init();
1847 return 1;
1848 }
1849
1850 static int sftp_cmd_lcd(struct sftp_command *cmd)
1851 {
1852 char *currdir, *errmsg;
1853
1854 if (cmd->nwords < 2) {
1855 printf("lcd: expects a local directory name\n");
1856 return 0;
1857 }
1858
1859 errmsg = psftp_lcd(cmd->words[1]);
1860 if (errmsg) {
1861 printf("lcd: unable to change directory: %s\n", errmsg);
1862 sfree(errmsg);
1863 return 0;
1864 }
1865
1866 currdir = psftp_getcwd();
1867 printf("New local directory is %s\n", currdir);
1868 sfree(currdir);
1869
1870 return 1;
1871 }
1872
1873 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1874 {
1875 char *currdir;
1876
1877 currdir = psftp_getcwd();
1878 printf("Current local directory is %s\n", currdir);
1879 sfree(currdir);
1880
1881 return 1;
1882 }
1883
1884 static int sftp_cmd_pling(struct sftp_command *cmd)
1885 {
1886 int exitcode;
1887
1888 exitcode = system(cmd->words[1]);
1889 return (exitcode == 0);
1890 }
1891
1892 static int sftp_cmd_help(struct sftp_command *cmd);
1893
1894 static struct sftp_cmd_lookup {
1895 char *name;
1896 /*
1897 * For help purposes, there are two kinds of command:
1898 *
1899 * - primary commands, in which `longhelp' is non-NULL. In
1900 * this case `shorthelp' is descriptive text, and `longhelp'
1901 * is longer descriptive text intended to be printed after
1902 * the command name.
1903 *
1904 * - alias commands, in which `longhelp' is NULL. In this case
1905 * `shorthelp' is the name of a primary command, which
1906 * contains the help that should double up for this command.
1907 */
1908 int listed; /* do we list this in primary help? */
1909 char *shorthelp;
1910 char *longhelp;
1911 int (*obey) (struct sftp_command *);
1912 } sftp_lookup[] = {
1913 /*
1914 * List of sftp commands. This is binary-searched so it MUST be
1915 * in ASCII order.
1916 */
1917 {
1918 "!", TRUE, "run a local command",
1919 "<command>\n"
1920 /* FIXME: this example is crap for non-Windows. */
1921 " Runs a local command. For example, \"!del myfile\".\n",
1922 sftp_cmd_pling
1923 },
1924 {
1925 "bye", TRUE, "finish your SFTP session",
1926 "\n"
1927 " Terminates your SFTP session and quits the PSFTP program.\n",
1928 sftp_cmd_quit
1929 },
1930 {
1931 "cd", TRUE, "change your remote working directory",
1932 " [ <new working directory> ]\n"
1933 " Change the remote working directory for your SFTP session.\n"
1934 " If a new working directory is not supplied, you will be\n"
1935 " returned to your home directory.\n",
1936 sftp_cmd_cd
1937 },
1938 {
1939 "chmod", TRUE, "change file permissions and modes",
1940 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1941 " Change the file permissions on one or more remote files or\n"
1942 " directories.\n"
1943 " <modes> can be any octal Unix permission specifier.\n"
1944 " Alternatively, <modes> can include the following modifiers:\n"
1945 " u+r make file readable by owning user\n"
1946 " u+w make file writable by owning user\n"
1947 " u+x make file executable by owning user\n"
1948 " u-r make file not readable by owning user\n"
1949 " [also u-w, u-x]\n"
1950 " g+r make file readable by members of owning group\n"
1951 " [also g+w, g+x, g-r, g-w, g-x]\n"
1952 " o+r make file readable by all other users\n"
1953 " [also o+w, o+x, o-r, o-w, o-x]\n"
1954 " a+r make file readable by absolutely everybody\n"
1955 " [also a+w, a+x, a-r, a-w, a-x]\n"
1956 " u+s enable the Unix set-user-ID bit\n"
1957 " u-s disable the Unix set-user-ID bit\n"
1958 " g+s enable the Unix set-group-ID bit\n"
1959 " g-s disable the Unix set-group-ID bit\n"
1960 " +t enable the Unix \"sticky bit\"\n"
1961 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1962 " more than one user for the same modifier (\"ug+w\"). You can\n"
1963 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1964 sftp_cmd_chmod
1965 },
1966 {
1967 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1968 "\n"
1969 " Terminates your SFTP session, but does not quit the PSFTP\n"
1970 " program. You can then use \"open\" to start another SFTP\n"
1971 " session, to the same server or to a different one.\n",
1972 sftp_cmd_close
1973 },
1974 {
1975 "del", TRUE, "delete files on the remote server",
1976 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1977 " Delete a file or files from the server.\n",
1978 sftp_cmd_rm
1979 },
1980 {
1981 "delete", FALSE, "del", NULL, sftp_cmd_rm
1982 },
1983 {
1984 "dir", TRUE, "list remote files",
1985 " [ <directory-name> ]/[ <wildcard> ]\n"
1986 " List the contents of a specified directory on the server.\n"
1987 " If <directory-name> is not given, the current working directory\n"
1988 " is assumed.\n"
1989 " If <wildcard> is given, it is treated as a set of files to\n"
1990 " list; otherwise, all files are listed.\n",
1991 sftp_cmd_ls
1992 },
1993 {
1994 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1995 },
1996 {
1997 "get", TRUE, "download a file from the server to your local machine",
1998 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1999 " Downloads a file on the server and stores it locally under\n"
2000 " the same name, or under a different one if you supply the\n"
2001 " argument <local-filename>.\n"
2002 " If -r specified, recursively fetch a directory.\n",
2003 sftp_cmd_get
2004 },
2005 {
2006 "help", TRUE, "give help",
2007 " [ <command> [ <command> ... ] ]\n"
2008 " Give general help if no commands are specified.\n"
2009 " If one or more commands are specified, give specific help on\n"
2010 " those particular commands.\n",
2011 sftp_cmd_help
2012 },
2013 {
2014 "lcd", TRUE, "change local working directory",
2015 " <local-directory-name>\n"
2016 " Change the local working directory of the PSFTP program (the\n"
2017 " default location where the \"get\" command will save files).\n",
2018 sftp_cmd_lcd
2019 },
2020 {
2021 "lpwd", TRUE, "print local working directory",
2022 "\n"
2023 " Print the local working directory of the PSFTP program (the\n"
2024 " default location where the \"get\" command will save files).\n",
2025 sftp_cmd_lpwd
2026 },
2027 {
2028 "ls", TRUE, "dir", NULL,
2029 sftp_cmd_ls
2030 },
2031 {
2032 "mget", TRUE, "download multiple files at once",
2033 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2034 " Downloads many files from the server, storing each one under\n"
2035 " the same name it has on the server side. You can use wildcards\n"
2036 " such as \"*.c\" to specify lots of files at once.\n"
2037 " If -r specified, recursively fetch files and directories.\n",
2038 sftp_cmd_mget
2039 },
2040 {
2041 "mkdir", TRUE, "create directories on the remote server",
2042 " <directory-name> [ <directory-name>... ]\n"
2043 " Creates directories with the given names on the server.\n",
2044 sftp_cmd_mkdir
2045 },
2046 {
2047 "mput", TRUE, "upload multiple files at once",
2048 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2049 " Uploads many files to the server, storing each one under the\n"
2050 " same name it has on the client side. You can use wildcards\n"
2051 " such as \"*.c\" to specify lots of files at once.\n"
2052 " If -r specified, recursively store files and directories.\n",
2053 sftp_cmd_mput
2054 },
2055 {
2056 "mv", TRUE, "move or rename file(s) on the remote server",
2057 " <source> [ <source>... ] <destination>\n"
2058 " Moves or renames <source>(s) on the server to <destination>,\n"
2059 " also on the server.\n"
2060 " If <destination> specifies an existing directory, then <source>\n"
2061 " may be a wildcard, and multiple <source>s may be given; all\n"
2062 " source files are moved into <destination>.\n"
2063 " Otherwise, <source> must specify a single file, which is moved\n"
2064 " or renamed so that it is accessible under the name <destination>.\n",
2065 sftp_cmd_mv
2066 },
2067 {
2068 "open", TRUE, "connect to a host",
2069 " [<user>@]<hostname> [<port>]\n"
2070 " Establishes an SFTP connection to a given host. Only usable\n"
2071 " when you are not already connected to a server.\n",
2072 sftp_cmd_open
2073 },
2074 {
2075 "put", TRUE, "upload a file from your local machine to the server",
2076 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2077 " Uploads a file to the server and stores it there under\n"
2078 " the same name, or under a different one if you supply the\n"
2079 " argument <remote-filename>.\n"
2080 " If -r specified, recursively store a directory.\n",
2081 sftp_cmd_put
2082 },
2083 {
2084 "pwd", TRUE, "print your remote working directory",
2085 "\n"
2086 " Print the current remote working directory for your SFTP session.\n",
2087 sftp_cmd_pwd
2088 },
2089 {
2090 "quit", TRUE, "bye", NULL,
2091 sftp_cmd_quit
2092 },
2093 {
2094 "reget", TRUE, "continue downloading files",
2095 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2096 " Works exactly like the \"get\" command, but the local file\n"
2097 " must already exist. The download will begin at the end of the\n"
2098 " file. This is for resuming a download that was interrupted.\n"
2099 " If -r specified, resume interrupted \"get -r\".\n",
2100 sftp_cmd_reget
2101 },
2102 {
2103 "ren", TRUE, "mv", NULL,
2104 sftp_cmd_mv
2105 },
2106 {
2107 "rename", FALSE, "mv", NULL,
2108 sftp_cmd_mv
2109 },
2110 {
2111 "reput", TRUE, "continue uploading files",
2112 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2113 " Works exactly like the \"put\" command, but the remote file\n"
2114 " must already exist. The upload will begin at the end of the\n"
2115 " file. This is for resuming an upload that was interrupted.\n"
2116 " If -r specified, resume interrupted \"put -r\".\n",
2117 sftp_cmd_reput
2118 },
2119 {
2120 "rm", TRUE, "del", NULL,
2121 sftp_cmd_rm
2122 },
2123 {
2124 "rmdir", TRUE, "remove directories on the remote server",
2125 " <directory-name> [ <directory-name>... ]\n"
2126 " Removes the directory with the given name on the server.\n"
2127 " The directory will not be removed unless it is empty.\n"
2128 " Wildcards may be used to specify multiple directories.\n",
2129 sftp_cmd_rmdir
2130 }
2131 };
2132
2133 const struct sftp_cmd_lookup *lookup_command(char *name)
2134 {
2135 int i, j, k, cmp;
2136
2137 i = -1;
2138 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2139 while (j - i > 1) {
2140 k = (j + i) / 2;
2141 cmp = strcmp(name, sftp_lookup[k].name);
2142 if (cmp < 0)
2143 j = k;
2144 else if (cmp > 0)
2145 i = k;
2146 else {
2147 return &sftp_lookup[k];
2148 }
2149 }
2150 return NULL;
2151 }
2152
2153 static int sftp_cmd_help(struct sftp_command *cmd)
2154 {
2155 int i;
2156 if (cmd->nwords == 1) {
2157 /*
2158 * Give short help on each command.
2159 */
2160 int maxlen;
2161 maxlen = 0;
2162 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2163 int len;
2164 if (!sftp_lookup[i].listed)
2165 continue;
2166 len = strlen(sftp_lookup[i].name);
2167 if (maxlen < len)
2168 maxlen = len;
2169 }
2170 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2171 const struct sftp_cmd_lookup *lookup;
2172 if (!sftp_lookup[i].listed)
2173 continue;
2174 lookup = &sftp_lookup[i];
2175 printf("%-*s", maxlen+2, lookup->name);
2176 if (lookup->longhelp == NULL)
2177 lookup = lookup_command(lookup->shorthelp);
2178 printf("%s\n", lookup->shorthelp);
2179 }
2180 } else {
2181 /*
2182 * Give long help on specific commands.
2183 */
2184 for (i = 1; i < cmd->nwords; i++) {
2185 const struct sftp_cmd_lookup *lookup;
2186 lookup = lookup_command(cmd->words[i]);
2187 if (!lookup) {
2188 printf("help: %s: command not found\n", cmd->words[i]);
2189 } else {
2190 printf("%s", lookup->name);
2191 if (lookup->longhelp == NULL)
2192 lookup = lookup_command(lookup->shorthelp);
2193 printf("%s", lookup->longhelp);
2194 }
2195 }
2196 }
2197 return 1;
2198 }
2199
2200 /* ----------------------------------------------------------------------
2201 * Command line reading and parsing.
2202 */
2203 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2204 {
2205 char *line;
2206 struct sftp_command *cmd;
2207 char *p, *q, *r;
2208 int quoting;
2209
2210 cmd = snew(struct sftp_command);
2211 cmd->words = NULL;
2212 cmd->nwords = 0;
2213 cmd->wordssize = 0;
2214
2215 line = NULL;
2216
2217 if (fp) {
2218 if (modeflags & 1)
2219 printf("psftp> ");
2220 line = fgetline(fp);
2221 } else {
2222 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2223 }
2224
2225 if (!line || !*line) {
2226 cmd->obey = sftp_cmd_quit;
2227 if ((mode == 0) || (modeflags & 1))
2228 printf("quit\n");
2229 return cmd; /* eof */
2230 }
2231
2232 line[strcspn(line, "\r\n")] = '\0';
2233
2234 if (modeflags & 1) {
2235 printf("%s\n", line);
2236 }
2237
2238 p = line;
2239 while (*p && (*p == ' ' || *p == '\t'))
2240 p++;
2241
2242 if (*p == '!') {
2243 /*
2244 * Special case: the ! command. This is always parsed as
2245 * exactly two words: one containing the !, and the second
2246 * containing everything else on the line.
2247 */
2248 cmd->nwords = cmd->wordssize = 2;
2249 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2250 cmd->words[0] = dupstr("!");
2251 cmd->words[1] = dupstr(p+1);
2252 } else if (*p == '#') {
2253 /*
2254 * Special case: comment. Entire line is ignored.
2255 */
2256 cmd->nwords = cmd->wordssize = 0;
2257 } else {
2258
2259 /*
2260 * Parse the command line into words. The syntax is:
2261 * - double quotes are removed, but cause spaces within to be
2262 * treated as non-separating.
2263 * - a double-doublequote pair is a literal double quote, inside
2264 * _or_ outside quotes. Like this:
2265 *
2266 * firstword "second word" "this has ""quotes"" in" and""this""
2267 *
2268 * becomes
2269 *
2270 * >firstword<
2271 * >second word<
2272 * >this has "quotes" in<
2273 * >and"this"<
2274 */
2275 while (1) {
2276 /* skip whitespace */
2277 while (*p && (*p == ' ' || *p == '\t'))
2278 p++;
2279 /* terminate loop */
2280 if (!*p)
2281 break;
2282 /* mark start of word */
2283 q = r = p; /* q sits at start, r writes word */
2284 quoting = 0;
2285 while (*p) {
2286 if (!quoting && (*p == ' ' || *p == '\t'))
2287 break; /* reached end of word */
2288 else if (*p == '"' && p[1] == '"')
2289 p += 2, *r++ = '"'; /* a literal quote */
2290 else if (*p == '"')
2291 p++, quoting = !quoting;
2292 else
2293 *r++ = *p++;
2294 }
2295 if (*p)
2296 p++; /* skip over the whitespace */
2297 *r = '\0';
2298 if (cmd->nwords >= cmd->wordssize) {
2299 cmd->wordssize = cmd->nwords + 16;
2300 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2301 }
2302 cmd->words[cmd->nwords++] = dupstr(q);
2303 }
2304 }
2305
2306 sfree(line);
2307
2308 /*
2309 * Now parse the first word and assign a function.
2310 */
2311
2312 if (cmd->nwords == 0)
2313 cmd->obey = sftp_cmd_null;
2314 else {
2315 const struct sftp_cmd_lookup *lookup;
2316 lookup = lookup_command(cmd->words[0]);
2317 if (!lookup)
2318 cmd->obey = sftp_cmd_unknown;
2319 else
2320 cmd->obey = lookup->obey;
2321 }
2322
2323 return cmd;
2324 }
2325
2326 static int do_sftp_init(void)
2327 {
2328 struct sftp_packet *pktin;
2329 struct sftp_request *req;
2330
2331 /*
2332 * Do protocol initialisation.
2333 */
2334 if (!fxp_init()) {
2335 fprintf(stderr,
2336 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2337 return 1; /* failure */
2338 }
2339
2340 /*
2341 * Find out where our home directory is.
2342 */
2343 req = fxp_realpath_send(".");
2344 pktin = sftp_wait_for_reply(req);
2345 homedir = fxp_realpath_recv(pktin, req);
2346
2347 if (!homedir) {
2348 fprintf(stderr,
2349 "Warning: failed to resolve home directory: %s\n",
2350 fxp_error());
2351 homedir = dupstr(".");
2352 } else {
2353 printf("Remote working directory is %s\n", homedir);
2354 }
2355 pwd = dupstr(homedir);
2356 return 0;
2357 }
2358
2359 void do_sftp_cleanup()
2360 {
2361 char ch;
2362 if (back) {
2363 back->special(backhandle, TS_EOF);
2364 sent_eof = TRUE;
2365 sftp_recvdata(&ch, 1);
2366 back->free(backhandle);
2367 sftp_cleanup_request();
2368 back = NULL;
2369 backhandle = NULL;
2370 }
2371 if (pwd) {
2372 sfree(pwd);
2373 pwd = NULL;
2374 }
2375 if (homedir) {
2376 sfree(homedir);
2377 homedir = NULL;
2378 }
2379 }
2380
2381 void do_sftp(int mode, int modeflags, char *batchfile)
2382 {
2383 FILE *fp;
2384 int ret;
2385
2386 /*
2387 * Batch mode?
2388 */
2389 if (mode == 0) {
2390
2391 /* ------------------------------------------------------------------
2392 * Now we're ready to do Real Stuff.
2393 */
2394 while (1) {
2395 struct sftp_command *cmd;
2396 cmd = sftp_getcmd(NULL, 0, 0);
2397 if (!cmd)
2398 break;
2399 ret = cmd->obey(cmd);
2400 if (cmd->words) {
2401 int i;
2402 for(i = 0; i < cmd->nwords; i++)
2403 sfree(cmd->words[i]);
2404 sfree(cmd->words);
2405 }
2406 sfree(cmd);
2407 if (ret < 0)
2408 break;
2409 }
2410 } else {
2411 fp = fopen(batchfile, "r");
2412 if (!fp) {
2413 printf("Fatal: unable to open %s\n", batchfile);
2414 return;
2415 }
2416 while (1) {
2417 struct sftp_command *cmd;
2418 cmd = sftp_getcmd(fp, mode, modeflags);
2419 if (!cmd)
2420 break;
2421 ret = cmd->obey(cmd);
2422 if (ret < 0)
2423 break;
2424 if (ret == 0) {
2425 if (!(modeflags & 2))
2426 break;
2427 }
2428 }
2429 fclose(fp);
2430
2431 }
2432 }
2433
2434 /* ----------------------------------------------------------------------
2435 * Dirty bits: integration with PuTTY.
2436 */
2437
2438 static int verbose = 0;
2439
2440 /*
2441 * Print an error message and perform a fatal exit.
2442 */
2443 void fatalbox(char *fmt, ...)
2444 {
2445 char *str, *str2;
2446 va_list ap;
2447 va_start(ap, fmt);
2448 str = dupvprintf(fmt, ap);
2449 str2 = dupcat("Fatal: ", str, "\n", NULL);
2450 sfree(str);
2451 va_end(ap);
2452 fputs(str2, stderr);
2453 sfree(str2);
2454
2455 cleanup_exit(1);
2456 }
2457 void modalfatalbox(char *fmt, ...)
2458 {
2459 char *str, *str2;
2460 va_list ap;
2461 va_start(ap, fmt);
2462 str = dupvprintf(fmt, ap);
2463 str2 = dupcat("Fatal: ", str, "\n", NULL);
2464 sfree(str);
2465 va_end(ap);
2466 fputs(str2, stderr);
2467 sfree(str2);
2468
2469 cleanup_exit(1);
2470 }
2471 void connection_fatal(void *frontend, char *fmt, ...)
2472 {
2473 char *str, *str2;
2474 va_list ap;
2475 va_start(ap, fmt);
2476 str = dupvprintf(fmt, ap);
2477 str2 = dupcat("Fatal: ", str, "\n", NULL);
2478 sfree(str);
2479 va_end(ap);
2480 fputs(str2, stderr);
2481 sfree(str2);
2482
2483 cleanup_exit(1);
2484 }
2485
2486 void ldisc_send(void *handle, char *buf, int len, int interactive)
2487 {
2488 /*
2489 * This is only here because of the calls to ldisc_send(NULL,
2490 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2491 * ldisc as an ldisc. So if we get called with any real data, I
2492 * want to know about it.
2493 */
2494 assert(len == 0);
2495 }
2496
2497 /*
2498 * In psftp, all agent requests should be synchronous, so this is a
2499 * never-called stub.
2500 */
2501 void agent_schedule_callback(void (*callback)(void *, void *, int),
2502 void *callback_ctx, void *data, int len)
2503 {
2504 assert(!"We shouldn't be here");
2505 }
2506
2507 /*
2508 * Receive a block of data from the SSH link. Block until all data
2509 * is available.
2510 *
2511 * To do this, we repeatedly call the SSH protocol module, with our
2512 * own trap in from_backend() to catch the data that comes back. We
2513 * do this until we have enough data.
2514 */
2515
2516 static unsigned char *outptr; /* where to put the data */
2517 static unsigned outlen; /* how much data required */
2518 static unsigned char *pending = NULL; /* any spare data */
2519 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2520 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2521 {
2522 unsigned char *p = (unsigned char *) data;
2523 unsigned len = (unsigned) datalen;
2524
2525 /*
2526 * stderr data is just spouted to local stderr and otherwise
2527 * ignored.
2528 */
2529 if (is_stderr) {
2530 if (len > 0)
2531 if (fwrite(data, 1, len, stderr) < len)
2532 /* oh well */;
2533 return 0;
2534 }
2535
2536 /*
2537 * If this is before the real session begins, just return.
2538 */
2539 if (!outptr)
2540 return 0;
2541
2542 if ((outlen > 0) && (len > 0)) {
2543 unsigned used = outlen;
2544 if (used > len)
2545 used = len;
2546 memcpy(outptr, p, used);
2547 outptr += used;
2548 outlen -= used;
2549 p += used;
2550 len -= used;
2551 }
2552
2553 if (len > 0) {
2554 if (pendsize < pendlen + len) {
2555 pendsize = pendlen + len + 4096;
2556 pending = sresize(pending, pendsize, unsigned char);
2557 }
2558 memcpy(pending + pendlen, p, len);
2559 pendlen += len;
2560 }
2561
2562 return 0;
2563 }
2564 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2565 {
2566 /*
2567 * No "untrusted" output should get here (the way the code is
2568 * currently, it's all diverted by FLAG_STDERR).
2569 */
2570 assert(!"Unexpected call to from_backend_untrusted()");
2571 return 0; /* not reached */
2572 }
2573 int from_backend_eof(void *frontend)
2574 {
2575 /*
2576 * We expect to be the party deciding when to close the
2577 * connection, so if we see EOF before we sent it ourselves, we
2578 * should panic.
2579 */
2580 if (!sent_eof) {
2581 connection_fatal(frontend,
2582 "Received unexpected end-of-file from SFTP server");
2583 }
2584 return FALSE;
2585 }
2586 int sftp_recvdata(char *buf, int len)
2587 {
2588 outptr = (unsigned char *) buf;
2589 outlen = len;
2590
2591 /*
2592 * See if the pending-input block contains some of what we
2593 * need.
2594 */
2595 if (pendlen > 0) {
2596 unsigned pendused = pendlen;
2597 if (pendused > outlen)
2598 pendused = outlen;
2599 memcpy(outptr, pending, pendused);
2600 memmove(pending, pending + pendused, pendlen - pendused);
2601 outptr += pendused;
2602 outlen -= pendused;
2603 pendlen -= pendused;
2604 if (pendlen == 0) {
2605 pendsize = 0;
2606 sfree(pending);
2607 pending = NULL;
2608 }
2609 if (outlen == 0)
2610 return 1;
2611 }
2612
2613 while (outlen > 0) {
2614 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2615 return 0; /* doom */
2616 }
2617
2618 return 1;
2619 }
2620 int sftp_senddata(char *buf, int len)
2621 {
2622 back->send(backhandle, buf, len);
2623 return 1;
2624 }
2625
2626 /*
2627 * Short description of parameters.
2628 */
2629 static void usage(void)
2630 {
2631 printf("PuTTY Secure File Transfer (SFTP) client\n");
2632 printf("%s\n", ver);
2633 printf("Usage: psftp [options] [user@]host\n");
2634 printf("Options:\n");
2635 printf(" -V print version information and exit\n");
2636 printf(" -pgpfp print PGP key fingerprints and exit\n");
2637 printf(" -b file use specified batchfile\n");
2638 printf(" -bc output batchfile commands\n");
2639 printf(" -be don't stop batchfile processing if errors\n");
2640 printf(" -v show verbose messages\n");
2641 printf(" -load sessname Load settings from saved session\n");
2642 printf(" -l user connect with specified username\n");
2643 printf(" -P port connect to specified port\n");
2644 printf(" -pw passw login with specified password\n");
2645 printf(" -1 -2 force use of particular SSH protocol version\n");
2646 printf(" -4 -6 force use of IPv4 or IPv6\n");
2647 printf(" -C enable compression\n");
2648 printf(" -i key private key file for authentication\n");
2649 printf(" -noagent disable use of Pageant\n");
2650 printf(" -agent enable use of Pageant\n");
2651 printf(" -batch disable all interactive prompts\n");
2652 cleanup_exit(1);
2653 }
2654
2655 static void version(void)
2656 {
2657 printf("psftp: %s\n", ver);
2658 cleanup_exit(1);
2659 }
2660
2661 /*
2662 * Connect to a host.
2663 */
2664 static int psftp_connect(char *userhost, char *user, int portnumber)
2665 {
2666 char *host, *realhost;
2667 const char *err;
2668 void *logctx;
2669
2670 /* Separate host and username */
2671 host = userhost;
2672 host = strrchr(host, '@');
2673 if (host == NULL) {
2674 host = userhost;
2675 } else {
2676 *host++ = '\0';
2677 if (user) {
2678 printf("psftp: multiple usernames specified; using \"%s\"\n",
2679 user);
2680 } else
2681 user = userhost;
2682 }
2683
2684 /*
2685 * If we haven't loaded session details already (e.g., from -load),
2686 * try looking for a session called "host".
2687 */
2688 if (!loaded_session) {
2689 /* Try to load settings for `host' into a temporary config */
2690 Conf *conf2 = conf_new();
2691 conf_set_str(conf2, CONF_host, "");
2692 do_defaults(host, conf2);
2693 if (conf_get_str(conf2, CONF_host)[0] != '\0') {
2694 /* Settings present and include hostname */
2695 /* Re-load data into the real config. */
2696 do_defaults(host, conf);
2697 } else {
2698 /* Session doesn't exist or mention a hostname. */
2699 /* Use `host' as a bare hostname. */
2700 conf_set_str(conf, CONF_host, host);
2701 }
2702 } else {
2703 /* Patch in hostname `host' to session details. */
2704 conf_set_str(conf, CONF_host, host);
2705 }
2706
2707 /*
2708 * Force use of SSH. (If they got the protocol wrong we assume the
2709 * port is useless too.)
2710 */
2711 if (conf_get_int(conf, CONF_protocol) != PROT_SSH) {
2712 conf_set_int(conf, CONF_protocol, PROT_SSH);
2713 conf_set_int(conf, CONF_port, 22);
2714 }
2715
2716 /*
2717 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2718 * then change it to SSH-2, on the grounds that that's more likely to
2719 * work for SFTP. (Can be overridden with `-1' option.)
2720 * But if it says `2 only' or `2', respect which.
2721 */
2722 if ((conf_get_int(conf, CONF_sshprot) & ~1) != 2) /* is it 2 or 3? */
2723 conf_set_int(conf, CONF_sshprot, 2);
2724
2725 /*
2726 * Enact command-line overrides.
2727 */
2728 cmdline_run_saved(conf);
2729
2730 /*
2731 * Muck about with the hostname in various ways.
2732 */
2733 {
2734 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
2735 char *host = hostbuf;
2736 char *p, *q;
2737
2738 /*
2739 * Trim leading whitespace.
2740 */
2741 host += strspn(host, " \t");
2742
2743 /*
2744 * See if host is of the form user@host, and separate out
2745 * the username if so.
2746 */
2747 if (host[0] != '\0') {
2748 char *atsign = strrchr(host, '@');
2749 if (atsign) {
2750 *atsign = '\0';
2751 conf_set_str(conf, CONF_username, host);
2752 host = atsign + 1;
2753 }
2754 }
2755
2756 /*
2757 * Remove any remaining whitespace.
2758 */
2759 p = hostbuf;
2760 q = host;
2761 while (*q) {
2762 if (*q != ' ' && *q != '\t')
2763 *p++ = *q;
2764 q++;
2765 }
2766 *p = '\0';
2767
2768 conf_set_str(conf, CONF_host, hostbuf);
2769 sfree(hostbuf);
2770 }
2771
2772 /* Set username */
2773 if (user != NULL && user[0] != '\0') {
2774 conf_set_str(conf, CONF_username, user);
2775 }
2776
2777 if (portnumber)
2778 conf_set_int(conf, CONF_port, portnumber);
2779
2780 /*
2781 * Disable scary things which shouldn't be enabled for simple
2782 * things like SCP and SFTP: agent forwarding, port forwarding,
2783 * X forwarding.
2784 */
2785 conf_set_int(conf, CONF_x11_forward, 0);
2786 conf_set_int(conf, CONF_agentfwd, 0);
2787 conf_set_int(conf, CONF_ssh_simple, TRUE);
2788 {
2789 char *key;
2790 while ((key = conf_get_str_nthstrkey(conf, CONF_portfwd, 0)) != NULL)
2791 conf_del_str_str(conf, CONF_portfwd, key);
2792 }
2793
2794 /* Set up subsystem name. */
2795 conf_set_str(conf, CONF_remote_cmd, "sftp");
2796 conf_set_int(conf, CONF_ssh_subsys, TRUE);
2797 conf_set_int(conf, CONF_nopty, TRUE);
2798
2799 /*
2800 * Set up fallback option, for SSH-1 servers or servers with the
2801 * sftp subsystem not enabled but the server binary installed
2802 * in the usual place. We only support fallback on Unix
2803 * systems, and we use a kludgy piece of shellery which should
2804 * try to find sftp-server in various places (the obvious
2805 * systemwide spots /usr/lib and /usr/local/lib, and then the
2806 * user's PATH) and finally give up.
2807 *
2808 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2809 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2810 * exec sftp-server
2811 *
2812 * the idea being that this will attempt to use either of the
2813 * obvious pathnames and then give up, and when it does give up
2814 * it will print the preferred pathname in the error messages.
2815 */
2816 conf_set_str(conf, CONF_remote_cmd2,
2817 "test -x /usr/lib/sftp-server &&"
2818 " exec /usr/lib/sftp-server\n"
2819 "test -x /usr/local/lib/sftp-server &&"
2820 " exec /usr/local/lib/sftp-server\n"
2821 "exec sftp-server");
2822 conf_set_int(conf, CONF_ssh_subsys2, FALSE);
2823
2824 back = &ssh_backend;
2825
2826 err = back->init(NULL, &backhandle, conf,
2827 conf_get_str(conf, CONF_host),
2828 conf_get_int(conf, CONF_port),
2829 &realhost, 0,
2830 conf_get_int(conf, CONF_tcp_keepalives));
2831 if (err != NULL) {
2832 fprintf(stderr, "ssh_init: %s\n", err);
2833 return 1;
2834 }
2835 logctx = log_init(NULL, conf);
2836 back->provide_logctx(backhandle, logctx);
2837 console_provide_logctx(logctx);
2838 while (!back->sendok(backhandle)) {
2839 if (back->exitcode(backhandle) >= 0)
2840 return 1;
2841 if (ssh_sftp_loop_iteration() < 0) {
2842 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2843 return 1;
2844 }
2845 }
2846 if (verbose && realhost != NULL)
2847 printf("Connected to %s\n", realhost);
2848 if (realhost != NULL)
2849 sfree(realhost);
2850 return 0;
2851 }
2852
2853 void cmdline_error(char *p, ...)
2854 {
2855 va_list ap;
2856 fprintf(stderr, "psftp: ");
2857 va_start(ap, p);
2858 vfprintf(stderr, p, ap);
2859 va_end(ap);
2860 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2861 exit(1);
2862 }
2863
2864 /*
2865 * Main program. Parse arguments etc.
2866 */
2867 int psftp_main(int argc, char *argv[])
2868 {
2869 int i;
2870 int portnumber = 0;
2871 char *userhost, *user;
2872 int mode = 0;
2873 int modeflags = 0;
2874 char *batchfile = NULL;
2875
2876 flags = FLAG_STDERR | FLAG_INTERACTIVE
2877 #ifdef FLAG_SYNCAGENT
2878 | FLAG_SYNCAGENT
2879 #endif
2880 ;
2881 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2882 sk_init();
2883
2884 userhost = user = NULL;
2885
2886 /* Load Default Settings before doing anything else. */
2887 conf = conf_new();
2888 do_defaults(NULL, conf);
2889 loaded_session = FALSE;
2890
2891 for (i = 1; i < argc; i++) {
2892 int ret;
2893 if (argv[i][0] != '-') {
2894 if (userhost)
2895 usage();
2896 else
2897 userhost = dupstr(argv[i]);
2898 continue;
2899 }
2900 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, conf);
2901 if (ret == -2) {
2902 cmdline_error("option \"%s\" requires an argument", argv[i]);
2903 } else if (ret == 2) {
2904 i++; /* skip next argument */
2905 } else if (ret == 1) {
2906 /* We have our own verbosity in addition to `flags'. */
2907 if (flags & FLAG_VERBOSE)
2908 verbose = 1;
2909 } else if (strcmp(argv[i], "-h") == 0 ||
2910 strcmp(argv[i], "-?") == 0 ||
2911 strcmp(argv[i], "--help") == 0) {
2912 usage();
2913 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2914 pgp_fingerprints();
2915 return 1;
2916 } else if (strcmp(argv[i], "-V") == 0 ||
2917 strcmp(argv[i], "--version") == 0) {
2918 version();
2919 } else if (strcmp(argv[i], "-batch") == 0) {
2920 console_batch_mode = 1;
2921 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2922 mode = 1;
2923 batchfile = argv[++i];
2924 } else if (strcmp(argv[i], "-bc") == 0) {
2925 modeflags = modeflags | 1;
2926 } else if (strcmp(argv[i], "-be") == 0) {
2927 modeflags = modeflags | 2;
2928 } else if (strcmp(argv[i], "--") == 0) {
2929 i++;
2930 break;
2931 } else {
2932 cmdline_error("unknown option \"%s\"", argv[i]);
2933 }
2934 }
2935 argc -= i;
2936 argv += i;
2937 back = NULL;
2938
2939 /*
2940 * If the loaded session provides a hostname, and a hostname has not
2941 * otherwise been specified, pop it in `userhost' so that
2942 * `psftp -load sessname' is sufficient to start a session.
2943 */
2944 if (!userhost && conf_get_str(conf, CONF_host)[0] != '\0') {
2945 userhost = dupstr(conf_get_str(conf, CONF_host));
2946 }
2947
2948 /*
2949 * If a user@host string has already been provided, connect to
2950 * it now.
2951 */
2952 if (userhost) {
2953 int ret;
2954 ret = psftp_connect(userhost, user, portnumber);
2955 sfree(userhost);
2956 if (ret)
2957 return 1;
2958 if (do_sftp_init())
2959 return 1;
2960 } else {
2961 printf("psftp: no hostname specified; use \"open host.name\""
2962 " to connect\n");
2963 }
2964
2965 do_sftp(mode, modeflags, batchfile);
2966
2967 if (back != NULL && back->connected(backhandle)) {
2968 char ch;
2969 back->special(backhandle, TS_EOF);
2970 sent_eof = TRUE;
2971 sftp_recvdata(&ch, 1);
2972 }
2973 do_sftp_cleanup();
2974 random_save_seed();
2975 cmdline_cleanup();
2976 console_provide_logctx(NULL);
2977 sk_cleanup();
2978
2979 return 0;
2980 }