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);
620 ret = xfer_upload_gotpkt(xfer, pktin);
623 printf("error while writing: %s\n", fxp_error());
630 sftp_register(req = fxp_close_send(fh));
631 rreq = sftp_find_request(pktin = sftp_recv());
633 fxp_close_recv(pktin, rreq);
640 int sftp_cmd_put(struct sftp_command *cmd)
642 return sftp_general_put(cmd, 0);
644 int sftp_cmd_reput(struct sftp_command *cmd)
646 return sftp_general_put(cmd, 1);
649 int sftp_cmd_mkdir(struct sftp_command *cmd)
652 struct sftp_packet *pktin;
653 struct sftp_request *req, *rreq;
657 printf("psftp: not connected to a host; use \"open host.name\"\n");
661 if (cmd->nwords < 2) {
662 printf("mkdir: expects a directory\n");
666 dir = canonify(cmd->words[1]);
668 printf("%s: %s\n", dir, fxp_error());
672 sftp_register(req = fxp_mkdir_send(dir));
673 rreq = sftp_find_request(pktin = sftp_recv());
675 result = fxp_mkdir_recv(pktin, rreq);
678 printf("mkdir %s: %s\n", dir, fxp_error());
687 int sftp_cmd_rmdir(struct sftp_command *cmd)
690 struct sftp_packet *pktin;
691 struct sftp_request *req, *rreq;
695 printf("psftp: not connected to a host; use \"open host.name\"\n");
699 if (cmd->nwords < 2) {
700 printf("rmdir: expects a directory\n");
704 dir = canonify(cmd->words[1]);
706 printf("%s: %s\n", dir, fxp_error());
710 sftp_register(req = fxp_rmdir_send(dir));
711 rreq = sftp_find_request(pktin = sftp_recv());
713 result = fxp_rmdir_recv(pktin, rreq);
716 printf("rmdir %s: %s\n", dir, fxp_error());
725 int sftp_cmd_rm(struct sftp_command *cmd)
728 struct sftp_packet *pktin;
729 struct sftp_request *req, *rreq;
733 printf("psftp: not connected to a host; use \"open host.name\"\n");
737 if (cmd->nwords < 2) {
738 printf("rm: expects a filename\n");
742 fname = canonify(cmd->words[1]);
744 printf("%s: %s\n", fname, fxp_error());
748 sftp_register(req = fxp_remove_send(fname));
749 rreq = sftp_find_request(pktin = sftp_recv());
751 result = fxp_remove_recv(pktin, rreq);
754 printf("rm %s: %s\n", fname, fxp_error());
763 int sftp_cmd_mv(struct sftp_command *cmd)
765 char *srcfname, *dstfname;
766 struct sftp_packet *pktin;
767 struct sftp_request *req, *rreq;
771 printf("psftp: not connected to a host; use \"open host.name\"\n");
775 if (cmd->nwords < 3) {
776 printf("mv: expects two filenames\n");
779 srcfname = canonify(cmd->words[1]);
781 printf("%s: %s\n", srcfname, fxp_error());
785 dstfname = canonify(cmd->words[2]);
787 printf("%s: %s\n", dstfname, fxp_error());
791 sftp_register(req = fxp_rename_send(srcfname, dstfname));
792 rreq = sftp_find_request(pktin = sftp_recv());
794 result = fxp_rename_recv(pktin, rreq);
797 char const *error = fxp_error();
798 struct fxp_attrs attrs;
801 * The move might have failed because dstfname pointed at a
802 * directory. We check this possibility now: if dstfname
803 * _is_ a directory, we re-attempt the move by appending
804 * the basename of srcfname to dstfname.
806 sftp_register(req = fxp_stat_send(dstfname));
807 rreq = sftp_find_request(pktin = sftp_recv());
809 result = fxp_stat_recv(pktin, rreq, &attrs);
812 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
813 (attrs.permissions & 0040000)) {
815 char *newname, *newcanon;
816 printf("(destination %s is a directory)\n", dstfname);
817 p = srcfname + strlen(srcfname);
818 while (p > srcfname && p[-1] != '/') p--;
819 newname = dupcat(dstfname, "/", p, NULL);
820 newcanon = canonify(newname);
826 sftp_register(req = fxp_rename_send(srcfname, dstfname));
827 rreq = sftp_find_request(pktin = sftp_recv());
829 result = fxp_rename_recv(pktin, rreq);
831 error = result ? NULL : fxp_error();
835 printf("mv %s %s: %s\n", srcfname, dstfname, error);
841 printf("%s -> %s\n", srcfname, dstfname);
848 int sftp_cmd_chmod(struct sftp_command *cmd)
852 struct fxp_attrs attrs;
853 unsigned attrs_clr, attrs_xor, oldperms, newperms;
854 struct sftp_packet *pktin;
855 struct sftp_request *req, *rreq;
858 printf("psftp: not connected to a host; use \"open host.name\"\n");
862 if (cmd->nwords < 3) {
863 printf("chmod: expects a mode specifier and a filename\n");
868 * Attempt to parse the mode specifier in cmd->words[1]. We
869 * don't support the full horror of Unix chmod; instead we
870 * support a much simpler syntax in which the user can either
871 * specify an octal number, or a comma-separated sequence of
872 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
873 * _only_ be omitted if the only attribute mentioned is t,
874 * since all others require a user/group/other specification.
875 * Additionally, the s attribute may not be specified for any
876 * [ugoa] specifications other than exactly u or exactly g.
878 attrs_clr = attrs_xor = 0;
879 mode = cmd->words[1];
880 if (mode[0] >= '0' && mode[0] <= '9') {
881 if (mode[strspn(mode, "01234567")]) {
882 printf("chmod: numeric file modes should"
883 " contain digits 0-7 only\n");
887 sscanf(mode, "%o", &attrs_xor);
888 attrs_xor &= attrs_clr;
891 char *modebegin = mode;
892 unsigned subset, perms;
896 while (*mode && *mode != ',' &&
897 *mode != '+' && *mode != '-' && *mode != '=') {
899 case 'u': subset |= 04700; break; /* setuid, user perms */
900 case 'g': subset |= 02070; break; /* setgid, group perms */
901 case 'o': subset |= 00007; break; /* just other perms */
902 case 'a': subset |= 06777; break; /* all of the above */
904 printf("chmod: file mode '%.*s' contains unrecognised"
905 " user/group/other specifier '%c'\n",
906 (int)strcspn(modebegin, ","), modebegin, *mode);
911 if (!*mode || *mode == ',') {
912 printf("chmod: file mode '%.*s' is incomplete\n",
913 (int)strcspn(modebegin, ","), modebegin);
917 if (!*mode || *mode == ',') {
918 printf("chmod: file mode '%.*s' is incomplete\n",
919 (int)strcspn(modebegin, ","), modebegin);
923 while (*mode && *mode != ',') {
925 case 'r': perms |= 00444; break;
926 case 'w': perms |= 00222; break;
927 case 'x': perms |= 00111; break;
928 case 't': perms |= 01000; subset |= 01000; break;
930 if ((subset & 06777) != 04700 &&
931 (subset & 06777) != 02070) {
932 printf("chmod: file mode '%.*s': set[ug]id bit should"
933 " be used with exactly one of u or g only\n",
934 (int)strcspn(modebegin, ","), modebegin);
940 printf("chmod: file mode '%.*s' contains unrecognised"
941 " permission specifier '%c'\n",
942 (int)strcspn(modebegin, ","), modebegin, *mode);
947 if (!(subset & 06777) && (perms &~ subset)) {
948 printf("chmod: file mode '%.*s' contains no user/group/other"
949 " specifier and permissions other than 't' \n",
950 (int)strcspn(modebegin, ","), modebegin);
968 if (*mode) mode++; /* eat comma */
972 fname = canonify(cmd->words[2]);
974 printf("%s: %s\n", fname, fxp_error());
978 sftp_register(req = fxp_stat_send(fname));
979 rreq = sftp_find_request(pktin = sftp_recv());
981 result = fxp_stat_recv(pktin, rreq, &attrs);
983 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
984 printf("get attrs for %s: %s\n", fname,
985 result ? "file permissions not provided" : fxp_error());
990 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
991 oldperms = attrs.permissions & 07777;
992 attrs.permissions &= ~attrs_clr;
993 attrs.permissions ^= attrs_xor;
994 newperms = attrs.permissions & 07777;
996 sftp_register(req = fxp_setstat_send(fname, attrs));
997 rreq = sftp_find_request(pktin = sftp_recv());
999 result = fxp_setstat_recv(pktin, rreq);
1002 printf("set attrs for %s: %s\n", fname, fxp_error());
1007 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1013 static int sftp_cmd_open(struct sftp_command *cmd)
1016 printf("psftp: already connected\n");
1020 if (cmd->nwords < 2) {
1021 printf("open: expects a host name\n");
1025 if (psftp_connect(cmd->words[1], NULL, 0)) {
1026 back = NULL; /* connection is already closed */
1027 return -1; /* this is fatal */
1033 static int sftp_cmd_lcd(struct sftp_command *cmd)
1035 char *currdir, *errmsg;
1037 if (cmd->nwords < 2) {
1038 printf("lcd: expects a local directory name\n");
1042 errmsg = psftp_lcd(cmd->words[1]);
1044 printf("lcd: unable to change directory: %s\n", errmsg);
1049 currdir = psftp_getcwd();
1050 printf("New local directory is %s\n", currdir);
1056 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1060 currdir = psftp_getcwd();
1061 printf("Current local directory is %s\n", currdir);
1067 static int sftp_cmd_pling(struct sftp_command *cmd)
1071 exitcode = system(cmd->words[1]);
1072 return (exitcode == 0);
1075 static int sftp_cmd_help(struct sftp_command *cmd);
1077 static struct sftp_cmd_lookup {
1080 * For help purposes, there are two kinds of command:
1082 * - primary commands, in which `longhelp' is non-NULL. In
1083 * this case `shorthelp' is descriptive text, and `longhelp'
1084 * is longer descriptive text intended to be printed after
1087 * - alias commands, in which `longhelp' is NULL. In this case
1088 * `shorthelp' is the name of a primary command, which
1089 * contains the help that should double up for this command.
1091 int listed; /* do we list this in primary help? */
1094 int (*obey) (struct sftp_command *);
1097 * List of sftp commands. This is binary-searched so it MUST be
1101 "!", TRUE, "run a local command",
1103 /* FIXME: this example is crap for non-Windows. */
1104 " Runs a local command. For example, \"!del myfile\".\n",
1108 "bye", TRUE, "finish your SFTP session",
1110 " Terminates your SFTP session and quits the PSFTP program.\n",
1114 "cd", TRUE, "change your remote working directory",
1115 " [ <New working directory> ]\n"
1116 " Change the remote working directory for your SFTP session.\n"
1117 " If a new working directory is not supplied, you will be\n"
1118 " returned to your home directory.\n",
1122 "chmod", TRUE, "change file permissions and modes",
1123 " ( <octal-digits> | <modifiers> ) <filename>\n"
1124 " Change the file permissions on a file or directory.\n"
1125 " <octal-digits> can be any octal Unix permission specifier.\n"
1126 " Alternatively, <modifiers> can include:\n"
1127 " u+r make file readable by owning user\n"
1128 " u+w make file writable by owning user\n"
1129 " u+x make file executable by owning user\n"
1130 " u-r make file not readable by owning user\n"
1131 " [also u-w, u-x]\n"
1132 " g+r make file readable by members of owning group\n"
1133 " [also g+w, g+x, g-r, g-w, g-x]\n"
1134 " o+r make file readable by all other users\n"
1135 " [also o+w, o+x, o-r, o-w, o-x]\n"
1136 " a+r make file readable by absolutely everybody\n"
1137 " [also a+w, a+x, a-r, a-w, a-x]\n"
1138 " u+s enable the Unix set-user-ID bit\n"
1139 " u-s disable the Unix set-user-ID bit\n"
1140 " g+s enable the Unix set-group-ID bit\n"
1141 " g-s disable the Unix set-group-ID bit\n"
1142 " +t enable the Unix \"sticky bit\"\n"
1143 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1144 " more than one user for the same modifier (\"ug+w\"). You can\n"
1145 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1149 "del", TRUE, "delete a file",
1151 " Delete a file.\n",
1155 "delete", FALSE, "del", NULL, sftp_cmd_rm
1158 "dir", TRUE, "list contents of a remote directory",
1159 " [ <directory-name> ]\n"
1160 " List the contents of a specified directory on the server.\n"
1161 " If <directory-name> is not given, the current working directory\n"
1162 " will be listed.\n",
1166 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1169 "get", TRUE, "download a file from the server to your local machine",
1170 " <filename> [ <local-filename> ]\n"
1171 " Downloads a file on the server and stores it locally under\n"
1172 " the same name, or under a different one if you supply the\n"
1173 " argument <local-filename>.\n",
1177 "help", TRUE, "give help",
1178 " [ <command> [ <command> ... ] ]\n"
1179 " Give general help if no commands are specified.\n"
1180 " If one or more commands are specified, give specific help on\n"
1181 " those particular commands.\n",
1185 "lcd", TRUE, "change local working directory",
1186 " <local-directory-name>\n"
1187 " Change the local working directory of the PSFTP program (the\n"
1188 " default location where the \"get\" command will save files).\n",
1192 "lpwd", TRUE, "print local working directory",
1194 " Print the local working directory of the PSFTP program (the\n"
1195 " default location where the \"get\" command will save files).\n",
1199 "ls", TRUE, "dir", NULL,
1203 "mkdir", TRUE, "create a directory on the remote server",
1204 " <directory-name>\n"
1205 " Creates a directory with the given name on the server.\n",
1209 "mv", TRUE, "move or rename a file on the remote server",
1210 " <source-filename> <destination-filename>\n"
1211 " Moves or renames the file <source-filename> on the server,\n"
1212 " so that it is accessible under the name <destination-filename>.\n",
1216 "open", TRUE, "connect to a host",
1217 " [<user>@]<hostname>\n"
1218 " Establishes an SFTP connection to a given host. Only usable\n"
1219 " when you did not already specify a host name on the command\n"
1224 "put", TRUE, "upload a file from your local machine to the server",
1225 " <filename> [ <remote-filename> ]\n"
1226 " Uploads a file to the server and stores it there under\n"
1227 " the same name, or under a different one if you supply the\n"
1228 " argument <remote-filename>.\n",
1232 "pwd", TRUE, "print your remote working directory",
1234 " Print the current remote working directory for your SFTP session.\n",
1238 "quit", TRUE, "bye", NULL,
1242 "reget", TRUE, "continue downloading a file",
1243 " <filename> [ <local-filename> ]\n"
1244 " Works exactly like the \"get\" command, but the local file\n"
1245 " must already exist. The download will begin at the end of the\n"
1246 " file. This is for resuming a download that was interrupted.\n",
1250 "ren", TRUE, "mv", NULL,
1254 "rename", FALSE, "mv", NULL,
1258 "reput", TRUE, "continue uploading a file",
1259 " <filename> [ <remote-filename> ]\n"
1260 " Works exactly like the \"put\" command, but the remote file\n"
1261 " must already exist. The upload will begin at the end of the\n"
1262 " file. This is for resuming an upload that was interrupted.\n",
1266 "rm", TRUE, "del", NULL,
1270 "rmdir", TRUE, "remove a directory on the remote server",
1271 " <directory-name>\n"
1272 " Removes the directory with the given name on the server.\n"
1273 " The directory will not be removed unless it is empty.\n",
1278 const struct sftp_cmd_lookup *lookup_command(char *name)
1283 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
1286 cmp = strcmp(name, sftp_lookup[k].name);
1292 return &sftp_lookup[k];
1298 static int sftp_cmd_help(struct sftp_command *cmd)
1301 if (cmd->nwords == 1) {
1303 * Give short help on each command.
1307 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1309 if (!sftp_lookup[i].listed)
1311 len = strlen(sftp_lookup[i].name);
1315 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1316 const struct sftp_cmd_lookup *lookup;
1317 if (!sftp_lookup[i].listed)
1319 lookup = &sftp_lookup[i];
1320 printf("%-*s", maxlen+2, lookup->name);
1321 if (lookup->longhelp == NULL)
1322 lookup = lookup_command(lookup->shorthelp);
1323 printf("%s\n", lookup->shorthelp);
1327 * Give long help on specific commands.
1329 for (i = 1; i < cmd->nwords; i++) {
1330 const struct sftp_cmd_lookup *lookup;
1331 lookup = lookup_command(cmd->words[i]);
1333 printf("help: %s: command not found\n", cmd->words[i]);
1335 printf("%s", lookup->name);
1336 if (lookup->longhelp == NULL)
1337 lookup = lookup_command(lookup->shorthelp);
1338 printf("%s", lookup->longhelp);
1345 /* ----------------------------------------------------------------------
1346 * Command line reading and parsing.
1348 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
1351 int linelen, linesize;
1352 struct sftp_command *cmd;
1356 if ((mode == 0) || (modeflags & 1)) {
1361 cmd = snew(struct sftp_command);
1367 linesize = linelen = 0;
1373 line = sresize(line, linesize, char);
1374 ret = fgets(line + linelen, linesize - linelen, fp);
1376 if (!ret || (linelen == 0 && line[0] == '\0')) {
1377 cmd->obey = sftp_cmd_quit;
1378 if ((mode == 0) || (modeflags & 1))
1380 return cmd; /* eof */
1382 len = linelen + strlen(line + linelen);
1384 if (line[linelen - 1] == '\n') {
1386 line[linelen] = '\0';
1390 if (modeflags & 1) {
1391 printf("%s\n", line);
1395 while (*p && (*p == ' ' || *p == '\t'))
1400 * Special case: the ! command. This is always parsed as
1401 * exactly two words: one containing the !, and the second
1402 * containing everything else on the line.
1404 cmd->nwords = cmd->wordssize = 2;
1405 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1406 cmd->words[0] = "!";
1407 cmd->words[1] = p+1;
1411 * Parse the command line into words. The syntax is:
1412 * - double quotes are removed, but cause spaces within to be
1413 * treated as non-separating.
1414 * - a double-doublequote pair is a literal double quote, inside
1415 * _or_ outside quotes. Like this:
1417 * firstword "second word" "this has ""quotes"" in" and""this""
1423 * >this has "quotes" in<
1427 /* skip whitespace */
1428 while (*p && (*p == ' ' || *p == '\t'))
1430 /* mark start of word */
1431 q = r = p; /* q sits at start, r writes word */
1434 if (!quoting && (*p == ' ' || *p == '\t'))
1435 break; /* reached end of word */
1436 else if (*p == '"' && p[1] == '"')
1437 p += 2, *r++ = '"'; /* a literal quote */
1439 p++, quoting = !quoting;
1444 p++; /* skip over the whitespace */
1446 if (cmd->nwords >= cmd->wordssize) {
1447 cmd->wordssize = cmd->nwords + 16;
1448 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1450 cmd->words[cmd->nwords++] = q;
1455 * Now parse the first word and assign a function.
1458 if (cmd->nwords == 0)
1459 cmd->obey = sftp_cmd_null;
1461 const struct sftp_cmd_lookup *lookup;
1462 lookup = lookup_command(cmd->words[0]);
1464 cmd->obey = sftp_cmd_unknown;
1466 cmd->obey = lookup->obey;
1472 static int do_sftp_init(void)
1474 struct sftp_packet *pktin;
1475 struct sftp_request *req, *rreq;
1478 * Do protocol initialisation.
1482 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
1483 return 1; /* failure */
1487 * Find out where our home directory is.
1489 sftp_register(req = fxp_realpath_send("."));
1490 rreq = sftp_find_request(pktin = sftp_recv());
1491 assert(rreq == req);
1492 homedir = fxp_realpath_recv(pktin, rreq);
1496 "Warning: failed to resolve home directory: %s\n",
1498 homedir = dupstr(".");
1500 printf("Remote working directory is %s\n", homedir);
1502 pwd = dupstr(homedir);
1506 void do_sftp(int mode, int modeflags, char *batchfile)
1516 /* ------------------------------------------------------------------
1517 * Now we're ready to do Real Stuff.
1520 struct sftp_command *cmd;
1521 cmd = sftp_getcmd(stdin, 0, 0);
1524 if (cmd->obey(cmd) < 0)
1528 fp = fopen(batchfile, "r");
1530 printf("Fatal: unable to open %s\n", batchfile);
1534 struct sftp_command *cmd;
1535 cmd = sftp_getcmd(fp, mode, modeflags);
1538 ret = cmd->obey(cmd);
1542 if (!(modeflags & 2))
1551 /* ----------------------------------------------------------------------
1552 * Dirty bits: integration with PuTTY.
1555 static int verbose = 0;
1558 * Print an error message and perform a fatal exit.
1560 void fatalbox(char *fmt, ...)
1565 str = dupvprintf(fmt, ap);
1566 str2 = dupcat("Fatal: ", str, "\n", NULL);
1569 fputs(str2, stderr);
1574 void modalfatalbox(char *fmt, ...)
1579 str = dupvprintf(fmt, ap);
1580 str2 = dupcat("Fatal: ", str, "\n", NULL);
1583 fputs(str2, stderr);
1588 void connection_fatal(void *frontend, char *fmt, ...)
1593 str = dupvprintf(fmt, ap);
1594 str2 = dupcat("Fatal: ", str, "\n", NULL);
1597 fputs(str2, stderr);
1603 void ldisc_send(void *handle, char *buf, int len, int interactive)
1606 * This is only here because of the calls to ldisc_send(NULL,
1607 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
1608 * ldisc as an ldisc. So if we get called with any real data, I
1609 * want to know about it.
1615 * In psftp, all agent requests should be synchronous, so this is a
1616 * never-called stub.
1618 void agent_schedule_callback(void (*callback)(void *, void *, int),
1619 void *callback_ctx, void *data, int len)
1621 assert(!"We shouldn't be here");
1625 * Receive a block of data from the SSH link. Block until all data
1628 * To do this, we repeatedly call the SSH protocol module, with our
1629 * own trap in from_backend() to catch the data that comes back. We
1630 * do this until we have enough data.
1633 static unsigned char *outptr; /* where to put the data */
1634 static unsigned outlen; /* how much data required */
1635 static unsigned char *pending = NULL; /* any spare data */
1636 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
1637 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
1639 unsigned char *p = (unsigned char *) data;
1640 unsigned len = (unsigned) datalen;
1643 * stderr data is just spouted to local stderr and otherwise
1648 fwrite(data, 1, len, stderr);
1653 * If this is before the real session begins, just return.
1658 if ((outlen > 0) && (len > 0)) {
1659 unsigned used = outlen;
1662 memcpy(outptr, p, used);
1670 if (pendsize < pendlen + len) {
1671 pendsize = pendlen + len + 4096;
1672 pending = sresize(pending, pendsize, unsigned char);
1674 memcpy(pending + pendlen, p, len);
1680 int sftp_recvdata(char *buf, int len)
1682 outptr = (unsigned char *) buf;
1686 * See if the pending-input block contains some of what we
1690 unsigned pendused = pendlen;
1691 if (pendused > outlen)
1693 memcpy(outptr, pending, pendused);
1694 memmove(pending, pending + pendused, pendlen - pendused);
1697 pendlen -= pendused;
1707 while (outlen > 0) {
1708 if (ssh_sftp_loop_iteration() < 0)
1709 return 0; /* doom */
1714 int sftp_senddata(char *buf, int len)
1716 back->send(backhandle, (unsigned char *) buf, len);
1721 * Short description of parameters.
1723 static void usage(void)
1725 printf("PuTTY Secure File Transfer (SFTP) client\n");
1726 printf("%s\n", ver);
1727 printf("Usage: psftp [options] user@host\n");
1728 printf("Options:\n");
1729 printf(" -b file use specified batchfile\n");
1730 printf(" -bc output batchfile commands\n");
1731 printf(" -be don't stop batchfile processing if errors\n");
1732 printf(" -v show verbose messages\n");
1733 printf(" -load sessname Load settings from saved session\n");
1734 printf(" -l user connect with specified username\n");
1735 printf(" -P port connect to specified port\n");
1736 printf(" -pw passw login with specified password\n");
1737 printf(" -1 -2 force use of particular SSH protocol version\n");
1738 printf(" -C enable compression\n");
1739 printf(" -i key private key file for authentication\n");
1740 printf(" -batch disable all interactive prompts\n");
1745 * Connect to a host.
1747 static int psftp_connect(char *userhost, char *user, int portnumber)
1749 char *host, *realhost;
1753 /* Separate host and username */
1755 host = strrchr(host, '@');
1761 printf("psftp: multiple usernames specified; using \"%s\"\n",
1767 /* Try to load settings for this host */
1768 do_defaults(host, &cfg);
1769 if (cfg.host[0] == '\0') {
1770 /* No settings for this host; use defaults */
1771 do_defaults(NULL, &cfg);
1772 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
1773 cfg.host[sizeof(cfg.host) - 1] = '\0';
1777 * Force use of SSH. (If they got the protocol wrong we assume the
1778 * port is useless too.)
1780 if (cfg.protocol != PROT_SSH) {
1781 cfg.protocol = PROT_SSH;
1786 * Enact command-line overrides.
1788 cmdline_run_saved(&cfg);
1791 * Trim leading whitespace off the hostname if it's there.
1794 int space = strspn(cfg.host, " \t");
1795 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
1798 /* See if host is of the form user@host */
1799 if (cfg.host[0] != '\0') {
1800 char *atsign = strchr(cfg.host, '@');
1801 /* Make sure we're not overflowing the user field */
1803 if (atsign - cfg.host < sizeof cfg.username) {
1804 strncpy(cfg.username, cfg.host, atsign - cfg.host);
1805 cfg.username[atsign - cfg.host] = '\0';
1807 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
1812 * Trim a colon suffix off the hostname if it's there.
1814 cfg.host[strcspn(cfg.host, ":")] = '\0';
1817 * Remove any remaining whitespace from the hostname.
1821 while (cfg.host[p2] != '\0') {
1822 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
1823 cfg.host[p1] = cfg.host[p2];
1828 cfg.host[p1] = '\0';
1832 if (user != NULL && user[0] != '\0') {
1833 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
1834 cfg.username[sizeof(cfg.username) - 1] = '\0';
1836 if (!cfg.username[0]) {
1837 printf("login as: ");
1839 if (!fgets(cfg.username, sizeof(cfg.username), stdin)) {
1840 fprintf(stderr, "psftp: aborting\n");
1843 int len = strlen(cfg.username);
1844 if (cfg.username[len - 1] == '\n')
1845 cfg.username[len - 1] = '\0';
1850 cfg.port = portnumber;
1852 /* SFTP uses SSH2 by default always */
1856 * Disable scary things which shouldn't be enabled for simple
1857 * things like SCP and SFTP: agent forwarding, port forwarding,
1860 cfg.x11_forward = 0;
1862 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
1864 /* Set up subsystem name. */
1865 strcpy(cfg.remote_cmd, "sftp");
1866 cfg.ssh_subsys = TRUE;
1870 * Set up fallback option, for SSH1 servers or servers with the
1871 * sftp subsystem not enabled but the server binary installed
1872 * in the usual place. We only support fallback on Unix
1873 * systems, and we use a kludgy piece of shellery which should
1874 * try to find sftp-server in various places (the obvious
1875 * systemwide spots /usr/lib and /usr/local/lib, and then the
1876 * user's PATH) and finally give up.
1878 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
1879 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
1882 * the idea being that this will attempt to use either of the
1883 * obvious pathnames and then give up, and when it does give up
1884 * it will print the preferred pathname in the error messages.
1886 cfg.remote_cmd_ptr2 =
1887 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
1888 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
1890 cfg.ssh_subsys2 = FALSE;
1892 back = &ssh_backend;
1894 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,0);
1896 fprintf(stderr, "ssh_init: %s\n", err);
1899 logctx = log_init(NULL, &cfg);
1900 back->provide_logctx(backhandle, logctx);
1901 console_provide_logctx(logctx);
1902 while (!back->sendok(backhandle)) {
1903 if (ssh_sftp_loop_iteration() < 0) {
1904 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
1908 if (verbose && realhost != NULL)
1909 printf("Connected to %s\n", realhost);
1913 void cmdline_error(char *p, ...)
1916 fprintf(stderr, "psftp: ");
1918 vfprintf(stderr, p, ap);
1920 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
1925 * Main program. Parse arguments etc.
1927 int psftp_main(int argc, char *argv[])
1931 char *userhost, *user;
1934 char *batchfile = NULL;
1937 flags = FLAG_STDERR | FLAG_INTERACTIVE
1938 #ifdef FLAG_SYNCAGENT
1942 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
1943 ssh_get_line = &console_get_line;
1946 userhost = user = NULL;
1949 for (i = 1; i < argc; i++) {
1951 if (argv[i][0] != '-') {
1955 userhost = dupstr(argv[i]);
1958 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
1960 cmdline_error("option \"%s\" requires an argument", argv[i]);
1961 } else if (ret == 2) {
1962 i++; /* skip next argument */
1963 } else if (ret == 1) {
1964 /* We have our own verbosity in addition to `flags'. */
1965 if (flags & FLAG_VERBOSE)
1967 } else if (strcmp(argv[i], "-h") == 0 ||
1968 strcmp(argv[i], "-?") == 0) {
1970 } else if (strcmp(argv[i], "-batch") == 0) {
1971 console_batch_mode = 1;
1972 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
1974 batchfile = argv[++i];
1975 } else if (strcmp(argv[i], "-bc") == 0) {
1976 modeflags = modeflags | 1;
1977 } else if (strcmp(argv[i], "-be") == 0) {
1978 modeflags = modeflags | 2;
1979 } else if (strcmp(argv[i], "--") == 0) {
1983 cmdline_error("unknown option \"%s\"", argv[i]);
1991 * If a user@host string has already been provided, connect to
1995 if (psftp_connect(userhost, user, portnumber))
2000 printf("psftp: no hostname specified; use \"open host.name\""
2004 do_sftp(mode, modeflags, batchfile);
2006 if (back != NULL && back->socket(backhandle) != NULL) {
2008 back->special(backhandle, TS_EOF);
2009 sftp_recvdata(&ch, 1);