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 * Determine whether a string is entirely composed of dots.
46 static int is_dots(char *str
)
48 return str
[strspn(str
, ".")] == '\0';
52 * Attempt to canonify a pathname starting from the pwd. If
53 * canonification fails, at least fall back to returning a _valid_
54 * pathname (though it may be ugly, eg /home/simon/../foobar).
56 char *canonify(char *name
)
58 char *fullname
, *canonname
;
59 struct sftp_packet
*pktin
;
60 struct sftp_request
*req
, *rreq
;
63 fullname
= dupstr(name
);
66 if (pwd
[strlen(pwd
) - 1] == '/')
70 fullname
= dupcat(pwd
, slash
, name
, NULL
);
73 sftp_register(req
= fxp_realpath_send(fullname
));
74 rreq
= sftp_find_request(pktin
= sftp_recv());
76 canonname
= fxp_realpath_recv(pktin
, rreq
);
83 * Attempt number 2. Some FXP_REALPATH implementations
84 * (glibc-based ones, in particular) require the _whole_
85 * path to point to something that exists, whereas others
86 * (BSD-based) only require all but the last component to
87 * exist. So if the first call failed, we should strip off
88 * everything from the last slash onwards and try again,
89 * then put the final component back on.
93 * - if the last component is "/." or "/..", then we don't
94 * bother trying this because there's no way it can work.
96 * - if the thing actually ends with a "/", we remove it
97 * before we start. Except if the string is "/" itself
98 * (although I can't see why we'd have got here if so,
99 * because surely "/" would have worked the first
100 * time?), in which case we don't bother.
102 * - if there's no slash in the string at all, give up in
103 * confusion (we expect at least one because of the way
104 * we constructed the string).
110 i
= strlen(fullname
);
111 if (i
> 2 && fullname
[i
- 1] == '/')
112 fullname
[--i
] = '\0'; /* strip trailing / unless at pos 0 */
113 while (i
> 0 && fullname
[--i
] != '/');
116 * Give up on special cases.
118 if (fullname
[i
] != '/' || /* no slash at all */
119 !strcmp(fullname
+ i
, "/.") || /* ends in /. */
120 !strcmp(fullname
+ i
, "/..") || /* ends in /.. */
121 !strcmp(fullname
, "/")) {
126 * Now i points at the slash. Deal with the final special
127 * case i==0 (ie the whole path was "/nonexistentfile").
129 fullname
[i
] = '\0'; /* separate the string */
131 sftp_register(req
= fxp_realpath_send("/"));
133 sftp_register(req
= fxp_realpath_send(fullname
));
135 rreq
= sftp_find_request(pktin
= sftp_recv());
137 canonname
= fxp_realpath_recv(pktin
, rreq
);
140 return fullname
; /* even that failed; give up */
143 * We have a canonical name for all but the last path
144 * component. Concatenate the last component and return.
146 returnname
= dupcat(canonname
,
147 canonname
[strlen(canonname
) - 1] ==
148 '/' ?
"" : "/", fullname
+ i
+ 1, NULL
);
156 * Return a pointer to the portion of str that comes after the last
157 * slash (or backslash or colon, if `local' is TRUE).
159 static char *stripslashes(char *str
, int local
)
164 p
= strchr(str
, ':');
168 p
= strrchr(str
, '/');
172 p
= strrchr(str
, '\\');
180 * qsort comparison routine for fxp_name structures. Sorts by real
183 static int sftp_name_compare(const void *av
, const void *bv
)
185 const struct fxp_name
*const *a
= (const struct fxp_name
*const *) av
;
186 const struct fxp_name
*const *b
= (const struct fxp_name
*const *) bv
;
187 return strcmp((*a
)->filename
, (*b
)->filename
);
191 * Likewise, but for a bare char *.
193 static int bare_name_compare(const void *av
, const void *bv
)
195 const char **a
= (const char **) av
;
196 const char **b
= (const char **) bv
;
197 return strcmp(*a
, *b
);
200 /* ----------------------------------------------------------------------
201 * The meat of the `get' and `put' commands.
203 int sftp_get_file(char *fname
, char *outfname
, int recurse
, int restart
,
206 struct fxp_handle
*fh
;
207 struct sftp_packet
*pktin
;
208 struct sftp_request
*req
, *rreq
;
209 struct fxp_xfer
*xfer
;
215 * In recursive mode, see if we're dealing with a directory.
216 * (If we're not in recursive mode, we need not even check: the
217 * subsequent FXP_OPEN will return a usable error message.)
219 if (wildcard
|| recurse
) {
220 struct fxp_attrs attrs
;
224 sftp_register(req
= fxp_stat_send(fname
));
225 rreq
= sftp_find_request(pktin
= sftp_recv());
227 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
229 result
= 0; /* placate optimisers */
233 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
234 (attrs
.permissions
& 0040000))) {
236 struct fxp_handle
*dirhandle
;
237 int nnames
, namesize
;
238 struct fxp_name
**ournames
;
239 struct fxp_names
*names
;
243 * First, attempt to create the destination directory,
244 * unless it already exists (or this is a wildcard
248 file_type(outfname
) != FILE_TYPE_DIRECTORY
&&
249 !create_directory(outfname
)) {
250 printf("%s: Cannot create directory\n", outfname
);
255 * Now get the list of filenames in the remote
258 sftp_register(req
= fxp_opendir_send(fname
));
259 rreq
= sftp_find_request(pktin
= sftp_recv());
261 dirhandle
= fxp_opendir_recv(pktin
, rreq
);
264 printf("%s: unable to open directory: %s\n",
268 nnames
= namesize
= 0;
273 sftp_register(req
= fxp_readdir_send(dirhandle
));
274 rreq
= sftp_find_request(pktin
= sftp_recv());
276 names
= fxp_readdir_recv(pktin
, rreq
);
279 if (fxp_error_type() == SSH_FX_EOF
)
281 printf("%s: reading directory: %s\n", fname
, fxp_error());
285 if (names
->nnames
== 0) {
286 fxp_free_names(names
);
289 if (nnames
+ names
->nnames
>= namesize
) {
290 namesize
+= names
->nnames
+ 128;
291 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
293 for (i
= 0; i
< names
->nnames
; i
++)
294 if (!is_dots(names
->names
[i
].filename
) &&
295 (!wildcard
|| wc_match(wildcard
,
296 names
->names
[i
].filename
)))
297 ournames
[nnames
++] = fxp_dup_name(&names
->names
[i
]);
298 fxp_free_names(names
);
300 sftp_register(req
= fxp_close_send(dirhandle
));
301 rreq
= sftp_find_request(pktin
= sftp_recv());
303 fxp_close_recv(pktin
, rreq
);
306 * A polite warning if nothing at all matched the
309 if (wildcard
&& !nnames
) {
310 printf("%s: nothing matched\n", wildcard
);
314 * Sort the names into a clear order. This ought to
315 * make things more predictable when we're doing a
316 * reget of the same directory, just in case two
317 * readdirs on the same remote directory return a
320 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
323 * If we're in restart mode, find the last filename on
324 * this list that already exists. We may have to do a
325 * reget on _that_ file, but shouldn't have to do
326 * anything on the previous files.
328 * If none of them exists, of course, we start at 0.
335 nextoutfname
= dir_file_cat(outfname
,
336 ournames
[i
]->filename
);
338 nextoutfname
= dupstr(ournames
[i
]->filename
);
339 ret
= (file_type(nextoutfname
) == FILE_TYPE_NONEXISTENT
);
349 * Now we're ready to recurse. Starting at ournames[i]
350 * and continuing on to the end of the list, we
351 * construct a new source and target file name, and
352 * call sftp_get_file again.
354 for (; i
< nnames
; i
++) {
355 char *nextfname
, *nextoutfname
;
358 nextfname
= dupcat(fname
, "/", ournames
[i
]->filename
, NULL
);
360 nextoutfname
= dir_file_cat(outfname
,
361 ournames
[i
]->filename
);
363 nextoutfname
= dupstr(ournames
[i
]->filename
);
364 ret
= sftp_get_file(nextfname
, nextoutfname
,
365 recurse
, restart
, NULL
);
366 restart
= FALSE
; /* after first partial file, do full */
370 for (i
= 0; i
< nnames
; i
++) {
371 fxp_free_name(ournames
[i
]);
379 * Done this recursion level. Free everything.
381 for (i
= 0; i
< nnames
; i
++) {
382 fxp_free_name(ournames
[i
]);
390 sftp_register(req
= fxp_open_send(fname
, SSH_FXF_READ
));
391 rreq
= sftp_find_request(pktin
= sftp_recv());
393 fh
= fxp_open_recv(pktin
, rreq
);
396 printf("%s: %s\n", fname
, fxp_error());
401 fp
= fopen(outfname
, "rb+");
403 fp
= fopen(outfname
, "wb");
407 printf("local: unable to open %s\n", outfname
);
409 sftp_register(req
= fxp_close_send(fh
));
410 rreq
= sftp_find_request(pktin
= sftp_recv());
412 fxp_close_recv(pktin
, rreq
);
419 fseek(fp
, 0L, SEEK_END
);
421 printf("reget: restarting at file position %ld\n", posn
);
422 offset
= uint64_make(0, posn
);
424 offset
= uint64_make(0, 0);
427 printf("remote:%s => local:%s\n", fname
, outfname
);
430 * FIXME: we can use FXP_FSTAT here to get the file size, and
431 * thus put up a progress bar.
434 xfer
= xfer_download_init(fh
, offset
);
435 while (!xfer_done(xfer
)) {
440 xfer_download_queue(xfer
);
442 ret
= xfer_download_gotpkt(xfer
, pktin
);
445 printf("error while reading: %s\n", fxp_error());
449 while (xfer_download_data(xfer
, &vbuf
, &len
)) {
450 unsigned char *buf
= (unsigned char *)vbuf
;
454 wlen
= fwrite(buf
+ wpos
, 1, len
- wpos
, fp
);
456 printf("error while writing local file\n");
458 xfer_set_error(xfer
);
462 if (wpos
< len
) { /* we had an error */
464 xfer_set_error(xfer
);
475 sftp_register(req
= fxp_close_send(fh
));
476 rreq
= sftp_find_request(pktin
= sftp_recv());
478 fxp_close_recv(pktin
, rreq
);
483 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 (wildcard
|| (recurse
&& file_type(fname
) == FILE_TYPE_DIRECTORY
)) {
500 struct fxp_attrs attrs
;
502 int nnames
, namesize
;
503 char *name
, **ournames
;
509 * First, attempt to create the destination directory,
510 * unless it already exists.
512 sftp_register(req
= fxp_stat_send(outfname
));
513 rreq
= sftp_find_request(pktin
= sftp_recv());
515 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
517 !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) ||
518 !(attrs
.permissions
& 0040000)) {
519 sftp_register(req
= fxp_mkdir_send(outfname
));
520 rreq
= sftp_find_request(pktin
= sftp_recv());
522 result
= fxp_mkdir_recv(pktin
, rreq
);
525 printf("%s: create directory: %s\n",
526 outfname
, fxp_error());
533 * Now get the list of filenames in the local directory.
535 nnames
= namesize
= 0;
538 WildcardMatcher
*wcm
;
540 wcm
= begin_wildcard_matching(wildcard
);
542 while ((name
= wildcard_get_filename(wcm
)) != NULL
) {
543 if (nnames
>= namesize
) {
545 ournames
= sresize(ournames
, namesize
, char *);
547 ournames
[nnames
++] = name
;
549 finish_wildcard_matching(wcm
);
552 dh
= open_directory(fname
);
554 printf("%s: unable to open directory\n", fname
);
557 while ((name
= read_filename(dh
)) != NULL
) {
558 if (nnames
>= namesize
) {
560 ournames
= sresize(ournames
, namesize
, char *);
562 ournames
[nnames
++] = name
;
568 * A polite warning if nothing at all matched the
571 if (wildcard
&& !nnames
) {
572 printf("%s: nothing matched\n", wildcard
);
576 * Sort the names into a clear order. This ought to make
577 * things more predictable when we're doing a reput of the
578 * same directory, just in case two readdirs on the same
579 * local directory return a different order.
581 qsort(ournames
, nnames
, sizeof(*ournames
), bare_name_compare
);
584 * If we're in restart mode, find the last filename on this
585 * list that already exists. We may have to do a reput on
586 * _that_ file, but shouldn't have to do anything on the
589 * If none of them exists, of course, we start at 0.
594 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
595 sftp_register(req
= fxp_stat_send(nextoutfname
));
596 rreq
= sftp_find_request(pktin
= sftp_recv());
598 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
608 * Now we're ready to recurse. Starting at ournames[i]
609 * and continuing on to the end of the list, we
610 * construct a new source and target file name, and
611 * call sftp_put_file again.
613 for (; i
< nnames
; i
++) {
614 char *nextfname
, *nextoutfname
;
618 nextfname
= dir_file_cat(fname
, ournames
[i
]);
620 nextfname
= dupstr(ournames
[i
]);
621 nextoutfname
= dupcat(outfname
, "/", ournames
[i
], NULL
);
622 ret
= sftp_put_file(nextfname
, nextoutfname
,
623 recurse
, restart
, NULL
);
624 restart
= FALSE
; /* after first partial file, do full */
628 for (i
= 0; i
< nnames
; i
++) {
637 * Done this recursion level. Free everything.
639 for (i
= 0; i
< nnames
; i
++) {
647 fp
= fopen(fname
, "rb");
649 printf("local: unable to open %s\n", fname
);
653 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
));
655 sftp_register(req
= fxp_open_send(outfname
, SSH_FXF_WRITE
|
656 SSH_FXF_CREAT
| SSH_FXF_TRUNC
));
658 rreq
= sftp_find_request(pktin
= sftp_recv());
660 fh
= fxp_open_recv(pktin
, rreq
);
663 printf("%s: %s\n", outfname
, fxp_error());
669 struct fxp_attrs attrs
;
672 sftp_register(req
= fxp_fstat_send(fh
));
673 rreq
= sftp_find_request(pktin
= sftp_recv());
675 ret
= fxp_fstat_recv(pktin
, rreq
, &attrs
);
678 printf("read size of %s: %s\n", outfname
, fxp_error());
681 if (!(attrs
.flags
& SSH_FILEXFER_ATTR_SIZE
)) {
682 printf("read size of %s: size was not given\n", outfname
);
686 uint64_decimal(offset
, decbuf
);
687 printf("reput: restarting at file position %s\n", decbuf
);
688 if (uint64_compare(offset
, uint64_make(0, LONG_MAX
)) > 0) {
689 printf("reput: remote file is larger than we can deal with\n");
692 if (fseek(fp
, offset
.lo
, SEEK_SET
) != 0)
693 fseek(fp
, 0, SEEK_END
); /* *shrug* */
695 offset
= uint64_make(0, 0);
698 printf("local:%s => remote:%s\n", fname
, outfname
);
701 * FIXME: we can use FXP_FSTAT here to get the file size, and
702 * thus put up a progress bar.
705 xfer
= xfer_upload_init(fh
, offset
);
707 while ((!err
&& !eof
) || !xfer_done(xfer
)) {
711 while (xfer_upload_ready(xfer
) && !err
&& !eof
) {
712 len
= fread(buffer
, 1, sizeof(buffer
), fp
);
714 printf("error while reading local file\n");
716 } else if (len
== 0) {
719 xfer_upload_data(xfer
, buffer
, len
);
723 if (!xfer_done(xfer
)) {
725 ret
= xfer_upload_gotpkt(xfer
, pktin
);
727 printf("error while writing: %s\n", fxp_error());
735 sftp_register(req
= fxp_close_send(fh
));
736 rreq
= sftp_find_request(pktin
= sftp_recv());
738 fxp_close_recv(pktin
, rreq
);
745 /* ----------------------------------------------------------------------
746 * Actual sftp commands.
748 struct sftp_command
{
750 int nwords
, wordssize
;
751 int (*obey
) (struct sftp_command
*); /* returns <0 to quit */
754 int sftp_cmd_null(struct sftp_command
*cmd
)
756 return 1; /* success */
759 int sftp_cmd_unknown(struct sftp_command
*cmd
)
761 printf("psftp: unknown command \"%s\"\n", cmd
->words
[0]);
762 return 0; /* failure */
765 int sftp_cmd_quit(struct sftp_command
*cmd
)
770 int sftp_cmd_close(struct sftp_command
*cmd
)
773 printf("psftp: not connected to a host; use \"open host.name\"\n");
777 if (back
!= NULL
&& back
->socket(backhandle
) != NULL
) {
779 back
->special(backhandle
, TS_EOF
);
780 sftp_recvdata(&ch
, 1);
788 * List a directory. If no arguments are given, list pwd; otherwise
789 * list the directory given in words[1].
791 int sftp_cmd_ls(struct sftp_command
*cmd
)
793 struct fxp_handle
*dirh
;
794 struct fxp_names
*names
;
795 struct fxp_name
**ournames
;
796 int nnames
, namesize
;
797 char *dir
, *cdir
, *unwcdir
, *wildcard
;
798 struct sftp_packet
*pktin
;
799 struct sftp_request
*req
, *rreq
;
803 printf("psftp: not connected to a host; use \"open host.name\"\n");
812 unwcdir
= snewn(1 + strlen(dir
), char);
813 if (wc_unescape(unwcdir
, dir
)) {
820 wildcard
= stripslashes(dir
, 0);
821 unwcdir
= dupstr(dir
);
822 len
= wildcard
- dir
;
824 if (len
> 0 && unwcdir
[len
-1] == '/')
825 unwcdir
[len
-1] = '\0';
826 tmpdir
= snewn(1 + len
, char);
827 check
= wc_unescape(tmpdir
, unwcdir
);
830 printf("Multiple-level wildcards are not supported\n");
837 cdir
= canonify(dir
);
839 printf("%s: %s\n", dir
, fxp_error());
844 printf("Listing directory %s\n", cdir
);
846 sftp_register(req
= fxp_opendir_send(cdir
));
847 rreq
= sftp_find_request(pktin
= sftp_recv());
849 dirh
= fxp_opendir_recv(pktin
, rreq
);
852 printf("Unable to open %s: %s\n", dir
, fxp_error());
854 nnames
= namesize
= 0;
859 sftp_register(req
= fxp_readdir_send(dirh
));
860 rreq
= sftp_find_request(pktin
= sftp_recv());
862 names
= fxp_readdir_recv(pktin
, rreq
);
865 if (fxp_error_type() == SSH_FX_EOF
)
867 printf("Reading directory %s: %s\n", dir
, fxp_error());
870 if (names
->nnames
== 0) {
871 fxp_free_names(names
);
875 if (nnames
+ names
->nnames
>= namesize
) {
876 namesize
+= names
->nnames
+ 128;
877 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
880 for (i
= 0; i
< names
->nnames
; i
++)
881 if (!wildcard
|| wc_match(wildcard
, names
->names
[i
].filename
))
882 ournames
[nnames
++] = fxp_dup_name(&names
->names
[i
]);
884 fxp_free_names(names
);
886 sftp_register(req
= fxp_close_send(dirh
));
887 rreq
= sftp_find_request(pktin
= sftp_recv());
889 fxp_close_recv(pktin
, rreq
);
892 * Now we have our filenames. Sort them by actual file
893 * name, and then output the longname parts.
895 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
900 for (i
= 0; i
< nnames
; i
++) {
901 printf("%s\n", ournames
[i
]->longname
);
902 fxp_free_name(ournames
[i
]);
914 * Change directories. We do this by canonifying the new name, then
915 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
917 int sftp_cmd_cd(struct sftp_command
*cmd
)
919 struct fxp_handle
*dirh
;
920 struct sftp_packet
*pktin
;
921 struct sftp_request
*req
, *rreq
;
925 printf("psftp: not connected to a host; use \"open host.name\"\n");
930 dir
= dupstr(homedir
);
932 dir
= canonify(cmd
->words
[1]);
935 printf("%s: %s\n", dir
, fxp_error());
939 sftp_register(req
= fxp_opendir_send(dir
));
940 rreq
= sftp_find_request(pktin
= sftp_recv());
942 dirh
= fxp_opendir_recv(pktin
, rreq
);
945 printf("Directory %s: %s\n", dir
, fxp_error());
950 sftp_register(req
= fxp_close_send(dirh
));
951 rreq
= sftp_find_request(pktin
= sftp_recv());
953 fxp_close_recv(pktin
, rreq
);
957 printf("Remote directory is now %s\n", pwd
);
963 * Print current directory. Easy as pie.
965 int sftp_cmd_pwd(struct sftp_command
*cmd
)
968 printf("psftp: not connected to a host; use \"open host.name\"\n");
972 printf("Remote directory is %s\n", pwd
);
977 * Get a file and save it at the local end. We have three very
978 * similar commands here. The basic one is `get'; `reget' differs
979 * in that it checks for the existence of the destination file and
980 * starts from where a previous aborted transfer left off; `mget'
981 * differs in that it interprets all its arguments as files to
982 * transfer (never as a different local name for a remote file) and
983 * can handle wildcards.
985 int sftp_general_get(struct sftp_command
*cmd
, int restart
, int multiple
)
987 char *fname
, *unwcfname
, *origfname
, *outfname
;
992 printf("psftp: not connected to a host; use \"open host.name\"\n");
997 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
998 if (!strcmp(cmd
->words
[i
], "--")) {
999 /* finish processing options */
1002 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1005 printf("get: unrecognised option '%s'\n", cmd
->words
[i
]);
1011 if (i
>= cmd
->nwords
) {
1012 printf("get: expects a filename\n");
1018 origfname
= cmd
->words
[i
++];
1021 !wc_unescape(unwcfname
= snewn(strlen(origfname
)+1, char),
1023 ret
= sftp_get_file(pwd
, NULL
, recurse
, restart
, origfname
);
1025 fname
= canonify(origfname
);
1027 printf("%s: %s\n", origfname
, fxp_error());
1032 if (!multiple
&& i
< cmd
->nwords
)
1033 outfname
= cmd
->words
[i
++];
1035 outfname
= stripslashes(origfname
, 0);
1037 ret
= sftp_get_file(fname
, outfname
, recurse
, restart
, NULL
);
1045 } while (multiple
&& i
< cmd
->nwords
);
1049 int sftp_cmd_get(struct sftp_command
*cmd
)
1051 return sftp_general_get(cmd
, 0, 0);
1053 int sftp_cmd_mget(struct sftp_command
*cmd
)
1055 return sftp_general_get(cmd
, 0, 1);
1057 int sftp_cmd_reget(struct sftp_command
*cmd
)
1059 return sftp_general_get(cmd
, 1, 0);
1063 * Send a file and store it at the remote end. We have three very
1064 * similar commands here. The basic one is `put'; `reput' differs
1065 * in that it checks for the existence of the destination file and
1066 * starts from where a previous aborted transfer left off; `mput'
1067 * differs in that it interprets all its arguments as files to
1068 * transfer (never as a different remote name for a local file) and
1069 * can handle wildcards.
1071 int sftp_general_put(struct sftp_command
*cmd
, int restart
, int multiple
)
1073 char *fname
, *origoutfname
, *outfname
;
1075 int recurse
= FALSE
;
1078 printf("psftp: not connected to a host; use \"open host.name\"\n");
1083 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1084 if (!strcmp(cmd
->words
[i
], "--")) {
1085 /* finish processing options */
1088 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1091 printf("put: unrecognised option '%s'\n", cmd
->words
[i
]);
1097 if (i
>= cmd
->nwords
) {
1098 printf("put: expects a filename\n");
1103 fname
= cmd
->words
[i
++];
1105 if (multiple
&& test_wildcard(fname
, FALSE
) == WCTYPE_WILDCARD
) {
1106 ret
= sftp_put_file(NULL
, pwd
, recurse
, restart
, fname
);
1108 if (!multiple
&& i
< cmd
->nwords
)
1109 origoutfname
= cmd
->words
[i
++];
1111 origoutfname
= stripslashes(fname
, 1);
1113 outfname
= canonify(origoutfname
);
1115 printf("%s: %s\n", origoutfname
, fxp_error());
1118 ret
= sftp_put_file(fname
, outfname
, recurse
, restart
, NULL
);
1124 } while (multiple
&& i
< cmd
->nwords
);
1128 int sftp_cmd_put(struct sftp_command
*cmd
)
1130 return sftp_general_put(cmd
, 0, 0);
1132 int sftp_cmd_mput(struct sftp_command
*cmd
)
1134 return sftp_general_put(cmd
, 0, 1);
1136 int sftp_cmd_reput(struct sftp_command
*cmd
)
1138 return sftp_general_put(cmd
, 1, 0);
1141 int sftp_cmd_mkdir(struct sftp_command
*cmd
)
1144 struct sftp_packet
*pktin
;
1145 struct sftp_request
*req
, *rreq
;
1149 printf("psftp: not connected to a host; use \"open host.name\"\n");
1153 if (cmd
->nwords
< 2) {
1154 printf("mkdir: expects a directory\n");
1158 dir
= canonify(cmd
->words
[1]);
1160 printf("%s: %s\n", dir
, fxp_error());
1164 sftp_register(req
= fxp_mkdir_send(dir
));
1165 rreq
= sftp_find_request(pktin
= sftp_recv());
1166 assert(rreq
== req
);
1167 result
= fxp_mkdir_recv(pktin
, rreq
);
1170 printf("mkdir %s: %s\n", dir
, fxp_error());
1179 int sftp_cmd_rmdir(struct sftp_command
*cmd
)
1182 struct sftp_packet
*pktin
;
1183 struct sftp_request
*req
, *rreq
;
1187 printf("psftp: not connected to a host; use \"open host.name\"\n");
1191 if (cmd
->nwords
< 2) {
1192 printf("rmdir: expects a directory\n");
1196 dir
= canonify(cmd
->words
[1]);
1198 printf("%s: %s\n", dir
, fxp_error());
1202 sftp_register(req
= fxp_rmdir_send(dir
));
1203 rreq
= sftp_find_request(pktin
= sftp_recv());
1204 assert(rreq
== req
);
1205 result
= fxp_rmdir_recv(pktin
, rreq
);
1208 printf("rmdir %s: %s\n", dir
, fxp_error());
1217 int sftp_cmd_rm(struct sftp_command
*cmd
)
1220 struct sftp_packet
*pktin
;
1221 struct sftp_request
*req
, *rreq
;
1225 printf("psftp: not connected to a host; use \"open host.name\"\n");
1229 if (cmd
->nwords
< 2) {
1230 printf("rm: expects a filename\n");
1234 fname
= canonify(cmd
->words
[1]);
1236 printf("%s: %s\n", fname
, fxp_error());
1240 sftp_register(req
= fxp_remove_send(fname
));
1241 rreq
= sftp_find_request(pktin
= sftp_recv());
1242 assert(rreq
== req
);
1243 result
= fxp_remove_recv(pktin
, rreq
);
1246 printf("rm %s: %s\n", fname
, fxp_error());
1255 int sftp_cmd_mv(struct sftp_command
*cmd
)
1257 char *srcfname
, *dstfname
;
1258 struct sftp_packet
*pktin
;
1259 struct sftp_request
*req
, *rreq
;
1263 printf("psftp: not connected to a host; use \"open host.name\"\n");
1267 if (cmd
->nwords
< 3) {
1268 printf("mv: expects two filenames\n");
1271 srcfname
= canonify(cmd
->words
[1]);
1273 printf("%s: %s\n", srcfname
, fxp_error());
1277 dstfname
= canonify(cmd
->words
[2]);
1279 printf("%s: %s\n", dstfname
, fxp_error());
1283 sftp_register(req
= fxp_rename_send(srcfname
, dstfname
));
1284 rreq
= sftp_find_request(pktin
= sftp_recv());
1285 assert(rreq
== req
);
1286 result
= fxp_rename_recv(pktin
, rreq
);
1289 char const *error
= fxp_error();
1290 struct fxp_attrs attrs
;
1293 * The move might have failed because dstfname pointed at a
1294 * directory. We check this possibility now: if dstfname
1295 * _is_ a directory, we re-attempt the move by appending
1296 * the basename of srcfname to dstfname.
1298 sftp_register(req
= fxp_stat_send(dstfname
));
1299 rreq
= sftp_find_request(pktin
= sftp_recv());
1300 assert(rreq
== req
);
1301 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1304 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
1305 (attrs
.permissions
& 0040000)) {
1307 char *newname
, *newcanon
;
1308 printf("(destination %s is a directory)\n", dstfname
);
1309 p
= srcfname
+ strlen(srcfname
);
1310 while (p
> srcfname
&& p
[-1] != '/') p
--;
1311 newname
= dupcat(dstfname
, "/", p
, NULL
);
1312 newcanon
= canonify(newname
);
1316 dstfname
= newcanon
;
1318 sftp_register(req
= fxp_rename_send(srcfname
, dstfname
));
1319 rreq
= sftp_find_request(pktin
= sftp_recv());
1320 assert(rreq
== req
);
1321 result
= fxp_rename_recv(pktin
, rreq
);
1323 error
= result ? NULL
: fxp_error();
1327 printf("mv %s %s: %s\n", srcfname
, dstfname
, error
);
1333 printf("%s -> %s\n", srcfname
, dstfname
);
1340 int sftp_cmd_chmod(struct sftp_command
*cmd
)
1344 struct fxp_attrs attrs
;
1345 unsigned attrs_clr
, attrs_xor
, oldperms
, newperms
;
1346 struct sftp_packet
*pktin
;
1347 struct sftp_request
*req
, *rreq
;
1350 printf("psftp: not connected to a host; use \"open host.name\"\n");
1354 if (cmd
->nwords
< 3) {
1355 printf("chmod: expects a mode specifier and a filename\n");
1360 * Attempt to parse the mode specifier in cmd->words[1]. We
1361 * don't support the full horror of Unix chmod; instead we
1362 * support a much simpler syntax in which the user can either
1363 * specify an octal number, or a comma-separated sequence of
1364 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1365 * _only_ be omitted if the only attribute mentioned is t,
1366 * since all others require a user/group/other specification.
1367 * Additionally, the s attribute may not be specified for any
1368 * [ugoa] specifications other than exactly u or exactly g.
1370 attrs_clr
= attrs_xor
= 0;
1371 mode
= cmd
->words
[1];
1372 if (mode
[0] >= '0' && mode
[0] <= '9') {
1373 if (mode
[strspn(mode
, "01234567")]) {
1374 printf("chmod: numeric file modes should"
1375 " contain digits 0-7 only\n");
1379 sscanf(mode
, "%o", &attrs_xor
);
1380 attrs_xor
&= attrs_clr
;
1383 char *modebegin
= mode
;
1384 unsigned subset
, perms
;
1388 while (*mode
&& *mode
!= ',' &&
1389 *mode
!= '+' && *mode
!= '-' && *mode
!= '=') {
1391 case 'u': subset
|= 04700; break; /* setuid, user perms */
1392 case 'g': subset
|= 02070; break; /* setgid, group perms */
1393 case 'o': subset
|= 00007; break; /* just other perms */
1394 case 'a': subset
|= 06777; break; /* all of the above */
1396 printf("chmod: file mode '%.*s' contains unrecognised"
1397 " user/group/other specifier '%c'\n",
1398 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1403 if (!*mode
|| *mode
== ',') {
1404 printf("chmod: file mode '%.*s' is incomplete\n",
1405 (int)strcspn(modebegin
, ","), modebegin
);
1409 if (!*mode
|| *mode
== ',') {
1410 printf("chmod: file mode '%.*s' is incomplete\n",
1411 (int)strcspn(modebegin
, ","), modebegin
);
1415 while (*mode
&& *mode
!= ',') {
1417 case 'r': perms
|= 00444; break;
1418 case 'w': perms
|= 00222; break;
1419 case 'x': perms
|= 00111; break;
1420 case 't': perms
|= 01000; subset
|= 01000; break;
1422 if ((subset
& 06777) != 04700 &&
1423 (subset
& 06777) != 02070) {
1424 printf("chmod: file mode '%.*s': set[ug]id bit should"
1425 " be used with exactly one of u or g only\n",
1426 (int)strcspn(modebegin
, ","), modebegin
);
1432 printf("chmod: file mode '%.*s' contains unrecognised"
1433 " permission specifier '%c'\n",
1434 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1439 if (!(subset
& 06777) && (perms
&~ subset
)) {
1440 printf("chmod: file mode '%.*s' contains no user/group/other"
1441 " specifier and permissions other than 't' \n",
1442 (int)strcspn(modebegin
, ","), modebegin
);
1453 attrs_xor
&= ~perms
;
1456 attrs_clr
|= subset
;
1460 if (*mode
) mode
++; /* eat comma */
1464 fname
= canonify(cmd
->words
[2]);
1466 printf("%s: %s\n", fname
, fxp_error());
1470 sftp_register(req
= fxp_stat_send(fname
));
1471 rreq
= sftp_find_request(pktin
= sftp_recv());
1472 assert(rreq
== req
);
1473 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1475 if (!result
|| !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
)) {
1476 printf("get attrs for %s: %s\n", fname
,
1477 result ?
"file permissions not provided" : fxp_error());
1482 attrs
.flags
= SSH_FILEXFER_ATTR_PERMISSIONS
; /* perms _only_ */
1483 oldperms
= attrs
.permissions
& 07777;
1484 attrs
.permissions
&= ~attrs_clr
;
1485 attrs
.permissions
^= attrs_xor
;
1486 newperms
= attrs
.permissions
& 07777;
1488 sftp_register(req
= fxp_setstat_send(fname
, attrs
));
1489 rreq
= sftp_find_request(pktin
= sftp_recv());
1490 assert(rreq
== req
);
1491 result
= fxp_setstat_recv(pktin
, rreq
);
1494 printf("set attrs for %s: %s\n", fname
, fxp_error());
1499 printf("%s: %04o -> %04o\n", fname
, oldperms
, newperms
);
1505 static int sftp_cmd_open(struct sftp_command
*cmd
)
1510 printf("psftp: already connected\n");
1514 if (cmd
->nwords
< 2) {
1515 printf("open: expects a host name\n");
1519 if (cmd
->nwords
> 2) {
1520 portnumber
= atoi(cmd
->words
[2]);
1521 if (portnumber
== 0) {
1522 printf("open: invalid port number\n");
1528 if (psftp_connect(cmd
->words
[1], NULL
, portnumber
)) {
1529 back
= NULL
; /* connection is already closed */
1530 return -1; /* this is fatal */
1536 static int sftp_cmd_lcd(struct sftp_command
*cmd
)
1538 char *currdir
, *errmsg
;
1540 if (cmd
->nwords
< 2) {
1541 printf("lcd: expects a local directory name\n");
1545 errmsg
= psftp_lcd(cmd
->words
[1]);
1547 printf("lcd: unable to change directory: %s\n", errmsg
);
1552 currdir
= psftp_getcwd();
1553 printf("New local directory is %s\n", currdir
);
1559 static int sftp_cmd_lpwd(struct sftp_command
*cmd
)
1563 currdir
= psftp_getcwd();
1564 printf("Current local directory is %s\n", currdir
);
1570 static int sftp_cmd_pling(struct sftp_command
*cmd
)
1574 exitcode
= system(cmd
->words
[1]);
1575 return (exitcode
== 0);
1578 static int sftp_cmd_help(struct sftp_command
*cmd
);
1580 static struct sftp_cmd_lookup
{
1583 * For help purposes, there are two kinds of command:
1585 * - primary commands, in which `longhelp' is non-NULL. In
1586 * this case `shorthelp' is descriptive text, and `longhelp'
1587 * is longer descriptive text intended to be printed after
1590 * - alias commands, in which `longhelp' is NULL. In this case
1591 * `shorthelp' is the name of a primary command, which
1592 * contains the help that should double up for this command.
1594 int listed
; /* do we list this in primary help? */
1597 int (*obey
) (struct sftp_command
*);
1600 * List of sftp commands. This is binary-searched so it MUST be
1604 "!", TRUE
, "run a local command",
1606 /* FIXME: this example is crap for non-Windows. */
1607 " Runs a local command. For example, \"!del myfile\".\n",
1611 "bye", TRUE
, "finish your SFTP session",
1613 " Terminates your SFTP session and quits the PSFTP program.\n",
1617 "cd", TRUE
, "change your remote working directory",
1618 " [ <New working directory> ]\n"
1619 " Change the remote working directory for your SFTP session.\n"
1620 " If a new working directory is not supplied, you will be\n"
1621 " returned to your home directory.\n",
1625 "chmod", TRUE
, "change file permissions and modes",
1626 " ( <octal-digits> | <modifiers> ) <filename>\n"
1627 " Change the file permissions on a file or directory.\n"
1628 " <octal-digits> can be any octal Unix permission specifier.\n"
1629 " Alternatively, <modifiers> can include:\n"
1630 " u+r make file readable by owning user\n"
1631 " u+w make file writable by owning user\n"
1632 " u+x make file executable by owning user\n"
1633 " u-r make file not readable by owning user\n"
1634 " [also u-w, u-x]\n"
1635 " g+r make file readable by members of owning group\n"
1636 " [also g+w, g+x, g-r, g-w, g-x]\n"
1637 " o+r make file readable by all other users\n"
1638 " [also o+w, o+x, o-r, o-w, o-x]\n"
1639 " a+r make file readable by absolutely everybody\n"
1640 " [also a+w, a+x, a-r, a-w, a-x]\n"
1641 " u+s enable the Unix set-user-ID bit\n"
1642 " u-s disable the Unix set-user-ID bit\n"
1643 " g+s enable the Unix set-group-ID bit\n"
1644 " g-s disable the Unix set-group-ID bit\n"
1645 " +t enable the Unix \"sticky bit\"\n"
1646 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1647 " more than one user for the same modifier (\"ug+w\"). You can\n"
1648 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1652 "close", TRUE
, "finish your SFTP session but do not quit PSFTP",
1654 " Terminates your SFTP session, but does not quit the PSFTP\n"
1655 " program. You can then use \"open\" to start another SFTP\n"
1656 " session, to the same server or to a different one.\n",
1660 "del", TRUE
, "delete a file",
1662 " Delete a file.\n",
1666 "delete", FALSE
, "del", NULL
, sftp_cmd_rm
1669 "dir", TRUE
, "list contents of a remote directory",
1670 " [ <directory-name> ]\n"
1671 " List the contents of a specified directory on the server.\n"
1672 " If <directory-name> is not given, the current working directory\n"
1673 " will be listed.\n",
1677 "exit", TRUE
, "bye", NULL
, sftp_cmd_quit
1680 "get", TRUE
, "download a file from the server to your local machine",
1681 " <filename> [ <local-filename> ]\n"
1682 " Downloads a file on the server and stores it locally under\n"
1683 " the same name, or under a different one if you supply the\n"
1684 " argument <local-filename>.\n",
1688 "help", TRUE
, "give help",
1689 " [ <command> [ <command> ... ] ]\n"
1690 " Give general help if no commands are specified.\n"
1691 " If one or more commands are specified, give specific help on\n"
1692 " those particular commands.\n",
1696 "lcd", TRUE
, "change local working directory",
1697 " <local-directory-name>\n"
1698 " Change the local working directory of the PSFTP program (the\n"
1699 " default location where the \"get\" command will save files).\n",
1703 "lpwd", TRUE
, "print local working directory",
1705 " Print the local working directory of the PSFTP program (the\n"
1706 " default location where the \"get\" command will save files).\n",
1710 "ls", TRUE
, "dir", NULL
,
1714 "mget", TRUE
, "download multiple files at once",
1715 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1716 " Downloads many files from the server, storing each one under\n"
1717 " the same name it has on the server side. You can use wildcards\n"
1718 " such as \"*.c\" to specify lots of files at once.\n",
1722 "mkdir", TRUE
, "create a directory on the remote server",
1723 " <directory-name>\n"
1724 " Creates a directory with the given name on the server.\n",
1728 "mput", TRUE
, "upload multiple files at once",
1729 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1730 " Uploads many files to the server, storing each one under the\n"
1731 " same name it has on the client side. You can use wildcards\n"
1732 " such as \"*.c\" to specify lots of files at once.\n",
1736 "mv", TRUE
, "move or rename a file on the remote server",
1737 " <source-filename> <destination-filename>\n"
1738 " Moves or renames the file <source-filename> on the server,\n"
1739 " so that it is accessible under the name <destination-filename>.\n",
1743 "open", TRUE
, "connect to a host",
1744 " [<user>@]<hostname> [<port>]\n"
1745 " Establishes an SFTP connection to a given host. Only usable\n"
1746 " when you did not already specify a host name on the command\n"
1751 "put", TRUE
, "upload a file from your local machine to the server",
1752 " <filename> [ <remote-filename> ]\n"
1753 " Uploads a file to the server and stores it there under\n"
1754 " the same name, or under a different one if you supply the\n"
1755 " argument <remote-filename>.\n",
1759 "pwd", TRUE
, "print your remote working directory",
1761 " Print the current remote working directory for your SFTP session.\n",
1765 "quit", TRUE
, "bye", NULL
,
1769 "reget", TRUE
, "continue downloading a file",
1770 " <filename> [ <local-filename> ]\n"
1771 " Works exactly like the \"get\" command, but the local file\n"
1772 " must already exist. The download will begin at the end of the\n"
1773 " file. This is for resuming a download that was interrupted.\n",
1777 "ren", TRUE
, "mv", NULL
,
1781 "rename", FALSE
, "mv", NULL
,
1785 "reput", TRUE
, "continue uploading a file",
1786 " <filename> [ <remote-filename> ]\n"
1787 " Works exactly like the \"put\" command, but the remote file\n"
1788 " must already exist. The upload will begin at the end of the\n"
1789 " file. This is for resuming an upload that was interrupted.\n",
1793 "rm", TRUE
, "del", NULL
,
1797 "rmdir", TRUE
, "remove a directory on the remote server",
1798 " <directory-name>\n"
1799 " Removes the directory with the given name on the server.\n"
1800 " The directory will not be removed unless it is empty.\n",
1805 const struct sftp_cmd_lookup
*lookup_command(char *name
)
1810 j
= sizeof(sftp_lookup
) / sizeof(*sftp_lookup
);
1813 cmp
= strcmp(name
, sftp_lookup
[k
].name
);
1819 return &sftp_lookup
[k
];
1825 static int sftp_cmd_help(struct sftp_command
*cmd
)
1828 if (cmd
->nwords
== 1) {
1830 * Give short help on each command.
1834 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
1836 if (!sftp_lookup
[i
].listed
)
1838 len
= strlen(sftp_lookup
[i
].name
);
1842 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
1843 const struct sftp_cmd_lookup
*lookup
;
1844 if (!sftp_lookup
[i
].listed
)
1846 lookup
= &sftp_lookup
[i
];
1847 printf("%-*s", maxlen
+2, lookup
->name
);
1848 if (lookup
->longhelp
== NULL
)
1849 lookup
= lookup_command(lookup
->shorthelp
);
1850 printf("%s\n", lookup
->shorthelp
);
1854 * Give long help on specific commands.
1856 for (i
= 1; i
< cmd
->nwords
; i
++) {
1857 const struct sftp_cmd_lookup
*lookup
;
1858 lookup
= lookup_command(cmd
->words
[i
]);
1860 printf("help: %s: command not found\n", cmd
->words
[i
]);
1862 printf("%s", lookup
->name
);
1863 if (lookup
->longhelp
== NULL
)
1864 lookup
= lookup_command(lookup
->shorthelp
);
1865 printf("%s", lookup
->longhelp
);
1872 /* ----------------------------------------------------------------------
1873 * Command line reading and parsing.
1875 struct sftp_command
*sftp_getcmd(FILE *fp
, int mode
, int modeflags
)
1878 struct sftp_command
*cmd
;
1882 cmd
= snew(struct sftp_command
);
1892 line
= fgetline(fp
);
1894 line
= ssh_sftp_get_cmdline("psftp> ", back
== NULL
);
1897 if (!line
|| !*line
) {
1898 cmd
->obey
= sftp_cmd_quit
;
1899 if ((mode
== 0) || (modeflags
& 1))
1901 return cmd
; /* eof */
1904 line
[strcspn(line
, "\r\n")] = '\0';
1906 if (modeflags
& 1) {
1907 printf("%s\n", line
);
1911 while (*p
&& (*p
== ' ' || *p
== '\t'))
1916 * Special case: the ! command. This is always parsed as
1917 * exactly two words: one containing the !, and the second
1918 * containing everything else on the line.
1920 cmd
->nwords
= cmd
->wordssize
= 2;
1921 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
1922 cmd
->words
[0] = dupstr("!");
1923 cmd
->words
[1] = dupstr(p
+1);
1927 * Parse the command line into words. The syntax is:
1928 * - double quotes are removed, but cause spaces within to be
1929 * treated as non-separating.
1930 * - a double-doublequote pair is a literal double quote, inside
1931 * _or_ outside quotes. Like this:
1933 * firstword "second word" "this has ""quotes"" in" and""this""
1939 * >this has "quotes" in<
1943 /* skip whitespace */
1944 while (*p
&& (*p
== ' ' || *p
== '\t'))
1946 /* mark start of word */
1947 q
= r
= p
; /* q sits at start, r writes word */
1950 if (!quoting
&& (*p
== ' ' || *p
== '\t'))
1951 break; /* reached end of word */
1952 else if (*p
== '"' && p
[1] == '"')
1953 p
+= 2, *r
++ = '"'; /* a literal quote */
1955 p
++, quoting
= !quoting
;
1960 p
++; /* skip over the whitespace */
1962 if (cmd
->nwords
>= cmd
->wordssize
) {
1963 cmd
->wordssize
= cmd
->nwords
+ 16;
1964 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
1966 cmd
->words
[cmd
->nwords
++] = dupstr(q
);
1973 * Now parse the first word and assign a function.
1976 if (cmd
->nwords
== 0)
1977 cmd
->obey
= sftp_cmd_null
;
1979 const struct sftp_cmd_lookup
*lookup
;
1980 lookup
= lookup_command(cmd
->words
[0]);
1982 cmd
->obey
= sftp_cmd_unknown
;
1984 cmd
->obey
= lookup
->obey
;
1990 static int do_sftp_init(void)
1992 struct sftp_packet
*pktin
;
1993 struct sftp_request
*req
, *rreq
;
1996 * Do protocol initialisation.
2000 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
2001 return 1; /* failure */
2005 * Find out where our home directory is.
2007 sftp_register(req
= fxp_realpath_send("."));
2008 rreq
= sftp_find_request(pktin
= sftp_recv());
2009 assert(rreq
== req
);
2010 homedir
= fxp_realpath_recv(pktin
, rreq
);
2014 "Warning: failed to resolve home directory: %s\n",
2016 homedir
= dupstr(".");
2018 printf("Remote working directory is %s\n", homedir
);
2020 pwd
= dupstr(homedir
);
2024 void do_sftp_cleanup()
2028 back
->special(backhandle
, TS_EOF
);
2029 sftp_recvdata(&ch
, 1);
2030 back
->free(backhandle
);
2031 sftp_cleanup_request();
2045 void do_sftp(int mode
, int modeflags
, char *batchfile
)
2055 /* ------------------------------------------------------------------
2056 * Now we're ready to do Real Stuff.
2059 struct sftp_command
*cmd
;
2060 cmd
= sftp_getcmd(NULL
, 0, 0);
2063 ret
= cmd
->obey(cmd
);
2066 for(i
= 0; i
< cmd
->nwords
; i
++)
2067 sfree(cmd
->words
[i
]);
2075 fp
= fopen(batchfile
, "r");
2077 printf("Fatal: unable to open %s\n", batchfile
);
2081 struct sftp_command
*cmd
;
2082 cmd
= sftp_getcmd(fp
, mode
, modeflags
);
2085 ret
= cmd
->obey(cmd
);
2089 if (!(modeflags
& 2))
2098 /* ----------------------------------------------------------------------
2099 * Dirty bits: integration with PuTTY.
2102 static int verbose
= 0;
2105 * Print an error message and perform a fatal exit.
2107 void fatalbox(char *fmt
, ...)
2112 str
= dupvprintf(fmt
, ap
);
2113 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2116 fputs(str2
, stderr
);
2121 void modalfatalbox(char *fmt
, ...)
2126 str
= dupvprintf(fmt
, ap
);
2127 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2130 fputs(str2
, stderr
);
2135 void connection_fatal(void *frontend
, char *fmt
, ...)
2140 str
= dupvprintf(fmt
, ap
);
2141 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2144 fputs(str2
, stderr
);
2150 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
)
2153 * This is only here because of the calls to ldisc_send(NULL,
2154 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2155 * ldisc as an ldisc. So if we get called with any real data, I
2156 * want to know about it.
2162 * In psftp, all agent requests should be synchronous, so this is a
2163 * never-called stub.
2165 void agent_schedule_callback(void (*callback
)(void *, void *, int),
2166 void *callback_ctx
, void *data
, int len
)
2168 assert(!"We shouldn't be here");
2172 * Receive a block of data from the SSH link. Block until all data
2175 * To do this, we repeatedly call the SSH protocol module, with our
2176 * own trap in from_backend() to catch the data that comes back. We
2177 * do this until we have enough data.
2180 static unsigned char *outptr
; /* where to put the data */
2181 static unsigned outlen
; /* how much data required */
2182 static unsigned char *pending
= NULL
; /* any spare data */
2183 static unsigned pendlen
= 0, pendsize
= 0; /* length and phys. size of buffer */
2184 int from_backend(void *frontend
, int is_stderr
, const char *data
, int datalen
)
2186 unsigned char *p
= (unsigned char *) data
;
2187 unsigned len
= (unsigned) datalen
;
2190 * stderr data is just spouted to local stderr and otherwise
2195 fwrite(data
, 1, len
, stderr
);
2200 * If this is before the real session begins, just return.
2205 if ((outlen
> 0) && (len
> 0)) {
2206 unsigned used
= outlen
;
2209 memcpy(outptr
, p
, used
);
2217 if (pendsize
< pendlen
+ len
) {
2218 pendsize
= pendlen
+ len
+ 4096;
2219 pending
= sresize(pending
, pendsize
, unsigned char);
2221 memcpy(pending
+ pendlen
, p
, len
);
2227 int sftp_recvdata(char *buf
, int len
)
2229 outptr
= (unsigned char *) buf
;
2233 * See if the pending-input block contains some of what we
2237 unsigned pendused
= pendlen
;
2238 if (pendused
> outlen
)
2240 memcpy(outptr
, pending
, pendused
);
2241 memmove(pending
, pending
+ pendused
, pendlen
- pendused
);
2244 pendlen
-= pendused
;
2254 while (outlen
> 0) {
2255 if (ssh_sftp_loop_iteration() < 0)
2256 return 0; /* doom */
2261 int sftp_senddata(char *buf
, int len
)
2263 back
->send(backhandle
, buf
, len
);
2268 * Short description of parameters.
2270 static void usage(void)
2272 printf("PuTTY Secure File Transfer (SFTP) client\n");
2273 printf("%s\n", ver
);
2274 printf("Usage: psftp [options] [user@]host\n");
2275 printf("Options:\n");
2276 printf(" -b file use specified batchfile\n");
2277 printf(" -bc output batchfile commands\n");
2278 printf(" -be don't stop batchfile processing if errors\n");
2279 printf(" -v show verbose messages\n");
2280 printf(" -load sessname Load settings from saved session\n");
2281 printf(" -l user connect with specified username\n");
2282 printf(" -P port connect to specified port\n");
2283 printf(" -pw passw login with specified password\n");
2284 printf(" -1 -2 force use of particular SSH protocol version\n");
2285 printf(" -C enable compression\n");
2286 printf(" -i key private key file for authentication\n");
2287 printf(" -batch disable all interactive prompts\n");
2288 printf(" -V print version information\n");
2292 static void version(void)
2294 printf("psftp: %s\n", ver
);
2299 * Connect to a host.
2301 static int psftp_connect(char *userhost
, char *user
, int portnumber
)
2303 char *host
, *realhost
;
2307 /* Separate host and username */
2309 host
= strrchr(host
, '@');
2315 printf("psftp: multiple usernames specified; using \"%s\"\n",
2322 * If we haven't loaded session details already (e.g., from -load),
2323 * try looking for a session called "host".
2325 if (!loaded_session
) {
2326 /* Try to load settings for `host' into a temporary config */
2328 cfg2
.host
[0] = '\0';
2329 do_defaults(host
, &cfg2
);
2330 if (cfg2
.host
[0] != '\0') {
2331 /* Settings present and include hostname */
2332 /* Re-load data into the real config. */
2333 do_defaults(host
, &cfg
);
2335 /* Session doesn't exist or mention a hostname. */
2336 /* Use `host' as a bare hostname. */
2337 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
2338 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
2341 /* Patch in hostname `host' to session details. */
2342 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
2343 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
2347 * Force use of SSH. (If they got the protocol wrong we assume the
2348 * port is useless too.)
2350 if (cfg
.protocol
!= PROT_SSH
) {
2351 cfg
.protocol
= PROT_SSH
;
2356 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2357 * then change it to SSH-2, on the grounds that that's more likely to
2358 * work for SFTP. (Can be overridden with `-1' option.)
2359 * But if it says `2 only' or `2', respect which.
2361 if (cfg
.sshprot
!= 2 && cfg
.sshprot
!= 3)
2365 * Enact command-line overrides.
2367 cmdline_run_saved(&cfg
);
2370 * Trim leading whitespace off the hostname if it's there.
2373 int space
= strspn(cfg
.host
, " \t");
2374 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
2377 /* See if host is of the form user@host */
2378 if (cfg
.host
[0] != '\0') {
2379 char *atsign
= strrchr(cfg
.host
, '@');
2380 /* Make sure we're not overflowing the user field */
2382 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
2383 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
2384 cfg
.username
[atsign
- cfg
.host
] = '\0';
2386 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
2391 * Trim a colon suffix off the hostname if it's there.
2393 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
2396 * Remove any remaining whitespace from the hostname.
2400 while (cfg
.host
[p2
] != '\0') {
2401 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
2402 cfg
.host
[p1
] = cfg
.host
[p2
];
2407 cfg
.host
[p1
] = '\0';
2411 if (user
!= NULL
&& user
[0] != '\0') {
2412 strncpy(cfg
.username
, user
, sizeof(cfg
.username
) - 1);
2413 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
2415 if (!cfg
.username
[0]) {
2416 if (!console_get_line("login as: ",
2417 cfg
.username
, sizeof(cfg
.username
), FALSE
)) {
2418 fprintf(stderr
, "psftp: no username, aborting\n");
2421 int len
= strlen(cfg
.username
);
2422 if (cfg
.username
[len
- 1] == '\n')
2423 cfg
.username
[len
- 1] = '\0';
2428 cfg
.port
= portnumber
;
2431 * Disable scary things which shouldn't be enabled for simple
2432 * things like SCP and SFTP: agent forwarding, port forwarding,
2435 cfg
.x11_forward
= 0;
2437 cfg
.portfwd
[0] = cfg
.portfwd
[1] = '\0';
2439 /* Set up subsystem name. */
2440 strcpy(cfg
.remote_cmd
, "sftp");
2441 cfg
.ssh_subsys
= TRUE
;
2445 * Set up fallback option, for SSH1 servers or servers with the
2446 * sftp subsystem not enabled but the server binary installed
2447 * in the usual place. We only support fallback on Unix
2448 * systems, and we use a kludgy piece of shellery which should
2449 * try to find sftp-server in various places (the obvious
2450 * systemwide spots /usr/lib and /usr/local/lib, and then the
2451 * user's PATH) and finally give up.
2453 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2454 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2457 * the idea being that this will attempt to use either of the
2458 * obvious pathnames and then give up, and when it does give up
2459 * it will print the preferred pathname in the error messages.
2461 cfg
.remote_cmd_ptr2
=
2462 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2463 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2465 cfg
.ssh_subsys2
= FALSE
;
2467 back
= &ssh_backend
;
2469 err
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
, &realhost
,
2470 0, cfg
.tcp_keepalives
);
2472 fprintf(stderr
, "ssh_init: %s\n", err
);
2475 logctx
= log_init(NULL
, &cfg
);
2476 back
->provide_logctx(backhandle
, logctx
);
2477 console_provide_logctx(logctx
);
2478 while (!back
->sendok(backhandle
)) {
2479 if (ssh_sftp_loop_iteration() < 0) {
2480 fprintf(stderr
, "ssh_init: error during SSH connection setup\n");
2484 if (verbose
&& realhost
!= NULL
)
2485 printf("Connected to %s\n", realhost
);
2486 if (realhost
!= NULL
)
2491 void cmdline_error(char *p
, ...)
2494 fprintf(stderr
, "psftp: ");
2496 vfprintf(stderr
, p
, ap
);
2498 fprintf(stderr
, "\n try typing \"psftp -h\" for help\n");
2503 * Main program. Parse arguments etc.
2505 int psftp_main(int argc
, char *argv
[])
2509 char *userhost
, *user
;
2512 char *batchfile
= NULL
;
2515 flags
= FLAG_STDERR
| FLAG_INTERACTIVE
2516 #ifdef FLAG_SYNCAGENT
2520 cmdline_tooltype
= TOOLTYPE_FILETRANSFER
;
2521 ssh_get_line
= &console_get_line
;
2524 userhost
= user
= NULL
;
2526 /* Load Default Settings before doing anything else. */
2527 do_defaults(NULL
, &cfg
);
2528 loaded_session
= FALSE
;
2531 for (i
= 1; i
< argc
; i
++) {
2533 if (argv
[i
][0] != '-') {
2537 userhost
= dupstr(argv
[i
]);
2540 ret
= cmdline_process_param(argv
[i
], i
+1<argc?argv
[i
+1]:NULL
, 1, &cfg
);
2542 cmdline_error("option \"%s\" requires an argument", argv
[i
]);
2543 } else if (ret
== 2) {
2544 i
++; /* skip next argument */
2545 } else if (ret
== 1) {
2546 /* We have our own verbosity in addition to `flags'. */
2547 if (flags
& FLAG_VERBOSE
)
2549 } else if (strcmp(argv
[i
], "-h") == 0 ||
2550 strcmp(argv
[i
], "-?") == 0) {
2552 } else if (strcmp(argv
[i
], "-V") == 0) {
2554 } else if (strcmp(argv
[i
], "-batch") == 0) {
2555 console_batch_mode
= 1;
2556 } else if (strcmp(argv
[i
], "-b") == 0 && i
+ 1 < argc
) {
2558 batchfile
= argv
[++i
];
2559 } else if (strcmp(argv
[i
], "-bc") == 0) {
2560 modeflags
= modeflags
| 1;
2561 } else if (strcmp(argv
[i
], "-be") == 0) {
2562 modeflags
= modeflags
| 2;
2563 } else if (strcmp(argv
[i
], "--") == 0) {
2567 cmdline_error("unknown option \"%s\"", argv
[i
]);
2575 * If the loaded session provides a hostname, and a hostname has not
2576 * otherwise been specified, pop it in `userhost' so that
2577 * `psftp -load sessname' is sufficient to start a session.
2579 if (!userhost
&& cfg
.host
[0] != '\0') {
2580 userhost
= dupstr(cfg
.host
);
2584 * If a user@host string has already been provided, connect to
2589 ret
= psftp_connect(userhost
, user
, portnumber
);
2596 printf("psftp: no hostname specified; use \"open host.name\""
2600 do_sftp(mode
, modeflags
, batchfile
);
2602 if (back
!= NULL
&& back
->socket(backhandle
) != NULL
) {
2604 back
->special(backhandle
, TS_EOF
);
2605 sftp_recvdata(&ch
, 1);
2610 console_provide_logctx(NULL
);