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;
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);
446 printf("error while reading: %s\n", fxp_error());
450 while (xfer_download_data(xfer, &vbuf, &len)) {
451 unsigned char *buf = (unsigned char *)vbuf;
455 wlen = fwrite(buf + wpos, 1, len - wpos, fp);
457 printf("error while writing local file\n");
459 xfer_set_error(xfer);
463 if (wpos < len) { /* we had an error */
465 xfer_set_error(xfer);
476 sftp_register(req = fxp_close_send(fh));
477 rreq = sftp_find_request(pktin = sftp_recv());
479 fxp_close_recv(pktin, rreq);
484 int sftp_put_file(char *fname, char *outfname, int recurse, int restart,
487 struct fxp_handle *fh;
488 struct fxp_xfer *xfer;
489 struct sftp_packet *pktin;
490 struct sftp_request *req, *rreq;
496 * In recursive mode, see if we're dealing with a directory.
497 * (If we're not in recursive mode, we need not even check: the
498 * subsequent fopen will return an error message.)
500 if (wildcard || (recurse && file_type(fname) == FILE_TYPE_DIRECTORY)) {
501 struct fxp_attrs attrs;
503 int nnames, namesize;
504 char *name, **ournames;
510 * First, attempt to create the destination directory,
511 * unless it already exists.
513 sftp_register(req = fxp_stat_send(outfname));
514 rreq = sftp_find_request(pktin = sftp_recv());
516 result = fxp_stat_recv(pktin, rreq, &attrs);
518 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
519 !(attrs.permissions & 0040000)) {
520 sftp_register(req = fxp_mkdir_send(outfname));
521 rreq = sftp_find_request(pktin = sftp_recv());
523 result = fxp_mkdir_recv(pktin, rreq);
526 printf("%s: create directory: %s\n",
527 outfname, fxp_error());
534 * Now get the list of filenames in the local directory.
536 nnames = namesize = 0;
539 WildcardMatcher *wcm;
541 wcm = begin_wildcard_matching(wildcard);
543 while ((name = wildcard_get_filename(wcm)) != NULL) {
544 if (nnames >= namesize) {
546 ournames = sresize(ournames, namesize, char *);
548 ournames[nnames++] = name;
550 finish_wildcard_matching(wcm);
553 dh = open_directory(fname);
555 printf("%s: unable to open directory\n", fname);
558 while ((name = read_filename(dh)) != NULL) {
559 if (nnames >= namesize) {
561 ournames = sresize(ournames, namesize, char *);
563 ournames[nnames++] = name;
569 * A polite warning if nothing at all matched the
572 if (wildcard && !nnames) {
573 printf("%s: nothing matched\n", wildcard);
577 * Sort the names into a clear order. This ought to make
578 * things more predictable when we're doing a reput of the
579 * same directory, just in case two readdirs on the same
580 * local directory return a different order.
582 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
585 * If we're in restart mode, find the last filename on this
586 * list that already exists. We may have to do a reput on
587 * _that_ file, but shouldn't have to do anything on the
590 * If none of them exists, of course, we start at 0.
595 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
596 sftp_register(req = fxp_stat_send(nextoutfname));
597 rreq = sftp_find_request(pktin = sftp_recv());
599 result = fxp_stat_recv(pktin, rreq, &attrs);
609 * Now we're ready to recurse. Starting at ournames[i]
610 * and continuing on to the end of the list, we
611 * construct a new source and target file name, and
612 * call sftp_put_file again.
614 for (; i < nnames; i++) {
615 char *nextfname, *nextoutfname;
619 nextfname = dir_file_cat(fname, ournames[i]);
621 nextfname = dupstr(ournames[i]);
622 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
623 ret = sftp_put_file(nextfname, nextoutfname,
624 recurse, restart, NULL);
625 restart = FALSE; /* after first partial file, do full */
629 for (i = 0; i < nnames; i++) {
638 * Done this recursion level. Free everything.
640 for (i = 0; i < nnames; i++) {
648 fp = fopen(fname, "rb");
650 printf("local: unable to open %s\n", fname);
654 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
656 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
657 SSH_FXF_CREAT | SSH_FXF_TRUNC));
659 rreq = sftp_find_request(pktin = sftp_recv());
661 fh = fxp_open_recv(pktin, rreq);
664 printf("%s: %s\n", outfname, fxp_error());
670 struct fxp_attrs attrs;
673 sftp_register(req = fxp_fstat_send(fh));
674 rreq = sftp_find_request(pktin = sftp_recv());
676 ret = fxp_fstat_recv(pktin, rreq, &attrs);
679 printf("read size of %s: %s\n", outfname, fxp_error());
682 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
683 printf("read size of %s: size was not given\n", outfname);
687 uint64_decimal(offset, decbuf);
688 printf("reput: restarting at file position %s\n", decbuf);
689 if (uint64_compare(offset, uint64_make(0, LONG_MAX)) > 0) {
690 printf("reput: remote file is larger than we can deal with\n");
693 if (fseek(fp, offset.lo, SEEK_SET) != 0)
694 fseek(fp, 0, SEEK_END); /* *shrug* */
696 offset = uint64_make(0, 0);
699 printf("local:%s => remote:%s\n", fname, outfname);
702 * FIXME: we can use FXP_FSTAT here to get the file size, and
703 * thus put up a progress bar.
706 xfer = xfer_upload_init(fh, offset);
708 while ((!err && !eof) || !xfer_done(xfer)) {
712 while (xfer_upload_ready(xfer) && !err && !eof) {
713 len = fread(buffer, 1, sizeof(buffer), fp);
715 printf("error while reading local file\n");
717 } else if (len == 0) {
720 xfer_upload_data(xfer, buffer, len);
724 if (!xfer_done(xfer)) {
726 ret = xfer_upload_gotpkt(xfer, pktin);
728 printf("error while writing: %s\n", fxp_error());
736 sftp_register(req = fxp_close_send(fh));
737 rreq = sftp_find_request(pktin = sftp_recv());
739 fxp_close_recv(pktin, rreq);
746 /* ----------------------------------------------------------------------
747 * Actual sftp commands.
749 struct sftp_command {
751 int nwords, wordssize;
752 int (*obey) (struct sftp_command *); /* returns <0 to quit */
755 int sftp_cmd_null(struct sftp_command *cmd)
757 return 1; /* success */
760 int sftp_cmd_unknown(struct sftp_command *cmd)
762 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
763 return 0; /* failure */
766 int sftp_cmd_quit(struct sftp_command *cmd)
771 int sftp_cmd_close(struct sftp_command *cmd)
774 printf("psftp: not connected to a host; use \"open host.name\"\n");
778 if (back != NULL && back->socket(backhandle) != NULL) {
780 back->special(backhandle, TS_EOF);
781 sftp_recvdata(&ch, 1);
789 * List a directory. If no arguments are given, list pwd; otherwise
790 * list the directory given in words[1].
792 int sftp_cmd_ls(struct sftp_command *cmd)
794 struct fxp_handle *dirh;
795 struct fxp_names *names;
796 struct fxp_name **ournames;
797 int nnames, namesize;
798 char *dir, *cdir, *unwcdir, *wildcard;
799 struct sftp_packet *pktin;
800 struct sftp_request *req, *rreq;
804 printf("psftp: not connected to a host; use \"open host.name\"\n");
813 unwcdir = snewn(1 + strlen(dir), char);
814 if (wc_unescape(unwcdir, dir)) {
821 wildcard = stripslashes(dir, 0);
822 unwcdir = dupstr(dir);
823 len = wildcard - dir;
825 if (len > 0 && unwcdir[len-1] == '/')
826 unwcdir[len-1] = '\0';
827 tmpdir = snewn(1 + len, char);
828 check = wc_unescape(tmpdir, unwcdir);
831 printf("Multiple-level wildcards are not supported\n");
838 cdir = canonify(dir);
840 printf("%s: %s\n", dir, fxp_error());
845 printf("Listing directory %s\n", cdir);
847 sftp_register(req = fxp_opendir_send(cdir));
848 rreq = sftp_find_request(pktin = sftp_recv());
850 dirh = fxp_opendir_recv(pktin, rreq);
853 printf("Unable to open %s: %s\n", dir, fxp_error());
855 nnames = namesize = 0;
860 sftp_register(req = fxp_readdir_send(dirh));
861 rreq = sftp_find_request(pktin = sftp_recv());
863 names = fxp_readdir_recv(pktin, rreq);
866 if (fxp_error_type() == SSH_FX_EOF)
868 printf("Reading directory %s: %s\n", dir, fxp_error());
871 if (names->nnames == 0) {
872 fxp_free_names(names);
876 if (nnames + names->nnames >= namesize) {
877 namesize += names->nnames + 128;
878 ournames = sresize(ournames, namesize, struct fxp_name *);
881 for (i = 0; i < names->nnames; i++)
882 if (!wildcard || wc_match(wildcard, names->names[i].filename))
883 ournames[nnames++] = fxp_dup_name(&names->names[i]);
885 fxp_free_names(names);
887 sftp_register(req = fxp_close_send(dirh));
888 rreq = sftp_find_request(pktin = sftp_recv());
890 fxp_close_recv(pktin, rreq);
893 * Now we have our filenames. Sort them by actual file
894 * name, and then output the longname parts.
896 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
901 for (i = 0; i < nnames; i++) {
902 printf("%s\n", ournames[i]->longname);
903 fxp_free_name(ournames[i]);
915 * Change directories. We do this by canonifying the new name, then
916 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
918 int sftp_cmd_cd(struct sftp_command *cmd)
920 struct fxp_handle *dirh;
921 struct sftp_packet *pktin;
922 struct sftp_request *req, *rreq;
926 printf("psftp: not connected to a host; use \"open host.name\"\n");
931 dir = dupstr(homedir);
933 dir = canonify(cmd->words[1]);
936 printf("%s: %s\n", dir, fxp_error());
940 sftp_register(req = fxp_opendir_send(dir));
941 rreq = sftp_find_request(pktin = sftp_recv());
943 dirh = fxp_opendir_recv(pktin, rreq);
946 printf("Directory %s: %s\n", dir, fxp_error());
951 sftp_register(req = fxp_close_send(dirh));
952 rreq = sftp_find_request(pktin = sftp_recv());
954 fxp_close_recv(pktin, rreq);
958 printf("Remote directory is now %s\n", pwd);
964 * Print current directory. Easy as pie.
966 int sftp_cmd_pwd(struct sftp_command *cmd)
969 printf("psftp: not connected to a host; use \"open host.name\"\n");
973 printf("Remote directory is %s\n", pwd);
978 * Get a file and save it at the local end. We have three very
979 * similar commands here. The basic one is `get'; `reget' differs
980 * in that it checks for the existence of the destination file and
981 * starts from where a previous aborted transfer left off; `mget'
982 * differs in that it interprets all its arguments as files to
983 * transfer (never as a different local name for a remote file) and
984 * can handle wildcards.
986 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
988 char *fname, *unwcfname, *origfname, *outfname;
993 printf("psftp: not connected to a host; use \"open host.name\"\n");
998 while (i < cmd->nwords && cmd->words[i][0] == '-') {
999 if (!strcmp(cmd->words[i], "--")) {
1000 /* finish processing options */
1003 } else if (!strcmp(cmd->words[i], "-r")) {
1006 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1012 if (i >= cmd->nwords) {
1013 printf("%s: expects a filename\n", cmd->words[0]);
1019 origfname = cmd->words[i++];
1022 !wc_unescape(unwcfname = snewn(strlen(origfname)+1, char),
1024 ret = sftp_get_file(pwd, NULL, recurse, restart, origfname);
1026 fname = canonify(origfname);
1028 printf("%s: %s\n", origfname, fxp_error());
1033 if (!multiple && i < cmd->nwords)
1034 outfname = cmd->words[i++];
1036 outfname = stripslashes(origfname, 0);
1038 ret = sftp_get_file(fname, outfname, recurse, restart, NULL);
1046 } while (multiple && i < cmd->nwords);
1050 int sftp_cmd_get(struct sftp_command *cmd)
1052 return sftp_general_get(cmd, 0, 0);
1054 int sftp_cmd_mget(struct sftp_command *cmd)
1056 return sftp_general_get(cmd, 0, 1);
1058 int sftp_cmd_reget(struct sftp_command *cmd)
1060 return sftp_general_get(cmd, 1, 0);
1064 * Send a file and store it at the remote end. We have three very
1065 * similar commands here. The basic one is `put'; `reput' differs
1066 * in that it checks for the existence of the destination file and
1067 * starts from where a previous aborted transfer left off; `mput'
1068 * differs in that it interprets all its arguments as files to
1069 * transfer (never as a different remote name for a local file) and
1070 * can handle wildcards.
1072 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1074 char *fname, *origoutfname, *outfname;
1076 int recurse = FALSE;
1079 printf("psftp: not connected to a host; use \"open host.name\"\n");
1084 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1085 if (!strcmp(cmd->words[i], "--")) {
1086 /* finish processing options */
1089 } else if (!strcmp(cmd->words[i], "-r")) {
1092 printf("%s: unrecognised option '%s'\n", cmd->words[0], cmd->words[i]);
1098 if (i >= cmd->nwords) {
1099 printf("%s: expects a filename\n", cmd->words[0]);
1104 fname = cmd->words[i++];
1106 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1107 ret = sftp_put_file(NULL, pwd, recurse, restart, fname);
1109 if (!multiple && i < cmd->nwords)
1110 origoutfname = cmd->words[i++];
1112 origoutfname = stripslashes(fname, 1);
1114 outfname = canonify(origoutfname);
1116 printf("%s: %s\n", origoutfname, fxp_error());
1119 ret = sftp_put_file(fname, outfname, recurse, restart, NULL);
1125 } while (multiple && i < cmd->nwords);
1129 int sftp_cmd_put(struct sftp_command *cmd)
1131 return sftp_general_put(cmd, 0, 0);
1133 int sftp_cmd_mput(struct sftp_command *cmd)
1135 return sftp_general_put(cmd, 0, 1);
1137 int sftp_cmd_reput(struct sftp_command *cmd)
1139 return sftp_general_put(cmd, 1, 0);
1142 int sftp_cmd_mkdir(struct sftp_command *cmd)
1145 struct sftp_packet *pktin;
1146 struct sftp_request *req, *rreq;
1150 printf("psftp: not connected to a host; use \"open host.name\"\n");
1154 if (cmd->nwords < 2) {
1155 printf("mkdir: expects a directory\n");
1159 dir = canonify(cmd->words[1]);
1161 printf("%s: %s\n", dir, fxp_error());
1165 sftp_register(req = fxp_mkdir_send(dir));
1166 rreq = sftp_find_request(pktin = sftp_recv());
1167 assert(rreq == req);
1168 result = fxp_mkdir_recv(pktin, rreq);
1171 printf("mkdir %s: %s\n", dir, fxp_error());
1180 int sftp_cmd_rmdir(struct sftp_command *cmd)
1183 struct sftp_packet *pktin;
1184 struct sftp_request *req, *rreq;
1188 printf("psftp: not connected to a host; use \"open host.name\"\n");
1192 if (cmd->nwords < 2) {
1193 printf("rmdir: expects a directory\n");
1197 dir = canonify(cmd->words[1]);
1199 printf("%s: %s\n", dir, fxp_error());
1203 sftp_register(req = fxp_rmdir_send(dir));
1204 rreq = sftp_find_request(pktin = sftp_recv());
1205 assert(rreq == req);
1206 result = fxp_rmdir_recv(pktin, rreq);
1209 printf("rmdir %s: %s\n", dir, fxp_error());
1218 int sftp_cmd_rm(struct sftp_command *cmd)
1221 struct sftp_packet *pktin;
1222 struct sftp_request *req, *rreq;
1226 printf("psftp: not connected to a host; use \"open host.name\"\n");
1230 if (cmd->nwords < 2) {
1231 printf("rm: expects a filename\n");
1235 fname = canonify(cmd->words[1]);
1237 printf("%s: %s\n", fname, fxp_error());
1241 sftp_register(req = fxp_remove_send(fname));
1242 rreq = sftp_find_request(pktin = sftp_recv());
1243 assert(rreq == req);
1244 result = fxp_remove_recv(pktin, rreq);
1247 printf("rm %s: %s\n", fname, fxp_error());
1256 int sftp_cmd_mv(struct sftp_command *cmd)
1258 char *srcfname, *dstfname;
1259 struct sftp_packet *pktin;
1260 struct sftp_request *req, *rreq;
1264 printf("psftp: not connected to a host; use \"open host.name\"\n");
1268 if (cmd->nwords < 3) {
1269 printf("mv: expects two filenames\n");
1272 srcfname = canonify(cmd->words[1]);
1274 printf("%s: %s\n", srcfname, fxp_error());
1278 dstfname = canonify(cmd->words[2]);
1280 printf("%s: %s\n", dstfname, fxp_error());
1284 sftp_register(req = fxp_rename_send(srcfname, dstfname));
1285 rreq = sftp_find_request(pktin = sftp_recv());
1286 assert(rreq == req);
1287 result = fxp_rename_recv(pktin, rreq);
1290 char const *error = fxp_error();
1291 struct fxp_attrs attrs;
1294 * The move might have failed because dstfname pointed at a
1295 * directory. We check this possibility now: if dstfname
1296 * _is_ a directory, we re-attempt the move by appending
1297 * the basename of srcfname to dstfname.
1299 sftp_register(req = fxp_stat_send(dstfname));
1300 rreq = sftp_find_request(pktin = sftp_recv());
1301 assert(rreq == req);
1302 result = fxp_stat_recv(pktin, rreq, &attrs);
1305 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1306 (attrs.permissions & 0040000)) {
1308 char *newname, *newcanon;
1309 printf("(destination %s is a directory)\n", dstfname);
1310 p = srcfname + strlen(srcfname);
1311 while (p > srcfname && p[-1] != '/') p--;
1312 newname = dupcat(dstfname, "/", p, NULL);
1313 newcanon = canonify(newname);
1317 dstfname = newcanon;
1319 sftp_register(req = fxp_rename_send(srcfname, dstfname));
1320 rreq = sftp_find_request(pktin = sftp_recv());
1321 assert(rreq == req);
1322 result = fxp_rename_recv(pktin, rreq);
1324 error = result ? NULL : fxp_error();
1328 printf("mv %s %s: %s\n", srcfname, dstfname, error);
1334 printf("%s -> %s\n", srcfname, dstfname);
1341 int sftp_cmd_chmod(struct sftp_command *cmd)
1345 struct fxp_attrs attrs;
1346 unsigned attrs_clr, attrs_xor, oldperms, newperms;
1347 struct sftp_packet *pktin;
1348 struct sftp_request *req, *rreq;
1351 printf("psftp: not connected to a host; use \"open host.name\"\n");
1355 if (cmd->nwords < 3) {
1356 printf("chmod: expects a mode specifier and a filename\n");
1361 * Attempt to parse the mode specifier in cmd->words[1]. We
1362 * don't support the full horror of Unix chmod; instead we
1363 * support a much simpler syntax in which the user can either
1364 * specify an octal number, or a comma-separated sequence of
1365 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1366 * _only_ be omitted if the only attribute mentioned is t,
1367 * since all others require a user/group/other specification.
1368 * Additionally, the s attribute may not be specified for any
1369 * [ugoa] specifications other than exactly u or exactly g.
1371 attrs_clr = attrs_xor = 0;
1372 mode = cmd->words[1];
1373 if (mode[0] >= '0' && mode[0] <= '9') {
1374 if (mode[strspn(mode, "01234567")]) {
1375 printf("chmod: numeric file modes should"
1376 " contain digits 0-7 only\n");
1380 sscanf(mode, "%o", &attrs_xor);
1381 attrs_xor &= attrs_clr;
1384 char *modebegin = mode;
1385 unsigned subset, perms;
1389 while (*mode && *mode != ',' &&
1390 *mode != '+' && *mode != '-' && *mode != '=') {
1392 case 'u': subset |= 04700; break; /* setuid, user perms */
1393 case 'g': subset |= 02070; break; /* setgid, group perms */
1394 case 'o': subset |= 00007; break; /* just other perms */
1395 case 'a': subset |= 06777; break; /* all of the above */
1397 printf("chmod: file mode '%.*s' contains unrecognised"
1398 " user/group/other specifier '%c'\n",
1399 (int)strcspn(modebegin, ","), modebegin, *mode);
1404 if (!*mode || *mode == ',') {
1405 printf("chmod: file mode '%.*s' is incomplete\n",
1406 (int)strcspn(modebegin, ","), modebegin);
1410 if (!*mode || *mode == ',') {
1411 printf("chmod: file mode '%.*s' is incomplete\n",
1412 (int)strcspn(modebegin, ","), modebegin);
1416 while (*mode && *mode != ',') {
1418 case 'r': perms |= 00444; break;
1419 case 'w': perms |= 00222; break;
1420 case 'x': perms |= 00111; break;
1421 case 't': perms |= 01000; subset |= 01000; break;
1423 if ((subset & 06777) != 04700 &&
1424 (subset & 06777) != 02070) {
1425 printf("chmod: file mode '%.*s': set[ug]id bit should"
1426 " be used with exactly one of u or g only\n",
1427 (int)strcspn(modebegin, ","), modebegin);
1433 printf("chmod: file mode '%.*s' contains unrecognised"
1434 " permission specifier '%c'\n",
1435 (int)strcspn(modebegin, ","), modebegin, *mode);
1440 if (!(subset & 06777) && (perms &~ subset)) {
1441 printf("chmod: file mode '%.*s' contains no user/group/other"
1442 " specifier and permissions other than 't' \n",
1443 (int)strcspn(modebegin, ","), modebegin);
1454 attrs_xor &= ~perms;
1457 attrs_clr |= subset;
1461 if (*mode) mode++; /* eat comma */
1465 fname = canonify(cmd->words[2]);
1467 printf("%s: %s\n", fname, fxp_error());
1471 sftp_register(req = fxp_stat_send(fname));
1472 rreq = sftp_find_request(pktin = sftp_recv());
1473 assert(rreq == req);
1474 result = fxp_stat_recv(pktin, rreq, &attrs);
1476 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1477 printf("get attrs for %s: %s\n", fname,
1478 result ? "file permissions not provided" : fxp_error());
1483 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1484 oldperms = attrs.permissions & 07777;
1485 attrs.permissions &= ~attrs_clr;
1486 attrs.permissions ^= attrs_xor;
1487 newperms = attrs.permissions & 07777;
1489 sftp_register(req = fxp_setstat_send(fname, attrs));
1490 rreq = sftp_find_request(pktin = sftp_recv());
1491 assert(rreq == req);
1492 result = fxp_setstat_recv(pktin, rreq);
1495 printf("set attrs for %s: %s\n", fname, fxp_error());
1500 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1506 static int sftp_cmd_open(struct sftp_command *cmd)
1511 printf("psftp: already connected\n");
1515 if (cmd->nwords < 2) {
1516 printf("open: expects a host name\n");
1520 if (cmd->nwords > 2) {
1521 portnumber = atoi(cmd->words[2]);
1522 if (portnumber == 0) {
1523 printf("open: invalid port number\n");
1529 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1530 back = NULL; /* connection is already closed */
1531 return -1; /* this is fatal */
1537 static int sftp_cmd_lcd(struct sftp_command *cmd)
1539 char *currdir, *errmsg;
1541 if (cmd->nwords < 2) {
1542 printf("lcd: expects a local directory name\n");
1546 errmsg = psftp_lcd(cmd->words[1]);
1548 printf("lcd: unable to change directory: %s\n", errmsg);
1553 currdir = psftp_getcwd();
1554 printf("New local directory is %s\n", currdir);
1560 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1564 currdir = psftp_getcwd();
1565 printf("Current local directory is %s\n", currdir);
1571 static int sftp_cmd_pling(struct sftp_command *cmd)
1575 exitcode = system(cmd->words[1]);
1576 return (exitcode == 0);
1579 static int sftp_cmd_help(struct sftp_command *cmd);
1581 static struct sftp_cmd_lookup {
1584 * For help purposes, there are two kinds of command:
1586 * - primary commands, in which `longhelp' is non-NULL. In
1587 * this case `shorthelp' is descriptive text, and `longhelp'
1588 * is longer descriptive text intended to be printed after
1591 * - alias commands, in which `longhelp' is NULL. In this case
1592 * `shorthelp' is the name of a primary command, which
1593 * contains the help that should double up for this command.
1595 int listed; /* do we list this in primary help? */
1598 int (*obey) (struct sftp_command *);
1601 * List of sftp commands. This is binary-searched so it MUST be
1605 "!", TRUE, "run a local command",
1607 /* FIXME: this example is crap for non-Windows. */
1608 " Runs a local command. For example, \"!del myfile\".\n",
1612 "bye", TRUE, "finish your SFTP session",
1614 " Terminates your SFTP session and quits the PSFTP program.\n",
1618 "cd", TRUE, "change your remote working directory",
1619 " [ <New working directory> ]\n"
1620 " Change the remote working directory for your SFTP session.\n"
1621 " If a new working directory is not supplied, you will be\n"
1622 " returned to your home directory.\n",
1626 "chmod", TRUE, "change file permissions and modes",
1627 " ( <octal-digits> | <modifiers> ) <filename>\n"
1628 " Change the file permissions on a file or directory.\n"
1629 " <octal-digits> can be any octal Unix permission specifier.\n"
1630 " Alternatively, <modifiers> can include:\n"
1631 " u+r make file readable by owning user\n"
1632 " u+w make file writable by owning user\n"
1633 " u+x make file executable by owning user\n"
1634 " u-r make file not readable by owning user\n"
1635 " [also u-w, u-x]\n"
1636 " g+r make file readable by members of owning group\n"
1637 " [also g+w, g+x, g-r, g-w, g-x]\n"
1638 " o+r make file readable by all other users\n"
1639 " [also o+w, o+x, o-r, o-w, o-x]\n"
1640 " a+r make file readable by absolutely everybody\n"
1641 " [also a+w, a+x, a-r, a-w, a-x]\n"
1642 " u+s enable the Unix set-user-ID bit\n"
1643 " u-s disable the Unix set-user-ID bit\n"
1644 " g+s enable the Unix set-group-ID bit\n"
1645 " g-s disable the Unix set-group-ID bit\n"
1646 " +t enable the Unix \"sticky bit\"\n"
1647 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1648 " more than one user for the same modifier (\"ug+w\"). You can\n"
1649 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1653 "close", TRUE, "finish your SFTP session but do not quit PSFTP",
1655 " Terminates your SFTP session, but does not quit the PSFTP\n"
1656 " program. You can then use \"open\" to start another SFTP\n"
1657 " session, to the same server or to a different one.\n",
1661 "del", TRUE, "delete a file",
1663 " Delete a file.\n",
1667 "delete", FALSE, "del", NULL, sftp_cmd_rm
1670 "dir", TRUE, "list contents of a remote directory",
1671 " [ <directory-name> ]/[ <wildcard> ]\n"
1672 " List the contents of a specified directory on the server.\n"
1673 " If <directory-name> is not given, the current working directory\n"
1675 " If <wildcard> is given, it is treated as a set of files to\n"
1676 " list; otherwise, all files are listed.\n",
1680 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1683 "get", TRUE, "download a file from the server to your local machine",
1684 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1685 " Downloads a file on the server and stores it locally under\n"
1686 " the same name, or under a different one if you supply the\n"
1687 " argument <local-filename>.\n"
1688 " If -r specified, recursively fetch a directory.\n",
1692 "help", TRUE, "give help",
1693 " [ <command> [ <command> ... ] ]\n"
1694 " Give general help if no commands are specified.\n"
1695 " If one or more commands are specified, give specific help on\n"
1696 " those particular commands.\n",
1700 "lcd", TRUE, "change local working directory",
1701 " <local-directory-name>\n"
1702 " Change the local working directory of the PSFTP program (the\n"
1703 " default location where the \"get\" command will save files).\n",
1707 "lpwd", TRUE, "print local working directory",
1709 " Print the local working directory of the PSFTP program (the\n"
1710 " default location where the \"get\" command will save files).\n",
1714 "ls", TRUE, "dir", NULL,
1718 "mget", TRUE, "download multiple files at once",
1719 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1720 " Downloads many files from the server, storing each one under\n"
1721 " the same name it has on the server side. You can use wildcards\n"
1722 " such as \"*.c\" to specify lots of files at once.\n"
1723 " If -r specified, recursively fetch files and directories.\n",
1727 "mkdir", TRUE, "create a directory on the remote server",
1728 " <directory-name>\n"
1729 " Creates a directory with the given name on the server.\n",
1733 "mput", TRUE, "upload multiple files at once",
1734 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1735 " Uploads many files to the server, storing each one under the\n"
1736 " same name it has on the client side. You can use wildcards\n"
1737 " such as \"*.c\" to specify lots of files at once.\n"
1738 " If -r specified, recursively store files and directories.\n",
1742 "mv", TRUE, "move or rename a file on the remote server",
1743 " <source-filename> <destination-filename>\n"
1744 " Moves or renames the file <source-filename> on the server,\n"
1745 " so that it is accessible under the name <destination-filename>.\n",
1749 "open", TRUE, "connect to a host",
1750 " [<user>@]<hostname> [<port>]\n"
1751 " Establishes an SFTP connection to a given host. Only usable\n"
1752 " when you did not already specify a host name on the command\n"
1757 "put", TRUE, "upload a file from your local machine to the server",
1758 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
1759 " Uploads a file to the server and stores it there under\n"
1760 " the same name, or under a different one if you supply the\n"
1761 " argument <remote-filename>.\n"
1762 " If -r specified, recursively store a directory.\n",
1766 "pwd", TRUE, "print your remote working directory",
1768 " Print the current remote working directory for your SFTP session.\n",
1772 "quit", TRUE, "bye", NULL,
1776 "reget", TRUE, "continue downloading a file",
1777 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1778 " Works exactly like the \"get\" command, but the local file\n"
1779 " must already exist. The download will begin at the end of the\n"
1780 " file. This is for resuming a download that was interrupted.\n"
1781 " If -r specified, resume interrupted \"get -r\".\n",
1785 "ren", TRUE, "mv", NULL,
1789 "rename", FALSE, "mv", NULL,
1793 "reput", TRUE, "continue uploading a file",
1794 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
1795 " Works exactly like the \"put\" command, but the remote file\n"
1796 " must already exist. The upload will begin at the end of the\n"
1797 " file. This is for resuming an upload that was interrupted.\n"
1798 " If -r specified, resume interrupted \"put -r\".\n",
1802 "rm", TRUE, "del", NULL,
1806 "rmdir", TRUE, "remove a directory on the remote server",
1807 " <directory-name>\n"
1808 " Removes the directory with the given name on the server.\n"
1809 " The directory will not be removed unless it is empty.\n",
1814 const struct sftp_cmd_lookup *lookup_command(char *name)
1819 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
1822 cmp = strcmp(name, sftp_lookup[k].name);
1828 return &sftp_lookup[k];
1834 static int sftp_cmd_help(struct sftp_command *cmd)
1837 if (cmd->nwords == 1) {
1839 * Give short help on each command.
1843 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1845 if (!sftp_lookup[i].listed)
1847 len = strlen(sftp_lookup[i].name);
1851 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1852 const struct sftp_cmd_lookup *lookup;
1853 if (!sftp_lookup[i].listed)
1855 lookup = &sftp_lookup[i];
1856 printf("%-*s", maxlen+2, lookup->name);
1857 if (lookup->longhelp == NULL)
1858 lookup = lookup_command(lookup->shorthelp);
1859 printf("%s\n", lookup->shorthelp);
1863 * Give long help on specific commands.
1865 for (i = 1; i < cmd->nwords; i++) {
1866 const struct sftp_cmd_lookup *lookup;
1867 lookup = lookup_command(cmd->words[i]);
1869 printf("help: %s: command not found\n", cmd->words[i]);
1871 printf("%s", lookup->name);
1872 if (lookup->longhelp == NULL)
1873 lookup = lookup_command(lookup->shorthelp);
1874 printf("%s", lookup->longhelp);
1881 /* ----------------------------------------------------------------------
1882 * Command line reading and parsing.
1884 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
1887 struct sftp_command *cmd;
1891 cmd = snew(struct sftp_command);
1901 line = fgetline(fp);
1903 line = ssh_sftp_get_cmdline("psftp> ", back == NULL);
1906 if (!line || !*line) {
1907 cmd->obey = sftp_cmd_quit;
1908 if ((mode == 0) || (modeflags & 1))
1910 return cmd; /* eof */
1913 line[strcspn(line, "\r\n")] = '\0';
1915 if (modeflags & 1) {
1916 printf("%s\n", line);
1920 while (*p && (*p == ' ' || *p == '\t'))
1925 * Special case: the ! command. This is always parsed as
1926 * exactly two words: one containing the !, and the second
1927 * containing everything else on the line.
1929 cmd->nwords = cmd->wordssize = 2;
1930 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1931 cmd->words[0] = dupstr("!");
1932 cmd->words[1] = dupstr(p+1);
1936 * Parse the command line into words. The syntax is:
1937 * - double quotes are removed, but cause spaces within to be
1938 * treated as non-separating.
1939 * - a double-doublequote pair is a literal double quote, inside
1940 * _or_ outside quotes. Like this:
1942 * firstword "second word" "this has ""quotes"" in" and""this""
1948 * >this has "quotes" in<
1952 /* skip whitespace */
1953 while (*p && (*p == ' ' || *p == '\t'))
1955 /* mark start of word */
1956 q = r = p; /* q sits at start, r writes word */
1959 if (!quoting && (*p == ' ' || *p == '\t'))
1960 break; /* reached end of word */
1961 else if (*p == '"' && p[1] == '"')
1962 p += 2, *r++ = '"'; /* a literal quote */
1964 p++, quoting = !quoting;
1969 p++; /* skip over the whitespace */
1971 if (cmd->nwords >= cmd->wordssize) {
1972 cmd->wordssize = cmd->nwords + 16;
1973 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1975 cmd->words[cmd->nwords++] = dupstr(q);
1982 * Now parse the first word and assign a function.
1985 if (cmd->nwords == 0)
1986 cmd->obey = sftp_cmd_null;
1988 const struct sftp_cmd_lookup *lookup;
1989 lookup = lookup_command(cmd->words[0]);
1991 cmd->obey = sftp_cmd_unknown;
1993 cmd->obey = lookup->obey;
1999 static int do_sftp_init(void)
2001 struct sftp_packet *pktin;
2002 struct sftp_request *req, *rreq;
2005 * Do protocol initialisation.
2009 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2010 return 1; /* failure */
2014 * Find out where our home directory is.
2016 sftp_register(req = fxp_realpath_send("."));
2017 rreq = sftp_find_request(pktin = sftp_recv());
2018 assert(rreq == req);
2019 homedir = fxp_realpath_recv(pktin, rreq);
2023 "Warning: failed to resolve home directory: %s\n",
2025 homedir = dupstr(".");
2027 printf("Remote working directory is %s\n", homedir);
2029 pwd = dupstr(homedir);
2033 void do_sftp_cleanup()
2037 back->special(backhandle, TS_EOF);
2038 sftp_recvdata(&ch, 1);
2039 back->free(backhandle);
2040 sftp_cleanup_request();
2054 void do_sftp(int mode, int modeflags, char *batchfile)
2064 /* ------------------------------------------------------------------
2065 * Now we're ready to do Real Stuff.
2068 struct sftp_command *cmd;
2069 cmd = sftp_getcmd(NULL, 0, 0);
2072 ret = cmd->obey(cmd);
2075 for(i = 0; i < cmd->nwords; i++)
2076 sfree(cmd->words[i]);
2084 fp = fopen(batchfile, "r");
2086 printf("Fatal: unable to open %s\n", batchfile);
2090 struct sftp_command *cmd;
2091 cmd = sftp_getcmd(fp, mode, modeflags);
2094 ret = cmd->obey(cmd);
2098 if (!(modeflags & 2))
2107 /* ----------------------------------------------------------------------
2108 * Dirty bits: integration with PuTTY.
2111 static int verbose = 0;
2114 * Print an error message and perform a fatal exit.
2116 void fatalbox(char *fmt, ...)
2121 str = dupvprintf(fmt, ap);
2122 str2 = dupcat("Fatal: ", str, "\n", NULL);
2125 fputs(str2, stderr);
2130 void modalfatalbox(char *fmt, ...)
2135 str = dupvprintf(fmt, ap);
2136 str2 = dupcat("Fatal: ", str, "\n", NULL);
2139 fputs(str2, stderr);
2144 void connection_fatal(void *frontend, char *fmt, ...)
2149 str = dupvprintf(fmt, ap);
2150 str2 = dupcat("Fatal: ", str, "\n", NULL);
2153 fputs(str2, stderr);
2159 void ldisc_send(void *handle, char *buf, int len, int interactive)
2162 * This is only here because of the calls to ldisc_send(NULL,
2163 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2164 * ldisc as an ldisc. So if we get called with any real data, I
2165 * want to know about it.
2171 * In psftp, all agent requests should be synchronous, so this is a
2172 * never-called stub.
2174 void agent_schedule_callback(void (*callback)(void *, void *, int),
2175 void *callback_ctx, void *data, int len)
2177 assert(!"We shouldn't be here");
2181 * Receive a block of data from the SSH link. Block until all data
2184 * To do this, we repeatedly call the SSH protocol module, with our
2185 * own trap in from_backend() to catch the data that comes back. We
2186 * do this until we have enough data.
2189 static unsigned char *outptr; /* where to put the data */
2190 static unsigned outlen; /* how much data required */
2191 static unsigned char *pending = NULL; /* any spare data */
2192 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2193 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2195 unsigned char *p = (unsigned char *) data;
2196 unsigned len = (unsigned) datalen;
2199 * stderr data is just spouted to local stderr and otherwise
2204 fwrite(data, 1, len, stderr);
2209 * If this is before the real session begins, just return.
2214 if ((outlen > 0) && (len > 0)) {
2215 unsigned used = outlen;
2218 memcpy(outptr, p, used);
2226 if (pendsize < pendlen + len) {
2227 pendsize = pendlen + len + 4096;
2228 pending = sresize(pending, pendsize, unsigned char);
2230 memcpy(pending + pendlen, p, len);
2236 int sftp_recvdata(char *buf, int len)
2238 outptr = (unsigned char *) buf;
2242 * See if the pending-input block contains some of what we
2246 unsigned pendused = pendlen;
2247 if (pendused > outlen)
2249 memcpy(outptr, pending, pendused);
2250 memmove(pending, pending + pendused, pendlen - pendused);
2253 pendlen -= pendused;
2263 while (outlen > 0) {
2264 if (ssh_sftp_loop_iteration() < 0)
2265 return 0; /* doom */
2270 int sftp_senddata(char *buf, int len)
2272 back->send(backhandle, buf, len);
2277 * Short description of parameters.
2279 static void usage(void)
2281 printf("PuTTY Secure File Transfer (SFTP) client\n");
2282 printf("%s\n", ver);
2283 printf("Usage: psftp [options] [user@]host\n");
2284 printf("Options:\n");
2285 printf(" -b file use specified batchfile\n");
2286 printf(" -bc output batchfile commands\n");
2287 printf(" -be don't stop batchfile processing if errors\n");
2288 printf(" -v show verbose messages\n");
2289 printf(" -load sessname Load settings from saved session\n");
2290 printf(" -l user connect with specified username\n");
2291 printf(" -P port connect to specified port\n");
2292 printf(" -pw passw login with specified password\n");
2293 printf(" -1 -2 force use of particular SSH protocol version\n");
2294 printf(" -C enable compression\n");
2295 printf(" -i key private key file for authentication\n");
2296 printf(" -batch disable all interactive prompts\n");
2297 printf(" -V print version information\n");
2301 static void version(void)
2303 printf("psftp: %s\n", ver);
2308 * Connect to a host.
2310 static int psftp_connect(char *userhost, char *user, int portnumber)
2312 char *host, *realhost;
2316 /* Separate host and username */
2318 host = strrchr(host, '@');
2324 printf("psftp: multiple usernames specified; using \"%s\"\n",
2331 * If we haven't loaded session details already (e.g., from -load),
2332 * try looking for a session called "host".
2334 if (!loaded_session) {
2335 /* Try to load settings for `host' into a temporary config */
2337 cfg2.host[0] = '\0';
2338 do_defaults(host, &cfg2);
2339 if (cfg2.host[0] != '\0') {
2340 /* Settings present and include hostname */
2341 /* Re-load data into the real config. */
2342 do_defaults(host, &cfg);
2344 /* Session doesn't exist or mention a hostname. */
2345 /* Use `host' as a bare hostname. */
2346 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2347 cfg.host[sizeof(cfg.host) - 1] = '\0';
2350 /* Patch in hostname `host' to session details. */
2351 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2352 cfg.host[sizeof(cfg.host) - 1] = '\0';
2356 * Force use of SSH. (If they got the protocol wrong we assume the
2357 * port is useless too.)
2359 if (cfg.protocol != PROT_SSH) {
2360 cfg.protocol = PROT_SSH;
2365 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2366 * then change it to SSH-2, on the grounds that that's more likely to
2367 * work for SFTP. (Can be overridden with `-1' option.)
2368 * But if it says `2 only' or `2', respect which.
2370 if (cfg.sshprot != 2 && cfg.sshprot != 3)
2374 * Enact command-line overrides.
2376 cmdline_run_saved(&cfg);
2379 * Trim leading whitespace off the hostname if it's there.
2382 int space = strspn(cfg.host, " \t");
2383 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
2386 /* See if host is of the form user@host */
2387 if (cfg.host[0] != '\0') {
2388 char *atsign = strrchr(cfg.host, '@');
2389 /* Make sure we're not overflowing the user field */
2391 if (atsign - cfg.host < sizeof cfg.username) {
2392 strncpy(cfg.username, cfg.host, atsign - cfg.host);
2393 cfg.username[atsign - cfg.host] = '\0';
2395 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
2400 * Trim a colon suffix off the hostname if it's there.
2402 cfg.host[strcspn(cfg.host, ":")] = '\0';
2405 * Remove any remaining whitespace from the hostname.
2409 while (cfg.host[p2] != '\0') {
2410 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
2411 cfg.host[p1] = cfg.host[p2];
2416 cfg.host[p1] = '\0';
2420 if (user != NULL && user[0] != '\0') {
2421 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
2422 cfg.username[sizeof(cfg.username) - 1] = '\0';
2424 if (!cfg.username[0]) {
2425 if (!console_get_line("login as: ",
2426 cfg.username, sizeof(cfg.username), FALSE)) {
2427 fprintf(stderr, "psftp: no username, aborting\n");
2430 int len = strlen(cfg.username);
2431 if (cfg.username[len - 1] == '\n')
2432 cfg.username[len - 1] = '\0';
2437 cfg.port = portnumber;
2440 * Disable scary things which shouldn't be enabled for simple
2441 * things like SCP and SFTP: agent forwarding, port forwarding,
2444 cfg.x11_forward = 0;
2446 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
2448 /* Set up subsystem name. */
2449 strcpy(cfg.remote_cmd, "sftp");
2450 cfg.ssh_subsys = TRUE;
2454 * Set up fallback option, for SSH1 servers or servers with the
2455 * sftp subsystem not enabled but the server binary installed
2456 * in the usual place. We only support fallback on Unix
2457 * systems, and we use a kludgy piece of shellery which should
2458 * try to find sftp-server in various places (the obvious
2459 * systemwide spots /usr/lib and /usr/local/lib, and then the
2460 * user's PATH) and finally give up.
2462 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2463 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2466 * the idea being that this will attempt to use either of the
2467 * obvious pathnames and then give up, and when it does give up
2468 * it will print the preferred pathname in the error messages.
2470 cfg.remote_cmd_ptr2 =
2471 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2472 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2474 cfg.ssh_subsys2 = FALSE;
2476 back = &ssh_backend;
2478 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,
2479 0, cfg.tcp_keepalives);
2481 fprintf(stderr, "ssh_init: %s\n", err);
2484 logctx = log_init(NULL, &cfg);
2485 back->provide_logctx(backhandle, logctx);
2486 console_provide_logctx(logctx);
2487 while (!back->sendok(backhandle)) {
2488 if (ssh_sftp_loop_iteration() < 0) {
2489 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2493 if (verbose && realhost != NULL)
2494 printf("Connected to %s\n", realhost);
2495 if (realhost != NULL)
2500 void cmdline_error(char *p, ...)
2503 fprintf(stderr, "psftp: ");
2505 vfprintf(stderr, p, ap);
2507 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2512 * Main program. Parse arguments etc.
2514 int psftp_main(int argc, char *argv[])
2518 char *userhost, *user;
2521 char *batchfile = NULL;
2524 flags = FLAG_STDERR | FLAG_INTERACTIVE
2525 #ifdef FLAG_SYNCAGENT
2529 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2530 ssh_get_line = &console_get_line;
2533 userhost = user = NULL;
2535 /* Load Default Settings before doing anything else. */
2536 do_defaults(NULL, &cfg);
2537 loaded_session = FALSE;
2540 for (i = 1; i < argc; i++) {
2542 if (argv[i][0] != '-') {
2546 userhost = dupstr(argv[i]);
2549 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2551 cmdline_error("option \"%s\" requires an argument", argv[i]);
2552 } else if (ret == 2) {
2553 i++; /* skip next argument */
2554 } else if (ret == 1) {
2555 /* We have our own verbosity in addition to `flags'. */
2556 if (flags & FLAG_VERBOSE)
2558 } else if (strcmp(argv[i], "-h") == 0 ||
2559 strcmp(argv[i], "-?") == 0) {
2561 } else if (strcmp(argv[i], "-V") == 0) {
2563 } else if (strcmp(argv[i], "-batch") == 0) {
2564 console_batch_mode = 1;
2565 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2567 batchfile = argv[++i];
2568 } else if (strcmp(argv[i], "-bc") == 0) {
2569 modeflags = modeflags | 1;
2570 } else if (strcmp(argv[i], "-be") == 0) {
2571 modeflags = modeflags | 2;
2572 } else if (strcmp(argv[i], "--") == 0) {
2576 cmdline_error("unknown option \"%s\"", argv[i]);
2584 * If the loaded session provides a hostname, and a hostname has not
2585 * otherwise been specified, pop it in `userhost' so that
2586 * `psftp -load sessname' is sufficient to start a session.
2588 if (!userhost && cfg.host[0] != '\0') {
2589 userhost = dupstr(cfg.host);
2593 * If a user@host string has already been provided, connect to
2598 ret = psftp_connect(userhost, user, portnumber);
2605 printf("psftp: no hostname specified; use \"open host.name\""
2609 do_sftp(mode, modeflags, batchfile);
2611 if (back != NULL && back->socket(backhandle) != NULL) {
2613 back->special(backhandle, TS_EOF);
2614 sftp_recvdata(&ch, 1);
2619 console_provide_logctx(NULL);