Annotation of src/usr.bin/ssh/sftp-client.h, Revision 1.26
1.26 ! djm 1: /* $OpenBSD: sftp-client.h,v 1.25 2014/04/21 14:36:16 logan Exp $ */
1.1 djm 2:
3: /*
1.12 djm 4: * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org>
1.1 djm 5: *
1.12 djm 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.
1.1 djm 9: *
1.12 djm 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.
1.1 djm 17: */
18:
19: /* Client side of SSH2 filexfer protocol */
20:
1.9 djm 21: #ifndef _SFTP_CLIENT_H
22: #define _SFTP_CLIENT_H
23:
1.3 djm 24: typedef struct SFTP_DIRENT SFTP_DIRENT;
25:
26: struct SFTP_DIRENT {
27: char *filename;
28: char *longname;
29: Attrib a;
30: };
31:
1.5 markus 32: /*
1.17 dtucker 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: /*
1.14 jmc 51: * Initialise a SSH filexfer connection. Returns NULL on error or
1.13 djm 52: * a pointer to a initialized sftp_conn struct on success.
1.2 djm 53: */
1.19 djm 54: struct sftp_conn *do_init(int, int, u_int, u_int, u_int64_t);
1.9 djm 55:
1.10 deraadt 56: u_int sftp_proto_version(struct sftp_conn *);
1.1 djm 57:
58: /* Close file referred to by 'handle' */
1.26 ! djm 59: int do_close(struct sftp_conn *, const u_char *, u_int);
1.3 djm 60:
61: /* Read contents of 'path' to NULL-terminated array 'dir' */
1.26 ! djm 62: int do_readdir(struct sftp_conn *, const char *, SFTP_DIRENT ***);
1.3 djm 63:
64: /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */
1.6 itojun 65: void free_sftp_dirents(SFTP_DIRENT **);
1.1 djm 66:
67: /* Delete file 'path' */
1.26 ! djm 68: int do_rm(struct sftp_conn *, const char *);
1.1 djm 69:
70: /* Create directory 'path' */
1.26 ! djm 71: int do_mkdir(struct sftp_conn *, const char *, Attrib *, int);
1.1 djm 72:
73: /* Remove directory 'path' */
1.26 ! djm 74: int do_rmdir(struct sftp_conn *, const char *);
1.1 djm 75:
76: /* Get file attributes of 'path' (follows symlinks) */
1.26 ! djm 77: Attrib *do_stat(struct sftp_conn *, const char *, int);
1.1 djm 78:
79: /* Get file attributes of 'path' (does not follow symlinks) */
1.26 ! djm 80: Attrib *do_lstat(struct sftp_conn *, const char *, int);
1.1 djm 81:
82: /* Set file attributes of 'path' */
1.26 ! djm 83: int do_setstat(struct sftp_conn *, const char *, Attrib *);
1.1 djm 84:
85: /* Set file attributes of open file 'handle' */
1.26 ! djm 86: int do_fsetstat(struct sftp_conn *, const u_char *, u_int, Attrib *);
1.1 djm 87:
88: /* Canonicalise 'path' - caller must free result */
1.26 ! djm 89: char *do_realpath(struct sftp_conn *, const char *);
1.16 djm 90:
91: /* Get statistics for filesystem hosting file at "path" */
1.17 dtucker 92: int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int);
1.1 djm 93:
94: /* Rename 'oldpath' to 'newpath' */
1.26 ! djm 95: int do_rename(struct sftp_conn *, const char *, const char *, int force_legacy);
1.20 djm 96:
97: /* Link 'oldpath' to 'newpath' */
1.26 ! djm 98: int do_hardlink(struct sftp_conn *, const char *, const char *);
1.2 djm 99:
100: /* Rename 'oldpath' to 'newpath' */
1.26 ! djm 101: int do_symlink(struct sftp_conn *, const char *, const char *);
1.1 djm 102:
1.24 djm 103: /* Call fsync() on open file 'handle' */
1.26 ! djm 104: int do_fsync(struct sftp_conn *conn, u_char *, u_int);
1.24 djm 105:
1.1 djm 106: /*
107: * Download 'remote_path' to 'local_path'. Preserve permissions and times
108: * if 'pflag' is set
109: */
1.26 ! djm 110: int do_download(struct sftp_conn *, const char *, const char *,
! 111: Attrib *, int, int, int);
1.18 djm 112:
113: /*
114: * Recursively download 'remote_directory' to 'local_directory'. Preserve
115: * times if 'pflag' is set
116: */
1.26 ! djm 117: int download_dir(struct sftp_conn *, const char *, const char *,
! 118: Attrib *, int, int, int, int);
1.1 djm 119:
120: /*
121: * Upload 'local_path' to 'remote_path'. Preserve permissions and times
122: * if 'pflag' is set
123: */
1.26 ! djm 124: int do_upload(struct sftp_conn *, const char *, const char *, int, int, int);
1.18 djm 125:
126: /*
127: * Recursively upload 'local_directory' to 'remote_directory'. Preserve
128: * times if 'pflag' is set
129: */
1.26 ! djm 130: int upload_dir(struct sftp_conn *, const char *, const char *, int, int, int,
! 131: int);
1.18 djm 132:
133: /* Concatenate paths, taking care of slashes. Caller must free result. */
1.26 ! djm 134: char *path_append(const char *, const char *);
1.9 djm 135:
136: #endif