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.121 2005/04/02 12:41:16 djm 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);
113 waitpid(do_cmd_pid, NULL, 0);
120 * This function executes the given command as the specified user on the
121 * given host. This returns < 0 if execution fails, and >= 0 otherwise. This
122 * assigns the input and output file descriptors on success.
126 do_cmd(char *host, char *remuser, char *cmd, int *fdin, int *fdout, int argc)
128 int pin[2], pout[2], reserved[2];
132 "Executing: program %s host %s, user %s, command %s\n",
134 remuser ? remuser : "(unspecified)", cmd);
137 * Reserve two descriptors so that the real pipes won't get
138 * descriptors 0 and 1 because that will screw up dup2 below.
142 /* Create a socket pair for communicating with ssh. */
144 fatal("pipe: %s", strerror(errno));
146 fatal("pipe: %s", strerror(errno));
148 /* Free the reserved descriptors. */
152 /* Fork a child to execute the command on the remote host using ssh. */
154 if (do_cmd_pid == 0) {
163 args.list[0] = ssh_program;
165 addargs(&args, "-l%s", remuser);
166 addargs(&args, "%s", host);
167 addargs(&args, "%s", cmd);
169 execvp(ssh_program, args.list);
172 } else if (do_cmd_pid == -1) {
173 fatal("fork: %s", strerror(errno));
175 /* Parent. Close the other side, and return the local side. */
180 signal(SIGTERM, killchild);
181 signal(SIGINT, killchild);
182 signal(SIGHUP, killchild);
191 BUF *allocbuf(BUF *, int, int);
195 void run_err(const char *,...);
196 void verifydir(char *);
200 int errs, remin, remout;
201 int pflag, iamremote, iamrecursive, targetshouldbedirectory;
204 char cmd[CMDNEEDS]; /* must hold "rcp -r -p -d\0" */
207 void rsource(char *, struct stat *);
208 void sink(int, char *[]);
209 void source(int, char *[]);
210 void tolocal(int, char *[]);
211 void toremote(char *, int, char *[]);
215 main(int argc, char **argv)
217 int ch, fflag, tflag, status;
223 __progname = ssh_get_progname(argv[0]);
226 addargs(&args, "ssh"); /* overwritten with ssh_program */
227 addargs(&args, "-x");
228 addargs(&args, "-oForwardAgent no");
229 addargs(&args, "-oClearAllForwardings yes");
232 while ((ch = getopt(argc, argv, "dfl:prtvBCc:i:P:q1246S:o:F:")) != -1)
234 /* User-visible flags. */
240 addargs(&args, "-%c", ch);
246 addargs(&args, "-%c%s", ch, optarg);
249 addargs(&args, "-p%s", optarg);
252 addargs(&args, "-oBatchmode yes");
255 speed = strtod(optarg, &endp);
256 if (speed <= 0 || *endp != '\0')
258 limit_rate = speed * 1024;
267 ssh_program = xstrdup(optarg);
270 addargs(&args, "-v");
274 addargs(&args, "-q");
278 /* Server options. */
280 targetshouldbedirectory = 1;
282 case 'f': /* "from" */
290 setmode(0, O_BINARY);
299 if ((pwd = getpwuid(userid = getuid())) == NULL)
300 fatal("unknown user %u", (u_int) userid);
302 if (!isatty(STDERR_FILENO))
305 remin = STDIN_FILENO;
306 remout = STDOUT_FILENO;
309 /* Follow "protocol", send data. */
322 targetshouldbedirectory = 1;
326 /* Command to be executed on remote system using "ssh". */
327 (void) snprintf(cmd, sizeof cmd, "scp%s%s%s%s",
328 verbose_mode ? " -v" : "",
329 iamrecursive ? " -r" : "", pflag ? " -p" : "",
330 targetshouldbedirectory ? " -d" : "");
332 (void) signal(SIGPIPE, lostconn);
334 if ((targ = colon(argv[argc - 1]))) /* Dest is remote host. */
335 toremote(targ, argc, argv);
337 tolocal(argc, argv); /* Dest is local host. */
338 if (targetshouldbedirectory)
339 verifydir(argv[argc - 1]);
342 * Finally check the exit status of the ssh process, if one was forked
343 * and no error has occured yet
345 if (do_cmd_pid != -1 && errs == 0) {
349 (void) close(remout);
350 if (waitpid(do_cmd_pid, &status, 0) == -1)
353 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
361 toremote(char *targ, int argc, char **argv)
364 char *bp, *host, *src, *suser, *thost, *tuser, *arg;
370 arg = xstrdup(argv[argc - 1]);
371 if ((thost = strrchr(arg, '@'))) {
382 for (i = 0; i < argc - 1; i++) {
383 src = colon(argv[i]);
384 if (src) { /* remote to remote */
385 static char *ssh_options =
386 "-x -o'ClearAllForwardings yes'";
390 host = strrchr(argv[i], '@');
391 len = strlen(ssh_program) + strlen(argv[i]) +
392 strlen(src) + (tuser ? strlen(tuser) : 0) +
393 strlen(thost) + strlen(targ) +
394 strlen(ssh_options) + CMDNEEDS + 20;
398 host = cleanhostname(host);
401 suser = pwd->pw_name;
402 else if (!okname(suser)) {
406 if (tuser && !okname(tuser)) {
412 "-l %s %s %s %s '%s%s%s:%s'",
413 ssh_program, verbose_mode ? " -v" : "",
414 ssh_options, suser, host, cmd, src,
415 tuser ? tuser : "", tuser ? "@" : "",
418 host = cleanhostname(argv[i]);
420 "exec %s%s %s -n %s "
422 ssh_program, verbose_mode ? " -v" : "",
423 ssh_options, host, cmd, src,
424 tuser ? tuser : "", tuser ? "@" : "",
428 fprintf(stderr, "Executing: %s\n", bp);
432 } else { /* local to remote */
434 len = strlen(targ) + CMDNEEDS + 20;
436 (void) snprintf(bp, len, "%s -t %s", cmd, targ);
437 host = cleanhostname(thost);
438 if (do_cmd(host, tuser, bp, &remin,
451 tolocal(int argc, char **argv)
454 char *bp, *host, *src, *suser;
456 for (i = 0; i < argc - 1; i++) {
457 if (!(src = colon(argv[i]))) { /* Local to local. */
458 len = strlen(_PATH_CP) + strlen(argv[i]) +
459 strlen(argv[argc - 1]) + 20;
461 (void) snprintf(bp, len, "exec %s%s%s %s %s", _PATH_CP,
462 iamrecursive ? " -r" : "", pflag ? " -p" : "",
463 argv[i], argv[argc - 1]);
465 fprintf(stderr, "Executing: %s\n", bp);
474 if ((host = strrchr(argv[i], '@')) == NULL) {
481 suser = pwd->pw_name;
483 host = cleanhostname(host);
484 len = strlen(src) + CMDNEEDS + 20;
486 (void) snprintf(bp, len, "%s -f %s", cmd, src);
487 if (do_cmd(host, suser, bp, &remin, &remout, argc) < 0) {
493 sink(1, argv + argc - 1);
500 source(int argc, char **argv)
505 off_t i, amt, result, statbytes;
506 int fd, haderr, indx;
507 char *last, *name, buf[2048];
510 for (indx = 0; indx < argc; ++indx) {
514 while (len > 1 && name[len-1] == '/')
516 if (strchr(name, '\n') != NULL) {
517 run_err("%s: skipping, filename contains a newline",
521 if ((fd = open(name, O_RDONLY, 0)) < 0)
523 if (fstat(fd, &stb) < 0) {
524 syserr: run_err("%s: %s", name, strerror(errno));
527 switch (stb.st_mode & S_IFMT) {
537 run_err("%s: not a regular file", name);
540 if ((last = strrchr(name, '/')) == NULL)
547 * Make it compatible with possible future
548 * versions expecting microseconds.
550 (void) snprintf(buf, sizeof buf, "T%lu 0 %lu 0\n",
551 (u_long) stb.st_mtime,
552 (u_long) stb.st_atime);
553 (void) atomicio(vwrite, remout, buf, strlen(buf));
557 #define FILEMODEMASK (S_ISUID|S_ISGID|S_IRWXU|S_IRWXG|S_IRWXO)
558 snprintf(buf, sizeof buf, "C%04o %lld %s\n",
559 (u_int) (stb.st_mode & FILEMODEMASK),
560 (int64_t)stb.st_size, last);
562 fprintf(stderr, "Sending file modes: %s", buf);
564 (void) atomicio(vwrite, remout, buf, strlen(buf));
567 if ((bp = allocbuf(&buffer, fd, 2048)) == NULL) {
568 next: (void) close(fd);
572 start_progress_meter(curfile, stb.st_size, &statbytes);
573 /* Keep writing after an error so that we stay sync'd up. */
574 for (haderr = i = 0; i < stb.st_size; i += bp->cnt) {
576 if (i + amt > stb.st_size)
577 amt = stb.st_size - i;
579 result = atomicio(read, fd, bp->buf, amt);
581 haderr = result >= 0 ? EIO : errno;
584 (void) atomicio(vwrite, remout, bp->buf, amt);
586 result = atomicio(vwrite, remout, bp->buf, amt);
588 haderr = result >= 0 ? EIO : errno;
595 stop_progress_meter();
597 if (close(fd) < 0 && !haderr)
600 (void) atomicio(vwrite, remout, "", 1);
602 run_err("%s: %s", name, strerror(haderr));
608 rsource(char *name, struct stat *statp)
612 char *last, *vect[1], path[1100];
614 if (!(dirp = opendir(name))) {
615 run_err("%s: %s", name, strerror(errno));
618 last = strrchr(name, '/');
624 (void) snprintf(path, sizeof(path), "T%lu 0 %lu 0\n",
625 (u_long) statp->st_mtime,
626 (u_long) statp->st_atime);
627 (void) atomicio(vwrite, remout, path, strlen(path));
628 if (response() < 0) {
633 (void) snprintf(path, sizeof path, "D%04o %d %.1024s\n",
634 (u_int) (statp->st_mode & FILEMODEMASK), 0, last);
636 fprintf(stderr, "Entering directory: %s", path);
637 (void) atomicio(vwrite, remout, path, strlen(path));
638 if (response() < 0) {
642 while ((dp = readdir(dirp)) != NULL) {
645 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
647 if (strlen(name) + 1 + strlen(dp->d_name) >= sizeof(path) - 1) {
648 run_err("%s/%s: name too long", name, dp->d_name);
651 (void) snprintf(path, sizeof path, "%s/%s", name, dp->d_name);
655 (void) closedir(dirp);
656 (void) atomicio(vwrite, remout, "E\n", 2);
663 static struct timeval bwstart, bwend;
664 static int lamt, thresh = 16384;
666 struct timespec ts, rm;
668 if (!timerisset(&bwstart)) {
669 gettimeofday(&bwstart, NULL);
677 gettimeofday(&bwend, NULL);
678 timersub(&bwend, &bwstart, &bwend);
679 if (!timerisset(&bwend))
683 waitlen = (double)1000000L * lamt / limit_rate;
685 bwstart.tv_sec = waitlen / 1000000L;
686 bwstart.tv_usec = waitlen % 1000000L;
688 if (timercmp(&bwstart, &bwend, >)) {
689 timersub(&bwstart, &bwend, &bwend);
691 /* Adjust the wait time */
696 } else if (bwend.tv_usec < 100) {
702 TIMEVAL_TO_TIMESPEC(&bwend, &ts);
703 while (nanosleep(&ts, &rm) == -1) {
711 gettimeofday(&bwstart, NULL);
715 sink(int argc, char **argv)
724 int amt, count, exists, first, mask, mode, ofd, omode;
725 off_t size, statbytes;
726 int setimes, targisdir, wrerrno = 0;
727 char ch, *cp, *np, *targ, *why, *vect[1], buf[2048];
728 struct timeval tv[2];
732 #define SCREWUP(str) { why = str; goto screwup; }
734 setimes = targisdir = 0;
739 run_err("ambiguous target");
743 if (targetshouldbedirectory)
746 (void) atomicio(vwrite, remout, "", 1);
747 if (stat(targ, &stb) == 0 && S_ISDIR(stb.st_mode))
749 for (first = 1;; first = 0) {
751 if (atomicio(read, remin, cp, 1) <= 0)
754 SCREWUP("unexpected <newline>");
756 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
757 SCREWUP("lost connection");
759 } while (cp < &buf[sizeof(buf) - 1] && ch != '\n');
762 fprintf(stderr, "Sink: %s", buf);
764 if (buf[0] == '\01' || buf[0] == '\02') {
766 (void) atomicio(vwrite, STDERR_FILENO,
767 buf + 1, strlen(buf + 1));
774 (void) atomicio(vwrite, remout, "", 1);
784 mtime.tv_sec = strtol(cp, &cp, 10);
785 if (!cp || *cp++ != ' ')
786 SCREWUP("mtime.sec not delimited");
787 mtime.tv_usec = strtol(cp, &cp, 10);
788 if (!cp || *cp++ != ' ')
789 SCREWUP("mtime.usec not delimited");
790 atime.tv_sec = strtol(cp, &cp, 10);
791 if (!cp || *cp++ != ' ')
792 SCREWUP("atime.sec not delimited");
793 atime.tv_usec = strtol(cp, &cp, 10);
794 if (!cp || *cp++ != '\0')
795 SCREWUP("atime.usec not delimited");
796 (void) atomicio(vwrite, remout, "", 1);
799 if (*cp != 'C' && *cp != 'D') {
801 * Check for the case "rcp remote:foo\* local:bar".
802 * In this case, the line "No match." can be returned
803 * by the shell before the rcp command on the remote is
804 * executed so the ^Aerror_message convention isn't
811 SCREWUP("expected control record");
814 for (++cp; cp < buf + 5; cp++) {
815 if (*cp < '0' || *cp > '7')
817 mode = (mode << 3) | (*cp - '0');
820 SCREWUP("mode not delimited");
822 for (size = 0; isdigit(*cp);)
823 size = size * 10 + (*cp++ - '0');
825 SCREWUP("size not delimited");
826 if ((strchr(cp, '/') != NULL) || (strcmp(cp, "..") == 0)) {
827 run_err("error: unexpected filename: %s", cp);
831 static char *namebuf;
835 need = strlen(targ) + strlen(cp) + 250;
836 if (need > cursize) {
839 namebuf = xmalloc(need);
842 (void) snprintf(namebuf, need, "%s%s%s", targ,
843 strcmp(targ, "/") ? "/" : "", cp);
848 exists = stat(np, &stb) == 0;
850 int mod_flag = pflag;
852 SCREWUP("received directory without -r");
854 if (!S_ISDIR(stb.st_mode)) {
859 (void) chmod(np, mode);
861 /* Handle copying from a read-only
864 if (mkdir(np, mode | S_IRWXU) < 0)
867 vect[0] = xstrdup(np);
871 if (utimes(vect[0], tv) < 0)
872 run_err("%s: set times: %s",
873 vect[0], strerror(errno));
876 (void) chmod(vect[0], mode);
883 if ((ofd = open(np, O_WRONLY|O_CREAT, mode)) < 0) {
884 bad: run_err("%s: %s", np, strerror(errno));
887 (void) atomicio(vwrite, remout, "", 1);
888 if ((bp = allocbuf(&buffer, ofd, 4096)) == NULL) {
897 start_progress_meter(curfile, size, &statbytes);
898 for (count = i = 0; i < size; i += 4096) {
904 j = atomicio(read, remin, cp, amt);
906 run_err("%s", j ? strerror(errno) :
907 "dropped connection");
918 if (count == bp->cnt) {
919 /* Keep reading so we stay sync'd up. */
921 j = atomicio(vwrite, ofd, bp->buf, count);
924 wrerrno = j >= 0 ? EIO : errno;
932 stop_progress_meter();
933 if (count != 0 && wrerr == NO &&
934 (j = atomicio(vwrite, ofd, bp->buf, count)) != count) {
936 wrerrno = j >= 0 ? EIO : errno;
938 if (wrerr == NO && ftruncate(ofd, size) != 0) {
939 run_err("%s: truncate: %s", np, strerror(errno));
943 if (exists || omode != mode)
945 if (fchmod(ofd, omode)) {
946 #else /* HAVE_FCHMOD */
947 if (chmod(np, omode)) {
948 #endif /* HAVE_FCHMOD */
949 run_err("%s: set mode: %s",
950 np, strerror(errno));
954 if (!exists && omode != mode)
956 if (fchmod(ofd, omode & ~mask)) {
957 #else /* HAVE_FCHMOD */
958 if (chmod(np, omode & ~mask)) {
959 #endif /* HAVE_FCHMOD */
960 run_err("%s: set mode: %s",
961 np, strerror(errno));
965 if (close(ofd) == -1) {
970 if (setimes && wrerr == NO) {
972 if (utimes(np, tv) < 0) {
973 run_err("%s: set times: %s",
974 np, strerror(errno));
980 run_err("%s: %s", np, strerror(wrerrno));
983 (void) atomicio(vwrite, remout, "", 1);
990 run_err("protocol error: %s", why);
997 char ch, *cp, resp, rbuf[2048];
999 if (atomicio(read, remin, &resp, sizeof(resp)) != sizeof(resp))
1009 case 1: /* error, followed by error msg */
1010 case 2: /* fatal error, "" */
1012 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
1015 } while (cp < &rbuf[sizeof(rbuf) - 1] && ch != '\n');
1018 (void) atomicio(vwrite, STDERR_FILENO, rbuf, cp - rbuf);
1030 (void) fprintf(stderr,
1031 "usage: scp [-1246BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file]\n"
1032 " [-l limit] [-o ssh_option] [-P port] [-S program]\n"
1033 " [[user@]host1:]file1 [...] [[user@]host2:]file2\n");
1038 run_err(const char *fmt,...)
1044 if (fp == NULL && !(fp = fdopen(remout, "w")))
1046 (void) fprintf(fp, "%c", 0x01);
1047 (void) fprintf(fp, "scp: ");
1049 (void) vfprintf(fp, fmt, ap);
1051 (void) fprintf(fp, "\n");
1056 vfprintf(stderr, fmt, ap);
1058 fprintf(stderr, "\n");
1067 if (!stat(cp, &stb)) {
1068 if (S_ISDIR(stb.st_mode))
1072 run_err("%s: %s", cp, strerror(errno));
1087 if (!isalpha(c) && !isdigit(c)) {
1102 bad: fprintf(stderr, "%s: invalid user name\n", cp0);
1107 allocbuf(BUF *bp, int fd, int blksize)
1110 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
1113 if (fstat(fd, &stb) < 0) {
1114 run_err("fstat: %s", strerror(errno));
1117 size = roundup(stb.st_blksize, blksize);
1120 #else /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1122 #endif /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1123 if (bp->cnt >= size)
1125 if (bp->buf == NULL)
1126 bp->buf = xmalloc(size);
1128 bp->buf = xrealloc(bp->buf, size);
1129 memset(bp->buf, 0, size);
1138 write(STDERR_FILENO, "lost connection\n", 16);