1 /* $OpenBSD: sftp-client.c,v 1.90 2009/10/11 10:41:26 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.
19 /* XXX: signed vs unsigned */
20 /* XXX: remove all logging, only return status codes */
21 /* XXX: copy between two remote sites */
25 #include <sys/types.h>
26 #include <sys/param.h>
27 #ifdef HAVE_SYS_STATVFS_H
28 #include <sys/statvfs.h>
30 #include "openbsd-compat/sys-queue.h"
31 #ifdef HAVE_SYS_STAT_H
32 # include <sys/stat.h>
34 #ifdef HAVE_SYS_TIME_H
35 # include <sys/time.h>
52 #include "progressmeter.h"
56 #include "sftp-common.h"
57 #include "sftp-client.h"
59 extern volatile sig_atomic_t interrupted;
60 extern int showprogress;
62 /* Minimum amount of data to read at a time */
63 #define MIN_READ_SIZE 512
65 /* Maximum depth to descend in directory trees */
66 #define MAX_DIR_DEPTH 64
71 u_int transfer_buflen;
75 #define SFTP_EXT_POSIX_RENAME 0x00000001
76 #define SFTP_EXT_STATVFS 0x00000002
77 #define SFTP_EXT_FSTATVFS 0x00000004
82 get_handle(int fd, u_int expected_id, u_int *len, const char *errfmt, ...)
83 __attribute__((format(printf, 4, 5)));
86 send_msg(int fd, Buffer *m)
91 if (buffer_len(m) > SFTP_MAX_MSG_LENGTH)
92 fatal("Outbound message too long %u", buffer_len(m));
94 /* Send length first */
95 put_u32(mlen, buffer_len(m));
96 iov[0].iov_base = mlen;
97 iov[0].iov_len = sizeof(mlen);
98 iov[1].iov_base = buffer_ptr(m);
99 iov[1].iov_len = buffer_len(m);
101 if (atomiciov(writev, fd, iov, 2) != buffer_len(m) + sizeof(mlen))
102 fatal("Couldn't send packet: %s", strerror(errno));
108 get_msg(int fd, Buffer *m)
112 buffer_append_space(m, 4);
113 if (atomicio(read, fd, buffer_ptr(m), 4) != 4) {
115 fatal("Connection closed");
117 fatal("Couldn't read packet: %s", strerror(errno));
120 msg_len = buffer_get_int(m);
121 if (msg_len > SFTP_MAX_MSG_LENGTH)
122 fatal("Received message too long %u", msg_len);
124 buffer_append_space(m, msg_len);
125 if (atomicio(read, fd, buffer_ptr(m), msg_len) != msg_len) {
127 fatal("Connection closed");
129 fatal("Read packet: %s", strerror(errno));
134 send_string_request(int fd, u_int id, u_int code, char *s,
140 buffer_put_char(&msg, code);
141 buffer_put_int(&msg, id);
142 buffer_put_string(&msg, s, len);
144 debug3("Sent message fd %d T:%u I:%u", fd, code, id);
149 send_string_attrs_request(int fd, u_int id, u_int code, char *s,
150 u_int len, Attrib *a)
155 buffer_put_char(&msg, code);
156 buffer_put_int(&msg, id);
157 buffer_put_string(&msg, s, len);
158 encode_attrib(&msg, a);
160 debug3("Sent message fd %d T:%u I:%u", fd, code, id);
165 get_status(int fd, u_int expected_id)
168 u_int type, id, status;
172 type = buffer_get_char(&msg);
173 id = buffer_get_int(&msg);
175 if (id != expected_id)
176 fatal("ID mismatch (%u != %u)", id, expected_id);
177 if (type != SSH2_FXP_STATUS)
178 fatal("Expected SSH2_FXP_STATUS(%u) packet, got %u",
179 SSH2_FXP_STATUS, type);
181 status = buffer_get_int(&msg);
184 debug3("SSH2_FXP_STATUS %u", status);
190 get_handle(int fd, u_int expected_id, u_int *len, const char *errfmt, ...)
194 char *handle, errmsg[256];
198 va_start(args, errfmt);
200 vsnprintf(errmsg, sizeof(errmsg), errfmt, args);
205 type = buffer_get_char(&msg);
206 id = buffer_get_int(&msg);
208 if (id != expected_id)
209 fatal("%s: ID mismatch (%u != %u)",
210 errfmt == NULL ? __func__ : errmsg, id, expected_id);
211 if (type == SSH2_FXP_STATUS) {
212 status = buffer_get_int(&msg);
214 error("%s: %s", errmsg, fx2txt(status));
217 } else if (type != SSH2_FXP_HANDLE)
218 fatal("%s: Expected SSH2_FXP_HANDLE(%u) packet, got %u",
219 errfmt == NULL ? __func__ : errmsg, SSH2_FXP_HANDLE, type);
221 handle = buffer_get_string(&msg, len);
228 get_decode_stat(int fd, u_int expected_id, int quiet)
237 type = buffer_get_char(&msg);
238 id = buffer_get_int(&msg);
240 debug3("Received stat reply T:%u I:%u", type, id);
241 if (id != expected_id)
242 fatal("ID mismatch (%u != %u)", id, expected_id);
243 if (type == SSH2_FXP_STATUS) {
244 int status = buffer_get_int(&msg);
247 debug("Couldn't stat remote file: %s", fx2txt(status));
249 error("Couldn't stat remote file: %s", fx2txt(status));
252 } else if (type != SSH2_FXP_ATTRS) {
253 fatal("Expected SSH2_FXP_ATTRS(%u) packet, got %u",
254 SSH2_FXP_ATTRS, type);
256 a = decode_attrib(&msg);
263 get_decode_statvfs(int fd, struct sftp_statvfs *st, u_int expected_id,
267 u_int type, id, flag;
272 type = buffer_get_char(&msg);
273 id = buffer_get_int(&msg);
275 debug3("Received statvfs reply T:%u I:%u", type, id);
276 if (id != expected_id)
277 fatal("ID mismatch (%u != %u)", id, expected_id);
278 if (type == SSH2_FXP_STATUS) {
279 int status = buffer_get_int(&msg);
282 debug("Couldn't statvfs: %s", fx2txt(status));
284 error("Couldn't statvfs: %s", fx2txt(status));
287 } else if (type != SSH2_FXP_EXTENDED_REPLY) {
288 fatal("Expected SSH2_FXP_EXTENDED_REPLY(%u) packet, got %u",
289 SSH2_FXP_EXTENDED_REPLY, type);
292 bzero(st, sizeof(*st));
293 st->f_bsize = buffer_get_int64(&msg);
294 st->f_frsize = buffer_get_int64(&msg);
295 st->f_blocks = buffer_get_int64(&msg);
296 st->f_bfree = buffer_get_int64(&msg);
297 st->f_bavail = buffer_get_int64(&msg);
298 st->f_files = buffer_get_int64(&msg);
299 st->f_ffree = buffer_get_int64(&msg);
300 st->f_favail = buffer_get_int64(&msg);
301 st->f_fsid = buffer_get_int64(&msg);
302 flag = buffer_get_int64(&msg);
303 st->f_namemax = buffer_get_int64(&msg);
305 st->f_flag = (flag & SSH2_FXE_STATVFS_ST_RDONLY) ? ST_RDONLY : 0;
306 st->f_flag |= (flag & SSH2_FXE_STATVFS_ST_NOSUID) ? ST_NOSUID : 0;
314 do_init(int fd_in, int fd_out, u_int transfer_buflen, u_int num_requests)
316 u_int type, exts = 0;
319 struct sftp_conn *ret;
322 buffer_put_char(&msg, SSH2_FXP_INIT);
323 buffer_put_int(&msg, SSH2_FILEXFER_VERSION);
324 send_msg(fd_out, &msg);
328 get_msg(fd_in, &msg);
330 /* Expecting a VERSION reply */
331 if ((type = buffer_get_char(&msg)) != SSH2_FXP_VERSION) {
332 error("Invalid packet back from SSH2_FXP_INIT (type %u)",
337 version = buffer_get_int(&msg);
339 debug2("Remote version: %d", version);
341 /* Check for extensions */
342 while (buffer_len(&msg) > 0) {
343 char *name = buffer_get_string(&msg, NULL);
344 char *value = buffer_get_string(&msg, NULL);
347 if (strcmp(name, "posix-rename@openssh.com") == 0 &&
348 strcmp(value, "1") == 0) {
349 exts |= SFTP_EXT_POSIX_RENAME;
351 } else if (strcmp(name, "statvfs@openssh.com") == 0 &&
352 strcmp(value, "2") == 0) {
353 exts |= SFTP_EXT_STATVFS;
355 } if (strcmp(name, "fstatvfs@openssh.com") == 0 &&
356 strcmp(value, "2") == 0) {
357 exts |= SFTP_EXT_FSTATVFS;
361 debug2("Server supports extension \"%s\" revision %s",
364 debug2("Unrecognised server extension \"%s\"", name);
372 ret = xmalloc(sizeof(*ret));
374 ret->fd_out = fd_out;
375 ret->transfer_buflen = transfer_buflen;
376 ret->num_requests = num_requests;
377 ret->version = version;
381 /* Some filexfer v.0 servers don't support large packets */
383 ret->transfer_buflen = MIN(ret->transfer_buflen, 20480);
389 sftp_proto_version(struct sftp_conn *conn)
391 return(conn->version);
395 do_close(struct sftp_conn *conn, char *handle, u_int handle_len)
403 buffer_put_char(&msg, SSH2_FXP_CLOSE);
404 buffer_put_int(&msg, id);
405 buffer_put_string(&msg, handle, handle_len);
406 send_msg(conn->fd_out, &msg);
407 debug3("Sent message SSH2_FXP_CLOSE I:%u", id);
409 status = get_status(conn->fd_in, id);
410 if (status != SSH2_FX_OK)
411 error("Couldn't close file: %s", fx2txt(status));
420 do_lsreaddir(struct sftp_conn *conn, char *path, int printflag,
424 u_int count, type, id, handle_len, i, expected_id, ents = 0;
430 buffer_put_char(&msg, SSH2_FXP_OPENDIR);
431 buffer_put_int(&msg, id);
432 buffer_put_cstring(&msg, path);
433 send_msg(conn->fd_out, &msg);
437 handle = get_handle(conn->fd_in, id, &handle_len,
438 "remote readdir(\"%s\")", path);
444 *dir = xmalloc(sizeof(**dir));
448 for (; !interrupted;) {
449 id = expected_id = conn->msg_id++;
451 debug3("Sending SSH2_FXP_READDIR I:%u", id);
454 buffer_put_char(&msg, SSH2_FXP_READDIR);
455 buffer_put_int(&msg, id);
456 buffer_put_string(&msg, handle, handle_len);
457 send_msg(conn->fd_out, &msg);
461 get_msg(conn->fd_in, &msg);
463 type = buffer_get_char(&msg);
464 id = buffer_get_int(&msg);
466 debug3("Received reply T:%u I:%u", type, id);
468 if (id != expected_id)
469 fatal("ID mismatch (%u != %u)", id, expected_id);
471 if (type == SSH2_FXP_STATUS) {
472 int status = buffer_get_int(&msg);
474 debug3("Received SSH2_FXP_STATUS %d", status);
476 if (status == SSH2_FX_EOF) {
479 error("Couldn't read directory: %s",
481 do_close(conn, handle, handle_len);
485 } else if (type != SSH2_FXP_NAME)
486 fatal("Expected SSH2_FXP_NAME(%u) packet, got %u",
487 SSH2_FXP_NAME, type);
489 count = buffer_get_int(&msg);
492 debug3("Received %d SSH2_FXP_NAME responses", count);
493 for (i = 0; i < count; i++) {
494 char *filename, *longname;
497 filename = buffer_get_string(&msg, NULL);
498 longname = buffer_get_string(&msg, NULL);
499 a = decode_attrib(&msg);
502 printf("%s\n", longname);
505 * Directory entries should never contain '/'
506 * These can be used to attack recursive ops
507 * (e.g. send '../../../../etc/passwd')
509 if (strchr(filename, '/') != NULL) {
510 error("Server sent suspect path \"%s\" "
511 "during readdir of \"%s\"", filename, path);
516 *dir = xrealloc(*dir, ents + 2, sizeof(**dir));
517 (*dir)[ents] = xmalloc(sizeof(***dir));
518 (*dir)[ents]->filename = xstrdup(filename);
519 (*dir)[ents]->longname = xstrdup(longname);
520 memcpy(&(*dir)[ents]->a, a, sizeof(*a));
521 (*dir)[++ents] = NULL;
530 do_close(conn, handle, handle_len);
533 /* Don't return partial matches on interrupt */
534 if (interrupted && dir != NULL && *dir != NULL) {
535 free_sftp_dirents(*dir);
536 *dir = xmalloc(sizeof(**dir));
544 do_readdir(struct sftp_conn *conn, char *path, SFTP_DIRENT ***dir)
546 return(do_lsreaddir(conn, path, 0, dir));
549 void free_sftp_dirents(SFTP_DIRENT **s)
553 for (i = 0; s[i]; i++) {
554 xfree(s[i]->filename);
555 xfree(s[i]->longname);
562 do_rm(struct sftp_conn *conn, char *path)
566 debug2("Sending SSH2_FXP_REMOVE \"%s\"", path);
569 send_string_request(conn->fd_out, id, SSH2_FXP_REMOVE, path,
571 status = get_status(conn->fd_in, id);
572 if (status != SSH2_FX_OK)
573 error("Couldn't delete file: %s", fx2txt(status));
578 do_mkdir(struct sftp_conn *conn, char *path, Attrib *a, int printflag)
583 send_string_attrs_request(conn->fd_out, id, SSH2_FXP_MKDIR, path,
586 status = get_status(conn->fd_in, id);
587 if (status != SSH2_FX_OK && printflag)
588 error("Couldn't create directory: %s", fx2txt(status));
594 do_rmdir(struct sftp_conn *conn, char *path)
599 send_string_request(conn->fd_out, id, SSH2_FXP_RMDIR, path,
602 status = get_status(conn->fd_in, id);
603 if (status != SSH2_FX_OK)
604 error("Couldn't remove directory: %s", fx2txt(status));
610 do_stat(struct sftp_conn *conn, char *path, int quiet)
616 send_string_request(conn->fd_out, id,
617 conn->version == 0 ? SSH2_FXP_STAT_VERSION_0 : SSH2_FXP_STAT,
620 return(get_decode_stat(conn->fd_in, id, quiet));
624 do_lstat(struct sftp_conn *conn, char *path, int quiet)
628 if (conn->version == 0) {
630 debug("Server version does not support lstat operation");
632 logit("Server version does not support lstat operation");
633 return(do_stat(conn, path, quiet));
637 send_string_request(conn->fd_out, id, SSH2_FXP_LSTAT, path,
640 return(get_decode_stat(conn->fd_in, id, quiet));
645 do_fstat(struct sftp_conn *conn, char *handle, u_int handle_len, int quiet)
650 send_string_request(conn->fd_out, id, SSH2_FXP_FSTAT, handle,
653 return(get_decode_stat(conn->fd_in, id, quiet));
658 do_setstat(struct sftp_conn *conn, char *path, Attrib *a)
663 send_string_attrs_request(conn->fd_out, id, SSH2_FXP_SETSTAT, path,
666 status = get_status(conn->fd_in, id);
667 if (status != SSH2_FX_OK)
668 error("Couldn't setstat on \"%s\": %s", path,
675 do_fsetstat(struct sftp_conn *conn, char *handle, u_int handle_len,
681 send_string_attrs_request(conn->fd_out, id, SSH2_FXP_FSETSTAT, handle,
684 status = get_status(conn->fd_in, id);
685 if (status != SSH2_FX_OK)
686 error("Couldn't fsetstat: %s", fx2txt(status));
692 do_realpath(struct sftp_conn *conn, char *path)
695 u_int type, expected_id, count, id;
696 char *filename, *longname;
699 expected_id = id = conn->msg_id++;
700 send_string_request(conn->fd_out, id, SSH2_FXP_REALPATH, path,
705 get_msg(conn->fd_in, &msg);
706 type = buffer_get_char(&msg);
707 id = buffer_get_int(&msg);
709 if (id != expected_id)
710 fatal("ID mismatch (%u != %u)", id, expected_id);
712 if (type == SSH2_FXP_STATUS) {
713 u_int status = buffer_get_int(&msg);
715 error("Couldn't canonicalise: %s", fx2txt(status));
717 } else if (type != SSH2_FXP_NAME)
718 fatal("Expected SSH2_FXP_NAME(%u) packet, got %u",
719 SSH2_FXP_NAME, type);
721 count = buffer_get_int(&msg);
723 fatal("Got multiple names (%d) from SSH_FXP_REALPATH", count);
725 filename = buffer_get_string(&msg, NULL);
726 longname = buffer_get_string(&msg, NULL);
727 a = decode_attrib(&msg);
729 debug3("SSH_FXP_REALPATH %s -> %s", path, filename);
739 do_rename(struct sftp_conn *conn, char *oldpath, char *newpath)
746 /* Send rename request */
748 if ((conn->exts & SFTP_EXT_POSIX_RENAME)) {
749 buffer_put_char(&msg, SSH2_FXP_EXTENDED);
750 buffer_put_int(&msg, id);
751 buffer_put_cstring(&msg, "posix-rename@openssh.com");
753 buffer_put_char(&msg, SSH2_FXP_RENAME);
754 buffer_put_int(&msg, id);
756 buffer_put_cstring(&msg, oldpath);
757 buffer_put_cstring(&msg, newpath);
758 send_msg(conn->fd_out, &msg);
759 debug3("Sent message %s \"%s\" -> \"%s\"",
760 (conn->exts & SFTP_EXT_POSIX_RENAME) ? "posix-rename@openssh.com" :
761 "SSH2_FXP_RENAME", oldpath, newpath);
764 status = get_status(conn->fd_in, id);
765 if (status != SSH2_FX_OK)
766 error("Couldn't rename file \"%s\" to \"%s\": %s", oldpath,
767 newpath, fx2txt(status));
773 do_symlink(struct sftp_conn *conn, char *oldpath, char *newpath)
778 if (conn->version < 3) {
779 error("This server does not support the symlink operation");
780 return(SSH2_FX_OP_UNSUPPORTED);
785 /* Send symlink request */
787 buffer_put_char(&msg, SSH2_FXP_SYMLINK);
788 buffer_put_int(&msg, id);
789 buffer_put_cstring(&msg, oldpath);
790 buffer_put_cstring(&msg, newpath);
791 send_msg(conn->fd_out, &msg);
792 debug3("Sent message SSH2_FXP_SYMLINK \"%s\" -> \"%s\"", oldpath,
796 status = get_status(conn->fd_in, id);
797 if (status != SSH2_FX_OK)
798 error("Couldn't symlink file \"%s\" to \"%s\": %s", oldpath,
799 newpath, fx2txt(status));
806 do_readlink(struct sftp_conn *conn, char *path)
809 u_int type, expected_id, count, id;
810 char *filename, *longname;
813 expected_id = id = conn->msg_id++;
814 send_string_request(conn->fd_out, id, SSH2_FXP_READLINK, path,
819 get_msg(conn->fd_in, &msg);
820 type = buffer_get_char(&msg);
821 id = buffer_get_int(&msg);
823 if (id != expected_id)
824 fatal("ID mismatch (%u != %u)", id, expected_id);
826 if (type == SSH2_FXP_STATUS) {
827 u_int status = buffer_get_int(&msg);
829 error("Couldn't readlink: %s", fx2txt(status));
831 } else if (type != SSH2_FXP_NAME)
832 fatal("Expected SSH2_FXP_NAME(%u) packet, got %u",
833 SSH2_FXP_NAME, type);
835 count = buffer_get_int(&msg);
837 fatal("Got multiple names (%d) from SSH_FXP_READLINK", count);
839 filename = buffer_get_string(&msg, NULL);
840 longname = buffer_get_string(&msg, NULL);
841 a = decode_attrib(&msg);
843 debug3("SSH_FXP_READLINK %s -> %s", path, filename);
854 do_statvfs(struct sftp_conn *conn, const char *path, struct sftp_statvfs *st,
860 if ((conn->exts & SFTP_EXT_STATVFS) == 0) {
861 error("Server does not support statvfs@openssh.com extension");
869 buffer_put_char(&msg, SSH2_FXP_EXTENDED);
870 buffer_put_int(&msg, id);
871 buffer_put_cstring(&msg, "statvfs@openssh.com");
872 buffer_put_cstring(&msg, path);
873 send_msg(conn->fd_out, &msg);
876 return get_decode_statvfs(conn->fd_in, st, id, quiet);
881 do_fstatvfs(struct sftp_conn *conn, const char *handle, u_int handle_len,
882 struct sftp_statvfs *st, int quiet)
887 if ((conn->exts & SFTP_EXT_FSTATVFS) == 0) {
888 error("Server does not support fstatvfs@openssh.com extension");
896 buffer_put_char(&msg, SSH2_FXP_EXTENDED);
897 buffer_put_int(&msg, id);
898 buffer_put_cstring(&msg, "fstatvfs@openssh.com");
899 buffer_put_string(&msg, handle, handle_len);
900 send_msg(conn->fd_out, &msg);
903 return get_decode_statvfs(conn->fd_in, st, id, quiet);
908 send_read_request(int fd_out, u_int id, u_int64_t offset, u_int len,
909 char *handle, u_int handle_len)
915 buffer_put_char(&msg, SSH2_FXP_READ);
916 buffer_put_int(&msg, id);
917 buffer_put_string(&msg, handle, handle_len);
918 buffer_put_int64(&msg, offset);
919 buffer_put_int(&msg, len);
920 send_msg(fd_out, &msg);
925 do_download(struct sftp_conn *conn, char *remote_path, char *local_path,
926 Attrib *a, int pflag)
931 int local_fd, status = 0, write_error;
932 int read_error, write_errno;
933 u_int64_t offset, size;
934 u_int handle_len, mode, type, id, buflen, num_req, max_req;
935 off_t progress_counter;
940 TAILQ_ENTRY(request) tq;
942 TAILQ_HEAD(reqhead, request) requests;
945 TAILQ_INIT(&requests);
947 if (a == NULL && (a = do_stat(conn, remote_path, 0)) == NULL)
950 /* Do not preserve set[ug]id here, as we do not preserve ownership */
951 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
952 mode = a->perm & 0777;
956 if ((a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) &&
957 (!S_ISREG(a->perm))) {
958 error("Cannot download non-regular file: %s", remote_path);
962 if (a->flags & SSH2_FILEXFER_ATTR_SIZE)
967 buflen = conn->transfer_buflen;
970 /* Send open request */
972 buffer_put_char(&msg, SSH2_FXP_OPEN);
973 buffer_put_int(&msg, id);
974 buffer_put_cstring(&msg, remote_path);
975 buffer_put_int(&msg, SSH2_FXF_READ);
976 attrib_clear(&junk); /* Send empty attributes */
977 encode_attrib(&msg, &junk);
978 send_msg(conn->fd_out, &msg);
979 debug3("Sent message SSH2_FXP_OPEN I:%u P:%s", id, remote_path);
981 handle = get_handle(conn->fd_in, id, &handle_len,
982 "remote open(\"%s\")", remote_path);
983 if (handle == NULL) {
988 local_fd = open(local_path, O_WRONLY | O_CREAT | O_TRUNC,
990 if (local_fd == -1) {
991 error("Couldn't open local file \"%s\" for writing: %s",
992 local_path, strerror(errno));
993 do_close(conn, handle, handle_len);
999 /* Read from remote and write to local */
1000 write_error = read_error = write_errno = num_req = offset = 0;
1002 progress_counter = 0;
1004 if (showprogress && size != 0)
1005 start_progress_meter(remote_path, size, &progress_counter);
1007 while (num_req > 0 || max_req > 0) {
1012 * Simulate EOF on interrupt: stop sending new requests and
1013 * allow outstanding requests to drain gracefully
1016 if (num_req == 0) /* If we haven't started yet... */
1021 /* Send some more requests */
1022 while (num_req < max_req) {
1023 debug3("Request range %llu -> %llu (%d/%d)",
1024 (unsigned long long)offset,
1025 (unsigned long long)offset + buflen - 1,
1027 req = xmalloc(sizeof(*req));
1028 req->id = conn->msg_id++;
1030 req->offset = offset;
1033 TAILQ_INSERT_TAIL(&requests, req, tq);
1034 send_read_request(conn->fd_out, req->id, req->offset,
1035 req->len, handle, handle_len);
1039 get_msg(conn->fd_in, &msg);
1040 type = buffer_get_char(&msg);
1041 id = buffer_get_int(&msg);
1042 debug3("Received reply T:%u I:%u R:%d", type, id, max_req);
1044 /* Find the request in our queue */
1045 for (req = TAILQ_FIRST(&requests);
1046 req != NULL && req->id != id;
1047 req = TAILQ_NEXT(req, tq))
1050 fatal("Unexpected reply %u", id);
1053 case SSH2_FXP_STATUS:
1054 status = buffer_get_int(&msg);
1055 if (status != SSH2_FX_EOF)
1058 TAILQ_REMOVE(&requests, req, tq);
1063 data = buffer_get_string(&msg, &len);
1064 debug3("Received data %llu -> %llu",
1065 (unsigned long long)req->offset,
1066 (unsigned long long)req->offset + len - 1);
1068 fatal("Received more data than asked for "
1069 "%u > %u", len, req->len);
1070 if ((lseek(local_fd, req->offset, SEEK_SET) == -1 ||
1071 atomicio(vwrite, local_fd, data, len) != len) &&
1073 write_errno = errno;
1077 progress_counter += len;
1080 if (len == req->len) {
1081 TAILQ_REMOVE(&requests, req, tq);
1085 /* Resend the request for the missing data */
1086 debug3("Short data block, re-requesting "
1087 "%llu -> %llu (%2d)",
1088 (unsigned long long)req->offset + len,
1089 (unsigned long long)req->offset +
1090 req->len - 1, num_req);
1091 req->id = conn->msg_id++;
1094 send_read_request(conn->fd_out, req->id,
1095 req->offset, req->len, handle, handle_len);
1096 /* Reduce the request size */
1098 buflen = MAX(MIN_READ_SIZE, len);
1100 if (max_req > 0) { /* max_req = 0 iff EOF received */
1101 if (size > 0 && offset > size) {
1102 /* Only one request at a time
1103 * after the expected EOF */
1104 debug3("Finish at %llu (%2d)",
1105 (unsigned long long)offset,
1108 } else if (max_req <= conn->num_requests) {
1114 fatal("Expected SSH2_FXP_DATA(%u) packet, got %u",
1115 SSH2_FXP_DATA, type);
1119 if (showprogress && size)
1120 stop_progress_meter();
1123 if (TAILQ_FIRST(&requests) != NULL)
1124 fatal("Transfer complete, but requests still in queue");
1127 error("Couldn't read from remote file \"%s\" : %s",
1128 remote_path, fx2txt(status));
1129 do_close(conn, handle, handle_len);
1130 } else if (write_error) {
1131 error("Couldn't write to \"%s\": %s", local_path,
1132 strerror(write_errno));
1134 do_close(conn, handle, handle_len);
1136 status = do_close(conn, handle, handle_len);
1138 /* Override umask and utimes if asked */
1140 if (pflag && fchmod(local_fd, mode) == -1)
1142 if (pflag && chmod(local_path, mode) == -1)
1143 #endif /* HAVE_FCHMOD */
1144 error("Couldn't set mode on \"%s\": %s", local_path,
1146 if (pflag && (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME)) {
1147 struct timeval tv[2];
1148 tv[0].tv_sec = a->atime;
1149 tv[1].tv_sec = a->mtime;
1150 tv[0].tv_usec = tv[1].tv_usec = 0;
1151 if (utimes(local_path, tv) == -1)
1152 error("Can't set times on \"%s\": %s",
1153 local_path, strerror(errno));
1164 download_dir_internal(struct sftp_conn *conn, char *src, char *dst,
1165 Attrib *dirattrib, int pflag, int printflag, int depth)
1168 SFTP_DIRENT **dir_entries;
1169 char *filename, *new_src, *new_dst;
1172 if (depth >= MAX_DIR_DEPTH) {
1173 error("Maximum directory depth exceeded: %d levels", depth);
1177 if (dirattrib == NULL &&
1178 (dirattrib = do_stat(conn, src, 1)) == NULL) {
1179 error("Unable to stat remote directory \"%s\"", src);
1182 if (!S_ISDIR(dirattrib->perm)) {
1183 error("\"%s\" is not a directory", src);
1187 printf("Retrieving %s\n", src);
1189 if (dirattrib->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
1190 mode = dirattrib->perm & 01777;
1192 debug("Server did not send permissions for "
1193 "directory \"%s\"", dst);
1196 if (mkdir(dst, mode) == -1 && errno != EEXIST) {
1197 error("mkdir %s: %s", dst, strerror(errno));
1201 if (do_readdir(conn, src, &dir_entries) == -1) {
1202 error("%s: Failed to get directory contents", src);
1206 for (i = 0; dir_entries[i] != NULL && !interrupted; i++) {
1207 filename = dir_entries[i]->filename;
1209 new_dst = path_append(dst, filename);
1210 new_src = path_append(src, filename);
1212 if (S_ISDIR(dir_entries[i]->a.perm)) {
1213 if (strcmp(filename, ".") == 0 ||
1214 strcmp(filename, "..") == 0)
1216 if (download_dir_internal(conn, new_src, new_dst,
1217 &(dir_entries[i]->a), pflag, printflag,
1220 } else if (S_ISREG(dir_entries[i]->a.perm) ) {
1221 if (do_download(conn, new_src, new_dst,
1222 &(dir_entries[i]->a), pflag) == -1) {
1223 error("Download of file %s to %s failed",
1228 logit("%s: not a regular file\n", new_src);
1235 if (dirattrib->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
1236 struct timeval tv[2];
1237 tv[0].tv_sec = dirattrib->atime;
1238 tv[1].tv_sec = dirattrib->mtime;
1239 tv[0].tv_usec = tv[1].tv_usec = 0;
1240 if (utimes(dst, tv) == -1)
1241 error("Can't set times on \"%s\": %s",
1242 dst, strerror(errno));
1244 debug("Server did not send times for directory "
1248 free_sftp_dirents(dir_entries);
1254 download_dir(struct sftp_conn *conn, char *src, char *dst,
1255 Attrib *dirattrib, int pflag, int printflag)
1260 if ((src_canon = do_realpath(conn, src)) == NULL) {
1261 error("Unable to canonicalise path \"%s\"", src);
1265 ret = download_dir_internal(conn, src_canon, dst,
1266 dirattrib, pflag, printflag, 0);
1272 do_upload(struct sftp_conn *conn, char *local_path, char *remote_path,
1276 int status = SSH2_FX_OK;
1277 u_int handle_len, id, type;
1279 char *handle, *data;
1285 struct outstanding_ack {
1289 TAILQ_ENTRY(outstanding_ack) tq;
1291 TAILQ_HEAD(ackhead, outstanding_ack) acks;
1292 struct outstanding_ack *ack = NULL;
1296 if ((local_fd = open(local_path, O_RDONLY, 0)) == -1) {
1297 error("Couldn't open local file \"%s\" for reading: %s",
1298 local_path, strerror(errno));
1301 if (fstat(local_fd, &sb) == -1) {
1302 error("Couldn't fstat local file \"%s\": %s",
1303 local_path, strerror(errno));
1307 if (!S_ISREG(sb.st_mode)) {
1308 error("%s is not a regular file", local_path);
1312 stat_to_attrib(&sb, &a);
1314 a.flags &= ~SSH2_FILEXFER_ATTR_SIZE;
1315 a.flags &= ~SSH2_FILEXFER_ATTR_UIDGID;
1318 a.flags &= ~SSH2_FILEXFER_ATTR_ACMODTIME;
1322 /* Send open request */
1323 id = conn->msg_id++;
1324 buffer_put_char(&msg, SSH2_FXP_OPEN);
1325 buffer_put_int(&msg, id);
1326 buffer_put_cstring(&msg, remote_path);
1327 buffer_put_int(&msg, SSH2_FXF_WRITE|SSH2_FXF_CREAT|SSH2_FXF_TRUNC);
1328 encode_attrib(&msg, &a);
1329 send_msg(conn->fd_out, &msg);
1330 debug3("Sent message SSH2_FXP_OPEN I:%u P:%s", id, remote_path);
1334 handle = get_handle(conn->fd_in, id, &handle_len,
1335 "remote open(\"%s\")", remote_path);
1336 if (handle == NULL) {
1342 startid = ackid = id + 1;
1343 data = xmalloc(conn->transfer_buflen);
1345 /* Read from local and write to remote */
1348 start_progress_meter(local_path, sb.st_size, &offset);
1354 * Can't use atomicio here because it returns 0 on EOF,
1355 * thus losing the last block of the file.
1356 * Simulate an EOF on interrupt, allowing ACKs from the
1359 if (interrupted || status != SSH2_FX_OK)
1362 len = read(local_fd, data, conn->transfer_buflen);
1363 while ((len == -1) &&
1364 (errno == EINTR || errno == EAGAIN || errno == EWOULDBLOCK));
1367 fatal("Couldn't read from \"%s\": %s", local_path,
1371 ack = xmalloc(sizeof(*ack));
1373 ack->offset = offset;
1375 TAILQ_INSERT_TAIL(&acks, ack, tq);
1378 buffer_put_char(&msg, SSH2_FXP_WRITE);
1379 buffer_put_int(&msg, ack->id);
1380 buffer_put_string(&msg, handle, handle_len);
1381 buffer_put_int64(&msg, offset);
1382 buffer_put_string(&msg, data, len);
1383 send_msg(conn->fd_out, &msg);
1384 debug3("Sent message SSH2_FXP_WRITE I:%u O:%llu S:%u",
1385 id, (unsigned long long)offset, len);
1386 } else if (TAILQ_FIRST(&acks) == NULL)
1390 fatal("Unexpected ACK %u", id);
1392 if (id == startid || len == 0 ||
1393 id - ackid >= conn->num_requests) {
1397 get_msg(conn->fd_in, &msg);
1398 type = buffer_get_char(&msg);
1399 r_id = buffer_get_int(&msg);
1401 if (type != SSH2_FXP_STATUS)
1402 fatal("Expected SSH2_FXP_STATUS(%d) packet, "
1403 "got %d", SSH2_FXP_STATUS, type);
1405 status = buffer_get_int(&msg);
1406 debug3("SSH2_FXP_STATUS %d", status);
1408 /* Find the request in our queue */
1409 for (ack = TAILQ_FIRST(&acks);
1410 ack != NULL && ack->id != r_id;
1411 ack = TAILQ_NEXT(ack, tq))
1414 fatal("Can't find request for ID %u", r_id);
1415 TAILQ_REMOVE(&acks, ack, tq);
1416 debug3("In write loop, ack for %u %u bytes at %lld",
1417 ack->id, ack->len, (long long)ack->offset);
1423 fatal("%s: offset < 0", __func__);
1428 stop_progress_meter();
1431 if (status != SSH2_FX_OK) {
1432 error("Couldn't write to remote file \"%s\": %s",
1433 remote_path, fx2txt(status));
1437 if (close(local_fd) == -1) {
1438 error("Couldn't close local file \"%s\": %s", local_path,
1443 /* Override umask and utimes if asked */
1445 do_fsetstat(conn, handle, handle_len, &a);
1447 if (do_close(conn, handle, handle_len) != SSH2_FX_OK)
1455 upload_dir_internal(struct sftp_conn *conn, char *src, char *dst,
1456 int pflag, int printflag, int depth)
1458 int ret = 0, status;
1461 char *filename, *new_src, *new_dst;
1465 if (depth >= MAX_DIR_DEPTH) {
1466 error("Maximum directory depth exceeded: %d levels", depth);
1470 if (stat(src, &sb) == -1) {
1471 error("Couldn't stat directory \"%s\": %s",
1472 src, strerror(errno));
1475 if (!S_ISDIR(sb.st_mode)) {
1476 error("\"%s\" is not a directory", src);
1480 printf("Entering %s\n", src);
1483 stat_to_attrib(&sb, &a);
1484 a.flags &= ~SSH2_FILEXFER_ATTR_SIZE;
1485 a.flags &= ~SSH2_FILEXFER_ATTR_UIDGID;
1488 a.flags &= ~SSH2_FILEXFER_ATTR_ACMODTIME;
1490 status = do_mkdir(conn, dst, &a, 0);
1492 * we lack a portable status for errno EEXIST,
1493 * so if we get a SSH2_FX_FAILURE back we must check
1494 * if it was created successfully.
1496 if (status != SSH2_FX_OK) {
1497 if (status != SSH2_FX_FAILURE)
1499 if (do_stat(conn, dst, 0) == NULL)
1503 if ((dirp = opendir(src)) == NULL) {
1504 error("Failed to open dir \"%s\": %s", src, strerror(errno));
1508 while (((dp = readdir(dirp)) != NULL) && !interrupted) {
1511 filename = dp->d_name;
1512 new_dst = path_append(dst, filename);
1513 new_src = path_append(src, filename);
1515 if (lstat(new_src, &sb) == -1) {
1516 logit("%s: lstat failed: %s", filename,
1519 } else if (S_ISDIR(sb.st_mode)) {
1520 if (strcmp(filename, ".") == 0 ||
1521 strcmp(filename, "..") == 0)
1524 if (upload_dir_internal(conn, new_src, new_dst,
1525 pflag, depth + 1, printflag) == -1)
1527 } else if (S_ISREG(sb.st_mode)) {
1528 if (do_upload(conn, new_src, new_dst, pflag) == -1) {
1529 error("Uploading of file %s to %s failed!",
1534 logit("%s: not a regular file\n", filename);
1539 do_setstat(conn, dst, &a);
1541 (void) closedir(dirp);
1546 upload_dir(struct sftp_conn *conn, char *src, char *dst, int printflag,
1552 if ((dst_canon = do_realpath(conn, dst)) == NULL) {
1553 error("Unable to canonicalise path \"%s\"", dst);
1557 ret = upload_dir_internal(conn, src, dst_canon, pflag, printflag, 0);
1563 path_append(char *p1, char *p2)
1566 size_t len = strlen(p1) + strlen(p2) + 2;
1569 strlcpy(ret, p1, len);
1570 if (p1[0] != '\0' && p1[strlen(p1) - 1] != '/')
1571 strlcat(ret, "/", len);
1572 strlcat(ret, p2, len);