1*ee116499SAntonio Huete Jimenez /* $OpenBSD: sftp-client.h,v 1.38 2022/09/19 10:43:12 djm Exp $ */ 218de8d7fSPeter Avalos 318de8d7fSPeter Avalos /* 418de8d7fSPeter Avalos * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org> 518de8d7fSPeter Avalos * 618de8d7fSPeter Avalos * Permission to use, copy, modify, and distribute this software for any 718de8d7fSPeter Avalos * purpose with or without fee is hereby granted, provided that the above 818de8d7fSPeter Avalos * copyright notice and this permission notice appear in all copies. 918de8d7fSPeter Avalos * 1018de8d7fSPeter Avalos * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 1118de8d7fSPeter Avalos * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 1218de8d7fSPeter Avalos * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 1318de8d7fSPeter Avalos * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 1418de8d7fSPeter Avalos * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 1518de8d7fSPeter Avalos * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 1618de8d7fSPeter Avalos * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 1718de8d7fSPeter Avalos */ 1818de8d7fSPeter Avalos 1918de8d7fSPeter Avalos /* Client side of SSH2 filexfer protocol */ 2018de8d7fSPeter Avalos 2118de8d7fSPeter Avalos #ifndef _SFTP_CLIENT_H 2218de8d7fSPeter Avalos #define _SFTP_CLIENT_H 2318de8d7fSPeter Avalos 24e9778795SPeter Avalos #ifdef USE_SYSTEM_GLOB 25e9778795SPeter Avalos # include <glob.h> 26e9778795SPeter Avalos #else 27e9778795SPeter Avalos # include "openbsd-compat/glob.h" 28e9778795SPeter Avalos #endif 29e9778795SPeter Avalos 3018de8d7fSPeter Avalos typedef struct SFTP_DIRENT SFTP_DIRENT; 3118de8d7fSPeter Avalos 3218de8d7fSPeter Avalos struct SFTP_DIRENT { 3318de8d7fSPeter Avalos char *filename; 3418de8d7fSPeter Avalos char *longname; 3518de8d7fSPeter Avalos Attrib a; 3618de8d7fSPeter Avalos }; 3718de8d7fSPeter Avalos 3818de8d7fSPeter Avalos /* 3918de8d7fSPeter Avalos * Used for statvfs responses on the wire from the server, because the 4018de8d7fSPeter Avalos * server's native format may be larger than the client's. 4118de8d7fSPeter Avalos */ 4218de8d7fSPeter Avalos struct sftp_statvfs { 4318de8d7fSPeter Avalos u_int64_t f_bsize; 4418de8d7fSPeter Avalos u_int64_t f_frsize; 4518de8d7fSPeter Avalos u_int64_t f_blocks; 4618de8d7fSPeter Avalos u_int64_t f_bfree; 4718de8d7fSPeter Avalos u_int64_t f_bavail; 4818de8d7fSPeter Avalos u_int64_t f_files; 4918de8d7fSPeter Avalos u_int64_t f_ffree; 5018de8d7fSPeter Avalos u_int64_t f_favail; 5118de8d7fSPeter Avalos u_int64_t f_fsid; 5218de8d7fSPeter Avalos u_int64_t f_flag; 5318de8d7fSPeter Avalos u_int64_t f_namemax; 5418de8d7fSPeter Avalos }; 5518de8d7fSPeter Avalos 5650a69bb5SSascha Wildner /* Used for limits response on the wire from the server */ 5750a69bb5SSascha Wildner struct sftp_limits { 5850a69bb5SSascha Wildner u_int64_t packet_length; 5950a69bb5SSascha Wildner u_int64_t read_length; 6050a69bb5SSascha Wildner u_int64_t write_length; 6150a69bb5SSascha Wildner u_int64_t open_handles; 6250a69bb5SSascha Wildner }; 6350a69bb5SSascha Wildner 6450a69bb5SSascha Wildner /* print flag values */ 6550a69bb5SSascha Wildner #define SFTP_QUIET 0 /* be quiet during transfers */ 6650a69bb5SSascha Wildner #define SFTP_PRINT 1 /* list files and show progress bar */ 6750a69bb5SSascha Wildner #define SFTP_PROGRESS_ONLY 2 /* progress bar only */ 6850a69bb5SSascha Wildner 6918de8d7fSPeter Avalos /* 7018de8d7fSPeter Avalos * Initialise a SSH filexfer connection. Returns NULL on error or 7118de8d7fSPeter Avalos * a pointer to a initialized sftp_conn struct on success. 7218de8d7fSPeter Avalos */ 739f304aafSPeter Avalos struct sftp_conn *do_init(int, int, u_int, u_int, u_int64_t); 7418de8d7fSPeter Avalos 7518de8d7fSPeter Avalos u_int sftp_proto_version(struct sftp_conn *); 7618de8d7fSPeter Avalos 7750a69bb5SSascha Wildner /* Query server limits */ 7850a69bb5SSascha Wildner int do_limits(struct sftp_conn *, struct sftp_limits *); 7950a69bb5SSascha Wildner 8018de8d7fSPeter Avalos /* Close file referred to by 'handle' */ 81e9778795SPeter Avalos int do_close(struct sftp_conn *, const u_char *, u_int); 8218de8d7fSPeter Avalos 8318de8d7fSPeter Avalos /* Read contents of 'path' to NULL-terminated array 'dir' */ 84e9778795SPeter Avalos int do_readdir(struct sftp_conn *, const char *, SFTP_DIRENT ***); 8518de8d7fSPeter Avalos 8618de8d7fSPeter Avalos /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */ 8718de8d7fSPeter Avalos void free_sftp_dirents(SFTP_DIRENT **); 8818de8d7fSPeter Avalos 8918de8d7fSPeter Avalos /* Delete file 'path' */ 90e9778795SPeter Avalos int do_rm(struct sftp_conn *, const char *); 9118de8d7fSPeter Avalos 9218de8d7fSPeter Avalos /* Create directory 'path' */ 93e9778795SPeter Avalos int do_mkdir(struct sftp_conn *, const char *, Attrib *, int); 9418de8d7fSPeter Avalos 9518de8d7fSPeter Avalos /* Remove directory 'path' */ 96e9778795SPeter Avalos int do_rmdir(struct sftp_conn *, const char *); 9718de8d7fSPeter Avalos 9818de8d7fSPeter Avalos /* Get file attributes of 'path' (follows symlinks) */ 99e9778795SPeter Avalos Attrib *do_stat(struct sftp_conn *, const char *, int); 10018de8d7fSPeter Avalos 10118de8d7fSPeter Avalos /* Get file attributes of 'path' (does not follow symlinks) */ 102e9778795SPeter Avalos Attrib *do_lstat(struct sftp_conn *, const char *, int); 10318de8d7fSPeter Avalos 10418de8d7fSPeter Avalos /* Set file attributes of 'path' */ 105e9778795SPeter Avalos int do_setstat(struct sftp_conn *, const char *, Attrib *); 10618de8d7fSPeter Avalos 10718de8d7fSPeter Avalos /* Set file attributes of open file 'handle' */ 108e9778795SPeter Avalos int do_fsetstat(struct sftp_conn *, const u_char *, u_int, Attrib *); 10918de8d7fSPeter Avalos 110664f4763Szrj /* Set file attributes of 'path', not following symlinks */ 111664f4763Szrj int do_lsetstat(struct sftp_conn *conn, const char *path, Attrib *a); 112664f4763Szrj 11318de8d7fSPeter Avalos /* Canonicalise 'path' - caller must free result */ 114e9778795SPeter Avalos char *do_realpath(struct sftp_conn *, const char *); 11518de8d7fSPeter Avalos 11650a69bb5SSascha Wildner /* Canonicalisation with tilde expansion (requires server extension) */ 11750a69bb5SSascha Wildner char *do_expand_path(struct sftp_conn *, const char *); 11850a69bb5SSascha Wildner 11950a69bb5SSascha Wildner /* Returns non-zero if server can tilde-expand paths */ 12050a69bb5SSascha Wildner int can_expand_path(struct sftp_conn *); 12150a69bb5SSascha Wildner 12218de8d7fSPeter Avalos /* Get statistics for filesystem hosting file at "path" */ 12318de8d7fSPeter Avalos int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int); 12418de8d7fSPeter Avalos 12518de8d7fSPeter Avalos /* Rename 'oldpath' to 'newpath' */ 12650a69bb5SSascha Wildner int do_rename(struct sftp_conn *, const char *, const char *, int); 12718de8d7fSPeter Avalos 128*ee116499SAntonio Huete Jimenez /* Copy 'oldpath' to 'newpath' */ 129*ee116499SAntonio Huete Jimenez int do_copy(struct sftp_conn *, const char *, const char *); 130*ee116499SAntonio Huete Jimenez 1319f304aafSPeter Avalos /* Link 'oldpath' to 'newpath' */ 132e9778795SPeter Avalos int do_hardlink(struct sftp_conn *, const char *, const char *); 1339f304aafSPeter Avalos 13418de8d7fSPeter Avalos /* Rename 'oldpath' to 'newpath' */ 135e9778795SPeter Avalos int do_symlink(struct sftp_conn *, const char *, const char *); 13618de8d7fSPeter Avalos 13736e94dc5SPeter Avalos /* Call fsync() on open file 'handle' */ 138e9778795SPeter Avalos int do_fsync(struct sftp_conn *conn, u_char *, u_int); 13918de8d7fSPeter Avalos 14018de8d7fSPeter Avalos /* 14118de8d7fSPeter Avalos * Download 'remote_path' to 'local_path'. Preserve permissions and times 14218de8d7fSPeter Avalos * if 'pflag' is set 14318de8d7fSPeter Avalos */ 144*ee116499SAntonio Huete Jimenez int do_download(struct sftp_conn *, const char *, const char *, Attrib *, 145*ee116499SAntonio Huete Jimenez int, int, int, int); 146856ea928SPeter Avalos 147856ea928SPeter Avalos /* 148856ea928SPeter Avalos * Recursively download 'remote_directory' to 'local_directory'. Preserve 149856ea928SPeter Avalos * times if 'pflag' is set 150856ea928SPeter Avalos */ 151*ee116499SAntonio Huete Jimenez int download_dir(struct sftp_conn *, const char *, const char *, Attrib *, 152*ee116499SAntonio Huete Jimenez int, int, int, int, int, int); 15318de8d7fSPeter Avalos 15418de8d7fSPeter Avalos /* 15518de8d7fSPeter Avalos * Upload 'local_path' to 'remote_path'. Preserve permissions and times 15618de8d7fSPeter Avalos * if 'pflag' is set 15718de8d7fSPeter Avalos */ 158*ee116499SAntonio Huete Jimenez int do_upload(struct sftp_conn *, const char *, const char *, 159*ee116499SAntonio Huete Jimenez int, int, int, int); 16018de8d7fSPeter Avalos 161856ea928SPeter Avalos /* 162856ea928SPeter Avalos * Recursively upload 'local_directory' to 'remote_directory'. Preserve 163856ea928SPeter Avalos * times if 'pflag' is set 164856ea928SPeter Avalos */ 165*ee116499SAntonio Huete Jimenez int upload_dir(struct sftp_conn *, const char *, const char *, 166*ee116499SAntonio Huete Jimenez int, int, int, int, int, int); 16750a69bb5SSascha Wildner 16850a69bb5SSascha Wildner /* 16950a69bb5SSascha Wildner * Download a 'from_path' from the 'from' connection and upload it to 17050a69bb5SSascha Wildner * to 'to' connection at 'to_path'. 17150a69bb5SSascha Wildner */ 17250a69bb5SSascha Wildner int 17350a69bb5SSascha Wildner do_crossload(struct sftp_conn *from, struct sftp_conn *to, 17450a69bb5SSascha Wildner const char *from_path, const char *to_path, 17550a69bb5SSascha Wildner Attrib *a, int preserve_flag); 17650a69bb5SSascha Wildner 17750a69bb5SSascha Wildner /* 17850a69bb5SSascha Wildner * Recursively download a directory from 'from_path' from the 'from' 17950a69bb5SSascha Wildner * connection and upload it to 'to' connection at 'to_path'. 18050a69bb5SSascha Wildner */ 18150a69bb5SSascha Wildner int crossload_dir(struct sftp_conn *from, struct sftp_conn *to, 18250a69bb5SSascha Wildner const char *from_path, const char *to_path, 18350a69bb5SSascha Wildner Attrib *dirattrib, int preserve_flag, int print_flag, 18450a69bb5SSascha Wildner int follow_link_flag); 185856ea928SPeter Avalos 186*ee116499SAntonio Huete Jimenez /* 187*ee116499SAntonio Huete Jimenez * User/group ID to name translation. 188*ee116499SAntonio Huete Jimenez */ 189*ee116499SAntonio Huete Jimenez int can_get_users_groups_by_id(struct sftp_conn *conn); 190*ee116499SAntonio Huete Jimenez int do_get_users_groups_by_id(struct sftp_conn *conn, 191*ee116499SAntonio Huete Jimenez const u_int *uids, u_int nuids, 192*ee116499SAntonio Huete Jimenez const u_int *gids, u_int ngids, 193*ee116499SAntonio Huete Jimenez char ***usernamesp, char ***groupnamesp); 194*ee116499SAntonio Huete Jimenez 195856ea928SPeter Avalos /* Concatenate paths, taking care of slashes. Caller must free result. */ 196e9778795SPeter Avalos char *path_append(const char *, const char *); 197856ea928SPeter Avalos 19850a69bb5SSascha Wildner /* Make absolute path if relative path and CWD is given. Does not modify 199*ee116499SAntonio Huete Jimenez * original if the path is already absolute. */ 20050a69bb5SSascha Wildner char *make_absolute(char *, const char *); 20150a69bb5SSascha Wildner 20250a69bb5SSascha Wildner /* Check if remote path is directory */ 20350a69bb5SSascha Wildner int remote_is_dir(struct sftp_conn *conn, const char *path); 20450a69bb5SSascha Wildner 20550a69bb5SSascha Wildner /* Check if local path is directory */ 20650a69bb5SSascha Wildner int local_is_dir(const char *path); 20750a69bb5SSascha Wildner 20850a69bb5SSascha Wildner /* Check whether path returned from glob(..., GLOB_MARK, ...) is a directory */ 20950a69bb5SSascha Wildner int globpath_is_dir(const char *pathname); 21050a69bb5SSascha Wildner 21118de8d7fSPeter Avalos #endif 212