1 /* $OpenBSD: sftp-client.h,v 1.34 2021/08/09 23:47:44 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 /* print flag values */ 59 #define SFTP_QUIET 0 /* be quiet during transfers */ 60 #define SFTP_PRINT 1 /* list files and show progress bar */ 61 #define SFTP_PROGRESS_ONLY 2 /* progress bar only */ 62 63 /* 64 * Initialise a SSH filexfer connection. Returns NULL on error or 65 * a pointer to a initialized sftp_conn struct on success. 66 */ 67 struct sftp_conn *do_init(int, int, u_int, u_int, u_int64_t); 68 69 u_int sftp_proto_version(struct sftp_conn *); 70 71 /* Query server limits */ 72 int do_limits(struct sftp_conn *, struct sftp_limits *); 73 74 /* Close file referred to by 'handle' */ 75 int do_close(struct sftp_conn *, const u_char *, u_int); 76 77 /* Read contents of 'path' to NULL-terminated array 'dir' */ 78 int do_readdir(struct sftp_conn *, const char *, SFTP_DIRENT ***); 79 80 /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */ 81 void free_sftp_dirents(SFTP_DIRENT **); 82 83 /* Delete file 'path' */ 84 int do_rm(struct sftp_conn *, const char *); 85 86 /* Create directory 'path' */ 87 int do_mkdir(struct sftp_conn *, const char *, Attrib *, int); 88 89 /* Remove directory 'path' */ 90 int do_rmdir(struct sftp_conn *, const char *); 91 92 /* Get file attributes of 'path' (follows symlinks) */ 93 Attrib *do_stat(struct sftp_conn *, const char *, int); 94 95 /* Get file attributes of 'path' (does not follow symlinks) */ 96 Attrib *do_lstat(struct sftp_conn *, const char *, int); 97 98 /* Set file attributes of 'path' */ 99 int do_setstat(struct sftp_conn *, const char *, Attrib *); 100 101 /* Set file attributes of open file 'handle' */ 102 int do_fsetstat(struct sftp_conn *, const u_char *, u_int, Attrib *); 103 104 /* Set file attributes of 'path', not following symlinks */ 105 int do_lsetstat(struct sftp_conn *conn, const char *path, Attrib *a); 106 107 /* Canonicalise 'path' - caller must free result */ 108 char *do_realpath(struct sftp_conn *, const char *); 109 110 /* Canonicalisation with tilde expansion (requires server extension) */ 111 char *do_expand_path(struct sftp_conn *, const char *); 112 113 /* Returns non-zero if server can tilde-expand paths */ 114 int can_expand_path(struct sftp_conn *); 115 116 /* Get statistics for filesystem hosting file at "path" */ 117 int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int); 118 119 /* Rename 'oldpath' to 'newpath' */ 120 int do_rename(struct sftp_conn *, const char *, const char *, int); 121 122 /* Link 'oldpath' to 'newpath' */ 123 int do_hardlink(struct sftp_conn *, const char *, const char *); 124 125 /* Rename 'oldpath' to 'newpath' */ 126 int do_symlink(struct sftp_conn *, const char *, const char *); 127 128 /* Call fsync() on open file 'handle' */ 129 int do_fsync(struct sftp_conn *conn, u_char *, u_int); 130 131 /* 132 * Download 'remote_path' to 'local_path'. Preserve permissions and times 133 * if 'pflag' is set 134 */ 135 int do_download(struct sftp_conn *, const char *, const char *, 136 Attrib *, int, int, int); 137 138 /* 139 * Recursively download 'remote_directory' to 'local_directory'. Preserve 140 * times if 'pflag' is set 141 */ 142 int download_dir(struct sftp_conn *, const char *, const char *, 143 Attrib *, int, int, int, int, int); 144 145 /* 146 * Upload 'local_path' to 'remote_path'. Preserve permissions and times 147 * if 'pflag' is set 148 */ 149 int do_upload(struct sftp_conn *, const char *, const char *, int, int, int); 150 151 /* 152 * Recursively upload 'local_directory' to 'remote_directory'. Preserve 153 * times if 'pflag' is set 154 */ 155 int upload_dir(struct sftp_conn *, const char *, const char *, int, int, int, 156 int, int); 157 158 /* 159 * Download a 'from_path' from the 'from' connection and upload it to 160 * to 'to' connection at 'to_path'. 161 */ 162 int 163 do_crossload(struct sftp_conn *from, struct sftp_conn *to, 164 const char *from_path, const char *to_path, 165 Attrib *a, int preserve_flag); 166 167 /* 168 * Recursively download a directory from 'from_path' from the 'from' 169 * connection and upload it to 'to' connection at 'to_path'. 170 */ 171 int crossload_dir(struct sftp_conn *from, struct sftp_conn *to, 172 const char *from_path, const char *to_path, 173 Attrib *dirattrib, int preserve_flag, int print_flag, 174 int follow_link_flag); 175 176 /* Concatenate paths, taking care of slashes. Caller must free result. */ 177 char *path_append(const char *, const char *); 178 179 /* Make absolute path if relative path and CWD is given. Does not modify 180 * original if the the path is already absolute. */ 181 char *make_absolute(char *, const char *); 182 183 /* Check if remote path is directory */ 184 int remote_is_dir(struct sftp_conn *conn, const char *path); 185 186 /* Check if local path is directory */ 187 int local_is_dir(const char *path); 188 189 /* Check whether path returned from glob(..., GLOB_MARK, ...) is a directory */ 190 int globpath_is_dir(const char *pathname); 191 192 #endif 193