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 * Determine whether a string is entirely composed of dots.
46 static int is_dots(char *str)
48 return str[strspn(str, ".")] == '\0';
52 * Attempt to canonify a pathname starting from the pwd. If
53 * canonification fails, at least fall back to returning a _valid_
54 * pathname (though it may be ugly, eg /home/simon/../foobar).
56 char *canonify(char *name)
58 char *fullname, *canonname;
59 struct sftp_packet *pktin;
60 struct sftp_request *req, *rreq;
63 fullname = dupstr(name);
66 if (pwd[strlen(pwd) - 1] == '/')
70 fullname = dupcat(pwd, slash, name, NULL);
73 sftp_register(req = fxp_realpath_send(fullname));
74 rreq = sftp_find_request(pktin = sftp_recv());
76 canonname = fxp_realpath_recv(pktin, rreq);
83 * Attempt number 2. Some FXP_REALPATH implementations
84 * (glibc-based ones, in particular) require the _whole_
85 * path to point to something that exists, whereas others
86 * (BSD-based) only require all but the last component to
87 * exist. So if the first call failed, we should strip off
88 * everything from the last slash onwards and try again,
89 * then put the final component back on.
93 * - if the last component is "/." or "/..", then we don't
94 * bother trying this because there's no way it can work.
96 * - if the thing actually ends with a "/", we remove it
97 * before we start. Except if the string is "/" itself
98 * (although I can't see why we'd have got here if so,
99 * because surely "/" would have worked the first
100 * time?), in which case we don't bother.
102 * - if there's no slash in the string at all, give up in
103 * confusion (we expect at least one because of the way
104 * we constructed the string).
110 i = strlen(fullname);
111 if (i > 2 && fullname[i - 1] == '/')
112 fullname[--i] = '\0'; /* strip trailing / unless at pos 0 */
113 while (i > 0 && fullname[--i] != '/');
116 * Give up on special cases.
118 if (fullname[i] != '/' || /* no slash at all */
119 !strcmp(fullname + i, "/.") || /* ends in /. */
120 !strcmp(fullname + i, "/..") || /* ends in /.. */
121 !strcmp(fullname, "/")) {
126 * Now i points at the slash. Deal with the final special
127 * case i==0 (ie the whole path was "/nonexistentfile").
129 fullname[i] = '\0'; /* separate the string */
131 sftp_register(req = fxp_realpath_send("/"));
133 sftp_register(req = fxp_realpath_send(fullname));
135 rreq = sftp_find_request(pktin = sftp_recv());
137 canonname = fxp_realpath_recv(pktin, rreq);
140 return fullname; /* even that failed; give up */
143 * We have a canonical name for all but the last path
144 * component. Concatenate the last component and return.
146 returnname = dupcat(canonname,
147 canonname[strlen(canonname) - 1] ==
148 '/' ? "" : "/", fullname + i + 1, NULL);
156 * Return a pointer to the portion of str that comes after the last
157 * slash (or backslash or colon, if `local' is TRUE).
159 static char *stripslashes(char *str, int local)
164 p = strchr(str, ':');
168 p = strrchr(str, '/');
172 p = strrchr(str, '\\');
180 * qsort comparison routine for fxp_name structures. Sorts by real
183 static int sftp_name_compare(const void *av, const void *bv)
185 const struct fxp_name *const *a = (const struct fxp_name *const *) av;
186 const struct fxp_name *const *b = (const struct fxp_name *const *) bv;
187 return strcmp((*a)->filename, (*b)->filename);
191 * Likewise, but for a bare char *.
193 static int bare_name_compare(const void *av, const void *bv)
195 const char **a = (const char **) av;
196 const char **b = (const char **) bv;
197 return strcmp(*a, *b);
200 /* ----------------------------------------------------------------------
201 * The meat of the `get' and `put' commands.
203 int sftp_get_file(char *fname, char *outfname, int recurse, int restart,
206 struct fxp_handle *fh;
207 struct sftp_packet *pktin;
208 struct sftp_request *req, *rreq;
209 struct fxp_xfer *xfer;
215 * In recursive mode, see if we're dealing with a directory.
216 * (If we're not in recursive mode, we need not even check: the
217 * subsequent FXP_OPEN will return a usable error message.)
219 if (wildcard || recurse) {
220 struct fxp_attrs attrs;
224 sftp_register(req = fxp_stat_send(fname));
225 rreq = sftp_find_request(pktin = sftp_recv());
227 result = fxp_stat_recv(pktin, rreq, &attrs);
229 result = 0; /* placate optimisers */
233 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
234 (attrs.permissions & 0040000))) {
236 struct fxp_handle *dirhandle;
237 int nnames, namesize;
238 struct fxp_name **ournames;
239 struct fxp_names *names;
243 * First, attempt to create the destination directory,
244 * unless it already exists (or this is a wildcard
248 file_type(outfname) != FILE_TYPE_DIRECTORY &&
249 !create_directory(outfname)) {
250 printf("%s: Cannot create directory\n", outfname);
255 * Now get the list of filenames in the remote
258 sftp_register(req = fxp_opendir_send(fname));
259 rreq = sftp_find_request(pktin = sftp_recv());
261 dirhandle = fxp_opendir_recv(pktin, rreq);
264 printf("%s: unable to open directory: %s\n",
268 nnames = namesize = 0;
273 sftp_register(req = fxp_readdir_send(dirhandle));
274 rreq = sftp_find_request(pktin = sftp_recv());
276 names = fxp_readdir_recv(pktin, rreq);
279 if (fxp_error_type() == SSH_FX_EOF)
281 printf("%s: reading directory: %s\n", fname, fxp_error());
285 if (names->nnames == 0) {
286 fxp_free_names(names);
289 if (nnames + names->nnames >= namesize) {
290 namesize += names->nnames + 128;
291 ournames = sresize(ournames, namesize, struct fxp_name *);
293 for (i = 0; i < names->nnames; i++)
294 if (!is_dots(names->names[i].filename) &&
295 (!wildcard || wc_match(wildcard,
296 names->names[i].filename)))
297 ournames[nnames++] = fxp_dup_name(&names->names[i]);
298 fxp_free_names(names);
300 sftp_register(req = fxp_close_send(dirhandle));
301 rreq = sftp_find_request(pktin = sftp_recv());
303 fxp_close_recv(pktin, rreq);
306 * A polite warning if nothing at all matched the
309 if (wildcard && !nnames) {
310 printf("%s: nothing matched\n", wildcard);
314 * Sort the names into a clear order. This ought to
315 * make things more predictable when we're doing a
316 * reget of the same directory, just in case two
317 * readdirs on the same remote directory return a
320 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
323 * If we're in restart mode, find the last filename on
324 * this list that already exists. We may have to do a
325 * reget on _that_ file, but shouldn't have to do
326 * anything on the previous files.
328 * If none of them exists, of course, we start at 0.
335 nextoutfname = dir_file_cat(outfname,
336 ournames[i]->filename);
338 nextoutfname = dupstr(ournames[i]->filename);
339 ret = (file_type(nextoutfname) == FILE_TYPE_NONEXISTENT);
349 * Now we're ready to recurse. Starting at ournames[i]
350 * and continuing on to the end of the list, we
351 * construct a new source and target file name, and
352 * call sftp_get_file again.
354 for (; i < nnames; i++) {
355 char *nextfname, *nextoutfname;
358 nextfname = dupcat(fname, "/", ournames[i]->filename, NULL);
360 nextoutfname = dir_file_cat(outfname,
361 ournames[i]->filename);
363 nextoutfname = dupstr(ournames[i]->filename);
364 ret = sftp_get_file(nextfname, nextoutfname,
365 recurse, restart, NULL);
366 restart = FALSE; /* after first partial file, do full */
370 for (i = 0; i < nnames; i++) {
371 fxp_free_name(ournames[i]);
379 * Done this recursion level. Free everything.
381 for (i = 0; i < nnames; i++) {
382 fxp_free_name(ournames[i]);
390 sftp_register(req = fxp_open_send(fname, SSH_FXF_READ));
391 rreq = sftp_find_request(pktin = sftp_recv());
393 fh = fxp_open_recv(pktin, rreq);
396 printf("%s: %s\n", fname, fxp_error());
401 fp = fopen(outfname, "rb+");
403 fp = fopen(outfname, "wb");
407 printf("local: unable to open %s\n", outfname);
409 sftp_register(req = fxp_close_send(fh));
410 rreq = sftp_find_request(pktin = sftp_recv());
412 fxp_close_recv(pktin, rreq);
419 fseek(fp, 0L, SEEK_END);
421 printf("reget: restarting at file position %ld\n", posn);
422 offset = uint64_make(0, posn);
424 offset = uint64_make(0, 0);
427 printf("remote:%s => local:%s\n", fname, outfname);
430 * FIXME: we can use FXP_FSTAT here to get the file size, and
431 * thus put up a progress bar.
434 xfer = xfer_download_init(fh, offset);
435 while (!xfer_done(xfer)) {
440 xfer_download_queue(xfer);
442 ret = xfer_download_gotpkt(xfer, pktin);
445 printf("error while reading: %s\n", fxp_error());
449 while (xfer_download_data(xfer, &vbuf, &len)) {
450 unsigned char *buf = (unsigned char *)vbuf;
454 wlen = fwrite(buf + wpos, 1, len - wpos, fp);
456 printf("error while writing local file\n");
458 xfer_set_error(xfer);
462 if (wpos < len) { /* we had an error */
464 xfer_set_error(xfer);
475 sftp_register(req = fxp_close_send(fh));
476 rreq = sftp_find_request(pktin = sftp_recv());
478 fxp_close_recv(pktin, rreq);
483 int sftp_put_file(char *fname, char *outfname, int recurse, int restart,
486 struct fxp_handle *fh;
487 struct fxp_xfer *xfer;
488 struct sftp_packet *pktin;
489 struct sftp_request *req, *rreq;
495 * In recursive mode, see if we're dealing with a directory.
496 * (If we're not in recursive mode, we need not even check: the
497 * subsequent fopen will return an error message.)
499 if (wildcard || (recurse && file_type(fname) == FILE_TYPE_DIRECTORY)) {
500 struct fxp_attrs attrs;
502 int nnames, namesize;
503 char *name, **ournames;
509 * First, attempt to create the destination directory,
510 * unless it already exists.
512 sftp_register(req = fxp_stat_send(outfname));
513 rreq = sftp_find_request(pktin = sftp_recv());
515 result = fxp_stat_recv(pktin, rreq, &attrs);
517 !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) ||
518 !(attrs.permissions & 0040000)) {
519 sftp_register(req = fxp_mkdir_send(outfname));
520 rreq = sftp_find_request(pktin = sftp_recv());
522 result = fxp_mkdir_recv(pktin, rreq);
525 printf("%s: create directory: %s\n",
526 outfname, fxp_error());
533 * Now get the list of filenames in the local directory.
535 nnames = namesize = 0;
538 WildcardMatcher *wcm;
540 wcm = begin_wildcard_matching(wildcard);
542 while ((name = wildcard_get_filename(wcm)) != NULL) {
543 if (nnames >= namesize) {
545 ournames = sresize(ournames, namesize, char *);
547 ournames[nnames++] = name;
549 finish_wildcard_matching(wcm);
552 dh = open_directory(fname);
554 printf("%s: unable to open directory\n", fname);
557 while ((name = read_filename(dh)) != NULL) {
558 if (nnames >= namesize) {
560 ournames = sresize(ournames, namesize, char *);
562 ournames[nnames++] = name;
568 * A polite warning if nothing at all matched the
571 if (wildcard && !nnames) {
572 printf("%s: nothing matched\n", wildcard);
576 * Sort the names into a clear order. This ought to make
577 * things more predictable when we're doing a reput of the
578 * same directory, just in case two readdirs on the same
579 * local directory return a different order.
581 qsort(ournames, nnames, sizeof(*ournames), bare_name_compare);
584 * If we're in restart mode, find the last filename on this
585 * list that already exists. We may have to do a reput on
586 * _that_ file, but shouldn't have to do anything on the
589 * If none of them exists, of course, we start at 0.
594 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
595 sftp_register(req = fxp_stat_send(nextoutfname));
596 rreq = sftp_find_request(pktin = sftp_recv());
598 result = fxp_stat_recv(pktin, rreq, &attrs);
608 * Now we're ready to recurse. Starting at ournames[i]
609 * and continuing on to the end of the list, we
610 * construct a new source and target file name, and
611 * call sftp_put_file again.
613 for (; i < nnames; i++) {
614 char *nextfname, *nextoutfname;
618 nextfname = dir_file_cat(fname, ournames[i]);
620 nextfname = dupstr(ournames[i]);
621 nextoutfname = dupcat(outfname, "/", ournames[i], NULL);
622 ret = sftp_put_file(nextfname, nextoutfname,
623 recurse, restart, NULL);
624 restart = FALSE; /* after first partial file, do full */
628 for (i = 0; i < nnames; i++) {
637 * Done this recursion level. Free everything.
639 for (i = 0; i < nnames; i++) {
647 fp = fopen(fname, "rb");
649 printf("local: unable to open %s\n", fname);
653 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE));
655 sftp_register(req = fxp_open_send(outfname, SSH_FXF_WRITE |
656 SSH_FXF_CREAT | SSH_FXF_TRUNC));
658 rreq = sftp_find_request(pktin = sftp_recv());
660 fh = fxp_open_recv(pktin, rreq);
663 printf("%s: %s\n", outfname, fxp_error());
669 struct fxp_attrs attrs;
672 sftp_register(req = fxp_fstat_send(fh));
673 rreq = sftp_find_request(pktin = sftp_recv());
675 ret = fxp_fstat_recv(pktin, rreq, &attrs);
678 printf("read size of %s: %s\n", outfname, fxp_error());
681 if (!(attrs.flags & SSH_FILEXFER_ATTR_SIZE)) {
682 printf("read size of %s: size was not given\n", outfname);
686 uint64_decimal(offset, decbuf);
687 printf("reput: restarting at file position %s\n", decbuf);
688 if (uint64_compare(offset, uint64_make(0, LONG_MAX)) > 0) {
689 printf("reput: remote file is larger than we can deal with\n");
692 if (fseek(fp, offset.lo, SEEK_SET) != 0)
693 fseek(fp, 0, SEEK_END); /* *shrug* */
695 offset = uint64_make(0, 0);
698 printf("local:%s => remote:%s\n", fname, outfname);
701 * FIXME: we can use FXP_FSTAT here to get the file size, and
702 * thus put up a progress bar.
705 xfer = xfer_upload_init(fh, offset);
707 while ((!err && !eof) || !xfer_done(xfer)) {
711 while (xfer_upload_ready(xfer) && !err && !eof) {
712 len = fread(buffer, 1, sizeof(buffer), fp);
714 printf("error while reading local file\n");
716 } else if (len == 0) {
719 xfer_upload_data(xfer, buffer, len);
723 if (!xfer_done(xfer)) {
725 ret = xfer_upload_gotpkt(xfer, pktin);
727 printf("error while writing: %s\n", fxp_error());
735 sftp_register(req = fxp_close_send(fh));
736 rreq = sftp_find_request(pktin = sftp_recv());
738 fxp_close_recv(pktin, rreq);
745 /* ----------------------------------------------------------------------
746 * Actual sftp commands.
748 struct sftp_command {
750 int nwords, wordssize;
751 int (*obey) (struct sftp_command *); /* returns <0 to quit */
754 int sftp_cmd_null(struct sftp_command *cmd)
756 return 1; /* success */
759 int sftp_cmd_unknown(struct sftp_command *cmd)
761 printf("psftp: unknown command \"%s\"\n", cmd->words[0]);
762 return 0; /* failure */
765 int sftp_cmd_quit(struct sftp_command *cmd)
771 * List a directory. If no arguments are given, list pwd; otherwise
772 * list the directory given in words[1].
774 int sftp_cmd_ls(struct sftp_command *cmd)
776 struct fxp_handle *dirh;
777 struct fxp_names *names;
778 struct fxp_name **ournames;
779 int nnames, namesize;
780 char *dir, *cdir, *unwcdir, *wildcard;
781 struct sftp_packet *pktin;
782 struct sftp_request *req, *rreq;
786 printf("psftp: not connected to a host; use \"open host.name\"\n");
795 unwcdir = snewn(1 + strlen(dir), char);
796 if (wc_unescape(unwcdir, dir)) {
803 wildcard = stripslashes(dir, 0);
804 unwcdir = dupstr(dir);
805 len = wildcard - dir;
807 if (len > 0 && unwcdir[len-1] == '/')
808 unwcdir[len-1] = '\0';
809 tmpdir = snewn(1 + len, char);
810 check = wc_unescape(tmpdir, unwcdir);
813 printf("Multiple-level wildcards are not supported\n");
820 cdir = canonify(dir);
822 printf("%s: %s\n", dir, fxp_error());
827 printf("Listing directory %s\n", cdir);
829 sftp_register(req = fxp_opendir_send(cdir));
830 rreq = sftp_find_request(pktin = sftp_recv());
832 dirh = fxp_opendir_recv(pktin, rreq);
835 printf("Unable to open %s: %s\n", dir, fxp_error());
837 nnames = namesize = 0;
842 sftp_register(req = fxp_readdir_send(dirh));
843 rreq = sftp_find_request(pktin = sftp_recv());
845 names = fxp_readdir_recv(pktin, rreq);
848 if (fxp_error_type() == SSH_FX_EOF)
850 printf("Reading directory %s: %s\n", dir, fxp_error());
853 if (names->nnames == 0) {
854 fxp_free_names(names);
858 if (nnames + names->nnames >= namesize) {
859 namesize += names->nnames + 128;
860 ournames = sresize(ournames, namesize, struct fxp_name *);
863 for (i = 0; i < names->nnames; i++)
864 if (!wildcard || wc_match(wildcard, names->names[i].filename))
865 ournames[nnames++] = fxp_dup_name(&names->names[i]);
867 fxp_free_names(names);
869 sftp_register(req = fxp_close_send(dirh));
870 rreq = sftp_find_request(pktin = sftp_recv());
872 fxp_close_recv(pktin, rreq);
875 * Now we have our filenames. Sort them by actual file
876 * name, and then output the longname parts.
878 qsort(ournames, nnames, sizeof(*ournames), sftp_name_compare);
883 for (i = 0; i < nnames; i++) {
884 printf("%s\n", ournames[i]->longname);
885 fxp_free_name(ournames[i]);
897 * Change directories. We do this by canonifying the new name, then
898 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
900 int sftp_cmd_cd(struct sftp_command *cmd)
902 struct fxp_handle *dirh;
903 struct sftp_packet *pktin;
904 struct sftp_request *req, *rreq;
908 printf("psftp: not connected to a host; use \"open host.name\"\n");
913 dir = dupstr(homedir);
915 dir = canonify(cmd->words[1]);
918 printf("%s: %s\n", dir, fxp_error());
922 sftp_register(req = fxp_opendir_send(dir));
923 rreq = sftp_find_request(pktin = sftp_recv());
925 dirh = fxp_opendir_recv(pktin, rreq);
928 printf("Directory %s: %s\n", dir, fxp_error());
933 sftp_register(req = fxp_close_send(dirh));
934 rreq = sftp_find_request(pktin = sftp_recv());
936 fxp_close_recv(pktin, rreq);
940 printf("Remote directory is now %s\n", pwd);
946 * Print current directory. Easy as pie.
948 int sftp_cmd_pwd(struct sftp_command *cmd)
951 printf("psftp: not connected to a host; use \"open host.name\"\n");
955 printf("Remote directory is %s\n", pwd);
960 * Get a file and save it at the local end. We have three very
961 * similar commands here. The basic one is `get'; `reget' differs
962 * in that it checks for the existence of the destination file and
963 * starts from where a previous aborted transfer left off; `mget'
964 * differs in that it interprets all its arguments as files to
965 * transfer (never as a different local name for a remote file) and
966 * can handle wildcards.
968 int sftp_general_get(struct sftp_command *cmd, int restart, int multiple)
970 char *fname, *unwcfname, *origfname, *outfname;
975 printf("psftp: not connected to a host; use \"open host.name\"\n");
980 while (i < cmd->nwords && cmd->words[i][0] == '-') {
981 if (!strcmp(cmd->words[i], "--")) {
982 /* finish processing options */
985 } else if (!strcmp(cmd->words[i], "-r")) {
988 printf("get: unrecognised option '%s'\n", cmd->words[i]);
994 if (i >= cmd->nwords) {
995 printf("get: expects a filename\n");
1001 origfname = cmd->words[i++];
1004 !wc_unescape(unwcfname = snewn(strlen(origfname)+1, char),
1006 ret = sftp_get_file(pwd, NULL, recurse, restart, origfname);
1008 fname = canonify(origfname);
1010 printf("%s: %s\n", origfname, fxp_error());
1015 if (!multiple && i < cmd->nwords)
1016 outfname = cmd->words[i++];
1018 outfname = stripslashes(origfname, 0);
1020 ret = sftp_get_file(fname, outfname, recurse, restart, NULL);
1028 } while (multiple && i < cmd->nwords);
1032 int sftp_cmd_get(struct sftp_command *cmd)
1034 return sftp_general_get(cmd, 0, 0);
1036 int sftp_cmd_mget(struct sftp_command *cmd)
1038 return sftp_general_get(cmd, 0, 1);
1040 int sftp_cmd_reget(struct sftp_command *cmd)
1042 return sftp_general_get(cmd, 1, 0);
1046 * Send a file and store it at the remote end. We have three very
1047 * similar commands here. The basic one is `put'; `reput' differs
1048 * in that it checks for the existence of the destination file and
1049 * starts from where a previous aborted transfer left off; `mput'
1050 * differs in that it interprets all its arguments as files to
1051 * transfer (never as a different remote name for a local file) and
1052 * can handle wildcards.
1054 int sftp_general_put(struct sftp_command *cmd, int restart, int multiple)
1056 char *fname, *origoutfname, *outfname;
1058 int recurse = FALSE;
1061 printf("psftp: not connected to a host; use \"open host.name\"\n");
1066 while (i < cmd->nwords && cmd->words[i][0] == '-') {
1067 if (!strcmp(cmd->words[i], "--")) {
1068 /* finish processing options */
1071 } else if (!strcmp(cmd->words[i], "-r")) {
1074 printf("put: unrecognised option '%s'\n", cmd->words[i]);
1080 if (i >= cmd->nwords) {
1081 printf("put: expects a filename\n");
1086 fname = cmd->words[i++];
1088 if (multiple && test_wildcard(fname, FALSE) == WCTYPE_WILDCARD) {
1089 ret = sftp_put_file(NULL, pwd, recurse, restart, fname);
1091 if (!multiple && i < cmd->nwords)
1092 origoutfname = cmd->words[i++];
1094 origoutfname = stripslashes(fname, 1);
1096 outfname = canonify(origoutfname);
1098 printf("%s: %s\n", origoutfname, fxp_error());
1101 ret = sftp_put_file(fname, outfname, recurse, restart, NULL);
1107 } while (multiple && i < cmd->nwords);
1111 int sftp_cmd_put(struct sftp_command *cmd)
1113 return sftp_general_put(cmd, 0, 0);
1115 int sftp_cmd_mput(struct sftp_command *cmd)
1117 return sftp_general_put(cmd, 0, 1);
1119 int sftp_cmd_reput(struct sftp_command *cmd)
1121 return sftp_general_put(cmd, 1, 0);
1124 int sftp_cmd_mkdir(struct sftp_command *cmd)
1127 struct sftp_packet *pktin;
1128 struct sftp_request *req, *rreq;
1132 printf("psftp: not connected to a host; use \"open host.name\"\n");
1136 if (cmd->nwords < 2) {
1137 printf("mkdir: expects a directory\n");
1141 dir = canonify(cmd->words[1]);
1143 printf("%s: %s\n", dir, fxp_error());
1147 sftp_register(req = fxp_mkdir_send(dir));
1148 rreq = sftp_find_request(pktin = sftp_recv());
1149 assert(rreq == req);
1150 result = fxp_mkdir_recv(pktin, rreq);
1153 printf("mkdir %s: %s\n", dir, fxp_error());
1162 int sftp_cmd_rmdir(struct sftp_command *cmd)
1165 struct sftp_packet *pktin;
1166 struct sftp_request *req, *rreq;
1170 printf("psftp: not connected to a host; use \"open host.name\"\n");
1174 if (cmd->nwords < 2) {
1175 printf("rmdir: expects a directory\n");
1179 dir = canonify(cmd->words[1]);
1181 printf("%s: %s\n", dir, fxp_error());
1185 sftp_register(req = fxp_rmdir_send(dir));
1186 rreq = sftp_find_request(pktin = sftp_recv());
1187 assert(rreq == req);
1188 result = fxp_rmdir_recv(pktin, rreq);
1191 printf("rmdir %s: %s\n", dir, fxp_error());
1200 int sftp_cmd_rm(struct sftp_command *cmd)
1203 struct sftp_packet *pktin;
1204 struct sftp_request *req, *rreq;
1208 printf("psftp: not connected to a host; use \"open host.name\"\n");
1212 if (cmd->nwords < 2) {
1213 printf("rm: expects a filename\n");
1217 fname = canonify(cmd->words[1]);
1219 printf("%s: %s\n", fname, fxp_error());
1223 sftp_register(req = fxp_remove_send(fname));
1224 rreq = sftp_find_request(pktin = sftp_recv());
1225 assert(rreq == req);
1226 result = fxp_remove_recv(pktin, rreq);
1229 printf("rm %s: %s\n", fname, fxp_error());
1238 int sftp_cmd_mv(struct sftp_command *cmd)
1240 char *srcfname, *dstfname;
1241 struct sftp_packet *pktin;
1242 struct sftp_request *req, *rreq;
1246 printf("psftp: not connected to a host; use \"open host.name\"\n");
1250 if (cmd->nwords < 3) {
1251 printf("mv: expects two filenames\n");
1254 srcfname = canonify(cmd->words[1]);
1256 printf("%s: %s\n", srcfname, fxp_error());
1260 dstfname = canonify(cmd->words[2]);
1262 printf("%s: %s\n", dstfname, fxp_error());
1266 sftp_register(req = fxp_rename_send(srcfname, dstfname));
1267 rreq = sftp_find_request(pktin = sftp_recv());
1268 assert(rreq == req);
1269 result = fxp_rename_recv(pktin, rreq);
1272 char const *error = fxp_error();
1273 struct fxp_attrs attrs;
1276 * The move might have failed because dstfname pointed at a
1277 * directory. We check this possibility now: if dstfname
1278 * _is_ a directory, we re-attempt the move by appending
1279 * the basename of srcfname to dstfname.
1281 sftp_register(req = fxp_stat_send(dstfname));
1282 rreq = sftp_find_request(pktin = sftp_recv());
1283 assert(rreq == req);
1284 result = fxp_stat_recv(pktin, rreq, &attrs);
1287 (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) &&
1288 (attrs.permissions & 0040000)) {
1290 char *newname, *newcanon;
1291 printf("(destination %s is a directory)\n", dstfname);
1292 p = srcfname + strlen(srcfname);
1293 while (p > srcfname && p[-1] != '/') p--;
1294 newname = dupcat(dstfname, "/", p, NULL);
1295 newcanon = canonify(newname);
1299 dstfname = newcanon;
1301 sftp_register(req = fxp_rename_send(srcfname, dstfname));
1302 rreq = sftp_find_request(pktin = sftp_recv());
1303 assert(rreq == req);
1304 result = fxp_rename_recv(pktin, rreq);
1306 error = result ? NULL : fxp_error();
1310 printf("mv %s %s: %s\n", srcfname, dstfname, error);
1316 printf("%s -> %s\n", srcfname, dstfname);
1323 int sftp_cmd_chmod(struct sftp_command *cmd)
1327 struct fxp_attrs attrs;
1328 unsigned attrs_clr, attrs_xor, oldperms, newperms;
1329 struct sftp_packet *pktin;
1330 struct sftp_request *req, *rreq;
1333 printf("psftp: not connected to a host; use \"open host.name\"\n");
1337 if (cmd->nwords < 3) {
1338 printf("chmod: expects a mode specifier and a filename\n");
1343 * Attempt to parse the mode specifier in cmd->words[1]. We
1344 * don't support the full horror of Unix chmod; instead we
1345 * support a much simpler syntax in which the user can either
1346 * specify an octal number, or a comma-separated sequence of
1347 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1348 * _only_ be omitted if the only attribute mentioned is t,
1349 * since all others require a user/group/other specification.
1350 * Additionally, the s attribute may not be specified for any
1351 * [ugoa] specifications other than exactly u or exactly g.
1353 attrs_clr = attrs_xor = 0;
1354 mode = cmd->words[1];
1355 if (mode[0] >= '0' && mode[0] <= '9') {
1356 if (mode[strspn(mode, "01234567")]) {
1357 printf("chmod: numeric file modes should"
1358 " contain digits 0-7 only\n");
1362 sscanf(mode, "%o", &attrs_xor);
1363 attrs_xor &= attrs_clr;
1366 char *modebegin = mode;
1367 unsigned subset, perms;
1371 while (*mode && *mode != ',' &&
1372 *mode != '+' && *mode != '-' && *mode != '=') {
1374 case 'u': subset |= 04700; break; /* setuid, user perms */
1375 case 'g': subset |= 02070; break; /* setgid, group perms */
1376 case 'o': subset |= 00007; break; /* just other perms */
1377 case 'a': subset |= 06777; break; /* all of the above */
1379 printf("chmod: file mode '%.*s' contains unrecognised"
1380 " user/group/other specifier '%c'\n",
1381 (int)strcspn(modebegin, ","), modebegin, *mode);
1386 if (!*mode || *mode == ',') {
1387 printf("chmod: file mode '%.*s' is incomplete\n",
1388 (int)strcspn(modebegin, ","), modebegin);
1392 if (!*mode || *mode == ',') {
1393 printf("chmod: file mode '%.*s' is incomplete\n",
1394 (int)strcspn(modebegin, ","), modebegin);
1398 while (*mode && *mode != ',') {
1400 case 'r': perms |= 00444; break;
1401 case 'w': perms |= 00222; break;
1402 case 'x': perms |= 00111; break;
1403 case 't': perms |= 01000; subset |= 01000; break;
1405 if ((subset & 06777) != 04700 &&
1406 (subset & 06777) != 02070) {
1407 printf("chmod: file mode '%.*s': set[ug]id bit should"
1408 " be used with exactly one of u or g only\n",
1409 (int)strcspn(modebegin, ","), modebegin);
1415 printf("chmod: file mode '%.*s' contains unrecognised"
1416 " permission specifier '%c'\n",
1417 (int)strcspn(modebegin, ","), modebegin, *mode);
1422 if (!(subset & 06777) && (perms &~ subset)) {
1423 printf("chmod: file mode '%.*s' contains no user/group/other"
1424 " specifier and permissions other than 't' \n",
1425 (int)strcspn(modebegin, ","), modebegin);
1436 attrs_xor &= ~perms;
1439 attrs_clr |= subset;
1443 if (*mode) mode++; /* eat comma */
1447 fname = canonify(cmd->words[2]);
1449 printf("%s: %s\n", fname, fxp_error());
1453 sftp_register(req = fxp_stat_send(fname));
1454 rreq = sftp_find_request(pktin = sftp_recv());
1455 assert(rreq == req);
1456 result = fxp_stat_recv(pktin, rreq, &attrs);
1458 if (!result || !(attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS)) {
1459 printf("get attrs for %s: %s\n", fname,
1460 result ? "file permissions not provided" : fxp_error());
1465 attrs.flags = SSH_FILEXFER_ATTR_PERMISSIONS; /* perms _only_ */
1466 oldperms = attrs.permissions & 07777;
1467 attrs.permissions &= ~attrs_clr;
1468 attrs.permissions ^= attrs_xor;
1469 newperms = attrs.permissions & 07777;
1471 sftp_register(req = fxp_setstat_send(fname, attrs));
1472 rreq = sftp_find_request(pktin = sftp_recv());
1473 assert(rreq == req);
1474 result = fxp_setstat_recv(pktin, rreq);
1477 printf("set attrs for %s: %s\n", fname, fxp_error());
1482 printf("%s: %04o -> %04o\n", fname, oldperms, newperms);
1488 static int sftp_cmd_open(struct sftp_command *cmd)
1493 printf("psftp: already connected\n");
1497 if (cmd->nwords < 2) {
1498 printf("open: expects a host name\n");
1502 if (cmd->nwords > 2) {
1503 portnumber = atoi(cmd->words[2]);
1504 if (portnumber == 0) {
1505 printf("open: invalid port number\n");
1511 if (psftp_connect(cmd->words[1], NULL, portnumber)) {
1512 back = NULL; /* connection is already closed */
1513 return -1; /* this is fatal */
1519 static int sftp_cmd_lcd(struct sftp_command *cmd)
1521 char *currdir, *errmsg;
1523 if (cmd->nwords < 2) {
1524 printf("lcd: expects a local directory name\n");
1528 errmsg = psftp_lcd(cmd->words[1]);
1530 printf("lcd: unable to change directory: %s\n", errmsg);
1535 currdir = psftp_getcwd();
1536 printf("New local directory is %s\n", currdir);
1542 static int sftp_cmd_lpwd(struct sftp_command *cmd)
1546 currdir = psftp_getcwd();
1547 printf("Current local directory is %s\n", currdir);
1553 static int sftp_cmd_pling(struct sftp_command *cmd)
1557 exitcode = system(cmd->words[1]);
1558 return (exitcode == 0);
1561 static int sftp_cmd_help(struct sftp_command *cmd);
1563 static struct sftp_cmd_lookup {
1566 * For help purposes, there are two kinds of command:
1568 * - primary commands, in which `longhelp' is non-NULL. In
1569 * this case `shorthelp' is descriptive text, and `longhelp'
1570 * is longer descriptive text intended to be printed after
1573 * - alias commands, in which `longhelp' is NULL. In this case
1574 * `shorthelp' is the name of a primary command, which
1575 * contains the help that should double up for this command.
1577 int listed; /* do we list this in primary help? */
1580 int (*obey) (struct sftp_command *);
1583 * List of sftp commands. This is binary-searched so it MUST be
1587 "!", TRUE, "run a local command",
1589 /* FIXME: this example is crap for non-Windows. */
1590 " Runs a local command. For example, \"!del myfile\".\n",
1594 "bye", TRUE, "finish your SFTP session",
1596 " Terminates your SFTP session and quits the PSFTP program.\n",
1600 "cd", TRUE, "change your remote working directory",
1601 " [ <New working directory> ]\n"
1602 " Change the remote working directory for your SFTP session.\n"
1603 " If a new working directory is not supplied, you will be\n"
1604 " returned to your home directory.\n",
1608 "chmod", TRUE, "change file permissions and modes",
1609 " ( <octal-digits> | <modifiers> ) <filename>\n"
1610 " Change the file permissions on a file or directory.\n"
1611 " <octal-digits> can be any octal Unix permission specifier.\n"
1612 " Alternatively, <modifiers> can include:\n"
1613 " u+r make file readable by owning user\n"
1614 " u+w make file writable by owning user\n"
1615 " u+x make file executable by owning user\n"
1616 " u-r make file not readable by owning user\n"
1617 " [also u-w, u-x]\n"
1618 " g+r make file readable by members of owning group\n"
1619 " [also g+w, g+x, g-r, g-w, g-x]\n"
1620 " o+r make file readable by all other users\n"
1621 " [also o+w, o+x, o-r, o-w, o-x]\n"
1622 " a+r make file readable by absolutely everybody\n"
1623 " [also a+w, a+x, a-r, a-w, a-x]\n"
1624 " u+s enable the Unix set-user-ID bit\n"
1625 " u-s disable the Unix set-user-ID bit\n"
1626 " g+s enable the Unix set-group-ID bit\n"
1627 " g-s disable the Unix set-group-ID bit\n"
1628 " +t enable the Unix \"sticky bit\"\n"
1629 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1630 " more than one user for the same modifier (\"ug+w\"). You can\n"
1631 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1635 "del", TRUE, "delete a file",
1637 " Delete a file.\n",
1641 "delete", FALSE, "del", NULL, sftp_cmd_rm
1644 "dir", TRUE, "list contents of a remote directory",
1645 " [ <directory-name> ]\n"
1646 " List the contents of a specified directory on the server.\n"
1647 " If <directory-name> is not given, the current working directory\n"
1648 " will be listed.\n",
1652 "exit", TRUE, "bye", NULL, sftp_cmd_quit
1655 "get", TRUE, "download a file from the server to your local machine",
1656 " <filename> [ <local-filename> ]\n"
1657 " Downloads a file on the server and stores it locally under\n"
1658 " the same name, or under a different one if you supply the\n"
1659 " argument <local-filename>.\n",
1663 "help", TRUE, "give help",
1664 " [ <command> [ <command> ... ] ]\n"
1665 " Give general help if no commands are specified.\n"
1666 " If one or more commands are specified, give specific help on\n"
1667 " those particular commands.\n",
1671 "lcd", TRUE, "change local working directory",
1672 " <local-directory-name>\n"
1673 " Change the local working directory of the PSFTP program (the\n"
1674 " default location where the \"get\" command will save files).\n",
1678 "lpwd", TRUE, "print local working directory",
1680 " Print the local working directory of the PSFTP program (the\n"
1681 " default location where the \"get\" command will save files).\n",
1685 "ls", TRUE, "dir", NULL,
1689 "mget", TRUE, "download multiple files at once",
1690 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1691 " Downloads many files from the server, storing each one under\n"
1692 " the same name it has on the server side. You can use wildcards\n"
1693 " such as \"*.c\" to specify lots of files at once.\n",
1697 "mkdir", TRUE, "create a directory on the remote server",
1698 " <directory-name>\n"
1699 " Creates a directory with the given name on the server.\n",
1703 "mput", TRUE, "upload multiple files at once",
1704 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1705 " Uploads many files to the server, storing each one under the\n"
1706 " same name it has on the client side. You can use wildcards\n"
1707 " such as \"*.c\" to specify lots of files at once.\n",
1711 "mv", TRUE, "move or rename a file on the remote server",
1712 " <source-filename> <destination-filename>\n"
1713 " Moves or renames the file <source-filename> on the server,\n"
1714 " so that it is accessible under the name <destination-filename>.\n",
1718 "open", TRUE, "connect to a host",
1719 " [<user>@]<hostname> [<port>]\n"
1720 " Establishes an SFTP connection to a given host. Only usable\n"
1721 " when you did not already specify a host name on the command\n"
1726 "put", TRUE, "upload a file from your local machine to the server",
1727 " <filename> [ <remote-filename> ]\n"
1728 " Uploads a file to the server and stores it there under\n"
1729 " the same name, or under a different one if you supply the\n"
1730 " argument <remote-filename>.\n",
1734 "pwd", TRUE, "print your remote working directory",
1736 " Print the current remote working directory for your SFTP session.\n",
1740 "quit", TRUE, "bye", NULL,
1744 "reget", TRUE, "continue downloading a file",
1745 " <filename> [ <local-filename> ]\n"
1746 " Works exactly like the \"get\" command, but the local file\n"
1747 " must already exist. The download will begin at the end of the\n"
1748 " file. This is for resuming a download that was interrupted.\n",
1752 "ren", TRUE, "mv", NULL,
1756 "rename", FALSE, "mv", NULL,
1760 "reput", TRUE, "continue uploading a file",
1761 " <filename> [ <remote-filename> ]\n"
1762 " Works exactly like the \"put\" command, but the remote file\n"
1763 " must already exist. The upload will begin at the end of the\n"
1764 " file. This is for resuming an upload that was interrupted.\n",
1768 "rm", TRUE, "del", NULL,
1772 "rmdir", TRUE, "remove a directory on the remote server",
1773 " <directory-name>\n"
1774 " Removes the directory with the given name on the server.\n"
1775 " The directory will not be removed unless it is empty.\n",
1780 const struct sftp_cmd_lookup *lookup_command(char *name)
1785 j = sizeof(sftp_lookup) / sizeof(*sftp_lookup);
1788 cmp = strcmp(name, sftp_lookup[k].name);
1794 return &sftp_lookup[k];
1800 static int sftp_cmd_help(struct sftp_command *cmd)
1803 if (cmd->nwords == 1) {
1805 * Give short help on each command.
1809 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1811 if (!sftp_lookup[i].listed)
1813 len = strlen(sftp_lookup[i].name);
1817 for (i = 0; i < sizeof(sftp_lookup) / sizeof(*sftp_lookup); i++) {
1818 const struct sftp_cmd_lookup *lookup;
1819 if (!sftp_lookup[i].listed)
1821 lookup = &sftp_lookup[i];
1822 printf("%-*s", maxlen+2, lookup->name);
1823 if (lookup->longhelp == NULL)
1824 lookup = lookup_command(lookup->shorthelp);
1825 printf("%s\n", lookup->shorthelp);
1829 * Give long help on specific commands.
1831 for (i = 1; i < cmd->nwords; i++) {
1832 const struct sftp_cmd_lookup *lookup;
1833 lookup = lookup_command(cmd->words[i]);
1835 printf("help: %s: command not found\n", cmd->words[i]);
1837 printf("%s", lookup->name);
1838 if (lookup->longhelp == NULL)
1839 lookup = lookup_command(lookup->shorthelp);
1840 printf("%s", lookup->longhelp);
1847 /* ----------------------------------------------------------------------
1848 * Command line reading and parsing.
1850 struct sftp_command *sftp_getcmd(FILE *fp, int mode, int modeflags)
1853 struct sftp_command *cmd;
1857 cmd = snew(struct sftp_command);
1867 line = fgetline(fp);
1869 line = ssh_sftp_get_cmdline("psftp> ");
1872 if (!line || !*line) {
1873 cmd->obey = sftp_cmd_quit;
1874 if ((mode == 0) || (modeflags & 1))
1876 return cmd; /* eof */
1879 line[strcspn(line, "\r\n")] = '\0';
1881 if (modeflags & 1) {
1882 printf("%s\n", line);
1886 while (*p && (*p == ' ' || *p == '\t'))
1891 * Special case: the ! command. This is always parsed as
1892 * exactly two words: one containing the !, and the second
1893 * containing everything else on the line.
1895 cmd->nwords = cmd->wordssize = 2;
1896 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1897 cmd->words[0] = dupstr("!");
1898 cmd->words[1] = dupstr(p+1);
1902 * Parse the command line into words. The syntax is:
1903 * - double quotes are removed, but cause spaces within to be
1904 * treated as non-separating.
1905 * - a double-doublequote pair is a literal double quote, inside
1906 * _or_ outside quotes. Like this:
1908 * firstword "second word" "this has ""quotes"" in" and""this""
1914 * >this has "quotes" in<
1918 /* skip whitespace */
1919 while (*p && (*p == ' ' || *p == '\t'))
1921 /* mark start of word */
1922 q = r = p; /* q sits at start, r writes word */
1925 if (!quoting && (*p == ' ' || *p == '\t'))
1926 break; /* reached end of word */
1927 else if (*p == '"' && p[1] == '"')
1928 p += 2, *r++ = '"'; /* a literal quote */
1930 p++, quoting = !quoting;
1935 p++; /* skip over the whitespace */
1937 if (cmd->nwords >= cmd->wordssize) {
1938 cmd->wordssize = cmd->nwords + 16;
1939 cmd->words = sresize(cmd->words, cmd->wordssize, char *);
1941 cmd->words[cmd->nwords++] = dupstr(q);
1948 * Now parse the first word and assign a function.
1951 if (cmd->nwords == 0)
1952 cmd->obey = sftp_cmd_null;
1954 const struct sftp_cmd_lookup *lookup;
1955 lookup = lookup_command(cmd->words[0]);
1957 cmd->obey = sftp_cmd_unknown;
1959 cmd->obey = lookup->obey;
1965 static int do_sftp_init(void)
1967 struct sftp_packet *pktin;
1968 struct sftp_request *req, *rreq;
1971 * Do protocol initialisation.
1975 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
1976 return 1; /* failure */
1980 * Find out where our home directory is.
1982 sftp_register(req = fxp_realpath_send("."));
1983 rreq = sftp_find_request(pktin = sftp_recv());
1984 assert(rreq == req);
1985 homedir = fxp_realpath_recv(pktin, rreq);
1989 "Warning: failed to resolve home directory: %s\n",
1991 homedir = dupstr(".");
1993 printf("Remote working directory is %s\n", homedir);
1995 pwd = dupstr(homedir);
1999 void do_sftp_cleanup()
2003 back->special(backhandle, TS_EOF);
2004 sftp_recvdata(&ch, 1);
2005 back->free(backhandle);
2006 sftp_cleanup_request();
2018 void do_sftp(int mode, int modeflags, char *batchfile)
2028 /* ------------------------------------------------------------------
2029 * Now we're ready to do Real Stuff.
2032 struct sftp_command *cmd;
2033 cmd = sftp_getcmd(NULL, 0, 0);
2036 ret = cmd->obey(cmd);
2039 for(i = 0; i < cmd->nwords; i++)
2040 sfree(cmd->words[i]);
2048 fp = fopen(batchfile, "r");
2050 printf("Fatal: unable to open %s\n", batchfile);
2054 struct sftp_command *cmd;
2055 cmd = sftp_getcmd(fp, mode, modeflags);
2058 ret = cmd->obey(cmd);
2062 if (!(modeflags & 2))
2071 /* ----------------------------------------------------------------------
2072 * Dirty bits: integration with PuTTY.
2075 static int verbose = 0;
2078 * Print an error message and perform a fatal exit.
2080 void fatalbox(char *fmt, ...)
2085 str = dupvprintf(fmt, ap);
2086 str2 = dupcat("Fatal: ", str, "\n", NULL);
2089 fputs(str2, stderr);
2094 void modalfatalbox(char *fmt, ...)
2099 str = dupvprintf(fmt, ap);
2100 str2 = dupcat("Fatal: ", str, "\n", NULL);
2103 fputs(str2, stderr);
2108 void connection_fatal(void *frontend, char *fmt, ...)
2113 str = dupvprintf(fmt, ap);
2114 str2 = dupcat("Fatal: ", str, "\n", NULL);
2117 fputs(str2, stderr);
2123 void ldisc_send(void *handle, char *buf, int len, int interactive)
2126 * This is only here because of the calls to ldisc_send(NULL,
2127 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2128 * ldisc as an ldisc. So if we get called with any real data, I
2129 * want to know about it.
2135 * In psftp, all agent requests should be synchronous, so this is a
2136 * never-called stub.
2138 void agent_schedule_callback(void (*callback)(void *, void *, int),
2139 void *callback_ctx, void *data, int len)
2141 assert(!"We shouldn't be here");
2145 * Receive a block of data from the SSH link. Block until all data
2148 * To do this, we repeatedly call the SSH protocol module, with our
2149 * own trap in from_backend() to catch the data that comes back. We
2150 * do this until we have enough data.
2153 static unsigned char *outptr; /* where to put the data */
2154 static unsigned outlen; /* how much data required */
2155 static unsigned char *pending = NULL; /* any spare data */
2156 static unsigned pendlen = 0, pendsize = 0; /* length and phys. size of buffer */
2157 int from_backend(void *frontend, int is_stderr, const char *data, int datalen)
2159 unsigned char *p = (unsigned char *) data;
2160 unsigned len = (unsigned) datalen;
2163 * stderr data is just spouted to local stderr and otherwise
2168 fwrite(data, 1, len, stderr);
2173 * If this is before the real session begins, just return.
2178 if ((outlen > 0) && (len > 0)) {
2179 unsigned used = outlen;
2182 memcpy(outptr, p, used);
2190 if (pendsize < pendlen + len) {
2191 pendsize = pendlen + len + 4096;
2192 pending = sresize(pending, pendsize, unsigned char);
2194 memcpy(pending + pendlen, p, len);
2200 int sftp_recvdata(char *buf, int len)
2202 outptr = (unsigned char *) buf;
2206 * See if the pending-input block contains some of what we
2210 unsigned pendused = pendlen;
2211 if (pendused > outlen)
2213 memcpy(outptr, pending, pendused);
2214 memmove(pending, pending + pendused, pendlen - pendused);
2217 pendlen -= pendused;
2227 while (outlen > 0) {
2228 if (ssh_sftp_loop_iteration() < 0)
2229 return 0; /* doom */
2234 int sftp_senddata(char *buf, int len)
2236 back->send(backhandle, buf, len);
2241 * Short description of parameters.
2243 static void usage(void)
2245 printf("PuTTY Secure File Transfer (SFTP) client\n");
2246 printf("%s\n", ver);
2247 printf("Usage: psftp [options] [user@]host\n");
2248 printf("Options:\n");
2249 printf(" -b file use specified batchfile\n");
2250 printf(" -bc output batchfile commands\n");
2251 printf(" -be don't stop batchfile processing if errors\n");
2252 printf(" -v show verbose messages\n");
2253 printf(" -load sessname Load settings from saved session\n");
2254 printf(" -l user connect with specified username\n");
2255 printf(" -P port connect to specified port\n");
2256 printf(" -pw passw login with specified password\n");
2257 printf(" -1 -2 force use of particular SSH protocol version\n");
2258 printf(" -C enable compression\n");
2259 printf(" -i key private key file for authentication\n");
2260 printf(" -batch disable all interactive prompts\n");
2261 printf(" -V print version information\n");
2265 static void version(void)
2267 printf("psftp: %s\n", ver);
2272 * Connect to a host.
2274 static int psftp_connect(char *userhost, char *user, int portnumber)
2276 char *host, *realhost;
2280 /* Separate host and username */
2282 host = strrchr(host, '@');
2288 printf("psftp: multiple usernames specified; using \"%s\"\n",
2295 * If we haven't loaded session details already (e.g., from -load),
2296 * try looking for a session called "host".
2298 if (!loaded_session) {
2299 /* Try to load settings for `host' into a temporary config */
2301 cfg2.host[0] = '\0';
2302 do_defaults(host, &cfg2);
2303 if (cfg2.host[0] != '\0') {
2304 /* Settings present and include hostname */
2305 /* Re-load data into the real config. */
2306 do_defaults(host, &cfg);
2308 /* Session doesn't exist or mention a hostname. */
2309 /* Use `host' as a bare hostname. */
2310 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2311 cfg.host[sizeof(cfg.host) - 1] = '\0';
2314 /* Patch in hostname `host' to session details. */
2315 strncpy(cfg.host, host, sizeof(cfg.host) - 1);
2316 cfg.host[sizeof(cfg.host) - 1] = '\0';
2320 * Force use of SSH. (If they got the protocol wrong we assume the
2321 * port is useless too.)
2323 if (cfg.protocol != PROT_SSH) {
2324 cfg.protocol = PROT_SSH;
2329 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2330 * then change it to SSH-2, on the grounds that that's more likely to
2331 * work for SFTP. (Can be overridden with `-1' option.)
2332 * But if it says `2 only' or `2', respect which.
2334 if (cfg.sshprot != 2 && cfg.sshprot != 3)
2338 * Enact command-line overrides.
2340 cmdline_run_saved(&cfg);
2343 * Trim leading whitespace off the hostname if it's there.
2346 int space = strspn(cfg.host, " \t");
2347 memmove(cfg.host, cfg.host+space, 1+strlen(cfg.host)-space);
2350 /* See if host is of the form user@host */
2351 if (cfg.host[0] != '\0') {
2352 char *atsign = strrchr(cfg.host, '@');
2353 /* Make sure we're not overflowing the user field */
2355 if (atsign - cfg.host < sizeof cfg.username) {
2356 strncpy(cfg.username, cfg.host, atsign - cfg.host);
2357 cfg.username[atsign - cfg.host] = '\0';
2359 memmove(cfg.host, atsign + 1, 1 + strlen(atsign + 1));
2364 * Trim a colon suffix off the hostname if it's there.
2366 cfg.host[strcspn(cfg.host, ":")] = '\0';
2369 * Remove any remaining whitespace from the hostname.
2373 while (cfg.host[p2] != '\0') {
2374 if (cfg.host[p2] != ' ' && cfg.host[p2] != '\t') {
2375 cfg.host[p1] = cfg.host[p2];
2380 cfg.host[p1] = '\0';
2384 if (user != NULL && user[0] != '\0') {
2385 strncpy(cfg.username, user, sizeof(cfg.username) - 1);
2386 cfg.username[sizeof(cfg.username) - 1] = '\0';
2388 if (!cfg.username[0]) {
2389 if (!console_get_line("login as: ",
2390 cfg.username, sizeof(cfg.username), FALSE)) {
2391 fprintf(stderr, "psftp: no username, aborting\n");
2394 int len = strlen(cfg.username);
2395 if (cfg.username[len - 1] == '\n')
2396 cfg.username[len - 1] = '\0';
2401 cfg.port = portnumber;
2404 * Disable scary things which shouldn't be enabled for simple
2405 * things like SCP and SFTP: agent forwarding, port forwarding,
2408 cfg.x11_forward = 0;
2410 cfg.portfwd[0] = cfg.portfwd[1] = '\0';
2412 /* Set up subsystem name. */
2413 strcpy(cfg.remote_cmd, "sftp");
2414 cfg.ssh_subsys = TRUE;
2418 * Set up fallback option, for SSH1 servers or servers with the
2419 * sftp subsystem not enabled but the server binary installed
2420 * in the usual place. We only support fallback on Unix
2421 * systems, and we use a kludgy piece of shellery which should
2422 * try to find sftp-server in various places (the obvious
2423 * systemwide spots /usr/lib and /usr/local/lib, and then the
2424 * user's PATH) and finally give up.
2426 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2427 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2430 * the idea being that this will attempt to use either of the
2431 * obvious pathnames and then give up, and when it does give up
2432 * it will print the preferred pathname in the error messages.
2434 cfg.remote_cmd_ptr2 =
2435 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2436 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2438 cfg.ssh_subsys2 = FALSE;
2440 back = &ssh_backend;
2442 err = back->init(NULL, &backhandle, &cfg, cfg.host, cfg.port, &realhost,
2443 0, cfg.tcp_keepalives);
2445 fprintf(stderr, "ssh_init: %s\n", err);
2448 logctx = log_init(NULL, &cfg);
2449 back->provide_logctx(backhandle, logctx);
2450 console_provide_logctx(logctx);
2451 while (!back->sendok(backhandle)) {
2452 if (ssh_sftp_loop_iteration() < 0) {
2453 fprintf(stderr, "ssh_init: error during SSH connection setup\n");
2457 if (verbose && realhost != NULL)
2458 printf("Connected to %s\n", realhost);
2459 if (realhost != NULL)
2464 void cmdline_error(char *p, ...)
2467 fprintf(stderr, "psftp: ");
2469 vfprintf(stderr, p, ap);
2471 fprintf(stderr, "\n try typing \"psftp -h\" for help\n");
2476 * Main program. Parse arguments etc.
2478 int psftp_main(int argc, char *argv[])
2482 char *userhost, *user;
2485 char *batchfile = NULL;
2488 flags = FLAG_STDERR | FLAG_INTERACTIVE
2489 #ifdef FLAG_SYNCAGENT
2493 cmdline_tooltype = TOOLTYPE_FILETRANSFER;
2494 ssh_get_line = &console_get_line;
2497 userhost = user = NULL;
2499 /* Load Default Settings before doing anything else. */
2500 do_defaults(NULL, &cfg);
2501 loaded_session = FALSE;
2504 for (i = 1; i < argc; i++) {
2506 if (argv[i][0] != '-') {
2510 userhost = dupstr(argv[i]);
2513 ret = cmdline_process_param(argv[i], i+1<argc?argv[i+1]:NULL, 1, &cfg);
2515 cmdline_error("option \"%s\" requires an argument", argv[i]);
2516 } else if (ret == 2) {
2517 i++; /* skip next argument */
2518 } else if (ret == 1) {
2519 /* We have our own verbosity in addition to `flags'. */
2520 if (flags & FLAG_VERBOSE)
2522 } else if (strcmp(argv[i], "-h") == 0 ||
2523 strcmp(argv[i], "-?") == 0) {
2525 } else if (strcmp(argv[i], "-V") == 0) {
2527 } else if (strcmp(argv[i], "-batch") == 0) {
2528 console_batch_mode = 1;
2529 } else if (strcmp(argv[i], "-b") == 0 && i + 1 < argc) {
2531 batchfile = argv[++i];
2532 } else if (strcmp(argv[i], "-bc") == 0) {
2533 modeflags = modeflags | 1;
2534 } else if (strcmp(argv[i], "-be") == 0) {
2535 modeflags = modeflags | 2;
2536 } else if (strcmp(argv[i], "--") == 0) {
2540 cmdline_error("unknown option \"%s\"", argv[i]);
2548 * If the loaded session provides a hostname, and a hostname has not
2549 * otherwise been specified, pop it in `userhost' so that
2550 * `psftp -load sessname' is sufficient to start a session.
2552 if (!userhost && cfg.host[0] != '\0') {
2553 userhost = dupstr(cfg.host);
2557 * If a user@host string has already been provided, connect to
2562 ret = psftp_connect(userhost, user, portnumber);
2569 printf("psftp: no hostname specified; use \"open host.name\""
2573 do_sftp(mode, modeflags, batchfile);
2575 if (back != NULL && back->socket(backhandle) != NULL) {
2577 back->special(backhandle, TS_EOF);
2578 sftp_recvdata(&ch, 1);
2582 console_provide_logctx(NULL);