2 * psftp.c: (platform-independent) front end for PSFTP.
11 #define PUTTY_DO_GLOBALS
20 * Since SFTP is a request-response oriented protocol, it requires
21 * no buffer management: when we send data, we stop and wait for an
22 * acknowledgement _anyway_, and so we can't possibly overfill our
26 static int psftp_connect(char *userhost, char *user, int portnumber);
27 static int do_sftp_init(void);
28 void do_sftp_cleanup();
30 /* ----------------------------------------------------------------------
36 static void *backhandle;
39 /* ----------------------------------------------------------------------
40 * Higher-level helper functions used in commands.
44 * Attempt to canonify a pathname starting from the pwd. If
45 * canonification fails, at least fall back to returning a _valid_
46 * pathname (though it may be ugly, eg /home/simon/../foobar).
48 char *canonify(char *name)
50 char *fullname, *canonname;
51 struct sftp_packet *pktin;
52 struct sftp_request *req, *rreq;
55 fullname = dupstr(name);
58 if (pwd[strlen(pwd) - 1] == '/')
62 fullname = dupcat(pwd, slash, name, NULL);
65 sftp_register(req = fxp_realpath_send(fullname));
66 rreq = sftp_find_request(pktin = sftp_recv());
68 canonname = fxp_realpath_recv(pktin, rreq);
75 * Attempt number 2. Some FXP_REALPATH implementations
76 * (glibc-based ones, in particular) require the _whole_
77 * path to point to something that exists, whereas others
78 * (BSD-based) only require all but the last component to
79 * exist. So if the first call failed, we should strip off
80 * everything from the last slash onwards and try again,
81 * then put the final component back on.
85 * - if the last component is "/." or "/..", then we don't
86 * bother trying this because there's no way it can work.
88 * - if the thing actually ends with a "/", we remove it
89 * before we start. Except if the string is "/" itself
90 * (although I can't see why we'd have got here if so,
91 * because surely "/" would have worked the first
92 * time?), in which case we don't bother.
94 * - if there's no slash in the string at all, give up in
95 * confusion (we expect at least one because of the way
96 * we constructed the string).
102 i = strlen(fullname);
103 if (i > 2 && fullname[i - 1] == '/')
104 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
105 while (i > 0 && fullname[--i] != '/');
108 * Give up on special cases.
110 if (fullname[i] != '/' || /* no slash at all */
111 !strcmp(fullname + i, "/.") || /* ends in /. */
112 !strcmp(fullname + i, "/..") || /* ends in /.. */
113 !strcmp(fullname, "/")) {
118 * Now i points at the slash. Deal with the final special
119 * case i==0 (ie the whole path was "/nonexistentfile").
121 fullname[i] = '\0'; /* separate the string */
123 sftp_register(req = fxp_realpath_send("/"));
125 sftp_register(req = fxp_realpath_send(fullname));
127 rreq = sftp_find_request(pktin = sftp_recv());
129 canonname = fxp_realpath_recv(pktin, rreq);
132 /* Even that failed. Restore our best guess at the
133 * constructed filename and give up */
134 fullname[i] = '/'; /* restore slash and last component */
139 * We have a canonical name for all but the last path
140 * component. Concatenate the last component and return.
142 returnname = dupcat(canonname,
143 canonname[strlen(canonname) - 1] ==
144 '/' ? "" : "/", fullname + i + 1, NULL);
152 * Return a pointer to the portion of str that comes after the last
153 * slash (or backslash or colon, if `local' is TRUE).
155 static char *stripslashes(char *str, int local)
160 p = strchr(str, ':');
164 p = strrchr(str, '/');
168 p = strrchr(str, '\\');
176 * qsort comparison routine for fxp_name structures. Sorts by real
179 static int sftp_name_compare(const void *av, const void *bv)
181 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
182 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
183 return strcmp((*a)->filename, (*b)->filename);
187 * Likewise, but for a bare char *.
189 static int bare_name_compare(const void *av, const void *bv)
191 const char **a = (const char **) av;
192 const char **b = (const char **) bv;
193 return strcmp(*a, *b);
196 static void not_connected(void)
198 printf("psftp: not connected to a host; use \"open host.name\"\n");
201 /* ----------------------------------------------------------------------
202 * The meat of the `get' and `put' commands.
204 int sftp_get_file(char *fname, char *outfname, int recurse, int restart)
206 struct fxp_handle *fh;
207 struct sftp_packet *pktin;
208 struct sftp_request *req, *rreq;
209 struct fxp_xfer *xfer;
212 int ret, shown_err = FALSE;
215 * In recursive mode, see if we're dealing with a directory.
216 * (If we're not in recursive mode, we need not even check: the
217 * subsequent FXP_OPEN will return a usable error message.)
220 struct fxp_attrs attrs;
223 sftp_register(req = fxp_stat_send(fname));
224 rreq = sftp_find_request(pktin = sftp_recv());
226 result = fxp_stat_recv(pktin, rreq, &attrs);
229 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
230 (attrs.permissions & 0040000)) {
232 struct fxp_handle *dirhandle;
233 int nnames, namesize;
234 struct fxp_name **ournames;
235 struct fxp_names *names;
239 * First, attempt to create the destination directory,
240 * unless it already exists.
242 if (file_type(outfname) != FILE_TYPE_DIRECTORY &&
243 !create_directory(outfname)) {
244 printf("%s: Cannot create directory\n", outfname);
249 * Now get the list of filenames in the remote
252 sftp_register(req = fxp_opendir_send(fname));
253 rreq = sftp_find_request(pktin = sftp_recv());
255 dirhandle = fxp_opendir_recv(pktin, rreq);
258 printf("%s: unable to open directory: %s\n",
262 nnames = namesize = 0;
267 sftp_register(req = fxp_readdir_send(dirhandle));
268 rreq = sftp_find_request(pktin = sftp_recv());
270 names = fxp_readdir_recv(pktin, rreq);
273 if (fxp_error_type() == SSH_FX_EOF)
275 printf("%s: reading directory: %s\n", fname, fxp_error());
279 if (names->nnames == 0) {
280 fxp_free_names(names);
283 if (nnames + names->nnames >= namesize) {
284 namesize += names->nnames + 128;
285 ournames = sresize(ournames, namesize, struct fxp_name *);
287 for (i = 0; i < names->nnames; i++)
288 if (strcmp(names->names[i].filename, ".") &&
289 strcmp(names->names[i].filename, "..")) {
290 if (!vet_filename(names->names[i].filename)) {
291 printf("ignoring potentially dangerous server-"
292 "supplied filename '%s'\n",
293 names->names[i].filename);
296 fxp_dup_name(&names->names[i]);
299 fxp_free_names(names);
301 sftp_register(req = fxp_close_send(dirhandle));
302 rreq = sftp_find_request(pktin = sftp_recv());
304 fxp_close_recv(pktin, rreq);
307 * Sort the names into a clear order. This ought to
308 * make things more predictable when we're doing a
309 * reget of the same directory, just in case two
310 * readdirs on the same remote directory return a
313 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
316 * If we're in restart mode, find the last filename on
317 * this list that already exists. We may have to do a
318 * reget on _that_ file, but shouldn't have to do
319 * anything on the previous files.
321 * If none of them exists, of course, we start at 0.
329 nextoutfname = dir_file_cat(outfname,
330 ournames[i]->filename);
332 nextoutfname = dupstr(ournames[i]->filename);
333 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
344 * Now we're ready to recurse. Starting at ournames[i]
345 * and continuing on to the end of the list, we
346 * construct a new source and target file name, and
347 * call sftp_get_file again.
349 for (; i < nnames; i++) {
350 char *nextfname, *nextoutfname;
353 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
355 nextoutfname = dir_file_cat(outfname,
356 ournames[i]->filename);
358 nextoutfname = dupstr(ournames[i]->filename);
359 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
360 restart = FALSE; /* after first partial file, do full */
364 for (i = 0; i < nnames; i++) {
365 fxp_free_name(ournames[i]);
373 * Done this recursion level. Free everything.
375 for (i = 0; i < nnames; i++) {
376 fxp_free_name(ournames[i]);
384 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
385 rreq = sftp_find_request(pktin = sftp_recv());
387 fh = fxp_open_recv(pktin, rreq);
390 printf("%s: open for read: %s\n", fname, fxp_error());
395 file = open_existing_wfile(outfname, NULL);
397 file = open_new_file(outfname);
401 printf("local: unable to open %s\n", outfname);
403 sftp_register(req = fxp_close_send(fh));
404 rreq = sftp_find_request(pktin = sftp_recv());
406 fxp_close_recv(pktin, rreq);
413 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
414 printf("reget: cannot restart %s - file too large\n",
416 sftp_register(req = fxp_close_send(fh));
417 rreq = sftp_find_request(pktin = sftp_recv());
419 fxp_close_recv(pktin, rreq);
424 offset = get_file_posn(file);
425 uint64_decimal(offset, decbuf);
426 printf("reget: restarting at file position %s\n", decbuf);
428 offset = uint64_make(0, 0);
431 printf("remote:%s => local:%s\n", fname, outfname);
434 * FIXME: we can use FXP_FSTAT here to get the file size, and
435 * thus put up a progress bar.
438 xfer = xfer_download_init(fh, offset);
439 while (!xfer_done(xfer)) {
444 xfer_download_queue(xfer);
446 ret = xfer_download_gotpkt(xfer, pktin);
450 printf("error while reading: %s\n", fxp_error());
456 while (xfer_download_data(xfer, &vbuf, &len)) {
457 unsigned char *buf = (unsigned char *)vbuf;
461 wlen = write_to_file(file, buf + wpos, len - wpos);
463 printf("error while writing local file\n");
465 xfer_set_error(xfer);
470 if (wpos < len) { /* we had an error */
472 xfer_set_error(xfer);
483 sftp_register(req = fxp_close_send(fh));
484 rreq = sftp_find_request(pktin = sftp_recv());
486 fxp_close_recv(pktin, rreq);
491 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
493 struct fxp_handle *fh;
494 struct fxp_xfer *xfer;
495 struct sftp_packet *pktin;
496 struct sftp_request *req, *rreq;
502 * In recursive mode, see if we're dealing with a directory.
503 * (If we're not in recursive mode, we need not even check: the
504 * subsequent fopen will return an error message.)
506 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
507 struct fxp_attrs attrs;
509 int nnames, namesize;
510 char *name, **ournames;
515 * First, attempt to create the destination directory,
516 * unless it already exists.
518 sftp_register(req = fxp_stat_send(outfname));
519 rreq = sftp_find_request(pktin = sftp_recv());
521 result = fxp_stat_recv(pktin, rreq, &attrs);
523 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
524 !(attrs.permissions & 0040000)) {
525 sftp_register(req = fxp_mkdir_send(outfname));
526 rreq = sftp_find_request(pktin = sftp_recv());
528 result = fxp_mkdir_recv(pktin, rreq);
531 printf("%s: create directory: %s\n",
532 outfname, fxp_error());
538 * Now get the list of filenames in the local directory.
540 nnames = namesize = 0;
543 dh = open_directory(fname);
545 printf("%s: unable to open directory\n", fname);
548 while ((name = read_filename(dh)) != NULL) {
549 if (nnames >= namesize) {
551 ournames = sresize(ournames, namesize, char *);
553 ournames[nnames++] = name;
558 * Sort the names into a clear order. This ought to make
559 * things more predictable when we're doing a reput of the
560 * same directory, just in case two readdirs on the same
561 * local directory return a different order.
563 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
566 * If we're in restart mode, find the last filename on this
567 * list that already exists. We may have to do a reput on
568 * _that_ file, but shouldn't have to do anything on the
571 * If none of them exists, of course, we start at 0.
577 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
578 sftp_register(req = fxp_stat_send(nextoutfname));
579 rreq = sftp_find_request(pktin = sftp_recv());
581 result = fxp_stat_recv(pktin, rreq, &attrs);
592 * Now we're ready to recurse. Starting at ournames[i]
593 * and continuing on to the end of the list, we
594 * construct a new source and target file name, and
595 * call sftp_put_file again.
597 for (; i < nnames; i++) {
598 char *nextfname, *nextoutfname;
602 nextfname = dir_file_cat(fname, ournames[i]);
604 nextfname = dupstr(ournames[i]);
605 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
606 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
607 restart = FALSE; /* after first partial file, do full */
611 for (i = 0; i < nnames; i++) {
620 * Done this recursion level. Free everything.
622 for (i = 0; i < nnames; i++) {
630 file = open_existing_file(fname, NULL, NULL, NULL);
632 printf("local: unable to open %s\n", fname);
636 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
638 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
639 SSH_FXF_CREAT | SSH_FXF_TRUNC));
641 rreq = sftp_find_request(pktin = sftp_recv());
643 fh = fxp_open_recv(pktin, rreq);
646 printf("%s: open for write: %s\n", outfname, fxp_error());
652 struct fxp_attrs attrs;
655 sftp_register(req = fxp_fstat_send(fh));
656 rreq = sftp_find_request(pktin = sftp_recv());
658 ret = fxp_fstat_recv(pktin, rreq, &attrs);
661 printf("read size of %s: %s\n", outfname, fxp_error());
664 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
665 printf("read size of %s: size was not given\n", outfname);
669 uint64_decimal(offset, decbuf);
670 printf("reput: restarting at file position %s\n", decbuf);
672 if (seek_file((WFile *)file, offset, FROM_START) != 0)
673 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
675 offset = uint64_make(0, 0);
678 printf("local:%s => remote:%s\n", fname, outfname);
681 * FIXME: we can use FXP_FSTAT here to get the file size, and
682 * thus put up a progress bar.
685 xfer = xfer_upload_init(fh, offset);
687 while ((!err && !eof) || !xfer_done(xfer)) {
691 while (xfer_upload_ready(xfer) && !err && !eof) {
692 len = read_from_file(file, buffer, sizeof(buffer));
694 printf("error while reading local file\n");
696 } else if (len == 0) {
699 xfer_upload_data(xfer, buffer, len);
703 if (!xfer_done(xfer)) {
705 ret = xfer_upload_gotpkt(xfer, pktin);
707 printf("error while writing: %s\n", fxp_error());
715 sftp_register(req = fxp_close_send(fh));
716 rreq = sftp_find_request(pktin = sftp_recv());
718 fxp_close_recv(pktin, rreq);
725 /* ----------------------------------------------------------------------
726 * A remote wildcard matcher, providing a similar interface to the
727 * local one in psftp.h.
730 typedef struct SftpWildcardMatcher {
731 struct fxp_handle *dirh;
732 struct fxp_names *names;
734 char *wildcard, *prefix;
735 } SftpWildcardMatcher;
737 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
739 struct sftp_packet *pktin;
740 struct sftp_request *req, *rreq;
742 char *unwcdir, *tmpdir, *cdir;
744 SftpWildcardMatcher *swcm;
745 struct fxp_handle *dirh;
748 * We don't handle multi-level wildcards; so we expect to find
749 * a fully specified directory part, followed by a wildcard
752 wildcard = stripslashes(name, 0);
754 unwcdir = dupstr(name);
755 len = wildcard - name;
757 if (len > 0 && unwcdir[len-1] == '/')
758 unwcdir[len-1] = '\0';
759 tmpdir = snewn(1 + len, char);
760 check = wc_unescape(tmpdir, unwcdir);
764 printf("Multiple-level wildcards are not supported\n");
769 cdir = canonify(unwcdir);
771 sftp_register(req = fxp_opendir_send(cdir));
772 rreq = sftp_find_request(pktin = sftp_recv());
774 dirh = fxp_opendir_recv(pktin, rreq);
777 swcm = snew(SftpWildcardMatcher);
780 swcm->wildcard = dupstr(wildcard);
781 swcm->prefix = unwcdir;
783 printf("Unable to open %s: %s\n", cdir, fxp_error());
793 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
795 struct fxp_name *name;
796 struct sftp_packet *pktin;
797 struct sftp_request *req, *rreq;
800 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
801 fxp_free_names(swcm->names);
806 sftp_register(req = fxp_readdir_send(swcm->dirh));
807 rreq = sftp_find_request(pktin = sftp_recv());
809 swcm->names = fxp_readdir_recv(pktin, rreq);
812 if (fxp_error_type() != SSH_FX_EOF)
813 printf("%s: reading directory: %s\n", swcm->prefix,
821 assert(swcm->names && swcm->namepos < swcm->names->nnames);
823 name = &swcm->names->names[swcm->namepos++];
825 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
826 continue; /* expected bad filenames */
828 if (!vet_filename(name->filename)) {
829 printf("ignoring potentially dangerous server-"
830 "supplied filename '%s'\n", name->filename);
831 continue; /* unexpected bad filename */
834 if (!wc_match(swcm->wildcard, name->filename))
835 continue; /* doesn't match the wildcard */
838 * We have a working filename. Return it.
840 return dupprintf("%s%s%s", swcm->prefix,
842 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
848 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
850 struct sftp_packet *pktin;
851 struct sftp_request *req, *rreq;
853 sftp_register(req = fxp_close_send(swcm->dirh));
854 rreq = sftp_find_request(pktin = sftp_recv());
856 fxp_close_recv(pktin, rreq);
859 fxp_free_names(swcm->names);
862 sfree(swcm->wildcard);
868 * General function to match a potential wildcard in a filename
869 * argument and iterate over every matching file. Used in several
870 * PSFTP commands (rmdir, rm, chmod, mv).
872 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
874 char *unwcfname, *newname, *cname;
877 unwcfname = snewn(strlen(filename)+1, char);
878 is_wc = !wc_unescape(unwcfname, filename);
881 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
890 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
891 cname = canonify(newname);
893 printf("%s: canonify: %s\n", newname, fxp_error());
897 ret &= func(ctx, cname);
902 /* Politely warn the user that nothing matched. */
903 printf("%s: nothing matched\n", filename);
906 sftp_finish_wildcard_matching(swcm);
908 cname = canonify(unwcfname);
910 printf("%s: canonify: %s\n", filename, fxp_error());
913 ret = func(ctx, cname);
922 * Handy helper function.
924 int is_wildcard(char *name)
926 char *unwcfname = snewn(strlen(name)+1, char);
927 int is_wc = !wc_unescape(unwcfname, name);
932 /* ----------------------------------------------------------------------
933 * Actual sftp commands.
935 struct sftp_command {
937 int nwords, wordssize;
938 int (*obey) (struct sftp_command *); /* returns <0 to quit */
941 int sftp_cmd_null(struct sftp_command *cmd)
943 return 1; /* success */
946 int sftp_cmd_unknown(struct sftp_command *cmd)
948 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
949 return 0; /* failure */
952 int sftp_cmd_quit(struct sftp_command *cmd)
957 int sftp_cmd_close(struct sftp_command *cmd)
964 if (back != NULL && back->connected(backhandle)) {
966 back->special(backhandle, TS_EOF);
967 sftp_recvdata(&ch, 1);
975 * List a directory. If no arguments are given, list pwd; otherwise
976 * list the directory given in words[1].
978 int sftp_cmd_ls(struct sftp_command *cmd)
980 struct fxp_handle *dirh;
981 struct fxp_names *names;
982 struct fxp_name **ournames;
983 int nnames, namesize;
984 char *dir, *cdir, *unwcdir, *wildcard;
985 struct sftp_packet *pktin;
986 struct sftp_request *req, *rreq;
999 unwcdir = snewn(1 + strlen(dir), char);
1000 if (wc_unescape(unwcdir, dir)) {
1007 wildcard = stripslashes(dir, 0);
1008 unwcdir = dupstr(dir);
1009 len = wildcard - dir;
1010 unwcdir[len] = '\0';
1011 if (len > 0 && unwcdir[len-1] == '/')
1012 unwcdir[len-1] = '\0';
1013 tmpdir = snewn(1 + len, char);
1014 check = wc_unescape(tmpdir, unwcdir);
1017 printf("Multiple-level wildcards are not supported\n");
1024 cdir = canonify(dir);
1026 printf("%s: canonify: %s\n", dir, fxp_error());
1031 printf("Listing directory %s\n", cdir);
1033 sftp_register(req = fxp_opendir_send(cdir));
1034 rreq = sftp_find_request(pktin = sftp_recv());
1035 assert(rreq == req);
1036 dirh = fxp_opendir_recv(pktin, rreq);
1039 printf("Unable to open %s: %s\n", dir, fxp_error());
1041 nnames = namesize = 0;
1046 sftp_register(req = fxp_readdir_send(dirh));
1047 rreq = sftp_find_request(pktin = sftp_recv());
1048 assert(rreq == req);
1049 names = fxp_readdir_recv(pktin, rreq);
1051 if (names == NULL) {
1052 if (fxp_error_type() == SSH_FX_EOF)
1054 printf("Reading directory %s: %s\n", dir, fxp_error());
1057 if (names->nnames == 0) {
1058 fxp_free_names(names);
1062 if (nnames + names->nnames >= namesize) {
1063 namesize += names->nnames + 128;
1064 ournames = sresize(ournames, namesize, struct fxp_name *);
1067 for (i = 0; i < names->nnames; i++)
1068 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1069 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1071 fxp_free_names(names);
1073 sftp_register(req = fxp_close_send(dirh));
1074 rreq = sftp_find_request(pktin = sftp_recv());
1075 assert(rreq == req);
1076 fxp_close_recv(pktin, rreq);
1079 * Now we have our filenames. Sort them by actual file
1080 * name, and then output the longname parts.
1082 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1087 for (i = 0; i < nnames; i++) {
1088 printf("%s\n", ournames[i]->longname);
1089 fxp_free_name(ournames[i]);
1101 * Change directories. We do this by canonifying the new name, then
1102 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1104 int sftp_cmd_cd(struct sftp_command *cmd)
1106 struct fxp_handle *dirh;
1107 struct sftp_packet *pktin;
1108 struct sftp_request *req, *rreq;
1116 if (cmd->nwords < 2)
1117 dir = dupstr(homedir);
1119 dir = canonify(cmd->words[1]);
1122 printf("%s: canonify: %s\n", dir, fxp_error());
1126 sftp_register(req = fxp_opendir_send(dir));
1127 rreq = sftp_find_request(pktin = sftp_recv());
1128 assert(rreq == req);
1129 dirh = fxp_opendir_recv(pktin, rreq);
1132 printf("Directory %s: %s\n", dir, fxp_error());
1137 sftp_register(req = fxp_close_send(dirh));
1138 rreq = sftp_find_request(pktin = sftp_recv());
1139 assert(rreq == req);
1140 fxp_close_recv(pktin, rreq);
1144 printf("Remote directory is now %s\n", pwd);
1150 * Print current directory. Easy as pie.
1152 int sftp_cmd_pwd(struct sftp_command *cmd)
1159 printf("Remote directory is %s\n", pwd);
1164 * Get a file and save it at the local end. We have three very
1165 * similar commands here. The basic one is `get'; `reget' differs
1166 * in that it checks for the existence of the destination file and
1167 * starts from where a previous aborted transfer left off; `mget'
1168 * differs in that it interprets all its arguments as files to
1169 * transfer (never as a different local name for a remote file) and
1170 * can handle wildcards.
1172 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1174 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1176 int recurse = FALSE;
1184 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1185 if (!strcmp(cmd->words[i], "--")) {
1186 /* finish processing options */
1189 } else if (!strcmp(cmd->words[i], "-r")) {
1192 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1198 if (i >= cmd->nwords) {
1199 printf("%s: expects a filename\n", cmd->words[0]);
1205 SftpWildcardMatcher *swcm;
1207 origfname = cmd->words[i++];
1208 unwcfname = snewn(strlen(origfname)+1, char);
1210 if (multiple && !wc_unescape(unwcfname, origfname)) {
1211 swcm = sftp_begin_wildcard_matching(origfname);
1216 origwfname = sftp_wildcard_get_filename(swcm);
1218 /* Politely warn the user that nothing matched. */
1219 printf("%s: nothing matched\n", origfname);
1220 sftp_finish_wildcard_matching(swcm);
1225 origwfname = origfname;
1229 while (origwfname) {
1230 fname = canonify(origwfname);
1233 printf("%s: canonify: %s\n", origwfname, fxp_error());
1238 if (!multiple && i < cmd->nwords)
1239 outfname = cmd->words[i++];
1241 outfname = stripslashes(origwfname, 0);
1243 ret = sftp_get_file(fname, outfname, recurse, restart);
1249 origwfname = sftp_wildcard_get_filename(swcm);
1256 sftp_finish_wildcard_matching(swcm);
1260 } while (multiple && i < cmd->nwords);
1264 int sftp_cmd_get(struct sftp_command *cmd)
1266 return sftp_general_get(cmd, 0, 0);
1268 int sftp_cmd_mget(struct sftp_command *cmd)
1270 return sftp_general_get(cmd, 0, 1);
1272 int sftp_cmd_reget(struct sftp_command *cmd)
1274 return sftp_general_get(cmd, 1, 0);
1278 * Send a file and store it at the remote end. We have three very
1279 * similar commands here. The basic one is `put'; `reput' differs
1280 * in that it checks for the existence of the destination file and
1281 * starts from where a previous aborted transfer left off; `mput'
1282 * differs in that it interprets all its arguments as files to
1283 * transfer (never as a different remote name for a local file) and
1284 * can handle wildcards.
1286 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1288 char *fname, *wfname, *origoutfname, *outfname;
1290 int recurse = FALSE;
1298 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1299 if (!strcmp(cmd->words[i], "--")) {
1300 /* finish processing options */
1303 } else if (!strcmp(cmd->words[i], "-r")) {
1306 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1312 if (i >= cmd->nwords) {
1313 printf("%s: expects a filename\n", cmd->words[0]);
1319 WildcardMatcher *wcm;
1320 fname = cmd->words[i++];
1322 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1323 wcm = begin_wildcard_matching(fname);
1324 wfname = wildcard_get_filename(wcm);
1326 /* Politely warn the user that nothing matched. */
1327 printf("%s: nothing matched\n", fname);
1328 finish_wildcard_matching(wcm);
1337 if (!multiple && i < cmd->nwords)
1338 origoutfname = cmd->words[i++];
1340 origoutfname = stripslashes(wfname, 1);
1342 outfname = canonify(origoutfname);
1344 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1347 finish_wildcard_matching(wcm);
1351 ret = sftp_put_file(wfname, outfname, recurse, restart);
1356 wfname = wildcard_get_filename(wcm);
1363 finish_wildcard_matching(wcm);
1368 } while (multiple && i < cmd->nwords);
1372 int sftp_cmd_put(struct sftp_command *cmd)
1374 return sftp_general_put(cmd, 0, 0);
1376 int sftp_cmd_mput(struct sftp_command *cmd)
1378 return sftp_general_put(cmd, 0, 1);
1380 int sftp_cmd_reput(struct sftp_command *cmd)
1382 return sftp_general_put(cmd, 1, 0);
1385 int sftp_cmd_mkdir(struct sftp_command *cmd)
1388 struct sftp_packet *pktin;
1389 struct sftp_request *req, *rreq;
1398 if (cmd->nwords < 2) {
1399 printf("mkdir: expects a directory\n");
1404 for (i = 1; i < cmd->nwords; i++) {
1405 dir = canonify(cmd->words[i]);
1407 printf("%s: canonify: %s\n", dir, fxp_error());
1411 sftp_register(req = fxp_mkdir_send(dir));
1412 rreq = sftp_find_request(pktin = sftp_recv());
1413 assert(rreq == req);
1414 result = fxp_mkdir_recv(pktin, rreq);
1417 printf("mkdir %s: %s\n", dir, fxp_error());
1420 printf("mkdir %s: OK\n", dir);
1428 static int sftp_action_rmdir(void *vctx, char *dir)
1430 struct sftp_packet *pktin;
1431 struct sftp_request *req, *rreq;
1434 sftp_register(req = fxp_rmdir_send(dir));
1435 rreq = sftp_find_request(pktin = sftp_recv());
1436 assert(rreq == req);
1437 result = fxp_rmdir_recv(pktin, rreq);
1440 printf("rmdir %s: %s\n", dir, fxp_error());
1444 printf("rmdir %s: OK\n", dir);
1449 int sftp_cmd_rmdir(struct sftp_command *cmd)
1458 if (cmd->nwords < 2) {
1459 printf("rmdir: expects a directory\n");
1464 for (i = 1; i < cmd->nwords; i++)
1465 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1470 static int sftp_action_rm(void *vctx, char *fname)
1472 struct sftp_packet *pktin;
1473 struct sftp_request *req, *rreq;
1476 sftp_register(req = fxp_remove_send(fname));
1477 rreq = sftp_find_request(pktin = sftp_recv());
1478 assert(rreq == req);
1479 result = fxp_remove_recv(pktin, rreq);
1482 printf("rm %s: %s\n", fname, fxp_error());
1486 printf("rm %s: OK\n", fname);
1491 int sftp_cmd_rm(struct sftp_command *cmd)
1500 if (cmd->nwords < 2) {
1501 printf("rm: expects a filename\n");
1506 for (i = 1; i < cmd->nwords; i++)
1507 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1512 static int check_is_dir(char *dstfname)
1514 struct sftp_packet *pktin;
1515 struct sftp_request *req, *rreq;
1516 struct fxp_attrs attrs;
1519 sftp_register(req = fxp_stat_send(dstfname));
1520 rreq = sftp_find_request(pktin = sftp_recv());
1521 assert(rreq == req);
1522 result = fxp_stat_recv(pktin, rreq, &attrs);
1525 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1526 (attrs.permissions & 0040000))
1532 struct sftp_context_mv {
1537 static int sftp_action_mv(void *vctx, char *srcfname)
1539 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1540 struct sftp_packet *pktin;
1541 struct sftp_request *req, *rreq;
1543 char *finalfname, *newcanon = NULL;
1546 if (ctx->dest_is_dir) {
1550 p = srcfname + strlen(srcfname);
1551 while (p > srcfname && p[-1] != '/') p--;
1552 newname = dupcat(ctx->dstfname, "/", p, NULL);
1553 newcanon = canonify(newname);
1555 printf("%s: canonify: %s\n", newname, fxp_error());
1561 finalfname = newcanon;
1563 finalfname = ctx->dstfname;
1566 sftp_register(req = fxp_rename_send(srcfname, finalfname));
1567 rreq = sftp_find_request(pktin = sftp_recv());
1568 assert(rreq == req);
1569 result = fxp_rename_recv(pktin, rreq);
1571 error = result ? NULL : fxp_error();
1574 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1577 printf("%s -> %s\n", srcfname, finalfname);
1585 int sftp_cmd_mv(struct sftp_command *cmd)
1587 struct sftp_context_mv actx, *ctx = &actx;
1595 if (cmd->nwords < 3) {
1596 printf("mv: expects two filenames\n");
1600 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1601 if (!ctx->dstfname) {
1602 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1607 * If there's more than one source argument, or one source
1608 * argument which is a wildcard, we _require_ that the
1609 * destination is a directory.
1611 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1612 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1613 printf("mv: multiple or wildcard arguments require the destination"
1614 " to be a directory\n");
1615 sfree(ctx->dstfname);
1620 * Now iterate over the source arguments.
1623 for (i = 1; i < cmd->nwords-1; i++)
1624 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1626 sfree(ctx->dstfname);
1630 struct sftp_context_chmod {
1631 unsigned attrs_clr, attrs_xor;
1634 static int sftp_action_chmod(void *vctx, char *fname)
1636 struct fxp_attrs attrs;
1637 struct sftp_packet *pktin;
1638 struct sftp_request *req, *rreq;
1640 unsigned oldperms, newperms;
1641 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1643 sftp_register(req = fxp_stat_send(fname));
1644 rreq = sftp_find_request(pktin = sftp_recv());
1645 assert(rreq == req);
1646 result = fxp_stat_recv(pktin, rreq, &attrs);
1648 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1649 printf("get attrs for %s: %s\n", fname,
1650 result ? "file permissions not provided" : fxp_error());
1654 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1655 oldperms = attrs.permissions & 07777;
1656 attrs.permissions &= ~ctx->attrs_clr;
1657 attrs.permissions ^= ctx->attrs_xor;
1658 newperms = attrs.permissions & 07777;
1660 if (oldperms == newperms)
1661 return 1; /* no need to do anything! */
1663 sftp_register(req = fxp_setstat_send(fname, attrs));
1664 rreq = sftp_find_request(pktin = sftp_recv());
1665 assert(rreq == req);
1666 result = fxp_setstat_recv(pktin, rreq);
1669 printf("set attrs for %s: %s\n", fname, fxp_error());
1673 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1678 int sftp_cmd_chmod(struct sftp_command *cmd)
1682 struct sftp_context_chmod actx, *ctx = &actx;
1689 if (cmd->nwords < 3) {
1690 printf("chmod: expects a mode specifier and a filename\n");
1695 * Attempt to parse the mode specifier in cmd->words[1]. We
1696 * don't support the full horror of Unix chmod; instead we
1697 * support a much simpler syntax in which the user can either
1698 * specify an octal number, or a comma-separated sequence of
1699 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1700 * _only_ be omitted if the only attribute mentioned is t,
1701 * since all others require a user/group/other specification.
1702 * Additionally, the s attribute may not be specified for any
1703 * [ugoa] specifications other than exactly u or exactly g.
1705 ctx->attrs_clr = ctx->attrs_xor = 0;
1706 mode = cmd->words[1];
1707 if (mode[0] >= '0' && mode[0] <= '9') {
1708 if (mode[strspn(mode, "01234567")]) {
1709 printf("chmod: numeric file modes should"
1710 " contain digits 0-7 only\n");
1713 ctx->attrs_clr = 07777;
1714 sscanf(mode, "%o", &ctx->attrs_xor);
1715 ctx->attrs_xor &= ctx->attrs_clr;
1718 char *modebegin = mode;
1719 unsigned subset, perms;
1723 while (*mode && *mode != ',' &&
1724 *mode != '+' && *mode != '-' && *mode != '=') {
1726 case 'u': subset |= 04700; break; /* setuid, user perms */
1727 case 'g': subset |= 02070; break; /* setgid, group perms */
1728 case 'o': subset |= 00007; break; /* just other perms */
1729 case 'a': subset |= 06777; break; /* all of the above */
1731 printf("chmod: file mode '%.*s' contains unrecognised"
1732 " user/group/other specifier '%c'\n",
1733 (int)strcspn(modebegin, ","), modebegin, *mode);
1738 if (!*mode || *mode == ',') {
1739 printf("chmod: file mode '%.*s' is incomplete\n",
1740 (int)strcspn(modebegin, ","), modebegin);
1744 if (!*mode || *mode == ',') {
1745 printf("chmod: file mode '%.*s' is incomplete\n",
1746 (int)strcspn(modebegin, ","), modebegin);
1750 while (*mode && *mode != ',') {
1752 case 'r': perms |= 00444; break;
1753 case 'w': perms |= 00222; break;
1754 case 'x': perms |= 00111; break;
1755 case 't': perms |= 01000; subset |= 01000; break;
1757 if ((subset & 06777) != 04700 &&
1758 (subset & 06777) != 02070) {
1759 printf("chmod: file mode '%.*s': set[ug]id bit should"
1760 " be used with exactly one of u or g only\n",
1761 (int)strcspn(modebegin, ","), modebegin);
1767 printf("chmod: file mode '%.*s' contains unrecognised"
1768 " permission specifier '%c'\n",
1769 (int)strcspn(modebegin, ","), modebegin, *mode);
1774 if (!(subset & 06777) && (perms &~ subset)) {
1775 printf("chmod: file mode '%.*s' contains no user/group/other"
1776 " specifier and permissions other than 't' \n",
1777 (int)strcspn(modebegin, ","), modebegin);
1783 ctx->attrs_clr |= perms;
1784 ctx->attrs_xor |= perms;
1787 ctx->attrs_clr |= perms;
1788 ctx->attrs_xor &= ~perms;
1791 ctx->attrs_clr |= subset;
1792 ctx->attrs_xor |= perms;
1795 if (*mode) mode++; /* eat comma */
1800 for (i = 2; i < cmd->nwords; i++)
1801 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1806 static int sftp_cmd_open(struct sftp_command *cmd)
1811 printf("psftp: already connected\n");
1815 if (cmd->nwords < 2) {
1816 printf("open: expects a host name\n");
1820 if (cmd->nwords > 2) {
1821 portnumber = atoi(cmd->words[2]);
1822 if (portnumber == 0) {
1823 printf("open: invalid port number\n");
1829 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1830 back = NULL; /* connection is already closed */
1831 return -1; /* this is fatal */
1837 static int sftp_cmd_lcd(struct sftp_command *cmd)
1839 char *currdir, *errmsg;
1841 if (cmd->nwords < 2) {
1842 printf("lcd: expects a local directory name\n");
1846 errmsg = psftp_lcd(cmd->words[1]);
1848 printf("lcd: unable to change directory: %s\n", errmsg);
1853 currdir = psftp_getcwd();
1854 printf("New local directory is %s\n", currdir);
1860 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1864 currdir = psftp_getcwd();
1865 printf("Current local directory is %s\n", currdir);
1871 static int sftp_cmd_pling(struct sftp_command *cmd)
1875 exitcode = system(cmd->words[1]);
1876 return (exitcode == 0);
1879 static int sftp_cmd_help(struct sftp_command *cmd);
1881 static struct sftp_cmd_lookup {
1884 * For help purposes, there are two kinds of command:
1886 * - primary commands, in which `longhelp' is non-NULL. In
1887 * this case `shorthelp' is descriptive text, and `longhelp'
1888 * is longer descriptive text intended to be printed after
1891 * - alias commands, in which `longhelp' is NULL. In this case
1892 * `shorthelp' is the name of a primary command, which
1893 * contains the help that should double up for this command.
1895 int listed; /* do we list this in primary help? */
1898 int (*obey) (struct sftp_command *);
1901 * List of sftp commands. This is binary-searched so it MUST be
1905 "!", TRUE, "run a local command",
1907 /* FIXME: this example is crap for non-Windows. */
1908 " Runs a local command. For example, \"!del myfile\".\n",
1912 "bye", TRUE, "finish your SFTP session",
1914 " Terminates your SFTP session and quits the PSFTP program.\n",
1918 "cd", TRUE, "change your remote working directory",
1919 " [ <new working directory> ]\n"
1920 " Change the remote working directory for your SFTP session.\n"
1921 " If a new working directory is not supplied, you will be\n"
1922 " returned to your home directory.\n",
1926 "chmod", TRUE, "change file permissions and modes",
1927 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1928 " Change the file permissions on one or more remote files or\n"
1930 " <modes> can be any octal Unix permission specifier.\n"
1931 " Alternatively, <modes> can include the following modifiers:\n"
1932 " u+r make file readable by owning user\n"
1933 " u+w make file writable by owning user\n"
1934 " u+x make file executable by owning user\n"
1935 " u-r make file not readable by owning user\n"
1936 " [also u-w, u-x]\n"
1937 " g+r make file readable by members of owning group\n"
1938 " [also g+w, g+x, g-r, g-w, g-x]\n"
1939 " o+r make file readable by all other users\n"
1940 " [also o+w, o+x, o-r, o-w, o-x]\n"
1941 " a+r make file readable by absolutely everybody\n"
1942 " [also a+w, a+x, a-r, a-w, a-x]\n"
1943 " u+s enable the Unix set-user-ID bit\n"
1944 " u-s disable the Unix set-user-ID bit\n"
1945 " g+s enable the Unix set-group-ID bit\n"
1946 " g-s disable the Unix set-group-ID bit\n"
1947 " +t enable the Unix \"sticky bit\"\n"
1948 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1949 " more than one user for the same modifier (\"ug+w\"). You can\n"
1950 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1954 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1956 " Terminates your SFTP session, but does not quit the PSFTP\n"
1957 " program. You can then use \"open\" to start another SFTP\n"
1958 " session, to the same server or to a different one.\n",
1962 "del", TRUE, "delete files on the remote server",
1963 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1964 " Delete a file or files from the server.\n",
1968 "delete", FALSE, "del", NULL, sftp_cmd_rm
1971 "dir", TRUE, "list remote files",
1972 " [ <directory-name> ]/[ <wildcard> ]\n"
1973 " List the contents of a specified directory on the server.\n"
1974 " If <directory-name> is not given, the current working directory\n"
1976 " If <wildcard> is given, it is treated as a set of files to\n"
1977 " list; otherwise, all files are listed.\n",
1981 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1984 "get", TRUE, "download a file from the server to your local machine",
1985 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1986 " Downloads a file on the server and stores it locally under\n"
1987 " the same name, or under a different one if you supply the\n"
1988 " argument <local-filename>.\n"
1989 " If -r specified, recursively fetch a directory.\n",
1993 "help", TRUE, "give help",
1994 " [ <command> [ <command> ... ] ]\n"
1995 " Give general help if no commands are specified.\n"
1996 " If one or more commands are specified, give specific help on\n"
1997 " those particular commands.\n",
2001 "lcd", TRUE, "change local working directory",
2002 " <local-directory-name>\n"
2003 " Change the local working directory of the PSFTP program (the\n"
2004 " default location where the \"get\" command will save files).\n",
2008 "lpwd", TRUE, "print local working directory",
2010 " Print the local working directory of the PSFTP program (the\n"
2011 " default location where the \"get\" command will save files).\n",
2015 "ls", TRUE, "dir", NULL,
2019 "mget", TRUE, "download multiple files at once",
2020 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2021 " Downloads many files from the server, storing each one under\n"
2022 " the same name it has on the server side. You can use wildcards\n"
2023 " such as \"*.c\" to specify lots of files at once.\n"
2024 " If -r specified, recursively fetch files and directories.\n",
2028 "mkdir", TRUE, "create directories on the remote server",
2029 " <directory-name> [ <directory-name>... ]\n"
2030 " Creates directories with the given names on the server.\n",
2034 "mput", TRUE, "upload multiple files at once",
2035 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2036 " Uploads many files to the server, storing each one under the\n"
2037 " same name it has on the client side. You can use wildcards\n"
2038 " such as \"*.c\" to specify lots of files at once.\n"
2039 " If -r specified, recursively store files and directories.\n",
2043 "mv", TRUE, "move or rename file(s) on the remote server",
2044 " <source> [ <source>... ] <destination>\n"
2045 " Moves or renames <source>(s) on the server to <destination>,\n"
2046 " also on the server.\n"
2047 " If <destination> specifies an existing directory, then <source>\n"
2048 " may be a wildcard, and multiple <source>s may be given; all\n"
2049 " source files are moved into <destination>.\n"
2050 " Otherwise, <source> must specify a single file, which is moved\n"
2051 " or renamed so that it is accessible under the name <destination>.\n",
2055 "open", TRUE, "connect to a host",
2056 " [<user>@]<hostname> [<port>]\n"
2057 " Establishes an SFTP connection to a given host. Only usable\n"
2058 " when you are not already connected to a server.\n",
2062 "put", TRUE, "upload a file from your local machine to the server",
2063 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2064 " Uploads a file to the server and stores it there under\n"
2065 " the same name, or under a different one if you supply the\n"
2066 " argument <remote-filename>.\n"
2067 " If -r specified, recursively store a directory.\n",
2071 "pwd", TRUE, "print your remote working directory",
2073 " Print the current remote working directory for your SFTP session.\n",
2077 "quit", TRUE, "bye", NULL,
2081 "reget", TRUE, "continue downloading files",
2082 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2083 " Works exactly like the \"get\" command, but the local file\n"
2084 " must already exist. The download will begin at the end of the\n"
2085 " file. This is for resuming a download that was interrupted.\n"
2086 " If -r specified, resume interrupted \"get -r\".\n",
2090 "ren", TRUE, "mv", NULL,
2094 "rename", FALSE, "mv", NULL,
2098 "reput", TRUE, "continue uploading files",
2099 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2100 " Works exactly like the \"put\" command, but the remote file\n"
2101 " must already exist. The upload will begin at the end of the\n"
2102 " file. This is for resuming an upload that was interrupted.\n"
2103 " If -r specified, resume interrupted \"put -r\".\n",
2107 "rm", TRUE, "del", NULL,
2111 "rmdir", TRUE, "remove directories on the remote server",
2112 " <directory-name> [ <directory-name>... ]\n"
2113 " Removes the directory with the given name on the server.\n"
2114 " The directory will not be removed unless it is empty.\n"
2115 " Wildcards may be used to specify multiple directories.\n",
2120 const struct sftp_cmd_lookup *lookup_command(char *name)
2125 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2128 cmp = strcmp(name, sftp_lookup[k].name);
2134 return &sftp_lookup[k];
2140 static int sftp_cmd_help(struct sftp_command *cmd)
2143 if (cmd->nwords == 1) {
2145 * Give short help on each command.
2149 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2151 if (!sftp_lookup[i].listed)
2153 len = strlen(sftp_lookup[i].name);
2157 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2158 const struct sftp_cmd_lookup *lookup;
2159 if (!sftp_lookup[i].listed)
2161 lookup = &sftp_lookup[i];
2162 printf("%-*s", maxlen+2, lookup->name);
2163 if (lookup->longhelp == NULL)
2164 lookup = lookup_command(lookup->shorthelp);
2165 printf("%s\n", lookup->shorthelp);
2169 * Give long help on specific commands.
2171 for (i = 1; i < cmd->nwords; i++) {
2172 const struct sftp_cmd_lookup *lookup;
2173 lookup = lookup_command(cmd->words[i]);
2175 printf("help: %s: command not found\n", cmd->words[i]);
2177 printf("%s", lookup->name);
2178 if (lookup->longhelp == NULL)
2179 lookup = lookup_command(lookup->shorthelp);
2180 printf("%s", lookup->longhelp);
2187 /* ----------------------------------------------------------------------
2188 * Command line reading and parsing.
2190 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2193 struct sftp_command *cmd;
2197 cmd = snew(struct sftp_command);
2207 line = fgetline(fp);
2209 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2212 if (!line || !*line) {
2213 cmd->obey = sftp_cmd_quit;
2214 if ((mode == 0) || (modeflags & 1))
2216 return cmd; /* eof */
2219 line[strcspn(line, "\r\n")] = '\0';
2221 if (modeflags & 1) {
2222 printf("%s\n", line);
2226 while (*p && (*p == ' ' || *p == '\t'))
2231 * Special case: the ! command. This is always parsed as
2232 * exactly two words: one containing the !, and the second
2233 * containing everything else on the line.
2235 cmd->nwords = cmd->wordssize = 2;
2236 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2237 cmd->words[0] = dupstr("!");
2238 cmd->words[1] = dupstr(p+1);
2242 * Parse the command line into words. The syntax is:
2243 * - double quotes are removed, but cause spaces within to be
2244 * treated as non-separating.
2245 * - a double-doublequote pair is a literal double quote, inside
2246 * _or_ outside quotes. Like this:
2248 * firstword "second word" "this has ""quotes"" in" and""this""
2254 * >this has "quotes" in<
2258 /* skip whitespace */
2259 while (*p && (*p == ' ' || *p == '\t'))
2261 /* mark start of word */
2262 q = r = p; /* q sits at start, r writes word */
2265 if (!quoting && (*p == ' ' || *p == '\t'))
2266 break; /* reached end of word */
2267 else if (*p == '"' && p[1] == '"')
2268 p += 2, *r++ = '"'; /* a literal quote */
2270 p++, quoting = !quoting;
2275 p++; /* skip over the whitespace */
2277 if (cmd->nwords >= cmd->wordssize) {
2278 cmd->wordssize = cmd->nwords + 16;
2279 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2281 cmd->words[cmd->nwords++] = dupstr(q);
2288 * Now parse the first word and assign a function.
2291 if (cmd->nwords == 0)
2292 cmd->obey = sftp_cmd_null;
2294 const struct sftp_cmd_lookup *lookup;
2295 lookup = lookup_command(cmd->words[0]);
2297 cmd->obey = sftp_cmd_unknown;
2299 cmd->obey = lookup->obey;
2305 static int do_sftp_init(void)
2307 struct sftp_packet *pktin;
2308 struct sftp_request *req, *rreq;
2311 * Do protocol initialisation.
2315 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2316 return 1; /* failure */
2320 * Find out where our home directory is.
2322 sftp_register(req = fxp_realpath_send("."));
2323 rreq = sftp_find_request(pktin = sftp_recv());
2324 assert(rreq == req);
2325 homedir = fxp_realpath_recv(pktin, rreq);
2329 "Warning: failed to resolve home directory: %s\n",
2331 homedir = dupstr(".");
2333 printf("Remote working directory is %s\n", homedir);
2335 pwd = dupstr(homedir);
2339 void do_sftp_cleanup()
2343 back->special(backhandle, TS_EOF);
2344 sftp_recvdata(&ch, 1);
2345 back->free(backhandle);
2346 sftp_cleanup_request();
2360 void do_sftp(int mode, int modeflags, char *batchfile)
2370 /* ------------------------------------------------------------------
2371 * Now we're ready to do Real Stuff.
2374 struct sftp_command *cmd;
2375 cmd = sftp_getcmd(NULL, 0, 0);
2378 ret = cmd->obey(cmd);
2381 for(i = 0; i < cmd->nwords; i++)
2382 sfree(cmd->words[i]);
2390 fp = fopen(batchfile, "r");
2392 printf("Fatal: unable to open %s\n", batchfile);
2396 struct sftp_command *cmd;
2397 cmd = sftp_getcmd(fp, mode, modeflags);
2400 ret = cmd->obey(cmd);
2404 if (!(modeflags & 2))
2413 /* ----------------------------------------------------------------------
2414 * Dirty bits: integration with PuTTY.
2417 static int verbose = 0;
2420 * Print an error message and perform a fatal exit.
2422 void fatalbox(char *fmt, ...)
2427 str = dupvprintf(fmt, ap);
2428 str2 = dupcat("Fatal: ", str, "\n", NULL);
2431 fputs(str2, stderr);
2436 void modalfatalbox(char *fmt, ...)
2441 str = dupvprintf(fmt, ap);
2442 str2 = dupcat("Fatal: ", str, "\n", NULL);
2445 fputs(str2, stderr);
2450 void connection_fatal(void *frontend, char *fmt, ...)
2455 str = dupvprintf(fmt, ap);
2456 str2 = dupcat("Fatal: ", str, "\n", NULL);
2459 fputs(str2, stderr);
2465 void ldisc_send(void *handle, char *buf, int len, int interactive)
2468 * This is only here because of the calls to ldisc_send(NULL,
2469 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2470 * ldisc as an ldisc. So if we get called with any real data, I
2471 * want to know about it.
2477 * In psftp, all agent requests should be synchronous, so this is a
2478 * never-called stub.
2480 void agent_schedule_callback(void (*callback)(void *, void *, int),
2481 void *callback_ctx, void *data, int len)
2483 assert(!"We shouldn't be here");
2487 * Receive a block of data from the SSH link. Block until all data
2490 * To do this, we repeatedly call the SSH protocol module, with our
2491 * own trap in from_backend() to catch the data that comes back. We
2492 * do this until we have enough data.
2495 static unsigned char *outptr; /* where to put the data */
2496 static unsigned outlen; /* how much data required */
2497 static unsigned char *pending = NULL; /* any spare data */
2498 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2499 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2501 unsigned char *p = (unsigned char *) data;
2502 unsigned len = (unsigned) datalen;
2505 * stderr data is just spouted to local stderr and otherwise
2510 fwrite(data, 1, len, stderr);
2515 * If this is before the real session begins, just return.
2520 if ((outlen > 0) && (len > 0)) {
2521 unsigned used = outlen;
2524 memcpy(outptr, p, used);
2532 if (pendsize < pendlen + len) {
2533 pendsize = pendlen + len + 4096;
2534 pending = sresize(pending, pendsize, unsigned char);
2536 memcpy(pending + pendlen, p, len);
2542 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2545 * No "untrusted" output should get here (the way the code is
2546 * currently, it's all diverted by FLAG_STDERR).
2548 assert(!"Unexpected call to from_backend_untrusted()");
2549 return 0; /* not reached */
2551 int sftp_recvdata(char *buf, int len)
2553 outptr = (unsigned char *) buf;
2557 * See if the pending-input block contains some of what we
2561 unsigned pendused = pendlen;
2562 if (pendused > outlen)
2564 memcpy(outptr, pending, pendused);
2565 memmove(pending, pending + pendused, pendlen - pendused);
2568 pendlen -= pendused;
2578 while (outlen > 0) {
2579 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2580 return 0; /* doom */
2585 int sftp_senddata(char *buf, int len)
2587 back->send(backhandle, buf, len);
2592 * Short description of parameters.
2594 static void usage(void)
2596 printf("PuTTY Secure File Transfer (SFTP) client\n");
2597 printf("%s\n", ver);
2598 printf("Usage: psftp [options] [user@]host\n");
2599 printf("Options:\n");
2600 printf(" -V print version information and exit\n");
2601 printf(" -pgpfp print PGP key fingerprints and exit\n");
2602 printf(" -b file use specified batchfile\n");
2603 printf(" -bc output batchfile commands\n");
2604 printf(" -be don't stop batchfile processing if errors\n");
2605 printf(" -v show verbose messages\n");
2606 printf(" -load sessname Load settings from saved session\n");
2607 printf(" -l user connect with specified username\n");
2608 printf(" -P port connect to specified port\n");
2609 printf(" -pw passw login with specified password\n");
2610 printf(" -1 -2 force use of particular SSH protocol version\n");
2611 printf(" -4 -6 force use of IPv4 or IPv6\n");
2612 printf(" -C enable compression\n");
2613 printf(" -i key private key file for authentication\n");
2614 printf(" -noagent disable use of Pageant\n");
2615 printf(" -agent enable use of Pageant\n");
2616 printf(" -batch disable all interactive prompts\n");
2620 static void version(void)
2622 printf("psftp: %s\n", ver);
2627 * Connect to a host.
2629 static int psftp_connect(char *userhost, char *user, int portnumber)
2631 char *host, *realhost;
2635 /* Separate host and username */
2637 host = strrchr(host, '@');
2643 printf("psftp: multiple usernames specified; using \"%s\"\n",
2650 * If we haven't loaded session details already (e.g., from -load),
2651 * try looking for a session called "host".
2653 if (!loaded_session) {
2654 /* Try to load settings for `host' into a temporary config */
2656 cfg2.host[0] = '\0';
2657 do_defaults(host, &cfg2);
2658 if (cfg2.host[0] != '\0') {
2659 /* Settings present and include hostname */
2660 /* Re-load data into the real config. */
2661 do_defaults(host, &cfg);
2663 /* Session doesn't exist or mention a hostname. */
2664 /* Use `host' as a bare hostname. */
2665 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2666 cfg.host[sizeof(cfg.host) - 1] = '\0';
2669 /* Patch in hostname `host' to session details. */
2670 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2671 cfg.host[sizeof(cfg.host) - 1] = '\0';
2675 * Force use of SSH. (If they got the protocol wrong we assume the
2676 * port is useless too.)
2678 if (cfg.protocol != PROT_SSH) {
2679 cfg.protocol = PROT_SSH;
2684 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2685 * then change it to SSH-2, on the grounds that that's more likely to
2686 * work for SFTP. (Can be overridden with `-1' option.)
2687 * But if it says `2 only' or `2', respect which.
2689 if (cfg.sshprot != 2 && cfg.sshprot != 3)
2693 * Enact command-line overrides.
2695 cmdline_run_saved(&cfg);
2698 * Trim leading whitespace off the hostname if it's there.
2701 int space = strspn(cfg.host, " \t");
2702 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
2705 /* See if host is of the form user@host */
2706 if (cfg.host[0] != '\0') {
2707 char *atsign = strrchr(cfg.host, '@');
2708 /* Make sure we're not overflowing the user field */
2710 if (atsign - cfg.host < sizeof cfg.username) {
2711 strncpy(cfg.username, cfg.host, atsign - cfg.host);
2712 cfg.username[atsign - cfg.host] = '\0';
2714 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
2719 * Trim a colon suffix off the hostname if it's there.
2721 cfg.host[strcspn(cfg.host, ":")] = '\0';
2724 * Remove any remaining whitespace from the hostname.
2728 while (cfg.host[p2] != '\0') {
2729 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
2730 cfg.host[p1] = cfg.host[p2];
2735 cfg.host[p1] = '\0';
2739 if (user != NULL && user[0] != '\0') {
2740 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
2741 cfg.username[sizeof(cfg.username) - 1] = '\0';
2745 cfg.port = portnumber;
2748 * Disable scary things which shouldn't be enabled for simple
2749 * things like SCP and SFTP: agent forwarding, port forwarding,
2752 cfg.x11_forward = 0;
2754 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
2755 cfg.ssh_simple = TRUE;
2757 /* Set up subsystem name. */
2758 strcpy(cfg.remote_cmd, "sftp");
2759 cfg.ssh_subsys = TRUE;
2763 * Set up fallback option, for SSH-1 servers or servers with the
2764 * sftp subsystem not enabled but the server binary installed
2765 * in the usual place. We only support fallback on Unix
2766 * systems, and we use a kludgy piece of shellery which should
2767 * try to find sftp-server in various places (the obvious
2768 * systemwide spots /usr/lib and /usr/local/lib, and then the
2769 * user's PATH) and finally give up.
2771 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2772 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2775 * the idea being that this will attempt to use either of the
2776 * obvious pathnames and then give up, and when it does give up
2777 * it will print the preferred pathname in the error messages.
2779 cfg.remote_cmd_ptr2 =
2780 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2781 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2783 cfg.ssh_subsys2 = FALSE;
2785 back = &ssh_backend;
2787 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,
2788 0, cfg.tcp_keepalives);
2790 fprintf(stderr, "ssh_init: %s\n", err);
2793 logctx = log_init(NULL, &cfg);
2794 back->provide_logctx(backhandle, logctx);
2795 console_provide_logctx(logctx);
2796 while (!back->sendok(backhandle)) {
2797 if (ssh_sftp_loop_iteration() < 0) {
2798 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2802 if (verbose && realhost != NULL)
2803 printf("Connected to %s\n", realhost);
2804 if (realhost != NULL)
2809 void cmdline_error(char *p, ...)
2812 fprintf(stderr, "psftp: ");
2814 vfprintf(stderr, p, ap);
2816 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2821 * Main program. Parse arguments etc.
2823 int psftp_main(int argc, char *argv[])
2827 char *userhost, *user;
2830 char *batchfile = NULL;
2833 flags = FLAG_STDERR | FLAG_INTERACTIVE
2834 #ifdef FLAG_SYNCAGENT
2838 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2841 userhost = user = NULL;
2843 /* Load Default Settings before doing anything else. */
2844 do_defaults(NULL, &cfg);
2845 loaded_session = FALSE;
2848 for (i = 1; i < argc; i++) {
2850 if (argv[i][0] != '-') {
2854 userhost = dupstr(argv[i]);
2857 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2859 cmdline_error("option \"%s\" requires an argument", argv[i]);
2860 } else if (ret == 2) {
2861 i++; /* skip next argument */
2862 } else if (ret == 1) {
2863 /* We have our own verbosity in addition to `flags'. */
2864 if (flags & FLAG_VERBOSE)
2866 } else if (strcmp(argv[i], "-h") == 0 ||
2867 strcmp(argv[i], "-?") == 0) {
2869 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2872 } else if (strcmp(argv[i], "-V") == 0) {
2874 } else if (strcmp(argv[i], "-batch") == 0) {
2875 console_batch_mode = 1;
2876 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2878 batchfile = argv[++i];
2879 } else if (strcmp(argv[i], "-bc") == 0) {
2880 modeflags = modeflags | 1;
2881 } else if (strcmp(argv[i], "-be") == 0) {
2882 modeflags = modeflags | 2;
2883 } else if (strcmp(argv[i], "--") == 0) {
2887 cmdline_error("unknown option \"%s\"", argv[i]);
2895 * If the loaded session provides a hostname, and a hostname has not
2896 * otherwise been specified, pop it in `userhost' so that
2897 * `psftp -load sessname' is sufficient to start a session.
2899 if (!userhost && cfg.host[0] != '\0') {
2900 userhost = dupstr(cfg.host);
2904 * If a user@host string has already been provided, connect to
2909 ret = psftp_connect(userhost, user, portnumber);
2916 printf("psftp: no hostname specified; use \"open host.name\""
2920 do_sftp(mode, modeflags, batchfile);
2922 if (back != NULL && back->connected(backhandle)) {
2924 back->special(backhandle, TS_EOF);
2925 sftp_recvdata(&ch, 1);
2930 console_provide_logctx(NULL);