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
)
771 * List a directory. If no arguments are given, list pwd; otherwise
772 * list the directory given in words[1].
774 int sftp_cmd_ls(struct sftp_command
*cmd
)
776 struct fxp_handle
*dirh
;
777 struct fxp_names
*names
;
778 struct fxp_name
**ournames
;
779 int nnames
, namesize
;
781 struct sftp_packet
*pktin
;
782 struct sftp_request
*req
, *rreq
;
786 printf("psftp: not connected to a host; use \"open host.name\"\n");
795 cdir
= canonify(dir
);
797 printf("%s: %s\n", dir
, fxp_error());
801 printf("Listing directory %s\n", cdir
);
803 sftp_register(req
= fxp_opendir_send(cdir
));
804 rreq
= sftp_find_request(pktin
= sftp_recv());
806 dirh
= fxp_opendir_recv(pktin
, rreq
);
809 printf("Unable to open %s: %s\n", dir
, fxp_error());
811 nnames
= namesize
= 0;
816 sftp_register(req
= fxp_readdir_send(dirh
));
817 rreq
= sftp_find_request(pktin
= sftp_recv());
819 names
= fxp_readdir_recv(pktin
, rreq
);
822 if (fxp_error_type() == SSH_FX_EOF
)
824 printf("Reading directory %s: %s\n", dir
, fxp_error());
827 if (names
->nnames
== 0) {
828 fxp_free_names(names
);
832 if (nnames
+ names
->nnames
>= namesize
) {
833 namesize
+= names
->nnames
+ 128;
834 ournames
= sresize(ournames
, namesize
, struct fxp_name
*);
837 for (i
= 0; i
< names
->nnames
; i
++)
838 ournames
[nnames
++] = fxp_dup_name(&names
->names
[i
]);
840 fxp_free_names(names
);
842 sftp_register(req
= fxp_close_send(dirh
));
843 rreq
= sftp_find_request(pktin
= sftp_recv());
845 fxp_close_recv(pktin
, rreq
);
848 * Now we have our filenames. Sort them by actual file
849 * name, and then output the longname parts.
851 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_name_compare
);
856 for (i
= 0; i
< nnames
; i
++) {
857 printf("%s\n", ournames
[i
]->longname
);
858 fxp_free_name(ournames
[i
]);
869 * Change directories. We do this by canonifying the new name, then
870 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
872 int sftp_cmd_cd(struct sftp_command
*cmd
)
874 struct fxp_handle
*dirh
;
875 struct sftp_packet
*pktin
;
876 struct sftp_request
*req
, *rreq
;
880 printf("psftp: not connected to a host; use \"open host.name\"\n");
885 dir
= dupstr(homedir
);
887 dir
= canonify(cmd
->words
[1]);
890 printf("%s: %s\n", dir
, fxp_error());
894 sftp_register(req
= fxp_opendir_send(dir
));
895 rreq
= sftp_find_request(pktin
= sftp_recv());
897 dirh
= fxp_opendir_recv(pktin
, rreq
);
900 printf("Directory %s: %s\n", dir
, fxp_error());
905 sftp_register(req
= fxp_close_send(dirh
));
906 rreq
= sftp_find_request(pktin
= sftp_recv());
908 fxp_close_recv(pktin
, rreq
);
912 printf("Remote directory is now %s\n", pwd
);
918 * Print current directory. Easy as pie.
920 int sftp_cmd_pwd(struct sftp_command
*cmd
)
923 printf("psftp: not connected to a host; use \"open host.name\"\n");
927 printf("Remote directory is %s\n", pwd
);
932 * Get a file and save it at the local end. We have three very
933 * similar commands here. The basic one is `get'; `reget' differs
934 * in that it checks for the existence of the destination file and
935 * starts from where a previous aborted transfer left off; `mget'
936 * differs in that it interprets all its arguments as files to
937 * transfer (never as a different local name for a remote file) and
938 * can handle wildcards.
940 int sftp_general_get(struct sftp_command
*cmd
, int restart
, int multiple
)
942 char *fname
, *unwcfname
, *origfname
, *outfname
;
947 printf("psftp: not connected to a host; use \"open host.name\"\n");
952 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
953 if (!strcmp(cmd
->words
[i
], "--")) {
954 /* finish processing options */
957 } else if (!strcmp(cmd
->words
[i
], "-r")) {
960 printf("get: unrecognised option '%s'\n", cmd
->words
[i
]);
966 if (i
>= cmd
->nwords
) {
967 printf("get: expects a filename\n");
973 origfname
= cmd
->words
[i
++];
976 !wc_unescape(unwcfname
= snewn(strlen(origfname
)+1, char),
978 ret
= sftp_get_file(pwd
, NULL
, recurse
, restart
, origfname
);
980 fname
= canonify(origfname
);
982 printf("%s: %s\n", origfname
, fxp_error());
987 if (!multiple
&& i
< cmd
->nwords
)
988 outfname
= cmd
->words
[i
++];
990 outfname
= stripslashes(origfname
, 1);
992 ret
= sftp_get_file(fname
, outfname
, recurse
, restart
, NULL
);
1000 } while (multiple
&& i
< cmd
->nwords
);
1004 int sftp_cmd_get(struct sftp_command
*cmd
)
1006 return sftp_general_get(cmd
, 0, 0);
1008 int sftp_cmd_mget(struct sftp_command
*cmd
)
1010 return sftp_general_get(cmd
, 0, 1);
1012 int sftp_cmd_reget(struct sftp_command
*cmd
)
1014 return sftp_general_get(cmd
, 1, 0);
1018 * Send a file and store it at the remote end. We have three very
1019 * similar commands here. The basic one is `put'; `reput' differs
1020 * in that it checks for the existence of the destination file and
1021 * starts from where a previous aborted transfer left off; `mput'
1022 * differs in that it interprets all its arguments as files to
1023 * transfer (never as a different remote name for a local file) and
1024 * can handle wildcards.
1026 int sftp_general_put(struct sftp_command
*cmd
, int restart
, int multiple
)
1028 char *fname
, *origoutfname
, *outfname
;
1030 int recurse
= FALSE
;
1033 printf("psftp: not connected to a host; use \"open host.name\"\n");
1038 while (i
< cmd
->nwords
&& cmd
->words
[i
][0] == '-') {
1039 if (!strcmp(cmd
->words
[i
], "--")) {
1040 /* finish processing options */
1043 } else if (!strcmp(cmd
->words
[i
], "-r")) {
1046 printf("put: unrecognised option '%s'\n", cmd
->words
[i
]);
1052 if (i
>= cmd
->nwords
) {
1053 printf("put: expects a filename\n");
1058 fname
= cmd
->words
[i
++];
1060 if (multiple
&& test_wildcard(fname
, FALSE
) == WCTYPE_WILDCARD
) {
1061 ret
= sftp_put_file(NULL
, pwd
, recurse
, restart
, fname
);
1063 if (!multiple
&& i
< cmd
->nwords
)
1064 origoutfname
= cmd
->words
[i
++];
1066 origoutfname
= stripslashes(fname
, 1);
1068 outfname
= canonify(origoutfname
);
1070 printf("%s: %s\n", origoutfname
, fxp_error());
1073 ret
= sftp_put_file(fname
, outfname
, recurse
, restart
, NULL
);
1079 } while (multiple
&& i
< cmd
->nwords
);
1083 int sftp_cmd_put(struct sftp_command
*cmd
)
1085 return sftp_general_put(cmd
, 0, 0);
1087 int sftp_cmd_mput(struct sftp_command
*cmd
)
1089 return sftp_general_put(cmd
, 0, 1);
1091 int sftp_cmd_reput(struct sftp_command
*cmd
)
1093 return sftp_general_put(cmd
, 1, 0);
1096 int sftp_cmd_mkdir(struct sftp_command
*cmd
)
1099 struct sftp_packet
*pktin
;
1100 struct sftp_request
*req
, *rreq
;
1104 printf("psftp: not connected to a host; use \"open host.name\"\n");
1108 if (cmd
->nwords
< 2) {
1109 printf("mkdir: expects a directory\n");
1113 dir
= canonify(cmd
->words
[1]);
1115 printf("%s: %s\n", dir
, fxp_error());
1119 sftp_register(req
= fxp_mkdir_send(dir
));
1120 rreq
= sftp_find_request(pktin
= sftp_recv());
1121 assert(rreq
== req
);
1122 result
= fxp_mkdir_recv(pktin
, rreq
);
1125 printf("mkdir %s: %s\n", dir
, fxp_error());
1134 int sftp_cmd_rmdir(struct sftp_command
*cmd
)
1137 struct sftp_packet
*pktin
;
1138 struct sftp_request
*req
, *rreq
;
1142 printf("psftp: not connected to a host; use \"open host.name\"\n");
1146 if (cmd
->nwords
< 2) {
1147 printf("rmdir: expects a directory\n");
1151 dir
= canonify(cmd
->words
[1]);
1153 printf("%s: %s\n", dir
, fxp_error());
1157 sftp_register(req
= fxp_rmdir_send(dir
));
1158 rreq
= sftp_find_request(pktin
= sftp_recv());
1159 assert(rreq
== req
);
1160 result
= fxp_rmdir_recv(pktin
, rreq
);
1163 printf("rmdir %s: %s\n", dir
, fxp_error());
1172 int sftp_cmd_rm(struct sftp_command
*cmd
)
1175 struct sftp_packet
*pktin
;
1176 struct sftp_request
*req
, *rreq
;
1180 printf("psftp: not connected to a host; use \"open host.name\"\n");
1184 if (cmd
->nwords
< 2) {
1185 printf("rm: expects a filename\n");
1189 fname
= canonify(cmd
->words
[1]);
1191 printf("%s: %s\n", fname
, fxp_error());
1195 sftp_register(req
= fxp_remove_send(fname
));
1196 rreq
= sftp_find_request(pktin
= sftp_recv());
1197 assert(rreq
== req
);
1198 result
= fxp_remove_recv(pktin
, rreq
);
1201 printf("rm %s: %s\n", fname
, fxp_error());
1210 int sftp_cmd_mv(struct sftp_command
*cmd
)
1212 char *srcfname
, *dstfname
;
1213 struct sftp_packet
*pktin
;
1214 struct sftp_request
*req
, *rreq
;
1218 printf("psftp: not connected to a host; use \"open host.name\"\n");
1222 if (cmd
->nwords
< 3) {
1223 printf("mv: expects two filenames\n");
1226 srcfname
= canonify(cmd
->words
[1]);
1228 printf("%s: %s\n", srcfname
, fxp_error());
1232 dstfname
= canonify(cmd
->words
[2]);
1234 printf("%s: %s\n", dstfname
, fxp_error());
1238 sftp_register(req
= fxp_rename_send(srcfname
, dstfname
));
1239 rreq
= sftp_find_request(pktin
= sftp_recv());
1240 assert(rreq
== req
);
1241 result
= fxp_rename_recv(pktin
, rreq
);
1244 char const *error
= fxp_error();
1245 struct fxp_attrs attrs
;
1248 * The move might have failed because dstfname pointed at a
1249 * directory. We check this possibility now: if dstfname
1250 * _is_ a directory, we re-attempt the move by appending
1251 * the basename of srcfname to dstfname.
1253 sftp_register(req
= fxp_stat_send(dstfname
));
1254 rreq
= sftp_find_request(pktin
= sftp_recv());
1255 assert(rreq
== req
);
1256 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1259 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
1260 (attrs
.permissions
& 0040000)) {
1262 char *newname
, *newcanon
;
1263 printf("(destination %s is a directory)\n", dstfname
);
1264 p
= srcfname
+ strlen(srcfname
);
1265 while (p
> srcfname
&& p
[-1] != '/') p
--;
1266 newname
= dupcat(dstfname
, "/", p
, NULL
);
1267 newcanon
= canonify(newname
);
1271 dstfname
= newcanon
;
1273 sftp_register(req
= fxp_rename_send(srcfname
, dstfname
));
1274 rreq
= sftp_find_request(pktin
= sftp_recv());
1275 assert(rreq
== req
);
1276 result
= fxp_rename_recv(pktin
, rreq
);
1278 error
= result ? NULL
: fxp_error();
1282 printf("mv %s %s: %s\n", srcfname
, dstfname
, error
);
1288 printf("%s -> %s\n", srcfname
, dstfname
);
1295 int sftp_cmd_chmod(struct sftp_command
*cmd
)
1299 struct fxp_attrs attrs
;
1300 unsigned attrs_clr
, attrs_xor
, oldperms
, newperms
;
1301 struct sftp_packet
*pktin
;
1302 struct sftp_request
*req
, *rreq
;
1305 printf("psftp: not connected to a host; use \"open host.name\"\n");
1309 if (cmd
->nwords
< 3) {
1310 printf("chmod: expects a mode specifier and a filename\n");
1315 * Attempt to parse the mode specifier in cmd->words[1]. We
1316 * don't support the full horror of Unix chmod; instead we
1317 * support a much simpler syntax in which the user can either
1318 * specify an octal number, or a comma-separated sequence of
1319 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
1320 * _only_ be omitted if the only attribute mentioned is t,
1321 * since all others require a user/group/other specification.
1322 * Additionally, the s attribute may not be specified for any
1323 * [ugoa] specifications other than exactly u or exactly g.
1325 attrs_clr
= attrs_xor
= 0;
1326 mode
= cmd
->words
[1];
1327 if (mode
[0] >= '0' && mode
[0] <= '9') {
1328 if (mode
[strspn(mode
, "01234567")]) {
1329 printf("chmod: numeric file modes should"
1330 " contain digits 0-7 only\n");
1334 sscanf(mode
, "%o", &attrs_xor
);
1335 attrs_xor
&= attrs_clr
;
1338 char *modebegin
= mode
;
1339 unsigned subset
, perms
;
1343 while (*mode
&& *mode
!= ',' &&
1344 *mode
!= '+' && *mode
!= '-' && *mode
!= '=') {
1346 case 'u': subset
|= 04700; break; /* setuid, user perms */
1347 case 'g': subset
|= 02070; break; /* setgid, group perms */
1348 case 'o': subset
|= 00007; break; /* just other perms */
1349 case 'a': subset
|= 06777; break; /* all of the above */
1351 printf("chmod: file mode '%.*s' contains unrecognised"
1352 " user/group/other specifier '%c'\n",
1353 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1358 if (!*mode
|| *mode
== ',') {
1359 printf("chmod: file mode '%.*s' is incomplete\n",
1360 (int)strcspn(modebegin
, ","), modebegin
);
1364 if (!*mode
|| *mode
== ',') {
1365 printf("chmod: file mode '%.*s' is incomplete\n",
1366 (int)strcspn(modebegin
, ","), modebegin
);
1370 while (*mode
&& *mode
!= ',') {
1372 case 'r': perms
|= 00444; break;
1373 case 'w': perms
|= 00222; break;
1374 case 'x': perms
|= 00111; break;
1375 case 't': perms
|= 01000; subset
|= 01000; break;
1377 if ((subset
& 06777) != 04700 &&
1378 (subset
& 06777) != 02070) {
1379 printf("chmod: file mode '%.*s': set[ug]id bit should"
1380 " be used with exactly one of u or g only\n",
1381 (int)strcspn(modebegin
, ","), modebegin
);
1387 printf("chmod: file mode '%.*s' contains unrecognised"
1388 " permission specifier '%c'\n",
1389 (int)strcspn(modebegin
, ","), modebegin
, *mode
);
1394 if (!(subset
& 06777) && (perms
&~ subset
)) {
1395 printf("chmod: file mode '%.*s' contains no user/group/other"
1396 " specifier and permissions other than 't' \n",
1397 (int)strcspn(modebegin
, ","), modebegin
);
1408 attrs_xor
&= ~perms
;
1411 attrs_clr
|= subset
;
1415 if (*mode
) mode
++; /* eat comma */
1419 fname
= canonify(cmd
->words
[2]);
1421 printf("%s: %s\n", fname
, fxp_error());
1425 sftp_register(req
= fxp_stat_send(fname
));
1426 rreq
= sftp_find_request(pktin
= sftp_recv());
1427 assert(rreq
== req
);
1428 result
= fxp_stat_recv(pktin
, rreq
, &attrs
);
1430 if (!result
|| !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
)) {
1431 printf("get attrs for %s: %s\n", fname
,
1432 result ?
"file permissions not provided" : fxp_error());
1437 attrs
.flags
= SSH_FILEXFER_ATTR_PERMISSIONS
; /* perms _only_ */
1438 oldperms
= attrs
.permissions
& 07777;
1439 attrs
.permissions
&= ~attrs_clr
;
1440 attrs
.permissions
^= attrs_xor
;
1441 newperms
= attrs
.permissions
& 07777;
1443 sftp_register(req
= fxp_setstat_send(fname
, attrs
));
1444 rreq
= sftp_find_request(pktin
= sftp_recv());
1445 assert(rreq
== req
);
1446 result
= fxp_setstat_recv(pktin
, rreq
);
1449 printf("set attrs for %s: %s\n", fname
, fxp_error());
1454 printf("%s: %04o -> %04o\n", fname
, oldperms
, newperms
);
1460 static int sftp_cmd_open(struct sftp_command
*cmd
)
1465 printf("psftp: already connected\n");
1469 if (cmd
->nwords
< 2) {
1470 printf("open: expects a host name\n");
1474 if (cmd
->nwords
> 2) {
1475 portnumber
= atoi(cmd
->words
[2]);
1476 if (portnumber
== 0) {
1477 printf("open: invalid port number\n");
1483 if (psftp_connect(cmd
->words
[1], NULL
, portnumber
)) {
1484 back
= NULL
; /* connection is already closed */
1485 return -1; /* this is fatal */
1491 static int sftp_cmd_lcd(struct sftp_command
*cmd
)
1493 char *currdir
, *errmsg
;
1495 if (cmd
->nwords
< 2) {
1496 printf("lcd: expects a local directory name\n");
1500 errmsg
= psftp_lcd(cmd
->words
[1]);
1502 printf("lcd: unable to change directory: %s\n", errmsg
);
1507 currdir
= psftp_getcwd();
1508 printf("New local directory is %s\n", currdir
);
1514 static int sftp_cmd_lpwd(struct sftp_command
*cmd
)
1518 currdir
= psftp_getcwd();
1519 printf("Current local directory is %s\n", currdir
);
1525 static int sftp_cmd_pling(struct sftp_command
*cmd
)
1529 exitcode
= system(cmd
->words
[1]);
1530 return (exitcode
== 0);
1533 static int sftp_cmd_help(struct sftp_command
*cmd
);
1535 static struct sftp_cmd_lookup
{
1538 * For help purposes, there are two kinds of command:
1540 * - primary commands, in which `longhelp' is non-NULL. In
1541 * this case `shorthelp' is descriptive text, and `longhelp'
1542 * is longer descriptive text intended to be printed after
1545 * - alias commands, in which `longhelp' is NULL. In this case
1546 * `shorthelp' is the name of a primary command, which
1547 * contains the help that should double up for this command.
1549 int listed
; /* do we list this in primary help? */
1552 int (*obey
) (struct sftp_command
*);
1555 * List of sftp commands. This is binary-searched so it MUST be
1559 "!", TRUE
, "run a local command",
1561 /* FIXME: this example is crap for non-Windows. */
1562 " Runs a local command. For example, \"!del myfile\".\n",
1566 "bye", TRUE
, "finish your SFTP session",
1568 " Terminates your SFTP session and quits the PSFTP program.\n",
1572 "cd", TRUE
, "change your remote working directory",
1573 " [ <New working directory> ]\n"
1574 " Change the remote working directory for your SFTP session.\n"
1575 " If a new working directory is not supplied, you will be\n"
1576 " returned to your home directory.\n",
1580 "chmod", TRUE
, "change file permissions and modes",
1581 " ( <octal-digits> | <modifiers> ) <filename>\n"
1582 " Change the file permissions on a file or directory.\n"
1583 " <octal-digits> can be any octal Unix permission specifier.\n"
1584 " Alternatively, <modifiers> can include:\n"
1585 " u+r make file readable by owning user\n"
1586 " u+w make file writable by owning user\n"
1587 " u+x make file executable by owning user\n"
1588 " u-r make file not readable by owning user\n"
1589 " [also u-w, u-x]\n"
1590 " g+r make file readable by members of owning group\n"
1591 " [also g+w, g+x, g-r, g-w, g-x]\n"
1592 " o+r make file readable by all other users\n"
1593 " [also o+w, o+x, o-r, o-w, o-x]\n"
1594 " a+r make file readable by absolutely everybody\n"
1595 " [also a+w, a+x, a-r, a-w, a-x]\n"
1596 " u+s enable the Unix set-user-ID bit\n"
1597 " u-s disable the Unix set-user-ID bit\n"
1598 " g+s enable the Unix set-group-ID bit\n"
1599 " g-s disable the Unix set-group-ID bit\n"
1600 " +t enable the Unix \"sticky bit\"\n"
1601 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1602 " more than one user for the same modifier (\"ug+w\"). You can\n"
1603 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1607 "del", TRUE
, "delete a file",
1609 " Delete a file.\n",
1613 "delete", FALSE
, "del", NULL
, sftp_cmd_rm
1616 "dir", TRUE
, "list contents of a remote directory",
1617 " [ <directory-name> ]\n"
1618 " List the contents of a specified directory on the server.\n"
1619 " If <directory-name> is not given, the current working directory\n"
1620 " will be listed.\n",
1624 "exit", TRUE
, "bye", NULL
, sftp_cmd_quit
1627 "get", TRUE
, "download a file from the server to your local machine",
1628 " <filename> [ <local-filename> ]\n"
1629 " Downloads a file on the server and stores it locally under\n"
1630 " the same name, or under a different one if you supply the\n"
1631 " argument <local-filename>.\n",
1635 "help", TRUE
, "give help",
1636 " [ <command> [ <command> ... ] ]\n"
1637 " Give general help if no commands are specified.\n"
1638 " If one or more commands are specified, give specific help on\n"
1639 " those particular commands.\n",
1643 "lcd", TRUE
, "change local working directory",
1644 " <local-directory-name>\n"
1645 " Change the local working directory of the PSFTP program (the\n"
1646 " default location where the \"get\" command will save files).\n",
1650 "lpwd", TRUE
, "print local working directory",
1652 " Print the local working directory of the PSFTP program (the\n"
1653 " default location where the \"get\" command will save files).\n",
1657 "ls", TRUE
, "dir", NULL
,
1661 "mget", TRUE
, "download multiple files at once",
1662 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1663 " Downloads many files from the server, storing each one under\n"
1664 " the same name it has on the server side. You can use wildcards\n"
1665 " such as \"*.c\" to specify lots of files at once.\n",
1669 "mkdir", TRUE
, "create a directory on the remote server",
1670 " <directory-name>\n"
1671 " Creates a directory with the given name on the server.\n",
1675 "mput", TRUE
, "upload multiple files at once",
1676 " <filename-or-wildcard> [ <filename-or-wildcard>... ]\n"
1677 " Uploads many files to the server, storing each one under the\n"
1678 " same name it has on the client side. You can use wildcards\n"
1679 " such as \"*.c\" to specify lots of files at once.\n",
1683 "mv", TRUE
, "move or rename a file on the remote server",
1684 " <source-filename> <destination-filename>\n"
1685 " Moves or renames the file <source-filename> on the server,\n"
1686 " so that it is accessible under the name <destination-filename>.\n",
1690 "open", TRUE
, "connect to a host",
1691 " [<user>@]<hostname> [<port>]\n"
1692 " Establishes an SFTP connection to a given host. Only usable\n"
1693 " when you did not already specify a host name on the command\n"
1698 "put", TRUE
, "upload a file from your local machine to the server",
1699 " <filename> [ <remote-filename> ]\n"
1700 " Uploads a file to the server and stores it there under\n"
1701 " the same name, or under a different one if you supply the\n"
1702 " argument <remote-filename>.\n",
1706 "pwd", TRUE
, "print your remote working directory",
1708 " Print the current remote working directory for your SFTP session.\n",
1712 "quit", TRUE
, "bye", NULL
,
1716 "reget", TRUE
, "continue downloading a file",
1717 " <filename> [ <local-filename> ]\n"
1718 " Works exactly like the \"get\" command, but the local file\n"
1719 " must already exist. The download will begin at the end of the\n"
1720 " file. This is for resuming a download that was interrupted.\n",
1724 "ren", TRUE
, "mv", NULL
,
1728 "rename", FALSE
, "mv", NULL
,
1732 "reput", TRUE
, "continue uploading a file",
1733 " <filename> [ <remote-filename> ]\n"
1734 " Works exactly like the \"put\" command, but the remote file\n"
1735 " must already exist. The upload will begin at the end of the\n"
1736 " file. This is for resuming an upload that was interrupted.\n",
1740 "rm", TRUE
, "del", NULL
,
1744 "rmdir", TRUE
, "remove a directory on the remote server",
1745 " <directory-name>\n"
1746 " Removes the directory with the given name on the server.\n"
1747 " The directory will not be removed unless it is empty.\n",
1752 const struct sftp_cmd_lookup
*lookup_command(char *name
)
1757 j
= sizeof(sftp_lookup
) / sizeof(*sftp_lookup
);
1760 cmp
= strcmp(name
, sftp_lookup
[k
].name
);
1766 return &sftp_lookup
[k
];
1772 static int sftp_cmd_help(struct sftp_command
*cmd
)
1775 if (cmd
->nwords
== 1) {
1777 * Give short help on each command.
1781 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
1783 if (!sftp_lookup
[i
].listed
)
1785 len
= strlen(sftp_lookup
[i
].name
);
1789 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
1790 const struct sftp_cmd_lookup
*lookup
;
1791 if (!sftp_lookup
[i
].listed
)
1793 lookup
= &sftp_lookup
[i
];
1794 printf("%-*s", maxlen
+2, lookup
->name
);
1795 if (lookup
->longhelp
== NULL
)
1796 lookup
= lookup_command(lookup
->shorthelp
);
1797 printf("%s\n", lookup
->shorthelp
);
1801 * Give long help on specific commands.
1803 for (i
= 1; i
< cmd
->nwords
; i
++) {
1804 const struct sftp_cmd_lookup
*lookup
;
1805 lookup
= lookup_command(cmd
->words
[i
]);
1807 printf("help: %s: command not found\n", cmd
->words
[i
]);
1809 printf("%s", lookup
->name
);
1810 if (lookup
->longhelp
== NULL
)
1811 lookup
= lookup_command(lookup
->shorthelp
);
1812 printf("%s", lookup
->longhelp
);
1819 /* ----------------------------------------------------------------------
1820 * Command line reading and parsing.
1822 struct sftp_command
*sftp_getcmd(FILE *fp
, int mode
, int modeflags
)
1825 struct sftp_command
*cmd
;
1829 cmd
= snew(struct sftp_command
);
1839 line
= fgetline(fp
);
1841 line
= ssh_sftp_get_cmdline("psftp> ");
1844 if (!line
|| !*line
) {
1845 cmd
->obey
= sftp_cmd_quit
;
1846 if ((mode
== 0) || (modeflags
& 1))
1848 return cmd
; /* eof */
1851 line
[strcspn(line
, "\r\n")] = '\0';
1853 if (modeflags
& 1) {
1854 printf("%s\n", line
);
1858 while (*p
&& (*p
== ' ' || *p
== '\t'))
1863 * Special case: the ! command. This is always parsed as
1864 * exactly two words: one containing the !, and the second
1865 * containing everything else on the line.
1867 cmd
->nwords
= cmd
->wordssize
= 2;
1868 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
1869 cmd
->words
[0] = dupstr("!");
1870 cmd
->words
[1] = dupstr(p
+1);
1874 * Parse the command line into words. The syntax is:
1875 * - double quotes are removed, but cause spaces within to be
1876 * treated as non-separating.
1877 * - a double-doublequote pair is a literal double quote, inside
1878 * _or_ outside quotes. Like this:
1880 * firstword "second word" "this has ""quotes"" in" and""this""
1886 * >this has "quotes" in<
1890 /* skip whitespace */
1891 while (*p
&& (*p
== ' ' || *p
== '\t'))
1893 /* mark start of word */
1894 q
= r
= p
; /* q sits at start, r writes word */
1897 if (!quoting
&& (*p
== ' ' || *p
== '\t'))
1898 break; /* reached end of word */
1899 else if (*p
== '"' && p
[1] == '"')
1900 p
+= 2, *r
++ = '"'; /* a literal quote */
1902 p
++, quoting
= !quoting
;
1907 p
++; /* skip over the whitespace */
1909 if (cmd
->nwords
>= cmd
->wordssize
) {
1910 cmd
->wordssize
= cmd
->nwords
+ 16;
1911 cmd
->words
= sresize(cmd
->words
, cmd
->wordssize
, char *);
1913 cmd
->words
[cmd
->nwords
++] = dupstr(q
);
1920 * Now parse the first word and assign a function.
1923 if (cmd
->nwords
== 0)
1924 cmd
->obey
= sftp_cmd_null
;
1926 const struct sftp_cmd_lookup
*lookup
;
1927 lookup
= lookup_command(cmd
->words
[0]);
1929 cmd
->obey
= sftp_cmd_unknown
;
1931 cmd
->obey
= lookup
->obey
;
1937 static int do_sftp_init(void)
1939 struct sftp_packet
*pktin
;
1940 struct sftp_request
*req
, *rreq
;
1943 * Do protocol initialisation.
1947 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
1948 return 1; /* failure */
1952 * Find out where our home directory is.
1954 sftp_register(req
= fxp_realpath_send("."));
1955 rreq
= sftp_find_request(pktin
= sftp_recv());
1956 assert(rreq
== req
);
1957 homedir
= fxp_realpath_recv(pktin
, rreq
);
1961 "Warning: failed to resolve home directory: %s\n",
1963 homedir
= dupstr(".");
1965 printf("Remote working directory is %s\n", homedir
);
1967 pwd
= dupstr(homedir
);
1971 void do_sftp_cleanup()
1975 back
->special(backhandle
, TS_EOF
);
1976 sftp_recvdata(&ch
, 1);
1977 back
->free(backhandle
);
1978 sftp_cleanup_request();
1990 void do_sftp(int mode
, int modeflags
, char *batchfile
)
2000 /* ------------------------------------------------------------------
2001 * Now we're ready to do Real Stuff.
2004 struct sftp_command
*cmd
;
2005 cmd
= sftp_getcmd(NULL
, 0, 0);
2008 ret
= cmd
->obey(cmd
);
2011 for(i
= 0; i
< cmd
->nwords
; i
++)
2012 sfree(cmd
->words
[i
]);
2020 fp
= fopen(batchfile
, "r");
2022 printf("Fatal: unable to open %s\n", batchfile
);
2026 struct sftp_command
*cmd
;
2027 cmd
= sftp_getcmd(fp
, mode
, modeflags
);
2030 ret
= cmd
->obey(cmd
);
2034 if (!(modeflags
& 2))
2043 /* ----------------------------------------------------------------------
2044 * Dirty bits: integration with PuTTY.
2047 static int verbose
= 0;
2050 * Print an error message and perform a fatal exit.
2052 void fatalbox(char *fmt
, ...)
2057 str
= dupvprintf(fmt
, ap
);
2058 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2061 fputs(str2
, stderr
);
2066 void modalfatalbox(char *fmt
, ...)
2071 str
= dupvprintf(fmt
, ap
);
2072 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2075 fputs(str2
, stderr
);
2080 void connection_fatal(void *frontend
, char *fmt
, ...)
2085 str
= dupvprintf(fmt
, ap
);
2086 str2
= dupcat("Fatal: ", str
, "\n", NULL
);
2089 fputs(str2
, stderr
);
2095 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
)
2098 * This is only here because of the calls to ldisc_send(NULL,
2099 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
2100 * ldisc as an ldisc. So if we get called with any real data, I
2101 * want to know about it.
2107 * In psftp, all agent requests should be synchronous, so this is a
2108 * never-called stub.
2110 void agent_schedule_callback(void (*callback
)(void *, void *, int),
2111 void *callback_ctx
, void *data
, int len
)
2113 assert(!"We shouldn't be here");
2117 * Receive a block of data from the SSH link. Block until all data
2120 * To do this, we repeatedly call the SSH protocol module, with our
2121 * own trap in from_backend() to catch the data that comes back. We
2122 * do this until we have enough data.
2125 static unsigned char *outptr
; /* where to put the data */
2126 static unsigned outlen
; /* how much data required */
2127 static unsigned char *pending
= NULL
; /* any spare data */
2128 static unsigned pendlen
= 0, pendsize
= 0; /* length and phys. size of buffer */
2129 int from_backend(void *frontend
, int is_stderr
, const char *data
, int datalen
)
2131 unsigned char *p
= (unsigned char *) data
;
2132 unsigned len
= (unsigned) datalen
;
2135 * stderr data is just spouted to local stderr and otherwise
2140 fwrite(data
, 1, len
, stderr
);
2145 * If this is before the real session begins, just return.
2150 if ((outlen
> 0) && (len
> 0)) {
2151 unsigned used
= outlen
;
2154 memcpy(outptr
, p
, used
);
2162 if (pendsize
< pendlen
+ len
) {
2163 pendsize
= pendlen
+ len
+ 4096;
2164 pending
= sresize(pending
, pendsize
, unsigned char);
2166 memcpy(pending
+ pendlen
, p
, len
);
2172 int sftp_recvdata(char *buf
, int len
)
2174 outptr
= (unsigned char *) buf
;
2178 * See if the pending-input block contains some of what we
2182 unsigned pendused
= pendlen
;
2183 if (pendused
> outlen
)
2185 memcpy(outptr
, pending
, pendused
);
2186 memmove(pending
, pending
+ pendused
, pendlen
- pendused
);
2189 pendlen
-= pendused
;
2199 while (outlen
> 0) {
2200 if (ssh_sftp_loop_iteration() < 0)
2201 return 0; /* doom */
2206 int sftp_senddata(char *buf
, int len
)
2208 back
->send(backhandle
, buf
, len
);
2213 * Short description of parameters.
2215 static void usage(void)
2217 printf("PuTTY Secure File Transfer (SFTP) client\n");
2218 printf("%s\n", ver
);
2219 printf("Usage: psftp [options] [user@]host\n");
2220 printf("Options:\n");
2221 printf(" -b file use specified batchfile\n");
2222 printf(" -bc output batchfile commands\n");
2223 printf(" -be don't stop batchfile processing if errors\n");
2224 printf(" -v show verbose messages\n");
2225 printf(" -load sessname Load settings from saved session\n");
2226 printf(" -l user connect with specified username\n");
2227 printf(" -P port connect to specified port\n");
2228 printf(" -pw passw login with specified password\n");
2229 printf(" -1 -2 force use of particular SSH protocol version\n");
2230 printf(" -C enable compression\n");
2231 printf(" -i key private key file for authentication\n");
2232 printf(" -batch disable all interactive prompts\n");
2233 printf(" -V print version information\n");
2237 static void version(void)
2239 printf("psftp: %s\n", ver
);
2244 * Connect to a host.
2246 static int psftp_connect(char *userhost
, char *user
, int portnumber
)
2248 char *host
, *realhost
;
2252 /* Separate host and username */
2254 host
= strrchr(host
, '@');
2260 printf("psftp: multiple usernames specified; using \"%s\"\n",
2267 * If we haven't loaded session details already (e.g., from -load),
2268 * try looking for a session called "host".
2270 if (!loaded_session
) {
2271 /* Try to load settings for `host' into a temporary config */
2273 cfg2
.host
[0] = '\0';
2274 do_defaults(host
, &cfg2
);
2275 if (cfg2
.host
[0] != '\0') {
2276 /* Settings present and include hostname */
2277 /* Re-load data into the real config. */
2278 do_defaults(host
, &cfg
);
2280 /* Session doesn't exist or mention a hostname. */
2281 /* Use `host' as a bare hostname. */
2282 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
2283 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
2286 /* Patch in hostname `host' to session details. */
2287 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
2288 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
2292 * Force use of SSH. (If they got the protocol wrong we assume the
2293 * port is useless too.)
2295 if (cfg
.protocol
!= PROT_SSH
) {
2296 cfg
.protocol
= PROT_SSH
;
2301 * If saved session / Default Settings says SSH-1 (`1 only' or `1'),
2302 * then change it to SSH-2, on the grounds that that's more likely to
2303 * work for SFTP. (Can be overridden with `-1' option.)
2304 * But if it says `2 only' or `2', respect which.
2306 if (cfg
.sshprot
!= 2 && cfg
.sshprot
!= 3)
2310 * Enact command-line overrides.
2312 cmdline_run_saved(&cfg
);
2315 * Trim leading whitespace off the hostname if it's there.
2318 int space
= strspn(cfg
.host
, " \t");
2319 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
2322 /* See if host is of the form user@host */
2323 if (cfg
.host
[0] != '\0') {
2324 char *atsign
= strrchr(cfg
.host
, '@');
2325 /* Make sure we're not overflowing the user field */
2327 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
2328 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
2329 cfg
.username
[atsign
- cfg
.host
] = '\0';
2331 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
2336 * Trim a colon suffix off the hostname if it's there.
2338 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
2341 * Remove any remaining whitespace from the hostname.
2345 while (cfg
.host
[p2
] != '\0') {
2346 if (cfg
.host
[p2
] != ' ' && cfg
.host
[p2
] != '\t') {
2347 cfg
.host
[p1
] = cfg
.host
[p2
];
2352 cfg
.host
[p1
] = '\0';
2356 if (user
!= NULL
&& user
[0] != '\0') {
2357 strncpy(cfg
.username
, user
, sizeof(cfg
.username
) - 1);
2358 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
2360 if (!cfg
.username
[0]) {
2361 if (!console_get_line("login as: ",
2362 cfg
.username
, sizeof(cfg
.username
), FALSE
)) {
2363 fprintf(stderr
, "psftp: no username, aborting\n");
2366 int len
= strlen(cfg
.username
);
2367 if (cfg
.username
[len
- 1] == '\n')
2368 cfg
.username
[len
- 1] = '\0';
2373 cfg
.port
= portnumber
;
2376 * Disable scary things which shouldn't be enabled for simple
2377 * things like SCP and SFTP: agent forwarding, port forwarding,
2380 cfg
.x11_forward
= 0;
2382 cfg
.portfwd
[0] = cfg
.portfwd
[1] = '\0';
2384 /* Set up subsystem name. */
2385 strcpy(cfg
.remote_cmd
, "sftp");
2386 cfg
.ssh_subsys
= TRUE
;
2390 * Set up fallback option, for SSH1 servers or servers with the
2391 * sftp subsystem not enabled but the server binary installed
2392 * in the usual place. We only support fallback on Unix
2393 * systems, and we use a kludgy piece of shellery which should
2394 * try to find sftp-server in various places (the obvious
2395 * systemwide spots /usr/lib and /usr/local/lib, and then the
2396 * user's PATH) and finally give up.
2398 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
2399 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
2402 * the idea being that this will attempt to use either of the
2403 * obvious pathnames and then give up, and when it does give up
2404 * it will print the preferred pathname in the error messages.
2406 cfg
.remote_cmd_ptr2
=
2407 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
2408 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
2410 cfg
.ssh_subsys2
= FALSE
;
2412 back
= &ssh_backend
;
2414 err
= back
->init(NULL
, &backhandle
, &cfg
, cfg
.host
, cfg
.port
, &realhost
,
2415 0, cfg
.tcp_keepalives
);
2417 fprintf(stderr
, "ssh_init: %s\n", err
);
2420 logctx
= log_init(NULL
, &cfg
);
2421 back
->provide_logctx(backhandle
, logctx
);
2422 console_provide_logctx(logctx
);
2423 while (!back
->sendok(backhandle
)) {
2424 if (ssh_sftp_loop_iteration() < 0) {
2425 fprintf(stderr
, "ssh_init: error during SSH connection setup\n");
2429 if (verbose
&& realhost
!= NULL
)
2430 printf("Connected to %s\n", realhost
);
2431 if (realhost
!= NULL
)
2436 void cmdline_error(char *p
, ...)
2439 fprintf(stderr
, "psftp: ");
2441 vfprintf(stderr
, p
, ap
);
2443 fprintf(stderr
, "\n try typing \"psftp -h\" for help\n");
2448 * Main program. Parse arguments etc.
2450 int psftp_main(int argc
, char *argv
[])
2454 char *userhost
, *user
;
2457 char *batchfile
= NULL
;
2460 flags
= FLAG_STDERR
| FLAG_INTERACTIVE
2461 #ifdef FLAG_SYNCAGENT
2465 cmdline_tooltype
= TOOLTYPE_FILETRANSFER
;
2466 ssh_get_line
= &console_get_line
;
2469 userhost
= user
= NULL
;
2471 /* Load Default Settings before doing anything else. */
2472 do_defaults(NULL
, &cfg
);
2473 loaded_session
= FALSE
;
2476 for (i
= 1; i
< argc
; i
++) {
2478 if (argv
[i
][0] != '-') {
2482 userhost
= dupstr(argv
[i
]);
2485 ret
= cmdline_process_param(argv
[i
], i
+1<argc?argv
[i
+1]:NULL
, 1, &cfg
);
2487 cmdline_error("option \"%s\" requires an argument", argv
[i
]);
2488 } else if (ret
== 2) {
2489 i
++; /* skip next argument */
2490 } else if (ret
== 1) {
2491 /* We have our own verbosity in addition to `flags'. */
2492 if (flags
& FLAG_VERBOSE
)
2494 } else if (strcmp(argv
[i
], "-h") == 0 ||
2495 strcmp(argv
[i
], "-?") == 0) {
2497 } else if (strcmp(argv
[i
], "-V") == 0) {
2499 } else if (strcmp(argv
[i
], "-batch") == 0) {
2500 console_batch_mode
= 1;
2501 } else if (strcmp(argv
[i
], "-b") == 0 && i
+ 1 < argc
) {
2503 batchfile
= argv
[++i
];
2504 } else if (strcmp(argv
[i
], "-bc") == 0) {
2505 modeflags
= modeflags
| 1;
2506 } else if (strcmp(argv
[i
], "-be") == 0) {
2507 modeflags
= modeflags
| 2;
2508 } else if (strcmp(argv
[i
], "--") == 0) {
2512 cmdline_error("unknown option \"%s\"", argv
[i
]);
2520 * If the loaded session provides a hostname, and a hostname has not
2521 * otherwise been specified, pop it in `userhost' so that
2522 * `psftp -load sessname' is sufficient to start a session.
2524 if (!userhost
&& cfg
.host
[0] != '\0') {
2525 userhost
= dupstr(cfg
.host
);
2529 * If a user@host string has already been provided, connect to
2534 ret
= psftp_connect(userhost
, user
, portnumber
);
2541 printf("psftp: no hostname specified; use \"open host.name\""
2545 do_sftp(mode
, modeflags
, batchfile
);
2547 if (back
!= NULL
&& back
->socket(backhandle
) != NULL
) {
2549 back
->special(backhandle
, TS_EOF
);
2550 sftp_recvdata(&ch
, 1);
2554 console_provide_logctx(NULL
);