2 * psftp.c: (platform-independent) front end for PSFTP.
11 #define PUTTY_DO_GLOBALS
20 * Since SFTP is a request-response oriented protocol, it requires
21 * no buffer management: when we send data, we stop and wait for an
22 * acknowledgement _anyway_, and so we can't possibly overfill our
26 static int psftp_connect(char *userhost
, char *user
, int portnumber
);
27 static int do_sftp_init(void);
28 void do_sftp_cleanup();
30 /* ----------------------------------------------------------------------
36 static void *backhandle
;
39 /* ----------------------------------------------------------------------
40 * Higher-level helper functions used in commands.
44 * Attempt to canonify a pathname starting from the pwd. If
45 * canonification fails, at least fall back to returning a _valid_
46 * pathname (though it may be ugly, eg /home/simon/../foobar).
48 char *canonify(char *name
)
50 char *fullname
, *canonname
;
51 struct sftp_packet
*pktin
;
52 struct sftp_request
*req
, *rreq
;
55 fullname
= dupstr(name
);
58 if (pwd
[strlen(pwd
) - 1] == '/')
62 fullname
= dupcat(pwd
, slash
, name
, NULL
);
65 sftp_register(req
= fxp_realpath_send(fullname
));
66 rreq
= sftp_find_request(pktin
= sftp_recv());
68 canonname
= fxp_realpath_recv(pktin
, rreq
);
75 * Attempt number 2. Some FXP_REALPATH implementations
76 * (glibc-based ones, in particular) require the _whole_
77 * path to point to something that exists, whereas others
78 * (BSD-based) only require all but the last component to
79 * exist. So if the first call failed, we should strip off
80 * everything from the last slash onwards and try again,
81 * then put the final component back on.
85 * - if the last component is "/." or "/..", then we don't
86 * bother trying this because there's no way it can work.
88 * - if the thing actually ends with a "/", we remove it
89 * before we start. Except if the string is "/" itself
90 * (although I can't see why we'd have got here if so,
91 * because surely "/" would have worked the first
92 * time?), in which case we don't bother.
94 * - if there's no slash in the string at all, give up in
95 * confusion (we expect at least one because of the way
96 * we constructed the string).
102 i
= strlen(fullname
);
103 if (i
> 2 && fullname
[i
- 1] == '/')
104 fullname
[--i
] = '\0'; /* strip trailing / unless at pos 0 */
105 while (i
> 0 && fullname
[--i
] != '/');
108 * Give up on special cases.
110 if (fullname
[i
] != '/' || /* no slash at all */
111 !strcmp(fullname
+ i
, "/.") || /* ends in /. */
112 !strcmp(fullname
+ i
, "/..") || /* ends in /.. */
113 !strcmp(fullname
, "/")) {
118 * Now i points at the slash. Deal with the final special
119 * case i==0 (ie the whole path was "/nonexistentfile").
121 fullname
[i
] = '\0'; /* separate the string */
123 sftp_register(req
= fxp_realpath_send("/"));
125 sftp_register(req
= fxp_realpath_send(fullname
));
127 rreq
= sftp_find_request(pktin
= sftp_recv());
129 canonname
= fxp_realpath_recv(pktin
, rreq
);
132 return fullname
; /* even that failed; give up */
135 * We have a canonical name for all but the last path
136 * component. Concatenate the last component and return.
138 returnname
= dupcat(canonname
,
139 canonname
[strlen(canonname
) - 1] ==
140 '/' ?
"" : "/", fullname
+ i
+ 1, NULL
);
148 * Return a pointer to the portion of str that comes after the last
149 * slash (or backslash or colon, if `local' is TRUE).
151 static char *stripslashes(char *str
, int local
)
156 p
= strchr(str
, ':');
160 p
= strrchr(str
, '/');
164 p
= strrchr(str
, '\\');
172 * qsort comparison routine for fxp_name structures. Sorts by real
175 static int sftp_name_compare(const void *av
, const void *bv
)
177 const struct fxp_name
*const *a
= (const struct fxp_name
*const *) av
;
178 const struct fxp_name
*const *b
= (const struct fxp_name
*const *) bv
;
179 return strcmp((*a
)->filename
, (*b
)->filename
);
183 * Likewise, but for a bare char *.
185 static int bare_name_compare(const void *av
, const void *bv
)
187 const char **a
= (const char **) av
;
188 const char **b
= (const char **) bv
;
189 return strcmp(*a
, *b
);
192 static void not_connected(void)
194 printf("psftp: not connected to a host; use \"open host.name\"\n");
197 /* ----------------------------------------------------------------------
198 * The meat of the `get' and `put' commands.
200 int sftp_get_file(char *fname
, char *outfname
, int recurse
, int restart
)
202 struct fxp_handle
*fh
;
203 struct sftp_packet
*pktin
;
204 struct sftp_request
*req
, *rreq
;
205 struct fxp_xfer
*xfer
;
208 int ret
, shown_err
= FALSE
;
211 * In recursive mode, see if we're dealing with a directory.
212 * (If we're not in recursive mode, we need not even check: the
213 * subsequent FXP_OPEN will return a usable error message.)
216 struct fxp_attrs attrs
;
219 sftp_register(req
= fxp_stat_send(fname
));
220 rreq
= sftp_find_request(pktin
= sftp_recv());
222 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
225 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
226 (attrs
.permissions
& 0040000)) {
228 struct fxp_handle
*dirhandle
;
229 int nnames
, namesize
;
230 struct fxp_name
**ournames
;
231 struct fxp_names
*names
;
235 * First, attempt to create the destination directory,
236 * unless it already exists.
238 if (file_type(outfname
) != FILE_TYPE_DIRECTORY
&&
239 !create_directory(outfname
)) {
240 printf("%s: Cannot create directory\n", outfname
);
245 * Now get the list of filenames in the remote
248 sftp_register(req
= fxp_opendir_send(fname
));
249 rreq
= sftp_find_request(pktin
= sftp_recv());
251 dirhandle
= fxp_opendir_recv(pktin
, rreq
);
254 printf("%s: unable to open directory: %s\n",
258 nnames
= namesize
= 0;
263 sftp_register(req
= fxp_readdir_send(dirhandle
));
264 rreq
= sftp_find_request(pktin
= sftp_recv());
266 names
= fxp_readdir_recv(pktin
, rreq
);
269 if (fxp_error_type() == SSH_FX_EOF
)
271 printf("%s: reading directory: %s\n", fname
, fxp_error());
275 if (names
->nnames
== 0) {
276 fxp_free_names(names
);
279 if (nnames
+ names
->nnames
>= namesize
) {
280 namesize
+= names
->nnames
+ 128;
281 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
283 for (i
= 0; i
< names
->nnames
; i
++)
284 if (strcmp(names
->names
[i
].filename
, ".") &&
285 strcmp(names
->names
[i
].filename
, "..")) {
286 if (!vet_filename(names
->names
[i
].filename
)) {
287 printf("ignoring potentially dangerous server-"
288 "supplied filename '%s'\n",
289 names
->names
[i
].filename
);
292 fxp_dup_name(&names
->names
[i
]);
295 fxp_free_names(names
);
297 sftp_register(req
= fxp_close_send(dirhandle
));
298 rreq
= sftp_find_request(pktin
= sftp_recv());
300 fxp_close_recv(pktin
, rreq
);
303 * Sort the names into a clear order. This ought to
304 * make things more predictable when we're doing a
305 * reget of the same directory, just in case two
306 * readdirs on the same remote directory return a
309 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
312 * If we're in restart mode, find the last filename on
313 * this list that already exists. We may have to do a
314 * reget on _that_ file, but shouldn't have to do
315 * anything on the previous files.
317 * If none of them exists, of course, we start at 0.
324 nextoutfname
= dir_file_cat(outfname
,
325 ournames
[i
]->filename
);
327 nextoutfname
= dupstr(ournames
[i
]->filename
);
328 ret
= (file_type(nextoutfname
) == FILE_TYPE_NONEXISTENT
);
338 * Now we're ready to recurse. Starting at ournames[i]
339 * and continuing on to the end of the list, we
340 * construct a new source and target file name, and
341 * call sftp_get_file again.
343 for (; i
< nnames
; i
++) {
344 char *nextfname
, *nextoutfname
;
347 nextfname
= dupcat(fname
, "/", ournames
[i
]->filename
, NULL
);
349 nextoutfname
= dir_file_cat(outfname
,
350 ournames
[i
]->filename
);
352 nextoutfname
= dupstr(ournames
[i
]->filename
);
353 ret
= sftp_get_file(nextfname
, nextoutfname
, recurse
, restart
);
354 restart
= FALSE
; /* after first partial file, do full */
358 for (i
= 0; i
< nnames
; i
++) {
359 fxp_free_name(ournames
[i
]);
367 * Done this recursion level. Free everything.
369 for (i
= 0; i
< nnames
; i
++) {
370 fxp_free_name(ournames
[i
]);
378 sftp_register(req
= fxp_open_send(fname
, SSH_FXF_READ
));
379 rreq
= sftp_find_request(pktin
= sftp_recv());
381 fh
= fxp_open_recv(pktin
, rreq
);
384 printf("%s: open for read: %s\n", fname
, fxp_error());
389 file
= open_existing_wfile(outfname
, NULL
);
391 file
= open_new_file(outfname
);
395 printf("local: unable to open %s\n", outfname
);
397 sftp_register(req
= fxp_close_send(fh
));
398 rreq
= sftp_find_request(pktin
= sftp_recv());
400 fxp_close_recv(pktin
, rreq
);
407 if (seek_file(file
, uint64_make(0,0) , FROM_END
) == -1) {
408 printf("reget: cannot restart %s - file too large\n",
410 sftp_register(req
= fxp_close_send(fh
));
411 rreq
= sftp_find_request(pktin
= sftp_recv());
413 fxp_close_recv(pktin
, rreq
);
418 offset
= get_file_posn(file
);
419 uint64_decimal(offset
, decbuf
);
420 printf("reget: restarting at file position %s\n", decbuf
);
422 offset
= uint64_make(0, 0);
425 printf("remote:%s => local:%s\n", fname
, outfname
);
428 * FIXME: we can use FXP_FSTAT here to get the file size, and
429 * thus put up a progress bar.
432 xfer
= xfer_download_init(fh
, offset
);
433 while (!xfer_done(xfer
)) {
438 xfer_download_queue(xfer
);
440 ret
= xfer_download_gotpkt(xfer
, pktin
);
444 printf("error while reading: %s\n", fxp_error());
450 while (xfer_download_data(xfer
, &vbuf
, &len
)) {
451 unsigned char *buf
= (unsigned char *)vbuf
;
455 wlen
= write_to_file(file
, buf
+ wpos
, len
- wpos
);
457 printf("error while writing local file\n");
459 xfer_set_error(xfer
);
463 if (wpos
< len
) { /* we had an error */
465 xfer_set_error(xfer
);
476 sftp_register(req
= fxp_close_send(fh
));
477 rreq
= sftp_find_request(pktin
= sftp_recv());
479 fxp_close_recv(pktin
, rreq
);
484 int sftp_put_file(char *fname
, char *outfname
, int recurse
, int restart
)
486 struct fxp_handle
*fh
;
487 struct fxp_xfer
*xfer
;
488 struct sftp_packet
*pktin
;
489 struct sftp_request
*req
, *rreq
;
495 * In recursive mode, see if we're dealing with a directory.
496 * (If we're not in recursive mode, we need not even check: the
497 * subsequent fopen will return an error message.)
499 if (recurse
&& file_type(fname
) == FILE_TYPE_DIRECTORY
) {
500 struct fxp_attrs attrs
;
502 int nnames
, namesize
;
503 char *name
, **ournames
;
508 * First, attempt to create the destination directory,
509 * unless it already exists.
511 sftp_register(req
= fxp_stat_send(outfname
));
512 rreq
= sftp_find_request(pktin
= sftp_recv());
514 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
516 !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) ||
517 !(attrs
.permissions
& 0040000)) {
518 sftp_register(req
= fxp_mkdir_send(outfname
));
519 rreq
= sftp_find_request(pktin
= sftp_recv());
521 result
= fxp_mkdir_recv(pktin
, rreq
);
524 printf("%s: create directory: %s\n",
525 outfname
, fxp_error());
531 * Now get the list of filenames in the local directory.
533 nnames
= namesize
= 0;
536 dh
= open_directory(fname
);
538 printf("%s: unable to open directory\n", fname
);
541 while ((name
= read_filename(dh
)) != NULL
) {
542 if (nnames
>= namesize
) {
544 ournames
= sresize(ournames
, namesize
, char *);
546 ournames
[nnames
++] = name
;
551 * Sort the names into a clear order. This ought to make
552 * things more predictable when we're doing a reput of the
553 * same directory, just in case two readdirs on the same
554 * local directory return a different order.
556 qsort(ournames
, nnames
, sizeof(*ournames
), bare_name_compare
);
559 * If we're in restart mode, find the last filename on this
560 * list that already exists. We may have to do a reput on
561 * _that_ file, but shouldn't have to do anything on the
564 * If none of them exists, of course, we start at 0.
569 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
570 sftp_register(req
= fxp_stat_send(nextoutfname
));
571 rreq
= sftp_find_request(pktin
= sftp_recv());
573 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
583 * Now we're ready to recurse. Starting at ournames[i]
584 * and continuing on to the end of the list, we
585 * construct a new source and target file name, and
586 * call sftp_put_file again.
588 for (; i
< nnames
; i
++) {
589 char *nextfname
, *nextoutfname
;
593 nextfname
= dir_file_cat(fname
, ournames
[i
]);
595 nextfname
= dupstr(ournames
[i
]);
596 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
597 ret
= sftp_put_file(nextfname
, nextoutfname
, recurse
, restart
);
598 restart
= FALSE
; /* after first partial file, do full */
602 for (i
= 0; i
< nnames
; i
++) {
611 * Done this recursion level. Free everything.
613 for (i
= 0; i
< nnames
; i
++) {
621 file
= open_existing_file(fname
, NULL
, NULL
, NULL
);
623 printf("local: unable to open %s\n", fname
);
627 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
));
629 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
|
630 SSH_FXF_CREAT
| SSH_FXF_TRUNC
));
632 rreq
= sftp_find_request(pktin
= sftp_recv());
634 fh
= fxp_open_recv(pktin
, rreq
);
637 printf("%s: open for write: %s\n", outfname
, fxp_error());
643 struct fxp_attrs attrs
;
646 sftp_register(req
= fxp_fstat_send(fh
));
647 rreq
= sftp_find_request(pktin
= sftp_recv());
649 ret
= fxp_fstat_recv(pktin
, rreq
, &attrs
);
652 printf("read size of %s: %s\n", outfname
, fxp_error());
655 if (!(attrs
.flags
& SSH_FILEXFER_ATTR_SIZE
)) {
656 printf("read size of %s: size was not given\n", outfname
);
660 uint64_decimal(offset
, decbuf
);
661 printf("reput: restarting at file position %s\n", decbuf
);
663 if (seek_file((WFile
*)file
, offset
, FROM_START
) != 0)
664 seek_file((WFile
*)file
, uint64_make(0,0), FROM_END
); /* *shrug* */
666 offset
= uint64_make(0, 0);
669 printf("local:%s => remote:%s\n", fname
, outfname
);
672 * FIXME: we can use FXP_FSTAT here to get the file size, and
673 * thus put up a progress bar.
676 xfer
= xfer_upload_init(fh
, offset
);
678 while ((!err
&& !eof
) || !xfer_done(xfer
)) {
682 while (xfer_upload_ready(xfer
) && !err
&& !eof
) {
683 len
= read_from_file(file
, buffer
, sizeof(buffer
));
685 printf("error while reading local file\n");
687 } else if (len
== 0) {
690 xfer_upload_data(xfer
, buffer
, len
);
694 if (!xfer_done(xfer
)) {
696 ret
= xfer_upload_gotpkt(xfer
, pktin
);
698 printf("error while writing: %s\n", fxp_error());
706 sftp_register(req
= fxp_close_send(fh
));
707 rreq
= sftp_find_request(pktin
= sftp_recv());
709 fxp_close_recv(pktin
, rreq
);
716 /* ----------------------------------------------------------------------
717 * A remote wildcard matcher, providing a similar interface to the
718 * local one in psftp.h.
721 typedef struct SftpWildcardMatcher
{
722 struct fxp_handle
*dirh
;
723 struct fxp_names
*names
;
725 char *wildcard
, *prefix
;
726 } SftpWildcardMatcher
;
728 SftpWildcardMatcher
*sftp_begin_wildcard_matching(char *name
)
730 struct sftp_packet
*pktin
;
731 struct sftp_request
*req
, *rreq
;
733 char *unwcdir
, *tmpdir
, *cdir
;
735 SftpWildcardMatcher
*swcm
;
736 struct fxp_handle
*dirh
;
739 * We don't handle multi-level wildcards; so we expect to find
740 * a fully specified directory part, followed by a wildcard
743 wildcard
= stripslashes(name
, 0);
745 unwcdir
= dupstr(name
);
746 len
= wildcard
- name
;
748 if (len
> 0 && unwcdir
[len
-1] == '/')
749 unwcdir
[len
-1] = '\0';
750 tmpdir
= snewn(1 + len
, char);
751 check
= wc_unescape(tmpdir
, unwcdir
);
755 printf("Multiple-level wildcards are not supported\n");
760 cdir
= canonify(unwcdir
);
762 sftp_register(req
= fxp_opendir_send(cdir
));
763 rreq
= sftp_find_request(pktin
= sftp_recv());
765 dirh
= fxp_opendir_recv(pktin
, rreq
);
768 swcm
= snew(SftpWildcardMatcher
);
771 swcm
->wildcard
= dupstr(wildcard
);
772 swcm
->prefix
= unwcdir
;
774 printf("Unable to open %s: %s\n", cdir
, fxp_error());
784 char *sftp_wildcard_get_filename(SftpWildcardMatcher
*swcm
)
786 struct fxp_name
*name
;
787 struct sftp_packet
*pktin
;
788 struct sftp_request
*req
, *rreq
;
791 if (swcm
->names
&& swcm
->namepos
>= swcm
->names
->nnames
) {
792 fxp_free_names(swcm
->names
);
797 sftp_register(req
= fxp_readdir_send(swcm
->dirh
));
798 rreq
= sftp_find_request(pktin
= sftp_recv());
800 swcm
->names
= fxp_readdir_recv(pktin
, rreq
);
803 if (fxp_error_type() != SSH_FX_EOF
)
804 printf("%s: reading directory: %s\n", swcm
->prefix
,
812 assert(swcm
->names
&& swcm
->namepos
< swcm
->names
->nnames
);
814 name
= &swcm
->names
->names
[swcm
->namepos
++];
816 if (!strcmp(name
->filename
, ".") || !strcmp(name
->filename
, ".."))
817 continue; /* expected bad filenames */
819 if (!vet_filename(name
->filename
)) {
820 printf("ignoring potentially dangerous server-"
821 "supplied filename '%s'\n", name
->filename
);
822 continue; /* unexpected bad filename */
825 if (!wc_match(swcm
->wildcard
, name
->filename
))
826 continue; /* doesn't match the wildcard */
829 * We have a working filename. Return it.
831 return dupprintf("%s%s%s", swcm
->prefix
,
833 swcm
->prefix
[strlen(swcm
->prefix
)-1]=='/' ?
839 void sftp_finish_wildcard_matching(SftpWildcardMatcher
*swcm
)
841 struct sftp_packet
*pktin
;
842 struct sftp_request
*req
, *rreq
;
844 sftp_register(req
= fxp_close_send(swcm
->dirh
));
845 rreq
= sftp_find_request(pktin
= sftp_recv());
847 fxp_close_recv(pktin
, rreq
);
850 fxp_free_names(swcm
->names
);
853 sfree(swcm
->wildcard
);
859 * General function to match a potential wildcard in a filename
860 * argument and iterate over every matching file. Used in several
861 * PSFTP commands (rmdir, rm, chmod, mv).
863 int wildcard_iterate(char *filename
, int (*func
)(void *, char *), void *ctx
)
865 char *unwcfname
, *newname
, *cname
;
868 unwcfname
= snewn(strlen(filename
)+1, char);
869 is_wc
= !wc_unescape(unwcfname
, filename
);
872 SftpWildcardMatcher
*swcm
= sftp_begin_wildcard_matching(filename
);
881 while ( (newname
= sftp_wildcard_get_filename(swcm
)) != NULL
) {
882 cname
= canonify(newname
);
884 printf("%s: canonify: %s\n", newname
, fxp_error());
888 ret
&= func(ctx
, cname
);
893 /* Politely warn the user that nothing matched. */
894 printf("%s: nothing matched\n", filename
);
897 sftp_finish_wildcard_matching(swcm
);
899 cname
= canonify(unwcfname
);
901 printf("%s: canonify: %s\n", filename
, fxp_error());
904 ret
= func(ctx
, cname
);
913 * Handy helper function.
915 int is_wildcard(char *name
)
917 char *unwcfname
= snewn(strlen(name
)+1, char);
918 int is_wc
= !wc_unescape(unwcfname
, name
);
923 /* ----------------------------------------------------------------------
924 * Actual sftp commands.
926 struct sftp_command
{
928 int nwords
, wordssize
;
929 int (*obey
) (struct sftp_command
*); /* returns <0 to quit */
932 int sftp_cmd_null(struct sftp_command
*cmd
)
934 return 1; /* success */
937 int sftp_cmd_unknown(struct sftp_command
*cmd
)
939 printf("psftp: unknown command \"%s\"\n", cmd
->words
[0]);
940 return 0; /* failure */
943 int sftp_cmd_quit(struct sftp_command
*cmd
)
948 int sftp_cmd_close(struct sftp_command
*cmd
)
955 if (back
!= NULL
&& back
->connected(backhandle
)) {
957 back
->special(backhandle
, TS_EOF
);
958 sftp_recvdata(&ch
, 1);
966 * List a directory. If no arguments are given, list pwd; otherwise
967 * list the directory given in words[1].
969 int sftp_cmd_ls(struct sftp_command
*cmd
)
971 struct fxp_handle
*dirh
;
972 struct fxp_names
*names
;
973 struct fxp_name
**ournames
;
974 int nnames
, namesize
;
975 char *dir
, *cdir
, *unwcdir
, *wildcard
;
976 struct sftp_packet
*pktin
;
977 struct sftp_request
*req
, *rreq
;
990 unwcdir
= snewn(1 + strlen(dir
), char);
991 if (wc_unescape(unwcdir
, dir
)) {
998 wildcard
= stripslashes(dir
, 0);
999 unwcdir
= dupstr(dir
);
1000 len
= wildcard
- dir
;
1001 unwcdir
[len
] = '\0';
1002 if (len
> 0 && unwcdir
[len
-1] == '/')
1003 unwcdir
[len
-1] = '\0';
1004 tmpdir
= snewn(1 + len
, char);
1005 check
= wc_unescape(tmpdir
, unwcdir
);
1008 printf("Multiple-level wildcards are not supported\n");
1015 cdir
= canonify(dir
);
1017 printf("%s: canonify: %s\n", dir
, fxp_error());
1022 printf("Listing directory %s\n", cdir
);
1024 sftp_register(req
= fxp_opendir_send(cdir
));
1025 rreq
= sftp_find_request(pktin
= sftp_recv());
1026 assert(rreq
== req
);
1027 dirh
= fxp_opendir_recv(pktin
, rreq
);
1030 printf("Unable to open %s: %s\n", dir
, fxp_error());
1032 nnames
= namesize
= 0;
1037 sftp_register(req
= fxp_readdir_send(dirh
));
1038 rreq
= sftp_find_request(pktin
= sftp_recv());
1039 assert(rreq
== req
);
1040 names
= fxp_readdir_recv(pktin
, rreq
);
1042 if (names
== NULL
) {
1043 if (fxp_error_type() == SSH_FX_EOF
)
1045 printf("Reading directory %s: %s\n", dir
, fxp_error());
1048 if (names
->nnames
== 0) {
1049 fxp_free_names(names
);
1053 if (nnames
+ names
->nnames
>= namesize
) {
1054 namesize
+= names
->nnames
+ 128;
1055 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
1058 for (i
= 0; i
< names
->nnames
; i
++)
1059 if (!wildcard
|| wc_match(wildcard
, names
->names
[i
].filename
))
1060 ournames
[nnames
++] = fxp_dup_name(&names
->names
[i
]);
1062 fxp_free_names(names
);
1064 sftp_register(req
= fxp_close_send(dirh
));
1065 rreq
= sftp_find_request(pktin
= sftp_recv());
1066 assert(rreq
== req
);
1067 fxp_close_recv(pktin
, rreq
);
1070 * Now we have our filenames. Sort them by actual file
1071 * name, and then output the longname parts.
1073 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
1078 for (i
= 0; i
< nnames
; i
++) {
1079 printf("%s\n", ournames
[i
]->longname
);
1080 fxp_free_name(ournames
[i
]);
1092 * Change directories. We do this by canonifying the new name, then
1093 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1095 int sftp_cmd_cd(struct sftp_command
*cmd
)
1097 struct fxp_handle
*dirh
;
1098 struct sftp_packet
*pktin
;
1099 struct sftp_request
*req
, *rreq
;
1107 if (cmd
->nwords
< 2)
1108 dir
= dupstr(homedir
);
1110 dir
= canonify(cmd
->words
[1]);
1113 printf("%s: canonify: %s\n", dir
, fxp_error());
1117 sftp_register(req
= fxp_opendir_send(dir
));
1118 rreq
= sftp_find_request(pktin
= sftp_recv());
1119 assert(rreq
== req
);
1120 dirh
= fxp_opendir_recv(pktin
, rreq
);
1123 printf("Directory %s: %s\n", dir
, fxp_error());
1128 sftp_register(req
= fxp_close_send(dirh
));
1129 rreq
= sftp_find_request(pktin
= sftp_recv());
1130 assert(rreq
== req
);
1131 fxp_close_recv(pktin
, rreq
);
1135 printf("Remote directory is now %s\n", pwd
);
1141 * Print current directory. Easy as pie.
1143 int sftp_cmd_pwd(struct sftp_command
*cmd
)
1150 printf("Remote directory is %s\n", pwd
);
1155 * Get a file and save it at the local end. We have three very
1156 * similar commands here. The basic one is `get'; `reget' differs
1157 * in that it checks for the existence of the destination file and
1158 * starts from where a previous aborted transfer left off; `mget'
1159 * differs in that it interprets all its arguments as files to
1160 * transfer (never as a different local name for a remote file) and
1161 * can handle wildcards.
1163 int sftp_general_get(struct sftp_command
*cmd
, int restart
, int multiple
)
1165 char *fname
, *unwcfname
, *origfname
, *origwfname
, *outfname
;
1167 int recurse
= FALSE
;
1175 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1176 if (!strcmp(cmd
->words
[i
], "--")) {
1177 /* finish processing options */
1180 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1183 printf("%s: unrecognised option '%s'\n", cmd
->words
[0], cmd
->words
[i
]);
1189 if (i
>= cmd
->nwords
) {
1190 printf("%s: expects a filename\n", cmd
->words
[0]);
1196 SftpWildcardMatcher
*swcm
;
1198 origfname
= cmd
->words
[i
++];
1199 unwcfname
= snewn(strlen(origfname
)+1, char);
1201 if (multiple
&& !wc_unescape(unwcfname
, origfname
)) {
1202 swcm
= sftp_begin_wildcard_matching(origfname
);
1207 origwfname
= sftp_wildcard_get_filename(swcm
);
1209 /* Politely warn the user that nothing matched. */
1210 printf("%s: nothing matched\n", origfname
);
1211 sftp_finish_wildcard_matching(swcm
);
1216 origwfname
= origfname
;
1220 while (origwfname
) {
1221 fname
= canonify(origwfname
);
1224 printf("%s: canonify: %s\n", origwfname
, fxp_error());
1229 if (!multiple
&& i
< cmd
->nwords
)
1230 outfname
= cmd
->words
[i
++];
1232 outfname
= stripslashes(origwfname
, 0);
1234 ret
= sftp_get_file(fname
, outfname
, recurse
, restart
);
1240 origwfname
= sftp_wildcard_get_filename(swcm
);
1247 sftp_finish_wildcard_matching(swcm
);
1251 } while (multiple
&& i
< cmd
->nwords
);
1255 int sftp_cmd_get(struct sftp_command
*cmd
)
1257 return sftp_general_get(cmd
, 0, 0);
1259 int sftp_cmd_mget(struct sftp_command
*cmd
)
1261 return sftp_general_get(cmd
, 0, 1);
1263 int sftp_cmd_reget(struct sftp_command
*cmd
)
1265 return sftp_general_get(cmd
, 1, 0);
1269 * Send a file and store it at the remote end. We have three very
1270 * similar commands here. The basic one is `put'; `reput' differs
1271 * in that it checks for the existence of the destination file and
1272 * starts from where a previous aborted transfer left off; `mput'
1273 * differs in that it interprets all its arguments as files to
1274 * transfer (never as a different remote name for a local file) and
1275 * can handle wildcards.
1277 int sftp_general_put(struct sftp_command
*cmd
, int restart
, int multiple
)
1279 char *fname
, *wfname
, *origoutfname
, *outfname
;
1281 int recurse
= FALSE
;
1289 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1290 if (!strcmp(cmd
->words
[i
], "--")) {
1291 /* finish processing options */
1294 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1297 printf("%s: unrecognised option '%s'\n", cmd
->words
[0], cmd
->words
[i
]);
1303 if (i
>= cmd
->nwords
) {
1304 printf("%s: expects a filename\n", cmd
->words
[0]);
1310 WildcardMatcher
*wcm
;
1311 fname
= cmd
->words
[i
++];
1313 if (multiple
&& test_wildcard(fname
, FALSE
) == WCTYPE_WILDCARD
) {
1314 wcm
= begin_wildcard_matching(fname
);
1315 wfname
= wildcard_get_filename(wcm
);
1317 /* Politely warn the user that nothing matched. */
1318 printf("%s: nothing matched\n", fname
);
1319 finish_wildcard_matching(wcm
);
1328 if (!multiple
&& i
< cmd
->nwords
)
1329 origoutfname
= cmd
->words
[i
++];
1331 origoutfname
= stripslashes(wfname
, 1);
1333 outfname
= canonify(origoutfname
);
1335 printf("%s: canonify: %s\n", origoutfname
, fxp_error());
1338 finish_wildcard_matching(wcm
);
1342 ret
= sftp_put_file(wfname
, outfname
, recurse
, restart
);
1347 wfname
= wildcard_get_filename(wcm
);
1354 finish_wildcard_matching(wcm
);
1359 } while (multiple
&& i
< cmd
->nwords
);
1363 int sftp_cmd_put(struct sftp_command
*cmd
)
1365 return sftp_general_put(cmd
, 0, 0);
1367 int sftp_cmd_mput(struct sftp_command
*cmd
)
1369 return sftp_general_put(cmd
, 0, 1);
1371 int sftp_cmd_reput(struct sftp_command
*cmd
)
1373 return sftp_general_put(cmd
, 1, 0);
1376 int sftp_cmd_mkdir(struct sftp_command
*cmd
)
1379 struct sftp_packet
*pktin
;
1380 struct sftp_request
*req
, *rreq
;
1389 if (cmd
->nwords
< 2) {
1390 printf("mkdir: expects a directory\n");
1395 for (i
= 1; i
< cmd
->nwords
; i
++) {
1396 dir
= canonify(cmd
->words
[i
]);
1398 printf("%s: canonify: %s\n", dir
, fxp_error());
1402 sftp_register(req
= fxp_mkdir_send(dir
));
1403 rreq
= sftp_find_request(pktin
= sftp_recv());
1404 assert(rreq
== req
);
1405 result
= fxp_mkdir_recv(pktin
, rreq
);
1408 printf("mkdir %s: %s\n", dir
, fxp_error());
1411 printf("mkdir %s: OK\n", dir
);
1419 static int sftp_action_rmdir(void *vctx
, char *dir
)
1421 struct sftp_packet
*pktin
;
1422 struct sftp_request
*req
, *rreq
;
1425 sftp_register(req
= fxp_rmdir_send(dir
));
1426 rreq
= sftp_find_request(pktin
= sftp_recv());
1427 assert(rreq
== req
);
1428 result
= fxp_rmdir_recv(pktin
, rreq
);
1431 printf("rmdir %s: %s\n", dir
, fxp_error());
1435 printf("rmdir %s: OK\n", dir
);
1440 int sftp_cmd_rmdir(struct sftp_command
*cmd
)
1449 if (cmd
->nwords
< 2) {
1450 printf("rmdir: expects a directory\n");
1455 for (i
= 1; i
< cmd
->nwords
; i
++)
1456 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_rmdir
, NULL
);
1461 static int sftp_action_rm(void *vctx
, char *fname
)
1463 struct sftp_packet
*pktin
;
1464 struct sftp_request
*req
, *rreq
;
1467 sftp_register(req
= fxp_remove_send(fname
));
1468 rreq
= sftp_find_request(pktin
= sftp_recv());
1469 assert(rreq
== req
);
1470 result
= fxp_remove_recv(pktin
, rreq
);
1473 printf("rm %s: %s\n", fname
, fxp_error());
1477 printf("rm %s: OK\n", fname
);
1482 int sftp_cmd_rm(struct sftp_command
*cmd
)
1491 if (cmd
->nwords
< 2) {
1492 printf("rm: expects a filename\n");
1497 for (i
= 1; i
< cmd
->nwords
; i
++)
1498 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_rm
, NULL
);
1503 static int check_is_dir(char *dstfname
)
1505 struct sftp_packet
*pktin
;
1506 struct sftp_request
*req
, *rreq
;
1507 struct fxp_attrs attrs
;
1510 sftp_register(req
= fxp_stat_send(dstfname
));
1511 rreq
= sftp_find_request(pktin
= sftp_recv());
1512 assert(rreq
== req
);
1513 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1516 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
1517 (attrs
.permissions
& 0040000))
1523 struct sftp_context_mv
{
1528 static int sftp_action_mv(void *vctx
, char *srcfname
)
1530 struct sftp_context_mv
*ctx
= (struct sftp_context_mv
*)vctx
;
1531 struct sftp_packet
*pktin
;
1532 struct sftp_request
*req
, *rreq
;
1534 char *finalfname
, *newcanon
= NULL
;
1537 if (ctx
->dest_is_dir
) {
1541 p
= srcfname
+ strlen(srcfname
);
1542 while (p
> srcfname
&& p
[-1] != '/') p
--;
1543 newname
= dupcat(ctx
->dstfname
, "/", p
, NULL
);
1544 newcanon
= canonify(newname
);
1546 printf("%s: canonify: %s\n", newname
, fxp_error());
1552 finalfname
= newcanon
;
1554 finalfname
= ctx
->dstfname
;
1557 sftp_register(req
= fxp_rename_send(srcfname
, finalfname
));
1558 rreq
= sftp_find_request(pktin
= sftp_recv());
1559 assert(rreq
== req
);
1560 result
= fxp_rename_recv(pktin
, rreq
);
1562 error
= result ? NULL
: fxp_error();
1565 printf("mv %s %s: %s\n", srcfname
, finalfname
, error
);
1568 printf("%s -> %s\n", srcfname
, finalfname
);
1576 int sftp_cmd_mv(struct sftp_command
*cmd
)
1578 struct sftp_context_mv actx
, *ctx
= &actx
;
1586 if (cmd
->nwords
< 3) {
1587 printf("mv: expects two filenames\n");
1591 ctx
->dstfname
= canonify(cmd
->words
[cmd
->nwords
-1]);
1592 if (!ctx
->dstfname
) {
1593 printf("%s: canonify: %s\n", ctx
->dstfname
, fxp_error());
1598 * If there's more than one source argument, or one source
1599 * argument which is a wildcard, we _require_ that the
1600 * destination is a directory.
1602 ctx
->dest_is_dir
= check_is_dir(ctx
->dstfname
);
1603 if ((cmd
->nwords
> 3 || is_wildcard(cmd
->words
[1])) && !ctx
->dest_is_dir
) {
1604 printf("mv: multiple or wildcard arguments require the destination"
1605 " to be a directory\n");
1606 sfree(ctx
->dstfname
);
1611 * Now iterate over the source arguments.
1614 for (i
= 1; i
< cmd
->nwords
-1; i
++)
1615 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_mv
, ctx
);
1617 sfree(ctx
->dstfname
);
1621 struct sftp_context_chmod
{
1622 unsigned attrs_clr
, attrs_xor
;
1625 static int sftp_action_chmod(void *vctx
, char *fname
)
1627 struct fxp_attrs attrs
;
1628 struct sftp_packet
*pktin
;
1629 struct sftp_request
*req
, *rreq
;
1631 unsigned oldperms
, newperms
;
1632 struct sftp_context_chmod
*ctx
= (struct sftp_context_chmod
*)vctx
;
1634 sftp_register(req
= fxp_stat_send(fname
));
1635 rreq
= sftp_find_request(pktin
= sftp_recv());
1636 assert(rreq
== req
);
1637 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1639 if (!result
|| !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
)) {
1640 printf("get attrs for %s: %s\n", fname
,
1641 result ?
"file permissions not provided" : fxp_error());
1645 attrs
.flags
= SSH_FILEXFER_ATTR_PERMISSIONS
; /* perms _only_ */
1646 oldperms
= attrs
.permissions
& 07777;
1647 attrs
.permissions
&= ~ctx
->attrs_clr
;
1648 attrs
.permissions
^= ctx
->attrs_xor
;
1649 newperms
= attrs
.permissions
& 07777;
1651 if (oldperms
== newperms
)
1652 return 1; /* no need to do anything! */
1654 sftp_register(req
= fxp_setstat_send(fname
, attrs
));
1655 rreq
= sftp_find_request(pktin
= sftp_recv());
1656 assert(rreq
== req
);
1657 result
= fxp_setstat_recv(pktin
, rreq
);
1660 printf("set attrs for %s: %s\n", fname
, fxp_error());
1664 printf("%s: %04o -> %04o\n", fname
, oldperms
, newperms
);
1669 int sftp_cmd_chmod(struct sftp_command
*cmd
)
1673 struct sftp_context_chmod actx
, *ctx
= &actx
;
1680 if (cmd
->nwords
< 3) {
1681 printf("chmod: expects a mode specifier and a filename\n");
1686 * Attempt to parse the mode specifier in cmd->words[1]. We
1687 * don't support the full horror of Unix chmod; instead we
1688 * support a much simpler syntax in which the user can either
1689 * specify an octal number, or a comma-separated sequence of
1690 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1691 * _only_ be omitted if the only attribute mentioned is t,
1692 * since all others require a user/group/other specification.
1693 * Additionally, the s attribute may not be specified for any
1694 * [ugoa] specifications other than exactly u or exactly g.
1696 ctx
->attrs_clr
= ctx
->attrs_xor
= 0;
1697 mode
= cmd
->words
[1];
1698 if (mode
[0] >= '0' && mode
[0] <= '9') {
1699 if (mode
[strspn(mode
, "01234567")]) {
1700 printf("chmod: numeric file modes should"
1701 " contain digits 0-7 only\n");
1704 ctx
->attrs_clr
= 07777;
1705 sscanf(mode
, "%o", &ctx
->attrs_xor
);
1706 ctx
->attrs_xor
&= ctx
->attrs_clr
;
1709 char *modebegin
= mode
;
1710 unsigned subset
, perms
;
1714 while (*mode
&& *mode
!= ',' &&
1715 *mode
!= '+' && *mode
!= '-' && *mode
!= '=') {
1717 case 'u': subset
|= 04700; break; /* setuid, user perms */
1718 case 'g': subset
|= 02070; break; /* setgid, group perms */
1719 case 'o': subset
|= 00007; break; /* just other perms */
1720 case 'a': subset
|= 06777; break; /* all of the above */
1722 printf("chmod: file mode '%.*s' contains unrecognised"
1723 " user/group/other specifier '%c'\n",
1724 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1729 if (!*mode
|| *mode
== ',') {
1730 printf("chmod: file mode '%.*s' is incomplete\n",
1731 (int)strcspn(modebegin
, ","), modebegin
);
1735 if (!*mode
|| *mode
== ',') {
1736 printf("chmod: file mode '%.*s' is incomplete\n",
1737 (int)strcspn(modebegin
, ","), modebegin
);
1741 while (*mode
&& *mode
!= ',') {
1743 case 'r': perms
|= 00444; break;
1744 case 'w': perms
|= 00222; break;
1745 case 'x': perms
|= 00111; break;
1746 case 't': perms
|= 01000; subset
|= 01000; break;
1748 if ((subset
& 06777) != 04700 &&
1749 (subset
& 06777) != 02070) {
1750 printf("chmod: file mode '%.*s': set[ug]id bit should"
1751 " be used with exactly one of u or g only\n",
1752 (int)strcspn(modebegin
, ","), modebegin
);
1758 printf("chmod: file mode '%.*s' contains unrecognised"
1759 " permission specifier '%c'\n",
1760 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1765 if (!(subset
& 06777) && (perms
&~ subset
)) {
1766 printf("chmod: file mode '%.*s' contains no user/group/other"
1767 " specifier and permissions other than 't' \n",
1768 (int)strcspn(modebegin
, ","), modebegin
);
1774 ctx
->attrs_clr
|= perms
;
1775 ctx
->attrs_xor
|= perms
;
1778 ctx
->attrs_clr
|= perms
;
1779 ctx
->attrs_xor
&= ~perms
;
1782 ctx
->attrs_clr
|= subset
;
1783 ctx
->attrs_xor
|= perms
;
1786 if (*mode
) mode
++; /* eat comma */
1791 for (i
= 2; i
< cmd
->nwords
; i
++)
1792 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_chmod
, ctx
);
1797 static int sftp_cmd_open(struct sftp_command
*cmd
)
1802 printf("psftp: already connected\n");
1806 if (cmd
->nwords
< 2) {
1807 printf("open: expects a host name\n");
1811 if (cmd
->nwords
> 2) {
1812 portnumber
= atoi(cmd
->words
[2]);
1813 if (portnumber
== 0) {
1814 printf("open: invalid port number\n");
1820 if (psftp_connect(cmd
->words
[1], NULL
, portnumber
)) {
1821 back
= NULL
; /* connection is already closed */
1822 return -1; /* this is fatal */
1828 static int sftp_cmd_lcd(struct sftp_command
*cmd
)
1830 char *currdir
, *errmsg
;
1832 if (cmd
->nwords
< 2) {
1833 printf("lcd: expects a local directory name\n");
1837 errmsg
= psftp_lcd(cmd
->words
[1]);
1839 printf("lcd: unable to change directory: %s\n", errmsg
);
1844 currdir
= psftp_getcwd();
1845 printf("New local directory is %s\n", currdir
);
1851 static int sftp_cmd_lpwd(struct sftp_command
*cmd
)
1855 currdir
= psftp_getcwd();
1856 printf("Current local directory is %s\n", currdir
);
1862 static int sftp_cmd_pling(struct sftp_command
*cmd
)
1866 exitcode
= system(cmd
->words
[1]);
1867 return (exitcode
== 0);
1870 static int sftp_cmd_help(struct sftp_command
*cmd
);
1872 static struct sftp_cmd_lookup
{
1875 * For help purposes, there are two kinds of command:
1877 * - primary commands, in which `longhelp' is non-NULL. In
1878 * this case `shorthelp' is descriptive text, and `longhelp'
1879 * is longer descriptive text intended to be printed after
1882 * - alias commands, in which `longhelp' is NULL. In this case
1883 * `shorthelp' is the name of a primary command, which
1884 * contains the help that should double up for this command.
1886 int listed
; /* do we list this in primary help? */
1889 int (*obey
) (struct sftp_command
*);
1892 * List of sftp commands. This is binary-searched so it MUST be
1896 "!", TRUE
, "run a local command",
1898 /* FIXME: this example is crap for non-Windows. */
1899 " Runs a local command. For example, \"!del myfile\".\n",
1903 "bye", TRUE
, "finish your SFTP session",
1905 " Terminates your SFTP session and quits the PSFTP program.\n",
1909 "cd", TRUE
, "change your remote working directory",
1910 " [ <new working directory> ]\n"
1911 " Change the remote working directory for your SFTP session.\n"
1912 " If a new working directory is not supplied, you will be\n"
1913 " returned to your home directory.\n",
1917 "chmod", TRUE
, "change file permissions and modes",
1918 " <modes> <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1919 " Change the file permissions on one or more remote files or\n"
1921 " <modes> can be any octal Unix permission specifier.\n"
1922 " Alternatively, <modes> can include the following modifiers:\n"
1923 " u+r make file readable by owning user\n"
1924 " u+w make file writable by owning user\n"
1925 " u+x make file executable by owning user\n"
1926 " u-r make file not readable by owning user\n"
1927 " [also u-w, u-x]\n"
1928 " g+r make file readable by members of owning group\n"
1929 " [also g+w, g+x, g-r, g-w, g-x]\n"
1930 " o+r make file readable by all other users\n"
1931 " [also o+w, o+x, o-r, o-w, o-x]\n"
1932 " a+r make file readable by absolutely everybody\n"
1933 " [also a+w, a+x, a-r, a-w, a-x]\n"
1934 " u+s enable the Unix set-user-ID bit\n"
1935 " u-s disable the Unix set-user-ID bit\n"
1936 " g+s enable the Unix set-group-ID bit\n"
1937 " g-s disable the Unix set-group-ID bit\n"
1938 " +t enable the Unix \"sticky bit\"\n"
1939 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1940 " more than one user for the same modifier (\"ug+w\"). You can\n"
1941 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1945 "close", TRUE
, "finish your SFTP session but do not quit PSFTP",
1947 " Terminates your SFTP session, but does not quit the PSFTP\n"
1948 " program. You can then use \"open\" to start another SFTP\n"
1949 " session, to the same server or to a different one.\n",
1953 "del", TRUE
, "delete files on the remote server",
1954 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1955 " Delete a file or files from the server.\n",
1959 "delete", FALSE
, "del", NULL
, sftp_cmd_rm
1962 "dir", TRUE
, "list remote files",
1963 " [ <directory-name> ]/[ <wildcard> ]\n"
1964 " List the contents of a specified directory on the server.\n"
1965 " If <directory-name> is not given, the current working directory\n"
1967 " If <wildcard> is given, it is treated as a set of files to\n"
1968 " list; otherwise, all files are listed.\n",
1972 "exit", TRUE
, "bye", NULL
, sftp_cmd_quit
1975 "get", TRUE
, "download a file from the server to your local machine",
1976 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1977 " Downloads a file on the server and stores it locally under\n"
1978 " the same name, or under a different one if you supply the\n"
1979 " argument <local-filename>.\n"
1980 " If -r specified, recursively fetch a directory.\n",
1984 "help", TRUE
, "give help",
1985 " [ <command> [ <command> ... ] ]\n"
1986 " Give general help if no commands are specified.\n"
1987 " If one or more commands are specified, give specific help on\n"
1988 " those particular commands.\n",
1992 "lcd", TRUE
, "change local working directory",
1993 " <local-directory-name>\n"
1994 " Change the local working directory of the PSFTP program (the\n"
1995 " default location where the \"get\" command will save files).\n",
1999 "lpwd", TRUE
, "print local working directory",
2001 " Print the local working directory of the PSFTP program (the\n"
2002 " default location where the \"get\" command will save files).\n",
2006 "ls", TRUE
, "dir", NULL
,
2010 "mget", TRUE
, "download multiple files at once",
2011 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2012 " Downloads many files from the server, storing each one under\n"
2013 " the same name it has on the server side. You can use wildcards\n"
2014 " such as \"*.c\" to specify lots of files at once.\n"
2015 " If -r specified, recursively fetch files and directories.\n",
2019 "mkdir", TRUE
, "create directories on the remote server",
2020 " <directory-name> [ <directory-name>... ]\n"
2021 " Creates directories with the given names on the server.\n",
2025 "mput", TRUE
, "upload multiple files at once",
2026 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2027 " Uploads many files to the server, storing each one under the\n"
2028 " same name it has on the client side. You can use wildcards\n"
2029 " such as \"*.c\" to specify lots of files at once.\n"
2030 " If -r specified, recursively store files and directories.\n",
2034 "mv", TRUE
, "move or rename file(s) on the remote server",
2035 " <source> [ <source>... ] <destination>\n"
2036 " Moves or renames <source>(s) on the server to <destination>,\n"
2037 " also on the server.\n"
2038 " If <destination> specifies an existing directory, then <source>\n"
2039 " may be a wildcard, and multiple <source>s may be given; all\n"
2040 " source files are moved into <destination>.\n"
2041 " Otherwise, <source> must specify a single file, which is moved\n"
2042 " or renamed so that it is accessible under the name <destination>.\n",
2046 "open", TRUE
, "connect to a host",
2047 " [<user>@]<hostname> [<port>]\n"
2048 " Establishes an SFTP connection to a given host. Only usable\n"
2049 " when you are not already connected to a server.\n",
2053 "put", TRUE
, "upload a file from your local machine to the server",
2054 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2055 " Uploads a file to the server and stores it there under\n"
2056 " the same name, or under a different one if you supply the\n"
2057 " argument <remote-filename>.\n"
2058 " If -r specified, recursively store a directory.\n",
2062 "pwd", TRUE
, "print your remote working directory",
2064 " Print the current remote working directory for your SFTP session.\n",
2068 "quit", TRUE
, "bye", NULL
,
2072 "reget", TRUE
, "continue downloading files",
2073 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2074 " Works exactly like the \"get\" command, but the local file\n"
2075 " must already exist. The download will begin at the end of the\n"
2076 " file. This is for resuming a download that was interrupted.\n"
2077 " If -r specified, resume interrupted \"get -r\".\n",
2081 "ren", TRUE
, "mv", NULL
,
2085 "rename", FALSE
, "mv", NULL
,
2089 "reput", TRUE
, "continue uploading files",
2090 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2091 " Works exactly like the \"put\" command, but the remote file\n"
2092 " must already exist. The upload will begin at the end of the\n"
2093 " file. This is for resuming an upload that was interrupted.\n"
2094 " If -r specified, resume interrupted \"put -r\".\n",
2098 "rm", TRUE
, "del", NULL
,
2102 "rmdir", TRUE
, "remove directories on the remote server",
2103 " <directory-name> [ <directory-name>... ]\n"
2104 " Removes the directory with the given name on the server.\n"
2105 " The directory will not be removed unless it is empty.\n"
2106 " Wildcards may be used to specify multiple directories.\n",
2111 const struct sftp_cmd_lookup
*lookup_command(char *name
)
2116 j
= sizeof(sftp_lookup
) / sizeof(*sftp_lookup
);
2119 cmp
= strcmp(name
, sftp_lookup
[k
].name
);
2125 return &sftp_lookup
[k
];
2131 static int sftp_cmd_help(struct sftp_command
*cmd
)
2134 if (cmd
->nwords
== 1) {
2136 * Give short help on each command.
2140 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
2142 if (!sftp_lookup
[i
].listed
)
2144 len
= strlen(sftp_lookup
[i
].name
);
2148 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
2149 const struct sftp_cmd_lookup
*lookup
;
2150 if (!sftp_lookup
[i
].listed
)
2152 lookup
= &sftp_lookup
[i
];
2153 printf("%-*s", maxlen
+2, lookup
->name
);
2154 if (lookup
->longhelp
== NULL
)
2155 lookup
= lookup_command(lookup
->shorthelp
);
2156 printf("%s\n", lookup
->shorthelp
);
2160 * Give long help on specific commands.
2162 for (i
= 1; i
< cmd
->nwords
; i
++) {
2163 const struct sftp_cmd_lookup
*lookup
;
2164 lookup
= lookup_command(cmd
->words
[i
]);
2166 printf("help: %s: command not found\n", cmd
->words
[i
]);
2168 printf("%s", lookup
->name
);
2169 if (lookup
->longhelp
== NULL
)
2170 lookup
= lookup_command(lookup
->shorthelp
);
2171 printf("%s", lookup
->longhelp
);
2178 /* ----------------------------------------------------------------------
2179 * Command line reading and parsing.
2181 struct sftp_command
*sftp_getcmd(FILE *fp
, int mode
, int modeflags
)
2184 struct sftp_command
*cmd
;
2188 cmd
= snew(struct sftp_command
);
2198 line
= fgetline(fp
);
2200 line
= ssh_sftp_get_cmdline("psftp> ", back
== NULL
);
2203 if (!line
|| !*line
) {
2204 cmd
->obey
= sftp_cmd_quit
;
2205 if ((mode
== 0) || (modeflags
& 1))
2207 return cmd
; /* eof */
2210 line
[strcspn(line
, "\r\n")] = '\0';
2212 if (modeflags
& 1) {
2213 printf("%s\n", line
);
2217 while (*p
&& (*p
== ' ' || *p
== '\t'))
2222 * Special case: the ! command. This is always parsed as
2223 * exactly two words: one containing the !, and the second
2224 * containing everything else on the line.
2226 cmd
->nwords
= cmd
->wordssize
= 2;
2227 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
2228 cmd
->words
[0] = dupstr("!");
2229 cmd
->words
[1] = dupstr(p
+1);
2233 * Parse the command line into words. The syntax is:
2234 * - double quotes are removed, but cause spaces within to be
2235 * treated as non-separating.
2236 * - a double-doublequote pair is a literal double quote, inside
2237 * _or_ outside quotes. Like this:
2239 * firstword "second word" "this has ""quotes"" in" and""this""
2245 * >this has "quotes" in<
2249 /* skip whitespace */
2250 while (*p
&& (*p
== ' ' || *p
== '\t'))
2252 /* mark start of word */
2253 q
= r
= p
; /* q sits at start, r writes word */
2256 if (!quoting
&& (*p
== ' ' || *p
== '\t'))
2257 break; /* reached end of word */
2258 else if (*p
== '"' && p
[1] == '"')
2259 p
+= 2, *r
++ = '"'; /* a literal quote */
2261 p
++, quoting
= !quoting
;
2266 p
++; /* skip over the whitespace */
2268 if (cmd
->nwords
>= cmd
->wordssize
) {
2269 cmd
->wordssize
= cmd
->nwords
+ 16;
2270 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
2272 cmd
->words
[cmd
->nwords
++] = dupstr(q
);
2279 * Now parse the first word and assign a function.
2282 if (cmd
->nwords
== 0)
2283 cmd
->obey
= sftp_cmd_null
;
2285 const struct sftp_cmd_lookup
*lookup
;
2286 lookup
= lookup_command(cmd
->words
[0]);
2288 cmd
->obey
= sftp_cmd_unknown
;
2290 cmd
->obey
= lookup
->obey
;
2296 static int do_sftp_init(void)
2298 struct sftp_packet
*pktin
;
2299 struct sftp_request
*req
, *rreq
;
2302 * Do protocol initialisation.
2306 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2307 return 1; /* failure */
2311 * Find out where our home directory is.
2313 sftp_register(req
= fxp_realpath_send("."));
2314 rreq
= sftp_find_request(pktin
= sftp_recv());
2315 assert(rreq
== req
);
2316 homedir
= fxp_realpath_recv(pktin
, rreq
);
2320 "Warning: failed to resolve home directory: %s\n",
2322 homedir
= dupstr(".");
2324 printf("Remote working directory is %s\n", homedir
);
2326 pwd
= dupstr(homedir
);
2330 void do_sftp_cleanup()
2334 back
->special(backhandle
, TS_EOF
);
2335 sftp_recvdata(&ch
, 1);
2336 back
->free(backhandle
);
2337 sftp_cleanup_request();
2351 void do_sftp(int mode
, int modeflags
, char *batchfile
)
2361 /* ------------------------------------------------------------------
2362 * Now we're ready to do Real Stuff.
2365 struct sftp_command
*cmd
;
2366 cmd
= sftp_getcmd(NULL
, 0, 0);
2369 ret
= cmd
->obey(cmd
);
2372 for(i
= 0; i
< cmd
->nwords
; i
++)
2373 sfree(cmd
->words
[i
]);
2381 fp
= fopen(batchfile
, "r");
2383 printf("Fatal: unable to open %s\n", batchfile
);
2387 struct sftp_command
*cmd
;
2388 cmd
= sftp_getcmd(fp
, mode
, modeflags
);
2391 ret
= cmd
->obey(cmd
);
2395 if (!(modeflags
& 2))
2404 /* ----------------------------------------------------------------------
2405 * Dirty bits: integration with PuTTY.
2408 static int verbose
= 0;
2411 * Print an error message and perform a fatal exit.
2413 void fatalbox(char *fmt
, ...)
2418 str
= dupvprintf(fmt
, ap
);
2419 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2422 fputs(str2
, stderr
);
2427 void modalfatalbox(char *fmt
, ...)
2432 str
= dupvprintf(fmt
, ap
);
2433 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2436 fputs(str2
, stderr
);
2441 void connection_fatal(void *frontend
, char *fmt
, ...)
2446 str
= dupvprintf(fmt
, ap
);
2447 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2450 fputs(str2
, stderr
);
2456 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
)
2459 * This is only here because of the calls to ldisc_send(NULL,
2460 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2461 * ldisc as an ldisc. So if we get called with any real data, I
2462 * want to know about it.
2468 * In psftp, all agent requests should be synchronous, so this is a
2469 * never-called stub.
2471 void agent_schedule_callback(void (*callback
)(void *, void *, int),
2472 void *callback_ctx
, void *data
, int len
)
2474 assert(!"We shouldn't be here");
2478 * Receive a block of data from the SSH link. Block until all data
2481 * To do this, we repeatedly call the SSH protocol module, with our
2482 * own trap in from_backend() to catch the data that comes back. We
2483 * do this until we have enough data.
2486 static unsigned char *outptr
; /* where to put the data */
2487 static unsigned outlen
; /* how much data required */
2488 static unsigned char *pending
= NULL
; /* any spare data */
2489 static unsigned pendlen
= 0, pendsize
= 0; /* length and phys. size of buffer */
2490 int from_backend(void *frontend
, int is_stderr
, const char *data
, int datalen
)
2492 unsigned char *p
= (unsigned char *) data
;
2493 unsigned len
= (unsigned) datalen
;
2496 * stderr data is just spouted to local stderr and otherwise
2501 fwrite(data
, 1, len
, stderr
);
2506 * If this is before the real session begins, just return.
2511 if ((outlen
> 0) && (len
> 0)) {
2512 unsigned used
= outlen
;
2515 memcpy(outptr
, p
, used
);
2523 if (pendsize
< pendlen
+ len
) {
2524 pendsize
= pendlen
+ len
+ 4096;
2525 pending
= sresize(pending
, pendsize
, unsigned char);
2527 memcpy(pending
+ pendlen
, p
, len
);
2533 int from_backend_untrusted(void *frontend_handle
, const char *data
, int len
)
2536 * No "untrusted" output should get here (the way the code is
2537 * currently, it's all diverted by FLAG_STDERR).
2539 assert(!"Unexpected call to from_backend_untrusted()");
2540 return 0; /* not reached */
2542 int sftp_recvdata(char *buf
, int len
)
2544 outptr
= (unsigned char *) buf
;
2548 * See if the pending-input block contains some of what we
2552 unsigned pendused
= pendlen
;
2553 if (pendused
> outlen
)
2555 memcpy(outptr
, pending
, pendused
);
2556 memmove(pending
, pending
+ pendused
, pendlen
- pendused
);
2559 pendlen
-= pendused
;
2569 while (outlen
> 0) {
2570 if (back
->exitcode(backhandle
) >= 0 || ssh_sftp_loop_iteration() < 0)
2571 return 0; /* doom */
2576 int sftp_senddata(char *buf
, int len
)
2578 back
->send(backhandle
, buf
, len
);
2583 * Short description of parameters.
2585 static void usage(void)
2587 printf("PuTTY Secure File Transfer (SFTP) client\n");
2588 printf("%s\n", ver
);
2589 printf("Usage: psftp [options] [user@]host\n");
2590 printf("Options:\n");
2591 printf(" -V print version information and exit\n");
2592 printf(" -pgpfp print PGP key fingerprints and exit\n");
2593 printf(" -b file use specified batchfile\n");
2594 printf(" -bc output batchfile commands\n");
2595 printf(" -be don't stop batchfile processing if errors\n");
2596 printf(" -v show verbose messages\n");
2597 printf(" -load sessname Load settings from saved session\n");
2598 printf(" -l user connect with specified username\n");
2599 printf(" -P port connect to specified port\n");
2600 printf(" -pw passw login with specified password\n");
2601 printf(" -1 -2 force use of particular SSH protocol version\n");
2602 printf(" -4 -6 force use of IPv4 or IPv6\n");
2603 printf(" -C enable compression\n");
2604 printf(" -i key private key file for authentication\n");
2605 printf(" -noagent disable use of Pageant\n");
2606 printf(" -agent enable use of Pageant\n");
2607 printf(" -batch disable all interactive prompts\n");
2611 static void version(void)
2613 printf("psftp: %s\n", ver
);
2618 * Connect to a host.
2620 static int psftp_connect(char *userhost
, char *user
, int portnumber
)
2622 char *host
, *realhost
;
2626 /* Separate host and username */
2628 host
= strrchr(host
, '@');
2634 printf("psftp: multiple usernames specified; using \"%s\"\n",
2641 * If we haven't loaded session details already (e.g., from -load),
2642 * try looking for a session called "host".
2644 if (!loaded_session
) {
2645 /* Try to load settings for `host' into a temporary config */
2647 cfg2
.host
[0] = '\0';
2648 do_defaults(host
, &cfg2
);
2649 if (cfg2
.host
[0] != '\0') {
2650 /* Settings present and include hostname */
2651 /* Re-load data into the real config. */
2652 do_defaults(host
, &cfg
);
2654 /* Session doesn't exist or mention a hostname. */
2655 /* Use `host' as a bare hostname. */
2656 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
2657 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
2660 /* Patch in hostname `host' to session details. */
2661 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
2662 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
2666 * Force use of SSH. (If they got the protocol wrong we assume the
2667 * port is useless too.)
2669 if (cfg
.protocol
!= PROT_SSH
) {
2670 cfg
.protocol
= PROT_SSH
;
2675 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2676 * then change it to SSH-2, on the grounds that that's more likely to
2677 * work for SFTP. (Can be overridden with `-1' option.)
2678 * But if it says `2 only' or `2', respect which.
2680 if (cfg
.sshprot
!= 2 && cfg
.sshprot
!= 3)
2684 * Enact command-line overrides.
2686 cmdline_run_saved(&cfg
);
2689 * Trim leading whitespace off the hostname if it's there.
2692 int space
= strspn(cfg
.host
, " \t");
2693 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
2696 /* See if host is of the form user@host */
2697 if (cfg
.host
[0] != '\0') {
2698 char *atsign
= strrchr(cfg
.host
, '@');
2699 /* Make sure we're not overflowing the user field */
2701 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
2702 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
2703 cfg
.username
[atsign
- cfg
.host
] = '\0';
2705 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
2710 * Trim a colon suffix off the hostname if it's there.
2712 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
2715 * Remove any remaining whitespace from the hostname.
2719 while (cfg
.host
[p2
] != '\0') {
2720 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
2721 cfg
.host
[p1
] = cfg
.host
[p2
];
2726 cfg
.host
[p1
] = '\0';
2730 if (user
!= NULL
&& user
[0] != '\0') {
2731 strncpy(cfg
.username
, user
, sizeof(cfg
.username
) - 1);
2732 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
2736 cfg
.port
= portnumber
;
2739 * Disable scary things which shouldn't be enabled for simple
2740 * things like SCP and SFTP: agent forwarding, port forwarding,
2743 cfg
.x11_forward
= 0;
2745 cfg
.portfwd
[0] = cfg
.portfwd
[1] = '\0';
2747 /* Set up subsystem name. */
2748 strcpy(cfg
.remote_cmd
, "sftp");
2749 cfg
.ssh_subsys
= TRUE
;
2753 * Set up fallback option, for SSH-1 servers or servers with the
2754 * sftp subsystem not enabled but the server binary installed
2755 * in the usual place. We only support fallback on Unix
2756 * systems, and we use a kludgy piece of shellery which should
2757 * try to find sftp-server in various places (the obvious
2758 * systemwide spots /usr/lib and /usr/local/lib, and then the
2759 * user's PATH) and finally give up.
2761 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2762 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2765 * the idea being that this will attempt to use either of the
2766 * obvious pathnames and then give up, and when it does give up
2767 * it will print the preferred pathname in the error messages.
2769 cfg
.remote_cmd_ptr2
=
2770 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2771 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2773 cfg
.ssh_subsys2
= FALSE
;
2775 back
= &ssh_backend
;
2777 err
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
, &realhost
,
2778 0, cfg
.tcp_keepalives
);
2780 fprintf(stderr
, "ssh_init: %s\n", err
);
2783 logctx
= log_init(NULL
, &cfg
);
2784 back
->provide_logctx(backhandle
, logctx
);
2785 console_provide_logctx(logctx
);
2786 while (!back
->sendok(backhandle
)) {
2787 if (ssh_sftp_loop_iteration() < 0) {
2788 fprintf(stderr
, "ssh_init: error during SSH connection setup\n");
2792 if (verbose
&& realhost
!= NULL
)
2793 printf("Connected to %s\n", realhost
);
2794 if (realhost
!= NULL
)
2799 void cmdline_error(char *p
, ...)
2802 fprintf(stderr
, "psftp: ");
2804 vfprintf(stderr
, p
, ap
);
2806 fprintf(stderr
, "\n try typing \"psftp -h\" for help\n");
2811 * Main program. Parse arguments etc.
2813 int psftp_main(int argc
, char *argv
[])
2817 char *userhost
, *user
;
2820 char *batchfile
= NULL
;
2823 flags
= FLAG_STDERR
| FLAG_INTERACTIVE
2824 #ifdef FLAG_SYNCAGENT
2828 cmdline_tooltype
= TOOLTYPE_FILETRANSFER
;
2831 userhost
= user
= NULL
;
2833 /* Load Default Settings before doing anything else. */
2834 do_defaults(NULL
, &cfg
);
2835 loaded_session
= FALSE
;
2838 for (i
= 1; i
< argc
; i
++) {
2840 if (argv
[i
][0] != '-') {
2844 userhost
= dupstr(argv
[i
]);
2847 ret
= cmdline_process_param(argv
[i
], i
+1<argc?argv
[i
+1]:NULL
, 1, &cfg
);
2849 cmdline_error("option \"%s\" requires an argument", argv
[i
]);
2850 } else if (ret
== 2) {
2851 i
++; /* skip next argument */
2852 } else if (ret
== 1) {
2853 /* We have our own verbosity in addition to `flags'. */
2854 if (flags
& FLAG_VERBOSE
)
2856 } else if (strcmp(argv
[i
], "-h") == 0 ||
2857 strcmp(argv
[i
], "-?") == 0) {
2859 } else if (strcmp(argv
[i
], "-pgpfp") == 0) {
2862 } else if (strcmp(argv
[i
], "-V") == 0) {
2864 } else if (strcmp(argv
[i
], "-batch") == 0) {
2865 console_batch_mode
= 1;
2866 } else if (strcmp(argv
[i
], "-b") == 0 && i
+ 1 < argc
) {
2868 batchfile
= argv
[++i
];
2869 } else if (strcmp(argv
[i
], "-bc") == 0) {
2870 modeflags
= modeflags
| 1;
2871 } else if (strcmp(argv
[i
], "-be") == 0) {
2872 modeflags
= modeflags
| 2;
2873 } else if (strcmp(argv
[i
], "--") == 0) {
2877 cmdline_error("unknown option \"%s\"", argv
[i
]);
2885 * If the loaded session provides a hostname, and a hostname has not
2886 * otherwise been specified, pop it in `userhost' so that
2887 * `psftp -load sessname' is sufficient to start a session.
2889 if (!userhost
&& cfg
.host
[0] != '\0') {
2890 userhost
= dupstr(cfg
.host
);
2894 * If a user@host string has already been provided, connect to
2899 ret
= psftp_connect(userhost
, user
, portnumber
);
2906 printf("psftp: no hostname specified; use \"open host.name\""
2910 do_sftp(mode
, modeflags
, batchfile
);
2912 if (back
!= NULL
&& back
->connected(backhandle
)) {
2914 back
->special(backhandle
, TS_EOF
);
2915 sftp_recvdata(&ch
, 1);
2920 console_provide_logctx(NULL
);