2 * sftp.c: SFTP generic client code.
16 #define GET_32BIT(cp) \
17 (((unsigned long)(unsigned char)(cp)[0] << 24) | \
18 ((unsigned long)(unsigned char)(cp)[1] << 16) | \
19 ((unsigned long)(unsigned char)(cp)[2] << 8) | \
20 ((unsigned long)(unsigned char)(cp)[3]))
22 #define PUT_32BIT(cp, value) { \
23 (cp)[0] = (unsigned char)((value) >> 24); \
24 (cp)[1] = (unsigned char)((value) >> 16); \
25 (cp)[2] = (unsigned char)((value) >> 8); \
26 (cp)[3] = (unsigned char)(value); }
35 static const char *fxp_error_message;
36 static int fxp_errtype;
38 static void fxp_internal_error(char *msg);
40 /* ----------------------------------------------------------------------
41 * SFTP packet construction functions.
43 static void sftp_pkt_ensure(struct sftp_packet *pkt, int length)
45 if (pkt->maxlen < length) {
46 pkt->maxlen = length + 256;
47 pkt->data = sresize(pkt->data, pkt->maxlen, char);
50 static void sftp_pkt_adddata(struct sftp_packet *pkt, void *data, int len)
53 sftp_pkt_ensure(pkt, pkt->length);
54 memcpy(pkt->data + pkt->length - len, data, len);
56 static void sftp_pkt_addbyte(struct sftp_packet *pkt, unsigned char byte)
58 sftp_pkt_adddata(pkt, &byte, 1);
60 static struct sftp_packet *sftp_pkt_init(int pkt_type)
62 struct sftp_packet *pkt;
63 pkt = snew(struct sftp_packet);
68 sftp_pkt_addbyte(pkt, (unsigned char) pkt_type);
72 static void sftp_pkt_addbool(struct sftp_packet *pkt, unsigned char value)
74 sftp_pkt_adddata(pkt, &value, 1);
77 static void sftp_pkt_adduint32(struct sftp_packet *pkt,
82 sftp_pkt_adddata(pkt, x, 4);
84 static void sftp_pkt_adduint64(struct sftp_packet *pkt, uint64 value)
87 PUT_32BIT(x, value.hi);
88 PUT_32BIT(x + 4, value.lo);
89 sftp_pkt_adddata(pkt, x, 8);
91 static void sftp_pkt_addstring_start(struct sftp_packet *pkt)
93 sftp_pkt_adduint32(pkt, 0);
94 pkt->savedpos = pkt->length;
96 static void sftp_pkt_addstring_str(struct sftp_packet *pkt, char *data)
98 sftp_pkt_adddata(pkt, data, strlen(data));
99 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
101 static void sftp_pkt_addstring_data(struct sftp_packet *pkt,
104 sftp_pkt_adddata(pkt, data, len);
105 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
107 static void sftp_pkt_addstring(struct sftp_packet *pkt, char *data)
109 sftp_pkt_addstring_start(pkt);
110 sftp_pkt_addstring_str(pkt, data);
112 static void sftp_pkt_addattrs(struct sftp_packet *pkt, struct fxp_attrs attrs)
114 sftp_pkt_adduint32(pkt, attrs.flags);
115 if (attrs.flags & SSH_FILEXFER_ATTR_SIZE) {
116 sftp_pkt_adduint32(pkt, attrs.size.hi);
117 sftp_pkt_adduint32(pkt, attrs.size.lo);
119 if (attrs.flags & SSH_FILEXFER_ATTR_UIDGID) {
120 sftp_pkt_adduint32(pkt, attrs.uid);
121 sftp_pkt_adduint32(pkt, attrs.gid);
123 if (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
124 sftp_pkt_adduint32(pkt, attrs.permissions);
126 if (attrs.flags & SSH_FILEXFER_ATTR_ACMODTIME) {
127 sftp_pkt_adduint32(pkt, attrs.atime);
128 sftp_pkt_adduint32(pkt, attrs.mtime);
130 if (attrs.flags & SSH_FILEXFER_ATTR_EXTENDED) {
132 * We currently don't support sending any extended
138 /* ----------------------------------------------------------------------
139 * SFTP packet decode functions.
142 static unsigned char sftp_pkt_getbyte(struct sftp_packet *pkt)
145 if (pkt->length - pkt->savedpos < 1)
146 return 0; /* arrgh, no way to decline (FIXME?) */
147 value = (unsigned char) pkt->data[pkt->savedpos];
151 static unsigned long sftp_pkt_getuint32(struct sftp_packet *pkt)
154 if (pkt->length - pkt->savedpos < 4)
155 return 0; /* arrgh, no way to decline (FIXME?) */
156 value = GET_32BIT(pkt->data + pkt->savedpos);
160 static void sftp_pkt_getstring(struct sftp_packet *pkt,
161 char **p, int *length)
164 if (pkt->length - pkt->savedpos < 4)
166 *length = GET_32BIT(pkt->data + pkt->savedpos);
168 if (pkt->length - pkt->savedpos < *length)
170 *p = pkt->data + pkt->savedpos;
171 pkt->savedpos += *length;
173 static struct fxp_attrs sftp_pkt_getattrs(struct sftp_packet *pkt)
175 struct fxp_attrs ret;
176 ret.flags = sftp_pkt_getuint32(pkt);
177 if (ret.flags & SSH_FILEXFER_ATTR_SIZE) {
178 unsigned long hi, lo;
179 hi = sftp_pkt_getuint32(pkt);
180 lo = sftp_pkt_getuint32(pkt);
181 ret.size = uint64_make(hi, lo);
183 if (ret.flags & SSH_FILEXFER_ATTR_UIDGID) {
184 ret.uid = sftp_pkt_getuint32(pkt);
185 ret.gid = sftp_pkt_getuint32(pkt);
187 if (ret.flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
188 ret.permissions = sftp_pkt_getuint32(pkt);
190 if (ret.flags & SSH_FILEXFER_ATTR_ACMODTIME) {
191 ret.atime = sftp_pkt_getuint32(pkt);
192 ret.mtime = sftp_pkt_getuint32(pkt);
194 if (ret.flags & SSH_FILEXFER_ATTR_EXTENDED) {
196 count = sftp_pkt_getuint32(pkt);
201 * We should try to analyse these, if we ever find one
204 sftp_pkt_getstring(pkt, &str, &len);
205 sftp_pkt_getstring(pkt, &str, &len);
210 static void sftp_pkt_free(struct sftp_packet *pkt)
217 /* ----------------------------------------------------------------------
218 * Send and receive packet functions.
220 int sftp_send(struct sftp_packet *pkt)
224 PUT_32BIT(x, pkt->length);
225 ret = (sftp_senddata(x, 4) && sftp_senddata(pkt->data, pkt->length));
229 struct sftp_packet *sftp_recv(void)
231 struct sftp_packet *pkt;
234 if (!sftp_recvdata(x, 4))
237 pkt = snew(struct sftp_packet);
239 pkt->length = pkt->maxlen = GET_32BIT(x);
240 pkt->data = snewn(pkt->length, char);
242 if (!sftp_recvdata(pkt->data, pkt->length)) {
247 pkt->type = sftp_pkt_getbyte(pkt);
252 /* ----------------------------------------------------------------------
253 * Request ID allocation and temporary dispatch routines.
256 #define REQUEST_ID_OFFSET 256
258 struct sftp_request {
264 static int sftp_reqcmp(void *av, void *bv)
266 struct sftp_request *a = (struct sftp_request *)av;
267 struct sftp_request *b = (struct sftp_request *)bv;
274 static int sftp_reqfind(void *av, void *bv)
276 unsigned *a = (unsigned *) av;
277 struct sftp_request *b = (struct sftp_request *)bv;
285 static tree234 *sftp_requests;
287 static struct sftp_request *sftp_alloc_request(void)
289 unsigned low, high, mid;
291 struct sftp_request *r;
293 if (sftp_requests == NULL)
294 sftp_requests = newtree234(sftp_reqcmp);
297 * First-fit allocation of request IDs: always pick the lowest
298 * unused one. To do this, binary-search using the counted
299 * B-tree to find the largest ID which is in a contiguous
300 * sequence from the beginning. (Precisely everything in that
301 * sequence must have ID equal to its tree index plus
302 * REQUEST_ID_OFFSET.)
304 tsize = count234(sftp_requests);
308 while (high - low > 1) {
309 mid = (high + low) / 2;
310 r = index234(sftp_requests, mid);
311 if (r->id == mid + REQUEST_ID_OFFSET)
312 low = mid; /* this one is fine */
314 high = mid; /* this one is past it */
317 * Now low points to either -1, or the tree index of the
318 * largest ID in the initial sequence.
321 unsigned i = low + 1 + REQUEST_ID_OFFSET;
322 assert(NULL == find234(sftp_requests, &i, sftp_reqfind));
326 * So the request ID we need to create is
327 * low + 1 + REQUEST_ID_OFFSET.
329 r = snew(struct sftp_request);
330 r->id = low + 1 + REQUEST_ID_OFFSET;
333 add234(sftp_requests, r);
337 void sftp_cleanup_request(void)
339 if (sftp_requests == NULL) {
340 freetree234(sftp_requests);
341 sftp_requests = NULL;
345 void sftp_register(struct sftp_request *req)
350 struct sftp_request *sftp_find_request(struct sftp_packet *pktin)
353 struct sftp_request *req;
356 fxp_internal_error("did not receive a valid SFTP packet\n");
360 id = sftp_pkt_getuint32(pktin);
361 req = find234(sftp_requests, &id, sftp_reqfind);
363 if (!req || !req->registered) {
364 fxp_internal_error("request ID mismatch\n");
365 sftp_pkt_free(pktin);
369 del234(sftp_requests, req);
374 /* ----------------------------------------------------------------------
375 * String handling routines.
378 static char *mkstr(char *s, int len)
380 char *p = snewn(len + 1, char);
386 /* ----------------------------------------------------------------------
391 * Deal with (and free) an FXP_STATUS packet. Return 1 if
392 * SSH_FX_OK, 0 if SSH_FX_EOF, and -1 for anything else (error).
393 * Also place the status into fxp_errtype.
395 static int fxp_got_status(struct sftp_packet *pktin)
397 static const char *const messages[] = {
398 /* SSH_FX_OK. The only time we will display a _message_ for this
399 * is if we were expecting something other than FXP_STATUS on
400 * success, so this is actually an error message! */
401 "unexpected OK response",
403 "no such file or directory",
409 "operation unsupported",
412 if (pktin->type != SSH_FXP_STATUS) {
413 fxp_error_message = "expected FXP_STATUS packet";
416 fxp_errtype = sftp_pkt_getuint32(pktin);
417 if (fxp_errtype < 0 ||
418 fxp_errtype >= sizeof(messages) / sizeof(*messages))
419 fxp_error_message = "unknown error code";
421 fxp_error_message = messages[fxp_errtype];
424 if (fxp_errtype == SSH_FX_OK)
426 else if (fxp_errtype == SSH_FX_EOF)
432 static void fxp_internal_error(char *msg)
434 fxp_error_message = msg;
438 const char *fxp_error(void)
440 return fxp_error_message;
443 int fxp_error_type(void)
449 * Perform exchange of init/version packets. Return 0 on failure.
453 struct sftp_packet *pktout, *pktin;
456 pktout = sftp_pkt_init(SSH_FXP_INIT);
457 sftp_pkt_adduint32(pktout, SFTP_PROTO_VERSION);
462 fxp_internal_error("could not connect");
465 if (pktin->type != SSH_FXP_VERSION) {
466 fxp_internal_error("did not receive FXP_VERSION");
467 sftp_pkt_free(pktin);
470 remotever = sftp_pkt_getuint32(pktin);
471 if (remotever > SFTP_PROTO_VERSION) {
473 ("remote protocol is more advanced than we support");
474 sftp_pkt_free(pktin);
478 * In principle, this packet might also contain extension-
479 * string pairs. We should work through them and look for any
480 * we recognise. In practice we don't currently do so because
481 * we know we don't recognise _any_.
483 sftp_pkt_free(pktin);
489 * Canonify a pathname.
491 struct sftp_request *fxp_realpath_send(char *path)
493 struct sftp_request *req = sftp_alloc_request();
494 struct sftp_packet *pktout;
496 pktout = sftp_pkt_init(SSH_FXP_REALPATH);
497 sftp_pkt_adduint32(pktout, req->id);
498 sftp_pkt_addstring_start(pktout);
499 sftp_pkt_addstring_str(pktout, path);
505 char *fxp_realpath_recv(struct sftp_packet *pktin, struct sftp_request *req)
509 if (pktin->type == SSH_FXP_NAME) {
514 count = sftp_pkt_getuint32(pktin);
516 fxp_internal_error("REALPATH returned name count != 1\n");
517 sftp_pkt_free(pktin);
520 sftp_pkt_getstring(pktin, &path, &len);
522 fxp_internal_error("REALPATH returned malformed FXP_NAME\n");
523 sftp_pkt_free(pktin);
526 path = mkstr(path, len);
527 sftp_pkt_free(pktin);
530 fxp_got_status(pktin);
531 sftp_pkt_free(pktin);
539 struct sftp_request *fxp_open_send(char *path, int type)
541 struct sftp_request *req = sftp_alloc_request();
542 struct sftp_packet *pktout;
544 pktout = sftp_pkt_init(SSH_FXP_OPEN);
545 sftp_pkt_adduint32(pktout, req->id);
546 sftp_pkt_addstring(pktout, path);
547 sftp_pkt_adduint32(pktout, type);
548 sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */
554 struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
555 struct sftp_request *req)
559 if (pktin->type == SSH_FXP_HANDLE) {
561 struct fxp_handle *handle;
564 sftp_pkt_getstring(pktin, &hstring, &len);
566 fxp_internal_error("OPEN returned malformed FXP_HANDLE\n");
567 sftp_pkt_free(pktin);
570 handle = snew(struct fxp_handle);
571 handle->hstring = mkstr(hstring, len);
573 sftp_pkt_free(pktin);
576 fxp_got_status(pktin);
577 sftp_pkt_free(pktin);
585 struct sftp_request *fxp_opendir_send(char *path)
587 struct sftp_request *req = sftp_alloc_request();
588 struct sftp_packet *pktout;
590 pktout = sftp_pkt_init(SSH_FXP_OPENDIR);
591 sftp_pkt_adduint32(pktout, req->id);
592 sftp_pkt_addstring(pktout, path);
598 struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
599 struct sftp_request *req)
602 if (pktin->type == SSH_FXP_HANDLE) {
604 struct fxp_handle *handle;
607 sftp_pkt_getstring(pktin, &hstring, &len);
609 fxp_internal_error("OPENDIR returned malformed FXP_HANDLE\n");
610 sftp_pkt_free(pktin);
613 handle = snew(struct fxp_handle);
614 handle->hstring = mkstr(hstring, len);
616 sftp_pkt_free(pktin);
619 fxp_got_status(pktin);
620 sftp_pkt_free(pktin);
628 struct sftp_request *fxp_close_send(struct fxp_handle *handle)
630 struct sftp_request *req = sftp_alloc_request();
631 struct sftp_packet *pktout;
633 pktout = sftp_pkt_init(SSH_FXP_CLOSE);
634 sftp_pkt_adduint32(pktout, req->id);
635 sftp_pkt_addstring_start(pktout);
636 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
639 sfree(handle->hstring);
645 void fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req)
648 fxp_got_status(pktin);
649 sftp_pkt_free(pktin);
652 struct sftp_request *fxp_mkdir_send(char *path)
654 struct sftp_request *req = sftp_alloc_request();
655 struct sftp_packet *pktout;
657 pktout = sftp_pkt_init(SSH_FXP_MKDIR);
658 sftp_pkt_adduint32(pktout, req->id);
659 sftp_pkt_addstring(pktout, path);
660 sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */
666 int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
670 id = fxp_got_status(pktin);
671 sftp_pkt_free(pktin);
678 struct sftp_request *fxp_rmdir_send(char *path)
680 struct sftp_request *req = sftp_alloc_request();
681 struct sftp_packet *pktout;
683 pktout = sftp_pkt_init(SSH_FXP_RMDIR);
684 sftp_pkt_adduint32(pktout, req->id);
685 sftp_pkt_addstring(pktout, path);
691 int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
695 id = fxp_got_status(pktin);
696 sftp_pkt_free(pktin);
703 struct sftp_request *fxp_remove_send(char *fname)
705 struct sftp_request *req = sftp_alloc_request();
706 struct sftp_packet *pktout;
708 pktout = sftp_pkt_init(SSH_FXP_REMOVE);
709 sftp_pkt_adduint32(pktout, req->id);
710 sftp_pkt_addstring(pktout, fname);
716 int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req)
720 id = fxp_got_status(pktin);
721 sftp_pkt_free(pktin);
728 struct sftp_request *fxp_rename_send(char *srcfname, char *dstfname)
730 struct sftp_request *req = sftp_alloc_request();
731 struct sftp_packet *pktout;
733 pktout = sftp_pkt_init(SSH_FXP_RENAME);
734 sftp_pkt_adduint32(pktout, req->id);
735 sftp_pkt_addstring(pktout, srcfname);
736 sftp_pkt_addstring(pktout, dstfname);
742 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req)
746 id = fxp_got_status(pktin);
747 sftp_pkt_free(pktin);
755 * Retrieve the attributes of a file. We have fxp_stat which works
756 * on filenames, and fxp_fstat which works on open file handles.
758 struct sftp_request *fxp_stat_send(char *fname)
760 struct sftp_request *req = sftp_alloc_request();
761 struct sftp_packet *pktout;
763 pktout = sftp_pkt_init(SSH_FXP_STAT);
764 sftp_pkt_adduint32(pktout, req->id);
765 sftp_pkt_addstring(pktout, fname);
771 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
772 struct fxp_attrs *attrs)
775 if (pktin->type == SSH_FXP_ATTRS) {
776 *attrs = sftp_pkt_getattrs(pktin);
777 sftp_pkt_free(pktin);
780 fxp_got_status(pktin);
781 sftp_pkt_free(pktin);
786 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle)
788 struct sftp_request *req = sftp_alloc_request();
789 struct sftp_packet *pktout;
791 pktout = sftp_pkt_init(SSH_FXP_FSTAT);
792 sftp_pkt_adduint32(pktout, req->id);
793 sftp_pkt_addstring_start(pktout);
794 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
800 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
801 struct fxp_attrs *attrs)
804 if (pktin->type == SSH_FXP_ATTRS) {
805 *attrs = sftp_pkt_getattrs(pktin);
806 sftp_pkt_free(pktin);
809 fxp_got_status(pktin);
810 sftp_pkt_free(pktin);
816 * Set the attributes of a file.
818 struct sftp_request *fxp_setstat_send(char *fname, struct fxp_attrs attrs)
820 struct sftp_request *req = sftp_alloc_request();
821 struct sftp_packet *pktout;
823 pktout = sftp_pkt_init(SSH_FXP_SETSTAT);
824 sftp_pkt_adduint32(pktout, req->id);
825 sftp_pkt_addstring(pktout, fname);
826 sftp_pkt_addattrs(pktout, attrs);
832 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
836 id = fxp_got_status(pktin);
837 sftp_pkt_free(pktin);
844 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
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_FSETSTAT);
851 sftp_pkt_adduint32(pktout, req->id);
852 sftp_pkt_addstring_start(pktout);
853 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
854 sftp_pkt_addattrs(pktout, attrs);
860 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
864 id = fxp_got_status(pktin);
865 sftp_pkt_free(pktin);
873 * Read from a file. Returns the number of bytes read, or -1 on an
874 * error, or possibly 0 if EOF. (I'm not entirely sure whether it
875 * will return 0 on EOF, or return -1 and store SSH_FX_EOF in the
876 * error indicator. It might even depend on the SFTP server.)
878 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
879 uint64 offset, int len)
881 struct sftp_request *req = sftp_alloc_request();
882 struct sftp_packet *pktout;
884 pktout = sftp_pkt_init(SSH_FXP_READ);
885 sftp_pkt_adduint32(pktout, req->id);
886 sftp_pkt_addstring_start(pktout);
887 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
888 sftp_pkt_adduint64(pktout, offset);
889 sftp_pkt_adduint32(pktout, len);
895 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
896 char *buffer, int len)
899 if (pktin->type == SSH_FXP_DATA) {
903 sftp_pkt_getstring(pktin, &str, &rlen);
905 if (rlen > len || rlen < 0) {
906 fxp_internal_error("READ returned more bytes than requested");
907 sftp_pkt_free(pktin);
911 memcpy(buffer, str, rlen);
912 sftp_pkt_free(pktin);
915 fxp_got_status(pktin);
916 sftp_pkt_free(pktin);
922 * Read from a directory.
924 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle)
926 struct sftp_request *req = sftp_alloc_request();
927 struct sftp_packet *pktout;
929 pktout = sftp_pkt_init(SSH_FXP_READDIR);
930 sftp_pkt_adduint32(pktout, req->id);
931 sftp_pkt_addstring_start(pktout);
932 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
938 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
939 struct sftp_request *req)
942 if (pktin->type == SSH_FXP_NAME) {
943 struct fxp_names *ret;
945 ret = snew(struct fxp_names);
946 ret->nnames = sftp_pkt_getuint32(pktin);
947 ret->names = snewn(ret->nnames, struct fxp_name);
948 for (i = 0; i < ret->nnames; i++) {
951 sftp_pkt_getstring(pktin, &str, &len);
952 ret->names[i].filename = mkstr(str, len);
953 sftp_pkt_getstring(pktin, &str, &len);
954 ret->names[i].longname = mkstr(str, len);
955 ret->names[i].attrs = sftp_pkt_getattrs(pktin);
957 sftp_pkt_free(pktin);
960 fxp_got_status(pktin);
961 sftp_pkt_free(pktin);
967 * Write to a file. Returns 0 on error, 1 on OK.
969 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
970 char *buffer, uint64 offset, int len)
972 struct sftp_request *req = sftp_alloc_request();
973 struct sftp_packet *pktout;
975 pktout = sftp_pkt_init(SSH_FXP_WRITE);
976 sftp_pkt_adduint32(pktout, req->id);
977 sftp_pkt_addstring_start(pktout);
978 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
979 sftp_pkt_adduint64(pktout, offset);
980 sftp_pkt_addstring_start(pktout);
981 sftp_pkt_addstring_data(pktout, buffer, len);
987 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req)
990 fxp_got_status(pktin);
991 sftp_pkt_free(pktin);
992 return fxp_errtype == SSH_FX_OK;
996 * Free up an fxp_names structure.
998 void fxp_free_names(struct fxp_names *names)
1002 for (i = 0; i < names->nnames; i++) {
1003 sfree(names->names[i].filename);
1004 sfree(names->names[i].longname);
1006 sfree(names->names);
1011 * Duplicate an fxp_name structure.
1013 struct fxp_name *fxp_dup_name(struct fxp_name *name)
1015 struct fxp_name *ret;
1016 ret = snew(struct fxp_name);
1017 ret->filename = dupstr(name->filename);
1018 ret->longname = dupstr(name->longname);
1019 ret->attrs = name->attrs; /* structure copy */
1024 * Free up an fxp_name structure.
1026 void fxp_free_name(struct fxp_name *name)
1028 sfree(name->filename);
1029 sfree(name->longname);
1034 * Store user data in an sftp_request structure.
1036 void *fxp_get_userdata(struct sftp_request *req)
1038 return req->userdata;
1041 void fxp_set_userdata(struct sftp_request *req, void *data)
1043 req->userdata = data;
1047 * A wrapper to go round fxp_read_* and fxp_write_*, which manages
1048 * the queueing of multiple read/write requests.
1053 int len, retlen, complete;
1055 struct req *next, *prev;
1059 uint64 offset, furthestdata, filesize;
1060 int req_totalsize, req_maxsize, eof, err;
1061 struct fxp_handle *fh;
1062 struct req *head, *tail;
1065 static struct fxp_xfer *xfer_init(struct fxp_handle *fh, uint64 offset)
1067 struct fxp_xfer *xfer = snew(struct fxp_xfer);
1070 xfer->offset = offset;
1071 xfer->head = xfer->tail = NULL;
1072 xfer->req_totalsize = 0;
1073 xfer->req_maxsize = 16384;
1075 xfer->filesize = uint64_make(ULONG_MAX, ULONG_MAX);
1076 xfer->furthestdata = uint64_make(0, 0);
1081 int xfer_done(struct fxp_xfer *xfer)
1084 * We're finished if we've seen EOF _and_ there are no
1085 * outstanding requests.
1087 return (xfer->eof || xfer->err) && !xfer->head;
1090 void xfer_download_queue(struct fxp_xfer *xfer)
1092 while (xfer->req_totalsize < xfer->req_maxsize &&
1093 !xfer->eof && !xfer->err) {
1095 * Queue a new read request.
1098 struct sftp_request *req;
1100 rr = snew(struct req);
1101 rr->offset = xfer->offset;
1104 xfer->tail->next = rr;
1105 rr->prev = xfer->tail;
1114 rr->buffer = snewn(rr->len, char);
1115 sftp_register(req = fxp_read_send(xfer->fh, rr->offset, rr->len));
1116 fxp_set_userdata(req, rr);
1118 xfer->offset = uint64_add32(xfer->offset, rr->len);
1119 xfer->req_totalsize += rr->len;
1121 #ifdef DEBUG_DOWNLOAD
1122 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing read request %p at %s\n", rr, buf); }
1127 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset)
1129 struct fxp_xfer *xfer = xfer_init(fh, offset);
1132 xfer_download_queue(xfer);
1137 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1139 struct sftp_request *rreq;
1142 rreq = sftp_find_request(pktin);
1143 rr = (struct req *)fxp_get_userdata(rreq);
1145 return 0; /* this packet isn't ours */
1146 rr->retlen = fxp_read_recv(pktin, rreq, rr->buffer, rr->len);
1147 #ifdef DEBUG_DOWNLOAD
1148 printf("read request %p has returned [%d]\n", rr, rr->retlen);
1151 if ((rr->retlen < 0 && fxp_error_type()==SSH_FX_EOF) || rr->retlen == 0) {
1154 #ifdef DEBUG_DOWNLOAD
1155 printf("setting eof\n");
1157 } else if (rr->retlen < 0) {
1158 /* some error other than EOF; signal it back to caller */
1159 xfer_set_error(xfer);
1167 * Special case: if we have received fewer bytes than we
1168 * actually read, we should do something. For the moment I'll
1169 * just throw an ersatz FXP error to signal this; the SFTP
1170 * draft I've got says that it can't happen except on special
1171 * files, in which case seeking probably has very little
1172 * meaning and so queueing an additional read request to fill
1173 * up the gap sounds like the wrong answer. I'm not sure what I
1174 * should be doing here - if it _was_ a special file, I suspect
1175 * I simply shouldn't have been queueing multiple requests in
1176 * the first place...
1178 if (rr->retlen > 0 && uint64_compare(xfer->furthestdata, rr->offset) < 0) {
1179 xfer->furthestdata = rr->offset;
1180 #ifdef DEBUG_DOWNLOAD
1182 uint64_decimal(xfer->furthestdata, buf);
1183 printf("setting furthestdata = %s\n", buf); }
1187 if (rr->retlen < rr->len) {
1188 uint64 filesize = uint64_add32(rr->offset,
1189 (rr->retlen < 0 ? 0 : rr->retlen));
1190 #ifdef DEBUG_DOWNLOAD
1192 uint64_decimal(filesize, buf);
1193 printf("short block! trying filesize = %s\n", buf); }
1195 if (uint64_compare(xfer->filesize, filesize) > 0) {
1196 xfer->filesize = filesize;
1197 #ifdef DEBUG_DOWNLOAD
1198 printf("actually changing filesize\n");
1203 if (uint64_compare(xfer->furthestdata, xfer->filesize) > 0) {
1204 fxp_error_message = "received a short buffer from FXP_READ, but not"
1207 xfer_set_error(xfer);
1214 void xfer_set_error(struct fxp_xfer *xfer)
1219 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len)
1221 void *retbuf = NULL;
1225 * Discard anything at the head of the rr queue with complete <
1226 * 0; return the first thing with complete > 0.
1228 while (xfer->head && xfer->head->complete && !retbuf) {
1229 struct req *rr = xfer->head;
1231 if (rr->complete > 0) {
1232 retbuf = rr->buffer;
1233 retlen = rr->retlen;
1234 #ifdef DEBUG_DOWNLOAD
1235 printf("handing back data from read request %p\n", rr);
1238 #ifdef DEBUG_DOWNLOAD
1240 printf("skipping failed read request %p\n", rr);
1243 xfer->head = xfer->head->next;
1245 xfer->head->prev = NULL;
1248 xfer->req_totalsize -= rr->len;
1260 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset)
1262 struct fxp_xfer *xfer = xfer_init(fh, offset);
1265 * We set `eof' to 1 because this will cause xfer_done() to
1266 * return true iff there are no outstanding requests. During an
1267 * upload, our caller will be responsible for working out
1268 * whether all the data has been sent, so all it needs to know
1269 * from us is whether the outstanding requests have been
1270 * handled once that's done.
1277 int xfer_upload_ready(struct fxp_xfer *xfer)
1279 if (xfer->req_totalsize < xfer->req_maxsize)
1285 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len)
1288 struct sftp_request *req;
1290 rr = snew(struct req);
1291 rr->offset = xfer->offset;
1294 xfer->tail->next = rr;
1295 rr->prev = xfer->tail;
1305 sftp_register(req = fxp_write_send(xfer->fh, buffer, rr->offset, len));
1306 fxp_set_userdata(req, rr);
1308 xfer->offset = uint64_add32(xfer->offset, rr->len);
1309 xfer->req_totalsize += rr->len;
1312 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing write request %p at %s [len %d]\n", rr, buf, len); }
1316 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
1318 struct sftp_request *rreq;
1319 struct req *rr, *prev, *next;
1322 rreq = sftp_find_request(pktin);
1323 rr = (struct req *)fxp_get_userdata(rreq);
1325 return 0; /* this packet isn't ours */
1326 ret = fxp_write_recv(pktin, rreq);
1328 printf("write request %p has returned [%d]\n", rr, ret);
1332 * Remove this one from the queue.
1344 xfer->req_totalsize -= rr->len;
1353 void xfer_cleanup(struct fxp_xfer *xfer)
1356 while (xfer->head) {
1358 xfer->head = xfer->head->next;