2 * psftp.c: (platform-independent) 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);
28 void do_sftp_cleanup();
30 /* ----------------------------------------------------------------------
36 static void *backhandle;
39 /* ----------------------------------------------------------------------
40 * Higher-level helper functions used in commands.
44 * Attempt to canonify a pathname starting from the pwd. If
45 * canonification fails, at least fall back to returning a _valid_
46 * pathname (though it may be ugly, eg /home/simon/../foobar).
48 char *canonify(char *name)
50 char *fullname, *canonname;
51 struct sftp_packet *pktin;
52 struct sftp_request *req, *rreq;
55 fullname = dupstr(name);
58 if (pwd[strlen(pwd) - 1] == '/')
62 fullname = dupcat(pwd, slash, name, NULL);
65 sftp_register(req = fxp_realpath_send(fullname));
66 rreq = sftp_find_request(pktin = sftp_recv());
68 canonname = fxp_realpath_recv(pktin, rreq);
75 * Attempt number 2. Some FXP_REALPATH implementations
76 * (glibc-based ones, in particular) require the _whole_
77 * path to point to something that exists, whereas others
78 * (BSD-based) only require all but the last component to
79 * exist. So if the first call failed, we should strip off
80 * everything from the last slash onwards and try again,
81 * then put the final component back on.
85 * - if the last component is "/." or "/..", then we don't
86 * bother trying this because there's no way it can work.
88 * - if the thing actually ends with a "/", we remove it
89 * before we start. Except if the string is "/" itself
90 * (although I can't see why we'd have got here if so,
91 * because surely "/" would have worked the first
92 * time?), in which case we don't bother.
94 * - if there's no slash in the string at all, give up in
95 * confusion (we expect at least one because of the way
96 * we constructed the string).
102 i = strlen(fullname);
103 if (i > 2 && fullname[i - 1] == '/')
104 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
105 while (i > 0 && fullname[--i] != '/');
108 * Give up on special cases.
110 if (fullname[i] != '/' || /* no slash at all */
111 !strcmp(fullname + i, "/.") || /* ends in /. */
112 !strcmp(fullname + i, "/..") || /* ends in /.. */
113 !strcmp(fullname, "/")) {
118 * Now i points at the slash. Deal with the final special
119 * case i==0 (ie the whole path was "/nonexistentfile").
121 fullname[i] = '\0'; /* separate the string */
123 sftp_register(req = fxp_realpath_send("/"));
125 sftp_register(req = fxp_realpath_send(fullname));
127 rreq = sftp_find_request(pktin = sftp_recv());
129 canonname = fxp_realpath_recv(pktin, rreq);
132 return fullname; /* even that failed; give up */
135 * We have a canonical name for all but the last path
136 * component. Concatenate the last component and return.
138 returnname = dupcat(canonname,
139 canonname[strlen(canonname) - 1] ==
140 '/' ? "" : "/", fullname + i + 1, NULL);
148 * Return a pointer to the portion of str that comes after the last
149 * slash (or backslash or colon, if `local' is TRUE).
151 static char *stripslashes(char *str, int local)
156 p = strchr(str, ':');
160 p = strrchr(str, '/');
164 p = strrchr(str, '\\');
171 /* ----------------------------------------------------------------------
172 * Actual sftp commands.
174 struct sftp_command {
176 int nwords, wordssize;
177 int (*obey) (struct sftp_command *); /* returns <0 to quit */
180 int sftp_cmd_null(struct sftp_command *cmd)
182 return 1; /* success */
185 int sftp_cmd_unknown(struct sftp_command *cmd)
187 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
188 return 0; /* failure */
191 int sftp_cmd_quit(struct sftp_command *cmd)
197 * List a directory. If no arguments are given, list pwd; otherwise
198 * list the directory given in words[1].
200 static int sftp_ls_compare(const void *av, const void *bv)
202 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
203 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
204 return strcmp((*a)->filename, (*b)->filename);
206 int sftp_cmd_ls(struct sftp_command *cmd)
208 struct fxp_handle *dirh;
209 struct fxp_names *names;
210 struct fxp_name **ournames;
211 int nnames, namesize;
213 struct sftp_packet *pktin;
214 struct sftp_request *req, *rreq;
218 printf("psftp: not connected to a host; use \"open host.name\"\n");
227 cdir = canonify(dir);
229 printf("%s: %s\n", dir, fxp_error());
233 printf("Listing directory %s\n", cdir);
235 sftp_register(req = fxp_opendir_send(cdir));
236 rreq = sftp_find_request(pktin = sftp_recv());
238 dirh = fxp_opendir_recv(pktin, rreq);
241 printf("Unable to open %s: %s\n", dir, fxp_error());
243 nnames = namesize = 0;
248 sftp_register(req = fxp_readdir_send(dirh));
249 rreq = sftp_find_request(pktin = sftp_recv());
251 names = fxp_readdir_recv(pktin, rreq);
254 if (fxp_error_type() == SSH_FX_EOF)
256 printf("Reading directory %s: %s\n", dir, fxp_error());
259 if (names->nnames == 0) {
260 fxp_free_names(names);
264 if (nnames + names->nnames >= namesize) {
265 namesize += names->nnames + 128;
266 ournames = sresize(ournames, namesize, struct fxp_name *);
269 for (i = 0; i < names->nnames; i++)
270 ournames[nnames++] = fxp_dup_name(&names->names[i]);
272 fxp_free_names(names);
274 sftp_register(req = fxp_close_send(dirh));
275 rreq = sftp_find_request(pktin = sftp_recv());
277 fxp_close_recv(pktin, rreq);
280 * Now we have our filenames. Sort them by actual file
281 * name, and then output the longname parts.
283 qsort(ournames, nnames, sizeof(*ournames), sftp_ls_compare);
288 for (i = 0; i < nnames; i++) {
289 printf("%s\n", ournames[i]->longname);
290 fxp_free_name(ournames[i]);
301 * Change directories. We do this by canonifying the new name, then
302 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
304 int sftp_cmd_cd(struct sftp_command *cmd)
306 struct fxp_handle *dirh;
307 struct sftp_packet *pktin;
308 struct sftp_request *req, *rreq;
312 printf("psftp: not connected to a host; use \"open host.name\"\n");
317 dir = dupstr(homedir);
319 dir = canonify(cmd->words[1]);
322 printf("%s: %s\n", dir, fxp_error());
326 sftp_register(req = fxp_opendir_send(dir));
327 rreq = sftp_find_request(pktin = sftp_recv());
329 dirh = fxp_opendir_recv(pktin, rreq);
332 printf("Directory %s: %s\n", dir, fxp_error());
337 sftp_register(req = fxp_close_send(dirh));
338 rreq = sftp_find_request(pktin = sftp_recv());
340 fxp_close_recv(pktin, rreq);
344 printf("Remote directory is now %s\n", pwd);
350 * Print current directory. Easy as pie.
352 int sftp_cmd_pwd(struct sftp_command *cmd)
355 printf("psftp: not connected to a host; use \"open host.name\"\n");
359 printf("Remote directory is %s\n", pwd);
364 * Get a file and save it at the local end. We have two very
365 * similar commands here: `get' and `reget', which differ in that
366 * `reget' checks for the existence of the destination file and
367 * starts from where a previous aborted transfer left off.
369 int sftp_general_get(struct sftp_command *cmd, int restart)
371 struct fxp_handle *fh;
372 struct sftp_packet *pktin;
373 struct sftp_request *req, *rreq;
374 struct fxp_xfer *xfer;
375 char *fname, *outfname;
381 printf("psftp: not connected to a host; use \"open host.name\"\n");
385 if (cmd->nwords < 2) {
386 printf("get: expects a filename\n");
390 fname = canonify(cmd->words[1]);
392 printf("%s: %s\n", cmd->words[1], fxp_error());
395 outfname = (cmd->nwords == 2 ?
396 stripslashes(cmd->words[1], 0) : cmd->words[2]);
398 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
399 rreq = sftp_find_request(pktin = sftp_recv());
401 fh = fxp_open_recv(pktin, rreq);
404 printf("%s: %s\n", fname, fxp_error());
410 fp = fopen(outfname, "rb+");
412 fp = fopen(outfname, "wb");
416 printf("local: unable to open %s\n", outfname);
418 sftp_register(req = fxp_close_send(fh));
419 rreq = sftp_find_request(pktin = sftp_recv());
421 fxp_close_recv(pktin, rreq);
429 fseek(fp, 0L, SEEK_END);
431 printf("reget: restarting at file position %ld\n", posn);
432 offset = uint64_make(0, posn);
434 offset = uint64_make(0, 0);
437 printf("remote:%s => local:%s\n", fname, outfname);
440 * FIXME: we can use FXP_FSTAT here to get the file size, and
441 * thus put up a progress bar.
444 xfer = xfer_download_init(fh, offset);
445 while (!xfer_done(xfer)) {
450 xfer_download_queue(xfer);
452 ret = xfer_download_gotpkt(xfer, pktin);
455 printf("error while reading: %s\n", fxp_error());
459 while (xfer_download_data(xfer, &vbuf, &len)) {
460 unsigned char *buf = (unsigned char *)vbuf;
464 wlen = fwrite(buf + wpos, 1, len - wpos, fp);
466 printf("error while writing local file\n");
468 xfer_set_error(xfer);
472 if (wpos < len) { /* we had an error */
474 xfer_set_error(xfer);
485 sftp_register(req = fxp_close_send(fh));
486 rreq = sftp_find_request(pktin = sftp_recv());
488 fxp_close_recv(pktin, rreq);
494 int sftp_cmd_get(struct sftp_command *cmd)
496 return sftp_general_get(cmd, 0);
498 int sftp_cmd_reget(struct sftp_command *cmd)
500 return sftp_general_get(cmd, 1);
504 * Send a file and store it at the remote end. We have two very
505 * similar commands here: `put' and `reput', which differ in that
506 * `reput' checks for the existence of the destination file and
507 * starts from where a previous aborted transfer left off.
509 int sftp_general_put(struct sftp_command *cmd, int restart)
511 struct fxp_handle *fh;
512 struct fxp_xfer *xfer;
513 char *fname, *origoutfname, *outfname;
514 struct sftp_packet *pktin;
515 struct sftp_request *req, *rreq;
521 printf("psftp: not connected to a host; use \"open host.name\"\n");
525 if (cmd->nwords < 2) {
526 printf("put: expects a filename\n");
530 fname = cmd->words[1];
531 origoutfname = (cmd->nwords == 2 ?
532 stripslashes(cmd->words[1], 1) : cmd->words[2]);
533 outfname = canonify(origoutfname);
535 printf("%s: %s\n", origoutfname, fxp_error());
539 fp = fopen(fname, "rb");
541 printf("local: unable to open %s\n", fname);
546 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
548 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
549 SSH_FXF_CREAT | SSH_FXF_TRUNC));
551 rreq = sftp_find_request(pktin = sftp_recv());
553 fh = fxp_open_recv(pktin, rreq);
556 printf("%s: %s\n", outfname, fxp_error());
563 struct fxp_attrs attrs;
566 sftp_register(req = fxp_fstat_send(fh));
567 rreq = sftp_find_request(pktin = sftp_recv());
569 ret = fxp_fstat_recv(pktin, rreq, &attrs);
572 printf("read size of %s: %s\n", outfname, fxp_error());
576 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
577 printf("read size of %s: size was not given\n", outfname);
582 uint64_decimal(offset, decbuf);
583 printf("reput: restarting at file position %s\n", decbuf);
584 if (uint64_compare(offset, uint64_make(0, LONG_MAX)) > 0) {
585 printf("reput: remote file is larger than we can deal with\n");
589 if (fseek(fp, offset.lo, SEEK_SET) != 0)
590 fseek(fp, 0, SEEK_END); /* *shrug* */
592 offset = uint64_make(0, 0);
595 printf("local:%s => remote:%s\n", fname, outfname);
598 * FIXME: we can use FXP_FSTAT here to get the file size, and
599 * thus put up a progress bar.
602 xfer = xfer_upload_init(fh, offset);
604 while ((!err && !eof) || !xfer_done(xfer)) {
608 while (xfer_upload_ready(xfer) && !err && !eof) {
609 len = fread(buffer, 1, sizeof(buffer), fp);
611 printf("error while reading local file\n");
613 } else if (len == 0) {
616 xfer_upload_data(xfer, buffer, len);
620 if (!xfer_done(xfer)) {
622 ret = xfer_upload_gotpkt(xfer, pktin);
624 printf("error while writing: %s\n", fxp_error());
632 sftp_register(req = fxp_close_send(fh));
633 rreq = sftp_find_request(pktin = sftp_recv());
635 fxp_close_recv(pktin, rreq);
642 int sftp_cmd_put(struct sftp_command *cmd)
644 return sftp_general_put(cmd, 0);
646 int sftp_cmd_reput(struct sftp_command *cmd)
648 return sftp_general_put(cmd, 1);
651 int sftp_cmd_mkdir(struct sftp_command *cmd)
654 struct sftp_packet *pktin;
655 struct sftp_request *req, *rreq;
659 printf("psftp: not connected to a host; use \"open host.name\"\n");
663 if (cmd->nwords < 2) {
664 printf("mkdir: expects a directory\n");
668 dir = canonify(cmd->words[1]);
670 printf("%s: %s\n", dir, fxp_error());
674 sftp_register(req = fxp_mkdir_send(dir));
675 rreq = sftp_find_request(pktin = sftp_recv());
677 result = fxp_mkdir_recv(pktin, rreq);
680 printf("mkdir %s: %s\n", dir, fxp_error());
689 int sftp_cmd_rmdir(struct sftp_command *cmd)
692 struct sftp_packet *pktin;
693 struct sftp_request *req, *rreq;
697 printf("psftp: not connected to a host; use \"open host.name\"\n");
701 if (cmd->nwords < 2) {
702 printf("rmdir: expects a directory\n");
706 dir = canonify(cmd->words[1]);
708 printf("%s: %s\n", dir, fxp_error());
712 sftp_register(req = fxp_rmdir_send(dir));
713 rreq = sftp_find_request(pktin = sftp_recv());
715 result = fxp_rmdir_recv(pktin, rreq);
718 printf("rmdir %s: %s\n", dir, fxp_error());
727 int sftp_cmd_rm(struct sftp_command *cmd)
730 struct sftp_packet *pktin;
731 struct sftp_request *req, *rreq;
735 printf("psftp: not connected to a host; use \"open host.name\"\n");
739 if (cmd->nwords < 2) {
740 printf("rm: expects a filename\n");
744 fname = canonify(cmd->words[1]);
746 printf("%s: %s\n", fname, fxp_error());
750 sftp_register(req = fxp_remove_send(fname));
751 rreq = sftp_find_request(pktin = sftp_recv());
753 result = fxp_remove_recv(pktin, rreq);
756 printf("rm %s: %s\n", fname, fxp_error());
765 int sftp_cmd_mv(struct sftp_command *cmd)
767 char *srcfname, *dstfname;
768 struct sftp_packet *pktin;
769 struct sftp_request *req, *rreq;
773 printf("psftp: not connected to a host; use \"open host.name\"\n");
777 if (cmd->nwords < 3) {
778 printf("mv: expects two filenames\n");
781 srcfname = canonify(cmd->words[1]);
783 printf("%s: %s\n", srcfname, fxp_error());
787 dstfname = canonify(cmd->words[2]);
789 printf("%s: %s\n", dstfname, fxp_error());
793 sftp_register(req = fxp_rename_send(srcfname, dstfname));
794 rreq = sftp_find_request(pktin = sftp_recv());
796 result = fxp_rename_recv(pktin, rreq);
799 char const *error = fxp_error();
800 struct fxp_attrs attrs;
803 * The move might have failed because dstfname pointed at a
804 * directory. We check this possibility now: if dstfname
805 * _is_ a directory, we re-attempt the move by appending
806 * the basename of srcfname to dstfname.
808 sftp_register(req = fxp_stat_send(dstfname));
809 rreq = sftp_find_request(pktin = sftp_recv());
811 result = fxp_stat_recv(pktin, rreq, &attrs);
814 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
815 (attrs.permissions & 0040000)) {
817 char *newname, *newcanon;
818 printf("(destination %s is a directory)\n", dstfname);
819 p = srcfname + strlen(srcfname);
820 while (p > srcfname && p[-1] != '/') p--;
821 newname = dupcat(dstfname, "/", p, NULL);
822 newcanon = canonify(newname);
828 sftp_register(req = fxp_rename_send(srcfname, dstfname));
829 rreq = sftp_find_request(pktin = sftp_recv());
831 result = fxp_rename_recv(pktin, rreq);
833 error = result ? NULL : fxp_error();
837 printf("mv %s %s: %s\n", srcfname, dstfname, error);
843 printf("%s -> %s\n", srcfname, dstfname);
850 int sftp_cmd_chmod(struct sftp_command *cmd)
854 struct fxp_attrs attrs;
855 unsigned attrs_clr, attrs_xor, oldperms, newperms;
856 struct sftp_packet *pktin;
857 struct sftp_request *req, *rreq;
860 printf("psftp: not connected to a host; use \"open host.name\"\n");
864 if (cmd->nwords < 3) {
865 printf("chmod: expects a mode specifier and a filename\n");
870 * Attempt to parse the mode specifier in cmd->words[1]. We
871 * don't support the full horror of Unix chmod; instead we
872 * support a much simpler syntax in which the user can either
873 * specify an octal number, or a comma-separated sequence of
874 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
875 * _only_ be omitted if the only attribute mentioned is t,
876 * since all others require a user/group/other specification.
877 * Additionally, the s attribute may not be specified for any
878 * [ugoa] specifications other than exactly u or exactly g.
880 attrs_clr = attrs_xor = 0;
881 mode = cmd->words[1];
882 if (mode[0] >= '0' && mode[0] <= '9') {
883 if (mode[strspn(mode, "01234567")]) {
884 printf("chmod: numeric file modes should"
885 " contain digits 0-7 only\n");
889 sscanf(mode, "%o", &attrs_xor);
890 attrs_xor &= attrs_clr;
893 char *modebegin = mode;
894 unsigned subset, perms;
898 while (*mode && *mode != ',' &&
899 *mode != '+' && *mode != '-' && *mode != '=') {
901 case 'u': subset |= 04700; break; /* setuid, user perms */
902 case 'g': subset |= 02070; break; /* setgid, group perms */
903 case 'o': subset |= 00007; break; /* just other perms */
904 case 'a': subset |= 06777; break; /* all of the above */
906 printf("chmod: file mode '%.*s' contains unrecognised"
907 " user/group/other specifier '%c'\n",
908 (int)strcspn(modebegin, ","), modebegin, *mode);
913 if (!*mode || *mode == ',') {
914 printf("chmod: file mode '%.*s' is incomplete\n",
915 (int)strcspn(modebegin, ","), modebegin);
919 if (!*mode || *mode == ',') {
920 printf("chmod: file mode '%.*s' is incomplete\n",
921 (int)strcspn(modebegin, ","), modebegin);
925 while (*mode && *mode != ',') {
927 case 'r': perms |= 00444; break;
928 case 'w': perms |= 00222; break;
929 case 'x': perms |= 00111; break;
930 case 't': perms |= 01000; subset |= 01000; break;
932 if ((subset & 06777) != 04700 &&
933 (subset & 06777) != 02070) {
934 printf("chmod: file mode '%.*s': set[ug]id bit should"
935 " be used with exactly one of u or g only\n",
936 (int)strcspn(modebegin, ","), modebegin);
942 printf("chmod: file mode '%.*s' contains unrecognised"
943 " permission specifier '%c'\n",
944 (int)strcspn(modebegin, ","), modebegin, *mode);
949 if (!(subset & 06777) && (perms &~ subset)) {
950 printf("chmod: file mode '%.*s' contains no user/group/other"
951 " specifier and permissions other than 't' \n",
952 (int)strcspn(modebegin, ","), modebegin);
970 if (*mode) mode++; /* eat comma */
974 fname = canonify(cmd->words[2]);
976 printf("%s: %s\n", fname, fxp_error());
980 sftp_register(req = fxp_stat_send(fname));
981 rreq = sftp_find_request(pktin = sftp_recv());
983 result = fxp_stat_recv(pktin, rreq, &attrs);
985 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
986 printf("get attrs for %s: %s\n", fname,
987 result ? "file permissions not provided" : fxp_error());
992 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
993 oldperms = attrs.permissions & 07777;
994 attrs.permissions &= ~attrs_clr;
995 attrs.permissions ^= attrs_xor;
996 newperms = attrs.permissions & 07777;
998 sftp_register(req = fxp_setstat_send(fname, attrs));
999 rreq = sftp_find_request(pktin = sftp_recv());
1000 assert(rreq == req);
1001 result = fxp_setstat_recv(pktin, rreq);
1004 printf("set attrs for %s: %s\n", fname, fxp_error());
1009 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1015 static int sftp_cmd_open(struct sftp_command *cmd)
1020 printf("psftp: already connected\n");
1024 if (cmd->nwords < 2) {
1025 printf("open: expects a host name\n");
1029 if (cmd->nwords > 2) {
1030 portnumber = atoi(cmd->words[2]);
1031 if (portnumber == 0) {
1032 printf("open: invalid port number\n");
1038 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1039 back = NULL; /* connection is already closed */
1040 return -1; /* this is fatal */
1046 static int sftp_cmd_lcd(struct sftp_command *cmd)
1048 char *currdir, *errmsg;
1050 if (cmd->nwords < 2) {
1051 printf("lcd: expects a local directory name\n");
1055 errmsg = psftp_lcd(cmd->words[1]);
1057 printf("lcd: unable to change directory: %s\n", errmsg);
1062 currdir = psftp_getcwd();
1063 printf("New local directory is %s\n", currdir);
1069 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1073 currdir = psftp_getcwd();
1074 printf("Current local directory is %s\n", currdir);
1080 static int sftp_cmd_pling(struct sftp_command *cmd)
1084 exitcode = system(cmd->words[1]);
1085 return (exitcode == 0);
1088 static int sftp_cmd_help(struct sftp_command *cmd);
1090 static struct sftp_cmd_lookup {
1093 * For help purposes, there are two kinds of command:
1095 * - primary commands, in which `longhelp' is non-NULL. In
1096 * this case `shorthelp' is descriptive text, and `longhelp'
1097 * is longer descriptive text intended to be printed after
1100 * - alias commands, in which `longhelp' is NULL. In this case
1101 * `shorthelp' is the name of a primary command, which
1102 * contains the help that should double up for this command.
1104 int listed; /* do we list this in primary help? */
1107 int (*obey) (struct sftp_command *);
1110 * List of sftp commands. This is binary-searched so it MUST be
1114 "!", TRUE, "run a local command",
1116 /* FIXME: this example is crap for non-Windows. */
1117 " Runs a local command. For example, \"!del myfile\".\n",
1121 "bye", TRUE, "finish your SFTP session",
1123 " Terminates your SFTP session and quits the PSFTP program.\n",
1127 "cd", TRUE, "change your remote working directory",
1128 " [ <New working directory> ]\n"
1129 " Change the remote working directory for your SFTP session.\n"
1130 " If a new working directory is not supplied, you will be\n"
1131 " returned to your home directory.\n",
1135 "chmod", TRUE, "change file permissions and modes",
1136 " ( <octal-digits> | <modifiers> ) <filename>\n"
1137 " Change the file permissions on a file or directory.\n"
1138 " <octal-digits> can be any octal Unix permission specifier.\n"
1139 " Alternatively, <modifiers> can include:\n"
1140 " u+r make file readable by owning user\n"
1141 " u+w make file writable by owning user\n"
1142 " u+x make file executable by owning user\n"
1143 " u-r make file not readable by owning user\n"
1144 " [also u-w, u-x]\n"
1145 " g+r make file readable by members of owning group\n"
1146 " [also g+w, g+x, g-r, g-w, g-x]\n"
1147 " o+r make file readable by all other users\n"
1148 " [also o+w, o+x, o-r, o-w, o-x]\n"
1149 " a+r make file readable by absolutely everybody\n"
1150 " [also a+w, a+x, a-r, a-w, a-x]\n"
1151 " u+s enable the Unix set-user-ID bit\n"
1152 " u-s disable the Unix set-user-ID bit\n"
1153 " g+s enable the Unix set-group-ID bit\n"
1154 " g-s disable the Unix set-group-ID bit\n"
1155 " +t enable the Unix \"sticky bit\"\n"
1156 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1157 " more than one user for the same modifier (\"ug+w\"). You can\n"
1158 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1162 "del", TRUE, "delete a file",
1164 " Delete a file.\n",
1168 "delete", FALSE, "del", NULL, sftp_cmd_rm
1171 "dir", TRUE, "list contents of a remote directory",
1172 " [ <directory-name> ]\n"
1173 " List the contents of a specified directory on the server.\n"
1174 " If <directory-name> is not given, the current working directory\n"
1175 " will be listed.\n",
1179 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1182 "get", TRUE, "download a file from the server to your local machine",
1183 " <filename> [ <local-filename> ]\n"
1184 " Downloads a file on the server and stores it locally under\n"
1185 " the same name, or under a different one if you supply the\n"
1186 " argument <local-filename>.\n",
1190 "help", TRUE, "give help",
1191 " [ <command> [ <command> ... ] ]\n"
1192 " Give general help if no commands are specified.\n"
1193 " If one or more commands are specified, give specific help on\n"
1194 " those particular commands.\n",
1198 "lcd", TRUE, "change local working directory",
1199 " <local-directory-name>\n"
1200 " Change the local working directory of the PSFTP program (the\n"
1201 " default location where the \"get\" command will save files).\n",
1205 "lpwd", TRUE, "print local working directory",
1207 " Print the local working directory of the PSFTP program (the\n"
1208 " default location where the \"get\" command will save files).\n",
1212 "ls", TRUE, "dir", NULL,
1216 "mkdir", TRUE, "create a directory on the remote server",
1217 " <directory-name>\n"
1218 " Creates a directory with the given name on the server.\n",
1222 "mv", TRUE, "move or rename a file on the remote server",
1223 " <source-filename> <destination-filename>\n"
1224 " Moves or renames the file <source-filename> on the server,\n"
1225 " so that it is accessible under the name <destination-filename>.\n",
1229 "open", TRUE, "connect to a host",
1230 " [<user>@]<hostname> [<port>]\n"
1231 " Establishes an SFTP connection to a given host. Only usable\n"
1232 " when you did not already specify a host name on the command\n"
1237 "put", TRUE, "upload a file from your local machine to the server",
1238 " <filename> [ <remote-filename> ]\n"
1239 " Uploads a file to the server and stores it there under\n"
1240 " the same name, or under a different one if you supply the\n"
1241 " argument <remote-filename>.\n",
1245 "pwd", TRUE, "print your remote working directory",
1247 " Print the current remote working directory for your SFTP session.\n",
1251 "quit", TRUE, "bye", NULL,
1255 "reget", TRUE, "continue downloading a file",
1256 " <filename> [ <local-filename> ]\n"
1257 " Works exactly like the \"get\" command, but the local file\n"
1258 " must already exist. The download will begin at the end of the\n"
1259 " file. This is for resuming a download that was interrupted.\n",
1263 "ren", TRUE, "mv", NULL,
1267 "rename", FALSE, "mv", NULL,
1271 "reput", TRUE, "continue uploading a file",
1272 " <filename> [ <remote-filename> ]\n"
1273 " Works exactly like the \"put\" command, but the remote file\n"
1274 " must already exist. The upload will begin at the end of the\n"
1275 " file. This is for resuming an upload that was interrupted.\n",
1279 "rm", TRUE, "del", NULL,
1283 "rmdir", TRUE, "remove a directory on the remote server",
1284 " <directory-name>\n"
1285 " Removes the directory with the given name on the server.\n"
1286 " The directory will not be removed unless it is empty.\n",
1291 const struct sftp_cmd_lookup *lookup_command(char *name)
1296 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
1299 cmp = strcmp(name, sftp_lookup[k].name);
1305 return &sftp_lookup[k];
1311 static int sftp_cmd_help(struct sftp_command *cmd)
1314 if (cmd->nwords == 1) {
1316 * Give short help on each command.
1320 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1322 if (!sftp_lookup[i].listed)
1324 len = strlen(sftp_lookup[i].name);
1328 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1329 const struct sftp_cmd_lookup *lookup;
1330 if (!sftp_lookup[i].listed)
1332 lookup = &sftp_lookup[i];
1333 printf("%-*s", maxlen+2, lookup->name);
1334 if (lookup->longhelp == NULL)
1335 lookup = lookup_command(lookup->shorthelp);
1336 printf("%s\n", lookup->shorthelp);
1340 * Give long help on specific commands.
1342 for (i = 1; i < cmd->nwords; i++) {
1343 const struct sftp_cmd_lookup *lookup;
1344 lookup = lookup_command(cmd->words[i]);
1346 printf("help: %s: command not found\n", cmd->words[i]);
1348 printf("%s", lookup->name);
1349 if (lookup->longhelp == NULL)
1350 lookup = lookup_command(lookup->shorthelp);
1351 printf("%s", lookup->longhelp);
1358 /* ----------------------------------------------------------------------
1359 * Command line reading and parsing.
1361 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
1364 int linelen, linesize;
1365 struct sftp_command *cmd;
1369 if ((mode == 0) || (modeflags & 1)) {
1374 cmd = snew(struct sftp_command);
1380 linesize = linelen = 0;
1386 line = sresize(line, linesize, char);
1387 ret = fgets(line + linelen, linesize - linelen, fp);
1389 if (!ret || (linelen == 0 && line[0] == '\0')) {
1390 cmd->obey = sftp_cmd_quit;
1391 if ((mode == 0) || (modeflags & 1))
1393 return cmd; /* eof */
1395 len = linelen + strlen(line + linelen);
1397 if (line[linelen - 1] == '\n') {
1399 line[linelen] = '\0';
1403 if (modeflags & 1) {
1404 printf("%s\n", line);
1408 while (*p && (*p == ' ' || *p == '\t'))
1413 * Special case: the ! command. This is always parsed as
1414 * exactly two words: one containing the !, and the second
1415 * containing everything else on the line.
1417 cmd->nwords = cmd->wordssize = 2;
1418 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1419 cmd->words[0] = dupstr("!");
1420 cmd->words[1] = dupstr(p+1);
1424 * Parse the command line into words. The syntax is:
1425 * - double quotes are removed, but cause spaces within to be
1426 * treated as non-separating.
1427 * - a double-doublequote pair is a literal double quote, inside
1428 * _or_ outside quotes. Like this:
1430 * firstword "second word" "this has ""quotes"" in" and""this""
1436 * >this has "quotes" in<
1440 /* skip whitespace */
1441 while (*p && (*p == ' ' || *p == '\t'))
1443 /* mark start of word */
1444 q = r = p; /* q sits at start, r writes word */
1447 if (!quoting && (*p == ' ' || *p == '\t'))
1448 break; /* reached end of word */
1449 else if (*p == '"' && p[1] == '"')
1450 p += 2, *r++ = '"'; /* a literal quote */
1452 p++, quoting = !quoting;
1457 p++; /* skip over the whitespace */
1459 if (cmd->nwords >= cmd->wordssize) {
1460 cmd->wordssize = cmd->nwords + 16;
1461 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1463 cmd->words[cmd->nwords++] = dupstr(q);
1469 * Now parse the first word and assign a function.
1472 if (cmd->nwords == 0)
1473 cmd->obey = sftp_cmd_null;
1475 const struct sftp_cmd_lookup *lookup;
1476 lookup = lookup_command(cmd->words[0]);
1478 cmd->obey = sftp_cmd_unknown;
1480 cmd->obey = lookup->obey;
1486 static int do_sftp_init(void)
1488 struct sftp_packet *pktin;
1489 struct sftp_request *req, *rreq;
1492 * Do protocol initialisation.
1496 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
1497 return 1; /* failure */
1501 * Find out where our home directory is.
1503 sftp_register(req = fxp_realpath_send("."));
1504 rreq = sftp_find_request(pktin = sftp_recv());
1505 assert(rreq == req);
1506 homedir = fxp_realpath_recv(pktin, rreq);
1510 "Warning: failed to resolve home directory: %s\n",
1512 homedir = dupstr(".");
1514 printf("Remote working directory is %s\n", homedir);
1516 pwd = dupstr(homedir);
1520 void do_sftp_cleanup()
1524 back->special(backhandle, TS_EOF);
1525 sftp_recvdata(&ch, 1);
1526 back->free(backhandle);
1527 sftp_cleanup_request();
1539 void do_sftp(int mode, int modeflags, char *batchfile)
1549 /* ------------------------------------------------------------------
1550 * Now we're ready to do Real Stuff.
1553 struct sftp_command *cmd;
1554 cmd = sftp_getcmd(stdin, 0, 0);
1557 ret = cmd->obey(cmd);
1560 for(i = 0; i < cmd->nwords; i++)
1561 sfree(cmd->words[i]);
1569 fp = fopen(batchfile, "r");
1571 printf("Fatal: unable to open %s\n", batchfile);
1575 struct sftp_command *cmd;
1576 cmd = sftp_getcmd(fp, mode, modeflags);
1579 ret = cmd->obey(cmd);
1583 if (!(modeflags & 2))
1592 /* ----------------------------------------------------------------------
1593 * Dirty bits: integration with PuTTY.
1596 static int verbose = 0;
1599 * Print an error message and perform a fatal exit.
1601 void fatalbox(char *fmt, ...)
1606 str = dupvprintf(fmt, ap);
1607 str2 = dupcat("Fatal: ", str, "\n", NULL);
1610 fputs(str2, stderr);
1615 void modalfatalbox(char *fmt, ...)
1620 str = dupvprintf(fmt, ap);
1621 str2 = dupcat("Fatal: ", str, "\n", NULL);
1624 fputs(str2, stderr);
1629 void connection_fatal(void *frontend, char *fmt, ...)
1634 str = dupvprintf(fmt, ap);
1635 str2 = dupcat("Fatal: ", str, "\n", NULL);
1638 fputs(str2, stderr);
1644 void ldisc_send(void *handle, char *buf, int len, int interactive)
1647 * This is only here because of the calls to ldisc_send(NULL,
1648 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
1649 * ldisc as an ldisc. So if we get called with any real data, I
1650 * want to know about it.
1656 * In psftp, all agent requests should be synchronous, so this is a
1657 * never-called stub.
1659 void agent_schedule_callback(void (*callback)(void *, void *, int),
1660 void *callback_ctx, void *data, int len)
1662 assert(!"We shouldn't be here");
1666 * Receive a block of data from the SSH link. Block until all data
1669 * To do this, we repeatedly call the SSH protocol module, with our
1670 * own trap in from_backend() to catch the data that comes back. We
1671 * do this until we have enough data.
1674 static unsigned char *outptr; /* where to put the data */
1675 static unsigned outlen; /* how much data required */
1676 static unsigned char *pending = NULL; /* any spare data */
1677 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
1678 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
1680 unsigned char *p = (unsigned char *) data;
1681 unsigned len = (unsigned) datalen;
1684 * stderr data is just spouted to local stderr and otherwise
1689 fwrite(data, 1, len, stderr);
1694 * If this is before the real session begins, just return.
1699 if ((outlen > 0) && (len > 0)) {
1700 unsigned used = outlen;
1703 memcpy(outptr, p, used);
1711 if (pendsize < pendlen + len) {
1712 pendsize = pendlen + len + 4096;
1713 pending = sresize(pending, pendsize, unsigned char);
1715 memcpy(pending + pendlen, p, len);
1721 int sftp_recvdata(char *buf, int len)
1723 outptr = (unsigned char *) buf;
1727 * See if the pending-input block contains some of what we
1731 unsigned pendused = pendlen;
1732 if (pendused > outlen)
1734 memcpy(outptr, pending, pendused);
1735 memmove(pending, pending + pendused, pendlen - pendused);
1738 pendlen -= pendused;
1748 while (outlen > 0) {
1749 if (ssh_sftp_loop_iteration() < 0)
1750 return 0; /* doom */
1755 int sftp_senddata(char *buf, int len)
1757 back->send(backhandle, buf, len);
1762 * Short description of parameters.
1764 static void usage(void)
1766 printf("PuTTY Secure File Transfer (SFTP) client\n");
1767 printf("%s\n", ver);
1768 printf("Usage: psftp [options] [user@]host\n");
1769 printf("Options:\n");
1770 printf(" -b file use specified batchfile\n");
1771 printf(" -bc output batchfile commands\n");
1772 printf(" -be don't stop batchfile processing if errors\n");
1773 printf(" -v show verbose messages\n");
1774 printf(" -load sessname Load settings from saved session\n");
1775 printf(" -l user connect with specified username\n");
1776 printf(" -P port connect to specified port\n");
1777 printf(" -pw passw login with specified password\n");
1778 printf(" -1 -2 force use of particular SSH protocol version\n");
1779 printf(" -C enable compression\n");
1780 printf(" -i key private key file for authentication\n");
1781 printf(" -batch disable all interactive prompts\n");
1782 printf(" -V print version information\n");
1786 static void version(void)
1788 printf("psftp: %s\n", ver);
1793 * Connect to a host.
1795 static int psftp_connect(char *userhost, char *user, int portnumber)
1797 char *host, *realhost;
1801 /* Separate host and username */
1803 host = strrchr(host, '@');
1809 printf("psftp: multiple usernames specified; using \"%s\"\n",
1816 * If we haven't loaded session details already (e.g., from -load),
1817 * try looking for a session called "host".
1819 if (!loaded_session) {
1820 /* Try to load settings for `host' into a temporary config */
1822 cfg2.host[0] = '\0';
1823 do_defaults(host, &cfg2);
1824 if (cfg2.host[0] != '\0') {
1825 /* Settings present and include hostname */
1826 /* Re-load data into the real config. */
1827 do_defaults(host, &cfg);
1829 /* Session doesn't exist or mention a hostname. */
1830 /* Use `host' as a bare hostname. */
1831 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
1832 cfg.host[sizeof(cfg.host) - 1] = '\0';
1835 /* Patch in hostname `host' to session details. */
1836 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
1837 cfg.host[sizeof(cfg.host) - 1] = '\0';
1841 * Force use of SSH. (If they got the protocol wrong we assume the
1842 * port is useless too.)
1844 if (cfg.protocol != PROT_SSH) {
1845 cfg.protocol = PROT_SSH;
1850 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
1851 * then change it to SSH-2, on the grounds that that's more likely to
1852 * work for SFTP. (Can be overridden with `-1' option.)
1853 * But if it says `2 only' or `2', respect which.
1855 if (cfg.sshprot != 2 && cfg.sshprot != 3)
1859 * Enact command-line overrides.
1861 cmdline_run_saved(&cfg);
1864 * Trim leading whitespace off the hostname if it's there.
1867 int space = strspn(cfg.host, " \t");
1868 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
1871 /* See if host is of the form user@host */
1872 if (cfg.host[0] != '\0') {
1873 char *atsign = strrchr(cfg.host, '@');
1874 /* Make sure we're not overflowing the user field */
1876 if (atsign - cfg.host < sizeof cfg.username) {
1877 strncpy(cfg.username, cfg.host, atsign - cfg.host);
1878 cfg.username[atsign - cfg.host] = '\0';
1880 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
1885 * Trim a colon suffix off the hostname if it's there.
1887 cfg.host[strcspn(cfg.host, ":")] = '\0';
1890 * Remove any remaining whitespace from the hostname.
1894 while (cfg.host[p2] != '\0') {
1895 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
1896 cfg.host[p1] = cfg.host[p2];
1901 cfg.host[p1] = '\0';
1905 if (user != NULL && user[0] != '\0') {
1906 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
1907 cfg.username[sizeof(cfg.username) - 1] = '\0';
1909 if (!cfg.username[0]) {
1910 printf("login as: ");
1912 if (!fgets(cfg.username, sizeof(cfg.username), stdin)) {
1913 fprintf(stderr, "psftp: aborting\n");
1916 int len = strlen(cfg.username);
1917 if (cfg.username[len - 1] == '\n')
1918 cfg.username[len - 1] = '\0';
1923 cfg.port = portnumber;
1926 * Disable scary things which shouldn't be enabled for simple
1927 * things like SCP and SFTP: agent forwarding, port forwarding,
1930 cfg.x11_forward = 0;
1932 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
1934 /* Set up subsystem name. */
1935 strcpy(cfg.remote_cmd, "sftp");
1936 cfg.ssh_subsys = TRUE;
1940 * Set up fallback option, for SSH1 servers or servers with the
1941 * sftp subsystem not enabled but the server binary installed
1942 * in the usual place. We only support fallback on Unix
1943 * systems, and we use a kludgy piece of shellery which should
1944 * try to find sftp-server in various places (the obvious
1945 * systemwide spots /usr/lib and /usr/local/lib, and then the
1946 * user's PATH) and finally give up.
1948 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
1949 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
1952 * the idea being that this will attempt to use either of the
1953 * obvious pathnames and then give up, and when it does give up
1954 * it will print the preferred pathname in the error messages.
1956 cfg.remote_cmd_ptr2 =
1957 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
1958 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
1960 cfg.ssh_subsys2 = FALSE;
1962 back = &ssh_backend;
1964 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,
1965 0, cfg.tcp_keepalives);
1967 fprintf(stderr, "ssh_init: %s\n", err);
1970 logctx = log_init(NULL, &cfg);
1971 back->provide_logctx(backhandle, logctx);
1972 console_provide_logctx(logctx);
1973 while (!back->sendok(backhandle)) {
1974 if (ssh_sftp_loop_iteration() < 0) {
1975 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
1979 if (verbose && realhost != NULL)
1980 printf("Connected to %s\n", realhost);
1981 if (realhost != NULL)
1986 void cmdline_error(char *p, ...)
1989 fprintf(stderr, "psftp: ");
1991 vfprintf(stderr, p, ap);
1993 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
1998 * Main program. Parse arguments etc.
2000 int psftp_main(int argc, char *argv[])
2004 char *userhost, *user;
2007 char *batchfile = NULL;
2010 flags = FLAG_STDERR | FLAG_INTERACTIVE
2011 #ifdef FLAG_SYNCAGENT
2015 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2016 ssh_get_line = &console_get_line;
2019 userhost = user = NULL;
2021 /* Load Default Settings before doing anything else. */
2022 do_defaults(NULL, &cfg);
2023 loaded_session = FALSE;
2026 for (i = 1; i < argc; i++) {
2028 if (argv[i][0] != '-') {
2032 userhost = dupstr(argv[i]);
2035 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2037 cmdline_error("option \"%s\" requires an argument", argv[i]);
2038 } else if (ret == 2) {
2039 i++; /* skip next argument */
2040 } else if (ret == 1) {
2041 /* We have our own verbosity in addition to `flags'. */
2042 if (flags & FLAG_VERBOSE)
2044 } else if (strcmp(argv[i], "-h") == 0 ||
2045 strcmp(argv[i], "-?") == 0) {
2047 } else if (strcmp(argv[i], "-V") == 0) {
2049 } else if (strcmp(argv[i], "-batch") == 0) {
2050 console_batch_mode = 1;
2051 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2053 batchfile = argv[++i];
2054 } else if (strcmp(argv[i], "-bc") == 0) {
2055 modeflags = modeflags | 1;
2056 } else if (strcmp(argv[i], "-be") == 0) {
2057 modeflags = modeflags | 2;
2058 } else if (strcmp(argv[i], "--") == 0) {
2062 cmdline_error("unknown option \"%s\"", argv[i]);
2070 * If the loaded session provides a hostname, and a hostname has not
2071 * otherwise been specified, pop it in `userhost' so that
2072 * `psftp -load sessname' is sufficient to start a session.
2074 if (!userhost && cfg.host[0] != '\0') {
2075 userhost = dupstr(cfg.host);
2079 * If a user@host string has already been provided, connect to
2084 ret = psftp_connect(userhost, user, portnumber);
2091 printf("psftp: no hostname specified; use \"open host.name\""
2095 do_sftp(mode, modeflags, batchfile);
2097 if (back != NULL && back->socket(backhandle) != NULL) {
2099 back->special(backhandle, TS_EOF);
2100 sftp_recvdata(&ch, 1);
2104 console_provide_logctx(NULL);