Annotation of src/usr.bin/ssh/sftp-client.h, Revision 1.1
1.1 ! djm 1: /* $OpenBSD$ */
! 2:
! 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:
! 29: /* Initialiase a SSH filexfer connection */
! 30: int do_init(int fd_in, int fd_out);
! 31:
! 32: /* Close file referred to by 'handle' */
! 33: int do_close(int fd_in, int fd_out, char *handle, u_int handle_len);
! 34:
! 35: /* List contents of directory 'path' to stdout */
! 36: int do_ls(int fd_in, int fd_out, char *path);
! 37:
! 38: /* Delete file 'path' */
! 39: int do_rm(int fd_in, int fd_out, char *path);
! 40:
! 41: /* Create directory 'path' */
! 42: int do_mkdir(int fd_in, int fd_out, char *path, Attrib *a);
! 43:
! 44: /* Remove directory 'path' */
! 45: int do_rmdir(int fd_in, int fd_out, char *path);
! 46:
! 47: /* Get file attributes of 'path' (follows symlinks) */
! 48: Attrib *do_stat(int fd_in, int fd_out, char *path);
! 49:
! 50: /* Get file attributes of 'path' (does not follow symlinks) */
! 51: Attrib *do_lstat(int fd_in, int fd_out, char *path);
! 52:
! 53: /* Get file attributes of open file 'handle' */
! 54: Attrib *do_fstat(int fd_in, int fd_out, char *handle,
! 55: u_int handle_len);
! 56:
! 57: /* Set file attributes of 'path' */
! 58: int do_setstat(int fd_in, int fd_out, char *path, Attrib *a);
! 59:
! 60: /* Set file attributes of open file 'handle' */
! 61: int do_fsetstat(int fd_in, int fd_out, char *handle,
! 62: u_int handle_len, Attrib *a);
! 63:
! 64: /* Canonicalise 'path' - caller must free result */
! 65: char *do_realpath(int fd_in, int fd_out, char *path);
! 66:
! 67: /* Rename 'oldpath' to 'newpath' */
! 68: int do_rename(int fd_in, int fd_out, char *oldpath, char *newpath);
! 69:
! 70: /* XXX: add callbacks to do_download/do_upload so we can do progress meter */
! 71:
! 72: /*
! 73: * Download 'remote_path' to 'local_path'. Preserve permissions and times
! 74: * if 'pflag' is set
! 75: */
! 76: int do_download(int fd_in, int fd_out, char *remote_path, char *local_path,
! 77: int pflag);
! 78:
! 79: /*
! 80: * Upload 'local_path' to 'remote_path'. Preserve permissions and times
! 81: * if 'pflag' is set
! 82: */
! 83: int do_upload(int fd_in, int fd_out, char *local_path, char *remote_path,
! 84: int pflag);