2 * psftp.c: 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);
29 /* ----------------------------------------------------------------------
35 static void *backhandle
;
38 /* ----------------------------------------------------------------------
39 * Higher-level helper functions used in commands.
43 * Attempt to canonify a pathname starting from the pwd. If
44 * canonification fails, at least fall back to returning a _valid_
45 * pathname (though it may be ugly, eg /home/simon/../foobar).
47 char *canonify(char *name
)
49 char *fullname
, *canonname
;
50 struct sftp_packet
*pktin
;
51 struct sftp_request
*req
, *rreq
;
54 fullname
= dupstr(name
);
57 if (pwd
[strlen(pwd
) - 1] == '/')
61 fullname
= dupcat(pwd
, slash
, name
, NULL
);
64 sftp_register(req
= fxp_realpath_send(fullname
));
65 rreq
= sftp_find_request(pktin
= sftp_recv());
67 canonname
= fxp_realpath_recv(pktin
, rreq
);
74 * Attempt number 2. Some FXP_REALPATH implementations
75 * (glibc-based ones, in particular) require the _whole_
76 * path to point to something that exists, whereas others
77 * (BSD-based) only require all but the last component to
78 * exist. So if the first call failed, we should strip off
79 * everything from the last slash onwards and try again,
80 * then put the final component back on.
84 * - if the last component is "/." or "/..", then we don't
85 * bother trying this because there's no way it can work.
87 * - if the thing actually ends with a "/", we remove it
88 * before we start. Except if the string is "/" itself
89 * (although I can't see why we'd have got here if so,
90 * because surely "/" would have worked the first
91 * time?), in which case we don't bother.
93 * - if there's no slash in the string at all, give up in
94 * confusion (we expect at least one because of the way
95 * we constructed the string).
101 i
= strlen(fullname
);
102 if (i
> 2 && fullname
[i
- 1] == '/')
103 fullname
[--i
] = '\0'; /* strip trailing / unless at pos 0 */
104 while (i
> 0 && fullname
[--i
] != '/');
107 * Give up on special cases.
109 if (fullname
[i
] != '/' || /* no slash at all */
110 !strcmp(fullname
+ i
, "/.") || /* ends in /. */
111 !strcmp(fullname
+ i
, "/..") || /* ends in /.. */
112 !strcmp(fullname
, "/")) {
117 * Now i points at the slash. Deal with the final special
118 * case i==0 (ie the whole path was "/nonexistentfile").
120 fullname
[i
] = '\0'; /* separate the string */
122 sftp_register(req
= fxp_realpath_send("/"));
124 sftp_register(req
= fxp_realpath_send(fullname
));
126 rreq
= sftp_find_request(pktin
= sftp_recv());
128 canonname
= fxp_realpath_recv(pktin
, rreq
);
131 return fullname
; /* even that failed; give up */
134 * We have a canonical name for all but the last path
135 * component. Concatenate the last component and return.
137 returnname
= dupcat(canonname
,
138 canonname
[strlen(canonname
) - 1] ==
139 '/' ?
"" : "/", fullname
+ i
+ 1, NULL
);
147 * Return a pointer to the portion of str that comes after the last
148 * slash (or backslash or colon, if `local' is TRUE).
150 static char *stripslashes(char *str
, int local
)
155 p
= strchr(str
, ':');
159 p
= strrchr(str
, '/');
163 p
= strrchr(str
, '\\');
170 /* ----------------------------------------------------------------------
171 * Actual sftp commands.
173 struct sftp_command
{
175 int nwords
, wordssize
;
176 int (*obey
) (struct sftp_command
*); /* returns <0 to quit */
179 int sftp_cmd_null(struct sftp_command
*cmd
)
181 return 1; /* success */
184 int sftp_cmd_unknown(struct sftp_command
*cmd
)
186 printf("psftp: unknown command \"%s\"\n", cmd
->words
[0]);
187 return 0; /* failure */
190 int sftp_cmd_quit(struct sftp_command
*cmd
)
196 * List a directory. If no arguments are given, list pwd; otherwise
197 * list the directory given in words[1].
199 static int sftp_ls_compare(const void *av
, const void *bv
)
201 const struct fxp_name
*const *a
= (const struct fxp_name
*const *) av
;
202 const struct fxp_name
*const *b
= (const struct fxp_name
*const *) bv
;
203 return strcmp((*a
)->filename
, (*b
)->filename
);
205 int sftp_cmd_ls(struct sftp_command
*cmd
)
207 struct fxp_handle
*dirh
;
208 struct fxp_names
*names
;
209 struct fxp_name
**ournames
;
210 int nnames
, namesize
;
212 struct sftp_packet
*pktin
;
213 struct sftp_request
*req
, *rreq
;
217 printf("psftp: not connected to a host; use \"open host.name\"\n");
226 cdir
= canonify(dir
);
228 printf("%s: %s\n", dir
, fxp_error());
232 printf("Listing directory %s\n", cdir
);
234 sftp_register(req
= fxp_opendir_send(cdir
));
235 rreq
= sftp_find_request(pktin
= sftp_recv());
237 dirh
= fxp_opendir_recv(pktin
, rreq
);
240 printf("Unable to open %s: %s\n", dir
, fxp_error());
242 nnames
= namesize
= 0;
247 sftp_register(req
= fxp_readdir_send(dirh
));
248 rreq
= sftp_find_request(pktin
= sftp_recv());
250 names
= fxp_readdir_recv(pktin
, rreq
);
253 if (fxp_error_type() == SSH_FX_EOF
)
255 printf("Reading directory %s: %s\n", dir
, fxp_error());
258 if (names
->nnames
== 0) {
259 fxp_free_names(names
);
263 if (nnames
+ names
->nnames
>= namesize
) {
264 namesize
+= names
->nnames
+ 128;
265 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
268 for (i
= 0; i
< names
->nnames
; i
++)
269 ournames
[nnames
++] = fxp_dup_name(&names
->names
[i
]);
271 fxp_free_names(names
);
273 sftp_register(req
= fxp_close_send(dirh
));
274 rreq
= sftp_find_request(pktin
= sftp_recv());
276 fxp_close_recv(pktin
, rreq
);
279 * Now we have our filenames. Sort them by actual file
280 * name, and then output the longname parts.
282 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_ls_compare
);
287 for (i
= 0; i
< nnames
; i
++) {
288 printf("%s\n", ournames
[i
]->longname
);
289 fxp_free_name(ournames
[i
]);
300 * Change directories. We do this by canonifying the new name, then
301 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
303 int sftp_cmd_cd(struct sftp_command
*cmd
)
305 struct fxp_handle
*dirh
;
306 struct sftp_packet
*pktin
;
307 struct sftp_request
*req
, *rreq
;
311 printf("psftp: not connected to a host; use \"open host.name\"\n");
316 dir
= dupstr(homedir
);
318 dir
= canonify(cmd
->words
[1]);
321 printf("%s: %s\n", dir
, fxp_error());
325 sftp_register(req
= fxp_opendir_send(dir
));
326 rreq
= sftp_find_request(pktin
= sftp_recv());
328 dirh
= fxp_opendir_recv(pktin
, rreq
);
331 printf("Directory %s: %s\n", dir
, fxp_error());
336 sftp_register(req
= fxp_close_send(dirh
));
337 rreq
= sftp_find_request(pktin
= sftp_recv());
339 fxp_close_recv(pktin
, rreq
);
343 printf("Remote directory is now %s\n", pwd
);
349 * Print current directory. Easy as pie.
351 int sftp_cmd_pwd(struct sftp_command
*cmd
)
354 printf("psftp: not connected to a host; use \"open host.name\"\n");
358 printf("Remote directory is %s\n", pwd
);
363 * Get a file and save it at the local end. We have two very
364 * similar commands here: `get' and `reget', which differ in that
365 * `reget' checks for the existence of the destination file and
366 * starts from where a previous aborted transfer left off.
368 int sftp_general_get(struct sftp_command
*cmd
, int restart
)
370 struct fxp_handle
*fh
;
371 struct sftp_packet
*pktin
;
372 struct sftp_request
*req
, *rreq
;
373 struct fxp_xfer
*xfer
;
374 char *fname
, *outfname
;
380 printf("psftp: not connected to a host; use \"open host.name\"\n");
384 if (cmd
->nwords
< 2) {
385 printf("get: expects a filename\n");
389 fname
= canonify(cmd
->words
[1]);
391 printf("%s: %s\n", cmd
->words
[1], fxp_error());
394 outfname
= (cmd
->nwords
== 2 ?
395 stripslashes(cmd
->words
[1], 0) : cmd
->words
[2]);
397 sftp_register(req
= fxp_open_send(fname
, SSH_FXF_READ
));
398 rreq
= sftp_find_request(pktin
= sftp_recv());
400 fh
= fxp_open_recv(pktin
, rreq
);
403 printf("%s: %s\n", fname
, fxp_error());
409 fp
= fopen(outfname
, "rb+");
411 fp
= fopen(outfname
, "wb");
415 printf("local: unable to open %s\n", outfname
);
417 sftp_register(req
= fxp_close_send(fh
));
418 rreq
= sftp_find_request(pktin
= sftp_recv());
420 fxp_close_recv(pktin
, rreq
);
428 fseek(fp
, 0L, SEEK_END
);
430 printf("reget: restarting at file position %ld\n", posn
);
431 offset
= uint64_make(0, posn
);
433 offset
= uint64_make(0, 0);
436 printf("remote:%s => local:%s\n", fname
, outfname
);
439 * FIXME: we can use FXP_FSTAT here to get the file size, and
440 * thus put up a progress bar.
443 xfer
= xfer_download_init(fh
, offset
);
444 while (!xfer_download_done(xfer
)) {
449 xfer_download_queue(xfer
);
451 ret
= xfer_download_gotpkt(xfer
, pktin
);
454 printf("error while reading: %s\n", fxp_error());
458 while (xfer_download_data(xfer
, &vbuf
, &len
)) {
459 unsigned char *buf
= (unsigned char *)vbuf
;
463 wlen
= fwrite(buf
+ wpos
, 1, len
- wpos
, fp
);
465 printf("error while writing local file\n");
467 xfer_set_error(xfer
);
471 if (wpos
< len
) { /* we had an error */
473 xfer_set_error(xfer
);
482 sftp_register(req
= fxp_close_send(fh
));
483 rreq
= sftp_find_request(pktin
= sftp_recv());
485 fxp_close_recv(pktin
, rreq
);
491 int sftp_cmd_get(struct sftp_command
*cmd
)
493 return sftp_general_get(cmd
, 0);
495 int sftp_cmd_reget(struct sftp_command
*cmd
)
497 return sftp_general_get(cmd
, 1);
501 * Send a file and store it at the remote end. We have two very
502 * similar commands here: `put' and `reput', which differ in that
503 * `reput' checks for the existence of the destination file and
504 * starts from where a previous aborted transfer left off.
506 int sftp_general_put(struct sftp_command
*cmd
, int restart
)
508 struct fxp_handle
*fh
;
509 char *fname
, *origoutfname
, *outfname
;
510 struct sftp_packet
*pktin
;
511 struct sftp_request
*req
, *rreq
;
517 printf("psftp: not connected to a host; use \"open host.name\"\n");
521 if (cmd
->nwords
< 2) {
522 printf("put: expects a filename\n");
526 fname
= cmd
->words
[1];
527 origoutfname
= (cmd
->nwords
== 2 ?
528 stripslashes(cmd
->words
[1], 1) : cmd
->words
[2]);
529 outfname
= canonify(origoutfname
);
531 printf("%s: %s\n", origoutfname
, fxp_error());
535 fp
= fopen(fname
, "rb");
537 printf("local: unable to open %s\n", fname
);
542 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
));
544 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
|
545 SSH_FXF_CREAT
| SSH_FXF_TRUNC
));
547 rreq
= sftp_find_request(pktin
= sftp_recv());
549 fh
= fxp_open_recv(pktin
, rreq
);
552 printf("%s: %s\n", outfname
, fxp_error());
559 struct fxp_attrs attrs
;
562 sftp_register(req
= fxp_fstat_send(fh
));
563 rreq
= sftp_find_request(pktin
= sftp_recv());
565 ret
= fxp_fstat_recv(pktin
, rreq
, &attrs
);
568 printf("read size of %s: %s\n", outfname
, fxp_error());
572 if (!(attrs
.flags
& SSH_FILEXFER_ATTR_SIZE
)) {
573 printf("read size of %s: size was not given\n", outfname
);
578 uint64_decimal(offset
, decbuf
);
579 printf("reput: restarting at file position %s\n", decbuf
);
580 if (uint64_compare(offset
, uint64_make(0, LONG_MAX
)) > 0) {
581 printf("reput: remote file is larger than we can deal with\n");
585 if (fseek(fp
, offset
.lo
, SEEK_SET
) != 0)
586 fseek(fp
, 0, SEEK_END
); /* *shrug* */
588 offset
= uint64_make(0, 0);
591 printf("local:%s => remote:%s\n", fname
, outfname
);
594 * FIXME: we can use FXP_FSTAT here to get the file size, and
595 * thus put up a progress bar.
602 len
= fread(buffer
, 1, sizeof(buffer
), fp
);
604 printf("error while reading local file\n");
607 } else if (len
== 0) {
611 sftp_register(req
= fxp_write_send(fh
, buffer
, offset
, len
));
612 rreq
= sftp_find_request(pktin
= sftp_recv());
614 ret
= fxp_write_recv(pktin
, rreq
);
617 printf("error while writing: %s\n", fxp_error());
621 offset
= uint64_add32(offset
, len
);
624 sftp_register(req
= fxp_close_send(fh
));
625 rreq
= sftp_find_request(pktin
= sftp_recv());
627 fxp_close_recv(pktin
, rreq
);
634 int sftp_cmd_put(struct sftp_command
*cmd
)
636 return sftp_general_put(cmd
, 0);
638 int sftp_cmd_reput(struct sftp_command
*cmd
)
640 return sftp_general_put(cmd
, 1);
643 int sftp_cmd_mkdir(struct sftp_command
*cmd
)
646 struct sftp_packet
*pktin
;
647 struct sftp_request
*req
, *rreq
;
651 printf("psftp: not connected to a host; use \"open host.name\"\n");
655 if (cmd
->nwords
< 2) {
656 printf("mkdir: expects a directory\n");
660 dir
= canonify(cmd
->words
[1]);
662 printf("%s: %s\n", dir
, fxp_error());
666 sftp_register(req
= fxp_mkdir_send(dir
));
667 rreq
= sftp_find_request(pktin
= sftp_recv());
669 result
= fxp_mkdir_recv(pktin
, rreq
);
672 printf("mkdir %s: %s\n", dir
, fxp_error());
681 int sftp_cmd_rmdir(struct sftp_command
*cmd
)
684 struct sftp_packet
*pktin
;
685 struct sftp_request
*req
, *rreq
;
689 printf("psftp: not connected to a host; use \"open host.name\"\n");
693 if (cmd
->nwords
< 2) {
694 printf("rmdir: expects a directory\n");
698 dir
= canonify(cmd
->words
[1]);
700 printf("%s: %s\n", dir
, fxp_error());
704 sftp_register(req
= fxp_rmdir_send(dir
));
705 rreq
= sftp_find_request(pktin
= sftp_recv());
707 result
= fxp_rmdir_recv(pktin
, rreq
);
710 printf("rmdir %s: %s\n", dir
, fxp_error());
719 int sftp_cmd_rm(struct sftp_command
*cmd
)
722 struct sftp_packet
*pktin
;
723 struct sftp_request
*req
, *rreq
;
727 printf("psftp: not connected to a host; use \"open host.name\"\n");
731 if (cmd
->nwords
< 2) {
732 printf("rm: expects a filename\n");
736 fname
= canonify(cmd
->words
[1]);
738 printf("%s: %s\n", fname
, fxp_error());
742 sftp_register(req
= fxp_remove_send(fname
));
743 rreq
= sftp_find_request(pktin
= sftp_recv());
745 result
= fxp_remove_recv(pktin
, rreq
);
748 printf("rm %s: %s\n", fname
, fxp_error());
757 int sftp_cmd_mv(struct sftp_command
*cmd
)
759 char *srcfname
, *dstfname
;
760 struct sftp_packet
*pktin
;
761 struct sftp_request
*req
, *rreq
;
765 printf("psftp: not connected to a host; use \"open host.name\"\n");
769 if (cmd
->nwords
< 3) {
770 printf("mv: expects two filenames\n");
773 srcfname
= canonify(cmd
->words
[1]);
775 printf("%s: %s\n", srcfname
, fxp_error());
779 dstfname
= canonify(cmd
->words
[2]);
781 printf("%s: %s\n", dstfname
, fxp_error());
785 sftp_register(req
= fxp_rename_send(srcfname
, dstfname
));
786 rreq
= sftp_find_request(pktin
= sftp_recv());
788 result
= fxp_rename_recv(pktin
, rreq
);
791 char const *error
= fxp_error();
792 struct fxp_attrs attrs
;
795 * The move might have failed because dstfname pointed at a
796 * directory. We check this possibility now: if dstfname
797 * _is_ a directory, we re-attempt the move by appending
798 * the basename of srcfname to dstfname.
800 sftp_register(req
= fxp_stat_send(dstfname
));
801 rreq
= sftp_find_request(pktin
= sftp_recv());
803 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
806 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
807 (attrs
.permissions
& 0040000)) {
809 char *newname
, *newcanon
;
810 printf("(destination %s is a directory)\n", dstfname
);
811 p
= srcfname
+ strlen(srcfname
);
812 while (p
> srcfname
&& p
[-1] != '/') p
--;
813 newname
= dupcat(dstfname
, "/", p
, NULL
);
814 newcanon
= canonify(newname
);
820 sftp_register(req
= fxp_rename_send(srcfname
, dstfname
));
821 rreq
= sftp_find_request(pktin
= sftp_recv());
823 result
= fxp_rename_recv(pktin
, rreq
);
825 error
= result ? NULL
: fxp_error();
829 printf("mv %s %s: %s\n", srcfname
, dstfname
, error
);
835 printf("%s -> %s\n", srcfname
, dstfname
);
842 int sftp_cmd_chmod(struct sftp_command
*cmd
)
846 struct fxp_attrs attrs
;
847 unsigned attrs_clr
, attrs_xor
, oldperms
, newperms
;
848 struct sftp_packet
*pktin
;
849 struct sftp_request
*req
, *rreq
;
852 printf("psftp: not connected to a host; use \"open host.name\"\n");
856 if (cmd
->nwords
< 3) {
857 printf("chmod: expects a mode specifier and a filename\n");
862 * Attempt to parse the mode specifier in cmd->words[1]. We
863 * don't support the full horror of Unix chmod; instead we
864 * support a much simpler syntax in which the user can either
865 * specify an octal number, or a comma-separated sequence of
866 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
867 * _only_ be omitted if the only attribute mentioned is t,
868 * since all others require a user/group/other specification.
869 * Additionally, the s attribute may not be specified for any
870 * [ugoa] specifications other than exactly u or exactly g.
872 attrs_clr
= attrs_xor
= 0;
873 mode
= cmd
->words
[1];
874 if (mode
[0] >= '0' && mode
[0] <= '9') {
875 if (mode
[strspn(mode
, "01234567")]) {
876 printf("chmod: numeric file modes should"
877 " contain digits 0-7 only\n");
881 sscanf(mode
, "%o", &attrs_xor
);
882 attrs_xor
&= attrs_clr
;
885 char *modebegin
= mode
;
886 unsigned subset
, perms
;
890 while (*mode
&& *mode
!= ',' &&
891 *mode
!= '+' && *mode
!= '-' && *mode
!= '=') {
893 case 'u': subset
|= 04700; break; /* setuid, user perms */
894 case 'g': subset
|= 02070; break; /* setgid, group perms */
895 case 'o': subset
|= 00007; break; /* just other perms */
896 case 'a': subset
|= 06777; break; /* all of the above */
898 printf("chmod: file mode '%.*s' contains unrecognised"
899 " user/group/other specifier '%c'\n",
900 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
905 if (!*mode
|| *mode
== ',') {
906 printf("chmod: file mode '%.*s' is incomplete\n",
907 (int)strcspn(modebegin
, ","), modebegin
);
911 if (!*mode
|| *mode
== ',') {
912 printf("chmod: file mode '%.*s' is incomplete\n",
913 (int)strcspn(modebegin
, ","), modebegin
);
917 while (*mode
&& *mode
!= ',') {
919 case 'r': perms
|= 00444; break;
920 case 'w': perms
|= 00222; break;
921 case 'x': perms
|= 00111; break;
922 case 't': perms
|= 01000; subset
|= 01000; break;
924 if ((subset
& 06777) != 04700 &&
925 (subset
& 06777) != 02070) {
926 printf("chmod: file mode '%.*s': set[ug]id bit should"
927 " be used with exactly one of u or g only\n",
928 (int)strcspn(modebegin
, ","), modebegin
);
934 printf("chmod: file mode '%.*s' contains unrecognised"
935 " permission specifier '%c'\n",
936 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
941 if (!(subset
& 06777) && (perms
&~ subset
)) {
942 printf("chmod: file mode '%.*s' contains no user/group/other"
943 " specifier and permissions other than 't' \n",
944 (int)strcspn(modebegin
, ","), modebegin
);
962 if (*mode
) mode
++; /* eat comma */
966 fname
= canonify(cmd
->words
[2]);
968 printf("%s: %s\n", fname
, fxp_error());
972 sftp_register(req
= fxp_stat_send(fname
));
973 rreq
= sftp_find_request(pktin
= sftp_recv());
975 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
977 if (!result
|| !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
)) {
978 printf("get attrs for %s: %s\n", fname
,
979 result ?
"file permissions not provided" : fxp_error());
984 attrs
.flags
= SSH_FILEXFER_ATTR_PERMISSIONS
; /* perms _only_ */
985 oldperms
= attrs
.permissions
& 07777;
986 attrs
.permissions
&= ~attrs_clr
;
987 attrs
.permissions
^= attrs_xor
;
988 newperms
= attrs
.permissions
& 07777;
990 sftp_register(req
= fxp_setstat_send(fname
, attrs
));
991 rreq
= sftp_find_request(pktin
= sftp_recv());
993 result
= fxp_setstat_recv(pktin
, rreq
);
996 printf("set attrs for %s: %s\n", fname
, fxp_error());
1001 printf("%s: %04o -> %04o\n", fname
, oldperms
, newperms
);
1007 static int sftp_cmd_open(struct sftp_command
*cmd
)
1010 printf("psftp: already connected\n");
1014 if (cmd
->nwords
< 2) {
1015 printf("open: expects a host name\n");
1019 if (psftp_connect(cmd
->words
[1], NULL
, 0)) {
1020 back
= NULL
; /* connection is already closed */
1021 return -1; /* this is fatal */
1027 static int sftp_cmd_lcd(struct sftp_command
*cmd
)
1029 char *currdir
, *errmsg
;
1031 if (cmd
->nwords
< 2) {
1032 printf("lcd: expects a local directory name\n");
1036 errmsg
= psftp_lcd(cmd
->words
[1]);
1038 printf("lcd: unable to change directory: %s\n", errmsg
);
1043 currdir
= psftp_getcwd();
1044 printf("New local directory is %s\n", currdir
);
1050 static int sftp_cmd_lpwd(struct sftp_command
*cmd
)
1054 currdir
= psftp_getcwd();
1055 printf("Current local directory is %s\n", currdir
);
1061 static int sftp_cmd_pling(struct sftp_command
*cmd
)
1065 exitcode
= system(cmd
->words
[1]);
1066 return (exitcode
== 0);
1069 static int sftp_cmd_help(struct sftp_command
*cmd
);
1071 static struct sftp_cmd_lookup
{
1074 * For help purposes, there are two kinds of command:
1076 * - primary commands, in which `longhelp' is non-NULL. In
1077 * this case `shorthelp' is descriptive text, and `longhelp'
1078 * is longer descriptive text intended to be printed after
1081 * - alias commands, in which `longhelp' is NULL. In this case
1082 * `shorthelp' is the name of a primary command, which
1083 * contains the help that should double up for this command.
1085 int listed
; /* do we list this in primary help? */
1088 int (*obey
) (struct sftp_command
*);
1091 * List of sftp commands. This is binary-searched so it MUST be
1095 "!", TRUE
, "run a local command",
1097 /* FIXME: this example is crap for non-Windows. */
1098 " Runs a local command. For example, \"!del myfile\".\n",
1102 "bye", TRUE
, "finish your SFTP session",
1104 " Terminates your SFTP session and quits the PSFTP program.\n",
1108 "cd", TRUE
, "change your remote working directory",
1109 " [ <New working directory> ]\n"
1110 " Change the remote working directory for your SFTP session.\n"
1111 " If a new working directory is not supplied, you will be\n"
1112 " returned to your home directory.\n",
1116 "chmod", TRUE
, "change file permissions and modes",
1117 " ( <octal-digits> | <modifiers> ) <filename>\n"
1118 " Change the file permissions on a file or directory.\n"
1119 " <octal-digits> can be any octal Unix permission specifier.\n"
1120 " Alternatively, <modifiers> can include:\n"
1121 " u+r make file readable by owning user\n"
1122 " u+w make file writable by owning user\n"
1123 " u+x make file executable by owning user\n"
1124 " u-r make file not readable by owning user\n"
1125 " [also u-w, u-x]\n"
1126 " g+r make file readable by members of owning group\n"
1127 " [also g+w, g+x, g-r, g-w, g-x]\n"
1128 " o+r make file readable by all other users\n"
1129 " [also o+w, o+x, o-r, o-w, o-x]\n"
1130 " a+r make file readable by absolutely everybody\n"
1131 " [also a+w, a+x, a-r, a-w, a-x]\n"
1132 " u+s enable the Unix set-user-ID bit\n"
1133 " u-s disable the Unix set-user-ID bit\n"
1134 " g+s enable the Unix set-group-ID bit\n"
1135 " g-s disable the Unix set-group-ID bit\n"
1136 " +t enable the Unix \"sticky bit\"\n"
1137 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1138 " more than one user for the same modifier (\"ug+w\"). You can\n"
1139 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1143 "del", TRUE
, "delete a file",
1145 " Delete a file.\n",
1149 "delete", FALSE
, "del", NULL
, sftp_cmd_rm
1152 "dir", TRUE
, "list contents of a remote directory",
1153 " [ <directory-name> ]\n"
1154 " List the contents of a specified directory on the server.\n"
1155 " If <directory-name> is not given, the current working directory\n"
1156 " will be listed.\n",
1160 "exit", TRUE
, "bye", NULL
, sftp_cmd_quit
1163 "get", TRUE
, "download a file from the server to your local machine",
1164 " <filename> [ <local-filename> ]\n"
1165 " Downloads a file on the server and stores it locally under\n"
1166 " the same name, or under a different one if you supply the\n"
1167 " argument <local-filename>.\n",
1171 "help", TRUE
, "give help",
1172 " [ <command> [ <command> ... ] ]\n"
1173 " Give general help if no commands are specified.\n"
1174 " If one or more commands are specified, give specific help on\n"
1175 " those particular commands.\n",
1179 "lcd", TRUE
, "change local working directory",
1180 " <local-directory-name>\n"
1181 " Change the local working directory of the PSFTP program (the\n"
1182 " default location where the \"get\" command will save files).\n",
1186 "lpwd", TRUE
, "print local working directory",
1188 " Print the local working directory of the PSFTP program (the\n"
1189 " default location where the \"get\" command will save files).\n",
1193 "ls", TRUE
, "dir", NULL
,
1197 "mkdir", TRUE
, "create a directory on the remote server",
1198 " <directory-name>\n"
1199 " Creates a directory with the given name on the server.\n",
1203 "mv", TRUE
, "move or rename a file on the remote server",
1204 " <source-filename> <destination-filename>\n"
1205 " Moves or renames the file <source-filename> on the server,\n"
1206 " so that it is accessible under the name <destination-filename>.\n",
1210 "open", TRUE
, "connect to a host",
1211 " [<user>@]<hostname>\n"
1212 " Establishes an SFTP connection to a given host. Only usable\n"
1213 " when you did not already specify a host name on the command\n"
1218 "put", TRUE
, "upload a file from your local machine to the server",
1219 " <filename> [ <remote-filename> ]\n"
1220 " Uploads a file to the server and stores it there under\n"
1221 " the same name, or under a different one if you supply the\n"
1222 " argument <remote-filename>.\n",
1226 "pwd", TRUE
, "print your remote working directory",
1228 " Print the current remote working directory for your SFTP session.\n",
1232 "quit", TRUE
, "bye", NULL
,
1236 "reget", TRUE
, "continue downloading a file",
1237 " <filename> [ <local-filename> ]\n"
1238 " Works exactly like the \"get\" command, but the local file\n"
1239 " must already exist. The download will begin at the end of the\n"
1240 " file. This is for resuming a download that was interrupted.\n",
1244 "ren", TRUE
, "mv", NULL
,
1248 "rename", FALSE
, "mv", NULL
,
1252 "reput", TRUE
, "continue uploading a file",
1253 " <filename> [ <remote-filename> ]\n"
1254 " Works exactly like the \"put\" command, but the remote file\n"
1255 " must already exist. The upload will begin at the end of the\n"
1256 " file. This is for resuming an upload that was interrupted.\n",
1260 "rm", TRUE
, "del", NULL
,
1264 "rmdir", TRUE
, "remove a directory on the remote server",
1265 " <directory-name>\n"
1266 " Removes the directory with the given name on the server.\n"
1267 " The directory will not be removed unless it is empty.\n",
1272 const struct sftp_cmd_lookup
*lookup_command(char *name
)
1277 j
= sizeof(sftp_lookup
) / sizeof(*sftp_lookup
);
1280 cmp
= strcmp(name
, sftp_lookup
[k
].name
);
1286 return &sftp_lookup
[k
];
1292 static int sftp_cmd_help(struct sftp_command
*cmd
)
1295 if (cmd
->nwords
== 1) {
1297 * Give short help on each command.
1301 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
1303 if (!sftp_lookup
[i
].listed
)
1305 len
= strlen(sftp_lookup
[i
].name
);
1309 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
1310 const struct sftp_cmd_lookup
*lookup
;
1311 if (!sftp_lookup
[i
].listed
)
1313 lookup
= &sftp_lookup
[i
];
1314 printf("%-*s", maxlen
+2, lookup
->name
);
1315 if (lookup
->longhelp
== NULL
)
1316 lookup
= lookup_command(lookup
->shorthelp
);
1317 printf("%s\n", lookup
->shorthelp
);
1321 * Give long help on specific commands.
1323 for (i
= 1; i
< cmd
->nwords
; i
++) {
1324 const struct sftp_cmd_lookup
*lookup
;
1325 lookup
= lookup_command(cmd
->words
[i
]);
1327 printf("help: %s: command not found\n", cmd
->words
[i
]);
1329 printf("%s", lookup
->name
);
1330 if (lookup
->longhelp
== NULL
)
1331 lookup
= lookup_command(lookup
->shorthelp
);
1332 printf("%s", lookup
->longhelp
);
1339 /* ----------------------------------------------------------------------
1340 * Command line reading and parsing.
1342 struct sftp_command
*sftp_getcmd(FILE *fp
, int mode
, int modeflags
)
1345 int linelen
, linesize
;
1346 struct sftp_command
*cmd
;
1350 if ((mode
== 0) || (modeflags
& 1)) {
1355 cmd
= snew(struct sftp_command
);
1361 linesize
= linelen
= 0;
1367 line
= sresize(line
, linesize
, char);
1368 ret
= fgets(line
+ linelen
, linesize
- linelen
, fp
);
1370 if (!ret
|| (linelen
== 0 && line
[0] == '\0')) {
1371 cmd
->obey
= sftp_cmd_quit
;
1372 if ((mode
== 0) || (modeflags
& 1))
1374 return cmd
; /* eof */
1376 len
= linelen
+ strlen(line
+ linelen
);
1378 if (line
[linelen
- 1] == '\n') {
1380 line
[linelen
] = '\0';
1384 if (modeflags
& 1) {
1385 printf("%s\n", line
);
1389 while (*p
&& (*p
== ' ' || *p
== '\t'))
1394 * Special case: the ! command. This is always parsed as
1395 * exactly two words: one containing the !, and the second
1396 * containing everything else on the line.
1398 cmd
->nwords
= cmd
->wordssize
= 2;
1399 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
1400 cmd
->words
[0] = "!";
1401 cmd
->words
[1] = p
+1;
1405 * Parse the command line into words. The syntax is:
1406 * - double quotes are removed, but cause spaces within to be
1407 * treated as non-separating.
1408 * - a double-doublequote pair is a literal double quote, inside
1409 * _or_ outside quotes. Like this:
1411 * firstword "second word" "this has ""quotes"" in" and""this""
1417 * >this has "quotes" in<
1421 /* skip whitespace */
1422 while (*p
&& (*p
== ' ' || *p
== '\t'))
1424 /* mark start of word */
1425 q
= r
= p
; /* q sits at start, r writes word */
1428 if (!quoting
&& (*p
== ' ' || *p
== '\t'))
1429 break; /* reached end of word */
1430 else if (*p
== '"' && p
[1] == '"')
1431 p
+= 2, *r
++ = '"'; /* a literal quote */
1433 p
++, quoting
= !quoting
;
1438 p
++; /* skip over the whitespace */
1440 if (cmd
->nwords
>= cmd
->wordssize
) {
1441 cmd
->wordssize
= cmd
->nwords
+ 16;
1442 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
1444 cmd
->words
[cmd
->nwords
++] = q
;
1449 * Now parse the first word and assign a function.
1452 if (cmd
->nwords
== 0)
1453 cmd
->obey
= sftp_cmd_null
;
1455 const struct sftp_cmd_lookup
*lookup
;
1456 lookup
= lookup_command(cmd
->words
[0]);
1458 cmd
->obey
= sftp_cmd_unknown
;
1460 cmd
->obey
= lookup
->obey
;
1466 static int do_sftp_init(void)
1468 struct sftp_packet
*pktin
;
1469 struct sftp_request
*req
, *rreq
;
1472 * Do protocol initialisation.
1476 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
1477 return 1; /* failure */
1481 * Find out where our home directory is.
1483 sftp_register(req
= fxp_realpath_send("."));
1484 rreq
= sftp_find_request(pktin
= sftp_recv());
1485 assert(rreq
== req
);
1486 homedir
= fxp_realpath_recv(pktin
, rreq
);
1490 "Warning: failed to resolve home directory: %s\n",
1492 homedir
= dupstr(".");
1494 printf("Remote working directory is %s\n", homedir
);
1496 pwd
= dupstr(homedir
);
1500 void do_sftp(int mode
, int modeflags
, char *batchfile
)
1510 /* ------------------------------------------------------------------
1511 * Now we're ready to do Real Stuff.
1514 struct sftp_command
*cmd
;
1515 cmd
= sftp_getcmd(stdin
, 0, 0);
1518 if (cmd
->obey(cmd
) < 0)
1522 fp
= fopen(batchfile
, "r");
1524 printf("Fatal: unable to open %s\n", batchfile
);
1528 struct sftp_command
*cmd
;
1529 cmd
= sftp_getcmd(fp
, mode
, modeflags
);
1532 ret
= cmd
->obey(cmd
);
1536 if (!(modeflags
& 2))
1545 /* ----------------------------------------------------------------------
1546 * Dirty bits: integration with PuTTY.
1549 static int verbose
= 0;
1552 * Print an error message and perform a fatal exit.
1554 void fatalbox(char *fmt
, ...)
1559 str
= dupvprintf(fmt
, ap
);
1560 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
1563 fputs(str2
, stderr
);
1568 void modalfatalbox(char *fmt
, ...)
1573 str
= dupvprintf(fmt
, ap
);
1574 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
1577 fputs(str2
, stderr
);
1582 void connection_fatal(void *frontend
, char *fmt
, ...)
1587 str
= dupvprintf(fmt
, ap
);
1588 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
1591 fputs(str2
, stderr
);
1597 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
)
1600 * This is only here because of the calls to ldisc_send(NULL,
1601 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
1602 * ldisc as an ldisc. So if we get called with any real data, I
1603 * want to know about it.
1609 * In psftp, all agent requests should be synchronous, so this is a
1610 * never-called stub.
1612 void agent_schedule_callback(void (*callback
)(void *, void *, int),
1613 void *callback_ctx
, void *data
, int len
)
1615 assert(!"We shouldn't be here");
1619 * Receive a block of data from the SSH link. Block until all data
1622 * To do this, we repeatedly call the SSH protocol module, with our
1623 * own trap in from_backend() to catch the data that comes back. We
1624 * do this until we have enough data.
1627 static unsigned char *outptr
; /* where to put the data */
1628 static unsigned outlen
; /* how much data required */
1629 static unsigned char *pending
= NULL
; /* any spare data */
1630 static unsigned pendlen
= 0, pendsize
= 0; /* length and phys. size of buffer */
1631 int from_backend(void *frontend
, int is_stderr
, const char *data
, int datalen
)
1633 unsigned char *p
= (unsigned char *) data
;
1634 unsigned len
= (unsigned) datalen
;
1639 * stderr data is just spouted to local stderr and otherwise
1643 fwrite(data
, 1, len
, stderr
);
1648 * If this is before the real session begins, just return.
1654 unsigned used
= outlen
;
1657 memcpy(outptr
, p
, used
);
1665 if (pendsize
< pendlen
+ len
) {
1666 pendsize
= pendlen
+ len
+ 4096;
1667 pending
= sresize(pending
, pendsize
, unsigned char);
1669 memcpy(pending
+ pendlen
, p
, len
);
1675 int sftp_recvdata(char *buf
, int len
)
1677 outptr
= (unsigned char *) buf
;
1681 * See if the pending-input block contains some of what we
1685 unsigned pendused
= pendlen
;
1686 if (pendused
> outlen
)
1688 memcpy(outptr
, pending
, pendused
);
1689 memmove(pending
, pending
+ pendused
, pendlen
- pendused
);
1692 pendlen
-= pendused
;
1702 while (outlen
> 0) {
1703 if (ssh_sftp_loop_iteration() < 0)
1704 return 0; /* doom */
1709 int sftp_senddata(char *buf
, int len
)
1711 back
->send(backhandle
, (unsigned char *) buf
, len
);
1716 * Short description of parameters.
1718 static void usage(void)
1720 printf("PuTTY Secure File Transfer (SFTP) client\n");
1721 printf("%s\n", ver
);
1722 printf("Usage: psftp [options] user@host\n");
1723 printf("Options:\n");
1724 printf(" -b file use specified batchfile\n");
1725 printf(" -bc output batchfile commands\n");
1726 printf(" -be don't stop batchfile processing if errors\n");
1727 printf(" -v show verbose messages\n");
1728 printf(" -load sessname Load settings from saved session\n");
1729 printf(" -l user connect with specified username\n");
1730 printf(" -P port connect to specified port\n");
1731 printf(" -pw passw login with specified password\n");
1732 printf(" -1 -2 force use of particular SSH protocol version\n");
1733 printf(" -C enable compression\n");
1734 printf(" -i key private key file for authentication\n");
1735 printf(" -batch disable all interactive prompts\n");
1740 * Connect to a host.
1742 static int psftp_connect(char *userhost
, char *user
, int portnumber
)
1744 char *host
, *realhost
;
1748 /* Separate host and username */
1750 host
= strrchr(host
, '@');
1756 printf("psftp: multiple usernames specified; using \"%s\"\n",
1762 /* Try to load settings for this host */
1763 do_defaults(host
, &cfg
);
1764 if (cfg
.host
[0] == '\0') {
1765 /* No settings for this host; use defaults */
1766 do_defaults(NULL
, &cfg
);
1767 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
1768 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
1772 * Force use of SSH. (If they got the protocol wrong we assume the
1773 * port is useless too.)
1775 if (cfg
.protocol
!= PROT_SSH
) {
1776 cfg
.protocol
= PROT_SSH
;
1781 * Enact command-line overrides.
1783 cmdline_run_saved(&cfg
);
1786 * Trim leading whitespace off the hostname if it's there.
1789 int space
= strspn(cfg
.host
, " \t");
1790 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
1793 /* See if host is of the form user@host */
1794 if (cfg
.host
[0] != '\0') {
1795 char *atsign
= strchr(cfg
.host
, '@');
1796 /* Make sure we're not overflowing the user field */
1798 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
1799 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
1800 cfg
.username
[atsign
- cfg
.host
] = '\0';
1802 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
1807 * Trim a colon suffix off the hostname if it's there.
1809 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
1812 * Remove any remaining whitespace from the hostname.
1816 while (cfg
.host
[p2
] != '\0') {
1817 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
1818 cfg
.host
[p1
] = cfg
.host
[p2
];
1823 cfg
.host
[p1
] = '\0';
1827 if (user
!= NULL
&& user
[0] != '\0') {
1828 strncpy(cfg
.username
, user
, sizeof(cfg
.username
) - 1);
1829 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
1831 if (!cfg
.username
[0]) {
1832 printf("login as: ");
1834 if (!fgets(cfg
.username
, sizeof(cfg
.username
), stdin
)) {
1835 fprintf(stderr
, "psftp: aborting\n");
1838 int len
= strlen(cfg
.username
);
1839 if (cfg
.username
[len
- 1] == '\n')
1840 cfg
.username
[len
- 1] = '\0';
1845 cfg
.port
= portnumber
;
1847 /* SFTP uses SSH2 by default always */
1851 * Disable scary things which shouldn't be enabled for simple
1852 * things like SCP and SFTP: agent forwarding, port forwarding,
1855 cfg
.x11_forward
= 0;
1857 cfg
.portfwd
[0] = cfg
.portfwd
[1] = '\0';
1859 /* Set up subsystem name. */
1860 strcpy(cfg
.remote_cmd
, "sftp");
1861 cfg
.ssh_subsys
= TRUE
;
1865 * Set up fallback option, for SSH1 servers or servers with the
1866 * sftp subsystem not enabled but the server binary installed
1867 * in the usual place. We only support fallback on Unix
1868 * systems, and we use a kludgy piece of shellery which should
1869 * try to find sftp-server in various places (the obvious
1870 * systemwide spots /usr/lib and /usr/local/lib, and then the
1871 * user's PATH) and finally give up.
1873 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
1874 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
1877 * the idea being that this will attempt to use either of the
1878 * obvious pathnames and then give up, and when it does give up
1879 * it will print the preferred pathname in the error messages.
1881 cfg
.remote_cmd_ptr2
=
1882 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
1883 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
1885 cfg
.ssh_subsys2
= FALSE
;
1887 back
= &ssh_backend
;
1889 err
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
, &realhost
,0);
1891 fprintf(stderr
, "ssh_init: %s\n", err
);
1894 logctx
= log_init(NULL
, &cfg
);
1895 back
->provide_logctx(backhandle
, logctx
);
1896 console_provide_logctx(logctx
);
1897 while (!back
->sendok(backhandle
)) {
1898 if (ssh_sftp_loop_iteration() < 0) {
1899 fprintf(stderr
, "ssh_init: error during SSH connection setup\n");
1903 if (verbose
&& realhost
!= NULL
)
1904 printf("Connected to %s\n", realhost
);
1908 void cmdline_error(char *p
, ...)
1911 fprintf(stderr
, "psftp: ");
1913 vfprintf(stderr
, p
, ap
);
1915 fprintf(stderr
, "\n try typing \"psftp -h\" for help\n");
1920 * Main program. Parse arguments etc.
1922 int psftp_main(int argc
, char *argv
[])
1926 char *userhost
, *user
;
1929 char *batchfile
= NULL
;
1932 flags
= FLAG_STDERR
| FLAG_INTERACTIVE
1933 #ifdef FLAG_SYNCAGENT
1937 cmdline_tooltype
= TOOLTYPE_FILETRANSFER
;
1938 ssh_get_line
= &console_get_line
;
1941 userhost
= user
= NULL
;
1944 for (i
= 1; i
< argc
; i
++) {
1946 if (argv
[i
][0] != '-') {
1950 userhost
= dupstr(argv
[i
]);
1953 ret
= cmdline_process_param(argv
[i
], i
+1<argc?argv
[i
+1]:NULL
, 1, &cfg
);
1955 cmdline_error("option \"%s\" requires an argument", argv
[i
]);
1956 } else if (ret
== 2) {
1957 i
++; /* skip next argument */
1958 } else if (ret
== 1) {
1959 /* We have our own verbosity in addition to `flags'. */
1960 if (flags
& FLAG_VERBOSE
)
1962 } else if (strcmp(argv
[i
], "-h") == 0 ||
1963 strcmp(argv
[i
], "-?") == 0) {
1965 } else if (strcmp(argv
[i
], "-batch") == 0) {
1966 console_batch_mode
= 1;
1967 } else if (strcmp(argv
[i
], "-b") == 0 && i
+ 1 < argc
) {
1969 batchfile
= argv
[++i
];
1970 } else if (strcmp(argv
[i
], "-bc") == 0) {
1971 modeflags
= modeflags
| 1;
1972 } else if (strcmp(argv
[i
], "-be") == 0) {
1973 modeflags
= modeflags
| 2;
1974 } else if (strcmp(argv
[i
], "--") == 0) {
1978 cmdline_error("unknown option \"%s\"", argv
[i
]);
1986 * If a user@host string has already been provided, connect to
1990 if (psftp_connect(userhost
, user
, portnumber
))
1995 printf("psftp: no hostname specified; use \"open host.name\""
1999 do_sftp(mode
, modeflags
, batchfile
);
2001 if (back
!= NULL
&& back
->socket(backhandle
) != NULL
) {
2003 back
->special(backhandle
, TS_EOF
);
2004 sftp_recvdata(&ch
, 1);