2 * psftp.c: front end for PSFTP.
11 #define PUTTY_DO_GLOBALS
20 * Since SFTP is a request-response oriented protocol, it requires
21 * no buffer management: when we send data, we stop and wait for an
22 * acknowledgement _anyway_, and so we can't possibly overfill our
26 static int psftp_connect(char *userhost, char *user, int portnumber);
27 static int do_sftp_init(void);
29 /* ----------------------------------------------------------------------
35 static void *backhandle;
38 /* ----------------------------------------------------------------------
39 * Higher-level helper functions used in commands.
43 * Attempt to canonify a pathname starting from the pwd. If
44 * canonification fails, at least fall back to returning a _valid_
45 * pathname (though it may be ugly, eg /home/simon/../foobar).
47 char *canonify(char *name)
49 char *fullname, *canonname;
50 struct sftp_packet *pktin;
51 struct sftp_request *req, *rreq;
54 fullname = dupstr(name);
57 if (pwd[strlen(pwd) - 1] == '/')
61 fullname = dupcat(pwd, slash, name, NULL);
64 sftp_register(req = fxp_realpath_send(fullname));
65 rreq = sftp_find_request(pktin = sftp_recv());
67 canonname = fxp_realpath_recv(pktin, rreq);
74 * Attempt number 2. Some FXP_REALPATH implementations
75 * (glibc-based ones, in particular) require the _whole_
76 * path to point to something that exists, whereas others
77 * (BSD-based) only require all but the last component to
78 * exist. So if the first call failed, we should strip off
79 * everything from the last slash onwards and try again,
80 * then put the final component back on.
84 * - if the last component is "/." or "/..", then we don't
85 * bother trying this because there's no way it can work.
87 * - if the thing actually ends with a "/", we remove it
88 * before we start. Except if the string is "/" itself
89 * (although I can't see why we'd have got here if so,
90 * because surely "/" would have worked the first
91 * time?), in which case we don't bother.
93 * - if there's no slash in the string at all, give up in
94 * confusion (we expect at least one because of the way
95 * we constructed the string).
101 i = strlen(fullname);
102 if (i > 2 && fullname[i - 1] == '/')
103 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
104 while (i > 0 && fullname[--i] != '/');
107 * Give up on special cases.
109 if (fullname[i] != '/' || /* no slash at all */
110 !strcmp(fullname + i, "/.") || /* ends in /. */
111 !strcmp(fullname + i, "/..") || /* ends in /.. */
112 !strcmp(fullname, "/")) {
117 * Now i points at the slash. Deal with the final special
118 * case i==0 (ie the whole path was "/nonexistentfile").
120 fullname[i] = '\0'; /* separate the string */
122 sftp_register(req = fxp_realpath_send("/"));
124 sftp_register(req = fxp_realpath_send(fullname));
126 rreq = sftp_find_request(pktin = sftp_recv());
128 canonname = fxp_realpath_recv(pktin, rreq);
131 return fullname; /* even that failed; give up */
134 * We have a canonical name for all but the last path
135 * component. Concatenate the last component and return.
137 returnname = dupcat(canonname,
138 canonname[strlen(canonname) - 1] ==
139 '/' ? "" : "/", fullname + i + 1, NULL);
147 * Return a pointer to the portion of str that comes after the last
148 * slash (or backslash or colon, if `local' is TRUE).
150 static char *stripslashes(char *str, int local)
155 p = strchr(str, ':');
159 p = strrchr(str, '/');
163 p = strrchr(str, '\\');
170 /* ----------------------------------------------------------------------
171 * Actual sftp commands.
173 struct sftp_command {
175 int nwords, wordssize;
176 int (*obey) (struct sftp_command *); /* returns <0 to quit */
179 int sftp_cmd_null(struct sftp_command *cmd)
181 return 1; /* success */
184 int sftp_cmd_unknown(struct sftp_command *cmd)
186 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
187 return 0; /* failure */
190 int sftp_cmd_quit(struct sftp_command *cmd)
196 * List a directory. If no arguments are given, list pwd; otherwise
197 * list the directory given in words[1].
199 static int sftp_ls_compare(const void *av, const void *bv)
201 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
202 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
203 return strcmp((*a)->filename, (*b)->filename);
205 int sftp_cmd_ls(struct sftp_command *cmd)
207 struct fxp_handle *dirh;
208 struct fxp_names *names;
209 struct fxp_name **ournames;
210 int nnames, namesize;
212 struct sftp_packet *pktin;
213 struct sftp_request *req, *rreq;
217 printf("psftp: not connected to a host; use \"open host.name\"\n");
226 cdir = canonify(dir);
228 printf("%s: %s\n", dir, fxp_error());
232 printf("Listing directory %s\n", cdir);
234 sftp_register(req = fxp_opendir_send(cdir));
235 rreq = sftp_find_request(pktin = sftp_recv());
237 dirh = fxp_opendir_recv(pktin, rreq);
240 printf("Unable to open %s: %s\n", dir, fxp_error());
242 nnames = namesize = 0;
247 sftp_register(req = fxp_readdir_send(dirh));
248 rreq = sftp_find_request(pktin = sftp_recv());
250 names = fxp_readdir_recv(pktin, rreq);
253 if (fxp_error_type() == SSH_FX_EOF)
255 printf("Reading directory %s: %s\n", dir, fxp_error());
258 if (names->nnames == 0) {
259 fxp_free_names(names);
263 if (nnames + names->nnames >= namesize) {
264 namesize += names->nnames + 128;
265 ournames = sresize(ournames, namesize, struct fxp_name *);
268 for (i = 0; i < names->nnames; i++)
269 ournames[nnames++] = fxp_dup_name(&names->names[i]);
271 fxp_free_names(names);
273 sftp_register(req = fxp_close_send(dirh));
274 rreq = sftp_find_request(pktin = sftp_recv());
276 fxp_close_recv(pktin, rreq);
279 * Now we have our filenames. Sort them by actual file
280 * name, and then output the longname parts.
282 qsort(ournames, nnames, sizeof(*ournames), sftp_ls_compare);
287 for (i = 0; i < nnames; i++) {
288 printf("%s\n", ournames[i]->longname);
289 fxp_free_name(ournames[i]);
300 * Change directories. We do this by canonifying the new name, then
301 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
303 int sftp_cmd_cd(struct sftp_command *cmd)
305 struct fxp_handle *dirh;
306 struct sftp_packet *pktin;
307 struct sftp_request *req, *rreq;
311 printf("psftp: not connected to a host; use \"open host.name\"\n");
316 dir = dupstr(homedir);
318 dir = canonify(cmd->words[1]);
321 printf("%s: %s\n", dir, fxp_error());
325 sftp_register(req = fxp_opendir_send(dir));
326 rreq = sftp_find_request(pktin = sftp_recv());
328 dirh = fxp_opendir_recv(pktin, rreq);
331 printf("Directory %s: %s\n", dir, fxp_error());
336 sftp_register(req = fxp_close_send(dirh));
337 rreq = sftp_find_request(pktin = sftp_recv());
339 fxp_close_recv(pktin, rreq);
343 printf("Remote directory is now %s\n", pwd);
349 * Print current directory. Easy as pie.
351 int sftp_cmd_pwd(struct sftp_command *cmd)
354 printf("psftp: not connected to a host; use \"open host.name\"\n");
358 printf("Remote directory is %s\n", pwd);
363 * Get a file and save it at the local end. We have two very
364 * similar commands here: `get' and `reget', which differ in that
365 * `reget' checks for the existence of the destination file and
366 * starts from where a previous aborted transfer left off.
368 int sftp_general_get(struct sftp_command *cmd, int restart)
370 struct fxp_handle *fh;
371 struct sftp_packet *pktin;
372 struct sftp_request *req, *rreq;
373 struct fxp_xfer *xfer;
374 char *fname, *outfname;
380 printf("psftp: not connected to a host; use \"open host.name\"\n");
384 if (cmd->nwords < 2) {
385 printf("get: expects a filename\n");
389 fname = canonify(cmd->words[1]);
391 printf("%s: %s\n", cmd->words[1], fxp_error());
394 outfname = (cmd->nwords == 2 ?
395 stripslashes(cmd->words[1], 0) : cmd->words[2]);
397 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
398 rreq = sftp_find_request(pktin = sftp_recv());
400 fh = fxp_open_recv(pktin, rreq);
403 printf("%s: %s\n", fname, fxp_error());
409 fp = fopen(outfname, "rb+");
411 fp = fopen(outfname, "wb");
415 printf("local: unable to open %s\n", outfname);
417 sftp_register(req = fxp_close_send(fh));
418 rreq = sftp_find_request(pktin = sftp_recv());
420 fxp_close_recv(pktin, rreq);
428 fseek(fp, 0L, SEEK_END);
430 printf("reget: restarting at file position %ld\n", posn);
431 offset = uint64_make(0, posn);
433 offset = uint64_make(0, 0);
436 printf("remote:%s => local:%s\n", fname, outfname);
439 * FIXME: we can use FXP_FSTAT here to get the file size, and
440 * thus put up a progress bar.
443 xfer = xfer_download_init(fh, offset);
444 while (!xfer_done(xfer)) {
449 xfer_download_queue(xfer);
451 ret = xfer_download_gotpkt(xfer, pktin);
454 printf("error while reading: %s\n", fxp_error());
458 while (xfer_download_data(xfer, &vbuf, &len)) {
459 unsigned char *buf = (unsigned char *)vbuf;
463 wlen = fwrite(buf + wpos, 1, len - wpos, fp);
465 printf("error while writing local file\n");
467 xfer_set_error(xfer);
471 if (wpos < len) { /* we had an error */
473 xfer_set_error(xfer);
484 sftp_register(req = fxp_close_send(fh));
485 rreq = sftp_find_request(pktin = sftp_recv());
487 fxp_close_recv(pktin, rreq);
493 int sftp_cmd_get(struct sftp_command *cmd)
495 return sftp_general_get(cmd, 0);
497 int sftp_cmd_reget(struct sftp_command *cmd)
499 return sftp_general_get(cmd, 1);
503 * Send a file and store it at the remote end. We have two very
504 * similar commands here: `put' and `reput', which differ in that
505 * `reput' checks for the existence of the destination file and
506 * starts from where a previous aborted transfer left off.
508 int sftp_general_put(struct sftp_command *cmd, int restart)
510 struct fxp_handle *fh;
511 struct fxp_xfer *xfer;
512 char *fname, *origoutfname, *outfname;
513 struct sftp_packet *pktin;
514 struct sftp_request *req, *rreq;
520 printf("psftp: not connected to a host; use \"open host.name\"\n");
524 if (cmd->nwords < 2) {
525 printf("put: expects a filename\n");
529 fname = cmd->words[1];
530 origoutfname = (cmd->nwords == 2 ?
531 stripslashes(cmd->words[1], 1) : cmd->words[2]);
532 outfname = canonify(origoutfname);
534 printf("%s: %s\n", origoutfname, fxp_error());
538 fp = fopen(fname, "rb");
540 printf("local: unable to open %s\n", fname);
545 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
547 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
548 SSH_FXF_CREAT | SSH_FXF_TRUNC));
550 rreq = sftp_find_request(pktin = sftp_recv());
552 fh = fxp_open_recv(pktin, rreq);
555 printf("%s: %s\n", outfname, fxp_error());
562 struct fxp_attrs attrs;
565 sftp_register(req = fxp_fstat_send(fh));
566 rreq = sftp_find_request(pktin = sftp_recv());
568 ret = fxp_fstat_recv(pktin, rreq, &attrs);
571 printf("read size of %s: %s\n", outfname, fxp_error());
575 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
576 printf("read size of %s: size was not given\n", outfname);
581 uint64_decimal(offset, decbuf);
582 printf("reput: restarting at file position %s\n", decbuf);
583 if (uint64_compare(offset, uint64_make(0, LONG_MAX)) > 0) {
584 printf("reput: remote file is larger than we can deal with\n");
588 if (fseek(fp, offset.lo, SEEK_SET) != 0)
589 fseek(fp, 0, SEEK_END); /* *shrug* */
591 offset = uint64_make(0, 0);
594 printf("local:%s => remote:%s\n", fname, outfname);
597 * FIXME: we can use FXP_FSTAT here to get the file size, and
598 * thus put up a progress bar.
601 xfer = xfer_upload_init(fh, offset);
603 while ((!err && !eof) || !xfer_done(xfer)) {
607 while (xfer_upload_ready(xfer) && !err && !eof) {
608 len = fread(buffer, 1, sizeof(buffer), fp);
610 printf("error while reading local file\n");
612 } else if (len == 0) {
615 xfer_upload_data(xfer, buffer, len);
619 if (!xfer_done(xfer)) {
621 ret = xfer_upload_gotpkt(xfer, pktin);
623 printf("error while writing: %s\n", fxp_error());
631 sftp_register(req = fxp_close_send(fh));
632 rreq = sftp_find_request(pktin = sftp_recv());
634 fxp_close_recv(pktin, rreq);
641 int sftp_cmd_put(struct sftp_command *cmd)
643 return sftp_general_put(cmd, 0);
645 int sftp_cmd_reput(struct sftp_command *cmd)
647 return sftp_general_put(cmd, 1);
650 int sftp_cmd_mkdir(struct sftp_command *cmd)
653 struct sftp_packet *pktin;
654 struct sftp_request *req, *rreq;
658 printf("psftp: not connected to a host; use \"open host.name\"\n");
662 if (cmd->nwords < 2) {
663 printf("mkdir: expects a directory\n");
667 dir = canonify(cmd->words[1]);
669 printf("%s: %s\n", dir, fxp_error());
673 sftp_register(req = fxp_mkdir_send(dir));
674 rreq = sftp_find_request(pktin = sftp_recv());
676 result = fxp_mkdir_recv(pktin, rreq);
679 printf("mkdir %s: %s\n", dir, fxp_error());
688 int sftp_cmd_rmdir(struct sftp_command *cmd)
691 struct sftp_packet *pktin;
692 struct sftp_request *req, *rreq;
696 printf("psftp: not connected to a host; use \"open host.name\"\n");
700 if (cmd->nwords < 2) {
701 printf("rmdir: expects a directory\n");
705 dir = canonify(cmd->words[1]);
707 printf("%s: %s\n", dir, fxp_error());
711 sftp_register(req = fxp_rmdir_send(dir));
712 rreq = sftp_find_request(pktin = sftp_recv());
714 result = fxp_rmdir_recv(pktin, rreq);
717 printf("rmdir %s: %s\n", dir, fxp_error());
726 int sftp_cmd_rm(struct sftp_command *cmd)
729 struct sftp_packet *pktin;
730 struct sftp_request *req, *rreq;
734 printf("psftp: not connected to a host; use \"open host.name\"\n");
738 if (cmd->nwords < 2) {
739 printf("rm: expects a filename\n");
743 fname = canonify(cmd->words[1]);
745 printf("%s: %s\n", fname, fxp_error());
749 sftp_register(req = fxp_remove_send(fname));
750 rreq = sftp_find_request(pktin = sftp_recv());
752 result = fxp_remove_recv(pktin, rreq);
755 printf("rm %s: %s\n", fname, fxp_error());
764 int sftp_cmd_mv(struct sftp_command *cmd)
766 char *srcfname, *dstfname;
767 struct sftp_packet *pktin;
768 struct sftp_request *req, *rreq;
772 printf("psftp: not connected to a host; use \"open host.name\"\n");
776 if (cmd->nwords < 3) {
777 printf("mv: expects two filenames\n");
780 srcfname = canonify(cmd->words[1]);
782 printf("%s: %s\n", srcfname, fxp_error());
786 dstfname = canonify(cmd->words[2]);
788 printf("%s: %s\n", dstfname, fxp_error());
792 sftp_register(req = fxp_rename_send(srcfname, dstfname));
793 rreq = sftp_find_request(pktin = sftp_recv());
795 result = fxp_rename_recv(pktin, rreq);
798 char const *error = fxp_error();
799 struct fxp_attrs attrs;
802 * The move might have failed because dstfname pointed at a
803 * directory. We check this possibility now: if dstfname
804 * _is_ a directory, we re-attempt the move by appending
805 * the basename of srcfname to dstfname.
807 sftp_register(req = fxp_stat_send(dstfname));
808 rreq = sftp_find_request(pktin = sftp_recv());
810 result = fxp_stat_recv(pktin, rreq, &attrs);
813 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
814 (attrs.permissions & 0040000)) {
816 char *newname, *newcanon;
817 printf("(destination %s is a directory)\n", dstfname);
818 p = srcfname + strlen(srcfname);
819 while (p > srcfname && p[-1] != '/') p--;
820 newname = dupcat(dstfname, "/", p, NULL);
821 newcanon = canonify(newname);
827 sftp_register(req = fxp_rename_send(srcfname, dstfname));
828 rreq = sftp_find_request(pktin = sftp_recv());
830 result = fxp_rename_recv(pktin, rreq);
832 error = result ? NULL : fxp_error();
836 printf("mv %s %s: %s\n", srcfname, dstfname, error);
842 printf("%s -> %s\n", srcfname, dstfname);
849 int sftp_cmd_chmod(struct sftp_command *cmd)
853 struct fxp_attrs attrs;
854 unsigned attrs_clr, attrs_xor, oldperms, newperms;
855 struct sftp_packet *pktin;
856 struct sftp_request *req, *rreq;
859 printf("psftp: not connected to a host; use \"open host.name\"\n");
863 if (cmd->nwords < 3) {
864 printf("chmod: expects a mode specifier and a filename\n");
869 * Attempt to parse the mode specifier in cmd->words[1]. We
870 * don't support the full horror of Unix chmod; instead we
871 * support a much simpler syntax in which the user can either
872 * specify an octal number, or a comma-separated sequence of
873 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
874 * _only_ be omitted if the only attribute mentioned is t,
875 * since all others require a user/group/other specification.
876 * Additionally, the s attribute may not be specified for any
877 * [ugoa] specifications other than exactly u or exactly g.
879 attrs_clr = attrs_xor = 0;
880 mode = cmd->words[1];
881 if (mode[0] >= '0' && mode[0] <= '9') {
882 if (mode[strspn(mode, "01234567")]) {
883 printf("chmod: numeric file modes should"
884 " contain digits 0-7 only\n");
888 sscanf(mode, "%o", &attrs_xor);
889 attrs_xor &= attrs_clr;
892 char *modebegin = mode;
893 unsigned subset, perms;
897 while (*mode && *mode != ',' &&
898 *mode != '+' && *mode != '-' && *mode != '=') {
900 case 'u': subset |= 04700; break; /* setuid, user perms */
901 case 'g': subset |= 02070; break; /* setgid, group perms */
902 case 'o': subset |= 00007; break; /* just other perms */
903 case 'a': subset |= 06777; break; /* all of the above */
905 printf("chmod: file mode '%.*s' contains unrecognised"
906 " user/group/other specifier '%c'\n",
907 (int)strcspn(modebegin, ","), modebegin, *mode);
912 if (!*mode || *mode == ',') {
913 printf("chmod: file mode '%.*s' is incomplete\n",
914 (int)strcspn(modebegin, ","), modebegin);
918 if (!*mode || *mode == ',') {
919 printf("chmod: file mode '%.*s' is incomplete\n",
920 (int)strcspn(modebegin, ","), modebegin);
924 while (*mode && *mode != ',') {
926 case 'r': perms |= 00444; break;
927 case 'w': perms |= 00222; break;
928 case 'x': perms |= 00111; break;
929 case 't': perms |= 01000; subset |= 01000; break;
931 if ((subset & 06777) != 04700 &&
932 (subset & 06777) != 02070) {
933 printf("chmod: file mode '%.*s': set[ug]id bit should"
934 " be used with exactly one of u or g only\n",
935 (int)strcspn(modebegin, ","), modebegin);
941 printf("chmod: file mode '%.*s' contains unrecognised"
942 " permission specifier '%c'\n",
943 (int)strcspn(modebegin, ","), modebegin, *mode);
948 if (!(subset & 06777) && (perms &~ subset)) {
949 printf("chmod: file mode '%.*s' contains no user/group/other"
950 " specifier and permissions other than 't' \n",
951 (int)strcspn(modebegin, ","), modebegin);
969 if (*mode) mode++; /* eat comma */
973 fname = canonify(cmd->words[2]);
975 printf("%s: %s\n", fname, fxp_error());
979 sftp_register(req = fxp_stat_send(fname));
980 rreq = sftp_find_request(pktin = sftp_recv());
982 result = fxp_stat_recv(pktin, rreq, &attrs);
984 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
985 printf("get attrs for %s: %s\n", fname,
986 result ? "file permissions not provided" : fxp_error());
991 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
992 oldperms = attrs.permissions & 07777;
993 attrs.permissions &= ~attrs_clr;
994 attrs.permissions ^= attrs_xor;
995 newperms = attrs.permissions & 07777;
997 sftp_register(req = fxp_setstat_send(fname, attrs));
998 rreq = sftp_find_request(pktin = sftp_recv());
1000 result = fxp_setstat_recv(pktin, rreq);
1003 printf("set attrs for %s: %s\n", fname, fxp_error());
1008 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1014 static int sftp_cmd_open(struct sftp_command *cmd)
1017 printf("psftp: already connected\n");
1021 if (cmd->nwords < 2) {
1022 printf("open: expects a host name\n");
1026 if (psftp_connect(cmd->words[1], NULL, 0)) {
1027 back = NULL; /* connection is already closed */
1028 return -1; /* this is fatal */
1034 static int sftp_cmd_lcd(struct sftp_command *cmd)
1036 char *currdir, *errmsg;
1038 if (cmd->nwords < 2) {
1039 printf("lcd: expects a local directory name\n");
1043 errmsg = psftp_lcd(cmd->words[1]);
1045 printf("lcd: unable to change directory: %s\n", errmsg);
1050 currdir = psftp_getcwd();
1051 printf("New local directory is %s\n", currdir);
1057 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1061 currdir = psftp_getcwd();
1062 printf("Current local directory is %s\n", currdir);
1068 static int sftp_cmd_pling(struct sftp_command *cmd)
1072 exitcode = system(cmd->words[1]);
1073 return (exitcode == 0);
1076 static int sftp_cmd_help(struct sftp_command *cmd);
1078 static struct sftp_cmd_lookup {
1081 * For help purposes, there are two kinds of command:
1083 * - primary commands, in which `longhelp' is non-NULL. In
1084 * this case `shorthelp' is descriptive text, and `longhelp'
1085 * is longer descriptive text intended to be printed after
1088 * - alias commands, in which `longhelp' is NULL. In this case
1089 * `shorthelp' is the name of a primary command, which
1090 * contains the help that should double up for this command.
1092 int listed; /* do we list this in primary help? */
1095 int (*obey) (struct sftp_command *);
1098 * List of sftp commands. This is binary-searched so it MUST be
1102 "!", TRUE, "run a local command",
1104 /* FIXME: this example is crap for non-Windows. */
1105 " Runs a local command. For example, \"!del myfile\".\n",
1109 "bye", TRUE, "finish your SFTP session",
1111 " Terminates your SFTP session and quits the PSFTP program.\n",
1115 "cd", TRUE, "change your remote working directory",
1116 " [ <New working directory> ]\n"
1117 " Change the remote working directory for your SFTP session.\n"
1118 " If a new working directory is not supplied, you will be\n"
1119 " returned to your home directory.\n",
1123 "chmod", TRUE, "change file permissions and modes",
1124 " ( <octal-digits> | <modifiers> ) <filename>\n"
1125 " Change the file permissions on a file or directory.\n"
1126 " <octal-digits> can be any octal Unix permission specifier.\n"
1127 " Alternatively, <modifiers> can include:\n"
1128 " u+r make file readable by owning user\n"
1129 " u+w make file writable by owning user\n"
1130 " u+x make file executable by owning user\n"
1131 " u-r make file not readable by owning user\n"
1132 " [also u-w, u-x]\n"
1133 " g+r make file readable by members of owning group\n"
1134 " [also g+w, g+x, g-r, g-w, g-x]\n"
1135 " o+r make file readable by all other users\n"
1136 " [also o+w, o+x, o-r, o-w, o-x]\n"
1137 " a+r make file readable by absolutely everybody\n"
1138 " [also a+w, a+x, a-r, a-w, a-x]\n"
1139 " u+s enable the Unix set-user-ID bit\n"
1140 " u-s disable the Unix set-user-ID bit\n"
1141 " g+s enable the Unix set-group-ID bit\n"
1142 " g-s disable the Unix set-group-ID bit\n"
1143 " +t enable the Unix \"sticky bit\"\n"
1144 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1145 " more than one user for the same modifier (\"ug+w\"). You can\n"
1146 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1150 "del", TRUE, "delete a file",
1152 " Delete a file.\n",
1156 "delete", FALSE, "del", NULL, sftp_cmd_rm
1159 "dir", TRUE, "list contents of a remote directory",
1160 " [ <directory-name> ]\n"
1161 " List the contents of a specified directory on the server.\n"
1162 " If <directory-name> is not given, the current working directory\n"
1163 " will be listed.\n",
1167 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1170 "get", TRUE, "download a file from the server to your local machine",
1171 " <filename> [ <local-filename> ]\n"
1172 " Downloads a file on the server and stores it locally under\n"
1173 " the same name, or under a different one if you supply the\n"
1174 " argument <local-filename>.\n",
1178 "help", TRUE, "give help",
1179 " [ <command> [ <command> ... ] ]\n"
1180 " Give general help if no commands are specified.\n"
1181 " If one or more commands are specified, give specific help on\n"
1182 " those particular commands.\n",
1186 "lcd", TRUE, "change local working directory",
1187 " <local-directory-name>\n"
1188 " Change the local working directory of the PSFTP program (the\n"
1189 " default location where the \"get\" command will save files).\n",
1193 "lpwd", TRUE, "print local working directory",
1195 " Print the local working directory of the PSFTP program (the\n"
1196 " default location where the \"get\" command will save files).\n",
1200 "ls", TRUE, "dir", NULL,
1204 "mkdir", TRUE, "create a directory on the remote server",
1205 " <directory-name>\n"
1206 " Creates a directory with the given name on the server.\n",
1210 "mv", TRUE, "move or rename a file on the remote server",
1211 " <source-filename> <destination-filename>\n"
1212 " Moves or renames the file <source-filename> on the server,\n"
1213 " so that it is accessible under the name <destination-filename>.\n",
1217 "open", TRUE, "connect to a host",
1218 " [<user>@]<hostname>\n"
1219 " Establishes an SFTP connection to a given host. Only usable\n"
1220 " when you did not already specify a host name on the command\n"
1225 "put", TRUE, "upload a file from your local machine to the server",
1226 " <filename> [ <remote-filename> ]\n"
1227 " Uploads a file to the server and stores it there under\n"
1228 " the same name, or under a different one if you supply the\n"
1229 " argument <remote-filename>.\n",
1233 "pwd", TRUE, "print your remote working directory",
1235 " Print the current remote working directory for your SFTP session.\n",
1239 "quit", TRUE, "bye", NULL,
1243 "reget", TRUE, "continue downloading a file",
1244 " <filename> [ <local-filename> ]\n"
1245 " Works exactly like the \"get\" command, but the local file\n"
1246 " must already exist. The download will begin at the end of the\n"
1247 " file. This is for resuming a download that was interrupted.\n",
1251 "ren", TRUE, "mv", NULL,
1255 "rename", FALSE, "mv", NULL,
1259 "reput", TRUE, "continue uploading a file",
1260 " <filename> [ <remote-filename> ]\n"
1261 " Works exactly like the \"put\" command, but the remote file\n"
1262 " must already exist. The upload will begin at the end of the\n"
1263 " file. This is for resuming an upload that was interrupted.\n",
1267 "rm", TRUE, "del", NULL,
1271 "rmdir", TRUE, "remove a directory on the remote server",
1272 " <directory-name>\n"
1273 " Removes the directory with the given name on the server.\n"
1274 " The directory will not be removed unless it is empty.\n",
1279 const struct sftp_cmd_lookup *lookup_command(char *name)
1284 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
1287 cmp = strcmp(name, sftp_lookup[k].name);
1293 return &sftp_lookup[k];
1299 static int sftp_cmd_help(struct sftp_command *cmd)
1302 if (cmd->nwords == 1) {
1304 * Give short help on each command.
1308 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1310 if (!sftp_lookup[i].listed)
1312 len = strlen(sftp_lookup[i].name);
1316 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1317 const struct sftp_cmd_lookup *lookup;
1318 if (!sftp_lookup[i].listed)
1320 lookup = &sftp_lookup[i];
1321 printf("%-*s", maxlen+2, lookup->name);
1322 if (lookup->longhelp == NULL)
1323 lookup = lookup_command(lookup->shorthelp);
1324 printf("%s\n", lookup->shorthelp);
1328 * Give long help on specific commands.
1330 for (i = 1; i < cmd->nwords; i++) {
1331 const struct sftp_cmd_lookup *lookup;
1332 lookup = lookup_command(cmd->words[i]);
1334 printf("help: %s: command not found\n", cmd->words[i]);
1336 printf("%s", lookup->name);
1337 if (lookup->longhelp == NULL)
1338 lookup = lookup_command(lookup->shorthelp);
1339 printf("%s", lookup->longhelp);
1346 /* ----------------------------------------------------------------------
1347 * Command line reading and parsing.
1349 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
1352 int linelen, linesize;
1353 struct sftp_command *cmd;
1357 if ((mode == 0) || (modeflags & 1)) {
1362 cmd = snew(struct sftp_command);
1368 linesize = linelen = 0;
1374 line = sresize(line, linesize, char);
1375 ret = fgets(line + linelen, linesize - linelen, fp);
1377 if (!ret || (linelen == 0 && line[0] == '\0')) {
1378 cmd->obey = sftp_cmd_quit;
1379 if ((mode == 0) || (modeflags & 1))
1381 return cmd; /* eof */
1383 len = linelen + strlen(line + linelen);
1385 if (line[linelen - 1] == '\n') {
1387 line[linelen] = '\0';
1391 if (modeflags & 1) {
1392 printf("%s\n", line);
1396 while (*p && (*p == ' ' || *p == '\t'))
1401 * Special case: the ! command. This is always parsed as
1402 * exactly two words: one containing the !, and the second
1403 * containing everything else on the line.
1405 cmd->nwords = cmd->wordssize = 2;
1406 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1407 cmd->words[0] = "!";
1408 cmd->words[1] = p+1;
1412 * Parse the command line into words. The syntax is:
1413 * - double quotes are removed, but cause spaces within to be
1414 * treated as non-separating.
1415 * - a double-doublequote pair is a literal double quote, inside
1416 * _or_ outside quotes. Like this:
1418 * firstword "second word" "this has ""quotes"" in" and""this""
1424 * >this has "quotes" in<
1428 /* skip whitespace */
1429 while (*p && (*p == ' ' || *p == '\t'))
1431 /* mark start of word */
1432 q = r = p; /* q sits at start, r writes word */
1435 if (!quoting && (*p == ' ' || *p == '\t'))
1436 break; /* reached end of word */
1437 else if (*p == '"' && p[1] == '"')
1438 p += 2, *r++ = '"'; /* a literal quote */
1440 p++, quoting = !quoting;
1445 p++; /* skip over the whitespace */
1447 if (cmd->nwords >= cmd->wordssize) {
1448 cmd->wordssize = cmd->nwords + 16;
1449 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1451 cmd->words[cmd->nwords++] = q;
1456 * Now parse the first word and assign a function.
1459 if (cmd->nwords == 0)
1460 cmd->obey = sftp_cmd_null;
1462 const struct sftp_cmd_lookup *lookup;
1463 lookup = lookup_command(cmd->words[0]);
1465 cmd->obey = sftp_cmd_unknown;
1467 cmd->obey = lookup->obey;
1473 static int do_sftp_init(void)
1475 struct sftp_packet *pktin;
1476 struct sftp_request *req, *rreq;
1479 * Do protocol initialisation.
1483 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
1484 return 1; /* failure */
1488 * Find out where our home directory is.
1490 sftp_register(req = fxp_realpath_send("."));
1491 rreq = sftp_find_request(pktin = sftp_recv());
1492 assert(rreq == req);
1493 homedir = fxp_realpath_recv(pktin, rreq);
1497 "Warning: failed to resolve home directory: %s\n",
1499 homedir = dupstr(".");
1501 printf("Remote working directory is %s\n", homedir);
1503 pwd = dupstr(homedir);
1507 void do_sftp(int mode, int modeflags, char *batchfile)
1517 /* ------------------------------------------------------------------
1518 * Now we're ready to do Real Stuff.
1521 struct sftp_command *cmd;
1522 cmd = sftp_getcmd(stdin, 0, 0);
1525 if (cmd->obey(cmd) < 0)
1529 fp = fopen(batchfile, "r");
1531 printf("Fatal: unable to open %s\n", batchfile);
1535 struct sftp_command *cmd;
1536 cmd = sftp_getcmd(fp, mode, modeflags);
1539 ret = cmd->obey(cmd);
1543 if (!(modeflags & 2))
1552 /* ----------------------------------------------------------------------
1553 * Dirty bits: integration with PuTTY.
1556 static int verbose = 0;
1559 * Print an error message and perform a fatal exit.
1561 void fatalbox(char *fmt, ...)
1566 str = dupvprintf(fmt, ap);
1567 str2 = dupcat("Fatal: ", str, "\n", NULL);
1570 fputs(str2, stderr);
1575 void modalfatalbox(char *fmt, ...)
1580 str = dupvprintf(fmt, ap);
1581 str2 = dupcat("Fatal: ", str, "\n", NULL);
1584 fputs(str2, stderr);
1589 void connection_fatal(void *frontend, char *fmt, ...)
1594 str = dupvprintf(fmt, ap);
1595 str2 = dupcat("Fatal: ", str, "\n", NULL);
1598 fputs(str2, stderr);
1604 void ldisc_send(void *handle, char *buf, int len, int interactive)
1607 * This is only here because of the calls to ldisc_send(NULL,
1608 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
1609 * ldisc as an ldisc. So if we get called with any real data, I
1610 * want to know about it.
1616 * In psftp, all agent requests should be synchronous, so this is a
1617 * never-called stub.
1619 void agent_schedule_callback(void (*callback)(void *, void *, int),
1620 void *callback_ctx, void *data, int len)
1622 assert(!"We shouldn't be here");
1626 * Receive a block of data from the SSH link. Block until all data
1629 * To do this, we repeatedly call the SSH protocol module, with our
1630 * own trap in from_backend() to catch the data that comes back. We
1631 * do this until we have enough data.
1634 static unsigned char *outptr; /* where to put the data */
1635 static unsigned outlen; /* how much data required */
1636 static unsigned char *pending = NULL; /* any spare data */
1637 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
1638 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
1640 unsigned char *p = (unsigned char *) data;
1641 unsigned len = (unsigned) datalen;
1644 * stderr data is just spouted to local stderr and otherwise
1649 fwrite(data, 1, len, stderr);
1654 * If this is before the real session begins, just return.
1659 if ((outlen > 0) && (len > 0)) {
1660 unsigned used = outlen;
1663 memcpy(outptr, p, used);
1671 if (pendsize < pendlen + len) {
1672 pendsize = pendlen + len + 4096;
1673 pending = sresize(pending, pendsize, unsigned char);
1675 memcpy(pending + pendlen, p, len);
1681 int sftp_recvdata(char *buf, int len)
1683 outptr = (unsigned char *) buf;
1687 * See if the pending-input block contains some of what we
1691 unsigned pendused = pendlen;
1692 if (pendused > outlen)
1694 memcpy(outptr, pending, pendused);
1695 memmove(pending, pending + pendused, pendlen - pendused);
1698 pendlen -= pendused;
1708 while (outlen > 0) {
1709 if (ssh_sftp_loop_iteration() < 0)
1710 return 0; /* doom */
1715 int sftp_senddata(char *buf, int len)
1717 back->send(backhandle, (unsigned char *) buf, len);
1722 * Short description of parameters.
1724 static void usage(void)
1726 printf("PuTTY Secure File Transfer (SFTP) client\n");
1727 printf("%s\n", ver);
1728 printf("Usage: psftp [options] user@host\n");
1729 printf("Options:\n");
1730 printf(" -b file use specified batchfile\n");
1731 printf(" -bc output batchfile commands\n");
1732 printf(" -be don't stop batchfile processing if errors\n");
1733 printf(" -v show verbose messages\n");
1734 printf(" -load sessname Load settings from saved session\n");
1735 printf(" -l user connect with specified username\n");
1736 printf(" -P port connect to specified port\n");
1737 printf(" -pw passw login with specified password\n");
1738 printf(" -1 -2 force use of particular SSH protocol version\n");
1739 printf(" -C enable compression\n");
1740 printf(" -i key private key file for authentication\n");
1741 printf(" -batch disable all interactive prompts\n");
1746 * Connect to a host.
1748 static int psftp_connect(char *userhost, char *user, int portnumber)
1750 char *host, *realhost;
1754 /* Separate host and username */
1756 host = strrchr(host, '@');
1762 printf("psftp: multiple usernames specified; using \"%s\"\n",
1768 /* Try to load settings for this host */
1769 do_defaults(host, &cfg);
1770 if (cfg.host[0] == '\0') {
1771 /* No settings for this host; use defaults */
1772 do_defaults(NULL, &cfg);
1773 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
1774 cfg.host[sizeof(cfg.host) - 1] = '\0';
1778 * Force use of SSH. (If they got the protocol wrong we assume the
1779 * port is useless too.)
1781 if (cfg.protocol != PROT_SSH) {
1782 cfg.protocol = PROT_SSH;
1787 * Enact command-line overrides.
1789 cmdline_run_saved(&cfg);
1792 * Trim leading whitespace off the hostname if it's there.
1795 int space = strspn(cfg.host, " \t");
1796 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
1799 /* See if host is of the form user@host */
1800 if (cfg.host[0] != '\0') {
1801 char *atsign = strchr(cfg.host, '@');
1802 /* Make sure we're not overflowing the user field */
1804 if (atsign - cfg.host < sizeof cfg.username) {
1805 strncpy(cfg.username, cfg.host, atsign - cfg.host);
1806 cfg.username[atsign - cfg.host] = '\0';
1808 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
1813 * Trim a colon suffix off the hostname if it's there.
1815 cfg.host[strcspn(cfg.host, ":")] = '\0';
1818 * Remove any remaining whitespace from the hostname.
1822 while (cfg.host[p2] != '\0') {
1823 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
1824 cfg.host[p1] = cfg.host[p2];
1829 cfg.host[p1] = '\0';
1833 if (user != NULL && user[0] != '\0') {
1834 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
1835 cfg.username[sizeof(cfg.username) - 1] = '\0';
1837 if (!cfg.username[0]) {
1838 printf("login as: ");
1840 if (!fgets(cfg.username, sizeof(cfg.username), stdin)) {
1841 fprintf(stderr, "psftp: aborting\n");
1844 int len = strlen(cfg.username);
1845 if (cfg.username[len - 1] == '\n')
1846 cfg.username[len - 1] = '\0';
1851 cfg.port = portnumber;
1853 /* SFTP uses SSH2 by default always */
1857 * Disable scary things which shouldn't be enabled for simple
1858 * things like SCP and SFTP: agent forwarding, port forwarding,
1861 cfg.x11_forward = 0;
1863 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
1865 /* Set up subsystem name. */
1866 strcpy(cfg.remote_cmd, "sftp");
1867 cfg.ssh_subsys = TRUE;
1871 * Set up fallback option, for SSH1 servers or servers with the
1872 * sftp subsystem not enabled but the server binary installed
1873 * in the usual place. We only support fallback on Unix
1874 * systems, and we use a kludgy piece of shellery which should
1875 * try to find sftp-server in various places (the obvious
1876 * systemwide spots /usr/lib and /usr/local/lib, and then the
1877 * user's PATH) and finally give up.
1879 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
1880 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
1883 * the idea being that this will attempt to use either of the
1884 * obvious pathnames and then give up, and when it does give up
1885 * it will print the preferred pathname in the error messages.
1887 cfg.remote_cmd_ptr2 =
1888 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
1889 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
1891 cfg.ssh_subsys2 = FALSE;
1893 back = &ssh_backend;
1895 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,0);
1897 fprintf(stderr, "ssh_init: %s\n", err);
1900 logctx = log_init(NULL, &cfg);
1901 back->provide_logctx(backhandle, logctx);
1902 console_provide_logctx(logctx);
1903 while (!back->sendok(backhandle)) {
1904 if (ssh_sftp_loop_iteration() < 0) {
1905 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
1909 if (verbose && realhost != NULL)
1910 printf("Connected to %s\n", realhost);
1914 void cmdline_error(char *p, ...)
1917 fprintf(stderr, "psftp: ");
1919 vfprintf(stderr, p, ap);
1921 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
1926 * Main program. Parse arguments etc.
1928 int psftp_main(int argc, char *argv[])
1932 char *userhost, *user;
1935 char *batchfile = NULL;
1938 flags = FLAG_STDERR | FLAG_INTERACTIVE
1939 #ifdef FLAG_SYNCAGENT
1943 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
1944 ssh_get_line = &console_get_line;
1947 userhost = user = NULL;
1950 for (i = 1; i < argc; i++) {
1952 if (argv[i][0] != '-') {
1956 userhost = dupstr(argv[i]);
1959 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
1961 cmdline_error("option \"%s\" requires an argument", argv[i]);
1962 } else if (ret == 2) {
1963 i++; /* skip next argument */
1964 } else if (ret == 1) {
1965 /* We have our own verbosity in addition to `flags'. */
1966 if (flags & FLAG_VERBOSE)
1968 } else if (strcmp(argv[i], "-h") == 0 ||
1969 strcmp(argv[i], "-?") == 0) {
1971 } else if (strcmp(argv[i], "-batch") == 0) {
1972 console_batch_mode = 1;
1973 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
1975 batchfile = argv[++i];
1976 } else if (strcmp(argv[i], "-bc") == 0) {
1977 modeflags = modeflags | 1;
1978 } else if (strcmp(argv[i], "-be") == 0) {
1979 modeflags = modeflags | 2;
1980 } else if (strcmp(argv[i], "--") == 0) {
1984 cmdline_error("unknown option \"%s\"", argv[i]);
1992 * If a user@host string has already been provided, connect to
1996 if (psftp_connect(userhost, user, portnumber))
2001 printf("psftp: no hostname specified; use \"open host.name\""
2005 do_sftp(mode, modeflags, batchfile);
2007 if (back != NULL && back->socket(backhandle) != NULL) {
2009 back->special(backhandle, TS_EOF);
2010 sftp_recvdata(&ch, 1);