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 /* ----------------------------------------------------------------------
193 * The meat of the `get' and `put' commands.
195 int sftp_get_file(char *fname
, char *outfname
, int recurse
, int restart
)
197 struct fxp_handle
*fh
;
198 struct sftp_packet
*pktin
;
199 struct sftp_request
*req
, *rreq
;
200 struct fxp_xfer
*xfer
;
203 int ret
, shown_err
= FALSE
;
206 * In recursive mode, see if we're dealing with a directory.
207 * (If we're not in recursive mode, we need not even check: the
208 * subsequent FXP_OPEN will return a usable error message.)
211 struct fxp_attrs attrs
;
214 sftp_register(req
= fxp_stat_send(fname
));
215 rreq
= sftp_find_request(pktin
= sftp_recv());
217 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
220 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
221 (attrs
.permissions
& 0040000)) {
223 struct fxp_handle
*dirhandle
;
224 int nnames
, namesize
;
225 struct fxp_name
**ournames
;
226 struct fxp_names
*names
;
230 * First, attempt to create the destination directory,
231 * unless it already exists.
233 if (file_type(outfname
) != FILE_TYPE_DIRECTORY
&&
234 !create_directory(outfname
)) {
235 printf("%s: Cannot create directory\n", outfname
);
240 * Now get the list of filenames in the remote
243 sftp_register(req
= fxp_opendir_send(fname
));
244 rreq
= sftp_find_request(pktin
= sftp_recv());
246 dirhandle
= fxp_opendir_recv(pktin
, rreq
);
249 printf("%s: unable to open directory: %s\n",
253 nnames
= namesize
= 0;
258 sftp_register(req
= fxp_readdir_send(dirhandle
));
259 rreq
= sftp_find_request(pktin
= sftp_recv());
261 names
= fxp_readdir_recv(pktin
, rreq
);
264 if (fxp_error_type() == SSH_FX_EOF
)
266 printf("%s: reading directory: %s\n", fname
, fxp_error());
270 if (names
->nnames
== 0) {
271 fxp_free_names(names
);
274 if (nnames
+ names
->nnames
>= namesize
) {
275 namesize
+= names
->nnames
+ 128;
276 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
278 for (i
= 0; i
< names
->nnames
; i
++)
279 if (strcmp(names
->names
[i
].filename
, ".") &&
280 strcmp(names
->names
[i
].filename
, "..")) {
281 if (!vet_filename(names
->names
[i
].filename
)) {
282 printf("ignoring potentially dangerous server-"
283 "supplied filename '%s'\n",
284 names
->names
[i
].filename
);
287 fxp_dup_name(&names
->names
[i
]);
290 fxp_free_names(names
);
292 sftp_register(req
= fxp_close_send(dirhandle
));
293 rreq
= sftp_find_request(pktin
= sftp_recv());
295 fxp_close_recv(pktin
, rreq
);
298 * Sort the names into a clear order. This ought to
299 * make things more predictable when we're doing a
300 * reget of the same directory, just in case two
301 * readdirs on the same remote directory return a
304 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
307 * If we're in restart mode, find the last filename on
308 * this list that already exists. We may have to do a
309 * reget on _that_ file, but shouldn't have to do
310 * anything on the previous files.
312 * If none of them exists, of course, we start at 0.
319 nextoutfname
= dir_file_cat(outfname
,
320 ournames
[i
]->filename
);
322 nextoutfname
= dupstr(ournames
[i
]->filename
);
323 ret
= (file_type(nextoutfname
) == FILE_TYPE_NONEXISTENT
);
333 * Now we're ready to recurse. Starting at ournames[i]
334 * and continuing on to the end of the list, we
335 * construct a new source and target file name, and
336 * call sftp_get_file again.
338 for (; i
< nnames
; i
++) {
339 char *nextfname
, *nextoutfname
;
342 nextfname
= dupcat(fname
, "/", ournames
[i
]->filename
, NULL
);
344 nextoutfname
= dir_file_cat(outfname
,
345 ournames
[i
]->filename
);
347 nextoutfname
= dupstr(ournames
[i
]->filename
);
348 ret
= sftp_get_file(nextfname
, nextoutfname
, recurse
, restart
);
349 restart
= FALSE
; /* after first partial file, do full */
353 for (i
= 0; i
< nnames
; i
++) {
354 fxp_free_name(ournames
[i
]);
362 * Done this recursion level. Free everything.
364 for (i
= 0; i
< nnames
; i
++) {
365 fxp_free_name(ournames
[i
]);
373 sftp_register(req
= fxp_open_send(fname
, SSH_FXF_READ
));
374 rreq
= sftp_find_request(pktin
= sftp_recv());
376 fh
= fxp_open_recv(pktin
, rreq
);
379 printf("%s: %s\n", fname
, fxp_error());
384 fp
= fopen(outfname
, "rb+");
386 fp
= fopen(outfname
, "wb");
390 printf("local: unable to open %s\n", outfname
);
392 sftp_register(req
= fxp_close_send(fh
));
393 rreq
= sftp_find_request(pktin
= sftp_recv());
395 fxp_close_recv(pktin
, rreq
);
402 fseek(fp
, 0L, SEEK_END
);
404 printf("reget: restarting at file position %ld\n", posn
);
405 offset
= uint64_make(0, posn
);
407 offset
= uint64_make(0, 0);
410 printf("remote:%s => local:%s\n", fname
, outfname
);
413 * FIXME: we can use FXP_FSTAT here to get the file size, and
414 * thus put up a progress bar.
417 xfer
= xfer_download_init(fh
, offset
);
418 while (!xfer_done(xfer
)) {
423 xfer_download_queue(xfer
);
425 ret
= xfer_download_gotpkt(xfer
, pktin
);
429 printf("error while reading: %s\n", fxp_error());
435 while (xfer_download_data(xfer
, &vbuf
, &len
)) {
436 unsigned char *buf
= (unsigned char *)vbuf
;
440 wlen
= fwrite(buf
+ wpos
, 1, len
- wpos
, fp
);
442 printf("error while writing local file\n");
444 xfer_set_error(xfer
);
448 if (wpos
< len
) { /* we had an error */
450 xfer_set_error(xfer
);
461 sftp_register(req
= fxp_close_send(fh
));
462 rreq
= sftp_find_request(pktin
= sftp_recv());
464 fxp_close_recv(pktin
, rreq
);
469 int sftp_put_file(char *fname
, char *outfname
, int recurse
, int restart
)
471 struct fxp_handle
*fh
;
472 struct fxp_xfer
*xfer
;
473 struct sftp_packet
*pktin
;
474 struct sftp_request
*req
, *rreq
;
480 * In recursive mode, see if we're dealing with a directory.
481 * (If we're not in recursive mode, we need not even check: the
482 * subsequent fopen will return an error message.)
484 if (recurse
&& file_type(fname
) == FILE_TYPE_DIRECTORY
) {
485 struct fxp_attrs attrs
;
487 int nnames
, namesize
;
488 char *name
, **ournames
;
493 * First, attempt to create the destination directory,
494 * unless it already exists.
496 sftp_register(req
= fxp_stat_send(outfname
));
497 rreq
= sftp_find_request(pktin
= sftp_recv());
499 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
501 !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) ||
502 !(attrs
.permissions
& 0040000)) {
503 sftp_register(req
= fxp_mkdir_send(outfname
));
504 rreq
= sftp_find_request(pktin
= sftp_recv());
506 result
= fxp_mkdir_recv(pktin
, rreq
);
509 printf("%s: create directory: %s\n",
510 outfname
, fxp_error());
516 * Now get the list of filenames in the local directory.
518 nnames
= namesize
= 0;
521 dh
= open_directory(fname
);
523 printf("%s: unable to open directory\n", fname
);
526 while ((name
= read_filename(dh
)) != NULL
) {
527 if (nnames
>= namesize
) {
529 ournames
= sresize(ournames
, namesize
, char *);
531 ournames
[nnames
++] = name
;
536 * Sort the names into a clear order. This ought to make
537 * things more predictable when we're doing a reput of the
538 * same directory, just in case two readdirs on the same
539 * local directory return a different order.
541 qsort(ournames
, nnames
, sizeof(*ournames
), bare_name_compare
);
544 * If we're in restart mode, find the last filename on this
545 * list that already exists. We may have to do a reput on
546 * _that_ file, but shouldn't have to do anything on the
549 * If none of them exists, of course, we start at 0.
554 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
555 sftp_register(req
= fxp_stat_send(nextoutfname
));
556 rreq
= sftp_find_request(pktin
= sftp_recv());
558 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
568 * Now we're ready to recurse. Starting at ournames[i]
569 * and continuing on to the end of the list, we
570 * construct a new source and target file name, and
571 * call sftp_put_file again.
573 for (; i
< nnames
; i
++) {
574 char *nextfname
, *nextoutfname
;
578 nextfname
= dir_file_cat(fname
, ournames
[i
]);
580 nextfname
= dupstr(ournames
[i
]);
581 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
582 ret
= sftp_put_file(nextfname
, nextoutfname
, recurse
, restart
);
583 restart
= FALSE
; /* after first partial file, do full */
587 for (i
= 0; i
< nnames
; i
++) {
596 * Done this recursion level. Free everything.
598 for (i
= 0; i
< nnames
; i
++) {
606 fp
= fopen(fname
, "rb");
608 printf("local: unable to open %s\n", fname
);
612 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
));
614 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
|
615 SSH_FXF_CREAT
| SSH_FXF_TRUNC
));
617 rreq
= sftp_find_request(pktin
= sftp_recv());
619 fh
= fxp_open_recv(pktin
, rreq
);
622 printf("%s: %s\n", outfname
, fxp_error());
628 struct fxp_attrs attrs
;
631 sftp_register(req
= fxp_fstat_send(fh
));
632 rreq
= sftp_find_request(pktin
= sftp_recv());
634 ret
= fxp_fstat_recv(pktin
, rreq
, &attrs
);
637 printf("read size of %s: %s\n", outfname
, fxp_error());
640 if (!(attrs
.flags
& SSH_FILEXFER_ATTR_SIZE
)) {
641 printf("read size of %s: size was not given\n", outfname
);
645 uint64_decimal(offset
, decbuf
);
646 printf("reput: restarting at file position %s\n", decbuf
);
647 if (uint64_compare(offset
, uint64_make(0, LONG_MAX
)) > 0) {
648 printf("reput: remote file is larger than we can deal with\n");
651 if (fseek(fp
, offset
.lo
, SEEK_SET
) != 0)
652 fseek(fp
, 0, SEEK_END
); /* *shrug* */
654 offset
= uint64_make(0, 0);
657 printf("local:%s => remote:%s\n", fname
, outfname
);
660 * FIXME: we can use FXP_FSTAT here to get the file size, and
661 * thus put up a progress bar.
664 xfer
= xfer_upload_init(fh
, offset
);
666 while ((!err
&& !eof
) || !xfer_done(xfer
)) {
670 while (xfer_upload_ready(xfer
) && !err
&& !eof
) {
671 len
= fread(buffer
, 1, sizeof(buffer
), fp
);
673 printf("error while reading local file\n");
675 } else if (len
== 0) {
678 xfer_upload_data(xfer
, buffer
, len
);
682 if (!xfer_done(xfer
)) {
684 ret
= xfer_upload_gotpkt(xfer
, pktin
);
686 printf("error while writing: %s\n", fxp_error());
694 sftp_register(req
= fxp_close_send(fh
));
695 rreq
= sftp_find_request(pktin
= sftp_recv());
697 fxp_close_recv(pktin
, rreq
);
704 /* ----------------------------------------------------------------------
705 * A remote wildcard matcher, providing a similar interface to the
706 * local one in psftp.h.
709 typedef struct SftpWildcardMatcher
{
710 struct fxp_handle
*dirh
;
711 struct fxp_names
*names
;
713 char *wildcard
, *prefix
;
714 } SftpWildcardMatcher
;
716 SftpWildcardMatcher
*sftp_begin_wildcard_matching(char *name
)
718 struct sftp_packet
*pktin
;
719 struct sftp_request
*req
, *rreq
;
721 char *unwcdir
, *tmpdir
, *cdir
;
723 SftpWildcardMatcher
*swcm
;
724 struct fxp_handle
*dirh
;
727 * We don't handle multi-level wildcards; so we expect to find
728 * a fully specified directory part, followed by a wildcard
731 wildcard
= stripslashes(name
, 0);
733 unwcdir
= dupstr(name
);
734 len
= wildcard
- name
;
736 if (len
> 0 && unwcdir
[len
-1] == '/')
737 unwcdir
[len
-1] = '\0';
738 tmpdir
= snewn(1 + len
, char);
739 check
= wc_unescape(tmpdir
, unwcdir
);
743 printf("Multiple-level wildcards are not supported\n");
748 cdir
= canonify(unwcdir
);
750 sftp_register(req
= fxp_opendir_send(cdir
));
751 rreq
= sftp_find_request(pktin
= sftp_recv());
753 dirh
= fxp_opendir_recv(pktin
, rreq
);
756 swcm
= snew(SftpWildcardMatcher
);
759 swcm
->wildcard
= dupstr(wildcard
);
760 swcm
->prefix
= unwcdir
;
762 printf("Unable to open %s: %s\n", cdir
, fxp_error());
772 char *sftp_wildcard_get_filename(SftpWildcardMatcher
*swcm
)
774 struct fxp_name
*name
;
775 struct sftp_packet
*pktin
;
776 struct sftp_request
*req
, *rreq
;
779 if (swcm
->names
&& swcm
->namepos
>= swcm
->names
->nnames
) {
780 fxp_free_names(swcm
->names
);
785 sftp_register(req
= fxp_readdir_send(swcm
->dirh
));
786 rreq
= sftp_find_request(pktin
= sftp_recv());
788 swcm
->names
= fxp_readdir_recv(pktin
, rreq
);
791 if (fxp_error_type() != SSH_FX_EOF
)
792 printf("%s: reading directory: %s\n", swcm
->prefix
,
800 assert(swcm
->names
&& swcm
->namepos
< swcm
->names
->nnames
);
802 name
= &swcm
->names
->names
[swcm
->namepos
++];
804 if (!strcmp(name
->filename
, ".") || !strcmp(name
->filename
, ".."))
805 continue; /* expected bad filenames */
807 if (!vet_filename(name
->filename
)) {
808 printf("ignoring potentially dangerous server-"
809 "supplied filename '%s'\n", name
->filename
);
810 continue; /* unexpected bad filename */
813 if (!wc_match(swcm
->wildcard
, name
->filename
))
814 continue; /* doesn't match the wildcard */
817 * We have a working filename. Return it.
819 return dupprintf("%s%s%s", swcm
->prefix
,
821 swcm
->prefix
[strlen(swcm
->prefix
)-1]=='/' ?
827 void sftp_finish_wildcard_matching(SftpWildcardMatcher
*swcm
)
829 struct sftp_packet
*pktin
;
830 struct sftp_request
*req
, *rreq
;
832 sftp_register(req
= fxp_close_send(swcm
->dirh
));
833 rreq
= sftp_find_request(pktin
= sftp_recv());
835 fxp_close_recv(pktin
, rreq
);
838 fxp_free_names(swcm
->names
);
841 sfree(swcm
->wildcard
);
847 * General function to match a potential wildcard in a filename
848 * argument and iterate over every matching file. Used in several
849 * PSFTP commands (rmdir, rm, chmod, mv).
851 int wildcard_iterate(char *filename
, int (*func
)(void *, char *), void *ctx
)
853 char *unwcfname
, *newname
, *cname
;
856 unwcfname
= snewn(strlen(filename
)+1, char);
857 is_wc
= !wc_unescape(unwcfname
, filename
);
860 SftpWildcardMatcher
*swcm
= sftp_begin_wildcard_matching(filename
);
869 while ( (newname
= sftp_wildcard_get_filename(swcm
)) != NULL
) {
870 cname
= canonify(newname
);
872 printf("%s: %s\n", newname
, fxp_error());
876 ret
&= func(ctx
, cname
);
881 /* Politely warn the user that nothing matched. */
882 printf("%s: nothing matched\n", filename
);
885 sftp_finish_wildcard_matching(swcm
);
887 cname
= canonify(unwcfname
);
889 printf("%s: %s\n", filename
, fxp_error());
892 ret
= func(ctx
, cname
);
901 * Handy helper function.
903 int is_wildcard(char *name
)
905 char *unwcfname
= snewn(strlen(name
)+1, char);
906 int is_wc
= !wc_unescape(unwcfname
, name
);
911 /* ----------------------------------------------------------------------
912 * Actual sftp commands.
914 struct sftp_command
{
916 int nwords
, wordssize
;
917 int (*obey
) (struct sftp_command
*); /* returns <0 to quit */
920 int sftp_cmd_null(struct sftp_command
*cmd
)
922 return 1; /* success */
925 int sftp_cmd_unknown(struct sftp_command
*cmd
)
927 printf("psftp: unknown command \"%s\"\n", cmd
->words
[0]);
928 return 0; /* failure */
931 int sftp_cmd_quit(struct sftp_command
*cmd
)
936 int sftp_cmd_close(struct sftp_command
*cmd
)
939 printf("psftp: not connected to a host; use \"open host.name\"\n");
943 if (back
!= NULL
&& back
->socket(backhandle
) != NULL
) {
945 back
->special(backhandle
, TS_EOF
);
946 sftp_recvdata(&ch
, 1);
954 * List a directory. If no arguments are given, list pwd; otherwise
955 * list the directory given in words[1].
957 int sftp_cmd_ls(struct sftp_command
*cmd
)
959 struct fxp_handle
*dirh
;
960 struct fxp_names
*names
;
961 struct fxp_name
**ournames
;
962 int nnames
, namesize
;
963 char *dir
, *cdir
, *unwcdir
, *wildcard
;
964 struct sftp_packet
*pktin
;
965 struct sftp_request
*req
, *rreq
;
969 printf("psftp: not connected to a host; use \"open host.name\"\n");
978 unwcdir
= snewn(1 + strlen(dir
), char);
979 if (wc_unescape(unwcdir
, dir
)) {
986 wildcard
= stripslashes(dir
, 0);
987 unwcdir
= dupstr(dir
);
988 len
= wildcard
- dir
;
990 if (len
> 0 && unwcdir
[len
-1] == '/')
991 unwcdir
[len
-1] = '\0';
992 tmpdir
= snewn(1 + len
, char);
993 check
= wc_unescape(tmpdir
, unwcdir
);
996 printf("Multiple-level wildcards are not supported\n");
1003 cdir
= canonify(dir
);
1005 printf("%s: %s\n", dir
, fxp_error());
1010 printf("Listing directory %s\n", cdir
);
1012 sftp_register(req
= fxp_opendir_send(cdir
));
1013 rreq
= sftp_find_request(pktin
= sftp_recv());
1014 assert(rreq
== req
);
1015 dirh
= fxp_opendir_recv(pktin
, rreq
);
1018 printf("Unable to open %s: %s\n", dir
, fxp_error());
1020 nnames
= namesize
= 0;
1025 sftp_register(req
= fxp_readdir_send(dirh
));
1026 rreq
= sftp_find_request(pktin
= sftp_recv());
1027 assert(rreq
== req
);
1028 names
= fxp_readdir_recv(pktin
, rreq
);
1030 if (names
== NULL
) {
1031 if (fxp_error_type() == SSH_FX_EOF
)
1033 printf("Reading directory %s: %s\n", dir
, fxp_error());
1036 if (names
->nnames
== 0) {
1037 fxp_free_names(names
);
1041 if (nnames
+ names
->nnames
>= namesize
) {
1042 namesize
+= names
->nnames
+ 128;
1043 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
1046 for (i
= 0; i
< names
->nnames
; i
++)
1047 if (!wildcard
|| wc_match(wildcard
, names
->names
[i
].filename
))
1048 ournames
[nnames
++] = fxp_dup_name(&names
->names
[i
]);
1050 fxp_free_names(names
);
1052 sftp_register(req
= fxp_close_send(dirh
));
1053 rreq
= sftp_find_request(pktin
= sftp_recv());
1054 assert(rreq
== req
);
1055 fxp_close_recv(pktin
, rreq
);
1058 * Now we have our filenames. Sort them by actual file
1059 * name, and then output the longname parts.
1061 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
1066 for (i
= 0; i
< nnames
; i
++) {
1067 printf("%s\n", ournames
[i
]->longname
);
1068 fxp_free_name(ournames
[i
]);
1080 * Change directories. We do this by canonifying the new name, then
1081 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
1083 int sftp_cmd_cd(struct sftp_command
*cmd
)
1085 struct fxp_handle
*dirh
;
1086 struct sftp_packet
*pktin
;
1087 struct sftp_request
*req
, *rreq
;
1091 printf("psftp: not connected to a host; use \"open host.name\"\n");
1095 if (cmd
->nwords
< 2)
1096 dir
= dupstr(homedir
);
1098 dir
= canonify(cmd
->words
[1]);
1101 printf("%s: %s\n", dir
, fxp_error());
1105 sftp_register(req
= fxp_opendir_send(dir
));
1106 rreq
= sftp_find_request(pktin
= sftp_recv());
1107 assert(rreq
== req
);
1108 dirh
= fxp_opendir_recv(pktin
, rreq
);
1111 printf("Directory %s: %s\n", dir
, fxp_error());
1116 sftp_register(req
= fxp_close_send(dirh
));
1117 rreq
= sftp_find_request(pktin
= sftp_recv());
1118 assert(rreq
== req
);
1119 fxp_close_recv(pktin
, rreq
);
1123 printf("Remote directory is now %s\n", pwd
);
1129 * Print current directory. Easy as pie.
1131 int sftp_cmd_pwd(struct sftp_command
*cmd
)
1134 printf("psftp: not connected to a host; use \"open host.name\"\n");
1138 printf("Remote directory is %s\n", pwd
);
1143 * Get a file and save it at the local end. We have three very
1144 * similar commands here. The basic one is `get'; `reget' differs
1145 * in that it checks for the existence of the destination file and
1146 * starts from where a previous aborted transfer left off; `mget'
1147 * differs in that it interprets all its arguments as files to
1148 * transfer (never as a different local name for a remote file) and
1149 * can handle wildcards.
1151 int sftp_general_get(struct sftp_command
*cmd
, int restart
, int multiple
)
1153 char *fname
, *unwcfname
, *origfname
, *origwfname
, *outfname
;
1155 int recurse
= FALSE
;
1158 printf("psftp: not connected to a host; use \"open host.name\"\n");
1163 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1164 if (!strcmp(cmd
->words
[i
], "--")) {
1165 /* finish processing options */
1168 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1171 printf("%s: unrecognised option '%s'\n", cmd
->words
[0], cmd
->words
[i
]);
1177 if (i
>= cmd
->nwords
) {
1178 printf("%s: expects a filename\n", cmd
->words
[0]);
1184 SftpWildcardMatcher
*swcm
;
1186 origfname
= cmd
->words
[i
++];
1187 unwcfname
= snewn(strlen(origfname
)+1, char);
1189 if (multiple
&& !wc_unescape(unwcfname
, origfname
)) {
1190 swcm
= sftp_begin_wildcard_matching(origfname
);
1195 origwfname
= sftp_wildcard_get_filename(swcm
);
1197 /* Politely warn the user that nothing matched. */
1198 printf("%s: nothing matched\n", origfname
);
1199 sftp_finish_wildcard_matching(swcm
);
1204 origwfname
= origfname
;
1208 while (origwfname
) {
1209 fname
= canonify(origwfname
);
1212 printf("%s: %s\n", origwfname
, fxp_error());
1217 if (!multiple
&& i
< cmd
->nwords
)
1218 outfname
= cmd
->words
[i
++];
1220 outfname
= stripslashes(origwfname
, 0);
1222 ret
= sftp_get_file(fname
, outfname
, recurse
, restart
);
1228 origwfname
= sftp_wildcard_get_filename(swcm
);
1235 sftp_finish_wildcard_matching(swcm
);
1239 } while (multiple
&& i
< cmd
->nwords
);
1243 int sftp_cmd_get(struct sftp_command
*cmd
)
1245 return sftp_general_get(cmd
, 0, 0);
1247 int sftp_cmd_mget(struct sftp_command
*cmd
)
1249 return sftp_general_get(cmd
, 0, 1);
1251 int sftp_cmd_reget(struct sftp_command
*cmd
)
1253 return sftp_general_get(cmd
, 1, 0);
1257 * Send a file and store it at the remote end. We have three very
1258 * similar commands here. The basic one is `put'; `reput' differs
1259 * in that it checks for the existence of the destination file and
1260 * starts from where a previous aborted transfer left off; `mput'
1261 * differs in that it interprets all its arguments as files to
1262 * transfer (never as a different remote name for a local file) and
1263 * can handle wildcards.
1265 int sftp_general_put(struct sftp_command
*cmd
, int restart
, int multiple
)
1267 char *fname
, *wfname
, *origoutfname
, *outfname
;
1269 int recurse
= FALSE
;
1272 printf("psftp: not connected to a host; use \"open host.name\"\n");
1277 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1278 if (!strcmp(cmd
->words
[i
], "--")) {
1279 /* finish processing options */
1282 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1285 printf("%s: unrecognised option '%s'\n", cmd
->words
[0], cmd
->words
[i
]);
1291 if (i
>= cmd
->nwords
) {
1292 printf("%s: expects a filename\n", cmd
->words
[0]);
1298 WildcardMatcher
*wcm
;
1299 fname
= cmd
->words
[i
++];
1301 if (multiple
&& test_wildcard(fname
, FALSE
) == WCTYPE_WILDCARD
) {
1302 wcm
= begin_wildcard_matching(fname
);
1303 wfname
= wildcard_get_filename(wcm
);
1305 /* Politely warn the user that nothing matched. */
1306 printf("%s: nothing matched\n", fname
);
1307 finish_wildcard_matching(wcm
);
1316 if (!multiple
&& i
< cmd
->nwords
)
1317 origoutfname
= cmd
->words
[i
++];
1319 origoutfname
= stripslashes(wfname
, 1);
1321 outfname
= canonify(origoutfname
);
1323 printf("%s: %s\n", origoutfname
, fxp_error());
1326 finish_wildcard_matching(wcm
);
1330 ret
= sftp_put_file(wfname
, outfname
, recurse
, restart
);
1335 wfname
= wildcard_get_filename(wcm
);
1342 finish_wildcard_matching(wcm
);
1347 } while (multiple
&& i
< cmd
->nwords
);
1351 int sftp_cmd_put(struct sftp_command
*cmd
)
1353 return sftp_general_put(cmd
, 0, 0);
1355 int sftp_cmd_mput(struct sftp_command
*cmd
)
1357 return sftp_general_put(cmd
, 0, 1);
1359 int sftp_cmd_reput(struct sftp_command
*cmd
)
1361 return sftp_general_put(cmd
, 1, 0);
1364 int sftp_cmd_mkdir(struct sftp_command
*cmd
)
1367 struct sftp_packet
*pktin
;
1368 struct sftp_request
*req
, *rreq
;
1373 printf("psftp: not connected to a host; use \"open host.name\"\n");
1377 if (cmd
->nwords
< 2) {
1378 printf("mkdir: expects a directory\n");
1383 for (i
= 1; i
< cmd
->nwords
; i
++) {
1384 dir
= canonify(cmd
->words
[i
]);
1386 printf("%s: %s\n", dir
, fxp_error());
1390 sftp_register(req
= fxp_mkdir_send(dir
));
1391 rreq
= sftp_find_request(pktin
= sftp_recv());
1392 assert(rreq
== req
);
1393 result
= fxp_mkdir_recv(pktin
, rreq
);
1396 printf("mkdir %s: %s\n", dir
, fxp_error());
1407 static int sftp_action_rmdir(void *vctx
, char *dir
)
1409 struct sftp_packet
*pktin
;
1410 struct sftp_request
*req
, *rreq
;
1413 sftp_register(req
= fxp_rmdir_send(dir
));
1414 rreq
= sftp_find_request(pktin
= sftp_recv());
1415 assert(rreq
== req
);
1416 result
= fxp_rmdir_recv(pktin
, rreq
);
1419 printf("rmdir %s: %s\n", dir
, fxp_error());
1426 int sftp_cmd_rmdir(struct sftp_command
*cmd
)
1431 printf("psftp: not connected to a host; use \"open host.name\"\n");
1435 if (cmd
->nwords
< 2) {
1436 printf("rmdir: expects a directory\n");
1441 for (i
= 1; i
< cmd
->nwords
; i
++)
1442 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_rmdir
, NULL
);
1447 static int sftp_action_rm(void *vctx
, char *fname
)
1449 struct sftp_packet
*pktin
;
1450 struct sftp_request
*req
, *rreq
;
1453 sftp_register(req
= fxp_remove_send(fname
));
1454 rreq
= sftp_find_request(pktin
= sftp_recv());
1455 assert(rreq
== req
);
1456 result
= fxp_remove_recv(pktin
, rreq
);
1459 printf("rm %s: %s\n", fname
, fxp_error());
1467 int sftp_cmd_rm(struct sftp_command
*cmd
)
1472 printf("psftp: not connected to a host; use \"open host.name\"\n");
1476 if (cmd
->nwords
< 2) {
1477 printf("rm: expects a filename\n");
1482 for (i
= 1; i
< cmd
->nwords
; i
++)
1483 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_rm
, NULL
);
1488 static int check_is_dir(char *dstfname
)
1490 struct sftp_packet
*pktin
;
1491 struct sftp_request
*req
, *rreq
;
1492 struct fxp_attrs attrs
;
1495 sftp_register(req
= fxp_stat_send(dstfname
));
1496 rreq
= sftp_find_request(pktin
= sftp_recv());
1497 assert(rreq
== req
);
1498 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1501 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
1502 (attrs
.permissions
& 0040000))
1508 struct sftp_context_mv
{
1513 static int sftp_action_mv(void *vctx
, char *srcfname
)
1515 struct sftp_context_mv
*ctx
= (struct sftp_context_mv
*)vctx
;
1516 struct sftp_packet
*pktin
;
1517 struct sftp_request
*req
, *rreq
;
1519 char *finalfname
, *newcanon
= NULL
;
1522 if (ctx
->dest_is_dir
) {
1526 p
= srcfname
+ strlen(srcfname
);
1527 while (p
> srcfname
&& p
[-1] != '/') p
--;
1528 newname
= dupcat(ctx
->dstfname
, "/", p
, NULL
);
1529 newcanon
= canonify(newname
);
1531 printf("%s: %s\n", newname
, fxp_error());
1537 finalfname
= newcanon
;
1539 finalfname
= ctx
->dstfname
;
1542 sftp_register(req
= fxp_rename_send(srcfname
, finalfname
));
1543 rreq
= sftp_find_request(pktin
= sftp_recv());
1544 assert(rreq
== req
);
1545 result
= fxp_rename_recv(pktin
, rreq
);
1547 error
= result ? NULL
: fxp_error();
1550 printf("mv %s %s: %s\n", srcfname
, finalfname
, error
);
1553 printf("%s -> %s\n", srcfname
, finalfname
);
1561 int sftp_cmd_mv(struct sftp_command
*cmd
)
1563 struct sftp_context_mv actx
, *ctx
= &actx
;
1567 printf("psftp: not connected to a host; use \"open host.name\"\n");
1571 if (cmd
->nwords
< 3) {
1572 printf("mv: expects two filenames\n");
1576 ctx
->dstfname
= canonify(cmd
->words
[cmd
->nwords
-1]);
1577 if (!ctx
->dstfname
) {
1578 printf("%s: %s\n", ctx
->dstfname
, fxp_error());
1583 * If there's more than one source argument, or one source
1584 * argument which is a wildcard, we _require_ that the
1585 * destination is a directory.
1587 ctx
->dest_is_dir
= check_is_dir(ctx
->dstfname
);
1588 if ((cmd
->nwords
> 3 || is_wildcard(cmd
->words
[1])) && !ctx
->dest_is_dir
) {
1589 printf("mv: multiple or wildcard arguments require the destination"
1590 " to be a directory\n");
1595 * Now iterate over the source arguments.
1598 for (i
= 1; i
< cmd
->nwords
-1; i
++)
1599 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_mv
, ctx
);
1604 struct sftp_context_chmod
{
1605 unsigned attrs_clr
, attrs_xor
;
1608 static int sftp_action_chmod(void *vctx
, char *fname
)
1610 struct fxp_attrs attrs
;
1611 struct sftp_packet
*pktin
;
1612 struct sftp_request
*req
, *rreq
;
1614 unsigned oldperms
, newperms
;
1615 struct sftp_context_chmod
*ctx
= (struct sftp_context_chmod
*)vctx
;
1617 sftp_register(req
= fxp_stat_send(fname
));
1618 rreq
= sftp_find_request(pktin
= sftp_recv());
1619 assert(rreq
== req
);
1620 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1622 if (!result
|| !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
)) {
1623 printf("get attrs for %s: %s\n", fname
,
1624 result ?
"file permissions not provided" : fxp_error());
1629 attrs
.flags
= SSH_FILEXFER_ATTR_PERMISSIONS
; /* perms _only_ */
1630 oldperms
= attrs
.permissions
& 07777;
1631 attrs
.permissions
&= ~ctx
->attrs_clr
;
1632 attrs
.permissions
^= ctx
->attrs_xor
;
1633 newperms
= attrs
.permissions
& 07777;
1635 if (oldperms
== newperms
)
1636 return 1; /* no need to do anything! */
1638 sftp_register(req
= fxp_setstat_send(fname
, attrs
));
1639 rreq
= sftp_find_request(pktin
= sftp_recv());
1640 assert(rreq
== req
);
1641 result
= fxp_setstat_recv(pktin
, rreq
);
1644 printf("set attrs for %s: %s\n", fname
, fxp_error());
1649 printf("%s: %04o -> %04o\n", fname
, oldperms
, newperms
);
1654 int sftp_cmd_chmod(struct sftp_command
*cmd
)
1658 struct sftp_context_chmod actx
, *ctx
= &actx
;
1661 printf("psftp: not connected to a host; use \"open host.name\"\n");
1665 if (cmd
->nwords
< 3) {
1666 printf("chmod: expects a mode specifier and a filename\n");
1671 * Attempt to parse the mode specifier in cmd->words[1]. We
1672 * don't support the full horror of Unix chmod; instead we
1673 * support a much simpler syntax in which the user can either
1674 * specify an octal number, or a comma-separated sequence of
1675 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1676 * _only_ be omitted if the only attribute mentioned is t,
1677 * since all others require a user/group/other specification.
1678 * Additionally, the s attribute may not be specified for any
1679 * [ugoa] specifications other than exactly u or exactly g.
1681 ctx
->attrs_clr
= ctx
->attrs_xor
= 0;
1682 mode
= cmd
->words
[1];
1683 if (mode
[0] >= '0' && mode
[0] <= '9') {
1684 if (mode
[strspn(mode
, "01234567")]) {
1685 printf("chmod: numeric file modes should"
1686 " contain digits 0-7 only\n");
1689 ctx
->attrs_clr
= 07777;
1690 sscanf(mode
, "%o", &ctx
->attrs_xor
);
1691 ctx
->attrs_xor
&= ctx
->attrs_clr
;
1694 char *modebegin
= mode
;
1695 unsigned subset
, perms
;
1699 while (*mode
&& *mode
!= ',' &&
1700 *mode
!= '+' && *mode
!= '-' && *mode
!= '=') {
1702 case 'u': subset
|= 04700; break; /* setuid, user perms */
1703 case 'g': subset
|= 02070; break; /* setgid, group perms */
1704 case 'o': subset
|= 00007; break; /* just other perms */
1705 case 'a': subset
|= 06777; break; /* all of the above */
1707 printf("chmod: file mode '%.*s' contains unrecognised"
1708 " user/group/other specifier '%c'\n",
1709 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1714 if (!*mode
|| *mode
== ',') {
1715 printf("chmod: file mode '%.*s' is incomplete\n",
1716 (int)strcspn(modebegin
, ","), modebegin
);
1720 if (!*mode
|| *mode
== ',') {
1721 printf("chmod: file mode '%.*s' is incomplete\n",
1722 (int)strcspn(modebegin
, ","), modebegin
);
1726 while (*mode
&& *mode
!= ',') {
1728 case 'r': perms
|= 00444; break;
1729 case 'w': perms
|= 00222; break;
1730 case 'x': perms
|= 00111; break;
1731 case 't': perms
|= 01000; subset
|= 01000; break;
1733 if ((subset
& 06777) != 04700 &&
1734 (subset
& 06777) != 02070) {
1735 printf("chmod: file mode '%.*s': set[ug]id bit should"
1736 " be used with exactly one of u or g only\n",
1737 (int)strcspn(modebegin
, ","), modebegin
);
1743 printf("chmod: file mode '%.*s' contains unrecognised"
1744 " permission specifier '%c'\n",
1745 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1750 if (!(subset
& 06777) && (perms
&~ subset
)) {
1751 printf("chmod: file mode '%.*s' contains no user/group/other"
1752 " specifier and permissions other than 't' \n",
1753 (int)strcspn(modebegin
, ","), modebegin
);
1759 ctx
->attrs_clr
|= perms
;
1760 ctx
->attrs_xor
|= perms
;
1763 ctx
->attrs_clr
|= perms
;
1764 ctx
->attrs_xor
&= ~perms
;
1767 ctx
->attrs_clr
|= subset
;
1768 ctx
->attrs_xor
|= perms
;
1771 if (*mode
) mode
++; /* eat comma */
1776 for (i
= 2; i
< cmd
->nwords
; i
++)
1777 ret
&= wildcard_iterate(cmd
->words
[i
], sftp_action_chmod
, ctx
);
1782 static int sftp_cmd_open(struct sftp_command
*cmd
)
1787 printf("psftp: already connected\n");
1791 if (cmd
->nwords
< 2) {
1792 printf("open: expects a host name\n");
1796 if (cmd
->nwords
> 2) {
1797 portnumber
= atoi(cmd
->words
[2]);
1798 if (portnumber
== 0) {
1799 printf("open: invalid port number\n");
1805 if (psftp_connect(cmd
->words
[1], NULL
, portnumber
)) {
1806 back
= NULL
; /* connection is already closed */
1807 return -1; /* this is fatal */
1813 static int sftp_cmd_lcd(struct sftp_command
*cmd
)
1815 char *currdir
, *errmsg
;
1817 if (cmd
->nwords
< 2) {
1818 printf("lcd: expects a local directory name\n");
1822 errmsg
= psftp_lcd(cmd
->words
[1]);
1824 printf("lcd: unable to change directory: %s\n", errmsg
);
1829 currdir
= psftp_getcwd();
1830 printf("New local directory is %s\n", currdir
);
1836 static int sftp_cmd_lpwd(struct sftp_command
*cmd
)
1840 currdir
= psftp_getcwd();
1841 printf("Current local directory is %s\n", currdir
);
1847 static int sftp_cmd_pling(struct sftp_command
*cmd
)
1851 exitcode
= system(cmd
->words
[1]);
1852 return (exitcode
== 0);
1855 static int sftp_cmd_help(struct sftp_command
*cmd
);
1857 static struct sftp_cmd_lookup
{
1860 * For help purposes, there are two kinds of command:
1862 * - primary commands, in which `longhelp' is non-NULL. In
1863 * this case `shorthelp' is descriptive text, and `longhelp'
1864 * is longer descriptive text intended to be printed after
1867 * - alias commands, in which `longhelp' is NULL. In this case
1868 * `shorthelp' is the name of a primary command, which
1869 * contains the help that should double up for this command.
1871 int listed
; /* do we list this in primary help? */
1874 int (*obey
) (struct sftp_command
*);
1877 * List of sftp commands. This is binary-searched so it MUST be
1881 "!", TRUE
, "run a local command",
1883 /* FIXME: this example is crap for non-Windows. */
1884 " Runs a local command. For example, \"!del myfile\".\n",
1888 "bye", TRUE
, "finish your SFTP session",
1890 " Terminates your SFTP session and quits the PSFTP program.\n",
1894 "cd", TRUE
, "change your remote working directory",
1895 " [ <New working directory> ]\n"
1896 " Change the remote working directory for your SFTP session.\n"
1897 " If a new working directory is not supplied, you will be\n"
1898 " returned to your home directory.\n",
1902 "chmod", TRUE
, "change file permissions and modes",
1903 " ( <octal-digits> | <modifiers> ) <filename>\n"
1904 " Change the file permissions on a file or directory.\n"
1905 " <octal-digits> can be any octal Unix permission specifier.\n"
1906 " Alternatively, <modifiers> can include:\n"
1907 " u+r make file readable by owning user\n"
1908 " u+w make file writable by owning user\n"
1909 " u+x make file executable by owning user\n"
1910 " u-r make file not readable by owning user\n"
1911 " [also u-w, u-x]\n"
1912 " g+r make file readable by members of owning group\n"
1913 " [also g+w, g+x, g-r, g-w, g-x]\n"
1914 " o+r make file readable by all other users\n"
1915 " [also o+w, o+x, o-r, o-w, o-x]\n"
1916 " a+r make file readable by absolutely everybody\n"
1917 " [also a+w, a+x, a-r, a-w, a-x]\n"
1918 " u+s enable the Unix set-user-ID bit\n"
1919 " u-s disable the Unix set-user-ID bit\n"
1920 " g+s enable the Unix set-group-ID bit\n"
1921 " g-s disable the Unix set-group-ID bit\n"
1922 " +t enable the Unix \"sticky bit\"\n"
1923 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1924 " more than one user for the same modifier (\"ug+w\"). You can\n"
1925 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1929 "close", TRUE
, "finish your SFTP session but do not quit PSFTP",
1931 " Terminates your SFTP session, but does not quit the PSFTP\n"
1932 " program. You can then use \"open\" to start another SFTP\n"
1933 " session, to the same server or to a different one.\n",
1937 "del", TRUE
, "delete a file",
1939 " Delete a file.\n",
1943 "delete", FALSE
, "del", NULL
, sftp_cmd_rm
1946 "dir", TRUE
, "list contents of a remote directory",
1947 " [ <directory-name> ]/[ <wildcard> ]\n"
1948 " List the contents of a specified directory on the server.\n"
1949 " If <directory-name> is not given, the current working directory\n"
1951 " If <wildcard> is given, it is treated as a set of files to\n"
1952 " list; otherwise, all files are listed.\n",
1956 "exit", TRUE
, "bye", NULL
, sftp_cmd_quit
1959 "get", TRUE
, "download a file from the server to your local machine",
1960 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
1961 " Downloads a file on the server and stores it locally under\n"
1962 " the same name, or under a different one if you supply the\n"
1963 " argument <local-filename>.\n"
1964 " If -r specified, recursively fetch a directory.\n",
1968 "help", TRUE
, "give help",
1969 " [ <command> [ <command> ... ] ]\n"
1970 " Give general help if no commands are specified.\n"
1971 " If one or more commands are specified, give specific help on\n"
1972 " those particular commands.\n",
1976 "lcd", TRUE
, "change local working directory",
1977 " <local-directory-name>\n"
1978 " Change the local working directory of the PSFTP program (the\n"
1979 " default location where the \"get\" command will save files).\n",
1983 "lpwd", TRUE
, "print local working directory",
1985 " Print the local working directory of the PSFTP program (the\n"
1986 " default location where the \"get\" command will save files).\n",
1990 "ls", TRUE
, "dir", NULL
,
1994 "mget", TRUE
, "download multiple files at once",
1995 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1996 " Downloads many files from the server, storing each one under\n"
1997 " the same name it has on the server side. You can use wildcards\n"
1998 " such as \"*.c\" to specify lots of files at once.\n"
1999 " If -r specified, recursively fetch files and directories.\n",
2003 "mkdir", TRUE
, "create a directory on the remote server",
2004 " <directory-name>\n"
2005 " Creates a directory with the given name on the server.\n",
2009 "mput", TRUE
, "upload multiple files at once",
2010 " [ -r ] [ -- ] <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
2011 " Uploads many files to the server, storing each one under the\n"
2012 " same name it has on the client side. You can use wildcards\n"
2013 " such as \"*.c\" to specify lots of files at once.\n"
2014 " If -r specified, recursively store files and directories.\n",
2018 "mv", TRUE
, "move or rename a file on the remote server",
2019 " <source-filename> <destination-filename>\n"
2020 " Moves or renames the file <source-filename> on the server,\n"
2021 " so that it is accessible under the name <destination-filename>.\n",
2025 "open", TRUE
, "connect to a host",
2026 " [<user>@]<hostname> [<port>]\n"
2027 " Establishes an SFTP connection to a given host. Only usable\n"
2028 " when you did not already specify a host name on the command\n"
2033 "put", TRUE
, "upload a file from your local machine to the server",
2034 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2035 " Uploads a file to the server and stores it there under\n"
2036 " the same name, or under a different one if you supply the\n"
2037 " argument <remote-filename>.\n"
2038 " If -r specified, recursively store a directory.\n",
2042 "pwd", TRUE
, "print your remote working directory",
2044 " Print the current remote working directory for your SFTP session.\n",
2048 "quit", TRUE
, "bye", NULL
,
2052 "reget", TRUE
, "continue downloading a file",
2053 " [ -r ] [ -- ] <filename> [ <local-filename> ]\n"
2054 " Works exactly like the \"get\" command, but the local file\n"
2055 " must already exist. The download will begin at the end of the\n"
2056 " file. This is for resuming a download that was interrupted.\n"
2057 " If -r specified, resume interrupted \"get -r\".\n",
2061 "ren", TRUE
, "mv", NULL
,
2065 "rename", FALSE
, "mv", NULL
,
2069 "reput", TRUE
, "continue uploading a file",
2070 " [ -r ] [ -- ] <filename> [ <remote-filename> ]\n"
2071 " Works exactly like the \"put\" command, but the remote file\n"
2072 " must already exist. The upload will begin at the end of the\n"
2073 " file. This is for resuming an upload that was interrupted.\n"
2074 " If -r specified, resume interrupted \"put -r\".\n",
2078 "rm", TRUE
, "del", NULL
,
2082 "rmdir", TRUE
, "remove a directory on the remote server",
2083 " <directory-name>\n"
2084 " Removes the directory with the given name on the server.\n"
2085 " The directory will not be removed unless it is empty.\n",
2090 const struct sftp_cmd_lookup
*lookup_command(char *name
)
2095 j
= sizeof(sftp_lookup
) / sizeof(*sftp_lookup
);
2098 cmp
= strcmp(name
, sftp_lookup
[k
].name
);
2104 return &sftp_lookup
[k
];
2110 static int sftp_cmd_help(struct sftp_command
*cmd
)
2113 if (cmd
->nwords
== 1) {
2115 * Give short help on each command.
2119 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
2121 if (!sftp_lookup
[i
].listed
)
2123 len
= strlen(sftp_lookup
[i
].name
);
2127 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
2128 const struct sftp_cmd_lookup
*lookup
;
2129 if (!sftp_lookup
[i
].listed
)
2131 lookup
= &sftp_lookup
[i
];
2132 printf("%-*s", maxlen
+2, lookup
->name
);
2133 if (lookup
->longhelp
== NULL
)
2134 lookup
= lookup_command(lookup
->shorthelp
);
2135 printf("%s\n", lookup
->shorthelp
);
2139 * Give long help on specific commands.
2141 for (i
= 1; i
< cmd
->nwords
; i
++) {
2142 const struct sftp_cmd_lookup
*lookup
;
2143 lookup
= lookup_command(cmd
->words
[i
]);
2145 printf("help: %s: command not found\n", cmd
->words
[i
]);
2147 printf("%s", lookup
->name
);
2148 if (lookup
->longhelp
== NULL
)
2149 lookup
= lookup_command(lookup
->shorthelp
);
2150 printf("%s", lookup
->longhelp
);
2157 /* ----------------------------------------------------------------------
2158 * Command line reading and parsing.
2160 struct sftp_command
*sftp_getcmd(FILE *fp
, int mode
, int modeflags
)
2163 struct sftp_command
*cmd
;
2167 cmd
= snew(struct sftp_command
);
2177 line
= fgetline(fp
);
2179 line
= ssh_sftp_get_cmdline("psftp> ", back
== NULL
);
2182 if (!line
|| !*line
) {
2183 cmd
->obey
= sftp_cmd_quit
;
2184 if ((mode
== 0) || (modeflags
& 1))
2186 return cmd
; /* eof */
2189 line
[strcspn(line
, "\r\n")] = '\0';
2191 if (modeflags
& 1) {
2192 printf("%s\n", line
);
2196 while (*p
&& (*p
== ' ' || *p
== '\t'))
2201 * Special case: the ! command. This is always parsed as
2202 * exactly two words: one containing the !, and the second
2203 * containing everything else on the line.
2205 cmd
->nwords
= cmd
->wordssize
= 2;
2206 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
2207 cmd
->words
[0] = dupstr("!");
2208 cmd
->words
[1] = dupstr(p
+1);
2212 * Parse the command line into words. The syntax is:
2213 * - double quotes are removed, but cause spaces within to be
2214 * treated as non-separating.
2215 * - a double-doublequote pair is a literal double quote, inside
2216 * _or_ outside quotes. Like this:
2218 * firstword "second word" "this has ""quotes"" in" and""this""
2224 * >this has "quotes" in<
2228 /* skip whitespace */
2229 while (*p
&& (*p
== ' ' || *p
== '\t'))
2231 /* mark start of word */
2232 q
= r
= p
; /* q sits at start, r writes word */
2235 if (!quoting
&& (*p
== ' ' || *p
== '\t'))
2236 break; /* reached end of word */
2237 else if (*p
== '"' && p
[1] == '"')
2238 p
+= 2, *r
++ = '"'; /* a literal quote */
2240 p
++, quoting
= !quoting
;
2245 p
++; /* skip over the whitespace */
2247 if (cmd
->nwords
>= cmd
->wordssize
) {
2248 cmd
->wordssize
= cmd
->nwords
+ 16;
2249 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
2251 cmd
->words
[cmd
->nwords
++] = dupstr(q
);
2258 * Now parse the first word and assign a function.
2261 if (cmd
->nwords
== 0)
2262 cmd
->obey
= sftp_cmd_null
;
2264 const struct sftp_cmd_lookup
*lookup
;
2265 lookup
= lookup_command(cmd
->words
[0]);
2267 cmd
->obey
= sftp_cmd_unknown
;
2269 cmd
->obey
= lookup
->obey
;
2275 static int do_sftp_init(void)
2277 struct sftp_packet
*pktin
;
2278 struct sftp_request
*req
, *rreq
;
2281 * Do protocol initialisation.
2285 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2286 return 1; /* failure */
2290 * Find out where our home directory is.
2292 sftp_register(req
= fxp_realpath_send("."));
2293 rreq
= sftp_find_request(pktin
= sftp_recv());
2294 assert(rreq
== req
);
2295 homedir
= fxp_realpath_recv(pktin
, rreq
);
2299 "Warning: failed to resolve home directory: %s\n",
2301 homedir
= dupstr(".");
2303 printf("Remote working directory is %s\n", homedir
);
2305 pwd
= dupstr(homedir
);
2309 void do_sftp_cleanup()
2313 back
->special(backhandle
, TS_EOF
);
2314 sftp_recvdata(&ch
, 1);
2315 back
->free(backhandle
);
2316 sftp_cleanup_request();
2330 void do_sftp(int mode
, int modeflags
, char *batchfile
)
2340 /* ------------------------------------------------------------------
2341 * Now we're ready to do Real Stuff.
2344 struct sftp_command
*cmd
;
2345 cmd
= sftp_getcmd(NULL
, 0, 0);
2348 ret
= cmd
->obey(cmd
);
2351 for(i
= 0; i
< cmd
->nwords
; i
++)
2352 sfree(cmd
->words
[i
]);
2360 fp
= fopen(batchfile
, "r");
2362 printf("Fatal: unable to open %s\n", batchfile
);
2366 struct sftp_command
*cmd
;
2367 cmd
= sftp_getcmd(fp
, mode
, modeflags
);
2370 ret
= cmd
->obey(cmd
);
2374 if (!(modeflags
& 2))
2383 /* ----------------------------------------------------------------------
2384 * Dirty bits: integration with PuTTY.
2387 static int verbose
= 0;
2390 * Print an error message and perform a fatal exit.
2392 void fatalbox(char *fmt
, ...)
2397 str
= dupvprintf(fmt
, ap
);
2398 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2401 fputs(str2
, stderr
);
2406 void modalfatalbox(char *fmt
, ...)
2411 str
= dupvprintf(fmt
, ap
);
2412 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2415 fputs(str2
, stderr
);
2420 void connection_fatal(void *frontend
, char *fmt
, ...)
2425 str
= dupvprintf(fmt
, ap
);
2426 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2429 fputs(str2
, stderr
);
2435 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
)
2438 * This is only here because of the calls to ldisc_send(NULL,
2439 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2440 * ldisc as an ldisc. So if we get called with any real data, I
2441 * want to know about it.
2447 * In psftp, all agent requests should be synchronous, so this is a
2448 * never-called stub.
2450 void agent_schedule_callback(void (*callback
)(void *, void *, int),
2451 void *callback_ctx
, void *data
, int len
)
2453 assert(!"We shouldn't be here");
2457 * Receive a block of data from the SSH link. Block until all data
2460 * To do this, we repeatedly call the SSH protocol module, with our
2461 * own trap in from_backend() to catch the data that comes back. We
2462 * do this until we have enough data.
2465 static unsigned char *outptr
; /* where to put the data */
2466 static unsigned outlen
; /* how much data required */
2467 static unsigned char *pending
= NULL
; /* any spare data */
2468 static unsigned pendlen
= 0, pendsize
= 0; /* length and phys. size of buffer */
2469 int from_backend(void *frontend
, int is_stderr
, const char *data
, int datalen
)
2471 unsigned char *p
= (unsigned char *) data
;
2472 unsigned len
= (unsigned) datalen
;
2475 * stderr data is just spouted to local stderr and otherwise
2480 fwrite(data
, 1, len
, stderr
);
2485 * If this is before the real session begins, just return.
2490 if ((outlen
> 0) && (len
> 0)) {
2491 unsigned used
= outlen
;
2494 memcpy(outptr
, p
, used
);
2502 if (pendsize
< pendlen
+ len
) {
2503 pendsize
= pendlen
+ len
+ 4096;
2504 pending
= sresize(pending
, pendsize
, unsigned char);
2506 memcpy(pending
+ pendlen
, p
, len
);
2512 int sftp_recvdata(char *buf
, int len
)
2514 outptr
= (unsigned char *) buf
;
2518 * See if the pending-input block contains some of what we
2522 unsigned pendused
= pendlen
;
2523 if (pendused
> outlen
)
2525 memcpy(outptr
, pending
, pendused
);
2526 memmove(pending
, pending
+ pendused
, pendlen
- pendused
);
2529 pendlen
-= pendused
;
2539 while (outlen
> 0) {
2540 if (ssh_sftp_loop_iteration() < 0)
2541 return 0; /* doom */
2546 int sftp_senddata(char *buf
, int len
)
2548 back
->send(backhandle
, buf
, len
);
2553 * Short description of parameters.
2555 static void usage(void)
2557 printf("PuTTY Secure File Transfer (SFTP) client\n");
2558 printf("%s\n", ver
);
2559 printf("Usage: psftp [options] [user@]host\n");
2560 printf("Options:\n");
2561 printf(" -b file use specified batchfile\n");
2562 printf(" -bc output batchfile commands\n");
2563 printf(" -be don't stop batchfile processing if errors\n");
2564 printf(" -v show verbose messages\n");
2565 printf(" -load sessname Load settings from saved session\n");
2566 printf(" -l user connect with specified username\n");
2567 printf(" -P port connect to specified port\n");
2568 printf(" -pw passw login with specified password\n");
2569 printf(" -1 -2 force use of particular SSH protocol version\n");
2570 printf(" -4 -6 force use of IPv4 or IPv6\n");
2571 printf(" -C enable compression\n");
2572 printf(" -i key private key file for authentication\n");
2573 printf(" -batch disable all interactive prompts\n");
2574 printf(" -V print version information\n");
2578 static void version(void)
2580 printf("psftp: %s\n", ver
);
2585 * Connect to a host.
2587 static int psftp_connect(char *userhost
, char *user
, int portnumber
)
2589 char *host
, *realhost
;
2593 /* Separate host and username */
2595 host
= strrchr(host
, '@');
2601 printf("psftp: multiple usernames specified; using \"%s\"\n",
2608 * If we haven't loaded session details already (e.g., from -load),
2609 * try looking for a session called "host".
2611 if (!loaded_session
) {
2612 /* Try to load settings for `host' into a temporary config */
2614 cfg2
.host
[0] = '\0';
2615 do_defaults(host
, &cfg2
);
2616 if (cfg2
.host
[0] != '\0') {
2617 /* Settings present and include hostname */
2618 /* Re-load data into the real config. */
2619 do_defaults(host
, &cfg
);
2621 /* Session doesn't exist or mention a hostname. */
2622 /* Use `host' as a bare hostname. */
2623 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
2624 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
2627 /* Patch in hostname `host' to session details. */
2628 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
2629 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
2633 * Force use of SSH. (If they got the protocol wrong we assume the
2634 * port is useless too.)
2636 if (cfg
.protocol
!= PROT_SSH
) {
2637 cfg
.protocol
= PROT_SSH
;
2642 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2643 * then change it to SSH-2, on the grounds that that's more likely to
2644 * work for SFTP. (Can be overridden with `-1' option.)
2645 * But if it says `2 only' or `2', respect which.
2647 if (cfg
.sshprot
!= 2 && cfg
.sshprot
!= 3)
2651 * Enact command-line overrides.
2653 cmdline_run_saved(&cfg
);
2656 * Trim leading whitespace off the hostname if it's there.
2659 int space
= strspn(cfg
.host
, " \t");
2660 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
2663 /* See if host is of the form user@host */
2664 if (cfg
.host
[0] != '\0') {
2665 char *atsign
= strrchr(cfg
.host
, '@');
2666 /* Make sure we're not overflowing the user field */
2668 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
2669 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
2670 cfg
.username
[atsign
- cfg
.host
] = '\0';
2672 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
2677 * Trim a colon suffix off the hostname if it's there.
2679 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
2682 * Remove any remaining whitespace from the hostname.
2686 while (cfg
.host
[p2
] != '\0') {
2687 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
2688 cfg
.host
[p1
] = cfg
.host
[p2
];
2693 cfg
.host
[p1
] = '\0';
2697 if (user
!= NULL
&& user
[0] != '\0') {
2698 strncpy(cfg
.username
, user
, sizeof(cfg
.username
) - 1);
2699 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
2701 if (!cfg
.username
[0]) {
2702 if (!console_get_line("login as: ",
2703 cfg
.username
, sizeof(cfg
.username
), FALSE
)) {
2704 fprintf(stderr
, "psftp: no username, aborting\n");
2707 int len
= strlen(cfg
.username
);
2708 if (cfg
.username
[len
- 1] == '\n')
2709 cfg
.username
[len
- 1] = '\0';
2714 cfg
.port
= portnumber
;
2717 * Disable scary things which shouldn't be enabled for simple
2718 * things like SCP and SFTP: agent forwarding, port forwarding,
2721 cfg
.x11_forward
= 0;
2723 cfg
.portfwd
[0] = cfg
.portfwd
[1] = '\0';
2725 /* Set up subsystem name. */
2726 strcpy(cfg
.remote_cmd
, "sftp");
2727 cfg
.ssh_subsys
= TRUE
;
2731 * Set up fallback option, for SSH1 servers or servers with the
2732 * sftp subsystem not enabled but the server binary installed
2733 * in the usual place. We only support fallback on Unix
2734 * systems, and we use a kludgy piece of shellery which should
2735 * try to find sftp-server in various places (the obvious
2736 * systemwide spots /usr/lib and /usr/local/lib, and then the
2737 * user's PATH) and finally give up.
2739 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2740 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2743 * the idea being that this will attempt to use either of the
2744 * obvious pathnames and then give up, and when it does give up
2745 * it will print the preferred pathname in the error messages.
2747 cfg
.remote_cmd_ptr2
=
2748 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2749 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2751 cfg
.ssh_subsys2
= FALSE
;
2753 back
= &ssh_backend
;
2755 err
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
, &realhost
,
2756 0, cfg
.tcp_keepalives
);
2758 fprintf(stderr
, "ssh_init: %s\n", err
);
2761 logctx
= log_init(NULL
, &cfg
);
2762 back
->provide_logctx(backhandle
, logctx
);
2763 console_provide_logctx(logctx
);
2764 while (!back
->sendok(backhandle
)) {
2765 if (ssh_sftp_loop_iteration() < 0) {
2766 fprintf(stderr
, "ssh_init: error during SSH connection setup\n");
2770 if (verbose
&& realhost
!= NULL
)
2771 printf("Connected to %s\n", realhost
);
2772 if (realhost
!= NULL
)
2777 void cmdline_error(char *p
, ...)
2780 fprintf(stderr
, "psftp: ");
2782 vfprintf(stderr
, p
, ap
);
2784 fprintf(stderr
, "\n try typing \"psftp -h\" for help\n");
2789 * Main program. Parse arguments etc.
2791 int psftp_main(int argc
, char *argv
[])
2795 char *userhost
, *user
;
2798 char *batchfile
= NULL
;
2801 flags
= FLAG_STDERR
| FLAG_INTERACTIVE
2802 #ifdef FLAG_SYNCAGENT
2806 cmdline_tooltype
= TOOLTYPE_FILETRANSFER
;
2807 ssh_get_line
= &console_get_line
;
2810 userhost
= user
= NULL
;
2812 /* Load Default Settings before doing anything else. */
2813 do_defaults(NULL
, &cfg
);
2814 loaded_session
= FALSE
;
2817 for (i
= 1; i
< argc
; i
++) {
2819 if (argv
[i
][0] != '-') {
2823 userhost
= dupstr(argv
[i
]);
2826 ret
= cmdline_process_param(argv
[i
], i
+1<argc?argv
[i
+1]:NULL
, 1, &cfg
);
2828 cmdline_error("option \"%s\" requires an argument", argv
[i
]);
2829 } else if (ret
== 2) {
2830 i
++; /* skip next argument */
2831 } else if (ret
== 1) {
2832 /* We have our own verbosity in addition to `flags'. */
2833 if (flags
& FLAG_VERBOSE
)
2835 } else if (strcmp(argv
[i
], "-h") == 0 ||
2836 strcmp(argv
[i
], "-?") == 0) {
2838 } else if (strcmp(argv
[i
], "-V") == 0) {
2840 } else if (strcmp(argv
[i
], "-batch") == 0) {
2841 console_batch_mode
= 1;
2842 } else if (strcmp(argv
[i
], "-b") == 0 && i
+ 1 < argc
) {
2844 batchfile
= argv
[++i
];
2845 } else if (strcmp(argv
[i
], "-bc") == 0) {
2846 modeflags
= modeflags
| 1;
2847 } else if (strcmp(argv
[i
], "-be") == 0) {
2848 modeflags
= modeflags
| 2;
2849 } else if (strcmp(argv
[i
], "--") == 0) {
2853 cmdline_error("unknown option \"%s\"", argv
[i
]);
2861 * If the loaded session provides a hostname, and a hostname has not
2862 * otherwise been specified, pop it in `userhost' so that
2863 * `psftp -load sessname' is sufficient to start a session.
2865 if (!userhost
&& cfg
.host
[0] != '\0') {
2866 userhost
= dupstr(cfg
.host
);
2870 * If a user@host string has already been provided, connect to
2875 ret
= psftp_connect(userhost
, user
, portnumber
);
2882 printf("psftp: no hostname specified; use \"open host.name\""
2886 do_sftp(mode
, modeflags
, batchfile
);
2888 if (back
!= NULL
&& back
->socket(backhandle
) != NULL
) {
2890 back
->special(backhandle
, TS_EOF
);
2891 sftp_recvdata(&ch
, 1);
2896 console_provide_logctx(NULL
);