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(const 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 * qsort comparison routine for fxp_name structures. Sorts by real
176 static int sftp_name_compare(const void *av, const void *bv)
178 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
179 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
180 return strcmp((*a)->filename, (*b)->filename);
184 * Likewise, but for a bare char *.
186 static int bare_name_compare(const void *av, const void *bv)
188 const char **a = (const char **) av;
189 const char **b = (const char **) bv;
190 return strcmp(*a, *b);
193 static void not_connected(void)
195 printf("psftp: not connected to a host; use \"open host.name\"\n");
198 /* ----------------------------------------------------------------------
199 * The meat of the `get' and `put' commands.
201 int sftp_get_file(char *fname, char *outfname, int recurse, int restart)
203 struct fxp_handle *fh;
204 struct sftp_packet *pktin;
205 struct sftp_request *req;
206 struct fxp_xfer *xfer;
209 int ret, shown_err = FALSE;
210 struct fxp_attrs attrs;
213 * In recursive mode, see if we're dealing with a directory.
214 * (If we're not in recursive mode, we need not even check: the
215 * subsequent FXP_OPEN will return a usable error message.)
220 req = fxp_stat_send(fname);
221 pktin = sftp_wait_for_reply(req);
222 result = fxp_stat_recv(pktin, req, &attrs);
225 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
226 (attrs.permissions & 0040000)) {
228 struct fxp_handle *dirhandle;
229 int nnames, namesize;
230 struct fxp_name **ournames;
231 struct fxp_names *names;
235 * First, attempt to create the destination directory,
236 * unless it already exists.
238 if (file_type(outfname) != FILE_TYPE_DIRECTORY &&
239 !create_directory(outfname)) {
240 printf("%s: Cannot create directory\n", outfname);
245 * Now get the list of filenames in the remote
248 req = fxp_opendir_send(fname);
249 pktin = sftp_wait_for_reply(req);
250 dirhandle = fxp_opendir_recv(pktin, req);
253 printf("%s: unable to open directory: %s\n",
257 nnames = namesize = 0;
262 req = fxp_readdir_send(dirhandle);
263 pktin = sftp_wait_for_reply(req);
264 names = fxp_readdir_recv(pktin, req);
267 if (fxp_error_type() == SSH_FX_EOF)
269 printf("%s: reading directory: %s\n", fname, fxp_error());
271 req = fxp_close_send(dirhandle);
272 pktin = sftp_wait_for_reply(req);
273 fxp_close_recv(pktin, req);
278 if (names->nnames == 0) {
279 fxp_free_names(names);
282 if (nnames + names->nnames >= namesize) {
283 namesize += names->nnames + 128;
284 ournames = sresize(ournames, namesize, struct fxp_name *);
286 for (i = 0; i < names->nnames; i++)
287 if (strcmp(names->names[i].filename, ".") &&
288 strcmp(names->names[i].filename, "..")) {
289 if (!vet_filename(names->names[i].filename)) {
290 printf("ignoring potentially dangerous server-"
291 "supplied filename '%s'\n",
292 names->names[i].filename);
295 fxp_dup_name(&names->names[i]);
298 fxp_free_names(names);
300 req = fxp_close_send(dirhandle);
301 pktin = sftp_wait_for_reply(req);
302 fxp_close_recv(pktin, req);
305 * Sort the names into a clear order. This ought to
306 * make things more predictable when we're doing a
307 * reget of the same directory, just in case two
308 * readdirs on the same remote directory return a
312 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
315 * If we're in restart mode, find the last filename on
316 * this list that already exists. We may have to do a
317 * reget on _that_ file, but shouldn't have to do
318 * anything on the previous files.
320 * If none of them exists, of course, we start at 0.
327 nextoutfname = dir_file_cat(outfname,
328 ournames[i]->filename);
329 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
340 * Now we're ready to recurse. Starting at ournames[i]
341 * and continuing on to the end of the list, we
342 * construct a new source and target file name, and
343 * call sftp_get_file again.
345 for (; i < nnames; i++) {
346 char *nextfname, *nextoutfname;
349 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
350 nextoutfname = dir_file_cat(outfname, ournames[i]->filename);
351 ret = sftp_get_file(nextfname, nextoutfname, recurse, restart);
352 restart = FALSE; /* after first partial file, do full */
356 for (i = 0; i < nnames; i++) {
357 fxp_free_name(ournames[i]);
365 * Done this recursion level. Free everything.
367 for (i = 0; i < nnames; i++) {
368 fxp_free_name(ournames[i]);
376 req = fxp_stat_send(fname);
377 pktin = sftp_wait_for_reply(req);
378 if (!fxp_stat_recv(pktin, req, &attrs))
381 req = fxp_open_send(fname, SSH_FXF_READ, NULL);
382 pktin = sftp_wait_for_reply(req);
383 fh = fxp_open_recv(pktin, req);
386 printf("%s: open for read: %s\n", fname, fxp_error());
391 file = open_existing_wfile(outfname, NULL);
393 file = open_new_file(outfname, GET_PERMISSIONS(attrs));
397 printf("local: unable to open %s\n", outfname);
399 req = fxp_close_send(fh);
400 pktin = sftp_wait_for_reply(req);
401 fxp_close_recv(pktin, req);
408 if (seek_file(file, uint64_make(0,0) , FROM_END) == -1) {
410 printf("reget: cannot restart %s - file too large\n",
412 req = fxp_close_send(fh);
413 pktin = sftp_wait_for_reply(req);
414 fxp_close_recv(pktin, req);
419 offset = get_file_posn(file);
420 uint64_decimal(offset, decbuf);
421 printf("reget: restarting at file position %s\n", decbuf);
423 offset = uint64_make(0, 0);
426 printf("remote:%s => local:%s\n", fname, outfname);
429 * FIXME: we can use FXP_FSTAT here to get the file size, and
430 * thus put up a progress bar.
433 xfer = xfer_download_init(fh, offset);
434 while (!xfer_done(xfer)) {
439 xfer_download_queue(xfer);
441 ret = xfer_download_gotpkt(xfer, pktin);
444 printf("error while reading: %s\n", fxp_error());
447 if (ret == INT_MIN) /* pktin not even freed */
452 while (xfer_download_data(xfer, &vbuf, &len)) {
453 unsigned char *buf = (unsigned char *)vbuf;
457 wlen = write_to_file(file, buf + wpos, len - wpos);
459 printf("error while writing local file\n");
461 xfer_set_error(xfer);
466 if (wpos < len) { /* we had an error */
468 xfer_set_error(xfer);
479 req = fxp_close_send(fh);
480 pktin = sftp_wait_for_reply(req);
481 fxp_close_recv(pktin, req);
486 int sftp_put_file(char *fname, char *outfname, int recurse, int restart)
488 struct fxp_handle *fh;
489 struct fxp_xfer *xfer;
490 struct sftp_packet *pktin;
491 struct sftp_request *req;
495 struct fxp_attrs attrs;
499 * In recursive mode, see if we're dealing with a directory.
500 * (If we're not in recursive mode, we need not even check: the
501 * subsequent fopen will return an error message.)
503 if (recurse && file_type(fname) == FILE_TYPE_DIRECTORY) {
505 int nnames, namesize;
506 char *name, **ournames;
511 * First, attempt to create the destination directory,
512 * unless it already exists.
514 req = fxp_stat_send(outfname);
515 pktin = sftp_wait_for_reply(req);
516 result = fxp_stat_recv(pktin, req, &attrs);
518 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
519 !(attrs.permissions & 0040000)) {
520 req = fxp_mkdir_send(outfname);
521 pktin = sftp_wait_for_reply(req);
522 result = fxp_mkdir_recv(pktin, req);
525 printf("%s: create directory: %s\n",
526 outfname, fxp_error());
532 * Now get the list of filenames in the local directory.
534 nnames = namesize = 0;
537 dh = open_directory(fname);
539 printf("%s: unable to open directory\n", fname);
542 while ((name = read_filename(dh)) != NULL) {
543 if (nnames >= namesize) {
545 ournames = sresize(ournames, namesize, char *);
547 ournames[nnames++] = name;
552 * Sort the names into a clear order. This ought to make
553 * things more predictable when we're doing a reput of the
554 * same directory, just in case two readdirs on the same
555 * local directory return a different order.
558 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
561 * If we're in restart mode, find the last filename on this
562 * list that already exists. We may have to do a reput on
563 * _that_ file, but shouldn't have to do anything on the
566 * If none of them exists, of course, we start at 0.
572 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
573 req = fxp_stat_send(nextoutfname);
574 pktin = sftp_wait_for_reply(req);
575 result = fxp_stat_recv(pktin, req, &attrs);
586 * Now we're ready to recurse. Starting at ournames[i]
587 * and continuing on to the end of the list, we
588 * construct a new source and target file name, and
589 * call sftp_put_file again.
591 for (; i < nnames; i++) {
592 char *nextfname, *nextoutfname;
595 nextfname = dir_file_cat(fname, ournames[i]);
596 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
597 ret = sftp_put_file(nextfname, nextoutfname, recurse, restart);
598 restart = FALSE; /* after first partial file, do full */
602 for (i = 0; i < nnames; i++) {
611 * Done this recursion level. Free everything.
613 for (i = 0; i < nnames; i++) {
621 file = open_existing_file(fname, NULL, NULL, NULL, &permissions);
623 printf("local: unable to open %s\n", fname);
627 PUT_PERMISSIONS(attrs, permissions);
629 req = fxp_open_send(outfname, SSH_FXF_WRITE, &attrs);
631 req = fxp_open_send(outfname,
632 SSH_FXF_WRITE | SSH_FXF_CREAT | SSH_FXF_TRUNC,
635 pktin = sftp_wait_for_reply(req);
636 fh = fxp_open_recv(pktin, req);
640 printf("%s: open for write: %s\n", outfname, fxp_error());
646 struct fxp_attrs attrs;
649 req = fxp_fstat_send(fh);
650 pktin = sftp_wait_for_reply(req);
651 ret = fxp_fstat_recv(pktin, req, &attrs);
654 printf("read size of %s: %s\n", outfname, fxp_error());
658 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
659 printf("read size of %s: size was not given\n", outfname);
664 uint64_decimal(offset, decbuf);
665 printf("reput: restarting at file position %s\n", decbuf);
667 if (seek_file((WFile *)file, offset, FROM_START) != 0)
668 seek_file((WFile *)file, uint64_make(0,0), FROM_END); /* *shrug* */
670 offset = uint64_make(0, 0);
673 printf("local:%s => remote:%s\n", fname, outfname);
676 * FIXME: we can use FXP_FSTAT here to get the file size, and
677 * thus put up a progress bar.
679 xfer = xfer_upload_init(fh, offset);
681 while ((!err && !eof) || !xfer_done(xfer)) {
685 while (xfer_upload_ready(xfer) && !err && !eof) {
686 len = read_from_file(file, buffer, sizeof(buffer));
688 printf("error while reading local file\n");
690 } else if (len == 0) {
693 xfer_upload_data(xfer, buffer, len);
697 if (!xfer_done(xfer)) {
699 ret = xfer_upload_gotpkt(xfer, pktin);
701 if (ret == INT_MIN) /* pktin not even freed */
704 printf("error while writing: %s\n", fxp_error());
714 req = fxp_close_send(fh);
715 pktin = sftp_wait_for_reply(req);
716 if (!fxp_close_recv(pktin, req)) {
718 printf("error while closing: %s", fxp_error());
725 return (err == 0) ? 1 : 0;
728 /* ----------------------------------------------------------------------
729 * A remote wildcard matcher, providing a similar interface to the
730 * local one in psftp.h.
733 typedef struct SftpWildcardMatcher {
734 struct fxp_handle *dirh;
735 struct fxp_names *names;
737 char *wildcard, *prefix;
738 } SftpWildcardMatcher;
740 SftpWildcardMatcher *sftp_begin_wildcard_matching(char *name)
742 struct sftp_packet *pktin;
743 struct sftp_request *req;
745 char *unwcdir, *tmpdir, *cdir;
747 SftpWildcardMatcher *swcm;
748 struct fxp_handle *dirh;
751 * We don't handle multi-level wildcards; so we expect to find
752 * a fully specified directory part, followed by a wildcard
755 wildcard = stripslashes(name, 0);
757 unwcdir = dupstr(name);
758 len = wildcard - name;
760 if (len > 0 && unwcdir[len-1] == '/')
761 unwcdir[len-1] = '\0';
762 tmpdir = snewn(1 + len, char);
763 check = wc_unescape(tmpdir, unwcdir);
767 printf("Multiple-level wildcards are not supported\n");
772 cdir = canonify(unwcdir);
774 req = fxp_opendir_send(cdir);
775 pktin = sftp_wait_for_reply(req);
776 dirh = fxp_opendir_recv(pktin, req);
779 swcm = snew(SftpWildcardMatcher);
782 swcm->wildcard = dupstr(wildcard);
783 swcm->prefix = unwcdir;
785 printf("Unable to open %s: %s\n", cdir, fxp_error());
795 char *sftp_wildcard_get_filename(SftpWildcardMatcher *swcm)
797 struct fxp_name *name;
798 struct sftp_packet *pktin;
799 struct sftp_request *req;
802 if (swcm->names && swcm->namepos >= swcm->names->nnames) {
803 fxp_free_names(swcm->names);
808 req = fxp_readdir_send(swcm->dirh);
809 pktin = sftp_wait_for_reply(req);
810 swcm->names = fxp_readdir_recv(pktin, req);
813 if (fxp_error_type() != SSH_FX_EOF)
814 printf("%s: reading directory: %s\n", swcm->prefix,
817 } else if (swcm->names->nnames == 0) {
819 * Another failure mode which we treat as EOF is if
820 * the server reports success from FXP_READDIR but
821 * returns no actual names. This is unusual, since
822 * from most servers you'd expect at least "." and
823 * "..", but there's nothing forbidding a server from
824 * omitting those if it wants to.
832 assert(swcm->names && swcm->namepos < swcm->names->nnames);
834 name = &swcm->names->names[swcm->namepos++];
836 if (!strcmp(name->filename, ".") || !strcmp(name->filename, ".."))
837 continue; /* expected bad filenames */
839 if (!vet_filename(name->filename)) {
840 printf("ignoring potentially dangerous server-"
841 "supplied filename '%s'\n", name->filename);
842 continue; /* unexpected bad filename */
845 if (!wc_match(swcm->wildcard, name->filename))
846 continue; /* doesn't match the wildcard */
849 * We have a working filename. Return it.
851 return dupprintf("%s%s%s", swcm->prefix,
853 swcm->prefix[strlen(swcm->prefix)-1]=='/' ?
859 void sftp_finish_wildcard_matching(SftpWildcardMatcher *swcm)
861 struct sftp_packet *pktin;
862 struct sftp_request *req;
864 req = fxp_close_send(swcm->dirh);
865 pktin = sftp_wait_for_reply(req);
866 fxp_close_recv(pktin, req);
869 fxp_free_names(swcm->names);
872 sfree(swcm->wildcard);
878 * General function to match a potential wildcard in a filename
879 * argument and iterate over every matching file. Used in several
880 * PSFTP commands (rmdir, rm, chmod, mv).
882 int wildcard_iterate(char *filename, int (*func)(void *, char *), void *ctx)
884 char *unwcfname, *newname, *cname;
887 unwcfname = snewn(strlen(filename)+1, char);
888 is_wc = !wc_unescape(unwcfname, filename);
891 SftpWildcardMatcher *swcm = sftp_begin_wildcard_matching(filename);
900 while ( (newname = sftp_wildcard_get_filename(swcm)) != NULL ) {
901 cname = canonify(newname);
903 printf("%s: canonify: %s\n", newname, fxp_error());
908 ret &= func(ctx, cname);
913 /* Politely warn the user that nothing matched. */
914 printf("%s: nothing matched\n", filename);
917 sftp_finish_wildcard_matching(swcm);
919 cname = canonify(unwcfname);
921 printf("%s: canonify: %s\n", filename, fxp_error());
924 ret = func(ctx, cname);
933 * Handy helper function.
935 int is_wildcard(char *name)
937 char *unwcfname = snewn(strlen(name)+1, char);
938 int is_wc = !wc_unescape(unwcfname, name);
943 /* ----------------------------------------------------------------------
944 * Actual sftp commands.
946 struct sftp_command {
948 int nwords, wordssize;
949 int (*obey) (struct sftp_command *); /* returns <0 to quit */
952 int sftp_cmd_null(struct sftp_command *cmd)
954 return 1; /* success */
957 int sftp_cmd_unknown(struct sftp_command *cmd)
959 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
960 return 0; /* failure */
963 int sftp_cmd_quit(struct sftp_command *cmd)
968 int sftp_cmd_close(struct sftp_command *cmd)
975 if (back != NULL && back->connected(backhandle)) {
977 back->special(backhandle, TS_EOF);
979 sftp_recvdata(&ch, 1);
987 * List a directory. If no arguments are given, list pwd; otherwise
988 * list the directory given in words[1].
990 int sftp_cmd_ls(struct sftp_command *cmd)
992 struct fxp_handle *dirh;
993 struct fxp_names *names;
994 struct fxp_name **ournames;
995 int nnames, namesize;
997 char *cdir, *unwcdir, *wildcard;
998 struct sftp_packet *pktin;
999 struct sftp_request *req;
1007 if (cmd->nwords < 2)
1010 dir = cmd->words[1];
1012 unwcdir = snewn(1 + strlen(dir), char);
1013 if (wc_unescape(unwcdir, dir)) {
1021 wildcard = stripslashes(dir, 0);
1022 unwcdir = dupstr(dir);
1023 len = wildcard - dir;
1024 unwcdir[len] = '\0';
1025 if (len > 0 && unwcdir[len-1] == '/')
1026 unwcdir[len-1] = '\0';
1027 tmpdir = snewn(1 + len, char);
1028 check = wc_unescape(tmpdir, unwcdir);
1031 printf("Multiple-level wildcards are not supported\n");
1038 cdir = canonify(dir);
1040 printf("%s: canonify: %s\n", dir, fxp_error());
1045 printf("Listing directory %s\n", cdir);
1047 req = fxp_opendir_send(cdir);
1048 pktin = sftp_wait_for_reply(req);
1049 dirh = fxp_opendir_recv(pktin, req);
1052 printf("Unable to open %s: %s\n", dir, fxp_error());
1055 nnames = namesize = 0;
1060 req = fxp_readdir_send(dirh);
1061 pktin = sftp_wait_for_reply(req);
1062 names = fxp_readdir_recv(pktin, req);
1064 if (names == NULL) {
1065 if (fxp_error_type() == SSH_FX_EOF)
1067 printf("Reading directory %s: %s\n", dir, fxp_error());
1070 if (names->nnames == 0) {
1071 fxp_free_names(names);
1075 if (nnames + names->nnames >= namesize) {
1076 namesize += names->nnames + 128;
1077 ournames = sresize(ournames, namesize, struct fxp_name *);
1080 for (i = 0; i < names->nnames; i++)
1081 if (!wildcard || wc_match(wildcard, names->names[i].filename))
1082 ournames[nnames++] = fxp_dup_name(&names->names[i]);
1084 fxp_free_names(names);
1086 req = fxp_close_send(dirh);
1087 pktin = sftp_wait_for_reply(req);
1088 fxp_close_recv(pktin, req);
1091 * Now we have our filenames. Sort them by actual file
1092 * name, and then output the longname parts.
1095 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
1100 for (i = 0; i < nnames; i++) {
1101 printf("%s\n", ournames[i]->longname);
1102 fxp_free_name(ournames[i]);
1114 * Change directories. We do this by canonifying the new name, then
1115 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1117 int sftp_cmd_cd(struct sftp_command *cmd)
1119 struct fxp_handle *dirh;
1120 struct sftp_packet *pktin;
1121 struct sftp_request *req;
1129 if (cmd->nwords < 2)
1130 dir = dupstr(homedir);
1132 dir = canonify(cmd->words[1]);
1135 printf("%s: canonify: %s\n", dir, fxp_error());
1139 req = fxp_opendir_send(dir);
1140 pktin = sftp_wait_for_reply(req);
1141 dirh = fxp_opendir_recv(pktin, req);
1144 printf("Directory %s: %s\n", dir, fxp_error());
1149 req = fxp_close_send(dirh);
1150 pktin = sftp_wait_for_reply(req);
1151 fxp_close_recv(pktin, req);
1155 printf("Remote directory is now %s\n", pwd);
1161 * Print current directory. Easy as pie.
1163 int sftp_cmd_pwd(struct sftp_command *cmd)
1170 printf("Remote directory is %s\n", pwd);
1175 * Get a file and save it at the local end. We have three very
1176 * similar commands here. The basic one is `get'; `reget' differs
1177 * in that it checks for the existence of the destination file and
1178 * starts from where a previous aborted transfer left off; `mget'
1179 * differs in that it interprets all its arguments as files to
1180 * transfer (never as a different local name for a remote file) and
1181 * can handle wildcards.
1183 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
1185 char *fname, *unwcfname, *origfname, *origwfname, *outfname;
1187 int recurse = FALSE;
1195 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1196 if (!strcmp(cmd->words[i], "--")) {
1197 /* finish processing options */
1200 } else if (!strcmp(cmd->words[i], "-r")) {
1203 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1209 if (i >= cmd->nwords) {
1210 printf("%s: expects a filename\n", cmd->words[0]);
1216 SftpWildcardMatcher *swcm;
1218 origfname = cmd->words[i++];
1219 unwcfname = snewn(strlen(origfname)+1, char);
1221 if (multiple && !wc_unescape(unwcfname, origfname)) {
1222 swcm = sftp_begin_wildcard_matching(origfname);
1227 origwfname = sftp_wildcard_get_filename(swcm);
1229 /* Politely warn the user that nothing matched. */
1230 printf("%s: nothing matched\n", origfname);
1231 sftp_finish_wildcard_matching(swcm);
1236 origwfname = origfname;
1240 while (origwfname) {
1241 fname = canonify(origwfname);
1244 sftp_finish_wildcard_matching(swcm);
1245 printf("%s: canonify: %s\n", origwfname, fxp_error());
1251 if (!multiple && i < cmd->nwords)
1252 outfname = cmd->words[i++];
1254 outfname = stripslashes(origwfname, 0);
1256 ret = sftp_get_file(fname, outfname, recurse, restart);
1262 origwfname = sftp_wildcard_get_filename(swcm);
1269 sftp_finish_wildcard_matching(swcm);
1273 } while (multiple && i < cmd->nwords);
1277 int sftp_cmd_get(struct sftp_command *cmd)
1279 return sftp_general_get(cmd, 0, 0);
1281 int sftp_cmd_mget(struct sftp_command *cmd)
1283 return sftp_general_get(cmd, 0, 1);
1285 int sftp_cmd_reget(struct sftp_command *cmd)
1287 return sftp_general_get(cmd, 1, 0);
1291 * Send a file and store it at the remote end. We have three very
1292 * similar commands here. The basic one is `put'; `reput' differs
1293 * in that it checks for the existence of the destination file and
1294 * starts from where a previous aborted transfer left off; `mput'
1295 * differs in that it interprets all its arguments as files to
1296 * transfer (never as a different remote name for a local file) and
1297 * can handle wildcards.
1299 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1301 char *fname, *wfname, *origoutfname, *outfname;
1303 int recurse = FALSE;
1311 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1312 if (!strcmp(cmd->words[i], "--")) {
1313 /* finish processing options */
1316 } else if (!strcmp(cmd->words[i], "-r")) {
1319 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1325 if (i >= cmd->nwords) {
1326 printf("%s: expects a filename\n", cmd->words[0]);
1332 WildcardMatcher *wcm;
1333 fname = cmd->words[i++];
1335 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1336 wcm = begin_wildcard_matching(fname);
1337 wfname = wildcard_get_filename(wcm);
1339 /* Politely warn the user that nothing matched. */
1340 printf("%s: nothing matched\n", fname);
1341 finish_wildcard_matching(wcm);
1350 if (!multiple && i < cmd->nwords)
1351 origoutfname = cmd->words[i++];
1353 origoutfname = stripslashes(wfname, 1);
1355 outfname = canonify(origoutfname);
1357 printf("%s: canonify: %s\n", origoutfname, fxp_error());
1360 finish_wildcard_matching(wcm);
1364 ret = sftp_put_file(wfname, outfname, recurse, restart);
1369 wfname = wildcard_get_filename(wcm);
1376 finish_wildcard_matching(wcm);
1381 } while (multiple && i < cmd->nwords);
1385 int sftp_cmd_put(struct sftp_command *cmd)
1387 return sftp_general_put(cmd, 0, 0);
1389 int sftp_cmd_mput(struct sftp_command *cmd)
1391 return sftp_general_put(cmd, 0, 1);
1393 int sftp_cmd_reput(struct sftp_command *cmd)
1395 return sftp_general_put(cmd, 1, 0);
1398 int sftp_cmd_mkdir(struct sftp_command *cmd)
1401 struct sftp_packet *pktin;
1402 struct sftp_request *req;
1411 if (cmd->nwords < 2) {
1412 printf("mkdir: expects a directory\n");
1417 for (i = 1; i < cmd->nwords; i++) {
1418 dir = canonify(cmd->words[i]);
1420 printf("%s: canonify: %s\n", dir, fxp_error());
1424 req = fxp_mkdir_send(dir);
1425 pktin = sftp_wait_for_reply(req);
1426 result = fxp_mkdir_recv(pktin, req);
1429 printf("mkdir %s: %s\n", dir, fxp_error());
1432 printf("mkdir %s: OK\n", dir);
1440 static int sftp_action_rmdir(void *vctx, char *dir)
1442 struct sftp_packet *pktin;
1443 struct sftp_request *req;
1446 req = fxp_rmdir_send(dir);
1447 pktin = sftp_wait_for_reply(req);
1448 result = fxp_rmdir_recv(pktin, req);
1451 printf("rmdir %s: %s\n", dir, fxp_error());
1455 printf("rmdir %s: OK\n", dir);
1460 int sftp_cmd_rmdir(struct sftp_command *cmd)
1469 if (cmd->nwords < 2) {
1470 printf("rmdir: expects a directory\n");
1475 for (i = 1; i < cmd->nwords; i++)
1476 ret &= wildcard_iterate(cmd->words[i], sftp_action_rmdir, NULL);
1481 static int sftp_action_rm(void *vctx, char *fname)
1483 struct sftp_packet *pktin;
1484 struct sftp_request *req;
1487 req = fxp_remove_send(fname);
1488 pktin = sftp_wait_for_reply(req);
1489 result = fxp_remove_recv(pktin, req);
1492 printf("rm %s: %s\n", fname, fxp_error());
1496 printf("rm %s: OK\n", fname);
1501 int sftp_cmd_rm(struct sftp_command *cmd)
1510 if (cmd->nwords < 2) {
1511 printf("rm: expects a filename\n");
1516 for (i = 1; i < cmd->nwords; i++)
1517 ret &= wildcard_iterate(cmd->words[i], sftp_action_rm, NULL);
1522 static int check_is_dir(char *dstfname)
1524 struct sftp_packet *pktin;
1525 struct sftp_request *req;
1526 struct fxp_attrs attrs;
1529 req = fxp_stat_send(dstfname);
1530 pktin = sftp_wait_for_reply(req);
1531 result = fxp_stat_recv(pktin, req, &attrs);
1534 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1535 (attrs.permissions & 0040000))
1541 struct sftp_context_mv {
1546 static int sftp_action_mv(void *vctx, char *srcfname)
1548 struct sftp_context_mv *ctx = (struct sftp_context_mv *)vctx;
1549 struct sftp_packet *pktin;
1550 struct sftp_request *req;
1552 char *finalfname, *newcanon = NULL;
1555 if (ctx->dest_is_dir) {
1559 p = srcfname + strlen(srcfname);
1560 while (p > srcfname && p[-1] != '/') p--;
1561 newname = dupcat(ctx->dstfname, "/", p, NULL);
1562 newcanon = canonify(newname);
1564 printf("%s: canonify: %s\n", newname, fxp_error());
1570 finalfname = newcanon;
1572 finalfname = ctx->dstfname;
1575 req = fxp_rename_send(srcfname, finalfname);
1576 pktin = sftp_wait_for_reply(req);
1577 result = fxp_rename_recv(pktin, req);
1579 error = result ? NULL : fxp_error();
1582 printf("mv %s %s: %s\n", srcfname, finalfname, error);
1585 printf("%s -> %s\n", srcfname, finalfname);
1593 int sftp_cmd_mv(struct sftp_command *cmd)
1595 struct sftp_context_mv actx, *ctx = &actx;
1603 if (cmd->nwords < 3) {
1604 printf("mv: expects two filenames\n");
1608 ctx->dstfname = canonify(cmd->words[cmd->nwords-1]);
1609 if (!ctx->dstfname) {
1610 printf("%s: canonify: %s\n", ctx->dstfname, fxp_error());
1615 * If there's more than one source argument, or one source
1616 * argument which is a wildcard, we _require_ that the
1617 * destination is a directory.
1619 ctx->dest_is_dir = check_is_dir(ctx->dstfname);
1620 if ((cmd->nwords > 3 || is_wildcard(cmd->words[1])) && !ctx->dest_is_dir) {
1621 printf("mv: multiple or wildcard arguments require the destination"
1622 " to be a directory\n");
1623 sfree(ctx->dstfname);
1628 * Now iterate over the source arguments.
1631 for (i = 1; i < cmd->nwords-1; i++)
1632 ret &= wildcard_iterate(cmd->words[i], sftp_action_mv, ctx);
1634 sfree(ctx->dstfname);
1638 struct sftp_context_chmod {
1639 unsigned attrs_clr, attrs_xor;
1642 static int sftp_action_chmod(void *vctx, char *fname)
1644 struct fxp_attrs attrs;
1645 struct sftp_packet *pktin;
1646 struct sftp_request *req;
1648 unsigned oldperms, newperms;
1649 struct sftp_context_chmod *ctx = (struct sftp_context_chmod *)vctx;
1651 req = fxp_stat_send(fname);
1652 pktin = sftp_wait_for_reply(req);
1653 result = fxp_stat_recv(pktin, req, &attrs);
1655 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1656 printf("get attrs for %s: %s\n", fname,
1657 result ? "file permissions not provided" : fxp_error());
1661 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1662 oldperms = attrs.permissions & 07777;
1663 attrs.permissions &= ~ctx->attrs_clr;
1664 attrs.permissions ^= ctx->attrs_xor;
1665 newperms = attrs.permissions & 07777;
1667 if (oldperms == newperms)
1668 return 1; /* no need to do anything! */
1670 req = fxp_setstat_send(fname, attrs);
1671 pktin = sftp_wait_for_reply(req);
1672 result = fxp_setstat_recv(pktin, req);
1675 printf("set attrs for %s: %s\n", fname, fxp_error());
1679 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1684 int sftp_cmd_chmod(struct sftp_command *cmd)
1688 struct sftp_context_chmod actx, *ctx = &actx;
1695 if (cmd->nwords < 3) {
1696 printf("chmod: expects a mode specifier and a filename\n");
1701 * Attempt to parse the mode specifier in cmd->words[1]. We
1702 * don't support the full horror of Unix chmod; instead we
1703 * support a much simpler syntax in which the user can either
1704 * specify an octal number, or a comma-separated sequence of
1705 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1706 * _only_ be omitted if the only attribute mentioned is t,
1707 * since all others require a user/group/other specification.
1708 * Additionally, the s attribute may not be specified for any
1709 * [ugoa] specifications other than exactly u or exactly g.
1711 ctx->attrs_clr = ctx->attrs_xor = 0;
1712 mode = cmd->words[1];
1713 if (mode[0] >= '0' && mode[0] <= '9') {
1714 if (mode[strspn(mode, "01234567")]) {
1715 printf("chmod: numeric file modes should"
1716 " contain digits 0-7 only\n");
1719 ctx->attrs_clr = 07777;
1720 sscanf(mode, "%o", &ctx->attrs_xor);
1721 ctx->attrs_xor &= ctx->attrs_clr;
1724 char *modebegin = mode;
1725 unsigned subset, perms;
1729 while (*mode && *mode != ',' &&
1730 *mode != '+' && *mode != '-' && *mode != '=') {
1732 case 'u': subset |= 04700; break; /* setuid, user perms */
1733 case 'g': subset |= 02070; break; /* setgid, group perms */
1734 case 'o': subset |= 00007; break; /* just other perms */
1735 case 'a': subset |= 06777; break; /* all of the above */
1737 printf("chmod: file mode '%.*s' contains unrecognised"
1738 " user/group/other specifier '%c'\n",
1739 (int)strcspn(modebegin, ","), modebegin, *mode);
1744 if (!*mode || *mode == ',') {
1745 printf("chmod: file mode '%.*s' is incomplete\n",
1746 (int)strcspn(modebegin, ","), modebegin);
1750 if (!*mode || *mode == ',') {
1751 printf("chmod: file mode '%.*s' is incomplete\n",
1752 (int)strcspn(modebegin, ","), modebegin);
1756 while (*mode && *mode != ',') {
1758 case 'r': perms |= 00444; break;
1759 case 'w': perms |= 00222; break;
1760 case 'x': perms |= 00111; break;
1761 case 't': perms |= 01000; subset |= 01000; break;
1763 if ((subset & 06777) != 04700 &&
1764 (subset & 06777) != 02070) {
1765 printf("chmod: file mode '%.*s': set[ug]id bit should"
1766 " be used with exactly one of u or g only\n",
1767 (int)strcspn(modebegin, ","), modebegin);
1773 printf("chmod: file mode '%.*s' contains unrecognised"
1774 " permission specifier '%c'\n",
1775 (int)strcspn(modebegin, ","), modebegin, *mode);
1780 if (!(subset & 06777) && (perms &~ subset)) {
1781 printf("chmod: file mode '%.*s' contains no user/group/other"
1782 " specifier and permissions other than 't' \n",
1783 (int)strcspn(modebegin, ","), modebegin);
1789 ctx->attrs_clr |= perms;
1790 ctx->attrs_xor |= perms;
1793 ctx->attrs_clr |= perms;
1794 ctx->attrs_xor &= ~perms;
1797 ctx->attrs_clr |= subset;
1798 ctx->attrs_xor |= perms;
1801 if (*mode) mode++; /* eat comma */
1806 for (i = 2; i < cmd->nwords; i++)
1807 ret &= wildcard_iterate(cmd->words[i], sftp_action_chmod, ctx);
1812 static int sftp_cmd_open(struct sftp_command *cmd)
1817 printf("psftp: already connected\n");
1821 if (cmd->nwords < 2) {
1822 printf("open: expects a host name\n");
1826 if (cmd->nwords > 2) {
1827 portnumber = atoi(cmd->words[2]);
1828 if (portnumber == 0) {
1829 printf("open: invalid port number\n");
1835 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1836 back = NULL; /* connection is already closed */
1837 return -1; /* this is fatal */
1843 static int sftp_cmd_lcd(struct sftp_command *cmd)
1845 char *currdir, *errmsg;
1847 if (cmd->nwords < 2) {
1848 printf("lcd: expects a local directory name\n");
1852 errmsg = psftp_lcd(cmd->words[1]);
1854 printf("lcd: unable to change directory: %s\n", errmsg);
1859 currdir = psftp_getcwd();
1860 printf("New local directory is %s\n", currdir);
1866 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1870 currdir = psftp_getcwd();
1871 printf("Current local directory is %s\n", currdir);
1877 static int sftp_cmd_pling(struct sftp_command *cmd)
1881 exitcode = system(cmd->words[1]);
1882 return (exitcode == 0);
1885 static int sftp_cmd_help(struct sftp_command *cmd);
1887 static struct sftp_cmd_lookup {
1890 * For help purposes, there are two kinds of command:
1892 * - primary commands, in which `longhelp' is non-NULL. In
1893 * this case `shorthelp' is descriptive text, and `longhelp'
1894 * is longer descriptive text intended to be printed after
1897 * - alias commands, in which `longhelp' is NULL. In this case
1898 * `shorthelp' is the name of a primary command, which
1899 * contains the help that should double up for this command.
1901 int listed; /* do we list this in primary help? */
1902 const char *shorthelp;
1903 const char *longhelp;
1904 int (*obey) (struct sftp_command *);
1907 * List of sftp commands. This is binary-searched so it MUST be
1911 "!", TRUE, "run a local command",
1913 /* FIXME: this example is crap for non-Windows. */
1914 " Runs a local command. For example, \"!del myfile\".\n",
1918 "bye", TRUE, "finish your SFTP session",
1920 " Terminates your SFTP session and quits the PSFTP program.\n",
1924 "cd", TRUE, "change your remote working directory",
1925 " [ <new working directory> ]\n"
1926 " Change the remote working directory for your SFTP session.\n"
1927 " If a new working directory is not supplied, you will be\n"
1928 " returned to your home directory.\n",
1932 "chmod", TRUE, "change file permissions and modes",
1933 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1934 " Change the file permissions on one or more remote files or\n"
1936 " <modes> can be any octal Unix permission specifier.\n"
1937 " Alternatively, <modes> can include the following modifiers:\n"
1938 " u+r make file readable by owning user\n"
1939 " u+w make file writable by owning user\n"
1940 " u+x make file executable by owning user\n"
1941 " u-r make file not readable by owning user\n"
1942 " [also u-w, u-x]\n"
1943 " g+r make file readable by members of owning group\n"
1944 " [also g+w, g+x, g-r, g-w, g-x]\n"
1945 " o+r make file readable by all other users\n"
1946 " [also o+w, o+x, o-r, o-w, o-x]\n"
1947 " a+r make file readable by absolutely everybody\n"
1948 " [also a+w, a+x, a-r, a-w, a-x]\n"
1949 " u+s enable the Unix set-user-ID bit\n"
1950 " u-s disable the Unix set-user-ID bit\n"
1951 " g+s enable the Unix set-group-ID bit\n"
1952 " g-s disable the Unix set-group-ID bit\n"
1953 " +t enable the Unix \"sticky bit\"\n"
1954 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1955 " more than one user for the same modifier (\"ug+w\"). You can\n"
1956 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1960 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1962 " Terminates your SFTP session, but does not quit the PSFTP\n"
1963 " program. You can then use \"open\" to start another SFTP\n"
1964 " session, to the same server or to a different one.\n",
1968 "del", TRUE, "delete files on the remote server",
1969 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1970 " Delete a file or files from the server.\n",
1974 "delete", FALSE, "del", NULL, sftp_cmd_rm
1977 "dir", TRUE, "list remote files",
1978 " [ <directory-name> ]/[ <wildcard> ]\n"
1979 " List the contents of a specified directory on the server.\n"
1980 " If <directory-name> is not given, the current working directory\n"
1982 " If <wildcard> is given, it is treated as a set of files to\n"
1983 " list; otherwise, all files are listed.\n",
1987 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1990 "get", TRUE, "download a file from the server to your local machine",
1991 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1992 " Downloads a file on the server and stores it locally under\n"
1993 " the same name, or under a different one if you supply the\n"
1994 " argument <local-filename>.\n"
1995 " If -r specified, recursively fetch a directory.\n",
1999 "help", TRUE, "give help",
2000 " [ <command> [ <command> ... ] ]\n"
2001 " Give general help if no commands are specified.\n"
2002 " If one or more commands are specified, give specific help on\n"
2003 " those particular commands.\n",
2007 "lcd", TRUE, "change local working directory",
2008 " <local-directory-name>\n"
2009 " Change the local working directory of the PSFTP program (the\n"
2010 " default location where the \"get\" command will save files).\n",
2014 "lpwd", TRUE, "print local working directory",
2016 " Print the local working directory of the PSFTP program (the\n"
2017 " default location where the \"get\" command will save files).\n",
2021 "ls", TRUE, "dir", NULL,
2025 "mget", TRUE, "download multiple files at once",
2026 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2027 " Downloads many files from the server, storing each one under\n"
2028 " the same name it has on the server side. You can use wildcards\n"
2029 " such as \"*.c\" to specify lots of files at once.\n"
2030 " If -r specified, recursively fetch files and directories.\n",
2034 "mkdir", TRUE, "create directories on the remote server",
2035 " <directory-name> [ <directory-name>... ]\n"
2036 " Creates directories with the given names on the server.\n",
2040 "mput", TRUE, "upload multiple files at once",
2041 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2042 " Uploads many files to the server, storing each one under the\n"
2043 " same name it has on the client side. You can use wildcards\n"
2044 " such as \"*.c\" to specify lots of files at once.\n"
2045 " If -r specified, recursively store files and directories.\n",
2049 "mv", TRUE, "move or rename file(s) on the remote server",
2050 " <source> [ <source>... ] <destination>\n"
2051 " Moves or renames <source>(s) on the server to <destination>,\n"
2052 " also on the server.\n"
2053 " If <destination> specifies an existing directory, then <source>\n"
2054 " may be a wildcard, and multiple <source>s may be given; all\n"
2055 " source files are moved into <destination>.\n"
2056 " Otherwise, <source> must specify a single file, which is moved\n"
2057 " or renamed so that it is accessible under the name <destination>.\n",
2061 "open", TRUE, "connect to a host",
2062 " [<user>@]<hostname> [<port>]\n"
2063 " Establishes an SFTP connection to a given host. Only usable\n"
2064 " when you are not already connected to a server.\n",
2068 "put", TRUE, "upload a file from your local machine to the server",
2069 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2070 " Uploads a file to the server and stores it there under\n"
2071 " the same name, or under a different one if you supply the\n"
2072 " argument <remote-filename>.\n"
2073 " If -r specified, recursively store a directory.\n",
2077 "pwd", TRUE, "print your remote working directory",
2079 " Print the current remote working directory for your SFTP session.\n",
2083 "quit", TRUE, "bye", NULL,
2087 "reget", TRUE, "continue downloading files",
2088 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2089 " Works exactly like the \"get\" command, but the local file\n"
2090 " must already exist. The download will begin at the end of the\n"
2091 " file. This is for resuming a download that was interrupted.\n"
2092 " If -r specified, resume interrupted \"get -r\".\n",
2096 "ren", TRUE, "mv", NULL,
2100 "rename", FALSE, "mv", NULL,
2104 "reput", TRUE, "continue uploading files",
2105 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2106 " Works exactly like the \"put\" command, but the remote file\n"
2107 " must already exist. The upload will begin at the end of the\n"
2108 " file. This is for resuming an upload that was interrupted.\n"
2109 " If -r specified, resume interrupted \"put -r\".\n",
2113 "rm", TRUE, "del", NULL,
2117 "rmdir", TRUE, "remove directories on the remote server",
2118 " <directory-name> [ <directory-name>... ]\n"
2119 " Removes the directory with the given name on the server.\n"
2120 " The directory will not be removed unless it is empty.\n"
2121 " Wildcards may be used to specify multiple directories.\n",
2126 const struct sftp_cmd_lookup *lookup_command(const char *name)
2131 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
2134 cmp = strcmp(name, sftp_lookup[k].name);
2140 return &sftp_lookup[k];
2146 static int sftp_cmd_help(struct sftp_command *cmd)
2149 if (cmd->nwords == 1) {
2151 * Give short help on each command.
2155 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2157 if (!sftp_lookup[i].listed)
2159 len = strlen(sftp_lookup[i].name);
2163 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
2164 const struct sftp_cmd_lookup *lookup;
2165 if (!sftp_lookup[i].listed)
2167 lookup = &sftp_lookup[i];
2168 printf("%-*s", maxlen+2, lookup->name);
2169 if (lookup->longhelp == NULL)
2170 lookup = lookup_command(lookup->shorthelp);
2171 printf("%s\n", lookup->shorthelp);
2175 * Give long help on specific commands.
2177 for (i = 1; i < cmd->nwords; i++) {
2178 const struct sftp_cmd_lookup *lookup;
2179 lookup = lookup_command(cmd->words[i]);
2181 printf("help: %s: command not found\n", cmd->words[i]);
2183 printf("%s", lookup->name);
2184 if (lookup->longhelp == NULL)
2185 lookup = lookup_command(lookup->shorthelp);
2186 printf("%s", lookup->longhelp);
2193 /* ----------------------------------------------------------------------
2194 * Command line reading and parsing.
2196 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
2199 struct sftp_command *cmd;
2203 cmd = snew(struct sftp_command);
2213 line = fgetline(fp);
2215 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
2218 if (!line || !*line) {
2219 cmd->obey = sftp_cmd_quit;
2220 if ((mode == 0) || (modeflags & 1))
2223 return cmd; /* eof */
2226 line[strcspn(line, "\r\n")] = '\0';
2228 if (modeflags & 1) {
2229 printf("%s\n", line);
2233 while (*p && (*p == ' ' || *p == '\t'))
2238 * Special case: the ! command. This is always parsed as
2239 * exactly two words: one containing the !, and the second
2240 * containing everything else on the line.
2242 cmd->nwords = cmd->wordssize = 2;
2243 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2244 cmd->words[0] = dupstr("!");
2245 cmd->words[1] = dupstr(p+1);
2246 } else if (*p == '#') {
2248 * Special case: comment. Entire line is ignored.
2250 cmd->nwords = cmd->wordssize = 0;
2254 * Parse the command line into words. The syntax is:
2255 * - double quotes are removed, but cause spaces within to be
2256 * treated as non-separating.
2257 * - a double-doublequote pair is a literal double quote, inside
2258 * _or_ outside quotes. Like this:
2260 * firstword "second word" "this has ""quotes"" in" and""this""
2266 * >this has "quotes" in<
2270 /* skip whitespace */
2271 while (*p && (*p == ' ' || *p == '\t'))
2273 /* terminate loop */
2276 /* mark start of word */
2277 q = r = p; /* q sits at start, r writes word */
2280 if (!quoting && (*p == ' ' || *p == '\t'))
2281 break; /* reached end of word */
2282 else if (*p == '"' && p[1] == '"')
2283 p += 2, *r++ = '"'; /* a literal quote */
2285 p++, quoting = !quoting;
2290 p++; /* skip over the whitespace */
2292 if (cmd->nwords >= cmd->wordssize) {
2293 cmd->wordssize = cmd->nwords + 16;
2294 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
2296 cmd->words[cmd->nwords++] = dupstr(q);
2303 * Now parse the first word and assign a function.
2306 if (cmd->nwords == 0)
2307 cmd->obey = sftp_cmd_null;
2309 const struct sftp_cmd_lookup *lookup;
2310 lookup = lookup_command(cmd->words[0]);
2312 cmd->obey = sftp_cmd_unknown;
2314 cmd->obey = lookup->obey;
2320 static int do_sftp_init(void)
2322 struct sftp_packet *pktin;
2323 struct sftp_request *req;
2326 * Do protocol initialisation.
2330 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2331 return 1; /* failure */
2335 * Find out where our home directory is.
2337 req = fxp_realpath_send(".");
2338 pktin = sftp_wait_for_reply(req);
2339 homedir = fxp_realpath_recv(pktin, req);
2343 "Warning: failed to resolve home directory: %s\n",
2345 homedir = dupstr(".");
2347 printf("Remote working directory is %s\n", homedir);
2349 pwd = dupstr(homedir);
2353 void do_sftp_cleanup()
2357 back->special(backhandle, TS_EOF);
2359 sftp_recvdata(&ch, 1);
2360 back->free(backhandle);
2361 sftp_cleanup_request();
2375 int do_sftp(int mode, int modeflags, char *batchfile)
2385 /* ------------------------------------------------------------------
2386 * Now we're ready to do Real Stuff.
2389 struct sftp_command *cmd;
2390 cmd = sftp_getcmd(NULL, 0, 0);
2393 ret = cmd->obey(cmd);
2396 for(i = 0; i < cmd->nwords; i++)
2397 sfree(cmd->words[i]);
2405 fp = fopen(batchfile, "r");
2407 printf("Fatal: unable to open %s\n", batchfile);
2412 struct sftp_command *cmd;
2413 cmd = sftp_getcmd(fp, mode, modeflags);
2416 ret = cmd->obey(cmd);
2420 if (!(modeflags & 2))
2426 * In batch mode, and if exit on command failure is enabled,
2427 * any command failure causes the whole of PSFTP to fail.
2429 if (ret == 0 && !(modeflags & 2)) return 2;
2434 /* ----------------------------------------------------------------------
2435 * Dirty bits: integration with PuTTY.
2438 static int verbose = 0;
2441 * Print an error message and perform a fatal exit.
2443 void fatalbox(const char *fmt, ...)
2448 str = dupvprintf(fmt, ap);
2449 str2 = dupcat("Fatal: ", str, "\n", NULL);
2452 fputs(str2, stderr);
2457 void modalfatalbox(const char *fmt, ...)
2462 str = dupvprintf(fmt, ap);
2463 str2 = dupcat("Fatal: ", str, "\n", NULL);
2466 fputs(str2, stderr);
2471 void nonfatal(const char *fmt, ...)
2476 str = dupvprintf(fmt, ap);
2477 str2 = dupcat("Error: ", str, "\n", NULL);
2480 fputs(str2, stderr);
2483 void connection_fatal(void *frontend, const char *fmt, ...)
2488 str = dupvprintf(fmt, ap);
2489 str2 = dupcat("Fatal: ", str, "\n", NULL);
2492 fputs(str2, stderr);
2498 void ldisc_echoedit_update(void *handle) { }
2501 * In psftp, all agent requests should be synchronous, so this is a
2502 * never-called stub.
2504 void agent_schedule_callback(void (*callback)(void *, void *, int),
2505 void *callback_ctx, void *data, int len)
2507 assert(!"We shouldn't be here");
2511 * Receive a block of data from the SSH link. Block until all data
2514 * To do this, we repeatedly call the SSH protocol module, with our
2515 * own trap in from_backend() to catch the data that comes back. We
2516 * do this until we have enough data.
2519 static unsigned char *outptr; /* where to put the data */
2520 static unsigned outlen; /* how much data required */
2521 static unsigned char *pending = NULL; /* any spare data */
2522 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2523 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2525 unsigned char *p = (unsigned char *) data;
2526 unsigned len = (unsigned) datalen;
2529 * stderr data is just spouted to local stderr and otherwise
2534 if (fwrite(data, 1, len, stderr) < len)
2540 * If this is before the real session begins, just return.
2545 if ((outlen > 0) && (len > 0)) {
2546 unsigned used = outlen;
2549 memcpy(outptr, p, used);
2557 if (pendsize < pendlen + len) {
2558 pendsize = pendlen + len + 4096;
2559 pending = sresize(pending, pendsize, unsigned char);
2561 memcpy(pending + pendlen, p, len);
2567 int from_backend_untrusted(void *frontend_handle, const char *data, int len)
2570 * No "untrusted" output should get here (the way the code is
2571 * currently, it's all diverted by FLAG_STDERR).
2573 assert(!"Unexpected call to from_backend_untrusted()");
2574 return 0; /* not reached */
2576 int from_backend_eof(void *frontend)
2579 * We expect to be the party deciding when to close the
2580 * connection, so if we see EOF before we sent it ourselves, we
2584 connection_fatal(frontend,
2585 "Received unexpected end-of-file from SFTP server");
2589 int sftp_recvdata(char *buf, int len)
2591 outptr = (unsigned char *) buf;
2595 * See if the pending-input block contains some of what we
2599 unsigned pendused = pendlen;
2600 if (pendused > outlen)
2602 memcpy(outptr, pending, pendused);
2603 memmove(pending, pending + pendused, pendlen - pendused);
2606 pendlen -= pendused;
2616 while (outlen > 0) {
2617 if (back->exitcode(backhandle) >= 0 || ssh_sftp_loop_iteration() < 0)
2618 return 0; /* doom */
2623 int sftp_senddata(char *buf, int len)
2625 back->send(backhandle, buf, len);
2628 int sftp_sendbuffer(void)
2630 return back->sendbuffer(backhandle);
2634 * Short description of parameters.
2636 static void usage(void)
2638 printf("PuTTY Secure File Transfer (SFTP) client\n");
2639 printf("%s\n", ver);
2640 printf("Usage: psftp [options] [user@]host\n");
2641 printf("Options:\n");
2642 printf(" -V print version information and exit\n");
2643 printf(" -pgpfp print PGP key fingerprints and exit\n");
2644 printf(" -b file use specified batchfile\n");
2645 printf(" -bc output batchfile commands\n");
2646 printf(" -be don't stop batchfile processing if errors\n");
2647 printf(" -v show verbose messages\n");
2648 printf(" -load sessname Load settings from saved session\n");
2649 printf(" -l user connect with specified username\n");
2650 printf(" -P port connect to specified port\n");
2651 printf(" -pw passw login with specified password\n");
2652 printf(" -1 -2 force use of particular SSH protocol version\n");
2653 printf(" -4 -6 force use of IPv4 or IPv6\n");
2654 printf(" -C enable compression\n");
2655 printf(" -i key private key file for user authentication\n");
2656 printf(" -noagent disable use of Pageant\n");
2657 printf(" -agent enable use of Pageant\n");
2658 printf(" -hostkey aa:bb:cc:...\n");
2659 printf(" manually specify a host key (may be repeated)\n");
2660 printf(" -batch disable all interactive prompts\n");
2661 printf(" -proxycmd command\n");
2662 printf(" use 'command' as local proxy\n");
2663 printf(" -sshlog file\n");
2664 printf(" -sshrawlog file\n");
2665 printf(" log protocol details to a file\n");
2669 static void version(void)
2671 char *buildinfo_text = buildinfo("\n");
2672 printf("psftp: %s\n%s\n", ver, buildinfo_text);
2673 sfree(buildinfo_text);
2678 * Connect to a host.
2680 static int psftp_connect(char *userhost, char *user, int portnumber)
2682 char *host, *realhost;
2686 /* Separate host and username */
2688 host = strrchr(host, '@');
2694 printf("psftp: multiple usernames specified; using \"%s\"\n",
2701 * If we haven't loaded session details already (e.g., from -load),
2702 * try looking for a session called "host".
2704 if (!loaded_session) {
2705 /* Try to load settings for `host' into a temporary config */
2706 Conf *conf2 = conf_new();
2707 conf_set_str(conf2, CONF_host, "");
2708 do_defaults(host, conf2);
2709 if (conf_get_str(conf2, CONF_host)[0] != '\0') {
2710 /* Settings present and include hostname */
2711 /* Re-load data into the real config. */
2712 do_defaults(host, conf);
2714 /* Session doesn't exist or mention a hostname. */
2715 /* Use `host' as a bare hostname. */
2716 conf_set_str(conf, CONF_host, host);
2720 /* Patch in hostname `host' to session details. */
2721 conf_set_str(conf, CONF_host, host);
2725 * Force use of SSH. (If they got the protocol wrong we assume the
2726 * port is useless too.)
2728 if (conf_get_int(conf, CONF_protocol) != PROT_SSH) {
2729 conf_set_int(conf, CONF_protocol, PROT_SSH);
2730 conf_set_int(conf, CONF_port, 22);
2734 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2735 * then change it to SSH-2, on the grounds that that's more likely to
2736 * work for SFTP. (Can be overridden with `-1' option.)
2737 * But if it says `2 only' or `2', respect which.
2739 if ((conf_get_int(conf, CONF_sshprot) & ~1) != 2) /* is it 2 or 3? */
2740 conf_set_int(conf, CONF_sshprot, 2);
2743 * Enact command-line overrides.
2745 cmdline_run_saved(conf);
2748 * Muck about with the hostname in various ways.
2751 char *hostbuf = dupstr(conf_get_str(conf, CONF_host));
2752 char *host = hostbuf;
2756 * Trim leading whitespace.
2758 host += strspn(host, " \t");
2761 * See if host is of the form user@host, and separate out
2762 * the username if so.
2764 if (host[0] != '\0') {
2765 char *atsign = strrchr(host, '@');
2768 conf_set_str(conf, CONF_username, host);
2774 * Remove any remaining whitespace.
2779 if (*q != ' ' && *q != '\t')
2785 conf_set_str(conf, CONF_host, hostbuf);
2790 if (user != NULL && user[0] != '\0') {
2791 conf_set_str(conf, CONF_username, user);
2795 conf_set_int(conf, CONF_port, portnumber);
2798 * Disable scary things which shouldn't be enabled for simple
2799 * things like SCP and SFTP: agent forwarding, port forwarding,
2802 conf_set_int(conf, CONF_x11_forward, 0);
2803 conf_set_int(conf, CONF_agentfwd, 0);
2804 conf_set_int(conf, CONF_ssh_simple, TRUE);
2807 while ((key = conf_get_str_nthstrkey(conf, CONF_portfwd, 0)) != NULL)
2808 conf_del_str_str(conf, CONF_portfwd, key);
2811 /* Set up subsystem name. */
2812 conf_set_str(conf, CONF_remote_cmd, "sftp");
2813 conf_set_int(conf, CONF_ssh_subsys, TRUE);
2814 conf_set_int(conf, CONF_nopty, TRUE);
2817 * Set up fallback option, for SSH-1 servers or servers with the
2818 * sftp subsystem not enabled but the server binary installed
2819 * in the usual place. We only support fallback on Unix
2820 * systems, and we use a kludgy piece of shellery which should
2821 * try to find sftp-server in various places (the obvious
2822 * systemwide spots /usr/lib and /usr/local/lib, and then the
2823 * user's PATH) and finally give up.
2825 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2826 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2829 * the idea being that this will attempt to use either of the
2830 * obvious pathnames and then give up, and when it does give up
2831 * it will print the preferred pathname in the error messages.
2833 conf_set_str(conf, CONF_remote_cmd2,
2834 "test -x /usr/lib/sftp-server &&"
2835 " exec /usr/lib/sftp-server\n"
2836 "test -x /usr/local/lib/sftp-server &&"
2837 " exec /usr/local/lib/sftp-server\n"
2838 "exec sftp-server");
2839 conf_set_int(conf, CONF_ssh_subsys2, FALSE);
2841 back = &ssh_backend;
2843 logctx = log_init(NULL, conf);
2844 console_provide_logctx(logctx);
2846 platform_psftp_pre_conn_setup();
2848 err = back->init(NULL, &backhandle, conf,
2849 conf_get_str(conf, CONF_host),
2850 conf_get_int(conf, CONF_port),
2852 conf_get_int(conf, CONF_tcp_keepalives));
2854 fprintf(stderr, "ssh_init: %s\n", err);
2857 back->provide_logctx(backhandle, logctx);
2858 while (!back->sendok(backhandle)) {
2859 if (back->exitcode(backhandle) >= 0)
2861 if (ssh_sftp_loop_iteration() < 0) {
2862 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2866 if (verbose && realhost != NULL)
2867 printf("Connected to %s\n", realhost);
2868 if (realhost != NULL)
2873 void cmdline_error(const char *p, ...)
2876 fprintf(stderr, "psftp: ");
2878 vfprintf(stderr, p, ap);
2880 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2884 const int share_can_be_downstream = TRUE;
2885 const int share_can_be_upstream = FALSE;
2888 * Main program. Parse arguments etc.
2890 int psftp_main(int argc, char *argv[])
2894 char *userhost, *user;
2897 char *batchfile = NULL;
2899 flags = FLAG_STDERR | FLAG_INTERACTIVE
2900 #ifdef FLAG_SYNCAGENT
2904 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2907 userhost = user = NULL;
2909 /* Load Default Settings before doing anything else. */
2911 do_defaults(NULL, conf);
2912 loaded_session = FALSE;
2914 for (i = 1; i < argc; i++) {
2916 if (argv[i][0] != '-') {
2920 userhost = dupstr(argv[i]);
2923 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, conf);
2925 cmdline_error("option \"%s\" requires an argument", argv[i]);
2926 } else if (ret == 2) {
2927 i++; /* skip next argument */
2928 } else if (ret == 1) {
2929 /* We have our own verbosity in addition to `flags'. */
2930 if (flags & FLAG_VERBOSE)
2932 } else if (strcmp(argv[i], "-h") == 0 ||
2933 strcmp(argv[i], "-?") == 0 ||
2934 strcmp(argv[i], "--help") == 0) {
2936 } else if (strcmp(argv[i], "-pgpfp") == 0) {
2939 } else if (strcmp(argv[i], "-V") == 0 ||
2940 strcmp(argv[i], "--version") == 0) {
2942 } else if (strcmp(argv[i], "-batch") == 0) {
2943 console_batch_mode = 1;
2944 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2946 batchfile = argv[++i];
2947 } else if (strcmp(argv[i], "-bc") == 0) {
2948 modeflags = modeflags | 1;
2949 } else if (strcmp(argv[i], "-be") == 0) {
2950 modeflags = modeflags | 2;
2951 } else if (strcmp(argv[i], "--") == 0) {
2955 cmdline_error("unknown option \"%s\"", argv[i]);
2963 * If the loaded session provides a hostname, and a hostname has not
2964 * otherwise been specified, pop it in `userhost' so that
2965 * `psftp -load sessname' is sufficient to start a session.
2967 if (!userhost && conf_get_str(conf, CONF_host)[0] != '\0') {
2968 userhost = dupstr(conf_get_str(conf, CONF_host));
2972 * If a user@host string has already been provided, connect to
2977 ret = psftp_connect(userhost, user, portnumber);
2984 printf("psftp: no hostname specified; use \"open host.name\""
2988 ret = do_sftp(mode, modeflags, batchfile);
2990 if (back != NULL && back->connected(backhandle)) {
2992 back->special(backhandle, TS_EOF);
2994 sftp_recvdata(&ch, 1);
2999 console_provide_logctx(NULL);