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