2 * sftp.h: definitions for SFTP and the sftp.c routines.
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 */
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
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
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
56 #define SFTP_PROTO_VERSION 3
59 * External references. The sftp client module sftp.c expects to be
60 * able to get at these functions.
62 * sftp_recvdata must never return less than len. It either blocks
63 * until len is available, or it returns failure.
65 * Both functions return 1 on success, 0 on failure.
67 int sftp_senddata(char *data, int len);
68 int sftp_recvdata(char *data, int len);
75 unsigned long permissions;
86 char *filename, *longname;
87 struct fxp_attrs attrs;
92 struct fxp_name *names;
98 const char *fxp_error(void);
99 int fxp_error_type(void);
102 * Perform exchange of init/version packets. Return 0 on failure.
107 * Canonify a pathname. Concatenate the two given path elements
108 * with a separating slash, unless the second is NULL.
110 struct sftp_request *fxp_realpath_send(char *path);
111 char *fxp_realpath_recv(struct sftp_packet *pktin, struct sftp_request *req);
116 struct sftp_request *fxp_open_send(char *path, int type);
117 struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
118 struct sftp_request *req);
123 struct sftp_request *fxp_opendir_send(char *path);
124 struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
125 struct sftp_request *req);
130 struct sftp_request *fxp_close_send(struct fxp_handle *handle);
131 void fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req);
136 struct sftp_request *fxp_mkdir_send(char *path);
137 int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req);
140 * Remove a directory.
142 struct sftp_request *fxp_rmdir_send(char *path);
143 int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req);
148 struct sftp_request *fxp_remove_send(char *fname);
149 int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req);
154 struct sftp_request *fxp_rename_send(char *srcfname, char *dstfname);
155 int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req);
158 * Return file attributes.
160 struct sftp_request *fxp_stat_send(char *fname);
161 int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
162 struct fxp_attrs *attrs);
163 struct sftp_request *fxp_fstat_send(struct fxp_handle *handle);
164 int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
165 struct fxp_attrs *attrs);
168 * Set file attributes.
170 struct sftp_request *fxp_setstat_send(char *fname, struct fxp_attrs attrs);
171 int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req);
172 struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
173 struct fxp_attrs attrs);
174 int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req);
179 struct sftp_request *fxp_read_send(struct fxp_handle *handle,
180 uint64 offset, int len);
181 int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
182 char *buffer, int len);
185 * Write to a file. Returns 0 on error, 1 on OK.
187 struct sftp_request *fxp_write_send(struct fxp_handle *handle,
188 char *buffer, uint64 offset, int len);
189 int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req);
192 * Read from a directory.
194 struct sftp_request *fxp_readdir_send(struct fxp_handle *handle);
195 struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
196 struct sftp_request *req);
199 * Free up an fxp_names structure.
201 void fxp_free_names(struct fxp_names *names);
204 * Duplicate and free fxp_name structures.
206 struct fxp_name *fxp_dup_name(struct fxp_name *name);
207 void fxp_free_name(struct fxp_name *name);
210 * Store user data in an sftp_request structure.
212 void *fxp_get_userdata(struct sftp_request *req);
213 void fxp_set_userdata(struct sftp_request *req, void *data);
216 * These functions might well be temporary placeholders to be
217 * replaced with more useful similar functions later. They form the
218 * main dispatch loop for processing incoming SFTP responses.
220 void sftp_register(struct sftp_request *req);
221 struct sftp_request *sftp_find_request(struct sftp_packet *pktin);
222 struct sftp_packet *sftp_recv(void);
225 * A wrapper to go round fxp_read_* and fxp_write_*, which manages
226 * the queueing of multiple read/write requests.
231 struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset);
232 void xfer_download_queue(struct fxp_xfer *xfer);
233 int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin);
234 int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len);
236 struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset);
237 int xfer_upload_ready(struct fxp_xfer *xfer);
238 void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len);
239 int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin);
241 int xfer_done(struct fxp_xfer *xfer);
242 void xfer_set_error(struct fxp_xfer *xfer);
243 void xfer_cleanup(struct fxp_xfer *xfer);