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(const 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,
39 const void *data, int len)
42 sftp_pkt_ensure(pkt, pkt->length);
43 memcpy(pkt->data + pkt->length - len, data, len);
45 static void sftp_pkt_addbyte(struct sftp_packet *pkt, unsigned char byte)
47 sftp_pkt_adddata(pkt, &byte, 1);
49 static void sftp_pkt_adduint32(struct sftp_packet *pkt,
54 sftp_pkt_adddata(pkt, x, 4);
56 static struct sftp_packet *sftp_pkt_init(int pkt_type)
58 struct sftp_packet *pkt;
59 pkt = snew(struct sftp_packet);
64 sftp_pkt_adduint32(pkt, 0); /* length field will be filled in later */
65 sftp_pkt_addbyte(pkt, (unsigned char) pkt_type);
69 static void sftp_pkt_addbool(struct sftp_packet *pkt, unsigned char value)
71 sftp_pkt_adddata(pkt, &value, 1);
74 static void sftp_pkt_adduint64(struct sftp_packet *pkt, uint64 value)
77 PUT_32BIT(x, value.hi);
78 PUT_32BIT(x + 4, value.lo);
79 sftp_pkt_adddata(pkt, x, 8);
81 static void sftp_pkt_addstring_start(struct sftp_packet *pkt)
83 sftp_pkt_adduint32(pkt, 0);
84 pkt->savedpos = pkt->length;
86 static void sftp_pkt_addstring_str(struct sftp_packet *pkt, const char *data)
88 sftp_pkt_adddata(pkt, data, strlen(data));
89 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
91 static void sftp_pkt_addstring_data(struct sftp_packet *pkt,
92 const char *data, int len)
94 sftp_pkt_adddata(pkt, data, len);
95 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
97 static void sftp_pkt_addstring(struct sftp_packet *pkt, const char *data)
99 sftp_pkt_addstring_start(pkt);
100 sftp_pkt_addstring_str(pkt, data);
102 static void sftp_pkt_addattrs(struct sftp_packet *pkt, struct fxp_attrs attrs)
104 sftp_pkt_adduint32(pkt, attrs.flags);
105 if (attrs.flags & SSH_FILEXFER_ATTR_SIZE) {
106 sftp_pkt_adduint32(pkt, attrs.size.hi);
107 sftp_pkt_adduint32(pkt, attrs.size.lo);
109 if (attrs.flags & SSH_FILEXFER_ATTR_UIDGID) {
110 sftp_pkt_adduint32(pkt, attrs.uid);
111 sftp_pkt_adduint32(pkt, attrs.gid);
113 if (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
114 sftp_pkt_adduint32(pkt, attrs.permissions);
116 if (attrs.flags & SSH_FILEXFER_ATTR_ACMODTIME) {
117 sftp_pkt_adduint32(pkt, attrs.atime);
118 sftp_pkt_adduint32(pkt, attrs.mtime);
120 if (attrs.flags & SSH_FILEXFER_ATTR_EXTENDED) {
122 * We currently don't support sending any extended
128 /* ----------------------------------------------------------------------
129 * SFTP packet decode functions.
132 static int sftp_pkt_getbyte(struct sftp_packet *pkt, unsigned char *ret)
134 if (pkt->length - pkt->savedpos < 1)
136 *ret = (unsigned char) pkt->data[pkt->savedpos];
140 static int sftp_pkt_getuint32(struct sftp_packet *pkt, unsigned long *ret)
142 if (pkt->length - pkt->savedpos < 4)
144 *ret = GET_32BIT(pkt->data + pkt->savedpos);
148 static int sftp_pkt_getstring(struct sftp_packet *pkt,
149 char **p, int *length)
152 if (pkt->length - pkt->savedpos < 4)
154 *length = toint(GET_32BIT(pkt->data + pkt->savedpos));
156 if ((int)(pkt->length - pkt->savedpos) < *length || *length < 0) {
160 *p = pkt->data + pkt->savedpos;
161 pkt->savedpos += *length;
164 static int sftp_pkt_getattrs(struct sftp_packet *pkt, struct fxp_attrs *ret)
166 if (!sftp_pkt_getuint32(pkt, &ret->flags))
168 if (ret->flags & SSH_FILEXFER_ATTR_SIZE) {
169 unsigned long hi, lo;
170 if (!sftp_pkt_getuint32(pkt, &hi) ||
171 !sftp_pkt_getuint32(pkt, &lo))
173 ret->size = uint64_make(hi, lo);
175 if (ret->flags & SSH_FILEXFER_ATTR_UIDGID) {
176 if (!sftp_pkt_getuint32(pkt, &ret->uid) ||
177 !sftp_pkt_getuint32(pkt, &ret->gid))
180 if (ret->flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
181 if (!sftp_pkt_getuint32(pkt, &ret->permissions))
184 if (ret->flags & SSH_FILEXFER_ATTR_ACMODTIME) {
185 if (!sftp_pkt_getuint32(pkt, &ret->atime) ||
186 !sftp_pkt_getuint32(pkt, &ret->mtime))
189 if (ret->flags & SSH_FILEXFER_ATTR_EXTENDED) {
191 if (!sftp_pkt_getuint32(pkt, &count))
197 * We should try to analyse these, if we ever find one
200 if (!sftp_pkt_getstring(pkt, &str, &len) ||
201 !sftp_pkt_getstring(pkt, &str, &len))
207 static void sftp_pkt_free(struct sftp_packet *pkt)
214 /* ----------------------------------------------------------------------
215 * Send and receive packet functions.
217 int sftp_send(struct sftp_packet *pkt)
220 PUT_32BIT(pkt->data, pkt->length - 4);
221 ret = sftp_senddata(pkt->data, pkt->length);
225 struct sftp_packet *sftp_recv(void)
227 struct sftp_packet *pkt;
231 if (!sftp_recvdata(x, 4))
234 pkt = snew(struct sftp_packet);
236 pkt->length = pkt->maxlen = GET_32BIT(x);
237 pkt->data = snewn(pkt->length, char);
239 if (!sftp_recvdata(pkt->data, pkt->length)) {
244 if (!sftp_pkt_getbyte(pkt, &uc)) {
254 /* ----------------------------------------------------------------------
255 * Request ID allocation and temporary dispatch routines.
258 #define REQUEST_ID_OFFSET 256
260 struct sftp_request {
266 static int sftp_reqcmp(void *av, void *bv)
268 struct sftp_request *a = (struct sftp_request *)av;
269 struct sftp_request *b = (struct sftp_request *)bv;
276 static int sftp_reqfind(void *av, void *bv)
278 unsigned *a = (unsigned *) av;
279 struct sftp_request *b = (struct sftp_request *)bv;
287 static tree234 *sftp_requests;
289 static struct sftp_request *sftp_alloc_request(void)
291 unsigned low, high, mid;
293 struct sftp_request *r;
295 if (sftp_requests == NULL)
296 sftp_requests = newtree234(sftp_reqcmp);
299 * First-fit allocation of request IDs: always pick the lowest
300 * unused one. To do this, binary-search using the counted
301 * B-tree to find the largest ID which is in a contiguous
302 * sequence from the beginning. (Precisely everything in that
303 * sequence must have ID equal to its tree index plus
304 * REQUEST_ID_OFFSET.)
306 tsize = count234(sftp_requests);
310 while (high - low > 1) {
311 mid = (high + low) / 2;
312 r = index234(sftp_requests, mid);
313 if (r->id == mid + REQUEST_ID_OFFSET)
314 low = mid; /* this one is fine */
316 high = mid; /* this one is past it */
319 * Now low points to either -1, or the tree index of the
320 * largest ID in the initial sequence.
323 unsigned i = low + 1 + REQUEST_ID_OFFSET;
324 assert(NULL == find234(sftp_requests, &i, sftp_reqfind));
328 * So the request ID we need to create is
329 * low + 1 + REQUEST_ID_OFFSET.
331 r = snew(struct sftp_request);
332 r->id = low + 1 + REQUEST_ID_OFFSET;
335 add234(sftp_requests, r);
339 void sftp_cleanup_request(void)
341 if (sftp_requests != NULL) {
342 freetree234(sftp_requests);
343 sftp_requests = NULL;
347 void sftp_register(struct sftp_request *req)
352 struct sftp_request *sftp_find_request(struct sftp_packet *pktin)
355 struct sftp_request *req;
358 fxp_internal_error("did not receive a valid SFTP packet\n");
362 if (!sftp_pkt_getuint32(pktin, &id)) {
363 fxp_internal_error("did not receive a valid SFTP packet\n");
366 req = find234(sftp_requests, &id, sftp_reqfind);
368 if (!req || !req->registered) {
369 fxp_internal_error("request ID mismatch\n");
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(const 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(const 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(const 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(const 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(const 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(const 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(const 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(const char *srcfname,
743 const char *dstfname)
745 struct sftp_request *req = sftp_alloc_request();
746 struct sftp_packet *pktout;
748 pktout = sftp_pkt_init(SSH_FXP_RENAME);
749 sftp_pkt_adduint32(pktout, req->id);
750 sftp_pkt_addstring(pktout, srcfname);
751 sftp_pkt_addstring(pktout, dstfname);
757 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req)
761 id = fxp_got_status(pktin);
762 sftp_pkt_free(pktin);
770 * Retrieve the attributes of a file. We have fxp_stat which works
771 * on filenames, and fxp_fstat which works on open file handles.
773 struct sftp_request *fxp_stat_send(const char *fname)
775 struct sftp_request *req = sftp_alloc_request();
776 struct sftp_packet *pktout;
778 pktout = sftp_pkt_init(SSH_FXP_STAT);
779 sftp_pkt_adduint32(pktout, req->id);
780 sftp_pkt_addstring(pktout, fname);
786 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
787 struct fxp_attrs *attrs)
790 if (pktin->type == SSH_FXP_ATTRS) {
791 if (!sftp_pkt_getattrs(pktin, attrs)) {
792 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
793 sftp_pkt_free(pktin);
796 sftp_pkt_free(pktin);
799 fxp_got_status(pktin);
800 sftp_pkt_free(pktin);
805 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle)
807 struct sftp_request *req = sftp_alloc_request();
808 struct sftp_packet *pktout;
810 pktout = sftp_pkt_init(SSH_FXP_FSTAT);
811 sftp_pkt_adduint32(pktout, req->id);
812 sftp_pkt_addstring_start(pktout);
813 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
819 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
820 struct fxp_attrs *attrs)
823 if (pktin->type == SSH_FXP_ATTRS) {
824 if (!sftp_pkt_getattrs(pktin, attrs)) {
825 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
826 sftp_pkt_free(pktin);
829 sftp_pkt_free(pktin);
832 fxp_got_status(pktin);
833 sftp_pkt_free(pktin);
839 * Set the attributes of a file.
841 struct sftp_request *fxp_setstat_send(const char *fname,
842 struct fxp_attrs attrs)
844 struct sftp_request *req = sftp_alloc_request();
845 struct sftp_packet *pktout;
847 pktout = sftp_pkt_init(SSH_FXP_SETSTAT);
848 sftp_pkt_adduint32(pktout, req->id);
849 sftp_pkt_addstring(pktout, fname);
850 sftp_pkt_addattrs(pktout, attrs);
856 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
860 id = fxp_got_status(pktin);
861 sftp_pkt_free(pktin);
868 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
869 struct fxp_attrs attrs)
871 struct sftp_request *req = sftp_alloc_request();
872 struct sftp_packet *pktout;
874 pktout = sftp_pkt_init(SSH_FXP_FSETSTAT);
875 sftp_pkt_adduint32(pktout, req->id);
876 sftp_pkt_addstring_start(pktout);
877 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
878 sftp_pkt_addattrs(pktout, attrs);
884 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
888 id = fxp_got_status(pktin);
889 sftp_pkt_free(pktin);
897 * Read from a file. Returns the number of bytes read, or -1 on an
898 * error, or possibly 0 if EOF. (I'm not entirely sure whether it
899 * will return 0 on EOF, or return -1 and store SSH_FX_EOF in the
900 * error indicator. It might even depend on the SFTP server.)
902 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
903 uint64 offset, int len)
905 struct sftp_request *req = sftp_alloc_request();
906 struct sftp_packet *pktout;
908 pktout = sftp_pkt_init(SSH_FXP_READ);
909 sftp_pkt_adduint32(pktout, req->id);
910 sftp_pkt_addstring_start(pktout);
911 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
912 sftp_pkt_adduint64(pktout, offset);
913 sftp_pkt_adduint32(pktout, len);
919 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
920 char *buffer, int len)
923 if (pktin->type == SSH_FXP_DATA) {
927 if (!sftp_pkt_getstring(pktin, &str, &rlen)) {
928 fxp_internal_error("READ returned malformed SSH_FXP_DATA packet");
929 sftp_pkt_free(pktin);
933 if (rlen > len || rlen < 0) {
934 fxp_internal_error("READ returned more bytes than requested");
935 sftp_pkt_free(pktin);
939 memcpy(buffer, str, rlen);
940 sftp_pkt_free(pktin);
943 fxp_got_status(pktin);
944 sftp_pkt_free(pktin);
950 * Read from a directory.
952 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle)
954 struct sftp_request *req = sftp_alloc_request();
955 struct sftp_packet *pktout;
957 pktout = sftp_pkt_init(SSH_FXP_READDIR);
958 sftp_pkt_adduint32(pktout, req->id);
959 sftp_pkt_addstring_start(pktout);
960 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
966 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
967 struct sftp_request *req)
970 if (pktin->type == SSH_FXP_NAME) {
971 struct fxp_names *ret;
975 * Sanity-check the number of names. Minimum is obviously
976 * zero. Maximum is the remaining space in the packet
977 * divided by the very minimum length of a name, which is
978 * 12 bytes (4 for an empty filename, 4 for an empty
979 * longname, 4 for a set of attribute flags indicating that
980 * no other attributes are supplied).
982 if (!sftp_pkt_getuint32(pktin, &i) ||
983 i > (pktin->length-pktin->savedpos)/12) {
984 fxp_internal_error("malformed FXP_NAME packet");
985 sftp_pkt_free(pktin);
990 * Ensure the implicit multiplication in the snewn() call
991 * doesn't suffer integer overflow and cause us to malloc
994 if (i > INT_MAX / sizeof(struct fxp_name)) {
995 fxp_internal_error("unreasonably large FXP_NAME packet");
996 sftp_pkt_free(pktin);
1000 ret = snew(struct fxp_names);
1002 ret->names = snewn(ret->nnames, struct fxp_name);
1003 for (i = 0; i < (unsigned long)ret->nnames; i++) {
1006 if (!sftp_pkt_getstring(pktin, &str1, &len1) ||
1007 !sftp_pkt_getstring(pktin, &str2, &len2) ||
1008 !sftp_pkt_getattrs(pktin, &ret->names[i].attrs)) {
1009 fxp_internal_error("malformed FXP_NAME packet");
1011 sfree(ret->names[i].filename);
1012 sfree(ret->names[i].longname);
1019 ret->names[i].filename = mkstr(str1, len1);
1020 ret->names[i].longname = mkstr(str2, len2);
1022 sftp_pkt_free(pktin);
1025 fxp_got_status(pktin);
1026 sftp_pkt_free(pktin);
1032 * Write to a file. Returns 0 on error, 1 on OK.
1034 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
1035 char *buffer, uint64 offset, int len)
1037 struct sftp_request *req = sftp_alloc_request();
1038 struct sftp_packet *pktout;
1040 pktout = sftp_pkt_init(SSH_FXP_WRITE);
1041 sftp_pkt_adduint32(pktout, req->id);
1042 sftp_pkt_addstring_start(pktout);
1043 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
1044 sftp_pkt_adduint64(pktout, offset);
1045 sftp_pkt_addstring_start(pktout);
1046 sftp_pkt_addstring_data(pktout, buffer, len);
1052 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req)
1055 fxp_got_status(pktin);
1056 sftp_pkt_free(pktin);
1057 return fxp_errtype == SSH_FX_OK;
1061 * Free up an fxp_names structure.
1063 void fxp_free_names(struct fxp_names *names)
1067 for (i = 0; i < names->nnames; i++) {
1068 sfree(names->names[i].filename);
1069 sfree(names->names[i].longname);
1071 sfree(names->names);
1076 * Duplicate an fxp_name structure.
1078 struct fxp_name *fxp_dup_name(struct fxp_name *name)
1080 struct fxp_name *ret;
1081 ret = snew(struct fxp_name);
1082 ret->filename = dupstr(name->filename);
1083 ret->longname = dupstr(name->longname);
1084 ret->attrs = name->attrs; /* structure copy */
1089 * Free up an fxp_name structure.
1091 void fxp_free_name(struct fxp_name *name)
1093 sfree(name->filename);
1094 sfree(name->longname);
1099 * Store user data in an sftp_request structure.
1101 void *fxp_get_userdata(struct sftp_request *req)
1103 return req->userdata;
1106 void fxp_set_userdata(struct sftp_request *req, void *data)
1108 req->userdata = data;
1112 * A wrapper to go round fxp_read_* and fxp_write_*, which manages
1113 * the queueing of multiple read/write requests.
1118 int len, retlen, complete;
1120 struct req *next, *prev;
1124 uint64 offset, furthestdata, filesize;
1125 int req_totalsize, req_maxsize, eof, err;
1126 struct fxp_handle *fh;
1127 struct req *head, *tail;
1130 static struct fxp_xfer *xfer_init(struct fxp_handle *fh, uint64 offset)
1132 struct fxp_xfer *xfer = snew(struct fxp_xfer);
1135 xfer->offset = offset;
1136 xfer->head = xfer->tail = NULL;
1137 xfer->req_totalsize = 0;
1138 xfer->req_maxsize = 1048576;
1140 xfer->filesize = uint64_make(ULONG_MAX, ULONG_MAX);
1141 xfer->furthestdata = uint64_make(0, 0);
1146 int xfer_done(struct fxp_xfer *xfer)
1149 * We're finished if we've seen EOF _and_ there are no
1150 * outstanding requests.
1152 return (xfer->eof || xfer->err) && !xfer->head;
1155 void xfer_download_queue(struct fxp_xfer *xfer)
1157 while (xfer->req_totalsize < xfer->req_maxsize &&
1158 !xfer->eof && !xfer->err) {
1160 * Queue a new read request.
1163 struct sftp_request *req;
1165 rr = snew(struct req);
1166 rr->offset = xfer->offset;
1169 xfer->tail->next = rr;
1170 rr->prev = xfer->tail;
1179 rr->buffer = snewn(rr->len, char);
1180 sftp_register(req = fxp_read_send(xfer->fh, rr->offset, rr->len));
1181 fxp_set_userdata(req, rr);
1183 xfer->offset = uint64_add32(xfer->offset, rr->len);
1184 xfer->req_totalsize += rr->len;
1186 #ifdef DEBUG_DOWNLOAD
1187 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing read request %p at %s\n", rr, buf); }
1192 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset)
1194 struct fxp_xfer *xfer = xfer_init(fh, offset);
1197 xfer_download_queue(xfer);
1203 * Returns INT_MIN to indicate that it didn't even get as far as
1204 * fxp_read_recv and hence has not freed pktin.
1206 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1208 struct sftp_request *rreq;
1211 rreq = sftp_find_request(pktin);
1213 return INT_MIN; /* this packet doesn't even make sense */
1214 rr = (struct req *)fxp_get_userdata(rreq);
1216 fxp_internal_error("request ID is not part of the current download");
1217 return INT_MIN; /* this packet isn't ours */
1219 rr->retlen = fxp_read_recv(pktin, rreq, rr->buffer, rr->len);
1220 #ifdef DEBUG_DOWNLOAD
1221 printf("read request %p has returned [%d]\n", rr, rr->retlen);
1224 if ((rr->retlen < 0 && fxp_error_type()==SSH_FX_EOF) || rr->retlen == 0) {
1227 #ifdef DEBUG_DOWNLOAD
1228 printf("setting eof\n");
1230 } else if (rr->retlen < 0) {
1231 /* some error other than EOF; signal it back to caller */
1232 xfer_set_error(xfer);
1240 * Special case: if we have received fewer bytes than we
1241 * actually read, we should do something. For the moment I'll
1242 * just throw an ersatz FXP error to signal this; the SFTP
1243 * draft I've got says that it can't happen except on special
1244 * files, in which case seeking probably has very little
1245 * meaning and so queueing an additional read request to fill
1246 * up the gap sounds like the wrong answer. I'm not sure what I
1247 * should be doing here - if it _was_ a special file, I suspect
1248 * I simply shouldn't have been queueing multiple requests in
1249 * the first place...
1251 if (rr->retlen > 0 && uint64_compare(xfer->furthestdata, rr->offset) < 0) {
1252 xfer->furthestdata = rr->offset;
1253 #ifdef DEBUG_DOWNLOAD
1255 uint64_decimal(xfer->furthestdata, buf);
1256 printf("setting furthestdata = %s\n", buf); }
1260 if (rr->retlen < rr->len) {
1261 uint64 filesize = uint64_add32(rr->offset,
1262 (rr->retlen < 0 ? 0 : rr->retlen));
1263 #ifdef DEBUG_DOWNLOAD
1265 uint64_decimal(filesize, buf);
1266 printf("short block! trying filesize = %s\n", buf); }
1268 if (uint64_compare(xfer->filesize, filesize) > 0) {
1269 xfer->filesize = filesize;
1270 #ifdef DEBUG_DOWNLOAD
1271 printf("actually changing filesize\n");
1276 if (uint64_compare(xfer->furthestdata, xfer->filesize) > 0) {
1277 fxp_error_message = "received a short buffer from FXP_READ, but not"
1280 xfer_set_error(xfer);
1287 void xfer_set_error(struct fxp_xfer *xfer)
1292 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len)
1294 void *retbuf = NULL;
1298 * Discard anything at the head of the rr queue with complete <
1299 * 0; return the first thing with complete > 0.
1301 while (xfer->head && xfer->head->complete && !retbuf) {
1302 struct req *rr = xfer->head;
1304 if (rr->complete > 0) {
1305 retbuf = rr->buffer;
1306 retlen = rr->retlen;
1307 #ifdef DEBUG_DOWNLOAD
1308 printf("handing back data from read request %p\n", rr);
1311 #ifdef DEBUG_DOWNLOAD
1313 printf("skipping failed read request %p\n", rr);
1316 xfer->head = xfer->head->next;
1318 xfer->head->prev = NULL;
1321 xfer->req_totalsize -= rr->len;
1333 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset)
1335 struct fxp_xfer *xfer = xfer_init(fh, offset);
1338 * We set `eof' to 1 because this will cause xfer_done() to
1339 * return true iff there are no outstanding requests. During an
1340 * upload, our caller will be responsible for working out
1341 * whether all the data has been sent, so all it needs to know
1342 * from us is whether the outstanding requests have been
1343 * handled once that's done.
1350 int xfer_upload_ready(struct fxp_xfer *xfer)
1352 if (sftp_sendbuffer() == 0)
1358 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len)
1361 struct sftp_request *req;
1363 rr = snew(struct req);
1364 rr->offset = xfer->offset;
1367 xfer->tail->next = rr;
1368 rr->prev = xfer->tail;
1378 sftp_register(req = fxp_write_send(xfer->fh, buffer, rr->offset, len));
1379 fxp_set_userdata(req, rr);
1381 xfer->offset = uint64_add32(xfer->offset, rr->len);
1382 xfer->req_totalsize += rr->len;
1385 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing write request %p at %s [len %d]\n", rr, buf, len); }
1390 * Returns INT_MIN to indicate that it didn't even get as far as
1391 * fxp_write_recv and hence has not freed pktin.
1393 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1395 struct sftp_request *rreq;
1396 struct req *rr, *prev, *next;
1399 rreq = sftp_find_request(pktin);
1401 return INT_MIN; /* this packet doesn't even make sense */
1402 rr = (struct req *)fxp_get_userdata(rreq);
1404 fxp_internal_error("request ID is not part of the current upload");
1405 return INT_MIN; /* this packet isn't ours */
1407 ret = fxp_write_recv(pktin, rreq);
1409 printf("write request %p has returned [%d]\n", rr, ret);
1413 * Remove this one from the queue.
1425 xfer->req_totalsize -= rr->len;
1434 void xfer_cleanup(struct fxp_xfer *xfer)
1437 while (xfer->head) {
1439 xfer->head = xfer->head->next;