Return to sftp-client.h CVS log

Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/sftp-client.h, Revision 1.8

1.8     ! djm         1: /* $OpenBSD: sftp-client.h,v 1.7 2002/02/05 00:00:46 djm Exp $ */
1.1       djm         2:
                      3: /*
1.7       djm         4:  * Copyright (c) 2001-2002 Damien Miller.  All rights reserved.
1.1       djm         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:
1.3       djm        29: typedef struct SFTP_DIRENT SFTP_DIRENT;
                     30:
                     31: struct SFTP_DIRENT {
                     32:        char *filename;
                     33:        char *longname;
                     34:        Attrib a;
                     35: };
                     36:
1.5       markus     37: /*
                     38:  * Initialiase a SSH filexfer connection. Returns -1 on error or
1.2       djm        39:  * protocol version on success.
                     40:  */
1.6       itojun     41: int do_init(int, int);
1.1       djm        42:
                     43: /* Close file referred to by 'handle' */
1.6       itojun     44: int do_close(int, int, char *, u_int);
1.1       djm        45:
                     46: /* List contents of directory 'path' to stdout */
1.6       itojun     47: int do_ls(int, int, char *);
1.3       djm        48:
                     49: /* Read contents of 'path' to NULL-terminated array 'dir' */
1.6       itojun     50: int do_readdir(int, int, char *, SFTP_DIRENT ***);
1.3       djm        51:
                     52: /* Frees a NULL-terminated array of SFTP_DIRENTs (eg. from do_readdir) */
1.6       itojun     53: void free_sftp_dirents(SFTP_DIRENT **);
1.1       djm        54:
                     55: /* Delete file 'path' */
1.6       itojun     56: int do_rm(int, int, char *);
1.1       djm        57:
                     58: /* Create directory 'path' */
1.6       itojun     59: int do_mkdir(int, int, char *, Attrib *);
1.1       djm        60:
                     61: /* Remove directory 'path' */
1.6       itojun     62: int do_rmdir(int, int, char *);
1.1       djm        63:
                     64: /* Get file attributes of 'path' (follows symlinks) */
1.6       itojun     65: Attrib *do_stat(int, int, char *, int);
1.1       djm        66:
                     67: /* Get file attributes of 'path' (does not follow symlinks) */
1.6       itojun     68: Attrib *do_lstat(int, int, char *, int);
1.1       djm        69:
                     70: /* Get file attributes of open file 'handle' */
1.6       itojun     71: Attrib *do_fstat(int, int, char *, u_int, int);
1.1       djm        72:
                     73: /* Set file attributes of 'path' */
1.6       itojun     74: int do_setstat(int, int, char *, Attrib *);
1.1       djm        75:
                     76: /* Set file attributes of open file 'handle' */
1.6       itojun     77: int do_fsetstat(int, int, char *, u_int, Attrib *);
1.1       djm        78:
                     79: /* Canonicalise 'path' - caller must free result */
1.6       itojun     80: char *do_realpath(int, int, char *);
1.1       djm        81:
                     82: /* Rename 'oldpath' to 'newpath' */
1.6       itojun     83: int do_rename(int, int, char *, char *);
1.2       djm        84:
                     85: /* Rename 'oldpath' to 'newpath' */
1.6       itojun     86: int do_symlink(int, int, char *, char *);
1.2       djm        87:
                     88: /* Return target of symlink 'path' - caller must free result */
1.6       itojun     89: char *do_readlink(int, int, char *);
1.1       djm        90:
                     91: /* XXX: add callbacks to do_download/do_upload so we can do progress meter */
                     92:
                     93: /*
                     94:  * Download 'remote_path' to 'local_path'. Preserve permissions and times
                     95:  * if 'pflag' is set
                     96:  */
1.8     ! djm        97: int do_download(int, int, char *, char *, int, size_t, int);
1.1       djm        98:
                     99: /*
                    100:  * Upload 'local_path' to 'remote_path'. Preserve permissions and times
                    101:  * if 'pflag' is set
                    102:  */
1.8     ! djm       103: int do_upload(int, int, char *, char *, int , size_t, int);