1 /* $OpenBSD: sftp-client.h,v 1.12 2004/02/17 05:39:51 djm Exp $ */
4 * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 /* Client side of SSH2 filexfer protocol */
21 #ifndef _SFTP_CLIENT_H
22 #define _SFTP_CLIENT_H
24 typedef struct SFTP_DIRENT SFTP_DIRENT
;
33 * Initialiase a SSH filexfer connection. Returns -1 on error or
34 * protocol version on success.
36 struct sftp_conn
*do_init(int, int, u_int
, u_int
);
38 u_int
sftp_proto_version(struct sftp_conn
*);
40 /* Close file referred to by 'handle' */
41 int do_close(struct sftp_conn
*, char *, u_int
);
43 /* Read contents of 'path' to NULL-terminated array 'dir' */
44 int do_readdir(struct sftp_conn
*, char *, SFTP_DIRENT
***);
46 /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */
47 void free_sftp_dirents(SFTP_DIRENT
**);
49 /* Delete file 'path' */
50 int do_rm(struct sftp_conn
*, char *);
52 /* Create directory 'path' */
53 int do_mkdir(struct sftp_conn
*, char *, Attrib
*);
55 /* Remove directory 'path' */
56 int do_rmdir(struct sftp_conn
*, char *);
58 /* Get file attributes of 'path' (follows symlinks) */
59 Attrib
*do_stat(struct sftp_conn
*, char *, int);
61 /* Get file attributes of 'path' (does not follow symlinks) */
62 Attrib
*do_lstat(struct sftp_conn
*, char *, int);
64 /* Get file attributes of open file 'handle' */
65 Attrib
*do_fstat(struct sftp_conn
*, char *, u_int
, int);
67 /* Set file attributes of 'path' */
68 int do_setstat(struct sftp_conn
*, char *, Attrib
*);
70 /* Set file attributes of open file 'handle' */
71 int do_fsetstat(struct sftp_conn
*, char *, u_int
, Attrib
*);
73 /* Canonicalise 'path' - caller must free result */
74 char *do_realpath(struct sftp_conn
*, char *);
76 /* Rename 'oldpath' to 'newpath' */
77 int do_rename(struct sftp_conn
*, char *, char *);
79 /* Rename 'oldpath' to 'newpath' */
80 int do_symlink(struct sftp_conn
*, char *, char *);
82 /* Return target of symlink 'path' - caller must free result */
83 char *do_readlink(struct sftp_conn
*, char *);
85 /* XXX: add callbacks to do_download/do_upload so we can do progress meter */
88 * Download 'remote_path' to 'local_path'. Preserve permissions and times
91 int do_download(struct sftp_conn
*, char *, char *, int);
94 * Upload 'local_path' to 'remote_path'. Preserve permissions and times
97 int do_upload(struct sftp_conn
*, char *, char *, int);