1/*	$NetBSD: sftp-client.h,v 1.18 2023/10/25 20:19:57 christos Exp $	*/
2/* $OpenBSD: sftp-client.h,v 1.39 2023/09/08 05:56:13 djm Exp $ */
3
4/*
5 * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19
20/* Client side of SSH2 filexfer protocol */
21
22#ifndef _SFTP_CLIENT_H
23#define _SFTP_CLIENT_H
24
25typedef struct SFTP_DIRENT SFTP_DIRENT;
26
27struct SFTP_DIRENT {
28	char *filename;
29	char *longname;
30	Attrib a;
31};
32
33/*
34 * Used for statvfs responses on the wire from the server, because the
35 * server's native format may be larger than the client's.
36 */
37struct sftp_statvfs {
38	u_int64_t f_bsize;
39	u_int64_t f_frsize;
40	u_int64_t f_blocks;
41	u_int64_t f_bfree;
42	u_int64_t f_bavail;
43	u_int64_t f_files;
44	u_int64_t f_ffree;
45	u_int64_t f_favail;
46	u_int64_t f_fsid;
47	u_int64_t f_flag;
48	u_int64_t f_namemax;
49};
50
51/* Used for limits response on the wire from the server */
52struct sftp_limits {
53	u_int64_t packet_length;
54	u_int64_t read_length;
55	u_int64_t write_length;
56	u_int64_t open_handles;
57};
58
59/* print flag values */
60#define SFTP_QUIET		0	/* be quiet during transfers */
61#define SFTP_PRINT		1	/* list files and show progress bar */
62#define SFTP_PROGRESS_ONLY	2	/* progress bar only */
63
64/*
65 * Initialise a SSH filexfer connection. Returns NULL on error or
66 * a pointer to a initialized sftp_conn struct on success.
67 */
68struct sftp_conn *sftp_init(int, int, u_int, u_int, u_int64_t);
69
70u_int sftp_proto_version(struct sftp_conn *);
71
72/* Query server limits */
73int sftp_get_limits(struct sftp_conn *, struct sftp_limits *);
74
75/* Close file referred to by 'handle' */
76int sftp_close(struct sftp_conn *, const u_char *, u_int);
77
78/* Read contents of 'path' to NULL-terminated array 'dir' */
79int sftp_readdir(struct sftp_conn *, const char *, SFTP_DIRENT ***);
80
81/* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from sftp_readdir) */
82void sftp_free_dirents(SFTP_DIRENT **);
83
84/* Delete file 'path' */
85int sftp_rm(struct sftp_conn *, const char *);
86
87/* Create directory 'path' */
88int sftp_mkdir(struct sftp_conn *, const char *, Attrib *, int);
89
90/* Remove directory 'path' */
91int sftp_rmdir(struct sftp_conn *, const char *);
92
93/* Get file attributes of 'path' (follows symlinks) */
94int sftp_stat(struct sftp_conn *, const char *, int, Attrib *);
95
96/* Get file attributes of 'path' (does not follow symlinks) */
97int sftp_lstat(struct sftp_conn *, const char *, int, Attrib *);
98
99/* Set file attributes of 'path' */
100int sftp_setstat(struct sftp_conn *, const char *, Attrib *);
101
102/* Set file attributes of open file 'handle' */
103int sftp_fsetstat(struct sftp_conn *, const u_char *, u_int, Attrib *);
104
105/* Set file attributes of 'path', not following symlinks */
106int sftp_lsetstat(struct sftp_conn *conn, const char *path, Attrib *a);
107
108/* Canonicalise 'path' - caller must free result */
109char *sftp_realpath(struct sftp_conn *, const char *);
110
111/* Canonicalisation with tilde expansion (requires server extension) */
112char *sftp_expand_path(struct sftp_conn *, const char *);
113
114/* Returns non-zero if server can tilde-expand paths */
115int sftp_can_expand_path(struct sftp_conn *);
116
117/* Get statistics for filesystem hosting file at "path" */
118int sftp_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int);
119
120/* Rename 'oldpath' to 'newpath' */
121int sftp_rename(struct sftp_conn *, const char *, const char *, int);
122
123/* Copy 'oldpath' to 'newpath' */
124int sftp_copy(struct sftp_conn *, const char *, const char *);
125
126/* Link 'oldpath' to 'newpath' */
127int sftp_hardlink(struct sftp_conn *, const char *, const char *);
128
129/* Rename 'oldpath' to 'newpath' */
130int sftp_symlink(struct sftp_conn *, const char *, const char *);
131
132/* Call fsync() on open file 'handle' */
133int sftp_fsync(struct sftp_conn *conn, u_char *, u_int);
134
135/*
136 * Download 'remote_path' to 'local_path'. Preserve permissions and times
137 * if 'pflag' is set
138 */
139int sftp_download(struct sftp_conn *, const char *, const char *, Attrib *,
140    int, int, int, int);
141
142/*
143 * Recursively download 'remote_directory' to 'local_directory'. Preserve
144 * times if 'pflag' is set
145 */
146int sftp_download_dir(struct sftp_conn *, const char *, const char *, Attrib *,
147    int, int, int, int, int, int);
148
149/*
150 * Upload 'local_path' to 'remote_path'. Preserve permissions and times
151 * if 'pflag' is set
152 */
153int sftp_upload(struct sftp_conn *, const char *, const char *,
154    int, int, int, int);
155
156/*
157 * Recursively upload 'local_directory' to 'remote_directory'. Preserve
158 * times if 'pflag' is set
159 */
160int sftp_upload_dir(struct sftp_conn *, const char *, const char *,
161    int, int, int, int, int, int);
162
163/*
164 * Download a 'from_path' from the 'from' connection and upload it to
165 * to 'to' connection at 'to_path'.
166 */
167int sftp_crossload(struct sftp_conn *from, struct sftp_conn *to,
168    const char *from_path, const char *to_path,
169    Attrib *a, int preserve_flag);
170
171/*
172 * Recursively download a directory from 'from_path' from the 'from'
173 * connection and upload it to 'to' connection at 'to_path'.
174 */
175int sftp_crossload_dir(struct sftp_conn *from, struct sftp_conn *to,
176    const char *from_path, const char *to_path,
177    Attrib *dirattrib, int preserve_flag, int print_flag,
178    int follow_link_flag);
179
180/*
181 * User/group ID to name translation.
182 */
183int sftp_can_get_users_groups_by_id(struct sftp_conn *conn);
184int sftp_get_users_groups_by_id(struct sftp_conn *conn,
185    const u_int *uids, u_int nuids,
186    const u_int *gids, u_int ngids,
187    char ***usernamesp, char ***groupnamesp);
188
189/* Concatenate paths, taking care of slashes. Caller must free result. */
190char *sftp_path_append(const char *, const char *);
191
192/* Make absolute path if relative path and CWD is given. Does not modify
193 * original if the path is already absolute. */
194char *sftp_make_absolute(char *, const char *);
195
196/* Check if remote path is directory */
197int sftp_remote_is_dir(struct sftp_conn *conn, const char *path);
198
199/* Check whether path returned from glob(..., GLOB_MARK, ...) is a directory */
200int sftp_globpath_is_dir(const char *pathname);
201
202#endif
203