Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / e13eace5220ac5badc15220272d36edacc9f8cea / . / sftp-client.h
blob: 991e05d332405d35ccc02bdc83b2cae35d5596bb [file] [log] [blame]
Darren Tuckere2f189a2004-12-06 22:45:53 +1100[diff] [blame]1/* $OpenBSD: sftp-client.h,v 1.13 2004/11/29 07:41:24 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 Tuckere2f189a2004-12-06 22:45:53 +1100[diff] [blame]33 * Initialiase a SSH filexfer connection. Returns NULL on error or
34 * a pointer to a initialized sftp_conn struct on success.
Damien Miller058316f2001-03-08 10:08:49 +1100[diff] [blame]35 */
Ben Lindstromb1f483f2002-06-23 21:27:18 +0000[diff] [blame]36struct sftp_conn *do_init(int, int, u_int, u_int);
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]37
Ben Lindstromb1f483f2002-06-23 21:27:18 +0000[diff] [blame]38u_int sftp_proto_version(struct sftp_conn *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]39
40/* Close file referred to by 'handle' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]41int do_close(struct sftp_conn *, char *, u_int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]42
Damien Miller4870afd2001-03-14 10:27:09 +1100[diff] [blame]43/* Read contents of 'path' to NULL-terminated array 'dir' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]44int do_readdir(struct sftp_conn *, char *, SFTP_DIRENT ***);
Damien Miller4870afd2001-03-14 10:27:09 +1100[diff] [blame]45
46/* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */
Ben Lindstromb4c774c2001-07-04 04:07:12 +0000[diff] [blame]47void free_sftp_dirents(SFTP_DIRENT **);
Damien Miller4870afd2001-03-14 10:27:09 +1100[diff] [blame]48
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]49/* Delete file 'path' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]50int do_rm(struct sftp_conn *, char *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]51
52/* Create directory 'path' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]53int do_mkdir(struct sftp_conn *, char *, Attrib *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]54
55/* Remove directory 'path' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]56int do_rmdir(struct sftp_conn *, char *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]57
58/* Get file attributes of 'path' (follows symlinks) */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]59Attrib *do_stat(struct sftp_conn *, char *, int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]60
61/* Get file attributes of 'path' (does not follow symlinks) */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]62Attrib *do_lstat(struct sftp_conn *, char *, int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]63
64/* Get file attributes of open file 'handle' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]65Attrib *do_fstat(struct sftp_conn *, char *, u_int, int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]66
67/* Set file attributes of 'path' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]68int do_setstat(struct sftp_conn *, char *, Attrib *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]69
70/* Set file attributes of open file 'handle' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]71int do_fsetstat(struct sftp_conn *, char *, u_int, Attrib *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]72
73/* Canonicalise 'path' - caller must free result */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]74char *do_realpath(struct sftp_conn *, char *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]75
76/* Rename 'oldpath' to 'newpath' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]77int do_rename(struct sftp_conn *, char *, char *);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]78
Damien Miller058316f2001-03-08 10:08:49 +1100[diff] [blame]79/* Rename 'oldpath' to 'newpath' */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]80int do_symlink(struct sftp_conn *, char *, char *);
Damien Miller058316f2001-03-08 10:08:49 +1100[diff] [blame]81
82/* Return target of symlink 'path' - caller must free result */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]83char *do_readlink(struct sftp_conn *, char *);
Damien Miller058316f2001-03-08 10:08:49 +1100[diff] [blame]84
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]85/* XXX: add callbacks to do_download/do_upload so we can do progress meter */
86
87/*
88 * Download 'remote_path' to 'local_path'. Preserve permissions and times
89 * if 'pflag' is set
90 */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]91int do_download(struct sftp_conn *, char *, char *, int);
Damien Miller33804262001-02-04 23:20:18 +1100[diff] [blame]92
93/*
94 * Upload 'local_path' to 'remote_path'. Preserve permissions and times
95 * if 'pflag' is set
96 */
Damien Miller3db5f532002-02-13 14:10:32 +1100[diff] [blame]97int do_upload(struct sftp_conn *, char *, char *, int);
98
99#endif