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 int sftp_senddata(char *data, int len);
  68 int sftp_recvdata(char *data, int len);
  69
  70 /*
  71  * Free sftp_requests
  72  */
  73 void sftp_cleanup_request(void);
  74
  75 struct fxp_attrs {
  76     unsigned long flags;
  77     uint64 size;
  78     unsigned long uid;
  79     unsigned long gid;
  80     unsigned long permissions;
  81     unsigned long atime;
  82     unsigned long mtime;
  83 };
  84
  85 /*
  86  * Copy between the possibly-unused permissions field in an fxp_attrs
  87  * and a possibly-negative integer containing the same permissions.
  88  */
  89 #define PUT_PERMISSIONS(attrs, perms)                   \
  90     ((perms) >= 0 ?                                     \
  91      ((attrs).flags |= SSH_FILEXFER_ATTR_PERMISSIONS,   \
  92       (attrs).permissions = (perms)) :                  \
  93      ((attrs).flags &= ~SSH_FILEXFER_ATTR_PERMISSIONS))
  94 #define GET_PERMISSIONS(attrs)                          \
  95     ((attrs).flags & SSH_FILEXFER_ATTR_PERMISSIONS ?    \
  96      (attrs).permissions : -1)
  97
  98 struct fxp_handle {
  99     char *hstring;
 100     int hlen;
 101 };
 102
 103 struct fxp_name {
 104     char *filename, *longname;
 105     struct fxp_attrs attrs;
 106 };
 107
 108 struct fxp_names {
 109     int nnames;
 110     struct fxp_name *names;
 111 };
 112
 113 struct sftp_request;
 114 struct sftp_packet;
 115
 116 const char *fxp_error(void);
 117 int fxp_error_type(void);
 118
 119 /*
 120  * Perform exchange of init/version packets. Return 0 on failure.
 121  */
 122 int fxp_init(void);
 123
 124 /*
 125  * Canonify a pathname. Concatenate the two given path elements
 126  * with a separating slash, unless the second is NULL.
 127  */
 128 struct sftp_request *fxp_realpath_send(const char *path);
 129 char *fxp_realpath_recv(struct sftp_packet *pktin, struct sftp_request *req);
 130
 131 /*
 132  * Open a file. 'attrs' contains attributes to be applied to the file
 133  * if it's being created.
 134  */
 135 struct sftp_request *fxp_open_send(const char *path, int type,
 136                                    struct fxp_attrs *attrs);
 137 struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
 138                                  struct sftp_request *req);
 139
 140 /*
 141  * Open a directory.
 142  */
 143 struct sftp_request *fxp_opendir_send(const char *path);
 144 struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
 145                                     struct sftp_request *req);
 146
 147 /*
 148  * Close a file/dir.
 149  */
 150 struct sftp_request *fxp_close_send(struct fxp_handle *handle);
 151 void fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req);
 152
 153 /*
 154  * Make a directory.
 155  */
 156 struct sftp_request *fxp_mkdir_send(const char *path);
 157 int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req);
 158
 159 /*
 160  * Remove a directory.
 161  */
 162 struct sftp_request *fxp_rmdir_send(const char *path);
 163 int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req);
 164
 165 /*
 166  * Remove a file.
 167  */
 168 struct sftp_request *fxp_remove_send(const char *fname);
 169 int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req);
 170
 171 /*
 172  * Rename a file.
 173  */
 174 struct sftp_request *fxp_rename_send(const char *srcfname,
 175                                      const char *dstfname);
 176 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req);
 177
 178 /*
 179  * Return file attributes.
 180  */
 181 struct sftp_request *fxp_stat_send(const char *fname);
 182 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
 183                   struct fxp_attrs *attrs);
 184 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle);
 185 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
 186                    struct fxp_attrs *attrs);
 187
 188 /*
 189  * Set file attributes.
 190  */
 191 struct sftp_request *fxp_setstat_send(const char *fname,
 192                                       struct fxp_attrs attrs);
 193 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req);
 194 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
 195                                        struct fxp_attrs attrs);
 196 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req);
 197
 198 /*
 199  * Read from a file.
 200  */
 201 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
 202                                    uint64 offset, int len);
 203 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
 204                   char *buffer, int len);
 205
 206 /*
 207  * Write to a file. Returns 0 on error, 1 on OK.
 208  */
 209 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
 210                                     char *buffer, uint64 offset, int len);
 211 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req);
 212
 213 /*
 214  * Read from a directory.
 215  */
 216 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle);
 217 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
 218                                    struct sftp_request *req);
 219
 220 /*
 221  * Free up an fxp_names structure.
 222  */
 223 void fxp_free_names(struct fxp_names *names);
 224
 225 /*
 226  * Duplicate and free fxp_name structures.
 227  */
 228 struct fxp_name *fxp_dup_name(struct fxp_name *name);
 229 void fxp_free_name(struct fxp_name *name);
 230
 231 /*
 232  * Store user data in an sftp_request structure.
 233  */
 234 void *fxp_get_userdata(struct sftp_request *req);
 235 void fxp_set_userdata(struct sftp_request *req, void *data);
 236
 237 /*
 238  * These functions might well be temporary placeholders to be
 239  * replaced with more useful similar functions later. They form the
 240  * main dispatch loop for processing incoming SFTP responses.
 241  */
 242 void sftp_register(struct sftp_request *req);
 243 struct sftp_request *sftp_find_request(struct sftp_packet *pktin);
 244 struct sftp_packet *sftp_recv(void);
 245
 246 /*
 247  * A wrapper to go round fxp_read_* and fxp_write_*, which manages
 248  * the queueing of multiple read/write requests.
 249  */
 250
 251 struct fxp_xfer;
 252
 253 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset);
 254 void xfer_download_queue(struct fxp_xfer *xfer);
 255 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin);
 256 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len);
 257
 258 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset);
 259 int xfer_upload_ready(struct fxp_xfer *xfer);
 260 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len);
 261 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin);
 262
 263 int xfer_done(struct fxp_xfer *xfer);
 264 void xfer_set_error(struct fxp_xfer *xfer);
 265 void xfer_cleanup(struct fxp_xfer *xfer);