]>
Commit | Line | Data |
---|---|---|
9906a836 | 1 | /* $OpenBSD: sftp-client.h,v 1.10 2002/06/23 09:30:14 deraadt Exp $ */ |
61e96248 | 2 | |
3 | /* | |
22e6c827 | 4 | * Copyright (c) 2001,2002 Damien Miller. All rights reserved. |
61e96248 | 5 | * |
6 | * Redistribution and use in source and binary forms, with or without | |
7 | * modification, are permitted provided that the following conditions | |
8 | * are met: | |
9 | * 1. Redistributions of source code must retain the above copyright | |
10 | * notice, this list of conditions and the following disclaimer. | |
11 | * 2. Redistributions in binary form must reproduce the above copyright | |
12 | * notice, this list of conditions and the following disclaimer in the | |
13 | * documentation and/or other materials provided with the distribution. | |
14 | * | |
15 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
16 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | |
17 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | |
18 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | |
19 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | |
20 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
21 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
22 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
23 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | |
24 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
25 | */ | |
26 | ||
27 | /* Client side of SSH2 filexfer protocol */ | |
28 | ||
22e6c827 | 29 | #ifndef _SFTP_CLIENT_H |
30 | #define _SFTP_CLIENT_H | |
31 | ||
2e4fb373 | 32 | typedef struct SFTP_DIRENT SFTP_DIRENT; |
33 | ||
34 | struct SFTP_DIRENT { | |
35 | char *filename; | |
36 | char *longname; | |
37 | Attrib a; | |
38 | }; | |
39 | ||
cd332296 | 40 | /* |
41 | * Initialiase a SSH filexfer connection. Returns -1 on error or | |
3a7fe5ba | 42 | * protocol version on success. |
43 | */ | |
9906a836 | 44 | struct sftp_conn *do_init(int, int, u_int, u_int); |
22e6c827 | 45 | |
9906a836 | 46 | u_int sftp_proto_version(struct sftp_conn *); |
61e96248 | 47 | |
48 | /* Close file referred to by 'handle' */ | |
22e6c827 | 49 | int do_close(struct sftp_conn *, char *, u_int); |
61e96248 | 50 | |
51 | /* List contents of directory 'path' to stdout */ | |
22e6c827 | 52 | int do_ls(struct sftp_conn *, char *); |
61e96248 | 53 | |
2e4fb373 | 54 | /* Read contents of 'path' to NULL-terminated array 'dir' */ |
22e6c827 | 55 | int do_readdir(struct sftp_conn *, char *, SFTP_DIRENT ***); |
2e4fb373 | 56 | |
57 | /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */ | |
1c06a9ca | 58 | void free_sftp_dirents(SFTP_DIRENT **); |
2e4fb373 | 59 | |
61e96248 | 60 | /* Delete file 'path' */ |
22e6c827 | 61 | int do_rm(struct sftp_conn *, char *); |
61e96248 | 62 | |
63 | /* Create directory 'path' */ | |
22e6c827 | 64 | int do_mkdir(struct sftp_conn *, char *, Attrib *); |
61e96248 | 65 | |
66 | /* Remove directory 'path' */ | |
22e6c827 | 67 | int do_rmdir(struct sftp_conn *, char *); |
61e96248 | 68 | |
69 | /* Get file attributes of 'path' (follows symlinks) */ | |
22e6c827 | 70 | Attrib *do_stat(struct sftp_conn *, char *, int); |
61e96248 | 71 | |
72 | /* Get file attributes of 'path' (does not follow symlinks) */ | |
22e6c827 | 73 | Attrib *do_lstat(struct sftp_conn *, char *, int); |
61e96248 | 74 | |
75 | /* Get file attributes of open file 'handle' */ | |
22e6c827 | 76 | Attrib *do_fstat(struct sftp_conn *, char *, u_int, int); |
61e96248 | 77 | |
78 | /* Set file attributes of 'path' */ | |
22e6c827 | 79 | int do_setstat(struct sftp_conn *, char *, Attrib *); |
61e96248 | 80 | |
81 | /* Set file attributes of open file 'handle' */ | |
22e6c827 | 82 | int do_fsetstat(struct sftp_conn *, char *, u_int, Attrib *); |
61e96248 | 83 | |
84 | /* Canonicalise 'path' - caller must free result */ | |
22e6c827 | 85 | char *do_realpath(struct sftp_conn *, char *); |
61e96248 | 86 | |
87 | /* Rename 'oldpath' to 'newpath' */ | |
22e6c827 | 88 | int do_rename(struct sftp_conn *, char *, char *); |
61e96248 | 89 | |
3a7fe5ba | 90 | /* Rename 'oldpath' to 'newpath' */ |
22e6c827 | 91 | int do_symlink(struct sftp_conn *, char *, char *); |
3a7fe5ba | 92 | |
93 | /* Return target of symlink 'path' - caller must free result */ | |
22e6c827 | 94 | char *do_readlink(struct sftp_conn *, char *); |
3a7fe5ba | 95 | |
61e96248 | 96 | /* XXX: add callbacks to do_download/do_upload so we can do progress meter */ |
97 | ||
98 | /* | |
99 | * Download 'remote_path' to 'local_path'. Preserve permissions and times | |
100 | * if 'pflag' is set | |
101 | */ | |
22e6c827 | 102 | int do_download(struct sftp_conn *, char *, char *, int); |
61e96248 | 103 | |
104 | /* | |
105 | * Upload 'local_path' to 'remote_path'. Preserve permissions and times | |
106 | * if 'pflag' is set | |
107 | */ | |
22e6c827 | 108 | int do_upload(struct sftp_conn *, char *, char *, int); |
109 | ||
110 | #endif |