]>
Commit | Line | Data |
---|---|---|
5a3cde15 | 1 | /* $OpenBSD: sftp-client.h,v 1.17 2008/06/08 20:15:29 dtucker Exp $ */ |
61e96248 | 2 | |
3 | /* | |
ab3932ab | 4 | * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org> |
61e96248 | 5 | * |
ab3932ab | 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. | |
61e96248 | 9 | * |
ab3932ab | 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. | |
61e96248 | 17 | */ |
18 | ||
19 | /* Client side of SSH2 filexfer protocol */ | |
20 | ||
22e6c827 | 21 | #ifndef _SFTP_CLIENT_H |
22 | #define _SFTP_CLIENT_H | |
23 | ||
2e4fb373 | 24 | typedef struct SFTP_DIRENT SFTP_DIRENT; |
25 | ||
26 | struct SFTP_DIRENT { | |
27 | char *filename; | |
28 | char *longname; | |
29 | Attrib a; | |
30 | }; | |
31 | ||
5a3cde15 | 32 | /* |
33 | * Used for statvfs responses on the wire from the server, because the | |
34 | * server's native format may be larger than the client's. | |
35 | */ | |
36 | struct sftp_statvfs { | |
37 | u_int64_t f_bsize; | |
38 | u_int64_t f_frsize; | |
39 | u_int64_t f_blocks; | |
40 | u_int64_t f_bfree; | |
41 | u_int64_t f_bavail; | |
42 | u_int64_t f_files; | |
43 | u_int64_t f_ffree; | |
44 | u_int64_t f_favail; | |
45 | u_int64_t f_fsid; | |
46 | u_int64_t f_flag; | |
47 | u_int64_t f_namemax; | |
48 | }; | |
49 | ||
cd332296 | 50 | /* |
d95daa6d | 51 | * Initialise a SSH filexfer connection. Returns NULL on error or |
47460206 | 52 | * a pointer to a initialized sftp_conn struct on success. |
3a7fe5ba | 53 | */ |
9906a836 | 54 | struct sftp_conn *do_init(int, int, u_int, u_int); |
22e6c827 | 55 | |
9906a836 | 56 | u_int sftp_proto_version(struct sftp_conn *); |
61e96248 | 57 | |
58 | /* Close file referred to by 'handle' */ | |
22e6c827 | 59 | int do_close(struct sftp_conn *, char *, u_int); |
61e96248 | 60 | |
2e4fb373 | 61 | /* Read contents of 'path' to NULL-terminated array 'dir' */ |
22e6c827 | 62 | int do_readdir(struct sftp_conn *, char *, SFTP_DIRENT ***); |
2e4fb373 | 63 | |
64 | /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */ | |
1c06a9ca | 65 | void free_sftp_dirents(SFTP_DIRENT **); |
2e4fb373 | 66 | |
61e96248 | 67 | /* Delete file 'path' */ |
22e6c827 | 68 | int do_rm(struct sftp_conn *, char *); |
61e96248 | 69 | |
70 | /* Create directory 'path' */ | |
22e6c827 | 71 | int do_mkdir(struct sftp_conn *, char *, Attrib *); |
61e96248 | 72 | |
73 | /* Remove directory 'path' */ | |
22e6c827 | 74 | int do_rmdir(struct sftp_conn *, char *); |
61e96248 | 75 | |
76 | /* Get file attributes of 'path' (follows symlinks) */ | |
22e6c827 | 77 | Attrib *do_stat(struct sftp_conn *, char *, int); |
61e96248 | 78 | |
79 | /* Get file attributes of 'path' (does not follow symlinks) */ | |
22e6c827 | 80 | Attrib *do_lstat(struct sftp_conn *, char *, int); |
61e96248 | 81 | |
61e96248 | 82 | /* Set file attributes of 'path' */ |
22e6c827 | 83 | int do_setstat(struct sftp_conn *, char *, Attrib *); |
61e96248 | 84 | |
85 | /* Set file attributes of open file 'handle' */ | |
22e6c827 | 86 | int do_fsetstat(struct sftp_conn *, char *, u_int, Attrib *); |
61e96248 | 87 | |
88 | /* Canonicalise 'path' - caller must free result */ | |
22e6c827 | 89 | char *do_realpath(struct sftp_conn *, char *); |
61e96248 | 90 | |
360b43ab | 91 | /* Get statistics for filesystem hosting file at "path" */ |
5a3cde15 | 92 | int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int); |
360b43ab | 93 | |
61e96248 | 94 | /* Rename 'oldpath' to 'newpath' */ |
22e6c827 | 95 | int do_rename(struct sftp_conn *, char *, char *); |
61e96248 | 96 | |
3a7fe5ba | 97 | /* Rename 'oldpath' to 'newpath' */ |
22e6c827 | 98 | int do_symlink(struct sftp_conn *, char *, char *); |
3a7fe5ba | 99 | |
61e96248 | 100 | /* XXX: add callbacks to do_download/do_upload so we can do progress meter */ |
101 | ||
102 | /* | |
103 | * Download 'remote_path' to 'local_path'. Preserve permissions and times | |
104 | * if 'pflag' is set | |
105 | */ | |
22e6c827 | 106 | int do_download(struct sftp_conn *, char *, char *, int); |
61e96248 | 107 | |
108 | /* | |
109 | * Upload 'local_path' to 'remote_path'. Preserve permissions and times | |
110 | * if 'pflag' is set | |
111 | */ | |
22e6c827 | 112 | int do_upload(struct sftp_conn *, char *, char *, int); |
113 | ||
114 | #endif |