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: signed vs unsigned */
27 /* XXX: redesign to allow concurrent overlapped operations */
28 /* XXX: we use fatal too much, error may be more appropriate in places */
29 /* XXX: copy between two remote sites */
32 RCSID("$OpenBSD: sftp-client.c,v 1.4 2001/02/06 23:30:28 djm Exp $");
41 #include "pathnames.h"
44 #include "sftp-common.h"
45 #include "sftp-client.h"
47 /* How much data to read/write at at time during copies */
48 /* XXX: what should this be? */
49 #define COPY_SIZE 8192
52 static u_int msg_id = 1;
55 send_msg(int fd, Buffer *m)
57 int mlen = buffer_len(m);
62 buffer_put_int(&oqueue, mlen);
63 buffer_append(&oqueue, buffer_ptr(m), mlen);
64 buffer_consume(m, mlen);
66 len = atomicio(write, fd, buffer_ptr(&oqueue), buffer_len(&oqueue));
68 fatal("Couldn't send packet: %s", strerror(errno));
74 get_msg(int fd, Buffer *m)
77 unsigned char buf[4096];
79 len = atomicio(read, fd, buf, 4);
81 fatal("Couldn't read packet: %s", strerror(errno));
83 msg_len = GET_32BIT(buf);
84 if (msg_len > 256 * 1024)
85 fatal("Received message too long %d", msg_len);
88 len = atomicio(read, fd, buf, MIN(msg_len, sizeof(buf)));
90 fatal("Couldn't read packet: %s", strerror(errno));
93 buffer_append(m, buf, len);
98 send_string_request(int fd, u_int id, u_int code, char *s,
104 buffer_put_char(&msg, code);
105 buffer_put_int(&msg, id);
106 buffer_put_string(&msg, s, len);
108 debug3("Sent message fd %d T:%d I:%d", fd, code, id);
113 send_string_attrs_request(int fd, u_int id, u_int code, char *s,
114 u_int len, Attrib *a)
119 buffer_put_char(&msg, code);
120 buffer_put_int(&msg, id);
121 buffer_put_string(&msg, s, len);
122 encode_attrib(&msg, a);
124 debug3("Sent message fd %d T:%d I:%d", fd, code, id);
129 get_status(int fd, int expected_id)
132 u_int type, id, status;
136 type = buffer_get_char(&msg);
137 id = buffer_get_int(&msg);
139 if (id != expected_id)
140 fatal("ID mismatch (%d != %d)", id, expected_id);
141 if (type != SSH2_FXP_STATUS)
142 fatal("Expected SSH2_FXP_STATUS(%d) packet, got %d",
143 SSH2_FXP_STATUS, type);
145 status = buffer_get_int(&msg);
148 debug3("SSH2_FXP_STATUS %d", status);
154 get_handle(int fd, u_int expected_id, u_int *len)
162 type = buffer_get_char(&msg);
163 id = buffer_get_int(&msg);
165 if (id != expected_id)
166 fatal("ID mismatch (%d != %d)", id, expected_id);
167 if (type == SSH2_FXP_STATUS) {
168 int status = buffer_get_int(&msg);
170 error("Couldn't get handle: %s", fx2txt(status));
172 } else if (type != SSH2_FXP_HANDLE)
173 fatal("Expected SSH2_FXP_HANDLE(%d) packet, got %d",
174 SSH2_FXP_HANDLE, type);
176 handle = buffer_get_string(&msg, len);
183 get_decode_stat(int fd, u_int expected_id)
192 type = buffer_get_char(&msg);
193 id = buffer_get_int(&msg);
195 debug3("Received stat reply T:%d I:%d", type, id);
196 if (id != expected_id)
197 fatal("ID mismatch (%d != %d)", id, expected_id);
198 if (type == SSH2_FXP_STATUS) {
199 int status = buffer_get_int(&msg);
201 error("Couldn't stat remote file: %s", fx2txt(status));
203 } else if (type != SSH2_FXP_ATTRS) {
204 fatal("Expected SSH2_FXP_ATTRS(%d) packet, got %d",
205 SSH2_FXP_ATTRS, type);
207 a = decode_attrib(&msg);
214 do_init(int fd_in, int fd_out)
220 buffer_put_char(&msg, SSH2_FXP_INIT);
221 buffer_put_int(&msg, SSH2_FILEXFER_VERSION);
222 send_msg(fd_out, &msg);
226 get_msg(fd_in, &msg);
228 /* Expecting a VERSION reply */
229 if ((type = buffer_get_char(&msg)) != SSH2_FXP_VERSION) {
230 error("Invalid packet back from SSH2_FXP_INIT (type %d)",
235 version = buffer_get_int(&msg);
237 debug2("Remote version: %d", version);
239 /* Check for extensions */
240 while (buffer_len(&msg) > 0) {
241 char *name = buffer_get_string(&msg, NULL);
242 char *value = buffer_get_string(&msg, NULL);
244 debug2("Init extension: \"%s\"", name);
254 do_close(int fd_in, int fd_out, char *handle, u_int handle_len)
262 buffer_put_char(&msg, SSH2_FXP_CLOSE);
263 buffer_put_int(&msg, id);
264 buffer_put_string(&msg, handle, handle_len);
265 send_msg(fd_out, &msg);
266 debug3("Sent message SSH2_FXP_CLOSE I:%d", id);
268 status = get_status(fd_in, id);
269 if (status != SSH2_FX_OK)
270 error("Couldn't close file: %s", fx2txt(status));
278 do_ls(int fd_in, int fd_out, char *path)
281 u_int type, id, handle_len, i, expected_id;
287 buffer_put_char(&msg, SSH2_FXP_OPENDIR);
288 buffer_put_int(&msg, id);
289 buffer_put_cstring(&msg, path);
290 send_msg(fd_out, &msg);
294 handle = get_handle(fd_in, id, &handle_len);
301 id = expected_id = msg_id++;
303 debug3("Sending SSH2_FXP_READDIR I:%d", id);
306 buffer_put_char(&msg, SSH2_FXP_READDIR);
307 buffer_put_int(&msg, id);
308 buffer_put_string(&msg, handle, handle_len);
309 send_msg(fd_out, &msg);
313 get_msg(fd_in, &msg);
315 type = buffer_get_char(&msg);
316 id = buffer_get_int(&msg);
318 debug3("Received reply T:%d I:%d", type, id);
320 if (id != expected_id)
321 fatal("ID mismatch (%d != %d)", id, expected_id);
323 if (type == SSH2_FXP_STATUS) {
324 int status = buffer_get_int(&msg);
326 debug3("Received SSH2_FXP_STATUS %d", status);
328 if (status == SSH2_FX_EOF) {
331 error("Couldn't read directory: %s",
333 do_close(fd_in, fd_out, handle, handle_len);
336 } else if (type != SSH2_FXP_NAME)
337 fatal("Expected SSH2_FXP_NAME(%d) packet, got %d",
338 SSH2_FXP_NAME, type);
340 count = buffer_get_int(&msg);
341 debug3("Received %i SSH2_FXP_NAME responses", count);
342 for(i = 0; i < count; i++) {
343 char *filename, *longname;
346 filename = buffer_get_string(&msg, NULL);
347 longname = buffer_get_string(&msg, NULL);
348 a = decode_attrib(&msg);
350 printf("%s\n", longname);
358 do_close(fd_in, fd_out, handle, handle_len);
365 do_rm(int fd_in, int fd_out, char *path)
369 debug2("Sending SSH2_FXP_REMOVE \"%s\"", path);
372 send_string_request(fd_out, id, SSH2_FXP_REMOVE, path, strlen(path));
373 status = get_status(fd_in, id);
374 if (status != SSH2_FX_OK)
375 error("Couldn't delete file: %s", fx2txt(status));
380 do_mkdir(int fd_in, int fd_out, char *path, Attrib *a)
385 send_string_attrs_request(fd_out, id, SSH2_FXP_MKDIR, path,
388 status = get_status(fd_in, id);
389 if (status != SSH2_FX_OK)
390 error("Couldn't create directory: %s", fx2txt(status));
396 do_rmdir(int fd_in, int fd_out, char *path)
401 send_string_request(fd_out, id, SSH2_FXP_RMDIR, path, strlen(path));
403 status = get_status(fd_in, id);
404 if (status != SSH2_FX_OK)
405 error("Couldn't remove directory: %s", fx2txt(status));
411 do_stat(int fd_in, int fd_out, char *path)
416 send_string_request(fd_out, id, SSH2_FXP_STAT, path, strlen(path));
417 return(get_decode_stat(fd_in, id));
421 do_lstat(int fd_in, int fd_out, char *path)
426 send_string_request(fd_out, id, SSH2_FXP_LSTAT, path, strlen(path));
427 return(get_decode_stat(fd_in, id));
431 do_fstat(int fd_in, int fd_out, char *handle,
437 send_string_request(fd_out, id, SSH2_FXP_FSTAT, handle, handle_len);
438 return(get_decode_stat(fd_in, id));
442 do_setstat(int fd_in, int fd_out, char *path, Attrib *a)
447 send_string_attrs_request(fd_out, id, SSH2_FXP_SETSTAT, path,
450 status = get_status(fd_in, id);
451 if (status != SSH2_FX_OK)
452 error("Couldn't setstat on \"%s\": %s", path,
459 do_fsetstat(int fd_in, int fd_out, char *handle, u_int handle_len,
465 send_string_attrs_request(fd_out, id, SSH2_FXP_FSETSTAT, handle,
468 status = get_status(fd_in, id);
469 if (status != SSH2_FX_OK)
470 error("Couldn't fsetstat: %s", fx2txt(status));
476 do_realpath(int fd_in, int fd_out, char *path)
479 u_int type, expected_id, count, id;
480 char *filename, *longname;
483 expected_id = id = msg_id++;
484 send_string_request(fd_out, id, SSH2_FXP_REALPATH, path,
489 get_msg(fd_in, &msg);
490 type = buffer_get_char(&msg);
491 id = buffer_get_int(&msg);
493 if (id != expected_id)
494 fatal("ID mismatch (%d != %d)", id, expected_id);
496 if (type == SSH2_FXP_STATUS) {
497 u_int status = buffer_get_int(&msg);
499 error("Couldn't canonicalise: %s", fx2txt(status));
501 } else if (type != SSH2_FXP_NAME)
502 fatal("Expected SSH2_FXP_NAME(%d) packet, got %d",
503 SSH2_FXP_NAME, type);
505 count = buffer_get_int(&msg);
507 fatal("Got multiple names (%d) from SSH_FXP_REALPATH", count);
509 filename = buffer_get_string(&msg, NULL);
510 longname = buffer_get_string(&msg, NULL);
511 a = decode_attrib(&msg);
513 debug3("SSH_FXP_REALPATH %s -> %s", path, filename);
523 do_rename(int fd_in, int fd_out, char *oldpath, char *newpath)
530 /* Send rename request */
532 buffer_put_char(&msg, SSH2_FXP_RENAME);
533 buffer_put_int(&msg, id);
534 buffer_put_cstring(&msg, oldpath);
535 buffer_put_cstring(&msg, newpath);
536 send_msg(fd_out, &msg);
537 debug3("Sent message SSH2_FXP_RENAME \"%s\" -> \"%s\"", oldpath,
541 status = get_status(fd_in, id);
542 if (status != SSH2_FX_OK)
543 error("Couldn't rename file \"%s\" to \"%s\": %s", oldpath, newpath,
550 do_download(int fd_in, int fd_out, char *remote_path, char *local_path,
554 u_int expected_id, handle_len, mode, type, id;
560 a = do_stat(fd_in, fd_out, remote_path);
564 /* XXX: should we preserve set[ug]id? */
565 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
566 mode = S_IWRITE | (a->perm & 0777);
570 local_fd = open(local_path, O_WRONLY | O_CREAT | O_TRUNC, mode);
571 if (local_fd == -1) {
572 error("Couldn't open local file \"%s\" for writing: %s",
573 local_path, strerror(errno));
577 /* Override umask and utimes if asked */
578 if (pflag && fchmod(local_fd, mode) == -1)
579 error("Couldn't set mode on \"%s\": %s", local_path,
581 if (pflag && (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME)) {
584 tv.tv_sec = a->atime;
585 tv.tv_usec = a->mtime;
586 if (utimes(local_path, &tv) == -1)
587 error("Can't set times on \"%s\": %s", local_path,
593 /* Send open request */
595 buffer_put_char(&msg, SSH2_FXP_OPEN);
596 buffer_put_int(&msg, id);
597 buffer_put_cstring(&msg, remote_path);
598 buffer_put_int(&msg, SSH2_FXF_READ);
599 attrib_clear(&junk); /* Send empty attributes */
600 encode_attrib(&msg, &junk);
601 send_msg(fd_out, &msg);
602 debug3("Sent message SSH2_FXP_OPEN I:%d P:%s", id, remote_path);
604 handle = get_handle(fd_in, id, &handle_len);
605 if (handle == NULL) {
611 /* Read from remote and write to local */
617 id = expected_id = msg_id++;
620 buffer_put_char(&msg, SSH2_FXP_READ);
621 buffer_put_int(&msg, id);
622 buffer_put_string(&msg, handle, handle_len);
623 buffer_put_int64(&msg, offset);
624 buffer_put_int(&msg, COPY_SIZE);
625 send_msg(fd_out, &msg);
626 debug3("Sent message SSH2_FXP_READ I:%d O:%llu S:%u",
627 id, (unsigned long long)offset, COPY_SIZE);
631 get_msg(fd_in, &msg);
632 type = buffer_get_char(&msg);
633 id = buffer_get_int(&msg);
634 debug3("Received reply T:%d I:%d", type, id);
635 if (id != expected_id)
636 fatal("ID mismatch (%d != %d)", id, expected_id);
637 if (type == SSH2_FXP_STATUS) {
638 int status = buffer_get_int(&msg);
640 if (status == SSH2_FX_EOF)
643 error("Couldn't read from remote "
644 "file \"%s\" : %s", remote_path,
646 do_close(fd_in, fd_out, handle, handle_len);
652 } else if (type != SSH2_FXP_DATA) {
653 fatal("Expected SSH2_FXP_DATA(%d) packet, got %d",
654 SSH2_FXP_DATA, type);
657 data = buffer_get_string(&msg, &len);
659 fatal("Received more data than asked for %d > %d",
662 debug3("In read loop, got %d offset %lld", len,
663 (unsigned long long)offset);
664 if (atomicio(write, local_fd, data, len) != len) {
665 error("Couldn't write to \"%s\": %s", local_path,
667 do_close(fd_in, fd_out, handle, handle_len);
682 return(do_close(fd_in, fd_out, handle, handle_len));
686 do_upload(int fd_in, int fd_out, char *local_path, char *remote_path,
690 u_int handle_len, id;
697 if ((local_fd = open(local_path, O_RDONLY, 0)) == -1) {
698 error("Couldn't open local file \"%s\" for reading: %s",
699 local_path, strerror(errno));
702 if (fstat(local_fd, &sb) == -1) {
703 error("Couldn't fstat local file \"%s\": %s",
704 local_path, strerror(errno));
708 stat_to_attrib(&sb, &a);
710 a.flags &= ~SSH2_FILEXFER_ATTR_SIZE;
711 a.flags &= ~SSH2_FILEXFER_ATTR_UIDGID;
714 a.flags &= ~SSH2_FILEXFER_ATTR_ACMODTIME;
718 /* Send open request */
720 buffer_put_char(&msg, SSH2_FXP_OPEN);
721 buffer_put_int(&msg, id);
722 buffer_put_cstring(&msg, remote_path);
723 buffer_put_int(&msg, SSH2_FXF_WRITE|SSH2_FXF_CREAT|SSH2_FXF_TRUNC);
724 encode_attrib(&msg, &a);
725 send_msg(fd_out, &msg);
726 debug3("Sent message SSH2_FXP_OPEN I:%d P:%s", id, remote_path);
730 handle = get_handle(fd_in, id, &handle_len);
731 if (handle == NULL) {
737 /* Override umask and utimes if asked */
739 do_fsetstat(fd_in, fd_out, handle, handle_len, &a);
741 /* Read from local and write to remote */
745 char data[COPY_SIZE];
749 * Can't use atomicio here because it returns 0 on EOF, thus losing
750 * the last block of the file
753 len = read(local_fd, data, COPY_SIZE);
754 while ((len == -1) && (errno == EINTR || errno == EAGAIN));
757 fatal("Couldn't read from \"%s\": %s", local_path,
763 buffer_put_char(&msg, SSH2_FXP_WRITE);
764 buffer_put_int(&msg, ++id);
765 buffer_put_string(&msg, handle, handle_len);
766 buffer_put_int64(&msg, offset);
767 buffer_put_string(&msg, data, len);
768 send_msg(fd_out, &msg);
769 debug3("Sent message SSH2_FXP_WRITE I:%d O:%llu S:%u",
770 id, (unsigned long long)offset, len);
772 status = get_status(fd_in, id);
773 if (status != SSH2_FX_OK) {
774 error("Couldn't write to remote file \"%s\": %s",
775 remote_path, fx2txt(status));
776 do_close(fd_in, fd_out, handle, handle_len);
781 debug3("In write loop, got %d offset %llu", len,
782 (unsigned long long)offset);
789 if (close(local_fd) == -1) {
790 error("Couldn't close local file \"%s\": %s", local_path,
792 do_close(fd_in, fd_out, handle, handle_len);
796 return(do_close(fd_in, fd_out, handle, handle_len));