jpayne@69: /* Copyright (c) 2004-2008, Sara Golemon jpayne@69: * All rights reserved. jpayne@69: * jpayne@69: * Redistribution and use in source and binary forms, jpayne@69: * with or without modification, are permitted provided jpayne@69: * that the following conditions are met: jpayne@69: * jpayne@69: * Redistributions of source code must retain the above jpayne@69: * copyright notice, this list of conditions and the jpayne@69: * following disclaimer. jpayne@69: * jpayne@69: * Redistributions in binary form must reproduce the above jpayne@69: * copyright notice, this list of conditions and the following jpayne@69: * disclaimer in the documentation and/or other materials jpayne@69: * provided with the distribution. jpayne@69: * jpayne@69: * Neither the name of the copyright holder nor the names jpayne@69: * of any other contributors may be used to endorse or jpayne@69: * promote products derived from this software without jpayne@69: * specific prior written permission. jpayne@69: * jpayne@69: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND jpayne@69: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, jpayne@69: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES jpayne@69: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE jpayne@69: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR jpayne@69: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, jpayne@69: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, jpayne@69: * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR jpayne@69: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS jpayne@69: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, jpayne@69: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING jpayne@69: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE jpayne@69: * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY jpayne@69: * OF SUCH DAMAGE. jpayne@69: */ jpayne@69: jpayne@69: #ifndef LIBSSH2_SFTP_H jpayne@69: #define LIBSSH2_SFTP_H 1 jpayne@69: jpayne@69: #include "libssh2.h" jpayne@69: jpayne@69: #ifndef WIN32 jpayne@69: #include jpayne@69: #endif jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: #endif jpayne@69: jpayne@69: /* Note: Version 6 was documented at the time of writing jpayne@69: * However it was marked as "DO NOT IMPLEMENT" due to pending changes jpayne@69: * jpayne@69: * Let's start with Version 3 (The version found in OpenSSH) and go from there jpayne@69: */ jpayne@69: #define LIBSSH2_SFTP_VERSION 3 jpayne@69: jpayne@69: typedef struct _LIBSSH2_SFTP LIBSSH2_SFTP; jpayne@69: typedef struct _LIBSSH2_SFTP_HANDLE LIBSSH2_SFTP_HANDLE; jpayne@69: typedef struct _LIBSSH2_SFTP_ATTRIBUTES LIBSSH2_SFTP_ATTRIBUTES; jpayne@69: typedef struct _LIBSSH2_SFTP_STATVFS LIBSSH2_SFTP_STATVFS; jpayne@69: jpayne@69: /* Flags for open_ex() */ jpayne@69: #define LIBSSH2_SFTP_OPENFILE 0 jpayne@69: #define LIBSSH2_SFTP_OPENDIR 1 jpayne@69: jpayne@69: /* Flags for rename_ex() */ jpayne@69: #define LIBSSH2_SFTP_RENAME_OVERWRITE 0x00000001 jpayne@69: #define LIBSSH2_SFTP_RENAME_ATOMIC 0x00000002 jpayne@69: #define LIBSSH2_SFTP_RENAME_NATIVE 0x00000004 jpayne@69: jpayne@69: /* Flags for stat_ex() */ jpayne@69: #define LIBSSH2_SFTP_STAT 0 jpayne@69: #define LIBSSH2_SFTP_LSTAT 1 jpayne@69: #define LIBSSH2_SFTP_SETSTAT 2 jpayne@69: jpayne@69: /* Flags for symlink_ex() */ jpayne@69: #define LIBSSH2_SFTP_SYMLINK 0 jpayne@69: #define LIBSSH2_SFTP_READLINK 1 jpayne@69: #define LIBSSH2_SFTP_REALPATH 2 jpayne@69: jpayne@69: /* Flags for sftp_mkdir() */ jpayne@69: #define LIBSSH2_SFTP_DEFAULT_MODE -1 jpayne@69: jpayne@69: /* SFTP attribute flag bits */ jpayne@69: #define LIBSSH2_SFTP_ATTR_SIZE 0x00000001 jpayne@69: #define LIBSSH2_SFTP_ATTR_UIDGID 0x00000002 jpayne@69: #define LIBSSH2_SFTP_ATTR_PERMISSIONS 0x00000004 jpayne@69: #define LIBSSH2_SFTP_ATTR_ACMODTIME 0x00000008 jpayne@69: #define LIBSSH2_SFTP_ATTR_EXTENDED 0x80000000 jpayne@69: jpayne@69: /* SFTP statvfs flag bits */ jpayne@69: #define LIBSSH2_SFTP_ST_RDONLY 0x00000001 jpayne@69: #define LIBSSH2_SFTP_ST_NOSUID 0x00000002 jpayne@69: jpayne@69: struct _LIBSSH2_SFTP_ATTRIBUTES { jpayne@69: /* If flags & ATTR_* bit is set, then the value in this struct will be jpayne@69: * meaningful Otherwise it should be ignored jpayne@69: */ jpayne@69: unsigned long flags; jpayne@69: jpayne@69: libssh2_uint64_t filesize; jpayne@69: unsigned long uid, gid; jpayne@69: unsigned long permissions; jpayne@69: unsigned long atime, mtime; jpayne@69: }; jpayne@69: jpayne@69: struct _LIBSSH2_SFTP_STATVFS { jpayne@69: libssh2_uint64_t f_bsize; /* file system block size */ jpayne@69: libssh2_uint64_t f_frsize; /* fragment size */ jpayne@69: libssh2_uint64_t f_blocks; /* size of fs in f_frsize units */ jpayne@69: libssh2_uint64_t f_bfree; /* # free blocks */ jpayne@69: libssh2_uint64_t f_bavail; /* # free blocks for non-root */ jpayne@69: libssh2_uint64_t f_files; /* # inodes */ jpayne@69: libssh2_uint64_t f_ffree; /* # free inodes */ jpayne@69: libssh2_uint64_t f_favail; /* # free inodes for non-root */ jpayne@69: libssh2_uint64_t f_fsid; /* file system ID */ jpayne@69: libssh2_uint64_t f_flag; /* mount flags */ jpayne@69: libssh2_uint64_t f_namemax; /* maximum filename length */ jpayne@69: }; jpayne@69: jpayne@69: /* SFTP filetypes */ jpayne@69: #define LIBSSH2_SFTP_TYPE_REGULAR 1 jpayne@69: #define LIBSSH2_SFTP_TYPE_DIRECTORY 2 jpayne@69: #define LIBSSH2_SFTP_TYPE_SYMLINK 3 jpayne@69: #define LIBSSH2_SFTP_TYPE_SPECIAL 4 jpayne@69: #define LIBSSH2_SFTP_TYPE_UNKNOWN 5 jpayne@69: #define LIBSSH2_SFTP_TYPE_SOCKET 6 jpayne@69: #define LIBSSH2_SFTP_TYPE_CHAR_DEVICE 7 jpayne@69: #define LIBSSH2_SFTP_TYPE_BLOCK_DEVICE 8 jpayne@69: #define LIBSSH2_SFTP_TYPE_FIFO 9 jpayne@69: jpayne@69: /* jpayne@69: * Reproduce the POSIX file modes here for systems that are not POSIX jpayne@69: * compliant. jpayne@69: * jpayne@69: * These is used in "permissions" of "struct _LIBSSH2_SFTP_ATTRIBUTES" jpayne@69: */ jpayne@69: /* File type */ jpayne@69: #define LIBSSH2_SFTP_S_IFMT 0170000 /* type of file mask */ jpayne@69: #define LIBSSH2_SFTP_S_IFIFO 0010000 /* named pipe (fifo) */ jpayne@69: #define LIBSSH2_SFTP_S_IFCHR 0020000 /* character special */ jpayne@69: #define LIBSSH2_SFTP_S_IFDIR 0040000 /* directory */ jpayne@69: #define LIBSSH2_SFTP_S_IFBLK 0060000 /* block special */ jpayne@69: #define LIBSSH2_SFTP_S_IFREG 0100000 /* regular */ jpayne@69: #define LIBSSH2_SFTP_S_IFLNK 0120000 /* symbolic link */ jpayne@69: #define LIBSSH2_SFTP_S_IFSOCK 0140000 /* socket */ jpayne@69: jpayne@69: /* File mode */ jpayne@69: /* Read, write, execute/search by owner */ jpayne@69: #define LIBSSH2_SFTP_S_IRWXU 0000700 /* RWX mask for owner */ jpayne@69: #define LIBSSH2_SFTP_S_IRUSR 0000400 /* R for owner */ jpayne@69: #define LIBSSH2_SFTP_S_IWUSR 0000200 /* W for owner */ jpayne@69: #define LIBSSH2_SFTP_S_IXUSR 0000100 /* X for owner */ jpayne@69: /* Read, write, execute/search by group */ jpayne@69: #define LIBSSH2_SFTP_S_IRWXG 0000070 /* RWX mask for group */ jpayne@69: #define LIBSSH2_SFTP_S_IRGRP 0000040 /* R for group */ jpayne@69: #define LIBSSH2_SFTP_S_IWGRP 0000020 /* W for group */ jpayne@69: #define LIBSSH2_SFTP_S_IXGRP 0000010 /* X for group */ jpayne@69: /* Read, write, execute/search by others */ jpayne@69: #define LIBSSH2_SFTP_S_IRWXO 0000007 /* RWX mask for other */ jpayne@69: #define LIBSSH2_SFTP_S_IROTH 0000004 /* R for other */ jpayne@69: #define LIBSSH2_SFTP_S_IWOTH 0000002 /* W for other */ jpayne@69: #define LIBSSH2_SFTP_S_IXOTH 0000001 /* X for other */ jpayne@69: jpayne@69: /* macros to check for specific file types, added in 1.2.5 */ jpayne@69: #define LIBSSH2_SFTP_S_ISLNK(m) \ jpayne@69: (((m) & LIBSSH2_SFTP_S_IFMT) == LIBSSH2_SFTP_S_IFLNK) jpayne@69: #define LIBSSH2_SFTP_S_ISREG(m) \ jpayne@69: (((m) & LIBSSH2_SFTP_S_IFMT) == LIBSSH2_SFTP_S_IFREG) jpayne@69: #define LIBSSH2_SFTP_S_ISDIR(m) \ jpayne@69: (((m) & LIBSSH2_SFTP_S_IFMT) == LIBSSH2_SFTP_S_IFDIR) jpayne@69: #define LIBSSH2_SFTP_S_ISCHR(m) \ jpayne@69: (((m) & LIBSSH2_SFTP_S_IFMT) == LIBSSH2_SFTP_S_IFCHR) jpayne@69: #define LIBSSH2_SFTP_S_ISBLK(m) \ jpayne@69: (((m) & LIBSSH2_SFTP_S_IFMT) == LIBSSH2_SFTP_S_IFBLK) jpayne@69: #define LIBSSH2_SFTP_S_ISFIFO(m) \ jpayne@69: (((m) & LIBSSH2_SFTP_S_IFMT) == LIBSSH2_SFTP_S_IFIFO) jpayne@69: #define LIBSSH2_SFTP_S_ISSOCK(m) \ jpayne@69: (((m) & LIBSSH2_SFTP_S_IFMT) == LIBSSH2_SFTP_S_IFSOCK) jpayne@69: jpayne@69: /* SFTP File Transfer Flags -- (e.g. flags parameter to sftp_open()) jpayne@69: * Danger will robinson... APPEND doesn't have any effect on OpenSSH servers */ jpayne@69: #define LIBSSH2_FXF_READ 0x00000001 jpayne@69: #define LIBSSH2_FXF_WRITE 0x00000002 jpayne@69: #define LIBSSH2_FXF_APPEND 0x00000004 jpayne@69: #define LIBSSH2_FXF_CREAT 0x00000008 jpayne@69: #define LIBSSH2_FXF_TRUNC 0x00000010 jpayne@69: #define LIBSSH2_FXF_EXCL 0x00000020 jpayne@69: jpayne@69: /* SFTP Status Codes (returned by libssh2_sftp_last_error() ) */ jpayne@69: #define LIBSSH2_FX_OK 0UL jpayne@69: #define LIBSSH2_FX_EOF 1UL jpayne@69: #define LIBSSH2_FX_NO_SUCH_FILE 2UL jpayne@69: #define LIBSSH2_FX_PERMISSION_DENIED 3UL jpayne@69: #define LIBSSH2_FX_FAILURE 4UL jpayne@69: #define LIBSSH2_FX_BAD_MESSAGE 5UL jpayne@69: #define LIBSSH2_FX_NO_CONNECTION 6UL jpayne@69: #define LIBSSH2_FX_CONNECTION_LOST 7UL jpayne@69: #define LIBSSH2_FX_OP_UNSUPPORTED 8UL jpayne@69: #define LIBSSH2_FX_INVALID_HANDLE 9UL jpayne@69: #define LIBSSH2_FX_NO_SUCH_PATH 10UL jpayne@69: #define LIBSSH2_FX_FILE_ALREADY_EXISTS 11UL jpayne@69: #define LIBSSH2_FX_WRITE_PROTECT 12UL jpayne@69: #define LIBSSH2_FX_NO_MEDIA 13UL jpayne@69: #define LIBSSH2_FX_NO_SPACE_ON_FILESYSTEM 14UL jpayne@69: #define LIBSSH2_FX_QUOTA_EXCEEDED 15UL jpayne@69: #define LIBSSH2_FX_UNKNOWN_PRINCIPLE 16UL /* Initial mis-spelling */ jpayne@69: #define LIBSSH2_FX_UNKNOWN_PRINCIPAL 16UL jpayne@69: #define LIBSSH2_FX_LOCK_CONFlICT 17UL /* Initial mis-spelling */ jpayne@69: #define LIBSSH2_FX_LOCK_CONFLICT 17UL jpayne@69: #define LIBSSH2_FX_DIR_NOT_EMPTY 18UL jpayne@69: #define LIBSSH2_FX_NOT_A_DIRECTORY 19UL jpayne@69: #define LIBSSH2_FX_INVALID_FILENAME 20UL jpayne@69: #define LIBSSH2_FX_LINK_LOOP 21UL jpayne@69: jpayne@69: /* Returned by any function that would block during a read/write operation */ jpayne@69: #define LIBSSH2SFTP_EAGAIN LIBSSH2_ERROR_EAGAIN jpayne@69: jpayne@69: /* SFTP API */ jpayne@69: LIBSSH2_API LIBSSH2_SFTP *libssh2_sftp_init(LIBSSH2_SESSION *session); jpayne@69: LIBSSH2_API int libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp); jpayne@69: LIBSSH2_API unsigned long libssh2_sftp_last_error(LIBSSH2_SFTP *sftp); jpayne@69: LIBSSH2_API LIBSSH2_CHANNEL *libssh2_sftp_get_channel(LIBSSH2_SFTP *sftp); jpayne@69: jpayne@69: /* File / Directory Ops */ jpayne@69: LIBSSH2_API LIBSSH2_SFTP_HANDLE * jpayne@69: libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, jpayne@69: const char *filename, jpayne@69: unsigned int filename_len, jpayne@69: unsigned long flags, jpayne@69: long mode, int open_type); jpayne@69: #define libssh2_sftp_open(sftp, filename, flags, mode) \ jpayne@69: libssh2_sftp_open_ex((sftp), (filename), strlen(filename), (flags), \ jpayne@69: (mode), LIBSSH2_SFTP_OPENFILE) jpayne@69: #define libssh2_sftp_opendir(sftp, path) \ jpayne@69: libssh2_sftp_open_ex((sftp), (path), strlen(path), 0, 0, \ jpayne@69: LIBSSH2_SFTP_OPENDIR) jpayne@69: jpayne@69: LIBSSH2_API ssize_t libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle, jpayne@69: char *buffer, size_t buffer_maxlen); jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, \ jpayne@69: char *buffer, size_t buffer_maxlen, jpayne@69: char *longentry, jpayne@69: size_t longentry_maxlen, jpayne@69: LIBSSH2_SFTP_ATTRIBUTES *attrs); jpayne@69: #define libssh2_sftp_readdir(handle, buffer, buffer_maxlen, attrs) \ jpayne@69: libssh2_sftp_readdir_ex((handle), (buffer), (buffer_maxlen), NULL, 0, \ jpayne@69: (attrs)) jpayne@69: jpayne@69: LIBSSH2_API ssize_t libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, jpayne@69: const char *buffer, size_t count); jpayne@69: LIBSSH2_API int libssh2_sftp_fsync(LIBSSH2_SFTP_HANDLE *handle); jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle); jpayne@69: #define libssh2_sftp_close(handle) libssh2_sftp_close_handle(handle) jpayne@69: #define libssh2_sftp_closedir(handle) libssh2_sftp_close_handle(handle) jpayne@69: jpayne@69: LIBSSH2_API void libssh2_sftp_seek(LIBSSH2_SFTP_HANDLE *handle, size_t offset); jpayne@69: LIBSSH2_API void libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle, jpayne@69: libssh2_uint64_t offset); jpayne@69: #define libssh2_sftp_rewind(handle) libssh2_sftp_seek64((handle), 0) jpayne@69: jpayne@69: LIBSSH2_API size_t libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle); jpayne@69: LIBSSH2_API libssh2_uint64_t libssh2_sftp_tell64(LIBSSH2_SFTP_HANDLE *handle); jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle, jpayne@69: LIBSSH2_SFTP_ATTRIBUTES *attrs, jpayne@69: int setstat); jpayne@69: #define libssh2_sftp_fstat(handle, attrs) \ jpayne@69: libssh2_sftp_fstat_ex((handle), (attrs), 0) jpayne@69: #define libssh2_sftp_fsetstat(handle, attrs) \ jpayne@69: libssh2_sftp_fstat_ex((handle), (attrs), 1) jpayne@69: jpayne@69: /* Miscellaneous Ops */ jpayne@69: LIBSSH2_API int libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, jpayne@69: const char *source_filename, jpayne@69: unsigned int srouce_filename_len, jpayne@69: const char *dest_filename, jpayne@69: unsigned int dest_filename_len, jpayne@69: long flags); jpayne@69: #define libssh2_sftp_rename(sftp, sourcefile, destfile) \ jpayne@69: libssh2_sftp_rename_ex((sftp), (sourcefile), strlen(sourcefile), \ jpayne@69: (destfile), strlen(destfile), \ jpayne@69: LIBSSH2_SFTP_RENAME_OVERWRITE | \ jpayne@69: LIBSSH2_SFTP_RENAME_ATOMIC | \ jpayne@69: LIBSSH2_SFTP_RENAME_NATIVE) jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, jpayne@69: const char *filename, jpayne@69: unsigned int filename_len); jpayne@69: #define libssh2_sftp_unlink(sftp, filename) \ jpayne@69: libssh2_sftp_unlink_ex((sftp), (filename), strlen(filename)) jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_fstatvfs(LIBSSH2_SFTP_HANDLE *handle, jpayne@69: LIBSSH2_SFTP_STATVFS *st); jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_statvfs(LIBSSH2_SFTP *sftp, jpayne@69: const char *path, jpayne@69: size_t path_len, jpayne@69: LIBSSH2_SFTP_STATVFS *st); jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, jpayne@69: const char *path, jpayne@69: unsigned int path_len, long mode); jpayne@69: #define libssh2_sftp_mkdir(sftp, path, mode) \ jpayne@69: libssh2_sftp_mkdir_ex((sftp), (path), strlen(path), (mode)) jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, jpayne@69: const char *path, jpayne@69: unsigned int path_len); jpayne@69: #define libssh2_sftp_rmdir(sftp, path) \ jpayne@69: libssh2_sftp_rmdir_ex((sftp), (path), strlen(path)) jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, jpayne@69: const char *path, jpayne@69: unsigned int path_len, jpayne@69: int stat_type, jpayne@69: LIBSSH2_SFTP_ATTRIBUTES *attrs); jpayne@69: #define libssh2_sftp_stat(sftp, path, attrs) \ jpayne@69: libssh2_sftp_stat_ex((sftp), (path), strlen(path), LIBSSH2_SFTP_STAT, \ jpayne@69: (attrs)) jpayne@69: #define libssh2_sftp_lstat(sftp, path, attrs) \ jpayne@69: libssh2_sftp_stat_ex((sftp), (path), strlen(path), LIBSSH2_SFTP_LSTAT, \ jpayne@69: (attrs)) jpayne@69: #define libssh2_sftp_setstat(sftp, path, attrs) \ jpayne@69: libssh2_sftp_stat_ex((sftp), (path), strlen(path), LIBSSH2_SFTP_SETSTAT, \ jpayne@69: (attrs)) jpayne@69: jpayne@69: LIBSSH2_API int libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, jpayne@69: const char *path, jpayne@69: unsigned int path_len, jpayne@69: char *target, jpayne@69: unsigned int target_len, jpayne@69: int link_type); jpayne@69: #define libssh2_sftp_symlink(sftp, orig, linkpath) \ jpayne@69: libssh2_sftp_symlink_ex((sftp), (orig), strlen(orig), (linkpath), \ jpayne@69: strlen(linkpath), LIBSSH2_SFTP_SYMLINK) jpayne@69: #define libssh2_sftp_readlink(sftp, path, target, maxlen) \ jpayne@69: libssh2_sftp_symlink_ex((sftp), (path), strlen(path), (target), (maxlen), \ jpayne@69: LIBSSH2_SFTP_READLINK) jpayne@69: #define libssh2_sftp_realpath(sftp, path, target, maxlen) \ jpayne@69: libssh2_sftp_symlink_ex((sftp), (path), strlen(path), (target), (maxlen), \ jpayne@69: LIBSSH2_SFTP_REALPATH) jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: } /* extern "C" */ jpayne@69: #endif jpayne@69: jpayne@69: #endif /* LIBSSH2_SFTP_H */