2 * psftp.c: (platform-independent) front end for PSFTP.
11 #define PUTTY_DO_GLOBALS
19 const char *const appname
= "PSFTP";
22 * Since SFTP is a request-response oriented protocol, it requires
23 * no buffer management: when we send data, we stop and wait for an
24 * acknowledgement _anyway_, and so we can't possibly overfill our
28 static int psftp_connect(char *userhost
, char *user
, int portnumber
);
29 static int do_sftp_init(void);
30 void do_sftp_cleanup();
32 /* ----------------------------------------------------------------------
38 static void *backhandle
;
42 /* ----------------------------------------------------------------------
43 * Manage sending requests and waiting for replies.
45 struct sftp_packet
*sftp_wait_for_reply(struct sftp_request
*req
)
47 struct sftp_packet
*pktin
;
48 struct sftp_request
*rreq
;
53 connection_fatal(NULL
, "did not receive SFTP response packet "
55 rreq
= sftp_find_request(pktin
);
57 connection_fatal(NULL
, "unable to understand SFTP response packet "
58 "from server: %s", fxp_error());
62 /* ----------------------------------------------------------------------
63 * Higher-level helper functions used in commands.
67 * Attempt to canonify a pathname starting from the pwd. If
68 * canonification fails, at least fall back to returning a _valid_
69 * pathname (though it may be ugly, eg /home/simon/../foobar).
71 char *canonify(char *name
)
73 char *fullname
, *canonname
;
74 struct sftp_packet
*pktin
;
75 struct sftp_request
*req
;
78 fullname
= dupstr(name
);
81 if (pwd
[strlen(pwd
) - 1] == '/')
85 fullname
= dupcat(pwd
, slash
, name
, NULL
);
88 req
= fxp_realpath_send(fullname
);
89 pktin
= sftp_wait_for_reply(req
);
90 canonname
= fxp_realpath_recv(pktin
, req
);
97 * Attempt number 2. Some FXP_REALPATH implementations
98 * (glibc-based ones, in particular) require the _whole_
99 * path to point to something that exists, whereas others
100 * (BSD-based) only require all but the last component to
101 * exist. So if the first call failed, we should strip off
102 * everything from the last slash onwards and try again,
103 * then put the final component back on.
107 * - if the last component is "/." or "/..", then we don't
108 * bother trying this because there's no way it can work.
110 * - if the thing actually ends with a "/", we remove it
111 * before we start. Except if the string is "/" itself
112 * (although I can't see why we'd have got here if so,
113 * because surely "/" would have worked the first
114 * time?), in which case we don't bother.
116 * - if there's no slash in the string at all, give up in
117 * confusion (we expect at least one because of the way
118 * we constructed the string).
124 i
= strlen(fullname
);
125 if (i
> 2 && fullname
[i
- 1] == '/')
126 fullname
[--i
] = '\0'; /* strip trailing / unless at pos 0 */
127 while (i
> 0 && fullname
[--i
] != '/');
130 * Give up on special cases.
132 if (fullname
[i
] != '/' || /* no slash at all */
133 !strcmp(fullname
+ i
, "/.") || /* ends in /. */
134 !strcmp(fullname
+ i
, "/..") || /* ends in /.. */
135 !strcmp(fullname
, "/")) {
140 * Now i points at the slash. Deal with the final special
141 * case i==0 (ie the whole path was "/nonexistentfile").
143 fullname
[i
] = '\0'; /* separate the string */
145 req
= fxp_realpath_send("/");
147 req
= fxp_realpath_send(fullname
);
149 pktin
= sftp_wait_for_reply(req
);
150 canonname
= fxp_realpath_recv(pktin
, req
);
153 /* Even that failed. Restore our best guess at the
154 * constructed filename and give up */
155 fullname
[i
] = '/'; /* restore slash and last component */
160 * We have a canonical name for all but the last path
161 * component. Concatenate the last component and return.
163 returnname
= dupcat(canonname
,
164 canonname
[strlen(canonname
) - 1] ==
165 '/' ?
"" : "/", fullname
+ i
+ 1, NULL
);
173 * Return a pointer to the portion of str that comes after the last
174 * slash (or backslash or colon, if `local' is TRUE).
176 static char *stripslashes(char *str
, int local
)
181 p
= strchr(str
, ':');
185 p
= strrchr(str
, '/');
189 p
= strrchr(str
, '\\');
197 * qsort comparison routine for fxp_name structures. Sorts by real
200 static int sftp_name_compare(const void *av
, const void *bv
)
202 const struct fxp_name
*const *a
= (const struct fxp_name
*const *) av
;
203 const struct fxp_name
*const *b
= (const struct fxp_name
*const *) bv
;
204 return strcmp((*a
)->filename
, (*b
)->filename
);
208 * Likewise, but for a bare char *.
210 static int bare_name_compare(const void *av
, const void *bv
)
212 const char **a
= (const char **) av
;
213 const char **b
= (const char **) bv
;
214 return strcmp(*a
, *b
);
217 static void not_connected(void)
219 printf("psftp: not connected to a host; use \"open host.name\"\n");
222 /* ----------------------------------------------------------------------
223 * The meat of the `get' and `put' commands.
225 int sftp_get_file(char *fname
, char *outfname
, int recurse
, int restart
)
227 struct fxp_handle
*fh
;
228 struct sftp_packet
*pktin
;
229 struct sftp_request
*req
;
230 struct fxp_xfer
*xfer
;
233 int ret
, shown_err
= FALSE
;
234 struct fxp_attrs attrs
;
237 * In recursive mode, see if we're dealing with a directory.
238 * (If we're not in recursive mode, we need not even check: the
239 * subsequent FXP_OPEN will return a usable error message.)
244 req
= fxp_stat_send(fname
);
245 pktin
= sftp_wait_for_reply(req
);
246 result
= fxp_stat_recv(pktin
, req
, &attrs
);
249 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
250 (attrs
.permissions
& 0040000)) {
252 struct fxp_handle
*dirhandle
;
253 int nnames
, namesize
;
254 struct fxp_name
**ournames
;
255 struct fxp_names
*names
;
259 * First, attempt to create the destination directory,
260 * unless it already exists.
262 if (file_type(outfname
) != FILE_TYPE_DIRECTORY
&&
263 !create_directory(outfname
)) {
264 printf("%s: Cannot create directory\n", outfname
);
269 * Now get the list of filenames in the remote
272 req
= fxp_opendir_send(fname
);
273 pktin
= sftp_wait_for_reply(req
);
274 dirhandle
= fxp_opendir_recv(pktin
, req
);
277 printf("%s: unable to open directory: %s\n",
281 nnames
= namesize
= 0;
286 req
= fxp_readdir_send(dirhandle
);
287 pktin
= sftp_wait_for_reply(req
);
288 names
= fxp_readdir_recv(pktin
, req
);
291 if (fxp_error_type() == SSH_FX_EOF
)
293 printf("%s: reading directory: %s\n", fname
, fxp_error());
297 if (names
->nnames
== 0) {
298 fxp_free_names(names
);
301 if (nnames
+ names
->nnames
>= namesize
) {
302 namesize
+= names
->nnames
+ 128;
303 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
305 for (i
= 0; i
< names
->nnames
; i
++)
306 if (strcmp(names
->names
[i
].filename
, ".") &&
307 strcmp(names
->names
[i
].filename
, "..")) {
308 if (!vet_filename(names
->names
[i
].filename
)) {
309 printf("ignoring potentially dangerous server-"
310 "supplied filename '%s'\n",
311 names
->names
[i
].filename
);
314 fxp_dup_name(&names
->names
[i
]);
317 fxp_free_names(names
);
319 req
= fxp_close_send(dirhandle
);
320 pktin
= sftp_wait_for_reply(req
);
321 fxp_close_recv(pktin
, req
);
324 * Sort the names into a clear order. This ought to
325 * make things more predictable when we're doing a
326 * reget of the same directory, just in case two
327 * readdirs on the same remote directory return a
330 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
333 * If we're in restart mode, find the last filename on
334 * this list that already exists. We may have to do a
335 * reget on _that_ file, but shouldn't have to do
336 * anything on the previous files.
338 * If none of them exists, of course, we start at 0.
346 nextoutfname
= dir_file_cat(outfname
,
347 ournames
[i
]->filename
);
349 nextoutfname
= dupstr(ournames
[i
]->filename
);
350 ret
= (file_type(nextoutfname
) == FILE_TYPE_NONEXISTENT
);
361 * Now we're ready to recurse. Starting at ournames[i]
362 * and continuing on to the end of the list, we
363 * construct a new source and target file name, and
364 * call sftp_get_file again.
366 for (; i
< nnames
; i
++) {
367 char *nextfname
, *nextoutfname
;
370 nextfname
= dupcat(fname
, "/", ournames
[i
]->filename
, NULL
);
372 nextoutfname
= dir_file_cat(outfname
,
373 ournames
[i
]->filename
);
375 nextoutfname
= dupstr(ournames
[i
]->filename
);
376 ret
= sftp_get_file(nextfname
, nextoutfname
, recurse
, restart
);
377 restart
= FALSE
; /* after first partial file, do full */
381 for (i
= 0; i
< nnames
; i
++) {
382 fxp_free_name(ournames
[i
]);
390 * Done this recursion level. Free everything.
392 for (i
= 0; i
< nnames
; i
++) {
393 fxp_free_name(ournames
[i
]);
401 req
= fxp_stat_send(fname
);
402 pktin
= sftp_wait_for_reply(req
);
403 if (!fxp_stat_recv(pktin
, req
, &attrs
))
406 req
= fxp_open_send(fname
, SSH_FXF_READ
, NULL
);
407 pktin
= sftp_wait_for_reply(req
);
408 fh
= fxp_open_recv(pktin
, req
);
411 printf("%s: open for read: %s\n", fname
, fxp_error());
416 file
= open_existing_wfile(outfname
, NULL
);
418 file
= open_new_file(outfname
, GET_PERMISSIONS(attrs
));
422 printf("local: unable to open %s\n", outfname
);
424 req
= fxp_close_send(fh
);
425 pktin
= sftp_wait_for_reply(req
);
426 fxp_close_recv(pktin
, req
);
433 if (seek_file(file
, uint64_make(0,0) , FROM_END
) == -1) {
435 printf("reget: cannot restart %s - file too large\n",
437 req
= fxp_close_send(fh
);
438 pktin
= sftp_wait_for_reply(req
);
439 fxp_close_recv(pktin
, req
);
444 offset
= get_file_posn(file
);
445 uint64_decimal(offset
, decbuf
);
446 printf("reget: restarting at file position %s\n", decbuf
);
448 offset
= uint64_make(0, 0);
451 printf("remote:%s => local:%s\n", fname
, outfname
);
454 * FIXME: we can use FXP_FSTAT here to get the file size, and
455 * thus put up a progress bar.
458 xfer
= xfer_download_init(fh
, offset
);
459 while (!xfer_done(xfer
)) {
464 xfer_download_queue(xfer
);
466 ret
= xfer_download_gotpkt(xfer
, pktin
);
469 printf("error while reading: %s\n", fxp_error());
475 while (xfer_download_data(xfer
, &vbuf
, &len
)) {
476 unsigned char *buf
= (unsigned char *)vbuf
;
480 wlen
= write_to_file(file
, buf
+ wpos
, len
- wpos
);
482 printf("error while writing local file\n");
484 xfer_set_error(xfer
);
489 if (wpos
< len
) { /* we had an error */
491 xfer_set_error(xfer
);
502 req
= fxp_close_send(fh
);
503 pktin
= sftp_wait_for_reply(req
);
504 fxp_close_recv(pktin
, req
);
509 int sftp_put_file(char *fname
, char *outfname
, int recurse
, int restart
)
511 struct fxp_handle
*fh
;
512 struct fxp_xfer
*xfer
;
513 struct sftp_packet
*pktin
;
514 struct sftp_request
*req
;
518 struct fxp_attrs attrs
;
522 * In recursive mode, see if we're dealing with a directory.
523 * (If we're not in recursive mode, we need not even check: the
524 * subsequent fopen will return an error message.)
526 if (recurse
&& file_type(fname
) == FILE_TYPE_DIRECTORY
) {
528 int nnames
, namesize
;
529 char *name
, **ournames
;
534 * First, attempt to create the destination directory,
535 * unless it already exists.
537 req
= fxp_stat_send(outfname
);
538 pktin
= sftp_wait_for_reply(req
);
539 result
= fxp_stat_recv(pktin
, req
, &attrs
);
541 !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) ||
542 !(attrs
.permissions
& 0040000)) {
543 req
= fxp_mkdir_send(outfname
);
544 pktin
= sftp_wait_for_reply(req
);
545 result
= fxp_mkdir_recv(pktin
, req
);
548 printf("%s: create directory: %s\n",
549 outfname
, fxp_error());
555 * Now get the list of filenames in the local directory.
557 nnames
= namesize
= 0;
560 dh
= open_directory(fname
);
562 printf("%s: unable to open directory\n", fname
);
565 while ((name
= read_filename(dh
)) != NULL
) {
566 if (nnames
>= namesize
) {
568 ournames
= sresize(ournames
, namesize
, char *);
570 ournames
[nnames
++] = name
;
575 * Sort the names into a clear order. This ought to make
576 * things more predictable when we're doing a reput of the
577 * same directory, just in case two readdirs on the same
578 * local directory return a different order.
580 qsort(ournames
, nnames
, sizeof(*ournames
), bare_name_compare
);
583 * If we're in restart mode, find the last filename on this
584 * list that already exists. We may have to do a reput on
585 * _that_ file, but shouldn't have to do anything on the
588 * If none of them exists, of course, we start at 0.
594 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
595 req
= fxp_stat_send(nextoutfname
);
596 pktin
= sftp_wait_for_reply(req
);
597 result
= fxp_stat_recv(pktin
, req
, &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
, recurse
, restart
);
623 restart
= FALSE
; /* after first partial file, do full */
627 for (i
= 0; i
< nnames
; i
++) {
636 * Done this recursion level. Free everything.
638 for (i
= 0; i
< nnames
; i
++) {
646 file
= open_existing_file(fname
, NULL
, NULL
, NULL
, &permissions
);
648 printf("local: unable to open %s\n", fname
);
652 PUT_PERMISSIONS(attrs
, permissions
);
654 req
= fxp_open_send(outfname
, SSH_FXF_WRITE
, &attrs
);
656 req
= fxp_open_send(outfname
,
657 SSH_FXF_WRITE
| SSH_FXF_CREAT
| SSH_FXF_TRUNC
,
660 pktin
= sftp_wait_for_reply(req
);
661 fh
= fxp_open_recv(pktin
, req
);
665 printf("%s: open for write: %s\n", outfname
, fxp_error());
671 struct fxp_attrs attrs
;
674 req
= fxp_fstat_send(fh
);
675 pktin
= sftp_wait_for_reply(req
);
676 ret
= fxp_fstat_recv(pktin
, req
, &attrs
);
680 printf("read size of %s: %s\n", outfname
, fxp_error());
683 if (!(attrs
.flags
& SSH_FILEXFER_ATTR_SIZE
)) {
685 printf("read size of %s: size was not given\n", outfname
);
689 uint64_decimal(offset
, decbuf
);
690 printf("reput: restarting at file position %s\n", decbuf
);
692 if (seek_file((WFile
*)file
, offset
, FROM_START
) != 0)
693 seek_file((WFile
*)file
, uint64_make(0,0), FROM_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
= read_from_file(file
, buffer
, sizeof(buffer
));
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
);
726 if (ret
<= 0 && !err
) {
727 printf("error while writing: %s\n", fxp_error());
735 req
= fxp_close_send(fh
);
736 pktin
= sftp_wait_for_reply(req
);
737 fxp_close_recv(pktin
, req
);
744 /* ----------------------------------------------------------------------
745 * A remote wildcard matcher, providing a similar interface to the
746 * local one in psftp.h.
749 typedef struct SftpWildcardMatcher
{
750 struct fxp_handle
*dirh
;
751 struct fxp_names
*names
;
753 char *wildcard
, *prefix
;
754 } SftpWildcardMatcher
;
756 SftpWildcardMatcher
*sftp_begin_wildcard_matching(char *name
)
758 struct sftp_packet
*pktin
;
759 struct sftp_request
*req
;
761 char *unwcdir
, *tmpdir
, *cdir
;
763 SftpWildcardMatcher
*swcm
;
764 struct fxp_handle
*dirh
;
767 * We don't handle multi-level wildcards; so we expect to find
768 * a fully specified directory part, followed by a wildcard
771 wildcard
= stripslashes(name
, 0);
773 unwcdir
= dupstr(name
);
774 len
= wildcard
- name
;
776 if (len
> 0 && unwcdir
[len
-1] == '/')
777 unwcdir
[len
-1] = '\0';
778 tmpdir
= snewn(1 + len
, char);
779 check
= wc_unescape(tmpdir
, unwcdir
);
783 printf("Multiple-level wildcards are not supported\n");
788 cdir
= canonify(unwcdir
);
790 req
= fxp_opendir_send(cdir
);
791 pktin
= sftp_wait_for_reply(req
);
792 dirh
= fxp_opendir_recv(pktin
, req
);
795 swcm
= snew(SftpWildcardMatcher
);
798 swcm
->wildcard
= dupstr(wildcard
);
799 swcm
->prefix
= unwcdir
;
801 printf("Unable to open %s: %s\n", cdir
, fxp_error());
811 char *sftp_wildcard_get_filename(SftpWildcardMatcher
*swcm
)
813 struct fxp_name
*name
;
814 struct sftp_packet
*pktin
;
815 struct sftp_request
*req
;
818 if (swcm
->names
&& swcm
->namepos
>= swcm
->names
->nnames
) {
819 fxp_free_names(swcm
->names
);
824 req
= fxp_readdir_send(swcm
->dirh
);
825 pktin
= sftp_wait_for_reply(req
);
826 swcm
->names
= fxp_readdir_recv(pktin
, req
);
829 if (fxp_error_type() != SSH_FX_EOF
)
830 printf("%s: reading directory: %s\n", swcm
->prefix
,
833 } else if (swcm
->names
->nnames
== 0) {
835 * Another failure mode which we treat as EOF is if
836 * the server reports success from FXP_READDIR but
837 * returns no actual names. This is unusual, since
838 * from most servers you'd expect at least "." and
839 * "..", but there's nothing forbidding a server from
840 * omitting those if it wants to.
848 assert(swcm
->names
&& swcm
->namepos
< swcm
->names
->nnames
);
850 name
= &swcm
->names
->names
[swcm
->namepos
++];
852 if (!strcmp(name
->filename
, ".") || !strcmp(name
->filename
, ".."))
853 continue; /* expected bad filenames */
855 if (!vet_filename(name
->filename
)) {
856 printf("ignoring potentially dangerous server-"
857 "supplied filename '%s'\n", name
->filename
);
858 continue; /* unexpected bad filename */
861 if (!wc_match(swcm
->wildcard
, name
->filename
))
862 continue; /* doesn't match the wildcard */
865 * We have a working filename. Return it.
867 return dupprintf("%s%s%s", swcm
->prefix
,
869 swcm
->prefix
[strlen(swcm
->prefix
)-1]=='/' ?
875 void sftp_finish_wildcard_matching(SftpWildcardMatcher
*swcm
)
877 struct sftp_packet
*pktin
;
878 struct sftp_request
*req
;
880 req
= fxp_close_send(swcm
->dirh
);
881 pktin
= sftp_wait_for_reply(req
);
882 fxp_close_recv(pktin
, req
);
885 fxp_free_names(swcm
->names
);
888 sfree(swcm
->wildcard
);
894 * General function to match a potential wildcard in a filename
895 * argument and iterate over every matching file. Used in several
896 * PSFTP commands (rmdir, rm, chmod, mv).
898 int wildcard_iterate(char *filename
, int (*func
)(void *, char *), void *ctx
)
900 char *unwcfname
, *newname
, *cname
;
903 unwcfname
= snewn(strlen(filename
)+1, char);
904 is_wc
= !wc_unescape(unwcfname
, filename
);
907 SftpWildcardMatcher
*swcm
= sftp_begin_wildcard_matching(filename
);
916 while ( (newname
= sftp_wildcard_get_filename(swcm
)) != NULL
) {
917 cname
= canonify(newname
);
919 printf("%s: canonify: %s\n", newname
, fxp_error());
923 ret
&= func(ctx
, cname
);
928 /* Politely warn the user that nothing matched. */
929 printf("%s: nothing matched\n", filename
);
932 sftp_finish_wildcard_matching(swcm
);
934 cname
= canonify(unwcfname
);
936 printf("%s: canonify: %s\n", filename
, fxp_error());
939 ret
= func(ctx
, cname
);
948 * Handy helper function.
950 int is_wildcard(char *name
)
952 char *unwcfname
= snewn(strlen(name
)+1, char);
953 int is_wc
= !wc_unescape(unwcfname
, name
);
958 /* ----------------------------------------------------------------------
959 * Actual sftp commands.
961 struct sftp_command
{
963 int nwords
, wordssize
;
964 int (*obey
) (struct sftp_command
*); /* returns <0 to quit */
967 int sftp_cmd_null(struct sftp_command
*cmd
)
969 return 1; /* success */
972 int sftp_cmd_unknown(struct sftp_command
*cmd
)
974 printf("psftp: unknown command \"%s\"\n", cmd
->words
[0]);
975 return 0; /* failure */
978 int sftp_cmd_quit(struct sftp_command
*cmd
)
983 int sftp_cmd_close(struct sftp_command
*cmd
)
990 if (back
!= NULL
&& back
->connected(backhandle
)) {
992 back
->special(backhandle
, TS_EOF
);
994 sftp_recvdata(&ch
, 1);
1002 * List a directory. If no arguments are given, list pwd; otherwise
1003 * list the directory given in words[1].
1005 int sftp_cmd_ls(struct sftp_command
*cmd
)
1007 struct fxp_handle
*dirh
;
1008 struct fxp_names
*names
;
1009 struct fxp_name
**ournames
;
1010 int nnames
, namesize
;
1011 char *dir
, *cdir
, *unwcdir
, *wildcard
;
1012 struct sftp_packet
*pktin
;
1013 struct sftp_request
*req
;
1021 if (cmd
->nwords
< 2)
1024 dir
= cmd
->words
[1];
1026 unwcdir
= snewn(1 + strlen(dir
), char);
1027 if (wc_unescape(unwcdir
, dir
)) {
1034 wildcard
= stripslashes(dir
, 0);
1035 unwcdir
= dupstr(dir
);
1036 len
= wildcard
- dir
;
1037 unwcdir
[len
] = '\0';
1038 if (len
> 0 && unwcdir
[len
-1] == '/')
1039 unwcdir
[len
-1] = '\0';
1040 tmpdir
= snewn(1 + len
, char);
1041 check
= wc_unescape(tmpdir
, unwcdir
);
1044 printf("Multiple-level wildcards are not supported\n");
1051 cdir
= canonify(dir
);
1053 printf("%s: canonify: %s\n", dir
, fxp_error());
1058 printf("Listing directory %s\n", cdir
);
1060 req
= fxp_opendir_send(cdir
);
1061 pktin
= sftp_wait_for_reply(req
);
1062 dirh
= fxp_opendir_recv(pktin
, req
);
1065 printf("Unable to open %s: %s\n", dir
, fxp_error());
1067 nnames
= namesize
= 0;
1072 req
= fxp_readdir_send(dirh
);
1073 pktin
= sftp_wait_for_reply(req
);
1074 names
= fxp_readdir_recv(pktin
, req
);
1076 if (names
== NULL
) {
1077 if (fxp_error_type() == SSH_FX_EOF
)
1079 printf("Reading directory %s: %s\n", dir
, fxp_error());
1082 if (names
->nnames
== 0) {
1083 fxp_free_names(names
);
1087 if (nnames
+ names
->nnames
>= namesize
) {
1088 namesize
+= names
->nnames
+ 128;
1089 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
1092 for (i
= 0; i
< names
->nnames
; i
++)
1093 if (!wildcard
|| wc_match(wildcard
, names
->names
[i
].filename
))
1094 ournames
[nnames
++] = fxp_dup_name(&names
->names
[i
]);
1096 fxp_free_names(names
);
1098 req
= fxp_close_send(dirh
);
1099 pktin
= sftp_wait_for_reply(req
);
1100 fxp_close_recv(pktin
, req
);
1103 * Now we have our filenames. Sort them by actual file
1104 * name, and then output the longname parts.
1106 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
1111 for (i
= 0; i
< nnames
; i
++) {
1112 printf("%s\n", ournames
[i
]->longname
);
1113 fxp_free_name(ournames
[i
]);
1125 * Change directories. We do this by canonifying the new name, then
1126 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1128 int sftp_cmd_cd(struct sftp_command
*cmd
)
1130 struct fxp_handle
*dirh
;
1131 struct sftp_packet
*pktin
;
1132 struct sftp_request
*req
;
1140 if (cmd
->nwords
< 2)
1141 dir
= dupstr(homedir
);
1143 dir
= canonify(cmd
->words
[1]);
1146 printf("%s: canonify: %s\n", dir
, fxp_error());
1150 req
= fxp_opendir_send(dir
);
1151 pktin
= sftp_wait_for_reply(req
);
1152 dirh
= fxp_opendir_recv(pktin
, req
);
1155 printf("Directory %s: %s\n", dir
, fxp_error());
1160 req
= fxp_close_send(dirh
);
1161 pktin
= sftp_wait_for_reply(req
);
1162 fxp_close_recv(pktin
, req
);
1166 printf("Remote directory is now %s\n", pwd
);
1172 * Print current directory. Easy as pie.
1174 int sftp_cmd_pwd(struct sftp_command
*cmd
)
1181 printf("Remote directory is %s\n", pwd
);
1186 * Get a file and save it at the local end. We have three very
1187 * similar commands here. The basic one is `get'; `reget' differs
1188 * in that it checks for the existence of the destination file and
1189 * starts from where a previous aborted transfer left off; `mget'
1190 * differs in that it interprets all its arguments as files to
1191 * transfer (never as a different local name for a remote file) and
1192 * can handle wildcards.
1194 int sftp_general_get(struct sftp_command
*cmd
, int restart
, int multiple
)
1196 char *fname
, *unwcfname
, *origfname
, *origwfname
, *outfname
;
1198 int recurse
= FALSE
;
1206 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1207 if (!strcmp(cmd
->words
[i
], "--")) {
1208 /* finish processing options */
1211 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1214 printf("%s: unrecognised option '%s'\n", cmd
->words
[0], cmd
->words
[i
]);
1220 if (i
>= cmd
->nwords
) {
1221 printf("%s: expects a filename\n", cmd
->words
[0]);
1227 SftpWildcardMatcher
*swcm
;
1229 origfname
= cmd
->words
[i
++];
1230 unwcfname
= snewn(strlen(origfname
)+1, char);
1232 if (multiple
&& !wc_unescape(unwcfname
, origfname
)) {
1233 swcm
= sftp_begin_wildcard_matching(origfname
);
1238 origwfname
= sftp_wildcard_get_filename(swcm
);
1240 /* Politely warn the user that nothing matched. */
1241 printf("%s: nothing matched\n", origfname
);
1242 sftp_finish_wildcard_matching(swcm
);
1247 origwfname
= origfname
;
1251 while (origwfname
) {
1252 fname
= canonify(origwfname
);
1255 printf("%s: canonify: %s\n", origwfname
, fxp_error());
1260 if (!multiple
&& i
< cmd
->nwords
)
1261 outfname
= cmd
->words
[i
++];
1263 outfname
= stripslashes(origwfname
, 0);
1265 ret
= sftp_get_file(fname
, outfname
, recurse
, restart
);
1271 origwfname
= sftp_wildcard_get_filename(swcm
);
1278 sftp_finish_wildcard_matching(swcm
);
1282 } while (multiple
&& i
< cmd
->nwords
);
1286 int sftp_cmd_get(struct sftp_command
*cmd
)
1288 return sftp_general_get(cmd
, 0, 0);
1290 int sftp_cmd_mget(struct sftp_command
*cmd
)
1292 return sftp_general_get(cmd
, 0, 1);
1294 int sftp_cmd_reget(struct sftp_command
*cmd
)
1296 return sftp_general_get(cmd
, 1, 0);
1300 * Send a file and store it at the remote end. We have three very
1301 * similar commands here. The basic one is `put'; `reput' differs
1302 * in that it checks for the existence of the destination file and
1303 * starts from where a previous aborted transfer left off; `mput'
1304 * differs in that it interprets all its arguments as files to
1305 * transfer (never as a different remote name for a local file) and
1306 * can handle wildcards.
1308 int sftp_general_put(struct sftp_command
*cmd
, int restart
, int multiple
)
1310 char *fname
, *wfname
, *origoutfname
, *outfname
;
1312 int recurse
= FALSE
;
1320 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1321 if (!strcmp(cmd
->words
[i
], "--")) {
1322 /* finish processing options */
1325 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1328 printf("%s: unrecognised option '%s'\n", cmd
->words
[0], cmd
->words
[i
]);
1334 if (i
>= cmd
->nwords
) {
1335 printf("%s: expects a filename\n", cmd
->words
[0]);
1341 WildcardMatcher
*wcm
;
1342 fname
= cmd
->words
[i
++];
1344 if (multiple
&& test_wildcard(fname
, FALSE
) == WCTYPE_WILDCARD
) {
1345 wcm
= begin_wildcard_matching(fname
);
1346 wfname
= wildcard_get_filename(wcm
);
1348 /* Politely warn the user that nothing matched. */
1349 printf("%s: nothing matched\n", fname
);
1350 finish_wildcard_matching(wcm
);
1359 if (!multiple
&& i
< cmd
->nwords
)
1360 origoutfname
= cmd
->words
[i
++];
1362 origoutfname
= stripslashes(wfname
, 1);
1364 outfname
= canonify(origoutfname
);
1366 printf("%s: canonify: %s\n", origoutfname
, fxp_error());
1369 finish_wildcard_matching(wcm
);
1373 ret
= sftp_put_file(wfname
, outfname
, recurse
, restart
);
1378 wfname
= wildcard_get_filename(wcm
);
1385 finish_wildcard_matching(wcm
);
1390 } while (multiple
&& i
< cmd
->nwords
);
1394 int sftp_cmd_put(struct sftp_command
*cmd
)
1396 return sftp_general_put(cmd
, 0, 0);
1398 int sftp_cmd_mput(struct sftp_command
*cmd
)
1400 return sftp_general_put(cmd
, 0, 1);
1402 int sftp_cmd_reput(struct sftp_command
*cmd
)
1404 return sftp_general_put(cmd
, 1, 0);
1407 int sftp_cmd_mkdir(struct sftp_command
*cmd
)
1410 struct sftp_packet
*pktin
;
1411 struct sftp_request
*req
;
1420 if (cmd
->nwords
< 2) {
1421 printf("mkdir: expects a directory\n");
1426 for (i
= 1; i
< cmd
->nwords
; i
++) {
1427 dir
= canonify(cmd
->words
[i
]);
1429 printf("%s: canonify: %s\n", dir
, fxp_error());
1433 req
= fxp_mkdir_send(dir
);
1434 pktin
= sftp_wait_for_reply(req
);
1435 result
= fxp_mkdir_recv(pktin
, req
);
1438 printf("mkdir %s: %s\n", dir
, fxp_error());
1441 printf("mkdir %s: OK\n", dir
);
1449 static int sftp_action_rmdir(void *vctx
, char *dir
)
1451 struct sftp_packet
*pktin
;
1452 struct sftp_request
*req
;
1455 req
= fxp_rmdir_send(dir
);
1456 pktin
= sftp_wait_for_reply(req
);
1457 result
= fxp_rmdir_recv(pktin
, req
);
1460 printf("rmdir %s: %s\n", dir
, fxp_error());
1464 printf("rmdir %s: OK\n", dir
);
1469 int sftp_cmd_rmdir(struct sftp_command
*cmd
)
1478 if (cmd
->nwords
< 2) {
1479 printf("rmdir: expects a directory\n");
1484 for (i
= 1; i
< cmd
->nwords
; i
++)
1485 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_rmdir
, NULL
);
1490 static int sftp_action_rm(void *vctx
, char *fname
)
1492 struct sftp_packet
*pktin
;
1493 struct sftp_request
*req
;
1496 req
= fxp_remove_send(fname
);
1497 pktin
= sftp_wait_for_reply(req
);
1498 result
= fxp_remove_recv(pktin
, req
);
1501 printf("rm %s: %s\n", fname
, fxp_error());
1505 printf("rm %s: OK\n", fname
);
1510 int sftp_cmd_rm(struct sftp_command
*cmd
)
1519 if (cmd
->nwords
< 2) {
1520 printf("rm: expects a filename\n");
1525 for (i
= 1; i
< cmd
->nwords
; i
++)
1526 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_rm
, NULL
);
1531 static int check_is_dir(char *dstfname
)
1533 struct sftp_packet
*pktin
;
1534 struct sftp_request
*req
;
1535 struct fxp_attrs attrs
;
1538 req
= fxp_stat_send(dstfname
);
1539 pktin
= sftp_wait_for_reply(req
);
1540 result
= fxp_stat_recv(pktin
, req
, &attrs
);
1543 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
1544 (attrs
.permissions
& 0040000))
1550 struct sftp_context_mv
{
1555 static int sftp_action_mv(void *vctx
, char *srcfname
)
1557 struct sftp_context_mv
*ctx
= (struct sftp_context_mv
*)vctx
;
1558 struct sftp_packet
*pktin
;
1559 struct sftp_request
*req
;
1561 char *finalfname
, *newcanon
= NULL
;
1564 if (ctx
->dest_is_dir
) {
1568 p
= srcfname
+ strlen(srcfname
);
1569 while (p
> srcfname
&& p
[-1] != '/') p
--;
1570 newname
= dupcat(ctx
->dstfname
, "/", p
, NULL
);
1571 newcanon
= canonify(newname
);
1573 printf("%s: canonify: %s\n", newname
, fxp_error());
1579 finalfname
= newcanon
;
1581 finalfname
= ctx
->dstfname
;
1584 req
= fxp_rename_send(srcfname
, finalfname
);
1585 pktin
= sftp_wait_for_reply(req
);
1586 result
= fxp_rename_recv(pktin
, req
);
1588 error
= result ? NULL
: fxp_error();
1591 printf("mv %s %s: %s\n", srcfname
, finalfname
, error
);
1594 printf("%s -> %s\n", srcfname
, finalfname
);
1602 int sftp_cmd_mv(struct sftp_command
*cmd
)
1604 struct sftp_context_mv actx
, *ctx
= &actx
;
1612 if (cmd
->nwords
< 3) {
1613 printf("mv: expects two filenames\n");
1617 ctx
->dstfname
= canonify(cmd
->words
[cmd
->nwords
-1]);
1618 if (!ctx
->dstfname
) {
1619 printf("%s: canonify: %s\n", ctx
->dstfname
, fxp_error());
1624 * If there's more than one source argument, or one source
1625 * argument which is a wildcard, we _require_ that the
1626 * destination is a directory.
1628 ctx
->dest_is_dir
= check_is_dir(ctx
->dstfname
);
1629 if ((cmd
->nwords
> 3 || is_wildcard(cmd
->words
[1])) && !ctx
->dest_is_dir
) {
1630 printf("mv: multiple or wildcard arguments require the destination"
1631 " to be a directory\n");
1632 sfree(ctx
->dstfname
);
1637 * Now iterate over the source arguments.
1640 for (i
= 1; i
< cmd
->nwords
-1; i
++)
1641 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_mv
, ctx
);
1643 sfree(ctx
->dstfname
);
1647 struct sftp_context_chmod
{
1648 unsigned attrs_clr
, attrs_xor
;
1651 static int sftp_action_chmod(void *vctx
, char *fname
)
1653 struct fxp_attrs attrs
;
1654 struct sftp_packet
*pktin
;
1655 struct sftp_request
*req
;
1657 unsigned oldperms
, newperms
;
1658 struct sftp_context_chmod
*ctx
= (struct sftp_context_chmod
*)vctx
;
1660 req
= fxp_stat_send(fname
);
1661 pktin
= sftp_wait_for_reply(req
);
1662 result
= fxp_stat_recv(pktin
, req
, &attrs
);
1664 if (!result
|| !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
)) {
1665 printf("get attrs for %s: %s\n", fname
,
1666 result ?
"file permissions not provided" : fxp_error());
1670 attrs
.flags
= SSH_FILEXFER_ATTR_PERMISSIONS
; /* perms _only_ */
1671 oldperms
= attrs
.permissions
& 07777;
1672 attrs
.permissions
&= ~ctx
->attrs_clr
;
1673 attrs
.permissions
^= ctx
->attrs_xor
;
1674 newperms
= attrs
.permissions
& 07777;
1676 if (oldperms
== newperms
)
1677 return 1; /* no need to do anything! */
1679 req
= fxp_setstat_send(fname
, attrs
);
1680 pktin
= sftp_wait_for_reply(req
);
1681 result
= fxp_setstat_recv(pktin
, req
);
1684 printf("set attrs for %s: %s\n", fname
, fxp_error());
1688 printf("%s: %04o -> %04o\n", fname
, oldperms
, newperms
);
1693 int sftp_cmd_chmod(struct sftp_command
*cmd
)
1697 struct sftp_context_chmod actx
, *ctx
= &actx
;
1704 if (cmd
->nwords
< 3) {
1705 printf("chmod: expects a mode specifier and a filename\n");
1710 * Attempt to parse the mode specifier in cmd->words[1]. We
1711 * don't support the full horror of Unix chmod; instead we
1712 * support a much simpler syntax in which the user can either
1713 * specify an octal number, or a comma-separated sequence of
1714 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1715 * _only_ be omitted if the only attribute mentioned is t,
1716 * since all others require a user/group/other specification.
1717 * Additionally, the s attribute may not be specified for any
1718 * [ugoa] specifications other than exactly u or exactly g.
1720 ctx
->attrs_clr
= ctx
->attrs_xor
= 0;
1721 mode
= cmd
->words
[1];
1722 if (mode
[0] >= '0' && mode
[0] <= '9') {
1723 if (mode
[strspn(mode
, "01234567")]) {
1724 printf("chmod: numeric file modes should"
1725 " contain digits 0-7 only\n");
1728 ctx
->attrs_clr
= 07777;
1729 sscanf(mode
, "%o", &ctx
->attrs_xor
);
1730 ctx
->attrs_xor
&= ctx
->attrs_clr
;
1733 char *modebegin
= mode
;
1734 unsigned subset
, perms
;
1738 while (*mode
&& *mode
!= ',' &&
1739 *mode
!= '+' && *mode
!= '-' && *mode
!= '=') {
1741 case 'u': subset
|= 04700; break; /* setuid, user perms */
1742 case 'g': subset
|= 02070; break; /* setgid, group perms */
1743 case 'o': subset
|= 00007; break; /* just other perms */
1744 case 'a': subset
|= 06777; break; /* all of the above */
1746 printf("chmod: file mode '%.*s' contains unrecognised"
1747 " user/group/other specifier '%c'\n",
1748 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1753 if (!*mode
|| *mode
== ',') {
1754 printf("chmod: file mode '%.*s' is incomplete\n",
1755 (int)strcspn(modebegin
, ","), modebegin
);
1759 if (!*mode
|| *mode
== ',') {
1760 printf("chmod: file mode '%.*s' is incomplete\n",
1761 (int)strcspn(modebegin
, ","), modebegin
);
1765 while (*mode
&& *mode
!= ',') {
1767 case 'r': perms
|= 00444; break;
1768 case 'w': perms
|= 00222; break;
1769 case 'x': perms
|= 00111; break;
1770 case 't': perms
|= 01000; subset
|= 01000; break;
1772 if ((subset
& 06777) != 04700 &&
1773 (subset
& 06777) != 02070) {
1774 printf("chmod: file mode '%.*s': set[ug]id bit should"
1775 " be used with exactly one of u or g only\n",
1776 (int)strcspn(modebegin
, ","), modebegin
);
1782 printf("chmod: file mode '%.*s' contains unrecognised"
1783 " permission specifier '%c'\n",
1784 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1789 if (!(subset
& 06777) && (perms
&~ subset
)) {
1790 printf("chmod: file mode '%.*s' contains no user/group/other"
1791 " specifier and permissions other than 't' \n",
1792 (int)strcspn(modebegin
, ","), modebegin
);
1798 ctx
->attrs_clr
|= perms
;
1799 ctx
->attrs_xor
|= perms
;
1802 ctx
->attrs_clr
|= perms
;
1803 ctx
->attrs_xor
&= ~perms
;
1806 ctx
->attrs_clr
|= subset
;
1807 ctx
->attrs_xor
|= perms
;
1810 if (*mode
) mode
++; /* eat comma */
1815 for (i
= 2; i
< cmd
->nwords
; i
++)
1816 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_chmod
, ctx
);
1821 static int sftp_cmd_open(struct sftp_command
*cmd
)
1826 printf("psftp: already connected\n");
1830 if (cmd
->nwords
< 2) {
1831 printf("open: expects a host name\n");
1835 if (cmd
->nwords
> 2) {
1836 portnumber
= atoi(cmd
->words
[2]);
1837 if (portnumber
== 0) {
1838 printf("open: invalid port number\n");
1844 if (psftp_connect(cmd
->words
[1], NULL
, portnumber
)) {
1845 back
= NULL
; /* connection is already closed */
1846 return -1; /* this is fatal */
1852 static int sftp_cmd_lcd(struct sftp_command
*cmd
)
1854 char *currdir
, *errmsg
;
1856 if (cmd
->nwords
< 2) {
1857 printf("lcd: expects a local directory name\n");
1861 errmsg
= psftp_lcd(cmd
->words
[1]);
1863 printf("lcd: unable to change directory: %s\n", errmsg
);
1868 currdir
= psftp_getcwd();
1869 printf("New local directory is %s\n", currdir
);
1875 static int sftp_cmd_lpwd(struct sftp_command
*cmd
)
1879 currdir
= psftp_getcwd();
1880 printf("Current local directory is %s\n", currdir
);
1886 static int sftp_cmd_pling(struct sftp_command
*cmd
)
1890 exitcode
= system(cmd
->words
[1]);
1891 return (exitcode
== 0);
1894 static int sftp_cmd_help(struct sftp_command
*cmd
);
1896 static struct sftp_cmd_lookup
{
1899 * For help purposes, there are two kinds of command:
1901 * - primary commands, in which `longhelp' is non-NULL. In
1902 * this case `shorthelp' is descriptive text, and `longhelp'
1903 * is longer descriptive text intended to be printed after
1906 * - alias commands, in which `longhelp' is NULL. In this case
1907 * `shorthelp' is the name of a primary command, which
1908 * contains the help that should double up for this command.
1910 int listed
; /* do we list this in primary help? */
1913 int (*obey
) (struct sftp_command
*);
1916 * List of sftp commands. This is binary-searched so it MUST be
1920 "!", TRUE
, "run a local command",
1922 /* FIXME: this example is crap for non-Windows. */
1923 " Runs a local command. For example, \"!del myfile\".\n",
1927 "bye", TRUE
, "finish your SFTP session",
1929 " Terminates your SFTP session and quits the PSFTP program.\n",
1933 "cd", TRUE
, "change your remote working directory",
1934 " [ <new working directory> ]\n"
1935 " Change the remote working directory for your SFTP session.\n"
1936 " If a new working directory is not supplied, you will be\n"
1937 " returned to your home directory.\n",
1941 "chmod", TRUE
, "change file permissions and modes",
1942 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1943 " Change the file permissions on one or more remote files or\n"
1945 " <modes> can be any octal Unix permission specifier.\n"
1946 " Alternatively, <modes> can include the following modifiers:\n"
1947 " u+r make file readable by owning user\n"
1948 " u+w make file writable by owning user\n"
1949 " u+x make file executable by owning user\n"
1950 " u-r make file not readable by owning user\n"
1951 " [also u-w, u-x]\n"
1952 " g+r make file readable by members of owning group\n"
1953 " [also g+w, g+x, g-r, g-w, g-x]\n"
1954 " o+r make file readable by all other users\n"
1955 " [also o+w, o+x, o-r, o-w, o-x]\n"
1956 " a+r make file readable by absolutely everybody\n"
1957 " [also a+w, a+x, a-r, a-w, a-x]\n"
1958 " u+s enable the Unix set-user-ID bit\n"
1959 " u-s disable the Unix set-user-ID bit\n"
1960 " g+s enable the Unix set-group-ID bit\n"
1961 " g-s disable the Unix set-group-ID bit\n"
1962 " +t enable the Unix \"sticky bit\"\n"
1963 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1964 " more than one user for the same modifier (\"ug+w\"). You can\n"
1965 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1969 "close", TRUE
, "finish your SFTP session but do not quit PSFTP",
1971 " Terminates your SFTP session, but does not quit the PSFTP\n"
1972 " program. You can then use \"open\" to start another SFTP\n"
1973 " session, to the same server or to a different one.\n",
1977 "del", TRUE
, "delete files on the remote server",
1978 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1979 " Delete a file or files from the server.\n",
1983 "delete", FALSE
, "del", NULL
, sftp_cmd_rm
1986 "dir", TRUE
, "list remote files",
1987 " [ <directory-name> ]/[ <wildcard> ]\n"
1988 " List the contents of a specified directory on the server.\n"
1989 " If <directory-name> is not given, the current working directory\n"
1991 " If <wildcard> is given, it is treated as a set of files to\n"
1992 " list; otherwise, all files are listed.\n",
1996 "exit", TRUE
, "bye", NULL
, sftp_cmd_quit
1999 "get", TRUE
, "download a file from the server to your local machine",
2000 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2001 " Downloads a file on the server and stores it locally under\n"
2002 " the same name, or under a different one if you supply the\n"
2003 " argument <local-filename>.\n"
2004 " If -r specified, recursively fetch a directory.\n",
2008 "help", TRUE
, "give help",
2009 " [ <command> [ <command> ... ] ]\n"
2010 " Give general help if no commands are specified.\n"
2011 " If one or more commands are specified, give specific help on\n"
2012 " those particular commands.\n",
2016 "lcd", TRUE
, "change local working directory",
2017 " <local-directory-name>\n"
2018 " Change the local working directory of the PSFTP program (the\n"
2019 " default location where the \"get\" command will save files).\n",
2023 "lpwd", TRUE
, "print local working directory",
2025 " Print the local working directory of the PSFTP program (the\n"
2026 " default location where the \"get\" command will save files).\n",
2030 "ls", TRUE
, "dir", NULL
,
2034 "mget", TRUE
, "download multiple files at once",
2035 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2036 " Downloads many files from the server, storing each one under\n"
2037 " the same name it has on the server side. You can use wildcards\n"
2038 " such as \"*.c\" to specify lots of files at once.\n"
2039 " If -r specified, recursively fetch files and directories.\n",
2043 "mkdir", TRUE
, "create directories on the remote server",
2044 " <directory-name> [ <directory-name>... ]\n"
2045 " Creates directories with the given names on the server.\n",
2049 "mput", TRUE
, "upload multiple files at once",
2050 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2051 " Uploads many files to the server, storing each one under the\n"
2052 " same name it has on the client side. You can use wildcards\n"
2053 " such as \"*.c\" to specify lots of files at once.\n"
2054 " If -r specified, recursively store files and directories.\n",
2058 "mv", TRUE
, "move or rename file(s) on the remote server",
2059 " <source> [ <source>... ] <destination>\n"
2060 " Moves or renames <source>(s) on the server to <destination>,\n"
2061 " also on the server.\n"
2062 " If <destination> specifies an existing directory, then <source>\n"
2063 " may be a wildcard, and multiple <source>s may be given; all\n"
2064 " source files are moved into <destination>.\n"
2065 " Otherwise, <source> must specify a single file, which is moved\n"
2066 " or renamed so that it is accessible under the name <destination>.\n",
2070 "open", TRUE
, "connect to a host",
2071 " [<user>@]<hostname> [<port>]\n"
2072 " Establishes an SFTP connection to a given host. Only usable\n"
2073 " when you are not already connected to a server.\n",
2077 "put", TRUE
, "upload a file from your local machine to the server",
2078 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2079 " Uploads a file to the server and stores it there under\n"
2080 " the same name, or under a different one if you supply the\n"
2081 " argument <remote-filename>.\n"
2082 " If -r specified, recursively store a directory.\n",
2086 "pwd", TRUE
, "print your remote working directory",
2088 " Print the current remote working directory for your SFTP session.\n",
2092 "quit", TRUE
, "bye", NULL
,
2096 "reget", TRUE
, "continue downloading files",
2097 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2098 " Works exactly like the \"get\" command, but the local file\n"
2099 " must already exist. The download will begin at the end of the\n"
2100 " file. This is for resuming a download that was interrupted.\n"
2101 " If -r specified, resume interrupted \"get -r\".\n",
2105 "ren", TRUE
, "mv", NULL
,
2109 "rename", FALSE
, "mv", NULL
,
2113 "reput", TRUE
, "continue uploading files",
2114 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2115 " Works exactly like the \"put\" command, but the remote file\n"
2116 " must already exist. The upload will begin at the end of the\n"
2117 " file. This is for resuming an upload that was interrupted.\n"
2118 " If -r specified, resume interrupted \"put -r\".\n",
2122 "rm", TRUE
, "del", NULL
,
2126 "rmdir", TRUE
, "remove directories on the remote server",
2127 " <directory-name> [ <directory-name>... ]\n"
2128 " Removes the directory with the given name on the server.\n"
2129 " The directory will not be removed unless it is empty.\n"
2130 " Wildcards may be used to specify multiple directories.\n",
2135 const struct sftp_cmd_lookup
*lookup_command(char *name
)
2140 j
= sizeof(sftp_lookup
) / sizeof(*sftp_lookup
);
2143 cmp
= strcmp(name
, sftp_lookup
[k
].name
);
2149 return &sftp_lookup
[k
];
2155 static int sftp_cmd_help(struct sftp_command
*cmd
)
2158 if (cmd
->nwords
== 1) {
2160 * Give short help on each command.
2164 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
2166 if (!sftp_lookup
[i
].listed
)
2168 len
= strlen(sftp_lookup
[i
].name
);
2172 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
2173 const struct sftp_cmd_lookup
*lookup
;
2174 if (!sftp_lookup
[i
].listed
)
2176 lookup
= &sftp_lookup
[i
];
2177 printf("%-*s", maxlen
+2, lookup
->name
);
2178 if (lookup
->longhelp
== NULL
)
2179 lookup
= lookup_command(lookup
->shorthelp
);
2180 printf("%s\n", lookup
->shorthelp
);
2184 * Give long help on specific commands.
2186 for (i
= 1; i
< cmd
->nwords
; i
++) {
2187 const struct sftp_cmd_lookup
*lookup
;
2188 lookup
= lookup_command(cmd
->words
[i
]);
2190 printf("help: %s: command not found\n", cmd
->words
[i
]);
2192 printf("%s", lookup
->name
);
2193 if (lookup
->longhelp
== NULL
)
2194 lookup
= lookup_command(lookup
->shorthelp
);
2195 printf("%s", lookup
->longhelp
);
2202 /* ----------------------------------------------------------------------
2203 * Command line reading and parsing.
2205 struct sftp_command
*sftp_getcmd(FILE *fp
, int mode
, int modeflags
)
2208 struct sftp_command
*cmd
;
2212 cmd
= snew(struct sftp_command
);
2222 line
= fgetline(fp
);
2224 line
= ssh_sftp_get_cmdline("psftp> ", back
== NULL
);
2227 if (!line
|| !*line
) {
2228 cmd
->obey
= sftp_cmd_quit
;
2229 if ((mode
== 0) || (modeflags
& 1))
2231 return cmd
; /* eof */
2234 line
[strcspn(line
, "\r\n")] = '\0';
2236 if (modeflags
& 1) {
2237 printf("%s\n", line
);
2241 while (*p
&& (*p
== ' ' || *p
== '\t'))
2246 * Special case: the ! command. This is always parsed as
2247 * exactly two words: one containing the !, and the second
2248 * containing everything else on the line.
2250 cmd
->nwords
= cmd
->wordssize
= 2;
2251 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
2252 cmd
->words
[0] = dupstr("!");
2253 cmd
->words
[1] = dupstr(p
+1);
2254 } else if (*p
== '#') {
2256 * Special case: comment. Entire line is ignored.
2258 cmd
->nwords
= cmd
->wordssize
= 0;
2262 * Parse the command line into words. The syntax is:
2263 * - double quotes are removed, but cause spaces within to be
2264 * treated as non-separating.
2265 * - a double-doublequote pair is a literal double quote, inside
2266 * _or_ outside quotes. Like this:
2268 * firstword "second word" "this has ""quotes"" in" and""this""
2274 * >this has "quotes" in<
2278 /* skip whitespace */
2279 while (*p
&& (*p
== ' ' || *p
== '\t'))
2281 /* terminate loop */
2284 /* mark start of word */
2285 q
= r
= p
; /* q sits at start, r writes word */
2288 if (!quoting
&& (*p
== ' ' || *p
== '\t'))
2289 break; /* reached end of word */
2290 else if (*p
== '"' && p
[1] == '"')
2291 p
+= 2, *r
++ = '"'; /* a literal quote */
2293 p
++, quoting
= !quoting
;
2298 p
++; /* skip over the whitespace */
2300 if (cmd
->nwords
>= cmd
->wordssize
) {
2301 cmd
->wordssize
= cmd
->nwords
+ 16;
2302 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
2304 cmd
->words
[cmd
->nwords
++] = dupstr(q
);
2311 * Now parse the first word and assign a function.
2314 if (cmd
->nwords
== 0)
2315 cmd
->obey
= sftp_cmd_null
;
2317 const struct sftp_cmd_lookup
*lookup
;
2318 lookup
= lookup_command(cmd
->words
[0]);
2320 cmd
->obey
= sftp_cmd_unknown
;
2322 cmd
->obey
= lookup
->obey
;
2328 static int do_sftp_init(void)
2330 struct sftp_packet
*pktin
;
2331 struct sftp_request
*req
;
2334 * Do protocol initialisation.
2338 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2339 return 1; /* failure */
2343 * Find out where our home directory is.
2345 req
= fxp_realpath_send(".");
2346 pktin
= sftp_wait_for_reply(req
);
2347 homedir
= fxp_realpath_recv(pktin
, req
);
2351 "Warning: failed to resolve home directory: %s\n",
2353 homedir
= dupstr(".");
2355 printf("Remote working directory is %s\n", homedir
);
2357 pwd
= dupstr(homedir
);
2361 void do_sftp_cleanup()
2365 back
->special(backhandle
, TS_EOF
);
2367 sftp_recvdata(&ch
, 1);
2368 back
->free(backhandle
);
2369 sftp_cleanup_request();
2383 void do_sftp(int mode
, int modeflags
, char *batchfile
)
2393 /* ------------------------------------------------------------------
2394 * Now we're ready to do Real Stuff.
2397 struct sftp_command
*cmd
;
2398 cmd
= sftp_getcmd(NULL
, 0, 0);
2401 ret
= cmd
->obey(cmd
);
2404 for(i
= 0; i
< cmd
->nwords
; i
++)
2405 sfree(cmd
->words
[i
]);
2413 fp
= fopen(batchfile
, "r");
2415 printf("Fatal: unable to open %s\n", batchfile
);
2419 struct sftp_command
*cmd
;
2420 cmd
= sftp_getcmd(fp
, mode
, modeflags
);
2423 ret
= cmd
->obey(cmd
);
2427 if (!(modeflags
& 2))
2436 /* ----------------------------------------------------------------------
2437 * Dirty bits: integration with PuTTY.
2440 static int verbose
= 0;
2443 * Print an error message and perform a fatal exit.
2445 void fatalbox(char *fmt
, ...)
2450 str
= dupvprintf(fmt
, ap
);
2451 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2454 fputs(str2
, stderr
);
2459 void modalfatalbox(char *fmt
, ...)
2464 str
= dupvprintf(fmt
, ap
);
2465 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2468 fputs(str2
, stderr
);
2473 void connection_fatal(void *frontend
, char *fmt
, ...)
2478 str
= dupvprintf(fmt
, ap
);
2479 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2482 fputs(str2
, stderr
);
2488 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
)
2491 * This is only here because of the calls to ldisc_send(NULL,
2492 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2493 * ldisc as an ldisc. So if we get called with any real data, I
2494 * want to know about it.
2500 * In psftp, all agent requests should be synchronous, so this is a
2501 * never-called stub.
2503 void agent_schedule_callback(void (*callback
)(void *, void *, int),
2504 void *callback_ctx
, void *data
, int len
)
2506 assert(!"We shouldn't be here");
2510 * Receive a block of data from the SSH link. Block until all data
2513 * To do this, we repeatedly call the SSH protocol module, with our
2514 * own trap in from_backend() to catch the data that comes back. We
2515 * do this until we have enough data.
2518 static unsigned char *outptr
; /* where to put the data */
2519 static unsigned outlen
; /* how much data required */
2520 static unsigned char *pending
= NULL
; /* any spare data */
2521 static unsigned pendlen
= 0, pendsize
= 0; /* length and phys. size of buffer */
2522 int from_backend(void *frontend
, int is_stderr
, const char *data
, int datalen
)
2524 unsigned char *p
= (unsigned char *) data
;
2525 unsigned len
= (unsigned) datalen
;
2528 * stderr data is just spouted to local stderr and otherwise
2533 if (fwrite(data
, 1, len
, stderr
) < len
)
2539 * If this is before the real session begins, just return.
2544 if ((outlen
> 0) && (len
> 0)) {
2545 unsigned used
= outlen
;
2548 memcpy(outptr
, p
, used
);
2556 if (pendsize
< pendlen
+ len
) {
2557 pendsize
= pendlen
+ len
+ 4096;
2558 pending
= sresize(pending
, pendsize
, unsigned char);
2560 memcpy(pending
+ pendlen
, p
, len
);
2566 int from_backend_untrusted(void *frontend_handle
, const char *data
, int len
)
2569 * No "untrusted" output should get here (the way the code is
2570 * currently, it's all diverted by FLAG_STDERR).
2572 assert(!"Unexpected call to from_backend_untrusted()");
2573 return 0; /* not reached */
2575 int from_backend_eof(void *frontend
)
2578 * We expect to be the party deciding when to close the
2579 * connection, so if we see EOF before we sent it ourselves, we
2583 connection_fatal(frontend
,
2584 "Received unexpected end-of-file from SFTP server");
2588 int sftp_recvdata(char *buf
, int len
)
2590 outptr
= (unsigned char *) buf
;
2594 * See if the pending-input block contains some of what we
2598 unsigned pendused
= pendlen
;
2599 if (pendused
> outlen
)
2601 memcpy(outptr
, pending
, pendused
);
2602 memmove(pending
, pending
+ pendused
, pendlen
- pendused
);
2605 pendlen
-= pendused
;
2615 while (outlen
> 0) {
2616 if (back
->exitcode(backhandle
) >= 0 || ssh_sftp_loop_iteration() < 0)
2617 return 0; /* doom */
2622 int sftp_senddata(char *buf
, int len
)
2624 back
->send(backhandle
, buf
, len
);
2629 * Short description of parameters.
2631 static void usage(void)
2633 printf("PuTTY Secure File Transfer (SFTP) client\n");
2634 printf("%s\n", ver
);
2635 printf("Usage: psftp [options] [user@]host\n");
2636 printf("Options:\n");
2637 printf(" -V print version information and exit\n");
2638 printf(" -pgpfp print PGP key fingerprints and exit\n");
2639 printf(" -b file use specified batchfile\n");
2640 printf(" -bc output batchfile commands\n");
2641 printf(" -be don't stop batchfile processing if errors\n");
2642 printf(" -v show verbose messages\n");
2643 printf(" -load sessname Load settings from saved session\n");
2644 printf(" -l user connect with specified username\n");
2645 printf(" -P port connect to specified port\n");
2646 printf(" -pw passw login with specified password\n");
2647 printf(" -1 -2 force use of particular SSH protocol version\n");
2648 printf(" -4 -6 force use of IPv4 or IPv6\n");
2649 printf(" -C enable compression\n");
2650 printf(" -i key private key file for authentication\n");
2651 printf(" -noagent disable use of Pageant\n");
2652 printf(" -agent enable use of Pageant\n");
2653 printf(" -batch disable all interactive prompts\n");
2657 static void version(void)
2659 printf("psftp: %s\n", ver
);
2664 * Connect to a host.
2666 static int psftp_connect(char *userhost
, char *user
, int portnumber
)
2668 char *host
, *realhost
;
2672 /* Separate host and username */
2674 host
= strrchr(host
, '@');
2680 printf("psftp: multiple usernames specified; using \"%s\"\n",
2687 * If we haven't loaded session details already (e.g., from -load),
2688 * try looking for a session called "host".
2690 if (!loaded_session
) {
2691 /* Try to load settings for `host' into a temporary config */
2692 Conf
*conf2
= conf_new();
2693 conf_set_str(conf2
, CONF_host
, "");
2694 do_defaults(host
, conf2
);
2695 if (conf_get_str(conf2
, CONF_host
)[0] != '\0') {
2696 /* Settings present and include hostname */
2697 /* Re-load data into the real config. */
2698 do_defaults(host
, conf
);
2700 /* Session doesn't exist or mention a hostname. */
2701 /* Use `host' as a bare hostname. */
2702 conf_set_str(conf
, CONF_host
, host
);
2705 /* Patch in hostname `host' to session details. */
2706 conf_set_str(conf
, CONF_host
, host
);
2710 * Force use of SSH. (If they got the protocol wrong we assume the
2711 * port is useless too.)
2713 if (conf_get_int(conf
, CONF_protocol
) != PROT_SSH
) {
2714 conf_set_int(conf
, CONF_protocol
, PROT_SSH
);
2715 conf_set_int(conf
, CONF_port
, 22);
2719 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2720 * then change it to SSH-2, on the grounds that that's more likely to
2721 * work for SFTP. (Can be overridden with `-1' option.)
2722 * But if it says `2 only' or `2', respect which.
2724 if ((conf_get_int(conf
, CONF_sshprot
) & ~1) != 2) /* is it 2 or 3? */
2725 conf_set_int(conf
, CONF_sshprot
, 2);
2728 * Enact command-line overrides.
2730 cmdline_run_saved(conf
);
2733 * Muck about with the hostname in various ways.
2736 char *hostbuf
= dupstr(conf_get_str(conf
, CONF_host
));
2737 char *host
= hostbuf
;
2741 * Trim leading whitespace.
2743 host
+= strspn(host
, " \t");
2746 * See if host is of the form user@host, and separate out
2747 * the username if so.
2749 if (host
[0] != '\0') {
2750 char *atsign
= strrchr(host
, '@');
2753 conf_set_str(conf
, CONF_username
, host
);
2759 * Remove any remaining whitespace.
2764 if (*q
!= ' ' && *q
!= '\t')
2770 conf_set_str(conf
, CONF_host
, hostbuf
);
2775 if (user
!= NULL
&& user
[0] != '\0') {
2776 conf_set_str(conf
, CONF_username
, user
);
2780 conf_set_int(conf
, CONF_port
, portnumber
);
2783 * Disable scary things which shouldn't be enabled for simple
2784 * things like SCP and SFTP: agent forwarding, port forwarding,
2787 conf_set_int(conf
, CONF_x11_forward
, 0);
2788 conf_set_int(conf
, CONF_agentfwd
, 0);
2789 conf_set_int(conf
, CONF_ssh_simple
, TRUE
);
2792 while ((key
= conf_get_str_nthstrkey(conf
, CONF_portfwd
, 0)) != NULL
)
2793 conf_del_str_str(conf
, CONF_portfwd
, key
);
2796 /* Set up subsystem name. */
2797 conf_set_str(conf
, CONF_remote_cmd
, "sftp");
2798 conf_set_int(conf
, CONF_ssh_subsys
, TRUE
);
2799 conf_set_int(conf
, CONF_nopty
, TRUE
);
2802 * Set up fallback option, for SSH-1 servers or servers with the
2803 * sftp subsystem not enabled but the server binary installed
2804 * in the usual place. We only support fallback on Unix
2805 * systems, and we use a kludgy piece of shellery which should
2806 * try to find sftp-server in various places (the obvious
2807 * systemwide spots /usr/lib and /usr/local/lib, and then the
2808 * user's PATH) and finally give up.
2810 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2811 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2814 * the idea being that this will attempt to use either of the
2815 * obvious pathnames and then give up, and when it does give up
2816 * it will print the preferred pathname in the error messages.
2818 conf_set_str(conf
, CONF_remote_cmd2
,
2819 "test -x /usr/lib/sftp-server &&"
2820 " exec /usr/lib/sftp-server\n"
2821 "test -x /usr/local/lib/sftp-server &&"
2822 " exec /usr/local/lib/sftp-server\n"
2823 "exec sftp-server");
2824 conf_set_int(conf
, CONF_ssh_subsys2
, FALSE
);
2826 back
= &ssh_backend
;
2828 err
= back
->init(NULL
, &backhandle
, conf
,
2829 conf_get_str(conf
, CONF_host
),
2830 conf_get_int(conf
, CONF_port
),
2832 conf_get_int(conf
, CONF_tcp_keepalives
));
2834 fprintf(stderr
, "ssh_init: %s\n", err
);
2837 logctx
= log_init(NULL
, conf
);
2838 back
->provide_logctx(backhandle
, logctx
);
2839 console_provide_logctx(logctx
);
2840 while (!back
->sendok(backhandle
)) {
2841 if (back
->exitcode(backhandle
) >= 0)
2843 if (ssh_sftp_loop_iteration() < 0) {
2844 fprintf(stderr
, "ssh_init: error during SSH connection setup\n");
2848 if (verbose
&& realhost
!= NULL
)
2849 printf("Connected to %s\n", realhost
);
2850 if (realhost
!= NULL
)
2855 void cmdline_error(char *p
, ...)
2858 fprintf(stderr
, "psftp: ");
2860 vfprintf(stderr
, p
, ap
);
2862 fprintf(stderr
, "\n try typing \"psftp -h\" for help\n");
2867 * Main program. Parse arguments etc.
2869 int psftp_main(int argc
, char *argv
[])
2873 char *userhost
, *user
;
2876 char *batchfile
= NULL
;
2878 flags
= FLAG_STDERR
| FLAG_INTERACTIVE
2879 #ifdef FLAG_SYNCAGENT
2883 cmdline_tooltype
= TOOLTYPE_FILETRANSFER
;
2886 userhost
= user
= NULL
;
2888 /* Load Default Settings before doing anything else. */
2890 do_defaults(NULL
, conf
);
2891 loaded_session
= FALSE
;
2893 for (i
= 1; i
< argc
; i
++) {
2895 if (argv
[i
][0] != '-') {
2899 userhost
= dupstr(argv
[i
]);
2902 ret
= cmdline_process_param(argv
[i
], i
+1<argc?argv
[i
+1]:NULL
, 1, conf
);
2904 cmdline_error("option \"%s\" requires an argument", argv
[i
]);
2905 } else if (ret
== 2) {
2906 i
++; /* skip next argument */
2907 } else if (ret
== 1) {
2908 /* We have our own verbosity in addition to `flags'. */
2909 if (flags
& FLAG_VERBOSE
)
2911 } else if (strcmp(argv
[i
], "-h") == 0 ||
2912 strcmp(argv
[i
], "-?") == 0 ||
2913 strcmp(argv
[i
], "--help") == 0) {
2915 } else if (strcmp(argv
[i
], "-pgpfp") == 0) {
2918 } else if (strcmp(argv
[i
], "-V") == 0 ||
2919 strcmp(argv
[i
], "--version") == 0) {
2921 } else if (strcmp(argv
[i
], "-batch") == 0) {
2922 console_batch_mode
= 1;
2923 } else if (strcmp(argv
[i
], "-b") == 0 && i
+ 1 < argc
) {
2925 batchfile
= argv
[++i
];
2926 } else if (strcmp(argv
[i
], "-bc") == 0) {
2927 modeflags
= modeflags
| 1;
2928 } else if (strcmp(argv
[i
], "-be") == 0) {
2929 modeflags
= modeflags
| 2;
2930 } else if (strcmp(argv
[i
], "--") == 0) {
2934 cmdline_error("unknown option \"%s\"", argv
[i
]);
2942 * If the loaded session provides a hostname, and a hostname has not
2943 * otherwise been specified, pop it in `userhost' so that
2944 * `psftp -load sessname' is sufficient to start a session.
2946 if (!userhost
&& conf_get_str(conf
, CONF_host
)[0] != '\0') {
2947 userhost
= dupstr(conf_get_str(conf
, CONF_host
));
2951 * If a user@host string has already been provided, connect to
2956 ret
= psftp_connect(userhost
, user
, portnumber
);
2963 printf("psftp: no hostname specified; use \"open host.name\""
2967 do_sftp(mode
, modeflags
, batchfile
);
2969 if (back
!= NULL
&& back
->connected(backhandle
)) {
2971 back
->special(backhandle
, TS_EOF
);
2973 sftp_recvdata(&ch
, 1);
2978 console_provide_logctx(NULL
);