libssh: /build/libssh/src/libssh-0.12.0/include/libssh/sftp.h Source File

libssh 0.12.0 The SSH library

Loading...
Searching...
No Matches
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
36
37#ifndef SFTP_H
38#define SFTP_H
39
40#include <sys/types.h>
41
42#include "libssh.h"
43
44#ifdef __cplusplus
45extern "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
69typedef struct sftp_attributes_struct* sftp_attributes;
70typedef struct sftp_client_message_struct* sftp_client_message;
71typedef struct sftp_dir_struct* sftp_dir;
72typedef struct sftp_ext_struct *sftp_ext;
73typedef struct sftp_file_struct* sftp_file;
74typedef struct sftp_message_struct* sftp_message;
75typedef struct sftp_packet_struct* sftp_packet;
76typedef struct sftp_request_queue_struct* sftp_request_queue;
77
92 typedef struct sftp_session_struct* sftp_session;
93typedef struct sftp_status_message_struct* sftp_status_message;
94typedef struct sftp_statvfs_struct* sftp_statvfs_t;
95typedef struct sftp_limits_struct* sftp_limits_t;
96typedef struct sftp_aio_struct* sftp_aio;
97typedef struct sftp_name_id_map_struct *sftp_name_id_map;
98
99struct sftp_session_struct {
100 ssh_session session;
101 ssh_channel channel;
102 int server_version;
103 int client_version;
104 int version;
105 sftp_request_queue queue;
106 uint32_t id_counter;
107 int errnum;
108 void **handles;
109 sftp_ext ext;
110 sftp_packet read_packet;
111 sftp_limits_t limits;
112};
113
114struct sftp_packet_struct {
115 sftp_session sftp;
116 uint8_t type;
117 ssh_buffer payload;
118};
119
120/* file handler */
121struct sftp_file_struct {
122 sftp_session sftp;
123 char *name;
124 uint64_t offset;
125 ssh_string handle;
126 int eof;
127 int nonblocking;
128};
129
130struct sftp_dir_struct {
131 sftp_session sftp;
132 char *name;
133 ssh_string handle; /* handle to directory */
134 ssh_buffer buffer; /* contains raw attributes from server which haven't been parsed */
135 uint32_t count; /* counts the number of following attributes structures into buffer */
136 int eof; /* end of directory listing */
137};
138
139struct sftp_message_struct {
140 sftp_session sftp;
141 uint8_t packet_type;
142 ssh_buffer payload;
143 uint32_t id;
144};
145
146/* this is a bunch of all data that could be into a message */
147struct sftp_client_message_struct {
148 sftp_session sftp;
149 uint8_t type;
150 uint32_t id;
151 char *filename; /* can be "path" */
152 uint32_t flags;
153 sftp_attributes attr;
154 ssh_string handle;
155 uint64_t offset;
156 uint32_t len;
157 int attr_num;
158 ssh_buffer attrbuf; /* used by sftp_reply_attrs */
159 ssh_string data; /* can be newpath of rename() */
160 ssh_buffer complete_message; /* complete message in case of retransmission*/
161 char *str_data; /* cstring version of data */
162 char *submessage; /* for extended messages */
163};
164
165struct sftp_request_queue_struct {
166 sftp_request_queue next;
167 sftp_message message;
168};
169
170/* SSH_FXP_MESSAGE described into .7 page 26 */
171struct sftp_status_message_struct {
172 uint32_t id;
173 uint32_t status;
174 ssh_string error_unused; /* not used anymore */
175 ssh_string lang_unused; /* not used anymore */
176 char *errormsg;
177 char *langmsg;
178};
179
180struct sftp_attributes_struct {
181 char *name;
182 char *longname; /* ls -l output on openssh, not reliable else */
183 uint32_t flags;
184 uint8_t type;
185 uint64_t size;
186 uint32_t uid;
187 uint32_t gid;
188 char *owner; /* set if openssh and version 4 */
189 char *group; /* set if openssh and version 4 */
190 uint32_t permissions;
191 uint64_t atime64;
192 uint32_t atime;
193 uint32_t atime_nseconds;
194 uint64_t createtime;
195 uint32_t createtime_nseconds;
196 uint64_t mtime64;
197 uint32_t mtime;
198 uint32_t mtime_nseconds;
199 ssh_string acl;
200 uint32_t extended_count;
201 ssh_string extended_type;
202 ssh_string extended_data;
203};
204
208 struct sftp_statvfs_struct {
209 uint64_t f_bsize;
210 uint64_t f_frsize;
211 uint64_t f_blocks;
212 uint64_t f_bfree;
213 uint64_t f_bavail;
214 uint64_t f_files;
215 uint64_t f_ffree;
216 uint64_t f_favail;
217 uint64_t f_fsid;
218 uint64_t f_flag;
219 uint64_t f_namemax;
220};
221
225 struct sftp_limits_struct {
226 uint64_t max_packet_length;
227 uint64_t max_read_length;
228 uint64_t max_write_length;
229 uint64_t max_open_handles;
230};
231
237 struct sftp_name_id_map_struct {
239 uint32_t count;
240
242 uint32_t *ids;
243
245 char **names;
246};
247
265LIBSSH_API sftp_session sftp_new(ssh_session session);
266
280LIBSSH_API sftp_session sftp_new_channel(ssh_session session, ssh_channel channel);
281
282
288LIBSSH_API void sftp_free(sftp_session sftp);
289
302LIBSSH_API int sftp_init(sftp_session sftp);
303
316LIBSSH_API int sftp_get_error(sftp_session sftp);
317
326LIBSSH_API unsigned int sftp_extensions_get_count(sftp_session sftp);
327
337LIBSSH_API const char *sftp_extensions_get_name(sftp_session sftp, unsigned int indexn);
338
350LIBSSH_API const char *sftp_extensions_get_data(sftp_session sftp, unsigned int indexn);
351
369LIBSSH_API int sftp_extension_supported(sftp_session sftp, const char *name,
370 const char *data);
371
384LIBSSH_API sftp_dir sftp_opendir(sftp_session session, const char *path);
385
399LIBSSH_API sftp_attributes sftp_readdir(sftp_session session, sftp_dir dir);
400
410LIBSSH_API int sftp_dir_eof(sftp_dir dir);
411
424LIBSSH_API sftp_attributes sftp_stat(sftp_session session, const char *path);
425
441LIBSSH_API sftp_attributes sftp_lstat(sftp_session session, const char *path);
442
453LIBSSH_API sftp_attributes sftp_fstat(sftp_file file);
454
460LIBSSH_API void sftp_attributes_free(sftp_attributes file);
461
469LIBSSH_API int sftp_closedir(sftp_dir dir);
470
480LIBSSH_API int sftp_close(sftp_file file);
481
510LIBSSH_API sftp_file sftp_open(sftp_session session, const char *file, int accesstype,
511 mode_t mode);
512
518LIBSSH_API void sftp_file_set_nonblocking(sftp_file handle);
519
525LIBSSH_API void sftp_file_set_blocking(sftp_file handle);
526
546LIBSSH_API ssize_t sftp_read(sftp_file file, void *buf, size_t count);
547
579SSH_DEPRECATED LIBSSH_API int sftp_async_read_begin(sftp_file file,
580 uint32_t len);
581
605SSH_DEPRECATED LIBSSH_API int sftp_async_read(sftp_file file,
606 void *data,
607 uint32_t len,
608 uint32_t id);
609
631LIBSSH_API ssize_t sftp_write(sftp_file file, const void *buf, size_t count);
632
649LIBSSH_API void sftp_aio_free(sftp_aio aio);
650#define SFTP_AIO_FREE(x) \
651 do { if(x != NULL) {sftp_aio_free(x); x = NULL;} } while(0)
652
716LIBSSH_API ssize_t sftp_aio_begin_read(sftp_file file,
717 size_t len,
718 sftp_aio *aio);
719
753LIBSSH_API ssize_t sftp_aio_wait_read(sftp_aio *aio,
754 void *buf,
755 size_t buf_size);
756
822LIBSSH_API ssize_t sftp_aio_begin_write(sftp_file file,
823 const void *buf,
824 size_t len,
825 sftp_aio *aio);
826
854LIBSSH_API ssize_t sftp_aio_wait_write(sftp_aio *aio);
855
865LIBSSH_API int sftp_seek(sftp_file file, uint32_t new_offset);
866
877LIBSSH_API int sftp_seek64(sftp_file file, uint64_t new_offset);
878
888LIBSSH_API unsigned long sftp_tell(sftp_file file);
889
898LIBSSH_API uint64_t sftp_tell64(sftp_file file);
899
906LIBSSH_API void sftp_rewind(sftp_file file);
907
919LIBSSH_API int sftp_unlink(sftp_session sftp, const char *file);
920
932LIBSSH_API int sftp_rmdir(sftp_session sftp, const char *directory);
933
949LIBSSH_API int sftp_mkdir(sftp_session sftp, const char *directory, mode_t mode);
950
966LIBSSH_API int sftp_rename(sftp_session sftp, const char *original, const char *newname);
967
987LIBSSH_API int sftp_setstat(sftp_session sftp, const char *file, sftp_attributes attr);
988
1009LIBSSH_API int
1010 sftp_lsetstat(sftp_session sftp, const char *file, sftp_attributes attr);
1011
1027LIBSSH_API int sftp_chown(sftp_session sftp, const char *file, uid_t owner, gid_t group);
1028
1044LIBSSH_API int sftp_chmod(sftp_session sftp, const char *file, mode_t mode);
1045
1060LIBSSH_API int sftp_utimes(sftp_session sftp, const char *file, const struct timeval *times);
1061
1075LIBSSH_API int sftp_symlink(sftp_session sftp, const char *target, const char *dest);
1076
1090LIBSSH_API char *sftp_readlink(sftp_session sftp, const char *path);
1091
1106LIBSSH_API int sftp_hardlink(sftp_session sftp, const char *oldpath, const char *newpath);
1107
1119LIBSSH_API sftp_statvfs_t sftp_statvfs(sftp_session sftp, const char *path);
1120
1130LIBSSH_API sftp_statvfs_t sftp_fstatvfs(sftp_file file);
1131
1137LIBSSH_API void sftp_statvfs_free(sftp_statvfs_t statvfs_o);
1138
1153LIBSSH_API int sftp_fsync(sftp_file file);
1154
1164LIBSSH_API sftp_limits_t sftp_limits(sftp_session sftp);
1165
1171LIBSSH_API void sftp_limits_free(sftp_limits_t limits);
1172
1184LIBSSH_API char *sftp_canonicalize_path(sftp_session sftp, const char *path);
1185
1193LIBSSH_API int sftp_server_version(sftp_session sftp);
1194
1206LIBSSH_API char *sftp_expand_path(sftp_session sftp, const char *path);
1207
1227LIBSSH_API char *sftp_home_directory(sftp_session sftp, const char *username);
1228
1237LIBSSH_API sftp_name_id_map sftp_name_id_map_new(uint32_t count);
1238
1244LIBSSH_API void sftp_name_id_map_free(sftp_name_id_map map);
1245
1277LIBSSH_API int sftp_get_users_groups_by_id(sftp_session sftp,
1278 sftp_name_id_map users_map,
1279 sftp_name_id_map groups_map);
1280
1281#ifdef WITH_SERVER
1291LIBSSH_API sftp_session sftp_server_new(ssh_session session, ssh_channel chan);
1292
1300SSH_DEPRECATED LIBSSH_API int sftp_server_init(sftp_session sftp);
1301
1307LIBSSH_API void sftp_server_free(sftp_session sftp);
1308#endif /* WITH_SERVER */
1309
1310/* sftpserver.c */
1311
1312LIBSSH_API sftp_client_message sftp_get_client_message(sftp_session sftp);
1313LIBSSH_API void sftp_client_message_free(sftp_client_message msg);
1314LIBSSH_API uint8_t sftp_client_message_get_type(sftp_client_message msg);
1315LIBSSH_API const char *sftp_client_message_get_filename(sftp_client_message msg);
1316LIBSSH_API void sftp_client_message_set_filename(sftp_client_message msg, const char *newname);
1317LIBSSH_API const char *sftp_client_message_get_data(sftp_client_message msg);
1318LIBSSH_API uint32_t sftp_client_message_get_flags(sftp_client_message msg);
1319LIBSSH_API const char *sftp_client_message_get_submessage(sftp_client_message msg);
1320LIBSSH_API int sftp_send_client_message(sftp_session sftp, sftp_client_message msg);
1321LIBSSH_API int sftp_reply_name(sftp_client_message msg, const char *name,
1322 sftp_attributes attr);
1323LIBSSH_API int sftp_reply_handle(sftp_client_message msg, ssh_string handle);
1324LIBSSH_API ssh_string sftp_handle_alloc(sftp_session sftp, void *info);
1325LIBSSH_API int sftp_reply_attr(sftp_client_message msg, sftp_attributes attr);
1326LIBSSH_API void *sftp_handle(sftp_session sftp, ssh_string handle);
1327LIBSSH_API int sftp_reply_status(sftp_client_message msg, uint32_t status, const char *message);
1328LIBSSH_API int sftp_reply_names_add(sftp_client_message msg, const char *file,
1329 const char *longname, sftp_attributes attr);
1330LIBSSH_API int sftp_reply_names(sftp_client_message msg);
1331LIBSSH_API int sftp_reply_data(sftp_client_message msg, const void *data, int len);
1332LIBSSH_API void sftp_handle_remove(sftp_session sftp, void *handle);
1333
1334/* SFTP commands and constants */
1335#define SSH_FXP_INIT 1
1336#define SSH_FXP_VERSION 2
1337#define SSH_FXP_OPEN 3
1338#define SSH_FXP_CLOSE 4
1339#define SSH_FXP_READ 5
1340#define SSH_FXP_WRITE 6
1341#define SSH_FXP_LSTAT 7
1342#define SSH_FXP_FSTAT 8
1343#define SSH_FXP_SETSTAT 9
1344#define SSH_FXP_FSETSTAT 10
1345#define SSH_FXP_OPENDIR 11
1346#define SSH_FXP_READDIR 12
1347#define SSH_FXP_REMOVE 13
1348#define SSH_FXP_MKDIR 14
1349#define SSH_FXP_RMDIR 15
1350#define SSH_FXP_REALPATH 16
1351#define SSH_FXP_STAT 17
1352#define SSH_FXP_RENAME 18
1353#define SSH_FXP_READLINK 19
1354#define SSH_FXP_SYMLINK 20
1355
1356#define SSH_FXP_STATUS 101
1357#define SSH_FXP_HANDLE 102
1358#define SSH_FXP_DATA 103
1359#define SSH_FXP_NAME 104
1360#define SSH_FXP_ATTRS 105
1361
1362#define SSH_FXP_EXTENDED 200
1363#define SSH_FXP_EXTENDED_REPLY 201
1364
1365/* attributes */
1366/* sftp draft is completely braindead : version 3 and 4 have different flags for same constants */
1367/* and even worst, version 4 has same flag for 2 different constants */
1368/* follow up : i won't develop any sftp4 compliant library before having a clarification */
1369
1370#define SSH_FILEXFER_ATTR_SIZE 0x00000001
1371#define SSH_FILEXFER_ATTR_PERMISSIONS 0x00000004
1372#define SSH_FILEXFER_ATTR_ACCESSTIME 0x00000008
1373#define SSH_FILEXFER_ATTR_ACMODTIME 0x00000008
1374#define SSH_FILEXFER_ATTR_CREATETIME 0x00000010
1375#define SSH_FILEXFER_ATTR_MODIFYTIME 0x00000020
1376#define SSH_FILEXFER_ATTR_ACL 0x00000040
1377#define SSH_FILEXFER_ATTR_OWNERGROUP 0x00000080
1378#define SSH_FILEXFER_ATTR_SUBSECOND_TIMES 0x00000100
1379#define SSH_FILEXFER_ATTR_EXTENDED 0x80000000
1380#define SSH_FILEXFER_ATTR_UIDGID 0x00000002
1381
1382/* types */
1383#define SSH_FILEXFER_TYPE_REGULAR 1
1384#define SSH_FILEXFER_TYPE_DIRECTORY 2
1385#define SSH_FILEXFER_TYPE_SYMLINK 3
1386#define SSH_FILEXFER_TYPE_SPECIAL 4
1387#define SSH_FILEXFER_TYPE_UNKNOWN 5
1388
1395
1397#define SSH_FX_OK 0
1399#define SSH_FX_EOF 1
1401#define SSH_FX_NO_SUCH_FILE 2
1403#define SSH_FX_PERMISSION_DENIED 3
1405#define SSH_FX_FAILURE 4
1407#define SSH_FX_BAD_MESSAGE 5
1409#define SSH_FX_NO_CONNECTION 6
1411#define SSH_FX_CONNECTION_LOST 7
1413#define SSH_FX_OP_UNSUPPORTED 8
1415#define SSH_FX_INVALID_HANDLE 9
1417#define SSH_FX_NO_SUCH_PATH 10
1419#define SSH_FX_FILE_ALREADY_EXISTS 11
1421#define SSH_FX_WRITE_PROTECT 12
1423#define SSH_FX_NO_MEDIA 13
1424
1426
1427/* file flags */
1428#define SSH_FXF_READ 0x01
1429#define SSH_FXF_WRITE 0x02
1430#define SSH_FXF_APPEND 0x04
1431#define SSH_FXF_CREAT 0x08
1432#define SSH_FXF_TRUNC 0x10
1433#define SSH_FXF_EXCL 0x20
1434#define SSH_FXF_TEXT 0x40
1435
1436/* file type flags */
1437#define SSH_S_IFMT 00170000
1438#define SSH_S_IFSOCK 0140000
1439#define SSH_S_IFLNK 0120000
1440#define SSH_S_IFREG 0100000
1441#define SSH_S_IFBLK 0060000
1442#define SSH_S_IFDIR 0040000
1443#define SSH_S_IFCHR 0020000
1444#define SSH_S_IFIFO 0010000
1445
1446/* rename flags */
1447#define SSH_FXF_RENAME_OVERWRITE 0x00000001
1448#define SSH_FXF_RENAME_ATOMIC 0x00000002
1449#define SSH_FXF_RENAME_NATIVE 0x00000004
1450
1451#define SFTP_OPEN SSH_FXP_OPEN
1452#define SFTP_CLOSE SSH_FXP_CLOSE
1453#define SFTP_READ SSH_FXP_READ
1454#define SFTP_WRITE SSH_FXP_WRITE
1455#define SFTP_LSTAT SSH_FXP_LSTAT
1456#define SFTP_FSTAT SSH_FXP_FSTAT
1457#define SFTP_SETSTAT SSH_FXP_SETSTAT
1458#define SFTP_FSETSTAT SSH_FXP_FSETSTAT
1459#define SFTP_OPENDIR SSH_FXP_OPENDIR
1460#define SFTP_READDIR SSH_FXP_READDIR
1461#define SFTP_REMOVE SSH_FXP_REMOVE
1462#define SFTP_MKDIR SSH_FXP_MKDIR
1463#define SFTP_RMDIR SSH_FXP_RMDIR
1464#define SFTP_REALPATH SSH_FXP_REALPATH
1465#define SFTP_STAT SSH_FXP_STAT
1466#define SFTP_RENAME SSH_FXP_RENAME
1467#define SFTP_READLINK SSH_FXP_READLINK
1468#define SFTP_SYMLINK SSH_FXP_SYMLINK
1469#define SFTP_EXTENDED SSH_FXP_EXTENDED
1470
1471/* openssh flags */
1472#define SSH_FXE_STATVFS_ST_RDONLY 0x1 /* read-only */
1473#define SSH_FXE_STATVFS_ST_NOSUID 0x2 /* no setuid */
1474
1475#ifdef __cplusplus
1476}
1477#endif
1478
1479#endif /* SFTP_H */
1480
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:3033
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:1149
sftp_mkdir
LIBSSH_API int sftp_mkdir(sftp_session sftp, const char *directory, mode_t mode)
Create a directory.
Definition sftp.c:1699
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:1799
sftp_reply_data
LIBSSH_API int sftp_reply_data(sftp_client_message msg, const void *data, int len)
Send an SFTP DATA reply.
Definition sftpserver.c:739
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:595
sftp_statvfs_free
LIBSSH_API void sftp_statvfs_free(sftp_statvfs_t statvfs_o)
Free the memory of an allocated statvfs.
Definition sftp.c:2675
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:2105
sftp_reply_status
LIBSSH_API int sftp_reply_status(sftp_client_message msg, uint32_t status, const char *message)
Send an SFTP STATUS reply.
Definition sftpserver.c:692
sftp_reply_handle
LIBSSH_API int sftp_reply_handle(sftp_client_message msg, ssh_string handle)
Send an SFTP HANDLE reply for a client message.
Definition sftpserver.c:523
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:787
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:1530
sftp_reply_names_add
LIBSSH_API int sftp_reply_names_add(sftp_client_message msg, const char *file, const char *longname, sftp_attributes attr)
Add one name entry to a multi-name SFTP reply.
Definition sftpserver.c:596
sftp_closedir
LIBSSH_API int sftp_closedir(sftp_dir dir)
Close a directory handle opened by sftp_opendir().
Definition sftp.c:1008
sftp_client_message_get_filename
LIBSSH_API const char * sftp_client_message_get_filename(sftp_client_message msg)
Get the filename associated with an SFTP client message.
Definition sftpserver.c:363
sftp_close
LIBSSH_API int sftp_close(sftp_file file)
Close an open file handle.
Definition sftp.c:989
sftp_client_message_get_submessage
LIBSSH_API const char * sftp_client_message_get_submessage(sftp_client_message msg)
Get the submessage name associated with an SFTP client message.
Definition sftpserver.c:429
sftp_name_id_map_new
LIBSSH_API sftp_name_id_map sftp_name_id_map_new(uint32_t count)
Create a new sftp_name_id_map struct.
Definition sftp.c:3317
sftp_send_client_message
LIBSSH_API int sftp_send_client_message(sftp_session sftp, sftp_client_message msg)
Send an SFTP client message.
Definition sftpserver.c:332
sftp_client_message_get_data
LIBSSH_API const char * sftp_client_message_get_data(sftp_client_message msg)
Get the data field of an SFTP client message as a string.
Definition sftpserver.c:395
sftp_reply_name
LIBSSH_API int sftp_reply_name(sftp_client_message msg, const char *name, sftp_attributes attr)
Send an SFTP NAME reply for a client message.
Definition sftpserver.c:476
sftp_expand_path
LIBSSH_API char * sftp_expand_path(sftp_session sftp, const char *path)
Canonicalize path using expand-path@openssh.com extension.
Definition sftp.c:3102
sftp_server_init
SSH_DEPRECATED LIBSSH_API int sftp_server_init(sftp_session sftp)
Initialize the sftp server.
Definition sftp.c:277
sftp_aio_wait_read
LIBSSH_API ssize_t sftp_aio_wait_read(sftp_aio *aio, void *buf, size_t buf_size)
Wait for an asynchronous read to complete and store the read data in the supplied buffer.
Definition sftp_aio.c:139
sftp_server_free
LIBSSH_API void sftp_server_free(sftp_session sftp)
Close and deallocate a sftp server session.
Definition sftp.c:310
sftp_aio_wait_write
LIBSSH_API ssize_t sftp_aio_wait_write(sftp_aio *aio)
Wait for an asynchronous write to complete.
Definition sftp_aio.c:404
sftp_session
struct sftp_session_struct * sftp_session
SFTP session handle.
Definition sftp.h:92
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:586
sftp_aio_free
LIBSSH_API void sftp_aio_free(sftp_aio aio)
Deallocate memory corresponding to a sftp aio handle.
Definition sftp_aio.c:48
sftp_get_error
LIBSSH_API int sftp_get_error(sftp_session sftp)
Get the last sftp error.
Definition sftp.c:427
sftp_tell
LIBSSH_API unsigned long sftp_tell(sftp_file file)
Report current byte position in file.
Definition sftp.c:1543
sftp_client_message_get_flags
LIBSSH_API uint32_t sftp_client_message_get_flags(sftp_client_message msg)
Get the flags associated with an SFTP client message.
Definition sftpserver.c:413
sftp_reply_names
LIBSSH_API int sftp_reply_names(sftp_client_message msg)
Send a multi-name SFTP reply.
Definition sftpserver.c:646
sftp_unlink
LIBSSH_API int sftp_unlink(sftp_session sftp, const char *file)
Unlink (delete) a file.
Definition sftp.c:1558
sftp_lstat
LIBSSH_API sftp_attributes sftp_lstat(sftp_session session, const char *path)
Get information about a file or directory.
Definition sftp.c:3029
sftp_client_message_free
LIBSSH_API void sftp_client_message_free(sftp_client_message msg)
Free an SFTP client message and its associated resources.
Definition sftpserver.c:444
sftp_async_read
SSH_DEPRECATED 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:1330
sftp_fstatvfs
LIBSSH_API sftp_statvfs_t sftp_fstatvfs(sftp_file file)
Get information about a mounted file system.
Definition sftp.c:2601
sftp_free
LIBSSH_API void sftp_free(sftp_session sftp)
Close and deallocate a sftp session.
Definition sftp.c:338
sftp_aio_begin_read
LIBSSH_API ssize_t sftp_aio_begin_read(sftp_file file, size_t len, sftp_aio *aio)
Start an asynchronous read from a file using an opened sftp file handle.
Definition sftp_aio.c:53
sftp_limits
LIBSSH_API sftp_limits_t sftp_limits(sftp_session sftp)
Get information about the various limits the server might impose.
Definition sftp.c:2827
sftp_lsetstat
LIBSSH_API int sftp_lsetstat(sftp_session sftp, const char *file, sftp_attributes attr)
This request is like setstat (excluding mode and size) but sets file attributes on symlinks themselve...
Definition sftp.c:1995
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:1517
sftp_get_client_message
LIBSSH_API sftp_client_message sftp_get_client_message(sftp_session sftp)
Reads the next SFTP client message from the session.
Definition sftpserver.c:291
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:239
sftp_attributes_free
LIBSSH_API void sftp_attributes_free(sftp_attributes file)
Free a sftp attribute structure.
Definition sftp.c:902
sftp_limits_free
LIBSSH_API void sftp_limits_free(sftp_limits_t limits)
Free the memory of an allocated limits.
Definition sftp.c:2854
sftp_stat
LIBSSH_API sftp_attributes sftp_stat(sftp_session session, const char *path)
Get information about a file or directory.
Definition sftp.c:3025
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:614
sftp_tell64
LIBSSH_API uint64_t sftp_tell64(sftp_file file)
Report current byte position in file.
Definition sftp.c:1547
sftp_handle
LIBSSH_API void * sftp_handle(sftp_session sftp, ssh_string handle)
Resolve an SFTP handle to its stored info.
Definition sftpserver.c:915
sftp_home_directory
LIBSSH_API char * sftp_home_directory(sftp_session sftp, const char *username)
Get the specified user's home directory.
Definition sftp.c:3194
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:2082
sftp_readlink
LIBSSH_API char * sftp_readlink(sftp_session sftp, const char *path)
Read the value of a symbolic link.
Definition sftp.c:2215
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:634
sftp_async_read_begin
SSH_DEPRECATED 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:1294
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:186
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:1024
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:1153
sftp_rmdir
LIBSSH_API int sftp_rmdir(sftp_session sftp, const char *directory)
Remove a directory.
Definition sftp.c:1631
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:1552
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:897
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:692
sftp_reply_attr
LIBSSH_API int sftp_reply_attr(sftp_client_message msg, sftp_attributes attr)
Send an SFTP ATTRS reply for a client message.
Definition sftpserver.c:559
sftp_init
LIBSSH_API int sftp_init(sftp_session sftp)
Initialize the sftp protocol with the server.
Definition sftp.c:439
sftp_handle_alloc
LIBSSH_API ssh_string sftp_handle_alloc(sftp_session sftp, void *info)
Allocate a new SFTP handle slot.
Definition sftpserver.c:867
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:1160
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:782
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:1910
sftp_get_users_groups_by_id
LIBSSH_API int sftp_get_users_groups_by_id(sftp_session sftp, sftp_name_id_map users_map, sftp_name_id_map groups_map)
Retrieves usernames and group names based on provided user and group IDs.
Definition sftp.c:3411
sftp_canonicalize_path
LIBSSH_API char * sftp_canonicalize_path(sftp_session sftp, const char *path)
Canonicalize a sftp path.
Definition sftp.c:2864
sftp_client_message_set_filename
LIBSSH_API void sftp_client_message_set_filename(sftp_client_message msg, const char *newname)
Set the filename associated with an SFTP client message.
Definition sftpserver.c:378
sftp_symlink
LIBSSH_API int sftp_symlink(sftp_session sftp, const char *target, const char *dest)
Create a symbolic link.
Definition sftp.c:2122
sftp_aio_begin_write
LIBSSH_API ssize_t sftp_aio_begin_write(sftp_file file, const void *buf, size_t len, sftp_aio *aio)
Start an asynchronous write to a file using an opened sftp file handle.
Definition sftp_aio.c:306
sftp_new
LIBSSH_API sftp_session sftp_new(ssh_session session)
Creates a new sftp session.
Definition sftp.c:103
sftp_chmod
LIBSSH_API int sftp_chmod(sftp_session sftp, const char *file, mode_t mode)
Change permissions of a file.
Definition sftp.c:2095
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:2426
sftp_fsync
LIBSSH_API int sftp_fsync(sftp_file file)
Synchronize a file's in-core state with storage device.
Definition sftp.c:2507
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:1412
sftp_name_id_map_free
LIBSSH_API void sftp_name_id_map_free(sftp_name_id_map map)
Free the memory of an allocated sftp_name_id_map struct.
Definition sftp.c:3344
sftp_hardlink
LIBSSH_API int sftp_hardlink(sftp_session sftp, const char *oldpath, const char *newpath)
Create a hard link.
Definition sftp.c:2306
sftp_client_message_get_type
LIBSSH_API uint8_t sftp_client_message_get_type(sftp_client_message msg)
Get the SFTP client message type.
Definition sftpserver.c:347
sftp_aio_struct
Definition sftp_aio.c:35
sftp_limits_struct
SFTP limits structure.
Definition sftp.h:225
sftp_limits_struct::max_write_length
uint64_t max_write_length
Definition sftp.h:228
sftp_limits_struct::max_open_handles
uint64_t max_open_handles
Definition sftp.h:229
sftp_limits_struct::max_read_length
uint64_t max_read_length
Definition sftp.h:227
sftp_name_id_map_struct
SFTP names map structure to store the mapping between ids and names.
Definition sftp.h:237
sftp_name_id_map_struct::ids
uint32_t * ids
Array of ids, ids[i] mapped to names[i].
Definition sftp.h:242
sftp_name_id_map_struct::names
char ** names
Array of names, names[i] mapped to ids[i].
Definition sftp.h:245
sftp_name_id_map_struct::count
uint32_t count
Count of name-id pairs in the map.
Definition sftp.h:239
sftp_statvfs_struct
SFTP statvfs structure.
Definition sftp.h:208
sftp_statvfs_struct::f_blocks
uint64_t f_blocks
Definition sftp.h:211
sftp_statvfs_struct::f_ffree
uint64_t f_ffree
Definition sftp.h:215
sftp_statvfs_struct::f_files
uint64_t f_files
Definition sftp.h:214
sftp_statvfs_struct::f_bavail
uint64_t f_bavail
Definition sftp.h:213
sftp_statvfs_struct::f_namemax
uint64_t f_namemax
Definition sftp.h:219
sftp_statvfs_struct::f_bfree
uint64_t f_bfree
Definition sftp.h:212
sftp_statvfs_struct::f_favail
uint64_t f_favail
Definition sftp.h:216
sftp_statvfs_struct::f_flag
uint64_t f_flag
Definition sftp.h:218
sftp_statvfs_struct::f_frsize
uint64_t f_frsize
Definition sftp.h:210
sftp_statvfs_struct::f_fsid
uint64_t f_fsid
Definition sftp.h:217