2 * psftp.c: (platform-independent) front end for PSFTP.
11 #define PUTTY_DO_GLOBALS
19 const char *const appname = "PSFTP";
22 * Since SFTP is a request-response oriented protocol, it requires
23 * no buffer management: when we send data, we stop and wait for an
24 * acknowledgement _anyway_, and so we can't possibly overfill our
28 static int psftp_connect(char *userhost, char *user, int portnumber);
29 static int do_sftp_init(void);
30 void do_sftp_cleanup();
32 /* ----------------------------------------------------------------------
38 static void *backhandle;
42 /* ----------------------------------------------------------------------
43 * Manage sending requests and waiting for replies.
45 struct sftp_packet *sftp_wait_for_reply(struct sftp_request *req)
47 struct sftp_packet *pktin;
48 struct sftp_request *rreq;
53 connection_fatal(NULL, "did not receive SFTP response packet "
55 rreq = sftp_find_request(pktin);
57 connection_fatal(NULL, "unable to understand SFTP response packet "
58 "from server: %s", fxp_error());
62 /* ----------------------------------------------------------------------
63 * Higher-level helper functions used in commands.
67 * Attempt to canonify a pathname starting from the pwd. If
68 * canonification fails, at least fall back to returning a _valid_
69 * pathname (though it may be ugly, eg /home/simon/../foobar).
71 char *canonify(char *name)
73 char *fullname, *canonname;
74 struct sftp_packet *pktin;
75 struct sftp_request *req;
78 fullname = dupstr(name);
81 if (pwd[strlen(pwd) - 1] == '/')
85 fullname = dupcat(pwd, slash, name, NULL);
88 req = fxp_realpath_send(fullname);
89 pktin = sftp_wait_for_reply(req);
90 canonname = fxp_realpath_recv(pktin, req);
97 * Attempt number 2. Some FXP_REALPATH implementations
98 * (glibc-based ones, in particular) require the _whole_
99 * path to point to something that exists, whereas others
100 * (BSD-based) only require all but the last component to
101 * exist. So if the first call failed, we should strip off
102 * everything from the last slash onwards and try again,
103 * then put the final component back on.
107 * - if the last component is "/." or "/..", then we don't
108 * bother trying this because there's no way it can work.
110 * - if the thing actually ends with a "/", we remove it
111 * before we start. Except if the string is "/" itself
112 * (although I can't see why we'd have got here if so,
113 * because surely "/" would have worked the first
114 * time?), in which case we don't bother.
116 * - if there's no slash in the string at all, give up in
117 * confusion (we expect at least one because of the way
118 * we constructed the string).
124 i = strlen(fullname);
125 if (i > 2 && fullname[i - 1] == '/')
126 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
127 while (i > 0 && fullname[--i] != '/');
130 * Give up on special cases.
132 if (fullname[i] != '/' || /* no slash at all */
133 !strcmp(fullname + i, "/.") || /* ends in /. */
134 !strcmp(fullname + i, "/..") || /* ends in /.. */
135 !strcmp(fullname, "/")) {
140 * Now i points at the slash. Deal with the final special
141 * case i==0 (ie the whole path was "/nonexistentfile").
143 fullname[i] = '\0'; /* separate the string */
145 req = fxp_realpath_send("/");
147 req = fxp_realpath_send(fullname);
149 pktin = sftp_wait_for_reply(req);
150 canonname = fxp_realpath_recv(pktin, req);
153 /* Even that failed. Restore our best guess at the
154 * constructed filename and give up */
155 fullname[i] = '/'; /* restore slash and last component */
160 * We have a canonical name for all but the last path
161 * component. Concatenate the last component and return.
163 returnname = dupcat(canonname,
164 canonname[strlen(canonname) - 1] ==
165 '/' ? "" : "/", fullname + i + 1, NULL);
173 * Return a pointer to the portion of str that comes after the last
174 * slash (or backslash or colon, if `local' is TRUE).
176 static char *stripslashes(char *str, int local)
181 p = strchr(str, ':');
185 p = strrchr(str, '/');
189 p = strrchr(str, '\\');
197 * qsort comparison routine for fxp_name structures. Sorts by real
200 static int sftp_name_compare(const void *av, const void *bv)
202 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
203 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
204 return strcmp((*a)->filename, (*b)->filename);
208 * Likewise, but for a bare char *.
210 static int bare_name_compare(const void *av, const void *bv)
212 const char **a = (const char **) av;
213 const char **b = (const char **) bv;
214 return strcmp(*a, *b);
217 static void not_connected(void)
219 printf("psftp: not connected to a host; use \"open host.name\"\n");
222 /* ----------------------------------------------------------------------
223 * The meat of the `get' and `put' commands.
225 int sftp_get_file(char *fname, char *outfname, int recurse, int restart)
227 struct fxp_handle *fh;
228 struct sftp_packet *pktin;
229 struct sftp_request *req;
230 struct fxp_xfer *xfer;
233 int ret, shown_err = FALSE;
234 struct fxp_attrs attrs;
237 * In recursive mode, see if we're dealing with a directory.
238 * (If we're not in recursive mode, we need not even check: the
239 * subsequent FXP_OPEN will return a usable error message.)
244 req = fxp_stat_send(fname);
245 pktin = sftp_wait_for_reply(req);
246 result = fxp_stat_recv(pktin, req, &attrs);
249 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
250 (attrs.permissions & 0040000)) {
252 struct fxp_handle *dirhandle;
253 int nnames, namesize;
254 struct fxp_name **ournames;
255 struct fxp_names *names;
259 * First, attempt to create the destination directory,
260 * unless it already exists.
262 if (file_type(outfname) != FILE_TYPE_DIRECTORY &&
263 !create_directory(outfname)) {
264 printf("%s: Cannot create directory\n", outfname);
269 * Now get the list of filenames in the remote
272 req = fxp_opendir_send(fname);
273 pktin = sftp_wait_for_reply(req);
274 dirhandle = fxp_opendir_recv(pktin, req);
277 printf("%s: unable to open directory: %s\n",
281 nnames = namesize = 0;
286 req = fxp_readdir_send(dirhandle);
287 pktin = sftp_wait_for_reply(req);
288 names = fxp_readdir_recv(pktin, req);
291 if (fxp_error_type() == SSH_FX_EOF)
293 printf("%s: reading directory: %s\n", fname, fxp_error());
297 if (names->nnames == 0) {
298 fxp_free_names(names);
301 if (nnames + names->nnames >= namesize) {
302 namesize += names->nnames + 128;
303 ournames = sresize(ournames, namesize, struct fxp_name *);
305 for (i = 0; i < names->nnames; i++)
306 if (strcmp(names->names[i].filename, ".") &&
307 strcmp(names->names[i].filename, "..")) {
308 if (!vet_filename(names->names[i].filename)) {
309 printf("ignoring potentially dangerous server-"
310 "supplied filename '%s'\n",
311 names->names[i].filename);
314 fxp_dup_name(&names->names[i]);
317 fxp_free_names(names);
319 req = fxp_close_send(dirhandle);
320 pktin = sftp_wait_for_reply(req);
321 fxp_close_recv(pktin, req);
324 * Sort the names into a clear order. This ought to
325 * make things more predictable when we're doing a
326 * reget of the same directory, just in case two
327 * readdirs on the same remote directory return a
330 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
333 * If we're in restart mode, find the last filename on
334 * this list that already exists. We may have to do a
335 * reget on _that_ file, but shouldn't have to do
336 * anything on the previous files.
338 * If none of them exists, of course, we start at 0.
345 nextoutfname = dir_file_cat(outfname,
346 ournames[i]->filename);
347 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
358 * Now we're ready to recurse. Starting at ournames[i]
359 * and continuing on to the end of the list, we
360 * construct a new source and target file name, and
361 * call sftp_get_file again.
363 for (; i < nnames; i++) {
364 char *nextfname, *nextoutfname;
367 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
368 nextoutfname = dir_file_cat(outfname, ournames[i]->filename);
369 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
370 restart = FALSE; /* after first partial file, do full */
374 for (i = 0; i < nnames; i++) {
375 fxp_free_name(ournames[i]);
383 * Done this recursion level. Free everything.
385 for (i = 0; i < nnames; i++) {
386 fxp_free_name(ournames[i]);
394 req = fxp_stat_send(fname);
395 pktin = sftp_wait_for_reply(req);
396 if (!fxp_stat_recv(pktin, req, &attrs))
399 req = fxp_open_send(fname, SSH_FXF_READ, NULL);
400 pktin = sftp_wait_for_reply(req);
401 fh = fxp_open_recv(pktin, req);
404 printf("%s: open for read: %s\n", fname, fxp_error());
409 file = open_existing_wfile(outfname, NULL);
411 file = open_new_file(outfname, GET_PERMISSIONS(attrs));
415 printf("local: unable to open %s\n", outfname);
417 req = fxp_close_send(fh);
418 pktin = sftp_wait_for_reply(req);
419 fxp_close_recv(pktin, req);
426 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
428 printf("reget: cannot restart %s - file too large\n",
430 req = fxp_close_send(fh);
431 pktin = sftp_wait_for_reply(req);
432 fxp_close_recv(pktin, req);
437 offset = get_file_posn(file);
438 uint64_decimal(offset, decbuf);
439 printf("reget: restarting at file position %s\n", decbuf);
441 offset = uint64_make(0, 0);
444 printf("remote:%s => local:%s\n", fname, outfname);
447 * FIXME: we can use FXP_FSTAT here to get the file size, and
448 * thus put up a progress bar.
451 xfer = xfer_download_init(fh, offset);
452 while (!xfer_done(xfer)) {
457 xfer_download_queue(xfer);
459 ret = xfer_download_gotpkt(xfer, pktin);
462 printf("error while reading: %s\n", fxp_error());
468 while (xfer_download_data(xfer, &vbuf, &len)) {
469 unsigned char *buf = (unsigned char *)vbuf;
473 wlen = write_to_file(file, buf + wpos, len - wpos);
475 printf("error while writing local file\n");
477 xfer_set_error(xfer);
482 if (wpos < len) { /* we had an error */
484 xfer_set_error(xfer);
495 req = fxp_close_send(fh);
496 pktin = sftp_wait_for_reply(req);
497 fxp_close_recv(pktin, req);
502 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
504 struct fxp_handle *fh;
505 struct fxp_xfer *xfer;
506 struct sftp_packet *pktin;
507 struct sftp_request *req;
511 struct fxp_attrs attrs;
515 * In recursive mode, see if we're dealing with a directory.
516 * (If we're not in recursive mode, we need not even check: the
517 * subsequent fopen will return an error message.)
519 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
521 int nnames, namesize;
522 char *name, **ournames;
527 * First, attempt to create the destination directory,
528 * unless it already exists.
530 req = fxp_stat_send(outfname);
531 pktin = sftp_wait_for_reply(req);
532 result = fxp_stat_recv(pktin, req, &attrs);
534 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
535 !(attrs.permissions & 0040000)) {
536 req = fxp_mkdir_send(outfname);
537 pktin = sftp_wait_for_reply(req);
538 result = fxp_mkdir_recv(pktin, req);
541 printf("%s: create directory: %s\n",
542 outfname, fxp_error());
548 * Now get the list of filenames in the local directory.
550 nnames = namesize = 0;
553 dh = open_directory(fname);
555 printf("%s: unable to open directory\n", fname);
558 while ((name = read_filename(dh)) != NULL) {
559 if (nnames >= namesize) {
561 ournames = sresize(ournames, namesize, char *);
563 ournames[nnames++] = name;
568 * Sort the names into a clear order. This ought to make
569 * things more predictable when we're doing a reput of the
570 * same directory, just in case two readdirs on the same
571 * local directory return a different order.
573 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
576 * If we're in restart mode, find the last filename on this
577 * list that already exists. We may have to do a reput on
578 * _that_ file, but shouldn't have to do anything on the
581 * If none of them exists, of course, we start at 0.
587 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
588 req = fxp_stat_send(nextoutfname);
589 pktin = sftp_wait_for_reply(req);
590 result = fxp_stat_recv(pktin, req, &attrs);
601 * Now we're ready to recurse. Starting at ournames[i]
602 * and continuing on to the end of the list, we
603 * construct a new source and target file name, and
604 * call sftp_put_file again.
606 for (; i < nnames; i++) {
607 char *nextfname, *nextoutfname;
610 nextfname = dir_file_cat(fname, ournames[i]);
611 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
612 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
613 restart = FALSE; /* after first partial file, do full */
617 for (i = 0; i < nnames; i++) {
626 * Done this recursion level. Free everything.
628 for (i = 0; i < nnames; i++) {
636 file = open_existing_file(fname, NULL, NULL, NULL, &permissions);
638 printf("local: unable to open %s\n", fname);
642 PUT_PERMISSIONS(attrs, permissions);
644 req = fxp_open_send(outfname, SSH_FXF_WRITE, &attrs);
646 req = fxp_open_send(outfname,
647 SSH_FXF_WRITE | SSH_FXF_CREAT | SSH_FXF_TRUNC,
650 pktin = sftp_wait_for_reply(req);
651 fh = fxp_open_recv(pktin, req);
655 printf("%s: open for write: %s\n", outfname, fxp_error());
661 struct fxp_attrs attrs;
664 req = fxp_fstat_send(fh);
665 pktin = sftp_wait_for_reply(req);
666 ret = fxp_fstat_recv(pktin, req, &attrs);
670 printf("read size of %s: %s\n", outfname, fxp_error());
673 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
675 printf("read size of %s: size was not given\n", outfname);
679 uint64_decimal(offset, decbuf);
680 printf("reput: restarting at file position %s\n", decbuf);
682 if (seek_file((WFile *)file, offset, FROM_START) != 0)
683 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
685 offset = uint64_make(0, 0);
688 printf("local:%s => remote:%s\n", fname, outfname);
691 * FIXME: we can use FXP_FSTAT here to get the file size, and
692 * thus put up a progress bar.
695 xfer = xfer_upload_init(fh, offset);
697 while ((!err && !eof) || !xfer_done(xfer)) {
701 while (xfer_upload_ready(xfer) && !err && !eof) {
702 len = read_from_file(file, buffer, sizeof(buffer));
704 printf("error while reading local file\n");
706 } else if (len == 0) {
709 xfer_upload_data(xfer, buffer, len);
713 if (!xfer_done(xfer)) {
715 ret = xfer_upload_gotpkt(xfer, pktin);
716 if (ret <= 0 && !err) {
717 printf("error while writing: %s\n", fxp_error());
725 req = fxp_close_send(fh);
726 pktin = sftp_wait_for_reply(req);
727 fxp_close_recv(pktin, req);
734 /* ----------------------------------------------------------------------
735 * A remote wildcard matcher, providing a similar interface to the
736 * local one in psftp.h.
739 typedef struct SftpWildcardMatcher {
740 struct fxp_handle *dirh;
741 struct fxp_names *names;
743 char *wildcard, *prefix;
744 } SftpWildcardMatcher;
746 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
748 struct sftp_packet *pktin;
749 struct sftp_request *req;
751 char *unwcdir, *tmpdir, *cdir;
753 SftpWildcardMatcher *swcm;
754 struct fxp_handle *dirh;
757 * We don't handle multi-level wildcards; so we expect to find
758 * a fully specified directory part, followed by a wildcard
761 wildcard = stripslashes(name, 0);
763 unwcdir = dupstr(name);
764 len = wildcard - name;
766 if (len > 0 && unwcdir[len-1] == '/')
767 unwcdir[len-1] = '\0';
768 tmpdir = snewn(1 + len, char);
769 check = wc_unescape(tmpdir, unwcdir);
773 printf("Multiple-level wildcards are not supported\n");
778 cdir = canonify(unwcdir);
780 req = fxp_opendir_send(cdir);
781 pktin = sftp_wait_for_reply(req);
782 dirh = fxp_opendir_recv(pktin, req);
785 swcm = snew(SftpWildcardMatcher);
788 swcm->wildcard = dupstr(wildcard);
789 swcm->prefix = unwcdir;
791 printf("Unable to open %s: %s\n", cdir, fxp_error());
801 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
803 struct fxp_name *name;
804 struct sftp_packet *pktin;
805 struct sftp_request *req;
808 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
809 fxp_free_names(swcm->names);
814 req = fxp_readdir_send(swcm->dirh);
815 pktin = sftp_wait_for_reply(req);
816 swcm->names = fxp_readdir_recv(pktin, req);
819 if (fxp_error_type() != SSH_FX_EOF)
820 printf("%s: reading directory: %s\n", swcm->prefix,
823 } else if (swcm->names->nnames == 0) {
825 * Another failure mode which we treat as EOF is if
826 * the server reports success from FXP_READDIR but
827 * returns no actual names. This is unusual, since
828 * from most servers you'd expect at least "." and
829 * "..", but there's nothing forbidding a server from
830 * omitting those if it wants to.
838 assert(swcm->names && swcm->namepos < swcm->names->nnames);
840 name = &swcm->names->names[swcm->namepos++];
842 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
843 continue; /* expected bad filenames */
845 if (!vet_filename(name->filename)) {
846 printf("ignoring potentially dangerous server-"
847 "supplied filename '%s'\n", name->filename);
848 continue; /* unexpected bad filename */
851 if (!wc_match(swcm->wildcard, name->filename))
852 continue; /* doesn't match the wildcard */
855 * We have a working filename. Return it.
857 return dupprintf("%s%s%s", swcm->prefix,
859 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
865 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
867 struct sftp_packet *pktin;
868 struct sftp_request *req;
870 req = fxp_close_send(swcm->dirh);
871 pktin = sftp_wait_for_reply(req);
872 fxp_close_recv(pktin, req);
875 fxp_free_names(swcm->names);
878 sfree(swcm->wildcard);
884 * General function to match a potential wildcard in a filename
885 * argument and iterate over every matching file. Used in several
886 * PSFTP commands (rmdir, rm, chmod, mv).
888 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
890 char *unwcfname, *newname, *cname;
893 unwcfname = snewn(strlen(filename)+1, char);
894 is_wc = !wc_unescape(unwcfname, filename);
897 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
906 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
907 cname = canonify(newname);
909 printf("%s: canonify: %s\n", newname, fxp_error());
913 ret &= func(ctx, cname);
918 /* Politely warn the user that nothing matched. */
919 printf("%s: nothing matched\n", filename);
922 sftp_finish_wildcard_matching(swcm);
924 cname = canonify(unwcfname);
926 printf("%s: canonify: %s\n", filename, fxp_error());
929 ret = func(ctx, cname);
938 * Handy helper function.
940 int is_wildcard(char *name)
942 char *unwcfname = snewn(strlen(name)+1, char);
943 int is_wc = !wc_unescape(unwcfname, name);
948 /* ----------------------------------------------------------------------
949 * Actual sftp commands.
951 struct sftp_command {
953 int nwords, wordssize;
954 int (*obey) (struct sftp_command *); /* returns <0 to quit */
957 int sftp_cmd_null(struct sftp_command *cmd)
959 return 1; /* success */
962 int sftp_cmd_unknown(struct sftp_command *cmd)
964 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
965 return 0; /* failure */
968 int sftp_cmd_quit(struct sftp_command *cmd)
973 int sftp_cmd_close(struct sftp_command *cmd)
980 if (back != NULL && back->connected(backhandle)) {
982 back->special(backhandle, TS_EOF);
984 sftp_recvdata(&ch, 1);
992 * List a directory. If no arguments are given, list pwd; otherwise
993 * list the directory given in words[1].
995 int sftp_cmd_ls(struct sftp_command *cmd)
997 struct fxp_handle *dirh;
998 struct fxp_names *names;
999 struct fxp_name **ournames;
1000 int nnames, namesize;
1001 char *dir, *cdir, *unwcdir, *wildcard;
1002 struct sftp_packet *pktin;
1003 struct sftp_request *req;
1011 if (cmd->nwords < 2)
1014 dir = cmd->words[1];
1016 unwcdir = snewn(1 + strlen(dir), char);
1017 if (wc_unescape(unwcdir, dir)) {
1024 wildcard = stripslashes(dir, 0);
1025 unwcdir = dupstr(dir);
1026 len = wildcard - dir;
1027 unwcdir[len] = '\0';
1028 if (len > 0 && unwcdir[len-1] == '/')
1029 unwcdir[len-1] = '\0';
1030 tmpdir = snewn(1 + len, char);
1031 check = wc_unescape(tmpdir, unwcdir);
1034 printf("Multiple-level wildcards are not supported\n");
1041 cdir = canonify(dir);
1043 printf("%s: canonify: %s\n", dir, fxp_error());
1048 printf("Listing directory %s\n", cdir);
1050 req = fxp_opendir_send(cdir);
1051 pktin = sftp_wait_for_reply(req);
1052 dirh = fxp_opendir_recv(pktin, req);
1055 printf("Unable to open %s: %s\n", dir, fxp_error());
1057 nnames = namesize = 0;
1062 req = fxp_readdir_send(dirh);
1063 pktin = sftp_wait_for_reply(req);
1064 names = fxp_readdir_recv(pktin, req);
1066 if (names == NULL) {
1067 if (fxp_error_type() == SSH_FX_EOF)
1069 printf("Reading directory %s: %s\n", dir, fxp_error());
1072 if (names->nnames == 0) {
1073 fxp_free_names(names);
1077 if (nnames + names->nnames >= namesize) {
1078 namesize += names->nnames + 128;
1079 ournames = sresize(ournames, namesize, struct fxp_name *);
1082 for (i = 0; i < names->nnames; i++)
1083 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1084 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1086 fxp_free_names(names);
1088 req = fxp_close_send(dirh);
1089 pktin = sftp_wait_for_reply(req);
1090 fxp_close_recv(pktin, req);
1093 * Now we have our filenames. Sort them by actual file
1094 * name, and then output the longname parts.
1096 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1101 for (i = 0; i < nnames; i++) {
1102 printf("%s\n", ournames[i]->longname);
1103 fxp_free_name(ournames[i]);
1115 * Change directories. We do this by canonifying the new name, then
1116 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1118 int sftp_cmd_cd(struct sftp_command *cmd)
1120 struct fxp_handle *dirh;
1121 struct sftp_packet *pktin;
1122 struct sftp_request *req;
1130 if (cmd->nwords < 2)
1131 dir = dupstr(homedir);
1133 dir = canonify(cmd->words[1]);
1136 printf("%s: canonify: %s\n", dir, fxp_error());
1140 req = fxp_opendir_send(dir);
1141 pktin = sftp_wait_for_reply(req);
1142 dirh = fxp_opendir_recv(pktin, req);
1145 printf("Directory %s: %s\n", dir, fxp_error());
1150 req = fxp_close_send(dirh);
1151 pktin = sftp_wait_for_reply(req);
1152 fxp_close_recv(pktin, req);
1156 printf("Remote directory is now %s\n", pwd);
1162 * Print current directory. Easy as pie.
1164 int sftp_cmd_pwd(struct sftp_command *cmd)
1171 printf("Remote directory is %s\n", pwd);
1176 * Get a file and save it at the local end. We have three very
1177 * similar commands here. The basic one is `get'; `reget' differs
1178 * in that it checks for the existence of the destination file and
1179 * starts from where a previous aborted transfer left off; `mget'
1180 * differs in that it interprets all its arguments as files to
1181 * transfer (never as a different local name for a remote file) and
1182 * can handle wildcards.
1184 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1186 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1188 int recurse = FALSE;
1196 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1197 if (!strcmp(cmd->words[i], "--")) {
1198 /* finish processing options */
1201 } else if (!strcmp(cmd->words[i], "-r")) {
1204 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1210 if (i >= cmd->nwords) {
1211 printf("%s: expects a filename\n", cmd->words[0]);
1217 SftpWildcardMatcher *swcm;
1219 origfname = cmd->words[i++];
1220 unwcfname = snewn(strlen(origfname)+1, char);
1222 if (multiple && !wc_unescape(unwcfname, origfname)) {
1223 swcm = sftp_begin_wildcard_matching(origfname);
1228 origwfname = sftp_wildcard_get_filename(swcm);
1230 /* Politely warn the user that nothing matched. */
1231 printf("%s: nothing matched\n", origfname);
1232 sftp_finish_wildcard_matching(swcm);
1237 origwfname = origfname;
1241 while (origwfname) {
1242 fname = canonify(origwfname);
1245 printf("%s: canonify: %s\n", origwfname, fxp_error());
1250 if (!multiple && i < cmd->nwords)
1251 outfname = cmd->words[i++];
1253 outfname = stripslashes(origwfname, 0);
1255 ret = sftp_get_file(fname, outfname, recurse, restart);
1261 origwfname = sftp_wildcard_get_filename(swcm);
1268 sftp_finish_wildcard_matching(swcm);
1272 } while (multiple && i < cmd->nwords);
1276 int sftp_cmd_get(struct sftp_command *cmd)
1278 return sftp_general_get(cmd, 0, 0);
1280 int sftp_cmd_mget(struct sftp_command *cmd)
1282 return sftp_general_get(cmd, 0, 1);
1284 int sftp_cmd_reget(struct sftp_command *cmd)
1286 return sftp_general_get(cmd, 1, 0);
1290 * Send a file and store it at the remote end. We have three very
1291 * similar commands here. The basic one is `put'; `reput' differs
1292 * in that it checks for the existence of the destination file and
1293 * starts from where a previous aborted transfer left off; `mput'
1294 * differs in that it interprets all its arguments as files to
1295 * transfer (never as a different remote name for a local file) and
1296 * can handle wildcards.
1298 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1300 char *fname, *wfname, *origoutfname, *outfname;
1302 int recurse = FALSE;
1310 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1311 if (!strcmp(cmd->words[i], "--")) {
1312 /* finish processing options */
1315 } else if (!strcmp(cmd->words[i], "-r")) {
1318 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1324 if (i >= cmd->nwords) {
1325 printf("%s: expects a filename\n", cmd->words[0]);
1331 WildcardMatcher *wcm;
1332 fname = cmd->words[i++];
1334 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1335 wcm = begin_wildcard_matching(fname);
1336 wfname = wildcard_get_filename(wcm);
1338 /* Politely warn the user that nothing matched. */
1339 printf("%s: nothing matched\n", fname);
1340 finish_wildcard_matching(wcm);
1349 if (!multiple && i < cmd->nwords)
1350 origoutfname = cmd->words[i++];
1352 origoutfname = stripslashes(wfname, 1);
1354 outfname = canonify(origoutfname);
1356 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1359 finish_wildcard_matching(wcm);
1363 ret = sftp_put_file(wfname, outfname, recurse, restart);
1368 wfname = wildcard_get_filename(wcm);
1375 finish_wildcard_matching(wcm);
1380 } while (multiple && i < cmd->nwords);
1384 int sftp_cmd_put(struct sftp_command *cmd)
1386 return sftp_general_put(cmd, 0, 0);
1388 int sftp_cmd_mput(struct sftp_command *cmd)
1390 return sftp_general_put(cmd, 0, 1);
1392 int sftp_cmd_reput(struct sftp_command *cmd)
1394 return sftp_general_put(cmd, 1, 0);
1397 int sftp_cmd_mkdir(struct sftp_command *cmd)
1400 struct sftp_packet *pktin;
1401 struct sftp_request *req;
1410 if (cmd->nwords < 2) {
1411 printf("mkdir: expects a directory\n");
1416 for (i = 1; i < cmd->nwords; i++) {
1417 dir = canonify(cmd->words[i]);
1419 printf("%s: canonify: %s\n", dir, fxp_error());
1423 req = fxp_mkdir_send(dir);
1424 pktin = sftp_wait_for_reply(req);
1425 result = fxp_mkdir_recv(pktin, req);
1428 printf("mkdir %s: %s\n", dir, fxp_error());
1431 printf("mkdir %s: OK\n", dir);
1439 static int sftp_action_rmdir(void *vctx, char *dir)
1441 struct sftp_packet *pktin;
1442 struct sftp_request *req;
1445 req = fxp_rmdir_send(dir);
1446 pktin = sftp_wait_for_reply(req);
1447 result = fxp_rmdir_recv(pktin, req);
1450 printf("rmdir %s: %s\n", dir, fxp_error());
1454 printf("rmdir %s: OK\n", dir);
1459 int sftp_cmd_rmdir(struct sftp_command *cmd)
1468 if (cmd->nwords < 2) {
1469 printf("rmdir: expects a directory\n");
1474 for (i = 1; i < cmd->nwords; i++)
1475 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1480 static int sftp_action_rm(void *vctx, char *fname)
1482 struct sftp_packet *pktin;
1483 struct sftp_request *req;
1486 req = fxp_remove_send(fname);
1487 pktin = sftp_wait_for_reply(req);
1488 result = fxp_remove_recv(pktin, req);
1491 printf("rm %s: %s\n", fname, fxp_error());
1495 printf("rm %s: OK\n", fname);
1500 int sftp_cmd_rm(struct sftp_command *cmd)
1509 if (cmd->nwords < 2) {
1510 printf("rm: expects a filename\n");
1515 for (i = 1; i < cmd->nwords; i++)
1516 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1521 static int check_is_dir(char *dstfname)
1523 struct sftp_packet *pktin;
1524 struct sftp_request *req;
1525 struct fxp_attrs attrs;
1528 req = fxp_stat_send(dstfname);
1529 pktin = sftp_wait_for_reply(req);
1530 result = fxp_stat_recv(pktin, req, &attrs);
1533 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1534 (attrs.permissions & 0040000))
1540 struct sftp_context_mv {
1545 static int sftp_action_mv(void *vctx, char *srcfname)
1547 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1548 struct sftp_packet *pktin;
1549 struct sftp_request *req;
1551 char *finalfname, *newcanon = NULL;
1554 if (ctx->dest_is_dir) {
1558 p = srcfname + strlen(srcfname);
1559 while (p > srcfname && p[-1] != '/') p--;
1560 newname = dupcat(ctx->dstfname, "/", p, NULL);
1561 newcanon = canonify(newname);
1563 printf("%s: canonify: %s\n", newname, fxp_error());
1569 finalfname = newcanon;
1571 finalfname = ctx->dstfname;
1574 req = fxp_rename_send(srcfname, finalfname);
1575 pktin = sftp_wait_for_reply(req);
1576 result = fxp_rename_recv(pktin, req);
1578 error = result ? NULL : fxp_error();
1581 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1584 printf("%s -> %s\n", srcfname, finalfname);
1592 int sftp_cmd_mv(struct sftp_command *cmd)
1594 struct sftp_context_mv actx, *ctx = &actx;
1602 if (cmd->nwords < 3) {
1603 printf("mv: expects two filenames\n");
1607 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1608 if (!ctx->dstfname) {
1609 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1614 * If there's more than one source argument, or one source
1615 * argument which is a wildcard, we _require_ that the
1616 * destination is a directory.
1618 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1619 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1620 printf("mv: multiple or wildcard arguments require the destination"
1621 " to be a directory\n");
1622 sfree(ctx->dstfname);
1627 * Now iterate over the source arguments.
1630 for (i = 1; i < cmd->nwords-1; i++)
1631 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1633 sfree(ctx->dstfname);
1637 struct sftp_context_chmod {
1638 unsigned attrs_clr, attrs_xor;
1641 static int sftp_action_chmod(void *vctx, char *fname)
1643 struct fxp_attrs attrs;
1644 struct sftp_packet *pktin;
1645 struct sftp_request *req;
1647 unsigned oldperms, newperms;
1648 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1650 req = fxp_stat_send(fname);
1651 pktin = sftp_wait_for_reply(req);
1652 result = fxp_stat_recv(pktin, req, &attrs);
1654 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1655 printf("get attrs for %s: %s\n", fname,
1656 result ? "file permissions not provided" : fxp_error());
1660 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1661 oldperms = attrs.permissions & 07777;
1662 attrs.permissions &= ~ctx->attrs_clr;
1663 attrs.permissions ^= ctx->attrs_xor;
1664 newperms = attrs.permissions & 07777;
1666 if (oldperms == newperms)
1667 return 1; /* no need to do anything! */
1669 req = fxp_setstat_send(fname, attrs);
1670 pktin = sftp_wait_for_reply(req);
1671 result = fxp_setstat_recv(pktin, req);
1674 printf("set attrs for %s: %s\n", fname, fxp_error());
1678 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1683 int sftp_cmd_chmod(struct sftp_command *cmd)
1687 struct sftp_context_chmod actx, *ctx = &actx;
1694 if (cmd->nwords < 3) {
1695 printf("chmod: expects a mode specifier and a filename\n");
1700 * Attempt to parse the mode specifier in cmd->words[1]. We
1701 * don't support the full horror of Unix chmod; instead we
1702 * support a much simpler syntax in which the user can either
1703 * specify an octal number, or a comma-separated sequence of
1704 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1705 * _only_ be omitted if the only attribute mentioned is t,
1706 * since all others require a user/group/other specification.
1707 * Additionally, the s attribute may not be specified for any
1708 * [ugoa] specifications other than exactly u or exactly g.
1710 ctx->attrs_clr = ctx->attrs_xor = 0;
1711 mode = cmd->words[1];
1712 if (mode[0] >= '0' && mode[0] <= '9') {
1713 if (mode[strspn(mode, "01234567")]) {
1714 printf("chmod: numeric file modes should"
1715 " contain digits 0-7 only\n");
1718 ctx->attrs_clr = 07777;
1719 sscanf(mode, "%o", &ctx->attrs_xor);
1720 ctx->attrs_xor &= ctx->attrs_clr;
1723 char *modebegin = mode;
1724 unsigned subset, perms;
1728 while (*mode && *mode != ',' &&
1729 *mode != '+' && *mode != '-' && *mode != '=') {
1731 case 'u': subset |= 04700; break; /* setuid, user perms */
1732 case 'g': subset |= 02070; break; /* setgid, group perms */
1733 case 'o': subset |= 00007; break; /* just other perms */
1734 case 'a': subset |= 06777; break; /* all of the above */
1736 printf("chmod: file mode '%.*s' contains unrecognised"
1737 " user/group/other specifier '%c'\n",
1738 (int)strcspn(modebegin, ","), modebegin, *mode);
1743 if (!*mode || *mode == ',') {
1744 printf("chmod: file mode '%.*s' is incomplete\n",
1745 (int)strcspn(modebegin, ","), modebegin);
1749 if (!*mode || *mode == ',') {
1750 printf("chmod: file mode '%.*s' is incomplete\n",
1751 (int)strcspn(modebegin, ","), modebegin);
1755 while (*mode && *mode != ',') {
1757 case 'r': perms |= 00444; break;
1758 case 'w': perms |= 00222; break;
1759 case 'x': perms |= 00111; break;
1760 case 't': perms |= 01000; subset |= 01000; break;
1762 if ((subset & 06777) != 04700 &&
1763 (subset & 06777) != 02070) {
1764 printf("chmod: file mode '%.*s': set[ug]id bit should"
1765 " be used with exactly one of u or g only\n",
1766 (int)strcspn(modebegin, ","), modebegin);
1772 printf("chmod: file mode '%.*s' contains unrecognised"
1773 " permission specifier '%c'\n",
1774 (int)strcspn(modebegin, ","), modebegin, *mode);
1779 if (!(subset & 06777) && (perms &~ subset)) {
1780 printf("chmod: file mode '%.*s' contains no user/group/other"
1781 " specifier and permissions other than 't' \n",
1782 (int)strcspn(modebegin, ","), modebegin);
1788 ctx->attrs_clr |= perms;
1789 ctx->attrs_xor |= perms;
1792 ctx->attrs_clr |= perms;
1793 ctx->attrs_xor &= ~perms;
1796 ctx->attrs_clr |= subset;
1797 ctx->attrs_xor |= perms;
1800 if (*mode) mode++; /* eat comma */
1805 for (i = 2; i < cmd->nwords; i++)
1806 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1811 static int sftp_cmd_open(struct sftp_command *cmd)
1816 printf("psftp: already connected\n");
1820 if (cmd->nwords < 2) {
1821 printf("open: expects a host name\n");
1825 if (cmd->nwords > 2) {
1826 portnumber = atoi(cmd->words[2]);
1827 if (portnumber == 0) {
1828 printf("open: invalid port number\n");
1834 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1835 back = NULL; /* connection is already closed */
1836 return -1; /* this is fatal */
1842 static int sftp_cmd_lcd(struct sftp_command *cmd)
1844 char *currdir, *errmsg;
1846 if (cmd->nwords < 2) {
1847 printf("lcd: expects a local directory name\n");
1851 errmsg = psftp_lcd(cmd->words[1]);
1853 printf("lcd: unable to change directory: %s\n", errmsg);
1858 currdir = psftp_getcwd();
1859 printf("New local directory is %s\n", currdir);
1865 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1869 currdir = psftp_getcwd();
1870 printf("Current local directory is %s\n", currdir);
1876 static int sftp_cmd_pling(struct sftp_command *cmd)
1880 exitcode = system(cmd->words[1]);
1881 return (exitcode == 0);
1884 static int sftp_cmd_help(struct sftp_command *cmd);
1886 static struct sftp_cmd_lookup {
1889 * For help purposes, there are two kinds of command:
1891 * - primary commands, in which `longhelp' is non-NULL. In
1892 * this case `shorthelp' is descriptive text, and `longhelp'
1893 * is longer descriptive text intended to be printed after
1896 * - alias commands, in which `longhelp' is NULL. In this case
1897 * `shorthelp' is the name of a primary command, which
1898 * contains the help that should double up for this command.
1900 int listed; /* do we list this in primary help? */
1903 int (*obey) (struct sftp_command *);
1906 * List of sftp commands. This is binary-searched so it MUST be
1910 "!", TRUE, "run a local command",
1912 /* FIXME: this example is crap for non-Windows. */
1913 " Runs a local command. For example, \"!del myfile\".\n",
1917 "bye", TRUE, "finish your SFTP session",
1919 " Terminates your SFTP session and quits the PSFTP program.\n",
1923 "cd", TRUE, "change your remote working directory",
1924 " [ <new working directory> ]\n"
1925 " Change the remote working directory for your SFTP session.\n"
1926 " If a new working directory is not supplied, you will be\n"
1927 " returned to your home directory.\n",
1931 "chmod", TRUE, "change file permissions and modes",
1932 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1933 " Change the file permissions on one or more remote files or\n"
1935 " <modes> can be any octal Unix permission specifier.\n"
1936 " Alternatively, <modes> can include the following modifiers:\n"
1937 " u+r make file readable by owning user\n"
1938 " u+w make file writable by owning user\n"
1939 " u+x make file executable by owning user\n"
1940 " u-r make file not readable by owning user\n"
1941 " [also u-w, u-x]\n"
1942 " g+r make file readable by members of owning group\n"
1943 " [also g+w, g+x, g-r, g-w, g-x]\n"
1944 " o+r make file readable by all other users\n"
1945 " [also o+w, o+x, o-r, o-w, o-x]\n"
1946 " a+r make file readable by absolutely everybody\n"
1947 " [also a+w, a+x, a-r, a-w, a-x]\n"
1948 " u+s enable the Unix set-user-ID bit\n"
1949 " u-s disable the Unix set-user-ID bit\n"
1950 " g+s enable the Unix set-group-ID bit\n"
1951 " g-s disable the Unix set-group-ID bit\n"
1952 " +t enable the Unix \"sticky bit\"\n"
1953 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1954 " more than one user for the same modifier (\"ug+w\"). You can\n"
1955 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1959 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1961 " Terminates your SFTP session, but does not quit the PSFTP\n"
1962 " program. You can then use \"open\" to start another SFTP\n"
1963 " session, to the same server or to a different one.\n",
1967 "del", TRUE, "delete files on the remote server",
1968 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1969 " Delete a file or files from the server.\n",
1973 "delete", FALSE, "del", NULL, sftp_cmd_rm
1976 "dir", TRUE, "list remote files",
1977 " [ <directory-name> ]/[ <wildcard> ]\n"
1978 " List the contents of a specified directory on the server.\n"
1979 " If <directory-name> is not given, the current working directory\n"
1981 " If <wildcard> is given, it is treated as a set of files to\n"
1982 " list; otherwise, all files are listed.\n",
1986 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1989 "get", TRUE, "download a file from the server to your local machine",
1990 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1991 " Downloads a file on the server and stores it locally under\n"
1992 " the same name, or under a different one if you supply the\n"
1993 " argument <local-filename>.\n"
1994 " If -r specified, recursively fetch a directory.\n",
1998 "help", TRUE, "give help",
1999 " [ <command> [ <command> ... ] ]\n"
2000 " Give general help if no commands are specified.\n"
2001 " If one or more commands are specified, give specific help on\n"
2002 " those particular commands.\n",
2006 "lcd", TRUE, "change local working directory",
2007 " <local-directory-name>\n"
2008 " Change the local working directory of the PSFTP program (the\n"
2009 " default location where the \"get\" command will save files).\n",
2013 "lpwd", TRUE, "print local working directory",
2015 " Print the local working directory of the PSFTP program (the\n"
2016 " default location where the \"get\" command will save files).\n",
2020 "ls", TRUE, "dir", NULL,
2024 "mget", TRUE, "download multiple files at once",
2025 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2026 " Downloads many files from the server, storing each one under\n"
2027 " the same name it has on the server side. You can use wildcards\n"
2028 " such as \"*.c\" to specify lots of files at once.\n"
2029 " If -r specified, recursively fetch files and directories.\n",
2033 "mkdir", TRUE, "create directories on the remote server",
2034 " <directory-name> [ <directory-name>... ]\n"
2035 " Creates directories with the given names on the server.\n",
2039 "mput", TRUE, "upload multiple files at once",
2040 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2041 " Uploads many files to the server, storing each one under the\n"
2042 " same name it has on the client side. You can use wildcards\n"
2043 " such as \"*.c\" to specify lots of files at once.\n"
2044 " If -r specified, recursively store files and directories.\n",
2048 "mv", TRUE, "move or rename file(s) on the remote server",
2049 " <source> [ <source>... ] <destination>\n"
2050 " Moves or renames <source>(s) on the server to <destination>,\n"
2051 " also on the server.\n"
2052 " If <destination> specifies an existing directory, then <source>\n"
2053 " may be a wildcard, and multiple <source>s may be given; all\n"
2054 " source files are moved into <destination>.\n"
2055 " Otherwise, <source> must specify a single file, which is moved\n"
2056 " or renamed so that it is accessible under the name <destination>.\n",
2060 "open", TRUE, "connect to a host",
2061 " [<user>@]<hostname> [<port>]\n"
2062 " Establishes an SFTP connection to a given host. Only usable\n"
2063 " when you are not already connected to a server.\n",
2067 "put", TRUE, "upload a file from your local machine to the server",
2068 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2069 " Uploads a file to the server and stores it there under\n"
2070 " the same name, or under a different one if you supply the\n"
2071 " argument <remote-filename>.\n"
2072 " If -r specified, recursively store a directory.\n",
2076 "pwd", TRUE, "print your remote working directory",
2078 " Print the current remote working directory for your SFTP session.\n",
2082 "quit", TRUE, "bye", NULL,
2086 "reget", TRUE, "continue downloading files",
2087 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2088 " Works exactly like the \"get\" command, but the local file\n"
2089 " must already exist. The download will begin at the end of the\n"
2090 " file. This is for resuming a download that was interrupted.\n"
2091 " If -r specified, resume interrupted \"get -r\".\n",
2095 "ren", TRUE, "mv", NULL,
2099 "rename", FALSE, "mv", NULL,
2103 "reput", TRUE, "continue uploading files",
2104 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2105 " Works exactly like the \"put\" command, but the remote file\n"
2106 " must already exist. The upload will begin at the end of the\n"
2107 " file. This is for resuming an upload that was interrupted.\n"
2108 " If -r specified, resume interrupted \"put -r\".\n",
2112 "rm", TRUE, "del", NULL,
2116 "rmdir", TRUE, "remove directories on the remote server",
2117 " <directory-name> [ <directory-name>... ]\n"
2118 " Removes the directory with the given name on the server.\n"
2119 " The directory will not be removed unless it is empty.\n"
2120 " Wildcards may be used to specify multiple directories.\n",
2125 const struct sftp_cmd_lookup *lookup_command(char *name)
2130 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2133 cmp = strcmp(name, sftp_lookup[k].name);
2139 return &sftp_lookup[k];
2145 static int sftp_cmd_help(struct sftp_command *cmd)
2148 if (cmd->nwords == 1) {
2150 * Give short help on each command.
2154 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2156 if (!sftp_lookup[i].listed)
2158 len = strlen(sftp_lookup[i].name);
2162 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2163 const struct sftp_cmd_lookup *lookup;
2164 if (!sftp_lookup[i].listed)
2166 lookup = &sftp_lookup[i];
2167 printf("%-*s", maxlen+2, lookup->name);
2168 if (lookup->longhelp == NULL)
2169 lookup = lookup_command(lookup->shorthelp);
2170 printf("%s\n", lookup->shorthelp);
2174 * Give long help on specific commands.
2176 for (i = 1; i < cmd->nwords; i++) {
2177 const struct sftp_cmd_lookup *lookup;
2178 lookup = lookup_command(cmd->words[i]);
2180 printf("help: %s: command not found\n", cmd->words[i]);
2182 printf("%s", lookup->name);
2183 if (lookup->longhelp == NULL)
2184 lookup = lookup_command(lookup->shorthelp);
2185 printf("%s", lookup->longhelp);
2192 /* ----------------------------------------------------------------------
2193 * Command line reading and parsing.
2195 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2198 struct sftp_command *cmd;
2202 cmd = snew(struct sftp_command);
2212 line = fgetline(fp);
2214 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2217 if (!line || !*line) {
2218 cmd->obey = sftp_cmd_quit;
2219 if ((mode == 0) || (modeflags & 1))
2221 return cmd; /* eof */
2224 line[strcspn(line, "\r\n")] = '\0';
2226 if (modeflags & 1) {
2227 printf("%s\n", line);
2231 while (*p && (*p == ' ' || *p == '\t'))
2236 * Special case: the ! command. This is always parsed as
2237 * exactly two words: one containing the !, and the second
2238 * containing everything else on the line.
2240 cmd->nwords = cmd->wordssize = 2;
2241 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2242 cmd->words[0] = dupstr("!");
2243 cmd->words[1] = dupstr(p+1);
2244 } else if (*p == '#') {
2246 * Special case: comment. Entire line is ignored.
2248 cmd->nwords = cmd->wordssize = 0;
2252 * Parse the command line into words. The syntax is:
2253 * - double quotes are removed, but cause spaces within to be
2254 * treated as non-separating.
2255 * - a double-doublequote pair is a literal double quote, inside
2256 * _or_ outside quotes. Like this:
2258 * firstword "second word" "this has ""quotes"" in" and""this""
2264 * >this has "quotes" in<
2268 /* skip whitespace */
2269 while (*p && (*p == ' ' || *p == '\t'))
2271 /* terminate loop */
2274 /* mark start of word */
2275 q = r = p; /* q sits at start, r writes word */
2278 if (!quoting && (*p == ' ' || *p == '\t'))
2279 break; /* reached end of word */
2280 else if (*p == '"' && p[1] == '"')
2281 p += 2, *r++ = '"'; /* a literal quote */
2283 p++, quoting = !quoting;
2288 p++; /* skip over the whitespace */
2290 if (cmd->nwords >= cmd->wordssize) {
2291 cmd->wordssize = cmd->nwords + 16;
2292 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2294 cmd->words[cmd->nwords++] = dupstr(q);
2301 * Now parse the first word and assign a function.
2304 if (cmd->nwords == 0)
2305 cmd->obey = sftp_cmd_null;
2307 const struct sftp_cmd_lookup *lookup;
2308 lookup = lookup_command(cmd->words[0]);
2310 cmd->obey = sftp_cmd_unknown;
2312 cmd->obey = lookup->obey;
2318 static int do_sftp_init(void)
2320 struct sftp_packet *pktin;
2321 struct sftp_request *req;
2324 * Do protocol initialisation.
2328 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2329 return 1; /* failure */
2333 * Find out where our home directory is.
2335 req = fxp_realpath_send(".");
2336 pktin = sftp_wait_for_reply(req);
2337 homedir = fxp_realpath_recv(pktin, req);
2341 "Warning: failed to resolve home directory: %s\n",
2343 homedir = dupstr(".");
2345 printf("Remote working directory is %s\n", homedir);
2347 pwd = dupstr(homedir);
2351 void do_sftp_cleanup()
2355 back->special(backhandle, TS_EOF);
2357 sftp_recvdata(&ch, 1);
2358 back->free(backhandle);
2359 sftp_cleanup_request();
2373 void do_sftp(int mode, int modeflags, char *batchfile)
2383 /* ------------------------------------------------------------------
2384 * Now we're ready to do Real Stuff.
2387 struct sftp_command *cmd;
2388 cmd = sftp_getcmd(NULL, 0, 0);
2391 ret = cmd->obey(cmd);
2394 for(i = 0; i < cmd->nwords; i++)
2395 sfree(cmd->words[i]);
2403 fp = fopen(batchfile, "r");
2405 printf("Fatal: unable to open %s\n", batchfile);
2409 struct sftp_command *cmd;
2410 cmd = sftp_getcmd(fp, mode, modeflags);
2413 ret = cmd->obey(cmd);
2417 if (!(modeflags & 2))
2426 /* ----------------------------------------------------------------------
2427 * Dirty bits: integration with PuTTY.
2430 static int verbose = 0;
2433 * Print an error message and perform a fatal exit.
2435 void fatalbox(char *fmt, ...)
2440 str = dupvprintf(fmt, ap);
2441 str2 = dupcat("Fatal: ", str, "\n", NULL);
2444 fputs(str2, stderr);
2449 void modalfatalbox(char *fmt, ...)
2454 str = dupvprintf(fmt, ap);
2455 str2 = dupcat("Fatal: ", str, "\n", NULL);
2458 fputs(str2, stderr);
2463 void connection_fatal(void *frontend, char *fmt, ...)
2468 str = dupvprintf(fmt, ap);
2469 str2 = dupcat("Fatal: ", str, "\n", NULL);
2472 fputs(str2, stderr);
2478 void ldisc_send(void *handle, char *buf, int len, int interactive)
2481 * This is only here because of the calls to ldisc_send(NULL,
2482 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2483 * ldisc as an ldisc. So if we get called with any real data, I
2484 * want to know about it.
2490 * In psftp, all agent requests should be synchronous, so this is a
2491 * never-called stub.
2493 void agent_schedule_callback(void (*callback)(void *, void *, int),
2494 void *callback_ctx, void *data, int len)
2496 assert(!"We shouldn't be here");
2500 * Receive a block of data from the SSH link. Block until all data
2503 * To do this, we repeatedly call the SSH protocol module, with our
2504 * own trap in from_backend() to catch the data that comes back. We
2505 * do this until we have enough data.
2508 static unsigned char *outptr; /* where to put the data */
2509 static unsigned outlen; /* how much data required */
2510 static unsigned char *pending = NULL; /* any spare data */
2511 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2512 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2514 unsigned char *p = (unsigned char *) data;
2515 unsigned len = (unsigned) datalen;
2518 * stderr data is just spouted to local stderr and otherwise
2523 if (fwrite(data, 1, len, stderr) < len)
2529 * If this is before the real session begins, just return.
2534 if ((outlen > 0) && (len > 0)) {
2535 unsigned used = outlen;
2538 memcpy(outptr, p, used);
2546 if (pendsize < pendlen + len) {
2547 pendsize = pendlen + len + 4096;
2548 pending = sresize(pending, pendsize, unsigned char);
2550 memcpy(pending + pendlen, p, len);
2556 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2559 * No "untrusted" output should get here (the way the code is
2560 * currently, it's all diverted by FLAG_STDERR).
2562 assert(!"Unexpected call to from_backend_untrusted()");
2563 return 0; /* not reached */
2565 int from_backend_eof(void *frontend)
2568 * We expect to be the party deciding when to close the
2569 * connection, so if we see EOF before we sent it ourselves, we
2573 connection_fatal(frontend,
2574 "Received unexpected end-of-file from SFTP server");
2578 int sftp_recvdata(char *buf, int len)
2580 outptr = (unsigned char *) buf;
2584 * See if the pending-input block contains some of what we
2588 unsigned pendused = pendlen;
2589 if (pendused > outlen)
2591 memcpy(outptr, pending, pendused);
2592 memmove(pending, pending + pendused, pendlen - pendused);
2595 pendlen -= pendused;
2605 while (outlen > 0) {
2606 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2607 return 0; /* doom */
2612 int sftp_senddata(char *buf, int len)
2614 back->send(backhandle, buf, len);
2619 * Short description of parameters.
2621 static void usage(void)
2623 printf("PuTTY Secure File Transfer (SFTP) client\n");
2624 printf("%s\n", ver);
2625 printf("Usage: psftp [options] [user@]host\n");
2626 printf("Options:\n");
2627 printf(" -V print version information and exit\n");
2628 printf(" -pgpfp print PGP key fingerprints and exit\n");
2629 printf(" -b file use specified batchfile\n");
2630 printf(" -bc output batchfile commands\n");
2631 printf(" -be don't stop batchfile processing if errors\n");
2632 printf(" -v show verbose messages\n");
2633 printf(" -load sessname Load settings from saved session\n");
2634 printf(" -l user connect with specified username\n");
2635 printf(" -P port connect to specified port\n");
2636 printf(" -pw passw login with specified password\n");
2637 printf(" -1 -2 force use of particular SSH protocol version\n");
2638 printf(" -4 -6 force use of IPv4 or IPv6\n");
2639 printf(" -C enable compression\n");
2640 printf(" -i key private key file for authentication\n");
2641 printf(" -noagent disable use of Pageant\n");
2642 printf(" -agent enable use of Pageant\n");
2643 printf(" -batch disable all interactive prompts\n");
2647 static void version(void)
2649 printf("psftp: %s\n", ver);
2654 * Connect to a host.
2656 static int psftp_connect(char *userhost, char *user, int portnumber)
2658 char *host, *realhost;
2662 /* Separate host and username */
2664 host = strrchr(host, '@');
2670 printf("psftp: multiple usernames specified; using \"%s\"\n",
2677 * If we haven't loaded session details already (e.g., from -load),
2678 * try looking for a session called "host".
2680 if (!loaded_session) {
2681 /* Try to load settings for `host' into a temporary config */
2682 Conf *conf2 = conf_new();
2683 conf_set_str(conf2, CONF_host, "");
2684 do_defaults(host, conf2);
2685 if (conf_get_str(conf2, CONF_host)[0] != '\0') {
2686 /* Settings present and include hostname */
2687 /* Re-load data into the real config. */
2688 do_defaults(host, conf);
2690 /* Session doesn't exist or mention a hostname. */
2691 /* Use `host' as a bare hostname. */
2692 conf_set_str(conf, CONF_host, host);
2695 /* Patch in hostname `host' to session details. */
2696 conf_set_str(conf, CONF_host, host);
2700 * Force use of SSH. (If they got the protocol wrong we assume the
2701 * port is useless too.)
2703 if (conf_get_int(conf, CONF_protocol) != PROT_SSH) {
2704 conf_set_int(conf, CONF_protocol, PROT_SSH);
2705 conf_set_int(conf, CONF_port, 22);
2709 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2710 * then change it to SSH-2, on the grounds that that's more likely to
2711 * work for SFTP. (Can be overridden with `-1' option.)
2712 * But if it says `2 only' or `2', respect which.
2714 if ((conf_get_int(conf, CONF_sshprot) & ~1) != 2) /* is it 2 or 3? */
2715 conf_set_int(conf, CONF_sshprot, 2);
2718 * Enact command-line overrides.
2720 cmdline_run_saved(conf);
2723 * Muck about with the hostname in various ways.
2726 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
2727 char *host = hostbuf;
2731 * Trim leading whitespace.
2733 host += strspn(host, " \t");
2736 * See if host is of the form user@host, and separate out
2737 * the username if so.
2739 if (host[0] != '\0') {
2740 char *atsign = strrchr(host, '@');
2743 conf_set_str(conf, CONF_username, host);
2749 * Remove any remaining whitespace.
2754 if (*q != ' ' && *q != '\t')
2760 conf_set_str(conf, CONF_host, hostbuf);
2765 if (user != NULL && user[0] != '\0') {
2766 conf_set_str(conf, CONF_username, user);
2770 conf_set_int(conf, CONF_port, portnumber);
2773 * Disable scary things which shouldn't be enabled for simple
2774 * things like SCP and SFTP: agent forwarding, port forwarding,
2777 conf_set_int(conf, CONF_x11_forward, 0);
2778 conf_set_int(conf, CONF_agentfwd, 0);
2779 conf_set_int(conf, CONF_ssh_simple, TRUE);
2782 while ((key = conf_get_str_nthstrkey(conf, CONF_portfwd, 0)) != NULL)
2783 conf_del_str_str(conf, CONF_portfwd, key);
2786 /* Set up subsystem name. */
2787 conf_set_str(conf, CONF_remote_cmd, "sftp");
2788 conf_set_int(conf, CONF_ssh_subsys, TRUE);
2789 conf_set_int(conf, CONF_nopty, TRUE);
2792 * Set up fallback option, for SSH-1 servers or servers with the
2793 * sftp subsystem not enabled but the server binary installed
2794 * in the usual place. We only support fallback on Unix
2795 * systems, and we use a kludgy piece of shellery which should
2796 * try to find sftp-server in various places (the obvious
2797 * systemwide spots /usr/lib and /usr/local/lib, and then the
2798 * user's PATH) and finally give up.
2800 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2801 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2804 * the idea being that this will attempt to use either of the
2805 * obvious pathnames and then give up, and when it does give up
2806 * it will print the preferred pathname in the error messages.
2808 conf_set_str(conf, CONF_remote_cmd2,
2809 "test -x /usr/lib/sftp-server &&"
2810 " exec /usr/lib/sftp-server\n"
2811 "test -x /usr/local/lib/sftp-server &&"
2812 " exec /usr/local/lib/sftp-server\n"
2813 "exec sftp-server");
2814 conf_set_int(conf, CONF_ssh_subsys2, FALSE);
2816 back = &ssh_backend;
2818 err = back->init(NULL, &backhandle, conf,
2819 conf_get_str(conf, CONF_host),
2820 conf_get_int(conf, CONF_port),
2822 conf_get_int(conf, CONF_tcp_keepalives));
2824 fprintf(stderr, "ssh_init: %s\n", err);
2827 logctx = log_init(NULL, conf);
2828 back->provide_logctx(backhandle, logctx);
2829 console_provide_logctx(logctx);
2830 while (!back->sendok(backhandle)) {
2831 if (back->exitcode(backhandle) >= 0)
2833 if (ssh_sftp_loop_iteration() < 0) {
2834 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2838 if (verbose && realhost != NULL)
2839 printf("Connected to %s\n", realhost);
2840 if (realhost != NULL)
2845 void cmdline_error(char *p, ...)
2848 fprintf(stderr, "psftp: ");
2850 vfprintf(stderr, p, ap);
2852 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2857 * Main program. Parse arguments etc.
2859 int psftp_main(int argc, char *argv[])
2863 char *userhost, *user;
2866 char *batchfile = NULL;
2868 flags = FLAG_STDERR | FLAG_INTERACTIVE
2869 #ifdef FLAG_SYNCAGENT
2873 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2876 userhost = user = NULL;
2878 /* Load Default Settings before doing anything else. */
2880 do_defaults(NULL, conf);
2881 loaded_session = FALSE;
2883 for (i = 1; i < argc; i++) {
2885 if (argv[i][0] != '-') {
2889 userhost = dupstr(argv[i]);
2892 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, conf);
2894 cmdline_error("option \"%s\" requires an argument", argv[i]);
2895 } else if (ret == 2) {
2896 i++; /* skip next argument */
2897 } else if (ret == 1) {
2898 /* We have our own verbosity in addition to `flags'. */
2899 if (flags & FLAG_VERBOSE)
2901 } else if (strcmp(argv[i], "-h") == 0 ||
2902 strcmp(argv[i], "-?") == 0 ||
2903 strcmp(argv[i], "--help") == 0) {
2905 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2908 } else if (strcmp(argv[i], "-V") == 0 ||
2909 strcmp(argv[i], "--version") == 0) {
2911 } else if (strcmp(argv[i], "-batch") == 0) {
2912 console_batch_mode = 1;
2913 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2915 batchfile = argv[++i];
2916 } else if (strcmp(argv[i], "-bc") == 0) {
2917 modeflags = modeflags | 1;
2918 } else if (strcmp(argv[i], "-be") == 0) {
2919 modeflags = modeflags | 2;
2920 } else if (strcmp(argv[i], "--") == 0) {
2924 cmdline_error("unknown option \"%s\"", argv[i]);
2932 * If the loaded session provides a hostname, and a hostname has not
2933 * otherwise been specified, pop it in `userhost' so that
2934 * `psftp -load sessname' is sufficient to start a session.
2936 if (!userhost && conf_get_str(conf, CONF_host)[0] != '\0') {
2937 userhost = dupstr(conf_get_str(conf, CONF_host));
2941 * If a user@host string has already been provided, connect to
2946 ret = psftp_connect(userhost, user, portnumber);
2953 printf("psftp: no hostname specified; use \"open host.name\""
2957 do_sftp(mode, modeflags, batchfile);
2959 if (back != NULL && back->connected(backhandle)) {
2961 back->special(backhandle, TS_EOF);
2963 sftp_recvdata(&ch, 1);
2968 console_provide_logctx(NULL);