2 * sftp.c: SFTP generic client code.
\r
13 #include "tree234.h"
\r
16 struct sftp_packet {
\r
18 unsigned length, maxlen;
\r
23 static const char *fxp_error_message;
\r
24 static int fxp_errtype;
\r
26 static void fxp_internal_error(char *msg);
\r
28 /* ----------------------------------------------------------------------
\r
29 * SFTP packet construction functions.
\r
31 static void sftp_pkt_ensure(struct sftp_packet *pkt, int length)
\r
33 if ((int)pkt->maxlen < length) {
\r
34 pkt->maxlen = length + 256;
\r
35 pkt->data = sresize(pkt->data, pkt->maxlen, char);
\r
38 static void sftp_pkt_adddata(struct sftp_packet *pkt, void *data, int len)
\r
41 sftp_pkt_ensure(pkt, pkt->length);
\r
42 memcpy(pkt->data + pkt->length - len, data, len);
\r
44 static void sftp_pkt_addbyte(struct sftp_packet *pkt, unsigned char byte)
\r
46 sftp_pkt_adddata(pkt, &byte, 1);
\r
48 static struct sftp_packet *sftp_pkt_init(int pkt_type)
\r
50 struct sftp_packet *pkt;
\r
51 pkt = snew(struct sftp_packet);
\r
56 sftp_pkt_addbyte(pkt, (unsigned char) pkt_type);
\r
60 static void sftp_pkt_addbool(struct sftp_packet *pkt, unsigned char value)
\r
62 sftp_pkt_adddata(pkt, &value, 1);
\r
65 static void sftp_pkt_adduint32(struct sftp_packet *pkt,
\r
66 unsigned long value)
\r
69 PUT_32BIT(x, value);
\r
70 sftp_pkt_adddata(pkt, x, 4);
\r
72 static void sftp_pkt_adduint64(struct sftp_packet *pkt, uint64 value)
\r
75 PUT_32BIT(x, value.hi);
\r
76 PUT_32BIT(x + 4, value.lo);
\r
77 sftp_pkt_adddata(pkt, x, 8);
\r
79 static void sftp_pkt_addstring_start(struct sftp_packet *pkt)
\r
81 sftp_pkt_adduint32(pkt, 0);
\r
82 pkt->savedpos = pkt->length;
\r
84 static void sftp_pkt_addstring_str(struct sftp_packet *pkt, char *data)
\r
86 sftp_pkt_adddata(pkt, data, strlen(data));
\r
87 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
\r
89 static void sftp_pkt_addstring_data(struct sftp_packet *pkt,
\r
90 char *data, int len)
\r
92 sftp_pkt_adddata(pkt, data, len);
\r
93 PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos);
\r
95 static void sftp_pkt_addstring(struct sftp_packet *pkt, char *data)
\r
97 sftp_pkt_addstring_start(pkt);
\r
98 sftp_pkt_addstring_str(pkt, data);
\r
100 static void sftp_pkt_addattrs(struct sftp_packet *pkt, struct fxp_attrs attrs)
\r
102 sftp_pkt_adduint32(pkt, attrs.flags);
\r
103 if (attrs.flags & SSH_FILEXFER_ATTR_SIZE) {
\r
104 sftp_pkt_adduint32(pkt, attrs.size.hi);
\r
105 sftp_pkt_adduint32(pkt, attrs.size.lo);
\r
107 if (attrs.flags & SSH_FILEXFER_ATTR_UIDGID) {
\r
108 sftp_pkt_adduint32(pkt, attrs.uid);
\r
109 sftp_pkt_adduint32(pkt, attrs.gid);
\r
111 if (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
\r
112 sftp_pkt_adduint32(pkt, attrs.permissions);
\r
114 if (attrs.flags & SSH_FILEXFER_ATTR_ACMODTIME) {
\r
115 sftp_pkt_adduint32(pkt, attrs.atime);
\r
116 sftp_pkt_adduint32(pkt, attrs.mtime);
\r
118 if (attrs.flags & SSH_FILEXFER_ATTR_EXTENDED) {
\r
120 * We currently don't support sending any extended
\r
126 /* ----------------------------------------------------------------------
\r
127 * SFTP packet decode functions.
\r
130 static int sftp_pkt_getbyte(struct sftp_packet *pkt, unsigned char *ret)
\r
132 if (pkt->length - pkt->savedpos < 1)
\r
134 *ret = (unsigned char) pkt->data[pkt->savedpos];
\r
138 static int sftp_pkt_getuint32(struct sftp_packet *pkt, unsigned long *ret)
\r
140 if (pkt->length - pkt->savedpos < 4)
\r
142 *ret = GET_32BIT(pkt->data + pkt->savedpos);
\r
143 pkt->savedpos += 4;
\r
146 static int sftp_pkt_getstring(struct sftp_packet *pkt,
\r
147 char **p, int *length)
\r
150 if (pkt->length - pkt->savedpos < 4)
\r
152 *length = GET_32BIT(pkt->data + pkt->savedpos);
\r
153 pkt->savedpos += 4;
\r
154 if ((int)(pkt->length - pkt->savedpos) < *length || *length < 0) {
\r
158 *p = pkt->data + pkt->savedpos;
\r
159 pkt->savedpos += *length;
\r
162 static int sftp_pkt_getattrs(struct sftp_packet *pkt, struct fxp_attrs *ret)
\r
164 if (!sftp_pkt_getuint32(pkt, &ret->flags))
\r
166 if (ret->flags & SSH_FILEXFER_ATTR_SIZE) {
\r
167 unsigned long hi, lo;
\r
168 if (!sftp_pkt_getuint32(pkt, &hi) ||
\r
169 !sftp_pkt_getuint32(pkt, &lo))
\r
171 ret->size = uint64_make(hi, lo);
\r
173 if (ret->flags & SSH_FILEXFER_ATTR_UIDGID) {
\r
174 if (!sftp_pkt_getuint32(pkt, &ret->uid) ||
\r
175 !sftp_pkt_getuint32(pkt, &ret->gid))
\r
178 if (ret->flags & SSH_FILEXFER_ATTR_PERMISSIONS) {
\r
179 if (!sftp_pkt_getuint32(pkt, &ret->permissions))
\r
182 if (ret->flags & SSH_FILEXFER_ATTR_ACMODTIME) {
\r
183 if (!sftp_pkt_getuint32(pkt, &ret->atime) ||
\r
184 !sftp_pkt_getuint32(pkt, &ret->mtime))
\r
187 if (ret->flags & SSH_FILEXFER_ATTR_EXTENDED) {
\r
188 unsigned long count;
\r
189 if (!sftp_pkt_getuint32(pkt, &count))
\r
195 * We should try to analyse these, if we ever find one
\r
198 if (!sftp_pkt_getstring(pkt, &str, &len) ||
\r
199 !sftp_pkt_getstring(pkt, &str, &len))
\r
205 static void sftp_pkt_free(struct sftp_packet *pkt)
\r
212 /* ----------------------------------------------------------------------
\r
213 * Send and receive packet functions.
\r
215 int sftp_send(struct sftp_packet *pkt)
\r
219 PUT_32BIT(x, pkt->length);
\r
220 ret = (sftp_senddata(x, 4) && sftp_senddata(pkt->data, pkt->length));
\r
221 sftp_pkt_free(pkt);
\r
224 struct sftp_packet *sftp_recv(void)
\r
226 struct sftp_packet *pkt;
\r
230 if (!sftp_recvdata(x, 4))
\r
233 pkt = snew(struct sftp_packet);
\r
235 pkt->length = pkt->maxlen = GET_32BIT(x);
\r
236 pkt->data = snewn(pkt->length, char);
\r
238 if (!sftp_recvdata(pkt->data, pkt->length)) {
\r
239 sftp_pkt_free(pkt);
\r
243 if (!sftp_pkt_getbyte(pkt, &uc)) {
\r
244 sftp_pkt_free(pkt);
\r
253 /* ----------------------------------------------------------------------
\r
254 * Request ID allocation and temporary dispatch routines.
\r
257 #define REQUEST_ID_OFFSET 256
\r
259 struct sftp_request {
\r
265 static int sftp_reqcmp(void *av, void *bv)
\r
267 struct sftp_request *a = (struct sftp_request *)av;
\r
268 struct sftp_request *b = (struct sftp_request *)bv;
\r
275 static int sftp_reqfind(void *av, void *bv)
\r
277 unsigned *a = (unsigned *) av;
\r
278 struct sftp_request *b = (struct sftp_request *)bv;
\r
286 static tree234 *sftp_requests;
\r
288 static struct sftp_request *sftp_alloc_request(void)
\r
290 unsigned low, high, mid;
\r
292 struct sftp_request *r;
\r
294 if (sftp_requests == NULL)
\r
295 sftp_requests = newtree234(sftp_reqcmp);
\r
298 * First-fit allocation of request IDs: always pick the lowest
\r
299 * unused one. To do this, binary-search using the counted
\r
300 * B-tree to find the largest ID which is in a contiguous
\r
301 * sequence from the beginning. (Precisely everything in that
\r
302 * sequence must have ID equal to its tree index plus
\r
303 * REQUEST_ID_OFFSET.)
\r
305 tsize = count234(sftp_requests);
\r
309 while (high - low > 1) {
\r
310 mid = (high + low) / 2;
\r
311 r = index234(sftp_requests, mid);
\r
312 if (r->id == mid + REQUEST_ID_OFFSET)
\r
313 low = mid; /* this one is fine */
\r
315 high = mid; /* this one is past it */
\r
318 * Now low points to either -1, or the tree index of the
\r
319 * largest ID in the initial sequence.
\r
322 unsigned i = low + 1 + REQUEST_ID_OFFSET;
\r
323 assert(NULL == find234(sftp_requests, &i, sftp_reqfind));
\r
327 * So the request ID we need to create is
\r
328 * low + 1 + REQUEST_ID_OFFSET.
\r
330 r = snew(struct sftp_request);
\r
331 r->id = low + 1 + REQUEST_ID_OFFSET;
\r
333 r->userdata = NULL;
\r
334 add234(sftp_requests, r);
\r
338 void sftp_cleanup_request(void)
\r
340 if (sftp_requests != NULL) {
\r
341 freetree234(sftp_requests);
\r
342 sftp_requests = NULL;
\r
346 void sftp_register(struct sftp_request *req)
\r
348 req->registered = 1;
\r
351 struct sftp_request *sftp_find_request(struct sftp_packet *pktin)
\r
354 struct sftp_request *req;
\r
357 fxp_internal_error("did not receive a valid SFTP packet\n");
\r
361 if (!sftp_pkt_getuint32(pktin, &id)) {
\r
362 fxp_internal_error("did not receive a valid SFTP packet\n");
\r
365 req = find234(sftp_requests, &id, sftp_reqfind);
\r
367 if (!req || !req->registered) {
\r
368 fxp_internal_error("request ID mismatch\n");
\r
369 sftp_pkt_free(pktin);
\r
373 del234(sftp_requests, req);
\r
378 /* ----------------------------------------------------------------------
\r
379 * String handling routines.
\r
382 static char *mkstr(char *s, int len)
\r
384 char *p = snewn(len + 1, char);
\r
390 /* ----------------------------------------------------------------------
\r
395 * Deal with (and free) an FXP_STATUS packet. Return 1 if
\r
396 * SSH_FX_OK, 0 if SSH_FX_EOF, and -1 for anything else (error).
\r
397 * Also place the status into fxp_errtype.
\r
399 static int fxp_got_status(struct sftp_packet *pktin)
\r
401 static const char *const messages[] = {
\r
402 /* SSH_FX_OK. The only time we will display a _message_ for this
\r
403 * is if we were expecting something other than FXP_STATUS on
\r
404 * success, so this is actually an error message! */
\r
405 "unexpected OK response",
\r
407 "no such file or directory",
\r
408 "permission denied",
\r
413 "operation unsupported",
\r
416 if (pktin->type != SSH_FXP_STATUS) {
\r
417 fxp_error_message = "expected FXP_STATUS packet";
\r
421 if (!sftp_pkt_getuint32(pktin, &ul)) {
\r
422 fxp_error_message = "malformed FXP_STATUS packet";
\r
426 if (fxp_errtype < 0 ||
\r
427 fxp_errtype >= sizeof(messages) / sizeof(*messages))
\r
428 fxp_error_message = "unknown error code";
\r
430 fxp_error_message = messages[fxp_errtype];
\r
434 if (fxp_errtype == SSH_FX_OK)
\r
436 else if (fxp_errtype == SSH_FX_EOF)
\r
442 static void fxp_internal_error(char *msg)
\r
444 fxp_error_message = msg;
\r
448 const char *fxp_error(void)
\r
450 return fxp_error_message;
\r
453 int fxp_error_type(void)
\r
455 return fxp_errtype;
\r
459 * Perform exchange of init/version packets. Return 0 on failure.
\r
463 struct sftp_packet *pktout, *pktin;
\r
464 unsigned long remotever;
\r
466 pktout = sftp_pkt_init(SSH_FXP_INIT);
\r
467 sftp_pkt_adduint32(pktout, SFTP_PROTO_VERSION);
\r
470 pktin = sftp_recv();
\r
472 fxp_internal_error("could not connect");
\r
475 if (pktin->type != SSH_FXP_VERSION) {
\r
476 fxp_internal_error("did not receive FXP_VERSION");
\r
477 sftp_pkt_free(pktin);
\r
480 if (!sftp_pkt_getuint32(pktin, &remotever)) {
\r
481 fxp_internal_error("malformed FXP_VERSION packet");
\r
482 sftp_pkt_free(pktin);
\r
485 if (remotever > SFTP_PROTO_VERSION) {
\r
487 ("remote protocol is more advanced than we support");
\r
488 sftp_pkt_free(pktin);
\r
492 * In principle, this packet might also contain extension-
\r
493 * string pairs. We should work through them and look for any
\r
494 * we recognise. In practice we don't currently do so because
\r
495 * we know we don't recognise _any_.
\r
497 sftp_pkt_free(pktin);
\r
503 * Canonify a pathname.
\r
505 struct sftp_request *fxp_realpath_send(char *path)
\r
507 struct sftp_request *req = sftp_alloc_request();
\r
508 struct sftp_packet *pktout;
\r
510 pktout = sftp_pkt_init(SSH_FXP_REALPATH);
\r
511 sftp_pkt_adduint32(pktout, req->id);
\r
512 sftp_pkt_addstring_start(pktout);
\r
513 sftp_pkt_addstring_str(pktout, path);
\r
519 char *fxp_realpath_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
523 if (pktin->type == SSH_FXP_NAME) {
\r
524 unsigned long count;
\r
528 if (!sftp_pkt_getuint32(pktin, &count) || count != 1) {
\r
529 fxp_internal_error("REALPATH did not return name count of 1\n");
\r
530 sftp_pkt_free(pktin);
\r
533 if (!sftp_pkt_getstring(pktin, &path, &len)) {
\r
534 fxp_internal_error("REALPATH returned malformed FXP_NAME\n");
\r
535 sftp_pkt_free(pktin);
\r
538 path = mkstr(path, len);
\r
539 sftp_pkt_free(pktin);
\r
542 fxp_got_status(pktin);
\r
543 sftp_pkt_free(pktin);
\r
551 struct sftp_request *fxp_open_send(char *path, int type)
\r
553 struct sftp_request *req = sftp_alloc_request();
\r
554 struct sftp_packet *pktout;
\r
556 pktout = sftp_pkt_init(SSH_FXP_OPEN);
\r
557 sftp_pkt_adduint32(pktout, req->id);
\r
558 sftp_pkt_addstring(pktout, path);
\r
559 sftp_pkt_adduint32(pktout, type);
\r
560 sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */
\r
566 struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
\r
567 struct sftp_request *req)
\r
571 if (pktin->type == SSH_FXP_HANDLE) {
\r
573 struct fxp_handle *handle;
\r
576 if (!sftp_pkt_getstring(pktin, &hstring, &len)) {
\r
577 fxp_internal_error("OPEN returned malformed FXP_HANDLE\n");
\r
578 sftp_pkt_free(pktin);
\r
581 handle = snew(struct fxp_handle);
\r
582 handle->hstring = mkstr(hstring, len);
\r
583 handle->hlen = len;
\r
584 sftp_pkt_free(pktin);
\r
587 fxp_got_status(pktin);
\r
588 sftp_pkt_free(pktin);
\r
594 * Open a directory.
\r
596 struct sftp_request *fxp_opendir_send(char *path)
\r
598 struct sftp_request *req = sftp_alloc_request();
\r
599 struct sftp_packet *pktout;
\r
601 pktout = sftp_pkt_init(SSH_FXP_OPENDIR);
\r
602 sftp_pkt_adduint32(pktout, req->id);
\r
603 sftp_pkt_addstring(pktout, path);
\r
609 struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
\r
610 struct sftp_request *req)
\r
613 if (pktin->type == SSH_FXP_HANDLE) {
\r
615 struct fxp_handle *handle;
\r
618 if (!sftp_pkt_getstring(pktin, &hstring, &len)) {
\r
619 fxp_internal_error("OPENDIR returned malformed FXP_HANDLE\n");
\r
620 sftp_pkt_free(pktin);
\r
623 handle = snew(struct fxp_handle);
\r
624 handle->hstring = mkstr(hstring, len);
\r
625 handle->hlen = len;
\r
626 sftp_pkt_free(pktin);
\r
629 fxp_got_status(pktin);
\r
630 sftp_pkt_free(pktin);
\r
636 * Close a file/dir.
\r
638 struct sftp_request *fxp_close_send(struct fxp_handle *handle)
\r
640 struct sftp_request *req = sftp_alloc_request();
\r
641 struct sftp_packet *pktout;
\r
643 pktout = sftp_pkt_init(SSH_FXP_CLOSE);
\r
644 sftp_pkt_adduint32(pktout, req->id);
\r
645 sftp_pkt_addstring_start(pktout);
\r
646 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
\r
649 sfree(handle->hstring);
\r
655 void fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
658 fxp_got_status(pktin);
\r
659 sftp_pkt_free(pktin);
\r
662 struct sftp_request *fxp_mkdir_send(char *path)
\r
664 struct sftp_request *req = sftp_alloc_request();
\r
665 struct sftp_packet *pktout;
\r
667 pktout = sftp_pkt_init(SSH_FXP_MKDIR);
\r
668 sftp_pkt_adduint32(pktout, req->id);
\r
669 sftp_pkt_addstring(pktout, path);
\r
670 sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */
\r
676 int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
680 id = fxp_got_status(pktin);
\r
681 sftp_pkt_free(pktin);
\r
688 struct sftp_request *fxp_rmdir_send(char *path)
\r
690 struct sftp_request *req = sftp_alloc_request();
\r
691 struct sftp_packet *pktout;
\r
693 pktout = sftp_pkt_init(SSH_FXP_RMDIR);
\r
694 sftp_pkt_adduint32(pktout, req->id);
\r
695 sftp_pkt_addstring(pktout, path);
\r
701 int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
705 id = fxp_got_status(pktin);
\r
706 sftp_pkt_free(pktin);
\r
713 struct sftp_request *fxp_remove_send(char *fname)
\r
715 struct sftp_request *req = sftp_alloc_request();
\r
716 struct sftp_packet *pktout;
\r
718 pktout = sftp_pkt_init(SSH_FXP_REMOVE);
\r
719 sftp_pkt_adduint32(pktout, req->id);
\r
720 sftp_pkt_addstring(pktout, fname);
\r
726 int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
730 id = fxp_got_status(pktin);
\r
731 sftp_pkt_free(pktin);
\r
738 struct sftp_request *fxp_rename_send(char *srcfname, char *dstfname)
\r
740 struct sftp_request *req = sftp_alloc_request();
\r
741 struct sftp_packet *pktout;
\r
743 pktout = sftp_pkt_init(SSH_FXP_RENAME);
\r
744 sftp_pkt_adduint32(pktout, req->id);
\r
745 sftp_pkt_addstring(pktout, srcfname);
\r
746 sftp_pkt_addstring(pktout, dstfname);
\r
752 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
756 id = fxp_got_status(pktin);
\r
757 sftp_pkt_free(pktin);
\r
765 * Retrieve the attributes of a file. We have fxp_stat which works
\r
766 * on filenames, and fxp_fstat which works on open file handles.
\r
768 struct sftp_request *fxp_stat_send(char *fname)
\r
770 struct sftp_request *req = sftp_alloc_request();
\r
771 struct sftp_packet *pktout;
\r
773 pktout = sftp_pkt_init(SSH_FXP_STAT);
\r
774 sftp_pkt_adduint32(pktout, req->id);
\r
775 sftp_pkt_addstring(pktout, fname);
\r
781 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
\r
782 struct fxp_attrs *attrs)
\r
785 if (pktin->type == SSH_FXP_ATTRS) {
\r
786 if (!sftp_pkt_getattrs(pktin, attrs)) {
\r
787 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
\r
788 sftp_pkt_free(pktin);
\r
791 sftp_pkt_free(pktin);
\r
794 fxp_got_status(pktin);
\r
795 sftp_pkt_free(pktin);
\r
800 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle)
\r
802 struct sftp_request *req = sftp_alloc_request();
\r
803 struct sftp_packet *pktout;
\r
805 pktout = sftp_pkt_init(SSH_FXP_FSTAT);
\r
806 sftp_pkt_adduint32(pktout, req->id);
\r
807 sftp_pkt_addstring_start(pktout);
\r
808 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
\r
814 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
\r
815 struct fxp_attrs *attrs)
\r
818 if (pktin->type == SSH_FXP_ATTRS) {
\r
819 if (!sftp_pkt_getattrs(pktin, attrs)) {
\r
820 fxp_internal_error("malformed SSH_FXP_ATTRS packet");
\r
821 sftp_pkt_free(pktin);
\r
824 sftp_pkt_free(pktin);
\r
827 fxp_got_status(pktin);
\r
828 sftp_pkt_free(pktin);
\r
834 * Set the attributes of a file.
\r
836 struct sftp_request *fxp_setstat_send(char *fname, struct fxp_attrs attrs)
\r
838 struct sftp_request *req = sftp_alloc_request();
\r
839 struct sftp_packet *pktout;
\r
841 pktout = sftp_pkt_init(SSH_FXP_SETSTAT);
\r
842 sftp_pkt_adduint32(pktout, req->id);
\r
843 sftp_pkt_addstring(pktout, fname);
\r
844 sftp_pkt_addattrs(pktout, attrs);
\r
850 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
854 id = fxp_got_status(pktin);
\r
855 sftp_pkt_free(pktin);
\r
862 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
\r
863 struct fxp_attrs attrs)
\r
865 struct sftp_request *req = sftp_alloc_request();
\r
866 struct sftp_packet *pktout;
\r
868 pktout = sftp_pkt_init(SSH_FXP_FSETSTAT);
\r
869 sftp_pkt_adduint32(pktout, req->id);
\r
870 sftp_pkt_addstring_start(pktout);
\r
871 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
\r
872 sftp_pkt_addattrs(pktout, attrs);
\r
878 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
882 id = fxp_got_status(pktin);
\r
883 sftp_pkt_free(pktin);
\r
891 * Read from a file. Returns the number of bytes read, or -1 on an
\r
892 * error, or possibly 0 if EOF. (I'm not entirely sure whether it
\r
893 * will return 0 on EOF, or return -1 and store SSH_FX_EOF in the
\r
894 * error indicator. It might even depend on the SFTP server.)
\r
896 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
\r
897 uint64 offset, int len)
\r
899 struct sftp_request *req = sftp_alloc_request();
\r
900 struct sftp_packet *pktout;
\r
902 pktout = sftp_pkt_init(SSH_FXP_READ);
\r
903 sftp_pkt_adduint32(pktout, req->id);
\r
904 sftp_pkt_addstring_start(pktout);
\r
905 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
\r
906 sftp_pkt_adduint64(pktout, offset);
\r
907 sftp_pkt_adduint32(pktout, len);
\r
913 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
\r
914 char *buffer, int len)
\r
917 if (pktin->type == SSH_FXP_DATA) {
\r
921 if (!sftp_pkt_getstring(pktin, &str, &rlen)) {
\r
922 fxp_internal_error("READ returned malformed SSH_FXP_DATA packet");
\r
923 sftp_pkt_free(pktin);
\r
927 if (rlen > len || rlen < 0) {
\r
928 fxp_internal_error("READ returned more bytes than requested");
\r
929 sftp_pkt_free(pktin);
\r
933 memcpy(buffer, str, rlen);
\r
934 sftp_pkt_free(pktin);
\r
937 fxp_got_status(pktin);
\r
938 sftp_pkt_free(pktin);
\r
944 * Read from a directory.
\r
946 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle)
\r
948 struct sftp_request *req = sftp_alloc_request();
\r
949 struct sftp_packet *pktout;
\r
951 pktout = sftp_pkt_init(SSH_FXP_READDIR);
\r
952 sftp_pkt_adduint32(pktout, req->id);
\r
953 sftp_pkt_addstring_start(pktout);
\r
954 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
\r
960 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
\r
961 struct sftp_request *req)
\r
964 if (pktin->type == SSH_FXP_NAME) {
\r
965 struct fxp_names *ret;
\r
969 * Sanity-check the number of names. Minimum is obviously
\r
970 * zero. Maximum is the remaining space in the packet
\r
971 * divided by the very minimum length of a name, which is
\r
972 * 12 bytes (4 for an empty filename, 4 for an empty
\r
973 * longname, 4 for a set of attribute flags indicating that
\r
974 * no other attributes are supplied).
\r
976 if (!sftp_pkt_getuint32(pktin, &i) ||
\r
977 i > (pktin->length-pktin->savedpos)/12) {
\r
978 fxp_internal_error("malformed FXP_NAME packet");
\r
979 sftp_pkt_free(pktin);
\r
984 * Ensure the implicit multiplication in the snewn() call
\r
985 * doesn't suffer integer overflow and cause us to malloc
\r
986 * too little space.
\r
988 if (i > INT_MAX / sizeof(struct fxp_name)) {
\r
989 fxp_internal_error("unreasonably large FXP_NAME packet");
\r
990 sftp_pkt_free(pktin);
\r
994 ret = snew(struct fxp_names);
\r
996 ret->names = snewn(ret->nnames, struct fxp_name);
\r
997 for (i = 0; i < (unsigned long)ret->nnames; i++) {
\r
1000 if (!sftp_pkt_getstring(pktin, &str1, &len1) ||
\r
1001 !sftp_pkt_getstring(pktin, &str2, &len2) ||
\r
1002 !sftp_pkt_getattrs(pktin, &ret->names[i].attrs)) {
\r
1003 fxp_internal_error("malformed FXP_NAME packet");
\r
1005 sfree(ret->names[i].filename);
\r
1006 sfree(ret->names[i].longname);
\r
1008 sfree(ret->names);
\r
1013 ret->names[i].filename = mkstr(str1, len1);
\r
1014 ret->names[i].longname = mkstr(str2, len2);
\r
1016 sftp_pkt_free(pktin);
\r
1019 fxp_got_status(pktin);
\r
1020 sftp_pkt_free(pktin);
\r
1026 * Write to a file. Returns 0 on error, 1 on OK.
\r
1028 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
\r
1029 char *buffer, uint64 offset, int len)
\r
1031 struct sftp_request *req = sftp_alloc_request();
\r
1032 struct sftp_packet *pktout;
\r
1034 pktout = sftp_pkt_init(SSH_FXP_WRITE);
\r
1035 sftp_pkt_adduint32(pktout, req->id);
\r
1036 sftp_pkt_addstring_start(pktout);
\r
1037 sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen);
\r
1038 sftp_pkt_adduint64(pktout, offset);
\r
1039 sftp_pkt_addstring_start(pktout);
\r
1040 sftp_pkt_addstring_data(pktout, buffer, len);
\r
1041 sftp_send(pktout);
\r
1046 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req)
\r
1049 fxp_got_status(pktin);
\r
1050 sftp_pkt_free(pktin);
\r
1051 return fxp_errtype == SSH_FX_OK;
\r
1055 * Free up an fxp_names structure.
\r
1057 void fxp_free_names(struct fxp_names *names)
\r
1061 for (i = 0; i < names->nnames; i++) {
\r
1062 sfree(names->names[i].filename);
\r
1063 sfree(names->names[i].longname);
\r
1065 sfree(names->names);
\r
1070 * Duplicate an fxp_name structure.
\r
1072 struct fxp_name *fxp_dup_name(struct fxp_name *name)
\r
1074 struct fxp_name *ret;
\r
1075 ret = snew(struct fxp_name);
\r
1076 ret->filename = dupstr(name->filename);
\r
1077 ret->longname = dupstr(name->longname);
\r
1078 ret->attrs = name->attrs; /* structure copy */
\r
1083 * Free up an fxp_name structure.
\r
1085 void fxp_free_name(struct fxp_name *name)
\r
1087 sfree(name->filename);
\r
1088 sfree(name->longname);
\r
1093 * Store user data in an sftp_request structure.
\r
1095 void *fxp_get_userdata(struct sftp_request *req)
\r
1097 return req->userdata;
\r
1100 void fxp_set_userdata(struct sftp_request *req, void *data)
\r
1102 req->userdata = data;
\r
1106 * A wrapper to go round fxp_read_* and fxp_write_*, which manages
\r
1107 * the queueing of multiple read/write requests.
\r
1112 int len, retlen, complete;
\r
1114 struct req *next, *prev;
\r
1118 uint64 offset, furthestdata, filesize;
\r
1119 int req_totalsize, req_maxsize, eof, err;
\r
1120 struct fxp_handle *fh;
\r
1121 struct req *head, *tail;
\r
1124 static struct fxp_xfer *xfer_init(struct fxp_handle *fh, uint64 offset)
\r
1126 struct fxp_xfer *xfer = snew(struct fxp_xfer);
\r
1129 xfer->offset = offset;
\r
1130 xfer->head = xfer->tail = NULL;
\r
1131 xfer->req_totalsize = 0;
\r
1132 xfer->req_maxsize = 1048576;
\r
1134 xfer->filesize = uint64_make(ULONG_MAX, ULONG_MAX);
\r
1135 xfer->furthestdata = uint64_make(0, 0);
\r
1140 int xfer_done(struct fxp_xfer *xfer)
\r
1143 * We're finished if we've seen EOF _and_ there are no
\r
1144 * outstanding requests.
\r
1146 return (xfer->eof || xfer->err) && !xfer->head;
\r
1149 void xfer_download_queue(struct fxp_xfer *xfer)
\r
1151 while (xfer->req_totalsize < xfer->req_maxsize &&
\r
1152 !xfer->eof && !xfer->err) {
\r
1154 * Queue a new read request.
\r
1157 struct sftp_request *req;
\r
1159 rr = snew(struct req);
\r
1160 rr->offset = xfer->offset;
\r
1163 xfer->tail->next = rr;
\r
1164 rr->prev = xfer->tail;
\r
1173 rr->buffer = snewn(rr->len, char);
\r
1174 sftp_register(req = fxp_read_send(xfer->fh, rr->offset, rr->len));
\r
1175 fxp_set_userdata(req, rr);
\r
1177 xfer->offset = uint64_add32(xfer->offset, rr->len);
\r
1178 xfer->req_totalsize += rr->len;
\r
1180 #ifdef DEBUG_DOWNLOAD
\r
1181 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing read request %p at %s\n", rr, buf); }
\r
1186 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset)
\r
1188 struct fxp_xfer *xfer = xfer_init(fh, offset);
\r
1190 xfer->eof = FALSE;
\r
1191 xfer_download_queue(xfer);
\r
1196 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
\r
1198 struct sftp_request *rreq;
\r
1201 rreq = sftp_find_request(pktin);
\r
1202 rr = (struct req *)fxp_get_userdata(rreq);
\r
1204 return 0; /* this packet isn't ours */
\r
1205 rr->retlen = fxp_read_recv(pktin, rreq, rr->buffer, rr->len);
\r
1206 #ifdef DEBUG_DOWNLOAD
\r
1207 printf("read request %p has returned [%d]\n", rr, rr->retlen);
\r
1210 if ((rr->retlen < 0 && fxp_error_type()==SSH_FX_EOF) || rr->retlen == 0) {
\r
1212 rr->complete = -1;
\r
1213 #ifdef DEBUG_DOWNLOAD
\r
1214 printf("setting eof\n");
\r
1216 } else if (rr->retlen < 0) {
\r
1217 /* some error other than EOF; signal it back to caller */
\r
1218 xfer_set_error(xfer);
\r
1219 rr->complete = -1;
\r
1226 * Special case: if we have received fewer bytes than we
\r
1227 * actually read, we should do something. For the moment I'll
\r
1228 * just throw an ersatz FXP error to signal this; the SFTP
\r
1229 * draft I've got says that it can't happen except on special
\r
1230 * files, in which case seeking probably has very little
\r
1231 * meaning and so queueing an additional read request to fill
\r
1232 * up the gap sounds like the wrong answer. I'm not sure what I
\r
1233 * should be doing here - if it _was_ a special file, I suspect
\r
1234 * I simply shouldn't have been queueing multiple requests in
\r
1235 * the first place...
\r
1237 if (rr->retlen > 0 && uint64_compare(xfer->furthestdata, rr->offset) < 0) {
\r
1238 xfer->furthestdata = rr->offset;
\r
1239 #ifdef DEBUG_DOWNLOAD
\r
1241 uint64_decimal(xfer->furthestdata, buf);
\r
1242 printf("setting furthestdata = %s\n", buf); }
\r
1246 if (rr->retlen < rr->len) {
\r
1247 uint64 filesize = uint64_add32(rr->offset,
\r
1248 (rr->retlen < 0 ? 0 : rr->retlen));
\r
1249 #ifdef DEBUG_DOWNLOAD
\r
1251 uint64_decimal(filesize, buf);
\r
1252 printf("short block! trying filesize = %s\n", buf); }
\r
1254 if (uint64_compare(xfer->filesize, filesize) > 0) {
\r
1255 xfer->filesize = filesize;
\r
1256 #ifdef DEBUG_DOWNLOAD
\r
1257 printf("actually changing filesize\n");
\r
1262 if (uint64_compare(xfer->furthestdata, xfer->filesize) > 0) {
\r
1263 fxp_error_message = "received a short buffer from FXP_READ, but not"
\r
1266 xfer_set_error(xfer);
\r
1273 void xfer_set_error(struct fxp_xfer *xfer)
\r
1278 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len)
\r
1280 void *retbuf = NULL;
\r
1284 * Discard anything at the head of the rr queue with complete <
\r
1285 * 0; return the first thing with complete > 0.
\r
1287 while (xfer->head && xfer->head->complete && !retbuf) {
\r
1288 struct req *rr = xfer->head;
\r
1290 if (rr->complete > 0) {
\r
1291 retbuf = rr->buffer;
\r
1292 retlen = rr->retlen;
\r
1293 #ifdef DEBUG_DOWNLOAD
\r
1294 printf("handing back data from read request %p\n", rr);
\r
1297 #ifdef DEBUG_DOWNLOAD
\r
1299 printf("skipping failed read request %p\n", rr);
\r
1302 xfer->head = xfer->head->next;
\r
1304 xfer->head->prev = NULL;
\r
1306 xfer->tail = NULL;
\r
1307 xfer->req_totalsize -= rr->len;
\r
1319 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset)
\r
1321 struct fxp_xfer *xfer = xfer_init(fh, offset);
\r
1324 * We set `eof' to 1 because this will cause xfer_done() to
\r
1325 * return true iff there are no outstanding requests. During an
\r
1326 * upload, our caller will be responsible for working out
\r
1327 * whether all the data has been sent, so all it needs to know
\r
1328 * from us is whether the outstanding requests have been
\r
1329 * handled once that's done.
\r
1336 int xfer_upload_ready(struct fxp_xfer *xfer)
\r
1338 if (xfer->req_totalsize < xfer->req_maxsize)
\r
1344 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len)
\r
1347 struct sftp_request *req;
\r
1349 rr = snew(struct req);
\r
1350 rr->offset = xfer->offset;
\r
1353 xfer->tail->next = rr;
\r
1354 rr->prev = xfer->tail;
\r
1363 rr->buffer = NULL;
\r
1364 sftp_register(req = fxp_write_send(xfer->fh, buffer, rr->offset, len));
\r
1365 fxp_set_userdata(req, rr);
\r
1367 xfer->offset = uint64_add32(xfer->offset, rr->len);
\r
1368 xfer->req_totalsize += rr->len;
\r
1370 #ifdef DEBUG_UPLOAD
\r
1371 { char buf[40]; uint64_decimal(rr->offset, buf); printf("queueing write request %p at %s [len %d]\n", rr, buf, len); }
\r
1375 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin)
\r
1377 struct sftp_request *rreq;
\r
1378 struct req *rr, *prev, *next;
\r
1381 rreq = sftp_find_request(pktin);
\r
1382 rr = (struct req *)fxp_get_userdata(rreq);
\r
1384 return 0; /* this packet isn't ours */
\r
1385 ret = fxp_write_recv(pktin, rreq);
\r
1386 #ifdef DEBUG_UPLOAD
\r
1387 printf("write request %p has returned [%d]\n", rr, ret);
\r
1391 * Remove this one from the queue.
\r
1396 prev->next = next;
\r
1398 xfer->head = next;
\r
1400 next->prev = prev;
\r
1402 xfer->tail = prev;
\r
1403 xfer->req_totalsize -= rr->len;
\r
1412 void xfer_cleanup(struct fxp_xfer *xfer)
\r
1415 while (xfer->head) {
\r
1417 xfer->head = xfer->head->next;
\r
1418 sfree(rr->buffer);
\r