2 * scp - secure remote copy. This is basically patched BSD rcp which
3 * uses ssh to do the data transfer (instead of using rcmd).
5 * NOTE: This version should NOT be suid root. (This uses ssh to
6 * do the transfer and ssh has the necessary privileges.)
8 * 1995 Timo Rinne <tri@iki.fi>, Tatu Ylonen <ylo@cs.hut.fi>
10 * As far as I am concerned, the code I have written for this software
11 * can be used freely for any purpose. Any derived versions of this
12 * software must be clearly marked as such, and if the derived work is
13 * incompatible with the protocol description in the RFC file, it must be
14 * called by a name other than "ssh" or "Secure Shell".
17 * Copyright (c) 1999 Theo de Raadt. All rights reserved.
18 * Copyright (c) 1999 Aaron Campbell. All rights reserved.
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
23 * 1. Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * 2. Redistributions in binary form must reproduce the above copyright
26 * notice, this list of conditions and the following disclaimer in the
27 * documentation and/or other materials provided with the distribution.
29 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
30 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
33 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
34 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
38 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 * Copyright (c) 1983, 1990, 1992, 1993, 1995
45 * The Regents of the University of California. All rights reserved.
47 * Redistribution and use in source and binary forms, with or without
48 * modification, are permitted provided that the following conditions
50 * 1. Redistributions of source code must retain the above copyright
51 * notice, this list of conditions and the following disclaimer.
52 * 2. Redistributions in binary form must reproduce the above copyright
53 * notice, this list of conditions and the following disclaimer in the
54 * documentation and/or other materials provided with the distribution.
55 * 3. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
74 RCSID("$OpenBSD: scp.c,v 1.127 2005/11/12 18:38:15 deraadt Exp $");
78 #include "pathnames.h"
81 #include "progressmeter.h"
83 extern char *__progname;
87 /* Struct for addargs */
93 /* Name of current file being transferred. */
96 /* This is set to non-zero to enable verbose mode. */
99 /* This is set to zero if the progressmeter is not desired. */
100 int showprogress = 1;
102 /* This is the program to execute for the secured connection. ("ssh" or -S) */
103 char *ssh_program = _PATH_SSH_PROGRAM;
105 /* This is used to store the pid of ssh_program */
106 pid_t do_cmd_pid = -1;
111 if (do_cmd_pid > 1) {
112 kill(do_cmd_pid, signo ? signo : SIGTERM);
113 waitpid(do_cmd_pid, NULL, 0);
122 * This function executes the given command as the specified user on the
123 * given host. This returns < 0 if execution fails, and >= 0 otherwise. This
124 * assigns the input and output file descriptors on success.
128 do_cmd(char *host, char *remuser, char *cmd, int *fdin, int *fdout, int argc)
130 int pin[2], pout[2], reserved[2];
134 "Executing: program %s host %s, user %s, command %s\n",
136 remuser ? remuser : "(unspecified)", cmd);
139 * Reserve two descriptors so that the real pipes won't get
140 * descriptors 0 and 1 because that will screw up dup2 below.
144 /* Create a socket pair for communicating with ssh. */
146 fatal("pipe: %s", strerror(errno));
148 fatal("pipe: %s", strerror(errno));
150 /* Free the reserved descriptors. */
154 /* Fork a child to execute the command on the remote host using ssh. */
156 if (do_cmd_pid == 0) {
165 args.list[0] = ssh_program;
167 addargs(&args, "-l%s", remuser);
168 addargs(&args, "%s", host);
169 addargs(&args, "%s", cmd);
171 execvp(ssh_program, args.list);
174 } else if (do_cmd_pid == -1) {
175 fatal("fork: %s", strerror(errno));
177 /* Parent. Close the other side, and return the local side. */
182 signal(SIGTERM, killchild);
183 signal(SIGINT, killchild);
184 signal(SIGHUP, killchild);
193 BUF *allocbuf(BUF *, int, int);
197 void run_err(const char *,...);
198 void verifydir(char *);
202 int errs, remin, remout;
203 int pflag, iamremote, iamrecursive, targetshouldbedirectory;
206 char cmd[CMDNEEDS]; /* must hold "rcp -r -p -d\0" */
209 void rsource(char *, struct stat *);
210 void sink(int, char *[]);
211 void source(int, char *[]);
212 void tolocal(int, char *[]);
213 void toremote(char *, int, char *[]);
217 main(int argc, char **argv)
219 int ch, fflag, tflag, status;
225 /* Ensure that fds 0, 1 and 2 are open or directed to /dev/null */
228 __progname = ssh_get_progname(argv[0]);
231 addargs(&args, "ssh"); /* overwritten with ssh_program */
232 addargs(&args, "-x");
233 addargs(&args, "-oForwardAgent no");
234 addargs(&args, "-oClearAllForwardings yes");
237 while ((ch = getopt(argc, argv, "dfl:prtvBCc:i:P:q1246S:o:F:")) != -1)
239 /* User-visible flags. */
245 addargs(&args, "-%c", ch);
251 addargs(&args, "-%c%s", ch, optarg);
254 addargs(&args, "-p%s", optarg);
257 addargs(&args, "-oBatchmode yes");
260 speed = strtod(optarg, &endp);
261 if (speed <= 0 || *endp != '\0')
263 limit_rate = speed * 1024;
272 ssh_program = xstrdup(optarg);
275 addargs(&args, "-v");
279 addargs(&args, "-q");
283 /* Server options. */
285 targetshouldbedirectory = 1;
287 case 'f': /* "from" */
295 setmode(0, O_BINARY);
304 if ((pwd = getpwuid(userid = getuid())) == NULL)
305 fatal("unknown user %u", (u_int) userid);
307 if (!isatty(STDERR_FILENO))
310 remin = STDIN_FILENO;
311 remout = STDOUT_FILENO;
314 /* Follow "protocol", send data. */
327 targetshouldbedirectory = 1;
331 /* Command to be executed on remote system using "ssh". */
332 (void) snprintf(cmd, sizeof cmd, "scp%s%s%s%s",
333 verbose_mode ? " -v" : "",
334 iamrecursive ? " -r" : "", pflag ? " -p" : "",
335 targetshouldbedirectory ? " -d" : "");
337 (void) signal(SIGPIPE, lostconn);
339 if ((targ = colon(argv[argc - 1]))) /* Dest is remote host. */
340 toremote(targ, argc, argv);
342 tolocal(argc, argv); /* Dest is local host. */
343 if (targetshouldbedirectory)
344 verifydir(argv[argc - 1]);
347 * Finally check the exit status of the ssh process, if one was forked
348 * and no error has occured yet
350 if (do_cmd_pid != -1 && errs == 0) {
354 (void) close(remout);
355 if (waitpid(do_cmd_pid, &status, 0) == -1)
358 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
366 toremote(char *targ, int argc, char **argv)
369 char *bp, *host, *src, *suser, *thost, *tuser, *arg;
375 arg = xstrdup(argv[argc - 1]);
376 if ((thost = strrchr(arg, '@'))) {
387 for (i = 0; i < argc - 1; i++) {
388 src = colon(argv[i]);
389 if (src) { /* remote to remote */
390 static char *ssh_options =
391 "-x -o'ClearAllForwardings yes'";
395 host = strrchr(argv[i], '@');
396 len = strlen(ssh_program) + strlen(argv[i]) +
397 strlen(src) + (tuser ? strlen(tuser) : 0) +
398 strlen(thost) + strlen(targ) +
399 strlen(ssh_options) + CMDNEEDS + 20;
403 host = cleanhostname(host);
406 suser = pwd->pw_name;
407 else if (!okname(suser)) {
411 if (tuser && !okname(tuser)) {
417 "-l %s %s %s %s '%s%s%s:%s'",
418 ssh_program, verbose_mode ? " -v" : "",
419 ssh_options, suser, host, cmd, src,
420 tuser ? tuser : "", tuser ? "@" : "",
423 host = cleanhostname(argv[i]);
425 "exec %s%s %s -n %s "
427 ssh_program, verbose_mode ? " -v" : "",
428 ssh_options, host, cmd, src,
429 tuser ? tuser : "", tuser ? "@" : "",
433 fprintf(stderr, "Executing: %s\n", bp);
437 } else { /* local to remote */
439 len = strlen(targ) + CMDNEEDS + 20;
441 (void) snprintf(bp, len, "%s -t %s", cmd, targ);
442 host = cleanhostname(thost);
443 if (do_cmd(host, tuser, bp, &remin,
456 tolocal(int argc, char **argv)
459 char *bp, *host, *src, *suser;
461 for (i = 0; i < argc - 1; i++) {
462 if (!(src = colon(argv[i]))) { /* Local to local. */
463 len = strlen(_PATH_CP) + strlen(argv[i]) +
464 strlen(argv[argc - 1]) + 20;
466 (void) snprintf(bp, len, "exec %s%s%s %s %s", _PATH_CP,
467 iamrecursive ? " -r" : "", pflag ? " -p" : "",
468 argv[i], argv[argc - 1]);
470 fprintf(stderr, "Executing: %s\n", bp);
479 if ((host = strrchr(argv[i], '@')) == NULL) {
486 suser = pwd->pw_name;
488 host = cleanhostname(host);
489 len = strlen(src) + CMDNEEDS + 20;
491 (void) snprintf(bp, len, "%s -f %s", cmd, src);
492 if (do_cmd(host, suser, bp, &remin, &remout, argc) < 0) {
498 sink(1, argv + argc - 1);
505 source(int argc, char **argv)
510 off_t i, amt, statbytes;
512 int fd = -1, haderr, indx;
513 char *last, *name, buf[2048];
516 for (indx = 0; indx < argc; ++indx) {
520 while (len > 1 && name[len-1] == '/')
522 if (strchr(name, '\n') != NULL) {
523 run_err("%s: skipping, filename contains a newline",
527 if ((fd = open(name, O_RDONLY, 0)) < 0)
529 if (fstat(fd, &stb) < 0) {
530 syserr: run_err("%s: %s", name, strerror(errno));
533 switch (stb.st_mode & S_IFMT) {
543 run_err("%s: not a regular file", name);
546 if ((last = strrchr(name, '/')) == NULL)
553 * Make it compatible with possible future
554 * versions expecting microseconds.
556 (void) snprintf(buf, sizeof buf, "T%lu 0 %lu 0\n",
557 (u_long) stb.st_mtime,
558 (u_long) stb.st_atime);
559 (void) atomicio(vwrite, remout, buf, strlen(buf));
563 #define FILEMODEMASK (S_ISUID|S_ISGID|S_IRWXU|S_IRWXG|S_IRWXO)
564 snprintf(buf, sizeof buf, "C%04o %lld %s\n",
565 (u_int) (stb.st_mode & FILEMODEMASK),
566 (int64_t)stb.st_size, last);
568 fprintf(stderr, "Sending file modes: %s", buf);
570 (void) atomicio(vwrite, remout, buf, strlen(buf));
573 if ((bp = allocbuf(&buffer, fd, 2048)) == NULL) {
574 next: if (fd != -1) {
581 start_progress_meter(curfile, stb.st_size, &statbytes);
582 /* Keep writing after an error so that we stay sync'd up. */
583 for (haderr = i = 0; i < stb.st_size; i += bp->cnt) {
585 if (i + amt > stb.st_size)
586 amt = stb.st_size - i;
588 result = atomicio(read, fd, bp->buf, amt);
593 (void) atomicio(vwrite, remout, bp->buf, amt);
595 result = atomicio(vwrite, remout, bp->buf, amt);
604 stop_progress_meter();
607 if (close(fd) < 0 && !haderr)
612 (void) atomicio(vwrite, remout, "", 1);
614 run_err("%s: %s", name, strerror(haderr));
620 rsource(char *name, struct stat *statp)
624 char *last, *vect[1], path[1100];
626 if (!(dirp = opendir(name))) {
627 run_err("%s: %s", name, strerror(errno));
630 last = strrchr(name, '/');
636 (void) snprintf(path, sizeof(path), "T%lu 0 %lu 0\n",
637 (u_long) statp->st_mtime,
638 (u_long) statp->st_atime);
639 (void) atomicio(vwrite, remout, path, strlen(path));
640 if (response() < 0) {
645 (void) snprintf(path, sizeof path, "D%04o %d %.1024s\n",
646 (u_int) (statp->st_mode & FILEMODEMASK), 0, last);
648 fprintf(stderr, "Entering directory: %s", path);
649 (void) atomicio(vwrite, remout, path, strlen(path));
650 if (response() < 0) {
654 while ((dp = readdir(dirp)) != NULL) {
657 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
659 if (strlen(name) + 1 + strlen(dp->d_name) >= sizeof(path) - 1) {
660 run_err("%s/%s: name too long", name, dp->d_name);
663 (void) snprintf(path, sizeof path, "%s/%s", name, dp->d_name);
667 (void) closedir(dirp);
668 (void) atomicio(vwrite, remout, "E\n", 2);
675 static struct timeval bwstart, bwend;
676 static int lamt, thresh = 16384;
678 struct timespec ts, rm;
680 if (!timerisset(&bwstart)) {
681 gettimeofday(&bwstart, NULL);
689 gettimeofday(&bwend, NULL);
690 timersub(&bwend, &bwstart, &bwend);
691 if (!timerisset(&bwend))
695 waitlen = (double)1000000L * lamt / limit_rate;
697 bwstart.tv_sec = waitlen / 1000000L;
698 bwstart.tv_usec = waitlen % 1000000L;
700 if (timercmp(&bwstart, &bwend, >)) {
701 timersub(&bwstart, &bwend, &bwend);
703 /* Adjust the wait time */
708 } else if (bwend.tv_usec < 100) {
714 TIMEVAL_TO_TIMESPEC(&bwend, &ts);
715 while (nanosleep(&ts, &rm) == -1) {
723 gettimeofday(&bwstart, NULL);
727 sink(int argc, char **argv)
737 int amt, exists, first, mask, mode, ofd, omode;
738 off_t size, statbytes;
739 int setimes, targisdir, wrerrno = 0;
740 char ch, *cp, *np, *targ, *why, *vect[1], buf[2048];
741 struct timeval tv[2];
745 #define SCREWUP(str) { why = str; goto screwup; }
747 setimes = targisdir = 0;
752 run_err("ambiguous target");
756 if (targetshouldbedirectory)
759 (void) atomicio(vwrite, remout, "", 1);
760 if (stat(targ, &stb) == 0 && S_ISDIR(stb.st_mode))
762 for (first = 1;; first = 0) {
764 if (atomicio(read, remin, cp, 1) != 1)
767 SCREWUP("unexpected <newline>");
769 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
770 SCREWUP("lost connection");
772 } while (cp < &buf[sizeof(buf) - 1] && ch != '\n');
775 fprintf(stderr, "Sink: %s", buf);
777 if (buf[0] == '\01' || buf[0] == '\02') {
779 (void) atomicio(vwrite, STDERR_FILENO,
780 buf + 1, strlen(buf + 1));
787 (void) atomicio(vwrite, remout, "", 1);
797 mtime.tv_sec = strtol(cp, &cp, 10);
798 if (!cp || *cp++ != ' ')
799 SCREWUP("mtime.sec not delimited");
800 mtime.tv_usec = strtol(cp, &cp, 10);
801 if (!cp || *cp++ != ' ')
802 SCREWUP("mtime.usec not delimited");
803 atime.tv_sec = strtol(cp, &cp, 10);
804 if (!cp || *cp++ != ' ')
805 SCREWUP("atime.sec not delimited");
806 atime.tv_usec = strtol(cp, &cp, 10);
807 if (!cp || *cp++ != '\0')
808 SCREWUP("atime.usec not delimited");
809 (void) atomicio(vwrite, remout, "", 1);
812 if (*cp != 'C' && *cp != 'D') {
814 * Check for the case "rcp remote:foo\* local:bar".
815 * In this case, the line "No match." can be returned
816 * by the shell before the rcp command on the remote is
817 * executed so the ^Aerror_message convention isn't
824 SCREWUP("expected control record");
827 for (++cp; cp < buf + 5; cp++) {
828 if (*cp < '0' || *cp > '7')
830 mode = (mode << 3) | (*cp - '0');
833 SCREWUP("mode not delimited");
835 for (size = 0; isdigit(*cp);)
836 size = size * 10 + (*cp++ - '0');
838 SCREWUP("size not delimited");
839 if ((strchr(cp, '/') != NULL) || (strcmp(cp, "..") == 0)) {
840 run_err("error: unexpected filename: %s", cp);
844 static char *namebuf;
845 static size_t cursize;
848 need = strlen(targ) + strlen(cp) + 250;
849 if (need > cursize) {
852 namebuf = xmalloc(need);
855 (void) snprintf(namebuf, need, "%s%s%s", targ,
856 strcmp(targ, "/") ? "/" : "", cp);
861 exists = stat(np, &stb) == 0;
863 int mod_flag = pflag;
865 SCREWUP("received directory without -r");
867 if (!S_ISDIR(stb.st_mode)) {
872 (void) chmod(np, mode);
874 /* Handle copying from a read-only
877 if (mkdir(np, mode | S_IRWXU) < 0)
880 vect[0] = xstrdup(np);
884 if (utimes(vect[0], tv) < 0)
885 run_err("%s: set times: %s",
886 vect[0], strerror(errno));
889 (void) chmod(vect[0], mode);
896 if ((ofd = open(np, O_WRONLY|O_CREAT, mode)) < 0) {
897 bad: run_err("%s: %s", np, strerror(errno));
900 (void) atomicio(vwrite, remout, "", 1);
901 if ((bp = allocbuf(&buffer, ofd, 4096)) == NULL) {
910 start_progress_meter(curfile, size, &statbytes);
911 for (count = i = 0; i < size; i += 4096) {
917 j = atomicio(read, remin, cp, amt);
919 run_err("%s", j ? strerror(errno) :
920 "dropped connection");
931 if (count == bp->cnt) {
932 /* Keep reading so we stay sync'd up. */
934 if (atomicio(vwrite, ofd, bp->buf,
945 stop_progress_meter();
946 if (count != 0 && wrerr == NO &&
947 atomicio(vwrite, ofd, bp->buf, count) != count) {
951 if (wrerr == NO && ftruncate(ofd, size) != 0) {
952 run_err("%s: truncate: %s", np, strerror(errno));
956 if (exists || omode != mode)
958 if (fchmod(ofd, omode)) {
959 #else /* HAVE_FCHMOD */
960 if (chmod(np, omode)) {
961 #endif /* HAVE_FCHMOD */
962 run_err("%s: set mode: %s",
963 np, strerror(errno));
967 if (!exists && omode != mode)
969 if (fchmod(ofd, omode & ~mask)) {
970 #else /* HAVE_FCHMOD */
971 if (chmod(np, omode & ~mask)) {
972 #endif /* HAVE_FCHMOD */
973 run_err("%s: set mode: %s",
974 np, strerror(errno));
978 if (close(ofd) == -1) {
983 if (setimes && wrerr == NO) {
985 if (utimes(np, tv) < 0) {
986 run_err("%s: set times: %s",
987 np, strerror(errno));
993 run_err("%s: %s", np, strerror(wrerrno));
996 (void) atomicio(vwrite, remout, "", 1);
1003 run_err("protocol error: %s", why);
1010 char ch, *cp, resp, rbuf[2048];
1012 if (atomicio(read, remin, &resp, sizeof(resp)) != sizeof(resp))
1022 case 1: /* error, followed by error msg */
1023 case 2: /* fatal error, "" */
1025 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
1028 } while (cp < &rbuf[sizeof(rbuf) - 1] && ch != '\n');
1031 (void) atomicio(vwrite, STDERR_FILENO, rbuf, cp - rbuf);
1043 (void) fprintf(stderr,
1044 "usage: scp [-1246BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file]\n"
1045 " [-l limit] [-o ssh_option] [-P port] [-S program]\n"
1046 " [[user@]host1:]file1 [...] [[user@]host2:]file2\n");
1051 run_err(const char *fmt,...)
1057 if (fp == NULL && !(fp = fdopen(remout, "w")))
1059 (void) fprintf(fp, "%c", 0x01);
1060 (void) fprintf(fp, "scp: ");
1062 (void) vfprintf(fp, fmt, ap);
1064 (void) fprintf(fp, "\n");
1069 vfprintf(stderr, fmt, ap);
1071 fprintf(stderr, "\n");
1080 if (!stat(cp, &stb)) {
1081 if (S_ISDIR(stb.st_mode))
1085 run_err("%s: %s", cp, strerror(errno));
1100 if (!isalpha(c) && !isdigit(c)) {
1115 bad: fprintf(stderr, "%s: invalid user name\n", cp0);
1120 allocbuf(BUF *bp, int fd, int blksize)
1123 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
1126 if (fstat(fd, &stb) < 0) {
1127 run_err("fstat: %s", strerror(errno));
1130 size = roundup(stb.st_blksize, blksize);
1133 #else /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1135 #endif /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1136 if (bp->cnt >= size)
1138 if (bp->buf == NULL)
1139 bp->buf = xmalloc(size);
1141 bp->buf = xrealloc(bp->buf, size);
1142 memset(bp->buf, 0, size);
1151 write(STDERR_FILENO, "lost connection\n", 16);