2 * psftp.c: front end for PSFTP.
13 #define PUTTY_DO_GLOBALS
21 * Since SFTP is a request-response oriented protocol, it requires
22 * no buffer management: when we send data, we stop and wait for an
23 * acknowledgement _anyway_, and so we can't possibly overfill our
27 static int psftp_connect(char *userhost, char *user, int portnumber);
28 static int do_sftp_init(void);
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 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.
448 sftp_register(req = fxp_read_send(fh, offset, sizeof(buffer)));
449 rreq = sftp_find_request(pktin = sftp_recv());
451 len = fxp_read_recv(pktin, rreq, buffer, sizeof(buffer));
453 if ((len == -1 && fxp_error_type() == SSH_FX_EOF) || len == 0)
456 printf("error while reading: %s\n", fxp_error());
463 wlen = fwrite(buffer, 1, len - wpos, fp);
465 printf("error while writing local file\n");
471 if (wpos < len) { /* we had an error */
475 offset = uint64_add32(offset, len);
480 sftp_register(req = fxp_close_send(fh));
481 rreq = sftp_find_request(pktin = sftp_recv());
483 fxp_close_recv(pktin, rreq);
489 int sftp_cmd_get(struct sftp_command *cmd)
491 return sftp_general_get(cmd, 0);
493 int sftp_cmd_reget(struct sftp_command *cmd)
495 return sftp_general_get(cmd, 1);
499 * Send a file and store it at the remote end. We have two very
500 * similar commands here: `put' and `reput', which differ in that
501 * `reput' checks for the existence of the destination file and
502 * starts from where a previous aborted transfer left off.
504 int sftp_general_put(struct sftp_command *cmd, int restart)
506 struct fxp_handle *fh;
507 char *fname, *origoutfname, *outfname;
508 struct sftp_packet *pktin;
509 struct sftp_request *req, *rreq;
515 printf("psftp: not connected to a host; use \"open host.name\"\n");
519 if (cmd->nwords < 2) {
520 printf("put: expects a filename\n");
524 fname = cmd->words[1];
525 origoutfname = (cmd->nwords == 2 ?
526 stripslashes(cmd->words[1], 1) : cmd->words[2]);
527 outfname = canonify(origoutfname);
529 printf("%s: %s\n", origoutfname, fxp_error());
533 fp = fopen(fname, "rb");
535 printf("local: unable to open %s\n", fname);
540 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
542 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
543 SSH_FXF_CREAT | SSH_FXF_TRUNC));
545 rreq = sftp_find_request(pktin = sftp_recv());
547 fh = fxp_open_recv(pktin, rreq);
550 printf("%s: %s\n", outfname, fxp_error());
557 struct fxp_attrs attrs;
560 sftp_register(req = fxp_fstat_send(fh));
561 rreq = sftp_find_request(pktin = sftp_recv());
563 ret = fxp_fstat_recv(pktin, rreq, &attrs);
566 printf("read size of %s: %s\n", outfname, fxp_error());
570 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
571 printf("read size of %s: size was not given\n", outfname);
576 uint64_decimal(offset, decbuf);
577 printf("reput: restarting at file position %s\n", decbuf);
578 if (uint64_compare(offset, uint64_make(0, LONG_MAX)) > 0) {
579 printf("reput: remote file is larger than we can deal with\n");
583 if (fseek(fp, offset.lo, SEEK_SET) != 0)
584 fseek(fp, 0, SEEK_END); /* *shrug* */
586 offset = uint64_make(0, 0);
589 printf("local:%s => remote:%s\n", fname, outfname);
592 * FIXME: we can use FXP_FSTAT here to get the file size, and
593 * thus put up a progress bar.
600 len = fread(buffer, 1, sizeof(buffer), fp);
602 printf("error while reading local file\n");
605 } else if (len == 0) {
609 sftp_register(req = fxp_write_send(fh, buffer, offset, len));
610 rreq = sftp_find_request(pktin = sftp_recv());
612 ret = fxp_write_recv(pktin, rreq);
615 printf("error while writing: %s\n", fxp_error());
619 offset = uint64_add32(offset, len);
622 sftp_register(req = fxp_close_send(fh));
623 rreq = sftp_find_request(pktin = sftp_recv());
625 fxp_close_recv(pktin, rreq);
632 int sftp_cmd_put(struct sftp_command *cmd)
634 return sftp_general_put(cmd, 0);
636 int sftp_cmd_reput(struct sftp_command *cmd)
638 return sftp_general_put(cmd, 1);
641 int sftp_cmd_mkdir(struct sftp_command *cmd)
644 struct sftp_packet *pktin;
645 struct sftp_request *req, *rreq;
649 printf("psftp: not connected to a host; use \"open host.name\"\n");
653 if (cmd->nwords < 2) {
654 printf("mkdir: expects a directory\n");
658 dir = canonify(cmd->words[1]);
660 printf("%s: %s\n", dir, fxp_error());
664 sftp_register(req = fxp_mkdir_send(dir));
665 rreq = sftp_find_request(pktin = sftp_recv());
667 result = fxp_mkdir_recv(pktin, rreq);
670 printf("mkdir %s: %s\n", dir, fxp_error());
679 int sftp_cmd_rmdir(struct sftp_command *cmd)
682 struct sftp_packet *pktin;
683 struct sftp_request *req, *rreq;
687 printf("psftp: not connected to a host; use \"open host.name\"\n");
691 if (cmd->nwords < 2) {
692 printf("rmdir: expects a directory\n");
696 dir = canonify(cmd->words[1]);
698 printf("%s: %s\n", dir, fxp_error());
702 sftp_register(req = fxp_rmdir_send(dir));
703 rreq = sftp_find_request(pktin = sftp_recv());
705 result = fxp_rmdir_recv(pktin, rreq);
708 printf("rmdir %s: %s\n", dir, fxp_error());
717 int sftp_cmd_rm(struct sftp_command *cmd)
720 struct sftp_packet *pktin;
721 struct sftp_request *req, *rreq;
725 printf("psftp: not connected to a host; use \"open host.name\"\n");
729 if (cmd->nwords < 2) {
730 printf("rm: expects a filename\n");
734 fname = canonify(cmd->words[1]);
736 printf("%s: %s\n", fname, fxp_error());
740 sftp_register(req = fxp_remove_send(fname));
741 rreq = sftp_find_request(pktin = sftp_recv());
743 result = fxp_remove_recv(pktin, rreq);
746 printf("rm %s: %s\n", fname, fxp_error());
755 int sftp_cmd_mv(struct sftp_command *cmd)
757 char *srcfname, *dstfname;
758 struct sftp_packet *pktin;
759 struct sftp_request *req, *rreq;
763 printf("psftp: not connected to a host; use \"open host.name\"\n");
767 if (cmd->nwords < 3) {
768 printf("mv: expects two filenames\n");
771 srcfname = canonify(cmd->words[1]);
773 printf("%s: %s\n", srcfname, fxp_error());
777 dstfname = canonify(cmd->words[2]);
779 printf("%s: %s\n", dstfname, fxp_error());
783 sftp_register(req = fxp_rename_send(srcfname, dstfname));
784 rreq = sftp_find_request(pktin = sftp_recv());
786 result = fxp_rename_recv(pktin, rreq);
789 char const *error = fxp_error();
790 struct fxp_attrs attrs;
793 * The move might have failed because dstfname pointed at a
794 * directory. We check this possibility now: if dstfname
795 * _is_ a directory, we re-attempt the move by appending
796 * the basename of srcfname to dstfname.
798 sftp_register(req = fxp_stat_send(dstfname));
799 rreq = sftp_find_request(pktin = sftp_recv());
801 result = fxp_stat_recv(pktin, rreq, &attrs);
804 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
805 (attrs.permissions & 0040000)) {
807 char *newname, *newcanon;
808 printf("(destination %s is a directory)\n", dstfname);
809 p = srcfname + strlen(srcfname);
810 while (p > srcfname && p[-1] != '/') p--;
811 newname = dupcat(dstfname, "/", p, NULL);
812 newcanon = canonify(newname);
818 sftp_register(req = fxp_rename_send(srcfname, dstfname));
819 rreq = sftp_find_request(pktin = sftp_recv());
821 result = fxp_rename_recv(pktin, rreq);
823 error = result ? NULL : fxp_error();
827 printf("mv %s %s: %s\n", srcfname, dstfname, error);
833 printf("%s -> %s\n", srcfname, dstfname);
840 int sftp_cmd_chmod(struct sftp_command *cmd)
844 struct fxp_attrs attrs;
845 unsigned attrs_clr, attrs_xor, oldperms, newperms;
846 struct sftp_packet *pktin;
847 struct sftp_request *req, *rreq;
850 printf("psftp: not connected to a host; use \"open host.name\"\n");
854 if (cmd->nwords < 3) {
855 printf("chmod: expects a mode specifier and a filename\n");
860 * Attempt to parse the mode specifier in cmd->words[1]. We
861 * don't support the full horror of Unix chmod; instead we
862 * support a much simpler syntax in which the user can either
863 * specify an octal number, or a comma-separated sequence of
864 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
865 * _only_ be omitted if the only attribute mentioned is t,
866 * since all others require a user/group/other specification.
867 * Additionally, the s attribute may not be specified for any
868 * [ugoa] specifications other than exactly u or exactly g.
870 attrs_clr = attrs_xor = 0;
871 mode = cmd->words[1];
872 if (mode[0] >= '0' && mode[0] <= '9') {
873 if (mode[strspn(mode, "01234567")]) {
874 printf("chmod: numeric file modes should"
875 " contain digits 0-7 only\n");
879 sscanf(mode, "%o", &attrs_xor);
880 attrs_xor &= attrs_clr;
883 char *modebegin = mode;
884 unsigned subset, perms;
888 while (*mode && *mode != ',' &&
889 *mode != '+' && *mode != '-' && *mode != '=') {
891 case 'u': subset |= 04700; break; /* setuid, user perms */
892 case 'g': subset |= 02070; break; /* setgid, group perms */
893 case 'o': subset |= 00007; break; /* just other perms */
894 case 'a': subset |= 06777; break; /* all of the above */
896 printf("chmod: file mode '%.*s' contains unrecognised"
897 " user/group/other specifier '%c'\n",
898 strcspn(modebegin, ","), modebegin, *mode);
903 if (!*mode || *mode == ',') {
904 printf("chmod: file mode '%.*s' is incomplete\n",
905 strcspn(modebegin, ","), modebegin);
909 if (!*mode || *mode == ',') {
910 printf("chmod: file mode '%.*s' is incomplete\n",
911 strcspn(modebegin, ","), modebegin);
915 while (*mode && *mode != ',') {
917 case 'r': perms |= 00444; break;
918 case 'w': perms |= 00222; break;
919 case 'x': perms |= 00111; break;
920 case 't': perms |= 01000; subset |= 01000; break;
922 if ((subset & 06777) != 04700 &&
923 (subset & 06777) != 02070) {
924 printf("chmod: file mode '%.*s': set[ug]id bit should"
925 " be used with exactly one of u or g only\n",
926 strcspn(modebegin, ","), modebegin);
932 printf("chmod: file mode '%.*s' contains unrecognised"
933 " permission specifier '%c'\n",
934 strcspn(modebegin, ","), modebegin, *mode);
939 if (!(subset & 06777) && (perms &~ subset)) {
940 printf("chmod: file mode '%.*s' contains no user/group/other"
941 " specifier and permissions other than 't' \n",
942 strcspn(modebegin, ","), modebegin);
960 if (*mode) mode++; /* eat comma */
964 fname = canonify(cmd->words[2]);
966 printf("%s: %s\n", fname, fxp_error());
970 sftp_register(req = fxp_stat_send(fname));
971 rreq = sftp_find_request(pktin = sftp_recv());
973 result = fxp_stat_recv(pktin, rreq, &attrs);
975 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
976 printf("get attrs for %s: %s\n", fname,
977 result ? "file permissions not provided" : fxp_error());
982 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
983 oldperms = attrs.permissions & 07777;
984 attrs.permissions &= ~attrs_clr;
985 attrs.permissions ^= attrs_xor;
986 newperms = attrs.permissions & 07777;
988 sftp_register(req = fxp_setstat_send(fname, attrs));
989 rreq = sftp_find_request(pktin = sftp_recv());
991 result = fxp_setstat_recv(pktin, rreq);
994 printf("set attrs for %s: %s\n", fname, fxp_error());
999 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1005 static int sftp_cmd_open(struct sftp_command *cmd)
1008 printf("psftp: already connected\n");
1012 if (cmd->nwords < 2) {
1013 printf("open: expects a host name\n");
1017 if (psftp_connect(cmd->words[1], NULL, 0)) {
1018 back = NULL; /* connection is already closed */
1019 return -1; /* this is fatal */
1025 static int sftp_cmd_lcd(struct sftp_command *cmd)
1030 if (cmd->nwords < 2) {
1031 printf("lcd: expects a local directory name\n");
1035 if (!SetCurrentDirectory(cmd->words[1])) {
1038 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
1039 FORMAT_MESSAGE_FROM_SYSTEM |
1040 FORMAT_MESSAGE_IGNORE_INSERTS,
1041 NULL, GetLastError(),
1042 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1043 (LPTSTR)&message, 0, NULL);
1044 i = strcspn((char *)message, "\n");
1045 printf("lcd: unable to change directory: %.*s\n", i, (LPCTSTR)message);
1050 currdir = snewn(256, char);
1051 len = GetCurrentDirectory(256, currdir);
1053 currdir = sresize(currdir, len, char);
1054 GetCurrentDirectory(len, currdir);
1055 printf("New local directory is %s\n", currdir);
1061 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1066 currdir = snewn(256, char);
1067 len = GetCurrentDirectory(256, currdir);
1069 currdir = sresize(currdir, len, char);
1070 GetCurrentDirectory(len, currdir);
1071 printf("Current local directory is %s\n", currdir);
1077 static int sftp_cmd_pling(struct sftp_command *cmd)
1081 exitcode = system(cmd->words[1]);
1082 return (exitcode == 0);
1085 static int sftp_cmd_help(struct sftp_command *cmd);
1087 static struct sftp_cmd_lookup {
1090 * For help purposes, there are two kinds of command:
1092 * - primary commands, in which `longhelp' is non-NULL. In
1093 * this case `shorthelp' is descriptive text, and `longhelp'
1094 * is longer descriptive text intended to be printed after
1097 * - alias commands, in which `longhelp' is NULL. In this case
1098 * `shorthelp' is the name of a primary command, which
1099 * contains the help that should double up for this command.
1101 int listed; /* do we list this in primary help? */
1104 int (*obey) (struct sftp_command *);
1107 * List of sftp commands. This is binary-searched so it MUST be
1111 "!", TRUE, "run a local Windows command",
1113 " Runs a local Windows command. For example, \"!del myfile\".\n",
1117 "bye", TRUE, "finish your SFTP session",
1119 " Terminates your SFTP session and quits the PSFTP program.\n",
1123 "cd", TRUE, "change your remote working directory",
1124 " [ <New working directory> ]\n"
1125 " Change the remote working directory for your SFTP session.\n"
1126 " If a new working directory is not supplied, you will be\n"
1127 " returned to your home directory.\n",
1131 "chmod", TRUE, "change file permissions and modes",
1132 " ( <octal-digits> | <modifiers> ) <filename>\n"
1133 " Change the file permissions on a file or directory.\n"
1134 " <octal-digits> can be any octal Unix permission specifier.\n"
1135 " Alternatively, <modifiers> can include:\n"
1136 " u+r make file readable by owning user\n"
1137 " u+w make file writable by owning user\n"
1138 " u+x make file executable by owning user\n"
1139 " u-r make file not readable by owning user\n"
1140 " [also u-w, u-x]\n"
1141 " g+r make file readable by members of owning group\n"
1142 " [also g+w, g+x, g-r, g-w, g-x]\n"
1143 " o+r make file readable by all other users\n"
1144 " [also o+w, o+x, o-r, o-w, o-x]\n"
1145 " a+r make file readable by absolutely everybody\n"
1146 " [also a+w, a+x, a-r, a-w, a-x]\n"
1147 " u+s enable the Unix set-user-ID bit\n"
1148 " u-s disable the Unix set-user-ID bit\n"
1149 " g+s enable the Unix set-group-ID bit\n"
1150 " g-s disable the Unix set-group-ID bit\n"
1151 " +t enable the Unix \"sticky bit\"\n"
1152 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1153 " more than one user for the same modifier (\"ug+w\"). You can\n"
1154 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1158 "del", TRUE, "delete a file",
1160 " Delete a file.\n",
1164 "delete", FALSE, "del", NULL, sftp_cmd_rm
1167 "dir", TRUE, "list contents of a remote directory",
1168 " [ <directory-name> ]\n"
1169 " List the contents of a specified directory on the server.\n"
1170 " If <directory-name> is not given, the current working directory\n"
1171 " will be listed.\n",
1175 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1178 "get", TRUE, "download a file from the server to your local machine",
1179 " <filename> [ <local-filename> ]\n"
1180 " Downloads a file on the server and stores it locally under\n"
1181 " the same name, or under a different one if you supply the\n"
1182 " argument <local-filename>.\n",
1186 "help", TRUE, "give help",
1187 " [ <command> [ <command> ... ] ]\n"
1188 " Give general help if no commands are specified.\n"
1189 " If one or more commands are specified, give specific help on\n"
1190 " those particular commands.\n",
1194 "lcd", TRUE, "change local working directory",
1195 " <local-directory-name>\n"
1196 " Change the local working directory of the PSFTP program (the\n"
1197 " default location where the \"get\" command will save files).\n",
1201 "lpwd", TRUE, "print local working directory",
1203 " Print the local working directory of the PSFTP program (the\n"
1204 " default location where the \"get\" command will save files).\n",
1208 "ls", TRUE, "dir", NULL,
1212 "mkdir", TRUE, "create a directory on the remote server",
1213 " <directory-name>\n"
1214 " Creates a directory with the given name on the server.\n",
1218 "mv", TRUE, "move or rename a file on the remote server",
1219 " <source-filename> <destination-filename>\n"
1220 " Moves or renames the file <source-filename> on the server,\n"
1221 " so that it is accessible under the name <destination-filename>.\n",
1225 "open", TRUE, "connect to a host",
1226 " [<user>@]<hostname>\n"
1227 " Establishes an SFTP connection to a given host. Only usable\n"
1228 " when you did not already specify a host name on the command\n"
1233 "put", TRUE, "upload a file from your local machine to the server",
1234 " <filename> [ <remote-filename> ]\n"
1235 " Uploads a file to the server and stores it there under\n"
1236 " the same name, or under a different one if you supply the\n"
1237 " argument <remote-filename>.\n",
1241 "pwd", TRUE, "print your remote working directory",
1243 " Print the current remote working directory for your SFTP session.\n",
1247 "quit", TRUE, "bye", NULL,
1251 "reget", TRUE, "continue downloading a file",
1252 " <filename> [ <local-filename> ]\n"
1253 " Works exactly like the \"get\" command, but the local file\n"
1254 " must already exist. The download will begin at the end of the\n"
1255 " file. This is for resuming a download that was interrupted.\n",
1259 "ren", TRUE, "mv", NULL,
1263 "rename", FALSE, "mv", NULL,
1267 "reput", TRUE, "continue uploading a file",
1268 " <filename> [ <remote-filename> ]\n"
1269 " Works exactly like the \"put\" command, but the remote file\n"
1270 " must already exist. The upload will begin at the end of the\n"
1271 " file. This is for resuming an upload that was interrupted.\n",
1275 "rm", TRUE, "del", NULL,
1279 "rmdir", TRUE, "remove a directory on the remote server",
1280 " <directory-name>\n"
1281 " Removes the directory with the given name on the server.\n"
1282 " The directory will not be removed unless it is empty.\n",
1287 const struct sftp_cmd_lookup *lookup_command(char *name)
1292 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
1295 cmp = strcmp(name, sftp_lookup[k].name);
1301 return &sftp_lookup[k];
1307 static int sftp_cmd_help(struct sftp_command *cmd)
1310 if (cmd->nwords == 1) {
1312 * Give short help on each command.
1316 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1318 if (!sftp_lookup[i].listed)
1320 len = strlen(sftp_lookup[i].name);
1324 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1325 const struct sftp_cmd_lookup *lookup;
1326 if (!sftp_lookup[i].listed)
1328 lookup = &sftp_lookup[i];
1329 printf("%-*s", maxlen+2, lookup->name);
1330 if (lookup->longhelp == NULL)
1331 lookup = lookup_command(lookup->shorthelp);
1332 printf("%s\n", lookup->shorthelp);
1336 * Give long help on specific commands.
1338 for (i = 1; i < cmd->nwords; i++) {
1339 const struct sftp_cmd_lookup *lookup;
1340 lookup = lookup_command(cmd->words[i]);
1342 printf("help: %s: command not found\n", cmd->words[i]);
1344 printf("%s", lookup->name);
1345 if (lookup->longhelp == NULL)
1346 lookup = lookup_command(lookup->shorthelp);
1347 printf("%s", lookup->longhelp);
1354 /* ----------------------------------------------------------------------
1355 * Command line reading and parsing.
1357 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
1360 int linelen, linesize;
1361 struct sftp_command *cmd;
1365 if ((mode == 0) || (modeflags & 1)) {
1370 cmd = snew(struct sftp_command);
1376 linesize = linelen = 0;
1382 line = sresize(line, linesize, char);
1383 ret = fgets(line + linelen, linesize - linelen, fp);
1385 if (!ret || (linelen == 0 && line[0] == '\0')) {
1386 cmd->obey = sftp_cmd_quit;
1387 if ((mode == 0) || (modeflags & 1))
1389 return cmd; /* eof */
1391 len = linelen + strlen(line + linelen);
1393 if (line[linelen - 1] == '\n') {
1395 line[linelen] = '\0';
1399 if (modeflags & 1) {
1400 printf("%s\n", line);
1404 while (*p && (*p == ' ' || *p == '\t'))
1409 * Special case: the ! command. This is always parsed as
1410 * exactly two words: one containing the !, and the second
1411 * containing everything else on the line.
1413 cmd->nwords = cmd->wordssize = 2;
1414 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1415 cmd->words[0] = "!";
1416 cmd->words[1] = p+1;
1420 * Parse the command line into words. The syntax is:
1421 * - double quotes are removed, but cause spaces within to be
1422 * treated as non-separating.
1423 * - a double-doublequote pair is a literal double quote, inside
1424 * _or_ outside quotes. Like this:
1426 * firstword "second word" "this has ""quotes"" in" and""this""
1432 * >this has "quotes" in<
1436 /* skip whitespace */
1437 while (*p && (*p == ' ' || *p == '\t'))
1439 /* mark start of word */
1440 q = r = p; /* q sits at start, r writes word */
1443 if (!quoting && (*p == ' ' || *p == '\t'))
1444 break; /* reached end of word */
1445 else if (*p == '"' && p[1] == '"')
1446 p += 2, *r++ = '"'; /* a literal quote */
1448 p++, quoting = !quoting;
1453 p++; /* skip over the whitespace */
1455 if (cmd->nwords >= cmd->wordssize) {
1456 cmd->wordssize = cmd->nwords + 16;
1457 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1459 cmd->words[cmd->nwords++] = q;
1464 * Now parse the first word and assign a function.
1467 if (cmd->nwords == 0)
1468 cmd->obey = sftp_cmd_null;
1470 const struct sftp_cmd_lookup *lookup;
1471 lookup = lookup_command(cmd->words[0]);
1473 cmd->obey = sftp_cmd_unknown;
1475 cmd->obey = lookup->obey;
1481 static int do_sftp_init(void)
1483 struct sftp_packet *pktin;
1484 struct sftp_request *req, *rreq;
1487 * Do protocol initialisation.
1491 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
1492 return 1; /* failure */
1496 * Find out where our home directory is.
1498 sftp_register(req = fxp_realpath_send("."));
1499 rreq = sftp_find_request(pktin = sftp_recv());
1500 assert(rreq == req);
1501 homedir = fxp_realpath_recv(pktin, rreq);
1505 "Warning: failed to resolve home directory: %s\n",
1507 homedir = dupstr(".");
1509 printf("Remote working directory is %s\n", homedir);
1511 pwd = dupstr(homedir);
1515 void do_sftp(int mode, int modeflags, char *batchfile)
1525 /* ------------------------------------------------------------------
1526 * Now we're ready to do Real Stuff.
1529 struct sftp_command *cmd;
1530 cmd = sftp_getcmd(stdin, 0, 0);
1533 if (cmd->obey(cmd) < 0)
1537 fp = fopen(batchfile, "r");
1539 printf("Fatal: unable to open %s\n", batchfile);
1543 struct sftp_command *cmd;
1544 cmd = sftp_getcmd(fp, mode, modeflags);
1547 ret = cmd->obey(cmd);
1551 if (!(modeflags & 2))
1560 /* ----------------------------------------------------------------------
1561 * Dirty bits: integration with PuTTY.
1564 static int verbose = 0;
1567 * Print an error message and perform a fatal exit.
1569 void fatalbox(char *fmt, ...)
1574 str = dupvprintf(fmt, ap);
1575 str2 = dupcat("Fatal: ", str, "\n", NULL);
1578 fputs(str2, stderr);
1583 void modalfatalbox(char *fmt, ...)
1588 str = dupvprintf(fmt, ap);
1589 str2 = dupcat("Fatal: ", str, "\n", NULL);
1592 fputs(str2, stderr);
1597 void connection_fatal(void *frontend, char *fmt, ...)
1602 str = dupvprintf(fmt, ap);
1603 str2 = dupcat("Fatal: ", str, "\n", NULL);
1606 fputs(str2, stderr);
1612 void ldisc_send(void *handle, char *buf, int len, int interactive)
1615 * This is only here because of the calls to ldisc_send(NULL,
1616 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
1617 * ldisc as an ldisc. So if we get called with any real data, I
1618 * want to know about it.
1624 * Be told what socket we're supposed to be using.
1626 static SOCKET sftp_ssh_socket;
1627 char *do_select(SOCKET skt, int startup)
1630 sftp_ssh_socket = skt;
1632 sftp_ssh_socket = INVALID_SOCKET;
1635 extern int select_result(WPARAM, LPARAM);
1638 * In psftp, all agent requests should be synchronous, so this is a
1639 * never-called stub.
1641 void agent_schedule_callback(void (*callback)(void *, void *, int),
1642 void *callback_ctx, void *data, int len)
1644 assert(!"We shouldn't be here");
1648 * Receive a block of data from the SSH link. Block until all data
1651 * To do this, we repeatedly call the SSH protocol module, with our
1652 * own trap in from_backend() to catch the data that comes back. We
1653 * do this until we have enough data.
1656 static unsigned char *outptr; /* where to put the data */
1657 static unsigned outlen; /* how much data required */
1658 static unsigned char *pending = NULL; /* any spare data */
1659 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
1660 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
1662 unsigned char *p = (unsigned char *) data;
1663 unsigned len = (unsigned) datalen;
1668 * stderr data is just spouted to local stderr and otherwise
1672 fwrite(data, 1, len, stderr);
1677 * If this is before the real session begins, just return.
1683 unsigned used = outlen;
1686 memcpy(outptr, p, used);
1694 if (pendsize < pendlen + len) {
1695 pendsize = pendlen + len + 4096;
1696 pending = sresize(pending, pendsize, unsigned char);
1698 memcpy(pending + pendlen, p, len);
1704 int sftp_recvdata(char *buf, int len)
1706 outptr = (unsigned char *) buf;
1710 * See if the pending-input block contains some of what we
1714 unsigned pendused = pendlen;
1715 if (pendused > outlen)
1717 memcpy(outptr, pending, pendused);
1718 memmove(pending, pending + pendused, pendlen - pendused);
1721 pendlen -= pendused;
1731 while (outlen > 0) {
1735 FD_SET(sftp_ssh_socket, &readfds);
1736 if (select(1, &readfds, NULL, NULL, NULL) < 0)
1737 return 0; /* doom */
1738 select_result((WPARAM) sftp_ssh_socket, (LPARAM) FD_READ);
1743 int sftp_senddata(char *buf, int len)
1745 back->send(backhandle, (unsigned char *) buf, len);
1750 * Loop through the ssh connection and authentication process.
1752 static void ssh_sftp_init(void)
1754 if (sftp_ssh_socket == INVALID_SOCKET)
1756 while (!back->sendok(backhandle)) {
1759 FD_SET(sftp_ssh_socket, &readfds);
1760 if (select(1, &readfds, NULL, NULL, NULL) < 0)
1762 select_result((WPARAM) sftp_ssh_socket, (LPARAM) FD_READ);
1767 * Initialize the Win$ock driver.
1769 static void init_winsock(void)
1774 winsock_ver = MAKEWORD(1, 1);
1775 if (WSAStartup(winsock_ver, &wsadata)) {
1776 fprintf(stderr, "Unable to initialise WinSock");
1779 if (LOBYTE(wsadata.wVersion) != 1 || HIBYTE(wsadata.wVersion) != 1) {
1780 fprintf(stderr, "WinSock version is incompatible with 1.1");
1786 * Short description of parameters.
1788 static void usage(void)
1790 printf("PuTTY Secure File Transfer (SFTP) client\n");
1791 printf("%s\n", ver);
1792 printf("Usage: psftp [options] user@host\n");
1793 printf("Options:\n");
1794 printf(" -b file use specified batchfile\n");
1795 printf(" -bc output batchfile commands\n");
1796 printf(" -be don't stop batchfile processing if errors\n");
1797 printf(" -v show verbose messages\n");
1798 printf(" -load sessname Load settings from saved session\n");
1799 printf(" -l user connect with specified username\n");
1800 printf(" -P port connect to specified port\n");
1801 printf(" -pw passw login with specified password\n");
1802 printf(" -1 -2 force use of particular SSH protocol version\n");
1803 printf(" -C enable compression\n");
1804 printf(" -i key private key file for authentication\n");
1805 printf(" -batch disable all interactive prompts\n");
1810 * Connect to a host.
1812 static int psftp_connect(char *userhost, char *user, int portnumber)
1814 char *host, *realhost;
1817 /* Separate host and username */
1819 host = strrchr(host, '@');
1825 printf("psftp: multiple usernames specified; using \"%s\"\n",
1831 /* Try to load settings for this host */
1832 do_defaults(host, &cfg);
1833 if (cfg.host[0] == '\0') {
1834 /* No settings for this host; use defaults */
1835 do_defaults(NULL, &cfg);
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 * Enact command-line overrides.
1852 cmdline_run_saved(&cfg);
1855 * Trim leading whitespace off the hostname if it's there.
1858 int space = strspn(cfg.host, " \t");
1859 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
1862 /* See if host is of the form user@host */
1863 if (cfg.host[0] != '\0') {
1864 char *atsign = strchr(cfg.host, '@');
1865 /* Make sure we're not overflowing the user field */
1867 if (atsign - cfg.host < sizeof cfg.username) {
1868 strncpy(cfg.username, cfg.host, atsign - cfg.host);
1869 cfg.username[atsign - cfg.host] = '\0';
1871 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
1876 * Trim a colon suffix off the hostname if it's there.
1878 cfg.host[strcspn(cfg.host, ":")] = '\0';
1881 * Remove any remaining whitespace from the hostname.
1885 while (cfg.host[p2] != '\0') {
1886 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
1887 cfg.host[p1] = cfg.host[p2];
1892 cfg.host[p1] = '\0';
1896 if (user != NULL && user[0] != '\0') {
1897 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
1898 cfg.username[sizeof(cfg.username) - 1] = '\0';
1900 if (!cfg.username[0]) {
1901 printf("login as: ");
1903 if (!fgets(cfg.username, sizeof(cfg.username), stdin)) {
1904 fprintf(stderr, "psftp: aborting\n");
1907 int len = strlen(cfg.username);
1908 if (cfg.username[len - 1] == '\n')
1909 cfg.username[len - 1] = '\0';
1914 cfg.port = portnumber;
1916 /* SFTP uses SSH2 by default always */
1920 * Disable scary things which shouldn't be enabled for simple
1921 * things like SCP and SFTP: agent forwarding, port forwarding,
1924 cfg.x11_forward = 0;
1926 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
1928 /* Set up subsystem name. */
1929 strcpy(cfg.remote_cmd, "sftp");
1930 cfg.ssh_subsys = TRUE;
1934 * Set up fallback option, for SSH1 servers or servers with the
1935 * sftp subsystem not enabled but the server binary installed
1936 * in the usual place. We only support fallback on Unix
1937 * systems, and we use a kludgy piece of shellery which should
1938 * try to find sftp-server in various places (the obvious
1939 * systemwide spots /usr/lib and /usr/local/lib, and then the
1940 * user's PATH) and finally give up.
1942 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
1943 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
1946 * the idea being that this will attempt to use either of the
1947 * obvious pathnames and then give up, and when it does give up
1948 * it will print the preferred pathname in the error messages.
1950 cfg.remote_cmd_ptr2 =
1951 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
1952 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
1954 cfg.ssh_subsys2 = FALSE;
1956 back = &ssh_backend;
1958 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,0);
1960 fprintf(stderr, "ssh_init: %s\n", err);
1963 logctx = log_init(NULL, &cfg);
1964 back->provide_logctx(backhandle, logctx);
1965 console_provide_logctx(logctx);
1967 if (verbose && realhost != NULL)
1968 printf("Connected to %s\n", realhost);
1972 void cmdline_error(char *p, ...)
1975 fprintf(stderr, "psftp: ");
1977 vfprintf(stderr, p, ap);
1979 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
1984 * Main program. Parse arguments etc.
1986 int main(int argc, char *argv[])
1990 char *userhost, *user;
1993 char *batchfile = NULL;
1996 flags = FLAG_STDERR | FLAG_INTERACTIVE | FLAG_SYNCAGENT;
1997 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
1998 ssh_get_line = &console_get_line;
2002 userhost = user = NULL;
2005 for (i = 1; i < argc; i++) {
2007 if (argv[i][0] != '-') {
2011 userhost = dupstr(argv[i]);
2014 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2016 cmdline_error("option \"%s\" requires an argument", argv[i]);
2017 } else if (ret == 2) {
2018 i++; /* skip next argument */
2019 } else if (ret == 1) {
2020 /* We have our own verbosity in addition to `flags'. */
2021 if (flags & FLAG_VERBOSE)
2023 } else if (strcmp(argv[i], "-h") == 0 ||
2024 strcmp(argv[i], "-?") == 0) {
2026 } else if (strcmp(argv[i], "-batch") == 0) {
2027 console_batch_mode = 1;
2028 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2030 batchfile = argv[++i];
2031 } else if (strcmp(argv[i], "-bc") == 0) {
2032 modeflags = modeflags | 1;
2033 } else if (strcmp(argv[i], "-be") == 0) {
2034 modeflags = modeflags | 2;
2035 } else if (strcmp(argv[i], "--") == 0) {
2039 cmdline_error("unknown option \"%s\"", argv[i]);
2047 * If a user@host string has already been provided, connect to
2051 if (psftp_connect(userhost, user, portnumber))
2056 printf("psftp: no hostname specified; use \"open host.name\""
2060 do_sftp(mode, modeflags, batchfile);
2062 if (back != NULL && back->socket(backhandle) != NULL) {
2064 back->special(backhandle, TS_EOF);
2065 sftp_recvdata(&ch, 1);