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 (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 struct sftp_packet *sftp_pkt_init(int pkt_type)
50 struct sftp_packet *pkt;
51 pkt = snew(struct sftp_packet);
56 sftp_pkt_addbyte(pkt, (unsigned char) pkt_type);
60 static void sftp_pkt_addbool(struct sftp_packet *pkt, unsigned char value)
62 sftp_pkt_adddata(pkt, &value, 1);
65 static void sftp_pkt_adduint32(struct sftp_packet *pkt,
70 sftp_pkt_adddata(pkt, x, 4);
72 static void sftp_pkt_adduint64(struct sftp_packet *pkt, uint64 value)
75 PUT_32BIT(x, value.hi);
76 PUT_32BIT(x + 4, value.lo);
77 sftp_pkt_adddata(pkt, x, 8);
79 static void sftp_pkt_addstring_start(struct sftp_packet *pkt)
81 sftp_pkt_adduint32(pkt, 0);
82 pkt->savedpos = pkt->length;
84 static void sftp_pkt_addstring_str(struct sftp_packet *pkt, char *data)
86 sftp_pkt_adddata(pkt, data, strlen(data));
87 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
89 static void sftp_pkt_addstring_data(struct sftp_packet *pkt,
92 sftp_pkt_adddata(pkt, data, len);
93 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
95 static void sftp_pkt_addstring(struct sftp_packet *pkt, char *data)
97 sftp_pkt_addstring_start(pkt);
98 sftp_pkt_addstring_str(pkt, data);
100 static void sftp_pkt_addattrs(struct sftp_packet *pkt, struct fxp_attrs attrs)
102 sftp_pkt_adduint32(pkt, attrs.flags);
103 if (attrs.flags & SSH_FILEXFER_ATTR_SIZE) {
104 sftp_pkt_adduint32(pkt, attrs.size.hi);
105 sftp_pkt_adduint32(pkt, attrs.size.lo);
107 if (attrs.flags & SSH_FILEXFER_ATTR_UIDGID) {
108 sftp_pkt_adduint32(pkt, attrs.uid);
109 sftp_pkt_adduint32(pkt, attrs.gid);
111 if (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
112 sftp_pkt_adduint32(pkt, attrs.permissions);
114 if (attrs.flags & SSH_FILEXFER_ATTR_ACMODTIME) {
115 sftp_pkt_adduint32(pkt, attrs.atime);
116 sftp_pkt_adduint32(pkt, attrs.mtime);
118 if (attrs.flags & SSH_FILEXFER_ATTR_EXTENDED) {
120 * We currently don't support sending any extended
126 /* ----------------------------------------------------------------------
127 * SFTP packet decode functions.
130 static int sftp_pkt_getbyte(struct sftp_packet *pkt, unsigned char *ret)
132 if (pkt->length - pkt->savedpos < 1)
134 *ret = (unsigned char) pkt->data[pkt->savedpos];
138 static int sftp_pkt_getuint32(struct sftp_packet *pkt, unsigned long *ret)
140 if (pkt->length - pkt->savedpos < 4)
142 *ret = GET_32BIT(pkt->data + pkt->savedpos);
146 static int sftp_pkt_getstring(struct sftp_packet *pkt,
147 char **p, int *length)
150 if (pkt->length - pkt->savedpos < 4)
152 *length = GET_32BIT(pkt->data + pkt->savedpos);
154 if (pkt->length - pkt->savedpos < *length || *length < 0) {
158 *p = pkt->data + pkt->savedpos;
159 pkt->savedpos += *length;
162 static int sftp_pkt_getattrs(struct sftp_packet *pkt, struct fxp_attrs *ret)
164 if (!sftp_pkt_getuint32(pkt, &ret->flags))
166 if (ret->flags & SSH_FILEXFER_ATTR_SIZE) {
167 unsigned long hi, lo;
168 if (!sftp_pkt_getuint32(pkt, &hi) ||
169 !sftp_pkt_getuint32(pkt, &lo))
171 ret->size = uint64_make(hi, lo);
173 if (ret->flags & SSH_FILEXFER_ATTR_UIDGID) {
174 if (!sftp_pkt_getuint32(pkt, &ret->uid) ||
175 !sftp_pkt_getuint32(pkt, &ret->gid))
178 if (ret->flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
179 if (!sftp_pkt_getuint32(pkt, &ret->permissions))
182 if (ret->flags & SSH_FILEXFER_ATTR_ACMODTIME) {
183 if (!sftp_pkt_getuint32(pkt, &ret->atime) ||
184 !sftp_pkt_getuint32(pkt, &ret->mtime))
187 if (ret->flags & SSH_FILEXFER_ATTR_EXTENDED) {
189 if (!sftp_pkt_getuint32(pkt, &count))
195 * We should try to analyse these, if we ever find one
198 if (!sftp_pkt_getstring(pkt, &str, &len) ||
199 !sftp_pkt_getstring(pkt, &str, &len))
205 static void sftp_pkt_free(struct sftp_packet *pkt)
212 /* ----------------------------------------------------------------------
213 * Send and receive packet functions.
215 int sftp_send(struct sftp_packet *pkt)
219 PUT_32BIT(x, pkt->length);
220 ret = (sftp_senddata(x, 4) && 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)
553 struct sftp_request *req = sftp_alloc_request();
554 struct sftp_packet *pktout;
556 pktout = sftp_pkt_init(SSH_FXP_OPEN);
557 sftp_pkt_adduint32(pktout, req->id);
558 sftp_pkt_addstring(pktout, path);
559 sftp_pkt_adduint32(pktout, type);
560 sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */
566 struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
567 struct sftp_request *req)
571 if (pktin->type == SSH_FXP_HANDLE) {
573 struct fxp_handle *handle;
576 if (!sftp_pkt_getstring(pktin, &hstring, &len)) {
577 fxp_internal_error("OPEN returned malformed FXP_HANDLE\n");
578 sftp_pkt_free(pktin);
581 handle = snew(struct fxp_handle);
582 handle->hstring = mkstr(hstring, len);
584 sftp_pkt_free(pktin);
587 fxp_got_status(pktin);
588 sftp_pkt_free(pktin);
596 struct sftp_request *fxp_opendir_send(char *path)
598 struct sftp_request *req = sftp_alloc_request();
599 struct sftp_packet *pktout;
601 pktout = sftp_pkt_init(SSH_FXP_OPENDIR);
602 sftp_pkt_adduint32(pktout, req->id);
603 sftp_pkt_addstring(pktout, path);
609 struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
610 struct sftp_request *req)
613 if (pktin->type == SSH_FXP_HANDLE) {
615 struct fxp_handle *handle;
618 if (!sftp_pkt_getstring(pktin, &hstring, &len)) {
619 fxp_internal_error("OPENDIR returned malformed FXP_HANDLE\n");
620 sftp_pkt_free(pktin);
623 handle = snew(struct fxp_handle);
624 handle->hstring = mkstr(hstring, len);
626 sftp_pkt_free(pktin);
629 fxp_got_status(pktin);
630 sftp_pkt_free(pktin);
638 struct sftp_request *fxp_close_send(struct fxp_handle *handle)
640 struct sftp_request *req = sftp_alloc_request();
641 struct sftp_packet *pktout;
643 pktout = sftp_pkt_init(SSH_FXP_CLOSE);
644 sftp_pkt_adduint32(pktout, req->id);
645 sftp_pkt_addstring_start(pktout);
646 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
649 sfree(handle->hstring);
655 void fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req)
658 fxp_got_status(pktin);
659 sftp_pkt_free(pktin);
662 struct sftp_request *fxp_mkdir_send(char *path)
664 struct sftp_request *req = sftp_alloc_request();
665 struct sftp_packet *pktout;
667 pktout = sftp_pkt_init(SSH_FXP_MKDIR);
668 sftp_pkt_adduint32(pktout, req->id);
669 sftp_pkt_addstring(pktout, path);
670 sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */
676 int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
680 id = fxp_got_status(pktin);
681 sftp_pkt_free(pktin);
688 struct sftp_request *fxp_rmdir_send(char *path)
690 struct sftp_request *req = sftp_alloc_request();
691 struct sftp_packet *pktout;
693 pktout = sftp_pkt_init(SSH_FXP_RMDIR);
694 sftp_pkt_adduint32(pktout, req->id);
695 sftp_pkt_addstring(pktout, path);
701 int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
705 id = fxp_got_status(pktin);
706 sftp_pkt_free(pktin);
713 struct sftp_request *fxp_remove_send(char *fname)
715 struct sftp_request *req = sftp_alloc_request();
716 struct sftp_packet *pktout;
718 pktout = sftp_pkt_init(SSH_FXP_REMOVE);
719 sftp_pkt_adduint32(pktout, req->id);
720 sftp_pkt_addstring(pktout, fname);
726 int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req)
730 id = fxp_got_status(pktin);
731 sftp_pkt_free(pktin);
738 struct sftp_request *fxp_rename_send(char *srcfname, char *dstfname)
740 struct sftp_request *req = sftp_alloc_request();
741 struct sftp_packet *pktout;
743 pktout = sftp_pkt_init(SSH_FXP_RENAME);
744 sftp_pkt_adduint32(pktout, req->id);
745 sftp_pkt_addstring(pktout, srcfname);
746 sftp_pkt_addstring(pktout, dstfname);
752 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req)
756 id = fxp_got_status(pktin);
757 sftp_pkt_free(pktin);
765 * Retrieve the attributes of a file. We have fxp_stat which works
766 * on filenames, and fxp_fstat which works on open file handles.
768 struct sftp_request *fxp_stat_send(char *fname)
770 struct sftp_request *req = sftp_alloc_request();
771 struct sftp_packet *pktout;
773 pktout = sftp_pkt_init(SSH_FXP_STAT);
774 sftp_pkt_adduint32(pktout, req->id);
775 sftp_pkt_addstring(pktout, fname);
781 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
782 struct fxp_attrs *attrs)
785 if (pktin->type == SSH_FXP_ATTRS) {
786 if (!sftp_pkt_getattrs(pktin, attrs)) {
787 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
788 sftp_pkt_free(pktin);
791 sftp_pkt_free(pktin);
794 fxp_got_status(pktin);
795 sftp_pkt_free(pktin);
800 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle)
802 struct sftp_request *req = sftp_alloc_request();
803 struct sftp_packet *pktout;
805 pktout = sftp_pkt_init(SSH_FXP_FSTAT);
806 sftp_pkt_adduint32(pktout, req->id);
807 sftp_pkt_addstring_start(pktout);
808 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
814 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
815 struct fxp_attrs *attrs)
818 if (pktin->type == SSH_FXP_ATTRS) {
819 if (!sftp_pkt_getattrs(pktin, attrs)) {
820 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
821 sftp_pkt_free(pktin);
824 sftp_pkt_free(pktin);
827 fxp_got_status(pktin);
828 sftp_pkt_free(pktin);
834 * Set the attributes of a file.
836 struct sftp_request *fxp_setstat_send(char *fname, struct fxp_attrs attrs)
838 struct sftp_request *req = sftp_alloc_request();
839 struct sftp_packet *pktout;
841 pktout = sftp_pkt_init(SSH_FXP_SETSTAT);
842 sftp_pkt_adduint32(pktout, req->id);
843 sftp_pkt_addstring(pktout, fname);
844 sftp_pkt_addattrs(pktout, attrs);
850 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
854 id = fxp_got_status(pktin);
855 sftp_pkt_free(pktin);
862 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
863 struct fxp_attrs attrs)
865 struct sftp_request *req = sftp_alloc_request();
866 struct sftp_packet *pktout;
868 pktout = sftp_pkt_init(SSH_FXP_FSETSTAT);
869 sftp_pkt_adduint32(pktout, req->id);
870 sftp_pkt_addstring_start(pktout);
871 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
872 sftp_pkt_addattrs(pktout, attrs);
878 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
882 id = fxp_got_status(pktin);
883 sftp_pkt_free(pktin);
891 * Read from a file. Returns the number of bytes read, or -1 on an
892 * error, or possibly 0 if EOF. (I'm not entirely sure whether it
893 * will return 0 on EOF, or return -1 and store SSH_FX_EOF in the
894 * error indicator. It might even depend on the SFTP server.)
896 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
897 uint64 offset, int len)
899 struct sftp_request *req = sftp_alloc_request();
900 struct sftp_packet *pktout;
902 pktout = sftp_pkt_init(SSH_FXP_READ);
903 sftp_pkt_adduint32(pktout, req->id);
904 sftp_pkt_addstring_start(pktout);
905 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
906 sftp_pkt_adduint64(pktout, offset);
907 sftp_pkt_adduint32(pktout, len);
913 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
914 char *buffer, int len)
917 if (pktin->type == SSH_FXP_DATA) {
921 if (!sftp_pkt_getstring(pktin, &str, &rlen)) {
922 fxp_internal_error("READ returned malformed SSH_FXP_DATA packet");
923 sftp_pkt_free(pktin);
927 if (rlen > len || rlen < 0) {
928 fxp_internal_error("READ returned more bytes than requested");
929 sftp_pkt_free(pktin);
933 memcpy(buffer, str, rlen);
934 sftp_pkt_free(pktin);
937 fxp_got_status(pktin);
938 sftp_pkt_free(pktin);
944 * Read from a directory.
946 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle)
948 struct sftp_request *req = sftp_alloc_request();
949 struct sftp_packet *pktout;
951 pktout = sftp_pkt_init(SSH_FXP_READDIR);
952 sftp_pkt_adduint32(pktout, req->id);
953 sftp_pkt_addstring_start(pktout);
954 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
960 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
961 struct sftp_request *req)
964 if (pktin->type == SSH_FXP_NAME) {
965 struct fxp_names *ret;
969 * Sanity-check the number of names. Minimum is obviously
970 * zero. Maximum is the remaining space in the packet
971 * divided by the very minimum length of a name, which is
972 * 12 bytes (4 for an empty filename, 4 for an empty
973 * longname, 4 for a set of attribute flags indicating that
974 * no other attributes are supplied).
976 if (!sftp_pkt_getuint32(pktin, &i) ||
977 i > (pktin->length-pktin->savedpos)/12) {
978 fxp_internal_error("malformed FXP_NAME packet");
979 sftp_pkt_free(pktin);
984 * Ensure the implicit multiplication in the snewn() call
985 * doesn't suffer integer overflow and cause us to malloc
988 if (i > INT_MAX / sizeof(struct fxp_name)) {
989 fxp_internal_error("unreasonably large FXP_NAME packet");
990 sftp_pkt_free(pktin);
994 ret = snew(struct fxp_names);
996 ret->names = snewn(ret->nnames, struct fxp_name);
997 for (i = 0; i < ret->nnames; i++) {
1000 if (!sftp_pkt_getstring(pktin, &str1, &len1) ||
1001 !sftp_pkt_getstring(pktin, &str2, &len2) ||
1002 !sftp_pkt_getattrs(pktin, &ret->names[i].attrs)) {
1003 fxp_internal_error("malformed FXP_NAME packet");
1005 sfree(ret->names[i].filename);
1006 sfree(ret->names[i].longname);
1013 ret->names[i].filename = mkstr(str1, len1);
1014 ret->names[i].longname = mkstr(str2, len2);
1016 sftp_pkt_free(pktin);
1019 fxp_got_status(pktin);
1020 sftp_pkt_free(pktin);
1026 * Write to a file. Returns 0 on error, 1 on OK.
1028 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
1029 char *buffer, uint64 offset, int len)
1031 struct sftp_request *req = sftp_alloc_request();
1032 struct sftp_packet *pktout;
1034 pktout = sftp_pkt_init(SSH_FXP_WRITE);
1035 sftp_pkt_adduint32(pktout, req->id);
1036 sftp_pkt_addstring_start(pktout);
1037 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
1038 sftp_pkt_adduint64(pktout, offset);
1039 sftp_pkt_addstring_start(pktout);
1040 sftp_pkt_addstring_data(pktout, buffer, len);
1046 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req)
1049 fxp_got_status(pktin);
1050 sftp_pkt_free(pktin);
1051 return fxp_errtype == SSH_FX_OK;
1055 * Free up an fxp_names structure.
1057 void fxp_free_names(struct fxp_names *names)
1061 for (i = 0; i < names->nnames; i++) {
1062 sfree(names->names[i].filename);
1063 sfree(names->names[i].longname);
1065 sfree(names->names);
1070 * Duplicate an fxp_name structure.
1072 struct fxp_name *fxp_dup_name(struct fxp_name *name)
1074 struct fxp_name *ret;
1075 ret = snew(struct fxp_name);
1076 ret->filename = dupstr(name->filename);
1077 ret->longname = dupstr(name->longname);
1078 ret->attrs = name->attrs; /* structure copy */
1083 * Free up an fxp_name structure.
1085 void fxp_free_name(struct fxp_name *name)
1087 sfree(name->filename);
1088 sfree(name->longname);
1093 * Store user data in an sftp_request structure.
1095 void *fxp_get_userdata(struct sftp_request *req)
1097 return req->userdata;
1100 void fxp_set_userdata(struct sftp_request *req, void *data)
1102 req->userdata = data;
1106 * A wrapper to go round fxp_read_* and fxp_write_*, which manages
1107 * the queueing of multiple read/write requests.
1112 int len, retlen, complete;
1114 struct req *next, *prev;
1118 uint64 offset, furthestdata, filesize;
1119 int req_totalsize, req_maxsize, eof, err;
1120 struct fxp_handle *fh;
1121 struct req *head, *tail;
1124 static struct fxp_xfer *xfer_init(struct fxp_handle *fh, uint64 offset)
1126 struct fxp_xfer *xfer = snew(struct fxp_xfer);
1129 xfer->offset = offset;
1130 xfer->head = xfer->tail = NULL;
1131 xfer->req_totalsize = 0;
1132 xfer->req_maxsize = 16384;
1134 xfer->filesize = uint64_make(ULONG_MAX, ULONG_MAX);
1135 xfer->furthestdata = uint64_make(0, 0);
1140 int xfer_done(struct fxp_xfer *xfer)
1143 * We're finished if we've seen EOF _and_ there are no
1144 * outstanding requests.
1146 return (xfer->eof || xfer->err) && !xfer->head;
1149 void xfer_download_queue(struct fxp_xfer *xfer)
1151 while (xfer->req_totalsize < xfer->req_maxsize &&
1152 !xfer->eof && !xfer->err) {
1154 * Queue a new read request.
1157 struct sftp_request *req;
1159 rr = snew(struct req);
1160 rr->offset = xfer->offset;
1163 xfer->tail->next = rr;
1164 rr->prev = xfer->tail;
1173 rr->buffer = snewn(rr->len, char);
1174 sftp_register(req = fxp_read_send(xfer->fh, rr->offset, rr->len));
1175 fxp_set_userdata(req, rr);
1177 xfer->offset = uint64_add32(xfer->offset, rr->len);
1178 xfer->req_totalsize += rr->len;
1180 #ifdef DEBUG_DOWNLOAD
1181 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing read request %p at %s\n", rr, buf); }
1186 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset)
1188 struct fxp_xfer *xfer = xfer_init(fh, offset);
1191 xfer_download_queue(xfer);
1196 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1198 struct sftp_request *rreq;
1201 rreq = sftp_find_request(pktin);
1202 rr = (struct req *)fxp_get_userdata(rreq);
1204 return 0; /* this packet isn't ours */
1205 rr->retlen = fxp_read_recv(pktin, rreq, rr->buffer, rr->len);
1206 #ifdef DEBUG_DOWNLOAD
1207 printf("read request %p has returned [%d]\n", rr, rr->retlen);
1210 if ((rr->retlen < 0 && fxp_error_type()==SSH_FX_EOF) || rr->retlen == 0) {
1213 #ifdef DEBUG_DOWNLOAD
1214 printf("setting eof\n");
1216 } else if (rr->retlen < 0) {
1217 /* some error other than EOF; signal it back to caller */
1218 xfer_set_error(xfer);
1226 * Special case: if we have received fewer bytes than we
1227 * actually read, we should do something. For the moment I'll
1228 * just throw an ersatz FXP error to signal this; the SFTP
1229 * draft I've got says that it can't happen except on special
1230 * files, in which case seeking probably has very little
1231 * meaning and so queueing an additional read request to fill
1232 * up the gap sounds like the wrong answer. I'm not sure what I
1233 * should be doing here - if it _was_ a special file, I suspect
1234 * I simply shouldn't have been queueing multiple requests in
1235 * the first place...
1237 if (rr->retlen > 0 && uint64_compare(xfer->furthestdata, rr->offset) < 0) {
1238 xfer->furthestdata = rr->offset;
1239 #ifdef DEBUG_DOWNLOAD
1241 uint64_decimal(xfer->furthestdata, buf);
1242 printf("setting furthestdata = %s\n", buf); }
1246 if (rr->retlen < rr->len) {
1247 uint64 filesize = uint64_add32(rr->offset,
1248 (rr->retlen < 0 ? 0 : rr->retlen));
1249 #ifdef DEBUG_DOWNLOAD
1251 uint64_decimal(filesize, buf);
1252 printf("short block! trying filesize = %s\n", buf); }
1254 if (uint64_compare(xfer->filesize, filesize) > 0) {
1255 xfer->filesize = filesize;
1256 #ifdef DEBUG_DOWNLOAD
1257 printf("actually changing filesize\n");
1262 if (uint64_compare(xfer->furthestdata, xfer->filesize) > 0) {
1263 fxp_error_message = "received a short buffer from FXP_READ, but not"
1266 xfer_set_error(xfer);
1273 void xfer_set_error(struct fxp_xfer *xfer)
1278 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len)
1280 void *retbuf = NULL;
1284 * Discard anything at the head of the rr queue with complete <
1285 * 0; return the first thing with complete > 0.
1287 while (xfer->head && xfer->head->complete && !retbuf) {
1288 struct req *rr = xfer->head;
1290 if (rr->complete > 0) {
1291 retbuf = rr->buffer;
1292 retlen = rr->retlen;
1293 #ifdef DEBUG_DOWNLOAD
1294 printf("handing back data from read request %p\n", rr);
1297 #ifdef DEBUG_DOWNLOAD
1299 printf("skipping failed read request %p\n", rr);
1302 xfer->head = xfer->head->next;
1304 xfer->head->prev = NULL;
1307 xfer->req_totalsize -= rr->len;
1319 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset)
1321 struct fxp_xfer *xfer = xfer_init(fh, offset);
1324 * We set `eof' to 1 because this will cause xfer_done() to
1325 * return true iff there are no outstanding requests. During an
1326 * upload, our caller will be responsible for working out
1327 * whether all the data has been sent, so all it needs to know
1328 * from us is whether the outstanding requests have been
1329 * handled once that's done.
1336 int xfer_upload_ready(struct fxp_xfer *xfer)
1338 if (xfer->req_totalsize < xfer->req_maxsize)
1344 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len)
1347 struct sftp_request *req;
1349 rr = snew(struct req);
1350 rr->offset = xfer->offset;
1353 xfer->tail->next = rr;
1354 rr->prev = xfer->tail;
1364 sftp_register(req = fxp_write_send(xfer->fh, buffer, rr->offset, len));
1365 fxp_set_userdata(req, rr);
1367 xfer->offset = uint64_add32(xfer->offset, rr->len);
1368 xfer->req_totalsize += rr->len;
1371 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing write request %p at %s [len %d]\n", rr, buf, len); }
1375 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1377 struct sftp_request *rreq;
1378 struct req *rr, *prev, *next;
1381 rreq = sftp_find_request(pktin);
1382 rr = (struct req *)fxp_get_userdata(rreq);
1384 return 0; /* this packet isn't ours */
1385 ret = fxp_write_recv(pktin, rreq);
1387 printf("write request %p has returned [%d]\n", rr, ret);
1391 * Remove this one from the queue.
1403 xfer->req_totalsize -= rr->len;
1412 void xfer_cleanup(struct fxp_xfer *xfer)
1415 while (xfer->head) {
1417 xfer->head = xfer->head->next;