2 * Copyright (c) 2001 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.
26 /* XXX: recursive operations */
29 RCSID("$OpenBSD: sftp-int.c,v 1.37 2001/06/23 15:12:20 itojun Exp $");
34 #include "pathnames.h"
37 #include "sftp-common.h"
38 #include "sftp-glob.h"
39 #include "sftp-client.h"
42 /* File to read commands from */
45 /* Version of server we are speaking to */
48 /* Seperators for interactive commands */
49 #define WHITESPACE " \t\r\n"
51 /* Commands for interactive mode */
80 const struct CMD cmds[] = {
92 { "lchdir", I_LCHDIR },
94 { "lmkdir", I_LMKDIR },
98 { "lumask", I_LUMASK },
104 { "rename", I_RENAME },
106 { "rmdir", I_RMDIR },
107 { "symlink", I_SYMLINK },
108 { "version", I_VERSION },
117 printf("Available commands:\n");
118 printf("cd path Change remote directory to 'path'\n");
119 printf("lcd path Change local directory to 'path'\n");
120 printf("chgrp grp path Change group of file 'path' to 'grp'\n");
121 printf("chmod mode path Change permissions of file 'path' to 'mode'\n");
122 printf("chown own path Change owner of file 'path' to 'own'\n");
123 printf("help Display this help text\n");
124 printf("get remote-path [local-path] Download file\n");
125 printf("lls [ls-options [path]] Display local directory listing\n");
126 printf("ln oldpath newpath Symlink remote file\n");
127 printf("lmkdir path Create local directory\n");
128 printf("lpwd Print local working directory\n");
129 printf("ls [path] Display remote directory listing\n");
130 printf("lumask umask Set local umask to 'umask'\n");
131 printf("mkdir path Create remote directory\n");
132 printf("put local-path [remote-path] Upload file\n");
133 printf("pwd Display remote working directory\n");
134 printf("exit Quit sftp\n");
135 printf("quit Quit sftp\n");
136 printf("rename oldpath newpath Rename remote file\n");
137 printf("rmdir path Remove remote directory\n");
138 printf("rm path Delete remote file\n");
139 printf("symlink oldpath newpath Symlink remote file\n");
140 printf("version Show SFTP version\n");
141 printf("!command Execute 'command' in local shell\n");
142 printf("! Escape to local shell\n");
143 printf("? Synonym for help\n");
147 local_do_shell(const char *args)
156 if ((shell = getenv("SHELL")) == NULL)
157 shell = _PATH_BSHELL;
159 if ((pid = fork()) == -1)
160 fatal("Couldn't fork: %s", strerror(errno));
163 /* XXX: child has pipe fds to ssh subproc open - issue? */
165 debug3("Executing %s -c \"%s\"", shell, args);
166 execl(shell, shell, "-c", args, NULL);
168 debug3("Executing %s", shell);
169 execl(shell, shell, NULL);
171 fprintf(stderr, "Couldn't execute \"%s\": %s\n", shell,
175 if (waitpid(pid, &status, 0) == -1)
176 fatal("Couldn't wait for child: %s", strerror(errno));
177 if (!WIFEXITED(status))
178 error("Shell exited abormally");
179 else if (WEXITSTATUS(status))
180 error("Shell exited with status %d", WEXITSTATUS(status));
184 local_do_ls(const char *args)
187 local_do_shell(_PATH_LS);
189 int len = strlen(_PATH_LS " ") + strlen(args) + 1;
190 char *buf = xmalloc(len);
192 /* XXX: quoting - rip quoting code from ftp? */
193 snprintf(buf, len, _PATH_LS " %s", args);
200 path_append(char *p1, char *p2)
203 int len = strlen(p1) + strlen(p2) + 2;
206 strlcpy(ret, p1, len);
207 strlcat(ret, "/", len);
208 strlcat(ret, p2, len);
214 make_absolute(char *p, char *pwd)
219 if (p && p[0] != '/') {
220 abs = path_append(pwd, p);
228 infer_path(const char *p, char **ifp)
232 cp = strrchr(p, '/');
239 error("Invalid path");
243 *ifp = xstrdup(cp + 1);
248 parse_getput_flags(const char **cpp, int *pflag)
250 const char *cp = *cpp;
252 /* Check for flags */
253 if (cp[0] == '-' && cp[1] && strchr(WHITESPACE, cp[2])) {
260 error("Invalid flag -%c", cp[1]);
264 *cpp = cp + strspn(cp, WHITESPACE);
271 get_pathname(const char **cpp, char **path)
273 const char *cp = *cpp, *end;
277 cp += strspn(cp, WHITESPACE);
284 /* Check for quoted filenames */
285 if (*cp == '\"' || *cp == '\'') {
288 end = strchr(cp, quot);
290 error("Unterminated quote");
294 error("Empty quotes");
297 *cpp = end + 1 + strspn(end + 1, WHITESPACE);
299 /* Read to end of filename */
300 end = strpbrk(cp, WHITESPACE);
302 end = strchr(cp, '\0');
303 *cpp = end + strspn(end, WHITESPACE);
308 *path = xmalloc(i + 1);
309 memcpy(*path, cp, i);
323 /* XXX: report errors? */
324 if (stat(path, &sb) == -1)
327 return(sb.st_mode & S_IFDIR);
331 remote_is_dir(int in, int out, char *path)
335 /* XXX: report errors? */
336 if ((a = do_stat(in, out, path, 1)) == NULL)
338 if (!(a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS))
340 return(a->perm & S_IFDIR);
344 process_get(int in, int out, char *src, char *dst, char *pwd, int pflag)
346 char *abs_src = NULL;
347 char *abs_dst = NULL;
353 abs_src = xstrdup(src);
354 abs_src = make_absolute(abs_src, pwd);
356 memset(&g, 0, sizeof(g));
357 debug3("Looking up %s", abs_src);
358 if (remote_glob(in, out, abs_src, 0, NULL, &g)) {
359 error("File \"%s\" not found.", abs_src);
364 /* Only one match, dst may be file, directory or unspecified */
365 if (g.gl_pathv[0] && g.gl_matchc == 1) {
367 /* If directory specified, append filename */
369 if (infer_path(g.gl_pathv[0], &tmp)) {
373 abs_dst = path_append(dst, tmp);
376 abs_dst = xstrdup(dst);
377 } else if (infer_path(g.gl_pathv[0], &abs_dst)) {
381 printf("Fetching %s to %s\n", g.gl_pathv[0], abs_dst);
382 err = do_download(in, out, g.gl_pathv[0], abs_dst, pflag);
386 /* Multiple matches, dst may be directory or unspecified */
387 if (dst && !is_dir(dst)) {
388 error("Multiple files match, but \"%s\" is not a directory",
394 for(i = 0; g.gl_pathv[i]; i++) {
395 if (infer_path(g.gl_pathv[i], &tmp)) {
400 abs_dst = path_append(dst, tmp);
405 printf("Fetching %s to %s\n", g.gl_pathv[i], abs_dst);
406 if (do_download(in, out, g.gl_pathv[i], abs_dst, pflag) == -1)
421 process_put(int in, int out, char *src, char *dst, char *pwd, int pflag)
423 char *tmp_dst = NULL;
424 char *abs_dst = NULL;
431 tmp_dst = xstrdup(dst);
432 tmp_dst = make_absolute(tmp_dst, pwd);
435 memset(&g, 0, sizeof(g));
436 debug3("Looking up %s", src);
437 if (glob(src, 0, NULL, &g)) {
438 error("File \"%s\" not found.", src);
443 /* Only one match, dst may be file, directory or unspecified */
444 if (g.gl_pathv[0] && g.gl_matchc == 1) {
446 /* If directory specified, append filename */
447 if (remote_is_dir(in, out, tmp_dst)) {
448 if (infer_path(g.gl_pathv[0], &tmp)) {
452 abs_dst = path_append(tmp_dst, tmp);
455 abs_dst = xstrdup(tmp_dst);
457 if (infer_path(g.gl_pathv[0], &abs_dst)) {
461 abs_dst = make_absolute(abs_dst, pwd);
463 printf("Uploading %s to %s\n", g.gl_pathv[0], abs_dst);
464 err = do_upload(in, out, g.gl_pathv[0], abs_dst, pflag);
468 /* Multiple matches, dst may be directory or unspecified */
469 if (tmp_dst && !remote_is_dir(in, out, tmp_dst)) {
470 error("Multiple files match, but \"%s\" is not a directory",
476 for(i = 0; g.gl_pathv[i]; i++) {
477 if (infer_path(g.gl_pathv[i], &tmp)) {
482 abs_dst = path_append(tmp_dst, tmp);
485 abs_dst = make_absolute(tmp, pwd);
487 printf("Uploading %s to %s\n", g.gl_pathv[i], abs_dst);
488 if (do_upload(in, out, g.gl_pathv[i], abs_dst, pflag) == -1)
501 parse_args(const char **cpp, int *pflag, unsigned long *n_arg,
502 char **path1, char **path2)
504 const char *cmd, *cp = *cpp;
510 /* Skip leading whitespace */
511 cp = cp + strspn(cp, WHITESPACE);
513 /* Ignore blank lines */
517 /* Figure out which command we have */
518 for(i = 0; cmds[i].c; i++) {
519 int cmdlen = strlen(cmds[i].c);
521 /* Check for command followed by whitespace */
522 if (!strncasecmp(cp, cmds[i].c, cmdlen) &&
523 strchr(WHITESPACE, cp[cmdlen])) {
525 cp = cp + strspn(cp, WHITESPACE);
536 } else if (cmdnum == -1) {
537 error("Invalid command.");
541 /* Get arguments and parse flags */
543 *path1 = *path2 = NULL;
547 if (parse_getput_flags(&cp, pflag))
549 /* Get first pathname (mandatory) */
550 if (get_pathname(&cp, path1))
552 if (*path1 == NULL) {
553 error("You must specify at least one path after a "
557 /* Try to get second pathname (optional) */
558 if (get_pathname(&cp, path2))
563 if (get_pathname(&cp, path1))
565 if (get_pathname(&cp, path2))
567 if (!*path1 || !*path2) {
568 error("You must specify two paths after a %s "
579 /* Get pathname (mandatory) */
580 if (get_pathname(&cp, path1))
582 if (*path1 == NULL) {
583 error("You must specify a path after a %s command.",
589 /* Path is optional */
590 if (get_pathname(&cp, path1))
595 /* Uses the rest of the line */
603 /* Get numeric arg (mandatory) */
604 l = strtol(cp, &cp2, base);
605 if (cp2 == cp || ((l == LONG_MIN || l == LONG_MAX) &&
606 errno == ERANGE) || l < 0) {
607 error("You must supply a numeric argument "
608 "to the %s command.", cmd);
613 if (cmdnum == I_LUMASK && strchr(WHITESPACE, *cp))
615 if (cmdnum == I_LUMASK || !strchr(WHITESPACE, *cp)) {
616 error("You must supply a numeric argument "
617 "to the %s command.", cmd);
620 cp += strspn(cp, WHITESPACE);
622 /* Get pathname (mandatory) */
623 if (get_pathname(&cp, path1))
625 if (*path1 == NULL) {
626 error("You must specify a path after a %s command.",
638 fatal("Command not implemented");
646 parse_dispatch_command(int in, int out, const char *cmd, char **pwd)
648 char *path1, *path2, *tmp;
649 int pflag, cmdnum, i;
652 char path_buf[MAXPATHLEN];
656 path1 = path2 = NULL;
657 cmdnum = parse_args(&cmd, &pflag, &n_arg, &path1, &path2);
659 memset(&g, 0, sizeof(g));
661 /* Perform command */
666 err = process_get(in, out, path1, path2, *pwd, pflag);
669 err = process_put(in, out, path1, path2, *pwd, pflag);
672 path1 = make_absolute(path1, *pwd);
673 path2 = make_absolute(path2, *pwd);
674 err = do_rename(in, out, path1, path2);
678 error("The server (version %d) does not support "
679 "this operation", version);
682 path2 = make_absolute(path2, *pwd);
683 err = do_symlink(in, out, path1, path2);
687 path1 = make_absolute(path1, *pwd);
688 remote_glob(in, out, path1, GLOB_NOCHECK, NULL, &g);
689 for(i = 0; g.gl_pathv[i]; i++) {
690 printf("Removing %s\n", g.gl_pathv[i]);
691 if (do_rm(in, out, g.gl_pathv[i]) == -1)
696 path1 = make_absolute(path1, *pwd);
698 a.flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
700 err = do_mkdir(in, out, path1, &a);
703 path1 = make_absolute(path1, *pwd);
704 err = do_rmdir(in, out, path1);
707 path1 = make_absolute(path1, *pwd);
708 if ((tmp = do_realpath(in, out, path1)) == NULL) {
712 if ((aa = do_stat(in, out, tmp, 0)) == NULL) {
717 if (!(aa->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)) {
718 error("Can't change directory: Can't check target");
723 if (!S_ISDIR(aa->perm)) {
724 error("Can't change directory: \"%s\" is not "
735 do_ls(in, out, *pwd);
738 path1 = make_absolute(path1, *pwd);
739 if ((tmp = do_realpath(in, out, path1)) == NULL)
743 if ((aa = do_stat(in, out, path1, 0)) == NULL)
745 if ((aa->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) &&
746 !S_ISDIR(aa->perm)) {
747 error("Can't ls: \"%s\" is not a directory", path1);
750 do_ls(in, out, path1);
753 if (chdir(path1) == -1) {
754 error("Couldn't change local directory to "
755 "\"%s\": %s", path1, strerror(errno));
760 if (mkdir(path1, 0777) == -1) {
761 error("Couldn't create local directory "
762 "\"%s\": %s", path1, strerror(errno));
774 printf("Local umask: %03lo\n", n_arg);
777 path1 = make_absolute(path1, *pwd);
779 a.flags |= SSH2_FILEXFER_ATTR_PERMISSIONS;
781 remote_glob(in, out, path1, GLOB_NOCHECK, NULL, &g);
782 for(i = 0; g.gl_pathv[i]; i++) {
783 printf("Changing mode on %s\n", g.gl_pathv[i]);
784 do_setstat(in, out, g.gl_pathv[i], &a);
788 path1 = make_absolute(path1, *pwd);
789 remote_glob(in, out, path1, GLOB_NOCHECK, NULL, &g);
790 for(i = 0; g.gl_pathv[i]; i++) {
791 if (!(aa = do_stat(in, out, g.gl_pathv[i], 0)))
793 if (!(aa->flags & SSH2_FILEXFER_ATTR_UIDGID)) {
794 error("Can't get current ownership of "
795 "remote file \"%s\"", g.gl_pathv[i]);
798 printf("Changing owner on %s\n", g.gl_pathv[i]);
799 aa->flags &= SSH2_FILEXFER_ATTR_UIDGID;
801 do_setstat(in, out, g.gl_pathv[i], aa);
805 path1 = make_absolute(path1, *pwd);
806 remote_glob(in, out, path1, GLOB_NOCHECK, NULL, &g);
807 for(i = 0; g.gl_pathv[i]; i++) {
808 if (!(aa = do_stat(in, out, g.gl_pathv[i], 0)))
810 if (!(aa->flags & SSH2_FILEXFER_ATTR_UIDGID)) {
811 error("Can't get current ownership of "
812 "remote file \"%s\"", g.gl_pathv[i]);
815 printf("Changing group on %s\n", g.gl_pathv[i]);
816 aa->flags &= SSH2_FILEXFER_ATTR_UIDGID;
818 do_setstat(in, out, g.gl_pathv[i], aa);
822 printf("Remote working directory: %s\n", *pwd);
825 if (!getcwd(path_buf, sizeof(path_buf)))
826 error("Couldn't get local cwd: %s",
829 printf("Local working directory: %s\n",
838 printf("SFTP protocol version %d\n", version);
841 fatal("%d is not implemented", cmdnum);
851 /* If an error occurs in batch mode we should abort. */
852 if (infile != stdin && err > 0)
859 interactive_loop(int fd_in, int fd_out, char *file1, char *file2)
865 version = do_init(fd_in, fd_out);
867 fatal("Couldn't initialise connection to server");
869 pwd = do_realpath(fd_in, fd_out, ".");
874 dir = xstrdup(file1);
875 dir = make_absolute(dir, pwd);
877 if (remote_is_dir(fd_in, fd_out, dir) && file2 == NULL) {
878 printf("Changing to: %s\n", dir);
879 snprintf(cmd, sizeof cmd, "cd \"%s\"", dir);
880 parse_dispatch_command(fd_in, fd_out, cmd, &pwd);
883 snprintf(cmd, sizeof cmd, "get %s", dir);
885 snprintf(cmd, sizeof cmd, "get %s %s", dir,
888 parse_dispatch_command(fd_in, fd_out, cmd, &pwd);
893 setvbuf(stdout, NULL, _IOLBF, 0);
894 setvbuf(infile, NULL, _IOLBF, 0);
905 /* XXX: use libedit */
906 if (fgets(cmd, sizeof(cmd), infile) == NULL) {
909 } else if (infile != stdin) /* Bluff typing */
912 cp = strrchr(cmd, '\n');
916 if (parse_dispatch_command(fd_in, fd_out, cmd, &pwd))