blob: e836c0d668d4abf78d5b0641e06d348eef61c9fb [file] [log] [blame]
Damien Miller058316f2001-03-08 10:08:49 +11001/* $OpenBSD: sftp-client.h,v 1.2 2001/03/07 10:11:23 djm Exp $ */
Damien Miller33804262001-02-04 23:20:18 +11002
3/*
4 * Copyright (c) 2001 Damien Miller. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27/* Client side of SSH2 filexfer protocol */
28
Damien Miller058316f2001-03-08 10:08:49 +110029/*
30 * Initialiase a SSH filexfer connection. Returns -1 on error or
31 * protocol version on success.
32 */
Damien Miller33804262001-02-04 23:20:18 +110033int do_init(int fd_in, int fd_out);
34
35/* Close file referred to by 'handle' */
36int do_close(int fd_in, int fd_out, char *handle, u_int handle_len);
37
38/* List contents of directory 'path' to stdout */
39int do_ls(int fd_in, int fd_out, char *path);
40
41/* Delete file 'path' */
42int do_rm(int fd_in, int fd_out, char *path);
43
44/* Create directory 'path' */
45int do_mkdir(int fd_in, int fd_out, char *path, Attrib *a);
46
47/* Remove directory 'path' */
48int do_rmdir(int fd_in, int fd_out, char *path);
49
50/* Get file attributes of 'path' (follows symlinks) */
51Attrib *do_stat(int fd_in, int fd_out, char *path);
52
53/* Get file attributes of 'path' (does not follow symlinks) */
54Attrib *do_lstat(int fd_in, int fd_out, char *path);
55
56/* Get file attributes of open file 'handle' */
57Attrib *do_fstat(int fd_in, int fd_out, char *handle,
58 u_int handle_len);
59
60/* Set file attributes of 'path' */
61int do_setstat(int fd_in, int fd_out, char *path, Attrib *a);
62
63/* Set file attributes of open file 'handle' */
64int do_fsetstat(int fd_in, int fd_out, char *handle,
65 u_int handle_len, Attrib *a);
66
67/* Canonicalise 'path' - caller must free result */
68char *do_realpath(int fd_in, int fd_out, char *path);
69
70/* Rename 'oldpath' to 'newpath' */
71int do_rename(int fd_in, int fd_out, char *oldpath, char *newpath);
72
Damien Miller058316f2001-03-08 10:08:49 +110073/* Rename 'oldpath' to 'newpath' */
74int do_symlink(int fd_in, int fd_out, char *oldpath, char *newpath);
75
76/* Return target of symlink 'path' - caller must free result */
77char *do_readlink(int fd_in, int fd_out, char *path);
78
Damien Miller33804262001-02-04 23:20:18 +110079/* XXX: add callbacks to do_download/do_upload so we can do progress meter */
80
81/*
82 * Download 'remote_path' to 'local_path'. Preserve permissions and times
83 * if 'pflag' is set
84 */
85int do_download(int fd_in, int fd_out, char *remote_path, char *local_path,
86 int pflag);
87
88/*
89 * Upload 'local_path' to 'remote_path'. Preserve permissions and times
90 * if 'pflag' is set
91 */
92int do_upload(int fd_in, int fd_out, char *local_path, char *remote_path,
93 int pflag);