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