]> andersk Git - openssh.git/blame - sftp-client.h
- djm@cvs.openbsd.org 2002/09/11 22:41:50
[openssh.git] / sftp-client.h
CommitLineData
00b3ad3e 1/* $OpenBSD: sftp-client.h,v 1.11 2002/09/11 22:41:50 djm Exp $ */
61e96248 2
3/*
22e6c827 4 * Copyright (c) 2001,2002 Damien Miller. All rights reserved.
61e96248 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
22e6c827 29#ifndef _SFTP_CLIENT_H
30#define _SFTP_CLIENT_H
31
2e4fb373 32typedef struct SFTP_DIRENT SFTP_DIRENT;
33
34struct SFTP_DIRENT {
35 char *filename;
36 char *longname;
37 Attrib a;
38};
39
cd332296 40/*
41 * Initialiase a SSH filexfer connection. Returns -1 on error or
3a7fe5ba 42 * protocol version on success.
43 */
9906a836 44struct sftp_conn *do_init(int, int, u_int, u_int);
22e6c827 45
9906a836 46u_int sftp_proto_version(struct sftp_conn *);
61e96248 47
48/* Close file referred to by 'handle' */
22e6c827 49int do_close(struct sftp_conn *, char *, u_int);
61e96248 50
2e4fb373 51/* Read contents of 'path' to NULL-terminated array 'dir' */
22e6c827 52int do_readdir(struct sftp_conn *, char *, SFTP_DIRENT ***);
2e4fb373 53
54/* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */
1c06a9ca 55void free_sftp_dirents(SFTP_DIRENT **);
2e4fb373 56
61e96248 57/* Delete file 'path' */
22e6c827 58int do_rm(struct sftp_conn *, char *);
61e96248 59
60/* Create directory 'path' */
22e6c827 61int do_mkdir(struct sftp_conn *, char *, Attrib *);
61e96248 62
63/* Remove directory 'path' */
22e6c827 64int do_rmdir(struct sftp_conn *, char *);
61e96248 65
66/* Get file attributes of 'path' (follows symlinks) */
22e6c827 67Attrib *do_stat(struct sftp_conn *, char *, int);
61e96248 68
69/* Get file attributes of 'path' (does not follow symlinks) */
22e6c827 70Attrib *do_lstat(struct sftp_conn *, char *, int);
61e96248 71
72/* Get file attributes of open file 'handle' */
22e6c827 73Attrib *do_fstat(struct sftp_conn *, char *, u_int, int);
61e96248 74
75/* Set file attributes of 'path' */
22e6c827 76int do_setstat(struct sftp_conn *, char *, Attrib *);
61e96248 77
78/* Set file attributes of open file 'handle' */
22e6c827 79int do_fsetstat(struct sftp_conn *, char *, u_int, Attrib *);
61e96248 80
81/* Canonicalise 'path' - caller must free result */
22e6c827 82char *do_realpath(struct sftp_conn *, char *);
61e96248 83
84/* Rename 'oldpath' to 'newpath' */
22e6c827 85int do_rename(struct sftp_conn *, char *, char *);
61e96248 86
3a7fe5ba 87/* Rename 'oldpath' to 'newpath' */
22e6c827 88int do_symlink(struct sftp_conn *, char *, char *);
3a7fe5ba 89
90/* Return target of symlink 'path' - caller must free result */
22e6c827 91char *do_readlink(struct sftp_conn *, char *);
3a7fe5ba 92
61e96248 93/* XXX: add callbacks to do_download/do_upload so we can do progress meter */
94
95/*
96 * Download 'remote_path' to 'local_path'. Preserve permissions and times
97 * if 'pflag' is set
98 */
22e6c827 99int do_download(struct sftp_conn *, char *, char *, int);
61e96248 100
101/*
102 * Upload 'local_path' to 'remote_path'. Preserve permissions and times
103 * if 'pflag' is set
104 */
22e6c827 105int do_upload(struct sftp_conn *, char *, char *, int);
106
107#endif
This page took 0.133552 seconds and 5 git commands to generate.