2 * psftp.c: front end for PSFTP.
13 #define PUTTY_DO_GLOBALS
21 * Since SFTP is a request-response oriented protocol, it requires
22 * no buffer management: when we send data, we stop and wait for an
23 * acknowledgement _anyway_, and so we can't possibly overfill our
27 static int psftp_connect(char *userhost
, char *user
, int portnumber
);
28 static int do_sftp_init(void);
30 /* ----------------------------------------------------------------------
36 /* ----------------------------------------------------------------------
37 * Higher-level helper functions used in commands.
41 * Attempt to canonify a pathname starting from the pwd. If
42 * canonification fails, at least fall back to returning a _valid_
43 * pathname (though it may be ugly, eg /home/simon/../foobar).
45 char *canonify(char *name
)
47 char *fullname
, *canonname
;
50 fullname
= dupstr(name
);
53 if (pwd
[strlen(pwd
) - 1] == '/')
57 fullname
= dupcat(pwd
, slash
, name
, NULL
);
60 canonname
= fxp_realpath(fullname
);
67 * Attempt number 2. Some FXP_REALPATH implementations
68 * (glibc-based ones, in particular) require the _whole_
69 * path to point to something that exists, whereas others
70 * (BSD-based) only require all but the last component to
71 * exist. So if the first call failed, we should strip off
72 * everything from the last slash onwards and try again,
73 * then put the final component back on.
77 * - if the last component is "/." or "/..", then we don't
78 * bother trying this because there's no way it can work.
80 * - if the thing actually ends with a "/", we remove it
81 * before we start. Except if the string is "/" itself
82 * (although I can't see why we'd have got here if so,
83 * because surely "/" would have worked the first
84 * time?), in which case we don't bother.
86 * - if there's no slash in the string at all, give up in
87 * confusion (we expect at least one because of the way
88 * we constructed the string).
95 if (i
> 2 && fullname
[i
- 1] == '/')
96 fullname
[--i
] = '\0'; /* strip trailing / unless at pos 0 */
97 while (i
> 0 && fullname
[--i
] != '/');
100 * Give up on special cases.
102 if (fullname
[i
] != '/' || /* no slash at all */
103 !strcmp(fullname
+ i
, "/.") || /* ends in /. */
104 !strcmp(fullname
+ i
, "/..") || /* ends in /.. */
105 !strcmp(fullname
, "/")) {
110 * Now i points at the slash. Deal with the final special
111 * case i==0 (ie the whole path was "/nonexistentfile").
113 fullname
[i
] = '\0'; /* separate the string */
115 canonname
= fxp_realpath("/");
117 canonname
= fxp_realpath(fullname
);
121 return fullname
; /* even that failed; give up */
124 * We have a canonical name for all but the last path
125 * component. Concatenate the last component and return.
127 returnname
= dupcat(canonname
,
128 canonname
[strlen(canonname
) - 1] ==
129 '/' ?
"" : "/", fullname
+ i
+ 1, NULL
);
137 * Return a pointer to the portion of str that comes after the last
138 * slash (or backslash or colon, if `local' is TRUE).
140 static char *stripslashes(char *str
, int local
)
145 p
= strchr(str
, ':');
149 p
= strrchr(str
, '/');
153 p
= strrchr(str
, '\\');
160 /* ----------------------------------------------------------------------
161 * Actual sftp commands.
163 struct sftp_command
{
165 int nwords
, wordssize
;
166 int (*obey
) (struct sftp_command
*); /* returns <0 to quit */
169 int sftp_cmd_null(struct sftp_command
*cmd
)
171 return 1; /* success */
174 int sftp_cmd_unknown(struct sftp_command
*cmd
)
176 printf("psftp: unknown command \"%s\"\n", cmd
->words
[0]);
177 return 0; /* failure */
180 int sftp_cmd_quit(struct sftp_command
*cmd
)
186 * List a directory. If no arguments are given, list pwd; otherwise
187 * list the directory given in words[1].
189 static int sftp_ls_compare(const void *av
, const void *bv
)
191 const struct fxp_name
*a
= (const struct fxp_name
*) av
;
192 const struct fxp_name
*b
= (const struct fxp_name
*) bv
;
193 return strcmp(a
->filename
, b
->filename
);
195 int sftp_cmd_ls(struct sftp_command
*cmd
)
197 struct fxp_handle
*dirh
;
198 struct fxp_names
*names
;
199 struct fxp_name
*ournames
;
200 int nnames
, namesize
;
205 printf("psftp: not connected to a host; use \"open host.name\"\n");
214 cdir
= canonify(dir
);
216 printf("%s: %s\n", dir
, fxp_error());
220 printf("Listing directory %s\n", cdir
);
222 dirh
= fxp_opendir(cdir
);
224 printf("Unable to open %s: %s\n", dir
, fxp_error());
226 nnames
= namesize
= 0;
231 names
= fxp_readdir(dirh
);
233 if (fxp_error_type() == SSH_FX_EOF
)
235 printf("Reading directory %s: %s\n", dir
, fxp_error());
238 if (names
->nnames
== 0) {
239 fxp_free_names(names
);
243 if (nnames
+ names
->nnames
>= namesize
) {
244 namesize
+= names
->nnames
+ 128;
246 srealloc(ournames
, namesize
* sizeof(*ournames
));
249 for (i
= 0; i
< names
->nnames
; i
++)
250 ournames
[nnames
++] = names
->names
[i
];
252 names
->nnames
= 0; /* prevent free_names */
253 fxp_free_names(names
);
258 * Now we have our filenames. Sort them by actual file
259 * name, and then output the longname parts.
261 qsort(ournames
, nnames
, sizeof(*ournames
), sftp_ls_compare
);
266 for (i
= 0; i
< nnames
; i
++)
267 printf("%s\n", ournames
[i
].longname
);
276 * Change directories. We do this by canonifying the new name, then
277 * trying to OPENDIR it. Only if that succeeds do we set the new pwd.
279 int sftp_cmd_cd(struct sftp_command
*cmd
)
281 struct fxp_handle
*dirh
;
285 printf("psftp: not connected to a host; use \"open host.name\"\n");
290 dir
= dupstr(homedir
);
292 dir
= canonify(cmd
->words
[1]);
295 printf("%s: %s\n", dir
, fxp_error());
299 dirh
= fxp_opendir(dir
);
301 printf("Directory %s: %s\n", dir
, fxp_error());
310 printf("Remote directory is now %s\n", pwd
);
316 * Print current directory. Easy as pie.
318 int sftp_cmd_pwd(struct sftp_command
*cmd
)
321 printf("psftp: not connected to a host; use \"open host.name\"\n");
325 printf("Remote directory is %s\n", pwd
);
330 * Get a file and save it at the local end. We have two very
331 * similar commands here: `get' and `reget', which differ in that
332 * `reget' checks for the existence of the destination file and
333 * starts from where a previous aborted transfer left off.
335 int sftp_general_get(struct sftp_command
*cmd
, int restart
)
337 struct fxp_handle
*fh
;
338 char *fname
, *outfname
;
344 printf("psftp: not connected to a host; use \"open host.name\"\n");
348 if (cmd
->nwords
< 2) {
349 printf("get: expects a filename\n");
353 fname
= canonify(cmd
->words
[1]);
355 printf("%s: %s\n", cmd
->words
[1], fxp_error());
358 outfname
= (cmd
->nwords
== 2 ?
359 stripslashes(cmd
->words
[1], 0) : cmd
->words
[2]);
361 fh
= fxp_open(fname
, SSH_FXF_READ
);
363 printf("%s: %s\n", fname
, fxp_error());
369 fp
= fopen(outfname
, "rb+");
371 fp
= fopen(outfname
, "wb");
375 printf("local: unable to open %s\n", outfname
);
383 fseek(fp
, 0L, SEEK_END
);
385 printf("reget: restarting at file position %ld\n", posn
);
386 offset
= uint64_make(0, posn
);
388 offset
= uint64_make(0, 0);
391 printf("remote:%s => local:%s\n", fname
, outfname
);
394 * FIXME: we can use FXP_FSTAT here to get the file size, and
395 * thus put up a progress bar.
403 len
= fxp_read(fh
, buffer
, offset
, sizeof(buffer
));
404 if ((len
== -1 && fxp_error_type() == SSH_FX_EOF
) || len
== 0)
407 printf("error while reading: %s\n", fxp_error());
414 wlen
= fwrite(buffer
, 1, len
- wpos
, fp
);
416 printf("error while writing local file\n");
422 if (wpos
< len
) { /* we had an error */
426 offset
= uint64_add32(offset
, len
);
435 int sftp_cmd_get(struct sftp_command
*cmd
)
437 return sftp_general_get(cmd
, 0);
439 int sftp_cmd_reget(struct sftp_command
*cmd
)
441 return sftp_general_get(cmd
, 1);
445 * Send a file and store it at the remote end. We have two very
446 * similar commands here: `put' and `reput', which differ in that
447 * `reput' checks for the existence of the destination file and
448 * starts from where a previous aborted transfer left off.
450 int sftp_general_put(struct sftp_command
*cmd
, int restart
)
452 struct fxp_handle
*fh
;
453 char *fname
, *origoutfname
, *outfname
;
459 printf("psftp: not connected to a host; use \"open host.name\"\n");
463 if (cmd
->nwords
< 2) {
464 printf("put: expects a filename\n");
468 fname
= cmd
->words
[1];
469 origoutfname
= (cmd
->nwords
== 2 ?
470 stripslashes(cmd
->words
[1], 1) : cmd
->words
[2]);
471 outfname
= canonify(origoutfname
);
473 printf("%s: %s\n", origoutfname
, fxp_error());
477 fp
= fopen(fname
, "rb");
479 printf("local: unable to open %s\n", fname
);
484 fh
= fxp_open(outfname
,
487 fh
= fxp_open(outfname
,
488 SSH_FXF_WRITE
| SSH_FXF_CREAT
| SSH_FXF_TRUNC
);
491 printf("%s: %s\n", outfname
, fxp_error());
498 struct fxp_attrs attrs
;
499 if (!fxp_fstat(fh
, &attrs
)) {
500 printf("read size of %s: %s\n", outfname
, fxp_error());
504 if (!(attrs
.flags
& SSH_FILEXFER_ATTR_SIZE
)) {
505 printf("read size of %s: size was not given\n", outfname
);
510 uint64_decimal(offset
, decbuf
);
511 printf("reput: restarting at file position %s\n", decbuf
);
512 if (uint64_compare(offset
, uint64_make(0, LONG_MAX
)) > 0) {
513 printf("reput: remote file is larger than we can deal with\n");
517 if (fseek(fp
, offset
.lo
, SEEK_SET
) != 0)
518 fseek(fp
, 0, SEEK_END
); /* *shrug* */
520 offset
= uint64_make(0, 0);
523 printf("local:%s => remote:%s\n", fname
, outfname
);
526 * FIXME: we can use FXP_FSTAT here to get the file size, and
527 * thus put up a progress bar.
534 len
= fread(buffer
, 1, sizeof(buffer
), fp
);
536 printf("error while reading local file\n");
539 } else if (len
== 0) {
542 if (!fxp_write(fh
, buffer
, offset
, len
)) {
543 printf("error while writing: %s\n", fxp_error());
547 offset
= uint64_add32(offset
, len
);
556 int sftp_cmd_put(struct sftp_command
*cmd
)
558 return sftp_general_put(cmd
, 0);
560 int sftp_cmd_reput(struct sftp_command
*cmd
)
562 return sftp_general_put(cmd
, 1);
565 int sftp_cmd_mkdir(struct sftp_command
*cmd
)
571 printf("psftp: not connected to a host; use \"open host.name\"\n");
575 if (cmd
->nwords
< 2) {
576 printf("mkdir: expects a directory\n");
580 dir
= canonify(cmd
->words
[1]);
582 printf("%s: %s\n", dir
, fxp_error());
586 result
= fxp_mkdir(dir
);
588 printf("mkdir %s: %s\n", dir
, fxp_error());
597 int sftp_cmd_rmdir(struct sftp_command
*cmd
)
603 printf("psftp: not connected to a host; use \"open host.name\"\n");
607 if (cmd
->nwords
< 2) {
608 printf("rmdir: expects a directory\n");
612 dir
= canonify(cmd
->words
[1]);
614 printf("%s: %s\n", dir
, fxp_error());
618 result
= fxp_rmdir(dir
);
620 printf("rmdir %s: %s\n", dir
, fxp_error());
629 int sftp_cmd_rm(struct sftp_command
*cmd
)
635 printf("psftp: not connected to a host; use \"open host.name\"\n");
639 if (cmd
->nwords
< 2) {
640 printf("rm: expects a filename\n");
644 fname
= canonify(cmd
->words
[1]);
646 printf("%s: %s\n", fname
, fxp_error());
650 result
= fxp_remove(fname
);
652 printf("rm %s: %s\n", fname
, fxp_error());
661 int sftp_cmd_mv(struct sftp_command
*cmd
)
663 char *srcfname
, *dstfname
;
667 printf("psftp: not connected to a host; use \"open host.name\"\n");
671 if (cmd
->nwords
< 3) {
672 printf("mv: expects two filenames\n");
675 srcfname
= canonify(cmd
->words
[1]);
677 printf("%s: %s\n", srcfname
, fxp_error());
681 dstfname
= canonify(cmd
->words
[2]);
683 printf("%s: %s\n", dstfname
, fxp_error());
687 result
= fxp_rename(srcfname
, dstfname
);
689 char const *error
= fxp_error();
690 struct fxp_attrs attrs
;
693 * The move might have failed because dstfname pointed at a
694 * directory. We check this possibility now: if dstfname
695 * _is_ a directory, we re-attempt the move by appending
696 * the basename of srcfname to dstfname.
698 result
= fxp_stat(dstfname
, &attrs
);
700 (attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
) &&
701 (attrs
.permissions
& 0040000)) {
703 char *newname
, *newcanon
;
704 printf("(destination %s is a directory)\n", dstfname
);
705 p
= srcfname
+ strlen(srcfname
);
706 while (p
> srcfname
&& p
[-1] != '/') p
--;
707 newname
= dupcat(dstfname
, "/", p
, NULL
);
708 newcanon
= canonify(newname
);
713 result
= fxp_rename(srcfname
, dstfname
);
714 error
= result ? NULL
: fxp_error();
718 printf("mv %s %s: %s\n", srcfname
, dstfname
, error
);
724 printf("%s -> %s\n", srcfname
, dstfname
);
731 int sftp_cmd_chmod(struct sftp_command
*cmd
)
735 struct fxp_attrs attrs
;
736 unsigned attrs_clr
, attrs_xor
, oldperms
, newperms
;
739 printf("psftp: not connected to a host; use \"open host.name\"\n");
743 if (cmd
->nwords
< 3) {
744 printf("chmod: expects a mode specifier and a filename\n");
749 * Attempt to parse the mode specifier in cmd->words[1]. We
750 * don't support the full horror of Unix chmod; instead we
751 * support a much simpler syntax in which the user can either
752 * specify an octal number, or a comma-separated sequence of
753 * [ugoa]*[-+=][rwxst]+. (The initial [ugoa] sequence may
754 * _only_ be omitted if the only attribute mentioned is t,
755 * since all others require a user/group/other specification.
756 * Additionally, the s attribute may not be specified for any
757 * [ugoa] specifications other than exactly u or exactly g.
759 attrs_clr
= attrs_xor
= 0;
760 mode
= cmd
->words
[1];
761 if (mode
[0] >= '0' && mode
[0] <= '9') {
762 if (mode
[strspn(mode
, "01234567")]) {
763 printf("chmod: numeric file modes should"
764 " contain digits 0-7 only\n");
768 sscanf(mode
, "%o", &attrs_xor
);
769 attrs_xor
&= attrs_clr
;
772 char *modebegin
= mode
;
773 unsigned subset
, perms
;
777 while (*mode
&& *mode
!= ',' &&
778 *mode
!= '+' && *mode
!= '-' && *mode
!= '=') {
780 case 'u': subset
|= 04700; break; /* setuid, user perms */
781 case 'g': subset
|= 02070; break; /* setgid, group perms */
782 case 'o': subset
|= 00007; break; /* just other perms */
783 case 'a': subset
|= 06777; break; /* all of the above */
785 printf("chmod: file mode '%.*s' contains unrecognised"
786 " user/group/other specifier '%c'\n",
787 strcspn(modebegin
, ","), modebegin
, *mode
);
792 if (!*mode
|| *mode
== ',') {
793 printf("chmod: file mode '%.*s' is incomplete\n",
794 strcspn(modebegin
, ","), modebegin
);
798 if (!*mode
|| *mode
== ',') {
799 printf("chmod: file mode '%.*s' is incomplete\n",
800 strcspn(modebegin
, ","), modebegin
);
804 while (*mode
&& *mode
!= ',') {
806 case 'r': perms
|= 00444; break;
807 case 'w': perms
|= 00222; break;
808 case 'x': perms
|= 00111; break;
809 case 't': perms
|= 01000; subset
|= 01000; break;
811 if ((subset
& 06777) != 04700 &&
812 (subset
& 06777) != 02070) {
813 printf("chmod: file mode '%.*s': set[ug]id bit should"
814 " be used with exactly one of u or g only\n",
815 strcspn(modebegin
, ","), modebegin
);
821 printf("chmod: file mode '%.*s' contains unrecognised"
822 " permission specifier '%c'\n",
823 strcspn(modebegin
, ","), modebegin
, *mode
);
828 if (!(subset
& 06777) && (perms
&~ subset
)) {
829 printf("chmod: file mode '%.*s' contains no user/group/other"
830 " specifier and permissions other than 't' \n",
831 strcspn(modebegin
, ","), modebegin
, *mode
);
849 if (*mode
) mode
++; /* eat comma */
853 fname
= canonify(cmd
->words
[2]);
855 printf("%s: %s\n", fname
, fxp_error());
859 result
= fxp_stat(fname
, &attrs
);
860 if (!result
|| !(attrs
.flags
& SSH_FILEXFER_ATTR_PERMISSIONS
)) {
861 printf("get attrs for %s: %s\n", fname
,
862 result ?
"file permissions not provided" : fxp_error());
867 attrs
.flags
= SSH_FILEXFER_ATTR_PERMISSIONS
; /* perms _only_ */
868 oldperms
= attrs
.permissions
& 07777;
869 attrs
.permissions
&= ~attrs_clr
;
870 attrs
.permissions
^= attrs_xor
;
871 newperms
= attrs
.permissions
& 07777;
873 result
= fxp_setstat(fname
, attrs
);
876 printf("set attrs for %s: %s\n", fname
, fxp_error());
881 printf("%s: %04o -> %04o\n", fname
, oldperms
, newperms
);
887 static int sftp_cmd_open(struct sftp_command
*cmd
)
890 printf("psftp: already connected\n");
894 if (cmd
->nwords
< 2) {
895 printf("open: expects a host name\n");
899 if (psftp_connect(cmd
->words
[1], NULL
, 0)) {
900 back
= NULL
; /* connection is already closed */
901 return -1; /* this is fatal */
907 static int sftp_cmd_lcd(struct sftp_command
*cmd
)
912 if (cmd
->nwords
< 2) {
913 printf("lcd: expects a local directory name\n");
917 if (!SetCurrentDirectory(cmd
->words
[1])) {
920 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
|
921 FORMAT_MESSAGE_FROM_SYSTEM
|
922 FORMAT_MESSAGE_IGNORE_INSERTS
,
923 NULL
, GetLastError(),
924 MAKELANGID(LANG_NEUTRAL
, SUBLANG_DEFAULT
),
925 (LPTSTR
)&message
, 0, NULL
);
926 i
= strcspn((char *)message
, "\n");
927 printf("lcd: unable to change directory: %.*s\n", i
, (LPCTSTR
)message
);
932 currdir
= smalloc(256);
933 len
= GetCurrentDirectory(256, currdir
);
935 currdir
= srealloc(currdir
, len
);
936 GetCurrentDirectory(len
, currdir
);
937 printf("New local directory is %s\n", currdir
);
943 static int sftp_cmd_lpwd(struct sftp_command
*cmd
)
948 currdir
= smalloc(256);
949 len
= GetCurrentDirectory(256, currdir
);
951 currdir
= srealloc(currdir
, len
);
952 GetCurrentDirectory(len
, currdir
);
953 printf("Current local directory is %s\n", currdir
);
959 static int sftp_cmd_pling(struct sftp_command
*cmd
)
963 exitcode
= system(cmd
->words
[1]);
964 return (exitcode
== 0);
967 static int sftp_cmd_help(struct sftp_command
*cmd
);
969 static struct sftp_cmd_lookup
{
972 * For help purposes, there are two kinds of command:
974 * - primary commands, in which `longhelp' is non-NULL. In
975 * this case `shorthelp' is descriptive text, and `longhelp'
976 * is longer descriptive text intended to be printed after
979 * - alias commands, in which `longhelp' is NULL. In this case
980 * `shorthelp' is the name of a primary command, which
981 * contains the help that should double up for this command.
983 int listed
; /* do we list this in primary help? */
986 int (*obey
) (struct sftp_command
*);
989 * List of sftp commands. This is binary-searched so it MUST be
993 "!", TRUE
, "run a local Windows command",
995 " Runs a local Windows command. For example, \"!del myfile\".\n",
999 "bye", TRUE
, "finish your SFTP session",
1001 " Terminates your SFTP session and quits the PSFTP program.\n",
1005 "cd", TRUE
, "change your remote working directory",
1006 " [ <New working directory> ]\n"
1007 " Change the remote working directory for your SFTP session.\n"
1008 " If a new working directory is not supplied, you will be\n"
1009 " returned to your home directory.\n",
1013 "chmod", TRUE
, "change file permissions and modes",
1014 " ( <octal-digits> | <modifiers> ) <filename>\n"
1015 " Change the file permissions on a file or directory.\n"
1016 " <octal-digits> can be any octal Unix permission specifier.\n"
1017 " Alternatively, <modifiers> can include:\n"
1018 " u+r make file readable by owning user\n"
1019 " u+w make file writable by owning user\n"
1020 " u+x make file executable by owning user\n"
1021 " u-r make file not readable by owning user\n"
1022 " [also u-w, u-x]\n"
1023 " g+r make file readable by members of owning group\n"
1024 " [also g+w, g+x, g-r, g-w, g-x]\n"
1025 " o+r make file readable by all other users\n"
1026 " [also o+w, o+x, o-r, o-w, o-x]\n"
1027 " a+r make file readable by absolutely everybody\n"
1028 " [also a+w, a+x, a-r, a-w, a-x]\n"
1029 " u+s enable the Unix set-user-ID bit\n"
1030 " u-s disable the Unix set-user-ID bit\n"
1031 " g+s enable the Unix set-group-ID bit\n"
1032 " g-s disable the Unix set-group-ID bit\n"
1033 " +t enable the Unix \"sticky bit\"\n"
1034 " You can give more than one modifier for the same user (\"g-rwx\"), and\n"
1035 " more than one user for the same modifier (\"ug+w\"). You can\n"
1036 " use commas to separate different modifiers (\"u+rwx,g+s\").\n",
1040 "del", TRUE
, "delete a file",
1042 " Delete a file.\n",
1046 "delete", FALSE
, "del", NULL
, sftp_cmd_rm
1049 "dir", TRUE
, "list contents of a remote directory",
1050 " [ <directory-name> ]\n"
1051 " List the contents of a specified directory on the server.\n"
1052 " If <directory-name> is not given, the current working directory\n"
1053 " will be listed.\n",
1057 "exit", TRUE
, "bye", NULL
, sftp_cmd_quit
1060 "get", TRUE
, "download a file from the server to your local machine",
1061 " <filename> [ <local-filename> ]\n"
1062 " Downloads a file on the server and stores it locally under\n"
1063 " the same name, or under a different one if you supply the\n"
1064 " argument <local-filename>.\n",
1068 "help", TRUE
, "give help",
1069 " [ <command> [ <command> ... ] ]\n"
1070 " Give general help if no commands are specified.\n"
1071 " If one or more commands are specified, give specific help on\n"
1072 " those particular commands.\n",
1076 "lcd", TRUE
, "change local working directory",
1077 " <local-directory-name>\n"
1078 " Change the local working directory of the PSFTP program (the\n"
1079 " default location where the \"get\" command will save files).\n",
1083 "lpwd", TRUE
, "print local working directory",
1085 " Print the local working directory of the PSFTP program (the\n"
1086 " default location where the \"get\" command will save files).\n",
1090 "ls", TRUE
, "dir", NULL
,
1094 "mkdir", TRUE
, "create a directory on the remote server",
1095 " <directory-name>\n"
1096 " Creates a directory with the given name on the server.\n",
1100 "mv", TRUE
, "move or rename a file on the remote server",
1101 " <source-filename> <destination-filename>\n"
1102 " Moves or renames the file <source-filename> on the server,\n"
1103 " so that it is accessible under the name <destination-filename>.\n",
1107 "open", TRUE
, "connect to a host",
1108 " [<user>@]<hostname>\n"
1109 " Establishes an SFTP connection to a given host. Only usable\n"
1110 " when you did not already specify a host name on the command\n"
1115 "put", TRUE
, "upload a file from your local machine to the server",
1116 " <filename> [ <remote-filename> ]\n"
1117 " Uploads a file to the server and stores it there under\n"
1118 " the same name, or under a different one if you supply the\n"
1119 " argument <remote-filename>.\n",
1123 "pwd", TRUE
, "print your remote working directory",
1125 " Print the current remote working directory for your SFTP session.\n",
1129 "quit", TRUE
, "bye", NULL
,
1133 "reget", TRUE
, "continue downloading a file",
1134 " <filename> [ <local-filename> ]\n"
1135 " Works exactly like the \"get\" command, but the local file\n"
1136 " must already exist. The download will begin at the end of the\n"
1137 " file. This is for resuming a download that was interrupted.\n",
1141 "ren", TRUE
, "mv", NULL
,
1145 "rename", FALSE
, "mv", NULL
,
1149 "reput", TRUE
, "continue uploading a file",
1150 " <filename> [ <remote-filename> ]\n"
1151 " Works exactly like the \"put\" command, but the remote file\n"
1152 " must already exist. The upload will begin at the end of the\n"
1153 " file. This is for resuming an upload that was interrupted.\n",
1157 "rm", TRUE
, "del", NULL
,
1161 "rmdir", TRUE
, "remove a directory on the remote server",
1162 " <directory-name>\n"
1163 " Removes the directory with the given name on the server.\n"
1164 " The directory will not be removed unless it is empty.\n",
1169 const struct sftp_cmd_lookup
*lookup_command(char *name
)
1174 j
= sizeof(sftp_lookup
) / sizeof(*sftp_lookup
);
1177 cmp
= strcmp(name
, sftp_lookup
[k
].name
);
1183 return &sftp_lookup
[k
];
1189 static int sftp_cmd_help(struct sftp_command
*cmd
)
1192 if (cmd
->nwords
== 1) {
1194 * Give short help on each command.
1198 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
1200 if (!sftp_lookup
[i
].listed
)
1202 len
= strlen(sftp_lookup
[i
].name
);
1206 for (i
= 0; i
< sizeof(sftp_lookup
) / sizeof(*sftp_lookup
); i
++) {
1207 const struct sftp_cmd_lookup
*lookup
;
1208 if (!sftp_lookup
[i
].listed
)
1210 lookup
= &sftp_lookup
[i
];
1211 printf("%-*s", maxlen
+2, lookup
->name
);
1212 if (lookup
->longhelp
== NULL
)
1213 lookup
= lookup_command(lookup
->shorthelp
);
1214 printf("%s\n", lookup
->shorthelp
);
1218 * Give long help on specific commands.
1220 for (i
= 1; i
< cmd
->nwords
; i
++) {
1221 const struct sftp_cmd_lookup
*lookup
;
1222 lookup
= lookup_command(cmd
->words
[i
]);
1224 printf("help: %s: command not found\n", cmd
->words
[i
]);
1226 printf("%s", lookup
->name
);
1227 if (lookup
->longhelp
== NULL
)
1228 lookup
= lookup_command(lookup
->shorthelp
);
1229 printf("%s", lookup
->longhelp
);
1236 /* ----------------------------------------------------------------------
1237 * Command line reading and parsing.
1239 struct sftp_command
*sftp_getcmd(FILE *fp
, int mode
, int modeflags
)
1242 int linelen
, linesize
;
1243 struct sftp_command
*cmd
;
1247 if ((mode
== 0) || (modeflags
& 1)) {
1252 cmd
= smalloc(sizeof(struct sftp_command
));
1258 linesize
= linelen
= 0;
1264 line
= srealloc(line
, linesize
);
1265 ret
= fgets(line
+ linelen
, linesize
- linelen
, fp
);
1267 if (!ret
|| (linelen
== 0 && line
[0] == '\0')) {
1268 cmd
->obey
= sftp_cmd_quit
;
1269 if ((mode
== 0) || (modeflags
& 1))
1271 return cmd
; /* eof */
1273 len
= linelen
+ strlen(line
+ linelen
);
1275 if (line
[linelen
- 1] == '\n') {
1277 line
[linelen
] = '\0';
1281 if (modeflags
& 1) {
1282 printf("%s\n", line
);
1286 while (*p
&& (*p
== ' ' || *p
== '\t'))
1291 * Special case: the ! command. This is always parsed as
1292 * exactly two words: one containing the !, and the second
1293 * containing everything else on the line.
1295 cmd
->nwords
= cmd
->wordssize
= 2;
1296 cmd
->words
= srealloc(cmd
->words
, cmd
->wordssize
* sizeof(char *));
1297 cmd
->words
[0] = "!";
1298 cmd
->words
[1] = p
+1;
1302 * Parse the command line into words. The syntax is:
1303 * - double quotes are removed, but cause spaces within to be
1304 * treated as non-separating.
1305 * - a double-doublequote pair is a literal double quote, inside
1306 * _or_ outside quotes. Like this:
1308 * firstword "second word" "this has ""quotes"" in" and""this""
1314 * >this has "quotes" in<
1318 /* skip whitespace */
1319 while (*p
&& (*p
== ' ' || *p
== '\t'))
1321 /* mark start of word */
1322 q
= r
= p
; /* q sits at start, r writes word */
1325 if (!quoting
&& (*p
== ' ' || *p
== '\t'))
1326 break; /* reached end of word */
1327 else if (*p
== '"' && p
[1] == '"')
1328 p
+= 2, *r
++ = '"'; /* a literal quote */
1330 p
++, quoting
= !quoting
;
1335 p
++; /* skip over the whitespace */
1337 if (cmd
->nwords
>= cmd
->wordssize
) {
1338 cmd
->wordssize
= cmd
->nwords
+ 16;
1340 srealloc(cmd
->words
, cmd
->wordssize
* sizeof(char *));
1342 cmd
->words
[cmd
->nwords
++] = q
;
1347 * Now parse the first word and assign a function.
1350 if (cmd
->nwords
== 0)
1351 cmd
->obey
= sftp_cmd_null
;
1353 const struct sftp_cmd_lookup
*lookup
;
1354 lookup
= lookup_command(cmd
->words
[0]);
1356 cmd
->obey
= sftp_cmd_unknown
;
1358 cmd
->obey
= lookup
->obey
;
1364 static int do_sftp_init(void)
1367 * Do protocol initialisation.
1371 "Fatal: unable to initialise SFTP: %s\n", fxp_error());
1372 return 1; /* failure */
1376 * Find out where our home directory is.
1378 homedir
= fxp_realpath(".");
1381 "Warning: failed to resolve home directory: %s\n",
1383 homedir
= dupstr(".");
1385 printf("Remote working directory is %s\n", homedir
);
1387 pwd
= dupstr(homedir
);
1391 void do_sftp(int mode
, int modeflags
, char *batchfile
)
1401 /* ------------------------------------------------------------------
1402 * Now we're ready to do Real Stuff.
1405 struct sftp_command
*cmd
;
1406 cmd
= sftp_getcmd(stdin
, 0, 0);
1409 if (cmd
->obey(cmd
) < 0)
1413 fp
= fopen(batchfile
, "r");
1415 printf("Fatal: unable to open %s\n", batchfile
);
1419 struct sftp_command
*cmd
;
1420 cmd
= sftp_getcmd(fp
, mode
, modeflags
);
1423 ret
= cmd
->obey(cmd
);
1427 if (!(modeflags
& 2))
1436 /* ----------------------------------------------------------------------
1437 * Dirty bits: integration with PuTTY.
1440 static int verbose
= 0;
1443 * Print an error message and perform a fatal exit.
1445 void fatalbox(char *fmt
, ...)
1447 char str
[0x100]; /* Make the size big enough */
1450 strcpy(str
, "Fatal:");
1451 vsprintf(str
+ strlen(str
), fmt
, ap
);
1458 void connection_fatal(char *fmt
, ...)
1460 char str
[0x100]; /* Make the size big enough */
1463 strcpy(str
, "Fatal:");
1464 vsprintf(str
+ strlen(str
), fmt
, ap
);
1472 void ldisc_send(char *buf
, int len
, int interactive
)
1475 * This is only here because of the calls to ldisc_send(NULL,
1476 * 0) in ssh.c. Nothing in PSFTP actually needs to use the
1477 * ldisc as an ldisc. So if we get called with any real data, I
1478 * want to know about it.
1484 * Be told what socket we're supposed to be using.
1486 static SOCKET sftp_ssh_socket
;
1487 char *do_select(SOCKET skt
, int startup
)
1490 sftp_ssh_socket
= skt
;
1492 sftp_ssh_socket
= INVALID_SOCKET
;
1495 extern int select_result(WPARAM
, LPARAM
);
1498 * Receive a block of data from the SSH link. Block until all data
1501 * To do this, we repeatedly call the SSH protocol module, with our
1502 * own trap in from_backend() to catch the data that comes back. We
1503 * do this until we have enough data.
1506 static unsigned char *outptr
; /* where to put the data */
1507 static unsigned outlen
; /* how much data required */
1508 static unsigned char *pending
= NULL
; /* any spare data */
1509 static unsigned pendlen
= 0, pendsize
= 0; /* length and phys. size of buffer */
1510 int from_backend(int is_stderr
, char *data
, int datalen
)
1512 unsigned char *p
= (unsigned char *) data
;
1513 unsigned len
= (unsigned) datalen
;
1518 * stderr data is just spouted to local stderr and otherwise
1522 fwrite(data
, 1, len
, stderr
);
1527 * If this is before the real session begins, just return.
1533 unsigned used
= outlen
;
1536 memcpy(outptr
, p
, used
);
1544 if (pendsize
< pendlen
+ len
) {
1545 pendsize
= pendlen
+ len
+ 4096;
1546 pending
= (pending ?
srealloc(pending
, pendsize
) :
1549 fatalbox("Out of memory");
1551 memcpy(pending
+ pendlen
, p
, len
);
1557 int sftp_recvdata(char *buf
, int len
)
1559 outptr
= (unsigned char *) buf
;
1563 * See if the pending-input block contains some of what we
1567 unsigned pendused
= pendlen
;
1568 if (pendused
> outlen
)
1570 memcpy(outptr
, pending
, pendused
);
1571 memmove(pending
, pending
+ pendused
, pendlen
- pendused
);
1574 pendlen
-= pendused
;
1584 while (outlen
> 0) {
1588 FD_SET(sftp_ssh_socket
, &readfds
);
1589 if (select(1, &readfds
, NULL
, NULL
, NULL
) < 0)
1590 return 0; /* doom */
1591 select_result((WPARAM
) sftp_ssh_socket
, (LPARAM
) FD_READ
);
1596 int sftp_senddata(char *buf
, int len
)
1598 back
->send((unsigned char *) buf
, len
);
1603 * Loop through the ssh connection and authentication process.
1605 static void ssh_sftp_init(void)
1607 if (sftp_ssh_socket
== INVALID_SOCKET
)
1609 while (!back
->sendok()) {
1612 FD_SET(sftp_ssh_socket
, &readfds
);
1613 if (select(1, &readfds
, NULL
, NULL
, NULL
) < 0)
1615 select_result((WPARAM
) sftp_ssh_socket
, (LPARAM
) FD_READ
);
1620 * Initialize the Win$ock driver.
1622 static void init_winsock(void)
1627 winsock_ver
= MAKEWORD(1, 1);
1628 if (WSAStartup(winsock_ver
, &wsadata
)) {
1629 fprintf(stderr
, "Unable to initialise WinSock");
1632 if (LOBYTE(wsadata
.wVersion
) != 1 || HIBYTE(wsadata
.wVersion
) != 1) {
1633 fprintf(stderr
, "WinSock version is incompatible with 1.1");
1639 * Short description of parameters.
1641 static void usage(void)
1643 printf("PuTTY Secure File Transfer (SFTP) client\n");
1644 printf("%s\n", ver
);
1645 printf("Usage: psftp [options] user@host\n");
1646 printf("Options:\n");
1647 printf(" -b file use specified batchfile\n");
1648 printf(" -bc output batchfile commands\n");
1649 printf(" -be don't stop batchfile processing if errors\n");
1650 printf(" -v show verbose messages\n");
1651 printf(" -P port connect to specified port\n");
1652 printf(" -pw passw login with specified password\n");
1657 * Connect to a host.
1659 static int psftp_connect(char *userhost
, char *user
, int portnumber
)
1661 char *host
, *realhost
;
1664 /* Separate host and username */
1666 host
= strrchr(host
, '@');
1672 printf("psftp: multiple usernames specified; using \"%s\"\n",
1678 /* Try to load settings for this host */
1679 do_defaults(host
, &cfg
);
1680 if (cfg
.host
[0] == '\0') {
1681 /* No settings for this host; use defaults */
1682 do_defaults(NULL
, &cfg
);
1683 strncpy(cfg
.host
, host
, sizeof(cfg
.host
) - 1);
1684 cfg
.host
[sizeof(cfg
.host
) - 1] = '\0';
1689 * Trim leading whitespace off the hostname if it's there.
1692 int space
= strspn(cfg
.host
, " \t");
1693 memmove(cfg
.host
, cfg
.host
+space
, 1+strlen(cfg
.host
)-space
);
1696 /* See if host is of the form user@host */
1697 if (cfg
.host
[0] != '\0') {
1698 char *atsign
= strchr(cfg
.host
, '@');
1699 /* Make sure we're not overflowing the user field */
1701 if (atsign
- cfg
.host
< sizeof cfg
.username
) {
1702 strncpy(cfg
.username
, cfg
.host
, atsign
- cfg
.host
);
1703 cfg
.username
[atsign
- cfg
.host
] = '\0';
1705 memmove(cfg
.host
, atsign
+ 1, 1 + strlen(atsign
+ 1));
1710 * Trim a colon suffix off the hostname if it's there.
1712 cfg
.host
[strcspn(cfg
.host
, ":")] = '\0';
1715 if (user
!= NULL
&& user
[0] != '\0') {
1716 strncpy(cfg
.username
, user
, sizeof(cfg
.username
) - 1);
1717 cfg
.username
[sizeof(cfg
.username
) - 1] = '\0';
1719 if (!cfg
.username
[0]) {
1720 printf("login as: ");
1721 if (!fgets(cfg
.username
, sizeof(cfg
.username
), stdin
)) {
1722 fprintf(stderr
, "psftp: aborting\n");
1725 int len
= strlen(cfg
.username
);
1726 if (cfg
.username
[len
- 1] == '\n')
1727 cfg
.username
[len
- 1] = '\0';
1731 if (cfg
.protocol
!= PROT_SSH
)
1735 cfg
.port
= portnumber
;
1737 /* SFTP uses SSH2 by default always */
1741 * Disable scary things which shouldn't be enabled for simple
1742 * things like SCP and SFTP: agent forwarding, port forwarding,
1745 cfg
.x11_forward
= 0;
1747 cfg
.portfwd
[0] = cfg
.portfwd
[1] = '\0';
1749 /* Set up subsystem name. */
1750 strcpy(cfg
.remote_cmd
, "sftp");
1751 cfg
.ssh_subsys
= TRUE
;
1755 * Set up fallback option, for SSH1 servers or servers with the
1756 * sftp subsystem not enabled but the server binary installed
1757 * in the usual place. We only support fallback on Unix
1758 * systems, and we use a kludgy piece of shellery which should
1759 * try to find sftp-server in various places (the obvious
1760 * systemwide spots /usr/lib and /usr/local/lib, and then the
1761 * user's PATH) and finally give up.
1763 * test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server
1764 * test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server
1767 * the idea being that this will attempt to use either of the
1768 * obvious pathnames and then give up, and when it does give up
1769 * it will print the preferred pathname in the error messages.
1771 cfg
.remote_cmd_ptr2
=
1772 "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
1773 "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
1775 cfg
.ssh_subsys2
= FALSE
;
1777 back
= &ssh_backend
;
1779 err
= back
->init(cfg
.host
, cfg
.port
, &realhost
, 0);
1781 fprintf(stderr
, "ssh_init: %s\n", err
);
1785 if (verbose
&& realhost
!= NULL
)
1786 printf("Connected to %s\n", realhost
);
1791 * Main program. Parse arguments etc.
1793 int main(int argc
, char *argv
[])
1797 char *userhost
, *user
;
1800 char *batchfile
= NULL
;
1802 flags
= FLAG_STDERR
| FLAG_INTERACTIVE
;
1803 ssh_get_line
= &console_get_line
;
1807 userhost
= user
= NULL
;
1809 for (i
= 1; i
< argc
; i
++) {
1810 if (argv
[i
][0] != '-') {
1814 userhost
= dupstr(argv
[i
]);
1815 } else if (strcmp(argv
[i
], "-v") == 0) {
1816 verbose
= 1, flags
|= FLAG_VERBOSE
;
1817 } else if (strcmp(argv
[i
], "-h") == 0 ||
1818 strcmp(argv
[i
], "-?") == 0) {
1820 } else if (strcmp(argv
[i
], "-l") == 0 && i
+ 1 < argc
) {
1822 } else if (strcmp(argv
[i
], "-P") == 0 && i
+ 1 < argc
) {
1823 portnumber
= atoi(argv
[++i
]);
1824 } else if (strcmp(argv
[i
], "-pw") == 0 && i
+ 1 < argc
) {
1825 console_password
= argv
[++i
];
1826 } else if (strcmp(argv
[i
], "-b") == 0 && i
+ 1 < argc
) {
1828 batchfile
= argv
[++i
];
1829 } else if (strcmp(argv
[i
], "-bc") == 0) {
1830 modeflags
= modeflags
| 1;
1831 } else if (strcmp(argv
[i
], "-batch") == 0) {
1832 console_batch_mode
= TRUE
;
1833 } else if (strcmp(argv
[i
], "-be") == 0) {
1834 modeflags
= modeflags
| 2;
1835 } else if (strcmp(argv
[i
], "--") == 0) {
1847 * If a user@host string has already been provided, connect to
1851 if (psftp_connect(userhost
, user
, portnumber
))
1856 printf("psftp: no hostname specified; use \"open host.name\""
1860 do_sftp(mode
, modeflags
, batchfile
);
1862 if (back
!= NULL
&& back
->socket() != NULL
) {
1864 back
->special(TS_EOF
);
1865 sftp_recvdata(&ch
, 1);