source: vendor/current/source3/include/libsmb_internal.h

Last change on this file was 988, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.3
File size: 15.1 KB
Line 
1/*
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
10
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.
15
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.
20
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/>.
23*/
24
25#include "includes.h"
26
27
28#ifndef _LIBSMB_INTERNAL_H_
29#define _LIBSMB_INTERNAL_H_
30
31#include "../include/libsmbclient.h"
32#include "libsmb/clirap.h"
33
34#define SMBC_MAX_NAME 1023
35#define SMBC_FILE_MODE (S_IFREG | 0444)
36#define SMBC_DIR_MODE (S_IFDIR | 0555)
37
38/*
39 * DOS Attribute values (used internally)
40 */
41typedef struct DOS_ATTR_DESC {
42 int mode;
43 off_t size;
44 time_t create_time;
45 time_t access_time;
46 time_t write_time;
47 time_t change_time;
48 SMB_INO_T inode;
49} DOS_ATTR_DESC;
50
51/*
52 * Extension of libsmbclient.h's #defines
53 */
54#define SMB_CTX_FLAG_USE_NT_HASH (1 << 4)
55
56/*
57 * Internal flags for extended attributes
58 */
59
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
67
68#define CREATE_ACCESS_READ READ_CONTROL_ACCESS
69
70/*We should test for this in configure ... */
71#ifndef ENOTSUP
72#define ENOTSUP EOPNOTSUPP
73#endif
74
75
76struct _SMBCSRV {
77 struct cli_state *cli;
78 dev_t dev;
79 bool no_pathinfo;
80 bool no_pathinfo2;
81 bool no_pathinfo3;
82 bool no_nt_session;
83 struct policy_handle pol;
84 time_t last_echo_time;
85
86 SMBCSRV *next, *prev;
87};
88
89/*
90 * Keep directory entries in a list
91 */
92struct smbc_dir_list {
93 struct smbc_dir_list *next;
94 struct smbc_dirent *dirent;
95};
96
97
98/*
99 * Structure for open file management
100 */
101struct _SMBCFILE {
102 int cli_fd;
103 /*
104 * cache of cli_state we opened cli_fd on.
105 * Due to DFS can be a subsidiary connection to srv->cli
106 */
107 struct cli_state *targetcli;
108 char *fname;
109 off_t offset;
110 struct _SMBCSRV *srv;
111 bool file;
112 struct smbc_dir_list *dir_list, *dir_end, *dir_next;
113 int dir_type, dir_error;
114
115 SMBCFILE *next, *prev;
116};
117
118
119/*
120 * Context structure
121 */
122struct SMBC_internal_data {
123
124 /* True when this handle is initialized */
125 bool initialized;
126
127 /* dirent pointer location */
128 struct smbc_dirent dirent;
129 /*
130 * Leave room for any urlencoded filename and the comment field.
131 *
132 * We use (NAME_MAX * 3) plus whatever the max length of a comment is,
133 * plus a couple of null terminators (one after the filename,
134 * one after the comment).
135 *
136 * According to <linux/limits.h>, NAME_MAX is 255. Is it longer
137 * anyplace else?
138 */
139 char _dirent_name[1024];
140
141 /*
142 * server connection list
143 */
144 SMBCSRV * servers;
145
146 /*
147 * open file/dir list
148 */
149 SMBCFILE * files;
150
151 /*
152 * Support "Create Time" in get/set with the *xattr() functions, if
153 * true. This replaces the dos attribute strings C_TIME, A_TIME and
154 * M_TIME with CHANGE_TIME, ACCESS_TIME and WRITE_TIME, and adds
155 * CREATE_TIME. Default is FALSE, i.e. to use the old-style shorter
156 * names and to not support CREATE time, for backward compatibility.
157 */
158 bool full_time_names;
159
160 /*
161 * The share mode of a file being opened. To match POSIX semantics
162 * (and maintain backward compatibility), DENY_NONE is the default.
163 */
164 smbc_share_mode share_mode;
165
166 /*
167 * Authentication function which includes the context. This will be
168 * used if set; otherwise context->callbacks.auth_fn() will be used.
169 */
170 smbc_get_auth_data_with_context_fn auth_fn_with_context;
171
172 /*
173 * An opaque (to this library) user data handle which can be set
174 * and retrieved with smbc_option_set() and smbc_option_get().
175 */
176 void * user_data;
177
178 /*
179 * Should we attempt UNIX smb encryption ?
180 * Set to 0 if we should never attempt, set to 1 if
181 * encryption requested, set to 2 if encryption required.
182 */
183 smbc_smb_encrypt_level smb_encryption_level;
184
185 /*
186 * Should we request case sensitivity of file names?
187 */
188 bool case_sensitive;
189
190 /*
191 * Auth info needed for DFS traversal.
192 */
193
194 struct user_auth_info *auth_info;
195
196 struct smbc_server_cache * server_cache;
197
198 /* POSIX emulation functions */
199 struct
200 {
201#if 0 /* Left in libsmbclient.h for backward compatibility */
202 smbc_open_fn open_fn;
203 smbc_creat_fn creat_fn;
204 smbc_read_fn read_fn;
205 smbc_write_fn write_fn;
206 smbc_unlink_fn unlink_fn;
207 smbc_rename_fn rename_fn;
208 smbc_lseek_fn lseek_fn;
209 smbc_stat_fn stat_fn;
210 smbc_fstat_fn fstat_fn;
211#endif
212 smbc_statvfs_fn statvfs_fn;
213 smbc_fstatvfs_fn fstatvfs_fn;
214 smbc_ftruncate_fn ftruncate_fn;
215#if 0 /* Left in libsmbclient.h for backward compatibility */
216 smbc_close_fn close_fn;
217 smbc_opendir_fn opendir_fn;
218 smbc_closedir_fn closedir_fn;
219 smbc_readdir_fn readdir_fn;
220 smbc_getdents_fn getdents_fn;
221 smbc_mkdir_fn mkdir_fn;
222 smbc_rmdir_fn rmdir_fn;
223 smbc_telldir_fn telldir_fn;
224 smbc_lseekdir_fn lseekdir_fn;
225 smbc_fstatdir_fn fstatdir_fn;
226 smbc_chmod_fn chmod_fn;
227 smbc_utimes_fn utimes_fn;
228 smbc_setxattr_fn setxattr_fn;
229 smbc_getxattr_fn getxattr_fn;
230 smbc_removexattr_fn removexattr_fn;
231 smbc_listxattr_fn listxattr_fn;
232#endif
233 } posix_emu;
234
235#if 0 /* Left in libsmbclient.h for backward compatibility */
236 /* Printing-related functions */
237 struct
238 {
239 smbc_print_file_fn print_file_fn;
240 smbc_open_print_job_fn open_print_job_fn;
241 smbc_list_print_jobs_fn list_print_jobs_fn;
242 smbc_unlink_print_job_fn unlink_print_job_fn;
243 } printing;
244#endif
245
246 /* SMB high-level functions */
247 struct
248 {
249 smbc_splice_fn splice_fn;
250 smbc_notify_fn notify_fn;
251 } smb;
252
253 uint16_t port;
254};
255
256/* Functions in libsmb_cache.c */
257int
258SMBC_add_cached_server(SMBCCTX * context,
259 SMBCSRV * newsrv,
260 const char * server,
261 const char * share,
262 const char * workgroup,
263 const char * username);
264
265SMBCSRV *
266SMBC_get_cached_server(SMBCCTX * context,
267 const char * server,
268 const char * share,
269 const char * workgroup,
270 const char * user);
271
272int
273SMBC_remove_cached_server(SMBCCTX * context,
274 SMBCSRV * server);
275
276int
277SMBC_purge_cached_servers(SMBCCTX * context);
278
279
280/* Functions in libsmb_dir.c */
281int
282SMBC_check_options(char *server,
283 char *share,
284 char *path,
285 char *options);
286
287SMBCFILE *
288SMBC_opendir_ctx(SMBCCTX *context,
289 const char *fname);
290
291int
292SMBC_closedir_ctx(SMBCCTX *context,
293 SMBCFILE *dir);
294
295struct smbc_dirent *
296SMBC_readdir_ctx(SMBCCTX *context,
297 SMBCFILE *dir);
298
299int
300SMBC_getdents_ctx(SMBCCTX *context,
301 SMBCFILE *dir,
302 struct smbc_dirent *dirp,
303 int count);
304
305int
306SMBC_mkdir_ctx(SMBCCTX *context,
307 const char *fname,
308 mode_t mode);
309
310int
311SMBC_rmdir_ctx(SMBCCTX *context,
312 const char *fname);
313
314off_t
315SMBC_telldir_ctx(SMBCCTX *context,
316 SMBCFILE *dir);
317
318int
319SMBC_lseekdir_ctx(SMBCCTX *context,
320 SMBCFILE *dir,
321 off_t offset);
322
323int
324SMBC_fstatdir_ctx(SMBCCTX *context,
325 SMBCFILE *dir,
326 struct stat *st);
327
328int
329SMBC_chmod_ctx(SMBCCTX *context,
330 const char *fname,
331 mode_t newmode);
332
333int
334SMBC_utimes_ctx(SMBCCTX *context,
335 const char *fname,
336 struct timeval *tbuf);
337
338int
339SMBC_unlink_ctx(SMBCCTX *context,
340 const char *fname);
341
342int
343SMBC_rename_ctx(SMBCCTX *ocontext,
344 const char *oname,
345 SMBCCTX *ncontext,
346 const char *nname);
347
348int
349SMBC_notify_ctx(SMBCCTX *c, SMBCFILE *dir, smbc_bool recursive,
350 uint32_t completion_filter, unsigned callback_timeout_ms,
351 smbc_notify_callback_fn cb, void *private_data);
352
353
354
355/* Functions in libsmb_file.c */
356SMBCFILE *
357SMBC_open_ctx(SMBCCTX *context,
358 const char *fname,
359 int flags,
360 mode_t mode);
361
362SMBCFILE *
363SMBC_creat_ctx(SMBCCTX *context,
364 const char *path,
365 mode_t mode);
366
367ssize_t
368SMBC_read_ctx(SMBCCTX *context,
369 SMBCFILE *file,
370 void *buf,
371 size_t count);
372
373ssize_t
374SMBC_write_ctx(SMBCCTX *context,
375 SMBCFILE *file,
376 const void *buf,
377 size_t count);
378
379off_t
380SMBC_splice_ctx(SMBCCTX *context,
381 SMBCFILE *srcfile,
382 SMBCFILE *dstfile,
383 off_t count,
384 int (*splice_cb)(off_t n, void *priv),
385 void *priv);
386
387int
388SMBC_close_ctx(SMBCCTX *context,
389 SMBCFILE *file);
390
391bool
392SMBC_getatr(SMBCCTX * context,
393 SMBCSRV *srv,
394 const char *path,
395 uint16_t *mode,
396 off_t *size,
397 struct timespec *create_time_ts,
398 struct timespec *access_time_ts,
399 struct timespec *write_time_ts,
400 struct timespec *change_time_ts,
401 SMB_INO_T *ino);
402
403bool
404SMBC_setatr(SMBCCTX * context, SMBCSRV *srv, char *path,
405 time_t create_time,
406 time_t access_time,
407 time_t write_time,
408 time_t change_time,
409 uint16_t mode);
410
411off_t
412SMBC_lseek_ctx(SMBCCTX *context,
413 SMBCFILE *file,
414 off_t offset,
415 int whence);
416
417int
418SMBC_ftruncate_ctx(SMBCCTX *context,
419 SMBCFILE *file,
420 off_t length);
421
422
423/* Functions in libsmb_misc.c */
424int
425SMBC_dlist_contains(SMBCFILE * list, SMBCFILE *p);
426
427int
428SMBC_errno(SMBCCTX *context,
429 struct cli_state *c);
430
431
432/* Functions in libsmb_path.c */
433int
434SMBC_parse_path(TALLOC_CTX *ctx,
435 SMBCCTX *context,
436 const char *fname,
437 char **pp_workgroup,
438 char **pp_server,
439 uint16_t *p_port,
440 char **pp_share,
441 char **pp_path,
442 char **pp_user,
443 char **pp_password,
444 char **pp_options);
445
446
447/* Functions in libsmb_printjob.c */
448SMBCFILE *
449SMBC_open_print_job_ctx(SMBCCTX *context,
450 const char *fname);
451
452int
453SMBC_print_file_ctx(SMBCCTX *c_file,
454 const char *fname,
455 SMBCCTX *c_print,
456 const char *printq);
457
458int
459SMBC_list_print_jobs_ctx(SMBCCTX *context,
460 const char *fname,
461 smbc_list_print_job_fn fn);
462
463int
464SMBC_unlink_print_job_ctx(SMBCCTX *context,
465 const char *fname,
466 int id);
467
468
469/* Functions in libsmb_server.c */
470int
471SMBC_check_server(SMBCCTX * context,
472 SMBCSRV * server);
473
474int
475SMBC_remove_unused_server(SMBCCTX * context,
476 SMBCSRV * srv);
477
478void
479SMBC_get_auth_data(const char *server, const char *share,
480 char *workgroup_buf, int workgroup_buf_len,
481 char *username_buf, int username_buf_len,
482 char *password_buf, int password_buf_len);
483
484SMBCSRV *
485SMBC_find_server(TALLOC_CTX *ctx,
486 SMBCCTX *context,
487 const char *server,
488 const char *share,
489 char **pp_workgroup,
490 char **pp_username,
491 char **pp_password);
492
493SMBCSRV *
494SMBC_server(TALLOC_CTX *ctx,
495 SMBCCTX *context,
496 bool connect_if_not_found,
497 const char *server,
498 uint16_t port,
499 const char *share,
500 char **pp_workgroup,
501 char **pp_username,
502 char **pp_password);
503
504SMBCSRV *
505SMBC_attr_server(TALLOC_CTX *ctx,
506 SMBCCTX *context,
507 const char *server,
508 uint16_t port,
509 const char *share,
510 char **pp_workgroup,
511 char **pp_username,
512 char **pp_password);
513
514
515/* Functions in libsmb_stat.c */
516int
517SMBC_stat_ctx(SMBCCTX *context,
518 const char *fname,
519 struct stat *st);
520
521int
522SMBC_fstat_ctx(SMBCCTX *context,
523 SMBCFILE *file,
524 struct stat *st);
525
526
527int
528SMBC_statvfs_ctx(SMBCCTX *context,
529 char *path,
530 struct statvfs *st);
531
532
533int
534SMBC_fstatvfs_ctx(SMBCCTX *context,
535 SMBCFILE *file,
536 struct statvfs *st);
537
538
539/* Functions in libsmb_xattr.c */
540int
541SMBC_setxattr_ctx(SMBCCTX *context,
542 const char *fname,
543 const char *name,
544 const void *value,
545 size_t size,
546 int flags);
547
548int
549SMBC_getxattr_ctx(SMBCCTX *context,
550 const char *fname,
551 const char *name,
552 const void *value,
553 size_t size);
554
555int
556SMBC_removexattr_ctx(SMBCCTX *context,
557 const char *fname,
558 const char *name);
559
560int
561SMBC_listxattr_ctx(SMBCCTX *context,
562 const char *fname,
563 char *list,
564 size_t size);
565
566
567#endif
Note: See TracBrowser for help on using the repository browser.