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 return fullname; /* even that failed; give up */
135 * We have a canonical name for all but the last path
136 * component. Concatenate the last component and return.
138 returnname = dupcat(canonname,
139 canonname[strlen(canonname) - 1] ==
140 '/' ? "" : "/", fullname + i + 1, NULL);
148 * Return a pointer to the portion of str that comes after the last
149 * slash (or backslash or colon, if `local' is TRUE).
151 static char *stripslashes(char *str, int local)
156 p = strchr(str, ':');
160 p = strrchr(str, '/');
164 p = strrchr(str, '\\');
172 * qsort comparison routine for fxp_name structures. Sorts by real
175 static int sftp_name_compare(const void *av, const void *bv)
177 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
178 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
179 return strcmp((*a)->filename, (*b)->filename);
183 * Likewise, but for a bare char *.
185 static int bare_name_compare(const void *av, const void *bv)
187 const char **a = (const char **) av;
188 const char **b = (const char **) bv;
189 return strcmp(*a, *b);
192 /* ----------------------------------------------------------------------
193 * The meat of the `get' and `put' commands.
195 int sftp_get_file(char *fname, char *outfname, int recurse, int restart)
197 struct fxp_handle *fh;
198 struct sftp_packet *pktin;
199 struct sftp_request *req, *rreq;
200 struct fxp_xfer *xfer;
203 int ret, shown_err = FALSE;
206 * In recursive mode, see if we're dealing with a directory.
207 * (If we're not in recursive mode, we need not even check: the
208 * subsequent FXP_OPEN will return a usable error message.)
211 struct fxp_attrs attrs;
214 sftp_register(req = fxp_stat_send(fname));
215 rreq = sftp_find_request(pktin = sftp_recv());
217 result = fxp_stat_recv(pktin, rreq, &attrs);
220 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
221 (attrs.permissions & 0040000)) {
223 struct fxp_handle *dirhandle;
224 int nnames, namesize;
225 struct fxp_name **ournames;
226 struct fxp_names *names;
230 * First, attempt to create the destination directory,
231 * unless it already exists.
233 if (file_type(outfname) != FILE_TYPE_DIRECTORY &&
234 !create_directory(outfname)) {
235 printf("%s: Cannot create directory\n", outfname);
240 * Now get the list of filenames in the remote
243 sftp_register(req = fxp_opendir_send(fname));
244 rreq = sftp_find_request(pktin = sftp_recv());
246 dirhandle = fxp_opendir_recv(pktin, rreq);
249 printf("%s: unable to open directory: %s\n",
253 nnames = namesize = 0;
258 sftp_register(req = fxp_readdir_send(dirhandle));
259 rreq = sftp_find_request(pktin = sftp_recv());
261 names = fxp_readdir_recv(pktin, rreq);
264 if (fxp_error_type() == SSH_FX_EOF)
266 printf("%s: reading directory: %s\n", fname, fxp_error());
270 if (names->nnames == 0) {
271 fxp_free_names(names);
274 if (nnames + names->nnames >= namesize) {
275 namesize += names->nnames + 128;
276 ournames = sresize(ournames, namesize, struct fxp_name *);
278 for (i = 0; i < names->nnames; i++)
279 if (strcmp(names->names[i].filename, ".") &&
280 strcmp(names->names[i].filename, "..")) {
281 if (!vet_filename(names->names[i].filename)) {
282 printf("ignoring potentially dangerous server-"
283 "supplied filename '%s'\n",
284 names->names[i].filename);
287 fxp_dup_name(&names->names[i]);
290 fxp_free_names(names);
292 sftp_register(req = fxp_close_send(dirhandle));
293 rreq = sftp_find_request(pktin = sftp_recv());
295 fxp_close_recv(pktin, rreq);
298 * Sort the names into a clear order. This ought to
299 * make things more predictable when we're doing a
300 * reget of the same directory, just in case two
301 * readdirs on the same remote directory return a
304 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
307 * If we're in restart mode, find the last filename on
308 * this list that already exists. We may have to do a
309 * reget on _that_ file, but shouldn't have to do
310 * anything on the previous files.
312 * If none of them exists, of course, we start at 0.
319 nextoutfname = dir_file_cat(outfname,
320 ournames[i]->filename);
322 nextoutfname = dupstr(ournames[i]->filename);
323 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
333 * Now we're ready to recurse. Starting at ournames[i]
334 * and continuing on to the end of the list, we
335 * construct a new source and target file name, and
336 * call sftp_get_file again.
338 for (; i < nnames; i++) {
339 char *nextfname, *nextoutfname;
342 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
344 nextoutfname = dir_file_cat(outfname,
345 ournames[i]->filename);
347 nextoutfname = dupstr(ournames[i]->filename);
348 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
349 restart = FALSE; /* after first partial file, do full */
353 for (i = 0; i < nnames; i++) {
354 fxp_free_name(ournames[i]);
362 * Done this recursion level. Free everything.
364 for (i = 0; i < nnames; i++) {
365 fxp_free_name(ournames[i]);
373 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
374 rreq = sftp_find_request(pktin = sftp_recv());
376 fh = fxp_open_recv(pktin, rreq);
379 printf("%s: %s\n", fname, fxp_error());
384 fp = fopen(outfname, "rb+");
386 fp = fopen(outfname, "wb");
390 printf("local: unable to open %s\n", outfname);
392 sftp_register(req = fxp_close_send(fh));
393 rreq = sftp_find_request(pktin = sftp_recv());
395 fxp_close_recv(pktin, rreq);
402 fseek(fp, 0L, SEEK_END);
404 printf("reget: restarting at file position %ld\n", posn);
405 offset = uint64_make(0, posn);
407 offset = uint64_make(0, 0);
410 printf("remote:%s => local:%s\n", fname, outfname);
413 * FIXME: we can use FXP_FSTAT here to get the file size, and
414 * thus put up a progress bar.
417 xfer = xfer_download_init(fh, offset);
418 while (!xfer_done(xfer)) {
423 xfer_download_queue(xfer);
425 ret = xfer_download_gotpkt(xfer, pktin);
429 printf("error while reading: %s\n", fxp_error());
435 while (xfer_download_data(xfer, &vbuf, &len)) {
436 unsigned char *buf = (unsigned char *)vbuf;
440 wlen = fwrite(buf + wpos, 1, len - wpos, fp);
442 printf("error while writing local file\n");
444 xfer_set_error(xfer);
448 if (wpos < len) { /* we had an error */
450 xfer_set_error(xfer);
461 sftp_register(req = fxp_close_send(fh));
462 rreq = sftp_find_request(pktin = sftp_recv());
464 fxp_close_recv(pktin, rreq);
469 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
471 struct fxp_handle *fh;
472 struct fxp_xfer *xfer;
473 struct sftp_packet *pktin;
474 struct sftp_request *req, *rreq;
480 * In recursive mode, see if we're dealing with a directory.
481 * (If we're not in recursive mode, we need not even check: the
482 * subsequent fopen will return an error message.)
484 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
485 struct fxp_attrs attrs;
487 int nnames, namesize;
488 char *name, **ournames;
493 * First, attempt to create the destination directory,
494 * unless it already exists.
496 sftp_register(req = fxp_stat_send(outfname));
497 rreq = sftp_find_request(pktin = sftp_recv());
499 result = fxp_stat_recv(pktin, rreq, &attrs);
501 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
502 !(attrs.permissions & 0040000)) {
503 sftp_register(req = fxp_mkdir_send(outfname));
504 rreq = sftp_find_request(pktin = sftp_recv());
506 result = fxp_mkdir_recv(pktin, rreq);
509 printf("%s: create directory: %s\n",
510 outfname, fxp_error());
516 * Now get the list of filenames in the local directory.
518 nnames = namesize = 0;
521 dh = open_directory(fname);
523 printf("%s: unable to open directory\n", fname);
526 while ((name = read_filename(dh)) != NULL) {
527 if (nnames >= namesize) {
529 ournames = sresize(ournames, namesize, char *);
531 ournames[nnames++] = name;
536 * Sort the names into a clear order. This ought to make
537 * things more predictable when we're doing a reput of the
538 * same directory, just in case two readdirs on the same
539 * local directory return a different order.
541 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
544 * If we're in restart mode, find the last filename on this
545 * list that already exists. We may have to do a reput on
546 * _that_ file, but shouldn't have to do anything on the
549 * If none of them exists, of course, we start at 0.
554 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
555 sftp_register(req = fxp_stat_send(nextoutfname));
556 rreq = sftp_find_request(pktin = sftp_recv());
558 result = fxp_stat_recv(pktin, rreq, &attrs);
568 * Now we're ready to recurse. Starting at ournames[i]
569 * and continuing on to the end of the list, we
570 * construct a new source and target file name, and
571 * call sftp_put_file again.
573 for (; i < nnames; i++) {
574 char *nextfname, *nextoutfname;
578 nextfname = dir_file_cat(fname, ournames[i]);
580 nextfname = dupstr(ournames[i]);
581 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
582 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
583 restart = FALSE; /* after first partial file, do full */
587 for (i = 0; i < nnames; i++) {
596 * Done this recursion level. Free everything.
598 for (i = 0; i < nnames; i++) {
606 fp = fopen(fname, "rb");
608 printf("local: unable to open %s\n", fname);
612 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
614 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
615 SSH_FXF_CREAT | SSH_FXF_TRUNC));
617 rreq = sftp_find_request(pktin = sftp_recv());
619 fh = fxp_open_recv(pktin, rreq);
622 printf("%s: %s\n", outfname, fxp_error());
628 struct fxp_attrs attrs;
631 sftp_register(req = fxp_fstat_send(fh));
632 rreq = sftp_find_request(pktin = sftp_recv());
634 ret = fxp_fstat_recv(pktin, rreq, &attrs);
637 printf("read size of %s: %s\n", outfname, fxp_error());
640 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
641 printf("read size of %s: size was not given\n", outfname);
645 uint64_decimal(offset, decbuf);
646 printf("reput: restarting at file position %s\n", decbuf);
647 if (uint64_compare(offset, uint64_make(0, LONG_MAX)) > 0) {
648 printf("reput: remote file is larger than we can deal with\n");
651 if (fseek(fp, offset.lo, SEEK_SET) != 0)
652 fseek(fp, 0, SEEK_END); /* *shrug* */
654 offset = uint64_make(0, 0);
657 printf("local:%s => remote:%s\n", fname, outfname);
660 * FIXME: we can use FXP_FSTAT here to get the file size, and
661 * thus put up a progress bar.
664 xfer = xfer_upload_init(fh, offset);
666 while ((!err && !eof) || !xfer_done(xfer)) {
670 while (xfer_upload_ready(xfer) && !err && !eof) {
671 len = fread(buffer, 1, sizeof(buffer), fp);
673 printf("error while reading local file\n");
675 } else if (len == 0) {
678 xfer_upload_data(xfer, buffer, len);
682 if (!xfer_done(xfer)) {
684 ret = xfer_upload_gotpkt(xfer, pktin);
686 printf("error while writing: %s\n", fxp_error());
694 sftp_register(req = fxp_close_send(fh));
695 rreq = sftp_find_request(pktin = sftp_recv());
697 fxp_close_recv(pktin, rreq);
704 /* ----------------------------------------------------------------------
705 * A remote wildcard matcher, providing a similar interface to the
706 * local one in psftp.h.
709 typedef struct SftpWildcardMatcher {
710 struct fxp_handle *dirh;
711 struct fxp_names *names;
713 char *wildcard, *prefix;
714 } SftpWildcardMatcher;
716 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
718 struct sftp_packet *pktin;
719 struct sftp_request *req, *rreq;
721 char *unwcdir, *tmpdir, *cdir;
723 SftpWildcardMatcher *swcm;
724 struct fxp_handle *dirh;
727 * We don't handle multi-level wildcards; so we expect to find
728 * a fully specified directory part, followed by a wildcard
731 wildcard = stripslashes(name, 0);
733 unwcdir = dupstr(name);
734 len = wildcard - name;
736 if (len > 0 && unwcdir[len-1] == '/')
737 unwcdir[len-1] = '\0';
738 tmpdir = snewn(1 + len, char);
739 check = wc_unescape(tmpdir, unwcdir);
743 printf("Multiple-level wildcards are not supported\n");
748 cdir = canonify(unwcdir);
750 sftp_register(req = fxp_opendir_send(cdir));
751 rreq = sftp_find_request(pktin = sftp_recv());
753 dirh = fxp_opendir_recv(pktin, rreq);
756 swcm = snew(SftpWildcardMatcher);
759 swcm->wildcard = dupstr(wildcard);
760 swcm->prefix = unwcdir;
762 printf("Unable to open %s: %s\n", cdir, fxp_error());
772 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
774 struct fxp_name *name;
775 struct sftp_packet *pktin;
776 struct sftp_request *req, *rreq;
779 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
780 fxp_free_names(swcm->names);
785 sftp_register(req = fxp_readdir_send(swcm->dirh));
786 rreq = sftp_find_request(pktin = sftp_recv());
788 swcm->names = fxp_readdir_recv(pktin, rreq);
791 if (fxp_error_type() != SSH_FX_EOF)
792 printf("%s: reading directory: %s\n", swcm->prefix,
800 assert(swcm->names && swcm->namepos < swcm->names->nnames);
802 name = &swcm->names->names[swcm->namepos++];
804 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
805 continue; /* expected bad filenames */
807 if (!vet_filename(name->filename)) {
808 printf("ignoring potentially dangerous server-"
809 "supplied filename '%s'\n", name->filename);
810 continue; /* unexpected bad filename */
813 if (!wc_match(swcm->wildcard, name->filename))
814 continue; /* doesn't match the wildcard */
817 * We have a working filename. Return it.
819 return dupprintf("%s%s%s", swcm->prefix,
821 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
827 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
829 struct sftp_packet *pktin;
830 struct sftp_request *req, *rreq;
832 sftp_register(req = fxp_close_send(swcm->dirh));
833 rreq = sftp_find_request(pktin = sftp_recv());
835 fxp_close_recv(pktin, rreq);
838 fxp_free_names(swcm->names);
841 sfree(swcm->wildcard);
847 * General function to match a potential wildcard in a filename
848 * argument and iterate over every matching file. Used in several
849 * PSFTP commands (rmdir, rm, chmod, mv).
851 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
853 char *unwcfname, *newname, *cname;
856 unwcfname = snewn(strlen(filename)+1, char);
857 is_wc = !wc_unescape(unwcfname, filename);
860 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
869 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
870 cname = canonify(newname);
872 printf("%s: %s\n", newname, fxp_error());
876 ret &= func(ctx, cname);
881 /* Politely warn the user that nothing matched. */
882 printf("%s: nothing matched\n", filename);
885 sftp_finish_wildcard_matching(swcm);
887 cname = canonify(unwcfname);
889 printf("%s: %s\n", filename, fxp_error());
892 ret = func(ctx, cname);
901 * Handy helper function.
903 int is_wildcard(char *name)
905 char *unwcfname = snewn(strlen(name)+1, char);
906 int is_wc = !wc_unescape(unwcfname, name);
911 /* ----------------------------------------------------------------------
912 * Actual sftp commands.
914 struct sftp_command {
916 int nwords, wordssize;
917 int (*obey) (struct sftp_command *); /* returns <0 to quit */
920 int sftp_cmd_null(struct sftp_command *cmd)
922 return 1; /* success */
925 int sftp_cmd_unknown(struct sftp_command *cmd)
927 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
928 return 0; /* failure */
931 int sftp_cmd_quit(struct sftp_command *cmd)
936 int sftp_cmd_close(struct sftp_command *cmd)
939 printf("psftp: not connected to a host; use \"open host.name\"\n");
943 if (back != NULL && back->socket(backhandle) != NULL) {
945 back->special(backhandle, TS_EOF);
946 sftp_recvdata(&ch, 1);
954 * List a directory. If no arguments are given, list pwd; otherwise
955 * list the directory given in words[1].
957 int sftp_cmd_ls(struct sftp_command *cmd)
959 struct fxp_handle *dirh;
960 struct fxp_names *names;
961 struct fxp_name **ournames;
962 int nnames, namesize;
963 char *dir, *cdir, *unwcdir, *wildcard;
964 struct sftp_packet *pktin;
965 struct sftp_request *req, *rreq;
969 printf("psftp: not connected to a host; use \"open host.name\"\n");
978 unwcdir = snewn(1 + strlen(dir), char);
979 if (wc_unescape(unwcdir, dir)) {
986 wildcard = stripslashes(dir, 0);
987 unwcdir = dupstr(dir);
988 len = wildcard - dir;
990 if (len > 0 && unwcdir[len-1] == '/')
991 unwcdir[len-1] = '\0';
992 tmpdir = snewn(1 + len, char);
993 check = wc_unescape(tmpdir, unwcdir);
996 printf("Multiple-level wildcards are not supported\n");
1003 cdir = canonify(dir);
1005 printf("%s: %s\n", dir, fxp_error());
1010 printf("Listing directory %s\n", cdir);
1012 sftp_register(req = fxp_opendir_send(cdir));
1013 rreq = sftp_find_request(pktin = sftp_recv());
1014 assert(rreq == req);
1015 dirh = fxp_opendir_recv(pktin, rreq);
1018 printf("Unable to open %s: %s\n", dir, fxp_error());
1020 nnames = namesize = 0;
1025 sftp_register(req = fxp_readdir_send(dirh));
1026 rreq = sftp_find_request(pktin = sftp_recv());
1027 assert(rreq == req);
1028 names = fxp_readdir_recv(pktin, rreq);
1030 if (names == NULL) {
1031 if (fxp_error_type() == SSH_FX_EOF)
1033 printf("Reading directory %s: %s\n", dir, fxp_error());
1036 if (names->nnames == 0) {
1037 fxp_free_names(names);
1041 if (nnames + names->nnames >= namesize) {
1042 namesize += names->nnames + 128;
1043 ournames = sresize(ournames, namesize, struct fxp_name *);
1046 for (i = 0; i < names->nnames; i++)
1047 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1048 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1050 fxp_free_names(names);
1052 sftp_register(req = fxp_close_send(dirh));
1053 rreq = sftp_find_request(pktin = sftp_recv());
1054 assert(rreq == req);
1055 fxp_close_recv(pktin, rreq);
1058 * Now we have our filenames. Sort them by actual file
1059 * name, and then output the longname parts.
1061 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1066 for (i = 0; i < nnames; i++) {
1067 printf("%s\n", ournames[i]->longname);
1068 fxp_free_name(ournames[i]);
1080 * Change directories. We do this by canonifying the new name, then
1081 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1083 int sftp_cmd_cd(struct sftp_command *cmd)
1085 struct fxp_handle *dirh;
1086 struct sftp_packet *pktin;
1087 struct sftp_request *req, *rreq;
1091 printf("psftp: not connected to a host; use \"open host.name\"\n");
1095 if (cmd->nwords < 2)
1096 dir = dupstr(homedir);
1098 dir = canonify(cmd->words[1]);
1101 printf("%s: %s\n", dir, fxp_error());
1105 sftp_register(req = fxp_opendir_send(dir));
1106 rreq = sftp_find_request(pktin = sftp_recv());
1107 assert(rreq == req);
1108 dirh = fxp_opendir_recv(pktin, rreq);
1111 printf("Directory %s: %s\n", dir, fxp_error());
1116 sftp_register(req = fxp_close_send(dirh));
1117 rreq = sftp_find_request(pktin = sftp_recv());
1118 assert(rreq == req);
1119 fxp_close_recv(pktin, rreq);
1123 printf("Remote directory is now %s\n", pwd);
1129 * Print current directory. Easy as pie.
1131 int sftp_cmd_pwd(struct sftp_command *cmd)
1134 printf("psftp: not connected to a host; use \"open host.name\"\n");
1138 printf("Remote directory is %s\n", pwd);
1143 * Get a file and save it at the local end. We have three very
1144 * similar commands here. The basic one is `get'; `reget' differs
1145 * in that it checks for the existence of the destination file and
1146 * starts from where a previous aborted transfer left off; `mget'
1147 * differs in that it interprets all its arguments as files to
1148 * transfer (never as a different local name for a remote file) and
1149 * can handle wildcards.
1151 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1153 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1155 int recurse = FALSE;
1158 printf("psftp: not connected to a host; use \"open host.name\"\n");
1163 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1164 if (!strcmp(cmd->words[i], "--")) {
1165 /* finish processing options */
1168 } else if (!strcmp(cmd->words[i], "-r")) {
1171 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1177 if (i >= cmd->nwords) {
1178 printf("%s: expects a filename\n", cmd->words[0]);
1184 SftpWildcardMatcher *swcm;
1186 origfname = cmd->words[i++];
1187 unwcfname = snewn(strlen(origfname)+1, char);
1189 if (multiple && !wc_unescape(unwcfname, origfname)) {
1190 swcm = sftp_begin_wildcard_matching(origfname);
1195 origwfname = sftp_wildcard_get_filename(swcm);
1197 /* Politely warn the user that nothing matched. */
1198 printf("%s: nothing matched\n", origfname);
1199 sftp_finish_wildcard_matching(swcm);
1204 origwfname = origfname;
1208 while (origwfname) {
1209 fname = canonify(origwfname);
1212 printf("%s: %s\n", origwfname, fxp_error());
1217 if (!multiple && i < cmd->nwords)
1218 outfname = cmd->words[i++];
1220 outfname = stripslashes(origwfname, 0);
1222 ret = sftp_get_file(fname, outfname, recurse, restart);
1228 origwfname = sftp_wildcard_get_filename(swcm);
1235 sftp_finish_wildcard_matching(swcm);
1239 } while (multiple && i < cmd->nwords);
1243 int sftp_cmd_get(struct sftp_command *cmd)
1245 return sftp_general_get(cmd, 0, 0);
1247 int sftp_cmd_mget(struct sftp_command *cmd)
1249 return sftp_general_get(cmd, 0, 1);
1251 int sftp_cmd_reget(struct sftp_command *cmd)
1253 return sftp_general_get(cmd, 1, 0);
1257 * Send a file and store it at the remote end. We have three very
1258 * similar commands here. The basic one is `put'; `reput' differs
1259 * in that it checks for the existence of the destination file and
1260 * starts from where a previous aborted transfer left off; `mput'
1261 * differs in that it interprets all its arguments as files to
1262 * transfer (never as a different remote name for a local file) and
1263 * can handle wildcards.
1265 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1267 char *fname, *wfname, *origoutfname, *outfname;
1269 int recurse = FALSE;
1272 printf("psftp: not connected to a host; use \"open host.name\"\n");
1277 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1278 if (!strcmp(cmd->words[i], "--")) {
1279 /* finish processing options */
1282 } else if (!strcmp(cmd->words[i], "-r")) {
1285 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1291 if (i >= cmd->nwords) {
1292 printf("%s: expects a filename\n", cmd->words[0]);
1298 WildcardMatcher *wcm;
1299 fname = cmd->words[i++];
1301 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1302 wcm = begin_wildcard_matching(fname);
1303 wfname = wildcard_get_filename(wcm);
1305 /* Politely warn the user that nothing matched. */
1306 printf("%s: nothing matched\n", fname);
1307 finish_wildcard_matching(wcm);
1316 if (!multiple && i < cmd->nwords)
1317 origoutfname = cmd->words[i++];
1319 origoutfname = stripslashes(wfname, 1);
1321 outfname = canonify(origoutfname);
1323 printf("%s: %s\n", origoutfname, fxp_error());
1326 finish_wildcard_matching(wcm);
1330 ret = sftp_put_file(wfname, outfname, recurse, restart);
1335 wfname = wildcard_get_filename(wcm);
1342 finish_wildcard_matching(wcm);
1347 } while (multiple && i < cmd->nwords);
1351 int sftp_cmd_put(struct sftp_command *cmd)
1353 return sftp_general_put(cmd, 0, 0);
1355 int sftp_cmd_mput(struct sftp_command *cmd)
1357 return sftp_general_put(cmd, 0, 1);
1359 int sftp_cmd_reput(struct sftp_command *cmd)
1361 return sftp_general_put(cmd, 1, 0);
1364 int sftp_cmd_mkdir(struct sftp_command *cmd)
1367 struct sftp_packet *pktin;
1368 struct sftp_request *req, *rreq;
1373 printf("psftp: not connected to a host; use \"open host.name\"\n");
1377 if (cmd->nwords < 2) {
1378 printf("mkdir: expects a directory\n");
1383 for (i = 1; i < cmd->nwords; i++) {
1384 dir = canonify(cmd->words[i]);
1386 printf("%s: %s\n", dir, fxp_error());
1390 sftp_register(req = fxp_mkdir_send(dir));
1391 rreq = sftp_find_request(pktin = sftp_recv());
1392 assert(rreq == req);
1393 result = fxp_mkdir_recv(pktin, rreq);
1396 printf("mkdir %s: %s\n", dir, fxp_error());
1400 printf("mkdir %s: OK\n", dir);
1408 static int sftp_action_rmdir(void *vctx, char *dir)
1410 struct sftp_packet *pktin;
1411 struct sftp_request *req, *rreq;
1414 sftp_register(req = fxp_rmdir_send(dir));
1415 rreq = sftp_find_request(pktin = sftp_recv());
1416 assert(rreq == req);
1417 result = fxp_rmdir_recv(pktin, rreq);
1420 printf("rmdir %s: %s\n", dir, fxp_error());
1424 printf("rmdir %s: OK\n", dir);
1429 int sftp_cmd_rmdir(struct sftp_command *cmd)
1434 printf("psftp: not connected to a host; use \"open host.name\"\n");
1438 if (cmd->nwords < 2) {
1439 printf("rmdir: expects a directory\n");
1444 for (i = 1; i < cmd->nwords; i++)
1445 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1450 static int sftp_action_rm(void *vctx, char *fname)
1452 struct sftp_packet *pktin;
1453 struct sftp_request *req, *rreq;
1456 sftp_register(req = fxp_remove_send(fname));
1457 rreq = sftp_find_request(pktin = sftp_recv());
1458 assert(rreq == req);
1459 result = fxp_remove_recv(pktin, rreq);
1462 printf("rm %s: %s\n", fname, fxp_error());
1466 printf("rm %s: OK\n", fname);
1471 int sftp_cmd_rm(struct sftp_command *cmd)
1476 printf("psftp: not connected to a host; use \"open host.name\"\n");
1480 if (cmd->nwords < 2) {
1481 printf("rm: expects a filename\n");
1486 for (i = 1; i < cmd->nwords; i++)
1487 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1492 static int check_is_dir(char *dstfname)
1494 struct sftp_packet *pktin;
1495 struct sftp_request *req, *rreq;
1496 struct fxp_attrs attrs;
1499 sftp_register(req = fxp_stat_send(dstfname));
1500 rreq = sftp_find_request(pktin = sftp_recv());
1501 assert(rreq == req);
1502 result = fxp_stat_recv(pktin, rreq, &attrs);
1505 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1506 (attrs.permissions & 0040000))
1512 struct sftp_context_mv {
1517 static int sftp_action_mv(void *vctx, char *srcfname)
1519 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1520 struct sftp_packet *pktin;
1521 struct sftp_request *req, *rreq;
1523 char *finalfname, *newcanon = NULL;
1526 if (ctx->dest_is_dir) {
1530 p = srcfname + strlen(srcfname);
1531 while (p > srcfname && p[-1] != '/') p--;
1532 newname = dupcat(ctx->dstfname, "/", p, NULL);
1533 newcanon = canonify(newname);
1535 printf("%s: %s\n", newname, fxp_error());
1541 finalfname = newcanon;
1543 finalfname = ctx->dstfname;
1546 sftp_register(req = fxp_rename_send(srcfname, finalfname));
1547 rreq = sftp_find_request(pktin = sftp_recv());
1548 assert(rreq == req);
1549 result = fxp_rename_recv(pktin, rreq);
1551 error = result ? NULL : fxp_error();
1554 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1557 printf("%s -> %s\n", srcfname, finalfname);
1565 int sftp_cmd_mv(struct sftp_command *cmd)
1567 struct sftp_context_mv actx, *ctx = &actx;
1571 printf("psftp: not connected to a host; use \"open host.name\"\n");
1575 if (cmd->nwords < 3) {
1576 printf("mv: expects two filenames\n");
1580 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1581 if (!ctx->dstfname) {
1582 printf("%s: %s\n", ctx->dstfname, fxp_error());
1587 * If there's more than one source argument, or one source
1588 * argument which is a wildcard, we _require_ that the
1589 * destination is a directory.
1591 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1592 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1593 printf("mv: multiple or wildcard arguments require the destination"
1594 " to be a directory\n");
1595 sfree(ctx->dstfname);
1600 * Now iterate over the source arguments.
1603 for (i = 1; i < cmd->nwords-1; i++)
1604 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1606 sfree(ctx->dstfname);
1610 struct sftp_context_chmod {
1611 unsigned attrs_clr, attrs_xor;
1614 static int sftp_action_chmod(void *vctx, char *fname)
1616 struct fxp_attrs attrs;
1617 struct sftp_packet *pktin;
1618 struct sftp_request *req, *rreq;
1620 unsigned oldperms, newperms;
1621 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1623 sftp_register(req = fxp_stat_send(fname));
1624 rreq = sftp_find_request(pktin = sftp_recv());
1625 assert(rreq == req);
1626 result = fxp_stat_recv(pktin, rreq, &attrs);
1628 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1629 printf("get attrs for %s: %s\n", fname,
1630 result ? "file permissions not provided" : fxp_error());
1634 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1635 oldperms = attrs.permissions & 07777;
1636 attrs.permissions &= ~ctx->attrs_clr;
1637 attrs.permissions ^= ctx->attrs_xor;
1638 newperms = attrs.permissions & 07777;
1640 if (oldperms == newperms)
1641 return 1; /* no need to do anything! */
1643 sftp_register(req = fxp_setstat_send(fname, attrs));
1644 rreq = sftp_find_request(pktin = sftp_recv());
1645 assert(rreq == req);
1646 result = fxp_setstat_recv(pktin, rreq);
1649 printf("set attrs for %s: %s\n", fname, fxp_error());
1653 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1658 int sftp_cmd_chmod(struct sftp_command *cmd)
1662 struct sftp_context_chmod actx, *ctx = &actx;
1665 printf("psftp: not connected to a host; use \"open host.name\"\n");
1669 if (cmd->nwords < 3) {
1670 printf("chmod: expects a mode specifier and a filename\n");
1675 * Attempt to parse the mode specifier in cmd->words[1]. We
1676 * don't support the full horror of Unix chmod; instead we
1677 * support a much simpler syntax in which the user can either
1678 * specify an octal number, or a comma-separated sequence of
1679 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1680 * _only_ be omitted if the only attribute mentioned is t,
1681 * since all others require a user/group/other specification.
1682 * Additionally, the s attribute may not be specified for any
1683 * [ugoa] specifications other than exactly u or exactly g.
1685 ctx->attrs_clr = ctx->attrs_xor = 0;
1686 mode = cmd->words[1];
1687 if (mode[0] >= '0' && mode[0] <= '9') {
1688 if (mode[strspn(mode, "01234567")]) {
1689 printf("chmod: numeric file modes should"
1690 " contain digits 0-7 only\n");
1693 ctx->attrs_clr = 07777;
1694 sscanf(mode, "%o", &ctx->attrs_xor);
1695 ctx->attrs_xor &= ctx->attrs_clr;
1698 char *modebegin = mode;
1699 unsigned subset, perms;
1703 while (*mode && *mode != ',' &&
1704 *mode != '+' && *mode != '-' && *mode != '=') {
1706 case 'u': subset |= 04700; break; /* setuid, user perms */
1707 case 'g': subset |= 02070; break; /* setgid, group perms */
1708 case 'o': subset |= 00007; break; /* just other perms */
1709 case 'a': subset |= 06777; break; /* all of the above */
1711 printf("chmod: file mode '%.*s' contains unrecognised"
1712 " user/group/other specifier '%c'\n",
1713 (int)strcspn(modebegin, ","), modebegin, *mode);
1718 if (!*mode || *mode == ',') {
1719 printf("chmod: file mode '%.*s' is incomplete\n",
1720 (int)strcspn(modebegin, ","), modebegin);
1724 if (!*mode || *mode == ',') {
1725 printf("chmod: file mode '%.*s' is incomplete\n",
1726 (int)strcspn(modebegin, ","), modebegin);
1730 while (*mode && *mode != ',') {
1732 case 'r': perms |= 00444; break;
1733 case 'w': perms |= 00222; break;
1734 case 'x': perms |= 00111; break;
1735 case 't': perms |= 01000; subset |= 01000; break;
1737 if ((subset & 06777) != 04700 &&
1738 (subset & 06777) != 02070) {
1739 printf("chmod: file mode '%.*s': set[ug]id bit should"
1740 " be used with exactly one of u or g only\n",
1741 (int)strcspn(modebegin, ","), modebegin);
1747 printf("chmod: file mode '%.*s' contains unrecognised"
1748 " permission specifier '%c'\n",
1749 (int)strcspn(modebegin, ","), modebegin, *mode);
1754 if (!(subset & 06777) && (perms &~ subset)) {
1755 printf("chmod: file mode '%.*s' contains no user/group/other"
1756 " specifier and permissions other than 't' \n",
1757 (int)strcspn(modebegin, ","), modebegin);
1763 ctx->attrs_clr |= perms;
1764 ctx->attrs_xor |= perms;
1767 ctx->attrs_clr |= perms;
1768 ctx->attrs_xor &= ~perms;
1771 ctx->attrs_clr |= subset;
1772 ctx->attrs_xor |= perms;
1775 if (*mode) mode++; /* eat comma */
1780 for (i = 2; i < cmd->nwords; i++)
1781 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1786 static int sftp_cmd_open(struct sftp_command *cmd)
1791 printf("psftp: already connected\n");
1795 if (cmd->nwords < 2) {
1796 printf("open: expects a host name\n");
1800 if (cmd->nwords > 2) {
1801 portnumber = atoi(cmd->words[2]);
1802 if (portnumber == 0) {
1803 printf("open: invalid port number\n");
1809 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1810 back = NULL; /* connection is already closed */
1811 return -1; /* this is fatal */
1817 static int sftp_cmd_lcd(struct sftp_command *cmd)
1819 char *currdir, *errmsg;
1821 if (cmd->nwords < 2) {
1822 printf("lcd: expects a local directory name\n");
1826 errmsg = psftp_lcd(cmd->words[1]);
1828 printf("lcd: unable to change directory: %s\n", errmsg);
1833 currdir = psftp_getcwd();
1834 printf("New local directory is %s\n", currdir);
1840 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1844 currdir = psftp_getcwd();
1845 printf("Current local directory is %s\n", currdir);
1851 static int sftp_cmd_pling(struct sftp_command *cmd)
1855 exitcode = system(cmd->words[1]);
1856 return (exitcode == 0);
1859 static int sftp_cmd_help(struct sftp_command *cmd);
1861 static struct sftp_cmd_lookup {
1864 * For help purposes, there are two kinds of command:
1866 * - primary commands, in which `longhelp' is non-NULL. In
1867 * this case `shorthelp' is descriptive text, and `longhelp'
1868 * is longer descriptive text intended to be printed after
1871 * - alias commands, in which `longhelp' is NULL. In this case
1872 * `shorthelp' is the name of a primary command, which
1873 * contains the help that should double up for this command.
1875 int listed; /* do we list this in primary help? */
1878 int (*obey) (struct sftp_command *);
1881 * List of sftp commands. This is binary-searched so it MUST be
1885 "!", TRUE, "run a local command",
1887 /* FIXME: this example is crap for non-Windows. */
1888 " Runs a local command. For example, \"!del myfile\".\n",
1892 "bye", TRUE, "finish your SFTP session",
1894 " Terminates your SFTP session and quits the PSFTP program.\n",
1898 "cd", TRUE, "change your remote working directory",
1899 " [ <new working directory> ]\n"
1900 " Change the remote working directory for your SFTP session.\n"
1901 " If a new working directory is not supplied, you will be\n"
1902 " returned to your home directory.\n",
1906 "chmod", TRUE, "change file permissions and modes",
1907 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1908 " Change the file permissions on one or more remote files or\n"
1910 " <modes> can be any octal Unix permission specifier.\n"
1911 " Alternatively, <modes> can include the following modifiers:\n"
1912 " u+r make file readable by owning user\n"
1913 " u+w make file writable by owning user\n"
1914 " u+x make file executable by owning user\n"
1915 " u-r make file not readable by owning user\n"
1916 " [also u-w, u-x]\n"
1917 " g+r make file readable by members of owning group\n"
1918 " [also g+w, g+x, g-r, g-w, g-x]\n"
1919 " o+r make file readable by all other users\n"
1920 " [also o+w, o+x, o-r, o-w, o-x]\n"
1921 " a+r make file readable by absolutely everybody\n"
1922 " [also a+w, a+x, a-r, a-w, a-x]\n"
1923 " u+s enable the Unix set-user-ID bit\n"
1924 " u-s disable the Unix set-user-ID bit\n"
1925 " g+s enable the Unix set-group-ID bit\n"
1926 " g-s disable the Unix set-group-ID bit\n"
1927 " +t enable the Unix \"sticky bit\"\n"
1928 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1929 " more than one user for the same modifier (\"ug+w\"). You can\n"
1930 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1934 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1936 " Terminates your SFTP session, but does not quit the PSFTP\n"
1937 " program. You can then use \"open\" to start another SFTP\n"
1938 " session, to the same server or to a different one.\n",
1942 "del", TRUE, "delete files on the remote server",
1943 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1944 " Delete a file or files from the server.\n",
1948 "delete", FALSE, "del", NULL, sftp_cmd_rm
1951 "dir", TRUE, "list remote files",
1952 " [ <directory-name> ]/[ <wildcard> ]\n"
1953 " List the contents of a specified directory on the server.\n"
1954 " If <directory-name> is not given, the current working directory\n"
1956 " If <wildcard> is given, it is treated as a set of files to\n"
1957 " list; otherwise, all files are listed.\n",
1961 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1964 "get", TRUE, "download a file from the server to your local machine",
1965 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1966 " Downloads a file on the server and stores it locally under\n"
1967 " the same name, or under a different one if you supply the\n"
1968 " argument <local-filename>.\n"
1969 " If -r specified, recursively fetch a directory.\n",
1973 "help", TRUE, "give help",
1974 " [ <command> [ <command> ... ] ]\n"
1975 " Give general help if no commands are specified.\n"
1976 " If one or more commands are specified, give specific help on\n"
1977 " those particular commands.\n",
1981 "lcd", TRUE, "change local working directory",
1982 " <local-directory-name>\n"
1983 " Change the local working directory of the PSFTP program (the\n"
1984 " default location where the \"get\" command will save files).\n",
1988 "lpwd", TRUE, "print local working directory",
1990 " Print the local working directory of the PSFTP program (the\n"
1991 " default location where the \"get\" command will save files).\n",
1995 "ls", TRUE, "dir", NULL,
1999 "mget", TRUE, "download multiple files at once",
2000 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2001 " Downloads many files from the server, storing each one under\n"
2002 " the same name it has on the server side. You can use wildcards\n"
2003 " such as \"*.c\" to specify lots of files at once.\n"
2004 " If -r specified, recursively fetch files and directories.\n",
2008 "mkdir", TRUE, "create directories on the remote server",
2009 " <directory-name> [ <directory-name>... ]\n"
2010 " Creates directories with the given names on the server.\n",
2014 "mput", TRUE, "upload multiple files at once",
2015 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2016 " Uploads many files to the server, storing each one under the\n"
2017 " same name it has on the client side. You can use wildcards\n"
2018 " such as \"*.c\" to specify lots of files at once.\n"
2019 " If -r specified, recursively store files and directories.\n",
2023 "mv", TRUE, "move or rename file(s) on the remote server",
2024 " <source> [ <source>... ] <destination>\n"
2025 " Moves or renames <source>(s) on the server to <destination>,\n"
2026 " also on the server.\n"
2027 " If <destination> specifies an existing directory, then <source>\n"
2028 " may be a wildcard, and multiple <source>s may be given; all\n"
2029 " source files are moved into <destination>.\n"
2030 " Otherwise, <source> must specify a single file, which is moved\n"
2031 " or renamed so that it is accessible under the name <destination>.\n",
2035 "open", TRUE, "connect to a host",
2036 " [<user>@]<hostname> [<port>]\n"
2037 " Establishes an SFTP connection to a given host. Only usable\n"
2038 " when you are not already connected to a server.\n",
2042 "put", TRUE, "upload a file from your local machine to the server",
2043 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2044 " Uploads a file to the server and stores it there under\n"
2045 " the same name, or under a different one if you supply the\n"
2046 " argument <remote-filename>.\n"
2047 " If -r specified, recursively store a directory.\n",
2051 "pwd", TRUE, "print your remote working directory",
2053 " Print the current remote working directory for your SFTP session.\n",
2057 "quit", TRUE, "bye", NULL,
2061 "reget", TRUE, "continue downloading files",
2062 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2063 " Works exactly like the \"get\" command, but the local file\n"
2064 " must already exist. The download will begin at the end of the\n"
2065 " file. This is for resuming a download that was interrupted.\n"
2066 " If -r specified, resume interrupted \"get -r\".\n",
2070 "ren", TRUE, "mv", NULL,
2074 "rename", FALSE, "mv", NULL,
2078 "reput", TRUE, "continue uploading files",
2079 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2080 " Works exactly like the \"put\" command, but the remote file\n"
2081 " must already exist. The upload will begin at the end of the\n"
2082 " file. This is for resuming an upload that was interrupted.\n"
2083 " If -r specified, resume interrupted \"put -r\".\n",
2087 "rm", TRUE, "del", NULL,
2091 "rmdir", TRUE, "remove directories on the remote server",
2092 " <directory-name> [ <directory-name>... ]\n"
2093 " Removes the directory with the given name on the server.\n"
2094 " The directory will not be removed unless it is empty.\n"
2095 " Wildcards may be used to specify multiple directories.\n",
2100 const struct sftp_cmd_lookup *lookup_command(char *name)
2105 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2108 cmp = strcmp(name, sftp_lookup[k].name);
2114 return &sftp_lookup[k];
2120 static int sftp_cmd_help(struct sftp_command *cmd)
2123 if (cmd->nwords == 1) {
2125 * Give short help on each command.
2129 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2131 if (!sftp_lookup[i].listed)
2133 len = strlen(sftp_lookup[i].name);
2137 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2138 const struct sftp_cmd_lookup *lookup;
2139 if (!sftp_lookup[i].listed)
2141 lookup = &sftp_lookup[i];
2142 printf("%-*s", maxlen+2, lookup->name);
2143 if (lookup->longhelp == NULL)
2144 lookup = lookup_command(lookup->shorthelp);
2145 printf("%s\n", lookup->shorthelp);
2149 * Give long help on specific commands.
2151 for (i = 1; i < cmd->nwords; i++) {
2152 const struct sftp_cmd_lookup *lookup;
2153 lookup = lookup_command(cmd->words[i]);
2155 printf("help: %s: command not found\n", cmd->words[i]);
2157 printf("%s", lookup->name);
2158 if (lookup->longhelp == NULL)
2159 lookup = lookup_command(lookup->shorthelp);
2160 printf("%s", lookup->longhelp);
2167 /* ----------------------------------------------------------------------
2168 * Command line reading and parsing.
2170 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2173 struct sftp_command *cmd;
2177 cmd = snew(struct sftp_command);
2187 line = fgetline(fp);
2189 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2192 if (!line || !*line) {
2193 cmd->obey = sftp_cmd_quit;
2194 if ((mode == 0) || (modeflags & 1))
2196 return cmd; /* eof */
2199 line[strcspn(line, "\r\n")] = '\0';
2201 if (modeflags & 1) {
2202 printf("%s\n", line);
2206 while (*p && (*p == ' ' || *p == '\t'))
2211 * Special case: the ! command. This is always parsed as
2212 * exactly two words: one containing the !, and the second
2213 * containing everything else on the line.
2215 cmd->nwords = cmd->wordssize = 2;
2216 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2217 cmd->words[0] = dupstr("!");
2218 cmd->words[1] = dupstr(p+1);
2222 * Parse the command line into words. The syntax is:
2223 * - double quotes are removed, but cause spaces within to be
2224 * treated as non-separating.
2225 * - a double-doublequote pair is a literal double quote, inside
2226 * _or_ outside quotes. Like this:
2228 * firstword "second word" "this has ""quotes"" in" and""this""
2234 * >this has "quotes" in<
2238 /* skip whitespace */
2239 while (*p && (*p == ' ' || *p == '\t'))
2241 /* mark start of word */
2242 q = r = p; /* q sits at start, r writes word */
2245 if (!quoting && (*p == ' ' || *p == '\t'))
2246 break; /* reached end of word */
2247 else if (*p == '"' && p[1] == '"')
2248 p += 2, *r++ = '"'; /* a literal quote */
2250 p++, quoting = !quoting;
2255 p++; /* skip over the whitespace */
2257 if (cmd->nwords >= cmd->wordssize) {
2258 cmd->wordssize = cmd->nwords + 16;
2259 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2261 cmd->words[cmd->nwords++] = dupstr(q);
2268 * Now parse the first word and assign a function.
2271 if (cmd->nwords == 0)
2272 cmd->obey = sftp_cmd_null;
2274 const struct sftp_cmd_lookup *lookup;
2275 lookup = lookup_command(cmd->words[0]);
2277 cmd->obey = sftp_cmd_unknown;
2279 cmd->obey = lookup->obey;
2285 static int do_sftp_init(void)
2287 struct sftp_packet *pktin;
2288 struct sftp_request *req, *rreq;
2291 * Do protocol initialisation.
2295 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2296 return 1; /* failure */
2300 * Find out where our home directory is.
2302 sftp_register(req = fxp_realpath_send("."));
2303 rreq = sftp_find_request(pktin = sftp_recv());
2304 assert(rreq == req);
2305 homedir = fxp_realpath_recv(pktin, rreq);
2309 "Warning: failed to resolve home directory: %s\n",
2311 homedir = dupstr(".");
2313 printf("Remote working directory is %s\n", homedir);
2315 pwd = dupstr(homedir);
2319 void do_sftp_cleanup()
2323 back->special(backhandle, TS_EOF);
2324 sftp_recvdata(&ch, 1);
2325 back->free(backhandle);
2326 sftp_cleanup_request();
2340 void do_sftp(int mode, int modeflags, char *batchfile)
2350 /* ------------------------------------------------------------------
2351 * Now we're ready to do Real Stuff.
2354 struct sftp_command *cmd;
2355 cmd = sftp_getcmd(NULL, 0, 0);
2358 ret = cmd->obey(cmd);
2361 for(i = 0; i < cmd->nwords; i++)
2362 sfree(cmd->words[i]);
2370 fp = fopen(batchfile, "r");
2372 printf("Fatal: unable to open %s\n", batchfile);
2376 struct sftp_command *cmd;
2377 cmd = sftp_getcmd(fp, mode, modeflags);
2380 ret = cmd->obey(cmd);
2384 if (!(modeflags & 2))
2393 /* ----------------------------------------------------------------------
2394 * Dirty bits: integration with PuTTY.
2397 static int verbose = 0;
2400 * Print an error message and perform a fatal exit.
2402 void fatalbox(char *fmt, ...)
2407 str = dupvprintf(fmt, ap);
2408 str2 = dupcat("Fatal: ", str, "\n", NULL);
2411 fputs(str2, stderr);
2416 void modalfatalbox(char *fmt, ...)
2421 str = dupvprintf(fmt, ap);
2422 str2 = dupcat("Fatal: ", str, "\n", NULL);
2425 fputs(str2, stderr);
2430 void connection_fatal(void *frontend, char *fmt, ...)
2435 str = dupvprintf(fmt, ap);
2436 str2 = dupcat("Fatal: ", str, "\n", NULL);
2439 fputs(str2, stderr);
2445 void ldisc_send(void *handle, char *buf, int len, int interactive)
2448 * This is only here because of the calls to ldisc_send(NULL,
2449 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2450 * ldisc as an ldisc. So if we get called with any real data, I
2451 * want to know about it.
2457 * In psftp, all agent requests should be synchronous, so this is a
2458 * never-called stub.
2460 void agent_schedule_callback(void (*callback)(void *, void *, int),
2461 void *callback_ctx, void *data, int len)
2463 assert(!"We shouldn't be here");
2467 * Receive a block of data from the SSH link. Block until all data
2470 * To do this, we repeatedly call the SSH protocol module, with our
2471 * own trap in from_backend() to catch the data that comes back. We
2472 * do this until we have enough data.
2475 static unsigned char *outptr; /* where to put the data */
2476 static unsigned outlen; /* how much data required */
2477 static unsigned char *pending = NULL; /* any spare data */
2478 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2479 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2481 unsigned char *p = (unsigned char *) data;
2482 unsigned len = (unsigned) datalen;
2485 * stderr data is just spouted to local stderr and otherwise
2490 fwrite(data, 1, len, stderr);
2495 * If this is before the real session begins, just return.
2500 if ((outlen > 0) && (len > 0)) {
2501 unsigned used = outlen;
2504 memcpy(outptr, p, used);
2512 if (pendsize < pendlen + len) {
2513 pendsize = pendlen + len + 4096;
2514 pending = sresize(pending, pendsize, unsigned char);
2516 memcpy(pending + pendlen, p, len);
2522 int sftp_recvdata(char *buf, int len)
2524 outptr = (unsigned char *) buf;
2528 * See if the pending-input block contains some of what we
2532 unsigned pendused = pendlen;
2533 if (pendused > outlen)
2535 memcpy(outptr, pending, pendused);
2536 memmove(pending, pending + pendused, pendlen - pendused);
2539 pendlen -= pendused;
2549 while (outlen > 0) {
2550 if (ssh_sftp_loop_iteration() < 0)
2551 return 0; /* doom */
2556 int sftp_senddata(char *buf, int len)
2558 back->send(backhandle, buf, len);
2563 * Short description of parameters.
2565 static void usage(void)
2567 printf("PuTTY Secure File Transfer (SFTP) client\n");
2568 printf("%s\n", ver);
2569 printf("Usage: psftp [options] [user@]host\n");
2570 printf("Options:\n");
2571 printf(" -b file use specified batchfile\n");
2572 printf(" -bc output batchfile commands\n");
2573 printf(" -be don't stop batchfile processing if errors\n");
2574 printf(" -v show verbose messages\n");
2575 printf(" -load sessname Load settings from saved session\n");
2576 printf(" -l user connect with specified username\n");
2577 printf(" -P port connect to specified port\n");
2578 printf(" -pw passw login with specified password\n");
2579 printf(" -1 -2 force use of particular SSH protocol version\n");
2580 printf(" -4 -6 force use of IPv4 or IPv6\n");
2581 printf(" -C enable compression\n");
2582 printf(" -i key private key file for authentication\n");
2583 printf(" -batch disable all interactive prompts\n");
2584 printf(" -V print version information\n");
2588 static void version(void)
2590 printf("psftp: %s\n", ver);
2595 * Connect to a host.
2597 static int psftp_connect(char *userhost, char *user, int portnumber)
2599 char *host, *realhost;
2603 /* Separate host and username */
2605 host = strrchr(host, '@');
2611 printf("psftp: multiple usernames specified; using \"%s\"\n",
2618 * If we haven't loaded session details already (e.g., from -load),
2619 * try looking for a session called "host".
2621 if (!loaded_session) {
2622 /* Try to load settings for `host' into a temporary config */
2624 cfg2.host[0] = '\0';
2625 do_defaults(host, &cfg2);
2626 if (cfg2.host[0] != '\0') {
2627 /* Settings present and include hostname */
2628 /* Re-load data into the real config. */
2629 do_defaults(host, &cfg);
2631 /* Session doesn't exist or mention a hostname. */
2632 /* Use `host' as a bare hostname. */
2633 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2634 cfg.host[sizeof(cfg.host) - 1] = '\0';
2637 /* Patch in hostname `host' to session details. */
2638 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2639 cfg.host[sizeof(cfg.host) - 1] = '\0';
2643 * Force use of SSH. (If they got the protocol wrong we assume the
2644 * port is useless too.)
2646 if (cfg.protocol != PROT_SSH) {
2647 cfg.protocol = PROT_SSH;
2652 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2653 * then change it to SSH-2, on the grounds that that's more likely to
2654 * work for SFTP. (Can be overridden with `-1' option.)
2655 * But if it says `2 only' or `2', respect which.
2657 if (cfg.sshprot != 2 && cfg.sshprot != 3)
2661 * Enact command-line overrides.
2663 cmdline_run_saved(&cfg);
2666 * Trim leading whitespace off the hostname if it's there.
2669 int space = strspn(cfg.host, " \t");
2670 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
2673 /* See if host is of the form user@host */
2674 if (cfg.host[0] != '\0') {
2675 char *atsign = strrchr(cfg.host, '@');
2676 /* Make sure we're not overflowing the user field */
2678 if (atsign - cfg.host < sizeof cfg.username) {
2679 strncpy(cfg.username, cfg.host, atsign - cfg.host);
2680 cfg.username[atsign - cfg.host] = '\0';
2682 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
2687 * Trim a colon suffix off the hostname if it's there.
2689 cfg.host[strcspn(cfg.host, ":")] = '\0';
2692 * Remove any remaining whitespace from the hostname.
2696 while (cfg.host[p2] != '\0') {
2697 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
2698 cfg.host[p1] = cfg.host[p2];
2703 cfg.host[p1] = '\0';
2707 if (user != NULL && user[0] != '\0') {
2708 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
2709 cfg.username[sizeof(cfg.username) - 1] = '\0';
2711 if (!cfg.username[0]) {
2712 if (!console_get_line("login as: ",
2713 cfg.username, sizeof(cfg.username), FALSE)) {
2714 fprintf(stderr, "psftp: no username, aborting\n");
2717 int len = strlen(cfg.username);
2718 if (cfg.username[len - 1] == '\n')
2719 cfg.username[len - 1] = '\0';
2724 cfg.port = portnumber;
2727 * Disable scary things which shouldn't be enabled for simple
2728 * things like SCP and SFTP: agent forwarding, port forwarding,
2731 cfg.x11_forward = 0;
2733 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
2735 /* Set up subsystem name. */
2736 strcpy(cfg.remote_cmd, "sftp");
2737 cfg.ssh_subsys = TRUE;
2741 * Set up fallback option, for SSH1 servers or servers with the
2742 * sftp subsystem not enabled but the server binary installed
2743 * in the usual place. We only support fallback on Unix
2744 * systems, and we use a kludgy piece of shellery which should
2745 * try to find sftp-server in various places (the obvious
2746 * systemwide spots /usr/lib and /usr/local/lib, and then the
2747 * user's PATH) and finally give up.
2749 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2750 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2753 * the idea being that this will attempt to use either of the
2754 * obvious pathnames and then give up, and when it does give up
2755 * it will print the preferred pathname in the error messages.
2757 cfg.remote_cmd_ptr2 =
2758 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2759 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2761 cfg.ssh_subsys2 = FALSE;
2763 back = &ssh_backend;
2765 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,
2766 0, cfg.tcp_keepalives);
2768 fprintf(stderr, "ssh_init: %s\n", err);
2771 logctx = log_init(NULL, &cfg);
2772 back->provide_logctx(backhandle, logctx);
2773 console_provide_logctx(logctx);
2774 while (!back->sendok(backhandle)) {
2775 if (ssh_sftp_loop_iteration() < 0) {
2776 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2780 if (verbose && realhost != NULL)
2781 printf("Connected to %s\n", realhost);
2782 if (realhost != NULL)
2787 void cmdline_error(char *p, ...)
2790 fprintf(stderr, "psftp: ");
2792 vfprintf(stderr, p, ap);
2794 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2799 * Main program. Parse arguments etc.
2801 int psftp_main(int argc, char *argv[])
2805 char *userhost, *user;
2808 char *batchfile = NULL;
2811 flags = FLAG_STDERR | FLAG_INTERACTIVE
2812 #ifdef FLAG_SYNCAGENT
2816 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2817 ssh_get_line = &console_get_line;
2820 userhost = user = NULL;
2822 /* Load Default Settings before doing anything else. */
2823 do_defaults(NULL, &cfg);
2824 loaded_session = FALSE;
2827 for (i = 1; i < argc; i++) {
2829 if (argv[i][0] != '-') {
2833 userhost = dupstr(argv[i]);
2836 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2838 cmdline_error("option \"%s\" requires an argument", argv[i]);
2839 } else if (ret == 2) {
2840 i++; /* skip next argument */
2841 } else if (ret == 1) {
2842 /* We have our own verbosity in addition to `flags'. */
2843 if (flags & FLAG_VERBOSE)
2845 } else if (strcmp(argv[i], "-h") == 0 ||
2846 strcmp(argv[i], "-?") == 0) {
2848 } else if (strcmp(argv[i], "-V") == 0) {
2850 } else if (strcmp(argv[i], "-batch") == 0) {
2851 console_batch_mode = 1;
2852 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2854 batchfile = argv[++i];
2855 } else if (strcmp(argv[i], "-bc") == 0) {
2856 modeflags = modeflags | 1;
2857 } else if (strcmp(argv[i], "-be") == 0) {
2858 modeflags = modeflags | 2;
2859 } else if (strcmp(argv[i], "--") == 0) {
2863 cmdline_error("unknown option \"%s\"", argv[i]);
2871 * If the loaded session provides a hostname, and a hostname has not
2872 * otherwise been specified, pop it in `userhost' so that
2873 * `psftp -load sessname' is sufficient to start a session.
2875 if (!userhost && cfg.host[0] != '\0') {
2876 userhost = dupstr(cfg.host);
2880 * If a user@host string has already been provided, connect to
2885 ret = psftp_connect(userhost, user, portnumber);
2892 printf("psftp: no hostname specified; use \"open host.name\""
2896 do_sftp(mode, modeflags, batchfile);
2898 if (back != NULL && back->socket(backhandle) != NULL) {
2900 back->special(backhandle, TS_EOF);
2901 sftp_recvdata(&ch, 1);
2906 console_provide_logctx(NULL);