Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 1 | /* $OpenBSD: sftp-client.h,v 1.26 2015/01/14 13:54:13 djm Exp $ */ |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 2 | |
| 3 | /* |
| 4 | * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org> |
| 5 | * |
| 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. |
| 9 | * |
| 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. |
| 17 | */ |
| 18 | |
| 19 | /* Client side of SSH2 filexfer protocol */ |
| 20 | |
| 21 | #ifndef _SFTP_CLIENT_H |
| 22 | #define _SFTP_CLIENT_H |
| 23 | |
| 24 | typedef struct SFTP_DIRENT SFTP_DIRENT; |
| 25 | |
| 26 | struct SFTP_DIRENT { |
| 27 | char *filename; |
| 28 | char *longname; |
| 29 | Attrib a; |
| 30 | }; |
| 31 | |
| 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 | |
| 50 | /* |
| 51 | * Initialise a SSH filexfer connection. Returns NULL on error or |
| 52 | * a pointer to a initialized sftp_conn struct on success. |
| 53 | */ |
| 54 | struct sftp_conn *do_init(int, int, u_int, u_int, u_int64_t); |
| 55 | |
| 56 | u_int sftp_proto_version(struct sftp_conn *); |
| 57 | |
| 58 | /* Close file referred to by 'handle' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 59 | int do_close(struct sftp_conn *, const u_char *, u_int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 60 | |
| 61 | /* Read contents of 'path' to NULL-terminated array 'dir' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 62 | int do_readdir(struct sftp_conn *, const char *, SFTP_DIRENT ***); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 63 | |
| 64 | /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */ |
| 65 | void free_sftp_dirents(SFTP_DIRENT **); |
| 66 | |
| 67 | /* Delete file 'path' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 68 | int do_rm(struct sftp_conn *, const char *); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 69 | |
| 70 | /* Create directory 'path' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 71 | int do_mkdir(struct sftp_conn *, const char *, Attrib *, int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 72 | |
| 73 | /* Remove directory 'path' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 74 | int do_rmdir(struct sftp_conn *, const char *); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 75 | |
| 76 | /* Get file attributes of 'path' (follows symlinks) */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 77 | Attrib *do_stat(struct sftp_conn *, const char *, int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 78 | |
| 79 | /* Get file attributes of 'path' (does not follow symlinks) */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 80 | Attrib *do_lstat(struct sftp_conn *, const char *, int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 81 | |
| 82 | /* Set file attributes of 'path' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 83 | int do_setstat(struct sftp_conn *, const char *, Attrib *); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 84 | |
| 85 | /* Set file attributes of open file 'handle' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 86 | int do_fsetstat(struct sftp_conn *, const u_char *, u_int, Attrib *); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 87 | |
| 88 | /* Canonicalise 'path' - caller must free result */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 89 | char *do_realpath(struct sftp_conn *, const char *); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 90 | |
| 91 | /* Get statistics for filesystem hosting file at "path" */ |
| 92 | int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int); |
| 93 | |
| 94 | /* Rename 'oldpath' to 'newpath' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 95 | int do_rename(struct sftp_conn *, const char *, const char *, int force_legacy); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 96 | |
| 97 | /* Link 'oldpath' to 'newpath' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 98 | int do_hardlink(struct sftp_conn *, const char *, const char *); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 99 | |
| 100 | /* Rename 'oldpath' to 'newpath' */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 101 | int do_symlink(struct sftp_conn *, const char *, const char *); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 102 | |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 103 | /* Call fsync() on open file 'handle' */ |
| 104 | int do_fsync(struct sftp_conn *conn, u_char *, u_int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 105 | |
| 106 | /* |
| 107 | * Download 'remote_path' to 'local_path'. Preserve permissions and times |
| 108 | * if 'pflag' is set |
| 109 | */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 110 | int do_download(struct sftp_conn *, const char *, const char *, |
| 111 | Attrib *, int, int, int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 112 | |
| 113 | /* |
| 114 | * Recursively download 'remote_directory' to 'local_directory'. Preserve |
| 115 | * times if 'pflag' is set |
| 116 | */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 117 | int download_dir(struct sftp_conn *, const char *, const char *, |
| 118 | Attrib *, int, int, int, int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 119 | |
| 120 | /* |
| 121 | * Upload 'local_path' to 'remote_path'. Preserve permissions and times |
| 122 | * if 'pflag' is set |
| 123 | */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 124 | int do_upload(struct sftp_conn *, const char *, const char *, int, int, int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 125 | |
| 126 | /* |
| 127 | * Recursively upload 'local_directory' to 'remote_directory'. Preserve |
| 128 | * times if 'pflag' is set |
| 129 | */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 130 | int upload_dir(struct sftp_conn *, const char *, const char *, int, int, int, |
| 131 | int); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 132 | |
| 133 | /* Concatenate paths, taking care of slashes. Caller must free result. */ |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 134 | char *path_append(const char *, const char *); |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 135 | |
| 136 | #endif |