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.
328 nextoutfname = dir_file_cat(outfname,
329 ournames[i]->filename);
331 nextoutfname = dupstr(ournames[i]->filename);
332 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
342 * Now we're ready to recurse. Starting at ournames[i]
343 * and continuing on to the end of the list, we
344 * construct a new source and target file name, and
345 * call sftp_get_file again.
347 for (; i < nnames; i++) {
348 char *nextfname, *nextoutfname;
351 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
353 nextoutfname = dir_file_cat(outfname,
354 ournames[i]->filename);
356 nextoutfname = dupstr(ournames[i]->filename);
357 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
358 restart = FALSE; /* after first partial file, do full */
362 for (i = 0; i < nnames; i++) {
363 fxp_free_name(ournames[i]);
371 * Done this recursion level. Free everything.
373 for (i = 0; i < nnames; i++) {
374 fxp_free_name(ournames[i]);
382 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
383 rreq = sftp_find_request(pktin = sftp_recv());
385 fh = fxp_open_recv(pktin, rreq);
388 printf("%s: open for read: %s\n", fname, fxp_error());
393 file = open_existing_wfile(outfname, NULL);
395 file = open_new_file(outfname);
399 printf("local: unable to open %s\n", outfname);
401 sftp_register(req = fxp_close_send(fh));
402 rreq = sftp_find_request(pktin = sftp_recv());
404 fxp_close_recv(pktin, rreq);
411 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
412 printf("reget: cannot restart %s - file too large\n",
414 sftp_register(req = fxp_close_send(fh));
415 rreq = sftp_find_request(pktin = sftp_recv());
417 fxp_close_recv(pktin, rreq);
422 offset = get_file_posn(file);
423 uint64_decimal(offset, decbuf);
424 printf("reget: restarting at file position %s\n", decbuf);
426 offset = uint64_make(0, 0);
429 printf("remote:%s => local:%s\n", fname, outfname);
432 * FIXME: we can use FXP_FSTAT here to get the file size, and
433 * thus put up a progress bar.
436 xfer = xfer_download_init(fh, offset);
437 while (!xfer_done(xfer)) {
442 xfer_download_queue(xfer);
444 ret = xfer_download_gotpkt(xfer, pktin);
448 printf("error while reading: %s\n", fxp_error());
454 while (xfer_download_data(xfer, &vbuf, &len)) {
455 unsigned char *buf = (unsigned char *)vbuf;
459 wlen = write_to_file(file, buf + wpos, len - wpos);
461 printf("error while writing local file\n");
463 xfer_set_error(xfer);
467 if (wpos < len) { /* we had an error */
469 xfer_set_error(xfer);
480 sftp_register(req = fxp_close_send(fh));
481 rreq = sftp_find_request(pktin = sftp_recv());
483 fxp_close_recv(pktin, rreq);
488 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
490 struct fxp_handle *fh;
491 struct fxp_xfer *xfer;
492 struct sftp_packet *pktin;
493 struct sftp_request *req, *rreq;
499 * In recursive mode, see if we're dealing with a directory.
500 * (If we're not in recursive mode, we need not even check: the
501 * subsequent fopen will return an error message.)
503 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
504 struct fxp_attrs attrs;
506 int nnames, namesize;
507 char *name, **ournames;
512 * First, attempt to create the destination directory,
513 * unless it already exists.
515 sftp_register(req = fxp_stat_send(outfname));
516 rreq = sftp_find_request(pktin = sftp_recv());
518 result = fxp_stat_recv(pktin, rreq, &attrs);
520 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
521 !(attrs.permissions & 0040000)) {
522 sftp_register(req = fxp_mkdir_send(outfname));
523 rreq = sftp_find_request(pktin = sftp_recv());
525 result = fxp_mkdir_recv(pktin, rreq);
528 printf("%s: create directory: %s\n",
529 outfname, fxp_error());
535 * Now get the list of filenames in the local directory.
537 nnames = namesize = 0;
540 dh = open_directory(fname);
542 printf("%s: unable to open directory\n", fname);
545 while ((name = read_filename(dh)) != NULL) {
546 if (nnames >= namesize) {
548 ournames = sresize(ournames, namesize, char *);
550 ournames[nnames++] = name;
555 * Sort the names into a clear order. This ought to make
556 * things more predictable when we're doing a reput of the
557 * same directory, just in case two readdirs on the same
558 * local directory return a different order.
560 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
563 * If we're in restart mode, find the last filename on this
564 * list that already exists. We may have to do a reput on
565 * _that_ file, but shouldn't have to do anything on the
568 * If none of them exists, of course, we start at 0.
573 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
574 sftp_register(req = fxp_stat_send(nextoutfname));
575 rreq = sftp_find_request(pktin = sftp_recv());
577 result = fxp_stat_recv(pktin, rreq, &attrs);
587 * Now we're ready to recurse. Starting at ournames[i]
588 * and continuing on to the end of the list, we
589 * construct a new source and target file name, and
590 * call sftp_put_file again.
592 for (; i < nnames; i++) {
593 char *nextfname, *nextoutfname;
597 nextfname = dir_file_cat(fname, ournames[i]);
599 nextfname = dupstr(ournames[i]);
600 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
601 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
602 restart = FALSE; /* after first partial file, do full */
606 for (i = 0; i < nnames; i++) {
615 * Done this recursion level. Free everything.
617 for (i = 0; i < nnames; i++) {
625 file = open_existing_file(fname, NULL, NULL, NULL);
627 printf("local: unable to open %s\n", fname);
631 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
633 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
634 SSH_FXF_CREAT | SSH_FXF_TRUNC));
636 rreq = sftp_find_request(pktin = sftp_recv());
638 fh = fxp_open_recv(pktin, rreq);
641 printf("%s: open for write: %s\n", outfname, fxp_error());
647 struct fxp_attrs attrs;
650 sftp_register(req = fxp_fstat_send(fh));
651 rreq = sftp_find_request(pktin = sftp_recv());
653 ret = fxp_fstat_recv(pktin, rreq, &attrs);
656 printf("read size of %s: %s\n", outfname, fxp_error());
659 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
660 printf("read size of %s: size was not given\n", outfname);
664 uint64_decimal(offset, decbuf);
665 printf("reput: restarting at file position %s\n", decbuf);
667 if (seek_file((WFile *)file, offset, FROM_START) != 0)
668 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
670 offset = uint64_make(0, 0);
673 printf("local:%s => remote:%s\n", fname, outfname);
676 * FIXME: we can use FXP_FSTAT here to get the file size, and
677 * thus put up a progress bar.
680 xfer = xfer_upload_init(fh, offset);
682 while ((!err && !eof) || !xfer_done(xfer)) {
686 while (xfer_upload_ready(xfer) && !err && !eof) {
687 len = read_from_file(file, buffer, sizeof(buffer));
689 printf("error while reading local file\n");
691 } else if (len == 0) {
694 xfer_upload_data(xfer, buffer, len);
698 if (!xfer_done(xfer)) {
700 ret = xfer_upload_gotpkt(xfer, pktin);
702 printf("error while writing: %s\n", fxp_error());
710 sftp_register(req = fxp_close_send(fh));
711 rreq = sftp_find_request(pktin = sftp_recv());
713 fxp_close_recv(pktin, rreq);
720 /* ----------------------------------------------------------------------
721 * A remote wildcard matcher, providing a similar interface to the
722 * local one in psftp.h.
725 typedef struct SftpWildcardMatcher {
726 struct fxp_handle *dirh;
727 struct fxp_names *names;
729 char *wildcard, *prefix;
730 } SftpWildcardMatcher;
732 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
734 struct sftp_packet *pktin;
735 struct sftp_request *req, *rreq;
737 char *unwcdir, *tmpdir, *cdir;
739 SftpWildcardMatcher *swcm;
740 struct fxp_handle *dirh;
743 * We don't handle multi-level wildcards; so we expect to find
744 * a fully specified directory part, followed by a wildcard
747 wildcard = stripslashes(name, 0);
749 unwcdir = dupstr(name);
750 len = wildcard - name;
752 if (len > 0 && unwcdir[len-1] == '/')
753 unwcdir[len-1] = '\0';
754 tmpdir = snewn(1 + len, char);
755 check = wc_unescape(tmpdir, unwcdir);
759 printf("Multiple-level wildcards are not supported\n");
764 cdir = canonify(unwcdir);
766 sftp_register(req = fxp_opendir_send(cdir));
767 rreq = sftp_find_request(pktin = sftp_recv());
769 dirh = fxp_opendir_recv(pktin, rreq);
772 swcm = snew(SftpWildcardMatcher);
775 swcm->wildcard = dupstr(wildcard);
776 swcm->prefix = unwcdir;
778 printf("Unable to open %s: %s\n", cdir, fxp_error());
788 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
790 struct fxp_name *name;
791 struct sftp_packet *pktin;
792 struct sftp_request *req, *rreq;
795 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
796 fxp_free_names(swcm->names);
801 sftp_register(req = fxp_readdir_send(swcm->dirh));
802 rreq = sftp_find_request(pktin = sftp_recv());
804 swcm->names = fxp_readdir_recv(pktin, rreq);
807 if (fxp_error_type() != SSH_FX_EOF)
808 printf("%s: reading directory: %s\n", swcm->prefix,
816 assert(swcm->names && swcm->namepos < swcm->names->nnames);
818 name = &swcm->names->names[swcm->namepos++];
820 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
821 continue; /* expected bad filenames */
823 if (!vet_filename(name->filename)) {
824 printf("ignoring potentially dangerous server-"
825 "supplied filename '%s'\n", name->filename);
826 continue; /* unexpected bad filename */
829 if (!wc_match(swcm->wildcard, name->filename))
830 continue; /* doesn't match the wildcard */
833 * We have a working filename. Return it.
835 return dupprintf("%s%s%s", swcm->prefix,
837 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
843 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
845 struct sftp_packet *pktin;
846 struct sftp_request *req, *rreq;
848 sftp_register(req = fxp_close_send(swcm->dirh));
849 rreq = sftp_find_request(pktin = sftp_recv());
851 fxp_close_recv(pktin, rreq);
854 fxp_free_names(swcm->names);
857 sfree(swcm->wildcard);
863 * General function to match a potential wildcard in a filename
864 * argument and iterate over every matching file. Used in several
865 * PSFTP commands (rmdir, rm, chmod, mv).
867 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
869 char *unwcfname, *newname, *cname;
872 unwcfname = snewn(strlen(filename)+1, char);
873 is_wc = !wc_unescape(unwcfname, filename);
876 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
885 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
886 cname = canonify(newname);
888 printf("%s: canonify: %s\n", newname, fxp_error());
892 ret &= func(ctx, cname);
897 /* Politely warn the user that nothing matched. */
898 printf("%s: nothing matched\n", filename);
901 sftp_finish_wildcard_matching(swcm);
903 cname = canonify(unwcfname);
905 printf("%s: canonify: %s\n", filename, fxp_error());
908 ret = func(ctx, cname);
917 * Handy helper function.
919 int is_wildcard(char *name)
921 char *unwcfname = snewn(strlen(name)+1, char);
922 int is_wc = !wc_unescape(unwcfname, name);
927 /* ----------------------------------------------------------------------
928 * Actual sftp commands.
930 struct sftp_command {
932 int nwords, wordssize;
933 int (*obey) (struct sftp_command *); /* returns <0 to quit */
936 int sftp_cmd_null(struct sftp_command *cmd)
938 return 1; /* success */
941 int sftp_cmd_unknown(struct sftp_command *cmd)
943 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
944 return 0; /* failure */
947 int sftp_cmd_quit(struct sftp_command *cmd)
952 int sftp_cmd_close(struct sftp_command *cmd)
959 if (back != NULL && back->connected(backhandle)) {
961 back->special(backhandle, TS_EOF);
962 sftp_recvdata(&ch, 1);
970 * List a directory. If no arguments are given, list pwd; otherwise
971 * list the directory given in words[1].
973 int sftp_cmd_ls(struct sftp_command *cmd)
975 struct fxp_handle *dirh;
976 struct fxp_names *names;
977 struct fxp_name **ournames;
978 int nnames, namesize;
979 char *dir, *cdir, *unwcdir, *wildcard;
980 struct sftp_packet *pktin;
981 struct sftp_request *req, *rreq;
994 unwcdir = snewn(1 + strlen(dir), char);
995 if (wc_unescape(unwcdir, dir)) {
1002 wildcard = stripslashes(dir, 0);
1003 unwcdir = dupstr(dir);
1004 len = wildcard - dir;
1005 unwcdir[len] = '\0';
1006 if (len > 0 && unwcdir[len-1] == '/')
1007 unwcdir[len-1] = '\0';
1008 tmpdir = snewn(1 + len, char);
1009 check = wc_unescape(tmpdir, unwcdir);
1012 printf("Multiple-level wildcards are not supported\n");
1019 cdir = canonify(dir);
1021 printf("%s: canonify: %s\n", dir, fxp_error());
1026 printf("Listing directory %s\n", cdir);
1028 sftp_register(req = fxp_opendir_send(cdir));
1029 rreq = sftp_find_request(pktin = sftp_recv());
1030 assert(rreq == req);
1031 dirh = fxp_opendir_recv(pktin, rreq);
1034 printf("Unable to open %s: %s\n", dir, fxp_error());
1036 nnames = namesize = 0;
1041 sftp_register(req = fxp_readdir_send(dirh));
1042 rreq = sftp_find_request(pktin = sftp_recv());
1043 assert(rreq == req);
1044 names = fxp_readdir_recv(pktin, rreq);
1046 if (names == NULL) {
1047 if (fxp_error_type() == SSH_FX_EOF)
1049 printf("Reading directory %s: %s\n", dir, fxp_error());
1052 if (names->nnames == 0) {
1053 fxp_free_names(names);
1057 if (nnames + names->nnames >= namesize) {
1058 namesize += names->nnames + 128;
1059 ournames = sresize(ournames, namesize, struct fxp_name *);
1062 for (i = 0; i < names->nnames; i++)
1063 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1064 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1066 fxp_free_names(names);
1068 sftp_register(req = fxp_close_send(dirh));
1069 rreq = sftp_find_request(pktin = sftp_recv());
1070 assert(rreq == req);
1071 fxp_close_recv(pktin, rreq);
1074 * Now we have our filenames. Sort them by actual file
1075 * name, and then output the longname parts.
1077 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1082 for (i = 0; i < nnames; i++) {
1083 printf("%s\n", ournames[i]->longname);
1084 fxp_free_name(ournames[i]);
1096 * Change directories. We do this by canonifying the new name, then
1097 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1099 int sftp_cmd_cd(struct sftp_command *cmd)
1101 struct fxp_handle *dirh;
1102 struct sftp_packet *pktin;
1103 struct sftp_request *req, *rreq;
1111 if (cmd->nwords < 2)
1112 dir = dupstr(homedir);
1114 dir = canonify(cmd->words[1]);
1117 printf("%s: canonify: %s\n", dir, fxp_error());
1121 sftp_register(req = fxp_opendir_send(dir));
1122 rreq = sftp_find_request(pktin = sftp_recv());
1123 assert(rreq == req);
1124 dirh = fxp_opendir_recv(pktin, rreq);
1127 printf("Directory %s: %s\n", dir, fxp_error());
1132 sftp_register(req = fxp_close_send(dirh));
1133 rreq = sftp_find_request(pktin = sftp_recv());
1134 assert(rreq == req);
1135 fxp_close_recv(pktin, rreq);
1139 printf("Remote directory is now %s\n", pwd);
1145 * Print current directory. Easy as pie.
1147 int sftp_cmd_pwd(struct sftp_command *cmd)
1154 printf("Remote directory is %s\n", pwd);
1159 * Get a file and save it at the local end. We have three very
1160 * similar commands here. The basic one is `get'; `reget' differs
1161 * in that it checks for the existence of the destination file and
1162 * starts from where a previous aborted transfer left off; `mget'
1163 * differs in that it interprets all its arguments as files to
1164 * transfer (never as a different local name for a remote file) and
1165 * can handle wildcards.
1167 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1169 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1171 int recurse = FALSE;
1179 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1180 if (!strcmp(cmd->words[i], "--")) {
1181 /* finish processing options */
1184 } else if (!strcmp(cmd->words[i], "-r")) {
1187 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1193 if (i >= cmd->nwords) {
1194 printf("%s: expects a filename\n", cmd->words[0]);
1200 SftpWildcardMatcher *swcm;
1202 origfname = cmd->words[i++];
1203 unwcfname = snewn(strlen(origfname)+1, char);
1205 if (multiple && !wc_unescape(unwcfname, origfname)) {
1206 swcm = sftp_begin_wildcard_matching(origfname);
1211 origwfname = sftp_wildcard_get_filename(swcm);
1213 /* Politely warn the user that nothing matched. */
1214 printf("%s: nothing matched\n", origfname);
1215 sftp_finish_wildcard_matching(swcm);
1220 origwfname = origfname;
1224 while (origwfname) {
1225 fname = canonify(origwfname);
1228 printf("%s: canonify: %s\n", origwfname, fxp_error());
1233 if (!multiple && i < cmd->nwords)
1234 outfname = cmd->words[i++];
1236 outfname = stripslashes(origwfname, 0);
1238 ret = sftp_get_file(fname, outfname, recurse, restart);
1244 origwfname = sftp_wildcard_get_filename(swcm);
1251 sftp_finish_wildcard_matching(swcm);
1255 } while (multiple && i < cmd->nwords);
1259 int sftp_cmd_get(struct sftp_command *cmd)
1261 return sftp_general_get(cmd, 0, 0);
1263 int sftp_cmd_mget(struct sftp_command *cmd)
1265 return sftp_general_get(cmd, 0, 1);
1267 int sftp_cmd_reget(struct sftp_command *cmd)
1269 return sftp_general_get(cmd, 1, 0);
1273 * Send a file and store it at the remote end. We have three very
1274 * similar commands here. The basic one is `put'; `reput' differs
1275 * in that it checks for the existence of the destination file and
1276 * starts from where a previous aborted transfer left off; `mput'
1277 * differs in that it interprets all its arguments as files to
1278 * transfer (never as a different remote name for a local file) and
1279 * can handle wildcards.
1281 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1283 char *fname, *wfname, *origoutfname, *outfname;
1285 int recurse = FALSE;
1293 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1294 if (!strcmp(cmd->words[i], "--")) {
1295 /* finish processing options */
1298 } else if (!strcmp(cmd->words[i], "-r")) {
1301 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1307 if (i >= cmd->nwords) {
1308 printf("%s: expects a filename\n", cmd->words[0]);
1314 WildcardMatcher *wcm;
1315 fname = cmd->words[i++];
1317 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1318 wcm = begin_wildcard_matching(fname);
1319 wfname = wildcard_get_filename(wcm);
1321 /* Politely warn the user that nothing matched. */
1322 printf("%s: nothing matched\n", fname);
1323 finish_wildcard_matching(wcm);
1332 if (!multiple && i < cmd->nwords)
1333 origoutfname = cmd->words[i++];
1335 origoutfname = stripslashes(wfname, 1);
1337 outfname = canonify(origoutfname);
1339 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1342 finish_wildcard_matching(wcm);
1346 ret = sftp_put_file(wfname, outfname, recurse, restart);
1351 wfname = wildcard_get_filename(wcm);
1358 finish_wildcard_matching(wcm);
1363 } while (multiple && i < cmd->nwords);
1367 int sftp_cmd_put(struct sftp_command *cmd)
1369 return sftp_general_put(cmd, 0, 0);
1371 int sftp_cmd_mput(struct sftp_command *cmd)
1373 return sftp_general_put(cmd, 0, 1);
1375 int sftp_cmd_reput(struct sftp_command *cmd)
1377 return sftp_general_put(cmd, 1, 0);
1380 int sftp_cmd_mkdir(struct sftp_command *cmd)
1383 struct sftp_packet *pktin;
1384 struct sftp_request *req, *rreq;
1393 if (cmd->nwords < 2) {
1394 printf("mkdir: expects a directory\n");
1399 for (i = 1; i < cmd->nwords; i++) {
1400 dir = canonify(cmd->words[i]);
1402 printf("%s: canonify: %s\n", dir, fxp_error());
1406 sftp_register(req = fxp_mkdir_send(dir));
1407 rreq = sftp_find_request(pktin = sftp_recv());
1408 assert(rreq == req);
1409 result = fxp_mkdir_recv(pktin, rreq);
1412 printf("mkdir %s: %s\n", dir, fxp_error());
1415 printf("mkdir %s: OK\n", dir);
1423 static int sftp_action_rmdir(void *vctx, char *dir)
1425 struct sftp_packet *pktin;
1426 struct sftp_request *req, *rreq;
1429 sftp_register(req = fxp_rmdir_send(dir));
1430 rreq = sftp_find_request(pktin = sftp_recv());
1431 assert(rreq == req);
1432 result = fxp_rmdir_recv(pktin, rreq);
1435 printf("rmdir %s: %s\n", dir, fxp_error());
1439 printf("rmdir %s: OK\n", dir);
1444 int sftp_cmd_rmdir(struct sftp_command *cmd)
1453 if (cmd->nwords < 2) {
1454 printf("rmdir: expects a directory\n");
1459 for (i = 1; i < cmd->nwords; i++)
1460 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1465 static int sftp_action_rm(void *vctx, char *fname)
1467 struct sftp_packet *pktin;
1468 struct sftp_request *req, *rreq;
1471 sftp_register(req = fxp_remove_send(fname));
1472 rreq = sftp_find_request(pktin = sftp_recv());
1473 assert(rreq == req);
1474 result = fxp_remove_recv(pktin, rreq);
1477 printf("rm %s: %s\n", fname, fxp_error());
1481 printf("rm %s: OK\n", fname);
1486 int sftp_cmd_rm(struct sftp_command *cmd)
1495 if (cmd->nwords < 2) {
1496 printf("rm: expects a filename\n");
1501 for (i = 1; i < cmd->nwords; i++)
1502 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1507 static int check_is_dir(char *dstfname)
1509 struct sftp_packet *pktin;
1510 struct sftp_request *req, *rreq;
1511 struct fxp_attrs attrs;
1514 sftp_register(req = fxp_stat_send(dstfname));
1515 rreq = sftp_find_request(pktin = sftp_recv());
1516 assert(rreq == req);
1517 result = fxp_stat_recv(pktin, rreq, &attrs);
1520 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1521 (attrs.permissions & 0040000))
1527 struct sftp_context_mv {
1532 static int sftp_action_mv(void *vctx, char *srcfname)
1534 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1535 struct sftp_packet *pktin;
1536 struct sftp_request *req, *rreq;
1538 char *finalfname, *newcanon = NULL;
1541 if (ctx->dest_is_dir) {
1545 p = srcfname + strlen(srcfname);
1546 while (p > srcfname && p[-1] != '/') p--;
1547 newname = dupcat(ctx->dstfname, "/", p, NULL);
1548 newcanon = canonify(newname);
1550 printf("%s: canonify: %s\n", newname, fxp_error());
1556 finalfname = newcanon;
1558 finalfname = ctx->dstfname;
1561 sftp_register(req = fxp_rename_send(srcfname, finalfname));
1562 rreq = sftp_find_request(pktin = sftp_recv());
1563 assert(rreq == req);
1564 result = fxp_rename_recv(pktin, rreq);
1566 error = result ? NULL : fxp_error();
1569 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1572 printf("%s -> %s\n", srcfname, finalfname);
1580 int sftp_cmd_mv(struct sftp_command *cmd)
1582 struct sftp_context_mv actx, *ctx = &actx;
1590 if (cmd->nwords < 3) {
1591 printf("mv: expects two filenames\n");
1595 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1596 if (!ctx->dstfname) {
1597 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1602 * If there's more than one source argument, or one source
1603 * argument which is a wildcard, we _require_ that the
1604 * destination is a directory.
1606 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1607 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1608 printf("mv: multiple or wildcard arguments require the destination"
1609 " to be a directory\n");
1610 sfree(ctx->dstfname);
1615 * Now iterate over the source arguments.
1618 for (i = 1; i < cmd->nwords-1; i++)
1619 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1621 sfree(ctx->dstfname);
1625 struct sftp_context_chmod {
1626 unsigned attrs_clr, attrs_xor;
1629 static int sftp_action_chmod(void *vctx, char *fname)
1631 struct fxp_attrs attrs;
1632 struct sftp_packet *pktin;
1633 struct sftp_request *req, *rreq;
1635 unsigned oldperms, newperms;
1636 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1638 sftp_register(req = fxp_stat_send(fname));
1639 rreq = sftp_find_request(pktin = sftp_recv());
1640 assert(rreq == req);
1641 result = fxp_stat_recv(pktin, rreq, &attrs);
1643 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1644 printf("get attrs for %s: %s\n", fname,
1645 result ? "file permissions not provided" : fxp_error());
1649 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1650 oldperms = attrs.permissions & 07777;
1651 attrs.permissions &= ~ctx->attrs_clr;
1652 attrs.permissions ^= ctx->attrs_xor;
1653 newperms = attrs.permissions & 07777;
1655 if (oldperms == newperms)
1656 return 1; /* no need to do anything! */
1658 sftp_register(req = fxp_setstat_send(fname, attrs));
1659 rreq = sftp_find_request(pktin = sftp_recv());
1660 assert(rreq == req);
1661 result = fxp_setstat_recv(pktin, rreq);
1664 printf("set attrs for %s: %s\n", fname, fxp_error());
1668 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1673 int sftp_cmd_chmod(struct sftp_command *cmd)
1677 struct sftp_context_chmod actx, *ctx = &actx;
1684 if (cmd->nwords < 3) {
1685 printf("chmod: expects a mode specifier and a filename\n");
1690 * Attempt to parse the mode specifier in cmd->words[1]. We
1691 * don't support the full horror of Unix chmod; instead we
1692 * support a much simpler syntax in which the user can either
1693 * specify an octal number, or a comma-separated sequence of
1694 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1695 * _only_ be omitted if the only attribute mentioned is t,
1696 * since all others require a user/group/other specification.
1697 * Additionally, the s attribute may not be specified for any
1698 * [ugoa] specifications other than exactly u or exactly g.
1700 ctx->attrs_clr = ctx->attrs_xor = 0;
1701 mode = cmd->words[1];
1702 if (mode[0] >= '0' && mode[0] <= '9') {
1703 if (mode[strspn(mode, "01234567")]) {
1704 printf("chmod: numeric file modes should"
1705 " contain digits 0-7 only\n");
1708 ctx->attrs_clr = 07777;
1709 sscanf(mode, "%o", &ctx->attrs_xor);
1710 ctx->attrs_xor &= ctx->attrs_clr;
1713 char *modebegin = mode;
1714 unsigned subset, perms;
1718 while (*mode && *mode != ',' &&
1719 *mode != '+' && *mode != '-' && *mode != '=') {
1721 case 'u': subset |= 04700; break; /* setuid, user perms */
1722 case 'g': subset |= 02070; break; /* setgid, group perms */
1723 case 'o': subset |= 00007; break; /* just other perms */
1724 case 'a': subset |= 06777; break; /* all of the above */
1726 printf("chmod: file mode '%.*s' contains unrecognised"
1727 " user/group/other specifier '%c'\n",
1728 (int)strcspn(modebegin, ","), modebegin, *mode);
1733 if (!*mode || *mode == ',') {
1734 printf("chmod: file mode '%.*s' is incomplete\n",
1735 (int)strcspn(modebegin, ","), modebegin);
1739 if (!*mode || *mode == ',') {
1740 printf("chmod: file mode '%.*s' is incomplete\n",
1741 (int)strcspn(modebegin, ","), modebegin);
1745 while (*mode && *mode != ',') {
1747 case 'r': perms |= 00444; break;
1748 case 'w': perms |= 00222; break;
1749 case 'x': perms |= 00111; break;
1750 case 't': perms |= 01000; subset |= 01000; break;
1752 if ((subset & 06777) != 04700 &&
1753 (subset & 06777) != 02070) {
1754 printf("chmod: file mode '%.*s': set[ug]id bit should"
1755 " be used with exactly one of u or g only\n",
1756 (int)strcspn(modebegin, ","), modebegin);
1762 printf("chmod: file mode '%.*s' contains unrecognised"
1763 " permission specifier '%c'\n",
1764 (int)strcspn(modebegin, ","), modebegin, *mode);
1769 if (!(subset & 06777) && (perms &~ subset)) {
1770 printf("chmod: file mode '%.*s' contains no user/group/other"
1771 " specifier and permissions other than 't' \n",
1772 (int)strcspn(modebegin, ","), modebegin);
1778 ctx->attrs_clr |= perms;
1779 ctx->attrs_xor |= perms;
1782 ctx->attrs_clr |= perms;
1783 ctx->attrs_xor &= ~perms;
1786 ctx->attrs_clr |= subset;
1787 ctx->attrs_xor |= perms;
1790 if (*mode) mode++; /* eat comma */
1795 for (i = 2; i < cmd->nwords; i++)
1796 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1801 static int sftp_cmd_open(struct sftp_command *cmd)
1806 printf("psftp: already connected\n");
1810 if (cmd->nwords < 2) {
1811 printf("open: expects a host name\n");
1815 if (cmd->nwords > 2) {
1816 portnumber = atoi(cmd->words[2]);
1817 if (portnumber == 0) {
1818 printf("open: invalid port number\n");
1824 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1825 back = NULL; /* connection is already closed */
1826 return -1; /* this is fatal */
1832 static int sftp_cmd_lcd(struct sftp_command *cmd)
1834 char *currdir, *errmsg;
1836 if (cmd->nwords < 2) {
1837 printf("lcd: expects a local directory name\n");
1841 errmsg = psftp_lcd(cmd->words[1]);
1843 printf("lcd: unable to change directory: %s\n", errmsg);
1848 currdir = psftp_getcwd();
1849 printf("New local directory is %s\n", currdir);
1855 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1859 currdir = psftp_getcwd();
1860 printf("Current local directory is %s\n", currdir);
1866 static int sftp_cmd_pling(struct sftp_command *cmd)
1870 exitcode = system(cmd->words[1]);
1871 return (exitcode == 0);
1874 static int sftp_cmd_help(struct sftp_command *cmd);
1876 static struct sftp_cmd_lookup {
1879 * For help purposes, there are two kinds of command:
1881 * - primary commands, in which `longhelp' is non-NULL. In
1882 * this case `shorthelp' is descriptive text, and `longhelp'
1883 * is longer descriptive text intended to be printed after
1886 * - alias commands, in which `longhelp' is NULL. In this case
1887 * `shorthelp' is the name of a primary command, which
1888 * contains the help that should double up for this command.
1890 int listed; /* do we list this in primary help? */
1893 int (*obey) (struct sftp_command *);
1896 * List of sftp commands. This is binary-searched so it MUST be
1900 "!", TRUE, "run a local command",
1902 /* FIXME: this example is crap for non-Windows. */
1903 " Runs a local command. For example, \"!del myfile\".\n",
1907 "bye", TRUE, "finish your SFTP session",
1909 " Terminates your SFTP session and quits the PSFTP program.\n",
1913 "cd", TRUE, "change your remote working directory",
1914 " [ <new working directory> ]\n"
1915 " Change the remote working directory for your SFTP session.\n"
1916 " If a new working directory is not supplied, you will be\n"
1917 " returned to your home directory.\n",
1921 "chmod", TRUE, "change file permissions and modes",
1922 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1923 " Change the file permissions on one or more remote files or\n"
1925 " <modes> can be any octal Unix permission specifier.\n"
1926 " Alternatively, <modes> can include the following modifiers:\n"
1927 " u+r make file readable by owning user\n"
1928 " u+w make file writable by owning user\n"
1929 " u+x make file executable by owning user\n"
1930 " u-r make file not readable by owning user\n"
1931 " [also u-w, u-x]\n"
1932 " g+r make file readable by members of owning group\n"
1933 " [also g+w, g+x, g-r, g-w, g-x]\n"
1934 " o+r make file readable by all other users\n"
1935 " [also o+w, o+x, o-r, o-w, o-x]\n"
1936 " a+r make file readable by absolutely everybody\n"
1937 " [also a+w, a+x, a-r, a-w, a-x]\n"
1938 " u+s enable the Unix set-user-ID bit\n"
1939 " u-s disable the Unix set-user-ID bit\n"
1940 " g+s enable the Unix set-group-ID bit\n"
1941 " g-s disable the Unix set-group-ID bit\n"
1942 " +t enable the Unix \"sticky bit\"\n"
1943 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1944 " more than one user for the same modifier (\"ug+w\"). You can\n"
1945 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1949 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1951 " Terminates your SFTP session, but does not quit the PSFTP\n"
1952 " program. You can then use \"open\" to start another SFTP\n"
1953 " session, to the same server or to a different one.\n",
1957 "del", TRUE, "delete files on the remote server",
1958 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1959 " Delete a file or files from the server.\n",
1963 "delete", FALSE, "del", NULL, sftp_cmd_rm
1966 "dir", TRUE, "list remote files",
1967 " [ <directory-name> ]/[ <wildcard> ]\n"
1968 " List the contents of a specified directory on the server.\n"
1969 " If <directory-name> is not given, the current working directory\n"
1971 " If <wildcard> is given, it is treated as a set of files to\n"
1972 " list; otherwise, all files are listed.\n",
1976 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1979 "get", TRUE, "download a file from the server to your local machine",
1980 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1981 " Downloads a file on the server and stores it locally under\n"
1982 " the same name, or under a different one if you supply the\n"
1983 " argument <local-filename>.\n"
1984 " If -r specified, recursively fetch a directory.\n",
1988 "help", TRUE, "give help",
1989 " [ <command> [ <command> ... ] ]\n"
1990 " Give general help if no commands are specified.\n"
1991 " If one or more commands are specified, give specific help on\n"
1992 " those particular commands.\n",
1996 "lcd", TRUE, "change local working directory",
1997 " <local-directory-name>\n"
1998 " Change the local working directory of the PSFTP program (the\n"
1999 " default location where the \"get\" command will save files).\n",
2003 "lpwd", TRUE, "print local working directory",
2005 " Print the local working directory of the PSFTP program (the\n"
2006 " default location where the \"get\" command will save files).\n",
2010 "ls", TRUE, "dir", NULL,
2014 "mget", TRUE, "download multiple files at once",
2015 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2016 " Downloads many files from the server, storing each one under\n"
2017 " the same name it has on the server side. You can use wildcards\n"
2018 " such as \"*.c\" to specify lots of files at once.\n"
2019 " If -r specified, recursively fetch files and directories.\n",
2023 "mkdir", TRUE, "create directories on the remote server",
2024 " <directory-name> [ <directory-name>... ]\n"
2025 " Creates directories with the given names on the server.\n",
2029 "mput", TRUE, "upload multiple files at once",
2030 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2031 " Uploads many files to the server, storing each one under the\n"
2032 " same name it has on the client side. You can use wildcards\n"
2033 " such as \"*.c\" to specify lots of files at once.\n"
2034 " If -r specified, recursively store files and directories.\n",
2038 "mv", TRUE, "move or rename file(s) on the remote server",
2039 " <source> [ <source>... ] <destination>\n"
2040 " Moves or renames <source>(s) on the server to <destination>,\n"
2041 " also on the server.\n"
2042 " If <destination> specifies an existing directory, then <source>\n"
2043 " may be a wildcard, and multiple <source>s may be given; all\n"
2044 " source files are moved into <destination>.\n"
2045 " Otherwise, <source> must specify a single file, which is moved\n"
2046 " or renamed so that it is accessible under the name <destination>.\n",
2050 "open", TRUE, "connect to a host",
2051 " [<user>@]<hostname> [<port>]\n"
2052 " Establishes an SFTP connection to a given host. Only usable\n"
2053 " when you are not already connected to a server.\n",
2057 "put", TRUE, "upload a file from your local machine to the server",
2058 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2059 " Uploads a file to the server and stores it there under\n"
2060 " the same name, or under a different one if you supply the\n"
2061 " argument <remote-filename>.\n"
2062 " If -r specified, recursively store a directory.\n",
2066 "pwd", TRUE, "print your remote working directory",
2068 " Print the current remote working directory for your SFTP session.\n",
2072 "quit", TRUE, "bye", NULL,
2076 "reget", TRUE, "continue downloading files",
2077 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2078 " Works exactly like the \"get\" command, but the local file\n"
2079 " must already exist. The download will begin at the end of the\n"
2080 " file. This is for resuming a download that was interrupted.\n"
2081 " If -r specified, resume interrupted \"get -r\".\n",
2085 "ren", TRUE, "mv", NULL,
2089 "rename", FALSE, "mv", NULL,
2093 "reput", TRUE, "continue uploading files",
2094 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2095 " Works exactly like the \"put\" command, but the remote file\n"
2096 " must already exist. The upload will begin at the end of the\n"
2097 " file. This is for resuming an upload that was interrupted.\n"
2098 " If -r specified, resume interrupted \"put -r\".\n",
2102 "rm", TRUE, "del", NULL,
2106 "rmdir", TRUE, "remove directories on the remote server",
2107 " <directory-name> [ <directory-name>... ]\n"
2108 " Removes the directory with the given name on the server.\n"
2109 " The directory will not be removed unless it is empty.\n"
2110 " Wildcards may be used to specify multiple directories.\n",
2115 const struct sftp_cmd_lookup *lookup_command(char *name)
2120 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2123 cmp = strcmp(name, sftp_lookup[k].name);
2129 return &sftp_lookup[k];
2135 static int sftp_cmd_help(struct sftp_command *cmd)
2138 if (cmd->nwords == 1) {
2140 * Give short help on each command.
2144 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2146 if (!sftp_lookup[i].listed)
2148 len = strlen(sftp_lookup[i].name);
2152 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2153 const struct sftp_cmd_lookup *lookup;
2154 if (!sftp_lookup[i].listed)
2156 lookup = &sftp_lookup[i];
2157 printf("%-*s", maxlen+2, lookup->name);
2158 if (lookup->longhelp == NULL)
2159 lookup = lookup_command(lookup->shorthelp);
2160 printf("%s\n", lookup->shorthelp);
2164 * Give long help on specific commands.
2166 for (i = 1; i < cmd->nwords; i++) {
2167 const struct sftp_cmd_lookup *lookup;
2168 lookup = lookup_command(cmd->words[i]);
2170 printf("help: %s: command not found\n", cmd->words[i]);
2172 printf("%s", lookup->name);
2173 if (lookup->longhelp == NULL)
2174 lookup = lookup_command(lookup->shorthelp);
2175 printf("%s", lookup->longhelp);
2182 /* ----------------------------------------------------------------------
2183 * Command line reading and parsing.
2185 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2188 struct sftp_command *cmd;
2192 cmd = snew(struct sftp_command);
2202 line = fgetline(fp);
2204 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2207 if (!line || !*line) {
2208 cmd->obey = sftp_cmd_quit;
2209 if ((mode == 0) || (modeflags & 1))
2211 return cmd; /* eof */
2214 line[strcspn(line, "\r\n")] = '\0';
2216 if (modeflags & 1) {
2217 printf("%s\n", line);
2221 while (*p && (*p == ' ' || *p == '\t'))
2226 * Special case: the ! command. This is always parsed as
2227 * exactly two words: one containing the !, and the second
2228 * containing everything else on the line.
2230 cmd->nwords = cmd->wordssize = 2;
2231 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2232 cmd->words[0] = dupstr("!");
2233 cmd->words[1] = dupstr(p+1);
2237 * Parse the command line into words. The syntax is:
2238 * - double quotes are removed, but cause spaces within to be
2239 * treated as non-separating.
2240 * - a double-doublequote pair is a literal double quote, inside
2241 * _or_ outside quotes. Like this:
2243 * firstword "second word" "this has ""quotes"" in" and""this""
2249 * >this has "quotes" in<
2253 /* skip whitespace */
2254 while (*p && (*p == ' ' || *p == '\t'))
2256 /* mark start of word */
2257 q = r = p; /* q sits at start, r writes word */
2260 if (!quoting && (*p == ' ' || *p == '\t'))
2261 break; /* reached end of word */
2262 else if (*p == '"' && p[1] == '"')
2263 p += 2, *r++ = '"'; /* a literal quote */
2265 p++, quoting = !quoting;
2270 p++; /* skip over the whitespace */
2272 if (cmd->nwords >= cmd->wordssize) {
2273 cmd->wordssize = cmd->nwords + 16;
2274 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2276 cmd->words[cmd->nwords++] = dupstr(q);
2283 * Now parse the first word and assign a function.
2286 if (cmd->nwords == 0)
2287 cmd->obey = sftp_cmd_null;
2289 const struct sftp_cmd_lookup *lookup;
2290 lookup = lookup_command(cmd->words[0]);
2292 cmd->obey = sftp_cmd_unknown;
2294 cmd->obey = lookup->obey;
2300 static int do_sftp_init(void)
2302 struct sftp_packet *pktin;
2303 struct sftp_request *req, *rreq;
2306 * Do protocol initialisation.
2310 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2311 return 1; /* failure */
2315 * Find out where our home directory is.
2317 sftp_register(req = fxp_realpath_send("."));
2318 rreq = sftp_find_request(pktin = sftp_recv());
2319 assert(rreq == req);
2320 homedir = fxp_realpath_recv(pktin, rreq);
2324 "Warning: failed to resolve home directory: %s\n",
2326 homedir = dupstr(".");
2328 printf("Remote working directory is %s\n", homedir);
2330 pwd = dupstr(homedir);
2334 void do_sftp_cleanup()
2338 back->special(backhandle, TS_EOF);
2339 sftp_recvdata(&ch, 1);
2340 back->free(backhandle);
2341 sftp_cleanup_request();
2355 void do_sftp(int mode, int modeflags, char *batchfile)
2365 /* ------------------------------------------------------------------
2366 * Now we're ready to do Real Stuff.
2369 struct sftp_command *cmd;
2370 cmd = sftp_getcmd(NULL, 0, 0);
2373 ret = cmd->obey(cmd);
2376 for(i = 0; i < cmd->nwords; i++)
2377 sfree(cmd->words[i]);
2385 fp = fopen(batchfile, "r");
2387 printf("Fatal: unable to open %s\n", batchfile);
2391 struct sftp_command *cmd;
2392 cmd = sftp_getcmd(fp, mode, modeflags);
2395 ret = cmd->obey(cmd);
2399 if (!(modeflags & 2))
2408 /* ----------------------------------------------------------------------
2409 * Dirty bits: integration with PuTTY.
2412 static int verbose = 0;
2415 * Print an error message and perform a fatal exit.
2417 void fatalbox(char *fmt, ...)
2422 str = dupvprintf(fmt, ap);
2423 str2 = dupcat("Fatal: ", str, "\n", NULL);
2426 fputs(str2, stderr);
2431 void modalfatalbox(char *fmt, ...)
2436 str = dupvprintf(fmt, ap);
2437 str2 = dupcat("Fatal: ", str, "\n", NULL);
2440 fputs(str2, stderr);
2445 void connection_fatal(void *frontend, char *fmt, ...)
2450 str = dupvprintf(fmt, ap);
2451 str2 = dupcat("Fatal: ", str, "\n", NULL);
2454 fputs(str2, stderr);
2460 void ldisc_send(void *handle, char *buf, int len, int interactive)
2463 * This is only here because of the calls to ldisc_send(NULL,
2464 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2465 * ldisc as an ldisc. So if we get called with any real data, I
2466 * want to know about it.
2472 * In psftp, all agent requests should be synchronous, so this is a
2473 * never-called stub.
2475 void agent_schedule_callback(void (*callback)(void *, void *, int),
2476 void *callback_ctx, void *data, int len)
2478 assert(!"We shouldn't be here");
2482 * Receive a block of data from the SSH link. Block until all data
2485 * To do this, we repeatedly call the SSH protocol module, with our
2486 * own trap in from_backend() to catch the data that comes back. We
2487 * do this until we have enough data.
2490 static unsigned char *outptr; /* where to put the data */
2491 static unsigned outlen; /* how much data required */
2492 static unsigned char *pending = NULL; /* any spare data */
2493 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2494 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2496 unsigned char *p = (unsigned char *) data;
2497 unsigned len = (unsigned) datalen;
2500 * stderr data is just spouted to local stderr and otherwise
2505 fwrite(data, 1, len, stderr);
2510 * If this is before the real session begins, just return.
2515 if ((outlen > 0) && (len > 0)) {
2516 unsigned used = outlen;
2519 memcpy(outptr, p, used);
2527 if (pendsize < pendlen + len) {
2528 pendsize = pendlen + len + 4096;
2529 pending = sresize(pending, pendsize, unsigned char);
2531 memcpy(pending + pendlen, p, len);
2537 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2540 * No "untrusted" output should get here (the way the code is
2541 * currently, it's all diverted by FLAG_STDERR).
2543 assert(!"Unexpected call to from_backend_untrusted()");
2544 return 0; /* not reached */
2546 int sftp_recvdata(char *buf, int len)
2548 outptr = (unsigned char *) buf;
2552 * See if the pending-input block contains some of what we
2556 unsigned pendused = pendlen;
2557 if (pendused > outlen)
2559 memcpy(outptr, pending, pendused);
2560 memmove(pending, pending + pendused, pendlen - pendused);
2563 pendlen -= pendused;
2573 while (outlen > 0) {
2574 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2575 return 0; /* doom */
2580 int sftp_senddata(char *buf, int len)
2582 back->send(backhandle, buf, len);
2587 * Short description of parameters.
2589 static void usage(void)
2591 printf("PuTTY Secure File Transfer (SFTP) client\n");
2592 printf("%s\n", ver);
2593 printf("Usage: psftp [options] [user@]host\n");
2594 printf("Options:\n");
2595 printf(" -V print version information and exit\n");
2596 printf(" -pgpfp print PGP key fingerprints and exit\n");
2597 printf(" -b file use specified batchfile\n");
2598 printf(" -bc output batchfile commands\n");
2599 printf(" -be don't stop batchfile processing if errors\n");
2600 printf(" -v show verbose messages\n");
2601 printf(" -load sessname Load settings from saved session\n");
2602 printf(" -l user connect with specified username\n");
2603 printf(" -P port connect to specified port\n");
2604 printf(" -pw passw login with specified password\n");
2605 printf(" -1 -2 force use of particular SSH protocol version\n");
2606 printf(" -4 -6 force use of IPv4 or IPv6\n");
2607 printf(" -C enable compression\n");
2608 printf(" -i key private key file for authentication\n");
2609 printf(" -noagent disable use of Pageant\n");
2610 printf(" -agent enable use of Pageant\n");
2611 printf(" -batch disable all interactive prompts\n");
2615 static void version(void)
2617 printf("psftp: %s\n", ver);
2622 * Connect to a host.
2624 static int psftp_connect(char *userhost, char *user, int portnumber)
2626 char *host, *realhost;
2630 /* Separate host and username */
2632 host = strrchr(host, '@');
2638 printf("psftp: multiple usernames specified; using \"%s\"\n",
2645 * If we haven't loaded session details already (e.g., from -load),
2646 * try looking for a session called "host".
2648 if (!loaded_session) {
2649 /* Try to load settings for `host' into a temporary config */
2651 cfg2.host[0] = '\0';
2652 do_defaults(host, &cfg2);
2653 if (cfg2.host[0] != '\0') {
2654 /* Settings present and include hostname */
2655 /* Re-load data into the real config. */
2656 do_defaults(host, &cfg);
2658 /* Session doesn't exist or mention a hostname. */
2659 /* Use `host' as a bare hostname. */
2660 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2661 cfg.host[sizeof(cfg.host) - 1] = '\0';
2664 /* Patch in hostname `host' to session details. */
2665 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2666 cfg.host[sizeof(cfg.host) - 1] = '\0';
2670 * Force use of SSH. (If they got the protocol wrong we assume the
2671 * port is useless too.)
2673 if (cfg.protocol != PROT_SSH) {
2674 cfg.protocol = PROT_SSH;
2679 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2680 * then change it to SSH-2, on the grounds that that's more likely to
2681 * work for SFTP. (Can be overridden with `-1' option.)
2682 * But if it says `2 only' or `2', respect which.
2684 if (cfg.sshprot != 2 && cfg.sshprot != 3)
2688 * Enact command-line overrides.
2690 cmdline_run_saved(&cfg);
2693 * Trim leading whitespace off the hostname if it's there.
2696 int space = strspn(cfg.host, " \t");
2697 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
2700 /* See if host is of the form user@host */
2701 if (cfg.host[0] != '\0') {
2702 char *atsign = strrchr(cfg.host, '@');
2703 /* Make sure we're not overflowing the user field */
2705 if (atsign - cfg.host < sizeof cfg.username) {
2706 strncpy(cfg.username, cfg.host, atsign - cfg.host);
2707 cfg.username[atsign - cfg.host] = '\0';
2709 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
2714 * Trim a colon suffix off the hostname if it's there.
2716 cfg.host[strcspn(cfg.host, ":")] = '\0';
2719 * Remove any remaining whitespace from the hostname.
2723 while (cfg.host[p2] != '\0') {
2724 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
2725 cfg.host[p1] = cfg.host[p2];
2730 cfg.host[p1] = '\0';
2734 if (user != NULL && user[0] != '\0') {
2735 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
2736 cfg.username[sizeof(cfg.username) - 1] = '\0';
2740 cfg.port = portnumber;
2743 * Disable scary things which shouldn't be enabled for simple
2744 * things like SCP and SFTP: agent forwarding, port forwarding,
2747 cfg.x11_forward = 0;
2749 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
2751 /* Set up subsystem name. */
2752 strcpy(cfg.remote_cmd, "sftp");
2753 cfg.ssh_subsys = TRUE;
2757 * Set up fallback option, for SSH-1 servers or servers with the
2758 * sftp subsystem not enabled but the server binary installed
2759 * in the usual place. We only support fallback on Unix
2760 * systems, and we use a kludgy piece of shellery which should
2761 * try to find sftp-server in various places (the obvious
2762 * systemwide spots /usr/lib and /usr/local/lib, and then the
2763 * user's PATH) and finally give up.
2765 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2766 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2769 * the idea being that this will attempt to use either of the
2770 * obvious pathnames and then give up, and when it does give up
2771 * it will print the preferred pathname in the error messages.
2773 cfg.remote_cmd_ptr2 =
2774 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2775 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2777 cfg.ssh_subsys2 = FALSE;
2779 back = &ssh_backend;
2781 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,
2782 0, cfg.tcp_keepalives);
2784 fprintf(stderr, "ssh_init: %s\n", err);
2787 logctx = log_init(NULL, &cfg);
2788 back->provide_logctx(backhandle, logctx);
2789 console_provide_logctx(logctx);
2790 while (!back->sendok(backhandle)) {
2791 if (ssh_sftp_loop_iteration() < 0) {
2792 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2796 if (verbose && realhost != NULL)
2797 printf("Connected to %s\n", realhost);
2798 if (realhost != NULL)
2803 void cmdline_error(char *p, ...)
2806 fprintf(stderr, "psftp: ");
2808 vfprintf(stderr, p, ap);
2810 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2815 * Main program. Parse arguments etc.
2817 int psftp_main(int argc, char *argv[])
2821 char *userhost, *user;
2824 char *batchfile = NULL;
2827 flags = FLAG_STDERR | FLAG_INTERACTIVE
2828 #ifdef FLAG_SYNCAGENT
2832 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2835 userhost = user = NULL;
2837 /* Load Default Settings before doing anything else. */
2838 do_defaults(NULL, &cfg);
2839 loaded_session = FALSE;
2842 for (i = 1; i < argc; i++) {
2844 if (argv[i][0] != '-') {
2848 userhost = dupstr(argv[i]);
2851 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2853 cmdline_error("option \"%s\" requires an argument", argv[i]);
2854 } else if (ret == 2) {
2855 i++; /* skip next argument */
2856 } else if (ret == 1) {
2857 /* We have our own verbosity in addition to `flags'. */
2858 if (flags & FLAG_VERBOSE)
2860 } else if (strcmp(argv[i], "-h") == 0 ||
2861 strcmp(argv[i], "-?") == 0) {
2863 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2866 } else if (strcmp(argv[i], "-V") == 0) {
2868 } else if (strcmp(argv[i], "-batch") == 0) {
2869 console_batch_mode = 1;
2870 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2872 batchfile = argv[++i];
2873 } else if (strcmp(argv[i], "-bc") == 0) {
2874 modeflags = modeflags | 1;
2875 } else if (strcmp(argv[i], "-be") == 0) {
2876 modeflags = modeflags | 2;
2877 } else if (strcmp(argv[i], "--") == 0) {
2881 cmdline_error("unknown option \"%s\"", argv[i]);
2889 * If the loaded session provides a hostname, and a hostname has not
2890 * otherwise been specified, pop it in `userhost' so that
2891 * `psftp -load sessname' is sufficient to start a session.
2893 if (!userhost && cfg.host[0] != '\0') {
2894 userhost = dupstr(cfg.host);
2898 * If a user@host string has already been provided, connect to
2903 ret = psftp_connect(userhost, user, portnumber);
2910 printf("psftp: no hostname specified; use \"open host.name\""
2914 do_sftp(mode, modeflags, batchfile);
2916 if (back != NULL && back->connected(backhandle)) {
2918 back->special(backhandle, TS_EOF);
2919 sftp_recvdata(&ch, 1);
2924 console_provide_logctx(NULL);