2 * sftp.c: SFTP generic client code.
18 unsigned length, maxlen;
23 static const char *fxp_error_message;
24 static int fxp_errtype;
26 static void fxp_internal_error(char *msg);
28 /* ----------------------------------------------------------------------
29 * SFTP packet construction functions.
31 static void sftp_pkt_ensure(struct sftp_packet *pkt, int length)
33 if ((int)pkt->maxlen < length) {
34 pkt->maxlen = length + 256;
35 pkt->data = sresize(pkt->data, pkt->maxlen, char);
38 static void sftp_pkt_adddata(struct sftp_packet *pkt, void *data, int len)
41 sftp_pkt_ensure(pkt, pkt->length);
42 memcpy(pkt->data + pkt->length - len, data, len);
44 static void sftp_pkt_addbyte(struct sftp_packet *pkt, unsigned char byte)
46 sftp_pkt_adddata(pkt, &byte, 1);
48 static void sftp_pkt_adduint32(struct sftp_packet *pkt,
53 sftp_pkt_adddata(pkt, x, 4);
55 static struct sftp_packet *sftp_pkt_init(int pkt_type)
57 struct sftp_packet *pkt;
58 pkt = snew(struct sftp_packet);
63 sftp_pkt_adduint32(pkt, 0); /* length field will be filled in later */
64 sftp_pkt_addbyte(pkt, (unsigned char) pkt_type);
68 static void sftp_pkt_addbool(struct sftp_packet *pkt, unsigned char value)
70 sftp_pkt_adddata(pkt, &value, 1);
73 static void sftp_pkt_adduint64(struct sftp_packet *pkt, uint64 value)
76 PUT_32BIT(x, value.hi);
77 PUT_32BIT(x + 4, value.lo);
78 sftp_pkt_adddata(pkt, x, 8);
80 static void sftp_pkt_addstring_start(struct sftp_packet *pkt)
82 sftp_pkt_adduint32(pkt, 0);
83 pkt->savedpos = pkt->length;
85 static void sftp_pkt_addstring_str(struct sftp_packet *pkt, char *data)
87 sftp_pkt_adddata(pkt, data, strlen(data));
88 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
90 static void sftp_pkt_addstring_data(struct sftp_packet *pkt,
93 sftp_pkt_adddata(pkt, data, len);
94 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
96 static void sftp_pkt_addstring(struct sftp_packet *pkt, char *data)
98 sftp_pkt_addstring_start(pkt);
99 sftp_pkt_addstring_str(pkt, data);
101 static void sftp_pkt_addattrs(struct sftp_packet *pkt, struct fxp_attrs attrs)
103 sftp_pkt_adduint32(pkt, attrs.flags);
104 if (attrs.flags & SSH_FILEXFER_ATTR_SIZE) {
105 sftp_pkt_adduint32(pkt, attrs.size.hi);
106 sftp_pkt_adduint32(pkt, attrs.size.lo);
108 if (attrs.flags & SSH_FILEXFER_ATTR_UIDGID) {
109 sftp_pkt_adduint32(pkt, attrs.uid);
110 sftp_pkt_adduint32(pkt, attrs.gid);
112 if (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
113 sftp_pkt_adduint32(pkt, attrs.permissions);
115 if (attrs.flags & SSH_FILEXFER_ATTR_ACMODTIME) {
116 sftp_pkt_adduint32(pkt, attrs.atime);
117 sftp_pkt_adduint32(pkt, attrs.mtime);
119 if (attrs.flags & SSH_FILEXFER_ATTR_EXTENDED) {
121 * We currently don't support sending any extended
127 /* ----------------------------------------------------------------------
128 * SFTP packet decode functions.
131 static int sftp_pkt_getbyte(struct sftp_packet *pkt, unsigned char *ret)
133 if (pkt->length - pkt->savedpos < 1)
135 *ret = (unsigned char) pkt->data[pkt->savedpos];
139 static int sftp_pkt_getuint32(struct sftp_packet *pkt, unsigned long *ret)
141 if (pkt->length - pkt->savedpos < 4)
143 *ret = GET_32BIT(pkt->data + pkt->savedpos);
147 static int sftp_pkt_getstring(struct sftp_packet *pkt,
148 char **p, int *length)
151 if (pkt->length - pkt->savedpos < 4)
153 *length = GET_32BIT(pkt->data + pkt->savedpos);
155 if ((int)(pkt->length - pkt->savedpos) < *length || *length < 0) {
159 *p = pkt->data + pkt->savedpos;
160 pkt->savedpos += *length;
163 static int sftp_pkt_getattrs(struct sftp_packet *pkt, struct fxp_attrs *ret)
165 if (!sftp_pkt_getuint32(pkt, &ret->flags))
167 if (ret->flags & SSH_FILEXFER_ATTR_SIZE) {
168 unsigned long hi, lo;
169 if (!sftp_pkt_getuint32(pkt, &hi) ||
170 !sftp_pkt_getuint32(pkt, &lo))
172 ret->size = uint64_make(hi, lo);
174 if (ret->flags & SSH_FILEXFER_ATTR_UIDGID) {
175 if (!sftp_pkt_getuint32(pkt, &ret->uid) ||
176 !sftp_pkt_getuint32(pkt, &ret->gid))
179 if (ret->flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
180 if (!sftp_pkt_getuint32(pkt, &ret->permissions))
183 if (ret->flags & SSH_FILEXFER_ATTR_ACMODTIME) {
184 if (!sftp_pkt_getuint32(pkt, &ret->atime) ||
185 !sftp_pkt_getuint32(pkt, &ret->mtime))
188 if (ret->flags & SSH_FILEXFER_ATTR_EXTENDED) {
190 if (!sftp_pkt_getuint32(pkt, &count))
196 * We should try to analyse these, if we ever find one
199 if (!sftp_pkt_getstring(pkt, &str, &len) ||
200 !sftp_pkt_getstring(pkt, &str, &len))
206 static void sftp_pkt_free(struct sftp_packet *pkt)
213 /* ----------------------------------------------------------------------
214 * Send and receive packet functions.
216 int sftp_send(struct sftp_packet *pkt)
219 PUT_32BIT(pkt->data, pkt->length - 4);
220 ret = sftp_senddata(pkt->data, pkt->length);
224 struct sftp_packet *sftp_recv(void)
226 struct sftp_packet *pkt;
230 if (!sftp_recvdata(x, 4))
233 pkt = snew(struct sftp_packet);
235 pkt->length = pkt->maxlen = GET_32BIT(x);
236 pkt->data = snewn(pkt->length, char);
238 if (!sftp_recvdata(pkt->data, pkt->length)) {
243 if (!sftp_pkt_getbyte(pkt, &uc)) {
253 /* ----------------------------------------------------------------------
254 * Request ID allocation and temporary dispatch routines.
257 #define REQUEST_ID_OFFSET 256
259 struct sftp_request {
265 static int sftp_reqcmp(void *av, void *bv)
267 struct sftp_request *a = (struct sftp_request *)av;
268 struct sftp_request *b = (struct sftp_request *)bv;
275 static int sftp_reqfind(void *av, void *bv)
277 unsigned *a = (unsigned *) av;
278 struct sftp_request *b = (struct sftp_request *)bv;
286 static tree234 *sftp_requests;
288 static struct sftp_request *sftp_alloc_request(void)
290 unsigned low, high, mid;
292 struct sftp_request *r;
294 if (sftp_requests == NULL)
295 sftp_requests = newtree234(sftp_reqcmp);
298 * First-fit allocation of request IDs: always pick the lowest
299 * unused one. To do this, binary-search using the counted
300 * B-tree to find the largest ID which is in a contiguous
301 * sequence from the beginning. (Precisely everything in that
302 * sequence must have ID equal to its tree index plus
303 * REQUEST_ID_OFFSET.)
305 tsize = count234(sftp_requests);
309 while (high - low > 1) {
310 mid = (high + low) / 2;
311 r = index234(sftp_requests, mid);
312 if (r->id == mid + REQUEST_ID_OFFSET)
313 low = mid; /* this one is fine */
315 high = mid; /* this one is past it */
318 * Now low points to either -1, or the tree index of the
319 * largest ID in the initial sequence.
322 unsigned i = low + 1 + REQUEST_ID_OFFSET;
323 assert(NULL == find234(sftp_requests, &i, sftp_reqfind));
327 * So the request ID we need to create is
328 * low + 1 + REQUEST_ID_OFFSET.
330 r = snew(struct sftp_request);
331 r->id = low + 1 + REQUEST_ID_OFFSET;
334 add234(sftp_requests, r);
338 void sftp_cleanup_request(void)
340 if (sftp_requests != NULL) {
341 freetree234(sftp_requests);
342 sftp_requests = NULL;
346 void sftp_register(struct sftp_request *req)
351 struct sftp_request *sftp_find_request(struct sftp_packet *pktin)
354 struct sftp_request *req;
357 fxp_internal_error("did not receive a valid SFTP packet\n");
361 if (!sftp_pkt_getuint32(pktin, &id)) {
362 fxp_internal_error("did not receive a valid SFTP packet\n");
365 req = find234(sftp_requests, &id, sftp_reqfind);
367 if (!req || !req->registered) {
368 fxp_internal_error("request ID mismatch\n");
369 sftp_pkt_free(pktin);
373 del234(sftp_requests, req);
378 /* ----------------------------------------------------------------------
379 * String handling routines.
382 static char *mkstr(char *s, int len)
384 char *p = snewn(len + 1, char);
390 /* ----------------------------------------------------------------------
395 * Deal with (and free) an FXP_STATUS packet. Return 1 if
396 * SSH_FX_OK, 0 if SSH_FX_EOF, and -1 for anything else (error).
397 * Also place the status into fxp_errtype.
399 static int fxp_got_status(struct sftp_packet *pktin)
401 static const char *const messages[] = {
402 /* SSH_FX_OK. The only time we will display a _message_ for this
403 * is if we were expecting something other than FXP_STATUS on
404 * success, so this is actually an error message! */
405 "unexpected OK response",
407 "no such file or directory",
413 "operation unsupported",
416 if (pktin->type != SSH_FXP_STATUS) {
417 fxp_error_message = "expected FXP_STATUS packet";
421 if (!sftp_pkt_getuint32(pktin, &ul)) {
422 fxp_error_message = "malformed FXP_STATUS packet";
426 if (fxp_errtype < 0 ||
427 fxp_errtype >= sizeof(messages) / sizeof(*messages))
428 fxp_error_message = "unknown error code";
430 fxp_error_message = messages[fxp_errtype];
434 if (fxp_errtype == SSH_FX_OK)
436 else if (fxp_errtype == SSH_FX_EOF)
442 static void fxp_internal_error(char *msg)
444 fxp_error_message = msg;
448 const char *fxp_error(void)
450 return fxp_error_message;
453 int fxp_error_type(void)
459 * Perform exchange of init/version packets. Return 0 on failure.
463 struct sftp_packet *pktout, *pktin;
464 unsigned long remotever;
466 pktout = sftp_pkt_init(SSH_FXP_INIT);
467 sftp_pkt_adduint32(pktout, SFTP_PROTO_VERSION);
472 fxp_internal_error("could not connect");
475 if (pktin->type != SSH_FXP_VERSION) {
476 fxp_internal_error("did not receive FXP_VERSION");
477 sftp_pkt_free(pktin);
480 if (!sftp_pkt_getuint32(pktin, &remotever)) {
481 fxp_internal_error("malformed FXP_VERSION packet");
482 sftp_pkt_free(pktin);
485 if (remotever > SFTP_PROTO_VERSION) {
487 ("remote protocol is more advanced than we support");
488 sftp_pkt_free(pktin);
492 * In principle, this packet might also contain extension-
493 * string pairs. We should work through them and look for any
494 * we recognise. In practice we don't currently do so because
495 * we know we don't recognise _any_.
497 sftp_pkt_free(pktin);
503 * Canonify a pathname.
505 struct sftp_request *fxp_realpath_send(char *path)
507 struct sftp_request *req = sftp_alloc_request();
508 struct sftp_packet *pktout;
510 pktout = sftp_pkt_init(SSH_FXP_REALPATH);
511 sftp_pkt_adduint32(pktout, req->id);
512 sftp_pkt_addstring_start(pktout);
513 sftp_pkt_addstring_str(pktout, path);
519 char *fxp_realpath_recv(struct sftp_packet *pktin, struct sftp_request *req)
523 if (pktin->type == SSH_FXP_NAME) {
528 if (!sftp_pkt_getuint32(pktin, &count) || count != 1) {
529 fxp_internal_error("REALPATH did not return name count of 1\n");
530 sftp_pkt_free(pktin);
533 if (!sftp_pkt_getstring(pktin, &path, &len)) {
534 fxp_internal_error("REALPATH returned malformed FXP_NAME\n");
535 sftp_pkt_free(pktin);
538 path = mkstr(path, len);
539 sftp_pkt_free(pktin);
542 fxp_got_status(pktin);
543 sftp_pkt_free(pktin);
551 struct sftp_request *fxp_open_send(char *path, int type,
552 struct fxp_attrs *attrs)
554 struct sftp_request *req = sftp_alloc_request();
555 struct sftp_packet *pktout;
557 pktout = sftp_pkt_init(SSH_FXP_OPEN);
558 sftp_pkt_adduint32(pktout, req->id);
559 sftp_pkt_addstring(pktout, path);
560 sftp_pkt_adduint32(pktout, type);
562 sftp_pkt_addattrs(pktout, *attrs);
564 sftp_pkt_adduint32(pktout, 0); /* empty ATTRS structure */
570 struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
571 struct sftp_request *req)
575 if (pktin->type == SSH_FXP_HANDLE) {
577 struct fxp_handle *handle;
580 if (!sftp_pkt_getstring(pktin, &hstring, &len)) {
581 fxp_internal_error("OPEN returned malformed FXP_HANDLE\n");
582 sftp_pkt_free(pktin);
585 handle = snew(struct fxp_handle);
586 handle->hstring = mkstr(hstring, len);
588 sftp_pkt_free(pktin);
591 fxp_got_status(pktin);
592 sftp_pkt_free(pktin);
600 struct sftp_request *fxp_opendir_send(char *path)
602 struct sftp_request *req = sftp_alloc_request();
603 struct sftp_packet *pktout;
605 pktout = sftp_pkt_init(SSH_FXP_OPENDIR);
606 sftp_pkt_adduint32(pktout, req->id);
607 sftp_pkt_addstring(pktout, path);
613 struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
614 struct sftp_request *req)
617 if (pktin->type == SSH_FXP_HANDLE) {
619 struct fxp_handle *handle;
622 if (!sftp_pkt_getstring(pktin, &hstring, &len)) {
623 fxp_internal_error("OPENDIR returned malformed FXP_HANDLE\n");
624 sftp_pkt_free(pktin);
627 handle = snew(struct fxp_handle);
628 handle->hstring = mkstr(hstring, len);
630 sftp_pkt_free(pktin);
633 fxp_got_status(pktin);
634 sftp_pkt_free(pktin);
642 struct sftp_request *fxp_close_send(struct fxp_handle *handle)
644 struct sftp_request *req = sftp_alloc_request();
645 struct sftp_packet *pktout;
647 pktout = sftp_pkt_init(SSH_FXP_CLOSE);
648 sftp_pkt_adduint32(pktout, req->id);
649 sftp_pkt_addstring_start(pktout);
650 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
653 sfree(handle->hstring);
659 void fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req)
662 fxp_got_status(pktin);
663 sftp_pkt_free(pktin);
666 struct sftp_request *fxp_mkdir_send(char *path)
668 struct sftp_request *req = sftp_alloc_request();
669 struct sftp_packet *pktout;
671 pktout = sftp_pkt_init(SSH_FXP_MKDIR);
672 sftp_pkt_adduint32(pktout, req->id);
673 sftp_pkt_addstring(pktout, path);
674 sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */
680 int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
684 id = fxp_got_status(pktin);
685 sftp_pkt_free(pktin);
692 struct sftp_request *fxp_rmdir_send(char *path)
694 struct sftp_request *req = sftp_alloc_request();
695 struct sftp_packet *pktout;
697 pktout = sftp_pkt_init(SSH_FXP_RMDIR);
698 sftp_pkt_adduint32(pktout, req->id);
699 sftp_pkt_addstring(pktout, path);
705 int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
709 id = fxp_got_status(pktin);
710 sftp_pkt_free(pktin);
717 struct sftp_request *fxp_remove_send(char *fname)
719 struct sftp_request *req = sftp_alloc_request();
720 struct sftp_packet *pktout;
722 pktout = sftp_pkt_init(SSH_FXP_REMOVE);
723 sftp_pkt_adduint32(pktout, req->id);
724 sftp_pkt_addstring(pktout, fname);
730 int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req)
734 id = fxp_got_status(pktin);
735 sftp_pkt_free(pktin);
742 struct sftp_request *fxp_rename_send(char *srcfname, char *dstfname)
744 struct sftp_request *req = sftp_alloc_request();
745 struct sftp_packet *pktout;
747 pktout = sftp_pkt_init(SSH_FXP_RENAME);
748 sftp_pkt_adduint32(pktout, req->id);
749 sftp_pkt_addstring(pktout, srcfname);
750 sftp_pkt_addstring(pktout, dstfname);
756 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req)
760 id = fxp_got_status(pktin);
761 sftp_pkt_free(pktin);
769 * Retrieve the attributes of a file. We have fxp_stat which works
770 * on filenames, and fxp_fstat which works on open file handles.
772 struct sftp_request *fxp_stat_send(char *fname)
774 struct sftp_request *req = sftp_alloc_request();
775 struct sftp_packet *pktout;
777 pktout = sftp_pkt_init(SSH_FXP_STAT);
778 sftp_pkt_adduint32(pktout, req->id);
779 sftp_pkt_addstring(pktout, fname);
785 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
786 struct fxp_attrs *attrs)
789 if (pktin->type == SSH_FXP_ATTRS) {
790 if (!sftp_pkt_getattrs(pktin, attrs)) {
791 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
792 sftp_pkt_free(pktin);
795 sftp_pkt_free(pktin);
798 fxp_got_status(pktin);
799 sftp_pkt_free(pktin);
804 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle)
806 struct sftp_request *req = sftp_alloc_request();
807 struct sftp_packet *pktout;
809 pktout = sftp_pkt_init(SSH_FXP_FSTAT);
810 sftp_pkt_adduint32(pktout, req->id);
811 sftp_pkt_addstring_start(pktout);
812 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
818 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
819 struct fxp_attrs *attrs)
822 if (pktin->type == SSH_FXP_ATTRS) {
823 if (!sftp_pkt_getattrs(pktin, attrs)) {
824 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
825 sftp_pkt_free(pktin);
828 sftp_pkt_free(pktin);
831 fxp_got_status(pktin);
832 sftp_pkt_free(pktin);
838 * Set the attributes of a file.
840 struct sftp_request *fxp_setstat_send(char *fname, struct fxp_attrs attrs)
842 struct sftp_request *req = sftp_alloc_request();
843 struct sftp_packet *pktout;
845 pktout = sftp_pkt_init(SSH_FXP_SETSTAT);
846 sftp_pkt_adduint32(pktout, req->id);
847 sftp_pkt_addstring(pktout, fname);
848 sftp_pkt_addattrs(pktout, attrs);
854 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
858 id = fxp_got_status(pktin);
859 sftp_pkt_free(pktin);
866 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
867 struct fxp_attrs attrs)
869 struct sftp_request *req = sftp_alloc_request();
870 struct sftp_packet *pktout;
872 pktout = sftp_pkt_init(SSH_FXP_FSETSTAT);
873 sftp_pkt_adduint32(pktout, req->id);
874 sftp_pkt_addstring_start(pktout);
875 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
876 sftp_pkt_addattrs(pktout, attrs);
882 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
886 id = fxp_got_status(pktin);
887 sftp_pkt_free(pktin);
895 * Read from a file. Returns the number of bytes read, or -1 on an
896 * error, or possibly 0 if EOF. (I'm not entirely sure whether it
897 * will return 0 on EOF, or return -1 and store SSH_FX_EOF in the
898 * error indicator. It might even depend on the SFTP server.)
900 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
901 uint64 offset, int len)
903 struct sftp_request *req = sftp_alloc_request();
904 struct sftp_packet *pktout;
906 pktout = sftp_pkt_init(SSH_FXP_READ);
907 sftp_pkt_adduint32(pktout, req->id);
908 sftp_pkt_addstring_start(pktout);
909 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
910 sftp_pkt_adduint64(pktout, offset);
911 sftp_pkt_adduint32(pktout, len);
917 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
918 char *buffer, int len)
921 if (pktin->type == SSH_FXP_DATA) {
925 if (!sftp_pkt_getstring(pktin, &str, &rlen)) {
926 fxp_internal_error("READ returned malformed SSH_FXP_DATA packet");
927 sftp_pkt_free(pktin);
931 if (rlen > len || rlen < 0) {
932 fxp_internal_error("READ returned more bytes than requested");
933 sftp_pkt_free(pktin);
937 memcpy(buffer, str, rlen);
938 sftp_pkt_free(pktin);
941 fxp_got_status(pktin);
942 sftp_pkt_free(pktin);
948 * Read from a directory.
950 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle)
952 struct sftp_request *req = sftp_alloc_request();
953 struct sftp_packet *pktout;
955 pktout = sftp_pkt_init(SSH_FXP_READDIR);
956 sftp_pkt_adduint32(pktout, req->id);
957 sftp_pkt_addstring_start(pktout);
958 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
964 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
965 struct sftp_request *req)
968 if (pktin->type == SSH_FXP_NAME) {
969 struct fxp_names *ret;
973 * Sanity-check the number of names. Minimum is obviously
974 * zero. Maximum is the remaining space in the packet
975 * divided by the very minimum length of a name, which is
976 * 12 bytes (4 for an empty filename, 4 for an empty
977 * longname, 4 for a set of attribute flags indicating that
978 * no other attributes are supplied).
980 if (!sftp_pkt_getuint32(pktin, &i) ||
981 i > (pktin->length-pktin->savedpos)/12) {
982 fxp_internal_error("malformed FXP_NAME packet");
983 sftp_pkt_free(pktin);
988 * Ensure the implicit multiplication in the snewn() call
989 * doesn't suffer integer overflow and cause us to malloc
992 if (i > INT_MAX / sizeof(struct fxp_name)) {
993 fxp_internal_error("unreasonably large FXP_NAME packet");
994 sftp_pkt_free(pktin);
998 ret = snew(struct fxp_names);
1000 ret->names = snewn(ret->nnames, struct fxp_name);
1001 for (i = 0; i < (unsigned long)ret->nnames; i++) {
1004 if (!sftp_pkt_getstring(pktin, &str1, &len1) ||
1005 !sftp_pkt_getstring(pktin, &str2, &len2) ||
1006 !sftp_pkt_getattrs(pktin, &ret->names[i].attrs)) {
1007 fxp_internal_error("malformed FXP_NAME packet");
1009 sfree(ret->names[i].filename);
1010 sfree(ret->names[i].longname);
1017 ret->names[i].filename = mkstr(str1, len1);
1018 ret->names[i].longname = mkstr(str2, len2);
1020 sftp_pkt_free(pktin);
1023 fxp_got_status(pktin);
1024 sftp_pkt_free(pktin);
1030 * Write to a file. Returns 0 on error, 1 on OK.
1032 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
1033 char *buffer, uint64 offset, int len)
1035 struct sftp_request *req = sftp_alloc_request();
1036 struct sftp_packet *pktout;
1038 pktout = sftp_pkt_init(SSH_FXP_WRITE);
1039 sftp_pkt_adduint32(pktout, req->id);
1040 sftp_pkt_addstring_start(pktout);
1041 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
1042 sftp_pkt_adduint64(pktout, offset);
1043 sftp_pkt_addstring_start(pktout);
1044 sftp_pkt_addstring_data(pktout, buffer, len);
1050 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req)
1053 fxp_got_status(pktin);
1054 sftp_pkt_free(pktin);
1055 return fxp_errtype == SSH_FX_OK;
1059 * Free up an fxp_names structure.
1061 void fxp_free_names(struct fxp_names *names)
1065 for (i = 0; i < names->nnames; i++) {
1066 sfree(names->names[i].filename);
1067 sfree(names->names[i].longname);
1069 sfree(names->names);
1074 * Duplicate an fxp_name structure.
1076 struct fxp_name *fxp_dup_name(struct fxp_name *name)
1078 struct fxp_name *ret;
1079 ret = snew(struct fxp_name);
1080 ret->filename = dupstr(name->filename);
1081 ret->longname = dupstr(name->longname);
1082 ret->attrs = name->attrs; /* structure copy */
1087 * Free up an fxp_name structure.
1089 void fxp_free_name(struct fxp_name *name)
1091 sfree(name->filename);
1092 sfree(name->longname);
1097 * Store user data in an sftp_request structure.
1099 void *fxp_get_userdata(struct sftp_request *req)
1101 return req->userdata;
1104 void fxp_set_userdata(struct sftp_request *req, void *data)
1106 req->userdata = data;
1110 * A wrapper to go round fxp_read_* and fxp_write_*, which manages
1111 * the queueing of multiple read/write requests.
1116 int len, retlen, complete;
1118 struct req *next, *prev;
1122 uint64 offset, furthestdata, filesize;
1123 int req_totalsize, req_maxsize, eof, err;
1124 struct fxp_handle *fh;
1125 struct req *head, *tail;
1128 static struct fxp_xfer *xfer_init(struct fxp_handle *fh, uint64 offset)
1130 struct fxp_xfer *xfer = snew(struct fxp_xfer);
1133 xfer->offset = offset;
1134 xfer->head = xfer->tail = NULL;
1135 xfer->req_totalsize = 0;
1136 xfer->req_maxsize = 1048576;
1138 xfer->filesize = uint64_make(ULONG_MAX, ULONG_MAX);
1139 xfer->furthestdata = uint64_make(0, 0);
1144 int xfer_done(struct fxp_xfer *xfer)
1147 * We're finished if we've seen EOF _and_ there are no
1148 * outstanding requests.
1150 return (xfer->eof || xfer->err) && !xfer->head;
1153 void xfer_download_queue(struct fxp_xfer *xfer)
1155 while (xfer->req_totalsize < xfer->req_maxsize &&
1156 !xfer->eof && !xfer->err) {
1158 * Queue a new read request.
1161 struct sftp_request *req;
1163 rr = snew(struct req);
1164 rr->offset = xfer->offset;
1167 xfer->tail->next = rr;
1168 rr->prev = xfer->tail;
1177 rr->buffer = snewn(rr->len, char);
1178 sftp_register(req = fxp_read_send(xfer->fh, rr->offset, rr->len));
1179 fxp_set_userdata(req, rr);
1181 xfer->offset = uint64_add32(xfer->offset, rr->len);
1182 xfer->req_totalsize += rr->len;
1184 #ifdef DEBUG_DOWNLOAD
1185 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing read request %p at %s\n", rr, buf); }
1190 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset)
1192 struct fxp_xfer *xfer = xfer_init(fh, offset);
1195 xfer_download_queue(xfer);
1200 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1202 struct sftp_request *rreq;
1205 rreq = sftp_find_request(pktin);
1206 rr = (struct req *)fxp_get_userdata(rreq);
1208 return 0; /* this packet isn't ours */
1209 rr->retlen = fxp_read_recv(pktin, rreq, rr->buffer, rr->len);
1210 #ifdef DEBUG_DOWNLOAD
1211 printf("read request %p has returned [%d]\n", rr, rr->retlen);
1214 if ((rr->retlen < 0 && fxp_error_type()==SSH_FX_EOF) || rr->retlen == 0) {
1217 #ifdef DEBUG_DOWNLOAD
1218 printf("setting eof\n");
1220 } else if (rr->retlen < 0) {
1221 /* some error other than EOF; signal it back to caller */
1222 xfer_set_error(xfer);
1230 * Special case: if we have received fewer bytes than we
1231 * actually read, we should do something. For the moment I'll
1232 * just throw an ersatz FXP error to signal this; the SFTP
1233 * draft I've got says that it can't happen except on special
1234 * files, in which case seeking probably has very little
1235 * meaning and so queueing an additional read request to fill
1236 * up the gap sounds like the wrong answer. I'm not sure what I
1237 * should be doing here - if it _was_ a special file, I suspect
1238 * I simply shouldn't have been queueing multiple requests in
1239 * the first place...
1241 if (rr->retlen > 0 && uint64_compare(xfer->furthestdata, rr->offset) < 0) {
1242 xfer->furthestdata = rr->offset;
1243 #ifdef DEBUG_DOWNLOAD
1245 uint64_decimal(xfer->furthestdata, buf);
1246 printf("setting furthestdata = %s\n", buf); }
1250 if (rr->retlen < rr->len) {
1251 uint64 filesize = uint64_add32(rr->offset,
1252 (rr->retlen < 0 ? 0 : rr->retlen));
1253 #ifdef DEBUG_DOWNLOAD
1255 uint64_decimal(filesize, buf);
1256 printf("short block! trying filesize = %s\n", buf); }
1258 if (uint64_compare(xfer->filesize, filesize) > 0) {
1259 xfer->filesize = filesize;
1260 #ifdef DEBUG_DOWNLOAD
1261 printf("actually changing filesize\n");
1266 if (uint64_compare(xfer->furthestdata, xfer->filesize) > 0) {
1267 fxp_error_message = "received a short buffer from FXP_READ, but not"
1270 xfer_set_error(xfer);
1277 void xfer_set_error(struct fxp_xfer *xfer)
1282 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len)
1284 void *retbuf = NULL;
1288 * Discard anything at the head of the rr queue with complete <
1289 * 0; return the first thing with complete > 0.
1291 while (xfer->head && xfer->head->complete && !retbuf) {
1292 struct req *rr = xfer->head;
1294 if (rr->complete > 0) {
1295 retbuf = rr->buffer;
1296 retlen = rr->retlen;
1297 #ifdef DEBUG_DOWNLOAD
1298 printf("handing back data from read request %p\n", rr);
1301 #ifdef DEBUG_DOWNLOAD
1303 printf("skipping failed read request %p\n", rr);
1306 xfer->head = xfer->head->next;
1308 xfer->head->prev = NULL;
1311 xfer->req_totalsize -= rr->len;
1323 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset)
1325 struct fxp_xfer *xfer = xfer_init(fh, offset);
1328 * We set `eof' to 1 because this will cause xfer_done() to
1329 * return true iff there are no outstanding requests. During an
1330 * upload, our caller will be responsible for working out
1331 * whether all the data has been sent, so all it needs to know
1332 * from us is whether the outstanding requests have been
1333 * handled once that's done.
1340 int xfer_upload_ready(struct fxp_xfer *xfer)
1342 if (xfer->req_totalsize < xfer->req_maxsize)
1348 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len)
1351 struct sftp_request *req;
1353 rr = snew(struct req);
1354 rr->offset = xfer->offset;
1357 xfer->tail->next = rr;
1358 rr->prev = xfer->tail;
1368 sftp_register(req = fxp_write_send(xfer->fh, buffer, rr->offset, len));
1369 fxp_set_userdata(req, rr);
1371 xfer->offset = uint64_add32(xfer->offset, rr->len);
1372 xfer->req_totalsize += rr->len;
1375 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing write request %p at %s [len %d]\n", rr, buf, len); }
1379 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1381 struct sftp_request *rreq;
1382 struct req *rr, *prev, *next;
1385 rreq = sftp_find_request(pktin);
1386 rr = (struct req *)fxp_get_userdata(rreq);
1388 return 0; /* this packet isn't ours */
1389 ret = fxp_write_recv(pktin, rreq);
1391 printf("write request %p has returned [%d]\n", rr, ret);
1395 * Remove this one from the queue.
1407 xfer->req_totalsize -= rr->len;
1416 void xfer_cleanup(struct fxp_xfer *xfer)
1419 while (xfer->head) {
1421 xfer->head = xfer->head->next;