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, '\\');
172 * qsort comparison routine for fxp_name structures. Sorts by real
175 static int sftp_name_compare(const void *av, const void *bv)
177 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
178 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
179 return strcmp((*a)->filename, (*b)->filename);
183 * Likewise, but for a bare char *.
185 static int bare_name_compare(const void *av, const void *bv)
187 const char **a = (const char **) av;
188 const char **b = (const char **) bv;
189 return strcmp(*a, *b);
192 /* ----------------------------------------------------------------------
193 * The meat of the `get' and `put' commands.
195 int sftp_get_file(char *fname, char *outfname, int recurse, int restart,
198 struct fxp_handle *fh;
199 struct sftp_packet *pktin;
200 struct sftp_request *req, *rreq;
201 struct fxp_xfer *xfer;
204 int ret, shown_err = FALSE;
207 * In recursive mode, see if we're dealing with a directory.
208 * (If we're not in recursive mode, we need not even check: the
209 * subsequent FXP_OPEN will return a usable error message.)
211 if (wildcard || recurse) {
212 struct fxp_attrs attrs;
216 sftp_register(req = fxp_stat_send(fname));
217 rreq = sftp_find_request(pktin = sftp_recv());
219 result = fxp_stat_recv(pktin, rreq, &attrs);
221 result = 0; /* placate optimisers */
225 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
226 (attrs.permissions & 0040000))) {
228 struct fxp_handle *dirhandle;
229 int nnames, namesize;
230 struct fxp_name **ournames;
231 struct fxp_names *names;
235 * First, attempt to create the destination directory,
236 * unless it already exists (or this is a wildcard
240 file_type(outfname) != FILE_TYPE_DIRECTORY &&
241 !create_directory(outfname)) {
242 printf("%s: Cannot create directory\n", outfname);
247 * Now get the list of filenames in the remote
250 sftp_register(req = fxp_opendir_send(fname));
251 rreq = sftp_find_request(pktin = sftp_recv());
253 dirhandle = fxp_opendir_recv(pktin, rreq);
256 printf("%s: unable to open directory: %s\n",
260 nnames = namesize = 0;
265 sftp_register(req = fxp_readdir_send(dirhandle));
266 rreq = sftp_find_request(pktin = sftp_recv());
268 names = fxp_readdir_recv(pktin, rreq);
271 if (fxp_error_type() == SSH_FX_EOF)
273 printf("%s: reading directory: %s\n", fname, fxp_error());
277 if (names->nnames == 0) {
278 fxp_free_names(names);
281 if (nnames + names->nnames >= namesize) {
282 namesize += names->nnames + 128;
283 ournames = sresize(ournames, namesize, struct fxp_name *);
285 for (i = 0; i < names->nnames; i++)
286 if (strcmp(names->names[i].filename, ".") &&
287 strcmp(names->names[i].filename, "..") &&
288 (!wildcard || wc_match(wildcard,
289 names->names[i].filename))) {
290 if (!vet_filename(names->names[i].filename)) {
291 printf("ignoring potentially dangerous server-"
292 "supplied filename '%s'\n",
293 names->names[i].filename);
296 fxp_dup_name(&names->names[i]);
299 fxp_free_names(names);
301 sftp_register(req = fxp_close_send(dirhandle));
302 rreq = sftp_find_request(pktin = sftp_recv());
304 fxp_close_recv(pktin, rreq);
307 * A polite warning if nothing at all matched the
310 if (wildcard && !nnames) {
311 printf("%s: nothing matched\n", wildcard);
315 * Sort the names into a clear order. This ought to
316 * make things more predictable when we're doing a
317 * reget of the same directory, just in case two
318 * readdirs on the same remote directory return a
321 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
324 * If we're in restart mode, find the last filename on
325 * this list that already exists. We may have to do a
326 * reget on _that_ file, but shouldn't have to do
327 * anything on the previous files.
329 * If none of them exists, of course, we start at 0.
336 nextoutfname = dir_file_cat(outfname,
337 ournames[i]->filename);
339 nextoutfname = dupstr(ournames[i]->filename);
340 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
350 * Now we're ready to recurse. Starting at ournames[i]
351 * and continuing on to the end of the list, we
352 * construct a new source and target file name, and
353 * call sftp_get_file again.
355 for (; i < nnames; i++) {
356 char *nextfname, *nextoutfname;
359 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
361 nextoutfname = dir_file_cat(outfname,
362 ournames[i]->filename);
364 nextoutfname = dupstr(ournames[i]->filename);
365 ret = sftp_get_file(nextfname, nextoutfname,
366 recurse, restart, NULL);
367 restart = FALSE; /* after first partial file, do full */
371 for (i = 0; i < nnames; i++) {
372 fxp_free_name(ournames[i]);
380 * Done this recursion level. Free everything.
382 for (i = 0; i < nnames; i++) {
383 fxp_free_name(ournames[i]);
391 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
392 rreq = sftp_find_request(pktin = sftp_recv());
394 fh = fxp_open_recv(pktin, rreq);
397 printf("%s: %s\n", fname, fxp_error());
402 fp = fopen(outfname, "rb+");
404 fp = fopen(outfname, "wb");
408 printf("local: unable to open %s\n", outfname);
410 sftp_register(req = fxp_close_send(fh));
411 rreq = sftp_find_request(pktin = sftp_recv());
413 fxp_close_recv(pktin, rreq);
420 fseek(fp, 0L, SEEK_END);
422 printf("reget: restarting at file position %ld\n", posn);
423 offset = uint64_make(0, posn);
425 offset = uint64_make(0, 0);
428 printf("remote:%s => local:%s\n", fname, outfname);
431 * FIXME: we can use FXP_FSTAT here to get the file size, and
432 * thus put up a progress bar.
435 xfer = xfer_download_init(fh, offset);
436 while (!xfer_done(xfer)) {
441 xfer_download_queue(xfer);
443 ret = xfer_download_gotpkt(xfer, pktin);
447 printf("error while reading: %s\n", fxp_error());
453 while (xfer_download_data(xfer, &vbuf, &len)) {
454 unsigned char *buf = (unsigned char *)vbuf;
458 wlen = fwrite(buf + wpos, 1, len - wpos, fp);
460 printf("error while writing local file\n");
462 xfer_set_error(xfer);
466 if (wpos < len) { /* we had an error */
468 xfer_set_error(xfer);
479 sftp_register(req = fxp_close_send(fh));
480 rreq = sftp_find_request(pktin = sftp_recv());
482 fxp_close_recv(pktin, rreq);
487 int sftp_put_file(char *fname, char *outfname, int recurse, int restart,
490 struct fxp_handle *fh;
491 struct fxp_xfer *xfer;
492 struct sftp_packet *pktin;
493 struct sftp_request *req, *rreq;
499 * In recursive mode, see if we're dealing with a directory.
500 * (If we're not in recursive mode, we need not even check: the
501 * subsequent fopen will return an error message.)
503 if (wildcard || (recurse && file_type(fname) == FILE_TYPE_DIRECTORY)) {
504 struct fxp_attrs attrs;
506 int nnames, namesize;
507 char *name, **ournames;
513 * First, attempt to create the destination directory,
514 * unless it already exists.
516 sftp_register(req = fxp_stat_send(outfname));
517 rreq = sftp_find_request(pktin = sftp_recv());
519 result = fxp_stat_recv(pktin, rreq, &attrs);
521 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
522 !(attrs.permissions & 0040000)) {
523 sftp_register(req = fxp_mkdir_send(outfname));
524 rreq = sftp_find_request(pktin = sftp_recv());
526 result = fxp_mkdir_recv(pktin, rreq);
529 printf("%s: create directory: %s\n",
530 outfname, fxp_error());
537 * Now get the list of filenames in the local directory.
539 nnames = namesize = 0;
542 WildcardMatcher *wcm;
544 wcm = begin_wildcard_matching(wildcard);
546 while ((name = wildcard_get_filename(wcm)) != NULL) {
547 if (nnames >= namesize) {
549 ournames = sresize(ournames, namesize, char *);
551 ournames[nnames++] = name;
553 finish_wildcard_matching(wcm);
556 dh = open_directory(fname);
558 printf("%s: unable to open directory\n", fname);
561 while ((name = read_filename(dh)) != NULL) {
562 if (nnames >= namesize) {
564 ournames = sresize(ournames, namesize, char *);
566 ournames[nnames++] = name;
572 * A polite warning if nothing at all matched the
575 if (wildcard && !nnames) {
576 printf("%s: nothing matched\n", wildcard);
580 * Sort the names into a clear order. This ought to make
581 * things more predictable when we're doing a reput of the
582 * same directory, just in case two readdirs on the same
583 * local directory return a different order.
585 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
588 * If we're in restart mode, find the last filename on this
589 * list that already exists. We may have to do a reput on
590 * _that_ file, but shouldn't have to do anything on the
593 * If none of them exists, of course, we start at 0.
598 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
599 sftp_register(req = fxp_stat_send(nextoutfname));
600 rreq = sftp_find_request(pktin = sftp_recv());
602 result = fxp_stat_recv(pktin, rreq, &attrs);
612 * Now we're ready to recurse. Starting at ournames[i]
613 * and continuing on to the end of the list, we
614 * construct a new source and target file name, and
615 * call sftp_put_file again.
617 for (; i < nnames; i++) {
618 char *nextfname, *nextoutfname;
622 nextfname = dir_file_cat(fname, ournames[i]);
624 nextfname = dupstr(ournames[i]);
625 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
626 ret = sftp_put_file(nextfname, nextoutfname,
627 recurse, restart, NULL);
628 restart = FALSE; /* after first partial file, do full */
632 for (i = 0; i < nnames; i++) {
641 * Done this recursion level. Free everything.
643 for (i = 0; i < nnames; i++) {
651 fp = fopen(fname, "rb");
653 printf("local: unable to open %s\n", fname);
657 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
659 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
660 SSH_FXF_CREAT | SSH_FXF_TRUNC));
662 rreq = sftp_find_request(pktin = sftp_recv());
664 fh = fxp_open_recv(pktin, rreq);
667 printf("%s: %s\n", outfname, fxp_error());
673 struct fxp_attrs attrs;
676 sftp_register(req = fxp_fstat_send(fh));
677 rreq = sftp_find_request(pktin = sftp_recv());
679 ret = fxp_fstat_recv(pktin, rreq, &attrs);
682 printf("read size of %s: %s\n", outfname, fxp_error());
685 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
686 printf("read size of %s: size was not given\n", outfname);
690 uint64_decimal(offset, decbuf);
691 printf("reput: restarting at file position %s\n", decbuf);
692 if (uint64_compare(offset, uint64_make(0, LONG_MAX)) > 0) {
693 printf("reput: remote file is larger than we can deal with\n");
696 if (fseek(fp, offset.lo, SEEK_SET) != 0)
697 fseek(fp, 0, SEEK_END); /* *shrug* */
699 offset = uint64_make(0, 0);
702 printf("local:%s => remote:%s\n", fname, outfname);
705 * FIXME: we can use FXP_FSTAT here to get the file size, and
706 * thus put up a progress bar.
709 xfer = xfer_upload_init(fh, offset);
711 while ((!err && !eof) || !xfer_done(xfer)) {
715 while (xfer_upload_ready(xfer) && !err && !eof) {
716 len = fread(buffer, 1, sizeof(buffer), fp);
718 printf("error while reading local file\n");
720 } else if (len == 0) {
723 xfer_upload_data(xfer, buffer, len);
727 if (!xfer_done(xfer)) {
729 ret = xfer_upload_gotpkt(xfer, pktin);
731 printf("error while writing: %s\n", fxp_error());
739 sftp_register(req = fxp_close_send(fh));
740 rreq = sftp_find_request(pktin = sftp_recv());
742 fxp_close_recv(pktin, rreq);
749 /* ----------------------------------------------------------------------
750 * Actual sftp commands.
752 struct sftp_command {
754 int nwords, wordssize;
755 int (*obey) (struct sftp_command *); /* returns <0 to quit */
758 int sftp_cmd_null(struct sftp_command *cmd)
760 return 1; /* success */
763 int sftp_cmd_unknown(struct sftp_command *cmd)
765 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
766 return 0; /* failure */
769 int sftp_cmd_quit(struct sftp_command *cmd)
774 int sftp_cmd_close(struct sftp_command *cmd)
777 printf("psftp: not connected to a host; use \"open host.name\"\n");
781 if (back != NULL && back->socket(backhandle) != NULL) {
783 back->special(backhandle, TS_EOF);
784 sftp_recvdata(&ch, 1);
792 * List a directory. If no arguments are given, list pwd; otherwise
793 * list the directory given in words[1].
795 int sftp_cmd_ls(struct sftp_command *cmd)
797 struct fxp_handle *dirh;
798 struct fxp_names *names;
799 struct fxp_name **ournames;
800 int nnames, namesize;
801 char *dir, *cdir, *unwcdir, *wildcard;
802 struct sftp_packet *pktin;
803 struct sftp_request *req, *rreq;
807 printf("psftp: not connected to a host; use \"open host.name\"\n");
816 unwcdir = snewn(1 + strlen(dir), char);
817 if (wc_unescape(unwcdir, dir)) {
824 wildcard = stripslashes(dir, 0);
825 unwcdir = dupstr(dir);
826 len = wildcard - dir;
828 if (len > 0 && unwcdir[len-1] == '/')
829 unwcdir[len-1] = '\0';
830 tmpdir = snewn(1 + len, char);
831 check = wc_unescape(tmpdir, unwcdir);
834 printf("Multiple-level wildcards are not supported\n");
841 cdir = canonify(dir);
843 printf("%s: %s\n", dir, fxp_error());
848 printf("Listing directory %s\n", cdir);
850 sftp_register(req = fxp_opendir_send(cdir));
851 rreq = sftp_find_request(pktin = sftp_recv());
853 dirh = fxp_opendir_recv(pktin, rreq);
856 printf("Unable to open %s: %s\n", dir, fxp_error());
858 nnames = namesize = 0;
863 sftp_register(req = fxp_readdir_send(dirh));
864 rreq = sftp_find_request(pktin = sftp_recv());
866 names = fxp_readdir_recv(pktin, rreq);
869 if (fxp_error_type() == SSH_FX_EOF)
871 printf("Reading directory %s: %s\n", dir, fxp_error());
874 if (names->nnames == 0) {
875 fxp_free_names(names);
879 if (nnames + names->nnames >= namesize) {
880 namesize += names->nnames + 128;
881 ournames = sresize(ournames, namesize, struct fxp_name *);
884 for (i = 0; i < names->nnames; i++)
885 if (!wildcard || wc_match(wildcard, names->names[i].filename))
886 ournames[nnames++] = fxp_dup_name(&names->names[i]);
888 fxp_free_names(names);
890 sftp_register(req = fxp_close_send(dirh));
891 rreq = sftp_find_request(pktin = sftp_recv());
893 fxp_close_recv(pktin, rreq);
896 * Now we have our filenames. Sort them by actual file
897 * name, and then output the longname parts.
899 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
904 for (i = 0; i < nnames; i++) {
905 printf("%s\n", ournames[i]->longname);
906 fxp_free_name(ournames[i]);
918 * Change directories. We do this by canonifying the new name, then
919 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
921 int sftp_cmd_cd(struct sftp_command *cmd)
923 struct fxp_handle *dirh;
924 struct sftp_packet *pktin;
925 struct sftp_request *req, *rreq;
929 printf("psftp: not connected to a host; use \"open host.name\"\n");
934 dir = dupstr(homedir);
936 dir = canonify(cmd->words[1]);
939 printf("%s: %s\n", dir, fxp_error());
943 sftp_register(req = fxp_opendir_send(dir));
944 rreq = sftp_find_request(pktin = sftp_recv());
946 dirh = fxp_opendir_recv(pktin, rreq);
949 printf("Directory %s: %s\n", dir, fxp_error());
954 sftp_register(req = fxp_close_send(dirh));
955 rreq = sftp_find_request(pktin = sftp_recv());
957 fxp_close_recv(pktin, rreq);
961 printf("Remote directory is now %s\n", pwd);
967 * Print current directory. Easy as pie.
969 int sftp_cmd_pwd(struct sftp_command *cmd)
972 printf("psftp: not connected to a host; use \"open host.name\"\n");
976 printf("Remote directory is %s\n", pwd);
981 * Get a file and save it at the local end. We have three very
982 * similar commands here. The basic one is `get'; `reget' differs
983 * in that it checks for the existence of the destination file and
984 * starts from where a previous aborted transfer left off; `mget'
985 * differs in that it interprets all its arguments as files to
986 * transfer (never as a different local name for a remote file) and
987 * can handle wildcards.
989 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
991 char *fname, *unwcfname, *origfname, *outfname;
996 printf("psftp: not connected to a host; use \"open host.name\"\n");
1001 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1002 if (!strcmp(cmd->words[i], "--")) {
1003 /* finish processing options */
1006 } else if (!strcmp(cmd->words[i], "-r")) {
1009 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1015 if (i >= cmd->nwords) {
1016 printf("%s: expects a filename\n", cmd->words[0]);
1022 origfname = cmd->words[i++];
1025 !wc_unescape(unwcfname = snewn(strlen(origfname)+1, char),
1027 ret = sftp_get_file(pwd, NULL, recurse, restart, origfname);
1029 fname = canonify(origfname);
1031 printf("%s: %s\n", origfname, fxp_error());
1036 if (!multiple && i < cmd->nwords)
1037 outfname = cmd->words[i++];
1039 outfname = stripslashes(origfname, 0);
1041 ret = sftp_get_file(fname, outfname, recurse, restart, NULL);
1049 } while (multiple && i < cmd->nwords);
1053 int sftp_cmd_get(struct sftp_command *cmd)
1055 return sftp_general_get(cmd, 0, 0);
1057 int sftp_cmd_mget(struct sftp_command *cmd)
1059 return sftp_general_get(cmd, 0, 1);
1061 int sftp_cmd_reget(struct sftp_command *cmd)
1063 return sftp_general_get(cmd, 1, 0);
1067 * Send a file and store it at the remote end. We have three very
1068 * similar commands here. The basic one is `put'; `reput' differs
1069 * in that it checks for the existence of the destination file and
1070 * starts from where a previous aborted transfer left off; `mput'
1071 * differs in that it interprets all its arguments as files to
1072 * transfer (never as a different remote name for a local file) and
1073 * can handle wildcards.
1075 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1077 char *fname, *origoutfname, *outfname;
1079 int recurse = FALSE;
1082 printf("psftp: not connected to a host; use \"open host.name\"\n");
1087 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1088 if (!strcmp(cmd->words[i], "--")) {
1089 /* finish processing options */
1092 } else if (!strcmp(cmd->words[i], "-r")) {
1095 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1101 if (i >= cmd->nwords) {
1102 printf("%s: expects a filename\n", cmd->words[0]);
1107 fname = cmd->words[i++];
1109 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1110 ret = sftp_put_file(NULL, pwd, recurse, restart, fname);
1112 if (!multiple && i < cmd->nwords)
1113 origoutfname = cmd->words[i++];
1115 origoutfname = stripslashes(fname, 1);
1117 outfname = canonify(origoutfname);
1119 printf("%s: %s\n", origoutfname, fxp_error());
1122 ret = sftp_put_file(fname, outfname, recurse, restart, NULL);
1128 } while (multiple && i < cmd->nwords);
1132 int sftp_cmd_put(struct sftp_command *cmd)
1134 return sftp_general_put(cmd, 0, 0);
1136 int sftp_cmd_mput(struct sftp_command *cmd)
1138 return sftp_general_put(cmd, 0, 1);
1140 int sftp_cmd_reput(struct sftp_command *cmd)
1142 return sftp_general_put(cmd, 1, 0);
1145 int sftp_cmd_mkdir(struct sftp_command *cmd)
1148 struct sftp_packet *pktin;
1149 struct sftp_request *req, *rreq;
1153 printf("psftp: not connected to a host; use \"open host.name\"\n");
1157 if (cmd->nwords < 2) {
1158 printf("mkdir: expects a directory\n");
1162 dir = canonify(cmd->words[1]);
1164 printf("%s: %s\n", dir, fxp_error());
1168 sftp_register(req = fxp_mkdir_send(dir));
1169 rreq = sftp_find_request(pktin = sftp_recv());
1170 assert(rreq == req);
1171 result = fxp_mkdir_recv(pktin, rreq);
1174 printf("mkdir %s: %s\n", dir, fxp_error());
1183 int sftp_cmd_rmdir(struct sftp_command *cmd)
1186 struct sftp_packet *pktin;
1187 struct sftp_request *req, *rreq;
1191 printf("psftp: not connected to a host; use \"open host.name\"\n");
1195 if (cmd->nwords < 2) {
1196 printf("rmdir: expects a directory\n");
1200 dir = canonify(cmd->words[1]);
1202 printf("%s: %s\n", dir, fxp_error());
1206 sftp_register(req = fxp_rmdir_send(dir));
1207 rreq = sftp_find_request(pktin = sftp_recv());
1208 assert(rreq == req);
1209 result = fxp_rmdir_recv(pktin, rreq);
1212 printf("rmdir %s: %s\n", dir, fxp_error());
1221 int sftp_cmd_rm(struct sftp_command *cmd)
1224 struct sftp_packet *pktin;
1225 struct sftp_request *req, *rreq;
1229 printf("psftp: not connected to a host; use \"open host.name\"\n");
1233 if (cmd->nwords < 2) {
1234 printf("rm: expects a filename\n");
1238 fname = canonify(cmd->words[1]);
1240 printf("%s: %s\n", fname, fxp_error());
1244 sftp_register(req = fxp_remove_send(fname));
1245 rreq = sftp_find_request(pktin = sftp_recv());
1246 assert(rreq == req);
1247 result = fxp_remove_recv(pktin, rreq);
1250 printf("rm %s: %s\n", fname, fxp_error());
1259 int sftp_cmd_mv(struct sftp_command *cmd)
1261 char *srcfname, *dstfname;
1262 struct sftp_packet *pktin;
1263 struct sftp_request *req, *rreq;
1267 printf("psftp: not connected to a host; use \"open host.name\"\n");
1271 if (cmd->nwords < 3) {
1272 printf("mv: expects two filenames\n");
1275 srcfname = canonify(cmd->words[1]);
1277 printf("%s: %s\n", srcfname, fxp_error());
1281 dstfname = canonify(cmd->words[2]);
1283 printf("%s: %s\n", dstfname, fxp_error());
1287 sftp_register(req = fxp_rename_send(srcfname, dstfname));
1288 rreq = sftp_find_request(pktin = sftp_recv());
1289 assert(rreq == req);
1290 result = fxp_rename_recv(pktin, rreq);
1293 char const *error = fxp_error();
1294 struct fxp_attrs attrs;
1297 * The move might have failed because dstfname pointed at a
1298 * directory. We check this possibility now: if dstfname
1299 * _is_ a directory, we re-attempt the move by appending
1300 * the basename of srcfname to dstfname.
1302 sftp_register(req = fxp_stat_send(dstfname));
1303 rreq = sftp_find_request(pktin = sftp_recv());
1304 assert(rreq == req);
1305 result = fxp_stat_recv(pktin, rreq, &attrs);
1308 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1309 (attrs.permissions & 0040000)) {
1311 char *newname, *newcanon;
1312 printf("(destination %s is a directory)\n", dstfname);
1313 p = srcfname + strlen(srcfname);
1314 while (p > srcfname && p[-1] != '/') p--;
1315 newname = dupcat(dstfname, "/", p, NULL);
1316 newcanon = canonify(newname);
1320 dstfname = newcanon;
1322 sftp_register(req = fxp_rename_send(srcfname, dstfname));
1323 rreq = sftp_find_request(pktin = sftp_recv());
1324 assert(rreq == req);
1325 result = fxp_rename_recv(pktin, rreq);
1327 error = result ? NULL : fxp_error();
1331 printf("mv %s %s: %s\n", srcfname, dstfname, error);
1337 printf("%s -> %s\n", srcfname, dstfname);
1344 int sftp_cmd_chmod(struct sftp_command *cmd)
1348 struct fxp_attrs attrs;
1349 unsigned attrs_clr, attrs_xor, oldperms, newperms;
1350 struct sftp_packet *pktin;
1351 struct sftp_request *req, *rreq;
1354 printf("psftp: not connected to a host; use \"open host.name\"\n");
1358 if (cmd->nwords < 3) {
1359 printf("chmod: expects a mode specifier and a filename\n");
1364 * Attempt to parse the mode specifier in cmd->words[1]. We
1365 * don't support the full horror of Unix chmod; instead we
1366 * support a much simpler syntax in which the user can either
1367 * specify an octal number, or a comma-separated sequence of
1368 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1369 * _only_ be omitted if the only attribute mentioned is t,
1370 * since all others require a user/group/other specification.
1371 * Additionally, the s attribute may not be specified for any
1372 * [ugoa] specifications other than exactly u or exactly g.
1374 attrs_clr = attrs_xor = 0;
1375 mode = cmd->words[1];
1376 if (mode[0] >= '0' && mode[0] <= '9') {
1377 if (mode[strspn(mode, "01234567")]) {
1378 printf("chmod: numeric file modes should"
1379 " contain digits 0-7 only\n");
1383 sscanf(mode, "%o", &attrs_xor);
1384 attrs_xor &= attrs_clr;
1387 char *modebegin = mode;
1388 unsigned subset, perms;
1392 while (*mode && *mode != ',' &&
1393 *mode != '+' && *mode != '-' && *mode != '=') {
1395 case 'u': subset |= 04700; break; /* setuid, user perms */
1396 case 'g': subset |= 02070; break; /* setgid, group perms */
1397 case 'o': subset |= 00007; break; /* just other perms */
1398 case 'a': subset |= 06777; break; /* all of the above */
1400 printf("chmod: file mode '%.*s' contains unrecognised"
1401 " user/group/other specifier '%c'\n",
1402 (int)strcspn(modebegin, ","), modebegin, *mode);
1407 if (!*mode || *mode == ',') {
1408 printf("chmod: file mode '%.*s' is incomplete\n",
1409 (int)strcspn(modebegin, ","), modebegin);
1413 if (!*mode || *mode == ',') {
1414 printf("chmod: file mode '%.*s' is incomplete\n",
1415 (int)strcspn(modebegin, ","), modebegin);
1419 while (*mode && *mode != ',') {
1421 case 'r': perms |= 00444; break;
1422 case 'w': perms |= 00222; break;
1423 case 'x': perms |= 00111; break;
1424 case 't': perms |= 01000; subset |= 01000; break;
1426 if ((subset & 06777) != 04700 &&
1427 (subset & 06777) != 02070) {
1428 printf("chmod: file mode '%.*s': set[ug]id bit should"
1429 " be used with exactly one of u or g only\n",
1430 (int)strcspn(modebegin, ","), modebegin);
1436 printf("chmod: file mode '%.*s' contains unrecognised"
1437 " permission specifier '%c'\n",
1438 (int)strcspn(modebegin, ","), modebegin, *mode);
1443 if (!(subset & 06777) && (perms &~ subset)) {
1444 printf("chmod: file mode '%.*s' contains no user/group/other"
1445 " specifier and permissions other than 't' \n",
1446 (int)strcspn(modebegin, ","), modebegin);
1457 attrs_xor &= ~perms;
1460 attrs_clr |= subset;
1464 if (*mode) mode++; /* eat comma */
1468 fname = canonify(cmd->words[2]);
1470 printf("%s: %s\n", fname, fxp_error());
1474 sftp_register(req = fxp_stat_send(fname));
1475 rreq = sftp_find_request(pktin = sftp_recv());
1476 assert(rreq == req);
1477 result = fxp_stat_recv(pktin, rreq, &attrs);
1479 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1480 printf("get attrs for %s: %s\n", fname,
1481 result ? "file permissions not provided" : fxp_error());
1486 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1487 oldperms = attrs.permissions & 07777;
1488 attrs.permissions &= ~attrs_clr;
1489 attrs.permissions ^= attrs_xor;
1490 newperms = attrs.permissions & 07777;
1492 sftp_register(req = fxp_setstat_send(fname, attrs));
1493 rreq = sftp_find_request(pktin = sftp_recv());
1494 assert(rreq == req);
1495 result = fxp_setstat_recv(pktin, rreq);
1498 printf("set attrs for %s: %s\n", fname, fxp_error());
1503 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1509 static int sftp_cmd_open(struct sftp_command *cmd)
1514 printf("psftp: already connected\n");
1518 if (cmd->nwords < 2) {
1519 printf("open: expects a host name\n");
1523 if (cmd->nwords > 2) {
1524 portnumber = atoi(cmd->words[2]);
1525 if (portnumber == 0) {
1526 printf("open: invalid port number\n");
1532 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1533 back = NULL; /* connection is already closed */
1534 return -1; /* this is fatal */
1540 static int sftp_cmd_lcd(struct sftp_command *cmd)
1542 char *currdir, *errmsg;
1544 if (cmd->nwords < 2) {
1545 printf("lcd: expects a local directory name\n");
1549 errmsg = psftp_lcd(cmd->words[1]);
1551 printf("lcd: unable to change directory: %s\n", errmsg);
1556 currdir = psftp_getcwd();
1557 printf("New local directory is %s\n", currdir);
1563 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1567 currdir = psftp_getcwd();
1568 printf("Current local directory is %s\n", currdir);
1574 static int sftp_cmd_pling(struct sftp_command *cmd)
1578 exitcode = system(cmd->words[1]);
1579 return (exitcode == 0);
1582 static int sftp_cmd_help(struct sftp_command *cmd);
1584 static struct sftp_cmd_lookup {
1587 * For help purposes, there are two kinds of command:
1589 * - primary commands, in which `longhelp' is non-NULL. In
1590 * this case `shorthelp' is descriptive text, and `longhelp'
1591 * is longer descriptive text intended to be printed after
1594 * - alias commands, in which `longhelp' is NULL. In this case
1595 * `shorthelp' is the name of a primary command, which
1596 * contains the help that should double up for this command.
1598 int listed; /* do we list this in primary help? */
1601 int (*obey) (struct sftp_command *);
1604 * List of sftp commands. This is binary-searched so it MUST be
1608 "!", TRUE, "run a local command",
1610 /* FIXME: this example is crap for non-Windows. */
1611 " Runs a local command. For example, \"!del myfile\".\n",
1615 "bye", TRUE, "finish your SFTP session",
1617 " Terminates your SFTP session and quits the PSFTP program.\n",
1621 "cd", TRUE, "change your remote working directory",
1622 " [ <New working directory> ]\n"
1623 " Change the remote working directory for your SFTP session.\n"
1624 " If a new working directory is not supplied, you will be\n"
1625 " returned to your home directory.\n",
1629 "chmod", TRUE, "change file permissions and modes",
1630 " ( <octal-digits> | <modifiers> ) <filename>\n"
1631 " Change the file permissions on a file or directory.\n"
1632 " <octal-digits> can be any octal Unix permission specifier.\n"
1633 " Alternatively, <modifiers> can include:\n"
1634 " u+r make file readable by owning user\n"
1635 " u+w make file writable by owning user\n"
1636 " u+x make file executable by owning user\n"
1637 " u-r make file not readable by owning user\n"
1638 " [also u-w, u-x]\n"
1639 " g+r make file readable by members of owning group\n"
1640 " [also g+w, g+x, g-r, g-w, g-x]\n"
1641 " o+r make file readable by all other users\n"
1642 " [also o+w, o+x, o-r, o-w, o-x]\n"
1643 " a+r make file readable by absolutely everybody\n"
1644 " [also a+w, a+x, a-r, a-w, a-x]\n"
1645 " u+s enable the Unix set-user-ID bit\n"
1646 " u-s disable the Unix set-user-ID bit\n"
1647 " g+s enable the Unix set-group-ID bit\n"
1648 " g-s disable the Unix set-group-ID bit\n"
1649 " +t enable the Unix \"sticky bit\"\n"
1650 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1651 " more than one user for the same modifier (\"ug+w\"). You can\n"
1652 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1656 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1658 " Terminates your SFTP session, but does not quit the PSFTP\n"
1659 " program. You can then use \"open\" to start another SFTP\n"
1660 " session, to the same server or to a different one.\n",
1664 "del", TRUE, "delete a file",
1666 " Delete a file.\n",
1670 "delete", FALSE, "del", NULL, sftp_cmd_rm
1673 "dir", TRUE, "list contents of a remote directory",
1674 " [ <directory-name> ]/[ <wildcard> ]\n"
1675 " List the contents of a specified directory on the server.\n"
1676 " If <directory-name> is not given, the current working directory\n"
1678 " If <wildcard> is given, it is treated as a set of files to\n"
1679 " list; otherwise, all files are listed.\n",
1683 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1686 "get", TRUE, "download a file from the server to your local machine",
1687 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1688 " Downloads a file on the server and stores it locally under\n"
1689 " the same name, or under a different one if you supply the\n"
1690 " argument <local-filename>.\n"
1691 " If -r specified, recursively fetch a directory.\n",
1695 "help", TRUE, "give help",
1696 " [ <command> [ <command> ... ] ]\n"
1697 " Give general help if no commands are specified.\n"
1698 " If one or more commands are specified, give specific help on\n"
1699 " those particular commands.\n",
1703 "lcd", TRUE, "change local working directory",
1704 " <local-directory-name>\n"
1705 " Change the local working directory of the PSFTP program (the\n"
1706 " default location where the \"get\" command will save files).\n",
1710 "lpwd", TRUE, "print local working directory",
1712 " Print the local working directory of the PSFTP program (the\n"
1713 " default location where the \"get\" command will save files).\n",
1717 "ls", TRUE, "dir", NULL,
1721 "mget", TRUE, "download multiple files at once",
1722 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1723 " Downloads many files from the server, storing each one under\n"
1724 " the same name it has on the server side. You can use wildcards\n"
1725 " such as \"*.c\" to specify lots of files at once.\n"
1726 " If -r specified, recursively fetch files and directories.\n",
1730 "mkdir", TRUE, "create a directory on the remote server",
1731 " <directory-name>\n"
1732 " Creates a directory with the given name on the server.\n",
1736 "mput", TRUE, "upload multiple files at once",
1737 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1738 " Uploads many files to the server, storing each one under the\n"
1739 " same name it has on the client side. You can use wildcards\n"
1740 " such as \"*.c\" to specify lots of files at once.\n"
1741 " If -r specified, recursively store files and directories.\n",
1745 "mv", TRUE, "move or rename a file on the remote server",
1746 " <source-filename> <destination-filename>\n"
1747 " Moves or renames the file <source-filename> on the server,\n"
1748 " so that it is accessible under the name <destination-filename>.\n",
1752 "open", TRUE, "connect to a host",
1753 " [<user>@]<hostname> [<port>]\n"
1754 " Establishes an SFTP connection to a given host. Only usable\n"
1755 " when you did not already specify a host name on the command\n"
1760 "put", TRUE, "upload a file from your local machine to the server",
1761 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
1762 " Uploads a file to the server and stores it there under\n"
1763 " the same name, or under a different one if you supply the\n"
1764 " argument <remote-filename>.\n"
1765 " If -r specified, recursively store a directory.\n",
1769 "pwd", TRUE, "print your remote working directory",
1771 " Print the current remote working directory for your SFTP session.\n",
1775 "quit", TRUE, "bye", NULL,
1779 "reget", TRUE, "continue downloading a file",
1780 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1781 " Works exactly like the \"get\" command, but the local file\n"
1782 " must already exist. The download will begin at the end of the\n"
1783 " file. This is for resuming a download that was interrupted.\n"
1784 " If -r specified, resume interrupted \"get -r\".\n",
1788 "ren", TRUE, "mv", NULL,
1792 "rename", FALSE, "mv", NULL,
1796 "reput", TRUE, "continue uploading a file",
1797 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
1798 " Works exactly like the \"put\" command, but the remote file\n"
1799 " must already exist. The upload will begin at the end of the\n"
1800 " file. This is for resuming an upload that was interrupted.\n"
1801 " If -r specified, resume interrupted \"put -r\".\n",
1805 "rm", TRUE, "del", NULL,
1809 "rmdir", TRUE, "remove a directory on the remote server",
1810 " <directory-name>\n"
1811 " Removes the directory with the given name on the server.\n"
1812 " The directory will not be removed unless it is empty.\n",
1817 const struct sftp_cmd_lookup *lookup_command(char *name)
1822 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
1825 cmp = strcmp(name, sftp_lookup[k].name);
1831 return &sftp_lookup[k];
1837 static int sftp_cmd_help(struct sftp_command *cmd)
1840 if (cmd->nwords == 1) {
1842 * Give short help on each command.
1846 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1848 if (!sftp_lookup[i].listed)
1850 len = strlen(sftp_lookup[i].name);
1854 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1855 const struct sftp_cmd_lookup *lookup;
1856 if (!sftp_lookup[i].listed)
1858 lookup = &sftp_lookup[i];
1859 printf("%-*s", maxlen+2, lookup->name);
1860 if (lookup->longhelp == NULL)
1861 lookup = lookup_command(lookup->shorthelp);
1862 printf("%s\n", lookup->shorthelp);
1866 * Give long help on specific commands.
1868 for (i = 1; i < cmd->nwords; i++) {
1869 const struct sftp_cmd_lookup *lookup;
1870 lookup = lookup_command(cmd->words[i]);
1872 printf("help: %s: command not found\n", cmd->words[i]);
1874 printf("%s", lookup->name);
1875 if (lookup->longhelp == NULL)
1876 lookup = lookup_command(lookup->shorthelp);
1877 printf("%s", lookup->longhelp);
1884 /* ----------------------------------------------------------------------
1885 * Command line reading and parsing.
1887 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
1890 struct sftp_command *cmd;
1894 cmd = snew(struct sftp_command);
1904 line = fgetline(fp);
1906 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
1909 if (!line || !*line) {
1910 cmd->obey = sftp_cmd_quit;
1911 if ((mode == 0) || (modeflags & 1))
1913 return cmd; /* eof */
1916 line[strcspn(line, "\r\n")] = '\0';
1918 if (modeflags & 1) {
1919 printf("%s\n", line);
1923 while (*p && (*p == ' ' || *p == '\t'))
1928 * Special case: the ! command. This is always parsed as
1929 * exactly two words: one containing the !, and the second
1930 * containing everything else on the line.
1932 cmd->nwords = cmd->wordssize = 2;
1933 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1934 cmd->words[0] = dupstr("!");
1935 cmd->words[1] = dupstr(p+1);
1939 * Parse the command line into words. The syntax is:
1940 * - double quotes are removed, but cause spaces within to be
1941 * treated as non-separating.
1942 * - a double-doublequote pair is a literal double quote, inside
1943 * _or_ outside quotes. Like this:
1945 * firstword "second word" "this has ""quotes"" in" and""this""
1951 * >this has "quotes" in<
1955 /* skip whitespace */
1956 while (*p && (*p == ' ' || *p == '\t'))
1958 /* mark start of word */
1959 q = r = p; /* q sits at start, r writes word */
1962 if (!quoting && (*p == ' ' || *p == '\t'))
1963 break; /* reached end of word */
1964 else if (*p == '"' && p[1] == '"')
1965 p += 2, *r++ = '"'; /* a literal quote */
1967 p++, quoting = !quoting;
1972 p++; /* skip over the whitespace */
1974 if (cmd->nwords >= cmd->wordssize) {
1975 cmd->wordssize = cmd->nwords + 16;
1976 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1978 cmd->words[cmd->nwords++] = dupstr(q);
1985 * Now parse the first word and assign a function.
1988 if (cmd->nwords == 0)
1989 cmd->obey = sftp_cmd_null;
1991 const struct sftp_cmd_lookup *lookup;
1992 lookup = lookup_command(cmd->words[0]);
1994 cmd->obey = sftp_cmd_unknown;
1996 cmd->obey = lookup->obey;
2002 static int do_sftp_init(void)
2004 struct sftp_packet *pktin;
2005 struct sftp_request *req, *rreq;
2008 * Do protocol initialisation.
2012 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2013 return 1; /* failure */
2017 * Find out where our home directory is.
2019 sftp_register(req = fxp_realpath_send("."));
2020 rreq = sftp_find_request(pktin = sftp_recv());
2021 assert(rreq == req);
2022 homedir = fxp_realpath_recv(pktin, rreq);
2026 "Warning: failed to resolve home directory: %s\n",
2028 homedir = dupstr(".");
2030 printf("Remote working directory is %s\n", homedir);
2032 pwd = dupstr(homedir);
2036 void do_sftp_cleanup()
2040 back->special(backhandle, TS_EOF);
2041 sftp_recvdata(&ch, 1);
2042 back->free(backhandle);
2043 sftp_cleanup_request();
2057 void do_sftp(int mode, int modeflags, char *batchfile)
2067 /* ------------------------------------------------------------------
2068 * Now we're ready to do Real Stuff.
2071 struct sftp_command *cmd;
2072 cmd = sftp_getcmd(NULL, 0, 0);
2075 ret = cmd->obey(cmd);
2078 for(i = 0; i < cmd->nwords; i++)
2079 sfree(cmd->words[i]);
2087 fp = fopen(batchfile, "r");
2089 printf("Fatal: unable to open %s\n", batchfile);
2093 struct sftp_command *cmd;
2094 cmd = sftp_getcmd(fp, mode, modeflags);
2097 ret = cmd->obey(cmd);
2101 if (!(modeflags & 2))
2110 /* ----------------------------------------------------------------------
2111 * Dirty bits: integration with PuTTY.
2114 static int verbose = 0;
2117 * Print an error message and perform a fatal exit.
2119 void fatalbox(char *fmt, ...)
2124 str = dupvprintf(fmt, ap);
2125 str2 = dupcat("Fatal: ", str, "\n", NULL);
2128 fputs(str2, stderr);
2133 void modalfatalbox(char *fmt, ...)
2138 str = dupvprintf(fmt, ap);
2139 str2 = dupcat("Fatal: ", str, "\n", NULL);
2142 fputs(str2, stderr);
2147 void connection_fatal(void *frontend, char *fmt, ...)
2152 str = dupvprintf(fmt, ap);
2153 str2 = dupcat("Fatal: ", str, "\n", NULL);
2156 fputs(str2, stderr);
2162 void ldisc_send(void *handle, char *buf, int len, int interactive)
2165 * This is only here because of the calls to ldisc_send(NULL,
2166 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2167 * ldisc as an ldisc. So if we get called with any real data, I
2168 * want to know about it.
2174 * In psftp, all agent requests should be synchronous, so this is a
2175 * never-called stub.
2177 void agent_schedule_callback(void (*callback)(void *, void *, int),
2178 void *callback_ctx, void *data, int len)
2180 assert(!"We shouldn't be here");
2184 * Receive a block of data from the SSH link. Block until all data
2187 * To do this, we repeatedly call the SSH protocol module, with our
2188 * own trap in from_backend() to catch the data that comes back. We
2189 * do this until we have enough data.
2192 static unsigned char *outptr; /* where to put the data */
2193 static unsigned outlen; /* how much data required */
2194 static unsigned char *pending = NULL; /* any spare data */
2195 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2196 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2198 unsigned char *p = (unsigned char *) data;
2199 unsigned len = (unsigned) datalen;
2202 * stderr data is just spouted to local stderr and otherwise
2207 fwrite(data, 1, len, stderr);
2212 * If this is before the real session begins, just return.
2217 if ((outlen > 0) && (len > 0)) {
2218 unsigned used = outlen;
2221 memcpy(outptr, p, used);
2229 if (pendsize < pendlen + len) {
2230 pendsize = pendlen + len + 4096;
2231 pending = sresize(pending, pendsize, unsigned char);
2233 memcpy(pending + pendlen, p, len);
2239 int sftp_recvdata(char *buf, int len)
2241 outptr = (unsigned char *) buf;
2245 * See if the pending-input block contains some of what we
2249 unsigned pendused = pendlen;
2250 if (pendused > outlen)
2252 memcpy(outptr, pending, pendused);
2253 memmove(pending, pending + pendused, pendlen - pendused);
2256 pendlen -= pendused;
2266 while (outlen > 0) {
2267 if (ssh_sftp_loop_iteration() < 0)
2268 return 0; /* doom */
2273 int sftp_senddata(char *buf, int len)
2275 back->send(backhandle, buf, len);
2280 * Short description of parameters.
2282 static void usage(void)
2284 printf("PuTTY Secure File Transfer (SFTP) client\n");
2285 printf("%s\n", ver);
2286 printf("Usage: psftp [options] [user@]host\n");
2287 printf("Options:\n");
2288 printf(" -b file use specified batchfile\n");
2289 printf(" -bc output batchfile commands\n");
2290 printf(" -be don't stop batchfile processing if errors\n");
2291 printf(" -v show verbose messages\n");
2292 printf(" -load sessname Load settings from saved session\n");
2293 printf(" -l user connect with specified username\n");
2294 printf(" -P port connect to specified port\n");
2295 printf(" -pw passw login with specified password\n");
2296 printf(" -1 -2 force use of particular SSH protocol version\n");
2297 printf(" -C enable compression\n");
2298 printf(" -i key private key file for authentication\n");
2299 printf(" -batch disable all interactive prompts\n");
2300 printf(" -V print version information\n");
2304 static void version(void)
2306 printf("psftp: %s\n", ver);
2311 * Connect to a host.
2313 static int psftp_connect(char *userhost, char *user, int portnumber)
2315 char *host, *realhost;
2319 /* Separate host and username */
2321 host = strrchr(host, '@');
2327 printf("psftp: multiple usernames specified; using \"%s\"\n",
2334 * If we haven't loaded session details already (e.g., from -load),
2335 * try looking for a session called "host".
2337 if (!loaded_session) {
2338 /* Try to load settings for `host' into a temporary config */
2340 cfg2.host[0] = '\0';
2341 do_defaults(host, &cfg2);
2342 if (cfg2.host[0] != '\0') {
2343 /* Settings present and include hostname */
2344 /* Re-load data into the real config. */
2345 do_defaults(host, &cfg);
2347 /* Session doesn't exist or mention a hostname. */
2348 /* Use `host' as a bare hostname. */
2349 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2350 cfg.host[sizeof(cfg.host) - 1] = '\0';
2353 /* Patch in hostname `host' to session details. */
2354 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2355 cfg.host[sizeof(cfg.host) - 1] = '\0';
2359 * Force use of SSH. (If they got the protocol wrong we assume the
2360 * port is useless too.)
2362 if (cfg.protocol != PROT_SSH) {
2363 cfg.protocol = PROT_SSH;
2368 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2369 * then change it to SSH-2, on the grounds that that's more likely to
2370 * work for SFTP. (Can be overridden with `-1' option.)
2371 * But if it says `2 only' or `2', respect which.
2373 if (cfg.sshprot != 2 && cfg.sshprot != 3)
2377 * Enact command-line overrides.
2379 cmdline_run_saved(&cfg);
2382 * Trim leading whitespace off the hostname if it's there.
2385 int space = strspn(cfg.host, " \t");
2386 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
2389 /* See if host is of the form user@host */
2390 if (cfg.host[0] != '\0') {
2391 char *atsign = strrchr(cfg.host, '@');
2392 /* Make sure we're not overflowing the user field */
2394 if (atsign - cfg.host < sizeof cfg.username) {
2395 strncpy(cfg.username, cfg.host, atsign - cfg.host);
2396 cfg.username[atsign - cfg.host] = '\0';
2398 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
2403 * Trim a colon suffix off the hostname if it's there.
2405 cfg.host[strcspn(cfg.host, ":")] = '\0';
2408 * Remove any remaining whitespace from the hostname.
2412 while (cfg.host[p2] != '\0') {
2413 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
2414 cfg.host[p1] = cfg.host[p2];
2419 cfg.host[p1] = '\0';
2423 if (user != NULL && user[0] != '\0') {
2424 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
2425 cfg.username[sizeof(cfg.username) - 1] = '\0';
2427 if (!cfg.username[0]) {
2428 if (!console_get_line("login as: ",
2429 cfg.username, sizeof(cfg.username), FALSE)) {
2430 fprintf(stderr, "psftp: no username, aborting\n");
2433 int len = strlen(cfg.username);
2434 if (cfg.username[len - 1] == '\n')
2435 cfg.username[len - 1] = '\0';
2440 cfg.port = portnumber;
2443 * Disable scary things which shouldn't be enabled for simple
2444 * things like SCP and SFTP: agent forwarding, port forwarding,
2447 cfg.x11_forward = 0;
2449 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
2451 /* Set up subsystem name. */
2452 strcpy(cfg.remote_cmd, "sftp");
2453 cfg.ssh_subsys = TRUE;
2457 * Set up fallback option, for SSH1 servers or servers with the
2458 * sftp subsystem not enabled but the server binary installed
2459 * in the usual place. We only support fallback on Unix
2460 * systems, and we use a kludgy piece of shellery which should
2461 * try to find sftp-server in various places (the obvious
2462 * systemwide spots /usr/lib and /usr/local/lib, and then the
2463 * user's PATH) and finally give up.
2465 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2466 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2469 * the idea being that this will attempt to use either of the
2470 * obvious pathnames and then give up, and when it does give up
2471 * it will print the preferred pathname in the error messages.
2473 cfg.remote_cmd_ptr2 =
2474 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2475 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2477 cfg.ssh_subsys2 = FALSE;
2479 back = &ssh_backend;
2481 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,
2482 0, cfg.tcp_keepalives);
2484 fprintf(stderr, "ssh_init: %s\n", err);
2487 logctx = log_init(NULL, &cfg);
2488 back->provide_logctx(backhandle, logctx);
2489 console_provide_logctx(logctx);
2490 while (!back->sendok(backhandle)) {
2491 if (ssh_sftp_loop_iteration() < 0) {
2492 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2496 if (verbose && realhost != NULL)
2497 printf("Connected to %s\n", realhost);
2498 if (realhost != NULL)
2503 void cmdline_error(char *p, ...)
2506 fprintf(stderr, "psftp: ");
2508 vfprintf(stderr, p, ap);
2510 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2515 * Main program. Parse arguments etc.
2517 int psftp_main(int argc, char *argv[])
2521 char *userhost, *user;
2524 char *batchfile = NULL;
2527 flags = FLAG_STDERR | FLAG_INTERACTIVE
2528 #ifdef FLAG_SYNCAGENT
2532 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2533 ssh_get_line = &console_get_line;
2536 userhost = user = NULL;
2538 /* Load Default Settings before doing anything else. */
2539 do_defaults(NULL, &cfg);
2540 loaded_session = FALSE;
2543 for (i = 1; i < argc; i++) {
2545 if (argv[i][0] != '-') {
2549 userhost = dupstr(argv[i]);
2552 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2554 cmdline_error("option \"%s\" requires an argument", argv[i]);
2555 } else if (ret == 2) {
2556 i++; /* skip next argument */
2557 } else if (ret == 1) {
2558 /* We have our own verbosity in addition to `flags'. */
2559 if (flags & FLAG_VERBOSE)
2561 } else if (strcmp(argv[i], "-h") == 0 ||
2562 strcmp(argv[i], "-?") == 0) {
2564 } else if (strcmp(argv[i], "-V") == 0) {
2566 } else if (strcmp(argv[i], "-batch") == 0) {
2567 console_batch_mode = 1;
2568 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2570 batchfile = argv[++i];
2571 } else if (strcmp(argv[i], "-bc") == 0) {
2572 modeflags = modeflags | 1;
2573 } else if (strcmp(argv[i], "-be") == 0) {
2574 modeflags = modeflags | 2;
2575 } else if (strcmp(argv[i], "--") == 0) {
2579 cmdline_error("unknown option \"%s\"", argv[i]);
2587 * If the loaded session provides a hostname, and a hostname has not
2588 * otherwise been specified, pop it in `userhost' so that
2589 * `psftp -load sessname' is sufficient to start a session.
2591 if (!userhost && cfg.host[0] != '\0') {
2592 userhost = dupstr(cfg.host);
2596 * If a user@host string has already been provided, connect to
2601 ret = psftp_connect(userhost, user, portnumber);
2608 printf("psftp: no hostname specified; use \"open host.name\""
2612 do_sftp(mode, modeflags, batchfile);
2614 if (back != NULL && back->socket(backhandle) != NULL) {
2616 back->special(backhandle, TS_EOF);
2617 sftp_recvdata(&ch, 1);
2622 console_provide_logctx(NULL);