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)
356 struct sftp_request *req;
359 fxp_internal_error("did not receive a valid SFTP packet\n");
363 if (!sftp_pkt_getuint32(pktin, &id)) {
364 fxp_internal_error("did not receive a valid SFTP packet\n");
368 req = find234(sftp_requests, &fid, sftp_reqfind);
370 if (!req || !req->registered) {
371 fxp_internal_error("request ID mismatch\n");
375 del234(sftp_requests, req);
380 /* ----------------------------------------------------------------------
381 * String handling routines.
384 static char *mkstr(char *s, int len)
386 char *p = snewn(len + 1, char);
392 /* ----------------------------------------------------------------------
397 * Deal with (and free) an FXP_STATUS packet. Return 1 if
398 * SSH_FX_OK, 0 if SSH_FX_EOF, and -1 for anything else (error).
399 * Also place the status into fxp_errtype.
401 static int fxp_got_status(struct sftp_packet *pktin)
403 static const char *const messages[] = {
404 /* SSH_FX_OK. The only time we will display a _message_ for this
405 * is if we were expecting something other than FXP_STATUS on
406 * success, so this is actually an error message! */
407 "unexpected OK response",
409 "no such file or directory",
415 "operation unsupported",
418 if (pktin->type != SSH_FXP_STATUS) {
419 fxp_error_message = "expected FXP_STATUS packet";
423 if (!sftp_pkt_getuint32(pktin, &ul)) {
424 fxp_error_message = "malformed FXP_STATUS packet";
428 if (fxp_errtype < 0 ||
429 fxp_errtype >= sizeof(messages) / sizeof(*messages))
430 fxp_error_message = "unknown error code";
432 fxp_error_message = messages[fxp_errtype];
436 if (fxp_errtype == SSH_FX_OK)
438 else if (fxp_errtype == SSH_FX_EOF)
444 static void fxp_internal_error(const char *msg)
446 fxp_error_message = msg;
450 const char *fxp_error(void)
452 return fxp_error_message;
455 int fxp_error_type(void)
461 * Perform exchange of init/version packets. Return 0 on failure.
465 struct sftp_packet *pktout, *pktin;
466 unsigned long remotever;
468 pktout = sftp_pkt_init(SSH_FXP_INIT);
469 sftp_pkt_adduint32(pktout, SFTP_PROTO_VERSION);
474 fxp_internal_error("could not connect");
477 if (pktin->type != SSH_FXP_VERSION) {
478 fxp_internal_error("did not receive FXP_VERSION");
479 sftp_pkt_free(pktin);
482 if (!sftp_pkt_getuint32(pktin, &remotever)) {
483 fxp_internal_error("malformed FXP_VERSION packet");
484 sftp_pkt_free(pktin);
487 if (remotever > SFTP_PROTO_VERSION) {
489 ("remote protocol is more advanced than we support");
490 sftp_pkt_free(pktin);
494 * In principle, this packet might also contain extension-
495 * string pairs. We should work through them and look for any
496 * we recognise. In practice we don't currently do so because
497 * we know we don't recognise _any_.
499 sftp_pkt_free(pktin);
505 * Canonify a pathname.
507 struct sftp_request *fxp_realpath_send(const char *path)
509 struct sftp_request *req = sftp_alloc_request();
510 struct sftp_packet *pktout;
512 pktout = sftp_pkt_init(SSH_FXP_REALPATH);
513 sftp_pkt_adduint32(pktout, req->id);
514 sftp_pkt_addstring_start(pktout);
515 sftp_pkt_addstring_str(pktout, path);
521 char *fxp_realpath_recv(struct sftp_packet *pktin, struct sftp_request *req)
525 if (pktin->type == SSH_FXP_NAME) {
530 if (!sftp_pkt_getuint32(pktin, &count) || count != 1) {
531 fxp_internal_error("REALPATH did not return name count of 1\n");
532 sftp_pkt_free(pktin);
535 if (!sftp_pkt_getstring(pktin, &path, &len)) {
536 fxp_internal_error("REALPATH returned malformed FXP_NAME\n");
537 sftp_pkt_free(pktin);
540 path = mkstr(path, len);
541 sftp_pkt_free(pktin);
544 fxp_got_status(pktin);
545 sftp_pkt_free(pktin);
553 struct sftp_request *fxp_open_send(const char *path, int type,
554 struct fxp_attrs *attrs)
556 struct sftp_request *req = sftp_alloc_request();
557 struct sftp_packet *pktout;
559 pktout = sftp_pkt_init(SSH_FXP_OPEN);
560 sftp_pkt_adduint32(pktout, req->id);
561 sftp_pkt_addstring(pktout, path);
562 sftp_pkt_adduint32(pktout, type);
564 sftp_pkt_addattrs(pktout, *attrs);
566 sftp_pkt_adduint32(pktout, 0); /* empty ATTRS structure */
572 struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
573 struct sftp_request *req)
577 if (pktin->type == SSH_FXP_HANDLE) {
579 struct fxp_handle *handle;
582 if (!sftp_pkt_getstring(pktin, &hstring, &len)) {
583 fxp_internal_error("OPEN returned malformed FXP_HANDLE\n");
584 sftp_pkt_free(pktin);
587 handle = snew(struct fxp_handle);
588 handle->hstring = mkstr(hstring, len);
590 sftp_pkt_free(pktin);
593 fxp_got_status(pktin);
594 sftp_pkt_free(pktin);
602 struct sftp_request *fxp_opendir_send(const char *path)
604 struct sftp_request *req = sftp_alloc_request();
605 struct sftp_packet *pktout;
607 pktout = sftp_pkt_init(SSH_FXP_OPENDIR);
608 sftp_pkt_adduint32(pktout, req->id);
609 sftp_pkt_addstring(pktout, path);
615 struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
616 struct sftp_request *req)
619 if (pktin->type == SSH_FXP_HANDLE) {
621 struct fxp_handle *handle;
624 if (!sftp_pkt_getstring(pktin, &hstring, &len)) {
625 fxp_internal_error("OPENDIR returned malformed FXP_HANDLE\n");
626 sftp_pkt_free(pktin);
629 handle = snew(struct fxp_handle);
630 handle->hstring = mkstr(hstring, len);
632 sftp_pkt_free(pktin);
635 fxp_got_status(pktin);
636 sftp_pkt_free(pktin);
644 struct sftp_request *fxp_close_send(struct fxp_handle *handle)
646 struct sftp_request *req = sftp_alloc_request();
647 struct sftp_packet *pktout;
649 pktout = sftp_pkt_init(SSH_FXP_CLOSE);
650 sftp_pkt_adduint32(pktout, req->id);
651 sftp_pkt_addstring_start(pktout);
652 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
655 sfree(handle->hstring);
661 int fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req)
664 fxp_got_status(pktin);
665 sftp_pkt_free(pktin);
666 return fxp_errtype == SSH_FX_OK;
669 struct sftp_request *fxp_mkdir_send(const char *path)
671 struct sftp_request *req = sftp_alloc_request();
672 struct sftp_packet *pktout;
674 pktout = sftp_pkt_init(SSH_FXP_MKDIR);
675 sftp_pkt_adduint32(pktout, req->id);
676 sftp_pkt_addstring(pktout, path);
677 sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */
683 int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
687 id = fxp_got_status(pktin);
688 sftp_pkt_free(pktin);
695 struct sftp_request *fxp_rmdir_send(const char *path)
697 struct sftp_request *req = sftp_alloc_request();
698 struct sftp_packet *pktout;
700 pktout = sftp_pkt_init(SSH_FXP_RMDIR);
701 sftp_pkt_adduint32(pktout, req->id);
702 sftp_pkt_addstring(pktout, path);
708 int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
712 id = fxp_got_status(pktin);
713 sftp_pkt_free(pktin);
720 struct sftp_request *fxp_remove_send(const char *fname)
722 struct sftp_request *req = sftp_alloc_request();
723 struct sftp_packet *pktout;
725 pktout = sftp_pkt_init(SSH_FXP_REMOVE);
726 sftp_pkt_adduint32(pktout, req->id);
727 sftp_pkt_addstring(pktout, fname);
733 int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req)
737 id = fxp_got_status(pktin);
738 sftp_pkt_free(pktin);
745 struct sftp_request *fxp_rename_send(const char *srcfname,
746 const char *dstfname)
748 struct sftp_request *req = sftp_alloc_request();
749 struct sftp_packet *pktout;
751 pktout = sftp_pkt_init(SSH_FXP_RENAME);
752 sftp_pkt_adduint32(pktout, req->id);
753 sftp_pkt_addstring(pktout, srcfname);
754 sftp_pkt_addstring(pktout, dstfname);
760 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req)
764 id = fxp_got_status(pktin);
765 sftp_pkt_free(pktin);
773 * Retrieve the attributes of a file. We have fxp_stat which works
774 * on filenames, and fxp_fstat which works on open file handles.
776 struct sftp_request *fxp_stat_send(const char *fname)
778 struct sftp_request *req = sftp_alloc_request();
779 struct sftp_packet *pktout;
781 pktout = sftp_pkt_init(SSH_FXP_STAT);
782 sftp_pkt_adduint32(pktout, req->id);
783 sftp_pkt_addstring(pktout, fname);
789 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
790 struct fxp_attrs *attrs)
793 if (pktin->type == SSH_FXP_ATTRS) {
794 if (!sftp_pkt_getattrs(pktin, attrs)) {
795 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
796 sftp_pkt_free(pktin);
799 sftp_pkt_free(pktin);
802 fxp_got_status(pktin);
803 sftp_pkt_free(pktin);
808 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle)
810 struct sftp_request *req = sftp_alloc_request();
811 struct sftp_packet *pktout;
813 pktout = sftp_pkt_init(SSH_FXP_FSTAT);
814 sftp_pkt_adduint32(pktout, req->id);
815 sftp_pkt_addstring_start(pktout);
816 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
822 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
823 struct fxp_attrs *attrs)
826 if (pktin->type == SSH_FXP_ATTRS) {
827 if (!sftp_pkt_getattrs(pktin, attrs)) {
828 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
829 sftp_pkt_free(pktin);
832 sftp_pkt_free(pktin);
835 fxp_got_status(pktin);
836 sftp_pkt_free(pktin);
842 * Set the attributes of a file.
844 struct sftp_request *fxp_setstat_send(const char *fname,
845 struct fxp_attrs attrs)
847 struct sftp_request *req = sftp_alloc_request();
848 struct sftp_packet *pktout;
850 pktout = sftp_pkt_init(SSH_FXP_SETSTAT);
851 sftp_pkt_adduint32(pktout, req->id);
852 sftp_pkt_addstring(pktout, fname);
853 sftp_pkt_addattrs(pktout, attrs);
859 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
863 id = fxp_got_status(pktin);
864 sftp_pkt_free(pktin);
871 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
872 struct fxp_attrs attrs)
874 struct sftp_request *req = sftp_alloc_request();
875 struct sftp_packet *pktout;
877 pktout = sftp_pkt_init(SSH_FXP_FSETSTAT);
878 sftp_pkt_adduint32(pktout, req->id);
879 sftp_pkt_addstring_start(pktout);
880 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
881 sftp_pkt_addattrs(pktout, attrs);
887 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
891 id = fxp_got_status(pktin);
892 sftp_pkt_free(pktin);
900 * Read from a file. Returns the number of bytes read, or -1 on an
901 * error, or possibly 0 if EOF. (I'm not entirely sure whether it
902 * will return 0 on EOF, or return -1 and store SSH_FX_EOF in the
903 * error indicator. It might even depend on the SFTP server.)
905 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
906 uint64 offset, int len)
908 struct sftp_request *req = sftp_alloc_request();
909 struct sftp_packet *pktout;
911 pktout = sftp_pkt_init(SSH_FXP_READ);
912 sftp_pkt_adduint32(pktout, req->id);
913 sftp_pkt_addstring_start(pktout);
914 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
915 sftp_pkt_adduint64(pktout, offset);
916 sftp_pkt_adduint32(pktout, len);
922 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
923 char *buffer, int len)
926 if (pktin->type == SSH_FXP_DATA) {
930 if (!sftp_pkt_getstring(pktin, &str, &rlen)) {
931 fxp_internal_error("READ returned malformed SSH_FXP_DATA packet");
932 sftp_pkt_free(pktin);
936 if (rlen > len || rlen < 0) {
937 fxp_internal_error("READ returned more bytes than requested");
938 sftp_pkt_free(pktin);
942 memcpy(buffer, str, rlen);
943 sftp_pkt_free(pktin);
946 fxp_got_status(pktin);
947 sftp_pkt_free(pktin);
953 * Read from a directory.
955 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle)
957 struct sftp_request *req = sftp_alloc_request();
958 struct sftp_packet *pktout;
960 pktout = sftp_pkt_init(SSH_FXP_READDIR);
961 sftp_pkt_adduint32(pktout, req->id);
962 sftp_pkt_addstring_start(pktout);
963 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
969 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
970 struct sftp_request *req)
973 if (pktin->type == SSH_FXP_NAME) {
974 struct fxp_names *ret;
978 * Sanity-check the number of names. Minimum is obviously
979 * zero. Maximum is the remaining space in the packet
980 * divided by the very minimum length of a name, which is
981 * 12 bytes (4 for an empty filename, 4 for an empty
982 * longname, 4 for a set of attribute flags indicating that
983 * no other attributes are supplied).
985 if (!sftp_pkt_getuint32(pktin, &i) ||
986 i > (pktin->length-pktin->savedpos)/12) {
987 fxp_internal_error("malformed FXP_NAME packet");
988 sftp_pkt_free(pktin);
993 * Ensure the implicit multiplication in the snewn() call
994 * doesn't suffer integer overflow and cause us to malloc
997 if (i > INT_MAX / sizeof(struct fxp_name)) {
998 fxp_internal_error("unreasonably large FXP_NAME packet");
999 sftp_pkt_free(pktin);
1003 ret = snew(struct fxp_names);
1005 ret->names = snewn(ret->nnames, struct fxp_name);
1006 for (i = 0; i < (unsigned long)ret->nnames; i++) {
1009 if (!sftp_pkt_getstring(pktin, &str1, &len1) ||
1010 !sftp_pkt_getstring(pktin, &str2, &len2) ||
1011 !sftp_pkt_getattrs(pktin, &ret->names[i].attrs)) {
1012 fxp_internal_error("malformed FXP_NAME packet");
1014 sfree(ret->names[i].filename);
1015 sfree(ret->names[i].longname);
1022 ret->names[i].filename = mkstr(str1, len1);
1023 ret->names[i].longname = mkstr(str2, len2);
1025 sftp_pkt_free(pktin);
1028 fxp_got_status(pktin);
1029 sftp_pkt_free(pktin);
1035 * Write to a file. Returns 0 on error, 1 on OK.
1037 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
1038 char *buffer, uint64 offset, int len)
1040 struct sftp_request *req = sftp_alloc_request();
1041 struct sftp_packet *pktout;
1043 pktout = sftp_pkt_init(SSH_FXP_WRITE);
1044 sftp_pkt_adduint32(pktout, req->id);
1045 sftp_pkt_addstring_start(pktout);
1046 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
1047 sftp_pkt_adduint64(pktout, offset);
1048 sftp_pkt_addstring_start(pktout);
1049 sftp_pkt_addstring_data(pktout, buffer, len);
1055 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req)
1058 fxp_got_status(pktin);
1059 sftp_pkt_free(pktin);
1060 return fxp_errtype == SSH_FX_OK;
1064 * Free up an fxp_names structure.
1066 void fxp_free_names(struct fxp_names *names)
1070 for (i = 0; i < names->nnames; i++) {
1071 sfree(names->names[i].filename);
1072 sfree(names->names[i].longname);
1074 sfree(names->names);
1079 * Duplicate an fxp_name structure.
1081 struct fxp_name *fxp_dup_name(struct fxp_name *name)
1083 struct fxp_name *ret;
1084 ret = snew(struct fxp_name);
1085 ret->filename = dupstr(name->filename);
1086 ret->longname = dupstr(name->longname);
1087 ret->attrs = name->attrs; /* structure copy */
1092 * Free up an fxp_name structure.
1094 void fxp_free_name(struct fxp_name *name)
1096 sfree(name->filename);
1097 sfree(name->longname);
1102 * Store user data in an sftp_request structure.
1104 void *fxp_get_userdata(struct sftp_request *req)
1106 return req->userdata;
1109 void fxp_set_userdata(struct sftp_request *req, void *data)
1111 req->userdata = data;
1115 * A wrapper to go round fxp_read_* and fxp_write_*, which manages
1116 * the queueing of multiple read/write requests.
1121 int len, retlen, complete;
1123 struct req *next, *prev;
1127 uint64 offset, furthestdata, filesize;
1128 int req_totalsize, req_maxsize, eof, err;
1129 struct fxp_handle *fh;
1130 struct req *head, *tail;
1133 static struct fxp_xfer *xfer_init(struct fxp_handle *fh, uint64 offset)
1135 struct fxp_xfer *xfer = snew(struct fxp_xfer);
1138 xfer->offset = offset;
1139 xfer->head = xfer->tail = NULL;
1140 xfer->req_totalsize = 0;
1141 xfer->req_maxsize = 1048576;
1143 xfer->filesize = uint64_make(ULONG_MAX, ULONG_MAX);
1144 xfer->furthestdata = uint64_make(0, 0);
1149 int xfer_done(struct fxp_xfer *xfer)
1152 * We're finished if we've seen EOF _and_ there are no
1153 * outstanding requests.
1155 return (xfer->eof || xfer->err) && !xfer->head;
1158 void xfer_download_queue(struct fxp_xfer *xfer)
1160 while (xfer->req_totalsize < xfer->req_maxsize &&
1161 !xfer->eof && !xfer->err) {
1163 * Queue a new read request.
1166 struct sftp_request *req;
1168 rr = snew(struct req);
1169 rr->offset = xfer->offset;
1172 xfer->tail->next = rr;
1173 rr->prev = xfer->tail;
1182 rr->buffer = snewn(rr->len, char);
1183 sftp_register(req = fxp_read_send(xfer->fh, rr->offset, rr->len));
1184 fxp_set_userdata(req, rr);
1186 xfer->offset = uint64_add32(xfer->offset, rr->len);
1187 xfer->req_totalsize += rr->len;
1189 #ifdef DEBUG_DOWNLOAD
1190 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing read request %p at %s\n", rr, buf); }
1195 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset)
1197 struct fxp_xfer *xfer = xfer_init(fh, offset);
1200 xfer_download_queue(xfer);
1206 * Returns INT_MIN to indicate that it didn't even get as far as
1207 * fxp_read_recv and hence has not freed pktin.
1209 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1211 struct sftp_request *rreq;
1214 rreq = sftp_find_request(pktin);
1216 return INT_MIN; /* this packet doesn't even make sense */
1217 rr = (struct req *)fxp_get_userdata(rreq);
1219 fxp_internal_error("request ID is not part of the current download");
1220 return INT_MIN; /* this packet isn't ours */
1222 rr->retlen = fxp_read_recv(pktin, rreq, rr->buffer, rr->len);
1223 #ifdef DEBUG_DOWNLOAD
1224 printf("read request %p has returned [%d]\n", rr, rr->retlen);
1227 if ((rr->retlen < 0 && fxp_error_type()==SSH_FX_EOF) || rr->retlen == 0) {
1230 #ifdef DEBUG_DOWNLOAD
1231 printf("setting eof\n");
1233 } else if (rr->retlen < 0) {
1234 /* some error other than EOF; signal it back to caller */
1235 xfer_set_error(xfer);
1243 * Special case: if we have received fewer bytes than we
1244 * actually read, we should do something. For the moment I'll
1245 * just throw an ersatz FXP error to signal this; the SFTP
1246 * draft I've got says that it can't happen except on special
1247 * files, in which case seeking probably has very little
1248 * meaning and so queueing an additional read request to fill
1249 * up the gap sounds like the wrong answer. I'm not sure what I
1250 * should be doing here - if it _was_ a special file, I suspect
1251 * I simply shouldn't have been queueing multiple requests in
1252 * the first place...
1254 if (rr->retlen > 0 && uint64_compare(xfer->furthestdata, rr->offset) < 0) {
1255 xfer->furthestdata = rr->offset;
1256 #ifdef DEBUG_DOWNLOAD
1258 uint64_decimal(xfer->furthestdata, buf);
1259 printf("setting furthestdata = %s\n", buf); }
1263 if (rr->retlen < rr->len) {
1264 uint64 filesize = uint64_add32(rr->offset,
1265 (rr->retlen < 0 ? 0 : rr->retlen));
1266 #ifdef DEBUG_DOWNLOAD
1268 uint64_decimal(filesize, buf);
1269 printf("short block! trying filesize = %s\n", buf); }
1271 if (uint64_compare(xfer->filesize, filesize) > 0) {
1272 xfer->filesize = filesize;
1273 #ifdef DEBUG_DOWNLOAD
1274 printf("actually changing filesize\n");
1279 if (uint64_compare(xfer->furthestdata, xfer->filesize) > 0) {
1280 fxp_error_message = "received a short buffer from FXP_READ, but not"
1283 xfer_set_error(xfer);
1290 void xfer_set_error(struct fxp_xfer *xfer)
1295 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len)
1297 void *retbuf = NULL;
1301 * Discard anything at the head of the rr queue with complete <
1302 * 0; return the first thing with complete > 0.
1304 while (xfer->head && xfer->head->complete && !retbuf) {
1305 struct req *rr = xfer->head;
1307 if (rr->complete > 0) {
1308 retbuf = rr->buffer;
1309 retlen = rr->retlen;
1310 #ifdef DEBUG_DOWNLOAD
1311 printf("handing back data from read request %p\n", rr);
1314 #ifdef DEBUG_DOWNLOAD
1316 printf("skipping failed read request %p\n", rr);
1319 xfer->head = xfer->head->next;
1321 xfer->head->prev = NULL;
1324 xfer->req_totalsize -= rr->len;
1336 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset)
1338 struct fxp_xfer *xfer = xfer_init(fh, offset);
1341 * We set `eof' to 1 because this will cause xfer_done() to
1342 * return true iff there are no outstanding requests. During an
1343 * upload, our caller will be responsible for working out
1344 * whether all the data has been sent, so all it needs to know
1345 * from us is whether the outstanding requests have been
1346 * handled once that's done.
1353 int xfer_upload_ready(struct fxp_xfer *xfer)
1355 if (sftp_sendbuffer() == 0)
1361 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len)
1364 struct sftp_request *req;
1366 rr = snew(struct req);
1367 rr->offset = xfer->offset;
1370 xfer->tail->next = rr;
1371 rr->prev = xfer->tail;
1381 sftp_register(req = fxp_write_send(xfer->fh, buffer, rr->offset, len));
1382 fxp_set_userdata(req, rr);
1384 xfer->offset = uint64_add32(xfer->offset, rr->len);
1385 xfer->req_totalsize += rr->len;
1388 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing write request %p at %s [len %d]\n", rr, buf, len); }
1393 * Returns INT_MIN to indicate that it didn't even get as far as
1394 * fxp_write_recv and hence has not freed pktin.
1396 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1398 struct sftp_request *rreq;
1399 struct req *rr, *prev, *next;
1402 rreq = sftp_find_request(pktin);
1404 return INT_MIN; /* this packet doesn't even make sense */
1405 rr = (struct req *)fxp_get_userdata(rreq);
1407 fxp_internal_error("request ID is not part of the current upload");
1408 return INT_MIN; /* this packet isn't ours */
1410 ret = fxp_write_recv(pktin, rreq);
1412 printf("write request %p has returned [%d]\n", rr, ret);
1416 * Remove this one from the queue.
1428 xfer->req_totalsize -= rr->len;
1437 void xfer_cleanup(struct fxp_xfer *xfer)
1440 while (xfer->head) {
1442 xfer->head = xfer->head->next;