[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);

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

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.
 */
struct sftp_request *fxp_open_send(char *path, int type);
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
4c7f0d61	70	struct fxp_attrs {
	71	unsigned long flags;
	72	uint64 size;
	73	unsigned long uid;
	74	unsigned long gid;
	75	unsigned long permissions;
	76	unsigned long atime;
	77	unsigned long mtime;
	78	};
	79
	80	struct fxp_handle {
	81	char *hstring;
f9e162aa	82	int hlen;
4c7f0d61	83	};
	84
	85	struct fxp_name {
	86	char filename, longname;
	87	struct fxp_attrs attrs;
	88	};
	89
	90	struct fxp_names {
	91	int nnames;
	92	struct fxp_name *names;
	93	};
	94
1bc24185	95	struct sftp_request;
	96	struct sftp_packet;
	97
4c7f0d61	98	const char *fxp_error(void);
	99	int fxp_error_type(void);
	100
	101	/*
	102	* Perform exchange of init/version packets. Return 0 on failure.
	103	*/
	104	int fxp_init(void);
	105
	106	/*
	107	* Canonify a pathname. Concatenate the two given path elements
	108	* with a separating slash, unless the second is NULL.
	109	*/
1bc24185	110	struct sftp_request fxp_realpath_send(char path);
7b7de4f4	111	char fxp_realpath_recv(struct sftp_packet pktin, struct sftp_request *req);
4c7f0d61	112
	113	/*
	114	* Open a file.
	115	*/
1bc24185	116	struct sftp_request fxp_open_send(char path, int type);
7b7de4f4	117	struct fxp_handle fxp_open_recv(struct sftp_packet pktin,
7b7de4f4	118	struct sftp_request *req);
4c7f0d61	119
	120	/*
	121	* Open a directory.
	122	*/
1bc24185	123	struct sftp_request fxp_opendir_send(char path);
7b7de4f4	124	struct fxp_handle fxp_opendir_recv(struct sftp_packet pktin,
7b7de4f4	125	struct sftp_request *req);
4c7f0d61	126
	127	/*
	128	* Close a file/dir.
	129	*/
1bc24185	130	struct sftp_request fxp_close_send(struct fxp_handle handle);
7b7de4f4	131	void fxp_close_recv(struct sftp_packet pktin, struct sftp_request req);
4c7f0d61	132
4c7f0d61	133	/*
d92624dc	134	* Make a directory.
9954aaa3	135	*/
1bc24185	136	struct sftp_request fxp_mkdir_send(char path);
7b7de4f4	137	int fxp_mkdir_recv(struct sftp_packet pktin, struct sftp_request req);
9954aaa3	138
9954aaa3	139	/*
d92624dc	140	* Remove a directory.
9954aaa3	141	*/
1bc24185	142	struct sftp_request fxp_rmdir_send(char path);
7b7de4f4	143	int fxp_rmdir_recv(struct sftp_packet pktin, struct sftp_request req);
9954aaa3	144
9954aaa3	145	/*
d92624dc	146	* Remove a file.
9954aaa3	147	*/
1bc24185	148	struct sftp_request fxp_remove_send(char fname);
7b7de4f4	149	int fxp_remove_recv(struct sftp_packet pktin, struct sftp_request req);
d92624dc	150
	151	/*
	152	* Rename a file.
	153	*/
1bc24185	154	struct sftp_request fxp_rename_send(char srcfname, char *dstfname);
7b7de4f4	155	int fxp_rename_recv(struct sftp_packet pktin, struct sftp_request req);
d92624dc	156
	157	/*
	158	* Return file attributes.
	159	*/
1bc24185	160	struct sftp_request fxp_stat_send(char fname);
7b7de4f4	161	int fxp_stat_recv(struct sftp_packet pktin, struct sftp_request req,
7b7de4f4	162	struct fxp_attrs *attrs);
1bc24185	163	struct sftp_request fxp_fstat_send(struct fxp_handle handle);
7b7de4f4	164	int fxp_fstat_recv(struct sftp_packet pktin, struct sftp_request req,
7b7de4f4	165	struct fxp_attrs *attrs);
d92624dc	166
	167	/*
	168	* Set file attributes.
	169	*/
1bc24185	170	struct sftp_request fxp_setstat_send(char fname, struct fxp_attrs attrs);
7b7de4f4	171	int fxp_setstat_recv(struct sftp_packet pktin, struct sftp_request req);
1bc24185	172	struct sftp_request fxp_fsetstat_send(struct fxp_handle handle,
1bc24185	173	struct fxp_attrs attrs);
7b7de4f4	174	int fxp_fsetstat_recv(struct sftp_packet pktin, struct sftp_request req);
9954aaa3	175
9954aaa3	176	/*
4c7f0d61	177	* Read from a file.
4c7f0d61	178	*/
1bc24185	179	struct sftp_request fxp_read_send(struct fxp_handle handle,
1bc24185	180	uint64 offset, int len);
7b7de4f4	181	int fxp_read_recv(struct sftp_packet pktin, struct sftp_request req,
7b7de4f4	182	char *buffer, int len);
4c7f0d61	183
4c7f0d61	184	/*
4a8fc3c4	185	* Write to a file. Returns 0 on error, 1 on OK.
4a8fc3c4	186	*/
1bc24185	187	struct sftp_request fxp_write_send(struct fxp_handle handle,
1bc24185	188	char *buffer, uint64 offset, int len);
7b7de4f4	189	int fxp_write_recv(struct sftp_packet pktin, struct sftp_request req);
4a8fc3c4	190
4a8fc3c4	191	/*
4c7f0d61	192	* Read from a directory.
4c7f0d61	193	*/
1bc24185	194	struct sftp_request fxp_readdir_send(struct fxp_handle handle);
7b7de4f4	195	struct fxp_names fxp_readdir_recv(struct sftp_packet pktin,
7b7de4f4	196	struct sftp_request *req);
4c7f0d61	197
	198	/*
	199	* Free up an fxp_names structure.
	200	*/
	201	void fxp_free_names(struct fxp_names *names);
7d2c1789	202
	203	/*
	204	* Duplicate and free fxp_name structures.
	205	*/
	206	struct fxp_name fxp_dup_name(struct fxp_name name);
	207	void fxp_free_name(struct fxp_name *name);
1bc24185	208
1bc24185	209	/*
c606c42d	210	* Store user data in an sftp_request structure.
	211	*/
	212	void fxp_get_userdata(struct sftp_request req);
	213	void fxp_set_userdata(struct sftp_request req, void data);
	214
	215	/*
1bc24185	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.
	219	*/
	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);
c606c42d	223
	224	/*
	225	* A wrapper to go round fxp_read_* and fxp_write_*, which manages
	226	* the queueing of multiple read/write requests.
	227	*/
	228
	229	struct fxp_xfer;
	230
	231	struct fxp_xfer xfer_download_init(struct fxp_handle fh, uint64 offset);
c606c42d	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);
	235
df0870fc	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);
	240
	241	int xfer_done(struct fxp_xfer *xfer);
c606c42d	242	void xfer_set_error(struct fxp_xfer *xfer);
c606c42d	243	void xfer_cleanup(struct fxp_xfer *xfer);