1 /* $OpenBSD: sftp-client.h,v 1.30 2021/03/31 22:16:34 djm Exp $ */ 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 /* Used for limits response on the wire from the server */ 51 struct sftp_limits { 52 u_int64_t packet_length; 53 u_int64_t read_length; 54 u_int64_t write_length; 55 u_int64_t open_handles; 56 }; 57 58 /* 59 * Initialise a SSH filexfer connection. Returns NULL on error or 60 * a pointer to a initialized sftp_conn struct on success. 61 */ 62 struct sftp_conn *do_init(int, int, u_int, u_int, u_int64_t); 63 64 u_int sftp_proto_version(struct sftp_conn *); 65 66 /* Query server limits */ 67 int do_limits(struct sftp_conn *, struct sftp_limits *); 68 69 /* Close file referred to by 'handle' */ 70 int do_close(struct sftp_conn *, const u_char *, u_int); 71 72 /* Read contents of 'path' to NULL-terminated array 'dir' */ 73 int do_readdir(struct sftp_conn *, const char *, SFTP_DIRENT ***); 74 75 /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */ 76 void free_sftp_dirents(SFTP_DIRENT **); 77 78 /* Delete file 'path' */ 79 int do_rm(struct sftp_conn *, const char *); 80 81 /* Create directory 'path' */ 82 int do_mkdir(struct sftp_conn *, const char *, Attrib *, int); 83 84 /* Remove directory 'path' */ 85 int do_rmdir(struct sftp_conn *, const char *); 86 87 /* Get file attributes of 'path' (follows symlinks) */ 88 Attrib *do_stat(struct sftp_conn *, const char *, int); 89 90 /* Get file attributes of 'path' (does not follow symlinks) */ 91 Attrib *do_lstat(struct sftp_conn *, const char *, int); 92 93 /* Set file attributes of 'path' */ 94 int do_setstat(struct sftp_conn *, const char *, Attrib *); 95 96 /* Set file attributes of open file 'handle' */ 97 int do_fsetstat(struct sftp_conn *, const u_char *, u_int, Attrib *); 98 99 /* Set file attributes of 'path', not following symlinks */ 100 int do_lsetstat(struct sftp_conn *conn, const char *path, Attrib *a); 101 102 /* Canonicalise 'path' - caller must free result */ 103 char *do_realpath(struct sftp_conn *, const char *); 104 105 /* Get statistics for filesystem hosting file at "path" */ 106 int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int); 107 108 /* Rename 'oldpath' to 'newpath' */ 109 int do_rename(struct sftp_conn *, const char *, const char *, int force_legacy); 110 111 /* Link 'oldpath' to 'newpath' */ 112 int do_hardlink(struct sftp_conn *, const char *, const char *); 113 114 /* Rename 'oldpath' to 'newpath' */ 115 int do_symlink(struct sftp_conn *, const char *, const char *); 116 117 /* Call fsync() on open file 'handle' */ 118 int do_fsync(struct sftp_conn *conn, u_char *, u_int); 119 120 /* 121 * Download 'remote_path' to 'local_path'. Preserve permissions and times 122 * if 'pflag' is set 123 */ 124 int do_download(struct sftp_conn *, const char *, const char *, 125 Attrib *, int, int, int); 126 127 /* 128 * Recursively download 'remote_directory' to 'local_directory'. Preserve 129 * times if 'pflag' is set 130 */ 131 int download_dir(struct sftp_conn *, const char *, const char *, 132 Attrib *, int, int, int, int); 133 134 /* 135 * Upload 'local_path' to 'remote_path'. Preserve permissions and times 136 * if 'pflag' is set 137 */ 138 int do_upload(struct sftp_conn *, const char *, const char *, int, int, int); 139 140 /* 141 * Recursively upload 'local_directory' to 'remote_directory'. Preserve 142 * times if 'pflag' is set 143 */ 144 int upload_dir(struct sftp_conn *, const char *, const char *, int, int, int, 145 int); 146 147 /* Concatenate paths, taking care of slashes. Caller must free result. */ 148 char *path_append(const char *, const char *); 149 150 /* Make absolute path if relative path and CWD is given. Does not modify 151 * original if the the path is already absolute. */ 152 char *make_absolute(char *, const char *); 153 154 /* Check if remote path is directory */ 155 int remote_is_dir(struct sftp_conn *conn, const char *path); 156 157 /* Check if local path is directory */ 158 int local_is_dir(const char *path); 159 160 /* Check whether path returned from glob(..., GLOB_MARK, ...) is a directory */ 161 int globpath_is_dir(const char *pathname); 162 163 #endif 164