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"
33 #define SMBC_MAX_NAME 1023
34 #define SMBC_FILE_MODE (S_IFREG | 0444)
35 #define SMBC_DIR_MODE (S_IFDIR | 0555)
38 * DOS Attribute values (used internally)
40 typedef struct DOS_ATTR_DESC {
52 * Internal flags for extended attributes
55 /* internal mode values */
56 #define SMBC_XATTR_MODE_ADD 1
57 #define SMBC_XATTR_MODE_REMOVE 2
58 #define SMBC_XATTR_MODE_REMOVE_ALL 3
59 #define SMBC_XATTR_MODE_SET 4
60 #define SMBC_XATTR_MODE_CHOWN 5
61 #define SMBC_XATTR_MODE_CHGRP 6
63 #define CREATE_ACCESS_READ READ_CONTROL_ACCESS
65 /*We should test for this in configure ... */
67 #define ENOTSUP EOPNOTSUPP
72 struct cli_state *cli;
84 * Keep directory entries in a list
86 struct smbc_dir_list {
87 struct smbc_dir_list *next;
88 struct smbc_dirent *dirent;
93 * Structure for open file management
101 struct smbc_dir_list *dir_list, *dir_end, *dir_next;
102 int dir_type, dir_error;
104 SMBCFILE *next, *prev;
111 struct SMBC_internal_data {
113 /* True when this handle is initialized */
116 /* dirent pointer location
118 * Leave room for any urlencoded filename and the comment field.
120 * We really should use sizeof(struct smbc_dirent) plus (NAME_MAX * 3)
121 * plus whatever the max length of a comment is, plus a couple of null
122 * terminators (one after the filename, one after the comment).
124 * According to <linux/limits.h>, NAME_MAX is 255. Is it longer
130 * server connection list
140 * Log to standard error instead of the more typical standard output
145 * Support "Create Time" in get/set with the *xattr() functions, if
146 * true. This replaces the dos attribute strings C_TIME, A_TIME and
147 * M_TIME with CHANGE_TIME, ACCESS_TIME and WRITE_TIME, and adds
148 * CREATE_TIME. Default is FALSE, i.e. to use the old-style shorter
149 * names and to not support CREATE time, for backward compatibility.
151 bool full_time_names;
154 * The share mode of a file being opened. To match POSIX semantics
155 * (and maintain backward compatibility), DENY_NONE is the default.
157 smbc_share_mode share_mode;
160 * Authentication function which includes the context. This will be
161 * used if set; otherwise context->callbacks.auth_fn() will be used.
163 smbc_get_auth_data_with_context_fn auth_fn_with_context;
166 * An opaque (to this library) user data handle which can be set
167 * and retrieved with smbc_option_set() and smbc_option_get().
172 * Should we attempt UNIX smb encryption ?
173 * Set to 0 if we should never attempt, set to 1 if
174 * encryption requested, set to 2 if encryption required.
176 smbc_smb_encrypt_level smb_encryption_level;
178 struct smbc_server_cache * server_cache;
180 /* POSIX emulation functions */
183 #if 0 /* Left in libsmbclient.h for backward compatibility */
184 smbc_open_fn open_fn;
185 smbc_creat_fn creat_fn;
186 smbc_read_fn read_fn;
187 smbc_write_fn write_fn;
188 smbc_unlink_fn unlink_fn;
189 smbc_rename_fn rename_fn;
190 smbc_lseek_fn lseek_fn;
191 smbc_stat_fn stat_fn;
192 smbc_fstat_fn fstat_fn;
194 smbc_ftruncate_fn ftruncate_fn;
195 #if 0 /* Left in libsmbclient.h for backward compatibility */
196 smbc_close_fn close_fn;
197 smbc_opendir_fn opendir_fn;
198 smbc_closedir_fn closedir_fn;
199 smbc_readdir_fn readdir_fn;
200 smbc_getdents_fn getdents_fn;
201 smbc_mkdir_fn mkdir_fn;
202 smbc_rmdir_fn rmdir_fn;
203 smbc_telldir_fn telldir_fn;
204 smbc_lseekdir_fn lseekdir_fn;
205 smbc_fstatdir_fn fstatdir_fn;
206 smbc_chmod_fn chmod_fn;
207 smbc_utimes_fn utimes_fn;
208 smbc_setxattr_fn setxattr_fn;
209 smbc_getxattr_fn getxattr_fn;
210 smbc_removexattr_fn removexattr_fn;
211 smbc_listxattr_fn listxattr_fn;
215 #if 0 /* Left in libsmbclient.h for backward compatibility */
216 /* Printing-related functions */
219 smbc_print_file_fn print_file_fn;
220 smbc_open_print_job_fn open_print_job_fn;
221 smbc_list_print_jobs_fn list_print_jobs_fn;
222 smbc_unlink_print_job_fn unlink_print_job_fn;
226 #if 0 /* None available yet */
227 /* SMB high-level functions */
235 /* Functions in libsmb_cache.c */
237 SMBC_add_cached_server(SMBCCTX * context,
241 const char * workgroup,
242 const char * username);
245 SMBC_get_cached_server(SMBCCTX * context,
248 const char * workgroup,
252 SMBC_remove_cached_server(SMBCCTX * context,
256 SMBC_purge_cached_servers(SMBCCTX * context);
259 /* Functions in libsmb_dir.c */
261 SMBC_check_options(char *server,
267 SMBC_opendir_ctx(SMBCCTX *context,
271 SMBC_closedir_ctx(SMBCCTX *context,
275 SMBC_readdir_ctx(SMBCCTX *context,
279 SMBC_getdents_ctx(SMBCCTX *context,
281 struct smbc_dirent *dirp,
285 SMBC_mkdir_ctx(SMBCCTX *context,
290 SMBC_rmdir_ctx(SMBCCTX *context,
294 SMBC_telldir_ctx(SMBCCTX *context,
298 SMBC_lseekdir_ctx(SMBCCTX *context,
303 SMBC_fstatdir_ctx(SMBCCTX *context,
308 SMBC_chmod_ctx(SMBCCTX *context,
313 SMBC_utimes_ctx(SMBCCTX *context,
315 struct timeval *tbuf);
318 SMBC_unlink_ctx(SMBCCTX *context,
322 SMBC_rename_ctx(SMBCCTX *ocontext,
328 /* Functions in libsmb_file.c */
330 SMBC_open_ctx(SMBCCTX *context,
336 SMBC_creat_ctx(SMBCCTX *context,
341 SMBC_read_ctx(SMBCCTX *context,
347 SMBC_write_ctx(SMBCCTX *context,
353 SMBC_close_ctx(SMBCCTX *context,
357 SMBC_getatr(SMBCCTX * context,
362 struct timespec *create_time_ts,
363 struct timespec *access_time_ts,
364 struct timespec *write_time_ts,
365 struct timespec *change_time_ts,
369 SMBC_setatr(SMBCCTX * context, SMBCSRV *srv, char *path,
377 SMBC_lseek_ctx(SMBCCTX *context,
383 SMBC_ftruncate_ctx(SMBCCTX *context,
388 /* Functions in libsmb_misc.c */
390 SMBC_dlist_contains(SMBCFILE * list, SMBCFILE *p);
393 SMBC_errno(SMBCCTX *context,
394 struct cli_state *c);
397 /* Functions in libsmb_path.c */
399 SMBC_urldecode(char *dest,
401 size_t max_dest_len);
404 SMBC_urlencode(char *dest,
409 SMBC_parse_path(TALLOC_CTX *ctx,
421 /* Functions in libsmb_printjob.c */
423 SMBC_open_print_job_ctx(SMBCCTX *context,
427 SMBC_print_file_ctx(SMBCCTX *c_file,
433 SMBC_list_print_jobs_ctx(SMBCCTX *context,
435 smbc_list_print_job_fn fn);
438 SMBC_unlink_print_job_ctx(SMBCCTX *context,
443 /* Functions in libsmb_server.c */
445 SMBC_check_server(SMBCCTX * context,
449 SMBC_remove_unused_server(SMBCCTX * context,
453 SMBC_call_auth_fn(TALLOC_CTX *ctx,
462 SMBC_get_auth_data(const char *server, const char *share,
463 char *workgroup_buf, int workgroup_buf_len,
464 char *username_buf, int username_buf_len,
465 char *password_buf, int password_buf_len);
468 SMBC_find_server(TALLOC_CTX *ctx,
477 SMBC_server(TALLOC_CTX *ctx,
479 bool connect_if_not_found,
487 SMBC_attr_server(TALLOC_CTX *ctx,
496 /* Functions in libsmb_stat.c */
498 SMBC_stat_ctx(SMBCCTX *context,
503 SMBC_fstat_ctx(SMBCCTX *context,
508 /* Functions in libsmb_xattr.c */
510 SMBC_setxattr_ctx(SMBCCTX *context,
518 SMBC_getxattr_ctx(SMBCCTX *context,
525 SMBC_removexattr_ctx(SMBCCTX *context,
530 SMBC_listxattr_ctx(SMBCCTX *context,