1 /* $OpenBSD: sftp.c,v 1.101 2008/06/08 20:15:29 dtucker Exp $ */
3 * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include <sys/types.h>
21 #include <sys/ioctl.h>
22 #ifdef HAVE_SYS_STAT_H
23 # include <sys/stat.h>
25 #include <sys/param.h>
26 #include <sys/socket.h>
28 #ifdef HAVE_SYS_STATVFS_H
29 #include <sys/statvfs.h>
41 typedef void EditLine
;
60 #include "pathnames.h"
65 #include "sftp-common.h"
66 #include "sftp-client.h"
68 /* File to read commands from */
71 /* Are we in batchfile mode? */
74 /* Size of buffer used when copying files */
75 size_t copy_buffer_len
= 32768;
77 /* Number of concurrent outstanding requests */
78 size_t num_requests
= 16;
80 /* PID of ssh transport process */
81 static pid_t sshpid
= -1;
83 /* This is set to 0 if the progressmeter is not desired. */
86 /* SIGINT received during command processing */
87 volatile sig_atomic_t interrupted
= 0;
89 /* I wish qsort() took a separate ctx for the comparison function...*/
92 int remote_glob(struct sftp_conn
*, const char *, int,
93 int (*)(const char *, int), glob_t
*); /* proto for sftp-glob.c */
95 extern char *__progname
;
97 /* Separators for interactive commands */
98 #define WHITESPACE " \t\r\n"
101 #define LS_LONG_VIEW 0x01 /* Full view ala ls -l */
102 #define LS_SHORT_VIEW 0x02 /* Single row view ala ls -1 */
103 #define LS_NUMERIC_VIEW 0x04 /* Long view with numeric uid/gid */
104 #define LS_NAME_SORT 0x08 /* Sort by name (default) */
105 #define LS_TIME_SORT 0x10 /* Sort by mtime */
106 #define LS_SIZE_SORT 0x20 /* Sort by file size */
107 #define LS_REVERSE_SORT 0x40 /* Reverse sort order */
108 #define LS_SHOW_ALL 0x80 /* Don't skip filenames starting with '.' */
110 #define VIEW_FLAGS (LS_LONG_VIEW|LS_SHORT_VIEW|LS_NUMERIC_VIEW)
111 #define SORT_FLAGS (LS_NAME_SORT|LS_TIME_SORT|LS_SIZE_SORT)
113 /* Commands for interactive mode */
137 #define I_PROGRESS 23
144 static const struct CMD cmds
[] = {
147 { "chdir", I_CHDIR
},
148 { "chgrp", I_CHGRP
},
149 { "chmod", I_CHMOD
},
150 { "chown", I_CHOWN
},
158 { "lchdir", I_LCHDIR
},
160 { "lmkdir", I_LMKDIR
},
164 { "lumask", I_LUMASK
},
165 { "mkdir", I_MKDIR
},
166 { "progress", I_PROGRESS
},
171 { "rename", I_RENAME
},
173 { "rmdir", I_RMDIR
},
174 { "symlink", I_SYMLINK
},
175 { "version", I_VERSION
},
181 int interactive_loop(int fd_in
, int fd_out
, char *file1
, char *file2
);
188 kill(sshpid
, SIGTERM
);
189 waitpid(sshpid
, NULL
, 0);
197 cmd_interrupt(int signo
)
199 const char msg
[] = "\rInterrupt \n";
200 int olderrno
= errno
;
202 write(STDERR_FILENO
, msg
, sizeof(msg
) - 1);
210 printf("Available commands:\n");
211 printf("cd path Change remote directory to 'path'\n");
212 printf("lcd path Change local directory to 'path'\n");
213 printf("chgrp grp path Change group of file 'path' to 'grp'\n");
214 printf("chmod mode path Change permissions of file 'path' to 'mode'\n");
215 printf("chown own path Change owner of file 'path' to 'own'\n");
216 printf("df [path] Display statistics for current directory or\n");
217 printf(" filesystem containing 'path'\n");
218 printf("help Display this help text\n");
219 printf("get remote-path [local-path] Download file\n");
220 printf("lls [ls-options [path]] Display local directory listing\n");
221 printf("ln oldpath newpath Symlink remote file\n");
222 printf("lmkdir path Create local directory\n");
223 printf("lpwd Print local working directory\n");
224 printf("ls [path] Display remote directory listing\n");
225 printf("lumask umask Set local umask to 'umask'\n");
226 printf("mkdir path Create remote directory\n");
227 printf("progress Toggle display of progress meter\n");
228 printf("put local-path [remote-path] Upload file\n");
229 printf("pwd Display remote working directory\n");
230 printf("exit Quit sftp\n");
231 printf("quit Quit sftp\n");
232 printf("rename oldpath newpath Rename remote file\n");
233 printf("rmdir path Remove remote directory\n");
234 printf("rm path Delete remote file\n");
235 printf("symlink oldpath newpath Symlink remote file\n");
236 printf("version Show SFTP version\n");
237 printf("!command Execute 'command' in local shell\n");
238 printf("! Escape to local shell\n");
239 printf("? Synonym for help\n");
243 local_do_shell(const char *args
)
252 if ((shell
= getenv("SHELL")) == NULL
)
253 shell
= _PATH_BSHELL
;
255 if ((pid
= fork()) == -1)
256 fatal("Couldn't fork: %s", strerror(errno
));
259 /* XXX: child has pipe fds to ssh subproc open - issue? */
261 debug3("Executing %s -c \"%s\"", shell
, args
);
262 execl(shell
, shell
, "-c", args
, (char *)NULL
);
264 debug3("Executing %s", shell
);
265 execl(shell
, shell
, (char *)NULL
);
267 fprintf(stderr
, "Couldn't execute \"%s\": %s\n", shell
,
271 while (waitpid(pid
, &status
, 0) == -1)
273 fatal("Couldn't wait for child: %s", strerror(errno
));
274 if (!WIFEXITED(status
))
275 error("Shell exited abnormally");
276 else if (WEXITSTATUS(status
))
277 error("Shell exited with status %d", WEXITSTATUS(status
));
281 local_do_ls(const char *args
)
284 local_do_shell(_PATH_LS
);
286 int len
= strlen(_PATH_LS
" ") + strlen(args
) + 1;
287 char *buf
= xmalloc(len
);
289 /* XXX: quoting - rip quoting code from ftp? */
290 snprintf(buf
, len
, _PATH_LS
" %s", args
);
296 /* Strip one path (usually the pwd) from the start of another */
298 path_strip(char *path
, char *strip
)
303 return (xstrdup(path
));
306 if (strncmp(path
, strip
, len
) == 0) {
307 if (strip
[len
- 1] != '/' && path
[len
] == '/')
309 return (xstrdup(path
+ len
));
312 return (xstrdup(path
));
316 path_append(char *p1
, char *p2
)
319 size_t len
= strlen(p1
) + strlen(p2
) + 2;
322 strlcpy(ret
, p1
, len
);
323 if (p1
[0] != '\0' && p1
[strlen(p1
) - 1] != '/')
324 strlcat(ret
, "/", len
);
325 strlcat(ret
, p2
, len
);
331 make_absolute(char *p
, char *pwd
)
336 if (p
&& p
[0] != '/') {
337 abs_str
= path_append(pwd
, p
);
345 infer_path(const char *p
, char **ifp
)
349 cp
= strrchr(p
, '/');
356 error("Invalid path");
360 *ifp
= xstrdup(cp
+ 1);
365 parse_getput_flags(const char *cmd
, char **argv
, int argc
, int *pflag
)
367 extern int optind
, optreset
, opterr
;
370 optind
= optreset
= 1;
374 while ((ch
= getopt(argc
, argv
, "Pp")) != -1) {
381 error("%s: Invalid flag -%c", cmd
, ch
);
390 parse_ls_flags(char **argv
, int argc
, int *lflag
)
392 extern int optind
, optreset
, opterr
;
395 optind
= optreset
= 1;
398 *lflag
= LS_NAME_SORT
;
399 while ((ch
= getopt(argc
, argv
, "1Saflnrt")) != -1) {
402 *lflag
&= ~VIEW_FLAGS
;
403 *lflag
|= LS_SHORT_VIEW
;
406 *lflag
&= ~SORT_FLAGS
;
407 *lflag
|= LS_SIZE_SORT
;
410 *lflag
|= LS_SHOW_ALL
;
413 *lflag
&= ~SORT_FLAGS
;
416 *lflag
&= ~VIEW_FLAGS
;
417 *lflag
|= LS_LONG_VIEW
;
420 *lflag
&= ~VIEW_FLAGS
;
421 *lflag
|= LS_NUMERIC_VIEW
|LS_LONG_VIEW
;
424 *lflag
|= LS_REVERSE_SORT
;
427 *lflag
&= ~SORT_FLAGS
;
428 *lflag
|= LS_TIME_SORT
;
431 error("ls: Invalid flag -%c", ch
);
440 parse_df_flags(const char *cmd
, char **argv
, int argc
, int *hflag
, int *iflag
)
442 extern int optind
, optreset
, opterr
;
445 optind
= optreset
= 1;
449 while ((ch
= getopt(argc
, argv
, "hi")) != -1) {
458 error("%s: Invalid flag -%c", cmd
, ch
);
471 /* XXX: report errors? */
472 if (stat(path
, &sb
) == -1)
475 return(S_ISDIR(sb
.st_mode
));
479 remote_is_dir(struct sftp_conn
*conn
, char *path
)
483 /* XXX: report errors? */
484 if ((a
= do_stat(conn
, path
, 1)) == NULL
)
486 if (!(a
->flags
& SSH2_FILEXFER_ATTR_PERMISSIONS
))
488 return(S_ISDIR(a
->perm
));
492 process_get(struct sftp_conn
*conn
, char *src
, char *dst
, char *pwd
, int pflag
)
494 char *abs_src
= NULL
;
495 char *abs_dst
= NULL
;
501 abs_src
= xstrdup(src
);
502 abs_src
= make_absolute(abs_src
, pwd
);
504 memset(&g
, 0, sizeof(g
));
505 debug3("Looking up %s", abs_src
);
506 if (remote_glob(conn
, abs_src
, 0, NULL
, &g
)) {
507 error("File \"%s\" not found.", abs_src
);
512 /* If multiple matches, dst must be a directory or unspecified */
513 if (g
.gl_matchc
> 1 && dst
&& !is_dir(dst
)) {
514 error("Multiple files match, but \"%s\" is not a directory",
520 for (i
= 0; g
.gl_pathv
[i
] && !interrupted
; i
++) {
521 if (infer_path(g
.gl_pathv
[i
], &tmp
)) {
526 if (g
.gl_matchc
== 1 && dst
) {
527 /* If directory specified, append filename */
530 if (infer_path(g
.gl_pathv
[0], &tmp
)) {
534 abs_dst
= path_append(dst
, tmp
);
537 abs_dst
= xstrdup(dst
);
539 abs_dst
= path_append(dst
, tmp
);
544 printf("Fetching %s to %s\n", g
.gl_pathv
[i
], abs_dst
);
545 if (do_download(conn
, g
.gl_pathv
[i
], abs_dst
, pflag
) == -1)
558 process_put(struct sftp_conn
*conn
, char *src
, char *dst
, char *pwd
, int pflag
)
560 char *tmp_dst
= NULL
;
561 char *abs_dst
= NULL
;
569 tmp_dst
= xstrdup(dst
);
570 tmp_dst
= make_absolute(tmp_dst
, pwd
);
573 memset(&g
, 0, sizeof(g
));
574 debug3("Looking up %s", src
);
575 if (glob(src
, GLOB_NOCHECK
, NULL
, &g
)) {
576 error("File \"%s\" not found.", src
);
581 /* If multiple matches, dst may be directory or unspecified */
582 if (g
.gl_matchc
> 1 && tmp_dst
&& !remote_is_dir(conn
, tmp_dst
)) {
583 error("Multiple files match, but \"%s\" is not a directory",
589 for (i
= 0; g
.gl_pathv
[i
] && !interrupted
; i
++) {
590 if (stat(g
.gl_pathv
[i
], &sb
) == -1) {
592 error("stat %s: %s", g
.gl_pathv
[i
], strerror(errno
));
596 if (!S_ISREG(sb
.st_mode
)) {
597 error("skipping non-regular file %s",
601 if (infer_path(g
.gl_pathv
[i
], &tmp
)) {
606 if (g
.gl_matchc
== 1 && tmp_dst
) {
607 /* If directory specified, append filename */
608 if (remote_is_dir(conn
, tmp_dst
)) {
609 if (infer_path(g
.gl_pathv
[0], &tmp
)) {
613 abs_dst
= path_append(tmp_dst
, tmp
);
616 abs_dst
= xstrdup(tmp_dst
);
618 } else if (tmp_dst
) {
619 abs_dst
= path_append(tmp_dst
, tmp
);
622 abs_dst
= make_absolute(tmp
, pwd
);
624 printf("Uploading %s to %s\n", g
.gl_pathv
[i
], abs_dst
);
625 if (do_upload(conn
, g
.gl_pathv
[i
], abs_dst
, pflag
) == -1)
639 sdirent_comp(const void *aa
, const void *bb
)
641 SFTP_DIRENT
*a
= *(SFTP_DIRENT
**)aa
;
642 SFTP_DIRENT
*b
= *(SFTP_DIRENT
**)bb
;
643 int rmul
= sort_flag
& LS_REVERSE_SORT
? -1 : 1;
645 #define NCMP(a,b) (a == b ? 0 : (a < b ? 1 : -1))
646 if (sort_flag
& LS_NAME_SORT
)
647 return (rmul
* strcmp(a
->filename
, b
->filename
));
648 else if (sort_flag
& LS_TIME_SORT
)
649 return (rmul
* NCMP(a
->a
.mtime
, b
->a
.mtime
));
650 else if (sort_flag
& LS_SIZE_SORT
)
651 return (rmul
* NCMP(a
->a
.size
, b
->a
.size
));
653 fatal("Unknown ls sort type");
656 /* sftp ls.1 replacement for directories */
658 do_ls_dir(struct sftp_conn
*conn
, char *path
, char *strip_path
, int lflag
)
661 u_int c
= 1, colspace
= 0, columns
= 1;
664 if ((n
= do_readdir(conn
, path
, &d
)) != 0)
667 if (!(lflag
& LS_SHORT_VIEW
)) {
668 u_int m
= 0, width
= 80;
672 /* Count entries for sort and find longest filename */
673 for (n
= 0; d
[n
] != NULL
; n
++) {
674 if (d
[n
]->filename
[0] != '.' || (lflag
& LS_SHOW_ALL
))
675 m
= MAX(m
, strlen(d
[n
]->filename
));
678 /* Add any subpath that also needs to be counted */
679 tmp
= path_strip(path
, strip_path
);
683 if (ioctl(fileno(stdin
), TIOCGWINSZ
, &ws
) != -1)
686 columns
= width
/ (m
+ 2);
687 columns
= MAX(columns
, 1);
688 colspace
= width
/ columns
;
689 colspace
= MIN(colspace
, width
);
692 if (lflag
& SORT_FLAGS
) {
693 for (n
= 0; d
[n
] != NULL
; n
++)
694 ; /* count entries */
695 sort_flag
= lflag
& (SORT_FLAGS
|LS_REVERSE_SORT
);
696 qsort(d
, n
, sizeof(*d
), sdirent_comp
);
699 for (n
= 0; d
[n
] != NULL
&& !interrupted
; n
++) {
702 if (d
[n
]->filename
[0] == '.' && !(lflag
& LS_SHOW_ALL
))
705 tmp
= path_append(path
, d
[n
]->filename
);
706 fname
= path_strip(tmp
, strip_path
);
709 if (lflag
& LS_LONG_VIEW
) {
710 if (lflag
& LS_NUMERIC_VIEW
) {
714 memset(&sb
, 0, sizeof(sb
));
715 attrib_to_stat(&d
[n
]->a
, &sb
);
716 lname
= ls_file(fname
, &sb
, 1);
717 printf("%s\n", lname
);
720 printf("%s\n", d
[n
]->longname
);
722 printf("%-*s", colspace
, fname
);
733 if (!(lflag
& LS_LONG_VIEW
) && (c
!= 1))
736 free_sftp_dirents(d
);
740 /* sftp ls.1 replacement which handles path globs */
742 do_globbed_ls(struct sftp_conn
*conn
, char *path
, char *strip_path
,
746 u_int i
, c
= 1, colspace
= 0, columns
= 1;
749 memset(&g
, 0, sizeof(g
));
751 if (remote_glob(conn
, path
, GLOB_MARK
|GLOB_NOCHECK
|GLOB_BRACE
,
752 NULL
, &g
) || (g
.gl_pathc
&& !g
.gl_matchc
)) {
755 error("Can't ls: \"%s\" not found", path
);
763 * If the glob returns a single match and it is a directory,
764 * then just list its contents.
766 if (g
.gl_matchc
== 1) {
767 if ((a
= do_lstat(conn
, g
.gl_pathv
[0], 1)) == NULL
) {
771 if ((a
->flags
& SSH2_FILEXFER_ATTR_PERMISSIONS
) &&
775 err
= do_ls_dir(conn
, g
.gl_pathv
[0], strip_path
, lflag
);
781 if (!(lflag
& LS_SHORT_VIEW
)) {
782 u_int m
= 0, width
= 80;
785 /* Count entries for sort and find longest filename */
786 for (i
= 0; g
.gl_pathv
[i
]; i
++)
787 m
= MAX(m
, strlen(g
.gl_pathv
[i
]));
789 if (ioctl(fileno(stdin
), TIOCGWINSZ
, &ws
) != -1)
792 columns
= width
/ (m
+ 2);
793 columns
= MAX(columns
, 1);
794 colspace
= width
/ columns
;
797 for (i
= 0; g
.gl_pathv
[i
] && !interrupted
; i
++, a
= NULL
) {
800 fname
= path_strip(g
.gl_pathv
[i
], strip_path
);
802 if (lflag
& LS_LONG_VIEW
) {
807 * XXX: this is slow - 1 roundtrip per path
808 * A solution to this is to fork glob() and
809 * build a sftp specific version which keeps the
810 * attribs (which currently get thrown away)
811 * that the server returns as well as the filenames.
813 memset(&sb
, 0, sizeof(sb
));
815 a
= do_lstat(conn
, g
.gl_pathv
[i
], 1);
817 attrib_to_stat(a
, &sb
);
818 lname
= ls_file(fname
, &sb
, 1);
819 printf("%s\n", lname
);
822 printf("%-*s", colspace
, fname
);
832 if (!(lflag
& LS_LONG_VIEW
) && (c
!= 1))
843 do_df(struct sftp_conn
*conn
, char *path
, int hflag
, int iflag
)
845 struct sftp_statvfs st
;
846 char s_used
[FMT_SCALED_STRSIZE
];
847 char s_avail
[FMT_SCALED_STRSIZE
];
848 char s_root
[FMT_SCALED_STRSIZE
];
849 char s_total
[FMT_SCALED_STRSIZE
];
851 if (do_statvfs(conn
, path
, &st
, 1) == -1)
854 printf(" Inodes Used Avail "
855 "(root) %%Capacity\n");
856 printf("%11llu %11llu %11llu %11llu %3llu%%\n",
857 (unsigned long long)st
.f_files
,
858 (unsigned long long)(st
.f_files
- st
.f_ffree
),
859 (unsigned long long)st
.f_favail
,
860 (unsigned long long)st
.f_ffree
,
861 (unsigned long long)(100 * (st
.f_files
- st
.f_ffree
) /
864 strlcpy(s_used
, "error", sizeof(s_used
));
865 strlcpy(s_avail
, "error", sizeof(s_avail
));
866 strlcpy(s_root
, "error", sizeof(s_root
));
867 strlcpy(s_total
, "error", sizeof(s_total
));
868 fmt_scaled((st
.f_blocks
- st
.f_bfree
) * st
.f_frsize
, s_used
);
869 fmt_scaled(st
.f_bavail
* st
.f_frsize
, s_avail
);
870 fmt_scaled(st
.f_bfree
* st
.f_frsize
, s_root
);
871 fmt_scaled(st
.f_blocks
* st
.f_frsize
, s_total
);
872 printf(" Size Used Avail (root) %%Capacity\n");
873 printf("%7sB %7sB %7sB %7sB %3llu%%\n",
874 s_total
, s_used
, s_avail
, s_root
,
875 (unsigned long long)(100 * (st
.f_blocks
- st
.f_bfree
) /
878 printf(" Size Used Avail "
879 "(root) %%Capacity\n");
880 printf("%12llu %12llu %12llu %12llu %3llu%%\n",
881 (unsigned long long)(st
.f_frsize
* st
.f_blocks
/ 1024),
882 (unsigned long long)(st
.f_frsize
*
883 (st
.f_blocks
- st
.f_bfree
) / 1024),
884 (unsigned long long)(st
.f_frsize
* st
.f_bavail
/ 1024),
885 (unsigned long long)(st
.f_frsize
* st
.f_bfree
/ 1024),
886 (unsigned long long)(100 * (st
.f_blocks
- st
.f_bfree
) /
893 * Undo escaping of glob sequences in place. Used to undo extra escaping
894 * applied in makeargv() when the string is destined for a function that
898 undo_glob_escape(char *s
)
933 * Split a string into an argument vector using sh(1)-style quoting,
934 * comment and escaping rules, but with some tweaks to handle glob(3)
936 * Returns NULL on error or a NULL-terminated array of arguments.
939 #define MAXARGLEN 8192
941 makeargv(const char *arg
, int *argcp
)
945 static char argvs
[MAXARGLEN
];
946 static char *argv
[MAXARGS
+ 1];
947 enum { MA_START
, MA_SQUOTE
, MA_DQUOTE
, MA_UNQUOTED
} state
, q
;
950 if (strlen(arg
) > sizeof(argvs
) - 1) {
952 error("string too long");
958 if (isspace(arg
[i
])) {
959 if (state
== MA_UNQUOTED
) {
960 /* Terminate current argument */
964 } else if (state
!= MA_START
)
966 } else if (arg
[i
] == '"' || arg
[i
] == '\'') {
967 q
= arg
[i
] == '"' ? MA_DQUOTE
: MA_SQUOTE
;
968 if (state
== MA_START
) {
969 argv
[argc
] = argvs
+ j
;
971 } else if (state
== MA_UNQUOTED
)
977 } else if (arg
[i
] == '\\') {
978 if (state
== MA_SQUOTE
|| state
== MA_DQUOTE
) {
979 quot
= state
== MA_SQUOTE
? '\'' : '"';
980 /* Unescape quote we are in */
981 /* XXX support \n and friends? */
982 if (arg
[i
+ 1] == quot
) {
985 } else if (arg
[i
+ 1] == '?' ||
986 arg
[i
+ 1] == '[' || arg
[i
+ 1] == '*') {
988 * Special case for sftp: append
989 * double-escaped glob sequence -
990 * glob will undo one level of
991 * escaping. NB. string can grow here.
993 if (j
>= sizeof(argvs
) - 5)
996 argvs
[j
++] = arg
[i
++];
1000 argvs
[j
++] = arg
[i
++];
1001 argvs
[j
++] = arg
[i
];
1004 if (state
== MA_START
) {
1005 argv
[argc
] = argvs
+ j
;
1006 state
= MA_UNQUOTED
;
1008 if (arg
[i
+ 1] == '?' || arg
[i
+ 1] == '[' ||
1009 arg
[i
+ 1] == '*' || arg
[i
+ 1] == '\\') {
1011 * Special case for sftp: append
1012 * escaped glob sequence -
1013 * glob will undo one level of
1016 argvs
[j
++] = arg
[i
++];
1017 argvs
[j
++] = arg
[i
];
1019 /* Unescape everything */
1020 /* XXX support \n and friends? */
1022 argvs
[j
++] = arg
[i
];
1025 } else if (arg
[i
] == '#') {
1026 if (state
== MA_SQUOTE
|| state
== MA_DQUOTE
)
1027 argvs
[j
++] = arg
[i
];
1030 } else if (arg
[i
] == '\0') {
1031 if (state
== MA_SQUOTE
|| state
== MA_DQUOTE
) {
1032 error("Unterminated quoted argument");
1036 if (state
== MA_UNQUOTED
) {
1042 if (state
== MA_START
) {
1043 argv
[argc
] = argvs
+ j
;
1044 state
= MA_UNQUOTED
;
1046 if ((state
== MA_SQUOTE
|| state
== MA_DQUOTE
) &&
1047 (arg
[i
] == '?' || arg
[i
] == '[' || arg
[i
] == '*')) {
1049 * Special case for sftp: escape quoted
1050 * glob(3) wildcards. NB. string can grow
1053 if (j
>= sizeof(argvs
) - 3)
1054 goto args_too_longs
;
1056 argvs
[j
++] = arg
[i
];
1058 argvs
[j
++] = arg
[i
];
1067 parse_args(const char **cpp
, int *pflag
, int *lflag
, int *iflag
, int *hflag
,
1068 unsigned long *n_arg
, char **path1
, char **path2
)
1070 const char *cmd
, *cp
= *cpp
;
1074 int i
, cmdnum
, optidx
, argc
;
1076 /* Skip leading whitespace */
1077 cp
= cp
+ strspn(cp
, WHITESPACE
);
1079 /* Ignore blank lines and lines which begin with comment '#' char */
1080 if (*cp
== '\0' || *cp
== '#')
1083 /* Check for leading '-' (disable error processing) */
1090 if ((argv
= makeargv(cp
, &argc
)) == NULL
)
1093 /* Figure out which command we have */
1094 for (i
= 0; cmds
[i
].c
!= NULL
; i
++) {
1095 if (strcasecmp(cmds
[i
].c
, argv
[0]) == 0)
1105 } else if (cmdnum
== -1) {
1106 error("Invalid command.");
1110 /* Get arguments and parse flags */
1111 *lflag
= *pflag
= *hflag
= *n_arg
= 0;
1112 *path1
= *path2
= NULL
;
1117 if ((optidx
= parse_getput_flags(cmd
, argv
, argc
, pflag
)) == -1)
1119 /* Get first pathname (mandatory) */
1120 if (argc
- optidx
< 1) {
1121 error("You must specify at least one path after a "
1122 "%s command.", cmd
);
1125 *path1
= xstrdup(argv
[optidx
]);
1126 /* Get second pathname (optional) */
1127 if (argc
- optidx
> 1) {
1128 *path2
= xstrdup(argv
[optidx
+ 1]);
1129 /* Destination is not globbed */
1130 undo_glob_escape(*path2
);
1135 if (argc
- optidx
< 2) {
1136 error("You must specify two paths after a %s "
1140 *path1
= xstrdup(argv
[optidx
]);
1141 *path2
= xstrdup(argv
[optidx
+ 1]);
1142 /* Paths are not globbed */
1143 undo_glob_escape(*path1
);
1144 undo_glob_escape(*path2
);
1152 /* Get pathname (mandatory) */
1153 if (argc
- optidx
< 1) {
1154 error("You must specify a path after a %s command.",
1158 *path1
= xstrdup(argv
[optidx
]);
1159 /* Only "rm" globs */
1161 undo_glob_escape(*path1
);
1164 if ((optidx
= parse_df_flags(cmd
, argv
, argc
, hflag
,
1167 /* Default to current directory if no path specified */
1168 if (argc
- optidx
< 1)
1171 *path1
= xstrdup(argv
[optidx
]);
1172 undo_glob_escape(*path1
);
1176 if ((optidx
= parse_ls_flags(argv
, argc
, lflag
)) == -1)
1178 /* Path is optional */
1179 if (argc
- optidx
> 0)
1180 *path1
= xstrdup(argv
[optidx
]);
1183 /* Skip ls command and following whitespace */
1184 cp
= cp
+ strlen(cmd
) + strspn(cp
, WHITESPACE
);
1186 /* Uses the rest of the line */
1193 /* Get numeric arg (mandatory) */
1194 if (argc
- optidx
< 1)
1197 l
= strtol(argv
[optidx
], &cp2
, base
);
1198 if (cp2
== argv
[optidx
] || *cp2
!= '\0' ||
1199 ((l
== LONG_MIN
|| l
== LONG_MAX
) && errno
== ERANGE
) ||
1202 error("You must supply a numeric argument "
1203 "to the %s command.", cmd
);
1207 if (cmdnum
== I_LUMASK
)
1209 /* Get pathname (mandatory) */
1210 if (argc
- optidx
< 2) {
1211 error("You must specify a path after a %s command.",
1215 *path1
= xstrdup(argv
[optidx
+ 1]);
1225 fatal("Command not implemented");
1233 parse_dispatch_command(struct sftp_conn
*conn
, const char *cmd
, char **pwd
,
1236 char *path1
, *path2
, *tmp
;
1237 int pflag
, lflag
, iflag
, hflag
, cmdnum
, i
;
1238 unsigned long n_arg
;
1240 char path_buf
[MAXPATHLEN
];
1244 path1
= path2
= NULL
;
1245 cmdnum
= parse_args(&cmd
, &pflag
, &lflag
, &iflag
, &hflag
, &n_arg
,
1251 memset(&g
, 0, sizeof(g
));
1253 /* Perform command */
1259 /* Unrecognized command */
1263 err
= process_get(conn
, path1
, path2
, *pwd
, pflag
);
1266 err
= process_put(conn
, path1
, path2
, *pwd
, pflag
);
1269 path1
= make_absolute(path1
, *pwd
);
1270 path2
= make_absolute(path2
, *pwd
);
1271 err
= do_rename(conn
, path1
, path2
);
1274 path2
= make_absolute(path2
, *pwd
);
1275 err
= do_symlink(conn
, path1
, path2
);
1278 path1
= make_absolute(path1
, *pwd
);
1279 remote_glob(conn
, path1
, GLOB_NOCHECK
, NULL
, &g
);
1280 for (i
= 0; g
.gl_pathv
[i
] && !interrupted
; i
++) {
1281 printf("Removing %s\n", g
.gl_pathv
[i
]);
1282 err
= do_rm(conn
, g
.gl_pathv
[i
]);
1283 if (err
!= 0 && err_abort
)
1288 path1
= make_absolute(path1
, *pwd
);
1290 a
.flags
|= SSH2_FILEXFER_ATTR_PERMISSIONS
;
1292 err
= do_mkdir(conn
, path1
, &a
);
1295 path1
= make_absolute(path1
, *pwd
);
1296 err
= do_rmdir(conn
, path1
);
1299 path1
= make_absolute(path1
, *pwd
);
1300 if ((tmp
= do_realpath(conn
, path1
)) == NULL
) {
1304 if ((aa
= do_stat(conn
, tmp
, 0)) == NULL
) {
1309 if (!(aa
->flags
& SSH2_FILEXFER_ATTR_PERMISSIONS
)) {
1310 error("Can't change directory: Can't check target");
1315 if (!S_ISDIR(aa
->perm
)) {
1316 error("Can't change directory: \"%s\" is not "
1317 "a directory", tmp
);
1327 do_globbed_ls(conn
, *pwd
, *pwd
, lflag
);
1331 /* Strip pwd off beginning of non-absolute paths */
1336 path1
= make_absolute(path1
, *pwd
);
1337 err
= do_globbed_ls(conn
, path1
, tmp
, lflag
);
1340 /* Default to current directory if no path specified */
1342 path1
= xstrdup(*pwd
);
1343 path1
= make_absolute(path1
, *pwd
);
1344 err
= do_df(conn
, path1
, hflag
, iflag
);
1347 if (chdir(path1
) == -1) {
1348 error("Couldn't change local directory to "
1349 "\"%s\": %s", path1
, strerror(errno
));
1354 if (mkdir(path1
, 0777) == -1) {
1355 error("Couldn't create local directory "
1356 "\"%s\": %s", path1
, strerror(errno
));
1364 local_do_shell(cmd
);
1368 printf("Local umask: %03lo\n", n_arg
);
1371 path1
= make_absolute(path1
, *pwd
);
1373 a
.flags
|= SSH2_FILEXFER_ATTR_PERMISSIONS
;
1375 remote_glob(conn
, path1
, GLOB_NOCHECK
, NULL
, &g
);
1376 for (i
= 0; g
.gl_pathv
[i
] && !interrupted
; i
++) {
1377 printf("Changing mode on %s\n", g
.gl_pathv
[i
]);
1378 err
= do_setstat(conn
, g
.gl_pathv
[i
], &a
);
1379 if (err
!= 0 && err_abort
)
1385 path1
= make_absolute(path1
, *pwd
);
1386 remote_glob(conn
, path1
, GLOB_NOCHECK
, NULL
, &g
);
1387 for (i
= 0; g
.gl_pathv
[i
] && !interrupted
; i
++) {
1388 if (!(aa
= do_stat(conn
, g
.gl_pathv
[i
], 0))) {
1389 if (err
!= 0 && err_abort
)
1394 if (!(aa
->flags
& SSH2_FILEXFER_ATTR_UIDGID
)) {
1395 error("Can't get current ownership of "
1396 "remote file \"%s\"", g
.gl_pathv
[i
]);
1397 if (err
!= 0 && err_abort
)
1402 aa
->flags
&= SSH2_FILEXFER_ATTR_UIDGID
;
1403 if (cmdnum
== I_CHOWN
) {
1404 printf("Changing owner on %s\n", g
.gl_pathv
[i
]);
1407 printf("Changing group on %s\n", g
.gl_pathv
[i
]);
1410 err
= do_setstat(conn
, g
.gl_pathv
[i
], aa
);
1411 if (err
!= 0 && err_abort
)
1416 printf("Remote working directory: %s\n", *pwd
);
1419 if (!getcwd(path_buf
, sizeof(path_buf
))) {
1420 error("Couldn't get local cwd: %s", strerror(errno
));
1424 printf("Local working directory: %s\n", path_buf
);
1427 /* Processed below */
1433 printf("SFTP protocol version %u\n", sftp_proto_version(conn
));
1436 showprogress
= !showprogress
;
1438 printf("Progress meter enabled\n");
1440 printf("Progress meter disabled\n");
1443 fatal("%d is not implemented", cmdnum
);
1453 /* If an unignored error occurs in batch mode we should abort. */
1454 if (err_abort
&& err
!= 0)
1456 else if (cmdnum
== I_QUIT
)
1464 prompt(EditLine
*el
)
1471 interactive_loop(int fd_in
, int fd_out
, char *file1
, char *file2
)
1476 struct sftp_conn
*conn
;
1477 int err
, interactive
;
1478 EditLine
*el
= NULL
;
1482 extern char *__progname
;
1484 if (!batchmode
&& isatty(STDIN_FILENO
)) {
1485 if ((el
= el_init(__progname
, stdin
, stdout
, stderr
)) == NULL
)
1486 fatal("Couldn't initialise editline");
1487 if ((hl
= history_init()) == NULL
)
1488 fatal("Couldn't initialise editline history");
1489 history(hl
, &hev
, H_SETSIZE
, 100);
1490 el_set(el
, EL_HIST
, history
, hl
);
1492 el_set(el
, EL_PROMPT
, prompt
);
1493 el_set(el
, EL_EDITOR
, "emacs");
1494 el_set(el
, EL_TERMINAL
, NULL
);
1495 el_set(el
, EL_SIGNAL
, 1);
1496 el_source(el
, NULL
);
1498 #endif /* USE_LIBEDIT */
1500 conn
= do_init(fd_in
, fd_out
, copy_buffer_len
, num_requests
);
1502 fatal("Couldn't initialise connection to server");
1504 pwd
= do_realpath(conn
, ".");
1508 if (file1
!= NULL
) {
1509 dir
= xstrdup(file1
);
1510 dir
= make_absolute(dir
, pwd
);
1512 if (remote_is_dir(conn
, dir
) && file2
== NULL
) {
1513 printf("Changing to: %s\n", dir
);
1514 snprintf(cmd
, sizeof cmd
, "cd \"%s\"", dir
);
1515 if (parse_dispatch_command(conn
, cmd
, &pwd
, 1) != 0) {
1523 snprintf(cmd
, sizeof cmd
, "get %s", dir
);
1525 snprintf(cmd
, sizeof cmd
, "get %s %s", dir
,
1528 err
= parse_dispatch_command(conn
, cmd
, &pwd
, 1);
1537 #if defined(HAVE_SETVBUF) && !defined(BROKEN_SETVBUF)
1538 setvbuf(stdout
, NULL
, _IOLBF
, 0);
1539 setvbuf(infile
, NULL
, _IOLBF
, 0);
1545 interactive
= !batchmode
&& isatty(STDIN_FILENO
);
1550 signal(SIGINT
, SIG_IGN
);
1555 if (fgets(cmd
, sizeof(cmd
), infile
) == NULL
) {
1560 if (!interactive
) { /* Echo command */
1561 printf("sftp> %s", cmd
);
1562 if (strlen(cmd
) > 0 &&
1563 cmd
[strlen(cmd
) - 1] != '\n')
1571 if ((line
= el_gets(el
, &count
)) == NULL
|| count
<= 0) {
1575 history(hl
, &hev
, H_ENTER
, line
);
1576 if (strlcpy(cmd
, line
, sizeof(cmd
)) >= sizeof(cmd
)) {
1577 fprintf(stderr
, "Error: input line too long\n");
1580 #endif /* USE_LIBEDIT */
1583 cp
= strrchr(cmd
, '\n');
1587 /* Handle user interrupts gracefully during commands */
1589 signal(SIGINT
, cmd_interrupt
);
1591 err
= parse_dispatch_command(conn
, cmd
, &pwd
, batchmode
);
1601 #endif /* USE_LIBEDIT */
1603 /* err == 1 signifies normal "quit" exit */
1604 return (err
>= 0 ? 0 : -1);
1608 connect_to_server(char *path
, char **args
, int *in
, int *out
)
1613 int pin
[2], pout
[2];
1615 if ((pipe(pin
) == -1) || (pipe(pout
) == -1))
1616 fatal("pipe: %s", strerror(errno
));
1621 #else /* USE_PIPES */
1624 if (socketpair(AF_UNIX
, SOCK_STREAM
, 0, inout
) == -1)
1625 fatal("socketpair: %s", strerror(errno
));
1626 *in
= *out
= inout
[0];
1627 c_in
= c_out
= inout
[1];
1628 #endif /* USE_PIPES */
1630 if ((sshpid
= fork()) == -1)
1631 fatal("fork: %s", strerror(errno
));
1632 else if (sshpid
== 0) {
1633 if ((dup2(c_in
, STDIN_FILENO
) == -1) ||
1634 (dup2(c_out
, STDOUT_FILENO
) == -1)) {
1635 fprintf(stderr
, "dup2: %s\n", strerror(errno
));
1644 * The underlying ssh is in the same process group, so we must
1645 * ignore SIGINT if we want to gracefully abort commands,
1646 * otherwise the signal will make it to the ssh process and
1649 signal(SIGINT
, SIG_IGN
);
1651 fprintf(stderr
, "exec: %s: %s\n", path
, strerror(errno
));
1655 signal(SIGTERM
, killchild
);
1656 signal(SIGINT
, killchild
);
1657 signal(SIGHUP
, killchild
);
1665 extern char *__progname
;
1668 "usage: %s [-1Cv] [-B buffer_size] [-b batchfile] [-F ssh_config]\n"
1669 " [-o ssh_option] [-P sftp_server_path] [-R num_requests]\n"
1670 " [-S program] [-s subsystem | sftp_server] host\n"
1671 " %s [[user@]host[:file [file]]]\n"
1672 " %s [[user@]host[:dir[/]]]\n"
1673 " %s -b batchfile [user@]host\n", __progname
, __progname
, __progname
, __progname
);
1678 main(int argc
, char **argv
)
1680 int in
, out
, ch
, err
;
1681 char *host
, *userhost
, *cp
, *file2
= NULL
;
1682 int debug_level
= 0, sshver
= 2;
1683 char *file1
= NULL
, *sftp_server
= NULL
;
1684 char *ssh_program
= _PATH_SSH_PROGRAM
, *sftp_direct
= NULL
;
1685 LogLevel ll
= SYSLOG_LEVEL_INFO
;
1688 extern char *optarg
;
1690 /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
1693 __progname
= ssh_get_progname(argv
[0]);
1694 memset(&args
, '\0', sizeof(args
));
1696 addargs(&args
, "%s", ssh_program
);
1697 addargs(&args
, "-oForwardX11 no");
1698 addargs(&args
, "-oForwardAgent no");
1699 addargs(&args
, "-oPermitLocalCommand no");
1700 addargs(&args
, "-oClearAllForwardings yes");
1702 ll
= SYSLOG_LEVEL_INFO
;
1705 while ((ch
= getopt(argc
, argv
, "1hvCo:s:S:b:B:F:P:R:")) != -1) {
1708 addargs(&args
, "-C");
1711 if (debug_level
< 3) {
1712 addargs(&args
, "-v");
1713 ll
= SYSLOG_LEVEL_DEBUG1
+ debug_level
;
1719 addargs(&args
, "-%c%s", ch
, optarg
);
1723 if (sftp_server
== NULL
)
1724 sftp_server
= _PATH_SFTP_SERVER
;
1727 sftp_server
= optarg
;
1730 ssh_program
= optarg
;
1731 replacearg(&args
, 0, "%s", ssh_program
);
1735 fatal("Batch file already specified.");
1737 /* Allow "-" as stdin */
1738 if (strcmp(optarg
, "-") != 0 &&
1739 (infile
= fopen(optarg
, "r")) == NULL
)
1740 fatal("%s (%s).", strerror(errno
), optarg
);
1743 addargs(&args
, "-obatchmode yes");
1746 sftp_direct
= optarg
;
1749 copy_buffer_len
= strtol(optarg
, &cp
, 10);
1750 if (copy_buffer_len
== 0 || *cp
!= '\0')
1751 fatal("Invalid buffer size \"%s\"", optarg
);
1754 num_requests
= strtol(optarg
, &cp
, 10);
1755 if (num_requests
== 0 || *cp
!= '\0')
1756 fatal("Invalid number of requests \"%s\"",
1765 if (!isatty(STDERR_FILENO
))
1768 log_init(argv
[0], ll
, SYSLOG_FACILITY_USER
, 1);
1770 if (sftp_direct
== NULL
) {
1771 if (optind
== argc
|| argc
> (optind
+ 2))
1774 userhost
= xstrdup(argv
[optind
]);
1775 file2
= argv
[optind
+1];
1777 if ((host
= strrchr(userhost
, '@')) == NULL
)
1782 fprintf(stderr
, "Missing username\n");
1785 addargs(&args
, "-l%s", userhost
);
1788 if ((cp
= colon(host
)) != NULL
) {
1793 host
= cleanhostname(host
);
1795 fprintf(stderr
, "Missing hostname\n");
1799 addargs(&args
, "-oProtocol %d", sshver
);
1801 /* no subsystem if the server-spec contains a '/' */
1802 if (sftp_server
== NULL
|| strchr(sftp_server
, '/') == NULL
)
1803 addargs(&args
, "-s");
1805 addargs(&args
, "%s", host
);
1806 addargs(&args
, "%s", (sftp_server
!= NULL
?
1807 sftp_server
: "sftp"));
1810 fprintf(stderr
, "Connecting to %s...\n", host
);
1811 connect_to_server(ssh_program
, args
.list
, &in
, &out
);
1814 addargs(&args
, "sftp-server");
1817 fprintf(stderr
, "Attaching to %s...\n", sftp_direct
);
1818 connect_to_server(sftp_direct
, args
.list
, &in
, &out
);
1822 err
= interactive_loop(in
, out
, file1
, file2
);
1824 #if !defined(USE_PIPES)
1825 shutdown(in
, SHUT_RDWR
);
1826 shutdown(out
, SHUT_RDWR
);
1834 while (waitpid(sshpid
, NULL
, 0) == -1)
1836 fatal("Couldn't wait for ssh process: %s",
1839 exit(err
== 0 ? 0 : 1);