X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/0d694692c59504838ec2043ddfe670b3a9247faf..3ca5c28cafade2c9e0ada4d5b30c1d9b1be32f4c:/sftp.c diff --git a/sftp.c b/sftp.c index e7b84412..78fbd325 100644 --- a/sftp.c +++ b/sftp.c @@ -7,13 +7,10 @@ #include #include +#include "misc.h" #include "int64.h" #include "sftp.h" -#define smalloc malloc -#define srealloc realloc -#define sfree free - #define GET_32BIT(cp) \ (((unsigned long)(unsigned char)(cp)[0] << 24) | \ ((unsigned long)(unsigned char)(cp)[1] << 16) | \ @@ -33,100 +30,142 @@ struct sftp_packet { int type; }; +static const char *fxp_error_message; +static int fxp_errtype; + /* ---------------------------------------------------------------------- * SFTP packet construction functions. */ -static void sftp_pkt_ensure(struct sftp_packet *pkt, int length) { +static void sftp_pkt_ensure(struct sftp_packet *pkt, int length) +{ if (pkt->maxlen < length) { - pkt->maxlen = length + 256; + pkt->maxlen = length + 256; pkt->data = srealloc(pkt->data, pkt->maxlen); } } -static void sftp_pkt_adddata(struct sftp_packet *pkt, void *data, int len) { +static void sftp_pkt_adddata(struct sftp_packet *pkt, void *data, int len) +{ pkt->length += len; sftp_pkt_ensure(pkt, pkt->length); - memcpy(pkt->data+pkt->length-len, data, len); + memcpy(pkt->data + pkt->length - len, data, len); } -static void sftp_pkt_addbyte(struct sftp_packet *pkt, unsigned char byte) { +static void sftp_pkt_addbyte(struct sftp_packet *pkt, unsigned char byte) +{ sftp_pkt_adddata(pkt, &byte, 1); } -static struct sftp_packet *sftp_pkt_init(int pkt_type) { +static struct sftp_packet *sftp_pkt_init(int pkt_type) +{ struct sftp_packet *pkt; pkt = smalloc(sizeof(struct sftp_packet)); pkt->data = NULL; pkt->savedpos = -1; pkt->length = 0; pkt->maxlen = 0; - sftp_pkt_addbyte(pkt, (unsigned char)pkt_type); + sftp_pkt_addbyte(pkt, (unsigned char) pkt_type); return pkt; } -static void sftp_pkt_addbool(struct sftp_packet *pkt, unsigned char value) { +static void sftp_pkt_addbool(struct sftp_packet *pkt, unsigned char value) +{ sftp_pkt_adddata(pkt, &value, 1); } -static void sftp_pkt_adduint32(struct sftp_packet *pkt, unsigned long value) { +static void sftp_pkt_adduint32(struct sftp_packet *pkt, + unsigned long value) +{ unsigned char x[4]; PUT_32BIT(x, value); sftp_pkt_adddata(pkt, x, 4); } -static void sftp_pkt_adduint64(struct sftp_packet *pkt, uint64 value) { +static void sftp_pkt_adduint64(struct sftp_packet *pkt, uint64 value) +{ unsigned char x[8]; PUT_32BIT(x, value.hi); - PUT_32BIT(x+4, value.lo); + PUT_32BIT(x + 4, value.lo); sftp_pkt_adddata(pkt, x, 8); } -static void sftp_pkt_addstring_start(struct sftp_packet *pkt) { +static void sftp_pkt_addstring_start(struct sftp_packet *pkt) +{ sftp_pkt_adduint32(pkt, 0); pkt->savedpos = pkt->length; } -static void sftp_pkt_addstring_str(struct sftp_packet *pkt, char *data) { +static void sftp_pkt_addstring_str(struct sftp_packet *pkt, char *data) +{ sftp_pkt_adddata(pkt, data, strlen(data)); - PUT_32BIT(pkt->data + pkt->savedpos - 4, - pkt->length - pkt->savedpos); + PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos); } static void sftp_pkt_addstring_data(struct sftp_packet *pkt, - char *data, int len) { + char *data, int len) +{ sftp_pkt_adddata(pkt, data, len); - PUT_32BIT(pkt->data + pkt->savedpos - 4, - pkt->length - pkt->savedpos); + PUT_32BIT(pkt->data + pkt->savedpos - 4, pkt->length - pkt->savedpos); } -static void sftp_pkt_addstring(struct sftp_packet *pkt, char *data) { +static void sftp_pkt_addstring(struct sftp_packet *pkt, char *data) +{ sftp_pkt_addstring_start(pkt); sftp_pkt_addstring_str(pkt, data); } +static void sftp_pkt_addattrs(struct sftp_packet *pkt, struct fxp_attrs attrs) +{ + sftp_pkt_adduint32(pkt, attrs.flags); + if (attrs.flags & SSH_FILEXFER_ATTR_SIZE) { + sftp_pkt_adduint32(pkt, attrs.size.hi); + sftp_pkt_adduint32(pkt, attrs.size.lo); + } + if (attrs.flags & SSH_FILEXFER_ATTR_UIDGID) { + sftp_pkt_adduint32(pkt, attrs.uid); + sftp_pkt_adduint32(pkt, attrs.gid); + } + if (attrs.flags & SSH_FILEXFER_ATTR_PERMISSIONS) { + sftp_pkt_adduint32(pkt, attrs.permissions); + } + if (attrs.flags & SSH_FILEXFER_ATTR_ACMODTIME) { + sftp_pkt_adduint32(pkt, attrs.atime); + sftp_pkt_adduint32(pkt, attrs.mtime); + } + if (attrs.flags & SSH_FILEXFER_ATTR_EXTENDED) { + /* + * We currently don't support sending any extended + * attributes. + */ + } +} /* ---------------------------------------------------------------------- * SFTP packet decode functions. */ -static unsigned char sftp_pkt_getbyte(struct sftp_packet *pkt) { - unsigned long value; +static unsigned char sftp_pkt_getbyte(struct sftp_packet *pkt) +{ + unsigned char value; if (pkt->length - pkt->savedpos < 1) - return 0; /* arrgh, no way to decline (FIXME?) */ + return 0; /* arrgh, no way to decline (FIXME?) */ value = (unsigned char) pkt->data[pkt->savedpos]; pkt->savedpos++; return value; } -static unsigned long sftp_pkt_getuint32(struct sftp_packet *pkt) { +static unsigned long sftp_pkt_getuint32(struct sftp_packet *pkt) +{ unsigned long value; if (pkt->length - pkt->savedpos < 4) - return 0; /* arrgh, no way to decline (FIXME?) */ - value = GET_32BIT(pkt->data+pkt->savedpos); + return 0; /* arrgh, no way to decline (FIXME?) */ + value = GET_32BIT(pkt->data + pkt->savedpos); pkt->savedpos += 4; return value; } static void sftp_pkt_getstring(struct sftp_packet *pkt, - char **p, int *length) { + char **p, int *length) +{ *p = NULL; if (pkt->length - pkt->savedpos < 4) - return; - *length = GET_32BIT(pkt->data+pkt->savedpos); + return; + *length = GET_32BIT(pkt->data + pkt->savedpos); pkt->savedpos += 4; if (pkt->length - pkt->savedpos < *length) - return; - *p = pkt->data+pkt->savedpos; + return; + *p = pkt->data + pkt->savedpos; pkt->savedpos += *length; } -static struct fxp_attrs sftp_pkt_getattrs(struct sftp_packet *pkt) { +static struct fxp_attrs sftp_pkt_getattrs(struct sftp_packet *pkt) +{ struct fxp_attrs ret; ret.flags = sftp_pkt_getuint32(pkt); if (ret.flags & SSH_FILEXFER_ATTR_SIZE) { @@ -162,27 +201,29 @@ static struct fxp_attrs sftp_pkt_getattrs(struct sftp_packet *pkt) { } return ret; } -static void sftp_pkt_free(struct sftp_packet *pkt) { - if (pkt->data) sfree(pkt->data); +static void sftp_pkt_free(struct sftp_packet *pkt) +{ + if (pkt->data) + sfree(pkt->data); sfree(pkt); } /* ---------------------------------------------------------------------- * Send and receive packet functions. */ -int sftp_send(struct sftp_packet *pkt) { +int sftp_send(struct sftp_packet *pkt) +{ int ret; char x[4]; PUT_32BIT(x, pkt->length); - ret = (sftp_senddata(x, 4) && - sftp_senddata(pkt->data, pkt->length)); + ret = (sftp_senddata(x, 4) && sftp_senddata(pkt->data, pkt->length)); sftp_pkt_free(pkt); return ret; } -struct sftp_packet *sftp_recv(void) { +struct sftp_packet *sftp_recv(void) +{ struct sftp_packet *pkt; char x[4]; - int p, ret; if (!sftp_recvdata(x, 4)) return NULL; @@ -206,8 +247,9 @@ struct sftp_packet *sftp_recv(void) { * String handling routines. */ -static char *mkstr(char *s, int len) { - char *p = smalloc(len+1); +static char *mkstr(char *s, int len) +{ + char *p = smalloc(len + 1); memcpy(p, s, len); p[len] = '\0'; return p; @@ -217,15 +259,13 @@ static char *mkstr(char *s, int len) { * SFTP primitives. */ -static const char *fxp_error_message; -static int fxp_errtype; - /* * Deal with (and free) an FXP_STATUS packet. Return 1 if * SSH_FX_OK, 0 if SSH_FX_EOF, and -1 for anything else (error). * Also place the status into fxp_errtype. */ -static int fxp_got_status(struct sftp_packet *pktin) { +static int fxp_got_status(struct sftp_packet *pktin) +{ static const char *const messages[] = { /* SSH_FX_OK. The only time we will display a _message_ for this * is if we were expecting something other than FXP_STATUS on @@ -247,8 +287,8 @@ static int fxp_got_status(struct sftp_packet *pktin) { } else { fxp_errtype = sftp_pkt_getuint32(pktin); if (fxp_errtype < 0 || - fxp_errtype >= sizeof(messages)/sizeof(*messages)) - fxp_error_message = "unknown error code"; + fxp_errtype >= sizeof(messages) / sizeof(*messages)) + fxp_error_message = "unknown error code"; else fxp_error_message = messages[fxp_errtype]; } @@ -261,23 +301,27 @@ static int fxp_got_status(struct sftp_packet *pktin) { return -1; } -static void fxp_internal_error(char *msg) { +static void fxp_internal_error(char *msg) +{ fxp_error_message = msg; fxp_errtype = -1; } -const char *fxp_error(void) { +const char *fxp_error(void) +{ return fxp_error_message; } -int fxp_error_type(void) { +int fxp_error_type(void) +{ return fxp_errtype; } /* * Perform exchange of init/version packets. Return 0 on failure. */ -int fxp_init(void) { +int fxp_init(void) +{ struct sftp_packet *pktout, *pktin; int remotever; @@ -296,7 +340,8 @@ int fxp_init(void) { } remotever = sftp_pkt_getuint32(pktin); if (remotever > SFTP_PROTO_VERSION) { - fxp_internal_error("remote protocol is more advanced than we support"); + fxp_internal_error + ("remote protocol is more advanced than we support"); return 0; } /* @@ -313,7 +358,8 @@ int fxp_init(void) { /* * Canonify a pathname. */ -char *fxp_realpath(char *path) { +char *fxp_realpath(char *path) +{ struct sftp_packet *pktin, *pktout; int id; @@ -323,6 +369,10 @@ char *fxp_realpath(char *path) { sftp_pkt_addstring_str(pktout, path); sftp_send(pktout); pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return NULL; + } id = sftp_pkt_getuint32(pktin); if (id != 0x123) { fxp_internal_error("request ID mismatch\n"); @@ -355,7 +405,8 @@ char *fxp_realpath(char *path) { /* * Open a file. */ -struct fxp_handle *fxp_open(char *path, int type) { +struct fxp_handle *fxp_open(char *path, int type) +{ struct sftp_packet *pktin, *pktout; int id; @@ -366,13 +417,16 @@ struct fxp_handle *fxp_open(char *path, int type) { sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */ sftp_send(pktout); pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return NULL; + } id = sftp_pkt_getuint32(pktin); if (id != 0x567) { fxp_internal_error("request ID mismatch\n"); return NULL; } if (pktin->type == SSH_FXP_HANDLE) { - int count; char *hstring; struct fxp_handle *handle; int len; @@ -396,7 +450,8 @@ struct fxp_handle *fxp_open(char *path, int type) { /* * Open a directory. */ -struct fxp_handle *fxp_opendir(char *path) { +struct fxp_handle *fxp_opendir(char *path) +{ struct sftp_packet *pktin, *pktout; int id; @@ -405,13 +460,16 @@ struct fxp_handle *fxp_opendir(char *path) { sftp_pkt_addstring(pktout, path); sftp_send(pktout); pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return NULL; + } id = sftp_pkt_getuint32(pktin); if (id != 0x456) { fxp_internal_error("request ID mismatch\n"); return NULL; } if (pktin->type == SSH_FXP_HANDLE) { - int count; char *hstring; struct fxp_handle *handle; int len; @@ -435,7 +493,8 @@ struct fxp_handle *fxp_opendir(char *path) { /* * Close a file/dir. */ -void fxp_close(struct fxp_handle *handle) { +void fxp_close(struct fxp_handle *handle) +{ struct sftp_packet *pktin, *pktout; int id; @@ -445,6 +504,10 @@ void fxp_close(struct fxp_handle *handle) { sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen); sftp_send(pktout); pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return; + } id = sftp_pkt_getuint32(pktin); if (id != 0x789) { fxp_internal_error("request ID mismatch\n"); @@ -455,13 +518,241 @@ void fxp_close(struct fxp_handle *handle) { sfree(handle); } +int fxp_mkdir(char *path) +{ + struct sftp_packet *pktin, *pktout; + int id; + + pktout = sftp_pkt_init(SSH_FXP_MKDIR); + sftp_pkt_adduint32(pktout, 0x234); /* request id */ + sftp_pkt_addstring(pktout, path); + sftp_pkt_adduint32(pktout, 0); /* (FIXME) empty ATTRS structure */ + sftp_send(pktout); + pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } + id = sftp_pkt_getuint32(pktin); + if (id != 0x234) { + fxp_internal_error("request ID mismatch\n"); + return 0; + } + id = fxp_got_status(pktin); + if (id != 1) { + return 0; + } + return 1; +} + +int fxp_rmdir(char *path) +{ + struct sftp_packet *pktin, *pktout; + int id; + + pktout = sftp_pkt_init(SSH_FXP_RMDIR); + sftp_pkt_adduint32(pktout, 0x345); /* request id */ + sftp_pkt_addstring(pktout, path); + sftp_send(pktout); + pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } + id = sftp_pkt_getuint32(pktin); + if (id != 0x345) { + fxp_internal_error("request ID mismatch\n"); + return 0; + } + id = fxp_got_status(pktin); + if (id != 1) { + return 0; + } + return 1; +} + +int fxp_remove(char *fname) +{ + struct sftp_packet *pktin, *pktout; + int id; + + pktout = sftp_pkt_init(SSH_FXP_REMOVE); + sftp_pkt_adduint32(pktout, 0x678); /* request id */ + sftp_pkt_addstring(pktout, fname); + sftp_send(pktout); + pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } + id = sftp_pkt_getuint32(pktin); + if (id != 0x678) { + fxp_internal_error("request ID mismatch\n"); + return 0; + } + id = fxp_got_status(pktin); + if (id != 1) { + return 0; + } + return 1; +} + +int fxp_rename(char *srcfname, char *dstfname) +{ + struct sftp_packet *pktin, *pktout; + int id; + + pktout = sftp_pkt_init(SSH_FXP_RENAME); + sftp_pkt_adduint32(pktout, 0x678); /* request id */ + sftp_pkt_addstring(pktout, srcfname); + sftp_pkt_addstring(pktout, dstfname); + sftp_send(pktout); + pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } + id = sftp_pkt_getuint32(pktin); + if (id != 0x678) { + fxp_internal_error("request ID mismatch\n"); + return 0; + } + id = fxp_got_status(pktin); + if (id != 1) { + return 0; + } + return 1; +} + +/* + * Retrieve the attributes of a file. We have fxp_stat which works + * on filenames, and fxp_fstat which works on open file handles. + */ +int fxp_stat(char *fname, struct fxp_attrs *attrs) +{ + struct sftp_packet *pktin, *pktout; + int id; + + pktout = sftp_pkt_init(SSH_FXP_STAT); + sftp_pkt_adduint32(pktout, 0x678); /* request id */ + sftp_pkt_addstring(pktout, fname); + sftp_send(pktout); + pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } + id = sftp_pkt_getuint32(pktin); + if (id != 0x678) { + fxp_internal_error("request ID mismatch\n"); + return 0; + } + + if (pktin->type == SSH_FXP_ATTRS) { + *attrs = sftp_pkt_getattrs(pktin); + return 1; + } else { + fxp_got_status(pktin); + return 0; + } +} + +int fxp_fstat(struct fxp_handle *handle, struct fxp_attrs *attrs) +{ + struct sftp_packet *pktin, *pktout; + int id; + + pktout = sftp_pkt_init(SSH_FXP_FSTAT); + sftp_pkt_adduint32(pktout, 0x678); /* request id */ + sftp_pkt_addstring_start(pktout); + sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen); + sftp_send(pktout); + pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } + id = sftp_pkt_getuint32(pktin); + if (id != 0x678) { + fxp_internal_error("request ID mismatch\n"); + return 0; + } + + if (pktin->type == SSH_FXP_ATTRS) { + *attrs = sftp_pkt_getattrs(pktin); + return 1; + } else { + fxp_got_status(pktin); + return 0; + } +} + +/* + * Set the attributes of a file. + */ +int fxp_setstat(char *fname, struct fxp_attrs attrs) +{ + struct sftp_packet *pktin, *pktout; + int id; + + pktout = sftp_pkt_init(SSH_FXP_SETSTAT); + sftp_pkt_adduint32(pktout, 0x678); /* request id */ + sftp_pkt_addstring(pktout, fname); + sftp_pkt_addattrs(pktout, attrs); + sftp_send(pktout); + pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } + id = sftp_pkt_getuint32(pktin); + if (id != 0x678) { + fxp_internal_error("request ID mismatch\n"); + return 0; + } + id = fxp_got_status(pktin); + if (id != 1) { + return 0; + } + return 1; +} +int fxp_fsetstat(struct fxp_handle *handle, struct fxp_attrs attrs) +{ + struct sftp_packet *pktin, *pktout; + int id; + + pktout = sftp_pkt_init(SSH_FXP_FSETSTAT); + sftp_pkt_adduint32(pktout, 0x678); /* request id */ + sftp_pkt_addstring_start(pktout); + sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen); + sftp_pkt_addattrs(pktout, attrs); + sftp_send(pktout); + pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } + id = sftp_pkt_getuint32(pktin); + if (id != 0x678) { + fxp_internal_error("request ID mismatch\n"); + return 0; + } + id = fxp_got_status(pktin); + if (id != 1) { + return 0; + } + return 1; +} + /* * Read from a file. Returns the number of bytes read, or -1 on an * error, or possibly 0 if EOF. (I'm not entirely sure whether it * will return 0 on EOF, or return -1 and store SSH_FX_EOF in the * error indicator. It might even depend on the SFTP server.) */ -int fxp_read(struct fxp_handle *handle, char *buffer, uint64 offset, int len) { +int fxp_read(struct fxp_handle *handle, char *buffer, uint64 offset, + int len) +{ struct sftp_packet *pktin, *pktout; int id; @@ -473,6 +764,10 @@ int fxp_read(struct fxp_handle *handle, char *buffer, uint64 offset, int len) { sftp_pkt_adduint32(pktout, len); sftp_send(pktout); pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return -1; + } id = sftp_pkt_getuint32(pktin); if (id != 0xBCD) { fxp_internal_error("request ID mismatch"); @@ -501,7 +796,8 @@ int fxp_read(struct fxp_handle *handle, char *buffer, uint64 offset, int len) { /* * Read from a directory. */ -struct fxp_names *fxp_readdir(struct fxp_handle *handle) { +struct fxp_names *fxp_readdir(struct fxp_handle *handle) +{ struct sftp_packet *pktin, *pktout; int id; @@ -511,6 +807,10 @@ struct fxp_names *fxp_readdir(struct fxp_handle *handle) { sftp_pkt_addstring_data(pktout, handle->hstring, handle->hlen); sftp_send(pktout); pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return NULL; + } id = sftp_pkt_getuint32(pktin); if (id != 0xABC) { fxp_internal_error("request ID mismatch\n"); @@ -541,7 +841,9 @@ struct fxp_names *fxp_readdir(struct fxp_handle *handle) { /* * Write to a file. Returns 0 on error, 1 on OK. */ -int fxp_write(struct fxp_handle *handle, char *buffer, uint64 offset, int len) { +int fxp_write(struct fxp_handle *handle, char *buffer, uint64 offset, + int len) +{ struct sftp_packet *pktin, *pktout; int id; @@ -554,10 +856,14 @@ int fxp_write(struct fxp_handle *handle, char *buffer, uint64 offset, int len) { sftp_pkt_addstring_data(pktout, buffer, len); sftp_send(pktout); pktin = sftp_recv(); + if (!pktin) { + fxp_internal_error("did not receive a valid SFTP packet\n"); + return 0; + } id = sftp_pkt_getuint32(pktin); if (id != 0xDCB) { fxp_internal_error("request ID mismatch\n"); - return NULL; + return 0; } fxp_got_status(pktin); return fxp_errtype == SSH_FX_OK; @@ -566,7 +872,8 @@ int fxp_write(struct fxp_handle *handle, char *buffer, uint64 offset, int len) { /* * Free up an fxp_names structure. */ -void fxp_free_names(struct fxp_names *names) { +void fxp_free_names(struct fxp_names *names) +{ int i; for (i = 0; i < names->nnames; i++) {