sftp.h

   1 /*
   2  * sftp.h: definitions for SFTP and the sftp.c routines.
   3  */
   4
   5 #include "int64.h"
   6
   7 #define SSH_FXP_INIT                              1     /* 0x1 */
   8 #define SSH_FXP_VERSION                           2     /* 0x2 */
   9 #define SSH_FXP_OPEN                              3     /* 0x3 */
  10 #define SSH_FXP_CLOSE                             4     /* 0x4 */
  11 #define SSH_FXP_READ                              5     /* 0x5 */
  12 #define SSH_FXP_WRITE                             6     /* 0x6 */
  13 #define SSH_FXP_LSTAT                             7     /* 0x7 */
  14 #define SSH_FXP_FSTAT                             8     /* 0x8 */
  15 #define SSH_FXP_SETSTAT                           9     /* 0x9 */
  16 #define SSH_FXP_FSETSTAT                          10    /* 0xa */
  17 #define SSH_FXP_OPENDIR                           11    /* 0xb */
  18 #define SSH_FXP_READDIR                           12    /* 0xc */
  19 #define SSH_FXP_REMOVE                            13    /* 0xd */
  20 #define SSH_FXP_MKDIR                             14    /* 0xe */
  21 #define SSH_FXP_RMDIR                             15    /* 0xf */
  22 #define SSH_FXP_REALPATH                          16    /* 0x10 */
  23 #define SSH_FXP_STAT                              17    /* 0x11 */
  24 #define SSH_FXP_RENAME                            18    /* 0x12 */
  25 #define SSH_FXP_STATUS                            101   /* 0x65 */
  26 #define SSH_FXP_HANDLE                            102   /* 0x66 */
  27 #define SSH_FXP_DATA                              103   /* 0x67 */
  28 #define SSH_FXP_NAME                              104   /* 0x68 */
  29 #define SSH_FXP_ATTRS                             105   /* 0x69 */
  30 #define SSH_FXP_EXTENDED                          200   /* 0xc8 */
  31 #define SSH_FXP_EXTENDED_REPLY                    201   /* 0xc9 */
  32
  33 #define SSH_FX_OK                                 0
  34 #define SSH_FX_EOF                                1
  35 #define SSH_FX_NO_SUCH_FILE                       2
  36 #define SSH_FX_PERMISSION_DENIED                  3
  37 #define SSH_FX_FAILURE                            4
  38 #define SSH_FX_BAD_MESSAGE                        5
  39 #define SSH_FX_NO_CONNECTION                      6
  40 #define SSH_FX_CONNECTION_LOST                    7
  41 #define SSH_FX_OP_UNSUPPORTED                     8
  42
  43 #define SSH_FILEXFER_ATTR_SIZE                    0x00000001
  44 #define SSH_FILEXFER_ATTR_UIDGID                  0x00000002
  45 #define SSH_FILEXFER_ATTR_PERMISSIONS             0x00000004
  46 #define SSH_FILEXFER_ATTR_ACMODTIME               0x00000008
  47 #define SSH_FILEXFER_ATTR_EXTENDED                0x80000000
  48
  49 #define SSH_FXF_READ                              0x00000001
  50 #define SSH_FXF_WRITE                             0x00000002
  51 #define SSH_FXF_APPEND                            0x00000004
  52 #define SSH_FXF_CREAT                             0x00000008
  53 #define SSH_FXF_TRUNC                             0x00000010
  54 #define SSH_FXF_EXCL                              0x00000020
  55
  56 #define SFTP_PROTO_VERSION 3
  57
  58 /*
  59  * External references. The sftp client module sftp.c expects to be
  60  * able to get at these functions.
  61  *
  62  * sftp_recvdata must never return less than len. It either blocks
  63  * until len is available, or it returns failure.
  64  *
  65  * Both functions return 1 on success, 0 on failure.
  66  *
  67  * sftp_sendbuffer returns the size of the backlog of data in the
  68  * transmit queue.
  69  */
  70 int sftp_senddata(char *data, int len);
  71 int sftp_sendbuffer(void);
  72 int sftp_recvdata(char *data, int len);
  73
  74 /*
  75  * Free sftp_requests
  76  */
  77 void sftp_cleanup_request(void);
  78
  79 struct fxp_attrs {
  80     unsigned long flags;
  81     uint64 size;
  82     unsigned long uid;
  83     unsigned long gid;
  84     unsigned long permissions;
  85     unsigned long atime;
  86     unsigned long mtime;
  87 };
  88
  89 /*
  90  * Copy between the possibly-unused permissions field in an fxp_attrs
  91  * and a possibly-negative integer containing the same permissions.
  92  */
  93 #define PUT_PERMISSIONS(attrs, perms)                   \
  94     ((perms) >= 0 ?                                     \
  95      ((attrs).flags |= SSH_FILEXFER_ATTR_PERMISSIONS,   \
  96       (attrs).permissions = (perms)) :                  \
  97      ((attrs).flags &= ~SSH_FILEXFER_ATTR_PERMISSIONS))
  98 #define GET_PERMISSIONS(attrs)                          \
  99     ((attrs).flags & SSH_FILEXFER_ATTR_PERMISSIONS ?    \
 100      (attrs).permissions : -1)
 101
 102 struct fxp_handle {
 103     char *hstring;
 104     int hlen;
 105 };
 106
 107 struct fxp_name {
 108     char *filename, *longname;
 109     struct fxp_attrs attrs;
 110 };
 111
 112 struct fxp_names {
 113     int nnames;
 114     struct fxp_name *names;
 115 };
 116
 117 struct sftp_request;
 118 struct sftp_packet;
 119
 120 const char *fxp_error(void);
 121 int fxp_error_type(void);
 122
 123 /*
 124  * Perform exchange of init/version packets. Return 0 on failure.
 125  */
 126 int fxp_init(void);
 127
 128 /*
 129  * Canonify a pathname. Concatenate the two given path elements
 130  * with a separating slash, unless the second is NULL.
 131  */
 132 struct sftp_request *fxp_realpath_send(const char *path);
 133 char *fxp_realpath_recv(struct sftp_packet *pktin, struct sftp_request *req);
 134
 135 /*
 136  * Open a file. 'attrs' contains attributes to be applied to the file
 137  * if it's being created.
 138  */
 139 struct sftp_request *fxp_open_send(const char *path, int type,
 140                                    struct fxp_attrs *attrs);
 141 struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
 142                                  struct sftp_request *req);
 143
 144 /*
 145  * Open a directory.
 146  */
 147 struct sftp_request *fxp_opendir_send(const char *path);
 148 struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
 149                                     struct sftp_request *req);
 150
 151 /*
 152  * Close a file/dir. Returns 1 on success, 0 on error.
 153  */
 154 struct sftp_request *fxp_close_send(struct fxp_handle *handle);
 155 int fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req);
 156
 157 /*
 158  * Make a directory.
 159  */
 160 struct sftp_request *fxp_mkdir_send(const char *path);
 161 int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req);
 162
 163 /*
 164  * Remove a directory.
 165  */
 166 struct sftp_request *fxp_rmdir_send(const char *path);
 167 int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req);
 168
 169 /*
 170  * Remove a file.
 171  */
 172 struct sftp_request *fxp_remove_send(const char *fname);
 173 int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req);
 174
 175 /*
 176  * Rename a file.
 177  */
 178 struct sftp_request *fxp_rename_send(const char *srcfname,
 179                                      const char *dstfname);
 180 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req);
 181
 182 /*
 183  * Return file attributes.
 184  */
 185 struct sftp_request *fxp_stat_send(const char *fname);
 186 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
 187                   struct fxp_attrs *attrs);
 188 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle);
 189 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
 190                    struct fxp_attrs *attrs);
 191
 192 /*
 193  * Set file attributes.
 194  */
 195 struct sftp_request *fxp_setstat_send(const char *fname,
 196                                       struct fxp_attrs attrs);
 197 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req);
 198 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
 199                                        struct fxp_attrs attrs);
 200 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req);
 201
 202 /*
 203  * Read from a file.
 204  */
 205 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
 206                                    uint64 offset, int len);
 207 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
 208                   char *buffer, int len);
 209
 210 /*
 211  * Write to a file. Returns 0 on error, 1 on OK.
 212  */
 213 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
 214                                     char *buffer, uint64 offset, int len);
 215 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req);
 216
 217 /*
 218  * Read from a directory.
 219  */
 220 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle);
 221 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
 222                                    struct sftp_request *req);
 223
 224 /*
 225  * Free up an fxp_names structure.
 226  */
 227 void fxp_free_names(struct fxp_names *names);
 228
 229 /*
 230  * Duplicate and free fxp_name structures.
 231  */
 232 struct fxp_name *fxp_dup_name(struct fxp_name *name);
 233 void fxp_free_name(struct fxp_name *name);
 234
 235 /*
 236  * Store user data in an sftp_request structure.
 237  */
 238 void *fxp_get_userdata(struct sftp_request *req);
 239 void fxp_set_userdata(struct sftp_request *req, void *data);
 240
 241 /*
 242  * These functions might well be temporary placeholders to be
 243  * replaced with more useful similar functions later. They form the
 244  * main dispatch loop for processing incoming SFTP responses.
 245  */
 246 void sftp_register(struct sftp_request *req);
 247 struct sftp_request *sftp_find_request(struct sftp_packet *pktin);
 248 struct sftp_packet *sftp_recv(void);
 249
 250 /*
 251  * A wrapper to go round fxp_read_* and fxp_write_*, which manages
 252  * the queueing of multiple read/write requests.
 253  */
 254
 255 struct fxp_xfer;
 256
 257 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset);
 258 void xfer_download_queue(struct fxp_xfer *xfer);
 259 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin);
 260 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len);
 261
 262 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset);
 263 int xfer_upload_ready(struct fxp_xfer *xfer);
 264 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len);
 265 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin);
 266
 267 int xfer_done(struct fxp_xfer *xfer);
 268 void xfer_set_error(struct fxp_xfer *xfer);
 269 void xfer_cleanup(struct fxp_xfer *xfer);