2 Unix SMB/Netbios implementation.
3 SMB client library implementation
4 Copyright (C) Andrew Tridgell 1998
5 Copyright (C) Richard Sharpe 2000, 2002
6 Copyright (C) John Terpstra 2000
7 Copyright (C) Tom Jansen (Ninja ISD) 2002
8 Copyright (C) Derrell Lipman 2003-2008
9 Copyright (C) Jeremy Allison 2007, 2008
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #ifndef _LIBSMB_INTERNAL_H_
29 #define _LIBSMB_INTERNAL_H_
31 #include "../include/libsmbclient.h"
32 #include "libsmb/clirap.h"
34 #define SMBC_MAX_NAME 1023
35 #define SMBC_FILE_MODE (S_IFREG | 0444)
36 #define SMBC_DIR_MODE (S_IFDIR | 0555)
39 * DOS Attribute values (used internally)
41 struct DOS_ATTR_DESC {
52 * Extension of libsmbclient.h's #defines
54 #define SMB_CTX_FLAG_USE_NT_HASH (1 << 4)
57 * Internal flags for extended attributes
60 /* internal mode values */
61 #define SMBC_XATTR_MODE_ADD 1
62 #define SMBC_XATTR_MODE_REMOVE 2
63 #define SMBC_XATTR_MODE_REMOVE_ALL 3
64 #define SMBC_XATTR_MODE_SET 4
65 #define SMBC_XATTR_MODE_CHOWN 5
66 #define SMBC_XATTR_MODE_CHGRP 6
68 /*We should test for this in configure ... */
70 #define ENOTSUP EOPNOTSUPP
75 struct cli_state *cli;
81 struct policy_handle pol;
82 time_t last_echo_time;
88 * Keep directory entries in a list
90 struct smbc_dir_list {
91 struct smbc_dir_list *next;
92 struct smbc_dirent *dirent;
95 struct smbc_dirplus_list {
96 struct smbc_dirplus_list *next;
97 struct libsmb_file_info *smb_finfo;
102 * Structure for open file management
107 * cache of cli_state we opened cli_fd on.
108 * Due to DFS can be a subsidiary connection to srv->cli
110 struct cli_state *targetcli;
113 struct _SMBCSRV *srv;
115 struct smbc_dir_list *dir_list, *dir_end, *dir_next;
116 struct smbc_dirplus_list *dirplus_list, *dirplus_end, *dirplus_next;
117 int dir_type, dir_error;
119 SMBCFILE *next, *prev;
126 struct SMBC_internal_data {
128 /* True when this handle is initialized */
131 /* dirent pointer location */
132 struct smbc_dirent dirent;
134 * Leave room for any urlencoded filename and the comment field.
136 * We use (NAME_MAX * 3) plus whatever the max length of a comment is,
137 * plus a couple of null terminators (one after the filename,
138 * one after the comment).
140 * According to <linux/limits.h>, NAME_MAX is 255. Is it longer
143 char _dirent_name[1024];
146 * server connection list
156 * Support "Create Time" in get/set with the *xattr() functions, if
157 * true. This replaces the dos attribute strings C_TIME, A_TIME and
158 * M_TIME with CHANGE_TIME, ACCESS_TIME and WRITE_TIME, and adds
159 * CREATE_TIME. Default is FALSE, i.e. to use the old-style shorter
160 * names and to not support CREATE time, for backward compatibility.
162 bool full_time_names;
165 * The share mode of a file being opened. To match POSIX semantics
166 * (and maintain backward compatibility), DENY_NONE is the default.
168 smbc_share_mode share_mode;
171 * Authentication function which includes the context. This will be
172 * used if set; otherwise context->callbacks.auth_fn() will be used.
174 smbc_get_auth_data_with_context_fn auth_fn_with_context;
177 * An opaque (to this library) user data handle which can be set
178 * and retrieved with smbc_option_set() and smbc_option_get().
183 * Should we attempt UNIX smb encryption ?
184 * Set to 0 if we should never attempt, set to 1 if
185 * encryption requested, set to 2 if encryption required.
187 smbc_smb_encrypt_level smb_encryption_level;
190 * Should we request case sensitivity of file names?
195 * Auth info needed for DFS traversal.
198 struct user_auth_info *auth_info;
200 struct smbc_server_cache * server_cache;
202 /* POSIX emulation functions */
205 #if 0 /* Left in libsmbclient.h for backward compatibility */
206 smbc_open_fn open_fn;
207 smbc_creat_fn creat_fn;
208 smbc_read_fn read_fn;
209 smbc_write_fn write_fn;
210 smbc_unlink_fn unlink_fn;
211 smbc_rename_fn rename_fn;
212 smbc_lseek_fn lseek_fn;
213 smbc_stat_fn stat_fn;
214 smbc_fstat_fn fstat_fn;
216 smbc_statvfs_fn statvfs_fn;
217 smbc_fstatvfs_fn fstatvfs_fn;
218 smbc_ftruncate_fn ftruncate_fn;
219 #if 0 /* Left in libsmbclient.h for backward compatibility */
220 smbc_close_fn close_fn;
221 smbc_opendir_fn opendir_fn;
222 smbc_closedir_fn closedir_fn;
223 smbc_readdir_fn readdir_fn;
224 smbc_getdents_fn getdents_fn;
225 smbc_mkdir_fn mkdir_fn;
226 smbc_rmdir_fn rmdir_fn;
227 smbc_telldir_fn telldir_fn;
228 smbc_lseekdir_fn lseekdir_fn;
229 smbc_fstatdir_fn fstatdir_fn;
230 smbc_chmod_fn chmod_fn;
231 smbc_utimes_fn utimes_fn;
232 smbc_setxattr_fn setxattr_fn;
233 smbc_getxattr_fn getxattr_fn;
234 smbc_removexattr_fn removexattr_fn;
235 smbc_listxattr_fn listxattr_fn;
239 #if 0 /* Left in libsmbclient.h for backward compatibility */
240 /* Printing-related functions */
243 smbc_print_file_fn print_file_fn;
244 smbc_open_print_job_fn open_print_job_fn;
245 smbc_list_print_jobs_fn list_print_jobs_fn;
246 smbc_unlink_print_job_fn unlink_print_job_fn;
250 /* SMB high-level functions */
253 smbc_splice_fn splice_fn;
254 smbc_notify_fn notify_fn;
260 /* Functions in libsmb_cache.c */
262 SMBC_add_cached_server(SMBCCTX * context,
266 const char * workgroup,
267 const char * username);
270 SMBC_get_cached_server(SMBCCTX * context,
273 const char * workgroup,
277 SMBC_remove_cached_server(SMBCCTX * context,
281 SMBC_purge_cached_servers(SMBCCTX * context);
284 /* Functions in libsmb_dir.c */
286 SMBC_check_options(char *server,
292 SMBC_opendir_ctx(SMBCCTX *context,
296 SMBC_closedir_ctx(SMBCCTX *context,
300 SMBC_readdir_ctx(SMBCCTX *context,
303 const struct libsmb_file_info *
304 SMBC_readdirplus_ctx(SMBCCTX *context,
307 const struct libsmb_file_info *
308 SMBC_readdirplus2_ctx(SMBCCTX *context,
313 SMBC_getdents_ctx(SMBCCTX *context,
315 struct smbc_dirent *dirp,
319 SMBC_mkdir_ctx(SMBCCTX *context,
324 SMBC_rmdir_ctx(SMBCCTX *context,
328 SMBC_telldir_ctx(SMBCCTX *context,
332 SMBC_lseekdir_ctx(SMBCCTX *context,
337 SMBC_fstatdir_ctx(SMBCCTX *context,
342 SMBC_chmod_ctx(SMBCCTX *context,
347 SMBC_utimes_ctx(SMBCCTX *context,
349 struct timeval *tbuf);
352 SMBC_unlink_ctx(SMBCCTX *context,
356 SMBC_rename_ctx(SMBCCTX *ocontext,
362 SMBC_notify_ctx(SMBCCTX *c, SMBCFILE *dir, smbc_bool recursive,
363 uint32_t completion_filter, unsigned callback_timeout_ms,
364 smbc_notify_callback_fn cb, void *private_data);
368 /* Functions in libsmb_file.c */
370 SMBC_open_ctx(SMBCCTX *context,
376 SMBC_creat_ctx(SMBCCTX *context,
381 SMBC_read_ctx(SMBCCTX *context,
387 SMBC_write_ctx(SMBCCTX *context,
393 SMBC_splice_ctx(SMBCCTX *context,
397 int (*splice_cb)(off_t n, void *priv),
401 SMBC_close_ctx(SMBCCTX *context,
405 SMBC_getatr(SMBCCTX * context,
411 SMBC_setatr(SMBCCTX * context, SMBCSRV *srv, char *path,
412 struct timespec create_time,
413 struct timespec access_time,
414 struct timespec write_time,
415 struct timespec change_time,
419 SMBC_lseek_ctx(SMBCCTX *context,
425 SMBC_ftruncate_ctx(SMBCCTX *context,
430 /* Functions in libsmb_misc.c */
431 bool SMBC_dlist_contains(SMBCFILE * list, SMBCFILE *p);
434 SMBC_errno(SMBCCTX *context,
435 struct cli_state *c);
438 /* Functions in libsmb_path.c */
440 SMBC_parse_path(TALLOC_CTX *ctx,
453 /* Functions in libsmb_printjob.c */
455 SMBC_open_print_job_ctx(SMBCCTX *context,
459 SMBC_print_file_ctx(SMBCCTX *c_file,
465 SMBC_list_print_jobs_ctx(SMBCCTX *context,
467 smbc_list_print_job_fn fn);
470 SMBC_unlink_print_job_ctx(SMBCCTX *context,
475 /* Functions in libsmb_server.c */
477 SMBC_check_server(SMBCCTX * context,
481 SMBC_remove_unused_server(SMBCCTX * context,
485 SMBC_get_auth_data(const char *server, const char *share,
486 char *workgroup_buf, int workgroup_buf_len,
487 char *username_buf, int username_buf_len,
488 char *password_buf, int password_buf_len);
491 SMBC_find_server(TALLOC_CTX *ctx,
500 SMBC_server(TALLOC_CTX *ctx,
502 bool connect_if_not_found,
511 SMBC_attr_server(TALLOC_CTX *ctx,
521 /* Functions in libsmb_stat.c */
522 void setup_stat(struct stat *st,
528 struct timespec access_time_ts,
529 struct timespec change_time_ts,
530 struct timespec write_time_ts);
531 void setup_stat_from_stat_ex(const struct stat_ex *stex,
536 SMBC_stat_ctx(SMBCCTX *context,
541 SMBC_fstat_ctx(SMBCCTX *context,
547 SMBC_statvfs_ctx(SMBCCTX *context,
553 SMBC_fstatvfs_ctx(SMBCCTX *context,
558 /* Functions in libsmb_xattr.c */
560 SMBC_setxattr_ctx(SMBCCTX *context,
568 SMBC_getxattr_ctx(SMBCCTX *context,
575 SMBC_removexattr_ctx(SMBCCTX *context,
580 SMBC_listxattr_ctx(SMBCCTX *context,