[u/mdw/putty] / sftp.h

/*
 * sftp.h: definitions for SFTP and the sftp.c routines.
 */

#include "int64.h"

#define SSH_FXP_INIT                              1	/* 0x1 */
#define SSH_FXP_VERSION                           2	/* 0x2 */
#define SSH_FXP_OPEN                              3	/* 0x3 */
#define SSH_FXP_CLOSE                             4	/* 0x4 */
#define SSH_FXP_READ                              5	/* 0x5 */
#define SSH_FXP_WRITE                             6	/* 0x6 */
#define SSH_FXP_LSTAT                             7	/* 0x7 */
#define SSH_FXP_FSTAT                             8	/* 0x8 */
#define SSH_FXP_SETSTAT                           9	/* 0x9 */
#define SSH_FXP_FSETSTAT                          10	/* 0xa */
#define SSH_FXP_OPENDIR                           11	/* 0xb */
#define SSH_FXP_READDIR                           12	/* 0xc */
#define SSH_FXP_REMOVE                            13	/* 0xd */
#define SSH_FXP_MKDIR                             14	/* 0xe */
#define SSH_FXP_RMDIR                             15	/* 0xf */
#define SSH_FXP_REALPATH                          16	/* 0x10 */
#define SSH_FXP_STAT                              17	/* 0x11 */
#define SSH_FXP_RENAME                            18	/* 0x12 */
#define SSH_FXP_STATUS                            101	/* 0x65 */
#define SSH_FXP_HANDLE                            102	/* 0x66 */
#define SSH_FXP_DATA                              103	/* 0x67 */
#define SSH_FXP_NAME                              104	/* 0x68 */
#define SSH_FXP_ATTRS                             105	/* 0x69 */
#define SSH_FXP_EXTENDED                          200	/* 0xc8 */
#define SSH_FXP_EXTENDED_REPLY                    201	/* 0xc9 */

#define SSH_FX_OK                                 0
#define SSH_FX_EOF                                1
#define SSH_FX_NO_SUCH_FILE                       2
#define SSH_FX_PERMISSION_DENIED                  3
#define SSH_FX_FAILURE                            4
#define SSH_FX_BAD_MESSAGE                        5
#define SSH_FX_NO_CONNECTION                      6
#define SSH_FX_CONNECTION_LOST                    7
#define SSH_FX_OP_UNSUPPORTED                     8

#define SSH_FILEXFER_ATTR_SIZE                    0x00000001
#define SSH_FILEXFER_ATTR_UIDGID                  0x00000002
#define SSH_FILEXFER_ATTR_PERMISSIONS             0x00000004
#define SSH_FILEXFER_ATTR_ACMODTIME               0x00000008
#define SSH_FILEXFER_ATTR_EXTENDED                0x80000000

#define SSH_FXF_READ                              0x00000001
#define SSH_FXF_WRITE                             0x00000002
#define SSH_FXF_APPEND                            0x00000004
#define SSH_FXF_CREAT                             0x00000008
#define SSH_FXF_TRUNC                             0x00000010
#define SSH_FXF_EXCL                              0x00000020

#define SFTP_PROTO_VERSION 3

/*
 * External references. The sftp client module sftp.c expects to be
 * able to get at these functions.
 * 
 * sftp_recvdata must never return less than len. It either blocks
 * until len is available, or it returns failure.
 * 
 * Both functions return 1 on success, 0 on failure.
 */
int sftp_senddata(char *data, int len);
int sftp_recvdata(char *data, int len);

/*
 * Free sftp_requests
 */
void sftp_cleanup_request(void);

struct fxp_attrs {
    unsigned long flags;
    uint64 size;
    unsigned long uid;
    unsigned long gid;
    unsigned long permissions;
    unsigned long atime;
    unsigned long mtime;
};

/*
 * Copy between the possibly-unused permissions field in an fxp_attrs
 * and a possibly-negative integer containing the same permissions.
 */
#define PUT_PERMISSIONS(attrs, perms)                   \
    ((perms) >= 0 ?                                     \
     ((attrs).flags |= SSH_FILEXFER_ATTR_PERMISSIONS,   \
      (attrs).permissions = (perms)) :                  \
     ((attrs).flags &= ~SSH_FILEXFER_ATTR_PERMISSIONS))
#define GET_PERMISSIONS(attrs)                          \
    ((attrs).flags & SSH_FILEXFER_ATTR_PERMISSIONS ?    \
     (attrs).permissions : -1)

struct fxp_handle {
    char *hstring;
    int hlen;
};

struct fxp_name {
    char *filename, *longname;
    struct fxp_attrs attrs;
};

struct fxp_names {
    int nnames;
    struct fxp_name *names;
};

struct sftp_request;
struct sftp_packet;

const char *fxp_error(void);
int fxp_error_type(void);

/*
 * Perform exchange of init/version packets. Return 0 on failure.
 */
int fxp_init(void);

/*
 * Canonify a pathname. Concatenate the two given path elements
 * with a separating slash, unless the second is NULL.
 */
struct sftp_request *fxp_realpath_send(char *path);
char *fxp_realpath_recv(struct sftp_packet *pktin, struct sftp_request *req);

/*
 * Open a file. 'attrs' contains attributes to be applied to the file
 * if it's being created.
 */
struct sftp_request *fxp_open_send(char *path, int type,
                                   struct fxp_attrs *attrs);
struct fxp_handle *fxp_open_recv(struct sftp_packet *pktin,
				 struct sftp_request *req);

/*
 * Open a directory.
 */
struct sftp_request *fxp_opendir_send(char *path);
struct fxp_handle *fxp_opendir_recv(struct sftp_packet *pktin,
				    struct sftp_request *req);

/*
 * Close a file/dir.
 */
struct sftp_request *fxp_close_send(struct fxp_handle *handle);
void fxp_close_recv(struct sftp_packet *pktin, struct sftp_request *req);

/*
 * Make a directory.
 */
struct sftp_request *fxp_mkdir_send(char *path);
int fxp_mkdir_recv(struct sftp_packet *pktin, struct sftp_request *req);

/*
 * Remove a directory.
 */
struct sftp_request *fxp_rmdir_send(char *path);
int fxp_rmdir_recv(struct sftp_packet *pktin, struct sftp_request *req);

/*
 * Remove a file.
 */
struct sftp_request *fxp_remove_send(char *fname);
int fxp_remove_recv(struct sftp_packet *pktin, struct sftp_request *req);

/*
 * Rename a file.
 */
struct sftp_request *fxp_rename_send(char *srcfname, char *dstfname);
int fxp_rename_recv(struct sftp_packet *pktin, struct sftp_request *req);

/*
 * Return file attributes.
 */
struct sftp_request *fxp_stat_send(char *fname);
int fxp_stat_recv(struct sftp_packet *pktin, struct sftp_request *req,
		  struct fxp_attrs *attrs);
struct sftp_request *fxp_fstat_send(struct fxp_handle *handle);
int fxp_fstat_recv(struct sftp_packet *pktin, struct sftp_request *req,
		   struct fxp_attrs *attrs);

/*
 * Set file attributes.
 */
struct sftp_request *fxp_setstat_send(char *fname, struct fxp_attrs attrs);
int fxp_setstat_recv(struct sftp_packet *pktin, struct sftp_request *req);
struct sftp_request *fxp_fsetstat_send(struct fxp_handle *handle,
				       struct fxp_attrs attrs);
int fxp_fsetstat_recv(struct sftp_packet *pktin, struct sftp_request *req);

/*
 * Read from a file.
 */
struct sftp_request *fxp_read_send(struct fxp_handle *handle,
				   uint64 offset, int len);
int fxp_read_recv(struct sftp_packet *pktin, struct sftp_request *req,
		  char *buffer, int len);

/*
 * Write to a file. Returns 0 on error, 1 on OK.
 */
struct sftp_request *fxp_write_send(struct fxp_handle *handle,
				    char *buffer, uint64 offset, int len);
int fxp_write_recv(struct sftp_packet *pktin, struct sftp_request *req);

/*
 * Read from a directory.
 */
struct sftp_request *fxp_readdir_send(struct fxp_handle *handle);
struct fxp_names *fxp_readdir_recv(struct sftp_packet *pktin,
				   struct sftp_request *req);

/*
 * Free up an fxp_names structure.
 */
void fxp_free_names(struct fxp_names *names);

/*
 * Duplicate and free fxp_name structures.
 */
struct fxp_name *fxp_dup_name(struct fxp_name *name);
void fxp_free_name(struct fxp_name *name);

/*
 * Store user data in an sftp_request structure.
 */
void *fxp_get_userdata(struct sftp_request *req);
void fxp_set_userdata(struct sftp_request *req, void *data);

/*
 * These functions might well be temporary placeholders to be
 * replaced with more useful similar functions later. They form the
 * main dispatch loop for processing incoming SFTP responses.
 */
void sftp_register(struct sftp_request *req);
struct sftp_request *sftp_find_request(struct sftp_packet *pktin);
struct sftp_packet *sftp_recv(void);

/*
 * A wrapper to go round fxp_read_* and fxp_write_*, which manages
 * the queueing of multiple read/write requests.
 */

struct fxp_xfer;

struct fxp_xfer *xfer_download_init(struct fxp_handle *fh, uint64 offset);
void xfer_download_queue(struct fxp_xfer *xfer);
int xfer_download_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin);
int xfer_download_data(struct fxp_xfer *xfer, void **buf, int *len);

struct fxp_xfer *xfer_upload_init(struct fxp_handle *fh, uint64 offset);
int xfer_upload_ready(struct fxp_xfer *xfer);
void xfer_upload_data(struct fxp_xfer *xfer, char *buffer, int len);
int xfer_upload_gotpkt(struct fxp_xfer *xfer, struct sftp_packet *pktin);

int xfer_done(struct fxp_xfer *xfer);
void xfer_set_error(struct fxp_xfer *xfer);
void xfer_cleanup(struct fxp_xfer *xfer);
Commit	Line	Data
4c7f0d61	1	/*
	2	* sftp.h: definitions for SFTP and the sftp.c routines.
	3	*/
	4
	5	#include "int64.h"
	6
32874aea	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 */
4c7f0d61	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
4a8fc3c4	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
679539d7	70	/*
	71	* Free sftp_requests
	72	*/
	73	void sftp_cleanup_request(void);
	74
4c7f0d61	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
ee07dce4	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
4c7f0d61	98	struct fxp_handle {
4c7f0d61	99	char *hstring;
f9e162aa	100	int hlen;
4c7f0d61	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
1bc24185	113	struct sftp_request;
	114	struct sftp_packet;
	115
4c7f0d61	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	*/
1bc24185	128	struct sftp_request fxp_realpath_send(char path);
7b7de4f4	129	char fxp_realpath_recv(struct sftp_packet pktin, struct sftp_request *req);
4c7f0d61	130
4c7f0d61	131	/*
ee07dce4	132	* Open a file. 'attrs' contains attributes to be applied to the file
ee07dce4	133	* if it's being created.
4c7f0d61	134	*/
ee07dce4	135	struct sftp_request fxp_open_send(char path, int type,
ee07dce4	136	struct fxp_attrs *attrs);
7b7de4f4	137	struct fxp_handle fxp_open_recv(struct sftp_packet pktin,
7b7de4f4	138	struct sftp_request *req);
4c7f0d61	139
	140	/*
	141	* Open a directory.
	142	*/
1bc24185	143	struct sftp_request fxp_opendir_send(char path);
7b7de4f4	144	struct fxp_handle fxp_opendir_recv(struct sftp_packet pktin,
7b7de4f4	145	struct sftp_request *req);
4c7f0d61	146
	147	/*
	148	* Close a file/dir.
	149	*/
1bc24185	150	struct sftp_request fxp_close_send(struct fxp_handle handle);
7b7de4f4	151	void fxp_close_recv(struct sftp_packet pktin, struct sftp_request req);
4c7f0d61	152
4c7f0d61	153	/*
d92624dc	154	* Make a directory.
9954aaa3	155	*/
1bc24185	156	struct sftp_request fxp_mkdir_send(char path);
7b7de4f4	157	int fxp_mkdir_recv(struct sftp_packet pktin, struct sftp_request req);
9954aaa3	158
9954aaa3	159	/*
d92624dc	160	* Remove a directory.
9954aaa3	161	*/
1bc24185	162	struct sftp_request fxp_rmdir_send(char path);
7b7de4f4	163	int fxp_rmdir_recv(struct sftp_packet pktin, struct sftp_request req);
9954aaa3	164
9954aaa3	165	/*
d92624dc	166	* Remove a file.
9954aaa3	167	*/
1bc24185	168	struct sftp_request fxp_remove_send(char fname);
7b7de4f4	169	int fxp_remove_recv(struct sftp_packet pktin, struct sftp_request req);
d92624dc	170
	171	/*
	172	* Rename a file.
	173	*/
1bc24185	174	struct sftp_request fxp_rename_send(char srcfname, char *dstfname);
7b7de4f4	175	int fxp_rename_recv(struct sftp_packet pktin, struct sftp_request req);
d92624dc	176
	177	/*
	178	* Return file attributes.
	179	*/
1bc24185	180	struct sftp_request fxp_stat_send(char fname);
7b7de4f4	181	int fxp_stat_recv(struct sftp_packet pktin, struct sftp_request req,
7b7de4f4	182	struct fxp_attrs *attrs);
1bc24185	183	struct sftp_request fxp_fstat_send(struct fxp_handle handle);
7b7de4f4	184	int fxp_fstat_recv(struct sftp_packet pktin, struct sftp_request req,
7b7de4f4	185	struct fxp_attrs *attrs);
d92624dc	186
	187	/*
	188	* Set file attributes.
	189	*/
1bc24185	190	struct sftp_request fxp_setstat_send(char fname, struct fxp_attrs attrs);
7b7de4f4	191	int fxp_setstat_recv(struct sftp_packet pktin, struct sftp_request req);
1bc24185	192	struct sftp_request fxp_fsetstat_send(struct fxp_handle handle,
1bc24185	193	struct fxp_attrs attrs);
7b7de4f4	194	int fxp_fsetstat_recv(struct sftp_packet pktin, struct sftp_request req);
9954aaa3	195
9954aaa3	196	/*
4c7f0d61	197	* Read from a file.
4c7f0d61	198	*/
1bc24185	199	struct sftp_request fxp_read_send(struct fxp_handle handle,
1bc24185	200	uint64 offset, int len);
7b7de4f4	201	int fxp_read_recv(struct sftp_packet pktin, struct sftp_request req,
7b7de4f4	202	char *buffer, int len);
4c7f0d61	203
4c7f0d61	204	/*
4a8fc3c4	205	* Write to a file. Returns 0 on error, 1 on OK.
4a8fc3c4	206	*/
1bc24185	207	struct sftp_request fxp_write_send(struct fxp_handle handle,
1bc24185	208	char *buffer, uint64 offset, int len);
7b7de4f4	209	int fxp_write_recv(struct sftp_packet pktin, struct sftp_request req);
4a8fc3c4	210
4a8fc3c4	211	/*
4c7f0d61	212	* Read from a directory.
4c7f0d61	213	*/
1bc24185	214	struct sftp_request fxp_readdir_send(struct fxp_handle handle);
7b7de4f4	215	struct fxp_names fxp_readdir_recv(struct sftp_packet pktin,
7b7de4f4	216	struct sftp_request *req);
4c7f0d61	217
	218	/*
	219	* Free up an fxp_names structure.
	220	*/
	221	void fxp_free_names(struct fxp_names *names);
7d2c1789	222
	223	/*
	224	* Duplicate and free fxp_name structures.
	225	*/
	226	struct fxp_name fxp_dup_name(struct fxp_name name);
	227	void fxp_free_name(struct fxp_name *name);
1bc24185	228
1bc24185	229	/*
c606c42d	230	* Store user data in an sftp_request structure.
	231	*/
	232	void fxp_get_userdata(struct sftp_request req);
	233	void fxp_set_userdata(struct sftp_request req, void data);
	234
	235	/*
1bc24185	236	* These functions might well be temporary placeholders to be
	237	* replaced with more useful similar functions later. They form the
	238	* main dispatch loop for processing incoming SFTP responses.
	239	*/
	240	void sftp_register(struct sftp_request *req);
	241	struct sftp_request sftp_find_request(struct sftp_packet pktin);
	242	struct sftp_packet *sftp_recv(void);
c606c42d	243
	244	/*
	245	* A wrapper to go round fxp_read_* and fxp_write_*, which manages
	246	* the queueing of multiple read/write requests.
	247	*/
	248
	249	struct fxp_xfer;
	250
	251	struct fxp_xfer xfer_download_init(struct fxp_handle fh, uint64 offset);
c606c42d	252	void xfer_download_queue(struct fxp_xfer *xfer);
	253	int xfer_download_gotpkt(struct fxp_xfer xfer, struct sftp_packet pktin);
	254	int xfer_download_data(struct fxp_xfer xfer, void buf, int len);
	255
df0870fc	256	struct fxp_xfer xfer_upload_init(struct fxp_handle fh, uint64 offset);
	257	int xfer_upload_ready(struct fxp_xfer *xfer);
	258	void xfer_upload_data(struct fxp_xfer xfer, char buffer, int len);
	259	int xfer_upload_gotpkt(struct fxp_xfer xfer, struct sftp_packet pktin);
	260
	261	int xfer_done(struct fxp_xfer *xfer);
c606c42d	262	void xfer_set_error(struct fxp_xfer *xfer);
c606c42d	263	void xfer_cleanup(struct fxp_xfer *xfer);