libssh 0.9.5 The SSH library

sftp.h
1/*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2003-2008 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
37#ifndef SFTP_H
38#define SFTP_H
39
40#include <sys/types.h>
41
42#include "libssh.h"
43
44#ifdef __cplusplus
45 extern "C" {
46#endif
47
48#ifdef _WIN32
49#ifndef uid_t
50 typedef uint32_t uid_t;
51#endif /* uid_t */
52#ifndef gid_t
53 typedef uint32_t gid_t;
54#endif /* gid_t */
55#ifdef _MSC_VER
56
57# ifndef _SSIZE_T_DEFINED
58# undef ssize_t
59# include <BaseTsd.h>
60 typedef _W64 SSIZE_T ssize_t;
61# define _SSIZE_T_DEFINED
62# endif /* _SSIZE_T_DEFINED */
63
64#endif /* _MSC_VER */
65#endif /* _WIN32 */
66
67#define LIBSFTP_VERSION 3
68
69 typedef struct sftp_attributes_struct* sftp_attributes;
70 typedef struct sftp_client_message_struct* sftp_client_message;
71 typedef struct sftp_dir_struct* sftp_dir;
72 typedef struct sftp_ext_struct *sftp_ext;
73 typedef struct sftp_file_struct* sftp_file;
74 typedef struct sftp_message_struct* sftp_message;
75 typedef struct sftp_packet_struct* sftp_packet;
76 typedef struct sftp_request_queue_struct* sftp_request_queue;
77 typedef struct sftp_session_struct* sftp_session;
78 typedef struct sftp_status_message_struct* sftp_status_message;
79 typedef struct sftp_statvfs_struct* sftp_statvfs_t;
80
81 struct sftp_session_struct {
82 ssh_session session;
83 ssh_channel channel;
84 int server_version;
85 int client_version;
86 int version;
87 sftp_request_queue queue;
88 uint32_t id_counter;
89 int errnum;
90 void **handles;
91 sftp_ext ext;
92 sftp_packet read_packet;
93};
94
95 struct sftp_packet_struct {
96 sftp_session sftp;
97 uint8_t type;
98 ssh_buffer payload;
99};
100
101/* file handler */
102 struct sftp_file_struct {
103 sftp_session sftp;
104 char *name;
105 uint64_t offset;
106 ssh_string handle;
107 int eof;
108 int nonblocking;
109};
110
111 struct sftp_dir_struct {
112 sftp_session sftp;
113 char *name;
114 ssh_string handle; /* handle to directory */
115 ssh_buffer buffer; /* contains raw attributes from server which haven't been parsed */
116 uint32_t count; /* counts the number of following attributes structures into buffer */
117 int eof; /* end of directory listing */
118};
119
120 struct sftp_message_struct {
121 sftp_session sftp;
122 uint8_t packet_type;
123 ssh_buffer payload;
124 uint32_t id;
125};
126
127/* this is a bunch of all data that could be into a message */
128 struct sftp_client_message_struct {
129 sftp_session sftp;
130 uint8_t type;
131 uint32_t id;
132 char *filename; /* can be "path" */
133 uint32_t flags;
134 sftp_attributes attr;
135 ssh_string handle;
136 uint64_t offset;
137 uint32_t len;
138 int attr_num;
139 ssh_buffer attrbuf; /* used by sftp_reply_attrs */
140 ssh_string data; /* can be newpath of rename() */
141 ssh_buffer complete_message; /* complete message in case of retransmission*/
142 char *str_data; /* cstring version of data */
143 char *submessage; /* for extended messages */
144};
145
146 struct sftp_request_queue_struct {
147 sftp_request_queue next;
148 sftp_message message;
149};
150
151/* SSH_FXP_MESSAGE described into .7 page 26 */
152 struct sftp_status_message_struct {
153 uint32_t id;
154 uint32_t status;
155 ssh_string error_unused; /* not used anymore */
156 ssh_string lang_unused; /* not used anymore */
157 char *errormsg;
158 char *langmsg;
159};
160
161 struct sftp_attributes_struct {
162 char *name;
163 char *longname; /* ls -l output on openssh, not reliable else */
164 uint32_t flags;
165 uint8_t type;
166 uint64_t size;
167 uint32_t uid;
168 uint32_t gid;
169 char *owner; /* set if openssh and version 4 */
170 char *group; /* set if openssh and version 4 */
171 uint32_t permissions;
172 uint64_t atime64;
173 uint32_t atime;
174 uint32_t atime_nseconds;
175 uint64_t createtime;
176 uint32_t createtime_nseconds;
177 uint64_t mtime64;
178 uint32_t mtime;
179 uint32_t mtime_nseconds;
180 ssh_string acl;
181 uint32_t extended_count;
182 ssh_string extended_type;
183 ssh_string extended_data;
184};
185
189 struct sftp_statvfs_struct {
190 uint64_t f_bsize;
191 uint64_t f_frsize;
192 uint64_t f_blocks;
193 uint64_t f_bfree;
194 uint64_t f_bavail;
195 uint64_t f_files;
196 uint64_t f_ffree;
197 uint64_t f_favail;
198 uint64_t f_fsid;
199 uint64_t f_flag;
200 uint64_t f_namemax;
201};
202
217LIBSSH_API sftp_session sftp_new(ssh_session session);
218
229LIBSSH_API sftp_session sftp_new_channel(ssh_session session, ssh_channel channel);
230
231
237LIBSSH_API void sftp_free(sftp_session sftp);
238
251LIBSSH_API int sftp_init(sftp_session sftp);
252
265LIBSSH_API int sftp_get_error(sftp_session sftp);
266
275LIBSSH_API unsigned int sftp_extensions_get_count(sftp_session sftp);
276
286LIBSSH_API const char *sftp_extensions_get_name(sftp_session sftp, unsigned int indexn);
287
299LIBSSH_API const char *sftp_extensions_get_data(sftp_session sftp, unsigned int indexn);
300
318LIBSSH_API int sftp_extension_supported(sftp_session sftp, const char *name,
319 const char *data);
320
333LIBSSH_API sftp_dir sftp_opendir(sftp_session session, const char *path);
334
348LIBSSH_API sftp_attributes sftp_readdir(sftp_session session, sftp_dir dir);
349
359LIBSSH_API int sftp_dir_eof(sftp_dir dir);
360
373LIBSSH_API sftp_attributes sftp_stat(sftp_session session, const char *path);
374
390LIBSSH_API sftp_attributes sftp_lstat(sftp_session session, const char *path);
391
402LIBSSH_API sftp_attributes sftp_fstat(sftp_file file);
403
409LIBSSH_API void sftp_attributes_free(sftp_attributes file);
410
418LIBSSH_API int sftp_closedir(sftp_dir dir);
419
429LIBSSH_API int sftp_close(sftp_file file);
430
459LIBSSH_API sftp_file sftp_open(sftp_session session, const char *file, int accesstype,
460 mode_t mode);
461
467LIBSSH_API void sftp_file_set_nonblocking(sftp_file handle);
468
474LIBSSH_API void sftp_file_set_blocking(sftp_file handle);
475
490LIBSSH_API ssize_t sftp_read(sftp_file file, void *buf, size_t count);
491
523LIBSSH_API int sftp_async_read_begin(sftp_file file, uint32_t len);
524
548LIBSSH_API int sftp_async_read(sftp_file file, void *data, uint32_t len, uint32_t id);
549
566LIBSSH_API ssize_t sftp_write(sftp_file file, const void *buf, size_t count);
567
577LIBSSH_API int sftp_seek(sftp_file file, uint32_t new_offset);
578
589LIBSSH_API int sftp_seek64(sftp_file file, uint64_t new_offset);
590
600LIBSSH_API unsigned long sftp_tell(sftp_file file);
601
611LIBSSH_API uint64_t sftp_tell64(sftp_file file);
612
619LIBSSH_API void sftp_rewind(sftp_file file);
620
632LIBSSH_API int sftp_unlink(sftp_session sftp, const char *file);
633
645LIBSSH_API int sftp_rmdir(sftp_session sftp, const char *directory);
646
662LIBSSH_API int sftp_mkdir(sftp_session sftp, const char *directory, mode_t mode);
663
679LIBSSH_API int sftp_rename(sftp_session sftp, const char *original, const char *newname);
680
695LIBSSH_API int sftp_setstat(sftp_session sftp, const char *file, sftp_attributes attr);
696
712LIBSSH_API int sftp_chown(sftp_session sftp, const char *file, uid_t owner, gid_t group);
713
729LIBSSH_API int sftp_chmod(sftp_session sftp, const char *file, mode_t mode);
730
745LIBSSH_API int sftp_utimes(sftp_session sftp, const char *file, const struct timeval *times);
746
760LIBSSH_API int sftp_symlink(sftp_session sftp, const char *target, const char *dest);
761
773LIBSSH_API char *sftp_readlink(sftp_session sftp, const char *path);
774
786LIBSSH_API sftp_statvfs_t sftp_statvfs(sftp_session sftp, const char *path);
787
797LIBSSH_API sftp_statvfs_t sftp_fstatvfs(sftp_file file);
798
804LIBSSH_API void sftp_statvfs_free(sftp_statvfs_t statvfs_o);
805
820LIBSSH_API int sftp_fsync(sftp_file file);
821
833LIBSSH_API char *sftp_canonicalize_path(sftp_session sftp, const char *path);
834
842LIBSSH_API int sftp_server_version(sftp_session sftp);
843
844#ifdef WITH_SERVER
854LIBSSH_API sftp_session sftp_server_new(ssh_session session, ssh_channel chan);
855
863LIBSSH_API int sftp_server_init(sftp_session sftp);
864
870LIBSSH_API void sftp_server_free(sftp_session sftp);
871#endif /* WITH_SERVER */
872
873/* sftpserver.c */
874
875LIBSSH_API sftp_client_message sftp_get_client_message(sftp_session sftp);
876LIBSSH_API void sftp_client_message_free(sftp_client_message msg);
877LIBSSH_API uint8_t sftp_client_message_get_type(sftp_client_message msg);
878LIBSSH_API const char *sftp_client_message_get_filename(sftp_client_message msg);
879LIBSSH_API void sftp_client_message_set_filename(sftp_client_message msg, const char *newname);
880LIBSSH_API const char *sftp_client_message_get_data(sftp_client_message msg);
881LIBSSH_API uint32_t sftp_client_message_get_flags(sftp_client_message msg);
882LIBSSH_API const char *sftp_client_message_get_submessage(sftp_client_message msg);
883LIBSSH_API int sftp_send_client_message(sftp_session sftp, sftp_client_message msg);
884LIBSSH_API int sftp_reply_name(sftp_client_message msg, const char *name,
885 sftp_attributes attr);
886LIBSSH_API int sftp_reply_handle(sftp_client_message msg, ssh_string handle);
887LIBSSH_API ssh_string sftp_handle_alloc(sftp_session sftp, void *info);
888LIBSSH_API int sftp_reply_attr(sftp_client_message msg, sftp_attributes attr);
889LIBSSH_API void *sftp_handle(sftp_session sftp, ssh_string handle);
890LIBSSH_API int sftp_reply_status(sftp_client_message msg, uint32_t status, const char *message);
891LIBSSH_API int sftp_reply_names_add(sftp_client_message msg, const char *file,
892 const char *longname, sftp_attributes attr);
893LIBSSH_API int sftp_reply_names(sftp_client_message msg);
894LIBSSH_API int sftp_reply_data(sftp_client_message msg, const void *data, int len);
895LIBSSH_API void sftp_handle_remove(sftp_session sftp, void *handle);
896
897/* SFTP commands and constants */
898#define SSH_FXP_INIT 1
899#define SSH_FXP_VERSION 2
900#define SSH_FXP_OPEN 3
901#define SSH_FXP_CLOSE 4
902#define SSH_FXP_READ 5
903#define SSH_FXP_WRITE 6
904#define SSH_FXP_LSTAT 7
905#define SSH_FXP_FSTAT 8
906#define SSH_FXP_SETSTAT 9
907#define SSH_FXP_FSETSTAT 10
908#define SSH_FXP_OPENDIR 11
909#define SSH_FXP_READDIR 12
910#define SSH_FXP_REMOVE 13
911#define SSH_FXP_MKDIR 14
912#define SSH_FXP_RMDIR 15
913#define SSH_FXP_REALPATH 16
914#define SSH_FXP_STAT 17
915#define SSH_FXP_RENAME 18
916#define SSH_FXP_READLINK 19
917#define SSH_FXP_SYMLINK 20
918
919#define SSH_FXP_STATUS 101
920#define SSH_FXP_HANDLE 102
921#define SSH_FXP_DATA 103
922#define SSH_FXP_NAME 104
923#define SSH_FXP_ATTRS 105
924
925#define SSH_FXP_EXTENDED 200
926#define SSH_FXP_EXTENDED_REPLY 201
927
928/* attributes */
929/* sftp draft is completely braindead : version 3 and 4 have different flags for same constants */
930/* and even worst, version 4 has same flag for 2 different constants */
931/* follow up : i won't develop any sftp4 compliant library before having a clarification */
932
933#define SSH_FILEXFER_ATTR_SIZE 0x00000001
934#define SSH_FILEXFER_ATTR_PERMISSIONS 0x00000004
935#define SSH_FILEXFER_ATTR_ACCESSTIME 0x00000008
936#define SSH_FILEXFER_ATTR_ACMODTIME 0x00000008
937#define SSH_FILEXFER_ATTR_CREATETIME 0x00000010
938#define SSH_FILEXFER_ATTR_MODIFYTIME 0x00000020
939#define SSH_FILEXFER_ATTR_ACL 0x00000040
940#define SSH_FILEXFER_ATTR_OWNERGROUP 0x00000080
941#define SSH_FILEXFER_ATTR_SUBSECOND_TIMES 0x00000100
942#define SSH_FILEXFER_ATTR_EXTENDED 0x80000000
943#define SSH_FILEXFER_ATTR_UIDGID 0x00000002
944
945/* types */
946#define SSH_FILEXFER_TYPE_REGULAR 1
947#define SSH_FILEXFER_TYPE_DIRECTORY 2
948#define SSH_FILEXFER_TYPE_SYMLINK 3
949#define SSH_FILEXFER_TYPE_SPECIAL 4
950#define SSH_FILEXFER_TYPE_UNKNOWN 5
951
960#define SSH_FX_OK 0
962#define SSH_FX_EOF 1
964#define SSH_FX_NO_SUCH_FILE 2
966#define SSH_FX_PERMISSION_DENIED 3
968#define SSH_FX_FAILURE 4
970#define SSH_FX_BAD_MESSAGE 5
972#define SSH_FX_NO_CONNECTION 6
974#define SSH_FX_CONNECTION_LOST 7
976#define SSH_FX_OP_UNSUPPORTED 8
978#define SSH_FX_INVALID_HANDLE 9
980#define SSH_FX_NO_SUCH_PATH 10
982#define SSH_FX_FILE_ALREADY_EXISTS 11
984#define SSH_FX_WRITE_PROTECT 12
986#define SSH_FX_NO_MEDIA 13
987
990/* file flags */
991#define SSH_FXF_READ 0x01
992#define SSH_FXF_WRITE 0x02
993#define SSH_FXF_APPEND 0x04
994#define SSH_FXF_CREAT 0x08
995#define SSH_FXF_TRUNC 0x10
996#define SSH_FXF_EXCL 0x20
997#define SSH_FXF_TEXT 0x40
998
999/* file type flags */
1000#define SSH_S_IFMT 00170000
1001#define SSH_S_IFSOCK 0140000
1002#define SSH_S_IFLNK 0120000
1003#define SSH_S_IFREG 0100000
1004#define SSH_S_IFBLK 0060000
1005#define SSH_S_IFDIR 0040000
1006#define SSH_S_IFCHR 0020000
1007#define SSH_S_IFIFO 0010000
1008
1009/* rename flags */
1010#define SSH_FXF_RENAME_OVERWRITE 0x00000001
1011#define SSH_FXF_RENAME_ATOMIC 0x00000002
1012#define SSH_FXF_RENAME_NATIVE 0x00000004
1013
1014#define SFTP_OPEN SSH_FXP_OPEN
1015#define SFTP_CLOSE SSH_FXP_CLOSE
1016#define SFTP_READ SSH_FXP_READ
1017#define SFTP_WRITE SSH_FXP_WRITE
1018#define SFTP_LSTAT SSH_FXP_LSTAT
1019#define SFTP_FSTAT SSH_FXP_FSTAT
1020#define SFTP_SETSTAT SSH_FXP_SETSTAT
1021#define SFTP_FSETSTAT SSH_FXP_FSETSTAT
1022#define SFTP_OPENDIR SSH_FXP_OPENDIR
1023#define SFTP_READDIR SSH_FXP_READDIR
1024#define SFTP_REMOVE SSH_FXP_REMOVE
1025#define SFTP_MKDIR SSH_FXP_MKDIR
1026#define SFTP_RMDIR SSH_FXP_RMDIR
1027#define SFTP_REALPATH SSH_FXP_REALPATH
1028#define SFTP_STAT SSH_FXP_STAT
1029#define SFTP_RENAME SSH_FXP_RENAME
1030#define SFTP_READLINK SSH_FXP_READLINK
1031#define SFTP_SYMLINK SSH_FXP_SYMLINK
1032#define SFTP_EXTENDED SSH_FXP_EXTENDED
1033
1034/* openssh flags */
1035#define SSH_FXE_STATVFS_ST_RDONLY 0x1 /* read-only */
1036#define SSH_FXE_STATVFS_ST_NOSUID 0x2 /* no setuid */
1037
1038#ifdef __cplusplus
1039}
1040#endif
1041
1042#endif /* SFTP_H */
1043
sftp_fstat
LIBSSH_API sftp_attributes sftp_fstat(sftp_file file)
Get information about a file or directory from a file handle.
Definition: sftp.c:3360
sftp_file_set_nonblocking
LIBSSH_API void sftp_file_set_nonblocking(sftp_file handle)
Make the sftp communication for this file handle non blocking.
Definition: sftp.c:1890
sftp_mkdir
LIBSSH_API int sftp_mkdir(sftp_session sftp, const char *directory, mode_t mode)
Create a directory.
Definition: sftp.c:2394
sftp_rename
LIBSSH_API int sftp_rename(sftp_session sftp, const char *original, const char *newname)
Rename or move a file or directory.
Definition: sftp.c:2496
sftp_extensions_get_name
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:742
sftp_statvfs_free
LIBSSH_API void sftp_statvfs_free(sftp_statvfs_t statvfs_o)
Free the memory of an allocated statvfs.
Definition: sftp.c:3178
sftp_utimes
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:2685
sftp_readdir
LIBSSH_API sftp_attributes sftp_readdir(sftp_session session, sftp_dir dir)
Get a single file attributes structure of a directory.
Definition: sftp.c:1526
sftp_seek64
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:2222
sftp_closedir
LIBSSH_API int sftp_closedir(sftp_dir dir)
Close a directory handle opened by sftp_opendir().
Definition: sftp.c:1749
sftp_close
LIBSSH_API int sftp_close(sftp_file file)
Close an open file handle.
Definition: sftp.c:1734
sftp_server_free
LIBSSH_API void sftp_server_free(sftp_session sftp)
Close and deallocate a sftp server session.
Definition: sftp.c:303
sftp_async_read
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:2045
sftp_extensions_get_count
LIBSSH_API unsigned int sftp_extensions_get_count(sftp_session sftp)
Get the count of extensions provided by the server.
Definition: sftp.c:734
sftp_get_error
LIBSSH_API int sftp_get_error(sftp_session sftp)
Get the last sftp error.
Definition: sftp.c:531
sftp_tell
LIBSSH_API unsigned long sftp_tell(sftp_file file)
Report current byte position in file.
Definition: sftp.c:2234
sftp_unlink
LIBSSH_API int sftp_unlink(sftp_session sftp, const char *file)
Unlink (delete) a file.
Definition: sftp.c:2249
sftp_lstat
LIBSSH_API sftp_attributes sftp_lstat(sftp_session session, const char *path)
Get information about a file or directory.
Definition: sftp.c:3356
sftp_fstatvfs
LIBSSH_API sftp_statvfs_t sftp_fstatvfs(sftp_file file)
Get information about a mounted file system.
Definition: sftp.c:3102
sftp_async_read_begin
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:2006
sftp_free
LIBSSH_API void sftp_free(sftp_session sftp)
Close and deallocate a sftp session.
Definition: sftp.c:330
sftp_seek
LIBSSH_API int sftp_seek(sftp_file file, uint32_t new_offset)
Seek to a specific location in a file.
Definition: sftp.c:2211
sftp_server_new
LIBSSH_API sftp_session sftp_server_new(ssh_session session, ssh_channel chan)
Create a new sftp server session.
Definition: sftp.c:205
sftp_attributes_free
LIBSSH_API void sftp_attributes_free(sftp_attributes file)
Free a sftp attribute structure.
Definition: sftp.c:1644
sftp_stat
LIBSSH_API sftp_attributes sftp_stat(sftp_session session, const char *path)
Get information about a file or directory.
Definition: sftp.c:3352
sftp_extensions_get_data
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:758
sftp_tell64
LIBSSH_API uint64_t sftp_tell64(sftp_file file)
Report current byte position in file.
Definition: sftp.c:2238
sftp_chown
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:2662
sftp_readlink
LIBSSH_API char * sftp_readlink(sftp_session sftp, const char *path)
Read the value of a symbolic link.
Definition: sftp.c:2793
sftp_extension_supported
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:774
sftp_new_channel
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:176
sftp_open
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:1765
sftp_file_set_blocking
LIBSSH_API void sftp_file_set_blocking(sftp_file handle)
Make the sftp communication for this file handle blocking.
Definition: sftp.c:1893
sftp_rmdir
LIBSSH_API int sftp_rmdir(sftp_session sftp, const char *directory)
Remove a directoy.
Definition: sftp.c:2324
sftp_rewind
LIBSSH_API void sftp_rewind(sftp_file file)
Rewinds the position of the file pointer to the beginning of the file.
Definition: sftp.c:2243
sftp_dir_eof
LIBSSH_API int sftp_dir_eof(sftp_dir dir)
Tell if the directory has reached EOF (End Of File).
Definition: sftp.c:1639
sftp_opendir
LIBSSH_API sftp_dir sftp_opendir(sftp_session session, const char *path)
Open a directory used to obtain directory entries.
Definition: sftp.c:990
sftp_init
LIBSSH_API int sftp_init(sftp_session sftp)
Initialize the sftp protocol with the server.
Definition: sftp.c:638
sftp_read
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:1898
sftp_server_version
LIBSSH_API int sftp_server_version(sftp_session sftp)
Get the version of the SFTP protocol supported by the server.
Definition: sftp.c:1521
sftp_setstat
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:2579
sftp_canonicalize_path
LIBSSH_API char * sftp_canonicalize_path(sftp_session sftp, const char *path)
Canonicalize a sftp path.
Definition: sftp.c:3187
sftp_server_init
LIBSSH_API int sftp_server_init(sftp_session sftp)
Intialize the sftp server.
Definition: sftp.c:241
sftp_symlink
LIBSSH_API int sftp_symlink(sftp_session sftp, const char *target, const char *dest)
Create a symbolic link.
Definition: sftp.c:2702
sftp_new
LIBSSH_API sftp_session sftp_new(ssh_session session)
Creates a new sftp session.
Definition: sftp.c:110
sftp_chmod
LIBSSH_API int sftp_chmod(sftp_session sftp, const char *file, mode_t mode)
Change permissions of a file.
Definition: sftp.c:2675
sftp_statvfs
LIBSSH_API sftp_statvfs_t sftp_statvfs(sftp_session sftp, const char *path)
Get information about a mounted file system.
Definition: sftp.c:2920
sftp_fsync
LIBSSH_API int sftp_fsync(sftp_file file)
Synchronize a file's in-core state with storage device.
Definition: sftp.c:3003
sftp_write
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:2128
sftp_attributes_struct
Definition: sftp.h:161
sftp_client_message_struct
Definition: sftp.h:128
sftp_dir_struct
Definition: sftp.h:111
sftp_ext_struct
Definition: sftp.c:60
sftp_file_struct
Definition: sftp.h:102
sftp_message_struct
Definition: sftp.h:120
sftp_packet_struct
Definition: sftp.h:95
sftp_request_queue_struct
Definition: sftp.h:146
sftp_session_struct
Definition: sftp.h:81
sftp_status_message_struct
Definition: sftp.h:152
sftp_statvfs_struct
SFTP statvfs structure.
Definition: sftp.h:189
sftp_statvfs_struct::f_blocks
uint64_t f_blocks
Definition: sftp.h:192
sftp_statvfs_struct::f_ffree
uint64_t f_ffree
Definition: sftp.h:196
sftp_statvfs_struct::f_files
uint64_t f_files
Definition: sftp.h:195
sftp_statvfs_struct::f_bavail
uint64_t f_bavail
Definition: sftp.h:194
sftp_statvfs_struct::f_namemax
uint64_t f_namemax
Definition: sftp.h:200
sftp_statvfs_struct::f_bfree
uint64_t f_bfree
Definition: sftp.h:193
sftp_statvfs_struct::f_favail
uint64_t f_favail
Definition: sftp.h:197
sftp_statvfs_struct::f_flag
uint64_t f_flag
Definition: sftp.h:199
sftp_statvfs_struct::f_frsize
uint64_t f_frsize
Definition: sftp.h:191
sftp_statvfs_struct::f_fsid
uint64_t f_fsid
Definition: sftp.h:198
ssh_buffer_struct
Definition: buffer.c:47
ssh_channel_struct
Definition: channels.h:62
ssh_session_struct
Definition: session.h:109
ssh_string_struct
Definition: string.h:29