2 * psftp.c: (platform-independent) front end for PSFTP.
11 #define PUTTY_DO_GLOBALS
19 const char *const appname = "PSFTP";
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
28 static int psftp_connect(char *userhost, char *user, int portnumber);
29 static int do_sftp_init(void);
30 void do_sftp_cleanup();
32 /* ----------------------------------------------------------------------
38 static void *backhandle;
42 /* ----------------------------------------------------------------------
43 * Higher-level helper functions used in commands.
47 * Attempt to canonify a pathname starting from the pwd. If
48 * canonification fails, at least fall back to returning a _valid_
49 * pathname (though it may be ugly, eg /home/simon/../foobar).
51 char *canonify(char *name)
53 char *fullname, *canonname;
54 struct sftp_packet *pktin;
55 struct sftp_request *req, *rreq;
58 fullname = dupstr(name);
61 if (pwd[strlen(pwd) - 1] == '/')
65 fullname = dupcat(pwd, slash, name, NULL);
68 sftp_register(req = fxp_realpath_send(fullname));
69 rreq = sftp_find_request(pktin = sftp_recv());
71 canonname = fxp_realpath_recv(pktin, rreq);
78 * Attempt number 2. Some FXP_REALPATH implementations
79 * (glibc-based ones, in particular) require the _whole_
80 * path to point to something that exists, whereas others
81 * (BSD-based) only require all but the last component to
82 * exist. So if the first call failed, we should strip off
83 * everything from the last slash onwards and try again,
84 * then put the final component back on.
88 * - if the last component is "/." or "/..", then we don't
89 * bother trying this because there's no way it can work.
91 * - if the thing actually ends with a "/", we remove it
92 * before we start. Except if the string is "/" itself
93 * (although I can't see why we'd have got here if so,
94 * because surely "/" would have worked the first
95 * time?), in which case we don't bother.
97 * - if there's no slash in the string at all, give up in
98 * confusion (we expect at least one because of the way
99 * we constructed the string).
105 i = strlen(fullname);
106 if (i > 2 && fullname[i - 1] == '/')
107 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
108 while (i > 0 && fullname[--i] != '/');
111 * Give up on special cases.
113 if (fullname[i] != '/' || /* no slash at all */
114 !strcmp(fullname + i, "/.") || /* ends in /. */
115 !strcmp(fullname + i, "/..") || /* ends in /.. */
116 !strcmp(fullname, "/")) {
121 * Now i points at the slash. Deal with the final special
122 * case i==0 (ie the whole path was "/nonexistentfile").
124 fullname[i] = '\0'; /* separate the string */
126 sftp_register(req = fxp_realpath_send("/"));
128 sftp_register(req = fxp_realpath_send(fullname));
130 rreq = sftp_find_request(pktin = sftp_recv());
132 canonname = fxp_realpath_recv(pktin, rreq);
135 /* Even that failed. Restore our best guess at the
136 * constructed filename and give up */
137 fullname[i] = '/'; /* restore slash and last component */
142 * We have a canonical name for all but the last path
143 * component. Concatenate the last component and return.
145 returnname = dupcat(canonname,
146 canonname[strlen(canonname) - 1] ==
147 '/' ? "" : "/", fullname + i + 1, NULL);
155 * Return a pointer to the portion of str that comes after the last
156 * slash (or backslash or colon, if `local' is TRUE).
158 static char *stripslashes(char *str, int local)
163 p = strchr(str, ':');
167 p = strrchr(str, '/');
171 p = strrchr(str, '\\');
179 * qsort comparison routine for fxp_name structures. Sorts by real
182 static int sftp_name_compare(const void *av, const void *bv)
184 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
185 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
186 return strcmp((*a)->filename, (*b)->filename);
190 * Likewise, but for a bare char *.
192 static int bare_name_compare(const void *av, const void *bv)
194 const char **a = (const char **) av;
195 const char **b = (const char **) bv;
196 return strcmp(*a, *b);
199 static void not_connected(void)
201 printf("psftp: not connected to a host; use \"open host.name\"\n");
204 /* ----------------------------------------------------------------------
205 * The meat of the `get' and `put' commands.
207 int sftp_get_file(char *fname, char *outfname, int recurse, int restart)
209 struct fxp_handle *fh;
210 struct sftp_packet *pktin;
211 struct sftp_request *req, *rreq;
212 struct fxp_xfer *xfer;
215 int ret, shown_err = FALSE;
216 struct fxp_attrs attrs;
219 * In recursive mode, see if we're dealing with a directory.
220 * (If we're not in recursive mode, we need not even check: the
221 * subsequent FXP_OPEN will return a usable error message.)
226 sftp_register(req = fxp_stat_send(fname));
227 rreq = sftp_find_request(pktin = sftp_recv());
229 result = fxp_stat_recv(pktin, rreq, &attrs);
232 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
233 (attrs.permissions & 0040000)) {
235 struct fxp_handle *dirhandle;
236 int nnames, namesize;
237 struct fxp_name **ournames;
238 struct fxp_names *names;
242 * First, attempt to create the destination directory,
243 * unless it already exists.
245 if (file_type(outfname) != FILE_TYPE_DIRECTORY &&
246 !create_directory(outfname)) {
247 printf("%s: Cannot create directory\n", outfname);
252 * Now get the list of filenames in the remote
255 sftp_register(req = fxp_opendir_send(fname));
256 rreq = sftp_find_request(pktin = sftp_recv());
258 dirhandle = fxp_opendir_recv(pktin, rreq);
261 printf("%s: unable to open directory: %s\n",
265 nnames = namesize = 0;
270 sftp_register(req = fxp_readdir_send(dirhandle));
271 rreq = sftp_find_request(pktin = sftp_recv());
273 names = fxp_readdir_recv(pktin, rreq);
276 if (fxp_error_type() == SSH_FX_EOF)
278 printf("%s: reading directory: %s\n", fname, fxp_error());
282 if (names->nnames == 0) {
283 fxp_free_names(names);
286 if (nnames + names->nnames >= namesize) {
287 namesize += names->nnames + 128;
288 ournames = sresize(ournames, namesize, struct fxp_name *);
290 for (i = 0; i < names->nnames; i++)
291 if (strcmp(names->names[i].filename, ".") &&
292 strcmp(names->names[i].filename, "..")) {
293 if (!vet_filename(names->names[i].filename)) {
294 printf("ignoring potentially dangerous server-"
295 "supplied filename '%s'\n",
296 names->names[i].filename);
299 fxp_dup_name(&names->names[i]);
302 fxp_free_names(names);
304 sftp_register(req = fxp_close_send(dirhandle));
305 rreq = sftp_find_request(pktin = sftp_recv());
307 fxp_close_recv(pktin, rreq);
310 * Sort the names into a clear order. This ought to
311 * make things more predictable when we're doing a
312 * reget of the same directory, just in case two
313 * readdirs on the same remote directory return a
316 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
319 * If we're in restart mode, find the last filename on
320 * this list that already exists. We may have to do a
321 * reget on _that_ file, but shouldn't have to do
322 * anything on the previous files.
324 * If none of them exists, of course, we start at 0.
332 nextoutfname = dir_file_cat(outfname,
333 ournames[i]->filename);
335 nextoutfname = dupstr(ournames[i]->filename);
336 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
347 * Now we're ready to recurse. Starting at ournames[i]
348 * and continuing on to the end of the list, we
349 * construct a new source and target file name, and
350 * call sftp_get_file again.
352 for (; i < nnames; i++) {
353 char *nextfname, *nextoutfname;
356 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
358 nextoutfname = dir_file_cat(outfname,
359 ournames[i]->filename);
361 nextoutfname = dupstr(ournames[i]->filename);
362 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
363 restart = FALSE; /* after first partial file, do full */
367 for (i = 0; i < nnames; i++) {
368 fxp_free_name(ournames[i]);
376 * Done this recursion level. Free everything.
378 for (i = 0; i < nnames; i++) {
379 fxp_free_name(ournames[i]);
387 sftp_register(req = fxp_stat_send(fname));
388 rreq = sftp_find_request(pktin = sftp_recv());
390 if (!fxp_stat_recv(pktin, rreq, &attrs))
393 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ, NULL));
394 rreq = sftp_find_request(pktin = sftp_recv());
396 fh = fxp_open_recv(pktin, rreq);
399 printf("%s: open for read: %s\n", fname, fxp_error());
404 file = open_existing_wfile(outfname, NULL);
406 file = open_new_file(outfname, GET_PERMISSIONS(attrs));
410 printf("local: unable to open %s\n", outfname);
412 sftp_register(req = fxp_close_send(fh));
413 rreq = sftp_find_request(pktin = sftp_recv());
415 fxp_close_recv(pktin, rreq);
422 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
424 printf("reget: cannot restart %s - file too large\n",
426 sftp_register(req = fxp_close_send(fh));
427 rreq = sftp_find_request(pktin = sftp_recv());
429 fxp_close_recv(pktin, rreq);
434 offset = get_file_posn(file);
435 uint64_decimal(offset, decbuf);
436 printf("reget: restarting at file position %s\n", decbuf);
438 offset = uint64_make(0, 0);
441 printf("remote:%s => local:%s\n", fname, outfname);
444 * FIXME: we can use FXP_FSTAT here to get the file size, and
445 * thus put up a progress bar.
448 xfer = xfer_download_init(fh, offset);
449 while (!xfer_done(xfer)) {
454 xfer_download_queue(xfer);
456 ret = xfer_download_gotpkt(xfer, pktin);
460 printf("error while reading: %s\n", fxp_error());
466 while (xfer_download_data(xfer, &vbuf, &len)) {
467 unsigned char *buf = (unsigned char *)vbuf;
471 wlen = write_to_file(file, buf + wpos, len - wpos);
473 printf("error while writing local file\n");
475 xfer_set_error(xfer);
480 if (wpos < len) { /* we had an error */
482 xfer_set_error(xfer);
493 sftp_register(req = fxp_close_send(fh));
494 rreq = sftp_find_request(pktin = sftp_recv());
496 fxp_close_recv(pktin, rreq);
501 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
503 struct fxp_handle *fh;
504 struct fxp_xfer *xfer;
505 struct sftp_packet *pktin;
506 struct sftp_request *req, *rreq;
510 struct fxp_attrs attrs;
514 * In recursive mode, see if we're dealing with a directory.
515 * (If we're not in recursive mode, we need not even check: the
516 * subsequent fopen will return an error message.)
518 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
520 int nnames, namesize;
521 char *name, **ournames;
526 * First, attempt to create the destination directory,
527 * unless it already exists.
529 sftp_register(req = fxp_stat_send(outfname));
530 rreq = sftp_find_request(pktin = sftp_recv());
532 result = fxp_stat_recv(pktin, rreq, &attrs);
534 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
535 !(attrs.permissions & 0040000)) {
536 sftp_register(req = fxp_mkdir_send(outfname));
537 rreq = sftp_find_request(pktin = sftp_recv());
539 result = fxp_mkdir_recv(pktin, rreq);
542 printf("%s: create directory: %s\n",
543 outfname, fxp_error());
549 * Now get the list of filenames in the local directory.
551 nnames = namesize = 0;
554 dh = open_directory(fname);
556 printf("%s: unable to open directory\n", fname);
559 while ((name = read_filename(dh)) != NULL) {
560 if (nnames >= namesize) {
562 ournames = sresize(ournames, namesize, char *);
564 ournames[nnames++] = name;
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.
574 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
577 * If we're in restart mode, find the last filename on this
578 * list that already exists. We may have to do a reput on
579 * _that_ file, but shouldn't have to do anything on the
582 * If none of them exists, of course, we start at 0.
588 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
589 sftp_register(req = fxp_stat_send(nextoutfname));
590 rreq = sftp_find_request(pktin = sftp_recv());
592 result = fxp_stat_recv(pktin, rreq, &attrs);
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.
608 for (; i < nnames; i++) {
609 char *nextfname, *nextoutfname;
613 nextfname = dir_file_cat(fname, ournames[i]);
615 nextfname = dupstr(ournames[i]);
616 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
617 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
618 restart = FALSE; /* after first partial file, do full */
622 for (i = 0; i < nnames; i++) {
631 * Done this recursion level. Free everything.
633 for (i = 0; i < nnames; i++) {
641 file = open_existing_file(fname, NULL, NULL, NULL, &permissions);
643 printf("local: unable to open %s\n", fname);
647 PUT_PERMISSIONS(attrs, permissions);
649 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE, &attrs));
651 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
652 SSH_FXF_CREAT | SSH_FXF_TRUNC,
655 rreq = sftp_find_request(pktin = sftp_recv());
657 fh = fxp_open_recv(pktin, rreq);
661 printf("%s: open for write: %s\n", outfname, fxp_error());
667 struct fxp_attrs attrs;
670 sftp_register(req = fxp_fstat_send(fh));
671 rreq = sftp_find_request(pktin = sftp_recv());
673 ret = fxp_fstat_recv(pktin, rreq, &attrs);
677 printf("read size of %s: %s\n", outfname, fxp_error());
680 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
682 printf("read size of %s: size was not given\n", outfname);
686 uint64_decimal(offset, decbuf);
687 printf("reput: restarting at file position %s\n", decbuf);
689 if (seek_file((WFile *)file, offset, FROM_START) != 0)
690 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
692 offset = uint64_make(0, 0);
695 printf("local:%s => remote:%s\n", fname, outfname);
698 * FIXME: we can use FXP_FSTAT here to get the file size, and
699 * thus put up a progress bar.
702 xfer = xfer_upload_init(fh, offset);
704 while ((!err && !eof) || !xfer_done(xfer)) {
708 while (xfer_upload_ready(xfer) && !err && !eof) {
709 len = read_from_file(file, buffer, sizeof(buffer));
711 printf("error while reading local file\n");
713 } else if (len == 0) {
716 xfer_upload_data(xfer, buffer, len);
720 if (!xfer_done(xfer)) {
722 ret = xfer_upload_gotpkt(xfer, pktin);
723 if (ret <= 0 && !err) {
724 printf("error while writing: %s\n", fxp_error());
732 sftp_register(req = fxp_close_send(fh));
733 rreq = sftp_find_request(pktin = sftp_recv());
735 fxp_close_recv(pktin, rreq);
742 /* ----------------------------------------------------------------------
743 * A remote wildcard matcher, providing a similar interface to the
744 * local one in psftp.h.
747 typedef struct SftpWildcardMatcher {
748 struct fxp_handle *dirh;
749 struct fxp_names *names;
751 char *wildcard, *prefix;
752 } SftpWildcardMatcher;
754 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
756 struct sftp_packet *pktin;
757 struct sftp_request *req, *rreq;
759 char *unwcdir, *tmpdir, *cdir;
761 SftpWildcardMatcher *swcm;
762 struct fxp_handle *dirh;
765 * We don't handle multi-level wildcards; so we expect to find
766 * a fully specified directory part, followed by a wildcard
769 wildcard = stripslashes(name, 0);
771 unwcdir = dupstr(name);
772 len = wildcard - name;
774 if (len > 0 && unwcdir[len-1] == '/')
775 unwcdir[len-1] = '\0';
776 tmpdir = snewn(1 + len, char);
777 check = wc_unescape(tmpdir, unwcdir);
781 printf("Multiple-level wildcards are not supported\n");
786 cdir = canonify(unwcdir);
788 sftp_register(req = fxp_opendir_send(cdir));
789 rreq = sftp_find_request(pktin = sftp_recv());
791 dirh = fxp_opendir_recv(pktin, rreq);
794 swcm = snew(SftpWildcardMatcher);
797 swcm->wildcard = dupstr(wildcard);
798 swcm->prefix = unwcdir;
800 printf("Unable to open %s: %s\n", cdir, fxp_error());
810 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
812 struct fxp_name *name;
813 struct sftp_packet *pktin;
814 struct sftp_request *req, *rreq;
817 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
818 fxp_free_names(swcm->names);
823 sftp_register(req = fxp_readdir_send(swcm->dirh));
824 rreq = sftp_find_request(pktin = sftp_recv());
826 swcm->names = fxp_readdir_recv(pktin, rreq);
829 if (fxp_error_type() != SSH_FX_EOF)
830 printf("%s: reading directory: %s\n", swcm->prefix,
838 assert(swcm->names && swcm->namepos < swcm->names->nnames);
840 name = &swcm->names->names[swcm->namepos++];
842 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
843 continue; /* expected bad filenames */
845 if (!vet_filename(name->filename)) {
846 printf("ignoring potentially dangerous server-"
847 "supplied filename '%s'\n", name->filename);
848 continue; /* unexpected bad filename */
851 if (!wc_match(swcm->wildcard, name->filename))
852 continue; /* doesn't match the wildcard */
855 * We have a working filename. Return it.
857 return dupprintf("%s%s%s", swcm->prefix,
859 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
865 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
867 struct sftp_packet *pktin;
868 struct sftp_request *req, *rreq;
870 sftp_register(req = fxp_close_send(swcm->dirh));
871 rreq = sftp_find_request(pktin = sftp_recv());
873 fxp_close_recv(pktin, rreq);
876 fxp_free_names(swcm->names);
879 sfree(swcm->wildcard);
885 * General function to match a potential wildcard in a filename
886 * argument and iterate over every matching file. Used in several
887 * PSFTP commands (rmdir, rm, chmod, mv).
889 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
891 char *unwcfname, *newname, *cname;
894 unwcfname = snewn(strlen(filename)+1, char);
895 is_wc = !wc_unescape(unwcfname, filename);
898 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
907 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
908 cname = canonify(newname);
910 printf("%s: canonify: %s\n", newname, fxp_error());
914 ret &= func(ctx, cname);
919 /* Politely warn the user that nothing matched. */
920 printf("%s: nothing matched\n", filename);
923 sftp_finish_wildcard_matching(swcm);
925 cname = canonify(unwcfname);
927 printf("%s: canonify: %s\n", filename, fxp_error());
930 ret = func(ctx, cname);
939 * Handy helper function.
941 int is_wildcard(char *name)
943 char *unwcfname = snewn(strlen(name)+1, char);
944 int is_wc = !wc_unescape(unwcfname, name);
949 /* ----------------------------------------------------------------------
950 * Actual sftp commands.
952 struct sftp_command {
954 int nwords, wordssize;
955 int (*obey) (struct sftp_command *); /* returns <0 to quit */
958 int sftp_cmd_null(struct sftp_command *cmd)
960 return 1; /* success */
963 int sftp_cmd_unknown(struct sftp_command *cmd)
965 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
966 return 0; /* failure */
969 int sftp_cmd_quit(struct sftp_command *cmd)
974 int sftp_cmd_close(struct sftp_command *cmd)
981 if (back != NULL && back->connected(backhandle)) {
983 back->special(backhandle, TS_EOF);
985 sftp_recvdata(&ch, 1);
993 * List a directory. If no arguments are given, list pwd; otherwise
994 * list the directory given in words[1].
996 int sftp_cmd_ls(struct sftp_command *cmd)
998 struct fxp_handle *dirh;
999 struct fxp_names *names;
1000 struct fxp_name **ournames;
1001 int nnames, namesize;
1002 char *dir, *cdir, *unwcdir, *wildcard;
1003 struct sftp_packet *pktin;
1004 struct sftp_request *req, *rreq;
1012 if (cmd->nwords < 2)
1015 dir = cmd->words[1];
1017 unwcdir = snewn(1 + strlen(dir), char);
1018 if (wc_unescape(unwcdir, dir)) {
1025 wildcard = stripslashes(dir, 0);
1026 unwcdir = dupstr(dir);
1027 len = wildcard - dir;
1028 unwcdir[len] = '\0';
1029 if (len > 0 && unwcdir[len-1] == '/')
1030 unwcdir[len-1] = '\0';
1031 tmpdir = snewn(1 + len, char);
1032 check = wc_unescape(tmpdir, unwcdir);
1035 printf("Multiple-level wildcards are not supported\n");
1042 cdir = canonify(dir);
1044 printf("%s: canonify: %s\n", dir, fxp_error());
1049 printf("Listing directory %s\n", cdir);
1051 sftp_register(req = fxp_opendir_send(cdir));
1052 rreq = sftp_find_request(pktin = sftp_recv());
1053 assert(rreq == req);
1054 dirh = fxp_opendir_recv(pktin, rreq);
1057 printf("Unable to open %s: %s\n", dir, fxp_error());
1059 nnames = namesize = 0;
1064 sftp_register(req = fxp_readdir_send(dirh));
1065 rreq = sftp_find_request(pktin = sftp_recv());
1066 assert(rreq == req);
1067 names = fxp_readdir_recv(pktin, rreq);
1069 if (names == NULL) {
1070 if (fxp_error_type() == SSH_FX_EOF)
1072 printf("Reading directory %s: %s\n", dir, fxp_error());
1075 if (names->nnames == 0) {
1076 fxp_free_names(names);
1080 if (nnames + names->nnames >= namesize) {
1081 namesize += names->nnames + 128;
1082 ournames = sresize(ournames, namesize, struct fxp_name *);
1085 for (i = 0; i < names->nnames; i++)
1086 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1087 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1089 fxp_free_names(names);
1091 sftp_register(req = fxp_close_send(dirh));
1092 rreq = sftp_find_request(pktin = sftp_recv());
1093 assert(rreq == req);
1094 fxp_close_recv(pktin, rreq);
1097 * Now we have our filenames. Sort them by actual file
1098 * name, and then output the longname parts.
1100 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1105 for (i = 0; i < nnames; i++) {
1106 printf("%s\n", ournames[i]->longname);
1107 fxp_free_name(ournames[i]);
1119 * Change directories. We do this by canonifying the new name, then
1120 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1122 int sftp_cmd_cd(struct sftp_command *cmd)
1124 struct fxp_handle *dirh;
1125 struct sftp_packet *pktin;
1126 struct sftp_request *req, *rreq;
1134 if (cmd->nwords < 2)
1135 dir = dupstr(homedir);
1137 dir = canonify(cmd->words[1]);
1140 printf("%s: canonify: %s\n", dir, fxp_error());
1144 sftp_register(req = fxp_opendir_send(dir));
1145 rreq = sftp_find_request(pktin = sftp_recv());
1146 assert(rreq == req);
1147 dirh = fxp_opendir_recv(pktin, rreq);
1150 printf("Directory %s: %s\n", dir, fxp_error());
1155 sftp_register(req = fxp_close_send(dirh));
1156 rreq = sftp_find_request(pktin = sftp_recv());
1157 assert(rreq == req);
1158 fxp_close_recv(pktin, rreq);
1162 printf("Remote directory is now %s\n", pwd);
1168 * Print current directory. Easy as pie.
1170 int sftp_cmd_pwd(struct sftp_command *cmd)
1177 printf("Remote directory is %s\n", pwd);
1182 * Get a file and save it at the local end. We have three very
1183 * similar commands here. The basic one is `get'; `reget' differs
1184 * in that it checks for the existence of the destination file and
1185 * starts from where a previous aborted transfer left off; `mget'
1186 * differs in that it interprets all its arguments as files to
1187 * transfer (never as a different local name for a remote file) and
1188 * can handle wildcards.
1190 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1192 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1194 int recurse = FALSE;
1202 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1203 if (!strcmp(cmd->words[i], "--")) {
1204 /* finish processing options */
1207 } else if (!strcmp(cmd->words[i], "-r")) {
1210 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1216 if (i >= cmd->nwords) {
1217 printf("%s: expects a filename\n", cmd->words[0]);
1223 SftpWildcardMatcher *swcm;
1225 origfname = cmd->words[i++];
1226 unwcfname = snewn(strlen(origfname)+1, char);
1228 if (multiple && !wc_unescape(unwcfname, origfname)) {
1229 swcm = sftp_begin_wildcard_matching(origfname);
1234 origwfname = sftp_wildcard_get_filename(swcm);
1236 /* Politely warn the user that nothing matched. */
1237 printf("%s: nothing matched\n", origfname);
1238 sftp_finish_wildcard_matching(swcm);
1243 origwfname = origfname;
1247 while (origwfname) {
1248 fname = canonify(origwfname);
1251 printf("%s: canonify: %s\n", origwfname, fxp_error());
1256 if (!multiple && i < cmd->nwords)
1257 outfname = cmd->words[i++];
1259 outfname = stripslashes(origwfname, 0);
1261 ret = sftp_get_file(fname, outfname, recurse, restart);
1267 origwfname = sftp_wildcard_get_filename(swcm);
1274 sftp_finish_wildcard_matching(swcm);
1278 } while (multiple && i < cmd->nwords);
1282 int sftp_cmd_get(struct sftp_command *cmd)
1284 return sftp_general_get(cmd, 0, 0);
1286 int sftp_cmd_mget(struct sftp_command *cmd)
1288 return sftp_general_get(cmd, 0, 1);
1290 int sftp_cmd_reget(struct sftp_command *cmd)
1292 return sftp_general_get(cmd, 1, 0);
1296 * Send a file and store it at the remote end. We have three very
1297 * similar commands here. The basic one is `put'; `reput' differs
1298 * in that it checks for the existence of the destination file and
1299 * starts from where a previous aborted transfer left off; `mput'
1300 * differs in that it interprets all its arguments as files to
1301 * transfer (never as a different remote name for a local file) and
1302 * can handle wildcards.
1304 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1306 char *fname, *wfname, *origoutfname, *outfname;
1308 int recurse = FALSE;
1316 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1317 if (!strcmp(cmd->words[i], "--")) {
1318 /* finish processing options */
1321 } else if (!strcmp(cmd->words[i], "-r")) {
1324 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1330 if (i >= cmd->nwords) {
1331 printf("%s: expects a filename\n", cmd->words[0]);
1337 WildcardMatcher *wcm;
1338 fname = cmd->words[i++];
1340 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1341 wcm = begin_wildcard_matching(fname);
1342 wfname = wildcard_get_filename(wcm);
1344 /* Politely warn the user that nothing matched. */
1345 printf("%s: nothing matched\n", fname);
1346 finish_wildcard_matching(wcm);
1355 if (!multiple && i < cmd->nwords)
1356 origoutfname = cmd->words[i++];
1358 origoutfname = stripslashes(wfname, 1);
1360 outfname = canonify(origoutfname);
1362 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1365 finish_wildcard_matching(wcm);
1369 ret = sftp_put_file(wfname, outfname, recurse, restart);
1374 wfname = wildcard_get_filename(wcm);
1381 finish_wildcard_matching(wcm);
1386 } while (multiple && i < cmd->nwords);
1390 int sftp_cmd_put(struct sftp_command *cmd)
1392 return sftp_general_put(cmd, 0, 0);
1394 int sftp_cmd_mput(struct sftp_command *cmd)
1396 return sftp_general_put(cmd, 0, 1);
1398 int sftp_cmd_reput(struct sftp_command *cmd)
1400 return sftp_general_put(cmd, 1, 0);
1403 int sftp_cmd_mkdir(struct sftp_command *cmd)
1406 struct sftp_packet *pktin;
1407 struct sftp_request *req, *rreq;
1416 if (cmd->nwords < 2) {
1417 printf("mkdir: expects a directory\n");
1422 for (i = 1; i < cmd->nwords; i++) {
1423 dir = canonify(cmd->words[i]);
1425 printf("%s: canonify: %s\n", dir, fxp_error());
1429 sftp_register(req = fxp_mkdir_send(dir));
1430 rreq = sftp_find_request(pktin = sftp_recv());
1431 assert(rreq == req);
1432 result = fxp_mkdir_recv(pktin, rreq);
1435 printf("mkdir %s: %s\n", dir, fxp_error());
1438 printf("mkdir %s: OK\n", dir);
1446 static int sftp_action_rmdir(void *vctx, char *dir)
1448 struct sftp_packet *pktin;
1449 struct sftp_request *req, *rreq;
1452 sftp_register(req = fxp_rmdir_send(dir));
1453 rreq = sftp_find_request(pktin = sftp_recv());
1454 assert(rreq == req);
1455 result = fxp_rmdir_recv(pktin, rreq);
1458 printf("rmdir %s: %s\n", dir, fxp_error());
1462 printf("rmdir %s: OK\n", dir);
1467 int sftp_cmd_rmdir(struct sftp_command *cmd)
1476 if (cmd->nwords < 2) {
1477 printf("rmdir: expects a directory\n");
1482 for (i = 1; i < cmd->nwords; i++)
1483 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1488 static int sftp_action_rm(void *vctx, char *fname)
1490 struct sftp_packet *pktin;
1491 struct sftp_request *req, *rreq;
1494 sftp_register(req = fxp_remove_send(fname));
1495 rreq = sftp_find_request(pktin = sftp_recv());
1496 assert(rreq == req);
1497 result = fxp_remove_recv(pktin, rreq);
1500 printf("rm %s: %s\n", fname, fxp_error());
1504 printf("rm %s: OK\n", fname);
1509 int sftp_cmd_rm(struct sftp_command *cmd)
1518 if (cmd->nwords < 2) {
1519 printf("rm: expects a filename\n");
1524 for (i = 1; i < cmd->nwords; i++)
1525 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1530 static int check_is_dir(char *dstfname)
1532 struct sftp_packet *pktin;
1533 struct sftp_request *req, *rreq;
1534 struct fxp_attrs attrs;
1537 sftp_register(req = fxp_stat_send(dstfname));
1538 rreq = sftp_find_request(pktin = sftp_recv());
1539 assert(rreq == req);
1540 result = fxp_stat_recv(pktin, rreq, &attrs);
1543 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1544 (attrs.permissions & 0040000))
1550 struct sftp_context_mv {
1555 static int sftp_action_mv(void *vctx, char *srcfname)
1557 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1558 struct sftp_packet *pktin;
1559 struct sftp_request *req, *rreq;
1561 char *finalfname, *newcanon = NULL;
1564 if (ctx->dest_is_dir) {
1568 p = srcfname + strlen(srcfname);
1569 while (p > srcfname && p[-1] != '/') p--;
1570 newname = dupcat(ctx->dstfname, "/", p, NULL);
1571 newcanon = canonify(newname);
1573 printf("%s: canonify: %s\n", newname, fxp_error());
1579 finalfname = newcanon;
1581 finalfname = ctx->dstfname;
1584 sftp_register(req = fxp_rename_send(srcfname, finalfname));
1585 rreq = sftp_find_request(pktin = sftp_recv());
1586 assert(rreq == req);
1587 result = fxp_rename_recv(pktin, rreq);
1589 error = result ? NULL : fxp_error();
1592 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1595 printf("%s -> %s\n", srcfname, finalfname);
1603 int sftp_cmd_mv(struct sftp_command *cmd)
1605 struct sftp_context_mv actx, *ctx = &actx;
1613 if (cmd->nwords < 3) {
1614 printf("mv: expects two filenames\n");
1618 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1619 if (!ctx->dstfname) {
1620 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1625 * If there's more than one source argument, or one source
1626 * argument which is a wildcard, we _require_ that the
1627 * destination is a directory.
1629 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1630 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1631 printf("mv: multiple or wildcard arguments require the destination"
1632 " to be a directory\n");
1633 sfree(ctx->dstfname);
1638 * Now iterate over the source arguments.
1641 for (i = 1; i < cmd->nwords-1; i++)
1642 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1644 sfree(ctx->dstfname);
1648 struct sftp_context_chmod {
1649 unsigned attrs_clr, attrs_xor;
1652 static int sftp_action_chmod(void *vctx, char *fname)
1654 struct fxp_attrs attrs;
1655 struct sftp_packet *pktin;
1656 struct sftp_request *req, *rreq;
1658 unsigned oldperms, newperms;
1659 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1661 sftp_register(req = fxp_stat_send(fname));
1662 rreq = sftp_find_request(pktin = sftp_recv());
1663 assert(rreq == req);
1664 result = fxp_stat_recv(pktin, rreq, &attrs);
1666 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1667 printf("get attrs for %s: %s\n", fname,
1668 result ? "file permissions not provided" : fxp_error());
1672 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1673 oldperms = attrs.permissions & 07777;
1674 attrs.permissions &= ~ctx->attrs_clr;
1675 attrs.permissions ^= ctx->attrs_xor;
1676 newperms = attrs.permissions & 07777;
1678 if (oldperms == newperms)
1679 return 1; /* no need to do anything! */
1681 sftp_register(req = fxp_setstat_send(fname, attrs));
1682 rreq = sftp_find_request(pktin = sftp_recv());
1683 assert(rreq == req);
1684 result = fxp_setstat_recv(pktin, rreq);
1687 printf("set attrs for %s: %s\n", fname, fxp_error());
1691 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1696 int sftp_cmd_chmod(struct sftp_command *cmd)
1700 struct sftp_context_chmod actx, *ctx = &actx;
1707 if (cmd->nwords < 3) {
1708 printf("chmod: expects a mode specifier and a filename\n");
1713 * Attempt to parse the mode specifier in cmd->words[1]. We
1714 * don't support the full horror of Unix chmod; instead we
1715 * support a much simpler syntax in which the user can either
1716 * specify an octal number, or a comma-separated sequence of
1717 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1718 * _only_ be omitted if the only attribute mentioned is t,
1719 * since all others require a user/group/other specification.
1720 * Additionally, the s attribute may not be specified for any
1721 * [ugoa] specifications other than exactly u or exactly g.
1723 ctx->attrs_clr = ctx->attrs_xor = 0;
1724 mode = cmd->words[1];
1725 if (mode[0] >= '0' && mode[0] <= '9') {
1726 if (mode[strspn(mode, "01234567")]) {
1727 printf("chmod: numeric file modes should"
1728 " contain digits 0-7 only\n");
1731 ctx->attrs_clr = 07777;
1732 sscanf(mode, "%o", &ctx->attrs_xor);
1733 ctx->attrs_xor &= ctx->attrs_clr;
1736 char *modebegin = mode;
1737 unsigned subset, perms;
1741 while (*mode && *mode != ',' &&
1742 *mode != '+' && *mode != '-' && *mode != '=') {
1744 case 'u': subset |= 04700; break; /* setuid, user perms */
1745 case 'g': subset |= 02070; break; /* setgid, group perms */
1746 case 'o': subset |= 00007; break; /* just other perms */
1747 case 'a': subset |= 06777; break; /* all of the above */
1749 printf("chmod: file mode '%.*s' contains unrecognised"
1750 " user/group/other specifier '%c'\n",
1751 (int)strcspn(modebegin, ","), modebegin, *mode);
1756 if (!*mode || *mode == ',') {
1757 printf("chmod: file mode '%.*s' is incomplete\n",
1758 (int)strcspn(modebegin, ","), modebegin);
1762 if (!*mode || *mode == ',') {
1763 printf("chmod: file mode '%.*s' is incomplete\n",
1764 (int)strcspn(modebegin, ","), modebegin);
1768 while (*mode && *mode != ',') {
1770 case 'r': perms |= 00444; break;
1771 case 'w': perms |= 00222; break;
1772 case 'x': perms |= 00111; break;
1773 case 't': perms |= 01000; subset |= 01000; break;
1775 if ((subset & 06777) != 04700 &&
1776 (subset & 06777) != 02070) {
1777 printf("chmod: file mode '%.*s': set[ug]id bit should"
1778 " be used with exactly one of u or g only\n",
1779 (int)strcspn(modebegin, ","), modebegin);
1785 printf("chmod: file mode '%.*s' contains unrecognised"
1786 " permission specifier '%c'\n",
1787 (int)strcspn(modebegin, ","), modebegin, *mode);
1792 if (!(subset & 06777) && (perms &~ subset)) {
1793 printf("chmod: file mode '%.*s' contains no user/group/other"
1794 " specifier and permissions other than 't' \n",
1795 (int)strcspn(modebegin, ","), modebegin);
1801 ctx->attrs_clr |= perms;
1802 ctx->attrs_xor |= perms;
1805 ctx->attrs_clr |= perms;
1806 ctx->attrs_xor &= ~perms;
1809 ctx->attrs_clr |= subset;
1810 ctx->attrs_xor |= perms;
1813 if (*mode) mode++; /* eat comma */
1818 for (i = 2; i < cmd->nwords; i++)
1819 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1824 static int sftp_cmd_open(struct sftp_command *cmd)
1829 printf("psftp: already connected\n");
1833 if (cmd->nwords < 2) {
1834 printf("open: expects a host name\n");
1838 if (cmd->nwords > 2) {
1839 portnumber = atoi(cmd->words[2]);
1840 if (portnumber == 0) {
1841 printf("open: invalid port number\n");
1847 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1848 back = NULL; /* connection is already closed */
1849 return -1; /* this is fatal */
1855 static int sftp_cmd_lcd(struct sftp_command *cmd)
1857 char *currdir, *errmsg;
1859 if (cmd->nwords < 2) {
1860 printf("lcd: expects a local directory name\n");
1864 errmsg = psftp_lcd(cmd->words[1]);
1866 printf("lcd: unable to change directory: %s\n", errmsg);
1871 currdir = psftp_getcwd();
1872 printf("New local directory is %s\n", currdir);
1878 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1882 currdir = psftp_getcwd();
1883 printf("Current local directory is %s\n", currdir);
1889 static int sftp_cmd_pling(struct sftp_command *cmd)
1893 exitcode = system(cmd->words[1]);
1894 return (exitcode == 0);
1897 static int sftp_cmd_help(struct sftp_command *cmd);
1899 static struct sftp_cmd_lookup {
1902 * For help purposes, there are two kinds of command:
1904 * - primary commands, in which `longhelp' is non-NULL. In
1905 * this case `shorthelp' is descriptive text, and `longhelp'
1906 * is longer descriptive text intended to be printed after
1909 * - alias commands, in which `longhelp' is NULL. In this case
1910 * `shorthelp' is the name of a primary command, which
1911 * contains the help that should double up for this command.
1913 int listed; /* do we list this in primary help? */
1916 int (*obey) (struct sftp_command *);
1919 * List of sftp commands. This is binary-searched so it MUST be
1923 "!", TRUE, "run a local command",
1925 /* FIXME: this example is crap for non-Windows. */
1926 " Runs a local command. For example, \"!del myfile\".\n",
1930 "bye", TRUE, "finish your SFTP session",
1932 " Terminates your SFTP session and quits the PSFTP program.\n",
1936 "cd", TRUE, "change your remote working directory",
1937 " [ <new working directory> ]\n"
1938 " Change the remote working directory for your SFTP session.\n"
1939 " If a new working directory is not supplied, you will be\n"
1940 " returned to your home directory.\n",
1944 "chmod", TRUE, "change file permissions and modes",
1945 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1946 " Change the file permissions on one or more remote files or\n"
1948 " <modes> can be any octal Unix permission specifier.\n"
1949 " Alternatively, <modes> can include the following modifiers:\n"
1950 " u+r make file readable by owning user\n"
1951 " u+w make file writable by owning user\n"
1952 " u+x make file executable by owning user\n"
1953 " u-r make file not readable by owning user\n"
1954 " [also u-w, u-x]\n"
1955 " g+r make file readable by members of owning group\n"
1956 " [also g+w, g+x, g-r, g-w, g-x]\n"
1957 " o+r make file readable by all other users\n"
1958 " [also o+w, o+x, o-r, o-w, o-x]\n"
1959 " a+r make file readable by absolutely everybody\n"
1960 " [also a+w, a+x, a-r, a-w, a-x]\n"
1961 " u+s enable the Unix set-user-ID bit\n"
1962 " u-s disable the Unix set-user-ID bit\n"
1963 " g+s enable the Unix set-group-ID bit\n"
1964 " g-s disable the Unix set-group-ID bit\n"
1965 " +t enable the Unix \"sticky bit\"\n"
1966 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1967 " more than one user for the same modifier (\"ug+w\"). You can\n"
1968 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1972 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1974 " Terminates your SFTP session, but does not quit the PSFTP\n"
1975 " program. You can then use \"open\" to start another SFTP\n"
1976 " session, to the same server or to a different one.\n",
1980 "del", TRUE, "delete files on the remote server",
1981 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1982 " Delete a file or files from the server.\n",
1986 "delete", FALSE, "del", NULL, sftp_cmd_rm
1989 "dir", TRUE, "list remote files",
1990 " [ <directory-name> ]/[ <wildcard> ]\n"
1991 " List the contents of a specified directory on the server.\n"
1992 " If <directory-name> is not given, the current working directory\n"
1994 " If <wildcard> is given, it is treated as a set of files to\n"
1995 " list; otherwise, all files are listed.\n",
1999 "exit", TRUE, "bye", NULL, sftp_cmd_quit
2002 "get", TRUE, "download a file from the server to your local machine",
2003 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2004 " Downloads a file on the server and stores it locally under\n"
2005 " the same name, or under a different one if you supply the\n"
2006 " argument <local-filename>.\n"
2007 " If -r specified, recursively fetch a directory.\n",
2011 "help", TRUE, "give help",
2012 " [ <command> [ <command> ... ] ]\n"
2013 " Give general help if no commands are specified.\n"
2014 " If one or more commands are specified, give specific help on\n"
2015 " those particular commands.\n",
2019 "lcd", TRUE, "change local working directory",
2020 " <local-directory-name>\n"
2021 " Change the local working directory of the PSFTP program (the\n"
2022 " default location where the \"get\" command will save files).\n",
2026 "lpwd", TRUE, "print local working directory",
2028 " Print the local working directory of the PSFTP program (the\n"
2029 " default location where the \"get\" command will save files).\n",
2033 "ls", TRUE, "dir", NULL,
2037 "mget", TRUE, "download multiple files at once",
2038 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2039 " Downloads many files from the server, storing each one under\n"
2040 " the same name it has on the server side. You can use wildcards\n"
2041 " such as \"*.c\" to specify lots of files at once.\n"
2042 " If -r specified, recursively fetch files and directories.\n",
2046 "mkdir", TRUE, "create directories on the remote server",
2047 " <directory-name> [ <directory-name>... ]\n"
2048 " Creates directories with the given names on the server.\n",
2052 "mput", TRUE, "upload multiple files at once",
2053 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2054 " Uploads many files to the server, storing each one under the\n"
2055 " same name it has on the client side. You can use wildcards\n"
2056 " such as \"*.c\" to specify lots of files at once.\n"
2057 " If -r specified, recursively store files and directories.\n",
2061 "mv", TRUE, "move or rename file(s) on the remote server",
2062 " <source> [ <source>... ] <destination>\n"
2063 " Moves or renames <source>(s) on the server to <destination>,\n"
2064 " also on the server.\n"
2065 " If <destination> specifies an existing directory, then <source>\n"
2066 " may be a wildcard, and multiple <source>s may be given; all\n"
2067 " source files are moved into <destination>.\n"
2068 " Otherwise, <source> must specify a single file, which is moved\n"
2069 " or renamed so that it is accessible under the name <destination>.\n",
2073 "open", TRUE, "connect to a host",
2074 " [<user>@]<hostname> [<port>]\n"
2075 " Establishes an SFTP connection to a given host. Only usable\n"
2076 " when you are not already connected to a server.\n",
2080 "put", TRUE, "upload a file from your local machine to the server",
2081 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2082 " Uploads a file to the server and stores it there under\n"
2083 " the same name, or under a different one if you supply the\n"
2084 " argument <remote-filename>.\n"
2085 " If -r specified, recursively store a directory.\n",
2089 "pwd", TRUE, "print your remote working directory",
2091 " Print the current remote working directory for your SFTP session.\n",
2095 "quit", TRUE, "bye", NULL,
2099 "reget", TRUE, "continue downloading files",
2100 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2101 " Works exactly like the \"get\" command, but the local file\n"
2102 " must already exist. The download will begin at the end of the\n"
2103 " file. This is for resuming a download that was interrupted.\n"
2104 " If -r specified, resume interrupted \"get -r\".\n",
2108 "ren", TRUE, "mv", NULL,
2112 "rename", FALSE, "mv", NULL,
2116 "reput", TRUE, "continue uploading files",
2117 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2118 " Works exactly like the \"put\" command, but the remote file\n"
2119 " must already exist. The upload will begin at the end of the\n"
2120 " file. This is for resuming an upload that was interrupted.\n"
2121 " If -r specified, resume interrupted \"put -r\".\n",
2125 "rm", TRUE, "del", NULL,
2129 "rmdir", TRUE, "remove directories on the remote server",
2130 " <directory-name> [ <directory-name>... ]\n"
2131 " Removes the directory with the given name on the server.\n"
2132 " The directory will not be removed unless it is empty.\n"
2133 " Wildcards may be used to specify multiple directories.\n",
2138 const struct sftp_cmd_lookup *lookup_command(char *name)
2143 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2146 cmp = strcmp(name, sftp_lookup[k].name);
2152 return &sftp_lookup[k];
2158 static int sftp_cmd_help(struct sftp_command *cmd)
2161 if (cmd->nwords == 1) {
2163 * Give short help on each command.
2167 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2169 if (!sftp_lookup[i].listed)
2171 len = strlen(sftp_lookup[i].name);
2175 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2176 const struct sftp_cmd_lookup *lookup;
2177 if (!sftp_lookup[i].listed)
2179 lookup = &sftp_lookup[i];
2180 printf("%-*s", maxlen+2, lookup->name);
2181 if (lookup->longhelp == NULL)
2182 lookup = lookup_command(lookup->shorthelp);
2183 printf("%s\n", lookup->shorthelp);
2187 * Give long help on specific commands.
2189 for (i = 1; i < cmd->nwords; i++) {
2190 const struct sftp_cmd_lookup *lookup;
2191 lookup = lookup_command(cmd->words[i]);
2193 printf("help: %s: command not found\n", cmd->words[i]);
2195 printf("%s", lookup->name);
2196 if (lookup->longhelp == NULL)
2197 lookup = lookup_command(lookup->shorthelp);
2198 printf("%s", lookup->longhelp);
2205 /* ----------------------------------------------------------------------
2206 * Command line reading and parsing.
2208 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2211 struct sftp_command *cmd;
2215 cmd = snew(struct sftp_command);
2225 line = fgetline(fp);
2227 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2230 if (!line || !*line) {
2231 cmd->obey = sftp_cmd_quit;
2232 if ((mode == 0) || (modeflags & 1))
2234 return cmd; /* eof */
2237 line[strcspn(line, "\r\n")] = '\0';
2239 if (modeflags & 1) {
2240 printf("%s\n", line);
2244 while (*p && (*p == ' ' || *p == '\t'))
2249 * Special case: the ! command. This is always parsed as
2250 * exactly two words: one containing the !, and the second
2251 * containing everything else on the line.
2253 cmd->nwords = cmd->wordssize = 2;
2254 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2255 cmd->words[0] = dupstr("!");
2256 cmd->words[1] = dupstr(p+1);
2257 } else if (*p == '#') {
2259 * Special case: comment. Entire line is ignored.
2261 cmd->nwords = cmd->wordssize = 0;
2265 * Parse the command line into words. The syntax is:
2266 * - double quotes are removed, but cause spaces within to be
2267 * treated as non-separating.
2268 * - a double-doublequote pair is a literal double quote, inside
2269 * _or_ outside quotes. Like this:
2271 * firstword "second word" "this has ""quotes"" in" and""this""
2277 * >this has "quotes" in<
2281 /* skip whitespace */
2282 while (*p && (*p == ' ' || *p == '\t'))
2284 /* mark start of word */
2285 q = r = p; /* q sits at start, r writes word */
2288 if (!quoting && (*p == ' ' || *p == '\t'))
2289 break; /* reached end of word */
2290 else if (*p == '"' && p[1] == '"')
2291 p += 2, *r++ = '"'; /* a literal quote */
2293 p++, quoting = !quoting;
2298 p++; /* skip over the whitespace */
2300 if (cmd->nwords >= cmd->wordssize) {
2301 cmd->wordssize = cmd->nwords + 16;
2302 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2304 cmd->words[cmd->nwords++] = dupstr(q);
2311 * Now parse the first word and assign a function.
2314 if (cmd->nwords == 0)
2315 cmd->obey = sftp_cmd_null;
2317 const struct sftp_cmd_lookup *lookup;
2318 lookup = lookup_command(cmd->words[0]);
2320 cmd->obey = sftp_cmd_unknown;
2322 cmd->obey = lookup->obey;
2328 static int do_sftp_init(void)
2330 struct sftp_packet *pktin;
2331 struct sftp_request *req, *rreq;
2334 * Do protocol initialisation.
2338 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2339 return 1; /* failure */
2343 * Find out where our home directory is.
2345 sftp_register(req = fxp_realpath_send("."));
2346 rreq = sftp_find_request(pktin = sftp_recv());
2347 assert(rreq == req);
2348 homedir = fxp_realpath_recv(pktin, rreq);
2352 "Warning: failed to resolve home directory: %s\n",
2354 homedir = dupstr(".");
2356 printf("Remote working directory is %s\n", homedir);
2358 pwd = dupstr(homedir);
2362 void do_sftp_cleanup()
2366 back->special(backhandle, TS_EOF);
2368 sftp_recvdata(&ch, 1);
2369 back->free(backhandle);
2370 sftp_cleanup_request();
2384 void do_sftp(int mode, int modeflags, char *batchfile)
2394 /* ------------------------------------------------------------------
2395 * Now we're ready to do Real Stuff.
2398 struct sftp_command *cmd;
2399 cmd = sftp_getcmd(NULL, 0, 0);
2402 ret = cmd->obey(cmd);
2405 for(i = 0; i < cmd->nwords; i++)
2406 sfree(cmd->words[i]);
2414 fp = fopen(batchfile, "r");
2416 printf("Fatal: unable to open %s\n", batchfile);
2420 struct sftp_command *cmd;
2421 cmd = sftp_getcmd(fp, mode, modeflags);
2424 ret = cmd->obey(cmd);
2428 if (!(modeflags & 2))
2437 /* ----------------------------------------------------------------------
2438 * Dirty bits: integration with PuTTY.
2441 static int verbose = 0;
2444 * Print an error message and perform a fatal exit.
2446 void fatalbox(char *fmt, ...)
2451 str = dupvprintf(fmt, ap);
2452 str2 = dupcat("Fatal: ", str, "\n", NULL);
2455 fputs(str2, stderr);
2460 void modalfatalbox(char *fmt, ...)
2465 str = dupvprintf(fmt, ap);
2466 str2 = dupcat("Fatal: ", str, "\n", NULL);
2469 fputs(str2, stderr);
2474 void connection_fatal(void *frontend, char *fmt, ...)
2479 str = dupvprintf(fmt, ap);
2480 str2 = dupcat("Fatal: ", str, "\n", NULL);
2483 fputs(str2, stderr);
2489 void ldisc_send(void *handle, char *buf, int len, int interactive)
2492 * This is only here because of the calls to ldisc_send(NULL,
2493 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2494 * ldisc as an ldisc. So if we get called with any real data, I
2495 * want to know about it.
2501 * In psftp, all agent requests should be synchronous, so this is a
2502 * never-called stub.
2504 void agent_schedule_callback(void (*callback)(void *, void *, int),
2505 void *callback_ctx, void *data, int len)
2507 assert(!"We shouldn't be here");
2511 * Receive a block of data from the SSH link. Block until all data
2514 * To do this, we repeatedly call the SSH protocol module, with our
2515 * own trap in from_backend() to catch the data that comes back. We
2516 * do this until we have enough data.
2519 static unsigned char *outptr; /* where to put the data */
2520 static unsigned outlen; /* how much data required */
2521 static unsigned char *pending = NULL; /* any spare data */
2522 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2523 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2525 unsigned char *p = (unsigned char *) data;
2526 unsigned len = (unsigned) datalen;
2529 * stderr data is just spouted to local stderr and otherwise
2534 if (fwrite(data, 1, len, stderr) < len)
2540 * If this is before the real session begins, just return.
2545 if ((outlen > 0) && (len > 0)) {
2546 unsigned used = outlen;
2549 memcpy(outptr, p, used);
2557 if (pendsize < pendlen + len) {
2558 pendsize = pendlen + len + 4096;
2559 pending = sresize(pending, pendsize, unsigned char);
2561 memcpy(pending + pendlen, p, len);
2567 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2570 * No "untrusted" output should get here (the way the code is
2571 * currently, it's all diverted by FLAG_STDERR).
2573 assert(!"Unexpected call to from_backend_untrusted()");
2574 return 0; /* not reached */
2576 int from_backend_eof(void *frontend)
2579 * We expect to be the party deciding when to close the
2580 * connection, so if we see EOF before we sent it ourselves, we
2584 connection_fatal(frontend,
2585 "Received unexpected end-of-file from SFTP server");
2589 int sftp_recvdata(char *buf, int len)
2591 outptr = (unsigned char *) buf;
2595 * See if the pending-input block contains some of what we
2599 unsigned pendused = pendlen;
2600 if (pendused > outlen)
2602 memcpy(outptr, pending, pendused);
2603 memmove(pending, pending + pendused, pendlen - pendused);
2606 pendlen -= pendused;
2616 while (outlen > 0) {
2617 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2618 return 0; /* doom */
2623 int sftp_senddata(char *buf, int len)
2625 back->send(backhandle, buf, len);
2630 * Short description of parameters.
2632 static void usage(void)
2634 printf("PuTTY Secure File Transfer (SFTP) client\n");
2635 printf("%s\n", ver);
2636 printf("Usage: psftp [options] [user@]host\n");
2637 printf("Options:\n");
2638 printf(" -V print version information and exit\n");
2639 printf(" -pgpfp print PGP key fingerprints and exit\n");
2640 printf(" -b file use specified batchfile\n");
2641 printf(" -bc output batchfile commands\n");
2642 printf(" -be don't stop batchfile processing if errors\n");
2643 printf(" -v show verbose messages\n");
2644 printf(" -load sessname Load settings from saved session\n");
2645 printf(" -l user connect with specified username\n");
2646 printf(" -P port connect to specified port\n");
2647 printf(" -pw passw login with specified password\n");
2648 printf(" -1 -2 force use of particular SSH protocol version\n");
2649 printf(" -4 -6 force use of IPv4 or IPv6\n");
2650 printf(" -C enable compression\n");
2651 printf(" -i key private key file for authentication\n");
2652 printf(" -noagent disable use of Pageant\n");
2653 printf(" -agent enable use of Pageant\n");
2654 printf(" -batch disable all interactive prompts\n");
2658 static void version(void)
2660 printf("psftp: %s\n", ver);
2665 * Connect to a host.
2667 static int psftp_connect(char *userhost, char *user, int portnumber)
2669 char *host, *realhost;
2673 /* Separate host and username */
2675 host = strrchr(host, '@');
2681 printf("psftp: multiple usernames specified; using \"%s\"\n",
2688 * If we haven't loaded session details already (e.g., from -load),
2689 * try looking for a session called "host".
2691 if (!loaded_session) {
2692 /* Try to load settings for `host' into a temporary config */
2693 Conf *conf2 = conf_new();
2694 conf_set_str(conf2, CONF_host, "");
2695 do_defaults(host, conf2);
2696 if (conf_get_str(conf2, CONF_host)[0] != '\0') {
2697 /* Settings present and include hostname */
2698 /* Re-load data into the real config. */
2699 do_defaults(host, conf);
2701 /* Session doesn't exist or mention a hostname. */
2702 /* Use `host' as a bare hostname. */
2703 conf_set_str(conf, CONF_host, host);
2706 /* Patch in hostname `host' to session details. */
2707 conf_set_str(conf, CONF_host, host);
2711 * Force use of SSH. (If they got the protocol wrong we assume the
2712 * port is useless too.)
2714 if (conf_get_int(conf, CONF_protocol) != PROT_SSH) {
2715 conf_set_int(conf, CONF_protocol, PROT_SSH);
2716 conf_set_int(conf, CONF_port, 22);
2720 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2721 * then change it to SSH-2, on the grounds that that's more likely to
2722 * work for SFTP. (Can be overridden with `-1' option.)
2723 * But if it says `2 only' or `2', respect which.
2725 if ((conf_get_int(conf, CONF_sshprot) & ~1) != 2) /* is it 2 or 3? */
2726 conf_set_int(conf, CONF_sshprot, 2);
2729 * Enact command-line overrides.
2731 cmdline_run_saved(conf);
2734 * Muck about with the hostname in various ways.
2737 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
2738 char *host = hostbuf;
2742 * Trim leading whitespace.
2744 host += strspn(host, " \t");
2747 * See if host is of the form user@host, and separate out
2748 * the username if so.
2750 if (host[0] != '\0') {
2751 char *atsign = strrchr(host, '@');
2754 conf_set_str(conf, CONF_username, host);
2760 * Remove any remaining whitespace.
2765 if (*q != ' ' && *q != '\t')
2771 conf_set_str(conf, CONF_host, hostbuf);
2776 if (user != NULL && user[0] != '\0') {
2777 conf_set_str(conf, CONF_username, user);
2781 conf_set_int(conf, CONF_port, portnumber);
2784 * Disable scary things which shouldn't be enabled for simple
2785 * things like SCP and SFTP: agent forwarding, port forwarding,
2788 conf_set_int(conf, CONF_x11_forward, 0);
2789 conf_set_int(conf, CONF_agentfwd, 0);
2790 conf_set_int(conf, CONF_ssh_simple, TRUE);
2793 while ((key = conf_get_str_nthstrkey(conf, CONF_portfwd, 0)) != NULL)
2794 conf_del_str_str(conf, CONF_portfwd, key);
2797 /* Set up subsystem name. */
2798 conf_set_str(conf, CONF_remote_cmd, "sftp");
2799 conf_set_int(conf, CONF_ssh_subsys, TRUE);
2800 conf_set_int(conf, CONF_nopty, TRUE);
2803 * Set up fallback option, for SSH-1 servers or servers with the
2804 * sftp subsystem not enabled but the server binary installed
2805 * in the usual place. We only support fallback on Unix
2806 * systems, and we use a kludgy piece of shellery which should
2807 * try to find sftp-server in various places (the obvious
2808 * systemwide spots /usr/lib and /usr/local/lib, and then the
2809 * user's PATH) and finally give up.
2811 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2812 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2815 * the idea being that this will attempt to use either of the
2816 * obvious pathnames and then give up, and when it does give up
2817 * it will print the preferred pathname in the error messages.
2819 conf_set_str(conf, CONF_remote_cmd2,
2820 "test -x /usr/lib/sftp-server &&"
2821 " exec /usr/lib/sftp-server\n"
2822 "test -x /usr/local/lib/sftp-server &&"
2823 " exec /usr/local/lib/sftp-server\n"
2824 "exec sftp-server");
2825 conf_set_int(conf, CONF_ssh_subsys2, FALSE);
2827 back = &ssh_backend;
2829 err = back->init(NULL, &backhandle, conf,
2830 conf_get_str(conf, CONF_host),
2831 conf_get_int(conf, CONF_port),
2833 conf_get_int(conf, CONF_tcp_keepalives));
2835 fprintf(stderr, "ssh_init: %s\n", err);
2838 logctx = log_init(NULL, conf);
2839 back->provide_logctx(backhandle, logctx);
2840 console_provide_logctx(logctx);
2841 while (!back->sendok(backhandle)) {
2842 if (back->exitcode(backhandle) >= 0)
2844 if (ssh_sftp_loop_iteration() < 0) {
2845 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2849 if (verbose && realhost != NULL)
2850 printf("Connected to %s\n", realhost);
2851 if (realhost != NULL)
2856 void cmdline_error(char *p, ...)
2859 fprintf(stderr, "psftp: ");
2861 vfprintf(stderr, p, ap);
2863 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2868 * Main program. Parse arguments etc.
2870 int psftp_main(int argc, char *argv[])
2874 char *userhost, *user;
2877 char *batchfile = NULL;
2879 flags = FLAG_STDERR | FLAG_INTERACTIVE
2880 #ifdef FLAG_SYNCAGENT
2884 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2887 userhost = user = NULL;
2889 /* Load Default Settings before doing anything else. */
2891 do_defaults(NULL, conf);
2892 loaded_session = FALSE;
2894 for (i = 1; i < argc; i++) {
2896 if (argv[i][0] != '-') {
2900 userhost = dupstr(argv[i]);
2903 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, conf);
2905 cmdline_error("option \"%s\" requires an argument", argv[i]);
2906 } else if (ret == 2) {
2907 i++; /* skip next argument */
2908 } else if (ret == 1) {
2909 /* We have our own verbosity in addition to `flags'. */
2910 if (flags & FLAG_VERBOSE)
2912 } else if (strcmp(argv[i], "-h") == 0 ||
2913 strcmp(argv[i], "-?") == 0) {
2915 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2918 } else if (strcmp(argv[i], "-V") == 0) {
2920 } else if (strcmp(argv[i], "-batch") == 0) {
2921 console_batch_mode = 1;
2922 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2924 batchfile = argv[++i];
2925 } else if (strcmp(argv[i], "-bc") == 0) {
2926 modeflags = modeflags | 1;
2927 } else if (strcmp(argv[i], "-be") == 0) {
2928 modeflags = modeflags | 2;
2929 } else if (strcmp(argv[i], "--") == 0) {
2933 cmdline_error("unknown option \"%s\"", argv[i]);
2941 * If the loaded session provides a hostname, and a hostname has not
2942 * otherwise been specified, pop it in `userhost' so that
2943 * `psftp -load sessname' is sufficient to start a session.
2945 if (!userhost && conf_get_str(conf, CONF_host)[0] != '\0') {
2946 userhost = dupstr(conf_get_str(conf, CONF_host));
2950 * If a user@host string has already been provided, connect to
2955 ret = psftp_connect(userhost, user, portnumber);
2962 printf("psftp: no hostname specified; use \"open host.name\""
2966 do_sftp(mode, modeflags, batchfile);
2968 if (back != NULL && back->connected(backhandle)) {
2970 back->special(backhandle, TS_EOF);
2972 sftp_recvdata(&ch, 1);
2977 console_provide_logctx(NULL);