1 /* $OpenBSD: sftp-client.h,v 1.39 2023/09/08 05:56:13 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 *sftp_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 sftp_get_limits(struct sftp_conn *, struct sftp_limits *); 73 74 /* Close file referred to by 'handle' */ 75 int sftp_close(struct sftp_conn *, const u_char *, u_int); 76 77 /* Read contents of 'path' to NULL-terminated array 'dir' */ 78 int sftp_readdir(struct sftp_conn *, const char *, SFTP_DIRENT ***); 79 80 /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from sftp_readdir) */ 81 void sftp_free_dirents(SFTP_DIRENT **); 82 83 /* Delete file 'path' */ 84 int sftp_rm(struct sftp_conn *, const char *); 85 86 /* Create directory 'path' */ 87 int sftp_mkdir(struct sftp_conn *, const char *, Attrib *, int); 88 89 /* Remove directory 'path' */ 90 int sftp_rmdir(struct sftp_conn *, const char *); 91 92 /* Get file attributes of 'path' (follows symlinks) */ 93 int sftp_stat(struct sftp_conn *, const char *, int, Attrib *); 94 95 /* Get file attributes of 'path' (does not follow symlinks) */ 96 int sftp_lstat(struct sftp_conn *, const char *, int, Attrib *); 97 98 /* Set file attributes of 'path' */ 99 int sftp_setstat(struct sftp_conn *, const char *, Attrib *); 100 101 /* Set file attributes of open file 'handle' */ 102 int sftp_fsetstat(struct sftp_conn *, const u_char *, u_int, Attrib *); 103 104 /* Set file attributes of 'path', not following symlinks */ 105 int sftp_lsetstat(struct sftp_conn *conn, const char *path, Attrib *a); 106 107 /* Canonicalise 'path' - caller must free result */ 108 char *sftp_realpath(struct sftp_conn *, const char *); 109 110 /* Canonicalisation with tilde expansion (requires server extension) */ 111 char *sftp_expand_path(struct sftp_conn *, const char *); 112 113 /* Returns non-zero if server can tilde-expand paths */ 114 int sftp_can_expand_path(struct sftp_conn *); 115 116 /* Get statistics for filesystem hosting file at "path" */ 117 int sftp_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int); 118 119 /* Rename 'oldpath' to 'newpath' */ 120 int sftp_rename(struct sftp_conn *, const char *, const char *, int); 121 122 /* Copy 'oldpath' to 'newpath' */ 123 int sftp_copy(struct sftp_conn *, const char *, const char *); 124 125 /* Link 'oldpath' to 'newpath' */ 126 int sftp_hardlink(struct sftp_conn *, const char *, const char *); 127 128 /* Rename 'oldpath' to 'newpath' */ 129 int sftp_symlink(struct sftp_conn *, const char *, const char *); 130 131 /* Call fsync() on open file 'handle' */ 132 int sftp_fsync(struct sftp_conn *conn, u_char *, u_int); 133 134 /* 135 * Download 'remote_path' to 'local_path'. Preserve permissions and times 136 * if 'pflag' is set 137 */ 138 int sftp_download(struct sftp_conn *, const char *, const char *, Attrib *, 139 int, int, int, int); 140 141 /* 142 * Recursively download 'remote_directory' to 'local_directory'. Preserve 143 * times if 'pflag' is set 144 */ 145 int sftp_download_dir(struct sftp_conn *, const char *, const char *, Attrib *, 146 int, int, int, int, int, int); 147 148 /* 149 * Upload 'local_path' to 'remote_path'. Preserve permissions and times 150 * if 'pflag' is set 151 */ 152 int sftp_upload(struct sftp_conn *, const char *, const char *, 153 int, int, int, int); 154 155 /* 156 * Recursively upload 'local_directory' to 'remote_directory'. Preserve 157 * times if 'pflag' is set 158 */ 159 int sftp_upload_dir(struct sftp_conn *, const char *, const char *, 160 int, int, int, int, int, int); 161 162 /* 163 * Download a 'from_path' from the 'from' connection and upload it to 164 * to 'to' connection at 'to_path'. 165 */ 166 int sftp_crossload(struct sftp_conn *from, struct sftp_conn *to, 167 const char *from_path, const char *to_path, 168 Attrib *a, int preserve_flag); 169 170 /* 171 * Recursively download a directory from 'from_path' from the 'from' 172 * connection and upload it to 'to' connection at 'to_path'. 173 */ 174 int sftp_crossload_dir(struct sftp_conn *from, struct sftp_conn *to, 175 const char *from_path, const char *to_path, 176 Attrib *dirattrib, int preserve_flag, int print_flag, 177 int follow_link_flag); 178 179 /* 180 * User/group ID to name translation. 181 */ 182 int sftp_can_get_users_groups_by_id(struct sftp_conn *conn); 183 int sftp_get_users_groups_by_id(struct sftp_conn *conn, 184 const u_int *uids, u_int nuids, 185 const u_int *gids, u_int ngids, 186 char ***usernamesp, char ***groupnamesp); 187 188 /* Concatenate paths, taking care of slashes. Caller must free result. */ 189 char *sftp_path_append(const char *, const char *); 190 191 /* Make absolute path if relative path and CWD is given. Does not modify 192 * original if the path is already absolute. */ 193 char *sftp_make_absolute(char *, const char *); 194 195 /* Check if remote path is directory */ 196 int sftp_remote_is_dir(struct sftp_conn *conn, const char *path); 197 198 /* Check whether path returned from glob(..., GLOB_MARK, ...) is a directory */ 199 int sftp_globpath_is_dir(const char *pathname); 200 201 #endif 202