1 /* $OpenBSD: sftp-client.h,v 1.20 2010/12/04 00:18:01 djm Exp $ */ 2 3 /* 4 * Copyright (c) 2001-2004 Damien Miller <djm (at) 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' */ 59 int do_close(struct sftp_conn *, char *, u_int); 60 61 /* Read contents of 'path' to NULL-terminated array 'dir' */ 62 int do_readdir(struct sftp_conn *, char *, SFTP_DIRENT ***); 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' */ 68 int do_rm(struct sftp_conn *, char *); 69 70 /* Create directory 'path' */ 71 int do_mkdir(struct sftp_conn *, char *, Attrib *, int); 72 73 /* Remove directory 'path' */ 74 int do_rmdir(struct sftp_conn *, char *); 75 76 /* Get file attributes of 'path' (follows symlinks) */ 77 Attrib *do_stat(struct sftp_conn *, char *, int); 78 79 /* Get file attributes of 'path' (does not follow symlinks) */ 80 Attrib *do_lstat(struct sftp_conn *, char *, int); 81 82 /* Set file attributes of 'path' */ 83 int do_setstat(struct sftp_conn *, char *, Attrib *); 84 85 /* Set file attributes of open file 'handle' */ 86 int do_fsetstat(struct sftp_conn *, char *, u_int, Attrib *); 87 88 /* Canonicalise 'path' - caller must free result */ 89 char *do_realpath(struct sftp_conn *, char *); 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' */ 95 int do_rename(struct sftp_conn *, char *, char *); 96 97 /* Link 'oldpath' to 'newpath' */ 98 int do_hardlink(struct sftp_conn *, char *, char *); 99 100 /* Rename 'oldpath' to 'newpath' */ 101 int do_symlink(struct sftp_conn *, char *, char *); 102 103 /* XXX: add callbacks to do_download/do_upload so we can do progress meter */ 104 105 /* 106 * Download 'remote_path' to 'local_path'. Preserve permissions and times 107 * if 'pflag' is set 108 */ 109 int do_download(struct sftp_conn *, char *, char *, Attrib *, int); 110 111 /* 112 * Recursively download 'remote_directory' to 'local_directory'. Preserve 113 * times if 'pflag' is set 114 */ 115 int download_dir(struct sftp_conn *, char *, char *, Attrib *, int, int); 116 117 /* 118 * Upload 'local_path' to 'remote_path'. Preserve permissions and times 119 * if 'pflag' is set 120 */ 121 int do_upload(struct sftp_conn *, char *, char *, int); 122 123 /* 124 * Recursively upload 'local_directory' to 'remote_directory'. Preserve 125 * times if 'pflag' is set 126 */ 127 int upload_dir(struct sftp_conn *, char *, char *, int, int); 128 129 /* Concatenate paths, taking care of slashes. Caller must free result. */ 130 char *path_append(char *, char *); 131 132 #endif 133
