2 * psftp.c: (platform-independent) front end for PSFTP.
11 #define PUTTY_DO_GLOBALS
20 * Since SFTP is a request-response oriented protocol, it requires
21 * no buffer management: when we send data, we stop and wait for an
22 * acknowledgement _anyway_, and so we can't possibly overfill our
26 static int psftp_connect(char *userhost, char *user, int portnumber);
27 static int do_sftp_init(void);
28 void do_sftp_cleanup();
30 /* ----------------------------------------------------------------------
36 static void *backhandle;
39 /* ----------------------------------------------------------------------
40 * Higher-level helper functions used in commands.
44 * Attempt to canonify a pathname starting from the pwd. If
45 * canonification fails, at least fall back to returning a _valid_
46 * pathname (though it may be ugly, eg /home/simon/../foobar).
48 char *canonify(char *name)
50 char *fullname, *canonname;
51 struct sftp_packet *pktin;
52 struct sftp_request *req, *rreq;
55 fullname = dupstr(name);
58 if (pwd[strlen(pwd) - 1] == '/')
62 fullname = dupcat(pwd, slash, name, NULL);
65 sftp_register(req = fxp_realpath_send(fullname));
66 rreq = sftp_find_request(pktin = sftp_recv());
68 canonname = fxp_realpath_recv(pktin, rreq);
75 * Attempt number 2. Some FXP_REALPATH implementations
76 * (glibc-based ones, in particular) require the _whole_
77 * path to point to something that exists, whereas others
78 * (BSD-based) only require all but the last component to
79 * exist. So if the first call failed, we should strip off
80 * everything from the last slash onwards and try again,
81 * then put the final component back on.
85 * - if the last component is "/." or "/..", then we don't
86 * bother trying this because there's no way it can work.
88 * - if the thing actually ends with a "/", we remove it
89 * before we start. Except if the string is "/" itself
90 * (although I can't see why we'd have got here if so,
91 * because surely "/" would have worked the first
92 * time?), in which case we don't bother.
94 * - if there's no slash in the string at all, give up in
95 * confusion (we expect at least one because of the way
96 * we constructed the string).
102 i = strlen(fullname);
103 if (i > 2 && fullname[i - 1] == '/')
104 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
105 while (i > 0 && fullname[--i] != '/');
108 * Give up on special cases.
110 if (fullname[i] != '/' || /* no slash at all */
111 !strcmp(fullname + i, "/.") || /* ends in /. */
112 !strcmp(fullname + i, "/..") || /* ends in /.. */
113 !strcmp(fullname, "/")) {
118 * Now i points at the slash. Deal with the final special
119 * case i==0 (ie the whole path was "/nonexistentfile").
121 fullname[i] = '\0'; /* separate the string */
123 sftp_register(req = fxp_realpath_send("/"));
125 sftp_register(req = fxp_realpath_send(fullname));
127 rreq = sftp_find_request(pktin = sftp_recv());
129 canonname = fxp_realpath_recv(pktin, rreq);
132 /* Even that failed. Restore our best guess at the
133 * constructed filename and give up */
134 fullname[i] = '/'; /* restore slash and last component */
139 * We have a canonical name for all but the last path
140 * component. Concatenate the last component and return.
142 returnname = dupcat(canonname,
143 canonname[strlen(canonname) - 1] ==
144 '/' ? "" : "/", fullname + i + 1, NULL);
152 * Return a pointer to the portion of str that comes after the last
153 * slash (or backslash or colon, if `local' is TRUE).
155 static char *stripslashes(char *str, int local)
160 p = strchr(str, ':');
164 p = strrchr(str, '/');
168 p = strrchr(str, '\\');
176 * qsort comparison routine for fxp_name structures. Sorts by real
179 static int sftp_name_compare(const void *av, const void *bv)
181 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
182 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
183 return strcmp((*a)->filename, (*b)->filename);
187 * Likewise, but for a bare char *.
189 static int bare_name_compare(const void *av, const void *bv)
191 const char **a = (const char **) av;
192 const char **b = (const char **) bv;
193 return strcmp(*a, *b);
196 static void not_connected(void)
198 printf("psftp: not connected to a host; use \"open host.name\"\n");
201 /* ----------------------------------------------------------------------
202 * The meat of the `get' and `put' commands.
204 int sftp_get_file(char *fname, char *outfname, int recurse, int restart)
206 struct fxp_handle *fh;
207 struct sftp_packet *pktin;
208 struct sftp_request *req, *rreq;
209 struct fxp_xfer *xfer;
212 int ret, shown_err = FALSE;
215 * In recursive mode, see if we're dealing with a directory.
216 * (If we're not in recursive mode, we need not even check: the
217 * subsequent FXP_OPEN will return a usable error message.)
220 struct fxp_attrs attrs;
223 sftp_register(req = fxp_stat_send(fname));
224 rreq = sftp_find_request(pktin = sftp_recv());
226 result = fxp_stat_recv(pktin, rreq, &attrs);
229 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
230 (attrs.permissions & 0040000)) {
232 struct fxp_handle *dirhandle;
233 int nnames, namesize;
234 struct fxp_name **ournames;
235 struct fxp_names *names;
239 * First, attempt to create the destination directory,
240 * unless it already exists.
242 if (file_type(outfname) != FILE_TYPE_DIRECTORY &&
243 !create_directory(outfname)) {
244 printf("%s: Cannot create directory\n", outfname);
249 * Now get the list of filenames in the remote
252 sftp_register(req = fxp_opendir_send(fname));
253 rreq = sftp_find_request(pktin = sftp_recv());
255 dirhandle = fxp_opendir_recv(pktin, rreq);
258 printf("%s: unable to open directory: %s\n",
262 nnames = namesize = 0;
267 sftp_register(req = fxp_readdir_send(dirhandle));
268 rreq = sftp_find_request(pktin = sftp_recv());
270 names = fxp_readdir_recv(pktin, rreq);
273 if (fxp_error_type() == SSH_FX_EOF)
275 printf("%s: reading directory: %s\n", fname, fxp_error());
279 if (names->nnames == 0) {
280 fxp_free_names(names);
283 if (nnames + names->nnames >= namesize) {
284 namesize += names->nnames + 128;
285 ournames = sresize(ournames, namesize, struct fxp_name *);
287 for (i = 0; i < names->nnames; i++)
288 if (strcmp(names->names[i].filename, ".") &&
289 strcmp(names->names[i].filename, "..")) {
290 if (!vet_filename(names->names[i].filename)) {
291 printf("ignoring potentially dangerous server-"
292 "supplied filename '%s'\n",
293 names->names[i].filename);
296 fxp_dup_name(&names->names[i]);
299 fxp_free_names(names);
301 sftp_register(req = fxp_close_send(dirhandle));
302 rreq = sftp_find_request(pktin = sftp_recv());
304 fxp_close_recv(pktin, rreq);
307 * Sort the names into a clear order. This ought to
308 * make things more predictable when we're doing a
309 * reget of the same directory, just in case two
310 * readdirs on the same remote directory return a
313 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
316 * If we're in restart mode, find the last filename on
317 * this list that already exists. We may have to do a
318 * reget on _that_ file, but shouldn't have to do
319 * anything on the previous files.
321 * If none of them exists, of course, we start at 0.
329 nextoutfname = dir_file_cat(outfname,
330 ournames[i]->filename);
332 nextoutfname = dupstr(ournames[i]->filename);
333 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
344 * Now we're ready to recurse. Starting at ournames[i]
345 * and continuing on to the end of the list, we
346 * construct a new source and target file name, and
347 * call sftp_get_file again.
349 for (; i < nnames; i++) {
350 char *nextfname, *nextoutfname;
353 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
355 nextoutfname = dir_file_cat(outfname,
356 ournames[i]->filename);
358 nextoutfname = dupstr(ournames[i]->filename);
359 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
360 restart = FALSE; /* after first partial file, do full */
364 for (i = 0; i < nnames; i++) {
365 fxp_free_name(ournames[i]);
373 * Done this recursion level. Free everything.
375 for (i = 0; i < nnames; i++) {
376 fxp_free_name(ournames[i]);
384 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
385 rreq = sftp_find_request(pktin = sftp_recv());
387 fh = fxp_open_recv(pktin, rreq);
390 printf("%s: open for read: %s\n", fname, fxp_error());
395 file = open_existing_wfile(outfname, NULL);
397 file = open_new_file(outfname);
401 printf("local: unable to open %s\n", outfname);
403 sftp_register(req = fxp_close_send(fh));
404 rreq = sftp_find_request(pktin = sftp_recv());
406 fxp_close_recv(pktin, rreq);
413 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
414 printf("reget: cannot restart %s - file too large\n",
416 sftp_register(req = fxp_close_send(fh));
417 rreq = sftp_find_request(pktin = sftp_recv());
419 fxp_close_recv(pktin, rreq);
424 offset = get_file_posn(file);
425 uint64_decimal(offset, decbuf);
426 printf("reget: restarting at file position %s\n", decbuf);
428 offset = uint64_make(0, 0);
431 printf("remote:%s => local:%s\n", fname, outfname);
434 * FIXME: we can use FXP_FSTAT here to get the file size, and
435 * thus put up a progress bar.
438 xfer = xfer_download_init(fh, offset);
439 while (!xfer_done(xfer)) {
444 xfer_download_queue(xfer);
446 ret = xfer_download_gotpkt(xfer, pktin);
450 printf("error while reading: %s\n", fxp_error());
456 while (xfer_download_data(xfer, &vbuf, &len)) {
457 unsigned char *buf = (unsigned char *)vbuf;
461 wlen = write_to_file(file, buf + wpos, len - wpos);
463 printf("error while writing local file\n");
465 xfer_set_error(xfer);
469 if (wpos < len) { /* we had an error */
471 xfer_set_error(xfer);
482 sftp_register(req = fxp_close_send(fh));
483 rreq = sftp_find_request(pktin = sftp_recv());
485 fxp_close_recv(pktin, rreq);
490 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
492 struct fxp_handle *fh;
493 struct fxp_xfer *xfer;
494 struct sftp_packet *pktin;
495 struct sftp_request *req, *rreq;
501 * In recursive mode, see if we're dealing with a directory.
502 * (If we're not in recursive mode, we need not even check: the
503 * subsequent fopen will return an error message.)
505 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
506 struct fxp_attrs attrs;
508 int nnames, namesize;
509 char *name, **ournames;
514 * First, attempt to create the destination directory,
515 * unless it already exists.
517 sftp_register(req = fxp_stat_send(outfname));
518 rreq = sftp_find_request(pktin = sftp_recv());
520 result = fxp_stat_recv(pktin, rreq, &attrs);
522 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
523 !(attrs.permissions & 0040000)) {
524 sftp_register(req = fxp_mkdir_send(outfname));
525 rreq = sftp_find_request(pktin = sftp_recv());
527 result = fxp_mkdir_recv(pktin, rreq);
530 printf("%s: create directory: %s\n",
531 outfname, fxp_error());
537 * Now get the list of filenames in the local directory.
539 nnames = namesize = 0;
542 dh = open_directory(fname);
544 printf("%s: unable to open directory\n", fname);
547 while ((name = read_filename(dh)) != NULL) {
548 if (nnames >= namesize) {
550 ournames = sresize(ournames, namesize, char *);
552 ournames[nnames++] = name;
557 * Sort the names into a clear order. This ought to make
558 * things more predictable when we're doing a reput of the
559 * same directory, just in case two readdirs on the same
560 * local directory return a different order.
562 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
565 * If we're in restart mode, find the last filename on this
566 * list that already exists. We may have to do a reput on
567 * _that_ file, but shouldn't have to do anything on the
570 * If none of them exists, of course, we start at 0.
576 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
577 sftp_register(req = fxp_stat_send(nextoutfname));
578 rreq = sftp_find_request(pktin = sftp_recv());
580 result = fxp_stat_recv(pktin, rreq, &attrs);
591 * Now we're ready to recurse. Starting at ournames[i]
592 * and continuing on to the end of the list, we
593 * construct a new source and target file name, and
594 * call sftp_put_file again.
596 for (; i < nnames; i++) {
597 char *nextfname, *nextoutfname;
601 nextfname = dir_file_cat(fname, ournames[i]);
603 nextfname = dupstr(ournames[i]);
604 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
605 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
606 restart = FALSE; /* after first partial file, do full */
610 for (i = 0; i < nnames; i++) {
619 * Done this recursion level. Free everything.
621 for (i = 0; i < nnames; i++) {
629 file = open_existing_file(fname, NULL, NULL, NULL);
631 printf("local: unable to open %s\n", fname);
635 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
637 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
638 SSH_FXF_CREAT | SSH_FXF_TRUNC));
640 rreq = sftp_find_request(pktin = sftp_recv());
642 fh = fxp_open_recv(pktin, rreq);
645 printf("%s: open for write: %s\n", outfname, fxp_error());
651 struct fxp_attrs attrs;
654 sftp_register(req = fxp_fstat_send(fh));
655 rreq = sftp_find_request(pktin = sftp_recv());
657 ret = fxp_fstat_recv(pktin, rreq, &attrs);
660 printf("read size of %s: %s\n", outfname, fxp_error());
663 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
664 printf("read size of %s: size was not given\n", outfname);
668 uint64_decimal(offset, decbuf);
669 printf("reput: restarting at file position %s\n", decbuf);
671 if (seek_file((WFile *)file, offset, FROM_START) != 0)
672 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
674 offset = uint64_make(0, 0);
677 printf("local:%s => remote:%s\n", fname, outfname);
680 * FIXME: we can use FXP_FSTAT here to get the file size, and
681 * thus put up a progress bar.
684 xfer = xfer_upload_init(fh, offset);
686 while ((!err && !eof) || !xfer_done(xfer)) {
690 while (xfer_upload_ready(xfer) && !err && !eof) {
691 len = read_from_file(file, buffer, sizeof(buffer));
693 printf("error while reading local file\n");
695 } else if (len == 0) {
698 xfer_upload_data(xfer, buffer, len);
702 if (!xfer_done(xfer)) {
704 ret = xfer_upload_gotpkt(xfer, pktin);
706 printf("error while writing: %s\n", fxp_error());
714 sftp_register(req = fxp_close_send(fh));
715 rreq = sftp_find_request(pktin = sftp_recv());
717 fxp_close_recv(pktin, rreq);
724 /* ----------------------------------------------------------------------
725 * A remote wildcard matcher, providing a similar interface to the
726 * local one in psftp.h.
729 typedef struct SftpWildcardMatcher {
730 struct fxp_handle *dirh;
731 struct fxp_names *names;
733 char *wildcard, *prefix;
734 } SftpWildcardMatcher;
736 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
738 struct sftp_packet *pktin;
739 struct sftp_request *req, *rreq;
741 char *unwcdir, *tmpdir, *cdir;
743 SftpWildcardMatcher *swcm;
744 struct fxp_handle *dirh;
747 * We don't handle multi-level wildcards; so we expect to find
748 * a fully specified directory part, followed by a wildcard
751 wildcard = stripslashes(name, 0);
753 unwcdir = dupstr(name);
754 len = wildcard - name;
756 if (len > 0 && unwcdir[len-1] == '/')
757 unwcdir[len-1] = '\0';
758 tmpdir = snewn(1 + len, char);
759 check = wc_unescape(tmpdir, unwcdir);
763 printf("Multiple-level wildcards are not supported\n");
768 cdir = canonify(unwcdir);
770 sftp_register(req = fxp_opendir_send(cdir));
771 rreq = sftp_find_request(pktin = sftp_recv());
773 dirh = fxp_opendir_recv(pktin, rreq);
776 swcm = snew(SftpWildcardMatcher);
779 swcm->wildcard = dupstr(wildcard);
780 swcm->prefix = unwcdir;
782 printf("Unable to open %s: %s\n", cdir, fxp_error());
792 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
794 struct fxp_name *name;
795 struct sftp_packet *pktin;
796 struct sftp_request *req, *rreq;
799 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
800 fxp_free_names(swcm->names);
805 sftp_register(req = fxp_readdir_send(swcm->dirh));
806 rreq = sftp_find_request(pktin = sftp_recv());
808 swcm->names = fxp_readdir_recv(pktin, rreq);
811 if (fxp_error_type() != SSH_FX_EOF)
812 printf("%s: reading directory: %s\n", swcm->prefix,
820 assert(swcm->names && swcm->namepos < swcm->names->nnames);
822 name = &swcm->names->names[swcm->namepos++];
824 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
825 continue; /* expected bad filenames */
827 if (!vet_filename(name->filename)) {
828 printf("ignoring potentially dangerous server-"
829 "supplied filename '%s'\n", name->filename);
830 continue; /* unexpected bad filename */
833 if (!wc_match(swcm->wildcard, name->filename))
834 continue; /* doesn't match the wildcard */
837 * We have a working filename. Return it.
839 return dupprintf("%s%s%s", swcm->prefix,
841 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
847 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
849 struct sftp_packet *pktin;
850 struct sftp_request *req, *rreq;
852 sftp_register(req = fxp_close_send(swcm->dirh));
853 rreq = sftp_find_request(pktin = sftp_recv());
855 fxp_close_recv(pktin, rreq);
858 fxp_free_names(swcm->names);
861 sfree(swcm->wildcard);
867 * General function to match a potential wildcard in a filename
868 * argument and iterate over every matching file. Used in several
869 * PSFTP commands (rmdir, rm, chmod, mv).
871 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
873 char *unwcfname, *newname, *cname;
876 unwcfname = snewn(strlen(filename)+1, char);
877 is_wc = !wc_unescape(unwcfname, filename);
880 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
889 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
890 cname = canonify(newname);
892 printf("%s: canonify: %s\n", newname, fxp_error());
896 ret &= func(ctx, cname);
901 /* Politely warn the user that nothing matched. */
902 printf("%s: nothing matched\n", filename);
905 sftp_finish_wildcard_matching(swcm);
907 cname = canonify(unwcfname);
909 printf("%s: canonify: %s\n", filename, fxp_error());
912 ret = func(ctx, cname);
921 * Handy helper function.
923 int is_wildcard(char *name)
925 char *unwcfname = snewn(strlen(name)+1, char);
926 int is_wc = !wc_unescape(unwcfname, name);
931 /* ----------------------------------------------------------------------
932 * Actual sftp commands.
934 struct sftp_command {
936 int nwords, wordssize;
937 int (*obey) (struct sftp_command *); /* returns <0 to quit */
940 int sftp_cmd_null(struct sftp_command *cmd)
942 return 1; /* success */
945 int sftp_cmd_unknown(struct sftp_command *cmd)
947 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
948 return 0; /* failure */
951 int sftp_cmd_quit(struct sftp_command *cmd)
956 int sftp_cmd_close(struct sftp_command *cmd)
963 if (back != NULL && back->connected(backhandle)) {
965 back->special(backhandle, TS_EOF);
966 sftp_recvdata(&ch, 1);
974 * List a directory. If no arguments are given, list pwd; otherwise
975 * list the directory given in words[1].
977 int sftp_cmd_ls(struct sftp_command *cmd)
979 struct fxp_handle *dirh;
980 struct fxp_names *names;
981 struct fxp_name **ournames;
982 int nnames, namesize;
983 char *dir, *cdir, *unwcdir, *wildcard;
984 struct sftp_packet *pktin;
985 struct sftp_request *req, *rreq;
998 unwcdir = snewn(1 + strlen(dir), char);
999 if (wc_unescape(unwcdir, dir)) {
1006 wildcard = stripslashes(dir, 0);
1007 unwcdir = dupstr(dir);
1008 len = wildcard - dir;
1009 unwcdir[len] = '\0';
1010 if (len > 0 && unwcdir[len-1] == '/')
1011 unwcdir[len-1] = '\0';
1012 tmpdir = snewn(1 + len, char);
1013 check = wc_unescape(tmpdir, unwcdir);
1016 printf("Multiple-level wildcards are not supported\n");
1023 cdir = canonify(dir);
1025 printf("%s: canonify: %s\n", dir, fxp_error());
1030 printf("Listing directory %s\n", cdir);
1032 sftp_register(req = fxp_opendir_send(cdir));
1033 rreq = sftp_find_request(pktin = sftp_recv());
1034 assert(rreq == req);
1035 dirh = fxp_opendir_recv(pktin, rreq);
1038 printf("Unable to open %s: %s\n", dir, fxp_error());
1040 nnames = namesize = 0;
1045 sftp_register(req = fxp_readdir_send(dirh));
1046 rreq = sftp_find_request(pktin = sftp_recv());
1047 assert(rreq == req);
1048 names = fxp_readdir_recv(pktin, rreq);
1050 if (names == NULL) {
1051 if (fxp_error_type() == SSH_FX_EOF)
1053 printf("Reading directory %s: %s\n", dir, fxp_error());
1056 if (names->nnames == 0) {
1057 fxp_free_names(names);
1061 if (nnames + names->nnames >= namesize) {
1062 namesize += names->nnames + 128;
1063 ournames = sresize(ournames, namesize, struct fxp_name *);
1066 for (i = 0; i < names->nnames; i++)
1067 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1068 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1070 fxp_free_names(names);
1072 sftp_register(req = fxp_close_send(dirh));
1073 rreq = sftp_find_request(pktin = sftp_recv());
1074 assert(rreq == req);
1075 fxp_close_recv(pktin, rreq);
1078 * Now we have our filenames. Sort them by actual file
1079 * name, and then output the longname parts.
1081 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1086 for (i = 0; i < nnames; i++) {
1087 printf("%s\n", ournames[i]->longname);
1088 fxp_free_name(ournames[i]);
1100 * Change directories. We do this by canonifying the new name, then
1101 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1103 int sftp_cmd_cd(struct sftp_command *cmd)
1105 struct fxp_handle *dirh;
1106 struct sftp_packet *pktin;
1107 struct sftp_request *req, *rreq;
1115 if (cmd->nwords < 2)
1116 dir = dupstr(homedir);
1118 dir = canonify(cmd->words[1]);
1121 printf("%s: canonify: %s\n", dir, fxp_error());
1125 sftp_register(req = fxp_opendir_send(dir));
1126 rreq = sftp_find_request(pktin = sftp_recv());
1127 assert(rreq == req);
1128 dirh = fxp_opendir_recv(pktin, rreq);
1131 printf("Directory %s: %s\n", dir, fxp_error());
1136 sftp_register(req = fxp_close_send(dirh));
1137 rreq = sftp_find_request(pktin = sftp_recv());
1138 assert(rreq == req);
1139 fxp_close_recv(pktin, rreq);
1143 printf("Remote directory is now %s\n", pwd);
1149 * Print current directory. Easy as pie.
1151 int sftp_cmd_pwd(struct sftp_command *cmd)
1158 printf("Remote directory is %s\n", pwd);
1163 * Get a file and save it at the local end. We have three very
1164 * similar commands here. The basic one is `get'; `reget' differs
1165 * in that it checks for the existence of the destination file and
1166 * starts from where a previous aborted transfer left off; `mget'
1167 * differs in that it interprets all its arguments as files to
1168 * transfer (never as a different local name for a remote file) and
1169 * can handle wildcards.
1171 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1173 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1175 int recurse = FALSE;
1183 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1184 if (!strcmp(cmd->words[i], "--")) {
1185 /* finish processing options */
1188 } else if (!strcmp(cmd->words[i], "-r")) {
1191 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1197 if (i >= cmd->nwords) {
1198 printf("%s: expects a filename\n", cmd->words[0]);
1204 SftpWildcardMatcher *swcm;
1206 origfname = cmd->words[i++];
1207 unwcfname = snewn(strlen(origfname)+1, char);
1209 if (multiple && !wc_unescape(unwcfname, origfname)) {
1210 swcm = sftp_begin_wildcard_matching(origfname);
1215 origwfname = sftp_wildcard_get_filename(swcm);
1217 /* Politely warn the user that nothing matched. */
1218 printf("%s: nothing matched\n", origfname);
1219 sftp_finish_wildcard_matching(swcm);
1224 origwfname = origfname;
1228 while (origwfname) {
1229 fname = canonify(origwfname);
1232 printf("%s: canonify: %s\n", origwfname, fxp_error());
1237 if (!multiple && i < cmd->nwords)
1238 outfname = cmd->words[i++];
1240 outfname = stripslashes(origwfname, 0);
1242 ret = sftp_get_file(fname, outfname, recurse, restart);
1248 origwfname = sftp_wildcard_get_filename(swcm);
1255 sftp_finish_wildcard_matching(swcm);
1259 } while (multiple && i < cmd->nwords);
1263 int sftp_cmd_get(struct sftp_command *cmd)
1265 return sftp_general_get(cmd, 0, 0);
1267 int sftp_cmd_mget(struct sftp_command *cmd)
1269 return sftp_general_get(cmd, 0, 1);
1271 int sftp_cmd_reget(struct sftp_command *cmd)
1273 return sftp_general_get(cmd, 1, 0);
1277 * Send a file and store it at the remote end. We have three very
1278 * similar commands here. The basic one is `put'; `reput' differs
1279 * in that it checks for the existence of the destination file and
1280 * starts from where a previous aborted transfer left off; `mput'
1281 * differs in that it interprets all its arguments as files to
1282 * transfer (never as a different remote name for a local file) and
1283 * can handle wildcards.
1285 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1287 char *fname, *wfname, *origoutfname, *outfname;
1289 int recurse = FALSE;
1297 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1298 if (!strcmp(cmd->words[i], "--")) {
1299 /* finish processing options */
1302 } else if (!strcmp(cmd->words[i], "-r")) {
1305 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1311 if (i >= cmd->nwords) {
1312 printf("%s: expects a filename\n", cmd->words[0]);
1318 WildcardMatcher *wcm;
1319 fname = cmd->words[i++];
1321 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1322 wcm = begin_wildcard_matching(fname);
1323 wfname = wildcard_get_filename(wcm);
1325 /* Politely warn the user that nothing matched. */
1326 printf("%s: nothing matched\n", fname);
1327 finish_wildcard_matching(wcm);
1336 if (!multiple && i < cmd->nwords)
1337 origoutfname = cmd->words[i++];
1339 origoutfname = stripslashes(wfname, 1);
1341 outfname = canonify(origoutfname);
1343 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1346 finish_wildcard_matching(wcm);
1350 ret = sftp_put_file(wfname, outfname, recurse, restart);
1355 wfname = wildcard_get_filename(wcm);
1362 finish_wildcard_matching(wcm);
1367 } while (multiple && i < cmd->nwords);
1371 int sftp_cmd_put(struct sftp_command *cmd)
1373 return sftp_general_put(cmd, 0, 0);
1375 int sftp_cmd_mput(struct sftp_command *cmd)
1377 return sftp_general_put(cmd, 0, 1);
1379 int sftp_cmd_reput(struct sftp_command *cmd)
1381 return sftp_general_put(cmd, 1, 0);
1384 int sftp_cmd_mkdir(struct sftp_command *cmd)
1387 struct sftp_packet *pktin;
1388 struct sftp_request *req, *rreq;
1397 if (cmd->nwords < 2) {
1398 printf("mkdir: expects a directory\n");
1403 for (i = 1; i < cmd->nwords; i++) {
1404 dir = canonify(cmd->words[i]);
1406 printf("%s: canonify: %s\n", dir, fxp_error());
1410 sftp_register(req = fxp_mkdir_send(dir));
1411 rreq = sftp_find_request(pktin = sftp_recv());
1412 assert(rreq == req);
1413 result = fxp_mkdir_recv(pktin, rreq);
1416 printf("mkdir %s: %s\n", dir, fxp_error());
1419 printf("mkdir %s: OK\n", dir);
1427 static int sftp_action_rmdir(void *vctx, char *dir)
1429 struct sftp_packet *pktin;
1430 struct sftp_request *req, *rreq;
1433 sftp_register(req = fxp_rmdir_send(dir));
1434 rreq = sftp_find_request(pktin = sftp_recv());
1435 assert(rreq == req);
1436 result = fxp_rmdir_recv(pktin, rreq);
1439 printf("rmdir %s: %s\n", dir, fxp_error());
1443 printf("rmdir %s: OK\n", dir);
1448 int sftp_cmd_rmdir(struct sftp_command *cmd)
1457 if (cmd->nwords < 2) {
1458 printf("rmdir: expects a directory\n");
1463 for (i = 1; i < cmd->nwords; i++)
1464 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1469 static int sftp_action_rm(void *vctx, char *fname)
1471 struct sftp_packet *pktin;
1472 struct sftp_request *req, *rreq;
1475 sftp_register(req = fxp_remove_send(fname));
1476 rreq = sftp_find_request(pktin = sftp_recv());
1477 assert(rreq == req);
1478 result = fxp_remove_recv(pktin, rreq);
1481 printf("rm %s: %s\n", fname, fxp_error());
1485 printf("rm %s: OK\n", fname);
1490 int sftp_cmd_rm(struct sftp_command *cmd)
1499 if (cmd->nwords < 2) {
1500 printf("rm: expects a filename\n");
1505 for (i = 1; i < cmd->nwords; i++)
1506 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1511 static int check_is_dir(char *dstfname)
1513 struct sftp_packet *pktin;
1514 struct sftp_request *req, *rreq;
1515 struct fxp_attrs attrs;
1518 sftp_register(req = fxp_stat_send(dstfname));
1519 rreq = sftp_find_request(pktin = sftp_recv());
1520 assert(rreq == req);
1521 result = fxp_stat_recv(pktin, rreq, &attrs);
1524 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1525 (attrs.permissions & 0040000))
1531 struct sftp_context_mv {
1536 static int sftp_action_mv(void *vctx, char *srcfname)
1538 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1539 struct sftp_packet *pktin;
1540 struct sftp_request *req, *rreq;
1542 char *finalfname, *newcanon = NULL;
1545 if (ctx->dest_is_dir) {
1549 p = srcfname + strlen(srcfname);
1550 while (p > srcfname && p[-1] != '/') p--;
1551 newname = dupcat(ctx->dstfname, "/", p, NULL);
1552 newcanon = canonify(newname);
1554 printf("%s: canonify: %s\n", newname, fxp_error());
1560 finalfname = newcanon;
1562 finalfname = ctx->dstfname;
1565 sftp_register(req = fxp_rename_send(srcfname, finalfname));
1566 rreq = sftp_find_request(pktin = sftp_recv());
1567 assert(rreq == req);
1568 result = fxp_rename_recv(pktin, rreq);
1570 error = result ? NULL : fxp_error();
1573 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1576 printf("%s -> %s\n", srcfname, finalfname);
1584 int sftp_cmd_mv(struct sftp_command *cmd)
1586 struct sftp_context_mv actx, *ctx = &actx;
1594 if (cmd->nwords < 3) {
1595 printf("mv: expects two filenames\n");
1599 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1600 if (!ctx->dstfname) {
1601 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1606 * If there's more than one source argument, or one source
1607 * argument which is a wildcard, we _require_ that the
1608 * destination is a directory.
1610 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1611 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1612 printf("mv: multiple or wildcard arguments require the destination"
1613 " to be a directory\n");
1614 sfree(ctx->dstfname);
1619 * Now iterate over the source arguments.
1622 for (i = 1; i < cmd->nwords-1; i++)
1623 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1625 sfree(ctx->dstfname);
1629 struct sftp_context_chmod {
1630 unsigned attrs_clr, attrs_xor;
1633 static int sftp_action_chmod(void *vctx, char *fname)
1635 struct fxp_attrs attrs;
1636 struct sftp_packet *pktin;
1637 struct sftp_request *req, *rreq;
1639 unsigned oldperms, newperms;
1640 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1642 sftp_register(req = fxp_stat_send(fname));
1643 rreq = sftp_find_request(pktin = sftp_recv());
1644 assert(rreq == req);
1645 result = fxp_stat_recv(pktin, rreq, &attrs);
1647 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1648 printf("get attrs for %s: %s\n", fname,
1649 result ? "file permissions not provided" : fxp_error());
1653 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1654 oldperms = attrs.permissions & 07777;
1655 attrs.permissions &= ~ctx->attrs_clr;
1656 attrs.permissions ^= ctx->attrs_xor;
1657 newperms = attrs.permissions & 07777;
1659 if (oldperms == newperms)
1660 return 1; /* no need to do anything! */
1662 sftp_register(req = fxp_setstat_send(fname, attrs));
1663 rreq = sftp_find_request(pktin = sftp_recv());
1664 assert(rreq == req);
1665 result = fxp_setstat_recv(pktin, rreq);
1668 printf("set attrs for %s: %s\n", fname, fxp_error());
1672 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1677 int sftp_cmd_chmod(struct sftp_command *cmd)
1681 struct sftp_context_chmod actx, *ctx = &actx;
1688 if (cmd->nwords < 3) {
1689 printf("chmod: expects a mode specifier and a filename\n");
1694 * Attempt to parse the mode specifier in cmd->words[1]. We
1695 * don't support the full horror of Unix chmod; instead we
1696 * support a much simpler syntax in which the user can either
1697 * specify an octal number, or a comma-separated sequence of
1698 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1699 * _only_ be omitted if the only attribute mentioned is t,
1700 * since all others require a user/group/other specification.
1701 * Additionally, the s attribute may not be specified for any
1702 * [ugoa] specifications other than exactly u or exactly g.
1704 ctx->attrs_clr = ctx->attrs_xor = 0;
1705 mode = cmd->words[1];
1706 if (mode[0] >= '0' && mode[0] <= '9') {
1707 if (mode[strspn(mode, "01234567")]) {
1708 printf("chmod: numeric file modes should"
1709 " contain digits 0-7 only\n");
1712 ctx->attrs_clr = 07777;
1713 sscanf(mode, "%o", &ctx->attrs_xor);
1714 ctx->attrs_xor &= ctx->attrs_clr;
1717 char *modebegin = mode;
1718 unsigned subset, perms;
1722 while (*mode && *mode != ',' &&
1723 *mode != '+' && *mode != '-' && *mode != '=') {
1725 case 'u': subset |= 04700; break; /* setuid, user perms */
1726 case 'g': subset |= 02070; break; /* setgid, group perms */
1727 case 'o': subset |= 00007; break; /* just other perms */
1728 case 'a': subset |= 06777; break; /* all of the above */
1730 printf("chmod: file mode '%.*s' contains unrecognised"
1731 " user/group/other specifier '%c'\n",
1732 (int)strcspn(modebegin, ","), modebegin, *mode);
1737 if (!*mode || *mode == ',') {
1738 printf("chmod: file mode '%.*s' is incomplete\n",
1739 (int)strcspn(modebegin, ","), modebegin);
1743 if (!*mode || *mode == ',') {
1744 printf("chmod: file mode '%.*s' is incomplete\n",
1745 (int)strcspn(modebegin, ","), modebegin);
1749 while (*mode && *mode != ',') {
1751 case 'r': perms |= 00444; break;
1752 case 'w': perms |= 00222; break;
1753 case 'x': perms |= 00111; break;
1754 case 't': perms |= 01000; subset |= 01000; break;
1756 if ((subset & 06777) != 04700 &&
1757 (subset & 06777) != 02070) {
1758 printf("chmod: file mode '%.*s': set[ug]id bit should"
1759 " be used with exactly one of u or g only\n",
1760 (int)strcspn(modebegin, ","), modebegin);
1766 printf("chmod: file mode '%.*s' contains unrecognised"
1767 " permission specifier '%c'\n",
1768 (int)strcspn(modebegin, ","), modebegin, *mode);
1773 if (!(subset & 06777) && (perms &~ subset)) {
1774 printf("chmod: file mode '%.*s' contains no user/group/other"
1775 " specifier and permissions other than 't' \n",
1776 (int)strcspn(modebegin, ","), modebegin);
1782 ctx->attrs_clr |= perms;
1783 ctx->attrs_xor |= perms;
1786 ctx->attrs_clr |= perms;
1787 ctx->attrs_xor &= ~perms;
1790 ctx->attrs_clr |= subset;
1791 ctx->attrs_xor |= perms;
1794 if (*mode) mode++; /* eat comma */
1799 for (i = 2; i < cmd->nwords; i++)
1800 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1805 static int sftp_cmd_open(struct sftp_command *cmd)
1810 printf("psftp: already connected\n");
1814 if (cmd->nwords < 2) {
1815 printf("open: expects a host name\n");
1819 if (cmd->nwords > 2) {
1820 portnumber = atoi(cmd->words[2]);
1821 if (portnumber == 0) {
1822 printf("open: invalid port number\n");
1828 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1829 back = NULL; /* connection is already closed */
1830 return -1; /* this is fatal */
1836 static int sftp_cmd_lcd(struct sftp_command *cmd)
1838 char *currdir, *errmsg;
1840 if (cmd->nwords < 2) {
1841 printf("lcd: expects a local directory name\n");
1845 errmsg = psftp_lcd(cmd->words[1]);
1847 printf("lcd: unable to change directory: %s\n", errmsg);
1852 currdir = psftp_getcwd();
1853 printf("New local directory is %s\n", currdir);
1859 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1863 currdir = psftp_getcwd();
1864 printf("Current local directory is %s\n", currdir);
1870 static int sftp_cmd_pling(struct sftp_command *cmd)
1874 exitcode = system(cmd->words[1]);
1875 return (exitcode == 0);
1878 static int sftp_cmd_help(struct sftp_command *cmd);
1880 static struct sftp_cmd_lookup {
1883 * For help purposes, there are two kinds of command:
1885 * - primary commands, in which `longhelp' is non-NULL. In
1886 * this case `shorthelp' is descriptive text, and `longhelp'
1887 * is longer descriptive text intended to be printed after
1890 * - alias commands, in which `longhelp' is NULL. In this case
1891 * `shorthelp' is the name of a primary command, which
1892 * contains the help that should double up for this command.
1894 int listed; /* do we list this in primary help? */
1897 int (*obey) (struct sftp_command *);
1900 * List of sftp commands. This is binary-searched so it MUST be
1904 "!", TRUE, "run a local command",
1906 /* FIXME: this example is crap for non-Windows. */
1907 " Runs a local command. For example, \"!del myfile\".\n",
1911 "bye", TRUE, "finish your SFTP session",
1913 " Terminates your SFTP session and quits the PSFTP program.\n",
1917 "cd", TRUE, "change your remote working directory",
1918 " [ <new working directory> ]\n"
1919 " Change the remote working directory for your SFTP session.\n"
1920 " If a new working directory is not supplied, you will be\n"
1921 " returned to your home directory.\n",
1925 "chmod", TRUE, "change file permissions and modes",
1926 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1927 " Change the file permissions on one or more remote files or\n"
1929 " <modes> can be any octal Unix permission specifier.\n"
1930 " Alternatively, <modes> can include the following modifiers:\n"
1931 " u+r make file readable by owning user\n"
1932 " u+w make file writable by owning user\n"
1933 " u+x make file executable by owning user\n"
1934 " u-r make file not readable by owning user\n"
1935 " [also u-w, u-x]\n"
1936 " g+r make file readable by members of owning group\n"
1937 " [also g+w, g+x, g-r, g-w, g-x]\n"
1938 " o+r make file readable by all other users\n"
1939 " [also o+w, o+x, o-r, o-w, o-x]\n"
1940 " a+r make file readable by absolutely everybody\n"
1941 " [also a+w, a+x, a-r, a-w, a-x]\n"
1942 " u+s enable the Unix set-user-ID bit\n"
1943 " u-s disable the Unix set-user-ID bit\n"
1944 " g+s enable the Unix set-group-ID bit\n"
1945 " g-s disable the Unix set-group-ID bit\n"
1946 " +t enable the Unix \"sticky bit\"\n"
1947 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1948 " more than one user for the same modifier (\"ug+w\"). You can\n"
1949 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1953 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1955 " Terminates your SFTP session, but does not quit the PSFTP\n"
1956 " program. You can then use \"open\" to start another SFTP\n"
1957 " session, to the same server or to a different one.\n",
1961 "del", TRUE, "delete files on the remote server",
1962 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1963 " Delete a file or files from the server.\n",
1967 "delete", FALSE, "del", NULL, sftp_cmd_rm
1970 "dir", TRUE, "list remote files",
1971 " [ <directory-name> ]/[ <wildcard> ]\n"
1972 " List the contents of a specified directory on the server.\n"
1973 " If <directory-name> is not given, the current working directory\n"
1975 " If <wildcard> is given, it is treated as a set of files to\n"
1976 " list; otherwise, all files are listed.\n",
1980 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1983 "get", TRUE, "download a file from the server to your local machine",
1984 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1985 " Downloads a file on the server and stores it locally under\n"
1986 " the same name, or under a different one if you supply the\n"
1987 " argument <local-filename>.\n"
1988 " If -r specified, recursively fetch a directory.\n",
1992 "help", TRUE, "give help",
1993 " [ <command> [ <command> ... ] ]\n"
1994 " Give general help if no commands are specified.\n"
1995 " If one or more commands are specified, give specific help on\n"
1996 " those particular commands.\n",
2000 "lcd", TRUE, "change local working directory",
2001 " <local-directory-name>\n"
2002 " Change the local working directory of the PSFTP program (the\n"
2003 " default location where the \"get\" command will save files).\n",
2007 "lpwd", TRUE, "print local working directory",
2009 " Print the local working directory of the PSFTP program (the\n"
2010 " default location where the \"get\" command will save files).\n",
2014 "ls", TRUE, "dir", NULL,
2018 "mget", TRUE, "download multiple files at once",
2019 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2020 " Downloads many files from the server, storing each one under\n"
2021 " the same name it has on the server side. You can use wildcards\n"
2022 " such as \"*.c\" to specify lots of files at once.\n"
2023 " If -r specified, recursively fetch files and directories.\n",
2027 "mkdir", TRUE, "create directories on the remote server",
2028 " <directory-name> [ <directory-name>... ]\n"
2029 " Creates directories with the given names on the server.\n",
2033 "mput", TRUE, "upload multiple files at once",
2034 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2035 " Uploads many files to the server, storing each one under the\n"
2036 " same name it has on the client side. You can use wildcards\n"
2037 " such as \"*.c\" to specify lots of files at once.\n"
2038 " If -r specified, recursively store files and directories.\n",
2042 "mv", TRUE, "move or rename file(s) on the remote server",
2043 " <source> [ <source>... ] <destination>\n"
2044 " Moves or renames <source>(s) on the server to <destination>,\n"
2045 " also on the server.\n"
2046 " If <destination> specifies an existing directory, then <source>\n"
2047 " may be a wildcard, and multiple <source>s may be given; all\n"
2048 " source files are moved into <destination>.\n"
2049 " Otherwise, <source> must specify a single file, which is moved\n"
2050 " or renamed so that it is accessible under the name <destination>.\n",
2054 "open", TRUE, "connect to a host",
2055 " [<user>@]<hostname> [<port>]\n"
2056 " Establishes an SFTP connection to a given host. Only usable\n"
2057 " when you are not already connected to a server.\n",
2061 "put", TRUE, "upload a file from your local machine to the server",
2062 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2063 " Uploads a file to the server and stores it there under\n"
2064 " the same name, or under a different one if you supply the\n"
2065 " argument <remote-filename>.\n"
2066 " If -r specified, recursively store a directory.\n",
2070 "pwd", TRUE, "print your remote working directory",
2072 " Print the current remote working directory for your SFTP session.\n",
2076 "quit", TRUE, "bye", NULL,
2080 "reget", TRUE, "continue downloading files",
2081 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2082 " Works exactly like the \"get\" command, but the local file\n"
2083 " must already exist. The download will begin at the end of the\n"
2084 " file. This is for resuming a download that was interrupted.\n"
2085 " If -r specified, resume interrupted \"get -r\".\n",
2089 "ren", TRUE, "mv", NULL,
2093 "rename", FALSE, "mv", NULL,
2097 "reput", TRUE, "continue uploading files",
2098 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2099 " Works exactly like the \"put\" command, but the remote file\n"
2100 " must already exist. The upload will begin at the end of the\n"
2101 " file. This is for resuming an upload that was interrupted.\n"
2102 " If -r specified, resume interrupted \"put -r\".\n",
2106 "rm", TRUE, "del", NULL,
2110 "rmdir", TRUE, "remove directories on the remote server",
2111 " <directory-name> [ <directory-name>... ]\n"
2112 " Removes the directory with the given name on the server.\n"
2113 " The directory will not be removed unless it is empty.\n"
2114 " Wildcards may be used to specify multiple directories.\n",
2119 const struct sftp_cmd_lookup *lookup_command(char *name)
2124 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2127 cmp = strcmp(name, sftp_lookup[k].name);
2133 return &sftp_lookup[k];
2139 static int sftp_cmd_help(struct sftp_command *cmd)
2142 if (cmd->nwords == 1) {
2144 * Give short help on each command.
2148 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2150 if (!sftp_lookup[i].listed)
2152 len = strlen(sftp_lookup[i].name);
2156 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2157 const struct sftp_cmd_lookup *lookup;
2158 if (!sftp_lookup[i].listed)
2160 lookup = &sftp_lookup[i];
2161 printf("%-*s", maxlen+2, lookup->name);
2162 if (lookup->longhelp == NULL)
2163 lookup = lookup_command(lookup->shorthelp);
2164 printf("%s\n", lookup->shorthelp);
2168 * Give long help on specific commands.
2170 for (i = 1; i < cmd->nwords; i++) {
2171 const struct sftp_cmd_lookup *lookup;
2172 lookup = lookup_command(cmd->words[i]);
2174 printf("help: %s: command not found\n", cmd->words[i]);
2176 printf("%s", lookup->name);
2177 if (lookup->longhelp == NULL)
2178 lookup = lookup_command(lookup->shorthelp);
2179 printf("%s", lookup->longhelp);
2186 /* ----------------------------------------------------------------------
2187 * Command line reading and parsing.
2189 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2192 struct sftp_command *cmd;
2196 cmd = snew(struct sftp_command);
2206 line = fgetline(fp);
2208 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2211 if (!line || !*line) {
2212 cmd->obey = sftp_cmd_quit;
2213 if ((mode == 0) || (modeflags & 1))
2215 return cmd; /* eof */
2218 line[strcspn(line, "\r\n")] = '\0';
2220 if (modeflags & 1) {
2221 printf("%s\n", line);
2225 while (*p && (*p == ' ' || *p == '\t'))
2230 * Special case: the ! command. This is always parsed as
2231 * exactly two words: one containing the !, and the second
2232 * containing everything else on the line.
2234 cmd->nwords = cmd->wordssize = 2;
2235 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2236 cmd->words[0] = dupstr("!");
2237 cmd->words[1] = dupstr(p+1);
2241 * Parse the command line into words. The syntax is:
2242 * - double quotes are removed, but cause spaces within to be
2243 * treated as non-separating.
2244 * - a double-doublequote pair is a literal double quote, inside
2245 * _or_ outside quotes. Like this:
2247 * firstword "second word" "this has ""quotes"" in" and""this""
2253 * >this has "quotes" in<
2257 /* skip whitespace */
2258 while (*p && (*p == ' ' || *p == '\t'))
2260 /* mark start of word */
2261 q = r = p; /* q sits at start, r writes word */
2264 if (!quoting && (*p == ' ' || *p == '\t'))
2265 break; /* reached end of word */
2266 else if (*p == '"' && p[1] == '"')
2267 p += 2, *r++ = '"'; /* a literal quote */
2269 p++, quoting = !quoting;
2274 p++; /* skip over the whitespace */
2276 if (cmd->nwords >= cmd->wordssize) {
2277 cmd->wordssize = cmd->nwords + 16;
2278 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2280 cmd->words[cmd->nwords++] = dupstr(q);
2287 * Now parse the first word and assign a function.
2290 if (cmd->nwords == 0)
2291 cmd->obey = sftp_cmd_null;
2293 const struct sftp_cmd_lookup *lookup;
2294 lookup = lookup_command(cmd->words[0]);
2296 cmd->obey = sftp_cmd_unknown;
2298 cmd->obey = lookup->obey;
2304 static int do_sftp_init(void)
2306 struct sftp_packet *pktin;
2307 struct sftp_request *req, *rreq;
2310 * Do protocol initialisation.
2314 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2315 return 1; /* failure */
2319 * Find out where our home directory is.
2321 sftp_register(req = fxp_realpath_send("."));
2322 rreq = sftp_find_request(pktin = sftp_recv());
2323 assert(rreq == req);
2324 homedir = fxp_realpath_recv(pktin, rreq);
2328 "Warning: failed to resolve home directory: %s\n",
2330 homedir = dupstr(".");
2332 printf("Remote working directory is %s\n", homedir);
2334 pwd = dupstr(homedir);
2338 void do_sftp_cleanup()
2342 back->special(backhandle, TS_EOF);
2343 sftp_recvdata(&ch, 1);
2344 back->free(backhandle);
2345 sftp_cleanup_request();
2359 void do_sftp(int mode, int modeflags, char *batchfile)
2369 /* ------------------------------------------------------------------
2370 * Now we're ready to do Real Stuff.
2373 struct sftp_command *cmd;
2374 cmd = sftp_getcmd(NULL, 0, 0);
2377 ret = cmd->obey(cmd);
2380 for(i = 0; i < cmd->nwords; i++)
2381 sfree(cmd->words[i]);
2389 fp = fopen(batchfile, "r");
2391 printf("Fatal: unable to open %s\n", batchfile);
2395 struct sftp_command *cmd;
2396 cmd = sftp_getcmd(fp, mode, modeflags);
2399 ret = cmd->obey(cmd);
2403 if (!(modeflags & 2))
2412 /* ----------------------------------------------------------------------
2413 * Dirty bits: integration with PuTTY.
2416 static int verbose = 0;
2419 * Print an error message and perform a fatal exit.
2421 void fatalbox(char *fmt, ...)
2426 str = dupvprintf(fmt, ap);
2427 str2 = dupcat("Fatal: ", str, "\n", NULL);
2430 fputs(str2, stderr);
2435 void modalfatalbox(char *fmt, ...)
2440 str = dupvprintf(fmt, ap);
2441 str2 = dupcat("Fatal: ", str, "\n", NULL);
2444 fputs(str2, stderr);
2449 void connection_fatal(void *frontend, char *fmt, ...)
2454 str = dupvprintf(fmt, ap);
2455 str2 = dupcat("Fatal: ", str, "\n", NULL);
2458 fputs(str2, stderr);
2464 void ldisc_send(void *handle, char *buf, int len, int interactive)
2467 * This is only here because of the calls to ldisc_send(NULL,
2468 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2469 * ldisc as an ldisc. So if we get called with any real data, I
2470 * want to know about it.
2476 * In psftp, all agent requests should be synchronous, so this is a
2477 * never-called stub.
2479 void agent_schedule_callback(void (*callback)(void *, void *, int),
2480 void *callback_ctx, void *data, int len)
2482 assert(!"We shouldn't be here");
2486 * Receive a block of data from the SSH link. Block until all data
2489 * To do this, we repeatedly call the SSH protocol module, with our
2490 * own trap in from_backend() to catch the data that comes back. We
2491 * do this until we have enough data.
2494 static unsigned char *outptr; /* where to put the data */
2495 static unsigned outlen; /* how much data required */
2496 static unsigned char *pending = NULL; /* any spare data */
2497 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2498 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2500 unsigned char *p = (unsigned char *) data;
2501 unsigned len = (unsigned) datalen;
2504 * stderr data is just spouted to local stderr and otherwise
2509 fwrite(data, 1, len, stderr);
2514 * If this is before the real session begins, just return.
2519 if ((outlen > 0) && (len > 0)) {
2520 unsigned used = outlen;
2523 memcpy(outptr, p, used);
2531 if (pendsize < pendlen + len) {
2532 pendsize = pendlen + len + 4096;
2533 pending = sresize(pending, pendsize, unsigned char);
2535 memcpy(pending + pendlen, p, len);
2541 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2544 * No "untrusted" output should get here (the way the code is
2545 * currently, it's all diverted by FLAG_STDERR).
2547 assert(!"Unexpected call to from_backend_untrusted()");
2548 return 0; /* not reached */
2550 int sftp_recvdata(char *buf, int len)
2552 outptr = (unsigned char *) buf;
2556 * See if the pending-input block contains some of what we
2560 unsigned pendused = pendlen;
2561 if (pendused > outlen)
2563 memcpy(outptr, pending, pendused);
2564 memmove(pending, pending + pendused, pendlen - pendused);
2567 pendlen -= pendused;
2577 while (outlen > 0) {
2578 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2579 return 0; /* doom */
2584 int sftp_senddata(char *buf, int len)
2586 back->send(backhandle, buf, len);
2591 * Short description of parameters.
2593 static void usage(void)
2595 printf("PuTTY Secure File Transfer (SFTP) client\n");
2596 printf("%s\n", ver);
2597 printf("Usage: psftp [options] [user@]host\n");
2598 printf("Options:\n");
2599 printf(" -V print version information and exit\n");
2600 printf(" -pgpfp print PGP key fingerprints and exit\n");
2601 printf(" -b file use specified batchfile\n");
2602 printf(" -bc output batchfile commands\n");
2603 printf(" -be don't stop batchfile processing if errors\n");
2604 printf(" -v show verbose messages\n");
2605 printf(" -load sessname Load settings from saved session\n");
2606 printf(" -l user connect with specified username\n");
2607 printf(" -P port connect to specified port\n");
2608 printf(" -pw passw login with specified password\n");
2609 printf(" -1 -2 force use of particular SSH protocol version\n");
2610 printf(" -4 -6 force use of IPv4 or IPv6\n");
2611 printf(" -C enable compression\n");
2612 printf(" -i key private key file for authentication\n");
2613 printf(" -noagent disable use of Pageant\n");
2614 printf(" -agent enable use of Pageant\n");
2615 printf(" -batch disable all interactive prompts\n");
2619 static void version(void)
2621 printf("psftp: %s\n", ver);
2626 * Connect to a host.
2628 static int psftp_connect(char *userhost, char *user, int portnumber)
2630 char *host, *realhost;
2634 /* Separate host and username */
2636 host = strrchr(host, '@');
2642 printf("psftp: multiple usernames specified; using \"%s\"\n",
2649 * If we haven't loaded session details already (e.g., from -load),
2650 * try looking for a session called "host".
2652 if (!loaded_session) {
2653 /* Try to load settings for `host' into a temporary config */
2655 cfg2.host[0] = '\0';
2656 do_defaults(host, &cfg2);
2657 if (cfg2.host[0] != '\0') {
2658 /* Settings present and include hostname */
2659 /* Re-load data into the real config. */
2660 do_defaults(host, &cfg);
2662 /* Session doesn't exist or mention a hostname. */
2663 /* Use `host' as a bare hostname. */
2664 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2665 cfg.host[sizeof(cfg.host) - 1] = '\0';
2668 /* Patch in hostname `host' to session details. */
2669 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2670 cfg.host[sizeof(cfg.host) - 1] = '\0';
2674 * Force use of SSH. (If they got the protocol wrong we assume the
2675 * port is useless too.)
2677 if (cfg.protocol != PROT_SSH) {
2678 cfg.protocol = PROT_SSH;
2683 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2684 * then change it to SSH-2, on the grounds that that's more likely to
2685 * work for SFTP. (Can be overridden with `-1' option.)
2686 * But if it says `2 only' or `2', respect which.
2688 if (cfg.sshprot != 2 && cfg.sshprot != 3)
2692 * Enact command-line overrides.
2694 cmdline_run_saved(&cfg);
2697 * Trim leading whitespace off the hostname if it's there.
2700 int space = strspn(cfg.host, " \t");
2701 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
2704 /* See if host is of the form user@host */
2705 if (cfg.host[0] != '\0') {
2706 char *atsign = strrchr(cfg.host, '@');
2707 /* Make sure we're not overflowing the user field */
2709 if (atsign - cfg.host < sizeof cfg.username) {
2710 strncpy(cfg.username, cfg.host, atsign - cfg.host);
2711 cfg.username[atsign - cfg.host] = '\0';
2713 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
2718 * Trim a colon suffix off the hostname if it's there.
2720 cfg.host[strcspn(cfg.host, ":")] = '\0';
2723 * Remove any remaining whitespace from the hostname.
2727 while (cfg.host[p2] != '\0') {
2728 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
2729 cfg.host[p1] = cfg.host[p2];
2734 cfg.host[p1] = '\0';
2738 if (user != NULL && user[0] != '\0') {
2739 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
2740 cfg.username[sizeof(cfg.username) - 1] = '\0';
2744 cfg.port = portnumber;
2747 * Disable scary things which shouldn't be enabled for simple
2748 * things like SCP and SFTP: agent forwarding, port forwarding,
2751 cfg.x11_forward = 0;
2753 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
2755 /* Set up subsystem name. */
2756 strcpy(cfg.remote_cmd, "sftp");
2757 cfg.ssh_subsys = TRUE;
2761 * Set up fallback option, for SSH-1 servers or servers with the
2762 * sftp subsystem not enabled but the server binary installed
2763 * in the usual place. We only support fallback on Unix
2764 * systems, and we use a kludgy piece of shellery which should
2765 * try to find sftp-server in various places (the obvious
2766 * systemwide spots /usr/lib and /usr/local/lib, and then the
2767 * user's PATH) and finally give up.
2769 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2770 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2773 * the idea being that this will attempt to use either of the
2774 * obvious pathnames and then give up, and when it does give up
2775 * it will print the preferred pathname in the error messages.
2777 cfg.remote_cmd_ptr2 =
2778 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2779 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2781 cfg.ssh_subsys2 = FALSE;
2783 back = &ssh_backend;
2785 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,
2786 0, cfg.tcp_keepalives);
2788 fprintf(stderr, "ssh_init: %s\n", err);
2791 logctx = log_init(NULL, &cfg);
2792 back->provide_logctx(backhandle, logctx);
2793 console_provide_logctx(logctx);
2794 while (!back->sendok(backhandle)) {
2795 if (ssh_sftp_loop_iteration() < 0) {
2796 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2800 if (verbose && realhost != NULL)
2801 printf("Connected to %s\n", realhost);
2802 if (realhost != NULL)
2807 void cmdline_error(char *p, ...)
2810 fprintf(stderr, "psftp: ");
2812 vfprintf(stderr, p, ap);
2814 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2819 * Main program. Parse arguments etc.
2821 int psftp_main(int argc, char *argv[])
2825 char *userhost, *user;
2828 char *batchfile = NULL;
2831 flags = FLAG_STDERR | FLAG_INTERACTIVE
2832 #ifdef FLAG_SYNCAGENT
2836 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2839 userhost = user = NULL;
2841 /* Load Default Settings before doing anything else. */
2842 do_defaults(NULL, &cfg);
2843 loaded_session = FALSE;
2846 for (i = 1; i < argc; i++) {
2848 if (argv[i][0] != '-') {
2852 userhost = dupstr(argv[i]);
2855 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2857 cmdline_error("option \"%s\" requires an argument", argv[i]);
2858 } else if (ret == 2) {
2859 i++; /* skip next argument */
2860 } else if (ret == 1) {
2861 /* We have our own verbosity in addition to `flags'. */
2862 if (flags & FLAG_VERBOSE)
2864 } else if (strcmp(argv[i], "-h") == 0 ||
2865 strcmp(argv[i], "-?") == 0) {
2867 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2870 } else if (strcmp(argv[i], "-V") == 0) {
2872 } else if (strcmp(argv[i], "-batch") == 0) {
2873 console_batch_mode = 1;
2874 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2876 batchfile = argv[++i];
2877 } else if (strcmp(argv[i], "-bc") == 0) {
2878 modeflags = modeflags | 1;
2879 } else if (strcmp(argv[i], "-be") == 0) {
2880 modeflags = modeflags | 2;
2881 } else if (strcmp(argv[i], "--") == 0) {
2885 cmdline_error("unknown option \"%s\"", argv[i]);
2893 * If the loaded session provides a hostname, and a hostname has not
2894 * otherwise been specified, pop it in `userhost' so that
2895 * `psftp -load sessname' is sufficient to start a session.
2897 if (!userhost && cfg.host[0] != '\0') {
2898 userhost = dupstr(cfg.host);
2902 * If a user@host string has already been provided, connect to
2907 ret = psftp_connect(userhost, user, portnumber);
2914 printf("psftp: no hostname specified; use \"open host.name\""
2918 do_sftp(mode, modeflags, batchfile);
2920 if (back != NULL && back->connected(backhandle)) {
2922 back->special(backhandle, TS_EOF);
2923 sftp_recvdata(&ch, 1);
2928 console_provide_logctx(NULL);