50 typedef uint32_t uid_t;
53 typedef uint32_t gid_t;
57# ifndef _SSIZE_T_DEFINED
60 typedef _W64 SSIZE_T ssize_t;
61# define _SSIZE_T_DEFINED
67#define LIBSFTP_VERSION 3
171 uint32_t permissions;
174 uint32_t atime_nseconds;
176 uint32_t createtime_nseconds;
179 uint32_t mtime_nseconds;
181 uint32_t extended_count;
886LIBSSH_API
void sftp_client_message_set_filename(
sftp_client_message msg,
const char *newname);
897LIBSSH_API
int sftp_reply_status(
sftp_client_message msg, uint32_t status,
const char *message);
902LIBSSH_API
void sftp_handle_remove(
sftp_session sftp,
void *handle);
905#define SSH_FXP_INIT 1
906#define SSH_FXP_VERSION 2
907#define SSH_FXP_OPEN 3
908#define SSH_FXP_CLOSE 4
909#define SSH_FXP_READ 5
910#define SSH_FXP_WRITE 6
911#define SSH_FXP_LSTAT 7
912#define SSH_FXP_FSTAT 8
913#define SSH_FXP_SETSTAT 9
914#define SSH_FXP_FSETSTAT 10
915#define SSH_FXP_OPENDIR 11
916#define SSH_FXP_READDIR 12
917#define SSH_FXP_REMOVE 13
918#define SSH_FXP_MKDIR 14
919#define SSH_FXP_RMDIR 15
920#define SSH_FXP_REALPATH 16
921#define SSH_FXP_STAT 17
922#define SSH_FXP_RENAME 18
923#define SSH_FXP_READLINK 19
924#define SSH_FXP_SYMLINK 20
926#define SSH_FXP_STATUS 101
927#define SSH_FXP_HANDLE 102
928#define SSH_FXP_DATA 103
929#define SSH_FXP_NAME 104
930#define SSH_FXP_ATTRS 105
932#define SSH_FXP_EXTENDED 200
933#define SSH_FXP_EXTENDED_REPLY 201
940#define SSH_FILEXFER_ATTR_SIZE 0x00000001
941#define SSH_FILEXFER_ATTR_PERMISSIONS 0x00000004
942#define SSH_FILEXFER_ATTR_ACCESSTIME 0x00000008
943#define SSH_FILEXFER_ATTR_ACMODTIME 0x00000008
944#define SSH_FILEXFER_ATTR_CREATETIME 0x00000010
945#define SSH_FILEXFER_ATTR_MODIFYTIME 0x00000020
946#define SSH_FILEXFER_ATTR_ACL 0x00000040
947#define SSH_FILEXFER_ATTR_OWNERGROUP 0x00000080
948#define SSH_FILEXFER_ATTR_SUBSECOND_TIMES 0x00000100
949#define SSH_FILEXFER_ATTR_EXTENDED 0x80000000
950#define SSH_FILEXFER_ATTR_UIDGID 0x00000002
953#define SSH_FILEXFER_TYPE_REGULAR 1
954#define SSH_FILEXFER_TYPE_DIRECTORY 2
955#define SSH_FILEXFER_TYPE_SYMLINK 3
956#define SSH_FILEXFER_TYPE_SPECIAL 4
957#define SSH_FILEXFER_TYPE_UNKNOWN 5
971#define SSH_FX_NO_SUCH_FILE 2
973#define SSH_FX_PERMISSION_DENIED 3
975#define SSH_FX_FAILURE 4
977#define SSH_FX_BAD_MESSAGE 5
979#define SSH_FX_NO_CONNECTION 6
981#define SSH_FX_CONNECTION_LOST 7
983#define SSH_FX_OP_UNSUPPORTED 8
985#define SSH_FX_INVALID_HANDLE 9
987#define SSH_FX_NO_SUCH_PATH 10
989#define SSH_FX_FILE_ALREADY_EXISTS 11
991#define SSH_FX_WRITE_PROTECT 12
993#define SSH_FX_NO_MEDIA 13
998#define SSH_FXF_READ 0x01
999#define SSH_FXF_WRITE 0x02
1000#define SSH_FXF_APPEND 0x04
1001#define SSH_FXF_CREAT 0x08
1002#define SSH_FXF_TRUNC 0x10
1003#define SSH_FXF_EXCL 0x20
1004#define SSH_FXF_TEXT 0x40
1007#define SSH_S_IFMT 00170000
1008#define SSH_S_IFSOCK 0140000
1009#define SSH_S_IFLNK 0120000
1010#define SSH_S_IFREG 0100000
1011#define SSH_S_IFBLK 0060000
1012#define SSH_S_IFDIR 0040000
1013#define SSH_S_IFCHR 0020000
1014#define SSH_S_IFIFO 0010000
1017#define SSH_FXF_RENAME_OVERWRITE 0x00000001
1018#define SSH_FXF_RENAME_ATOMIC 0x00000002
1019#define SSH_FXF_RENAME_NATIVE 0x00000004
1021#define SFTP_OPEN SSH_FXP_OPEN
1022#define SFTP_CLOSE SSH_FXP_CLOSE
1023#define SFTP_READ SSH_FXP_READ
1024#define SFTP_WRITE SSH_FXP_WRITE
1025#define SFTP_LSTAT SSH_FXP_LSTAT
1026#define SFTP_FSTAT SSH_FXP_FSTAT
1027#define SFTP_SETSTAT SSH_FXP_SETSTAT
1028#define SFTP_FSETSTAT SSH_FXP_FSETSTAT
1029#define SFTP_OPENDIR SSH_FXP_OPENDIR
1030#define SFTP_READDIR SSH_FXP_READDIR
1031#define SFTP_REMOVE SSH_FXP_REMOVE
1032#define SFTP_MKDIR SSH_FXP_MKDIR
1033#define SFTP_RMDIR SSH_FXP_RMDIR
1034#define SFTP_REALPATH SSH_FXP_REALPATH
1035#define SFTP_STAT SSH_FXP_STAT
1036#define SFTP_RENAME SSH_FXP_RENAME
1037#define SFTP_READLINK SSH_FXP_READLINK
1038#define SFTP_SYMLINK SSH_FXP_SYMLINK
1039#define SFTP_EXTENDED SSH_FXP_EXTENDED
1042#define SSH_FXE_STATVFS_ST_RDONLY 0x1
1043#define SSH_FXE_STATVFS_ST_NOSUID 0x2
LIBSSH_API sftp_attributes sftp_fstat(sftp_file file)
Get information about a file or directory from a file handle.
Definition sftp.c:3381
LIBSSH_API void sftp_file_set_nonblocking(sftp_file handle)
Make the sftp communication for this file handle non blocking.
Definition sftp.c:1911
LIBSSH_API int sftp_mkdir(sftp_session sftp, const char *directory, mode_t mode)
Create a directory.
Definition sftp.c:2415
LIBSSH_API int sftp_rename(sftp_session sftp, const char *original, const char *newname)
Rename or move a file or directory.
Definition sftp.c:2517
LIBSSH_API const char * sftp_extensions_get_name(sftp_session sftp, unsigned int indexn)
Get the name of the extension provided by the server.
Definition sftp.c:763
LIBSSH_API void sftp_statvfs_free(sftp_statvfs_t statvfs_o)
Free the memory of an allocated statvfs.
Definition sftp.c:3199
LIBSSH_API int sftp_utimes(sftp_session sftp, const char *file, const struct timeval *times)
Change the last modification and access time of a file.
Definition sftp.c:2706
LIBSSH_API sftp_attributes sftp_readdir(sftp_session session, sftp_dir dir)
Get a single file attributes structure of a directory.
Definition sftp.c:1547
LIBSSH_API int sftp_seek64(sftp_file file, uint64_t new_offset)
Seek to a specific location in a file. This is the 64bit version.
Definition sftp.c:2243
LIBSSH_API int sftp_closedir(sftp_dir dir)
Close a directory handle opened by sftp_opendir().
Definition sftp.c:1770
LIBSSH_API int sftp_close(sftp_file file)
Close an open file handle.
Definition sftp.c:1755
LIBSSH_API void sftp_server_free(sftp_session sftp)
Close and deallocate a sftp server session.
Definition sftp.c:331
LIBSSH_API int sftp_async_read(sftp_file file, void *data, uint32_t len, uint32_t id)
Wait for an asynchronous read to complete and save the data.
Definition sftp.c:2066
LIBSSH_API unsigned int sftp_extensions_get_count(sftp_session sftp)
Get the count of extensions provided by the server.
Definition sftp.c:755
LIBSSH_API int sftp_get_error(sftp_session sftp)
Get the last sftp error.
Definition sftp.c:552
LIBSSH_API unsigned long sftp_tell(sftp_file file)
Report current byte position in file.
Definition sftp.c:2255
LIBSSH_API int sftp_unlink(sftp_session sftp, const char *file)
Unlink (delete) a file.
Definition sftp.c:2270
LIBSSH_API sftp_attributes sftp_lstat(sftp_session session, const char *path)
Get information about a file or directory.
Definition sftp.c:3377
LIBSSH_API sftp_statvfs_t sftp_fstatvfs(sftp_file file)
Get information about a mounted file system.
Definition sftp.c:3123
LIBSSH_API int sftp_async_read_begin(sftp_file file, uint32_t len)
Start an asynchronous read from a file using an opened sftp file handle.
Definition sftp.c:2027
LIBSSH_API void sftp_free(sftp_session sftp)
Close and deallocate a sftp session.
Definition sftp.c:358
LIBSSH_API int sftp_seek(sftp_file file, uint32_t new_offset)
Seek to a specific location in a file.
Definition sftp.c:2232
LIBSSH_API sftp_session sftp_server_new(ssh_session session, ssh_channel chan)
Create a new sftp server session.
Definition sftp.c:232
LIBSSH_API void sftp_attributes_free(sftp_attributes file)
Free a sftp attribute structure.
Definition sftp.c:1665
LIBSSH_API sftp_attributes sftp_stat(sftp_session session, const char *path)
Get information about a file or directory.
Definition sftp.c:3373
LIBSSH_API const char * sftp_extensions_get_data(sftp_session sftp, unsigned int indexn)
Get the data of the extension provided by the server.
Definition sftp.c:779
LIBSSH_API uint64_t sftp_tell64(sftp_file file)
Report current byte position in file.
Definition sftp.c:2259
LIBSSH_API int sftp_chown(sftp_session sftp, const char *file, uid_t owner, gid_t group)
Change the file owner and group.
Definition sftp.c:2683
LIBSSH_API char * sftp_readlink(sftp_session sftp, const char *path)
Read the value of a symbolic link.
Definition sftp.c:2814
LIBSSH_API int sftp_extension_supported(sftp_session sftp, const char *name, const char *data)
Check if the given extension is supported.
Definition sftp.c:795
LIBSSH_API sftp_session sftp_new_channel(ssh_session session, ssh_channel channel)
Start a new sftp session with an existing channel.
Definition sftp.c:179
LIBSSH_API sftp_file sftp_open(sftp_session session, const char *file, int accesstype, mode_t mode)
Open a file on the server.
Definition sftp.c:1786
LIBSSH_API void sftp_file_set_blocking(sftp_file handle)
Make the sftp communication for this file handle blocking.
Definition sftp.c:1914
LIBSSH_API int sftp_rmdir(sftp_session sftp, const char *directory)
Remove a directory.
Definition sftp.c:2345
LIBSSH_API void sftp_rewind(sftp_file file)
Rewinds the position of the file pointer to the beginning of the file.
Definition sftp.c:2264
LIBSSH_API int sftp_dir_eof(sftp_dir dir)
Tell if the directory has reached EOF (End Of File).
Definition sftp.c:1660
LIBSSH_API sftp_dir sftp_opendir(sftp_session session, const char *path)
Open a directory used to obtain directory entries.
Definition sftp.c:1011
LIBSSH_API int sftp_init(sftp_session sftp)
Initialize the sftp protocol with the server.
Definition sftp.c:659
LIBSSH_API ssize_t sftp_read(sftp_file file, void *buf, size_t count)
Read from a file using an opened sftp file handle.
Definition sftp.c:1919
LIBSSH_API int sftp_server_version(sftp_session sftp)
Get the version of the SFTP protocol supported by the server.
Definition sftp.c:1542
LIBSSH_API int sftp_setstat(sftp_session sftp, const char *file, sftp_attributes attr)
Set file attributes on a file, directory or symbolic link.
Definition sftp.c:2600
LIBSSH_API char * sftp_canonicalize_path(sftp_session sftp, const char *path)
Canonicalize a sftp path.
Definition sftp.c:3208
LIBSSH_API int sftp_server_init(sftp_session sftp)
Initialize the sftp server.
Definition sftp.c:269
LIBSSH_API int sftp_symlink(sftp_session sftp, const char *target, const char *dest)
Create a symbolic link.
Definition sftp.c:2723
LIBSSH_API sftp_session sftp_new(ssh_session session)
Creates a new sftp session.
Definition sftp.c:112
LIBSSH_API int sftp_chmod(sftp_session sftp, const char *file, mode_t mode)
Change permissions of a file.
Definition sftp.c:2696
LIBSSH_API sftp_statvfs_t sftp_statvfs(sftp_session sftp, const char *path)
Get information about a mounted file system.
Definition sftp.c:2941
LIBSSH_API int sftp_fsync(sftp_file file)
Synchronize a file's in-core state with storage device.
Definition sftp.c:3024
LIBSSH_API ssize_t sftp_write(sftp_file file, const void *buf, size_t count)
Write to a file using an opened sftp file handle.
Definition sftp.c:2149
SFTP statvfs structure.
Definition sftp.h:189
uint64_t f_blocks
Definition sftp.h:192
uint64_t f_ffree
Definition sftp.h:196
uint64_t f_files
Definition sftp.h:195
uint64_t f_bavail
Definition sftp.h:194
uint64_t f_namemax
Definition sftp.h:200
uint64_t f_bfree
Definition sftp.h:193
uint64_t f_favail
Definition sftp.h:197
uint64_t f_flag
Definition sftp.h:199
uint64_t f_frsize
Definition sftp.h:191
uint64_t f_fsid
Definition sftp.h:198