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 struct fxp_attrs {
  59     unsigned long flags;
  60     uint64 size;
  61     unsigned long uid;
  62     unsigned long gid;
  63     unsigned long permissions;
  64     unsigned long atime;
  65     unsigned long mtime;
  66 };
  67
  68 struct fxp_handle {
  69     char *hstring;
  70 };
  71
  72 struct fxp_name {
  73     char *filename, *longname;
  74     struct fxp_attrs attrs;
  75 };
  76
  77 struct fxp_names {
  78     int nnames;
  79     struct fxp_name *names;
  80 };
  81
  82 const char *fxp_error(void);
  83 int fxp_error_type(void);
  84
  85 /*
  86  * Perform exchange of init/version packets. Return 0 on failure.
  87  */
  88 int fxp_init(void);
  89
  90 /*
  91  * Canonify a pathname. Concatenate the two given path elements
  92  * with a separating slash, unless the second is NULL.
  93  */
  94 char *fxp_realpath(char *path, char *path2);
  95
  96 /*
  97  * Open a file.
  98  */
  99 struct fxp_handle *fxp_open(char *path, int type);
 100
 101 /*
 102  * Open a directory.
 103  */
 104 struct fxp_handle *fxp_opendir(char *path);
 105
 106 /*
 107  * Close a file/dir.
 108  */
 109 void fxp_close(struct fxp_handle *handle);
 110
 111 /*
 112  * Read from a file.
 113  */
 114 int fxp_read(struct fxp_handle *handle, char *buffer, uint64 offset, int len);
 115
 116 /*
 117  * Read from a directory.
 118  */
 119 struct fxp_names *fxp_readdir(struct fxp_handle *handle);
 120
 121 /*
 122  * Free up an fxp_names structure.
 123  */
 124 void fxp_free_names(struct fxp_names *names);