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

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.
 */
char *fxp_realpath(char *path);

/*
 * Open a file.
 */
struct fxp_handle *fxp_open(char *path, int type);

/*
 * Open a directory.
 */
struct fxp_handle *fxp_opendir(char *path);

/*
 * Close a file/dir.
 */
void fxp_close(struct fxp_handle *handle);

/*
 * Makes a directory
 */
int fxp_mkdir(char *path);

/*
 * Removes a directory
 */
int fxp_rmdir(char *path);

/*
 * Removes a file
 */
int fxp_rm(char *fname);

/*
 * Read from a file.
 */
int fxp_read(struct fxp_handle *handle, char *buffer, uint64 offset,
	     int len);

/*
 * Write to a file. Returns 0 on error, 1 on OK.
 */
int fxp_write(struct fxp_handle *handle, char *buffer, uint64 offset,
	      int len);

/*
 * Read from a directory.
 */
struct fxp_names *fxp_readdir(struct fxp_handle *handle);

/*
 * Free up an fxp_names structure.
 */
void fxp_free_names(struct fxp_names *names);
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
	95	const char *fxp_error(void);
	96	int fxp_error_type(void);
	97
	98	/*
	99	* Perform exchange of init/version packets. Return 0 on failure.
	100	*/
	101	int fxp_init(void);
	102
	103	/*
	104	* Canonify a pathname. Concatenate the two given path elements
	105	* with a separating slash, unless the second is NULL.
	106	*/
f9e162aa	107	char fxp_realpath(char path);
4c7f0d61	108
	109	/*
	110	* Open a file.
	111	*/
	112	struct fxp_handle fxp_open(char path, int type);
	113
	114	/*
	115	* Open a directory.
	116	*/
	117	struct fxp_handle fxp_opendir(char path);
	118
	119	/*
	120	* Close a file/dir.
	121	*/
	122	void fxp_close(struct fxp_handle *handle);
	123
	124	/*
9954aaa3	125	* Makes a directory
	126	*/
	127	int fxp_mkdir(char *path);
	128
	129	/*
	130	* Removes a directory
	131	*/
	132	int fxp_rmdir(char *path);
	133
	134	/*
	135	* Removes a file
	136	*/
	137	int fxp_rm(char *fname);
	138
	139	/*
4c7f0d61	140	* Read from a file.
4c7f0d61	141	*/
32874aea	142	int fxp_read(struct fxp_handle handle, char buffer, uint64 offset,
32874aea	143	int len);
4c7f0d61	144
4c7f0d61	145	/*
4a8fc3c4	146	* Write to a file. Returns 0 on error, 1 on OK.
4a8fc3c4	147	*/
32874aea	148	int fxp_write(struct fxp_handle handle, char buffer, uint64 offset,
32874aea	149	int len);
4a8fc3c4	150
4a8fc3c4	151	/*
4c7f0d61	152	* Read from a directory.
	153	*/
	154	struct fxp_names fxp_readdir(struct fxp_handle handle);
	155
	156	/*
	157	* Free up an fxp_names structure.
	158	*/
	159	void fxp_free_names(struct fxp_names *names);