s3/libsmb: Fix typo in error message.
[Samba.git] / source / include / libsmb_internal.h
bloba00547f34eb159c606d9d1a1c342dcc12768cc3a
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
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/>.
25 #include "includes.h"
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 {
41 int mode;
42 SMB_OFF_T size;
43 time_t create_time;
44 time_t access_time;
45 time_t write_time;
46 time_t change_time;
47 SMB_INO_T inode;
48 } 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 ... */
66 #ifndef ENOTSUP
67 #define ENOTSUP EOPNOTSUPP
68 #endif
71 struct _SMBCSRV {
72 struct cli_state *cli;
73 dev_t dev;
74 bool no_pathinfo;
75 bool no_pathinfo2;
76 bool no_nt_session;
77 POLICY_HND pol;
79 SMBCSRV *next, *prev;
83 /*
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
94 */
95 struct _SMBCFILE {
96 int cli_fd;
97 char *fname;
98 SMB_OFF_T offset;
99 struct _SMBCSRV *srv;
100 bool file;
101 struct smbc_dir_list *dir_list, *dir_end, *dir_next;
102 int dir_type, dir_error;
104 SMBCFILE *next, *prev;
109 * Context structure
111 struct SMBC_internal_data {
113 /* True when this handle is initialized */
114 bool initialized;
116 /* dirent pointer location */
117 struct smbc_dirent dirent;
119 * Leave room for any urlencoded filename and the comment field.
121 * We use (NAME_MAX * 3) plus whatever the max length of a comment is,
122 * plus a couple of null terminators (one after the filename,
123 * one after the comment).
125 * According to <linux/limits.h>, NAME_MAX is 255. Is it longer
126 * anyplace else?
128 char _dirent_name[1024];
131 * server connection list
133 SMBCSRV * servers;
136 * open file/dir list
138 SMBCFILE * files;
141 * Log to standard error instead of the more typical standard output
143 bool debug_stderr;
146 * Support "Create Time" in get/set with the *xattr() functions, if
147 * true. This replaces the dos attribute strings C_TIME, A_TIME and
148 * M_TIME with CHANGE_TIME, ACCESS_TIME and WRITE_TIME, and adds
149 * CREATE_TIME. Default is FALSE, i.e. to use the old-style shorter
150 * names and to not support CREATE time, for backward compatibility.
152 bool full_time_names;
155 * The share mode of a file being opened. To match POSIX semantics
156 * (and maintain backward compatibility), DENY_NONE is the default.
158 smbc_share_mode share_mode;
161 * Authentication function which includes the context. This will be
162 * used if set; otherwise context->callbacks.auth_fn() will be used.
164 smbc_get_auth_data_with_context_fn auth_fn_with_context;
167 * An opaque (to this library) user data handle which can be set
168 * and retrieved with smbc_option_set() and smbc_option_get().
170 void * user_data;
173 * Should we attempt UNIX smb encryption ?
174 * Set to 0 if we should never attempt, set to 1 if
175 * encryption requested, set to 2 if encryption required.
177 smbc_smb_encrypt_level smb_encryption_level;
180 * Should we request case sensitivity of file names?
182 bool case_sensitive;
184 struct smbc_server_cache * server_cache;
186 /* POSIX emulation functions */
187 struct
189 #if 0 /* Left in libsmbclient.h for backward compatibility */
190 smbc_open_fn open_fn;
191 smbc_creat_fn creat_fn;
192 smbc_read_fn read_fn;
193 smbc_write_fn write_fn;
194 smbc_unlink_fn unlink_fn;
195 smbc_rename_fn rename_fn;
196 smbc_lseek_fn lseek_fn;
197 smbc_stat_fn stat_fn;
198 smbc_fstat_fn fstat_fn;
199 #endif
200 smbc_ftruncate_fn ftruncate_fn;
201 #if 0 /* Left in libsmbclient.h for backward compatibility */
202 smbc_close_fn close_fn;
203 smbc_opendir_fn opendir_fn;
204 smbc_closedir_fn closedir_fn;
205 smbc_readdir_fn readdir_fn;
206 smbc_getdents_fn getdents_fn;
207 smbc_mkdir_fn mkdir_fn;
208 smbc_rmdir_fn rmdir_fn;
209 smbc_telldir_fn telldir_fn;
210 smbc_lseekdir_fn lseekdir_fn;
211 smbc_fstatdir_fn fstatdir_fn;
212 smbc_chmod_fn chmod_fn;
213 smbc_utimes_fn utimes_fn;
214 smbc_setxattr_fn setxattr_fn;
215 smbc_getxattr_fn getxattr_fn;
216 smbc_removexattr_fn removexattr_fn;
217 smbc_listxattr_fn listxattr_fn;
218 #endif
219 } posix_emu;
221 #if 0 /* Left in libsmbclient.h for backward compatibility */
222 /* Printing-related functions */
223 struct
225 smbc_print_file_fn print_file_fn;
226 smbc_open_print_job_fn open_print_job_fn;
227 smbc_list_print_jobs_fn list_print_jobs_fn;
228 smbc_unlink_print_job_fn unlink_print_job_fn;
229 } printing;
230 #endif
232 #if 0 /* None available yet */
233 /* SMB high-level functions */
234 struct
236 } smb;
238 #endif
241 /* Functions in libsmb_cache.c */
243 SMBC_add_cached_server(SMBCCTX * context,
244 SMBCSRV * newsrv,
245 const char * server,
246 const char * share,
247 const char * workgroup,
248 const char * username);
250 SMBCSRV *
251 SMBC_get_cached_server(SMBCCTX * context,
252 const char * server,
253 const char * share,
254 const char * workgroup,
255 const char * user);
258 SMBC_remove_cached_server(SMBCCTX * context,
259 SMBCSRV * server);
262 SMBC_purge_cached_servers(SMBCCTX * context);
265 /* Functions in libsmb_dir.c */
267 SMBC_check_options(char *server,
268 char *share,
269 char *path,
270 char *options);
272 SMBCFILE *
273 SMBC_opendir_ctx(SMBCCTX *context,
274 const char *fname);
277 SMBC_closedir_ctx(SMBCCTX *context,
278 SMBCFILE *dir);
280 struct smbc_dirent *
281 SMBC_readdir_ctx(SMBCCTX *context,
282 SMBCFILE *dir);
285 SMBC_getdents_ctx(SMBCCTX *context,
286 SMBCFILE *dir,
287 struct smbc_dirent *dirp,
288 int count);
291 SMBC_mkdir_ctx(SMBCCTX *context,
292 const char *fname,
293 mode_t mode);
296 SMBC_rmdir_ctx(SMBCCTX *context,
297 const char *fname);
299 off_t
300 SMBC_telldir_ctx(SMBCCTX *context,
301 SMBCFILE *dir);
304 SMBC_lseekdir_ctx(SMBCCTX *context,
305 SMBCFILE *dir,
306 off_t offset);
309 SMBC_fstatdir_ctx(SMBCCTX *context,
310 SMBCFILE *dir,
311 struct stat *st);
314 SMBC_chmod_ctx(SMBCCTX *context,
315 const char *fname,
316 mode_t newmode);
319 SMBC_utimes_ctx(SMBCCTX *context,
320 const char *fname,
321 struct timeval *tbuf);
324 SMBC_unlink_ctx(SMBCCTX *context,
325 const char *fname);
328 SMBC_rename_ctx(SMBCCTX *ocontext,
329 const char *oname,
330 SMBCCTX *ncontext,
331 const char *nname);
334 /* Functions in libsmb_file.c */
335 SMBCFILE *
336 SMBC_open_ctx(SMBCCTX *context,
337 const char *fname,
338 int flags,
339 mode_t mode);
341 SMBCFILE *
342 SMBC_creat_ctx(SMBCCTX *context,
343 const char *path,
344 mode_t mode);
346 ssize_t
347 SMBC_read_ctx(SMBCCTX *context,
348 SMBCFILE *file,
349 void *buf,
350 size_t count);
352 ssize_t
353 SMBC_write_ctx(SMBCCTX *context,
354 SMBCFILE *file,
355 void *buf,
356 size_t count);
359 SMBC_close_ctx(SMBCCTX *context,
360 SMBCFILE *file);
362 bool
363 SMBC_getatr(SMBCCTX * context,
364 SMBCSRV *srv,
365 char *path,
366 uint16 *mode,
367 SMB_OFF_T *size,
368 struct timespec *create_time_ts,
369 struct timespec *access_time_ts,
370 struct timespec *write_time_ts,
371 struct timespec *change_time_ts,
372 SMB_INO_T *ino);
374 bool
375 SMBC_setatr(SMBCCTX * context, SMBCSRV *srv, char *path,
376 time_t create_time,
377 time_t access_time,
378 time_t write_time,
379 time_t change_time,
380 uint16 mode);
382 off_t
383 SMBC_lseek_ctx(SMBCCTX *context,
384 SMBCFILE *file,
385 off_t offset,
386 int whence);
389 SMBC_ftruncate_ctx(SMBCCTX *context,
390 SMBCFILE *file,
391 off_t length);
394 /* Functions in libsmb_misc.c */
396 SMBC_dlist_contains(SMBCFILE * list, SMBCFILE *p);
399 SMBC_errno(SMBCCTX *context,
400 struct cli_state *c);
403 /* Functions in libsmb_path.c */
405 SMBC_parse_path(TALLOC_CTX *ctx,
406 SMBCCTX *context,
407 const char *fname,
408 char **pp_workgroup,
409 char **pp_server,
410 char **pp_share,
411 char **pp_path,
412 char **pp_user,
413 char **pp_password,
414 char **pp_options);
417 /* Functions in libsmb_printjob.c */
418 SMBCFILE *
419 SMBC_open_print_job_ctx(SMBCCTX *context,
420 const char *fname);
423 SMBC_print_file_ctx(SMBCCTX *c_file,
424 const char *fname,
425 SMBCCTX *c_print,
426 const char *printq);
429 SMBC_list_print_jobs_ctx(SMBCCTX *context,
430 const char *fname,
431 smbc_list_print_job_fn fn);
434 SMBC_unlink_print_job_ctx(SMBCCTX *context,
435 const char *fname,
436 int id);
439 /* Functions in libsmb_server.c */
441 SMBC_check_server(SMBCCTX * context,
442 SMBCSRV * server);
445 SMBC_remove_unused_server(SMBCCTX * context,
446 SMBCSRV * srv);
448 void
449 SMBC_call_auth_fn(TALLOC_CTX *ctx,
450 SMBCCTX *context,
451 const char *server,
452 const char *share,
453 char **pp_workgroup,
454 char **pp_username,
455 char **pp_password);
457 void
458 SMBC_get_auth_data(const char *server, const char *share,
459 char *workgroup_buf, int workgroup_buf_len,
460 char *username_buf, int username_buf_len,
461 char *password_buf, int password_buf_len);
463 SMBCSRV *
464 SMBC_find_server(TALLOC_CTX *ctx,
465 SMBCCTX *context,
466 const char *server,
467 const char *share,
468 char **pp_workgroup,
469 char **pp_username,
470 char **pp_password);
472 SMBCSRV *
473 SMBC_server(TALLOC_CTX *ctx,
474 SMBCCTX *context,
475 bool connect_if_not_found,
476 const char *server,
477 const char *share,
478 char **pp_workgroup,
479 char **pp_username,
480 char **pp_password);
482 SMBCSRV *
483 SMBC_attr_server(TALLOC_CTX *ctx,
484 SMBCCTX *context,
485 const char *server,
486 const char *share,
487 char **pp_workgroup,
488 char **pp_username,
489 char **pp_password);
492 /* Functions in libsmb_stat.c */
494 SMBC_stat_ctx(SMBCCTX *context,
495 const char *fname,
496 struct stat *st);
499 SMBC_fstat_ctx(SMBCCTX *context,
500 SMBCFILE *file,
501 struct stat *st);
504 /* Functions in libsmb_xattr.c */
506 SMBC_setxattr_ctx(SMBCCTX *context,
507 const char *fname,
508 const char *name,
509 const void *value,
510 size_t size,
511 int flags);
514 SMBC_getxattr_ctx(SMBCCTX *context,
515 const char *fname,
516 const char *name,
517 const void *value,
518 size_t size);
521 SMBC_removexattr_ctx(SMBCCTX *context,
522 const char *fname,
523 const char *name);
526 SMBC_listxattr_ctx(SMBCCTX *context,
527 const char *fname,
528 char *list,
529 size_t size);
532 #endif