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,
833 } else if (swcm->names->nnames == 0) {
835 * Another failure mode which we treat as EOF is if
836 * the server reports success from FXP_READDIR but
837 * returns no actual names. This is unusual, since
838 * from most servers you'd expect at least "." and
839 * "..", but there's nothing forbidding a server from
840 * omitting those if it wants to.
848 assert(swcm->names && swcm->namepos < swcm->names->nnames);
850 name = &swcm->names->names[swcm->namepos++];
852 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
853 continue; /* expected bad filenames */
855 if (!vet_filename(name->filename)) {
856 printf("ignoring potentially dangerous server-"
857 "supplied filename '%s'\n", name->filename);
858 continue; /* unexpected bad filename */
861 if (!wc_match(swcm->wildcard, name->filename))
862 continue; /* doesn't match the wildcard */
865 * We have a working filename. Return it.
867 return dupprintf("%s%s%s", swcm->prefix,
869 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
875 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
877 struct sftp_packet *pktin;
878 struct sftp_request *req, *rreq;
880 sftp_register(req = fxp_close_send(swcm->dirh));
881 rreq = sftp_find_request(pktin = sftp_recv());
883 fxp_close_recv(pktin, rreq);
886 fxp_free_names(swcm->names);
889 sfree(swcm->wildcard);
895 * General function to match a potential wildcard in a filename
896 * argument and iterate over every matching file. Used in several
897 * PSFTP commands (rmdir, rm, chmod, mv).
899 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
901 char *unwcfname, *newname, *cname;
904 unwcfname = snewn(strlen(filename)+1, char);
905 is_wc = !wc_unescape(unwcfname, filename);
908 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
917 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
918 cname = canonify(newname);
920 printf("%s: canonify: %s\n", newname, fxp_error());
924 ret &= func(ctx, cname);
929 /* Politely warn the user that nothing matched. */
930 printf("%s: nothing matched\n", filename);
933 sftp_finish_wildcard_matching(swcm);
935 cname = canonify(unwcfname);
937 printf("%s: canonify: %s\n", filename, fxp_error());
940 ret = func(ctx, cname);
949 * Handy helper function.
951 int is_wildcard(char *name)
953 char *unwcfname = snewn(strlen(name)+1, char);
954 int is_wc = !wc_unescape(unwcfname, name);
959 /* ----------------------------------------------------------------------
960 * Actual sftp commands.
962 struct sftp_command {
964 int nwords, wordssize;
965 int (*obey) (struct sftp_command *); /* returns <0 to quit */
968 int sftp_cmd_null(struct sftp_command *cmd)
970 return 1; /* success */
973 int sftp_cmd_unknown(struct sftp_command *cmd)
975 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
976 return 0; /* failure */
979 int sftp_cmd_quit(struct sftp_command *cmd)
984 int sftp_cmd_close(struct sftp_command *cmd)
991 if (back != NULL && back->connected(backhandle)) {
993 back->special(backhandle, TS_EOF);
995 sftp_recvdata(&ch, 1);
1003 * List a directory. If no arguments are given, list pwd; otherwise
1004 * list the directory given in words[1].
1006 int sftp_cmd_ls(struct sftp_command *cmd)
1008 struct fxp_handle *dirh;
1009 struct fxp_names *names;
1010 struct fxp_name **ournames;
1011 int nnames, namesize;
1012 char *dir, *cdir, *unwcdir, *wildcard;
1013 struct sftp_packet *pktin;
1014 struct sftp_request *req, *rreq;
1022 if (cmd->nwords < 2)
1025 dir = cmd->words[1];
1027 unwcdir = snewn(1 + strlen(dir), char);
1028 if (wc_unescape(unwcdir, dir)) {
1035 wildcard = stripslashes(dir, 0);
1036 unwcdir = dupstr(dir);
1037 len = wildcard - dir;
1038 unwcdir[len] = '\0';
1039 if (len > 0 && unwcdir[len-1] == '/')
1040 unwcdir[len-1] = '\0';
1041 tmpdir = snewn(1 + len, char);
1042 check = wc_unescape(tmpdir, unwcdir);
1045 printf("Multiple-level wildcards are not supported\n");
1052 cdir = canonify(dir);
1054 printf("%s: canonify: %s\n", dir, fxp_error());
1059 printf("Listing directory %s\n", cdir);
1061 sftp_register(req = fxp_opendir_send(cdir));
1062 rreq = sftp_find_request(pktin = sftp_recv());
1063 assert(rreq == req);
1064 dirh = fxp_opendir_recv(pktin, rreq);
1067 printf("Unable to open %s: %s\n", dir, fxp_error());
1069 nnames = namesize = 0;
1074 sftp_register(req = fxp_readdir_send(dirh));
1075 rreq = sftp_find_request(pktin = sftp_recv());
1076 assert(rreq == req);
1077 names = fxp_readdir_recv(pktin, rreq);
1079 if (names == NULL) {
1080 if (fxp_error_type() == SSH_FX_EOF)
1082 printf("Reading directory %s: %s\n", dir, fxp_error());
1085 if (names->nnames == 0) {
1086 fxp_free_names(names);
1090 if (nnames + names->nnames >= namesize) {
1091 namesize += names->nnames + 128;
1092 ournames = sresize(ournames, namesize, struct fxp_name *);
1095 for (i = 0; i < names->nnames; i++)
1096 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1097 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1099 fxp_free_names(names);
1101 sftp_register(req = fxp_close_send(dirh));
1102 rreq = sftp_find_request(pktin = sftp_recv());
1103 assert(rreq == req);
1104 fxp_close_recv(pktin, rreq);
1107 * Now we have our filenames. Sort them by actual file
1108 * name, and then output the longname parts.
1110 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1115 for (i = 0; i < nnames; i++) {
1116 printf("%s\n", ournames[i]->longname);
1117 fxp_free_name(ournames[i]);
1129 * Change directories. We do this by canonifying the new name, then
1130 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1132 int sftp_cmd_cd(struct sftp_command *cmd)
1134 struct fxp_handle *dirh;
1135 struct sftp_packet *pktin;
1136 struct sftp_request *req, *rreq;
1144 if (cmd->nwords < 2)
1145 dir = dupstr(homedir);
1147 dir = canonify(cmd->words[1]);
1150 printf("%s: canonify: %s\n", dir, fxp_error());
1154 sftp_register(req = fxp_opendir_send(dir));
1155 rreq = sftp_find_request(pktin = sftp_recv());
1156 assert(rreq == req);
1157 dirh = fxp_opendir_recv(pktin, rreq);
1160 printf("Directory %s: %s\n", dir, fxp_error());
1165 sftp_register(req = fxp_close_send(dirh));
1166 rreq = sftp_find_request(pktin = sftp_recv());
1167 assert(rreq == req);
1168 fxp_close_recv(pktin, rreq);
1172 printf("Remote directory is now %s\n", pwd);
1178 * Print current directory. Easy as pie.
1180 int sftp_cmd_pwd(struct sftp_command *cmd)
1187 printf("Remote directory is %s\n", pwd);
1192 * Get a file and save it at the local end. We have three very
1193 * similar commands here. The basic one is `get'; `reget' differs
1194 * in that it checks for the existence of the destination file and
1195 * starts from where a previous aborted transfer left off; `mget'
1196 * differs in that it interprets all its arguments as files to
1197 * transfer (never as a different local name for a remote file) and
1198 * can handle wildcards.
1200 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1202 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1204 int recurse = FALSE;
1212 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1213 if (!strcmp(cmd->words[i], "--")) {
1214 /* finish processing options */
1217 } else if (!strcmp(cmd->words[i], "-r")) {
1220 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1226 if (i >= cmd->nwords) {
1227 printf("%s: expects a filename\n", cmd->words[0]);
1233 SftpWildcardMatcher *swcm;
1235 origfname = cmd->words[i++];
1236 unwcfname = snewn(strlen(origfname)+1, char);
1238 if (multiple && !wc_unescape(unwcfname, origfname)) {
1239 swcm = sftp_begin_wildcard_matching(origfname);
1244 origwfname = sftp_wildcard_get_filename(swcm);
1246 /* Politely warn the user that nothing matched. */
1247 printf("%s: nothing matched\n", origfname);
1248 sftp_finish_wildcard_matching(swcm);
1253 origwfname = origfname;
1257 while (origwfname) {
1258 fname = canonify(origwfname);
1261 printf("%s: canonify: %s\n", origwfname, fxp_error());
1266 if (!multiple && i < cmd->nwords)
1267 outfname = cmd->words[i++];
1269 outfname = stripslashes(origwfname, 0);
1271 ret = sftp_get_file(fname, outfname, recurse, restart);
1277 origwfname = sftp_wildcard_get_filename(swcm);
1284 sftp_finish_wildcard_matching(swcm);
1288 } while (multiple && i < cmd->nwords);
1292 int sftp_cmd_get(struct sftp_command *cmd)
1294 return sftp_general_get(cmd, 0, 0);
1296 int sftp_cmd_mget(struct sftp_command *cmd)
1298 return sftp_general_get(cmd, 0, 1);
1300 int sftp_cmd_reget(struct sftp_command *cmd)
1302 return sftp_general_get(cmd, 1, 0);
1306 * Send a file and store it at the remote end. We have three very
1307 * similar commands here. The basic one is `put'; `reput' differs
1308 * in that it checks for the existence of the destination file and
1309 * starts from where a previous aborted transfer left off; `mput'
1310 * differs in that it interprets all its arguments as files to
1311 * transfer (never as a different remote name for a local file) and
1312 * can handle wildcards.
1314 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1316 char *fname, *wfname, *origoutfname, *outfname;
1318 int recurse = FALSE;
1326 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1327 if (!strcmp(cmd->words[i], "--")) {
1328 /* finish processing options */
1331 } else if (!strcmp(cmd->words[i], "-r")) {
1334 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1340 if (i >= cmd->nwords) {
1341 printf("%s: expects a filename\n", cmd->words[0]);
1347 WildcardMatcher *wcm;
1348 fname = cmd->words[i++];
1350 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1351 wcm = begin_wildcard_matching(fname);
1352 wfname = wildcard_get_filename(wcm);
1354 /* Politely warn the user that nothing matched. */
1355 printf("%s: nothing matched\n", fname);
1356 finish_wildcard_matching(wcm);
1365 if (!multiple && i < cmd->nwords)
1366 origoutfname = cmd->words[i++];
1368 origoutfname = stripslashes(wfname, 1);
1370 outfname = canonify(origoutfname);
1372 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1375 finish_wildcard_matching(wcm);
1379 ret = sftp_put_file(wfname, outfname, recurse, restart);
1384 wfname = wildcard_get_filename(wcm);
1391 finish_wildcard_matching(wcm);
1396 } while (multiple && i < cmd->nwords);
1400 int sftp_cmd_put(struct sftp_command *cmd)
1402 return sftp_general_put(cmd, 0, 0);
1404 int sftp_cmd_mput(struct sftp_command *cmd)
1406 return sftp_general_put(cmd, 0, 1);
1408 int sftp_cmd_reput(struct sftp_command *cmd)
1410 return sftp_general_put(cmd, 1, 0);
1413 int sftp_cmd_mkdir(struct sftp_command *cmd)
1416 struct sftp_packet *pktin;
1417 struct sftp_request *req, *rreq;
1426 if (cmd->nwords < 2) {
1427 printf("mkdir: expects a directory\n");
1432 for (i = 1; i < cmd->nwords; i++) {
1433 dir = canonify(cmd->words[i]);
1435 printf("%s: canonify: %s\n", dir, fxp_error());
1439 sftp_register(req = fxp_mkdir_send(dir));
1440 rreq = sftp_find_request(pktin = sftp_recv());
1441 assert(rreq == req);
1442 result = fxp_mkdir_recv(pktin, rreq);
1445 printf("mkdir %s: %s\n", dir, fxp_error());
1448 printf("mkdir %s: OK\n", dir);
1456 static int sftp_action_rmdir(void *vctx, char *dir)
1458 struct sftp_packet *pktin;
1459 struct sftp_request *req, *rreq;
1462 sftp_register(req = fxp_rmdir_send(dir));
1463 rreq = sftp_find_request(pktin = sftp_recv());
1464 assert(rreq == req);
1465 result = fxp_rmdir_recv(pktin, rreq);
1468 printf("rmdir %s: %s\n", dir, fxp_error());
1472 printf("rmdir %s: OK\n", dir);
1477 int sftp_cmd_rmdir(struct sftp_command *cmd)
1486 if (cmd->nwords < 2) {
1487 printf("rmdir: expects a directory\n");
1492 for (i = 1; i < cmd->nwords; i++)
1493 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1498 static int sftp_action_rm(void *vctx, char *fname)
1500 struct sftp_packet *pktin;
1501 struct sftp_request *req, *rreq;
1504 sftp_register(req = fxp_remove_send(fname));
1505 rreq = sftp_find_request(pktin = sftp_recv());
1506 assert(rreq == req);
1507 result = fxp_remove_recv(pktin, rreq);
1510 printf("rm %s: %s\n", fname, fxp_error());
1514 printf("rm %s: OK\n", fname);
1519 int sftp_cmd_rm(struct sftp_command *cmd)
1528 if (cmd->nwords < 2) {
1529 printf("rm: expects a filename\n");
1534 for (i = 1; i < cmd->nwords; i++)
1535 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1540 static int check_is_dir(char *dstfname)
1542 struct sftp_packet *pktin;
1543 struct sftp_request *req, *rreq;
1544 struct fxp_attrs attrs;
1547 sftp_register(req = fxp_stat_send(dstfname));
1548 rreq = sftp_find_request(pktin = sftp_recv());
1549 assert(rreq == req);
1550 result = fxp_stat_recv(pktin, rreq, &attrs);
1553 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1554 (attrs.permissions & 0040000))
1560 struct sftp_context_mv {
1565 static int sftp_action_mv(void *vctx, char *srcfname)
1567 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1568 struct sftp_packet *pktin;
1569 struct sftp_request *req, *rreq;
1571 char *finalfname, *newcanon = NULL;
1574 if (ctx->dest_is_dir) {
1578 p = srcfname + strlen(srcfname);
1579 while (p > srcfname && p[-1] != '/') p--;
1580 newname = dupcat(ctx->dstfname, "/", p, NULL);
1581 newcanon = canonify(newname);
1583 printf("%s: canonify: %s\n", newname, fxp_error());
1589 finalfname = newcanon;
1591 finalfname = ctx->dstfname;
1594 sftp_register(req = fxp_rename_send(srcfname, finalfname));
1595 rreq = sftp_find_request(pktin = sftp_recv());
1596 assert(rreq == req);
1597 result = fxp_rename_recv(pktin, rreq);
1599 error = result ? NULL : fxp_error();
1602 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1605 printf("%s -> %s\n", srcfname, finalfname);
1613 int sftp_cmd_mv(struct sftp_command *cmd)
1615 struct sftp_context_mv actx, *ctx = &actx;
1623 if (cmd->nwords < 3) {
1624 printf("mv: expects two filenames\n");
1628 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1629 if (!ctx->dstfname) {
1630 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1635 * If there's more than one source argument, or one source
1636 * argument which is a wildcard, we _require_ that the
1637 * destination is a directory.
1639 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1640 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1641 printf("mv: multiple or wildcard arguments require the destination"
1642 " to be a directory\n");
1643 sfree(ctx->dstfname);
1648 * Now iterate over the source arguments.
1651 for (i = 1; i < cmd->nwords-1; i++)
1652 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1654 sfree(ctx->dstfname);
1658 struct sftp_context_chmod {
1659 unsigned attrs_clr, attrs_xor;
1662 static int sftp_action_chmod(void *vctx, char *fname)
1664 struct fxp_attrs attrs;
1665 struct sftp_packet *pktin;
1666 struct sftp_request *req, *rreq;
1668 unsigned oldperms, newperms;
1669 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1671 sftp_register(req = fxp_stat_send(fname));
1672 rreq = sftp_find_request(pktin = sftp_recv());
1673 assert(rreq == req);
1674 result = fxp_stat_recv(pktin, rreq, &attrs);
1676 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1677 printf("get attrs for %s: %s\n", fname,
1678 result ? "file permissions not provided" : fxp_error());
1682 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1683 oldperms = attrs.permissions & 07777;
1684 attrs.permissions &= ~ctx->attrs_clr;
1685 attrs.permissions ^= ctx->attrs_xor;
1686 newperms = attrs.permissions & 07777;
1688 if (oldperms == newperms)
1689 return 1; /* no need to do anything! */
1691 sftp_register(req = fxp_setstat_send(fname, attrs));
1692 rreq = sftp_find_request(pktin = sftp_recv());
1693 assert(rreq == req);
1694 result = fxp_setstat_recv(pktin, rreq);
1697 printf("set attrs for %s: %s\n", fname, fxp_error());
1701 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1706 int sftp_cmd_chmod(struct sftp_command *cmd)
1710 struct sftp_context_chmod actx, *ctx = &actx;
1717 if (cmd->nwords < 3) {
1718 printf("chmod: expects a mode specifier and a filename\n");
1723 * Attempt to parse the mode specifier in cmd->words[1]. We
1724 * don't support the full horror of Unix chmod; instead we
1725 * support a much simpler syntax in which the user can either
1726 * specify an octal number, or a comma-separated sequence of
1727 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1728 * _only_ be omitted if the only attribute mentioned is t,
1729 * since all others require a user/group/other specification.
1730 * Additionally, the s attribute may not be specified for any
1731 * [ugoa] specifications other than exactly u or exactly g.
1733 ctx->attrs_clr = ctx->attrs_xor = 0;
1734 mode = cmd->words[1];
1735 if (mode[0] >= '0' && mode[0] <= '9') {
1736 if (mode[strspn(mode, "01234567")]) {
1737 printf("chmod: numeric file modes should"
1738 " contain digits 0-7 only\n");
1741 ctx->attrs_clr = 07777;
1742 sscanf(mode, "%o", &ctx->attrs_xor);
1743 ctx->attrs_xor &= ctx->attrs_clr;
1746 char *modebegin = mode;
1747 unsigned subset, perms;
1751 while (*mode && *mode != ',' &&
1752 *mode != '+' && *mode != '-' && *mode != '=') {
1754 case 'u': subset |= 04700; break; /* setuid, user perms */
1755 case 'g': subset |= 02070; break; /* setgid, group perms */
1756 case 'o': subset |= 00007; break; /* just other perms */
1757 case 'a': subset |= 06777; break; /* all of the above */
1759 printf("chmod: file mode '%.*s' contains unrecognised"
1760 " user/group/other specifier '%c'\n",
1761 (int)strcspn(modebegin, ","), modebegin, *mode);
1766 if (!*mode || *mode == ',') {
1767 printf("chmod: file mode '%.*s' is incomplete\n",
1768 (int)strcspn(modebegin, ","), modebegin);
1772 if (!*mode || *mode == ',') {
1773 printf("chmod: file mode '%.*s' is incomplete\n",
1774 (int)strcspn(modebegin, ","), modebegin);
1778 while (*mode && *mode != ',') {
1780 case 'r': perms |= 00444; break;
1781 case 'w': perms |= 00222; break;
1782 case 'x': perms |= 00111; break;
1783 case 't': perms |= 01000; subset |= 01000; break;
1785 if ((subset & 06777) != 04700 &&
1786 (subset & 06777) != 02070) {
1787 printf("chmod: file mode '%.*s': set[ug]id bit should"
1788 " be used with exactly one of u or g only\n",
1789 (int)strcspn(modebegin, ","), modebegin);
1795 printf("chmod: file mode '%.*s' contains unrecognised"
1796 " permission specifier '%c'\n",
1797 (int)strcspn(modebegin, ","), modebegin, *mode);
1802 if (!(subset & 06777) && (perms &~ subset)) {
1803 printf("chmod: file mode '%.*s' contains no user/group/other"
1804 " specifier and permissions other than 't' \n",
1805 (int)strcspn(modebegin, ","), modebegin);
1811 ctx->attrs_clr |= perms;
1812 ctx->attrs_xor |= perms;
1815 ctx->attrs_clr |= perms;
1816 ctx->attrs_xor &= ~perms;
1819 ctx->attrs_clr |= subset;
1820 ctx->attrs_xor |= perms;
1823 if (*mode) mode++; /* eat comma */
1828 for (i = 2; i < cmd->nwords; i++)
1829 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1834 static int sftp_cmd_open(struct sftp_command *cmd)
1839 printf("psftp: already connected\n");
1843 if (cmd->nwords < 2) {
1844 printf("open: expects a host name\n");
1848 if (cmd->nwords > 2) {
1849 portnumber = atoi(cmd->words[2]);
1850 if (portnumber == 0) {
1851 printf("open: invalid port number\n");
1857 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1858 back = NULL; /* connection is already closed */
1859 return -1; /* this is fatal */
1865 static int sftp_cmd_lcd(struct sftp_command *cmd)
1867 char *currdir, *errmsg;
1869 if (cmd->nwords < 2) {
1870 printf("lcd: expects a local directory name\n");
1874 errmsg = psftp_lcd(cmd->words[1]);
1876 printf("lcd: unable to change directory: %s\n", errmsg);
1881 currdir = psftp_getcwd();
1882 printf("New local directory is %s\n", currdir);
1888 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1892 currdir = psftp_getcwd();
1893 printf("Current local directory is %s\n", currdir);
1899 static int sftp_cmd_pling(struct sftp_command *cmd)
1903 exitcode = system(cmd->words[1]);
1904 return (exitcode == 0);
1907 static int sftp_cmd_help(struct sftp_command *cmd);
1909 static struct sftp_cmd_lookup {
1912 * For help purposes, there are two kinds of command:
1914 * - primary commands, in which `longhelp' is non-NULL. In
1915 * this case `shorthelp' is descriptive text, and `longhelp'
1916 * is longer descriptive text intended to be printed after
1919 * - alias commands, in which `longhelp' is NULL. In this case
1920 * `shorthelp' is the name of a primary command, which
1921 * contains the help that should double up for this command.
1923 int listed; /* do we list this in primary help? */
1926 int (*obey) (struct sftp_command *);
1929 * List of sftp commands. This is binary-searched so it MUST be
1933 "!", TRUE, "run a local command",
1935 /* FIXME: this example is crap for non-Windows. */
1936 " Runs a local command. For example, \"!del myfile\".\n",
1940 "bye", TRUE, "finish your SFTP session",
1942 " Terminates your SFTP session and quits the PSFTP program.\n",
1946 "cd", TRUE, "change your remote working directory",
1947 " [ <new working directory> ]\n"
1948 " Change the remote working directory for your SFTP session.\n"
1949 " If a new working directory is not supplied, you will be\n"
1950 " returned to your home directory.\n",
1954 "chmod", TRUE, "change file permissions and modes",
1955 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1956 " Change the file permissions on one or more remote files or\n"
1958 " <modes> can be any octal Unix permission specifier.\n"
1959 " Alternatively, <modes> can include the following modifiers:\n"
1960 " u+r make file readable by owning user\n"
1961 " u+w make file writable by owning user\n"
1962 " u+x make file executable by owning user\n"
1963 " u-r make file not readable by owning user\n"
1964 " [also u-w, u-x]\n"
1965 " g+r make file readable by members of owning group\n"
1966 " [also g+w, g+x, g-r, g-w, g-x]\n"
1967 " o+r make file readable by all other users\n"
1968 " [also o+w, o+x, o-r, o-w, o-x]\n"
1969 " a+r make file readable by absolutely everybody\n"
1970 " [also a+w, a+x, a-r, a-w, a-x]\n"
1971 " u+s enable the Unix set-user-ID bit\n"
1972 " u-s disable the Unix set-user-ID bit\n"
1973 " g+s enable the Unix set-group-ID bit\n"
1974 " g-s disable the Unix set-group-ID bit\n"
1975 " +t enable the Unix \"sticky bit\"\n"
1976 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1977 " more than one user for the same modifier (\"ug+w\"). You can\n"
1978 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1982 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1984 " Terminates your SFTP session, but does not quit the PSFTP\n"
1985 " program. You can then use \"open\" to start another SFTP\n"
1986 " session, to the same server or to a different one.\n",
1990 "del", TRUE, "delete files on the remote server",
1991 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1992 " Delete a file or files from the server.\n",
1996 "delete", FALSE, "del", NULL, sftp_cmd_rm
1999 "dir", TRUE, "list remote files",
2000 " [ <directory-name> ]/[ <wildcard> ]\n"
2001 " List the contents of a specified directory on the server.\n"
2002 " If <directory-name> is not given, the current working directory\n"
2004 " If <wildcard> is given, it is treated as a set of files to\n"
2005 " list; otherwise, all files are listed.\n",
2009 "exit", TRUE, "bye", NULL, sftp_cmd_quit
2012 "get", TRUE, "download a file from the server to your local machine",
2013 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2014 " Downloads a file on the server and stores it locally under\n"
2015 " the same name, or under a different one if you supply the\n"
2016 " argument <local-filename>.\n"
2017 " If -r specified, recursively fetch a directory.\n",
2021 "help", TRUE, "give help",
2022 " [ <command> [ <command> ... ] ]\n"
2023 " Give general help if no commands are specified.\n"
2024 " If one or more commands are specified, give specific help on\n"
2025 " those particular commands.\n",
2029 "lcd", TRUE, "change local working directory",
2030 " <local-directory-name>\n"
2031 " Change the local working directory of the PSFTP program (the\n"
2032 " default location where the \"get\" command will save files).\n",
2036 "lpwd", TRUE, "print local working directory",
2038 " Print the local working directory of the PSFTP program (the\n"
2039 " default location where the \"get\" command will save files).\n",
2043 "ls", TRUE, "dir", NULL,
2047 "mget", TRUE, "download multiple files at once",
2048 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2049 " Downloads many files from the server, storing each one under\n"
2050 " the same name it has on the server side. You can use wildcards\n"
2051 " such as \"*.c\" to specify lots of files at once.\n"
2052 " If -r specified, recursively fetch files and directories.\n",
2056 "mkdir", TRUE, "create directories on the remote server",
2057 " <directory-name> [ <directory-name>... ]\n"
2058 " Creates directories with the given names on the server.\n",
2062 "mput", TRUE, "upload multiple files at once",
2063 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2064 " Uploads many files to the server, storing each one under the\n"
2065 " same name it has on the client side. You can use wildcards\n"
2066 " such as \"*.c\" to specify lots of files at once.\n"
2067 " If -r specified, recursively store files and directories.\n",
2071 "mv", TRUE, "move or rename file(s) on the remote server",
2072 " <source> [ <source>... ] <destination>\n"
2073 " Moves or renames <source>(s) on the server to <destination>,\n"
2074 " also on the server.\n"
2075 " If <destination> specifies an existing directory, then <source>\n"
2076 " may be a wildcard, and multiple <source>s may be given; all\n"
2077 " source files are moved into <destination>.\n"
2078 " Otherwise, <source> must specify a single file, which is moved\n"
2079 " or renamed so that it is accessible under the name <destination>.\n",
2083 "open", TRUE, "connect to a host",
2084 " [<user>@]<hostname> [<port>]\n"
2085 " Establishes an SFTP connection to a given host. Only usable\n"
2086 " when you are not already connected to a server.\n",
2090 "put", TRUE, "upload a file from your local machine to the server",
2091 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2092 " Uploads a file to the server and stores it there under\n"
2093 " the same name, or under a different one if you supply the\n"
2094 " argument <remote-filename>.\n"
2095 " If -r specified, recursively store a directory.\n",
2099 "pwd", TRUE, "print your remote working directory",
2101 " Print the current remote working directory for your SFTP session.\n",
2105 "quit", TRUE, "bye", NULL,
2109 "reget", TRUE, "continue downloading files",
2110 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2111 " Works exactly like the \"get\" command, but the local file\n"
2112 " must already exist. The download will begin at the end of the\n"
2113 " file. This is for resuming a download that was interrupted.\n"
2114 " If -r specified, resume interrupted \"get -r\".\n",
2118 "ren", TRUE, "mv", NULL,
2122 "rename", FALSE, "mv", NULL,
2126 "reput", TRUE, "continue uploading files",
2127 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2128 " Works exactly like the \"put\" command, but the remote file\n"
2129 " must already exist. The upload will begin at the end of the\n"
2130 " file. This is for resuming an upload that was interrupted.\n"
2131 " If -r specified, resume interrupted \"put -r\".\n",
2135 "rm", TRUE, "del", NULL,
2139 "rmdir", TRUE, "remove directories on the remote server",
2140 " <directory-name> [ <directory-name>... ]\n"
2141 " Removes the directory with the given name on the server.\n"
2142 " The directory will not be removed unless it is empty.\n"
2143 " Wildcards may be used to specify multiple directories.\n",
2148 const struct sftp_cmd_lookup *lookup_command(char *name)
2153 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2156 cmp = strcmp(name, sftp_lookup[k].name);
2162 return &sftp_lookup[k];
2168 static int sftp_cmd_help(struct sftp_command *cmd)
2171 if (cmd->nwords == 1) {
2173 * Give short help on each command.
2177 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2179 if (!sftp_lookup[i].listed)
2181 len = strlen(sftp_lookup[i].name);
2185 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2186 const struct sftp_cmd_lookup *lookup;
2187 if (!sftp_lookup[i].listed)
2189 lookup = &sftp_lookup[i];
2190 printf("%-*s", maxlen+2, lookup->name);
2191 if (lookup->longhelp == NULL)
2192 lookup = lookup_command(lookup->shorthelp);
2193 printf("%s\n", lookup->shorthelp);
2197 * Give long help on specific commands.
2199 for (i = 1; i < cmd->nwords; i++) {
2200 const struct sftp_cmd_lookup *lookup;
2201 lookup = lookup_command(cmd->words[i]);
2203 printf("help: %s: command not found\n", cmd->words[i]);
2205 printf("%s", lookup->name);
2206 if (lookup->longhelp == NULL)
2207 lookup = lookup_command(lookup->shorthelp);
2208 printf("%s", lookup->longhelp);
2215 /* ----------------------------------------------------------------------
2216 * Command line reading and parsing.
2218 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2221 struct sftp_command *cmd;
2225 cmd = snew(struct sftp_command);
2235 line = fgetline(fp);
2237 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2240 if (!line || !*line) {
2241 cmd->obey = sftp_cmd_quit;
2242 if ((mode == 0) || (modeflags & 1))
2244 return cmd; /* eof */
2247 line[strcspn(line, "\r\n")] = '\0';
2249 if (modeflags & 1) {
2250 printf("%s\n", line);
2254 while (*p && (*p == ' ' || *p == '\t'))
2259 * Special case: the ! command. This is always parsed as
2260 * exactly two words: one containing the !, and the second
2261 * containing everything else on the line.
2263 cmd->nwords = cmd->wordssize = 2;
2264 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2265 cmd->words[0] = dupstr("!");
2266 cmd->words[1] = dupstr(p+1);
2267 } else if (*p == '#') {
2269 * Special case: comment. Entire line is ignored.
2271 cmd->nwords = cmd->wordssize = 0;
2275 * Parse the command line into words. The syntax is:
2276 * - double quotes are removed, but cause spaces within to be
2277 * treated as non-separating.
2278 * - a double-doublequote pair is a literal double quote, inside
2279 * _or_ outside quotes. Like this:
2281 * firstword "second word" "this has ""quotes"" in" and""this""
2287 * >this has "quotes" in<
2291 /* skip whitespace */
2292 while (*p && (*p == ' ' || *p == '\t'))
2294 /* mark start of word */
2295 q = r = p; /* q sits at start, r writes word */
2298 if (!quoting && (*p == ' ' || *p == '\t'))
2299 break; /* reached end of word */
2300 else if (*p == '"' && p[1] == '"')
2301 p += 2, *r++ = '"'; /* a literal quote */
2303 p++, quoting = !quoting;
2308 p++; /* skip over the whitespace */
2310 if (cmd->nwords >= cmd->wordssize) {
2311 cmd->wordssize = cmd->nwords + 16;
2312 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2314 cmd->words[cmd->nwords++] = dupstr(q);
2321 * Now parse the first word and assign a function.
2324 if (cmd->nwords == 0)
2325 cmd->obey = sftp_cmd_null;
2327 const struct sftp_cmd_lookup *lookup;
2328 lookup = lookup_command(cmd->words[0]);
2330 cmd->obey = sftp_cmd_unknown;
2332 cmd->obey = lookup->obey;
2338 static int do_sftp_init(void)
2340 struct sftp_packet *pktin;
2341 struct sftp_request *req, *rreq;
2344 * Do protocol initialisation.
2348 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2349 return 1; /* failure */
2353 * Find out where our home directory is.
2355 sftp_register(req = fxp_realpath_send("."));
2356 rreq = sftp_find_request(pktin = sftp_recv());
2357 assert(rreq == req);
2358 homedir = fxp_realpath_recv(pktin, rreq);
2362 "Warning: failed to resolve home directory: %s\n",
2364 homedir = dupstr(".");
2366 printf("Remote working directory is %s\n", homedir);
2368 pwd = dupstr(homedir);
2372 void do_sftp_cleanup()
2376 back->special(backhandle, TS_EOF);
2378 sftp_recvdata(&ch, 1);
2379 back->free(backhandle);
2380 sftp_cleanup_request();
2394 void do_sftp(int mode, int modeflags, char *batchfile)
2404 /* ------------------------------------------------------------------
2405 * Now we're ready to do Real Stuff.
2408 struct sftp_command *cmd;
2409 cmd = sftp_getcmd(NULL, 0, 0);
2412 ret = cmd->obey(cmd);
2415 for(i = 0; i < cmd->nwords; i++)
2416 sfree(cmd->words[i]);
2424 fp = fopen(batchfile, "r");
2426 printf("Fatal: unable to open %s\n", batchfile);
2430 struct sftp_command *cmd;
2431 cmd = sftp_getcmd(fp, mode, modeflags);
2434 ret = cmd->obey(cmd);
2438 if (!(modeflags & 2))
2447 /* ----------------------------------------------------------------------
2448 * Dirty bits: integration with PuTTY.
2451 static int verbose = 0;
2454 * Print an error message and perform a fatal exit.
2456 void fatalbox(char *fmt, ...)
2461 str = dupvprintf(fmt, ap);
2462 str2 = dupcat("Fatal: ", str, "\n", NULL);
2465 fputs(str2, stderr);
2470 void modalfatalbox(char *fmt, ...)
2475 str = dupvprintf(fmt, ap);
2476 str2 = dupcat("Fatal: ", str, "\n", NULL);
2479 fputs(str2, stderr);
2484 void connection_fatal(void *frontend, char *fmt, ...)
2489 str = dupvprintf(fmt, ap);
2490 str2 = dupcat("Fatal: ", str, "\n", NULL);
2493 fputs(str2, stderr);
2499 void ldisc_send(void *handle, char *buf, int len, int interactive)
2502 * This is only here because of the calls to ldisc_send(NULL,
2503 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2504 * ldisc as an ldisc. So if we get called with any real data, I
2505 * want to know about it.
2511 * In psftp, all agent requests should be synchronous, so this is a
2512 * never-called stub.
2514 void agent_schedule_callback(void (*callback)(void *, void *, int),
2515 void *callback_ctx, void *data, int len)
2517 assert(!"We shouldn't be here");
2521 * Receive a block of data from the SSH link. Block until all data
2524 * To do this, we repeatedly call the SSH protocol module, with our
2525 * own trap in from_backend() to catch the data that comes back. We
2526 * do this until we have enough data.
2529 static unsigned char *outptr; /* where to put the data */
2530 static unsigned outlen; /* how much data required */
2531 static unsigned char *pending = NULL; /* any spare data */
2532 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2533 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2535 unsigned char *p = (unsigned char *) data;
2536 unsigned len = (unsigned) datalen;
2539 * stderr data is just spouted to local stderr and otherwise
2544 if (fwrite(data, 1, len, stderr) < len)
2550 * If this is before the real session begins, just return.
2555 if ((outlen > 0) && (len > 0)) {
2556 unsigned used = outlen;
2559 memcpy(outptr, p, used);
2567 if (pendsize < pendlen + len) {
2568 pendsize = pendlen + len + 4096;
2569 pending = sresize(pending, pendsize, unsigned char);
2571 memcpy(pending + pendlen, p, len);
2577 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2580 * No "untrusted" output should get here (the way the code is
2581 * currently, it's all diverted by FLAG_STDERR).
2583 assert(!"Unexpected call to from_backend_untrusted()");
2584 return 0; /* not reached */
2586 int from_backend_eof(void *frontend)
2589 * We expect to be the party deciding when to close the
2590 * connection, so if we see EOF before we sent it ourselves, we
2594 connection_fatal(frontend,
2595 "Received unexpected end-of-file from SFTP server");
2599 int sftp_recvdata(char *buf, int len)
2601 outptr = (unsigned char *) buf;
2605 * See if the pending-input block contains some of what we
2609 unsigned pendused = pendlen;
2610 if (pendused > outlen)
2612 memcpy(outptr, pending, pendused);
2613 memmove(pending, pending + pendused, pendlen - pendused);
2616 pendlen -= pendused;
2626 while (outlen > 0) {
2627 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2628 return 0; /* doom */
2633 int sftp_senddata(char *buf, int len)
2635 back->send(backhandle, buf, len);
2640 * Short description of parameters.
2642 static void usage(void)
2644 printf("PuTTY Secure File Transfer (SFTP) client\n");
2645 printf("%s\n", ver);
2646 printf("Usage: psftp [options] [user@]host\n");
2647 printf("Options:\n");
2648 printf(" -V print version information and exit\n");
2649 printf(" -pgpfp print PGP key fingerprints and exit\n");
2650 printf(" -b file use specified batchfile\n");
2651 printf(" -bc output batchfile commands\n");
2652 printf(" -be don't stop batchfile processing if errors\n");
2653 printf(" -v show verbose messages\n");
2654 printf(" -load sessname Load settings from saved session\n");
2655 printf(" -l user connect with specified username\n");
2656 printf(" -P port connect to specified port\n");
2657 printf(" -pw passw login with specified password\n");
2658 printf(" -1 -2 force use of particular SSH protocol version\n");
2659 printf(" -4 -6 force use of IPv4 or IPv6\n");
2660 printf(" -C enable compression\n");
2661 printf(" -i key private key file for authentication\n");
2662 printf(" -noagent disable use of Pageant\n");
2663 printf(" -agent enable use of Pageant\n");
2664 printf(" -batch disable all interactive prompts\n");
2668 static void version(void)
2670 printf("psftp: %s\n", ver);
2675 * Connect to a host.
2677 static int psftp_connect(char *userhost, char *user, int portnumber)
2679 char *host, *realhost;
2683 /* Separate host and username */
2685 host = strrchr(host, '@');
2691 printf("psftp: multiple usernames specified; using \"%s\"\n",
2698 * If we haven't loaded session details already (e.g., from -load),
2699 * try looking for a session called "host".
2701 if (!loaded_session) {
2702 /* Try to load settings for `host' into a temporary config */
2703 Conf *conf2 = conf_new();
2704 conf_set_str(conf2, CONF_host, "");
2705 do_defaults(host, conf2);
2706 if (conf_get_str(conf2, CONF_host)[0] != '\0') {
2707 /* Settings present and include hostname */
2708 /* Re-load data into the real config. */
2709 do_defaults(host, conf);
2711 /* Session doesn't exist or mention a hostname. */
2712 /* Use `host' as a bare hostname. */
2713 conf_set_str(conf, CONF_host, host);
2716 /* Patch in hostname `host' to session details. */
2717 conf_set_str(conf, CONF_host, host);
2721 * Force use of SSH. (If they got the protocol wrong we assume the
2722 * port is useless too.)
2724 if (conf_get_int(conf, CONF_protocol) != PROT_SSH) {
2725 conf_set_int(conf, CONF_protocol, PROT_SSH);
2726 conf_set_int(conf, CONF_port, 22);
2730 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2731 * then change it to SSH-2, on the grounds that that's more likely to
2732 * work for SFTP. (Can be overridden with `-1' option.)
2733 * But if it says `2 only' or `2', respect which.
2735 if ((conf_get_int(conf, CONF_sshprot) & ~1) != 2) /* is it 2 or 3? */
2736 conf_set_int(conf, CONF_sshprot, 2);
2739 * Enact command-line overrides.
2741 cmdline_run_saved(conf);
2744 * Muck about with the hostname in various ways.
2747 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
2748 char *host = hostbuf;
2752 * Trim leading whitespace.
2754 host += strspn(host, " \t");
2757 * See if host is of the form user@host, and separate out
2758 * the username if so.
2760 if (host[0] != '\0') {
2761 char *atsign = strrchr(host, '@');
2764 conf_set_str(conf, CONF_username, host);
2770 * Remove any remaining whitespace.
2775 if (*q != ' ' && *q != '\t')
2781 conf_set_str(conf, CONF_host, hostbuf);
2786 if (user != NULL && user[0] != '\0') {
2787 conf_set_str(conf, CONF_username, user);
2791 conf_set_int(conf, CONF_port, portnumber);
2794 * Disable scary things which shouldn't be enabled for simple
2795 * things like SCP and SFTP: agent forwarding, port forwarding,
2798 conf_set_int(conf, CONF_x11_forward, 0);
2799 conf_set_int(conf, CONF_agentfwd, 0);
2800 conf_set_int(conf, CONF_ssh_simple, TRUE);
2803 while ((key = conf_get_str_nthstrkey(conf, CONF_portfwd, 0)) != NULL)
2804 conf_del_str_str(conf, CONF_portfwd, key);
2807 /* Set up subsystem name. */
2808 conf_set_str(conf, CONF_remote_cmd, "sftp");
2809 conf_set_int(conf, CONF_ssh_subsys, TRUE);
2810 conf_set_int(conf, CONF_nopty, TRUE);
2813 * Set up fallback option, for SSH-1 servers or servers with the
2814 * sftp subsystem not enabled but the server binary installed
2815 * in the usual place. We only support fallback on Unix
2816 * systems, and we use a kludgy piece of shellery which should
2817 * try to find sftp-server in various places (the obvious
2818 * systemwide spots /usr/lib and /usr/local/lib, and then the
2819 * user's PATH) and finally give up.
2821 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2822 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2825 * the idea being that this will attempt to use either of the
2826 * obvious pathnames and then give up, and when it does give up
2827 * it will print the preferred pathname in the error messages.
2829 conf_set_str(conf, CONF_remote_cmd2,
2830 "test -x /usr/lib/sftp-server &&"
2831 " exec /usr/lib/sftp-server\n"
2832 "test -x /usr/local/lib/sftp-server &&"
2833 " exec /usr/local/lib/sftp-server\n"
2834 "exec sftp-server");
2835 conf_set_int(conf, CONF_ssh_subsys2, FALSE);
2837 back = &ssh_backend;
2839 err = back->init(NULL, &backhandle, conf,
2840 conf_get_str(conf, CONF_host),
2841 conf_get_int(conf, CONF_port),
2843 conf_get_int(conf, CONF_tcp_keepalives));
2845 fprintf(stderr, "ssh_init: %s\n", err);
2848 logctx = log_init(NULL, conf);
2849 back->provide_logctx(backhandle, logctx);
2850 console_provide_logctx(logctx);
2851 while (!back->sendok(backhandle)) {
2852 if (back->exitcode(backhandle) >= 0)
2854 if (ssh_sftp_loop_iteration() < 0) {
2855 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2859 if (verbose && realhost != NULL)
2860 printf("Connected to %s\n", realhost);
2861 if (realhost != NULL)
2866 void cmdline_error(char *p, ...)
2869 fprintf(stderr, "psftp: ");
2871 vfprintf(stderr, p, ap);
2873 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2878 * Main program. Parse arguments etc.
2880 int psftp_main(int argc, char *argv[])
2884 char *userhost, *user;
2887 char *batchfile = NULL;
2889 flags = FLAG_STDERR | FLAG_INTERACTIVE
2890 #ifdef FLAG_SYNCAGENT
2894 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2897 userhost = user = NULL;
2899 /* Load Default Settings before doing anything else. */
2901 do_defaults(NULL, conf);
2902 loaded_session = FALSE;
2904 for (i = 1; i < argc; i++) {
2906 if (argv[i][0] != '-') {
2910 userhost = dupstr(argv[i]);
2913 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, conf);
2915 cmdline_error("option \"%s\" requires an argument", argv[i]);
2916 } else if (ret == 2) {
2917 i++; /* skip next argument */
2918 } else if (ret == 1) {
2919 /* We have our own verbosity in addition to `flags'. */
2920 if (flags & FLAG_VERBOSE)
2922 } else if (strcmp(argv[i], "-h") == 0 ||
2923 strcmp(argv[i], "-?") == 0) {
2925 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2928 } else if (strcmp(argv[i], "-V") == 0) {
2930 } else if (strcmp(argv[i], "-batch") == 0) {
2931 console_batch_mode = 1;
2932 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2934 batchfile = argv[++i];
2935 } else if (strcmp(argv[i], "-bc") == 0) {
2936 modeflags = modeflags | 1;
2937 } else if (strcmp(argv[i], "-be") == 0) {
2938 modeflags = modeflags | 2;
2939 } else if (strcmp(argv[i], "--") == 0) {
2943 cmdline_error("unknown option \"%s\"", argv[i]);
2951 * If the loaded session provides a hostname, and a hostname has not
2952 * otherwise been specified, pop it in `userhost' so that
2953 * `psftp -load sessname' is sufficient to start a session.
2955 if (!userhost && conf_get_str(conf, CONF_host)[0] != '\0') {
2956 userhost = dupstr(conf_get_str(conf, CONF_host));
2960 * If a user@host string has already been provided, connect to
2965 ret = psftp_connect(userhost, user, portnumber);
2972 printf("psftp: no hostname specified; use \"open host.name\""
2976 do_sftp(mode, modeflags, batchfile);
2978 if (back != NULL && back->connected(backhandle)) {
2980 back->special(backhandle, TS_EOF);
2982 sftp_recvdata(&ch, 1);
2987 console_provide_logctx(NULL);