Annotation of src/usr.bin/ssh/sftp-client.h, Revision 1.33
1.33 ! djm 1: /* $OpenBSD: sftp-client.h,v 1.32 2021/08/07 00:08:52 djm 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:
1.30 djm 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: };
1.32 djm 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 */
1.30 djm 62:
1.17 dtucker 63: /*
1.14 jmc 64: * Initialise a SSH filexfer connection. Returns NULL on error or
1.13 djm 65: * a pointer to a initialized sftp_conn struct on success.
1.2 djm 66: */
1.19 djm 67: struct sftp_conn *do_init(int, int, u_int, u_int, u_int64_t);
1.9 djm 68:
1.10 deraadt 69: u_int sftp_proto_version(struct sftp_conn *);
1.30 djm 70:
71: /* Query server limits */
72: int do_limits(struct sftp_conn *, struct sftp_limits *);
1.1 djm 73:
74: /* Close file referred to by 'handle' */
1.26 djm 75: int do_close(struct sftp_conn *, const u_char *, u_int);
1.3 djm 76:
77: /* Read contents of 'path' to NULL-terminated array 'dir' */
1.26 djm 78: int do_readdir(struct sftp_conn *, const char *, SFTP_DIRENT ***);
1.3 djm 79:
80: /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */
1.6 itojun 81: void free_sftp_dirents(SFTP_DIRENT **);
1.1 djm 82:
83: /* Delete file 'path' */
1.26 djm 84: int do_rm(struct sftp_conn *, const char *);
1.1 djm 85:
86: /* Create directory 'path' */
1.26 djm 87: int do_mkdir(struct sftp_conn *, const char *, Attrib *, int);
1.1 djm 88:
89: /* Remove directory 'path' */
1.26 djm 90: int do_rmdir(struct sftp_conn *, const char *);
1.1 djm 91:
92: /* Get file attributes of 'path' (follows symlinks) */
1.26 djm 93: Attrib *do_stat(struct sftp_conn *, const char *, int);
1.1 djm 94:
95: /* Get file attributes of 'path' (does not follow symlinks) */
1.26 djm 96: Attrib *do_lstat(struct sftp_conn *, const char *, int);
1.1 djm 97:
98: /* Set file attributes of 'path' */
1.26 djm 99: int do_setstat(struct sftp_conn *, const char *, Attrib *);
1.1 djm 100:
101: /* Set file attributes of open file 'handle' */
1.26 djm 102: int do_fsetstat(struct sftp_conn *, const u_char *, u_int, Attrib *);
1.28 djm 103:
104: /* Set file attributes of 'path', not following symlinks */
105: int do_lsetstat(struct sftp_conn *conn, const char *path, Attrib *a);
1.1 djm 106:
107: /* Canonicalise 'path' - caller must free result */
1.26 djm 108: char *do_realpath(struct sftp_conn *, const char *);
1.16 djm 109:
110: /* Get statistics for filesystem hosting file at "path" */
1.17 dtucker 111: int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int);
1.1 djm 112:
113: /* Rename 'oldpath' to 'newpath' */
1.26 djm 114: int do_rename(struct sftp_conn *, const char *, const char *, int force_legacy);
1.20 djm 115:
116: /* Link 'oldpath' to 'newpath' */
1.26 djm 117: int do_hardlink(struct sftp_conn *, const char *, const char *);
1.2 djm 118:
119: /* Rename 'oldpath' to 'newpath' */
1.26 djm 120: int do_symlink(struct sftp_conn *, const char *, const char *);
1.1 djm 121:
1.24 djm 122: /* Call fsync() on open file 'handle' */
1.26 djm 123: int do_fsync(struct sftp_conn *conn, u_char *, u_int);
1.24 djm 124:
1.1 djm 125: /*
126: * Download 'remote_path' to 'local_path'. Preserve permissions and times
127: * if 'pflag' is set
128: */
1.26 djm 129: int do_download(struct sftp_conn *, const char *, const char *,
130: Attrib *, int, int, int);
1.18 djm 131:
132: /*
1.27 djm 133: * Recursively download 'remote_directory' to 'local_directory'. Preserve
1.18 djm 134: * times if 'pflag' is set
135: */
1.26 djm 136: int download_dir(struct sftp_conn *, const char *, const char *,
1.33 ! djm 137: Attrib *, int, int, int, int, int);
1.1 djm 138:
139: /*
140: * Upload 'local_path' to 'remote_path'. Preserve permissions and times
141: * if 'pflag' is set
142: */
1.26 djm 143: int do_upload(struct sftp_conn *, const char *, const char *, int, int, int);
1.18 djm 144:
145: /*
1.27 djm 146: * Recursively upload 'local_directory' to 'remote_directory'. Preserve
1.18 djm 147: * times if 'pflag' is set
148: */
1.26 djm 149: int upload_dir(struct sftp_conn *, const char *, const char *, int, int, int,
1.33 ! djm 150: int, int);
1.31 djm 151:
152: /*
153: * Download a 'from_path' from the 'from' connection and upload it to
154: * to 'to' connection at 'to_path'.
155: */
156: int
157: do_crossload(struct sftp_conn *from, struct sftp_conn *to,
158: const char *from_path, const char *to_path,
159: Attrib *a, int preserve_flag);
160:
161: /*
162: * Recursively download a directory from 'from_path' from the 'from'
163: * connection and upload it to 'to' connection at 'to_path'.
164: */
165: int crossload_dir(struct sftp_conn *from, struct sftp_conn *to,
166: const char *from_path, const char *to_path,
1.33 ! djm 167: Attrib *dirattrib, int preserve_flag, int print_flag,
! 168: int follow_link_flag);
1.18 djm 169:
170: /* Concatenate paths, taking care of slashes. Caller must free result. */
1.26 djm 171: char *path_append(const char *, const char *);
1.29 djm 172:
173: /* Make absolute path if relative path and CWD is given. Does not modify
174: * original if the the path is already absolute. */
175: char *make_absolute(char *, const char *);
176:
177: /* Check if remote path is directory */
178: int remote_is_dir(struct sftp_conn *conn, const char *path);
179:
180: /* Check if local path is directory */
181: int local_is_dir(const char *path);
182:
183: /* Check whether path returned from glob(..., GLOB_MARK, ...) is a directory */
184: int globpath_is_dir(const char *pathname);
1.9 djm 185:
186: #endif
![[BACK]](/icons/back.gif){kind=icon}
Return to sftp-client.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh