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
;
41 /* ----------------------------------------------------------------------
42 * Higher-level helper functions used in commands.
46 * Attempt to canonify a pathname starting from the pwd. If
47 * canonification fails, at least fall back to returning a _valid_
48 * pathname (though it may be ugly, eg /home/simon/../foobar).
50 char *canonify(char *name
)
52 char *fullname
, *canonname
;
53 struct sftp_packet
*pktin
;
54 struct sftp_request
*req
, *rreq
;
57 fullname
= dupstr(name
);
60 if (pwd
[strlen(pwd
) - 1] == '/')
64 fullname
= dupcat(pwd
, slash
, name
, NULL
);
67 sftp_register(req
= fxp_realpath_send(fullname
));
68 rreq
= sftp_find_request(pktin
= sftp_recv());
70 canonname
= fxp_realpath_recv(pktin
, rreq
);
77 * Attempt number 2. Some FXP_REALPATH implementations
78 * (glibc-based ones, in particular) require the _whole_
79 * path to point to something that exists, whereas others
80 * (BSD-based) only require all but the last component to
81 * exist. So if the first call failed, we should strip off
82 * everything from the last slash onwards and try again,
83 * then put the final component back on.
87 * - if the last component is "/." or "/..", then we don't
88 * bother trying this because there's no way it can work.
90 * - if the thing actually ends with a "/", we remove it
91 * before we start. Except if the string is "/" itself
92 * (although I can't see why we'd have got here if so,
93 * because surely "/" would have worked the first
94 * time?), in which case we don't bother.
96 * - if there's no slash in the string at all, give up in
97 * confusion (we expect at least one because of the way
98 * we constructed the string).
104 i
= strlen(fullname
);
105 if (i
> 2 && fullname
[i
- 1] == '/')
106 fullname
[--i
] = '\0'; /* strip trailing / unless at pos 0 */
107 while (i
> 0 && fullname
[--i
] != '/');
110 * Give up on special cases.
112 if (fullname
[i
] != '/' || /* no slash at all */
113 !strcmp(fullname
+ i
, "/.") || /* ends in /. */
114 !strcmp(fullname
+ i
, "/..") || /* ends in /.. */
115 !strcmp(fullname
, "/")) {
120 * Now i points at the slash. Deal with the final special
121 * case i==0 (ie the whole path was "/nonexistentfile").
123 fullname
[i
] = '\0'; /* separate the string */
125 sftp_register(req
= fxp_realpath_send("/"));
127 sftp_register(req
= fxp_realpath_send(fullname
));
129 rreq
= sftp_find_request(pktin
= sftp_recv());
131 canonname
= fxp_realpath_recv(pktin
, rreq
);
134 /* Even that failed. Restore our best guess at the
135 * constructed filename and give up */
136 fullname
[i
] = '/'; /* restore slash and last component */
141 * We have a canonical name for all but the last path
142 * component. Concatenate the last component and return.
144 returnname
= dupcat(canonname
,
145 canonname
[strlen(canonname
) - 1] ==
146 '/' ?
"" : "/", fullname
+ i
+ 1, NULL
);
154 * Return a pointer to the portion of str that comes after the last
155 * slash (or backslash or colon, if `local' is TRUE).
157 static char *stripslashes(char *str
, int local
)
162 p
= strchr(str
, ':');
166 p
= strrchr(str
, '/');
170 p
= strrchr(str
, '\\');
178 * qsort comparison routine for fxp_name structures. Sorts by real
181 static int sftp_name_compare(const void *av
, const void *bv
)
183 const struct fxp_name
*const *a
= (const struct fxp_name
*const *) av
;
184 const struct fxp_name
*const *b
= (const struct fxp_name
*const *) bv
;
185 return strcmp((*a
)->filename
, (*b
)->filename
);
189 * Likewise, but for a bare char *.
191 static int bare_name_compare(const void *av
, const void *bv
)
193 const char **a
= (const char **) av
;
194 const char **b
= (const char **) bv
;
195 return strcmp(*a
, *b
);
198 static void not_connected(void)
200 printf("psftp: not connected to a host; use \"open host.name\"\n");
203 /* ----------------------------------------------------------------------
204 * The meat of the `get' and `put' commands.
206 int sftp_get_file(char *fname
, char *outfname
, int recurse
, int restart
)
208 struct fxp_handle
*fh
;
209 struct sftp_packet
*pktin
;
210 struct sftp_request
*req
, *rreq
;
211 struct fxp_xfer
*xfer
;
214 int ret
, shown_err
= FALSE
;
215 struct fxp_attrs attrs
;
218 * In recursive mode, see if we're dealing with a directory.
219 * (If we're not in recursive mode, we need not even check: the
220 * subsequent FXP_OPEN will return a usable error message.)
225 sftp_register(req
= fxp_stat_send(fname
));
226 rreq
= sftp_find_request(pktin
= sftp_recv());
228 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
231 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
232 (attrs
.permissions
& 0040000)) {
234 struct fxp_handle
*dirhandle
;
235 int nnames
, namesize
;
236 struct fxp_name
**ournames
;
237 struct fxp_names
*names
;
241 * First, attempt to create the destination directory,
242 * unless it already exists.
244 if (file_type(outfname
) != FILE_TYPE_DIRECTORY
&&
245 !create_directory(outfname
)) {
246 printf("%s: Cannot create directory\n", outfname
);
251 * Now get the list of filenames in the remote
254 sftp_register(req
= fxp_opendir_send(fname
));
255 rreq
= sftp_find_request(pktin
= sftp_recv());
257 dirhandle
= fxp_opendir_recv(pktin
, rreq
);
260 printf("%s: unable to open directory: %s\n",
264 nnames
= namesize
= 0;
269 sftp_register(req
= fxp_readdir_send(dirhandle
));
270 rreq
= sftp_find_request(pktin
= sftp_recv());
272 names
= fxp_readdir_recv(pktin
, rreq
);
275 if (fxp_error_type() == SSH_FX_EOF
)
277 printf("%s: reading directory: %s\n", fname
, fxp_error());
281 if (names
->nnames
== 0) {
282 fxp_free_names(names
);
285 if (nnames
+ names
->nnames
>= namesize
) {
286 namesize
+= names
->nnames
+ 128;
287 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
289 for (i
= 0; i
< names
->nnames
; i
++)
290 if (strcmp(names
->names
[i
].filename
, ".") &&
291 strcmp(names
->names
[i
].filename
, "..")) {
292 if (!vet_filename(names
->names
[i
].filename
)) {
293 printf("ignoring potentially dangerous server-"
294 "supplied filename '%s'\n",
295 names
->names
[i
].filename
);
298 fxp_dup_name(&names
->names
[i
]);
301 fxp_free_names(names
);
303 sftp_register(req
= fxp_close_send(dirhandle
));
304 rreq
= sftp_find_request(pktin
= sftp_recv());
306 fxp_close_recv(pktin
, rreq
);
309 * Sort the names into a clear order. This ought to
310 * make things more predictable when we're doing a
311 * reget of the same directory, just in case two
312 * readdirs on the same remote directory return a
315 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
318 * If we're in restart mode, find the last filename on
319 * this list that already exists. We may have to do a
320 * reget on _that_ file, but shouldn't have to do
321 * anything on the previous files.
323 * If none of them exists, of course, we start at 0.
331 nextoutfname
= dir_file_cat(outfname
,
332 ournames
[i
]->filename
);
334 nextoutfname
= dupstr(ournames
[i
]->filename
);
335 ret
= (file_type(nextoutfname
) == FILE_TYPE_NONEXISTENT
);
346 * Now we're ready to recurse. Starting at ournames[i]
347 * and continuing on to the end of the list, we
348 * construct a new source and target file name, and
349 * call sftp_get_file again.
351 for (; i
< nnames
; i
++) {
352 char *nextfname
, *nextoutfname
;
355 nextfname
= dupcat(fname
, "/", ournames
[i
]->filename
, NULL
);
357 nextoutfname
= dir_file_cat(outfname
,
358 ournames
[i
]->filename
);
360 nextoutfname
= dupstr(ournames
[i
]->filename
);
361 ret
= sftp_get_file(nextfname
, nextoutfname
, recurse
, restart
);
362 restart
= FALSE
; /* after first partial file, do full */
366 for (i
= 0; i
< nnames
; i
++) {
367 fxp_free_name(ournames
[i
]);
375 * Done this recursion level. Free everything.
377 for (i
= 0; i
< nnames
; i
++) {
378 fxp_free_name(ournames
[i
]);
386 sftp_register(req
= fxp_stat_send(fname
));
387 rreq
= sftp_find_request(pktin
= sftp_recv());
389 if (!fxp_stat_recv(pktin
, rreq
, &attrs
))
392 sftp_register(req
= fxp_open_send(fname
, SSH_FXF_READ
, NULL
));
393 rreq
= sftp_find_request(pktin
= sftp_recv());
395 fh
= fxp_open_recv(pktin
, rreq
);
398 printf("%s: open for read: %s\n", fname
, fxp_error());
403 file
= open_existing_wfile(outfname
, NULL
);
405 file
= open_new_file(outfname
, GET_PERMISSIONS(attrs
));
409 printf("local: unable to open %s\n", outfname
);
411 sftp_register(req
= fxp_close_send(fh
));
412 rreq
= sftp_find_request(pktin
= sftp_recv());
414 fxp_close_recv(pktin
, rreq
);
421 if (seek_file(file
, uint64_make(0,0) , FROM_END
) == -1) {
423 printf("reget: cannot restart %s - file too large\n",
425 sftp_register(req
= fxp_close_send(fh
));
426 rreq
= sftp_find_request(pktin
= sftp_recv());
428 fxp_close_recv(pktin
, rreq
);
433 offset
= get_file_posn(file
);
434 uint64_decimal(offset
, decbuf
);
435 printf("reget: restarting at file position %s\n", decbuf
);
437 offset
= uint64_make(0, 0);
440 printf("remote:%s => local:%s\n", fname
, outfname
);
443 * FIXME: we can use FXP_FSTAT here to get the file size, and
444 * thus put up a progress bar.
447 xfer
= xfer_download_init(fh
, offset
);
448 while (!xfer_done(xfer
)) {
453 xfer_download_queue(xfer
);
455 ret
= xfer_download_gotpkt(xfer
, pktin
);
459 printf("error while reading: %s\n", fxp_error());
465 while (xfer_download_data(xfer
, &vbuf
, &len
)) {
466 unsigned char *buf
= (unsigned char *)vbuf
;
470 wlen
= write_to_file(file
, buf
+ wpos
, len
- wpos
);
472 printf("error while writing local file\n");
474 xfer_set_error(xfer
);
479 if (wpos
< len
) { /* we had an error */
481 xfer_set_error(xfer
);
492 sftp_register(req
= fxp_close_send(fh
));
493 rreq
= sftp_find_request(pktin
= sftp_recv());
495 fxp_close_recv(pktin
, rreq
);
500 int sftp_put_file(char *fname
, char *outfname
, int recurse
, int restart
)
502 struct fxp_handle
*fh
;
503 struct fxp_xfer
*xfer
;
504 struct sftp_packet
*pktin
;
505 struct sftp_request
*req
, *rreq
;
509 struct fxp_attrs attrs
;
513 * In recursive mode, see if we're dealing with a directory.
514 * (If we're not in recursive mode, we need not even check: the
515 * subsequent fopen will return an error message.)
517 if (recurse
&& file_type(fname
) == FILE_TYPE_DIRECTORY
) {
519 int nnames
, namesize
;
520 char *name
, **ournames
;
525 * First, attempt to create the destination directory,
526 * unless it already exists.
528 sftp_register(req
= fxp_stat_send(outfname
));
529 rreq
= sftp_find_request(pktin
= sftp_recv());
531 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
533 !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) ||
534 !(attrs
.permissions
& 0040000)) {
535 sftp_register(req
= fxp_mkdir_send(outfname
));
536 rreq
= sftp_find_request(pktin
= sftp_recv());
538 result
= fxp_mkdir_recv(pktin
, rreq
);
541 printf("%s: create directory: %s\n",
542 outfname
, fxp_error());
548 * Now get the list of filenames in the local directory.
550 nnames
= namesize
= 0;
553 dh
= open_directory(fname
);
555 printf("%s: unable to open directory\n", fname
);
558 while ((name
= read_filename(dh
)) != NULL
) {
559 if (nnames
>= namesize
) {
561 ournames
= sresize(ournames
, namesize
, char *);
563 ournames
[nnames
++] = name
;
568 * Sort the names into a clear order. This ought to make
569 * things more predictable when we're doing a reput of the
570 * same directory, just in case two readdirs on the same
571 * local directory return a different order.
573 qsort(ournames
, nnames
, sizeof(*ournames
), bare_name_compare
);
576 * If we're in restart mode, find the last filename on this
577 * list that already exists. We may have to do a reput on
578 * _that_ file, but shouldn't have to do anything on the
581 * If none of them exists, of course, we start at 0.
587 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
588 sftp_register(req
= fxp_stat_send(nextoutfname
));
589 rreq
= sftp_find_request(pktin
= sftp_recv());
591 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
602 * Now we're ready to recurse. Starting at ournames[i]
603 * and continuing on to the end of the list, we
604 * construct a new source and target file name, and
605 * call sftp_put_file again.
607 for (; i
< nnames
; i
++) {
608 char *nextfname
, *nextoutfname
;
612 nextfname
= dir_file_cat(fname
, ournames
[i
]);
614 nextfname
= dupstr(ournames
[i
]);
615 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
616 ret
= sftp_put_file(nextfname
, nextoutfname
, recurse
, restart
);
617 restart
= FALSE
; /* after first partial file, do full */
621 for (i
= 0; i
< nnames
; i
++) {
630 * Done this recursion level. Free everything.
632 for (i
= 0; i
< nnames
; i
++) {
640 file
= open_existing_file(fname
, NULL
, NULL
, NULL
, &permissions
);
642 printf("local: unable to open %s\n", fname
);
646 PUT_PERMISSIONS(attrs
, permissions
);
648 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
, &attrs
));
650 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
|
651 SSH_FXF_CREAT
| SSH_FXF_TRUNC
,
654 rreq
= sftp_find_request(pktin
= sftp_recv());
656 fh
= fxp_open_recv(pktin
, rreq
);
660 printf("%s: open for write: %s\n", outfname
, fxp_error());
666 struct fxp_attrs attrs
;
669 sftp_register(req
= fxp_fstat_send(fh
));
670 rreq
= sftp_find_request(pktin
= sftp_recv());
672 ret
= fxp_fstat_recv(pktin
, rreq
, &attrs
);
676 printf("read size of %s: %s\n", outfname
, fxp_error());
679 if (!(attrs
.flags
& SSH_FILEXFER_ATTR_SIZE
)) {
681 printf("read size of %s: size was not given\n", outfname
);
685 uint64_decimal(offset
, decbuf
);
686 printf("reput: restarting at file position %s\n", decbuf
);
688 if (seek_file((WFile
*)file
, offset
, FROM_START
) != 0)
689 seek_file((WFile
*)file
, uint64_make(0,0), FROM_END
); /* *shrug* */
691 offset
= uint64_make(0, 0);
694 printf("local:%s => remote:%s\n", fname
, outfname
);
697 * FIXME: we can use FXP_FSTAT here to get the file size, and
698 * thus put up a progress bar.
701 xfer
= xfer_upload_init(fh
, offset
);
703 while ((!err
&& !eof
) || !xfer_done(xfer
)) {
707 while (xfer_upload_ready(xfer
) && !err
&& !eof
) {
708 len
= read_from_file(file
, buffer
, sizeof(buffer
));
710 printf("error while reading local file\n");
712 } else if (len
== 0) {
715 xfer_upload_data(xfer
, buffer
, len
);
719 if (!xfer_done(xfer
)) {
721 ret
= xfer_upload_gotpkt(xfer
, pktin
);
722 if (ret
<= 0 && !err
) {
723 printf("error while writing: %s\n", fxp_error());
731 sftp_register(req
= fxp_close_send(fh
));
732 rreq
= sftp_find_request(pktin
= sftp_recv());
734 fxp_close_recv(pktin
, rreq
);
741 /* ----------------------------------------------------------------------
742 * A remote wildcard matcher, providing a similar interface to the
743 * local one in psftp.h.
746 typedef struct SftpWildcardMatcher
{
747 struct fxp_handle
*dirh
;
748 struct fxp_names
*names
;
750 char *wildcard
, *prefix
;
751 } SftpWildcardMatcher
;
753 SftpWildcardMatcher
*sftp_begin_wildcard_matching(char *name
)
755 struct sftp_packet
*pktin
;
756 struct sftp_request
*req
, *rreq
;
758 char *unwcdir
, *tmpdir
, *cdir
;
760 SftpWildcardMatcher
*swcm
;
761 struct fxp_handle
*dirh
;
764 * We don't handle multi-level wildcards; so we expect to find
765 * a fully specified directory part, followed by a wildcard
768 wildcard
= stripslashes(name
, 0);
770 unwcdir
= dupstr(name
);
771 len
= wildcard
- name
;
773 if (len
> 0 && unwcdir
[len
-1] == '/')
774 unwcdir
[len
-1] = '\0';
775 tmpdir
= snewn(1 + len
, char);
776 check
= wc_unescape(tmpdir
, unwcdir
);
780 printf("Multiple-level wildcards are not supported\n");
785 cdir
= canonify(unwcdir
);
787 sftp_register(req
= fxp_opendir_send(cdir
));
788 rreq
= sftp_find_request(pktin
= sftp_recv());
790 dirh
= fxp_opendir_recv(pktin
, rreq
);
793 swcm
= snew(SftpWildcardMatcher
);
796 swcm
->wildcard
= dupstr(wildcard
);
797 swcm
->prefix
= unwcdir
;
799 printf("Unable to open %s: %s\n", cdir
, fxp_error());
809 char *sftp_wildcard_get_filename(SftpWildcardMatcher
*swcm
)
811 struct fxp_name
*name
;
812 struct sftp_packet
*pktin
;
813 struct sftp_request
*req
, *rreq
;
816 if (swcm
->names
&& swcm
->namepos
>= swcm
->names
->nnames
) {
817 fxp_free_names(swcm
->names
);
822 sftp_register(req
= fxp_readdir_send(swcm
->dirh
));
823 rreq
= sftp_find_request(pktin
= sftp_recv());
825 swcm
->names
= fxp_readdir_recv(pktin
, rreq
);
828 if (fxp_error_type() != SSH_FX_EOF
)
829 printf("%s: reading directory: %s\n", swcm
->prefix
,
837 assert(swcm
->names
&& swcm
->namepos
< swcm
->names
->nnames
);
839 name
= &swcm
->names
->names
[swcm
->namepos
++];
841 if (!strcmp(name
->filename
, ".") || !strcmp(name
->filename
, ".."))
842 continue; /* expected bad filenames */
844 if (!vet_filename(name
->filename
)) {
845 printf("ignoring potentially dangerous server-"
846 "supplied filename '%s'\n", name
->filename
);
847 continue; /* unexpected bad filename */
850 if (!wc_match(swcm
->wildcard
, name
->filename
))
851 continue; /* doesn't match the wildcard */
854 * We have a working filename. Return it.
856 return dupprintf("%s%s%s", swcm
->prefix
,
858 swcm
->prefix
[strlen(swcm
->prefix
)-1]=='/' ?
864 void sftp_finish_wildcard_matching(SftpWildcardMatcher
*swcm
)
866 struct sftp_packet
*pktin
;
867 struct sftp_request
*req
, *rreq
;
869 sftp_register(req
= fxp_close_send(swcm
->dirh
));
870 rreq
= sftp_find_request(pktin
= sftp_recv());
872 fxp_close_recv(pktin
, rreq
);
875 fxp_free_names(swcm
->names
);
878 sfree(swcm
->wildcard
);
884 * General function to match a potential wildcard in a filename
885 * argument and iterate over every matching file. Used in several
886 * PSFTP commands (rmdir, rm, chmod, mv).
888 int wildcard_iterate(char *filename
, int (*func
)(void *, char *), void *ctx
)
890 char *unwcfname
, *newname
, *cname
;
893 unwcfname
= snewn(strlen(filename
)+1, char);
894 is_wc
= !wc_unescape(unwcfname
, filename
);
897 SftpWildcardMatcher
*swcm
= sftp_begin_wildcard_matching(filename
);
906 while ( (newname
= sftp_wildcard_get_filename(swcm
)) != NULL
) {
907 cname
= canonify(newname
);
909 printf("%s: canonify: %s\n", newname
, fxp_error());
913 ret
&= func(ctx
, cname
);
918 /* Politely warn the user that nothing matched. */
919 printf("%s: nothing matched\n", filename
);
922 sftp_finish_wildcard_matching(swcm
);
924 cname
= canonify(unwcfname
);
926 printf("%s: canonify: %s\n", filename
, fxp_error());
929 ret
= func(ctx
, cname
);
938 * Handy helper function.
940 int is_wildcard(char *name
)
942 char *unwcfname
= snewn(strlen(name
)+1, char);
943 int is_wc
= !wc_unescape(unwcfname
, name
);
948 /* ----------------------------------------------------------------------
949 * Actual sftp commands.
951 struct sftp_command
{
953 int nwords
, wordssize
;
954 int (*obey
) (struct sftp_command
*); /* returns <0 to quit */
957 int sftp_cmd_null(struct sftp_command
*cmd
)
959 return 1; /* success */
962 int sftp_cmd_unknown(struct sftp_command
*cmd
)
964 printf("psftp: unknown command \"%s\"\n", cmd
->words
[0]);
965 return 0; /* failure */
968 int sftp_cmd_quit(struct sftp_command
*cmd
)
973 int sftp_cmd_close(struct sftp_command
*cmd
)
980 if (back
!= NULL
&& back
->connected(backhandle
)) {
982 back
->special(backhandle
, TS_EOF
);
983 sftp_recvdata(&ch
, 1);
991 * List a directory. If no arguments are given, list pwd; otherwise
992 * list the directory given in words[1].
994 int sftp_cmd_ls(struct sftp_command
*cmd
)
996 struct fxp_handle
*dirh
;
997 struct fxp_names
*names
;
998 struct fxp_name
**ournames
;
999 int nnames
, namesize
;
1000 char *dir
, *cdir
, *unwcdir
, *wildcard
;
1001 struct sftp_packet
*pktin
;
1002 struct sftp_request
*req
, *rreq
;
1010 if (cmd
->nwords
< 2)
1013 dir
= cmd
->words
[1];
1015 unwcdir
= snewn(1 + strlen(dir
), char);
1016 if (wc_unescape(unwcdir
, dir
)) {
1023 wildcard
= stripslashes(dir
, 0);
1024 unwcdir
= dupstr(dir
);
1025 len
= wildcard
- dir
;
1026 unwcdir
[len
] = '\0';
1027 if (len
> 0 && unwcdir
[len
-1] == '/')
1028 unwcdir
[len
-1] = '\0';
1029 tmpdir
= snewn(1 + len
, char);
1030 check
= wc_unescape(tmpdir
, unwcdir
);
1033 printf("Multiple-level wildcards are not supported\n");
1040 cdir
= canonify(dir
);
1042 printf("%s: canonify: %s\n", dir
, fxp_error());
1047 printf("Listing directory %s\n", cdir
);
1049 sftp_register(req
= fxp_opendir_send(cdir
));
1050 rreq
= sftp_find_request(pktin
= sftp_recv());
1051 assert(rreq
== req
);
1052 dirh
= fxp_opendir_recv(pktin
, rreq
);
1055 printf("Unable to open %s: %s\n", dir
, fxp_error());
1057 nnames
= namesize
= 0;
1062 sftp_register(req
= fxp_readdir_send(dirh
));
1063 rreq
= sftp_find_request(pktin
= sftp_recv());
1064 assert(rreq
== req
);
1065 names
= fxp_readdir_recv(pktin
, rreq
);
1067 if (names
== NULL
) {
1068 if (fxp_error_type() == SSH_FX_EOF
)
1070 printf("Reading directory %s: %s\n", dir
, fxp_error());
1073 if (names
->nnames
== 0) {
1074 fxp_free_names(names
);
1078 if (nnames
+ names
->nnames
>= namesize
) {
1079 namesize
+= names
->nnames
+ 128;
1080 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
1083 for (i
= 0; i
< names
->nnames
; i
++)
1084 if (!wildcard
|| wc_match(wildcard
, names
->names
[i
].filename
))
1085 ournames
[nnames
++] = fxp_dup_name(&names
->names
[i
]);
1087 fxp_free_names(names
);
1089 sftp_register(req
= fxp_close_send(dirh
));
1090 rreq
= sftp_find_request(pktin
= sftp_recv());
1091 assert(rreq
== req
);
1092 fxp_close_recv(pktin
, rreq
);
1095 * Now we have our filenames. Sort them by actual file
1096 * name, and then output the longname parts.
1098 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
1103 for (i
= 0; i
< nnames
; i
++) {
1104 printf("%s\n", ournames
[i
]->longname
);
1105 fxp_free_name(ournames
[i
]);
1117 * Change directories. We do this by canonifying the new name, then
1118 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1120 int sftp_cmd_cd(struct sftp_command
*cmd
)
1122 struct fxp_handle
*dirh
;
1123 struct sftp_packet
*pktin
;
1124 struct sftp_request
*req
, *rreq
;
1132 if (cmd
->nwords
< 2)
1133 dir
= dupstr(homedir
);
1135 dir
= canonify(cmd
->words
[1]);
1138 printf("%s: canonify: %s\n", dir
, fxp_error());
1142 sftp_register(req
= fxp_opendir_send(dir
));
1143 rreq
= sftp_find_request(pktin
= sftp_recv());
1144 assert(rreq
== req
);
1145 dirh
= fxp_opendir_recv(pktin
, rreq
);
1148 printf("Directory %s: %s\n", dir
, fxp_error());
1153 sftp_register(req
= fxp_close_send(dirh
));
1154 rreq
= sftp_find_request(pktin
= sftp_recv());
1155 assert(rreq
== req
);
1156 fxp_close_recv(pktin
, rreq
);
1160 printf("Remote directory is now %s\n", pwd
);
1166 * Print current directory. Easy as pie.
1168 int sftp_cmd_pwd(struct sftp_command
*cmd
)
1175 printf("Remote directory is %s\n", pwd
);
1180 * Get a file and save it at the local end. We have three very
1181 * similar commands here. The basic one is `get'; `reget' differs
1182 * in that it checks for the existence of the destination file and
1183 * starts from where a previous aborted transfer left off; `mget'
1184 * differs in that it interprets all its arguments as files to
1185 * transfer (never as a different local name for a remote file) and
1186 * can handle wildcards.
1188 int sftp_general_get(struct sftp_command
*cmd
, int restart
, int multiple
)
1190 char *fname
, *unwcfname
, *origfname
, *origwfname
, *outfname
;
1192 int recurse
= FALSE
;
1200 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1201 if (!strcmp(cmd
->words
[i
], "--")) {
1202 /* finish processing options */
1205 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1208 printf("%s: unrecognised option '%s'\n", cmd
->words
[0], cmd
->words
[i
]);
1214 if (i
>= cmd
->nwords
) {
1215 printf("%s: expects a filename\n", cmd
->words
[0]);
1221 SftpWildcardMatcher
*swcm
;
1223 origfname
= cmd
->words
[i
++];
1224 unwcfname
= snewn(strlen(origfname
)+1, char);
1226 if (multiple
&& !wc_unescape(unwcfname
, origfname
)) {
1227 swcm
= sftp_begin_wildcard_matching(origfname
);
1232 origwfname
= sftp_wildcard_get_filename(swcm
);
1234 /* Politely warn the user that nothing matched. */
1235 printf("%s: nothing matched\n", origfname
);
1236 sftp_finish_wildcard_matching(swcm
);
1241 origwfname
= origfname
;
1245 while (origwfname
) {
1246 fname
= canonify(origwfname
);
1249 printf("%s: canonify: %s\n", origwfname
, fxp_error());
1254 if (!multiple
&& i
< cmd
->nwords
)
1255 outfname
= cmd
->words
[i
++];
1257 outfname
= stripslashes(origwfname
, 0);
1259 ret
= sftp_get_file(fname
, outfname
, recurse
, restart
);
1265 origwfname
= sftp_wildcard_get_filename(swcm
);
1272 sftp_finish_wildcard_matching(swcm
);
1276 } while (multiple
&& i
< cmd
->nwords
);
1280 int sftp_cmd_get(struct sftp_command
*cmd
)
1282 return sftp_general_get(cmd
, 0, 0);
1284 int sftp_cmd_mget(struct sftp_command
*cmd
)
1286 return sftp_general_get(cmd
, 0, 1);
1288 int sftp_cmd_reget(struct sftp_command
*cmd
)
1290 return sftp_general_get(cmd
, 1, 0);
1294 * Send a file and store it at the remote end. We have three very
1295 * similar commands here. The basic one is `put'; `reput' differs
1296 * in that it checks for the existence of the destination file and
1297 * starts from where a previous aborted transfer left off; `mput'
1298 * differs in that it interprets all its arguments as files to
1299 * transfer (never as a different remote name for a local file) and
1300 * can handle wildcards.
1302 int sftp_general_put(struct sftp_command
*cmd
, int restart
, int multiple
)
1304 char *fname
, *wfname
, *origoutfname
, *outfname
;
1306 int recurse
= FALSE
;
1314 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1315 if (!strcmp(cmd
->words
[i
], "--")) {
1316 /* finish processing options */
1319 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1322 printf("%s: unrecognised option '%s'\n", cmd
->words
[0], cmd
->words
[i
]);
1328 if (i
>= cmd
->nwords
) {
1329 printf("%s: expects a filename\n", cmd
->words
[0]);
1335 WildcardMatcher
*wcm
;
1336 fname
= cmd
->words
[i
++];
1338 if (multiple
&& test_wildcard(fname
, FALSE
) == WCTYPE_WILDCARD
) {
1339 wcm
= begin_wildcard_matching(fname
);
1340 wfname
= wildcard_get_filename(wcm
);
1342 /* Politely warn the user that nothing matched. */
1343 printf("%s: nothing matched\n", fname
);
1344 finish_wildcard_matching(wcm
);
1353 if (!multiple
&& i
< cmd
->nwords
)
1354 origoutfname
= cmd
->words
[i
++];
1356 origoutfname
= stripslashes(wfname
, 1);
1358 outfname
= canonify(origoutfname
);
1360 printf("%s: canonify: %s\n", origoutfname
, fxp_error());
1363 finish_wildcard_matching(wcm
);
1367 ret
= sftp_put_file(wfname
, outfname
, recurse
, restart
);
1372 wfname
= wildcard_get_filename(wcm
);
1379 finish_wildcard_matching(wcm
);
1384 } while (multiple
&& i
< cmd
->nwords
);
1388 int sftp_cmd_put(struct sftp_command
*cmd
)
1390 return sftp_general_put(cmd
, 0, 0);
1392 int sftp_cmd_mput(struct sftp_command
*cmd
)
1394 return sftp_general_put(cmd
, 0, 1);
1396 int sftp_cmd_reput(struct sftp_command
*cmd
)
1398 return sftp_general_put(cmd
, 1, 0);
1401 int sftp_cmd_mkdir(struct sftp_command
*cmd
)
1404 struct sftp_packet
*pktin
;
1405 struct sftp_request
*req
, *rreq
;
1414 if (cmd
->nwords
< 2) {
1415 printf("mkdir: expects a directory\n");
1420 for (i
= 1; i
< cmd
->nwords
; i
++) {
1421 dir
= canonify(cmd
->words
[i
]);
1423 printf("%s: canonify: %s\n", dir
, fxp_error());
1427 sftp_register(req
= fxp_mkdir_send(dir
));
1428 rreq
= sftp_find_request(pktin
= sftp_recv());
1429 assert(rreq
== req
);
1430 result
= fxp_mkdir_recv(pktin
, rreq
);
1433 printf("mkdir %s: %s\n", dir
, fxp_error());
1436 printf("mkdir %s: OK\n", dir
);
1444 static int sftp_action_rmdir(void *vctx
, char *dir
)
1446 struct sftp_packet
*pktin
;
1447 struct sftp_request
*req
, *rreq
;
1450 sftp_register(req
= fxp_rmdir_send(dir
));
1451 rreq
= sftp_find_request(pktin
= sftp_recv());
1452 assert(rreq
== req
);
1453 result
= fxp_rmdir_recv(pktin
, rreq
);
1456 printf("rmdir %s: %s\n", dir
, fxp_error());
1460 printf("rmdir %s: OK\n", dir
);
1465 int sftp_cmd_rmdir(struct sftp_command
*cmd
)
1474 if (cmd
->nwords
< 2) {
1475 printf("rmdir: expects a directory\n");
1480 for (i
= 1; i
< cmd
->nwords
; i
++)
1481 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_rmdir
, NULL
);
1486 static int sftp_action_rm(void *vctx
, char *fname
)
1488 struct sftp_packet
*pktin
;
1489 struct sftp_request
*req
, *rreq
;
1492 sftp_register(req
= fxp_remove_send(fname
));
1493 rreq
= sftp_find_request(pktin
= sftp_recv());
1494 assert(rreq
== req
);
1495 result
= fxp_remove_recv(pktin
, rreq
);
1498 printf("rm %s: %s\n", fname
, fxp_error());
1502 printf("rm %s: OK\n", fname
);
1507 int sftp_cmd_rm(struct sftp_command
*cmd
)
1516 if (cmd
->nwords
< 2) {
1517 printf("rm: expects a filename\n");
1522 for (i
= 1; i
< cmd
->nwords
; i
++)
1523 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_rm
, NULL
);
1528 static int check_is_dir(char *dstfname
)
1530 struct sftp_packet
*pktin
;
1531 struct sftp_request
*req
, *rreq
;
1532 struct fxp_attrs attrs
;
1535 sftp_register(req
= fxp_stat_send(dstfname
));
1536 rreq
= sftp_find_request(pktin
= sftp_recv());
1537 assert(rreq
== req
);
1538 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1541 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
1542 (attrs
.permissions
& 0040000))
1548 struct sftp_context_mv
{
1553 static int sftp_action_mv(void *vctx
, char *srcfname
)
1555 struct sftp_context_mv
*ctx
= (struct sftp_context_mv
*)vctx
;
1556 struct sftp_packet
*pktin
;
1557 struct sftp_request
*req
, *rreq
;
1559 char *finalfname
, *newcanon
= NULL
;
1562 if (ctx
->dest_is_dir
) {
1566 p
= srcfname
+ strlen(srcfname
);
1567 while (p
> srcfname
&& p
[-1] != '/') p
--;
1568 newname
= dupcat(ctx
->dstfname
, "/", p
, NULL
);
1569 newcanon
= canonify(newname
);
1571 printf("%s: canonify: %s\n", newname
, fxp_error());
1577 finalfname
= newcanon
;
1579 finalfname
= ctx
->dstfname
;
1582 sftp_register(req
= fxp_rename_send(srcfname
, finalfname
));
1583 rreq
= sftp_find_request(pktin
= sftp_recv());
1584 assert(rreq
== req
);
1585 result
= fxp_rename_recv(pktin
, rreq
);
1587 error
= result ? NULL
: fxp_error();
1590 printf("mv %s %s: %s\n", srcfname
, finalfname
, error
);
1593 printf("%s -> %s\n", srcfname
, finalfname
);
1601 int sftp_cmd_mv(struct sftp_command
*cmd
)
1603 struct sftp_context_mv actx
, *ctx
= &actx
;
1611 if (cmd
->nwords
< 3) {
1612 printf("mv: expects two filenames\n");
1616 ctx
->dstfname
= canonify(cmd
->words
[cmd
->nwords
-1]);
1617 if (!ctx
->dstfname
) {
1618 printf("%s: canonify: %s\n", ctx
->dstfname
, fxp_error());
1623 * If there's more than one source argument, or one source
1624 * argument which is a wildcard, we _require_ that the
1625 * destination is a directory.
1627 ctx
->dest_is_dir
= check_is_dir(ctx
->dstfname
);
1628 if ((cmd
->nwords
> 3 || is_wildcard(cmd
->words
[1])) && !ctx
->dest_is_dir
) {
1629 printf("mv: multiple or wildcard arguments require the destination"
1630 " to be a directory\n");
1631 sfree(ctx
->dstfname
);
1636 * Now iterate over the source arguments.
1639 for (i
= 1; i
< cmd
->nwords
-1; i
++)
1640 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_mv
, ctx
);
1642 sfree(ctx
->dstfname
);
1646 struct sftp_context_chmod
{
1647 unsigned attrs_clr
, attrs_xor
;
1650 static int sftp_action_chmod(void *vctx
, char *fname
)
1652 struct fxp_attrs attrs
;
1653 struct sftp_packet
*pktin
;
1654 struct sftp_request
*req
, *rreq
;
1656 unsigned oldperms
, newperms
;
1657 struct sftp_context_chmod
*ctx
= (struct sftp_context_chmod
*)vctx
;
1659 sftp_register(req
= fxp_stat_send(fname
));
1660 rreq
= sftp_find_request(pktin
= sftp_recv());
1661 assert(rreq
== req
);
1662 result
= fxp_stat_recv(pktin
, rreq
, &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 sftp_register(req
= fxp_setstat_send(fname
, attrs
));
1680 rreq
= sftp_find_request(pktin
= sftp_recv());
1681 assert(rreq
== req
);
1682 result
= fxp_setstat_recv(pktin
, rreq
);
1685 printf("set attrs for %s: %s\n", fname
, fxp_error());
1689 printf("%s: %04o -> %04o\n", fname
, oldperms
, newperms
);
1694 int sftp_cmd_chmod(struct sftp_command
*cmd
)
1698 struct sftp_context_chmod actx
, *ctx
= &actx
;
1705 if (cmd
->nwords
< 3) {
1706 printf("chmod: expects a mode specifier and a filename\n");
1711 * Attempt to parse the mode specifier in cmd->words[1]. We
1712 * don't support the full horror of Unix chmod; instead we
1713 * support a much simpler syntax in which the user can either
1714 * specify an octal number, or a comma-separated sequence of
1715 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1716 * _only_ be omitted if the only attribute mentioned is t,
1717 * since all others require a user/group/other specification.
1718 * Additionally, the s attribute may not be specified for any
1719 * [ugoa] specifications other than exactly u or exactly g.
1721 ctx
->attrs_clr
= ctx
->attrs_xor
= 0;
1722 mode
= cmd
->words
[1];
1723 if (mode
[0] >= '0' && mode
[0] <= '9') {
1724 if (mode
[strspn(mode
, "01234567")]) {
1725 printf("chmod: numeric file modes should"
1726 " contain digits 0-7 only\n");
1729 ctx
->attrs_clr
= 07777;
1730 sscanf(mode
, "%o", &ctx
->attrs_xor
);
1731 ctx
->attrs_xor
&= ctx
->attrs_clr
;
1734 char *modebegin
= mode
;
1735 unsigned subset
, perms
;
1739 while (*mode
&& *mode
!= ',' &&
1740 *mode
!= '+' && *mode
!= '-' && *mode
!= '=') {
1742 case 'u': subset
|= 04700; break; /* setuid, user perms */
1743 case 'g': subset
|= 02070; break; /* setgid, group perms */
1744 case 'o': subset
|= 00007; break; /* just other perms */
1745 case 'a': subset
|= 06777; break; /* all of the above */
1747 printf("chmod: file mode '%.*s' contains unrecognised"
1748 " user/group/other specifier '%c'\n",
1749 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1754 if (!*mode
|| *mode
== ',') {
1755 printf("chmod: file mode '%.*s' is incomplete\n",
1756 (int)strcspn(modebegin
, ","), modebegin
);
1760 if (!*mode
|| *mode
== ',') {
1761 printf("chmod: file mode '%.*s' is incomplete\n",
1762 (int)strcspn(modebegin
, ","), modebegin
);
1766 while (*mode
&& *mode
!= ',') {
1768 case 'r': perms
|= 00444; break;
1769 case 'w': perms
|= 00222; break;
1770 case 'x': perms
|= 00111; break;
1771 case 't': perms
|= 01000; subset
|= 01000; break;
1773 if ((subset
& 06777) != 04700 &&
1774 (subset
& 06777) != 02070) {
1775 printf("chmod: file mode '%.*s': set[ug]id bit should"
1776 " be used with exactly one of u or g only\n",
1777 (int)strcspn(modebegin
, ","), modebegin
);
1783 printf("chmod: file mode '%.*s' contains unrecognised"
1784 " permission specifier '%c'\n",
1785 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1790 if (!(subset
& 06777) && (perms
&~ subset
)) {
1791 printf("chmod: file mode '%.*s' contains no user/group/other"
1792 " specifier and permissions other than 't' \n",
1793 (int)strcspn(modebegin
, ","), modebegin
);
1799 ctx
->attrs_clr
|= perms
;
1800 ctx
->attrs_xor
|= perms
;
1803 ctx
->attrs_clr
|= perms
;
1804 ctx
->attrs_xor
&= ~perms
;
1807 ctx
->attrs_clr
|= subset
;
1808 ctx
->attrs_xor
|= perms
;
1811 if (*mode
) mode
++; /* eat comma */
1816 for (i
= 2; i
< cmd
->nwords
; i
++)
1817 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_chmod
, ctx
);
1822 static int sftp_cmd_open(struct sftp_command
*cmd
)
1827 printf("psftp: already connected\n");
1831 if (cmd
->nwords
< 2) {
1832 printf("open: expects a host name\n");
1836 if (cmd
->nwords
> 2) {
1837 portnumber
= atoi(cmd
->words
[2]);
1838 if (portnumber
== 0) {
1839 printf("open: invalid port number\n");
1845 if (psftp_connect(cmd
->words
[1], NULL
, portnumber
)) {
1846 back
= NULL
; /* connection is already closed */
1847 return -1; /* this is fatal */
1853 static int sftp_cmd_lcd(struct sftp_command
*cmd
)
1855 char *currdir
, *errmsg
;
1857 if (cmd
->nwords
< 2) {
1858 printf("lcd: expects a local directory name\n");
1862 errmsg
= psftp_lcd(cmd
->words
[1]);
1864 printf("lcd: unable to change directory: %s\n", errmsg
);
1869 currdir
= psftp_getcwd();
1870 printf("New local directory is %s\n", currdir
);
1876 static int sftp_cmd_lpwd(struct sftp_command
*cmd
)
1880 currdir
= psftp_getcwd();
1881 printf("Current local directory is %s\n", currdir
);
1887 static int sftp_cmd_pling(struct sftp_command
*cmd
)
1891 exitcode
= system(cmd
->words
[1]);
1892 return (exitcode
== 0);
1895 static int sftp_cmd_help(struct sftp_command
*cmd
);
1897 static struct sftp_cmd_lookup
{
1900 * For help purposes, there are two kinds of command:
1902 * - primary commands, in which `longhelp' is non-NULL. In
1903 * this case `shorthelp' is descriptive text, and `longhelp'
1904 * is longer descriptive text intended to be printed after
1907 * - alias commands, in which `longhelp' is NULL. In this case
1908 * `shorthelp' is the name of a primary command, which
1909 * contains the help that should double up for this command.
1911 int listed
; /* do we list this in primary help? */
1914 int (*obey
) (struct sftp_command
*);
1917 * List of sftp commands. This is binary-searched so it MUST be
1921 "!", TRUE
, "run a local command",
1923 /* FIXME: this example is crap for non-Windows. */
1924 " Runs a local command. For example, \"!del myfile\".\n",
1928 "bye", TRUE
, "finish your SFTP session",
1930 " Terminates your SFTP session and quits the PSFTP program.\n",
1934 "cd", TRUE
, "change your remote working directory",
1935 " [ <new working directory> ]\n"
1936 " Change the remote working directory for your SFTP session.\n"
1937 " If a new working directory is not supplied, you will be\n"
1938 " returned to your home directory.\n",
1942 "chmod", TRUE
, "change file permissions and modes",
1943 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1944 " Change the file permissions on one or more remote files or\n"
1946 " <modes> can be any octal Unix permission specifier.\n"
1947 " Alternatively, <modes> can include the following modifiers:\n"
1948 " u+r make file readable by owning user\n"
1949 " u+w make file writable by owning user\n"
1950 " u+x make file executable by owning user\n"
1951 " u-r make file not readable by owning user\n"
1952 " [also u-w, u-x]\n"
1953 " g+r make file readable by members of owning group\n"
1954 " [also g+w, g+x, g-r, g-w, g-x]\n"
1955 " o+r make file readable by all other users\n"
1956 " [also o+w, o+x, o-r, o-w, o-x]\n"
1957 " a+r make file readable by absolutely everybody\n"
1958 " [also a+w, a+x, a-r, a-w, a-x]\n"
1959 " u+s enable the Unix set-user-ID bit\n"
1960 " u-s disable the Unix set-user-ID bit\n"
1961 " g+s enable the Unix set-group-ID bit\n"
1962 " g-s disable the Unix set-group-ID bit\n"
1963 " +t enable the Unix \"sticky bit\"\n"
1964 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1965 " more than one user for the same modifier (\"ug+w\"). You can\n"
1966 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1970 "close", TRUE
, "finish your SFTP session but do not quit PSFTP",
1972 " Terminates your SFTP session, but does not quit the PSFTP\n"
1973 " program. You can then use \"open\" to start another SFTP\n"
1974 " session, to the same server or to a different one.\n",
1978 "del", TRUE
, "delete files on the remote server",
1979 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1980 " Delete a file or files from the server.\n",
1984 "delete", FALSE
, "del", NULL
, sftp_cmd_rm
1987 "dir", TRUE
, "list remote files",
1988 " [ <directory-name> ]/[ <wildcard> ]\n"
1989 " List the contents of a specified directory on the server.\n"
1990 " If <directory-name> is not given, the current working directory\n"
1992 " If <wildcard> is given, it is treated as a set of files to\n"
1993 " list; otherwise, all files are listed.\n",
1997 "exit", TRUE
, "bye", NULL
, sftp_cmd_quit
2000 "get", TRUE
, "download a file from the server to your local machine",
2001 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2002 " Downloads a file on the server and stores it locally under\n"
2003 " the same name, or under a different one if you supply the\n"
2004 " argument <local-filename>.\n"
2005 " If -r specified, recursively fetch a directory.\n",
2009 "help", TRUE
, "give help",
2010 " [ <command> [ <command> ... ] ]\n"
2011 " Give general help if no commands are specified.\n"
2012 " If one or more commands are specified, give specific help on\n"
2013 " those particular commands.\n",
2017 "lcd", TRUE
, "change local working directory",
2018 " <local-directory-name>\n"
2019 " Change the local working directory of the PSFTP program (the\n"
2020 " default location where the \"get\" command will save files).\n",
2024 "lpwd", TRUE
, "print local working directory",
2026 " Print the local working directory of the PSFTP program (the\n"
2027 " default location where the \"get\" command will save files).\n",
2031 "ls", TRUE
, "dir", NULL
,
2035 "mget", TRUE
, "download multiple files at once",
2036 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2037 " Downloads many files from the server, storing each one under\n"
2038 " the same name it has on the server side. You can use wildcards\n"
2039 " such as \"*.c\" to specify lots of files at once.\n"
2040 " If -r specified, recursively fetch files and directories.\n",
2044 "mkdir", TRUE
, "create directories on the remote server",
2045 " <directory-name> [ <directory-name>... ]\n"
2046 " Creates directories with the given names on the server.\n",
2050 "mput", TRUE
, "upload multiple files at once",
2051 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2052 " Uploads many files to the server, storing each one under the\n"
2053 " same name it has on the client side. You can use wildcards\n"
2054 " such as \"*.c\" to specify lots of files at once.\n"
2055 " If -r specified, recursively store files and directories.\n",
2059 "mv", TRUE
, "move or rename file(s) on the remote server",
2060 " <source> [ <source>... ] <destination>\n"
2061 " Moves or renames <source>(s) on the server to <destination>,\n"
2062 " also on the server.\n"
2063 " If <destination> specifies an existing directory, then <source>\n"
2064 " may be a wildcard, and multiple <source>s may be given; all\n"
2065 " source files are moved into <destination>.\n"
2066 " Otherwise, <source> must specify a single file, which is moved\n"
2067 " or renamed so that it is accessible under the name <destination>.\n",
2071 "open", TRUE
, "connect to a host",
2072 " [<user>@]<hostname> [<port>]\n"
2073 " Establishes an SFTP connection to a given host. Only usable\n"
2074 " when you are not already connected to a server.\n",
2078 "put", TRUE
, "upload a file from your local machine to the server",
2079 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2080 " Uploads a file to the server and stores it there under\n"
2081 " the same name, or under a different one if you supply the\n"
2082 " argument <remote-filename>.\n"
2083 " If -r specified, recursively store a directory.\n",
2087 "pwd", TRUE
, "print your remote working directory",
2089 " Print the current remote working directory for your SFTP session.\n",
2093 "quit", TRUE
, "bye", NULL
,
2097 "reget", TRUE
, "continue downloading files",
2098 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2099 " Works exactly like the \"get\" command, but the local file\n"
2100 " must already exist. The download will begin at the end of the\n"
2101 " file. This is for resuming a download that was interrupted.\n"
2102 " If -r specified, resume interrupted \"get -r\".\n",
2106 "ren", TRUE
, "mv", NULL
,
2110 "rename", FALSE
, "mv", NULL
,
2114 "reput", TRUE
, "continue uploading files",
2115 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2116 " Works exactly like the \"put\" command, but the remote file\n"
2117 " must already exist. The upload will begin at the end of the\n"
2118 " file. This is for resuming an upload that was interrupted.\n"
2119 " If -r specified, resume interrupted \"put -r\".\n",
2123 "rm", TRUE
, "del", NULL
,
2127 "rmdir", TRUE
, "remove directories on the remote server",
2128 " <directory-name> [ <directory-name>... ]\n"
2129 " Removes the directory with the given name on the server.\n"
2130 " The directory will not be removed unless it is empty.\n"
2131 " Wildcards may be used to specify multiple directories.\n",
2136 const struct sftp_cmd_lookup
*lookup_command(char *name
)
2141 j
= sizeof(sftp_lookup
) / sizeof(*sftp_lookup
);
2144 cmp
= strcmp(name
, sftp_lookup
[k
].name
);
2150 return &sftp_lookup
[k
];
2156 static int sftp_cmd_help(struct sftp_command
*cmd
)
2159 if (cmd
->nwords
== 1) {
2161 * Give short help on each command.
2165 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
2167 if (!sftp_lookup
[i
].listed
)
2169 len
= strlen(sftp_lookup
[i
].name
);
2173 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
2174 const struct sftp_cmd_lookup
*lookup
;
2175 if (!sftp_lookup
[i
].listed
)
2177 lookup
= &sftp_lookup
[i
];
2178 printf("%-*s", maxlen
+2, lookup
->name
);
2179 if (lookup
->longhelp
== NULL
)
2180 lookup
= lookup_command(lookup
->shorthelp
);
2181 printf("%s\n", lookup
->shorthelp
);
2185 * Give long help on specific commands.
2187 for (i
= 1; i
< cmd
->nwords
; i
++) {
2188 const struct sftp_cmd_lookup
*lookup
;
2189 lookup
= lookup_command(cmd
->words
[i
]);
2191 printf("help: %s: command not found\n", cmd
->words
[i
]);
2193 printf("%s", lookup
->name
);
2194 if (lookup
->longhelp
== NULL
)
2195 lookup
= lookup_command(lookup
->shorthelp
);
2196 printf("%s", lookup
->longhelp
);
2203 /* ----------------------------------------------------------------------
2204 * Command line reading and parsing.
2206 struct sftp_command
*sftp_getcmd(FILE *fp
, int mode
, int modeflags
)
2209 struct sftp_command
*cmd
;
2213 cmd
= snew(struct sftp_command
);
2223 line
= fgetline(fp
);
2225 line
= ssh_sftp_get_cmdline("psftp> ", back
== NULL
);
2228 if (!line
|| !*line
) {
2229 cmd
->obey
= sftp_cmd_quit
;
2230 if ((mode
== 0) || (modeflags
& 1))
2232 return cmd
; /* eof */
2235 line
[strcspn(line
, "\r\n")] = '\0';
2237 if (modeflags
& 1) {
2238 printf("%s\n", line
);
2242 while (*p
&& (*p
== ' ' || *p
== '\t'))
2247 * Special case: the ! command. This is always parsed as
2248 * exactly two words: one containing the !, and the second
2249 * containing everything else on the line.
2251 cmd
->nwords
= cmd
->wordssize
= 2;
2252 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
2253 cmd
->words
[0] = dupstr("!");
2254 cmd
->words
[1] = dupstr(p
+1);
2255 } else if (*p
== '#') {
2257 * Special case: comment. Entire line is ignored.
2259 cmd
->nwords
= cmd
->wordssize
= 0;
2263 * Parse the command line into words. The syntax is:
2264 * - double quotes are removed, but cause spaces within to be
2265 * treated as non-separating.
2266 * - a double-doublequote pair is a literal double quote, inside
2267 * _or_ outside quotes. Like this:
2269 * firstword "second word" "this has ""quotes"" in" and""this""
2275 * >this has "quotes" in<
2279 /* skip whitespace */
2280 while (*p
&& (*p
== ' ' || *p
== '\t'))
2282 /* mark start of word */
2283 q
= r
= p
; /* q sits at start, r writes word */
2286 if (!quoting
&& (*p
== ' ' || *p
== '\t'))
2287 break; /* reached end of word */
2288 else if (*p
== '"' && p
[1] == '"')
2289 p
+= 2, *r
++ = '"'; /* a literal quote */
2291 p
++, quoting
= !quoting
;
2296 p
++; /* skip over the whitespace */
2298 if (cmd
->nwords
>= cmd
->wordssize
) {
2299 cmd
->wordssize
= cmd
->nwords
+ 16;
2300 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
2302 cmd
->words
[cmd
->nwords
++] = dupstr(q
);
2309 * Now parse the first word and assign a function.
2312 if (cmd
->nwords
== 0)
2313 cmd
->obey
= sftp_cmd_null
;
2315 const struct sftp_cmd_lookup
*lookup
;
2316 lookup
= lookup_command(cmd
->words
[0]);
2318 cmd
->obey
= sftp_cmd_unknown
;
2320 cmd
->obey
= lookup
->obey
;
2326 static int do_sftp_init(void)
2328 struct sftp_packet
*pktin
;
2329 struct sftp_request
*req
, *rreq
;
2332 * Do protocol initialisation.
2336 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2337 return 1; /* failure */
2341 * Find out where our home directory is.
2343 sftp_register(req
= fxp_realpath_send("."));
2344 rreq
= sftp_find_request(pktin
= sftp_recv());
2345 assert(rreq
== req
);
2346 homedir
= fxp_realpath_recv(pktin
, rreq
);
2350 "Warning: failed to resolve home directory: %s\n",
2352 homedir
= dupstr(".");
2354 printf("Remote working directory is %s\n", homedir
);
2356 pwd
= dupstr(homedir
);
2360 void do_sftp_cleanup()
2364 back
->special(backhandle
, TS_EOF
);
2365 sftp_recvdata(&ch
, 1);
2366 back
->free(backhandle
);
2367 sftp_cleanup_request();
2381 void do_sftp(int mode
, int modeflags
, char *batchfile
)
2391 /* ------------------------------------------------------------------
2392 * Now we're ready to do Real Stuff.
2395 struct sftp_command
*cmd
;
2396 cmd
= sftp_getcmd(NULL
, 0, 0);
2399 ret
= cmd
->obey(cmd
);
2402 for(i
= 0; i
< cmd
->nwords
; i
++)
2403 sfree(cmd
->words
[i
]);
2411 fp
= fopen(batchfile
, "r");
2413 printf("Fatal: unable to open %s\n", batchfile
);
2417 struct sftp_command
*cmd
;
2418 cmd
= sftp_getcmd(fp
, mode
, modeflags
);
2421 ret
= cmd
->obey(cmd
);
2425 if (!(modeflags
& 2))
2434 /* ----------------------------------------------------------------------
2435 * Dirty bits: integration with PuTTY.
2438 static int verbose
= 0;
2441 * Print an error message and perform a fatal exit.
2443 void fatalbox(char *fmt
, ...)
2448 str
= dupvprintf(fmt
, ap
);
2449 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2452 fputs(str2
, stderr
);
2457 void modalfatalbox(char *fmt
, ...)
2462 str
= dupvprintf(fmt
, ap
);
2463 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2466 fputs(str2
, stderr
);
2471 void connection_fatal(void *frontend
, char *fmt
, ...)
2476 str
= dupvprintf(fmt
, ap
);
2477 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2480 fputs(str2
, stderr
);
2486 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
)
2489 * This is only here because of the calls to ldisc_send(NULL,
2490 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2491 * ldisc as an ldisc. So if we get called with any real data, I
2492 * want to know about it.
2498 * In psftp, all agent requests should be synchronous, so this is a
2499 * never-called stub.
2501 void agent_schedule_callback(void (*callback
)(void *, void *, int),
2502 void *callback_ctx
, void *data
, int len
)
2504 assert(!"We shouldn't be here");
2508 * Receive a block of data from the SSH link. Block until all data
2511 * To do this, we repeatedly call the SSH protocol module, with our
2512 * own trap in from_backend() to catch the data that comes back. We
2513 * do this until we have enough data.
2516 static unsigned char *outptr
; /* where to put the data */
2517 static unsigned outlen
; /* how much data required */
2518 static unsigned char *pending
= NULL
; /* any spare data */
2519 static unsigned pendlen
= 0, pendsize
= 0; /* length and phys. size of buffer */
2520 int from_backend(void *frontend
, int is_stderr
, const char *data
, int datalen
)
2522 unsigned char *p
= (unsigned char *) data
;
2523 unsigned len
= (unsigned) datalen
;
2526 * stderr data is just spouted to local stderr and otherwise
2531 if (fwrite(data
, 1, len
, stderr
) < len
)
2537 * If this is before the real session begins, just return.
2542 if ((outlen
> 0) && (len
> 0)) {
2543 unsigned used
= outlen
;
2546 memcpy(outptr
, p
, used
);
2554 if (pendsize
< pendlen
+ len
) {
2555 pendsize
= pendlen
+ len
+ 4096;
2556 pending
= sresize(pending
, pendsize
, unsigned char);
2558 memcpy(pending
+ pendlen
, p
, len
);
2564 int from_backend_untrusted(void *frontend_handle
, const char *data
, int len
)
2567 * No "untrusted" output should get here (the way the code is
2568 * currently, it's all diverted by FLAG_STDERR).
2570 assert(!"Unexpected call to from_backend_untrusted()");
2571 return 0; /* not reached */
2573 int sftp_recvdata(char *buf
, int len
)
2575 outptr
= (unsigned char *) buf
;
2579 * See if the pending-input block contains some of what we
2583 unsigned pendused
= pendlen
;
2584 if (pendused
> outlen
)
2586 memcpy(outptr
, pending
, pendused
);
2587 memmove(pending
, pending
+ pendused
, pendlen
- pendused
);
2590 pendlen
-= pendused
;
2600 while (outlen
> 0) {
2601 if (back
->exitcode(backhandle
) >= 0 || ssh_sftp_loop_iteration() < 0)
2602 return 0; /* doom */
2607 int sftp_senddata(char *buf
, int len
)
2609 back
->send(backhandle
, buf
, len
);
2614 * Short description of parameters.
2616 static void usage(void)
2618 printf("PuTTY Secure File Transfer (SFTP) client\n");
2619 printf("%s\n", ver
);
2620 printf("Usage: psftp [options] [user@]host\n");
2621 printf("Options:\n");
2622 printf(" -V print version information and exit\n");
2623 printf(" -pgpfp print PGP key fingerprints and exit\n");
2624 printf(" -b file use specified batchfile\n");
2625 printf(" -bc output batchfile commands\n");
2626 printf(" -be don't stop batchfile processing if errors\n");
2627 printf(" -v show verbose messages\n");
2628 printf(" -load sessname Load settings from saved session\n");
2629 printf(" -l user connect with specified username\n");
2630 printf(" -P port connect to specified port\n");
2631 printf(" -pw passw login with specified password\n");
2632 printf(" -1 -2 force use of particular SSH protocol version\n");
2633 printf(" -4 -6 force use of IPv4 or IPv6\n");
2634 printf(" -C enable compression\n");
2635 printf(" -i key private key file for authentication\n");
2636 printf(" -noagent disable use of Pageant\n");
2637 printf(" -agent enable use of Pageant\n");
2638 printf(" -batch disable all interactive prompts\n");
2642 static void version(void)
2644 printf("psftp: %s\n", ver
);
2649 * Connect to a host.
2651 static int psftp_connect(char *userhost
, char *user
, int portnumber
)
2653 char *host
, *realhost
;
2657 /* Separate host and username */
2659 host
= strrchr(host
, '@');
2665 printf("psftp: multiple usernames specified; using \"%s\"\n",
2672 * If we haven't loaded session details already (e.g., from -load),
2673 * try looking for a session called "host".
2675 if (!loaded_session
) {
2676 /* Try to load settings for `host' into a temporary config */
2677 Conf
*conf2
= conf_new();
2678 conf_set_str(conf2
, CONF_host
, "");
2679 do_defaults(host
, conf2
);
2680 if (conf_get_str(conf2
, CONF_host
)[0] != '\0') {
2681 /* Settings present and include hostname */
2682 /* Re-load data into the real config. */
2683 do_defaults(host
, conf
);
2685 /* Session doesn't exist or mention a hostname. */
2686 /* Use `host' as a bare hostname. */
2687 conf_set_str(conf
, CONF_host
, host
);
2690 /* Patch in hostname `host' to session details. */
2691 conf_set_str(conf
, CONF_host
, host
);
2695 * Force use of SSH. (If they got the protocol wrong we assume the
2696 * port is useless too.)
2698 if (conf_get_int(conf
, CONF_protocol
) != PROT_SSH
) {
2699 conf_set_int(conf
, CONF_protocol
, PROT_SSH
);
2700 conf_set_int(conf
, CONF_port
, 22);
2704 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2705 * then change it to SSH-2, on the grounds that that's more likely to
2706 * work for SFTP. (Can be overridden with `-1' option.)
2707 * But if it says `2 only' or `2', respect which.
2709 if ((conf_get_int(conf
, CONF_sshprot
) & ~1) != 2) /* is it 2 or 3? */
2710 conf_set_int(conf
, CONF_sshprot
, 2);
2713 * Enact command-line overrides.
2715 cmdline_run_saved(conf
);
2718 * Muck about with the hostname in various ways.
2721 char *hostbuf
= dupstr(conf_get_str(conf
, CONF_host
));
2722 char *host
= hostbuf
;
2726 * Trim leading whitespace.
2728 host
+= strspn(host
, " \t");
2731 * See if host is of the form user@host, and separate out
2732 * the username if so.
2734 if (host
[0] != '\0') {
2735 char *atsign
= strrchr(host
, '@');
2738 conf_set_str(conf
, CONF_username
, host
);
2744 * Remove any remaining whitespace.
2749 if (*q
!= ' ' && *q
!= '\t')
2755 conf_set_str(conf
, CONF_host
, hostbuf
);
2760 if (user
!= NULL
&& user
[0] != '\0') {
2761 conf_set_str(conf
, CONF_username
, user
);
2765 conf_set_int(conf
, CONF_port
, portnumber
);
2768 * Disable scary things which shouldn't be enabled for simple
2769 * things like SCP and SFTP: agent forwarding, port forwarding,
2772 conf_set_int(conf
, CONF_x11_forward
, 0);
2773 conf_set_int(conf
, CONF_agentfwd
, 0);
2774 conf_set_int(conf
, CONF_ssh_simple
, TRUE
);
2777 while ((key
= conf_get_str_nthstrkey(conf
, CONF_portfwd
, 0)) != NULL
)
2778 conf_del_str_str(conf
, CONF_portfwd
, key
);
2781 /* Set up subsystem name. */
2782 conf_set_str(conf
, CONF_remote_cmd
, "sftp");
2783 conf_set_int(conf
, CONF_ssh_subsys
, TRUE
);
2784 conf_set_int(conf
, CONF_nopty
, TRUE
);
2787 * Set up fallback option, for SSH-1 servers or servers with the
2788 * sftp subsystem not enabled but the server binary installed
2789 * in the usual place. We only support fallback on Unix
2790 * systems, and we use a kludgy piece of shellery which should
2791 * try to find sftp-server in various places (the obvious
2792 * systemwide spots /usr/lib and /usr/local/lib, and then the
2793 * user's PATH) and finally give up.
2795 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2796 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2799 * the idea being that this will attempt to use either of the
2800 * obvious pathnames and then give up, and when it does give up
2801 * it will print the preferred pathname in the error messages.
2803 conf_set_str(conf
, CONF_remote_cmd2
,
2804 "test -x /usr/lib/sftp-server &&"
2805 " exec /usr/lib/sftp-server\n"
2806 "test -x /usr/local/lib/sftp-server &&"
2807 " exec /usr/local/lib/sftp-server\n"
2808 "exec sftp-server");
2809 conf_set_int(conf
, CONF_ssh_subsys2
, FALSE
);
2811 back
= &ssh_backend
;
2813 err
= back
->init(NULL
, &backhandle
, conf
,
2814 conf_get_str(conf
, CONF_host
),
2815 conf_get_int(conf
, CONF_port
),
2817 conf_get_int(conf
, CONF_tcp_keepalives
));
2819 fprintf(stderr
, "ssh_init: %s\n", err
);
2822 logctx
= log_init(NULL
, conf
);
2823 back
->provide_logctx(backhandle
, logctx
);
2824 console_provide_logctx(logctx
);
2825 while (!back
->sendok(backhandle
)) {
2826 if (back
->exitcode(backhandle
) >= 0)
2828 if (ssh_sftp_loop_iteration() < 0) {
2829 fprintf(stderr
, "ssh_init: error during SSH connection setup\n");
2833 if (verbose
&& realhost
!= NULL
)
2834 printf("Connected to %s\n", realhost
);
2835 if (realhost
!= NULL
)
2840 void cmdline_error(char *p
, ...)
2843 fprintf(stderr
, "psftp: ");
2845 vfprintf(stderr
, p
, ap
);
2847 fprintf(stderr
, "\n try typing \"psftp -h\" for help\n");
2852 * Main program. Parse arguments etc.
2854 int psftp_main(int argc
, char *argv
[])
2858 char *userhost
, *user
;
2861 char *batchfile
= NULL
;
2863 flags
= FLAG_STDERR
| FLAG_INTERACTIVE
2864 #ifdef FLAG_SYNCAGENT
2868 cmdline_tooltype
= TOOLTYPE_FILETRANSFER
;
2871 userhost
= user
= NULL
;
2873 /* Load Default Settings before doing anything else. */
2875 do_defaults(NULL
, conf
);
2876 loaded_session
= FALSE
;
2878 for (i
= 1; i
< argc
; i
++) {
2880 if (argv
[i
][0] != '-') {
2884 userhost
= dupstr(argv
[i
]);
2887 ret
= cmdline_process_param(argv
[i
], i
+1<argc?argv
[i
+1]:NULL
, 1, conf
);
2889 cmdline_error("option \"%s\" requires an argument", argv
[i
]);
2890 } else if (ret
== 2) {
2891 i
++; /* skip next argument */
2892 } else if (ret
== 1) {
2893 /* We have our own verbosity in addition to `flags'. */
2894 if (flags
& FLAG_VERBOSE
)
2896 } else if (strcmp(argv
[i
], "-h") == 0 ||
2897 strcmp(argv
[i
], "-?") == 0) {
2899 } else if (strcmp(argv
[i
], "-pgpfp") == 0) {
2902 } else if (strcmp(argv
[i
], "-V") == 0) {
2904 } else if (strcmp(argv
[i
], "-batch") == 0) {
2905 console_batch_mode
= 1;
2906 } else if (strcmp(argv
[i
], "-b") == 0 && i
+ 1 < argc
) {
2908 batchfile
= argv
[++i
];
2909 } else if (strcmp(argv
[i
], "-bc") == 0) {
2910 modeflags
= modeflags
| 1;
2911 } else if (strcmp(argv
[i
], "-be") == 0) {
2912 modeflags
= modeflags
| 2;
2913 } else if (strcmp(argv
[i
], "--") == 0) {
2917 cmdline_error("unknown option \"%s\"", argv
[i
]);
2925 * If the loaded session provides a hostname, and a hostname has not
2926 * otherwise been specified, pop it in `userhost' so that
2927 * `psftp -load sessname' is sufficient to start a session.
2929 if (!userhost
&& conf_get_str(conf
, CONF_host
)[0] != '\0') {
2930 userhost
= dupstr(conf_get_str(conf
, CONF_host
));
2934 * If a user@host string has already been provided, connect to
2939 ret
= psftp_connect(userhost
, user
, portnumber
);
2946 printf("psftp: no hostname specified; use \"open host.name\""
2950 do_sftp(mode
, modeflags
, batchfile
);
2952 if (back
!= NULL
&& back
->connected(backhandle
)) {
2954 back
->special(backhandle
, TS_EOF
);
2955 sftp_recvdata(&ch
, 1);
2960 console_provide_logctx(NULL
);