2 * Copyright (c) 2001,2002 Damien Miller. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 /* XXX: recursive operations */
28 RCSID("$OpenBSD: sftp-int.c,v 1.65 2003/11/21 11:57:03 djm Exp $");
33 #include "pathnames.h"
36 #include "sftp-common.h"
37 #include "sftp-glob.h"
38 #include "sftp-client.h"
41 /* File to read commands from */
44 /* Size of buffer used when copying files */
45 extern size_t copy_buffer_len;
47 /* Number of concurrent outstanding requests */
48 extern int num_requests;
50 /* This is set to 0 if the progressmeter is not desired. */
53 /* Separators for interactive commands */
54 #define WHITESPACE " \t\r\n"
56 /* Define what type of ls view (0 - multi-column) */
57 #define LONG_VIEW 1 /* Full view ala ls -l */
58 #define SHORT_VIEW 2 /* Single row view ala ls -1 */
60 /* Commands for interactive mode */
90 static const struct CMD cmds[] = {
103 { "lchdir", I_LCHDIR },
105 { "lmkdir", I_LMKDIR },
109 { "lumask", I_LUMASK },
110 { "mkdir", I_MKDIR },
111 { "progress", I_PROGRESS },
116 { "rename", I_RENAME },
118 { "rmdir", I_RMDIR },
119 { "symlink", I_SYMLINK },
120 { "version", I_VERSION },
129 printf("Available commands:\n");
130 printf("cd path Change remote directory to 'path'\n");
131 printf("lcd path Change local directory to 'path'\n");
132 printf("chgrp grp path Change group of file 'path' to 'grp'\n");
133 printf("chmod mode path Change permissions of file 'path' to 'mode'\n");
134 printf("chown own path Change owner of file 'path' to 'own'\n");
135 printf("help Display this help text\n");
136 printf("get remote-path [local-path] Download file\n");
137 printf("lls [ls-options [path]] Display local directory listing\n");
138 printf("ln oldpath newpath Symlink remote file\n");
139 printf("lmkdir path Create local directory\n");
140 printf("lpwd Print local working directory\n");
141 printf("ls [path] Display remote directory listing\n");
142 printf("lumask umask Set local umask to 'umask'\n");
143 printf("mkdir path Create remote directory\n");
144 printf("progress Toggle display of progress meter\n");
145 printf("put local-path [remote-path] Upload file\n");
146 printf("pwd Display remote working directory\n");
147 printf("exit Quit sftp\n");
148 printf("quit Quit sftp\n");
149 printf("rename oldpath newpath Rename remote file\n");
150 printf("rmdir path Remove remote directory\n");
151 printf("rm path Delete remote file\n");
152 printf("symlink oldpath newpath Symlink remote file\n");
153 printf("version Show SFTP version\n");
154 printf("!command Execute 'command' in local shell\n");
155 printf("! Escape to local shell\n");
156 printf("? Synonym for help\n");
160 local_do_shell(const char *args)
169 if ((shell = getenv("SHELL")) == NULL)
170 shell = _PATH_BSHELL;
172 if ((pid = fork()) == -1)
173 fatal("Couldn't fork: %s", strerror(errno));
176 /* XXX: child has pipe fds to ssh subproc open - issue? */
178 debug3("Executing %s -c \"%s\"", shell, args);
179 execl(shell, shell, "-c", args, (char *)NULL);
181 debug3("Executing %s", shell);
182 execl(shell, shell, (char *)NULL);
184 fprintf(stderr, "Couldn't execute \"%s\": %s\n", shell,
188 while (waitpid(pid, &status, 0) == -1)
190 fatal("Couldn't wait for child: %s", strerror(errno));
191 if (!WIFEXITED(status))
192 error("Shell exited abormally");
193 else if (WEXITSTATUS(status))
194 error("Shell exited with status %d", WEXITSTATUS(status));
198 local_do_ls(const char *args)
201 local_do_shell(_PATH_LS);
203 int len = strlen(_PATH_LS " ") + strlen(args) + 1;
204 char *buf = xmalloc(len);
206 /* XXX: quoting - rip quoting code from ftp? */
207 snprintf(buf, len, _PATH_LS " %s", args);
213 /* Strip one path (usually the pwd) from the start of another */
215 path_strip(char *path, char *strip)
220 return (xstrdup(path));
223 if (strip != NULL && strncmp(path, strip, len) == 0) {
224 if (strip[len - 1] != '/' && path[len] == '/')
226 return (xstrdup(path + len));
229 return (xstrdup(path));
233 path_append(char *p1, char *p2)
236 int len = strlen(p1) + strlen(p2) + 2;
239 strlcpy(ret, p1, len);
240 if (p1[strlen(p1) - 1] != '/')
241 strlcat(ret, "/", len);
242 strlcat(ret, p2, len);
248 make_absolute(char *p, char *pwd)
253 if (p && p[0] != '/') {
254 abs = path_append(pwd, p);
262 infer_path(const char *p, char **ifp)
266 cp = strrchr(p, '/');
273 error("Invalid path");
277 *ifp = xstrdup(cp + 1);
282 parse_getput_flags(const char **cpp, int *pflag)
284 const char *cp = *cpp;
286 /* Check for flags */
287 if (cp[0] == '-' && cp[1] && strchr(WHITESPACE, cp[2])) {
294 error("Invalid flag -%c", cp[1]);
298 *cpp = cp + strspn(cp, WHITESPACE);
305 parse_ls_flags(const char **cpp, int *lflag)
307 const char *cp = *cpp;
309 /* Check for flags */
310 if (cp++[0] == '-') {
311 for(; strchr(WHITESPACE, *cp) == NULL; cp++) {
320 error("Invalid flag -%c", *cp);
324 *cpp = cp + strspn(cp, WHITESPACE);
331 get_pathname(const char **cpp, char **path)
333 const char *cp = *cpp, *end;
337 cp += strspn(cp, WHITESPACE);
344 *path = xmalloc(strlen(cp) + 1);
346 /* Check for quoted filenames */
347 if (*cp == '\"' || *cp == '\'') {
350 /* Search for terminating quote, unescape some chars */
351 for (i = j = 0; i <= strlen(cp); i++) {
352 if (cp[i] == quot) { /* Found quote */
358 if (cp[i] == '\0') { /* End of string */
359 error("Unterminated quote");
362 if (cp[i] == '\\') { /* Escaped characters */
364 if (cp[i] != '\'' && cp[i] != '\"' &&
366 error("Bad escaped character '\%c'",
371 (*path)[j++] = cp[i];
375 error("Empty quotes");
378 *cpp = cp + i + strspn(cp + i, WHITESPACE);
380 /* Read to end of filename */
381 end = strpbrk(cp, WHITESPACE);
383 end = strchr(cp, '\0');
384 *cpp = end + strspn(end, WHITESPACE);
386 memcpy(*path, cp, end - cp);
387 (*path)[end - cp] = '\0';
402 /* XXX: report errors? */
403 if (stat(path, &sb) == -1)
406 return(sb.st_mode & S_IFDIR);
414 if (stat(path, &sb) == -1)
415 fatal("stat %s: %s", path, strerror(errno));
417 return(S_ISREG(sb.st_mode));
421 remote_is_dir(struct sftp_conn *conn, char *path)
425 /* XXX: report errors? */
426 if ((a = do_stat(conn, path, 1)) == NULL)
428 if (!(a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS))
430 return(a->perm & S_IFDIR);
434 process_get(struct sftp_conn *conn, char *src, char *dst, char *pwd, int pflag)
436 char *abs_src = NULL;
437 char *abs_dst = NULL;
443 abs_src = xstrdup(src);
444 abs_src = make_absolute(abs_src, pwd);
446 memset(&g, 0, sizeof(g));
447 debug3("Looking up %s", abs_src);
448 if (remote_glob(conn, abs_src, 0, NULL, &g)) {
449 error("File \"%s\" not found.", abs_src);
454 /* If multiple matches, dst must be a directory or unspecified */
455 if (g.gl_matchc > 1 && dst && !is_dir(dst)) {
456 error("Multiple files match, but \"%s\" is not a directory",
462 for (i = 0; g.gl_pathv[i]; i++) {
463 if (infer_path(g.gl_pathv[i], &tmp)) {
468 if (g.gl_matchc == 1 && dst) {
469 /* If directory specified, append filename */
471 if (infer_path(g.gl_pathv[0], &tmp)) {
475 abs_dst = path_append(dst, tmp);
478 abs_dst = xstrdup(dst);
480 abs_dst = path_append(dst, tmp);
485 printf("Fetching %s to %s\n", g.gl_pathv[i], abs_dst);
486 if (do_download(conn, g.gl_pathv[i], abs_dst, pflag) == -1)
501 process_put(struct sftp_conn *conn, char *src, char *dst, char *pwd, int pflag)
503 char *tmp_dst = NULL;
504 char *abs_dst = NULL;
511 tmp_dst = xstrdup(dst);
512 tmp_dst = make_absolute(tmp_dst, pwd);
515 memset(&g, 0, sizeof(g));
516 debug3("Looking up %s", src);
517 if (glob(src, 0, NULL, &g)) {
518 error("File \"%s\" not found.", src);
523 /* If multiple matches, dst may be directory or unspecified */
524 if (g.gl_matchc > 1 && tmp_dst && !remote_is_dir(conn, tmp_dst)) {
525 error("Multiple files match, but \"%s\" is not a directory",
531 for (i = 0; g.gl_pathv[i]; i++) {
532 if (!is_reg(g.gl_pathv[i])) {
533 error("skipping non-regular file %s",
537 if (infer_path(g.gl_pathv[i], &tmp)) {
542 if (g.gl_matchc == 1 && tmp_dst) {
543 /* If directory specified, append filename */
544 if (remote_is_dir(conn, tmp_dst)) {
545 if (infer_path(g.gl_pathv[0], &tmp)) {
549 abs_dst = path_append(tmp_dst, tmp);
552 abs_dst = xstrdup(tmp_dst);
554 } else if (tmp_dst) {
555 abs_dst = path_append(tmp_dst, tmp);
558 abs_dst = make_absolute(tmp, pwd);
560 printf("Uploading %s to %s\n", g.gl_pathv[i], abs_dst);
561 if (do_upload(conn, g.gl_pathv[i], abs_dst, pflag) == -1)
575 sdirent_comp(const void *aa, const void *bb)
577 SFTP_DIRENT *a = *(SFTP_DIRENT **)aa;
578 SFTP_DIRENT *b = *(SFTP_DIRENT **)bb;
580 return (strcmp(a->filename, b->filename));
583 /* sftp ls.1 replacement for directories */
585 do_ls_dir(struct sftp_conn *conn, char *path, char *strip_path, int lflag)
587 int n, c = 1, colspace = 0, columns = 1;
590 if ((n = do_readdir(conn, path, &d)) != 0)
593 if (!(lflag & SHORT_VIEW)) {
594 int m = 0, width = 80;
597 /* Count entries for sort and find longest filename */
598 for (n = 0; d[n] != NULL; n++)
599 m = MAX(m, strlen(d[n]->filename));
601 if (ioctl(fileno(stdin), TIOCGWINSZ, &ws) != -1)
604 columns = width / (m + 2);
605 columns = MAX(columns, 1);
606 colspace = width / columns;
609 qsort(d, n, sizeof(*d), sdirent_comp);
611 for (n = 0; d[n] != NULL; n++) {
614 tmp = path_append(path, d[n]->filename);
615 fname = path_strip(tmp, strip_path);
618 if (lflag & LONG_VIEW) {
622 memset(&sb, 0, sizeof(sb));
623 attrib_to_stat(&d[n]->a, &sb);
624 lname = ls_file(fname, &sb, 1);
625 printf("%s\n", lname);
628 printf("%-*s", colspace, fname);
639 if (!(lflag & LONG_VIEW) && (c != 1))
642 free_sftp_dirents(d);
646 /* sftp ls.1 replacement which handles path globs */
648 do_globbed_ls(struct sftp_conn *conn, char *path, char *strip_path,
652 int i, c = 1, colspace = 0, columns = 1;
655 memset(&g, 0, sizeof(g));
657 if (remote_glob(conn, path, GLOB_MARK|GLOB_NOCHECK|GLOB_BRACE,
659 error("Can't ls: \"%s\" not found", path);
664 * If the glob returns a single match, which is the same as the
665 * input glob, and it is a directory, then just list its contents
667 if (g.gl_pathc == 1 &&
668 strncmp(path, g.gl_pathv[0], strlen(g.gl_pathv[0]) - 1) == 0) {
669 if ((a = do_lstat(conn, path, 1)) == NULL) {
673 if ((a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) &&
676 return (do_ls_dir(conn, path, strip_path, lflag));
680 if (!(lflag & SHORT_VIEW)) {
681 int m = 0, width = 80;
684 /* Count entries for sort and find longest filename */
685 for (i = 0; g.gl_pathv[i]; i++)
686 m = MAX(m, strlen(g.gl_pathv[i]));
688 if (ioctl(fileno(stdin), TIOCGWINSZ, &ws) != -1)
691 columns = width / (m + 2);
692 columns = MAX(columns, 1);
693 colspace = width / columns;
696 for (i = 0; g.gl_pathv[i]; i++) {
699 fname = path_strip(g.gl_pathv[i], strip_path);
701 if (lflag & LONG_VIEW) {
706 * XXX: this is slow - 1 roundtrip per path
707 * A solution to this is to fork glob() and
708 * build a sftp specific version which keeps the
709 * attribs (which currently get thrown away)
710 * that the server returns as well as the filenames.
712 memset(&sb, 0, sizeof(sb));
713 a = do_lstat(conn, g.gl_pathv[i], 1);
715 attrib_to_stat(a, &sb);
716 lname = ls_file(fname, &sb, 1);
717 printf("%s\n", lname);
720 printf("%-*s", colspace, fname);
730 if (!(lflag & LONG_VIEW) && (c != 1))
740 parse_args(const char **cpp, int *pflag, int *lflag, int *iflag,
741 unsigned long *n_arg, char **path1, char **path2)
743 const char *cmd, *cp = *cpp;
749 /* Skip leading whitespace */
750 cp = cp + strspn(cp, WHITESPACE);
752 /* Ignore blank lines and lines which begin with comment '#' char */
753 if (*cp == '\0' || *cp == '#')
756 /* Check for leading '-' (disable error processing) */
763 /* Figure out which command we have */
764 for (i = 0; cmds[i].c; i++) {
765 int cmdlen = strlen(cmds[i].c);
767 /* Check for command followed by whitespace */
768 if (!strncasecmp(cp, cmds[i].c, cmdlen) &&
769 strchr(WHITESPACE, cp[cmdlen])) {
771 cp = cp + strspn(cp, WHITESPACE);
782 } else if (cmdnum == -1) {
783 error("Invalid command.");
787 /* Get arguments and parse flags */
788 *lflag = *pflag = *n_arg = 0;
789 *path1 = *path2 = NULL;
793 if (parse_getput_flags(&cp, pflag))
795 /* Get first pathname (mandatory) */
796 if (get_pathname(&cp, path1))
798 if (*path1 == NULL) {
799 error("You must specify at least one path after a "
803 /* Try to get second pathname (optional) */
804 if (get_pathname(&cp, path2))
809 if (get_pathname(&cp, path1))
811 if (get_pathname(&cp, path2))
813 if (!*path1 || !*path2) {
814 error("You must specify two paths after a %s "
825 /* Get pathname (mandatory) */
826 if (get_pathname(&cp, path1))
828 if (*path1 == NULL) {
829 error("You must specify a path after a %s command.",
835 if (parse_ls_flags(&cp, lflag))
837 /* Path is optional */
838 if (get_pathname(&cp, path1))
843 /* Uses the rest of the line */
851 /* Get numeric arg (mandatory) */
852 l = strtol(cp, &cp2, base);
853 if (cp2 == cp || ((l == LONG_MIN || l == LONG_MAX) &&
854 errno == ERANGE) || l < 0) {
855 error("You must supply a numeric argument "
856 "to the %s command.", cmd);
861 if (cmdnum == I_LUMASK && strchr(WHITESPACE, *cp))
863 if (cmdnum == I_LUMASK || !strchr(WHITESPACE, *cp)) {
864 error("You must supply a numeric argument "
865 "to the %s command.", cmd);
868 cp += strspn(cp, WHITESPACE);
870 /* Get pathname (mandatory) */
871 if (get_pathname(&cp, path1))
873 if (*path1 == NULL) {
874 error("You must specify a path after a %s command.",
887 fatal("Command not implemented");
895 parse_dispatch_command(struct sftp_conn *conn, const char *cmd, char **pwd,
898 char *path1, *path2, *tmp;
899 int pflag, lflag, iflag, cmdnum, i;
902 char path_buf[MAXPATHLEN];
906 path1 = path2 = NULL;
907 cmdnum = parse_args(&cmd, &pflag, &lflag, &iflag, &n_arg,
913 memset(&g, 0, sizeof(g));
915 /* Perform command */
921 /* Unrecognized command */
925 err = process_get(conn, path1, path2, *pwd, pflag);
928 err = process_put(conn, path1, path2, *pwd, pflag);
931 path1 = make_absolute(path1, *pwd);
932 path2 = make_absolute(path2, *pwd);
933 err = do_rename(conn, path1, path2);
936 path2 = make_absolute(path2, *pwd);
937 err = do_symlink(conn, path1, path2);
940 path1 = make_absolute(path1, *pwd);
941 remote_glob(conn, path1, GLOB_NOCHECK, NULL, &g);
942 for (i = 0; g.gl_pathv[i]; i++) {
943 printf("Removing %s\n", g.gl_pathv[i]);
944 err = do_rm(conn, g.gl_pathv[i]);
945 if (err != 0 && err_abort)
950 path1 = make_absolute(path1, *pwd);
952 a.flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
954 err = do_mkdir(conn, path1, &a);
957 path1 = make_absolute(path1, *pwd);
958 err = do_rmdir(conn, path1);
961 path1 = make_absolute(path1, *pwd);
962 if ((tmp = do_realpath(conn, path1)) == NULL) {
966 if ((aa = do_stat(conn, tmp, 0)) == NULL) {
971 if (!(aa->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)) {
972 error("Can't change directory: Can't check target");
977 if (!S_ISDIR(aa->perm)) {
978 error("Can't change directory: \"%s\" is not "
989 do_globbed_ls(conn, *pwd, *pwd, lflag);
993 /* Strip pwd off beginning of non-absolute paths */
998 path1 = make_absolute(path1, *pwd);
999 err = do_globbed_ls(conn, path1, tmp, lflag);
1002 if (chdir(path1) == -1) {
1003 error("Couldn't change local directory to "
1004 "\"%s\": %s", path1, strerror(errno));
1009 if (mkdir(path1, 0777) == -1) {
1010 error("Couldn't create local directory "
1011 "\"%s\": %s", path1, strerror(errno));
1019 local_do_shell(cmd);
1023 printf("Local umask: %03lo\n", n_arg);
1026 path1 = make_absolute(path1, *pwd);
1028 a.flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
1030 remote_glob(conn, path1, GLOB_NOCHECK, NULL, &g);
1031 for (i = 0; g.gl_pathv[i]; i++) {
1032 printf("Changing mode on %s\n", g.gl_pathv[i]);
1033 err = do_setstat(conn, g.gl_pathv[i], &a);
1034 if (err != 0 && err_abort)
1040 path1 = make_absolute(path1, *pwd);
1041 remote_glob(conn, path1, GLOB_NOCHECK, NULL, &g);
1042 for (i = 0; g.gl_pathv[i]; i++) {
1043 if (!(aa = do_stat(conn, g.gl_pathv[i], 0))) {
1044 if (err != 0 && err_abort)
1049 if (!(aa->flags & SSH2_FILEXFER_ATTR_UIDGID)) {
1050 error("Can't get current ownership of "
1051 "remote file \"%s\"", g.gl_pathv[i]);
1052 if (err != 0 && err_abort)
1057 aa->flags &= SSH2_FILEXFER_ATTR_UIDGID;
1058 if (cmdnum == I_CHOWN) {
1059 printf("Changing owner on %s\n", g.gl_pathv[i]);
1062 printf("Changing group on %s\n", g.gl_pathv[i]);
1065 err = do_setstat(conn, g.gl_pathv[i], aa);
1066 if (err != 0 && err_abort)
1071 printf("Remote working directory: %s\n", *pwd);
1074 if (!getcwd(path_buf, sizeof(path_buf))) {
1075 error("Couldn't get local cwd: %s", strerror(errno));
1079 printf("Local working directory: %s\n", path_buf);
1082 /* Processed below */
1088 printf("SFTP protocol version %u\n", sftp_proto_version(conn));
1091 showprogress = !showprogress;
1093 printf("Progress meter enabled\n");
1095 printf("Progress meter disabled\n");
1098 fatal("%d is not implemented", cmdnum);
1108 /* If an unignored error occurs in batch mode we should abort. */
1109 if (err_abort && err != 0)
1111 else if (cmdnum == I_QUIT)
1118 interactive_loop(int fd_in, int fd_out, char *file1, char *file2)
1123 struct sftp_conn *conn;
1126 conn = do_init(fd_in, fd_out, copy_buffer_len, num_requests);
1128 fatal("Couldn't initialise connection to server");
1130 pwd = do_realpath(conn, ".");
1134 if (file1 != NULL) {
1135 dir = xstrdup(file1);
1136 dir = make_absolute(dir, pwd);
1138 if (remote_is_dir(conn, dir) && file2 == NULL) {
1139 printf("Changing to: %s\n", dir);
1140 snprintf(cmd, sizeof cmd, "cd \"%s\"", dir);
1141 if (parse_dispatch_command(conn, cmd, &pwd, 1) != 0)
1145 snprintf(cmd, sizeof cmd, "get %s", dir);
1147 snprintf(cmd, sizeof cmd, "get %s %s", dir,
1150 err = parse_dispatch_command(conn, cmd, &pwd, 1);
1159 setvbuf(stdout, NULL, _IOLBF, 0);
1160 setvbuf(infile, NULL, _IOLBF, 0);
1172 /* XXX: use libedit */
1173 if (fgets(cmd, sizeof(cmd), infile) == NULL) {
1176 } else if (infile != stdin) /* Bluff typing */
1179 cp = strrchr(cmd, '\n');
1183 err = parse_dispatch_command(conn, cmd, &pwd, infile != stdin);
1189 /* err == 1 signifies normal "quit" exit */
1190 return (err >= 0 ? 0 : -1);