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());
295 req = fxp_close_send(dirhandle);
296 pktin = sftp_wait_for_reply(req);
297 fxp_close_recv(pktin, req);
302 if (names->nnames == 0) {
303 fxp_free_names(names);
306 if (nnames + names->nnames >= namesize) {
307 namesize += names->nnames + 128;
308 ournames = sresize(ournames, namesize, struct fxp_name *);
310 for (i = 0; i < names->nnames; i++)
311 if (strcmp(names->names[i].filename, ".") &&
312 strcmp(names->names[i].filename, "..")) {
313 if (!vet_filename(names->names[i].filename)) {
314 printf("ignoring potentially dangerous server-"
315 "supplied filename '%s'\n",
316 names->names[i].filename);
319 fxp_dup_name(&names->names[i]);
322 fxp_free_names(names);
324 req = fxp_close_send(dirhandle);
325 pktin = sftp_wait_for_reply(req);
326 fxp_close_recv(pktin, req);
329 * Sort the names into a clear order. This ought to
330 * make things more predictable when we're doing a
331 * reget of the same directory, just in case two
332 * readdirs on the same remote directory return a
336 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
339 * If we're in restart mode, find the last filename on
340 * this list that already exists. We may have to do a
341 * reget on _that_ file, but shouldn't have to do
342 * anything on the previous files.
344 * If none of them exists, of course, we start at 0.
351 nextoutfname = dir_file_cat(outfname,
352 ournames[i]->filename);
353 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
364 * Now we're ready to recurse. Starting at ournames[i]
365 * and continuing on to the end of the list, we
366 * construct a new source and target file name, and
367 * call sftp_get_file again.
369 for (; i < nnames; i++) {
370 char *nextfname, *nextoutfname;
373 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
374 nextoutfname = dir_file_cat(outfname, ournames[i]->filename);
375 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
376 restart = FALSE; /* after first partial file, do full */
380 for (i = 0; i < nnames; i++) {
381 fxp_free_name(ournames[i]);
389 * Done this recursion level. Free everything.
391 for (i = 0; i < nnames; i++) {
392 fxp_free_name(ournames[i]);
400 req = fxp_stat_send(fname);
401 pktin = sftp_wait_for_reply(req);
402 if (!fxp_stat_recv(pktin, req, &attrs))
405 req = fxp_open_send(fname, SSH_FXF_READ, NULL);
406 pktin = sftp_wait_for_reply(req);
407 fh = fxp_open_recv(pktin, req);
410 printf("%s: open for read: %s\n", fname, fxp_error());
415 file = open_existing_wfile(outfname, NULL);
417 file = open_new_file(outfname, GET_PERMISSIONS(attrs));
421 printf("local: unable to open %s\n", outfname);
423 req = fxp_close_send(fh);
424 pktin = sftp_wait_for_reply(req);
425 fxp_close_recv(pktin, req);
432 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
434 printf("reget: cannot restart %s - file too large\n",
436 req = fxp_close_send(fh);
437 pktin = sftp_wait_for_reply(req);
438 fxp_close_recv(pktin, req);
443 offset = get_file_posn(file);
444 uint64_decimal(offset, decbuf);
445 printf("reget: restarting at file position %s\n", decbuf);
447 offset = uint64_make(0, 0);
450 printf("remote:%s => local:%s\n", fname, outfname);
453 * FIXME: we can use FXP_FSTAT here to get the file size, and
454 * thus put up a progress bar.
457 xfer = xfer_download_init(fh, offset);
458 while (!xfer_done(xfer)) {
463 xfer_download_queue(xfer);
465 ret = xfer_download_gotpkt(xfer, pktin);
468 printf("error while reading: %s\n", fxp_error());
471 if (ret == INT_MIN) /* pktin not even freed */
476 while (xfer_download_data(xfer, &vbuf, &len)) {
477 unsigned char *buf = (unsigned char *)vbuf;
481 wlen = write_to_file(file, buf + wpos, len - wpos);
483 printf("error while writing local file\n");
485 xfer_set_error(xfer);
490 if (wpos < len) { /* we had an error */
492 xfer_set_error(xfer);
503 req = fxp_close_send(fh);
504 pktin = sftp_wait_for_reply(req);
505 fxp_close_recv(pktin, req);
510 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
512 struct fxp_handle *fh;
513 struct fxp_xfer *xfer;
514 struct sftp_packet *pktin;
515 struct sftp_request *req;
519 struct fxp_attrs attrs;
523 * In recursive mode, see if we're dealing with a directory.
524 * (If we're not in recursive mode, we need not even check: the
525 * subsequent fopen will return an error message.)
527 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
529 int nnames, namesize;
530 char *name, **ournames;
535 * First, attempt to create the destination directory,
536 * unless it already exists.
538 req = fxp_stat_send(outfname);
539 pktin = sftp_wait_for_reply(req);
540 result = fxp_stat_recv(pktin, req, &attrs);
542 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
543 !(attrs.permissions & 0040000)) {
544 req = fxp_mkdir_send(outfname);
545 pktin = sftp_wait_for_reply(req);
546 result = fxp_mkdir_recv(pktin, req);
549 printf("%s: create directory: %s\n",
550 outfname, fxp_error());
556 * Now get the list of filenames in the local directory.
558 nnames = namesize = 0;
561 dh = open_directory(fname);
563 printf("%s: unable to open directory\n", fname);
566 while ((name = read_filename(dh)) != NULL) {
567 if (nnames >= namesize) {
569 ournames = sresize(ournames, namesize, char *);
571 ournames[nnames++] = name;
576 * Sort the names into a clear order. This ought to make
577 * things more predictable when we're doing a reput of the
578 * same directory, just in case two readdirs on the same
579 * local directory return a different order.
582 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
585 * If we're in restart mode, find the last filename on this
586 * list that already exists. We may have to do a reput on
587 * _that_ file, but shouldn't have to do anything on the
590 * If none of them exists, of course, we start at 0.
596 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
597 req = fxp_stat_send(nextoutfname);
598 pktin = sftp_wait_for_reply(req);
599 result = fxp_stat_recv(pktin, req, &attrs);
610 * Now we're ready to recurse. Starting at ournames[i]
611 * and continuing on to the end of the list, we
612 * construct a new source and target file name, and
613 * call sftp_put_file again.
615 for (; i < nnames; i++) {
616 char *nextfname, *nextoutfname;
619 nextfname = dir_file_cat(fname, ournames[i]);
620 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
621 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
622 restart = FALSE; /* after first partial file, do full */
626 for (i = 0; i < nnames; i++) {
635 * Done this recursion level. Free everything.
637 for (i = 0; i < nnames; i++) {
645 file = open_existing_file(fname, NULL, NULL, NULL, &permissions);
647 printf("local: unable to open %s\n", fname);
651 PUT_PERMISSIONS(attrs, permissions);
653 req = fxp_open_send(outfname, SSH_FXF_WRITE, &attrs);
655 req = fxp_open_send(outfname,
656 SSH_FXF_WRITE | SSH_FXF_CREAT | SSH_FXF_TRUNC,
659 pktin = sftp_wait_for_reply(req);
660 fh = fxp_open_recv(pktin, req);
664 printf("%s: open for write: %s\n", outfname, fxp_error());
670 struct fxp_attrs attrs;
673 req = fxp_fstat_send(fh);
674 pktin = sftp_wait_for_reply(req);
675 ret = fxp_fstat_recv(pktin, req, &attrs);
679 printf("read size of %s: %s\n", outfname, fxp_error());
682 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
684 printf("read size of %s: size was not given\n", outfname);
688 uint64_decimal(offset, decbuf);
689 printf("reput: restarting at file position %s\n", decbuf);
691 if (seek_file((WFile *)file, offset, FROM_START) != 0)
692 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
694 offset = uint64_make(0, 0);
697 printf("local:%s => remote:%s\n", fname, outfname);
700 * FIXME: we can use FXP_FSTAT here to get the file size, and
701 * thus put up a progress bar.
704 xfer = xfer_upload_init(fh, offset);
706 while ((!err && !eof) || !xfer_done(xfer)) {
710 while (xfer_upload_ready(xfer) && !err && !eof) {
711 len = read_from_file(file, buffer, sizeof(buffer));
713 printf("error while reading local file\n");
715 } else if (len == 0) {
718 xfer_upload_data(xfer, buffer, len);
722 if (!xfer_done(xfer)) {
724 ret = xfer_upload_gotpkt(xfer, pktin);
726 if (ret == INT_MIN) /* pktin not even freed */
729 printf("error while writing: %s\n", fxp_error());
738 req = fxp_close_send(fh);
739 pktin = sftp_wait_for_reply(req);
740 fxp_close_recv(pktin, req);
747 /* ----------------------------------------------------------------------
748 * A remote wildcard matcher, providing a similar interface to the
749 * local one in psftp.h.
752 typedef struct SftpWildcardMatcher {
753 struct fxp_handle *dirh;
754 struct fxp_names *names;
756 char *wildcard, *prefix;
757 } SftpWildcardMatcher;
759 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
761 struct sftp_packet *pktin;
762 struct sftp_request *req;
764 char *unwcdir, *tmpdir, *cdir;
766 SftpWildcardMatcher *swcm;
767 struct fxp_handle *dirh;
770 * We don't handle multi-level wildcards; so we expect to find
771 * a fully specified directory part, followed by a wildcard
774 wildcard = stripslashes(name, 0);
776 unwcdir = dupstr(name);
777 len = wildcard - name;
779 if (len > 0 && unwcdir[len-1] == '/')
780 unwcdir[len-1] = '\0';
781 tmpdir = snewn(1 + len, char);
782 check = wc_unescape(tmpdir, unwcdir);
786 printf("Multiple-level wildcards are not supported\n");
791 cdir = canonify(unwcdir);
793 req = fxp_opendir_send(cdir);
794 pktin = sftp_wait_for_reply(req);
795 dirh = fxp_opendir_recv(pktin, req);
798 swcm = snew(SftpWildcardMatcher);
801 swcm->wildcard = dupstr(wildcard);
802 swcm->prefix = unwcdir;
804 printf("Unable to open %s: %s\n", cdir, fxp_error());
814 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
816 struct fxp_name *name;
817 struct sftp_packet *pktin;
818 struct sftp_request *req;
821 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
822 fxp_free_names(swcm->names);
827 req = fxp_readdir_send(swcm->dirh);
828 pktin = sftp_wait_for_reply(req);
829 swcm->names = fxp_readdir_recv(pktin, req);
832 if (fxp_error_type() != SSH_FX_EOF)
833 printf("%s: reading directory: %s\n", swcm->prefix,
836 } else if (swcm->names->nnames == 0) {
838 * Another failure mode which we treat as EOF is if
839 * the server reports success from FXP_READDIR but
840 * returns no actual names. This is unusual, since
841 * from most servers you'd expect at least "." and
842 * "..", but there's nothing forbidding a server from
843 * omitting those if it wants to.
851 assert(swcm->names && swcm->namepos < swcm->names->nnames);
853 name = &swcm->names->names[swcm->namepos++];
855 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
856 continue; /* expected bad filenames */
858 if (!vet_filename(name->filename)) {
859 printf("ignoring potentially dangerous server-"
860 "supplied filename '%s'\n", name->filename);
861 continue; /* unexpected bad filename */
864 if (!wc_match(swcm->wildcard, name->filename))
865 continue; /* doesn't match the wildcard */
868 * We have a working filename. Return it.
870 return dupprintf("%s%s%s", swcm->prefix,
872 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
878 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
880 struct sftp_packet *pktin;
881 struct sftp_request *req;
883 req = fxp_close_send(swcm->dirh);
884 pktin = sftp_wait_for_reply(req);
885 fxp_close_recv(pktin, req);
888 fxp_free_names(swcm->names);
891 sfree(swcm->wildcard);
897 * General function to match a potential wildcard in a filename
898 * argument and iterate over every matching file. Used in several
899 * PSFTP commands (rmdir, rm, chmod, mv).
901 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
903 char *unwcfname, *newname, *cname;
906 unwcfname = snewn(strlen(filename)+1, char);
907 is_wc = !wc_unescape(unwcfname, filename);
910 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
919 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
920 cname = canonify(newname);
922 printf("%s: canonify: %s\n", newname, fxp_error());
927 ret &= func(ctx, cname);
932 /* Politely warn the user that nothing matched. */
933 printf("%s: nothing matched\n", filename);
936 sftp_finish_wildcard_matching(swcm);
938 cname = canonify(unwcfname);
940 printf("%s: canonify: %s\n", filename, fxp_error());
943 ret = func(ctx, cname);
952 * Handy helper function.
954 int is_wildcard(char *name)
956 char *unwcfname = snewn(strlen(name)+1, char);
957 int is_wc = !wc_unescape(unwcfname, name);
962 /* ----------------------------------------------------------------------
963 * Actual sftp commands.
965 struct sftp_command {
967 int nwords, wordssize;
968 int (*obey) (struct sftp_command *); /* returns <0 to quit */
971 int sftp_cmd_null(struct sftp_command *cmd)
973 return 1; /* success */
976 int sftp_cmd_unknown(struct sftp_command *cmd)
978 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
979 return 0; /* failure */
982 int sftp_cmd_quit(struct sftp_command *cmd)
987 int sftp_cmd_close(struct sftp_command *cmd)
994 if (back != NULL && back->connected(backhandle)) {
996 back->special(backhandle, TS_EOF);
998 sftp_recvdata(&ch, 1);
1006 * List a directory. If no arguments are given, list pwd; otherwise
1007 * list the directory given in words[1].
1009 int sftp_cmd_ls(struct sftp_command *cmd)
1011 struct fxp_handle *dirh;
1012 struct fxp_names *names;
1013 struct fxp_name **ournames;
1014 int nnames, namesize;
1015 char *dir, *cdir, *unwcdir, *wildcard;
1016 struct sftp_packet *pktin;
1017 struct sftp_request *req;
1025 if (cmd->nwords < 2)
1028 dir = cmd->words[1];
1030 unwcdir = snewn(1 + strlen(dir), char);
1031 if (wc_unescape(unwcdir, dir)) {
1039 wildcard = stripslashes(dir, 0);
1040 unwcdir = dupstr(dir);
1041 len = wildcard - dir;
1042 unwcdir[len] = '\0';
1043 if (len > 0 && unwcdir[len-1] == '/')
1044 unwcdir[len-1] = '\0';
1045 tmpdir = snewn(1 + len, char);
1046 check = wc_unescape(tmpdir, unwcdir);
1049 printf("Multiple-level wildcards are not supported\n");
1056 cdir = canonify(dir);
1058 printf("%s: canonify: %s\n", dir, fxp_error());
1063 printf("Listing directory %s\n", cdir);
1065 req = fxp_opendir_send(cdir);
1066 pktin = sftp_wait_for_reply(req);
1067 dirh = fxp_opendir_recv(pktin, req);
1070 printf("Unable to open %s: %s\n", dir, fxp_error());
1072 nnames = namesize = 0;
1077 req = fxp_readdir_send(dirh);
1078 pktin = sftp_wait_for_reply(req);
1079 names = fxp_readdir_recv(pktin, req);
1081 if (names == NULL) {
1082 if (fxp_error_type() == SSH_FX_EOF)
1084 printf("Reading directory %s: %s\n", dir, fxp_error());
1087 if (names->nnames == 0) {
1088 fxp_free_names(names);
1092 if (nnames + names->nnames >= namesize) {
1093 namesize += names->nnames + 128;
1094 ournames = sresize(ournames, namesize, struct fxp_name *);
1097 for (i = 0; i < names->nnames; i++)
1098 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1099 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1101 fxp_free_names(names);
1103 req = fxp_close_send(dirh);
1104 pktin = sftp_wait_for_reply(req);
1105 fxp_close_recv(pktin, req);
1108 * Now we have our filenames. Sort them by actual file
1109 * name, and then output the longname parts.
1112 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1117 for (i = 0; i < nnames; i++) {
1118 printf("%s\n", ournames[i]->longname);
1119 fxp_free_name(ournames[i]);
1131 * Change directories. We do this by canonifying the new name, then
1132 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1134 int sftp_cmd_cd(struct sftp_command *cmd)
1136 struct fxp_handle *dirh;
1137 struct sftp_packet *pktin;
1138 struct sftp_request *req;
1146 if (cmd->nwords < 2)
1147 dir = dupstr(homedir);
1149 dir = canonify(cmd->words[1]);
1152 printf("%s: canonify: %s\n", dir, fxp_error());
1156 req = fxp_opendir_send(dir);
1157 pktin = sftp_wait_for_reply(req);
1158 dirh = fxp_opendir_recv(pktin, req);
1161 printf("Directory %s: %s\n", dir, fxp_error());
1166 req = fxp_close_send(dirh);
1167 pktin = sftp_wait_for_reply(req);
1168 fxp_close_recv(pktin, req);
1172 printf("Remote directory is now %s\n", pwd);
1178 * Print current directory. Easy as pie.
1180 int sftp_cmd_pwd(struct sftp_command *cmd)
1187 printf("Remote directory is %s\n", pwd);
1192 * Get a file and save it at the local end. We have three very
1193 * similar commands here. The basic one is `get'; `reget' differs
1194 * in that it checks for the existence of the destination file and
1195 * starts from where a previous aborted transfer left off; `mget'
1196 * differs in that it interprets all its arguments as files to
1197 * transfer (never as a different local name for a remote file) and
1198 * can handle wildcards.
1200 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1202 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1204 int recurse = FALSE;
1212 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1213 if (!strcmp(cmd->words[i], "--")) {
1214 /* finish processing options */
1217 } else if (!strcmp(cmd->words[i], "-r")) {
1220 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1226 if (i >= cmd->nwords) {
1227 printf("%s: expects a filename\n", cmd->words[0]);
1233 SftpWildcardMatcher *swcm;
1235 origfname = cmd->words[i++];
1236 unwcfname = snewn(strlen(origfname)+1, char);
1238 if (multiple && !wc_unescape(unwcfname, origfname)) {
1239 swcm = sftp_begin_wildcard_matching(origfname);
1244 origwfname = sftp_wildcard_get_filename(swcm);
1246 /* Politely warn the user that nothing matched. */
1247 printf("%s: nothing matched\n", origfname);
1248 sftp_finish_wildcard_matching(swcm);
1253 origwfname = origfname;
1257 while (origwfname) {
1258 fname = canonify(origwfname);
1261 sftp_finish_wildcard_matching(swcm);
1262 printf("%s: canonify: %s\n", origwfname, fxp_error());
1268 if (!multiple && i < cmd->nwords)
1269 outfname = cmd->words[i++];
1271 outfname = stripslashes(origwfname, 0);
1273 ret = sftp_get_file(fname, outfname, recurse, restart);
1279 origwfname = sftp_wildcard_get_filename(swcm);
1286 sftp_finish_wildcard_matching(swcm);
1290 } while (multiple && i < cmd->nwords);
1294 int sftp_cmd_get(struct sftp_command *cmd)
1296 return sftp_general_get(cmd, 0, 0);
1298 int sftp_cmd_mget(struct sftp_command *cmd)
1300 return sftp_general_get(cmd, 0, 1);
1302 int sftp_cmd_reget(struct sftp_command *cmd)
1304 return sftp_general_get(cmd, 1, 0);
1308 * Send a file and store it at the remote end. We have three very
1309 * similar commands here. The basic one is `put'; `reput' differs
1310 * in that it checks for the existence of the destination file and
1311 * starts from where a previous aborted transfer left off; `mput'
1312 * differs in that it interprets all its arguments as files to
1313 * transfer (never as a different remote name for a local file) and
1314 * can handle wildcards.
1316 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1318 char *fname, *wfname, *origoutfname, *outfname;
1320 int recurse = FALSE;
1328 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1329 if (!strcmp(cmd->words[i], "--")) {
1330 /* finish processing options */
1333 } else if (!strcmp(cmd->words[i], "-r")) {
1336 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1342 if (i >= cmd->nwords) {
1343 printf("%s: expects a filename\n", cmd->words[0]);
1349 WildcardMatcher *wcm;
1350 fname = cmd->words[i++];
1352 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1353 wcm = begin_wildcard_matching(fname);
1354 wfname = wildcard_get_filename(wcm);
1356 /* Politely warn the user that nothing matched. */
1357 printf("%s: nothing matched\n", fname);
1358 finish_wildcard_matching(wcm);
1367 if (!multiple && i < cmd->nwords)
1368 origoutfname = cmd->words[i++];
1370 origoutfname = stripslashes(wfname, 1);
1372 outfname = canonify(origoutfname);
1374 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1377 finish_wildcard_matching(wcm);
1381 ret = sftp_put_file(wfname, outfname, recurse, restart);
1386 wfname = wildcard_get_filename(wcm);
1393 finish_wildcard_matching(wcm);
1398 } while (multiple && i < cmd->nwords);
1402 int sftp_cmd_put(struct sftp_command *cmd)
1404 return sftp_general_put(cmd, 0, 0);
1406 int sftp_cmd_mput(struct sftp_command *cmd)
1408 return sftp_general_put(cmd, 0, 1);
1410 int sftp_cmd_reput(struct sftp_command *cmd)
1412 return sftp_general_put(cmd, 1, 0);
1415 int sftp_cmd_mkdir(struct sftp_command *cmd)
1418 struct sftp_packet *pktin;
1419 struct sftp_request *req;
1428 if (cmd->nwords < 2) {
1429 printf("mkdir: expects a directory\n");
1434 for (i = 1; i < cmd->nwords; i++) {
1435 dir = canonify(cmd->words[i]);
1437 printf("%s: canonify: %s\n", dir, fxp_error());
1441 req = fxp_mkdir_send(dir);
1442 pktin = sftp_wait_for_reply(req);
1443 result = fxp_mkdir_recv(pktin, req);
1446 printf("mkdir %s: %s\n", dir, fxp_error());
1449 printf("mkdir %s: OK\n", dir);
1457 static int sftp_action_rmdir(void *vctx, char *dir)
1459 struct sftp_packet *pktin;
1460 struct sftp_request *req;
1463 req = fxp_rmdir_send(dir);
1464 pktin = sftp_wait_for_reply(req);
1465 result = fxp_rmdir_recv(pktin, req);
1468 printf("rmdir %s: %s\n", dir, fxp_error());
1472 printf("rmdir %s: OK\n", dir);
1477 int sftp_cmd_rmdir(struct sftp_command *cmd)
1486 if (cmd->nwords < 2) {
1487 printf("rmdir: expects a directory\n");
1492 for (i = 1; i < cmd->nwords; i++)
1493 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1498 static int sftp_action_rm(void *vctx, char *fname)
1500 struct sftp_packet *pktin;
1501 struct sftp_request *req;
1504 req = fxp_remove_send(fname);
1505 pktin = sftp_wait_for_reply(req);
1506 result = fxp_remove_recv(pktin, req);
1509 printf("rm %s: %s\n", fname, fxp_error());
1513 printf("rm %s: OK\n", fname);
1518 int sftp_cmd_rm(struct sftp_command *cmd)
1527 if (cmd->nwords < 2) {
1528 printf("rm: expects a filename\n");
1533 for (i = 1; i < cmd->nwords; i++)
1534 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1539 static int check_is_dir(char *dstfname)
1541 struct sftp_packet *pktin;
1542 struct sftp_request *req;
1543 struct fxp_attrs attrs;
1546 req = fxp_stat_send(dstfname);
1547 pktin = sftp_wait_for_reply(req);
1548 result = fxp_stat_recv(pktin, req, &attrs);
1551 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1552 (attrs.permissions & 0040000))
1558 struct sftp_context_mv {
1563 static int sftp_action_mv(void *vctx, char *srcfname)
1565 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1566 struct sftp_packet *pktin;
1567 struct sftp_request *req;
1569 char *finalfname, *newcanon = NULL;
1572 if (ctx->dest_is_dir) {
1576 p = srcfname + strlen(srcfname);
1577 while (p > srcfname && p[-1] != '/') p--;
1578 newname = dupcat(ctx->dstfname, "/", p, NULL);
1579 newcanon = canonify(newname);
1581 printf("%s: canonify: %s\n", newname, fxp_error());
1587 finalfname = newcanon;
1589 finalfname = ctx->dstfname;
1592 req = fxp_rename_send(srcfname, finalfname);
1593 pktin = sftp_wait_for_reply(req);
1594 result = fxp_rename_recv(pktin, req);
1596 error = result ? NULL : fxp_error();
1599 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1602 printf("%s -> %s\n", srcfname, finalfname);
1610 int sftp_cmd_mv(struct sftp_command *cmd)
1612 struct sftp_context_mv actx, *ctx = &actx;
1620 if (cmd->nwords < 3) {
1621 printf("mv: expects two filenames\n");
1625 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1626 if (!ctx->dstfname) {
1627 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1632 * If there's more than one source argument, or one source
1633 * argument which is a wildcard, we _require_ that the
1634 * destination is a directory.
1636 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1637 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1638 printf("mv: multiple or wildcard arguments require the destination"
1639 " to be a directory\n");
1640 sfree(ctx->dstfname);
1645 * Now iterate over the source arguments.
1648 for (i = 1; i < cmd->nwords-1; i++)
1649 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1651 sfree(ctx->dstfname);
1655 struct sftp_context_chmod {
1656 unsigned attrs_clr, attrs_xor;
1659 static int sftp_action_chmod(void *vctx, char *fname)
1661 struct fxp_attrs attrs;
1662 struct sftp_packet *pktin;
1663 struct sftp_request *req;
1665 unsigned oldperms, newperms;
1666 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1668 req = fxp_stat_send(fname);
1669 pktin = sftp_wait_for_reply(req);
1670 result = fxp_stat_recv(pktin, req, &attrs);
1672 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1673 printf("get attrs for %s: %s\n", fname,
1674 result ? "file permissions not provided" : fxp_error());
1678 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1679 oldperms = attrs.permissions & 07777;
1680 attrs.permissions &= ~ctx->attrs_clr;
1681 attrs.permissions ^= ctx->attrs_xor;
1682 newperms = attrs.permissions & 07777;
1684 if (oldperms == newperms)
1685 return 1; /* no need to do anything! */
1687 req = fxp_setstat_send(fname, attrs);
1688 pktin = sftp_wait_for_reply(req);
1689 result = fxp_setstat_recv(pktin, req);
1692 printf("set attrs for %s: %s\n", fname, fxp_error());
1696 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1701 int sftp_cmd_chmod(struct sftp_command *cmd)
1705 struct sftp_context_chmod actx, *ctx = &actx;
1712 if (cmd->nwords < 3) {
1713 printf("chmod: expects a mode specifier and a filename\n");
1718 * Attempt to parse the mode specifier in cmd->words[1]. We
1719 * don't support the full horror of Unix chmod; instead we
1720 * support a much simpler syntax in which the user can either
1721 * specify an octal number, or a comma-separated sequence of
1722 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1723 * _only_ be omitted if the only attribute mentioned is t,
1724 * since all others require a user/group/other specification.
1725 * Additionally, the s attribute may not be specified for any
1726 * [ugoa] specifications other than exactly u or exactly g.
1728 ctx->attrs_clr = ctx->attrs_xor = 0;
1729 mode = cmd->words[1];
1730 if (mode[0] >= '0' && mode[0] <= '9') {
1731 if (mode[strspn(mode, "01234567")]) {
1732 printf("chmod: numeric file modes should"
1733 " contain digits 0-7 only\n");
1736 ctx->attrs_clr = 07777;
1737 sscanf(mode, "%o", &ctx->attrs_xor);
1738 ctx->attrs_xor &= ctx->attrs_clr;
1741 char *modebegin = mode;
1742 unsigned subset, perms;
1746 while (*mode && *mode != ',' &&
1747 *mode != '+' && *mode != '-' && *mode != '=') {
1749 case 'u': subset |= 04700; break; /* setuid, user perms */
1750 case 'g': subset |= 02070; break; /* setgid, group perms */
1751 case 'o': subset |= 00007; break; /* just other perms */
1752 case 'a': subset |= 06777; break; /* all of the above */
1754 printf("chmod: file mode '%.*s' contains unrecognised"
1755 " user/group/other specifier '%c'\n",
1756 (int)strcspn(modebegin, ","), modebegin, *mode);
1761 if (!*mode || *mode == ',') {
1762 printf("chmod: file mode '%.*s' is incomplete\n",
1763 (int)strcspn(modebegin, ","), modebegin);
1767 if (!*mode || *mode == ',') {
1768 printf("chmod: file mode '%.*s' is incomplete\n",
1769 (int)strcspn(modebegin, ","), modebegin);
1773 while (*mode && *mode != ',') {
1775 case 'r': perms |= 00444; break;
1776 case 'w': perms |= 00222; break;
1777 case 'x': perms |= 00111; break;
1778 case 't': perms |= 01000; subset |= 01000; break;
1780 if ((subset & 06777) != 04700 &&
1781 (subset & 06777) != 02070) {
1782 printf("chmod: file mode '%.*s': set[ug]id bit should"
1783 " be used with exactly one of u or g only\n",
1784 (int)strcspn(modebegin, ","), modebegin);
1790 printf("chmod: file mode '%.*s' contains unrecognised"
1791 " permission specifier '%c'\n",
1792 (int)strcspn(modebegin, ","), modebegin, *mode);
1797 if (!(subset & 06777) && (perms &~ subset)) {
1798 printf("chmod: file mode '%.*s' contains no user/group/other"
1799 " specifier and permissions other than 't' \n",
1800 (int)strcspn(modebegin, ","), modebegin);
1806 ctx->attrs_clr |= perms;
1807 ctx->attrs_xor |= perms;
1810 ctx->attrs_clr |= perms;
1811 ctx->attrs_xor &= ~perms;
1814 ctx->attrs_clr |= subset;
1815 ctx->attrs_xor |= perms;
1818 if (*mode) mode++; /* eat comma */
1823 for (i = 2; i < cmd->nwords; i++)
1824 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1829 static int sftp_cmd_open(struct sftp_command *cmd)
1834 printf("psftp: already connected\n");
1838 if (cmd->nwords < 2) {
1839 printf("open: expects a host name\n");
1843 if (cmd->nwords > 2) {
1844 portnumber = atoi(cmd->words[2]);
1845 if (portnumber == 0) {
1846 printf("open: invalid port number\n");
1852 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1853 back = NULL; /* connection is already closed */
1854 return -1; /* this is fatal */
1860 static int sftp_cmd_lcd(struct sftp_command *cmd)
1862 char *currdir, *errmsg;
1864 if (cmd->nwords < 2) {
1865 printf("lcd: expects a local directory name\n");
1869 errmsg = psftp_lcd(cmd->words[1]);
1871 printf("lcd: unable to change directory: %s\n", errmsg);
1876 currdir = psftp_getcwd();
1877 printf("New local directory is %s\n", currdir);
1883 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1887 currdir = psftp_getcwd();
1888 printf("Current local directory is %s\n", currdir);
1894 static int sftp_cmd_pling(struct sftp_command *cmd)
1898 exitcode = system(cmd->words[1]);
1899 return (exitcode == 0);
1902 static int sftp_cmd_help(struct sftp_command *cmd);
1904 static struct sftp_cmd_lookup {
1907 * For help purposes, there are two kinds of command:
1909 * - primary commands, in which `longhelp' is non-NULL. In
1910 * this case `shorthelp' is descriptive text, and `longhelp'
1911 * is longer descriptive text intended to be printed after
1914 * - alias commands, in which `longhelp' is NULL. In this case
1915 * `shorthelp' is the name of a primary command, which
1916 * contains the help that should double up for this command.
1918 int listed; /* do we list this in primary help? */
1921 int (*obey) (struct sftp_command *);
1924 * List of sftp commands. This is binary-searched so it MUST be
1928 "!", TRUE, "run a local command",
1930 /* FIXME: this example is crap for non-Windows. */
1931 " Runs a local command. For example, \"!del myfile\".\n",
1935 "bye", TRUE, "finish your SFTP session",
1937 " Terminates your SFTP session and quits the PSFTP program.\n",
1941 "cd", TRUE, "change your remote working directory",
1942 " [ <new working directory> ]\n"
1943 " Change the remote working directory for your SFTP session.\n"
1944 " If a new working directory is not supplied, you will be\n"
1945 " returned to your home directory.\n",
1949 "chmod", TRUE, "change file permissions and modes",
1950 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1951 " Change the file permissions on one or more remote files or\n"
1953 " <modes> can be any octal Unix permission specifier.\n"
1954 " Alternatively, <modes> can include the following modifiers:\n"
1955 " u+r make file readable by owning user\n"
1956 " u+w make file writable by owning user\n"
1957 " u+x make file executable by owning user\n"
1958 " u-r make file not readable by owning user\n"
1959 " [also u-w, u-x]\n"
1960 " g+r make file readable by members of owning group\n"
1961 " [also g+w, g+x, g-r, g-w, g-x]\n"
1962 " o+r make file readable by all other users\n"
1963 " [also o+w, o+x, o-r, o-w, o-x]\n"
1964 " a+r make file readable by absolutely everybody\n"
1965 " [also a+w, a+x, a-r, a-w, a-x]\n"
1966 " u+s enable the Unix set-user-ID bit\n"
1967 " u-s disable the Unix set-user-ID bit\n"
1968 " g+s enable the Unix set-group-ID bit\n"
1969 " g-s disable the Unix set-group-ID bit\n"
1970 " +t enable the Unix \"sticky bit\"\n"
1971 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1972 " more than one user for the same modifier (\"ug+w\"). You can\n"
1973 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1977 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1979 " Terminates your SFTP session, but does not quit the PSFTP\n"
1980 " program. You can then use \"open\" to start another SFTP\n"
1981 " session, to the same server or to a different one.\n",
1985 "del", TRUE, "delete files on the remote server",
1986 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1987 " Delete a file or files from the server.\n",
1991 "delete", FALSE, "del", NULL, sftp_cmd_rm
1994 "dir", TRUE, "list remote files",
1995 " [ <directory-name> ]/[ <wildcard> ]\n"
1996 " List the contents of a specified directory on the server.\n"
1997 " If <directory-name> is not given, the current working directory\n"
1999 " If <wildcard> is given, it is treated as a set of files to\n"
2000 " list; otherwise, all files are listed.\n",
2004 "exit", TRUE, "bye", NULL, sftp_cmd_quit
2007 "get", TRUE, "download a file from the server to your local machine",
2008 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2009 " Downloads a file on the server and stores it locally under\n"
2010 " the same name, or under a different one if you supply the\n"
2011 " argument <local-filename>.\n"
2012 " If -r specified, recursively fetch a directory.\n",
2016 "help", TRUE, "give help",
2017 " [ <command> [ <command> ... ] ]\n"
2018 " Give general help if no commands are specified.\n"
2019 " If one or more commands are specified, give specific help on\n"
2020 " those particular commands.\n",
2024 "lcd", TRUE, "change local working directory",
2025 " <local-directory-name>\n"
2026 " Change the local working directory of the PSFTP program (the\n"
2027 " default location where the \"get\" command will save files).\n",
2031 "lpwd", TRUE, "print local working directory",
2033 " Print the local working directory of the PSFTP program (the\n"
2034 " default location where the \"get\" command will save files).\n",
2038 "ls", TRUE, "dir", NULL,
2042 "mget", TRUE, "download multiple files at once",
2043 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2044 " Downloads many files from the server, storing each one under\n"
2045 " the same name it has on the server side. You can use wildcards\n"
2046 " such as \"*.c\" to specify lots of files at once.\n"
2047 " If -r specified, recursively fetch files and directories.\n",
2051 "mkdir", TRUE, "create directories on the remote server",
2052 " <directory-name> [ <directory-name>... ]\n"
2053 " Creates directories with the given names on the server.\n",
2057 "mput", TRUE, "upload multiple files at once",
2058 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2059 " Uploads many files to the server, storing each one under the\n"
2060 " same name it has on the client side. You can use wildcards\n"
2061 " such as \"*.c\" to specify lots of files at once.\n"
2062 " If -r specified, recursively store files and directories.\n",
2066 "mv", TRUE, "move or rename file(s) on the remote server",
2067 " <source> [ <source>... ] <destination>\n"
2068 " Moves or renames <source>(s) on the server to <destination>,\n"
2069 " also on the server.\n"
2070 " If <destination> specifies an existing directory, then <source>\n"
2071 " may be a wildcard, and multiple <source>s may be given; all\n"
2072 " source files are moved into <destination>.\n"
2073 " Otherwise, <source> must specify a single file, which is moved\n"
2074 " or renamed so that it is accessible under the name <destination>.\n",
2078 "open", TRUE, "connect to a host",
2079 " [<user>@]<hostname> [<port>]\n"
2080 " Establishes an SFTP connection to a given host. Only usable\n"
2081 " when you are not already connected to a server.\n",
2085 "put", TRUE, "upload a file from your local machine to the server",
2086 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2087 " Uploads a file to the server and stores it there under\n"
2088 " the same name, or under a different one if you supply the\n"
2089 " argument <remote-filename>.\n"
2090 " If -r specified, recursively store a directory.\n",
2094 "pwd", TRUE, "print your remote working directory",
2096 " Print the current remote working directory for your SFTP session.\n",
2100 "quit", TRUE, "bye", NULL,
2104 "reget", TRUE, "continue downloading files",
2105 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2106 " Works exactly like the \"get\" command, but the local file\n"
2107 " must already exist. The download will begin at the end of the\n"
2108 " file. This is for resuming a download that was interrupted.\n"
2109 " If -r specified, resume interrupted \"get -r\".\n",
2113 "ren", TRUE, "mv", NULL,
2117 "rename", FALSE, "mv", NULL,
2121 "reput", TRUE, "continue uploading files",
2122 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2123 " Works exactly like the \"put\" command, but the remote file\n"
2124 " must already exist. The upload will begin at the end of the\n"
2125 " file. This is for resuming an upload that was interrupted.\n"
2126 " If -r specified, resume interrupted \"put -r\".\n",
2130 "rm", TRUE, "del", NULL,
2134 "rmdir", TRUE, "remove directories on the remote server",
2135 " <directory-name> [ <directory-name>... ]\n"
2136 " Removes the directory with the given name on the server.\n"
2137 " The directory will not be removed unless it is empty.\n"
2138 " Wildcards may be used to specify multiple directories.\n",
2143 const struct sftp_cmd_lookup *lookup_command(char *name)
2148 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2151 cmp = strcmp(name, sftp_lookup[k].name);
2157 return &sftp_lookup[k];
2163 static int sftp_cmd_help(struct sftp_command *cmd)
2166 if (cmd->nwords == 1) {
2168 * Give short help on each command.
2172 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2174 if (!sftp_lookup[i].listed)
2176 len = strlen(sftp_lookup[i].name);
2180 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2181 const struct sftp_cmd_lookup *lookup;
2182 if (!sftp_lookup[i].listed)
2184 lookup = &sftp_lookup[i];
2185 printf("%-*s", maxlen+2, lookup->name);
2186 if (lookup->longhelp == NULL)
2187 lookup = lookup_command(lookup->shorthelp);
2188 printf("%s\n", lookup->shorthelp);
2192 * Give long help on specific commands.
2194 for (i = 1; i < cmd->nwords; i++) {
2195 const struct sftp_cmd_lookup *lookup;
2196 lookup = lookup_command(cmd->words[i]);
2198 printf("help: %s: command not found\n", cmd->words[i]);
2200 printf("%s", lookup->name);
2201 if (lookup->longhelp == NULL)
2202 lookup = lookup_command(lookup->shorthelp);
2203 printf("%s", lookup->longhelp);
2210 /* ----------------------------------------------------------------------
2211 * Command line reading and parsing.
2213 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2216 struct sftp_command *cmd;
2220 cmd = snew(struct sftp_command);
2230 line = fgetline(fp);
2232 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2235 if (!line || !*line) {
2236 cmd->obey = sftp_cmd_quit;
2237 if ((mode == 0) || (modeflags & 1))
2240 return cmd; /* eof */
2243 line[strcspn(line, "\r\n")] = '\0';
2245 if (modeflags & 1) {
2246 printf("%s\n", line);
2250 while (*p && (*p == ' ' || *p == '\t'))
2255 * Special case: the ! command. This is always parsed as
2256 * exactly two words: one containing the !, and the second
2257 * containing everything else on the line.
2259 cmd->nwords = cmd->wordssize = 2;
2260 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2261 cmd->words[0] = dupstr("!");
2262 cmd->words[1] = dupstr(p+1);
2263 } else if (*p == '#') {
2265 * Special case: comment. Entire line is ignored.
2267 cmd->nwords = cmd->wordssize = 0;
2271 * Parse the command line into words. The syntax is:
2272 * - double quotes are removed, but cause spaces within to be
2273 * treated as non-separating.
2274 * - a double-doublequote pair is a literal double quote, inside
2275 * _or_ outside quotes. Like this:
2277 * firstword "second word" "this has ""quotes"" in" and""this""
2283 * >this has "quotes" in<
2287 /* skip whitespace */
2288 while (*p && (*p == ' ' || *p == '\t'))
2290 /* terminate loop */
2293 /* mark start of word */
2294 q = r = p; /* q sits at start, r writes word */
2297 if (!quoting && (*p == ' ' || *p == '\t'))
2298 break; /* reached end of word */
2299 else if (*p == '"' && p[1] == '"')
2300 p += 2, *r++ = '"'; /* a literal quote */
2302 p++, quoting = !quoting;
2307 p++; /* skip over the whitespace */
2309 if (cmd->nwords >= cmd->wordssize) {
2310 cmd->wordssize = cmd->nwords + 16;
2311 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2313 cmd->words[cmd->nwords++] = dupstr(q);
2320 * Now parse the first word and assign a function.
2323 if (cmd->nwords == 0)
2324 cmd->obey = sftp_cmd_null;
2326 const struct sftp_cmd_lookup *lookup;
2327 lookup = lookup_command(cmd->words[0]);
2329 cmd->obey = sftp_cmd_unknown;
2331 cmd->obey = lookup->obey;
2337 static int do_sftp_init(void)
2339 struct sftp_packet *pktin;
2340 struct sftp_request *req;
2343 * Do protocol initialisation.
2347 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2348 return 1; /* failure */
2352 * Find out where our home directory is.
2354 req = fxp_realpath_send(".");
2355 pktin = sftp_wait_for_reply(req);
2356 homedir = fxp_realpath_recv(pktin, req);
2360 "Warning: failed to resolve home directory: %s\n",
2362 homedir = dupstr(".");
2364 printf("Remote working directory is %s\n", homedir);
2366 pwd = dupstr(homedir);
2370 void do_sftp_cleanup()
2374 back->special(backhandle, TS_EOF);
2376 sftp_recvdata(&ch, 1);
2377 back->free(backhandle);
2378 sftp_cleanup_request();
2392 void do_sftp(int mode, int modeflags, char *batchfile)
2402 /* ------------------------------------------------------------------
2403 * Now we're ready to do Real Stuff.
2406 struct sftp_command *cmd;
2407 cmd = sftp_getcmd(NULL, 0, 0);
2410 ret = cmd->obey(cmd);
2413 for(i = 0; i < cmd->nwords; i++)
2414 sfree(cmd->words[i]);
2422 fp = fopen(batchfile, "r");
2424 printf("Fatal: unable to open %s\n", batchfile);
2428 struct sftp_command *cmd;
2429 cmd = sftp_getcmd(fp, mode, modeflags);
2432 ret = cmd->obey(cmd);
2436 if (!(modeflags & 2))
2445 /* ----------------------------------------------------------------------
2446 * Dirty bits: integration with PuTTY.
2449 static int verbose = 0;
2452 * Print an error message and perform a fatal exit.
2454 void fatalbox(char *fmt, ...)
2459 str = dupvprintf(fmt, ap);
2460 str2 = dupcat("Fatal: ", str, "\n", NULL);
2463 fputs(str2, stderr);
2468 void modalfatalbox(char *fmt, ...)
2473 str = dupvprintf(fmt, ap);
2474 str2 = dupcat("Fatal: ", str, "\n", NULL);
2477 fputs(str2, stderr);
2482 void nonfatal(char *fmt, ...)
2487 str = dupvprintf(fmt, ap);
2488 str2 = dupcat("Error: ", str, "\n", NULL);
2491 fputs(str2, stderr);
2494 void connection_fatal(void *frontend, char *fmt, ...)
2499 str = dupvprintf(fmt, ap);
2500 str2 = dupcat("Fatal: ", str, "\n", NULL);
2503 fputs(str2, stderr);
2509 void ldisc_send(void *handle, char *buf, int len, int interactive)
2512 * This is only here because of the calls to ldisc_send(NULL,
2513 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2514 * ldisc as an ldisc. So if we get called with any real data, I
2515 * want to know about it.
2521 * In psftp, all agent requests should be synchronous, so this is a
2522 * never-called stub.
2524 void agent_schedule_callback(void (*callback)(void *, void *, int),
2525 void *callback_ctx, void *data, int len)
2527 assert(!"We shouldn't be here");
2531 * Receive a block of data from the SSH link. Block until all data
2534 * To do this, we repeatedly call the SSH protocol module, with our
2535 * own trap in from_backend() to catch the data that comes back. We
2536 * do this until we have enough data.
2539 static unsigned char *outptr; /* where to put the data */
2540 static unsigned outlen; /* how much data required */
2541 static unsigned char *pending = NULL; /* any spare data */
2542 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2543 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2545 unsigned char *p = (unsigned char *) data;
2546 unsigned len = (unsigned) datalen;
2549 * stderr data is just spouted to local stderr and otherwise
2554 if (fwrite(data, 1, len, stderr) < len)
2560 * If this is before the real session begins, just return.
2565 if ((outlen > 0) && (len > 0)) {
2566 unsigned used = outlen;
2569 memcpy(outptr, p, used);
2577 if (pendsize < pendlen + len) {
2578 pendsize = pendlen + len + 4096;
2579 pending = sresize(pending, pendsize, unsigned char);
2581 memcpy(pending + pendlen, p, len);
2587 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2590 * No "untrusted" output should get here (the way the code is
2591 * currently, it's all diverted by FLAG_STDERR).
2593 assert(!"Unexpected call to from_backend_untrusted()");
2594 return 0; /* not reached */
2596 int from_backend_eof(void *frontend)
2599 * We expect to be the party deciding when to close the
2600 * connection, so if we see EOF before we sent it ourselves, we
2604 connection_fatal(frontend,
2605 "Received unexpected end-of-file from SFTP server");
2609 int sftp_recvdata(char *buf, int len)
2611 outptr = (unsigned char *) buf;
2615 * See if the pending-input block contains some of what we
2619 unsigned pendused = pendlen;
2620 if (pendused > outlen)
2622 memcpy(outptr, pending, pendused);
2623 memmove(pending, pending + pendused, pendlen - pendused);
2626 pendlen -= pendused;
2636 while (outlen > 0) {
2637 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2638 return 0; /* doom */
2643 int sftp_senddata(char *buf, int len)
2645 back->send(backhandle, buf, len);
2650 * Short description of parameters.
2652 static void usage(void)
2654 printf("PuTTY Secure File Transfer (SFTP) client\n");
2655 printf("%s\n", ver);
2656 printf("Usage: psftp [options] [user@]host\n");
2657 printf("Options:\n");
2658 printf(" -V print version information and exit\n");
2659 printf(" -pgpfp print PGP key fingerprints and exit\n");
2660 printf(" -b file use specified batchfile\n");
2661 printf(" -bc output batchfile commands\n");
2662 printf(" -be don't stop batchfile processing if errors\n");
2663 printf(" -v show verbose messages\n");
2664 printf(" -load sessname Load settings from saved session\n");
2665 printf(" -l user connect with specified username\n");
2666 printf(" -P port connect to specified port\n");
2667 printf(" -pw passw login with specified password\n");
2668 printf(" -1 -2 force use of particular SSH protocol version\n");
2669 printf(" -4 -6 force use of IPv4 or IPv6\n");
2670 printf(" -C enable compression\n");
2671 printf(" -i key private key file for authentication\n");
2672 printf(" -noagent disable use of Pageant\n");
2673 printf(" -agent enable use of Pageant\n");
2674 printf(" -batch disable all interactive prompts\n");
2678 static void version(void)
2680 printf("psftp: %s\n", ver);
2685 * Connect to a host.
2687 static int psftp_connect(char *userhost, char *user, int portnumber)
2689 char *host, *realhost;
2693 /* Separate host and username */
2695 host = strrchr(host, '@');
2701 printf("psftp: multiple usernames specified; using \"%s\"\n",
2708 * If we haven't loaded session details already (e.g., from -load),
2709 * try looking for a session called "host".
2711 if (!loaded_session) {
2712 /* Try to load settings for `host' into a temporary config */
2713 Conf *conf2 = conf_new();
2714 conf_set_str(conf2, CONF_host, "");
2715 do_defaults(host, conf2);
2716 if (conf_get_str(conf2, CONF_host)[0] != '\0') {
2717 /* Settings present and include hostname */
2718 /* Re-load data into the real config. */
2719 do_defaults(host, conf);
2721 /* Session doesn't exist or mention a hostname. */
2722 /* Use `host' as a bare hostname. */
2723 conf_set_str(conf, CONF_host, host);
2727 /* Patch in hostname `host' to session details. */
2728 conf_set_str(conf, CONF_host, host);
2732 * Force use of SSH. (If they got the protocol wrong we assume the
2733 * port is useless too.)
2735 if (conf_get_int(conf, CONF_protocol) != PROT_SSH) {
2736 conf_set_int(conf, CONF_protocol, PROT_SSH);
2737 conf_set_int(conf, CONF_port, 22);
2741 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2742 * then change it to SSH-2, on the grounds that that's more likely to
2743 * work for SFTP. (Can be overridden with `-1' option.)
2744 * But if it says `2 only' or `2', respect which.
2746 if ((conf_get_int(conf, CONF_sshprot) & ~1) != 2) /* is it 2 or 3? */
2747 conf_set_int(conf, CONF_sshprot, 2);
2750 * Enact command-line overrides.
2752 cmdline_run_saved(conf);
2755 * Muck about with the hostname in various ways.
2758 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
2759 char *host = hostbuf;
2763 * Trim leading whitespace.
2765 host += strspn(host, " \t");
2768 * See if host is of the form user@host, and separate out
2769 * the username if so.
2771 if (host[0] != '\0') {
2772 char *atsign = strrchr(host, '@');
2775 conf_set_str(conf, CONF_username, host);
2781 * Remove any remaining whitespace.
2786 if (*q != ' ' && *q != '\t')
2792 conf_set_str(conf, CONF_host, hostbuf);
2797 if (user != NULL && user[0] != '\0') {
2798 conf_set_str(conf, CONF_username, user);
2802 conf_set_int(conf, CONF_port, portnumber);
2805 * Disable scary things which shouldn't be enabled for simple
2806 * things like SCP and SFTP: agent forwarding, port forwarding,
2809 conf_set_int(conf, CONF_x11_forward, 0);
2810 conf_set_int(conf, CONF_agentfwd, 0);
2811 conf_set_int(conf, CONF_ssh_simple, TRUE);
2814 while ((key = conf_get_str_nthstrkey(conf, CONF_portfwd, 0)) != NULL)
2815 conf_del_str_str(conf, CONF_portfwd, key);
2818 /* Set up subsystem name. */
2819 conf_set_str(conf, CONF_remote_cmd, "sftp");
2820 conf_set_int(conf, CONF_ssh_subsys, TRUE);
2821 conf_set_int(conf, CONF_nopty, TRUE);
2824 * Set up fallback option, for SSH-1 servers or servers with the
2825 * sftp subsystem not enabled but the server binary installed
2826 * in the usual place. We only support fallback on Unix
2827 * systems, and we use a kludgy piece of shellery which should
2828 * try to find sftp-server in various places (the obvious
2829 * systemwide spots /usr/lib and /usr/local/lib, and then the
2830 * user's PATH) and finally give up.
2832 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2833 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2836 * the idea being that this will attempt to use either of the
2837 * obvious pathnames and then give up, and when it does give up
2838 * it will print the preferred pathname in the error messages.
2840 conf_set_str(conf, CONF_remote_cmd2,
2841 "test -x /usr/lib/sftp-server &&"
2842 " exec /usr/lib/sftp-server\n"
2843 "test -x /usr/local/lib/sftp-server &&"
2844 " exec /usr/local/lib/sftp-server\n"
2845 "exec sftp-server");
2846 conf_set_int(conf, CONF_ssh_subsys2, FALSE);
2848 back = &ssh_backend;
2850 err = back->init(NULL, &backhandle, conf,
2851 conf_get_str(conf, CONF_host),
2852 conf_get_int(conf, CONF_port),
2854 conf_get_int(conf, CONF_tcp_keepalives));
2856 fprintf(stderr, "ssh_init: %s\n", err);
2859 logctx = log_init(NULL, conf);
2860 back->provide_logctx(backhandle, logctx);
2861 console_provide_logctx(logctx);
2862 while (!back->sendok(backhandle)) {
2863 if (back->exitcode(backhandle) >= 0)
2865 if (ssh_sftp_loop_iteration() < 0) {
2866 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2870 if (verbose && realhost != NULL)
2871 printf("Connected to %s\n", realhost);
2872 if (realhost != NULL)
2877 void cmdline_error(char *p, ...)
2880 fprintf(stderr, "psftp: ");
2882 vfprintf(stderr, p, ap);
2884 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2889 * Main program. Parse arguments etc.
2891 int psftp_main(int argc, char *argv[])
2895 char *userhost, *user;
2898 char *batchfile = NULL;
2900 flags = FLAG_STDERR | FLAG_INTERACTIVE
2901 #ifdef FLAG_SYNCAGENT
2905 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2908 userhost = user = NULL;
2910 /* Load Default Settings before doing anything else. */
2912 do_defaults(NULL, conf);
2913 loaded_session = FALSE;
2915 for (i = 1; i < argc; i++) {
2917 if (argv[i][0] != '-') {
2921 userhost = dupstr(argv[i]);
2924 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, conf);
2926 cmdline_error("option \"%s\" requires an argument", argv[i]);
2927 } else if (ret == 2) {
2928 i++; /* skip next argument */
2929 } else if (ret == 1) {
2930 /* We have our own verbosity in addition to `flags'. */
2931 if (flags & FLAG_VERBOSE)
2933 } else if (strcmp(argv[i], "-h") == 0 ||
2934 strcmp(argv[i], "-?") == 0 ||
2935 strcmp(argv[i], "--help") == 0) {
2937 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2940 } else if (strcmp(argv[i], "-V") == 0 ||
2941 strcmp(argv[i], "--version") == 0) {
2943 } else if (strcmp(argv[i], "-batch") == 0) {
2944 console_batch_mode = 1;
2945 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2947 batchfile = argv[++i];
2948 } else if (strcmp(argv[i], "-bc") == 0) {
2949 modeflags = modeflags | 1;
2950 } else if (strcmp(argv[i], "-be") == 0) {
2951 modeflags = modeflags | 2;
2952 } else if (strcmp(argv[i], "--") == 0) {
2956 cmdline_error("unknown option \"%s\"", argv[i]);
2964 * If the loaded session provides a hostname, and a hostname has not
2965 * otherwise been specified, pop it in `userhost' so that
2966 * `psftp -load sessname' is sufficient to start a session.
2968 if (!userhost && conf_get_str(conf, CONF_host)[0] != '\0') {
2969 userhost = dupstr(conf_get_str(conf, CONF_host));
2973 * If a user@host string has already been provided, connect to
2978 ret = psftp_connect(userhost, user, portnumber);
2985 printf("psftp: no hostname specified; use \"open host.name\""
2989 do_sftp(mode, modeflags, batchfile);
2991 if (back != NULL && back->connected(backhandle)) {
2993 back->special(backhandle, TS_EOF);
2995 sftp_recvdata(&ch, 1);
3000 console_provide_logctx(NULL);