| /* $OpenBSD: sftp-client.h,v 1.22 2013/08/08 05:04:03 djm Exp $ */ |
| |
| /* |
| * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org> |
| * |
| * Permission to use, copy, modify, and distribute this software for any |
| * purpose with or without fee is hereby granted, provided that the above |
| * copyright notice and this permission notice appear in all copies. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
| * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
| * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
| * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| */ |
| |
| /* Client side of SSH2 filexfer protocol */ |
| |
| #ifndef _SFTP_CLIENT_H |
| #define _SFTP_CLIENT_H |
| |
| typedef struct SFTP_DIRENT SFTP_DIRENT; |
| |
| struct SFTP_DIRENT { |
| char *filename; |
| char *longname; |
| Attrib a; |
| }; |
| |
| /* |
| * Used for statvfs responses on the wire from the server, because the |
| * server's native format may be larger than the client's. |
| */ |
| struct sftp_statvfs { |
| u_int64_t f_bsize; |
| u_int64_t f_frsize; |
| u_int64_t f_blocks; |
| u_int64_t f_bfree; |
| u_int64_t f_bavail; |
| u_int64_t f_files; |
| u_int64_t f_ffree; |
| u_int64_t f_favail; |
| u_int64_t f_fsid; |
| u_int64_t f_flag; |
| u_int64_t f_namemax; |
| }; |
| |
| /* |
| * Initialise a SSH filexfer connection. Returns NULL on error or |
| * a pointer to a initialized sftp_conn struct on success. |
| */ |
| struct sftp_conn *do_init(int, int, u_int, u_int, u_int64_t); |
| |
| u_int sftp_proto_version(struct sftp_conn *); |
| |
| /* Close file referred to by 'handle' */ |
| int do_close(struct sftp_conn *, char *, u_int); |
| |
| /* Read contents of 'path' to NULL-terminated array 'dir' */ |
| int do_readdir(struct sftp_conn *, char *, SFTP_DIRENT ***); |
| |
| /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */ |
| void free_sftp_dirents(SFTP_DIRENT **); |
| |
| /* Delete file 'path' */ |
| int do_rm(struct sftp_conn *, char *); |
| |
| /* Create directory 'path' */ |
| int do_mkdir(struct sftp_conn *, char *, Attrib *, int); |
| |
| /* Remove directory 'path' */ |
| int do_rmdir(struct sftp_conn *, char *); |
| |
| /* Get file attributes of 'path' (follows symlinks) */ |
| Attrib *do_stat(struct sftp_conn *, char *, int); |
| |
| /* Get file attributes of 'path' (does not follow symlinks) */ |
| Attrib *do_lstat(struct sftp_conn *, char *, int); |
| |
| /* Set file attributes of 'path' */ |
| int do_setstat(struct sftp_conn *, char *, Attrib *); |
| |
| /* Set file attributes of open file 'handle' */ |
| int do_fsetstat(struct sftp_conn *, char *, u_int, Attrib *); |
| |
| /* Canonicalise 'path' - caller must free result */ |
| char *do_realpath(struct sftp_conn *, char *); |
| |
| /* Get statistics for filesystem hosting file at "path" */ |
| int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int); |
| |
| /* Rename 'oldpath' to 'newpath' */ |
| int do_rename(struct sftp_conn *, char *, char *m, int force_legacy); |
| |
| /* Link 'oldpath' to 'newpath' */ |
| int do_hardlink(struct sftp_conn *, char *, char *); |
| |
| /* Rename 'oldpath' to 'newpath' */ |
| int do_symlink(struct sftp_conn *, char *, char *); |
| |
| /* XXX: add callbacks to do_download/do_upload so we can do progress meter */ |
| |
| /* |
| * Download 'remote_path' to 'local_path'. Preserve permissions and times |
| * if 'pflag' is set |
| */ |
| int do_download(struct sftp_conn *, char *, char *, Attrib *, int, int); |
| |
| /* |
| * Recursively download 'remote_directory' to 'local_directory'. Preserve |
| * times if 'pflag' is set |
| */ |
| int download_dir(struct sftp_conn *, char *, char *, Attrib *, int, int, int); |
| |
| /* |
| * Upload 'local_path' to 'remote_path'. Preserve permissions and times |
| * if 'pflag' is set |
| */ |
| int do_upload(struct sftp_conn *, char *, char *, int); |
| |
| /* |
| * Recursively upload 'local_directory' to 'remote_directory'. Preserve |
| * times if 'pflag' is set |
| */ |
| int upload_dir(struct sftp_conn *, char *, char *, int, int); |
| |
| /* Concatenate paths, taking care of slashes. Caller must free result. */ |
| char *path_append(char *, char *); |
| |
| #endif |