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;
41 /* ----------------------------------------------------------------------
42 * Higher-level helper functions used in commands.
46 * Attempt to canonify a pathname starting from the pwd. If
47 * canonification fails, at least fall back to returning a _valid_
48 * pathname (though it may be ugly, eg /home/simon/../foobar).
50 char *canonify(char *name)
52 char *fullname, *canonname;
53 struct sftp_packet *pktin;
54 struct sftp_request *req, *rreq;
57 fullname = dupstr(name);
60 if (pwd[strlen(pwd) - 1] == '/')
64 fullname = dupcat(pwd, slash, name, NULL);
67 sftp_register(req = fxp_realpath_send(fullname));
68 rreq = sftp_find_request(pktin = sftp_recv());
70 canonname = fxp_realpath_recv(pktin, rreq);
77 * Attempt number 2. Some FXP_REALPATH implementations
78 * (glibc-based ones, in particular) require the _whole_
79 * path to point to something that exists, whereas others
80 * (BSD-based) only require all but the last component to
81 * exist. So if the first call failed, we should strip off
82 * everything from the last slash onwards and try again,
83 * then put the final component back on.
87 * - if the last component is "/." or "/..", then we don't
88 * bother trying this because there's no way it can work.
90 * - if the thing actually ends with a "/", we remove it
91 * before we start. Except if the string is "/" itself
92 * (although I can't see why we'd have got here if so,
93 * because surely "/" would have worked the first
94 * time?), in which case we don't bother.
96 * - if there's no slash in the string at all, give up in
97 * confusion (we expect at least one because of the way
98 * we constructed the string).
104 i = strlen(fullname);
105 if (i > 2 && fullname[i - 1] == '/')
106 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
107 while (i > 0 && fullname[--i] != '/');
110 * Give up on special cases.
112 if (fullname[i] != '/' || /* no slash at all */
113 !strcmp(fullname + i, "/.") || /* ends in /. */
114 !strcmp(fullname + i, "/..") || /* ends in /.. */
115 !strcmp(fullname, "/")) {
120 * Now i points at the slash. Deal with the final special
121 * case i==0 (ie the whole path was "/nonexistentfile").
123 fullname[i] = '\0'; /* separate the string */
125 sftp_register(req = fxp_realpath_send("/"));
127 sftp_register(req = fxp_realpath_send(fullname));
129 rreq = sftp_find_request(pktin = sftp_recv());
131 canonname = fxp_realpath_recv(pktin, rreq);
134 /* Even that failed. Restore our best guess at the
135 * constructed filename and give up */
136 fullname[i] = '/'; /* restore slash and last component */
141 * We have a canonical name for all but the last path
142 * component. Concatenate the last component and return.
144 returnname = dupcat(canonname,
145 canonname[strlen(canonname) - 1] ==
146 '/' ? "" : "/", fullname + i + 1, NULL);
154 * Return a pointer to the portion of str that comes after the last
155 * slash (or backslash or colon, if `local' is TRUE).
157 static char *stripslashes(char *str, int local)
162 p = strchr(str, ':');
166 p = strrchr(str, '/');
170 p = strrchr(str, '\\');
178 * qsort comparison routine for fxp_name structures. Sorts by real
181 static int sftp_name_compare(const void *av, const void *bv)
183 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
184 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
185 return strcmp((*a)->filename, (*b)->filename);
189 * Likewise, but for a bare char *.
191 static int bare_name_compare(const void *av, const void *bv)
193 const char **a = (const char **) av;
194 const char **b = (const char **) bv;
195 return strcmp(*a, *b);
198 static void not_connected(void)
200 printf("psftp: not connected to a host; use \"open host.name\"\n");
203 /* ----------------------------------------------------------------------
204 * The meat of the `get' and `put' commands.
206 int sftp_get_file(char *fname, char *outfname, int recurse, int restart)
208 struct fxp_handle *fh;
209 struct sftp_packet *pktin;
210 struct sftp_request *req, *rreq;
211 struct fxp_xfer *xfer;
214 int ret, shown_err = FALSE;
217 * In recursive mode, see if we're dealing with a directory.
218 * (If we're not in recursive mode, we need not even check: the
219 * subsequent FXP_OPEN will return a usable error message.)
222 struct fxp_attrs attrs;
225 sftp_register(req = fxp_stat_send(fname));
226 rreq = sftp_find_request(pktin = sftp_recv());
228 result = fxp_stat_recv(pktin, rreq, &attrs);
231 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
232 (attrs.permissions & 0040000)) {
234 struct fxp_handle *dirhandle;
235 int nnames, namesize;
236 struct fxp_name **ournames;
237 struct fxp_names *names;
241 * First, attempt to create the destination directory,
242 * unless it already exists.
244 if (file_type(outfname) != FILE_TYPE_DIRECTORY &&
245 !create_directory(outfname)) {
246 printf("%s: Cannot create directory\n", outfname);
251 * Now get the list of filenames in the remote
254 sftp_register(req = fxp_opendir_send(fname));
255 rreq = sftp_find_request(pktin = sftp_recv());
257 dirhandle = fxp_opendir_recv(pktin, rreq);
260 printf("%s: unable to open directory: %s\n",
264 nnames = namesize = 0;
269 sftp_register(req = fxp_readdir_send(dirhandle));
270 rreq = sftp_find_request(pktin = sftp_recv());
272 names = fxp_readdir_recv(pktin, rreq);
275 if (fxp_error_type() == SSH_FX_EOF)
277 printf("%s: reading directory: %s\n", fname, fxp_error());
281 if (names->nnames == 0) {
282 fxp_free_names(names);
285 if (nnames + names->nnames >= namesize) {
286 namesize += names->nnames + 128;
287 ournames = sresize(ournames, namesize, struct fxp_name *);
289 for (i = 0; i < names->nnames; i++)
290 if (strcmp(names->names[i].filename, ".") &&
291 strcmp(names->names[i].filename, "..")) {
292 if (!vet_filename(names->names[i].filename)) {
293 printf("ignoring potentially dangerous server-"
294 "supplied filename '%s'\n",
295 names->names[i].filename);
298 fxp_dup_name(&names->names[i]);
301 fxp_free_names(names);
303 sftp_register(req = fxp_close_send(dirhandle));
304 rreq = sftp_find_request(pktin = sftp_recv());
306 fxp_close_recv(pktin, rreq);
309 * Sort the names into a clear order. This ought to
310 * make things more predictable when we're doing a
311 * reget of the same directory, just in case two
312 * readdirs on the same remote directory return a
315 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
318 * If we're in restart mode, find the last filename on
319 * this list that already exists. We may have to do a
320 * reget on _that_ file, but shouldn't have to do
321 * anything on the previous files.
323 * If none of them exists, of course, we start at 0.
331 nextoutfname = dir_file_cat(outfname,
332 ournames[i]->filename);
334 nextoutfname = dupstr(ournames[i]->filename);
335 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
346 * Now we're ready to recurse. Starting at ournames[i]
347 * and continuing on to the end of the list, we
348 * construct a new source and target file name, and
349 * call sftp_get_file again.
351 for (; i < nnames; i++) {
352 char *nextfname, *nextoutfname;
355 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
357 nextoutfname = dir_file_cat(outfname,
358 ournames[i]->filename);
360 nextoutfname = dupstr(ournames[i]->filename);
361 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
362 restart = FALSE; /* after first partial file, do full */
366 for (i = 0; i < nnames; i++) {
367 fxp_free_name(ournames[i]);
375 * Done this recursion level. Free everything.
377 for (i = 0; i < nnames; i++) {
378 fxp_free_name(ournames[i]);
386 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
387 rreq = sftp_find_request(pktin = sftp_recv());
389 fh = fxp_open_recv(pktin, rreq);
392 printf("%s: open for read: %s\n", fname, fxp_error());
397 file = open_existing_wfile(outfname, NULL);
399 file = open_new_file(outfname);
403 printf("local: unable to open %s\n", outfname);
405 sftp_register(req = fxp_close_send(fh));
406 rreq = sftp_find_request(pktin = sftp_recv());
408 fxp_close_recv(pktin, rreq);
415 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
417 printf("reget: cannot restart %s - file too large\n",
419 sftp_register(req = fxp_close_send(fh));
420 rreq = sftp_find_request(pktin = sftp_recv());
422 fxp_close_recv(pktin, rreq);
427 offset = get_file_posn(file);
428 uint64_decimal(offset, decbuf);
429 printf("reget: restarting at file position %s\n", decbuf);
431 offset = uint64_make(0, 0);
434 printf("remote:%s => local:%s\n", fname, outfname);
437 * FIXME: we can use FXP_FSTAT here to get the file size, and
438 * thus put up a progress bar.
441 xfer = xfer_download_init(fh, offset);
442 while (!xfer_done(xfer)) {
447 xfer_download_queue(xfer);
449 ret = xfer_download_gotpkt(xfer, pktin);
453 printf("error while reading: %s\n", fxp_error());
459 while (xfer_download_data(xfer, &vbuf, &len)) {
460 unsigned char *buf = (unsigned char *)vbuf;
464 wlen = write_to_file(file, buf + wpos, len - wpos);
466 printf("error while writing local file\n");
468 xfer_set_error(xfer);
473 if (wpos < len) { /* we had an error */
475 xfer_set_error(xfer);
486 sftp_register(req = fxp_close_send(fh));
487 rreq = sftp_find_request(pktin = sftp_recv());
489 fxp_close_recv(pktin, rreq);
494 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
496 struct fxp_handle *fh;
497 struct fxp_xfer *xfer;
498 struct sftp_packet *pktin;
499 struct sftp_request *req, *rreq;
505 * In recursive mode, see if we're dealing with a directory.
506 * (If we're not in recursive mode, we need not even check: the
507 * subsequent fopen will return an error message.)
509 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
510 struct fxp_attrs attrs;
512 int nnames, namesize;
513 char *name, **ournames;
518 * First, attempt to create the destination directory,
519 * unless it already exists.
521 sftp_register(req = fxp_stat_send(outfname));
522 rreq = sftp_find_request(pktin = sftp_recv());
524 result = fxp_stat_recv(pktin, rreq, &attrs);
526 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
527 !(attrs.permissions & 0040000)) {
528 sftp_register(req = fxp_mkdir_send(outfname));
529 rreq = sftp_find_request(pktin = sftp_recv());
531 result = fxp_mkdir_recv(pktin, rreq);
534 printf("%s: create directory: %s\n",
535 outfname, fxp_error());
541 * Now get the list of filenames in the local directory.
543 nnames = namesize = 0;
546 dh = open_directory(fname);
548 printf("%s: unable to open directory\n", fname);
551 while ((name = read_filename(dh)) != NULL) {
552 if (nnames >= namesize) {
554 ournames = sresize(ournames, namesize, char *);
556 ournames[nnames++] = name;
561 * Sort the names into a clear order. This ought to make
562 * things more predictable when we're doing a reput of the
563 * same directory, just in case two readdirs on the same
564 * local directory return a different order.
566 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
569 * If we're in restart mode, find the last filename on this
570 * list that already exists. We may have to do a reput on
571 * _that_ file, but shouldn't have to do anything on the
574 * If none of them exists, of course, we start at 0.
580 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
581 sftp_register(req = fxp_stat_send(nextoutfname));
582 rreq = sftp_find_request(pktin = sftp_recv());
584 result = fxp_stat_recv(pktin, rreq, &attrs);
595 * Now we're ready to recurse. Starting at ournames[i]
596 * and continuing on to the end of the list, we
597 * construct a new source and target file name, and
598 * call sftp_put_file again.
600 for (; i < nnames; i++) {
601 char *nextfname, *nextoutfname;
605 nextfname = dir_file_cat(fname, ournames[i]);
607 nextfname = dupstr(ournames[i]);
608 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
609 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
610 restart = FALSE; /* after first partial file, do full */
614 for (i = 0; i < nnames; i++) {
623 * Done this recursion level. Free everything.
625 for (i = 0; i < nnames; i++) {
633 file = open_existing_file(fname, NULL, NULL, NULL);
635 printf("local: unable to open %s\n", fname);
639 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
641 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
642 SSH_FXF_CREAT | SSH_FXF_TRUNC));
644 rreq = sftp_find_request(pktin = sftp_recv());
646 fh = fxp_open_recv(pktin, rreq);
650 printf("%s: open for write: %s\n", outfname, fxp_error());
656 struct fxp_attrs attrs;
659 sftp_register(req = fxp_fstat_send(fh));
660 rreq = sftp_find_request(pktin = sftp_recv());
662 ret = fxp_fstat_recv(pktin, rreq, &attrs);
666 printf("read size of %s: %s\n", outfname, fxp_error());
669 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
671 printf("read size of %s: size was not given\n", outfname);
675 uint64_decimal(offset, decbuf);
676 printf("reput: restarting at file position %s\n", decbuf);
678 if (seek_file((WFile *)file, offset, FROM_START) != 0)
679 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
681 offset = uint64_make(0, 0);
684 printf("local:%s => remote:%s\n", fname, outfname);
687 * FIXME: we can use FXP_FSTAT here to get the file size, and
688 * thus put up a progress bar.
691 xfer = xfer_upload_init(fh, offset);
693 while ((!err && !eof) || !xfer_done(xfer)) {
697 while (xfer_upload_ready(xfer) && !err && !eof) {
698 len = read_from_file(file, buffer, sizeof(buffer));
700 printf("error while reading local file\n");
702 } else if (len == 0) {
705 xfer_upload_data(xfer, buffer, len);
709 if (!xfer_done(xfer)) {
711 ret = xfer_upload_gotpkt(xfer, pktin);
712 if (ret <= 0 && !err) {
713 printf("error while writing: %s\n", fxp_error());
721 sftp_register(req = fxp_close_send(fh));
722 rreq = sftp_find_request(pktin = sftp_recv());
724 fxp_close_recv(pktin, rreq);
731 /* ----------------------------------------------------------------------
732 * A remote wildcard matcher, providing a similar interface to the
733 * local one in psftp.h.
736 typedef struct SftpWildcardMatcher {
737 struct fxp_handle *dirh;
738 struct fxp_names *names;
740 char *wildcard, *prefix;
741 } SftpWildcardMatcher;
743 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
745 struct sftp_packet *pktin;
746 struct sftp_request *req, *rreq;
748 char *unwcdir, *tmpdir, *cdir;
750 SftpWildcardMatcher *swcm;
751 struct fxp_handle *dirh;
754 * We don't handle multi-level wildcards; so we expect to find
755 * a fully specified directory part, followed by a wildcard
758 wildcard = stripslashes(name, 0);
760 unwcdir = dupstr(name);
761 len = wildcard - name;
763 if (len > 0 && unwcdir[len-1] == '/')
764 unwcdir[len-1] = '\0';
765 tmpdir = snewn(1 + len, char);
766 check = wc_unescape(tmpdir, unwcdir);
770 printf("Multiple-level wildcards are not supported\n");
775 cdir = canonify(unwcdir);
777 sftp_register(req = fxp_opendir_send(cdir));
778 rreq = sftp_find_request(pktin = sftp_recv());
780 dirh = fxp_opendir_recv(pktin, rreq);
783 swcm = snew(SftpWildcardMatcher);
786 swcm->wildcard = dupstr(wildcard);
787 swcm->prefix = unwcdir;
789 printf("Unable to open %s: %s\n", cdir, fxp_error());
799 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
801 struct fxp_name *name;
802 struct sftp_packet *pktin;
803 struct sftp_request *req, *rreq;
806 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
807 fxp_free_names(swcm->names);
812 sftp_register(req = fxp_readdir_send(swcm->dirh));
813 rreq = sftp_find_request(pktin = sftp_recv());
815 swcm->names = fxp_readdir_recv(pktin, rreq);
818 if (fxp_error_type() != SSH_FX_EOF)
819 printf("%s: reading directory: %s\n", swcm->prefix,
827 assert(swcm->names && swcm->namepos < swcm->names->nnames);
829 name = &swcm->names->names[swcm->namepos++];
831 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
832 continue; /* expected bad filenames */
834 if (!vet_filename(name->filename)) {
835 printf("ignoring potentially dangerous server-"
836 "supplied filename '%s'\n", name->filename);
837 continue; /* unexpected bad filename */
840 if (!wc_match(swcm->wildcard, name->filename))
841 continue; /* doesn't match the wildcard */
844 * We have a working filename. Return it.
846 return dupprintf("%s%s%s", swcm->prefix,
848 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
854 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
856 struct sftp_packet *pktin;
857 struct sftp_request *req, *rreq;
859 sftp_register(req = fxp_close_send(swcm->dirh));
860 rreq = sftp_find_request(pktin = sftp_recv());
862 fxp_close_recv(pktin, rreq);
865 fxp_free_names(swcm->names);
868 sfree(swcm->wildcard);
874 * General function to match a potential wildcard in a filename
875 * argument and iterate over every matching file. Used in several
876 * PSFTP commands (rmdir, rm, chmod, mv).
878 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
880 char *unwcfname, *newname, *cname;
883 unwcfname = snewn(strlen(filename)+1, char);
884 is_wc = !wc_unescape(unwcfname, filename);
887 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
896 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
897 cname = canonify(newname);
899 printf("%s: canonify: %s\n", newname, fxp_error());
903 ret &= func(ctx, cname);
908 /* Politely warn the user that nothing matched. */
909 printf("%s: nothing matched\n", filename);
912 sftp_finish_wildcard_matching(swcm);
914 cname = canonify(unwcfname);
916 printf("%s: canonify: %s\n", filename, fxp_error());
919 ret = func(ctx, cname);
928 * Handy helper function.
930 int is_wildcard(char *name)
932 char *unwcfname = snewn(strlen(name)+1, char);
933 int is_wc = !wc_unescape(unwcfname, name);
938 /* ----------------------------------------------------------------------
939 * Actual sftp commands.
941 struct sftp_command {
943 int nwords, wordssize;
944 int (*obey) (struct sftp_command *); /* returns <0 to quit */
947 int sftp_cmd_null(struct sftp_command *cmd)
949 return 1; /* success */
952 int sftp_cmd_unknown(struct sftp_command *cmd)
954 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
955 return 0; /* failure */
958 int sftp_cmd_quit(struct sftp_command *cmd)
963 int sftp_cmd_close(struct sftp_command *cmd)
970 if (back != NULL && back->connected(backhandle)) {
972 back->special(backhandle, TS_EOF);
973 sftp_recvdata(&ch, 1);
981 * List a directory. If no arguments are given, list pwd; otherwise
982 * list the directory given in words[1].
984 int sftp_cmd_ls(struct sftp_command *cmd)
986 struct fxp_handle *dirh;
987 struct fxp_names *names;
988 struct fxp_name **ournames;
989 int nnames, namesize;
990 char *dir, *cdir, *unwcdir, *wildcard;
991 struct sftp_packet *pktin;
992 struct sftp_request *req, *rreq;
1000 if (cmd->nwords < 2)
1003 dir = cmd->words[1];
1005 unwcdir = snewn(1 + strlen(dir), char);
1006 if (wc_unescape(unwcdir, dir)) {
1013 wildcard = stripslashes(dir, 0);
1014 unwcdir = dupstr(dir);
1015 len = wildcard - dir;
1016 unwcdir[len] = '\0';
1017 if (len > 0 && unwcdir[len-1] == '/')
1018 unwcdir[len-1] = '\0';
1019 tmpdir = snewn(1 + len, char);
1020 check = wc_unescape(tmpdir, unwcdir);
1023 printf("Multiple-level wildcards are not supported\n");
1030 cdir = canonify(dir);
1032 printf("%s: canonify: %s\n", dir, fxp_error());
1037 printf("Listing directory %s\n", cdir);
1039 sftp_register(req = fxp_opendir_send(cdir));
1040 rreq = sftp_find_request(pktin = sftp_recv());
1041 assert(rreq == req);
1042 dirh = fxp_opendir_recv(pktin, rreq);
1045 printf("Unable to open %s: %s\n", dir, fxp_error());
1047 nnames = namesize = 0;
1052 sftp_register(req = fxp_readdir_send(dirh));
1053 rreq = sftp_find_request(pktin = sftp_recv());
1054 assert(rreq == req);
1055 names = fxp_readdir_recv(pktin, rreq);
1057 if (names == NULL) {
1058 if (fxp_error_type() == SSH_FX_EOF)
1060 printf("Reading directory %s: %s\n", dir, fxp_error());
1063 if (names->nnames == 0) {
1064 fxp_free_names(names);
1068 if (nnames + names->nnames >= namesize) {
1069 namesize += names->nnames + 128;
1070 ournames = sresize(ournames, namesize, struct fxp_name *);
1073 for (i = 0; i < names->nnames; i++)
1074 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1075 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1077 fxp_free_names(names);
1079 sftp_register(req = fxp_close_send(dirh));
1080 rreq = sftp_find_request(pktin = sftp_recv());
1081 assert(rreq == req);
1082 fxp_close_recv(pktin, rreq);
1085 * Now we have our filenames. Sort them by actual file
1086 * name, and then output the longname parts.
1088 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1093 for (i = 0; i < nnames; i++) {
1094 printf("%s\n", ournames[i]->longname);
1095 fxp_free_name(ournames[i]);
1107 * Change directories. We do this by canonifying the new name, then
1108 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1110 int sftp_cmd_cd(struct sftp_command *cmd)
1112 struct fxp_handle *dirh;
1113 struct sftp_packet *pktin;
1114 struct sftp_request *req, *rreq;
1122 if (cmd->nwords < 2)
1123 dir = dupstr(homedir);
1125 dir = canonify(cmd->words[1]);
1128 printf("%s: canonify: %s\n", dir, fxp_error());
1132 sftp_register(req = fxp_opendir_send(dir));
1133 rreq = sftp_find_request(pktin = sftp_recv());
1134 assert(rreq == req);
1135 dirh = fxp_opendir_recv(pktin, rreq);
1138 printf("Directory %s: %s\n", dir, fxp_error());
1143 sftp_register(req = fxp_close_send(dirh));
1144 rreq = sftp_find_request(pktin = sftp_recv());
1145 assert(rreq == req);
1146 fxp_close_recv(pktin, rreq);
1150 printf("Remote directory is now %s\n", pwd);
1156 * Print current directory. Easy as pie.
1158 int sftp_cmd_pwd(struct sftp_command *cmd)
1165 printf("Remote directory is %s\n", pwd);
1170 * Get a file and save it at the local end. We have three very
1171 * similar commands here. The basic one is `get'; `reget' differs
1172 * in that it checks for the existence of the destination file and
1173 * starts from where a previous aborted transfer left off; `mget'
1174 * differs in that it interprets all its arguments as files to
1175 * transfer (never as a different local name for a remote file) and
1176 * can handle wildcards.
1178 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1180 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1182 int recurse = FALSE;
1190 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1191 if (!strcmp(cmd->words[i], "--")) {
1192 /* finish processing options */
1195 } else if (!strcmp(cmd->words[i], "-r")) {
1198 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1204 if (i >= cmd->nwords) {
1205 printf("%s: expects a filename\n", cmd->words[0]);
1211 SftpWildcardMatcher *swcm;
1213 origfname = cmd->words[i++];
1214 unwcfname = snewn(strlen(origfname)+1, char);
1216 if (multiple && !wc_unescape(unwcfname, origfname)) {
1217 swcm = sftp_begin_wildcard_matching(origfname);
1222 origwfname = sftp_wildcard_get_filename(swcm);
1224 /* Politely warn the user that nothing matched. */
1225 printf("%s: nothing matched\n", origfname);
1226 sftp_finish_wildcard_matching(swcm);
1231 origwfname = origfname;
1235 while (origwfname) {
1236 fname = canonify(origwfname);
1239 printf("%s: canonify: %s\n", origwfname, fxp_error());
1244 if (!multiple && i < cmd->nwords)
1245 outfname = cmd->words[i++];
1247 outfname = stripslashes(origwfname, 0);
1249 ret = sftp_get_file(fname, outfname, recurse, restart);
1255 origwfname = sftp_wildcard_get_filename(swcm);
1262 sftp_finish_wildcard_matching(swcm);
1266 } while (multiple && i < cmd->nwords);
1270 int sftp_cmd_get(struct sftp_command *cmd)
1272 return sftp_general_get(cmd, 0, 0);
1274 int sftp_cmd_mget(struct sftp_command *cmd)
1276 return sftp_general_get(cmd, 0, 1);
1278 int sftp_cmd_reget(struct sftp_command *cmd)
1280 return sftp_general_get(cmd, 1, 0);
1284 * Send a file and store it at the remote end. We have three very
1285 * similar commands here. The basic one is `put'; `reput' differs
1286 * in that it checks for the existence of the destination file and
1287 * starts from where a previous aborted transfer left off; `mput'
1288 * differs in that it interprets all its arguments as files to
1289 * transfer (never as a different remote name for a local file) and
1290 * can handle wildcards.
1292 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1294 char *fname, *wfname, *origoutfname, *outfname;
1296 int recurse = FALSE;
1304 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1305 if (!strcmp(cmd->words[i], "--")) {
1306 /* finish processing options */
1309 } else if (!strcmp(cmd->words[i], "-r")) {
1312 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1318 if (i >= cmd->nwords) {
1319 printf("%s: expects a filename\n", cmd->words[0]);
1325 WildcardMatcher *wcm;
1326 fname = cmd->words[i++];
1328 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1329 wcm = begin_wildcard_matching(fname);
1330 wfname = wildcard_get_filename(wcm);
1332 /* Politely warn the user that nothing matched. */
1333 printf("%s: nothing matched\n", fname);
1334 finish_wildcard_matching(wcm);
1343 if (!multiple && i < cmd->nwords)
1344 origoutfname = cmd->words[i++];
1346 origoutfname = stripslashes(wfname, 1);
1348 outfname = canonify(origoutfname);
1350 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1353 finish_wildcard_matching(wcm);
1357 ret = sftp_put_file(wfname, outfname, recurse, restart);
1362 wfname = wildcard_get_filename(wcm);
1369 finish_wildcard_matching(wcm);
1374 } while (multiple && i < cmd->nwords);
1378 int sftp_cmd_put(struct sftp_command *cmd)
1380 return sftp_general_put(cmd, 0, 0);
1382 int sftp_cmd_mput(struct sftp_command *cmd)
1384 return sftp_general_put(cmd, 0, 1);
1386 int sftp_cmd_reput(struct sftp_command *cmd)
1388 return sftp_general_put(cmd, 1, 0);
1391 int sftp_cmd_mkdir(struct sftp_command *cmd)
1394 struct sftp_packet *pktin;
1395 struct sftp_request *req, *rreq;
1404 if (cmd->nwords < 2) {
1405 printf("mkdir: expects a directory\n");
1410 for (i = 1; i < cmd->nwords; i++) {
1411 dir = canonify(cmd->words[i]);
1413 printf("%s: canonify: %s\n", dir, fxp_error());
1417 sftp_register(req = fxp_mkdir_send(dir));
1418 rreq = sftp_find_request(pktin = sftp_recv());
1419 assert(rreq == req);
1420 result = fxp_mkdir_recv(pktin, rreq);
1423 printf("mkdir %s: %s\n", dir, fxp_error());
1426 printf("mkdir %s: OK\n", dir);
1434 static int sftp_action_rmdir(void *vctx, char *dir)
1436 struct sftp_packet *pktin;
1437 struct sftp_request *req, *rreq;
1440 sftp_register(req = fxp_rmdir_send(dir));
1441 rreq = sftp_find_request(pktin = sftp_recv());
1442 assert(rreq == req);
1443 result = fxp_rmdir_recv(pktin, rreq);
1446 printf("rmdir %s: %s\n", dir, fxp_error());
1450 printf("rmdir %s: OK\n", dir);
1455 int sftp_cmd_rmdir(struct sftp_command *cmd)
1464 if (cmd->nwords < 2) {
1465 printf("rmdir: expects a directory\n");
1470 for (i = 1; i < cmd->nwords; i++)
1471 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1476 static int sftp_action_rm(void *vctx, char *fname)
1478 struct sftp_packet *pktin;
1479 struct sftp_request *req, *rreq;
1482 sftp_register(req = fxp_remove_send(fname));
1483 rreq = sftp_find_request(pktin = sftp_recv());
1484 assert(rreq == req);
1485 result = fxp_remove_recv(pktin, rreq);
1488 printf("rm %s: %s\n", fname, fxp_error());
1492 printf("rm %s: OK\n", fname);
1497 int sftp_cmd_rm(struct sftp_command *cmd)
1506 if (cmd->nwords < 2) {
1507 printf("rm: expects a filename\n");
1512 for (i = 1; i < cmd->nwords; i++)
1513 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1518 static int check_is_dir(char *dstfname)
1520 struct sftp_packet *pktin;
1521 struct sftp_request *req, *rreq;
1522 struct fxp_attrs attrs;
1525 sftp_register(req = fxp_stat_send(dstfname));
1526 rreq = sftp_find_request(pktin = sftp_recv());
1527 assert(rreq == req);
1528 result = fxp_stat_recv(pktin, rreq, &attrs);
1531 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1532 (attrs.permissions & 0040000))
1538 struct sftp_context_mv {
1543 static int sftp_action_mv(void *vctx, char *srcfname)
1545 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1546 struct sftp_packet *pktin;
1547 struct sftp_request *req, *rreq;
1549 char *finalfname, *newcanon = NULL;
1552 if (ctx->dest_is_dir) {
1556 p = srcfname + strlen(srcfname);
1557 while (p > srcfname && p[-1] != '/') p--;
1558 newname = dupcat(ctx->dstfname, "/", p, NULL);
1559 newcanon = canonify(newname);
1561 printf("%s: canonify: %s\n", newname, fxp_error());
1567 finalfname = newcanon;
1569 finalfname = ctx->dstfname;
1572 sftp_register(req = fxp_rename_send(srcfname, finalfname));
1573 rreq = sftp_find_request(pktin = sftp_recv());
1574 assert(rreq == req);
1575 result = fxp_rename_recv(pktin, rreq);
1577 error = result ? NULL : fxp_error();
1580 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1583 printf("%s -> %s\n", srcfname, finalfname);
1591 int sftp_cmd_mv(struct sftp_command *cmd)
1593 struct sftp_context_mv actx, *ctx = &actx;
1601 if (cmd->nwords < 3) {
1602 printf("mv: expects two filenames\n");
1606 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1607 if (!ctx->dstfname) {
1608 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1613 * If there's more than one source argument, or one source
1614 * argument which is a wildcard, we _require_ that the
1615 * destination is a directory.
1617 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1618 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1619 printf("mv: multiple or wildcard arguments require the destination"
1620 " to be a directory\n");
1621 sfree(ctx->dstfname);
1626 * Now iterate over the source arguments.
1629 for (i = 1; i < cmd->nwords-1; i++)
1630 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1632 sfree(ctx->dstfname);
1636 struct sftp_context_chmod {
1637 unsigned attrs_clr, attrs_xor;
1640 static int sftp_action_chmod(void *vctx, char *fname)
1642 struct fxp_attrs attrs;
1643 struct sftp_packet *pktin;
1644 struct sftp_request *req, *rreq;
1646 unsigned oldperms, newperms;
1647 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1649 sftp_register(req = fxp_stat_send(fname));
1650 rreq = sftp_find_request(pktin = sftp_recv());
1651 assert(rreq == req);
1652 result = fxp_stat_recv(pktin, rreq, &attrs);
1654 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1655 printf("get attrs for %s: %s\n", fname,
1656 result ? "file permissions not provided" : fxp_error());
1660 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1661 oldperms = attrs.permissions & 07777;
1662 attrs.permissions &= ~ctx->attrs_clr;
1663 attrs.permissions ^= ctx->attrs_xor;
1664 newperms = attrs.permissions & 07777;
1666 if (oldperms == newperms)
1667 return 1; /* no need to do anything! */
1669 sftp_register(req = fxp_setstat_send(fname, attrs));
1670 rreq = sftp_find_request(pktin = sftp_recv());
1671 assert(rreq == req);
1672 result = fxp_setstat_recv(pktin, rreq);
1675 printf("set attrs for %s: %s\n", fname, fxp_error());
1679 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1684 int sftp_cmd_chmod(struct sftp_command *cmd)
1688 struct sftp_context_chmod actx, *ctx = &actx;
1695 if (cmd->nwords < 3) {
1696 printf("chmod: expects a mode specifier and a filename\n");
1701 * Attempt to parse the mode specifier in cmd->words[1]. We
1702 * don't support the full horror of Unix chmod; instead we
1703 * support a much simpler syntax in which the user can either
1704 * specify an octal number, or a comma-separated sequence of
1705 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1706 * _only_ be omitted if the only attribute mentioned is t,
1707 * since all others require a user/group/other specification.
1708 * Additionally, the s attribute may not be specified for any
1709 * [ugoa] specifications other than exactly u or exactly g.
1711 ctx->attrs_clr = ctx->attrs_xor = 0;
1712 mode = cmd->words[1];
1713 if (mode[0] >= '0' && mode[0] <= '9') {
1714 if (mode[strspn(mode, "01234567")]) {
1715 printf("chmod: numeric file modes should"
1716 " contain digits 0-7 only\n");
1719 ctx->attrs_clr = 07777;
1720 sscanf(mode, "%o", &ctx->attrs_xor);
1721 ctx->attrs_xor &= ctx->attrs_clr;
1724 char *modebegin = mode;
1725 unsigned subset, perms;
1729 while (*mode && *mode != ',' &&
1730 *mode != '+' && *mode != '-' && *mode != '=') {
1732 case 'u': subset |= 04700; break; /* setuid, user perms */
1733 case 'g': subset |= 02070; break; /* setgid, group perms */
1734 case 'o': subset |= 00007; break; /* just other perms */
1735 case 'a': subset |= 06777; break; /* all of the above */
1737 printf("chmod: file mode '%.*s' contains unrecognised"
1738 " user/group/other specifier '%c'\n",
1739 (int)strcspn(modebegin, ","), modebegin, *mode);
1744 if (!*mode || *mode == ',') {
1745 printf("chmod: file mode '%.*s' is incomplete\n",
1746 (int)strcspn(modebegin, ","), modebegin);
1750 if (!*mode || *mode == ',') {
1751 printf("chmod: file mode '%.*s' is incomplete\n",
1752 (int)strcspn(modebegin, ","), modebegin);
1756 while (*mode && *mode != ',') {
1758 case 'r': perms |= 00444; break;
1759 case 'w': perms |= 00222; break;
1760 case 'x': perms |= 00111; break;
1761 case 't': perms |= 01000; subset |= 01000; break;
1763 if ((subset & 06777) != 04700 &&
1764 (subset & 06777) != 02070) {
1765 printf("chmod: file mode '%.*s': set[ug]id bit should"
1766 " be used with exactly one of u or g only\n",
1767 (int)strcspn(modebegin, ","), modebegin);
1773 printf("chmod: file mode '%.*s' contains unrecognised"
1774 " permission specifier '%c'\n",
1775 (int)strcspn(modebegin, ","), modebegin, *mode);
1780 if (!(subset & 06777) && (perms &~ subset)) {
1781 printf("chmod: file mode '%.*s' contains no user/group/other"
1782 " specifier and permissions other than 't' \n",
1783 (int)strcspn(modebegin, ","), modebegin);
1789 ctx->attrs_clr |= perms;
1790 ctx->attrs_xor |= perms;
1793 ctx->attrs_clr |= perms;
1794 ctx->attrs_xor &= ~perms;
1797 ctx->attrs_clr |= subset;
1798 ctx->attrs_xor |= perms;
1801 if (*mode) mode++; /* eat comma */
1806 for (i = 2; i < cmd->nwords; i++)
1807 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1812 static int sftp_cmd_open(struct sftp_command *cmd)
1817 printf("psftp: already connected\n");
1821 if (cmd->nwords < 2) {
1822 printf("open: expects a host name\n");
1826 if (cmd->nwords > 2) {
1827 portnumber = atoi(cmd->words[2]);
1828 if (portnumber == 0) {
1829 printf("open: invalid port number\n");
1835 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1836 back = NULL; /* connection is already closed */
1837 return -1; /* this is fatal */
1843 static int sftp_cmd_lcd(struct sftp_command *cmd)
1845 char *currdir, *errmsg;
1847 if (cmd->nwords < 2) {
1848 printf("lcd: expects a local directory name\n");
1852 errmsg = psftp_lcd(cmd->words[1]);
1854 printf("lcd: unable to change directory: %s\n", errmsg);
1859 currdir = psftp_getcwd();
1860 printf("New local directory is %s\n", currdir);
1866 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1870 currdir = psftp_getcwd();
1871 printf("Current local directory is %s\n", currdir);
1877 static int sftp_cmd_pling(struct sftp_command *cmd)
1881 exitcode = system(cmd->words[1]);
1882 return (exitcode == 0);
1885 static int sftp_cmd_help(struct sftp_command *cmd);
1887 static struct sftp_cmd_lookup {
1890 * For help purposes, there are two kinds of command:
1892 * - primary commands, in which `longhelp' is non-NULL. In
1893 * this case `shorthelp' is descriptive text, and `longhelp'
1894 * is longer descriptive text intended to be printed after
1897 * - alias commands, in which `longhelp' is NULL. In this case
1898 * `shorthelp' is the name of a primary command, which
1899 * contains the help that should double up for this command.
1901 int listed; /* do we list this in primary help? */
1904 int (*obey) (struct sftp_command *);
1907 * List of sftp commands. This is binary-searched so it MUST be
1911 "!", TRUE, "run a local command",
1913 /* FIXME: this example is crap for non-Windows. */
1914 " Runs a local command. For example, \"!del myfile\".\n",
1918 "bye", TRUE, "finish your SFTP session",
1920 " Terminates your SFTP session and quits the PSFTP program.\n",
1924 "cd", TRUE, "change your remote working directory",
1925 " [ <new working directory> ]\n"
1926 " Change the remote working directory for your SFTP session.\n"
1927 " If a new working directory is not supplied, you will be\n"
1928 " returned to your home directory.\n",
1932 "chmod", TRUE, "change file permissions and modes",
1933 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1934 " Change the file permissions on one or more remote files or\n"
1936 " <modes> can be any octal Unix permission specifier.\n"
1937 " Alternatively, <modes> can include the following modifiers:\n"
1938 " u+r make file readable by owning user\n"
1939 " u+w make file writable by owning user\n"
1940 " u+x make file executable by owning user\n"
1941 " u-r make file not readable by owning user\n"
1942 " [also u-w, u-x]\n"
1943 " g+r make file readable by members of owning group\n"
1944 " [also g+w, g+x, g-r, g-w, g-x]\n"
1945 " o+r make file readable by all other users\n"
1946 " [also o+w, o+x, o-r, o-w, o-x]\n"
1947 " a+r make file readable by absolutely everybody\n"
1948 " [also a+w, a+x, a-r, a-w, a-x]\n"
1949 " u+s enable the Unix set-user-ID bit\n"
1950 " u-s disable the Unix set-user-ID bit\n"
1951 " g+s enable the Unix set-group-ID bit\n"
1952 " g-s disable the Unix set-group-ID bit\n"
1953 " +t enable the Unix \"sticky bit\"\n"
1954 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1955 " more than one user for the same modifier (\"ug+w\"). You can\n"
1956 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1960 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1962 " Terminates your SFTP session, but does not quit the PSFTP\n"
1963 " program. You can then use \"open\" to start another SFTP\n"
1964 " session, to the same server or to a different one.\n",
1968 "del", TRUE, "delete files on the remote server",
1969 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1970 " Delete a file or files from the server.\n",
1974 "delete", FALSE, "del", NULL, sftp_cmd_rm
1977 "dir", TRUE, "list remote files",
1978 " [ <directory-name> ]/[ <wildcard> ]\n"
1979 " List the contents of a specified directory on the server.\n"
1980 " If <directory-name> is not given, the current working directory\n"
1982 " If <wildcard> is given, it is treated as a set of files to\n"
1983 " list; otherwise, all files are listed.\n",
1987 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1990 "get", TRUE, "download a file from the server to your local machine",
1991 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1992 " Downloads a file on the server and stores it locally under\n"
1993 " the same name, or under a different one if you supply the\n"
1994 " argument <local-filename>.\n"
1995 " If -r specified, recursively fetch a directory.\n",
1999 "help", TRUE, "give help",
2000 " [ <command> [ <command> ... ] ]\n"
2001 " Give general help if no commands are specified.\n"
2002 " If one or more commands are specified, give specific help on\n"
2003 " those particular commands.\n",
2007 "lcd", TRUE, "change local working directory",
2008 " <local-directory-name>\n"
2009 " Change the local working directory of the PSFTP program (the\n"
2010 " default location where the \"get\" command will save files).\n",
2014 "lpwd", TRUE, "print local working directory",
2016 " Print the local working directory of the PSFTP program (the\n"
2017 " default location where the \"get\" command will save files).\n",
2021 "ls", TRUE, "dir", NULL,
2025 "mget", TRUE, "download multiple files at once",
2026 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2027 " Downloads many files from the server, storing each one under\n"
2028 " the same name it has on the server side. You can use wildcards\n"
2029 " such as \"*.c\" to specify lots of files at once.\n"
2030 " If -r specified, recursively fetch files and directories.\n",
2034 "mkdir", TRUE, "create directories on the remote server",
2035 " <directory-name> [ <directory-name>... ]\n"
2036 " Creates directories with the given names on the server.\n",
2040 "mput", TRUE, "upload multiple files at once",
2041 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2042 " Uploads many files to the server, storing each one under the\n"
2043 " same name it has on the client side. You can use wildcards\n"
2044 " such as \"*.c\" to specify lots of files at once.\n"
2045 " If -r specified, recursively store files and directories.\n",
2049 "mv", TRUE, "move or rename file(s) on the remote server",
2050 " <source> [ <source>... ] <destination>\n"
2051 " Moves or renames <source>(s) on the server to <destination>,\n"
2052 " also on the server.\n"
2053 " If <destination> specifies an existing directory, then <source>\n"
2054 " may be a wildcard, and multiple <source>s may be given; all\n"
2055 " source files are moved into <destination>.\n"
2056 " Otherwise, <source> must specify a single file, which is moved\n"
2057 " or renamed so that it is accessible under the name <destination>.\n",
2061 "open", TRUE, "connect to a host",
2062 " [<user>@]<hostname> [<port>]\n"
2063 " Establishes an SFTP connection to a given host. Only usable\n"
2064 " when you are not already connected to a server.\n",
2068 "put", TRUE, "upload a file from your local machine to the server",
2069 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2070 " Uploads a file to the server and stores it there under\n"
2071 " the same name, or under a different one if you supply the\n"
2072 " argument <remote-filename>.\n"
2073 " If -r specified, recursively store a directory.\n",
2077 "pwd", TRUE, "print your remote working directory",
2079 " Print the current remote working directory for your SFTP session.\n",
2083 "quit", TRUE, "bye", NULL,
2087 "reget", TRUE, "continue downloading files",
2088 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2089 " Works exactly like the \"get\" command, but the local file\n"
2090 " must already exist. The download will begin at the end of the\n"
2091 " file. This is for resuming a download that was interrupted.\n"
2092 " If -r specified, resume interrupted \"get -r\".\n",
2096 "ren", TRUE, "mv", NULL,
2100 "rename", FALSE, "mv", NULL,
2104 "reput", TRUE, "continue uploading files",
2105 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2106 " Works exactly like the \"put\" command, but the remote file\n"
2107 " must already exist. The upload will begin at the end of the\n"
2108 " file. This is for resuming an upload that was interrupted.\n"
2109 " If -r specified, resume interrupted \"put -r\".\n",
2113 "rm", TRUE, "del", NULL,
2117 "rmdir", TRUE, "remove directories on the remote server",
2118 " <directory-name> [ <directory-name>... ]\n"
2119 " Removes the directory with the given name on the server.\n"
2120 " The directory will not be removed unless it is empty.\n"
2121 " Wildcards may be used to specify multiple directories.\n",
2126 const struct sftp_cmd_lookup *lookup_command(char *name)
2131 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2134 cmp = strcmp(name, sftp_lookup[k].name);
2140 return &sftp_lookup[k];
2146 static int sftp_cmd_help(struct sftp_command *cmd)
2149 if (cmd->nwords == 1) {
2151 * Give short help on each command.
2155 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2157 if (!sftp_lookup[i].listed)
2159 len = strlen(sftp_lookup[i].name);
2163 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2164 const struct sftp_cmd_lookup *lookup;
2165 if (!sftp_lookup[i].listed)
2167 lookup = &sftp_lookup[i];
2168 printf("%-*s", maxlen+2, lookup->name);
2169 if (lookup->longhelp == NULL)
2170 lookup = lookup_command(lookup->shorthelp);
2171 printf("%s\n", lookup->shorthelp);
2175 * Give long help on specific commands.
2177 for (i = 1; i < cmd->nwords; i++) {
2178 const struct sftp_cmd_lookup *lookup;
2179 lookup = lookup_command(cmd->words[i]);
2181 printf("help: %s: command not found\n", cmd->words[i]);
2183 printf("%s", lookup->name);
2184 if (lookup->longhelp == NULL)
2185 lookup = lookup_command(lookup->shorthelp);
2186 printf("%s", lookup->longhelp);
2193 /* ----------------------------------------------------------------------
2194 * Command line reading and parsing.
2196 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2199 struct sftp_command *cmd;
2203 cmd = snew(struct sftp_command);
2213 line = fgetline(fp);
2215 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2218 if (!line || !*line) {
2219 cmd->obey = sftp_cmd_quit;
2220 if ((mode == 0) || (modeflags & 1))
2222 return cmd; /* eof */
2225 line[strcspn(line, "\r\n")] = '\0';
2227 if (modeflags & 1) {
2228 printf("%s\n", line);
2232 while (*p && (*p == ' ' || *p == '\t'))
2237 * Special case: the ! command. This is always parsed as
2238 * exactly two words: one containing the !, and the second
2239 * containing everything else on the line.
2241 cmd->nwords = cmd->wordssize = 2;
2242 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2243 cmd->words[0] = dupstr("!");
2244 cmd->words[1] = dupstr(p+1);
2245 } else if (*p == '#') {
2247 * Special case: comment. Entire line is ignored.
2249 cmd->nwords = cmd->wordssize = 0;
2253 * Parse the command line into words. The syntax is:
2254 * - double quotes are removed, but cause spaces within to be
2255 * treated as non-separating.
2256 * - a double-doublequote pair is a literal double quote, inside
2257 * _or_ outside quotes. Like this:
2259 * firstword "second word" "this has ""quotes"" in" and""this""
2265 * >this has "quotes" in<
2269 /* skip whitespace */
2270 while (*p && (*p == ' ' || *p == '\t'))
2272 /* mark start of word */
2273 q = r = p; /* q sits at start, r writes word */
2276 if (!quoting && (*p == ' ' || *p == '\t'))
2277 break; /* reached end of word */
2278 else if (*p == '"' && p[1] == '"')
2279 p += 2, *r++ = '"'; /* a literal quote */
2281 p++, quoting = !quoting;
2286 p++; /* skip over the whitespace */
2288 if (cmd->nwords >= cmd->wordssize) {
2289 cmd->wordssize = cmd->nwords + 16;
2290 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2292 cmd->words[cmd->nwords++] = dupstr(q);
2299 * Now parse the first word and assign a function.
2302 if (cmd->nwords == 0)
2303 cmd->obey = sftp_cmd_null;
2305 const struct sftp_cmd_lookup *lookup;
2306 lookup = lookup_command(cmd->words[0]);
2308 cmd->obey = sftp_cmd_unknown;
2310 cmd->obey = lookup->obey;
2316 static int do_sftp_init(void)
2318 struct sftp_packet *pktin;
2319 struct sftp_request *req, *rreq;
2322 * Do protocol initialisation.
2326 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2327 return 1; /* failure */
2331 * Find out where our home directory is.
2333 sftp_register(req = fxp_realpath_send("."));
2334 rreq = sftp_find_request(pktin = sftp_recv());
2335 assert(rreq == req);
2336 homedir = fxp_realpath_recv(pktin, rreq);
2340 "Warning: failed to resolve home directory: %s\n",
2342 homedir = dupstr(".");
2344 printf("Remote working directory is %s\n", homedir);
2346 pwd = dupstr(homedir);
2350 void do_sftp_cleanup()
2354 back->special(backhandle, TS_EOF);
2355 sftp_recvdata(&ch, 1);
2356 back->free(backhandle);
2357 sftp_cleanup_request();
2371 void do_sftp(int mode, int modeflags, char *batchfile)
2381 /* ------------------------------------------------------------------
2382 * Now we're ready to do Real Stuff.
2385 struct sftp_command *cmd;
2386 cmd = sftp_getcmd(NULL, 0, 0);
2389 ret = cmd->obey(cmd);
2392 for(i = 0; i < cmd->nwords; i++)
2393 sfree(cmd->words[i]);
2401 fp = fopen(batchfile, "r");
2403 printf("Fatal: unable to open %s\n", batchfile);
2407 struct sftp_command *cmd;
2408 cmd = sftp_getcmd(fp, mode, modeflags);
2411 ret = cmd->obey(cmd);
2415 if (!(modeflags & 2))
2424 /* ----------------------------------------------------------------------
2425 * Dirty bits: integration with PuTTY.
2428 static int verbose = 0;
2431 * Print an error message and perform a fatal exit.
2433 void fatalbox(char *fmt, ...)
2438 str = dupvprintf(fmt, ap);
2439 str2 = dupcat("Fatal: ", str, "\n", NULL);
2442 fputs(str2, stderr);
2447 void modalfatalbox(char *fmt, ...)
2452 str = dupvprintf(fmt, ap);
2453 str2 = dupcat("Fatal: ", str, "\n", NULL);
2456 fputs(str2, stderr);
2461 void connection_fatal(void *frontend, char *fmt, ...)
2466 str = dupvprintf(fmt, ap);
2467 str2 = dupcat("Fatal: ", str, "\n", NULL);
2470 fputs(str2, stderr);
2476 void ldisc_send(void *handle, char *buf, int len, int interactive)
2479 * This is only here because of the calls to ldisc_send(NULL,
2480 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2481 * ldisc as an ldisc. So if we get called with any real data, I
2482 * want to know about it.
2488 * In psftp, all agent requests should be synchronous, so this is a
2489 * never-called stub.
2491 void agent_schedule_callback(void (*callback)(void *, void *, int),
2492 void *callback_ctx, void *data, int len)
2494 assert(!"We shouldn't be here");
2498 * Receive a block of data from the SSH link. Block until all data
2501 * To do this, we repeatedly call the SSH protocol module, with our
2502 * own trap in from_backend() to catch the data that comes back. We
2503 * do this until we have enough data.
2506 static unsigned char *outptr; /* where to put the data */
2507 static unsigned outlen; /* how much data required */
2508 static unsigned char *pending = NULL; /* any spare data */
2509 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2510 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2512 unsigned char *p = (unsigned char *) data;
2513 unsigned len = (unsigned) datalen;
2516 * stderr data is just spouted to local stderr and otherwise
2521 if (fwrite(data, 1, len, stderr) < len)
2527 * If this is before the real session begins, just return.
2532 if ((outlen > 0) && (len > 0)) {
2533 unsigned used = outlen;
2536 memcpy(outptr, p, used);
2544 if (pendsize < pendlen + len) {
2545 pendsize = pendlen + len + 4096;
2546 pending = sresize(pending, pendsize, unsigned char);
2548 memcpy(pending + pendlen, p, len);
2554 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2557 * No "untrusted" output should get here (the way the code is
2558 * currently, it's all diverted by FLAG_STDERR).
2560 assert(!"Unexpected call to from_backend_untrusted()");
2561 return 0; /* not reached */
2563 int sftp_recvdata(char *buf, int len)
2565 outptr = (unsigned char *) buf;
2569 * See if the pending-input block contains some of what we
2573 unsigned pendused = pendlen;
2574 if (pendused > outlen)
2576 memcpy(outptr, pending, pendused);
2577 memmove(pending, pending + pendused, pendlen - pendused);
2580 pendlen -= pendused;
2590 while (outlen > 0) {
2591 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2592 return 0; /* doom */
2597 int sftp_senddata(char *buf, int len)
2599 back->send(backhandle, buf, len);
2604 * Short description of parameters.
2606 static void usage(void)
2608 printf("PuTTY Secure File Transfer (SFTP) client\n");
2609 printf("%s\n", ver);
2610 printf("Usage: psftp [options] [user@]host\n");
2611 printf("Options:\n");
2612 printf(" -V print version information and exit\n");
2613 printf(" -pgpfp print PGP key fingerprints and exit\n");
2614 printf(" -b file use specified batchfile\n");
2615 printf(" -bc output batchfile commands\n");
2616 printf(" -be don't stop batchfile processing if errors\n");
2617 printf(" -v show verbose messages\n");
2618 printf(" -load sessname Load settings from saved session\n");
2619 printf(" -l user connect with specified username\n");
2620 printf(" -P port connect to specified port\n");
2621 printf(" -pw passw login with specified password\n");
2622 printf(" -1 -2 force use of particular SSH protocol version\n");
2623 printf(" -4 -6 force use of IPv4 or IPv6\n");
2624 printf(" -C enable compression\n");
2625 printf(" -i key private key file for authentication\n");
2626 printf(" -noagent disable use of Pageant\n");
2627 printf(" -agent enable use of Pageant\n");
2628 printf(" -batch disable all interactive prompts\n");
2632 static void version(void)
2634 printf("psftp: %s\n", ver);
2639 * Connect to a host.
2641 static int psftp_connect(char *userhost, char *user, int portnumber)
2643 char *host, *realhost;
2647 /* Separate host and username */
2649 host = strrchr(host, '@');
2655 printf("psftp: multiple usernames specified; using \"%s\"\n",
2662 * If we haven't loaded session details already (e.g., from -load),
2663 * try looking for a session called "host".
2665 if (!loaded_session) {
2666 /* Try to load settings for `host' into a temporary config */
2667 Conf *conf2 = conf_new();
2668 conf_set_str(conf2, CONF_host, "");
2669 do_defaults(host, conf2);
2670 if (conf_get_str(conf2, CONF_host)[0] != '\0') {
2671 /* Settings present and include hostname */
2672 /* Re-load data into the real config. */
2673 do_defaults(host, conf);
2675 /* Session doesn't exist or mention a hostname. */
2676 /* Use `host' as a bare hostname. */
2677 conf_set_str(conf, CONF_host, host);
2680 /* Patch in hostname `host' to session details. */
2681 conf_set_str(conf, CONF_host, host);
2685 * Force use of SSH. (If they got the protocol wrong we assume the
2686 * port is useless too.)
2688 if (conf_get_int(conf, CONF_protocol) != PROT_SSH) {
2689 conf_set_int(conf, CONF_protocol, PROT_SSH);
2690 conf_set_int(conf, CONF_port, 22);
2694 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2695 * then change it to SSH-2, on the grounds that that's more likely to
2696 * work for SFTP. (Can be overridden with `-1' option.)
2697 * But if it says `2 only' or `2', respect which.
2699 if ((conf_get_int(conf, CONF_sshprot) & ~1) != 2) /* is it 2 or 3? */
2700 conf_set_int(conf, CONF_sshprot, 2);
2703 * Enact command-line overrides.
2705 cmdline_run_saved(conf);
2708 * Muck about with the hostname in various ways.
2711 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
2712 char *host = hostbuf;
2716 * Trim leading whitespace.
2718 host += strspn(host, " \t");
2721 * See if host is of the form user@host, and separate out
2722 * the username if so.
2724 if (host[0] != '\0') {
2725 char *atsign = strrchr(host, '@');
2728 conf_set_str(conf, CONF_username, host);
2734 * Remove any remaining whitespace.
2739 if (*q != ' ' && *q != '\t')
2745 conf_set_str(conf, CONF_host, hostbuf);
2750 if (user != NULL && user[0] != '\0') {
2751 conf_set_str(conf, CONF_username, user);
2755 conf_set_int(conf, CONF_port, portnumber);
2758 * Disable scary things which shouldn't be enabled for simple
2759 * things like SCP and SFTP: agent forwarding, port forwarding,
2762 conf_set_int(conf, CONF_x11_forward, 0);
2763 conf_set_int(conf, CONF_agentfwd, 0);
2764 conf_set_int(conf, CONF_ssh_simple, TRUE);
2767 while ((key = conf_get_str_nthstrkey(conf, CONF_portfwd, 0)) != NULL)
2768 conf_del_str_str(conf, CONF_portfwd, key);
2771 /* Set up subsystem name. */
2772 conf_set_str(conf, CONF_remote_cmd, "sftp");
2773 conf_set_int(conf, CONF_ssh_subsys, TRUE);
2774 conf_set_int(conf, CONF_nopty, TRUE);
2777 * Set up fallback option, for SSH-1 servers or servers with the
2778 * sftp subsystem not enabled but the server binary installed
2779 * in the usual place. We only support fallback on Unix
2780 * systems, and we use a kludgy piece of shellery which should
2781 * try to find sftp-server in various places (the obvious
2782 * systemwide spots /usr/lib and /usr/local/lib, and then the
2783 * user's PATH) and finally give up.
2785 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2786 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2789 * the idea being that this will attempt to use either of the
2790 * obvious pathnames and then give up, and when it does give up
2791 * it will print the preferred pathname in the error messages.
2793 conf_set_str(conf, CONF_remote_cmd2,
2794 "test -x /usr/lib/sftp-server &&"
2795 " exec /usr/lib/sftp-server\n"
2796 "test -x /usr/local/lib/sftp-server &&"
2797 " exec /usr/local/lib/sftp-server\n"
2798 "exec sftp-server");
2799 conf_set_int(conf, CONF_ssh_subsys2, FALSE);
2801 back = &ssh_backend;
2803 err = back->init(NULL, &backhandle, conf,
2804 conf_get_str(conf, CONF_host),
2805 conf_get_int(conf, CONF_port),
2807 conf_get_int(conf, CONF_tcp_keepalives));
2809 fprintf(stderr, "ssh_init: %s\n", err);
2812 logctx = log_init(NULL, conf);
2813 back->provide_logctx(backhandle, logctx);
2814 console_provide_logctx(logctx);
2815 while (!back->sendok(backhandle)) {
2816 if (back->exitcode(backhandle) >= 0)
2818 if (ssh_sftp_loop_iteration() < 0) {
2819 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2823 if (verbose && realhost != NULL)
2824 printf("Connected to %s\n", realhost);
2825 if (realhost != NULL)
2830 void cmdline_error(char *p, ...)
2833 fprintf(stderr, "psftp: ");
2835 vfprintf(stderr, p, ap);
2837 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2842 * Main program. Parse arguments etc.
2844 int psftp_main(int argc, char *argv[])
2848 char *userhost, *user;
2851 char *batchfile = NULL;
2853 flags = FLAG_STDERR | FLAG_INTERACTIVE
2854 #ifdef FLAG_SYNCAGENT
2858 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2861 userhost = user = NULL;
2863 /* Load Default Settings before doing anything else. */
2865 do_defaults(NULL, conf);
2866 loaded_session = FALSE;
2868 for (i = 1; i < argc; i++) {
2870 if (argv[i][0] != '-') {
2874 userhost = dupstr(argv[i]);
2877 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, conf);
2879 cmdline_error("option \"%s\" requires an argument", argv[i]);
2880 } else if (ret == 2) {
2881 i++; /* skip next argument */
2882 } else if (ret == 1) {
2883 /* We have our own verbosity in addition to `flags'. */
2884 if (flags & FLAG_VERBOSE)
2886 } else if (strcmp(argv[i], "-h") == 0 ||
2887 strcmp(argv[i], "-?") == 0) {
2889 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2892 } else if (strcmp(argv[i], "-V") == 0) {
2894 } else if (strcmp(argv[i], "-batch") == 0) {
2895 console_batch_mode = 1;
2896 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2898 batchfile = argv[++i];
2899 } else if (strcmp(argv[i], "-bc") == 0) {
2900 modeflags = modeflags | 1;
2901 } else if (strcmp(argv[i], "-be") == 0) {
2902 modeflags = modeflags | 2;
2903 } else if (strcmp(argv[i], "--") == 0) {
2907 cmdline_error("unknown option \"%s\"", argv[i]);
2915 * If the loaded session provides a hostname, and a hostname has not
2916 * otherwise been specified, pop it in `userhost' so that
2917 * `psftp -load sessname' is sufficient to start a session.
2919 if (!userhost && conf_get_str(conf, CONF_host)[0] != '\0') {
2920 userhost = dupstr(conf_get_str(conf, CONF_host));
2924 * If a user@host string has already been provided, connect to
2929 ret = psftp_connect(userhost, user, portnumber);
2936 printf("psftp: no hostname specified; use \"open host.name\""
2940 do_sftp(mode, modeflags, batchfile);
2942 if (back != NULL && back->connected(backhandle)) {
2944 back->special(backhandle, TS_EOF);
2945 sftp_recvdata(&ch, 1);
2950 console_provide_logctx(NULL);