Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / 5246df47a4e01fb4c17c672fea31f041c88205e9 / . / sftp-client.h
blob: 1d08c40493b87cee06a036442cf2db6c7fdcf5a3 [file] [log] [blame]
Darren Tucker1b0dd172009-10-07 08:37:48 +1100[diff] [blame]1/* $OpenBSD: sftp-client.h,v 1.18 2009/08/18 18:36:20 djm Exp $ */
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]2
3/*
Damien Miller4e60ed72004-02-17 17:07:59 +1100[diff] [blame]4 * Copyright (c) 2001-2004 Damien Miller <djm@openbsd.org>
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]5 *
Damien Miller4e60ed72004-02-17 17:07:59 +1100[diff] [blame]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.
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]9 *
Damien Miller4e60ed72004-02-17 17:07:59 +1100[diff] [blame]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.
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]17 */
18
19/* Client side of SSH2 filexfer protocol */
20
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]21#ifndef _SFTP_CLIENT_H
22#define _SFTP_CLIENT_H
23
Damien Miller4870afd2001-03-14 10:27:09 +1100[diff] [blame]24typedef struct SFTP_DIRENT SFTP_DIRENT;
25
26struct SFTP_DIRENT {
27 char *filename;
28 char *longname;
29 Attrib a;
30};
31
Ben Lindstroma3700052001-04-05 23:26:32 +0000[diff] [blame]32/*
Darren Tucker7b598892008-06-09 22:49:36 +1000[diff] [blame]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 */
36struct 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/*
Damien Millerac7a0052005-05-26 12:05:49 +1000[diff] [blame]51 * Initialise a SSH filexfer connection. Returns NULL on error or
Darren Tuckere2f189a2004-12-06 22:45:53 +1100[diff] [blame]52 * a pointer to a initialized sftp_conn struct on success.
Damien Miller058316f2001-03-08 10:08:49 +1100[diff] [blame]53 */
Ben Lindstromb1f483f2002-06-23 21:27:18 +0000[diff] [blame]54struct sftp_conn *do_init(int, int, u_int, u_int);
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]55
Ben Lindstromb1f483f2002-06-23 21:27:18 +0000[diff] [blame]56u_int sftp_proto_version(struct sftp_conn *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]57
58/* Close file referred to by 'handle' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]59int do_close(struct sftp_conn *, char *, u_int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]60
Damien Miller4870afd2001-03-14 10:27:09 +1100[diff] [blame]61/* Read contents of 'path' to NULL-terminated array 'dir' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]62int do_readdir(struct sftp_conn *, char *, SFTP_DIRENT ***);
Damien Miller4870afd2001-03-14 10:27:09 +1100[diff] [blame]63
64/* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */
Ben Lindstromb4c774c2001-07-04 04:07:12 +0000[diff] [blame]65void free_sftp_dirents(SFTP_DIRENT **);
Damien Miller4870afd2001-03-14 10:27:09 +1100[diff] [blame]66
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]67/* Delete file 'path' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]68int do_rm(struct sftp_conn *, char *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]69
70/* Create directory 'path' */
Darren Tucker1b0dd172009-10-07 08:37:48 +1100[diff] [blame]71int do_mkdir(struct sftp_conn *, char *, Attrib *, int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]72
73/* Remove directory 'path' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]74int do_rmdir(struct sftp_conn *, char *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]75
76/* Get file attributes of 'path' (follows symlinks) */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]77Attrib *do_stat(struct sftp_conn *, char *, int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]78
79/* Get file attributes of 'path' (does not follow symlinks) */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]80Attrib *do_lstat(struct sftp_conn *, char *, int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]81
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]82/* Set file attributes of 'path' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]83int do_setstat(struct sftp_conn *, char *, Attrib *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]84
85/* Set file attributes of open file 'handle' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]86int do_fsetstat(struct sftp_conn *, char *, u_int, Attrib *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]87
88/* Canonicalise 'path' - caller must free result */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]89char *do_realpath(struct sftp_conn *, char *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]90
Damien Millerd671e5a2008-05-19 14:53:33 +1000[diff] [blame]91/* Get statistics for filesystem hosting file at "path" */
Darren Tucker7b598892008-06-09 22:49:36 +1000[diff] [blame]92int do_statvfs(struct sftp_conn *, const char *, struct sftp_statvfs *, int);
Damien Millerd671e5a2008-05-19 14:53:33 +1000[diff] [blame]93
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]94/* Rename 'oldpath' to 'newpath' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]95int do_rename(struct sftp_conn *, char *, char *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]96
Damien Miller058316f2001-03-08 10:08:49 +1100[diff] [blame]97/* Rename 'oldpath' to 'newpath' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]98int do_symlink(struct sftp_conn *, char *, char *);
Damien Miller058316f2001-03-08 10:08:49 +1100[diff] [blame]99
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]100/* XXX: add callbacks to do_download/do_upload so we can do progress meter */
101
102/*
103 * Download 'remote_path' to 'local_path'. Preserve permissions and times
104 * if 'pflag' is set
105 */
Darren Tucker1b0dd172009-10-07 08:37:48 +1100[diff] [blame]106int do_download(struct sftp_conn *, char *, char *, Attrib *, int);
107
108/*
109 * Recursively download 'remote_directory' to 'local_directory'. Preserve
110 * times if 'pflag' is set
111 */
112int download_dir(struct sftp_conn *, char *, char *, Attrib *, int, int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]113
114/*
115 * Upload 'local_path' to 'remote_path'. Preserve permissions and times
116 * if 'pflag' is set
117 */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]118int do_upload(struct sftp_conn *, char *, char *, int);
119
Darren Tucker1b0dd172009-10-07 08:37:48 +1100[diff] [blame]120/*
121 * Recursively upload 'local_directory' to 'remote_directory'. Preserve
122 * times if 'pflag' is set
123 */
124int upload_dir(struct sftp_conn *, char *, char *, int, int);
125
126/* Concatenate paths, taking care of slashes. Caller must free result. */
127char *path_append(char *, char *);
128
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]129#endif